esisl_genoa_client 0.1.0

package/docs/AllianceApi.md

@@ -0,0 +1,329 @@
+# AllianceApi
+
+All URIs are relative to *https://esi.evetech.net*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**getAlliances**](AllianceApi.md#getalliances) | **GET** /alliances | List all alliances |
+| [**getAlliancesAllianceId**](AllianceApi.md#getalliancesallianceid) | **GET** /alliances/{alliance_id} | Get alliance information |
+| [**getAlliancesAllianceIdCorporations**](AllianceApi.md#getalliancesallianceidcorporations) | **GET** /alliances/{alliance_id}/corporations | List alliance\'s corporations |
+| [**getAlliancesAllianceIdIcons**](AllianceApi.md#getalliancesallianceidicons) | **GET** /alliances/{alliance_id}/icons | Get alliance icon |
+
+
+
+## getAlliances
+
+> Set<number> getAlliances(xCompatibilityDate, acceptLanguage, ifNoneMatch, xTenant)
+
+List all alliances
+
+List all active player alliances
+
+### Example
+
+```ts
+import {
+  Configuration,
+  AllianceApi,
+} from 'esisl_genoa_client';
+import type { GetAlliancesRequest } from 'esisl_genoa_client';
+
+async function example() {
+  console.log("🚀 Testing esisl_genoa_client SDK...");
+  const api = new AllianceApi();
+
+  const body = {
+    // '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 GetAlliancesRequest;
+
+  try {
+    const data = await api.getAlliances(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] |
+| **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
+
+**Set<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)
+
+
+## getAlliancesAllianceId
+
+> AlliancesAllianceIdGet getAlliancesAllianceId(allianceId, xCompatibilityDate, acceptLanguage, ifNoneMatch, xTenant)
+
+Get alliance information
+
+Public information about an alliance
+
+### Example
+
+```ts
+import {
+  Configuration,
+  AllianceApi,
+} from 'esisl_genoa_client';
+import type { GetAlliancesAllianceIdRequest } from 'esisl_genoa_client';
+
+async function example() {
+  console.log("🚀 Testing esisl_genoa_client SDK...");
+  const api = new AllianceApi();
+
+  const body = {
+    // number | The ID of the alliance
+    allianceId: 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 GetAlliancesAllianceIdRequest;
+
+  try {
+    const data = await api.getAlliancesAllianceId(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **allianceId** | `number` | The ID of the alliance | [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
+
+[**AlliancesAllianceIdGet**](AlliancesAllianceIdGet.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)
+
+
+## getAlliancesAllianceIdCorporations
+
+> Set&lt;number&gt; getAlliancesAllianceIdCorporations(allianceId, xCompatibilityDate, acceptLanguage, ifNoneMatch, xTenant)
+
+List alliance\&#39;s corporations
+
+List all current member corporations of an alliance
+
+### Example
+
+```ts
+import {
+  Configuration,
+  AllianceApi,
+} from 'esisl_genoa_client';
+import type { GetAlliancesAllianceIdCorporationsRequest } from 'esisl_genoa_client';
+
+async function example() {
+  console.log("🚀 Testing esisl_genoa_client SDK...");
+  const api = new AllianceApi();
+
+  const body = {
+    // number | The ID of the alliance
+    allianceId: 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 GetAlliancesAllianceIdCorporationsRequest;
+
+  try {
+    const data = await api.getAlliancesAllianceIdCorporations(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **allianceId** | `number` | The ID of the alliance | [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
+
+**Set<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)
+
+
+## getAlliancesAllianceIdIcons
+
+> AlliancesAllianceIdIconsGet getAlliancesAllianceIdIcons(allianceId, xCompatibilityDate, acceptLanguage, ifNoneMatch, xTenant)
+
+Get alliance icon
+
+Get the icon urls for a alliance  This route expires daily at 11:05
+
+### Example
+
+```ts
+import {
+  Configuration,
+  AllianceApi,
+} from 'esisl_genoa_client';
+import type { GetAlliancesAllianceIdIconsRequest } from 'esisl_genoa_client';
+
+async function example() {
+  console.log("🚀 Testing esisl_genoa_client SDK...");
+  const api = new AllianceApi();
+
+  const body = {
+    // number | The ID of the alliance
+    allianceId: 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 GetAlliancesAllianceIdIconsRequest;
+
+  try {
+    const data = await api.getAlliancesAllianceIdIcons(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **allianceId** | `number` | The ID of the alliance | [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
+
+[**AlliancesAllianceIdIconsGet**](AlliancesAllianceIdIconsGet.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)
+

package/docs/AlliancesAllianceIdContactsGetInner.md

@@ -0,0 +1,17 @@
+
+# AlliancesAllianceIdContactsGetInner
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`contactId` | number
+`contactType` | string
+`labelIds` | Array<number>
+`standing` | 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/AlliancesAllianceIdContactsLabelsGetInner.md

@@ -0,0 +1,15 @@
+
+# AlliancesAllianceIdContactsLabelsGetInner
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`labelId` | number
+`labelName` | 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/AlliancesAllianceIdGet.md

@@ -0,0 +1,20 @@
+
+# AlliancesAllianceIdGet
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`creatorCorporationId` | number
+`creatorId` | number
+`dateFounded` | string
+`executorCorporationId` | number
+`factionId` | number
+`name` | string
+`ticker` | 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/AlliancesAllianceIdIconsGet.md

@@ -0,0 +1,15 @@
+
+# AlliancesAllianceIdIconsGet
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`px128x128` | string
+`px64x64` | string
+
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+