esisl_genoa_client 0.1.0

package/docs/WarsApi.md

@@ -0,0 +1,254 @@
+# WarsApi
+
+All URIs are relative to *https://esi.evetech.net*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**getWars**](WarsApi.md#getwars) | **GET** /wars | List wars |
+| [**getWarsWarId**](WarsApi.md#getwarswarid) | **GET** /wars/{war_id} | Get war information |
+| [**getWarsWarIdKillmails**](WarsApi.md#getwarswaridkillmails) | **GET** /wars/{war_id}/killmails | List kills for a war |
+
+
+
+## getWars
+
+> Array<number> getWars(xCompatibilityDate, maxWarId, acceptLanguage, ifNoneMatch, xTenant)
+
+List wars
+
+Return a list of wars
+
+### Example
+
+```ts
+import {
+  Configuration,
+  WarsApi,
+} from 'esisl_genoa_client';
+import type { GetWarsRequest } from 'esisl_genoa_client';
+
+async function example() {
+  console.log("🚀 Testing esisl_genoa_client SDK...");
+  const api = new WarsApi();
+
+  const body = {
+    // '2020-01-01' | The compatibility date for the request.
+    xCompatibilityDate: 2013-10-20,
+    // number (optional)
+    maxWarId: 789,
+    // 'en' | 'de' | 'fr' | 'ja' | 'ru' | 'zh' | 'ko' | 'es' | The language to use for the response. (optional)
+    acceptLanguage: acceptLanguage_example,
+    // string | The ETag of the previous request. A 304 will be returned if this matches the current ETag. (optional)
+    ifNoneMatch: ifNoneMatch_example,
+    // string | The tenant ID for the request. (optional)
+    xTenant: ,
+  } satisfies GetWarsRequest;
+
+  try {
+    const data = await api.getWars(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **xCompatibilityDate** | `2020-01-01` | The compatibility date for the request. | [Defaults to `undefined`] [Enum: 2020-01-01] |
+| **maxWarId** | `number` |  | [Optional] [Defaults to `undefined`] |
+| **acceptLanguage** | `en`, `de`, `fr`, `ja`, `ru`, `zh`, `ko`, `es` | The language to use for the response. | [Optional] [Defaults to `'en'`] [Enum: en, de, fr, ja, ru, zh, ko, es] |
+| **ifNoneMatch** | `string` | The ETag of the previous request. A 304 will be returned if this matches the current ETag. | [Optional] [Defaults to `undefined`] |
+| **xTenant** | `string` | The tenant ID for the request. | [Optional] [Defaults to `'tranquility'`] |
+
+### Return type
+
+**Array<number>**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | OK |  * Cache-Control -  <br>  * ETag -  <br>  * Last-Modified -  <br>  |
+| **0** | Error |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## getWarsWarId
+
+> WarsWarIdGet getWarsWarId(warId, xCompatibilityDate, acceptLanguage, ifNoneMatch, xTenant)
+
+Get war information
+
+Return details about a war
+
+### Example
+
+```ts
+import {
+  Configuration,
+  WarsApi,
+} from 'esisl_genoa_client';
+import type { GetWarsWarIdRequest } from 'esisl_genoa_client';
+
+async function example() {
+  console.log("🚀 Testing esisl_genoa_client SDK...");
+  const api = new WarsApi();
+
+  const body = {
+    // number
+    warId: 789,
+    // '2020-01-01' | The compatibility date for the request.
+    xCompatibilityDate: 2013-10-20,
+    // 'en' | 'de' | 'fr' | 'ja' | 'ru' | 'zh' | 'ko' | 'es' | The language to use for the response. (optional)
+    acceptLanguage: acceptLanguage_example,
+    // string | The ETag of the previous request. A 304 will be returned if this matches the current ETag. (optional)
+    ifNoneMatch: ifNoneMatch_example,
+    // string | The tenant ID for the request. (optional)
+    xTenant: ,
+  } satisfies GetWarsWarIdRequest;
+
+  try {
+    const data = await api.getWarsWarId(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **warId** | `number` |  | [Defaults to `undefined`] |
+| **xCompatibilityDate** | `2020-01-01` | The compatibility date for the request. | [Defaults to `undefined`] [Enum: 2020-01-01] |
+| **acceptLanguage** | `en`, `de`, `fr`, `ja`, `ru`, `zh`, `ko`, `es` | The language to use for the response. | [Optional] [Defaults to `&#39;en&#39;`] [Enum: en, de, fr, ja, ru, zh, ko, es] |
+| **ifNoneMatch** | `string` | The ETag of the previous request. A 304 will be returned if this matches the current ETag. | [Optional] [Defaults to `undefined`] |
+| **xTenant** | `string` | The tenant ID for the request. | [Optional] [Defaults to `&#39;tranquility&#39;`] |
+
+### Return type
+
+[**WarsWarIdGet**](WarsWarIdGet.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | OK |  * Cache-Control -  <br>  * ETag -  <br>  * Last-Modified -  <br>  |
+| **0** | Error |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## getWarsWarIdKillmails
+
+> Array&lt;CharactersCharacterIdKillmailsRecentGetInner&gt; getWarsWarIdKillmails(warId, xCompatibilityDate, page, acceptLanguage, ifNoneMatch, xTenant)
+
+List kills for a war
+
+Return a list of kills related to a war
+
+### Example
+
+```ts
+import {
+  Configuration,
+  WarsApi,
+} from 'esisl_genoa_client';
+import type { GetWarsWarIdKillmailsRequest } from 'esisl_genoa_client';
+
+async function example() {
+  console.log("🚀 Testing esisl_genoa_client SDK...");
+  const api = new WarsApi();
+
+  const body = {
+    // number
+    warId: 789,
+    // '2020-01-01' | The compatibility date for the request.
+    xCompatibilityDate: 2013-10-20,
+    // number (optional)
+    page: 56,
+    // 'en' | 'de' | 'fr' | 'ja' | 'ru' | 'zh' | 'ko' | 'es' | The language to use for the response. (optional)
+    acceptLanguage: acceptLanguage_example,
+    // string | The ETag of the previous request. A 304 will be returned if this matches the current ETag. (optional)
+    ifNoneMatch: ifNoneMatch_example,
+    // string | The tenant ID for the request. (optional)
+    xTenant: ,
+  } satisfies GetWarsWarIdKillmailsRequest;
+
+  try {
+    const data = await api.getWarsWarIdKillmails(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **warId** | `number` |  | [Defaults to `undefined`] |
+| **xCompatibilityDate** | `2020-01-01` | The compatibility date for the request. | [Defaults to `undefined`] [Enum: 2020-01-01] |
+| **page** | `number` |  | [Optional] [Defaults to `undefined`] |
+| **acceptLanguage** | `en`, `de`, `fr`, `ja`, `ru`, `zh`, `ko`, `es` | The language to use for the response. | [Optional] [Defaults to `&#39;en&#39;`] [Enum: en, de, fr, ja, ru, zh, ko, es] |
+| **ifNoneMatch** | `string` | The ETag of the previous request. A 304 will be returned if this matches the current ETag. | [Optional] [Defaults to `undefined`] |
+| **xTenant** | `string` | The tenant ID for the request. | [Optional] [Defaults to `&#39;tranquility&#39;`] |
+
+### Return type
+
+[**Array&lt;CharactersCharacterIdKillmailsRecentGetInner&gt;**](CharactersCharacterIdKillmailsRecentGetInner.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | OK |  * Cache-Control -  <br>  * ETag -  <br>  * Last-Modified -  <br>  * X-Pages - The total number of pages in the result set. <br>  |
+| **0** | Error |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+

package/docs/WarsWarIdGet.md

@@ -0,0 +1,23 @@
+
+# WarsWarIdGet
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`aggressor` | [WarsWarIdGetAggressor](WarsWarIdGetAggressor.md)
+`allies` | [Array<WarsWarIdGetAlliesInner>](WarsWarIdGetAlliesInner.md)
+`declared` | string
+`defender` | [WarsWarIdGetDefender](WarsWarIdGetDefender.md)
+`finished` | string
+`id` | number
+`mutual` | boolean
+`openForAllies` | boolean
+`retracted` | string
+`started` | string
+
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/WarsWarIdGetAggressor.md

@@ -0,0 +1,18 @@
+
+# WarsWarIdGetAggressor
+
+The aggressor corporation or alliance that declared this war, only contains either corporation_id or alliance_id
+
+## Properties
+
+Name | Type
+------------ | -------------
+`allianceId` | number
+`corporationId` | number
+`iskDestroyed` | number
+`shipsKilled` | number
+
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/WarsWarIdGetAlliesInner.md

@@ -0,0 +1,16 @@
+
+# WarsWarIdGetAlliesInner
+
+ally object
+
+## Properties
+
+Name | Type
+------------ | -------------
+`allianceId` | number
+`corporationId` | number
+
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/WarsWarIdGetDefender.md

@@ -0,0 +1,18 @@
+
+# WarsWarIdGetDefender
+
+The defending corporation or alliance that declared this war, only contains either corporation_id or alliance_id
+
+## Properties
+
+Name | Type
+------------ | -------------
+`allianceId` | number
+`corporationId` | number
+`iskDestroyed` | number
+`shipsKilled` | number
+
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/package.json

@@ -0,0 +1,19 @@
+{
+  "name": "esisl_genoa_client",
+  "version": "0.1.0",
+  "description": "OpenAPI client for esisl_genoa_client",
+  "author": "OpenAPI-Generator",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/Arcyfa/esisl-genoa-client.git"
+  },
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "scripts": {
+    "build": "tsc",
+    "prepare": "npm run build"
+  },
+  "devDependencies": {
+    "typescript": "^4.0 || ^5.0"
+  }
+}