esisl_genoa_client 0.1.0

package/docs/AssetsApi.md

@@ -0,0 +1,536 @@
+# AssetsApi
+
+All URIs are relative to *https://esi.evetech.net*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**getCharactersCharacterIdAssets**](AssetsApi.md#getcharacterscharacteridassets) | **GET** /characters/{character_id}/assets | Get character assets |
+| [**getCorporationsCorporationIdAssets**](AssetsApi.md#getcorporationscorporationidassets) | **GET** /corporations/{corporation_id}/assets | Get corporation assets |
+| [**postCharactersCharacterIdAssetsLocations**](AssetsApi.md#postcharacterscharacteridassetslocations) | **POST** /characters/{character_id}/assets/locations | Get character asset locations |
+| [**postCharactersCharacterIdAssetsNames**](AssetsApi.md#postcharacterscharacteridassetsnames) | **POST** /characters/{character_id}/assets/names | Get character asset names |
+| [**postCorporationsCorporationIdAssetsLocations**](AssetsApi.md#postcorporationscorporationidassetslocations) | **POST** /corporations/{corporation_id}/assets/locations | Get corporation asset locations |
+| [**postCorporationsCorporationIdAssetsNames**](AssetsApi.md#postcorporationscorporationidassetsnames) | **POST** /corporations/{corporation_id}/assets/names | Get corporation asset names |
+
+
+
+## getCharactersCharacterIdAssets
+
+> Array<CharactersCharacterIdAssetsGetInner> getCharactersCharacterIdAssets(characterId, xCompatibilityDate, page, acceptLanguage, ifNoneMatch, xTenant)
+
+Get character assets
+
+Return a list of the characters assets
+
+### Example
+
+```ts
+import {
+  Configuration,
+  AssetsApi,
+} from 'esisl_genoa_client';
+import type { GetCharactersCharacterIdAssetsRequest } 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 AssetsApi(config);
+
+  const body = {
+    // number | The ID of the character
+    characterId: 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 GetCharactersCharacterIdAssetsRequest;
+
+  try {
+    const data = await api.getCharactersCharacterIdAssets(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] |
+| **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 `'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<CharactersCharacterIdAssetsGetInner>**](CharactersCharacterIdAssetsGetInner.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>  * 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)
+
+
+## getCorporationsCorporationIdAssets
+
+> Array&lt;CorporationsCorporationIdAssetsGetInner&gt; getCorporationsCorporationIdAssets(corporationId, xCompatibilityDate, page, acceptLanguage, ifNoneMatch, xTenant)
+
+Get corporation assets
+
+Return a list of the corporation assets
+
+### Example
+
+```ts
+import {
+  Configuration,
+  AssetsApi,
+} from 'esisl_genoa_client';
+import type { GetCorporationsCorporationIdAssetsRequest } 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 AssetsApi(config);
+
+  const body = {
+    // number | The ID of the corporation
+    corporationId: 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 GetCorporationsCorporationIdAssetsRequest;
+
+  try {
+    const data = await api.getCorporationsCorporationIdAssets(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] |
+| **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;CorporationsCorporationIdAssetsGetInner&gt;**](CorporationsCorporationIdAssetsGetInner.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>  * 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)
+
+
+## postCharactersCharacterIdAssetsLocations
+
+> Array&lt;CharactersCharacterIdAssetsLocationsPostInner&gt; postCharactersCharacterIdAssetsLocations(characterId, xCompatibilityDate, requestBody, acceptLanguage, ifNoneMatch, xTenant)
+
+Get character asset locations
+
+Return locations for a set of item ids, which you can get from character assets endpoint. Coordinates for items in hangars or stations are set to (0,0,0)
+
+### Example
+
+```ts
+import {
+  Configuration,
+  AssetsApi,
+} from 'esisl_genoa_client';
+import type { PostCharactersCharacterIdAssetsLocationsRequest } 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 AssetsApi(config);
+
+  const body = {
+    // number | The ID of the character
+    characterId: 789,
+    // '2020-01-01' | The compatibility date for the request.
+    xCompatibilityDate: 2013-10-20,
+    // Set<number>
+    requestBody: ...,
+    // '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 PostCharactersCharacterIdAssetsLocationsRequest;
+
+  try {
+    const data = await api.postCharactersCharacterIdAssetsLocations(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] |
+| **requestBody** | `Set<number>` |  | |
+| **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;CharactersCharacterIdAssetsLocationsPostInner&gt;**](CharactersCharacterIdAssetsLocationsPostInner.md)
+
+### Authorization
+
+[OAuth2 accessCode](../README.md#OAuth2-accessCode)
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **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)
+
+
+## postCharactersCharacterIdAssetsNames
+
+> Array&lt;CharactersCharacterIdAssetsNamesPostInner&gt; postCharactersCharacterIdAssetsNames(characterId, xCompatibilityDate, requestBody, acceptLanguage, ifNoneMatch, xTenant)
+
+Get character asset names
+
+Return names for a set of item ids, which you can get from character assets endpoint. Typically used for items that can customize names, like containers or ships.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  AssetsApi,
+} from 'esisl_genoa_client';
+import type { PostCharactersCharacterIdAssetsNamesRequest } 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 AssetsApi(config);
+
+  const body = {
+    // number | The ID of the character
+    characterId: 789,
+    // '2020-01-01' | The compatibility date for the request.
+    xCompatibilityDate: 2013-10-20,
+    // Set<number>
+    requestBody: ...,
+    // '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 PostCharactersCharacterIdAssetsNamesRequest;
+
+  try {
+    const data = await api.postCharactersCharacterIdAssetsNames(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] |
+| **requestBody** | `Set<number>` |  | |
+| **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;CharactersCharacterIdAssetsNamesPostInner&gt;**](CharactersCharacterIdAssetsNamesPostInner.md)
+
+### Authorization
+
+[OAuth2 accessCode](../README.md#OAuth2-accessCode)
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **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)
+
+
+## postCorporationsCorporationIdAssetsLocations
+
+> Array&lt;CharactersCharacterIdAssetsLocationsPostInner&gt; postCorporationsCorporationIdAssetsLocations(corporationId, xCompatibilityDate, requestBody, acceptLanguage, ifNoneMatch, xTenant)
+
+Get corporation asset locations
+
+Return locations for a set of item ids, which you can get from corporation assets endpoint. Coordinates for items in hangars or stations are set to (0,0,0)
+
+### Example
+
+```ts
+import {
+  Configuration,
+  AssetsApi,
+} from 'esisl_genoa_client';
+import type { PostCorporationsCorporationIdAssetsLocationsRequest } 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 AssetsApi(config);
+
+  const body = {
+    // number | The ID of the corporation
+    corporationId: 789,
+    // '2020-01-01' | The compatibility date for the request.
+    xCompatibilityDate: 2013-10-20,
+    // Set<number>
+    requestBody: ...,
+    // '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 PostCorporationsCorporationIdAssetsLocationsRequest;
+
+  try {
+    const data = await api.postCorporationsCorporationIdAssetsLocations(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] |
+| **requestBody** | `Set<number>` |  | |
+| **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;CharactersCharacterIdAssetsLocationsPostInner&gt;**](CharactersCharacterIdAssetsLocationsPostInner.md)
+
+### Authorization
+
+[OAuth2 accessCode](../README.md#OAuth2-accessCode)
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **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)
+
+
+## postCorporationsCorporationIdAssetsNames
+
+> Array&lt;CharactersCharacterIdAssetsNamesPostInner&gt; postCorporationsCorporationIdAssetsNames(corporationId, xCompatibilityDate, requestBody, acceptLanguage, ifNoneMatch, xTenant)
+
+Get corporation asset names
+
+Return names for a set of item ids, which you can get from corporation assets endpoint. Only valid for items that can customize names, like containers or ships
+
+### Example
+
+```ts
+import {
+  Configuration,
+  AssetsApi,
+} from 'esisl_genoa_client';
+import type { PostCorporationsCorporationIdAssetsNamesRequest } 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 AssetsApi(config);
+
+  const body = {
+    // number | The ID of the corporation
+    corporationId: 789,
+    // '2020-01-01' | The compatibility date for the request.
+    xCompatibilityDate: 2013-10-20,
+    // Set<number>
+    requestBody: ...,
+    // '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 PostCorporationsCorporationIdAssetsNamesRequest;
+
+  try {
+    const data = await api.postCorporationsCorporationIdAssetsNames(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] |
+| **requestBody** | `Set<number>` |  | |
+| **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;CharactersCharacterIdAssetsNamesPostInner&gt;**](CharactersCharacterIdAssetsNamesPostInner.md)
+
+### Authorization
+
+[OAuth2 accessCode](../README.md#OAuth2-accessCode)
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **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)
+