esisl_genoa_client 0.1.0

package/docs/UniverseTypesTypeIdGet.md

@@ -0,0 +1,29 @@
+
+# UniverseTypesTypeIdGet
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`capacity` | number
+`description` | string
+`dogmaAttributes` | [Array<DogmaDynamicItemsTypeIdItemIdGetDogmaAttributesInner>](DogmaDynamicItemsTypeIdItemIdGetDogmaAttributesInner.md)
+`dogmaEffects` | [Array<DogmaDynamicItemsTypeIdItemIdGetDogmaEffectsInner>](DogmaDynamicItemsTypeIdItemIdGetDogmaEffectsInner.md)
+`graphicId` | number
+`groupId` | number
+`iconId` | number
+`marketGroupId` | number
+`mass` | number
+`name` | string
+`packagedVolume` | number
+`portionSize` | number
+`published` | boolean
+`radius` | number
+`typeId` | number
+`volume` | 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/UserInterfaceApi.md

@@ -0,0 +1,439 @@
+# UserInterfaceApi
+
+All URIs are relative to *https://esi.evetech.net*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**postUiAutopilotWaypoint**](UserInterfaceApi.md#postuiautopilotwaypoint) | **POST** /ui/autopilot/waypoint | Set Autopilot Waypoint |
+| [**postUiOpenwindowContract**](UserInterfaceApi.md#postuiopenwindowcontract) | **POST** /ui/openwindow/contract | Open Contract Window |
+| [**postUiOpenwindowInformation**](UserInterfaceApi.md#postuiopenwindowinformation) | **POST** /ui/openwindow/information | Open Information Window |
+| [**postUiOpenwindowMarketdetails**](UserInterfaceApi.md#postuiopenwindowmarketdetails) | **POST** /ui/openwindow/marketdetails | Open Market Details |
+| [**postUiOpenwindowNewmail**](UserInterfaceApi.md#postuiopenwindownewmailoperation) | **POST** /ui/openwindow/newmail | Open New Mail Window |
+
+
+
+## postUiAutopilotWaypoint
+
+> postUiAutopilotWaypoint(addToBeginning, clearOtherWaypoints, destinationId, xCompatibilityDate, acceptLanguage, ifNoneMatch, xTenant)
+
+Set Autopilot Waypoint
+
+Set a solar system as autopilot waypoint
+
+### Example
+
+```ts
+import {
+  Configuration,
+  UserInterfaceApi,
+} from 'esisl_genoa_client';
+import type { PostUiAutopilotWaypointRequest } 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 UserInterfaceApi(config);
+
+  const body = {
+    // boolean
+    addToBeginning: true,
+    // boolean
+    clearOtherWaypoints: true,
+    // number
+    destinationId: 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 PostUiAutopilotWaypointRequest;
+
+  try {
+    const data = await api.postUiAutopilotWaypoint(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **addToBeginning** | `boolean` |  | [Defaults to `false`] |
+| **clearOtherWaypoints** | `boolean` |  | [Defaults to `false`] |
+| **destinationId** | `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 `'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
+
+`void` (Empty response body)
+
+### 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 |
+|-------------|-------------|------------------|
+| **204** | Open window request received |  * 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)
+
+
+## postUiOpenwindowContract
+
+> postUiOpenwindowContract(contractId, xCompatibilityDate, acceptLanguage, ifNoneMatch, xTenant)
+
+Open Contract Window
+
+Open the contract window inside the client
+
+### Example
+
+```ts
+import {
+  Configuration,
+  UserInterfaceApi,
+} from 'esisl_genoa_client';
+import type { PostUiOpenwindowContractRequest } 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 UserInterfaceApi(config);
+
+  const body = {
+    // number
+    contractId: 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 PostUiOpenwindowContractRequest;
+
+  try {
+    const data = await api.postUiOpenwindowContract(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **contractId** | `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
+
+`void` (Empty response body)
+
+### 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 |
+|-------------|-------------|------------------|
+| **204** | Open window request received |  * 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)
+
+
+## postUiOpenwindowInformation
+
+> postUiOpenwindowInformation(targetId, xCompatibilityDate, acceptLanguage, ifNoneMatch, xTenant)
+
+Open Information Window
+
+Open the information window for a character, corporation or alliance inside the client
+
+### Example
+
+```ts
+import {
+  Configuration,
+  UserInterfaceApi,
+} from 'esisl_genoa_client';
+import type { PostUiOpenwindowInformationRequest } 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 UserInterfaceApi(config);
+
+  const body = {
+    // number
+    targetId: 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 PostUiOpenwindowInformationRequest;
+
+  try {
+    const data = await api.postUiOpenwindowInformation(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **targetId** | `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
+
+`void` (Empty response body)
+
+### 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 |
+|-------------|-------------|------------------|
+| **204** | Open window request received |  * 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)
+
+
+## postUiOpenwindowMarketdetails
+
+> postUiOpenwindowMarketdetails(typeId, xCompatibilityDate, acceptLanguage, ifNoneMatch, xTenant)
+
+Open Market Details
+
+Open the market details window for a specific typeID inside the client
+
+### Example
+
+```ts
+import {
+  Configuration,
+  UserInterfaceApi,
+} from 'esisl_genoa_client';
+import type { PostUiOpenwindowMarketdetailsRequest } 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 UserInterfaceApi(config);
+
+  const body = {
+    // number
+    typeId: 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 PostUiOpenwindowMarketdetailsRequest;
+
+  try {
+    const data = await api.postUiOpenwindowMarketdetails(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **typeId** | `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
+
+`void` (Empty response body)
+
+### 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 |
+|-------------|-------------|------------------|
+| **204** | Open window request received |  * 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)
+
+
+## postUiOpenwindowNewmail
+
+> postUiOpenwindowNewmail(xCompatibilityDate, postUiOpenwindowNewmailRequest, acceptLanguage, ifNoneMatch, xTenant)
+
+Open New Mail Window
+
+Open the New Mail window, according to settings from the request if applicable
+
+### Example
+
+```ts
+import {
+  Configuration,
+  UserInterfaceApi,
+} from 'esisl_genoa_client';
+import type { PostUiOpenwindowNewmailOperationRequest } 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 UserInterfaceApi(config);
+
+  const body = {
+    // '2020-01-01' | The compatibility date for the request.
+    xCompatibilityDate: 2013-10-20,
+    // PostUiOpenwindowNewmailRequest
+    postUiOpenwindowNewmailRequest: ...,
+    // '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 PostUiOpenwindowNewmailOperationRequest;
+
+  try {
+    const data = await api.postUiOpenwindowNewmail(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] |
+| **postUiOpenwindowNewmailRequest** | [PostUiOpenwindowNewmailRequest](PostUiOpenwindowNewmailRequest.md) |  | |
+| **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
+
+`void` (Empty response body)
+
+### 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 |
+|-------------|-------------|------------------|
+| **204** | Open window request received |  * 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)
+