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)

632 lines (631 loc) 30.8 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 { GetCharactersCharacterIdAgentsResearch200OkFromJSON, GetCharactersCharacterIdBlueprints200OkFromJSON, GetCharactersCharacterIdCorporationhistory200OkFromJSON, GetCharactersCharacterIdFatigueOkFromJSON, GetCharactersCharacterIdMedals200OkFromJSON, GetCharactersCharacterIdNotifications200OkFromJSON, GetCharactersCharacterIdNotificationsContacts200OkFromJSON, GetCharactersCharacterIdOkFromJSON, GetCharactersCharacterIdPortraitOkFromJSON, GetCharactersCharacterIdRolesOkFromJSON, GetCharactersCharacterIdStandings200OkFromJSON, GetCharactersCharacterIdTitles200OkFromJSON, PostCharactersAffiliation200OkFromJSON, } from '../models/index'; /** * */ export class CharacterApi extends runtime.BaseAPI { /** * Public information about a character --- This route is cached for up to 604800 seconds * Get character\'s public information */ async getCharactersCharacterIdRaw(requestParameters, initOverrides) { if (requestParameters['characterId'] == null) { throw new runtime.RequiredError('characterId', 'Required parameter "characterId" was null or undefined when calling getCharactersCharacterId().'); } 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: `/v5/characters/{character_id}/`.replace(`{${"character_id"}}`, encodeURIComponent(String(requestParameters['characterId']))), method: 'GET', headers: headerParameters, query: queryParameters, }, initOverrides); return new runtime.JSONApiResponse(response, (jsonValue) => GetCharactersCharacterIdOkFromJSON(jsonValue)); } /** * Public information about a character --- This route is cached for up to 604800 seconds * Get character\'s public information */ async getCharactersCharacterId(requestParameters, initOverrides) { const response = await this.getCharactersCharacterIdRaw(requestParameters, initOverrides); return await response.value(); } /** * Return a list of agents research information for a character. The formula for finding the current research points with an agent is: currentPoints = remainderPoints + pointsPerDay * days(currentTime - researchStartDate) --- This route is cached for up to 3600 seconds * Get agents research */ async getCharactersCharacterIdAgentsResearchRaw(requestParameters, initOverrides) { if (requestParameters['characterId'] == null) { throw new runtime.RequiredError('characterId', 'Required parameter "characterId" was null or undefined when calling getCharactersCharacterIdAgentsResearch().'); } const queryParameters = {}; if (requestParameters['datasource'] != null) { queryParameters['datasource'] = requestParameters['datasource']; } 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-characters.read_agents_research.v1"]); } const response = await this.request({ path: `/v1/characters/{character_id}/agents_research/`.replace(`{${"character_id"}}`, encodeURIComponent(String(requestParameters['characterId']))), method: 'GET', headers: headerParameters, query: queryParameters, }, initOverrides); return new runtime.JSONApiResponse(response, (jsonValue) => jsonValue.map(GetCharactersCharacterIdAgentsResearch200OkFromJSON)); } /** * Return a list of agents research information for a character. The formula for finding the current research points with an agent is: currentPoints = remainderPoints + pointsPerDay * days(currentTime - researchStartDate) --- This route is cached for up to 3600 seconds * Get agents research */ async getCharactersCharacterIdAgentsResearch(requestParameters, initOverrides) { const response = await this.getCharactersCharacterIdAgentsResearchRaw(requestParameters, initOverrides); return await response.value(); } /** * Return a list of blueprints the character owns --- This route is cached for up to 3600 seconds * Get blueprints */ async getCharactersCharacterIdBlueprintsRaw(requestParameters, initOverrides) { if (requestParameters['characterId'] == null) { throw new runtime.RequiredError('characterId', 'Required parameter "characterId" was null or undefined when calling getCharactersCharacterIdBlueprints().'); } 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-characters.read_blueprints.v1"]); } const response = await this.request({ path: `/v2/characters/{character_id}/blueprints/`.replace(`{${"character_id"}}`, encodeURIComponent(String(requestParameters['characterId']))), method: 'GET', headers: headerParameters, query: queryParameters, }, initOverrides); return new runtime.JSONApiResponse(response, (jsonValue) => jsonValue.map(GetCharactersCharacterIdBlueprints200OkFromJSON)); } /** * Return a list of blueprints the character owns --- This route is cached for up to 3600 seconds * Get blueprints */ async getCharactersCharacterIdBlueprints(requestParameters, initOverrides) { const response = await this.getCharactersCharacterIdBlueprintsRaw(requestParameters, initOverrides); return await response.value(); } /** * Get a list of all the corporations a character has been a member of --- This route is cached for up to 86400 seconds * Get corporation history */ async getCharactersCharacterIdCorporationhistoryRaw(requestParameters, initOverrides) { if (requestParameters['characterId'] == null) { throw new runtime.RequiredError('characterId', 'Required parameter "characterId" was null or undefined when calling getCharactersCharacterIdCorporationhistory().'); } 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/characters/{character_id}/corporationhistory/`.replace(`{${"character_id"}}`, encodeURIComponent(String(requestParameters['characterId']))), method: 'GET', headers: headerParameters, query: queryParameters, }, initOverrides); return new runtime.JSONApiResponse(response, (jsonValue) => jsonValue.map(GetCharactersCharacterIdCorporationhistory200OkFromJSON)); } /** * Get a list of all the corporations a character has been a member of --- This route is cached for up to 86400 seconds * Get corporation history */ async getCharactersCharacterIdCorporationhistory(requestParameters, initOverrides) { const response = await this.getCharactersCharacterIdCorporationhistoryRaw(requestParameters, initOverrides); return await response.value(); } /** * Return a character\'s jump activation and fatigue information --- This route is cached for up to 300 seconds * Get jump fatigue */ async getCharactersCharacterIdFatigueRaw(requestParameters, initOverrides) { if (requestParameters['characterId'] == null) { throw new runtime.RequiredError('characterId', 'Required parameter "characterId" was null or undefined when calling getCharactersCharacterIdFatigue().'); } const queryParameters = {}; if (requestParameters['datasource'] != null) { queryParameters['datasource'] = requestParameters['datasource']; } 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-characters.read_fatigue.v1"]); } const response = await this.request({ path: `/v1/characters/{character_id}/fatigue/`.replace(`{${"character_id"}}`, encodeURIComponent(String(requestParameters['characterId']))), method: 'GET', headers: headerParameters, query: queryParameters, }, initOverrides); return new runtime.JSONApiResponse(response, (jsonValue) => GetCharactersCharacterIdFatigueOkFromJSON(jsonValue)); } /** * Return a character\'s jump activation and fatigue information --- This route is cached for up to 300 seconds * Get jump fatigue */ async getCharactersCharacterIdFatigue(requestParameters, initOverrides) { const response = await this.getCharactersCharacterIdFatigueRaw(requestParameters, initOverrides); return await response.value(); } /** * Return a list of medals the character has --- This route is cached for up to 3600 seconds * Get medals */ async getCharactersCharacterIdMedalsRaw(requestParameters, initOverrides) { if (requestParameters['characterId'] == null) { throw new runtime.RequiredError('characterId', 'Required parameter "characterId" was null or undefined when calling getCharactersCharacterIdMedals().'); } const queryParameters = {}; if (requestParameters['datasource'] != null) { queryParameters['datasource'] = requestParameters['datasource']; } 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-characters.read_medals.v1"]); } const response = await this.request({ path: `/v1/characters/{character_id}/medals/`.replace(`{${"character_id"}}`, encodeURIComponent(String(requestParameters['characterId']))), method: 'GET', headers: headerParameters, query: queryParameters, }, initOverrides); return new runtime.JSONApiResponse(response, (jsonValue) => jsonValue.map(GetCharactersCharacterIdMedals200OkFromJSON)); } /** * Return a list of medals the character has --- This route is cached for up to 3600 seconds * Get medals */ async getCharactersCharacterIdMedals(requestParameters, initOverrides) { const response = await this.getCharactersCharacterIdMedalsRaw(requestParameters, initOverrides); return await response.value(); } /** * Return character notifications --- This route is cached for up to 600 seconds * Get character notifications */ async getCharactersCharacterIdNotificationsRaw(requestParameters, initOverrides) { if (requestParameters['characterId'] == null) { throw new runtime.RequiredError('characterId', 'Required parameter "characterId" was null or undefined when calling getCharactersCharacterIdNotifications().'); } const queryParameters = {}; if (requestParameters['datasource'] != null) { queryParameters['datasource'] = requestParameters['datasource']; } 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-characters.read_notifications.v1"]); } const response = await this.request({ path: `/v4/characters/{character_id}/notifications/`.replace(`{${"character_id"}}`, encodeURIComponent(String(requestParameters['characterId']))), method: 'GET', headers: headerParameters, query: queryParameters, }, initOverrides); return new runtime.JSONApiResponse(response, (jsonValue) => jsonValue.map(GetCharactersCharacterIdNotifications200OkFromJSON)); } /** * Return character notifications --- This route is cached for up to 600 seconds * Get character notifications */ async getCharactersCharacterIdNotifications(requestParameters, initOverrides) { const response = await this.getCharactersCharacterIdNotificationsRaw(requestParameters, initOverrides); return await response.value(); } /** * Return notifications about having been added to someone\'s contact list --- This route is cached for up to 600 seconds * Get new contact notifications */ async getCharactersCharacterIdNotificationsContactsRaw(requestParameters, initOverrides) { if (requestParameters['characterId'] == null) { throw new runtime.RequiredError('characterId', 'Required parameter "characterId" was null or undefined when calling getCharactersCharacterIdNotificationsContacts().'); } const queryParameters = {}; if (requestParameters['datasource'] != null) { queryParameters['datasource'] = requestParameters['datasource']; } 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-characters.read_notifications.v1"]); } const response = await this.request({ path: `/v1/characters/{character_id}/notifications/contacts/`.replace(`{${"character_id"}}`, encodeURIComponent(String(requestParameters['characterId']))), method: 'GET', headers: headerParameters, query: queryParameters, }, initOverrides); return new runtime.JSONApiResponse(response, (jsonValue) => jsonValue.map(GetCharactersCharacterIdNotificationsContacts200OkFromJSON)); } /** * Return notifications about having been added to someone\'s contact list --- This route is cached for up to 600 seconds * Get new contact notifications */ async getCharactersCharacterIdNotificationsContacts(requestParameters, initOverrides) { const response = await this.getCharactersCharacterIdNotificationsContactsRaw(requestParameters, initOverrides); return await response.value(); } /** * Get portrait urls for a character --- This route expires daily at 11:05 * Get character portraits */ async getCharactersCharacterIdPortraitRaw(requestParameters, initOverrides) { if (requestParameters['characterId'] == null) { throw new runtime.RequiredError('characterId', 'Required parameter "characterId" was null or undefined when calling getCharactersCharacterIdPortrait().'); } 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: `/v2/characters/{character_id}/portrait/`.replace(`{${"character_id"}}`, encodeURIComponent(String(requestParameters['characterId']))), method: 'GET', headers: headerParameters, query: queryParameters, }, initOverrides); return new runtime.JSONApiResponse(response, (jsonValue) => GetCharactersCharacterIdPortraitOkFromJSON(jsonValue)); } /** * Get portrait urls for a character --- This route expires daily at 11:05 * Get character portraits */ async getCharactersCharacterIdPortrait(requestParameters, initOverrides) { const response = await this.getCharactersCharacterIdPortraitRaw(requestParameters, initOverrides); return await response.value(); } /** * Returns a character\'s corporation roles --- This route is cached for up to 3600 seconds * Get character corporation roles */ async getCharactersCharacterIdRolesRaw(requestParameters, initOverrides) { if (requestParameters['characterId'] == null) { throw new runtime.RequiredError('characterId', 'Required parameter "characterId" was null or undefined when calling getCharactersCharacterIdRoles().'); } const queryParameters = {}; if (requestParameters['datasource'] != null) { queryParameters['datasource'] = requestParameters['datasource']; } 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-characters.read_corporation_roles.v1"]); } const response = await this.request({ path: `/v2/characters/{character_id}/roles/`.replace(`{${"character_id"}}`, encodeURIComponent(String(requestParameters['characterId']))), method: 'GET', headers: headerParameters, query: queryParameters, }, initOverrides); return new runtime.JSONApiResponse(response, (jsonValue) => GetCharactersCharacterIdRolesOkFromJSON(jsonValue)); } /** * Returns a character\'s corporation roles --- This route is cached for up to 3600 seconds * Get character corporation roles */ async getCharactersCharacterIdRoles(requestParameters, initOverrides) { const response = await this.getCharactersCharacterIdRolesRaw(requestParameters, initOverrides); return await response.value(); } /** * Return character standings from agents, NPC corporations, and factions --- This route is cached for up to 3600 seconds * Get standings */ async getCharactersCharacterIdStandingsRaw(requestParameters, initOverrides) { if (requestParameters['characterId'] == null) { throw new runtime.RequiredError('characterId', 'Required parameter "characterId" was null or undefined when calling getCharactersCharacterIdStandings().'); } const queryParameters = {}; if (requestParameters['datasource'] != null) { queryParameters['datasource'] = requestParameters['datasource']; } 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-characters.read_standings.v1"]); } const response = await this.request({ path: `/v1/characters/{character_id}/standings/`.replace(`{${"character_id"}}`, encodeURIComponent(String(requestParameters['characterId']))), method: 'GET', headers: headerParameters, query: queryParameters, }, initOverrides); return new runtime.JSONApiResponse(response, (jsonValue) => jsonValue.map(GetCharactersCharacterIdStandings200OkFromJSON)); } /** * Return character standings from agents, NPC corporations, and factions --- This route is cached for up to 3600 seconds * Get standings */ async getCharactersCharacterIdStandings(requestParameters, initOverrides) { const response = await this.getCharactersCharacterIdStandingsRaw(requestParameters, initOverrides); return await response.value(); } /** * Returns a character\'s titles --- This route is cached for up to 3600 seconds * Get character corporation titles */ async getCharactersCharacterIdTitlesRaw(requestParameters, initOverrides) { if (requestParameters['characterId'] == null) { throw new runtime.RequiredError('characterId', 'Required parameter "characterId" was null or undefined when calling getCharactersCharacterIdTitles().'); } const queryParameters = {}; if (requestParameters['datasource'] != null) { queryParameters['datasource'] = requestParameters['datasource']; } 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-characters.read_titles.v1"]); } const response = await this.request({ path: `/v1/characters/{character_id}/titles/`.replace(`{${"character_id"}}`, encodeURIComponent(String(requestParameters['characterId']))), method: 'GET', headers: headerParameters, query: queryParameters, }, initOverrides); return new runtime.JSONApiResponse(response, (jsonValue) => jsonValue.map(GetCharactersCharacterIdTitles200OkFromJSON)); } /** * Returns a character\'s titles --- This route is cached for up to 3600 seconds * Get character corporation titles */ async getCharactersCharacterIdTitles(requestParameters, initOverrides) { const response = await this.getCharactersCharacterIdTitlesRaw(requestParameters, initOverrides); return await response.value(); } /** * Bulk lookup of character IDs to corporation, alliance and faction --- This route is cached for up to 3600 seconds * Character affiliation */ async postCharactersAffiliationRaw(requestParameters, initOverrides) { if (requestParameters['characters'] == null) { throw new runtime.RequiredError('characters', 'Required parameter "characters" was null or undefined when calling postCharactersAffiliation().'); } const queryParameters = {}; if (requestParameters['datasource'] != null) { queryParameters['datasource'] = requestParameters['datasource']; } const headerParameters = {}; headerParameters['Content-Type'] = 'application/json'; const response = await this.request({ path: `/v1/characters/affiliation/`, method: 'POST', headers: headerParameters, query: queryParameters, body: requestParameters['characters'], }, initOverrides); return new runtime.JSONApiResponse(response, (jsonValue) => jsonValue.map(PostCharactersAffiliation200OkFromJSON)); } /** * Bulk lookup of character IDs to corporation, alliance and faction --- This route is cached for up to 3600 seconds * Character affiliation */ async postCharactersAffiliation(requestParameters, initOverrides) { const response = await this.postCharactersAffiliationRaw(requestParameters, initOverrides); return await response.value(); } /** * Takes a source character ID in the url and a set of target character ID\'s in the body, returns a CSPA charge cost --- * Calculate a CSPA charge cost */ async postCharactersCharacterIdCspaRaw(requestParameters, initOverrides) { if (requestParameters['characterId'] == null) { throw new runtime.RequiredError('characterId', 'Required parameter "characterId" was null or undefined when calling postCharactersCharacterIdCspa().'); } if (requestParameters['characters'] == null) { throw new runtime.RequiredError('characters', 'Required parameter "characters" was null or undefined when calling postCharactersCharacterIdCspa().'); } const queryParameters = {}; if (requestParameters['datasource'] != null) { queryParameters['datasource'] = requestParameters['datasource']; } if (requestParameters['token'] != null) { queryParameters['token'] = requestParameters['token']; } const headerParameters = {}; headerParameters['Content-Type'] = 'application/json'; if (this.configuration && this.configuration.accessToken) { // oauth required headerParameters["Authorization"] = await this.configuration.accessToken("evesso", ["esi-characters.read_contacts.v1"]); } const response = await this.request({ path: `/v4/characters/{character_id}/cspa/`.replace(`{${"character_id"}}`, encodeURIComponent(String(requestParameters['characterId']))), method: 'POST', headers: headerParameters, query: queryParameters, body: requestParameters['characters'], }, initOverrides); if (this.isJsonMime(response.headers.get('content-type'))) { return new runtime.JSONApiResponse(response); } else { return new runtime.TextApiResponse(response); } } /** * Takes a source character ID in the url and a set of target character ID\'s in the body, returns a CSPA charge cost --- * Calculate a CSPA charge cost */ async postCharactersCharacterIdCspa(requestParameters, initOverrides) { const response = await this.postCharactersCharacterIdCspaRaw(requestParameters, initOverrides); return await response.value(); } } /** * @export */ export const GetCharactersCharacterIdDatasourceEnum = { Tranquility: 'tranquility' }; /** * @export */ export const GetCharactersCharacterIdAgentsResearchDatasourceEnum = { Tranquility: 'tranquility' }; /** * @export */ export const GetCharactersCharacterIdBlueprintsDatasourceEnum = { Tranquility: 'tranquility' }; /** * @export */ export const GetCharactersCharacterIdCorporationhistoryDatasourceEnum = { Tranquility: 'tranquility' }; /** * @export */ export const GetCharactersCharacterIdFatigueDatasourceEnum = { Tranquility: 'tranquility' }; /** * @export */ export const GetCharactersCharacterIdMedalsDatasourceEnum = { Tranquility: 'tranquility' }; /** * @export */ export const GetCharactersCharacterIdNotificationsDatasourceEnum = { Tranquility: 'tranquility' }; /** * @export */ export const GetCharactersCharacterIdNotificationsContactsDatasourceEnum = { Tranquility: 'tranquility' }; /** * @export */ export const GetCharactersCharacterIdPortraitDatasourceEnum = { Tranquility: 'tranquility' }; /** * @export */ export const GetCharactersCharacterIdRolesDatasourceEnum = { Tranquility: 'tranquility' }; /** * @export */ export const GetCharactersCharacterIdStandingsDatasourceEnum = { Tranquility: 'tranquility' }; /** * @export */ export const GetCharactersCharacterIdTitlesDatasourceEnum = { Tranquility: 'tranquility' }; /** * @export */ export const PostCharactersAffiliationDatasourceEnum = { Tranquility: 'tranquility' }; /** * @export */ export const PostCharactersCharacterIdCspaDatasourceEnum = { Tranquility: 'tranquility' };