esisl_genoa_client 0.1.0

package/docs/WalletApi.md

@@ -0,0 +1,536 @@
+# WalletApi
+
+All URIs are relative to *https://esi.evetech.net*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**getCharactersCharacterIdWallet**](WalletApi.md#getcharacterscharacteridwallet) | **GET** /characters/{character_id}/wallet | Get a character\'s wallet balance |
+| [**getCharactersCharacterIdWalletJournal**](WalletApi.md#getcharacterscharacteridwalletjournal) | **GET** /characters/{character_id}/wallet/journal | Get character wallet journal |
+| [**getCharactersCharacterIdWalletTransactions**](WalletApi.md#getcharacterscharacteridwallettransactions) | **GET** /characters/{character_id}/wallet/transactions | Get wallet transactions |
+| [**getCorporationsCorporationIdWallets**](WalletApi.md#getcorporationscorporationidwallets) | **GET** /corporations/{corporation_id}/wallets | Returns a corporation\'s wallet balance |
+| [**getCorporationsCorporationIdWalletsDivisionJournal**](WalletApi.md#getcorporationscorporationidwalletsdivisionjournal) | **GET** /corporations/{corporation_id}/wallets/{division}/journal | Get corporation wallet journal |
+| [**getCorporationsCorporationIdWalletsDivisionTransactions**](WalletApi.md#getcorporationscorporationidwalletsdivisiontransactions) | **GET** /corporations/{corporation_id}/wallets/{division}/transactions | Get corporation wallet transactions |
+
+
+
+## getCharactersCharacterIdWallet
+
+> number getCharactersCharacterIdWallet(characterId, xCompatibilityDate, acceptLanguage, ifNoneMatch, xTenant)
+
+Get a character\'s wallet balance
+
+Returns a character\'s wallet balance
+
+### Example
+
+```ts
+import {
+  Configuration,
+  WalletApi,
+} from 'esisl_genoa_client';
+import type { GetCharactersCharacterIdWalletRequest } 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 WalletApi(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 GetCharactersCharacterIdWalletRequest;
+
+  try {
+    const data = await api.getCharactersCharacterIdWallet(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
+
+**number**
+
+### 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)
+
+
+## getCharactersCharacterIdWalletJournal
+
+> Array&lt;CharactersCharacterIdWalletJournalGetInner&gt; getCharactersCharacterIdWalletJournal(characterId, xCompatibilityDate, page, acceptLanguage, ifNoneMatch, xTenant)
+
+Get character wallet journal
+
+Retrieve the given character\&#39;s wallet journal going 30 days back
+
+### Example
+
+```ts
+import {
+  Configuration,
+  WalletApi,
+} from 'esisl_genoa_client';
+import type { GetCharactersCharacterIdWalletJournalRequest } 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 WalletApi(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 GetCharactersCharacterIdWalletJournalRequest;
+
+  try {
+    const data = await api.getCharactersCharacterIdWalletJournal(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 `&#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;CharactersCharacterIdWalletJournalGetInner&gt;**](CharactersCharacterIdWalletJournalGetInner.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)
+
+
+## getCharactersCharacterIdWalletTransactions
+
+> Array&lt;CharactersCharacterIdWalletTransactionsGetInner&gt; getCharactersCharacterIdWalletTransactions(characterId, xCompatibilityDate, fromId, acceptLanguage, ifNoneMatch, xTenant)
+
+Get wallet transactions
+
+Get wallet transactions of a character
+
+### Example
+
+```ts
+import {
+  Configuration,
+  WalletApi,
+} from 'esisl_genoa_client';
+import type { GetCharactersCharacterIdWalletTransactionsRequest } 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 WalletApi(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)
+    fromId: 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 GetCharactersCharacterIdWalletTransactionsRequest;
+
+  try {
+    const data = await api.getCharactersCharacterIdWalletTransactions(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] |
+| **fromId** | `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;CharactersCharacterIdWalletTransactionsGetInner&gt;**](CharactersCharacterIdWalletTransactionsGetInner.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)
+
+
+## getCorporationsCorporationIdWallets
+
+> Array&lt;CorporationsCorporationIdWalletsGetInner&gt; getCorporationsCorporationIdWallets(corporationId, xCompatibilityDate, acceptLanguage, ifNoneMatch, xTenant)
+
+Returns a corporation\&#39;s wallet balance
+
+Get a corporation\&#39;s wallets
+
+### Example
+
+```ts
+import {
+  Configuration,
+  WalletApi,
+} from 'esisl_genoa_client';
+import type { GetCorporationsCorporationIdWalletsRequest } 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 WalletApi(config);
+
+  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 GetCorporationsCorporationIdWalletsRequest;
+
+  try {
+    const data = await api.getCorporationsCorporationIdWallets(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;CorporationsCorporationIdWalletsGetInner&gt;**](CorporationsCorporationIdWalletsGetInner.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)
+
+
+## getCorporationsCorporationIdWalletsDivisionJournal
+
+> Array&lt;CorporationsCorporationIdWalletsDivisionJournalGetInner&gt; getCorporationsCorporationIdWalletsDivisionJournal(corporationId, division, xCompatibilityDate, page, acceptLanguage, ifNoneMatch, xTenant)
+
+Get corporation wallet journal
+
+Retrieve the given corporation\&#39;s wallet journal for the given division going 30 days back
+
+### Example
+
+```ts
+import {
+  Configuration,
+  WalletApi,
+} from 'esisl_genoa_client';
+import type { GetCorporationsCorporationIdWalletsDivisionJournalRequest } 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 WalletApi(config);
+
+  const body = {
+    // number | The ID of the corporation
+    corporationId: 789,
+    // number
+    division: 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 GetCorporationsCorporationIdWalletsDivisionJournalRequest;
+
+  try {
+    const data = await api.getCorporationsCorporationIdWalletsDivisionJournal(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`] |
+| **division** | `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;CorporationsCorporationIdWalletsDivisionJournalGetInner&gt;**](CorporationsCorporationIdWalletsDivisionJournalGetInner.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)
+
+
+## getCorporationsCorporationIdWalletsDivisionTransactions
+
+> Array&lt;CorporationsCorporationIdWalletsDivisionTransactionsGetInner&gt; getCorporationsCorporationIdWalletsDivisionTransactions(corporationId, division, xCompatibilityDate, fromId, acceptLanguage, ifNoneMatch, xTenant)
+
+Get corporation wallet transactions
+
+Get wallet transactions of a corporation
+
+### Example
+
+```ts
+import {
+  Configuration,
+  WalletApi,
+} from 'esisl_genoa_client';
+import type { GetCorporationsCorporationIdWalletsDivisionTransactionsRequest } 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 WalletApi(config);
+
+  const body = {
+    // number | The ID of the corporation
+    corporationId: 789,
+    // number
+    division: 789,
+    // '2020-01-01' | The compatibility date for the request.
+    xCompatibilityDate: 2013-10-20,
+    // number (optional)
+    fromId: 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 GetCorporationsCorporationIdWalletsDivisionTransactionsRequest;
+
+  try {
+    const data = await api.getCorporationsCorporationIdWalletsDivisionTransactions(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`] |
+| **division** | `number` |  | [Defaults to `undefined`] |
+| **xCompatibilityDate** | `2020-01-01` | The compatibility date for the request. | [Defaults to `undefined`] [Enum: 2020-01-01] |
+| **fromId** | `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;CorporationsCorporationIdWalletsDivisionTransactionsGetInner&gt;**](CorporationsCorporationIdWalletsDivisionTransactionsGetInner.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)
+