esisl_genoa_client 0.1.0

package/docs/LocationApi.md

@@ -0,0 +1,263 @@
+# LocationApi
+
+All URIs are relative to *https://esi.evetech.net*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**getCharactersCharacterIdLocation**](LocationApi.md#getcharacterscharacteridlocation) | **GET** /characters/{character_id}/location | Get character location |
+| [**getCharactersCharacterIdOnline**](LocationApi.md#getcharacterscharacteridonline) | **GET** /characters/{character_id}/online | Get character online |
+| [**getCharactersCharacterIdShip**](LocationApi.md#getcharacterscharacteridship) | **GET** /characters/{character_id}/ship | Get current ship |
+
+
+
+## getCharactersCharacterIdLocation
+
+> CharactersCharacterIdLocationGet getCharactersCharacterIdLocation(characterId, xCompatibilityDate, acceptLanguage, ifNoneMatch, xTenant)
+
+Get character location
+
+Information about the characters current location. Returns the current solar system id, and also the current station or structure ID if applicable
+
+### Example
+
+```ts
+import {
+  Configuration,
+  LocationApi,
+} from 'esisl_genoa_client';
+import type { GetCharactersCharacterIdLocationRequest } from 'esisl_genoa_client';
+
+async function example() {
+  console.log("🚀 Testing esisl_genoa_client SDK...");
+  const config = new Configuration({ 
+    // To configure OAuth2 access token for authorization: OAuth2 accessCode
+    accessToken: "YOUR ACCESS TOKEN",
+  });
+  const api = new LocationApi(config);
+
+  const body = {
+    // number | The ID of the character
+    characterId: 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 GetCharactersCharacterIdLocationRequest;
+
+  try {
+    const data = await api.getCharactersCharacterIdLocation(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **characterId** | `number` | The ID of the character | [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 `'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
+
+[**CharactersCharacterIdLocationGet**](CharactersCharacterIdLocationGet.md)
+
+### Authorization
+
+[OAuth2 accessCode](../README.md#OAuth2-accessCode)
+
+### 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)
+
+
+## getCharactersCharacterIdOnline
+
+> CharactersCharacterIdOnlineGet getCharactersCharacterIdOnline(characterId, xCompatibilityDate, acceptLanguage, ifNoneMatch, xTenant)
+
+Get character online
+
+Checks if the character is currently online
+
+### Example
+
+```ts
+import {
+  Configuration,
+  LocationApi,
+} from 'esisl_genoa_client';
+import type { GetCharactersCharacterIdOnlineRequest } from 'esisl_genoa_client';
+
+async function example() {
+  console.log("🚀 Testing esisl_genoa_client SDK...");
+  const config = new Configuration({ 
+    // To configure OAuth2 access token for authorization: OAuth2 accessCode
+    accessToken: "YOUR ACCESS TOKEN",
+  });
+  const api = new LocationApi(config);
+
+  const body = {
+    // number | The ID of the character
+    characterId: 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 GetCharactersCharacterIdOnlineRequest;
+
+  try {
+    const data = await api.getCharactersCharacterIdOnline(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **characterId** | `number` | The ID of the character | [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
+
+[**CharactersCharacterIdOnlineGet**](CharactersCharacterIdOnlineGet.md)
+
+### Authorization
+
+[OAuth2 accessCode](../README.md#OAuth2-accessCode)
+
+### 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)
+
+
+## getCharactersCharacterIdShip
+
+> CharactersCharacterIdShipGet getCharactersCharacterIdShip(characterId, xCompatibilityDate, acceptLanguage, ifNoneMatch, xTenant)
+
+Get current ship
+
+Get the current ship type, name and id
+
+### Example
+
+```ts
+import {
+  Configuration,
+  LocationApi,
+} from 'esisl_genoa_client';
+import type { GetCharactersCharacterIdShipRequest } from 'esisl_genoa_client';
+
+async function example() {
+  console.log("🚀 Testing esisl_genoa_client SDK...");
+  const config = new Configuration({ 
+    // To configure OAuth2 access token for authorization: OAuth2 accessCode
+    accessToken: "YOUR ACCESS TOKEN",
+  });
+  const api = new LocationApi(config);
+
+  const body = {
+    // number | The ID of the character
+    characterId: 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 GetCharactersCharacterIdShipRequest;
+
+  try {
+    const data = await api.getCharactersCharacterIdShip(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **characterId** | `number` | The ID of the character | [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
+
+[**CharactersCharacterIdShipGet**](CharactersCharacterIdShipGet.md)
+
+### Authorization
+
+[OAuth2 accessCode](../README.md#OAuth2-accessCode)
+
+### 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/LoyaltyApi.md

@@ -0,0 +1,174 @@
+# LoyaltyApi
+
+All URIs are relative to *https://esi.evetech.net*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**getCharactersCharacterIdLoyaltyPoints**](LoyaltyApi.md#getcharacterscharacteridloyaltypoints) | **GET** /characters/{character_id}/loyalty/points | Get loyalty points |
+| [**getLoyaltyStoresCorporationIdOffers**](LoyaltyApi.md#getloyaltystorescorporationidoffers) | **GET** /loyalty/stores/{corporation_id}/offers | List loyalty store offers |
+
+
+
+## getCharactersCharacterIdLoyaltyPoints
+
+> Array<CharactersCharacterIdLoyaltyPointsGetInner> getCharactersCharacterIdLoyaltyPoints(characterId, xCompatibilityDate, acceptLanguage, ifNoneMatch, xTenant)
+
+Get loyalty points
+
+Return a list of loyalty points for all corporations the character has worked for
+
+### Example
+
+```ts
+import {
+  Configuration,
+  LoyaltyApi,
+} from 'esisl_genoa_client';
+import type { GetCharactersCharacterIdLoyaltyPointsRequest } from 'esisl_genoa_client';
+
+async function example() {
+  console.log("🚀 Testing esisl_genoa_client SDK...");
+  const config = new Configuration({ 
+    // To configure OAuth2 access token for authorization: OAuth2 accessCode
+    accessToken: "YOUR ACCESS TOKEN",
+  });
+  const api = new LoyaltyApi(config);
+
+  const body = {
+    // number | The ID of the character
+    characterId: 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 GetCharactersCharacterIdLoyaltyPointsRequest;
+
+  try {
+    const data = await api.getCharactersCharacterIdLoyaltyPoints(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **characterId** | `number` | The ID of the character | [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 `'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<CharactersCharacterIdLoyaltyPointsGetInner>**](CharactersCharacterIdLoyaltyPointsGetInner.md)
+
+### Authorization
+
+[OAuth2 accessCode](../README.md#OAuth2-accessCode)
+
+### 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)
+
+
+## getLoyaltyStoresCorporationIdOffers
+
+> Array&lt;LoyaltyStoresCorporationIdOffersGetInner&gt; getLoyaltyStoresCorporationIdOffers(corporationId, xCompatibilityDate, acceptLanguage, ifNoneMatch, xTenant)
+
+List loyalty store offers
+
+Return a list of offers from a specific corporation\&#39;s loyalty store  This route expires daily at 11:05
+
+### Example
+
+```ts
+import {
+  Configuration,
+  LoyaltyApi,
+} from 'esisl_genoa_client';
+import type { GetLoyaltyStoresCorporationIdOffersRequest } from 'esisl_genoa_client';
+
+async function example() {
+  console.log("🚀 Testing esisl_genoa_client SDK...");
+  const api = new LoyaltyApi();
+
+  const body = {
+    // number | The ID of the corporation
+    corporationId: 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 GetLoyaltyStoresCorporationIdOffersRequest;
+
+  try {
+    const data = await api.getLoyaltyStoresCorporationIdOffers(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **corporationId** | `number` | The ID of the corporation | [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
+
+[**Array&lt;LoyaltyStoresCorporationIdOffersGetInner&gt;**](LoyaltyStoresCorporationIdOffersGetInner.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/LoyaltyStoresCorporationIdOffersGetInner.md

@@ -0,0 +1,20 @@
+
+# LoyaltyStoresCorporationIdOffersGetInner
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`akCost` | number
+`iskCost` | number
+`lpCost` | number
+`offerId` | number
+`quantity` | number
+`requiredItems` | [Array<LoyaltyStoresCorporationIdOffersGetInnerRequiredItemsInner>](LoyaltyStoresCorporationIdOffersGetInnerRequiredItemsInner.md)
+`typeId` | 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/LoyaltyStoresCorporationIdOffersGetInnerRequiredItemsInner.md

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