UNPKG

@fnt-eve/esi-client-typescript

Version:

[![npm version](https://img.shields.io/npm/v/@fnt-eve/esi-client-typescript)](https://www.npmjs.com/package/@fnt-eve/esi-client-typescript)

385 lines (384 loc) 19.2 kB
/* tslint:disable */ /* eslint-disable */ /** * EVE Swagger Interface * An OpenAPI for EVE Online * * The version of the OpenAPI document: 1.36 * * * 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 { GetCharactersCharacterIdIndustryJobs200OkFromJSON, GetCharactersCharacterIdMining200OkFromJSON, GetCorporationCorporationIdMiningExtractions200OkFromJSON, GetCorporationCorporationIdMiningObservers200OkFromJSON, GetCorporationCorporationIdMiningObserversObserverId200OkFromJSON, GetCorporationsCorporationIdIndustryJobs200OkFromJSON, GetIndustryFacilities200OkFromJSON, GetIndustrySystems200OkFromJSON, } from '../models/index'; /** * */ export class IndustryApi extends runtime.BaseAPI { /** * List industry jobs placed by a character --- This route is cached for up to 300 seconds * List character industry jobs */ async getCharactersCharacterIdIndustryJobsRaw(requestParameters, initOverrides) { if (requestParameters['characterId'] == null) { throw new runtime.RequiredError('characterId', 'Required parameter "characterId" was null or undefined when calling getCharactersCharacterIdIndustryJobs().'); } const queryParameters = {}; if (requestParameters['datasource'] != null) { queryParameters['datasource'] = requestParameters['datasource']; } if (requestParameters['includeCompleted'] != null) { queryParameters['include_completed'] = requestParameters['includeCompleted']; } if (requestParameters['token'] != null) { queryParameters['token'] = requestParameters['token']; } const headerParameters = {}; if (requestParameters['ifNoneMatch'] != null) { headerParameters['If-None-Match'] = String(requestParameters['ifNoneMatch']); } if (this.configuration && this.configuration.accessToken) { // oauth required headerParameters["Authorization"] = await this.configuration.accessToken("evesso", ["esi-industry.read_character_jobs.v1"]); } const response = await this.request({ path: `/v1/characters/{character_id}/industry/jobs/`.replace(`{${"character_id"}}`, encodeURIComponent(String(requestParameters['characterId']))), method: 'GET', headers: headerParameters, query: queryParameters, }, initOverrides); return new runtime.JSONApiResponse(response, (jsonValue) => jsonValue.map(GetCharactersCharacterIdIndustryJobs200OkFromJSON)); } /** * List industry jobs placed by a character --- This route is cached for up to 300 seconds * List character industry jobs */ async getCharactersCharacterIdIndustryJobs(requestParameters, initOverrides) { const response = await this.getCharactersCharacterIdIndustryJobsRaw(requestParameters, initOverrides); return await response.value(); } /** * Paginated record of all mining done by a character for the past 30 days --- This route is cached for up to 600 seconds * Character mining ledger */ async getCharactersCharacterIdMiningRaw(requestParameters, initOverrides) { if (requestParameters['characterId'] == null) { throw new runtime.RequiredError('characterId', 'Required parameter "characterId" was null or undefined when calling getCharactersCharacterIdMining().'); } const queryParameters = {}; if (requestParameters['datasource'] != null) { queryParameters['datasource'] = requestParameters['datasource']; } if (requestParameters['page'] != null) { queryParameters['page'] = requestParameters['page']; } if (requestParameters['token'] != null) { queryParameters['token'] = requestParameters['token']; } const headerParameters = {}; if (requestParameters['ifNoneMatch'] != null) { headerParameters['If-None-Match'] = String(requestParameters['ifNoneMatch']); } if (this.configuration && this.configuration.accessToken) { // oauth required headerParameters["Authorization"] = await this.configuration.accessToken("evesso", ["esi-industry.read_character_mining.v1"]); } const response = await this.request({ path: `/v1/characters/{character_id}/mining/`.replace(`{${"character_id"}}`, encodeURIComponent(String(requestParameters['characterId']))), method: 'GET', headers: headerParameters, query: queryParameters, }, initOverrides); return new runtime.JSONApiResponse(response, (jsonValue) => jsonValue.map(GetCharactersCharacterIdMining200OkFromJSON)); } /** * Paginated record of all mining done by a character for the past 30 days --- This route is cached for up to 600 seconds * Character mining ledger */ async getCharactersCharacterIdMining(requestParameters, initOverrides) { const response = await this.getCharactersCharacterIdMiningRaw(requestParameters, initOverrides); return await response.value(); } /** * Extraction timers for all moon chunks being extracted by refineries belonging to a corporation. --- This route is cached for up to 1800 seconds --- Requires one of the following EVE corporation role(s): Station_Manager * Moon extraction timers */ async getCorporationCorporationIdMiningExtractionsRaw(requestParameters, initOverrides) { if (requestParameters['corporationId'] == null) { throw new runtime.RequiredError('corporationId', 'Required parameter "corporationId" was null or undefined when calling getCorporationCorporationIdMiningExtractions().'); } const queryParameters = {}; if (requestParameters['datasource'] != null) { queryParameters['datasource'] = requestParameters['datasource']; } if (requestParameters['page'] != null) { queryParameters['page'] = requestParameters['page']; } if (requestParameters['token'] != null) { queryParameters['token'] = requestParameters['token']; } const headerParameters = {}; if (requestParameters['ifNoneMatch'] != null) { headerParameters['If-None-Match'] = String(requestParameters['ifNoneMatch']); } if (this.configuration && this.configuration.accessToken) { // oauth required headerParameters["Authorization"] = await this.configuration.accessToken("evesso", ["esi-industry.read_corporation_mining.v1"]); } const response = await this.request({ path: `/v1/corporation/{corporation_id}/mining/extractions/`.replace(`{${"corporation_id"}}`, encodeURIComponent(String(requestParameters['corporationId']))), method: 'GET', headers: headerParameters, query: queryParameters, }, initOverrides); return new runtime.JSONApiResponse(response, (jsonValue) => jsonValue.map(GetCorporationCorporationIdMiningExtractions200OkFromJSON)); } /** * Extraction timers for all moon chunks being extracted by refineries belonging to a corporation. --- This route is cached for up to 1800 seconds --- Requires one of the following EVE corporation role(s): Station_Manager * Moon extraction timers */ async getCorporationCorporationIdMiningExtractions(requestParameters, initOverrides) { const response = await this.getCorporationCorporationIdMiningExtractionsRaw(requestParameters, initOverrides); return await response.value(); } /** * Paginated list of all entities capable of observing and recording mining for a corporation --- This route is cached for up to 3600 seconds --- Requires one of the following EVE corporation role(s): Accountant * Corporation mining observers */ async getCorporationCorporationIdMiningObserversRaw(requestParameters, initOverrides) { if (requestParameters['corporationId'] == null) { throw new runtime.RequiredError('corporationId', 'Required parameter "corporationId" was null or undefined when calling getCorporationCorporationIdMiningObservers().'); } const queryParameters = {}; if (requestParameters['datasource'] != null) { queryParameters['datasource'] = requestParameters['datasource']; } if (requestParameters['page'] != null) { queryParameters['page'] = requestParameters['page']; } if (requestParameters['token'] != null) { queryParameters['token'] = requestParameters['token']; } const headerParameters = {}; if (requestParameters['ifNoneMatch'] != null) { headerParameters['If-None-Match'] = String(requestParameters['ifNoneMatch']); } if (this.configuration && this.configuration.accessToken) { // oauth required headerParameters["Authorization"] = await this.configuration.accessToken("evesso", ["esi-industry.read_corporation_mining.v1"]); } const response = await this.request({ path: `/v1/corporation/{corporation_id}/mining/observers/`.replace(`{${"corporation_id"}}`, encodeURIComponent(String(requestParameters['corporationId']))), method: 'GET', headers: headerParameters, query: queryParameters, }, initOverrides); return new runtime.JSONApiResponse(response, (jsonValue) => jsonValue.map(GetCorporationCorporationIdMiningObservers200OkFromJSON)); } /** * Paginated list of all entities capable of observing and recording mining for a corporation --- This route is cached for up to 3600 seconds --- Requires one of the following EVE corporation role(s): Accountant * Corporation mining observers */ async getCorporationCorporationIdMiningObservers(requestParameters, initOverrides) { const response = await this.getCorporationCorporationIdMiningObserversRaw(requestParameters, initOverrides); return await response.value(); } /** * Paginated record of all mining seen by an observer --- This route is cached for up to 3600 seconds --- Requires one of the following EVE corporation role(s): Accountant * Observed corporation mining */ async getCorporationCorporationIdMiningObserversObserverIdRaw(requestParameters, initOverrides) { if (requestParameters['corporationId'] == null) { throw new runtime.RequiredError('corporationId', 'Required parameter "corporationId" was null or undefined when calling getCorporationCorporationIdMiningObserversObserverId().'); } if (requestParameters['observerId'] == null) { throw new runtime.RequiredError('observerId', 'Required parameter "observerId" was null or undefined when calling getCorporationCorporationIdMiningObserversObserverId().'); } const queryParameters = {}; if (requestParameters['datasource'] != null) { queryParameters['datasource'] = requestParameters['datasource']; } if (requestParameters['page'] != null) { queryParameters['page'] = requestParameters['page']; } if (requestParameters['token'] != null) { queryParameters['token'] = requestParameters['token']; } const headerParameters = {}; if (requestParameters['ifNoneMatch'] != null) { headerParameters['If-None-Match'] = String(requestParameters['ifNoneMatch']); } if (this.configuration && this.configuration.accessToken) { // oauth required headerParameters["Authorization"] = await this.configuration.accessToken("evesso", ["esi-industry.read_corporation_mining.v1"]); } const response = await this.request({ path: `/v1/corporation/{corporation_id}/mining/observers/{observer_id}/`.replace(`{${"corporation_id"}}`, encodeURIComponent(String(requestParameters['corporationId']))).replace(`{${"observer_id"}}`, encodeURIComponent(String(requestParameters['observerId']))), method: 'GET', headers: headerParameters, query: queryParameters, }, initOverrides); return new runtime.JSONApiResponse(response, (jsonValue) => jsonValue.map(GetCorporationCorporationIdMiningObserversObserverId200OkFromJSON)); } /** * Paginated record of all mining seen by an observer --- This route is cached for up to 3600 seconds --- Requires one of the following EVE corporation role(s): Accountant * Observed corporation mining */ async getCorporationCorporationIdMiningObserversObserverId(requestParameters, initOverrides) { const response = await this.getCorporationCorporationIdMiningObserversObserverIdRaw(requestParameters, initOverrides); return await response.value(); } /** * List industry jobs run by a corporation --- This route is cached for up to 300 seconds --- Requires one of the following EVE corporation role(s): Factory_Manager * List corporation industry jobs */ async getCorporationsCorporationIdIndustryJobsRaw(requestParameters, initOverrides) { if (requestParameters['corporationId'] == null) { throw new runtime.RequiredError('corporationId', 'Required parameter "corporationId" was null or undefined when calling getCorporationsCorporationIdIndustryJobs().'); } const queryParameters = {}; if (requestParameters['datasource'] != null) { queryParameters['datasource'] = requestParameters['datasource']; } if (requestParameters['includeCompleted'] != null) { queryParameters['include_completed'] = requestParameters['includeCompleted']; } if (requestParameters['page'] != null) { queryParameters['page'] = requestParameters['page']; } if (requestParameters['token'] != null) { queryParameters['token'] = requestParameters['token']; } const headerParameters = {}; if (requestParameters['ifNoneMatch'] != null) { headerParameters['If-None-Match'] = String(requestParameters['ifNoneMatch']); } if (this.configuration && this.configuration.accessToken) { // oauth required headerParameters["Authorization"] = await this.configuration.accessToken("evesso", ["esi-industry.read_corporation_jobs.v1"]); } const response = await this.request({ path: `/v1/corporations/{corporation_id}/industry/jobs/`.replace(`{${"corporation_id"}}`, encodeURIComponent(String(requestParameters['corporationId']))), method: 'GET', headers: headerParameters, query: queryParameters, }, initOverrides); return new runtime.JSONApiResponse(response, (jsonValue) => jsonValue.map(GetCorporationsCorporationIdIndustryJobs200OkFromJSON)); } /** * List industry jobs run by a corporation --- This route is cached for up to 300 seconds --- Requires one of the following EVE corporation role(s): Factory_Manager * List corporation industry jobs */ async getCorporationsCorporationIdIndustryJobs(requestParameters, initOverrides) { const response = await this.getCorporationsCorporationIdIndustryJobsRaw(requestParameters, initOverrides); return await response.value(); } /** * Return a list of industry facilities --- This route is cached for up to 3600 seconds * List industry facilities */ async getIndustryFacilitiesRaw(requestParameters, initOverrides) { const queryParameters = {}; if (requestParameters['datasource'] != null) { queryParameters['datasource'] = requestParameters['datasource']; } const headerParameters = {}; if (requestParameters['ifNoneMatch'] != null) { headerParameters['If-None-Match'] = String(requestParameters['ifNoneMatch']); } const response = await this.request({ path: `/v1/industry/facilities/`, method: 'GET', headers: headerParameters, query: queryParameters, }, initOverrides); return new runtime.JSONApiResponse(response, (jsonValue) => jsonValue.map(GetIndustryFacilities200OkFromJSON)); } /** * Return a list of industry facilities --- This route is cached for up to 3600 seconds * List industry facilities */ async getIndustryFacilities(requestParameters = {}, initOverrides) { const response = await this.getIndustryFacilitiesRaw(requestParameters, initOverrides); return await response.value(); } /** * Return cost indices for solar systems --- This route is cached for up to 3600 seconds * List solar system cost indices */ async getIndustrySystemsRaw(requestParameters, initOverrides) { const queryParameters = {}; if (requestParameters['datasource'] != null) { queryParameters['datasource'] = requestParameters['datasource']; } const headerParameters = {}; if (requestParameters['ifNoneMatch'] != null) { headerParameters['If-None-Match'] = String(requestParameters['ifNoneMatch']); } const response = await this.request({ path: `/v1/industry/systems/`, method: 'GET', headers: headerParameters, query: queryParameters, }, initOverrides); return new runtime.JSONApiResponse(response, (jsonValue) => jsonValue.map(GetIndustrySystems200OkFromJSON)); } /** * Return cost indices for solar systems --- This route is cached for up to 3600 seconds * List solar system cost indices */ async getIndustrySystems(requestParameters = {}, initOverrides) { const response = await this.getIndustrySystemsRaw(requestParameters, initOverrides); return await response.value(); } } /** * @export */ export const GetCharactersCharacterIdIndustryJobsDatasourceEnum = { Tranquility: 'tranquility' }; /** * @export */ export const GetCharactersCharacterIdMiningDatasourceEnum = { Tranquility: 'tranquility' }; /** * @export */ export const GetCorporationCorporationIdMiningExtractionsDatasourceEnum = { Tranquility: 'tranquility' }; /** * @export */ export const GetCorporationCorporationIdMiningObserversDatasourceEnum = { Tranquility: 'tranquility' }; /** * @export */ export const GetCorporationCorporationIdMiningObserversObserverIdDatasourceEnum = { Tranquility: 'tranquility' }; /** * @export */ export const GetCorporationsCorporationIdIndustryJobsDatasourceEnum = { Tranquility: 'tranquility' }; /** * @export */ export const GetIndustryFacilitiesDatasourceEnum = { Tranquility: 'tranquility' }; /** * @export */ export const GetIndustrySystemsDatasourceEnum = { Tranquility: 'tranquility' };