esisl_genoa_client 0.1.0

package/src/apis/PlanetaryInteractionApi.ts

@@ -0,0 +1,523 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * EVE Stable Infrastructure (ESI) - tranquility
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: 2020-01-01
+ * Contact: arcyfa_github@pm.me
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+import * as runtime from '../runtime';
+import api from '../serviceFacade'
+import type {
+  CharactersCharacterIdPlanetsGetInner,
+  CharactersCharacterIdPlanetsPlanetIdGet,
+  CorporationsCorporationIdCustomsOfficesGetInner,
+  UniverseSchematicsSchematicIdGet,
+} from '../models/index';
+
+export interface GetCharactersCharacterIdPlanetsRequest {
+    characterId: number;
+    xCompatibilityDate: GetCharactersCharacterIdPlanetsXCompatibilityDateEnum;
+    acceptLanguage?: GetCharactersCharacterIdPlanetsAcceptLanguageEnum;
+    ifNoneMatch?: string;
+    xTenant?: string;
+}
+
+export interface GetCharactersCharacterIdPlanetsPlanetIdRequest {
+    characterId: number;
+    planetId: number;
+    xCompatibilityDate: GetCharactersCharacterIdPlanetsPlanetIdXCompatibilityDateEnum;
+    acceptLanguage?: GetCharactersCharacterIdPlanetsPlanetIdAcceptLanguageEnum;
+    ifNoneMatch?: string;
+    xTenant?: string;
+}
+
+export interface GetCorporationsCorporationIdCustomsOfficesRequest {
+    corporationId: number;
+    xCompatibilityDate: GetCorporationsCorporationIdCustomsOfficesXCompatibilityDateEnum;
+    page?: number;
+    acceptLanguage?: GetCorporationsCorporationIdCustomsOfficesAcceptLanguageEnum;
+    ifNoneMatch?: string;
+    xTenant?: string;
+}
+
+export interface GetUniverseSchematicsSchematicIdRequest {
+    schematicId: number;
+    xCompatibilityDate: GetUniverseSchematicsSchematicIdXCompatibilityDateEnum;
+    acceptLanguage?: GetUniverseSchematicsSchematicIdAcceptLanguageEnum;
+    ifNoneMatch?: string;
+    xTenant?: string;
+}
+
+/**
+ * PlanetaryInteractionApi - interface
+ * 
+ * @export
+ * @interface PlanetaryInteractionApiInterface
+ */
+export interface PlanetaryInteractionApiInterface {
+    /**
+     * Returns a list of all planetary colonies owned by a character.
+     * @summary Get colonies
+     * @param {number} characterId The ID of the character
+     * @param {'2020-01-01'} xCompatibilityDate The compatibility date for the request.
+     * @param {'en' | 'de' | 'fr' | 'ja' | 'ru' | 'zh' | 'ko' | 'es'} [acceptLanguage] The language to use for the response.
+     * @param {string} [ifNoneMatch] The ETag of the previous request. A 304 will be returned if this matches the current ETag.
+     * @param {string} [xTenant] The tenant ID for the request.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof PlanetaryInteractionApiInterface
+     */
+    getCharactersCharacterIdPlanetsRaw(requestParameters: GetCharactersCharacterIdPlanetsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<CharactersCharacterIdPlanetsGetInner>>>;
+
+    /**
+     * Returns a list of all planetary colonies owned by a character.
+     * Get colonies
+     */
+    getCharactersCharacterIdPlanets(requestParameters: GetCharactersCharacterIdPlanetsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<CharactersCharacterIdPlanetsGetInner>>;
+
+    /**
+     * Returns full details on the layout of a single planetary colony, including links, pins and routes. Note: Planetary information is only recalculated when the colony is viewed through the client. Information will not update until this criteria is met.
+     * @summary Get colony layout
+     * @param {number} characterId The ID of the character
+     * @param {number} planetId 
+     * @param {'2020-01-01'} xCompatibilityDate The compatibility date for the request.
+     * @param {'en' | 'de' | 'fr' | 'ja' | 'ru' | 'zh' | 'ko' | 'es'} [acceptLanguage] The language to use for the response.
+     * @param {string} [ifNoneMatch] The ETag of the previous request. A 304 will be returned if this matches the current ETag.
+     * @param {string} [xTenant] The tenant ID for the request.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof PlanetaryInteractionApiInterface
+     */
+    getCharactersCharacterIdPlanetsPlanetIdRaw(requestParameters: GetCharactersCharacterIdPlanetsPlanetIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CharactersCharacterIdPlanetsPlanetIdGet>>;
+
+    /**
+     * Returns full details on the layout of a single planetary colony, including links, pins and routes. Note: Planetary information is only recalculated when the colony is viewed through the client. Information will not update until this criteria is met.
+     * Get colony layout
+     */
+    getCharactersCharacterIdPlanetsPlanetId(requestParameters: GetCharactersCharacterIdPlanetsPlanetIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CharactersCharacterIdPlanetsPlanetIdGet>;
+
+    /**
+     * List customs offices owned by a corporation
+     * @summary List corporation customs offices
+     * @param {number} corporationId The ID of the corporation
+     * @param {'2020-01-01'} xCompatibilityDate The compatibility date for the request.
+     * @param {number} [page] 
+     * @param {'en' | 'de' | 'fr' | 'ja' | 'ru' | 'zh' | 'ko' | 'es'} [acceptLanguage] The language to use for the response.
+     * @param {string} [ifNoneMatch] The ETag of the previous request. A 304 will be returned if this matches the current ETag.
+     * @param {string} [xTenant] The tenant ID for the request.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof PlanetaryInteractionApiInterface
+     */
+    getCorporationsCorporationIdCustomsOfficesRaw(requestParameters: GetCorporationsCorporationIdCustomsOfficesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<CorporationsCorporationIdCustomsOfficesGetInner>>>;
+
+    /**
+     * List customs offices owned by a corporation
+     * List corporation customs offices
+     */
+    getCorporationsCorporationIdCustomsOffices(requestParameters: GetCorporationsCorporationIdCustomsOfficesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<CorporationsCorporationIdCustomsOfficesGetInner>>;
+
+    /**
+     * Get information on a planetary factory schematic
+     * @summary Get schematic information
+     * @param {number} schematicId 
+     * @param {'2020-01-01'} xCompatibilityDate The compatibility date for the request.
+     * @param {'en' | 'de' | 'fr' | 'ja' | 'ru' | 'zh' | 'ko' | 'es'} [acceptLanguage] The language to use for the response.
+     * @param {string} [ifNoneMatch] The ETag of the previous request. A 304 will be returned if this matches the current ETag.
+     * @param {string} [xTenant] The tenant ID for the request.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof PlanetaryInteractionApiInterface
+     */
+    getUniverseSchematicsSchematicIdRaw(requestParameters: GetUniverseSchematicsSchematicIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<UniverseSchematicsSchematicIdGet>>;
+
+    /**
+     * Get information on a planetary factory schematic
+     * Get schematic information
+     */
+    getUniverseSchematicsSchematicId(requestParameters: GetUniverseSchematicsSchematicIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UniverseSchematicsSchematicIdGet>;
+
+}
+
+/**
+ * 
+ */
+export class PlanetaryInteractionApi extends runtime.BaseAPI implements PlanetaryInteractionApiInterface {
+
+    /**
+     * Returns a list of all planetary colonies owned by a character.
+     * Get colonies
+     */
+    async getCharactersCharacterIdPlanetsRaw(requestParameters: GetCharactersCharacterIdPlanetsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<CharactersCharacterIdPlanetsGetInner>>> {
+        if (requestParameters['characterId'] == null) {
+            throw new runtime.RequiredError(
+                'characterId',
+                'Required parameter "characterId" was null or undefined when calling getCharactersCharacterIdPlanets().'
+            );
+        }
+
+        if (requestParameters['xCompatibilityDate'] == null) {
+            throw new runtime.RequiredError(
+                'xCompatibilityDate',
+                'Required parameter "xCompatibilityDate" was null or undefined when calling getCharactersCharacterIdPlanets().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (requestParameters['acceptLanguage'] != null) {
+            headerParameters['Accept-Language'] = String(requestParameters['acceptLanguage']);
+        }
+
+        if (requestParameters['ifNoneMatch'] != null) {
+            headerParameters['If-None-Match'] = String(requestParameters['ifNoneMatch']);
+        }
+
+        if (requestParameters['xCompatibilityDate'] != null) {
+            headerParameters['X-Compatibility-Date'] = String(requestParameters['xCompatibilityDate']);
+        }
+
+        if (requestParameters['xTenant'] != null) {
+            headerParameters['X-Tenant'] = String(requestParameters['xTenant']);
+        }
+
+        /*
+        if (this.configuration && this.configuration.accessToken) {
+            // oauth required
+            headerParameters["Authorization"] = await this.configuration.accessToken("OAuth2", ["esi-planets.manage_planets.v1"]);
+        }
+
+        */
+
+        let urlPath = `/characters/{character_id}/planets`;
+        urlPath = urlPath.replace(`{${"character_id"}}`, encodeURIComponent(String(requestParameters['characterId'])));
+
+        const response = await api.esi.proxy({
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response);
+    }
+
+    /**
+     * Returns a list of all planetary colonies owned by a character.
+     * Get colonies
+     */
+    async getCharactersCharacterIdPlanets(requestParameters: GetCharactersCharacterIdPlanetsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<CharactersCharacterIdPlanetsGetInner>> {
+        const response = await this.getCharactersCharacterIdPlanetsRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Returns full details on the layout of a single planetary colony, including links, pins and routes. Note: Planetary information is only recalculated when the colony is viewed through the client. Information will not update until this criteria is met.
+     * Get colony layout
+     */
+    async getCharactersCharacterIdPlanetsPlanetIdRaw(requestParameters: GetCharactersCharacterIdPlanetsPlanetIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CharactersCharacterIdPlanetsPlanetIdGet>> {
+        if (requestParameters['characterId'] == null) {
+            throw new runtime.RequiredError(
+                'characterId',
+                'Required parameter "characterId" was null or undefined when calling getCharactersCharacterIdPlanetsPlanetId().'
+            );
+        }
+
+        if (requestParameters['planetId'] == null) {
+            throw new runtime.RequiredError(
+                'planetId',
+                'Required parameter "planetId" was null or undefined when calling getCharactersCharacterIdPlanetsPlanetId().'
+            );
+        }
+
+        if (requestParameters['xCompatibilityDate'] == null) {
+            throw new runtime.RequiredError(
+                'xCompatibilityDate',
+                'Required parameter "xCompatibilityDate" was null or undefined when calling getCharactersCharacterIdPlanetsPlanetId().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (requestParameters['acceptLanguage'] != null) {
+            headerParameters['Accept-Language'] = String(requestParameters['acceptLanguage']);
+        }
+
+        if (requestParameters['ifNoneMatch'] != null) {
+            headerParameters['If-None-Match'] = String(requestParameters['ifNoneMatch']);
+        }
+
+        if (requestParameters['xCompatibilityDate'] != null) {
+            headerParameters['X-Compatibility-Date'] = String(requestParameters['xCompatibilityDate']);
+        }
+
+        if (requestParameters['xTenant'] != null) {
+            headerParameters['X-Tenant'] = String(requestParameters['xTenant']);
+        }
+
+        /*
+        if (this.configuration && this.configuration.accessToken) {
+            // oauth required
+            headerParameters["Authorization"] = await this.configuration.accessToken("OAuth2", ["esi-planets.manage_planets.v1"]);
+        }
+
+        */
+
+        let urlPath = `/characters/{character_id}/planets/{planet_id}`;
+        urlPath = urlPath.replace(`{${"character_id"}}`, encodeURIComponent(String(requestParameters['characterId'])));
+        urlPath = urlPath.replace(`{${"planet_id"}}`, encodeURIComponent(String(requestParameters['planetId'])));
+
+        const response = await api.esi.proxy({
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response);
+    }
+
+    /**
+     * Returns full details on the layout of a single planetary colony, including links, pins and routes. Note: Planetary information is only recalculated when the colony is viewed through the client. Information will not update until this criteria is met.
+     * Get colony layout
+     */
+    async getCharactersCharacterIdPlanetsPlanetId(requestParameters: GetCharactersCharacterIdPlanetsPlanetIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CharactersCharacterIdPlanetsPlanetIdGet> {
+        const response = await this.getCharactersCharacterIdPlanetsPlanetIdRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * List customs offices owned by a corporation
+     * List corporation customs offices
+     */
+    async getCorporationsCorporationIdCustomsOfficesRaw(requestParameters: GetCorporationsCorporationIdCustomsOfficesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<CorporationsCorporationIdCustomsOfficesGetInner>>> {
+        if (requestParameters['corporationId'] == null) {
+            throw new runtime.RequiredError(
+                'corporationId',
+                'Required parameter "corporationId" was null or undefined when calling getCorporationsCorporationIdCustomsOffices().'
+            );
+        }
+
+        if (requestParameters['xCompatibilityDate'] == null) {
+            throw new runtime.RequiredError(
+                'xCompatibilityDate',
+                'Required parameter "xCompatibilityDate" was null or undefined when calling getCorporationsCorporationIdCustomsOffices().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        if (requestParameters['page'] != null) {
+            queryParameters['page'] = requestParameters['page'];
+        }
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (requestParameters['acceptLanguage'] != null) {
+            headerParameters['Accept-Language'] = String(requestParameters['acceptLanguage']);
+        }
+
+        if (requestParameters['ifNoneMatch'] != null) {
+            headerParameters['If-None-Match'] = String(requestParameters['ifNoneMatch']);
+        }
+
+        if (requestParameters['xCompatibilityDate'] != null) {
+            headerParameters['X-Compatibility-Date'] = String(requestParameters['xCompatibilityDate']);
+        }
+
+        if (requestParameters['xTenant'] != null) {
+            headerParameters['X-Tenant'] = String(requestParameters['xTenant']);
+        }
+
+        /*
+        if (this.configuration && this.configuration.accessToken) {
+            // oauth required
+            headerParameters["Authorization"] = await this.configuration.accessToken("OAuth2", ["esi-planets.read_customs_offices.v1"]);
+        }
+
+        */
+
+        let urlPath = `/corporations/{corporation_id}/customs_offices`;
+        urlPath = urlPath.replace(`{${"corporation_id"}}`, encodeURIComponent(String(requestParameters['corporationId'])));
+
+        const response = await api.esi.proxy({
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response);
+    }
+
+    /**
+     * List customs offices owned by a corporation
+     * List corporation customs offices
+     */
+    async getCorporationsCorporationIdCustomsOffices(requestParameters: GetCorporationsCorporationIdCustomsOfficesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<CorporationsCorporationIdCustomsOfficesGetInner>> {
+        const response = await this.getCorporationsCorporationIdCustomsOfficesRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Get information on a planetary factory schematic
+     * Get schematic information
+     */
+    async getUniverseSchematicsSchematicIdRaw(requestParameters: GetUniverseSchematicsSchematicIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<UniverseSchematicsSchematicIdGet>> {
+        if (requestParameters['schematicId'] == null) {
+            throw new runtime.RequiredError(
+                'schematicId',
+                'Required parameter "schematicId" was null or undefined when calling getUniverseSchematicsSchematicId().'
+            );
+        }
+
+        if (requestParameters['xCompatibilityDate'] == null) {
+            throw new runtime.RequiredError(
+                'xCompatibilityDate',
+                'Required parameter "xCompatibilityDate" was null or undefined when calling getUniverseSchematicsSchematicId().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (requestParameters['acceptLanguage'] != null) {
+            headerParameters['Accept-Language'] = String(requestParameters['acceptLanguage']);
+        }
+
+        if (requestParameters['ifNoneMatch'] != null) {
+            headerParameters['If-None-Match'] = String(requestParameters['ifNoneMatch']);
+        }
+
+        if (requestParameters['xCompatibilityDate'] != null) {
+            headerParameters['X-Compatibility-Date'] = String(requestParameters['xCompatibilityDate']);
+        }
+
+        if (requestParameters['xTenant'] != null) {
+            headerParameters['X-Tenant'] = String(requestParameters['xTenant']);
+        }
+
+        /*
+        */
+
+        let urlPath = `/universe/schematics/{schematic_id}`;
+        urlPath = urlPath.replace(`{${"schematic_id"}}`, encodeURIComponent(String(requestParameters['schematicId'])));
+
+        const response = await api.esi.proxy({
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response);
+    }
+
+    /**
+     * Get information on a planetary factory schematic
+     * Get schematic information
+     */
+    async getUniverseSchematicsSchematicId(requestParameters: GetUniverseSchematicsSchematicIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UniverseSchematicsSchematicIdGet> {
+        const response = await this.getUniverseSchematicsSchematicIdRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+}
+
+/**
+  * @export
+  * @enum {string}
+  */
+export enum GetCharactersCharacterIdPlanetsXCompatibilityDateEnum {
+    _20200101 = '2020-01-01'
+}
+/**
+  * @export
+  * @enum {string}
+  */
+export enum GetCharactersCharacterIdPlanetsAcceptLanguageEnum {
+    En = 'en',
+    De = 'de',
+    Fr = 'fr',
+    Ja = 'ja',
+    Ru = 'ru',
+    Zh = 'zh',
+    Ko = 'ko',
+    Es = 'es'
+}
+/**
+  * @export
+  * @enum {string}
+  */
+export enum GetCharactersCharacterIdPlanetsPlanetIdXCompatibilityDateEnum {
+    _20200101 = '2020-01-01'
+}
+/**
+  * @export
+  * @enum {string}
+  */
+export enum GetCharactersCharacterIdPlanetsPlanetIdAcceptLanguageEnum {
+    En = 'en',
+    De = 'de',
+    Fr = 'fr',
+    Ja = 'ja',
+    Ru = 'ru',
+    Zh = 'zh',
+    Ko = 'ko',
+    Es = 'es'
+}
+/**
+  * @export
+  * @enum {string}
+  */
+export enum GetCorporationsCorporationIdCustomsOfficesXCompatibilityDateEnum {
+    _20200101 = '2020-01-01'
+}
+/**
+  * @export
+  * @enum {string}
+  */
+export enum GetCorporationsCorporationIdCustomsOfficesAcceptLanguageEnum {
+    En = 'en',
+    De = 'de',
+    Fr = 'fr',
+    Ja = 'ja',
+    Ru = 'ru',
+    Zh = 'zh',
+    Ko = 'ko',
+    Es = 'es'
+}
+/**
+  * @export
+  * @enum {string}
+  */
+export enum GetUniverseSchematicsSchematicIdXCompatibilityDateEnum {
+    _20200101 = '2020-01-01'
+}
+/**
+  * @export
+  * @enum {string}
+  */
+export enum GetUniverseSchematicsSchematicIdAcceptLanguageEnum {
+    En = 'en',
+    De = 'de',
+    Fr = 'fr',
+    Ja = 'ja',
+    Ru = 'ru',
+    Zh = 'zh',
+    Ko = 'ko',
+    Es = 'es'
+}