@fnt-eve/esi-client-typescript
Version:
[](https://www.npmjs.com/package/@fnt-eve/esi-client-typescript)
156 lines (155 loc) • 7.16 kB
JavaScript
/* 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 { GetCharactersCharacterIdLocationOkFromJSON, GetCharactersCharacterIdOnlineOkFromJSON, GetCharactersCharacterIdShipOkFromJSON, } from '../models/index';
/**
*
*/
export class LocationApi extends runtime.BaseAPI {
/**
* Information about the characters current location. Returns the current solar system id, and also the current station or structure ID if applicable --- This route is cached for up to 5 seconds
* Get character location
*/
async getCharactersCharacterIdLocationRaw(requestParameters, initOverrides) {
if (requestParameters['characterId'] == null) {
throw new runtime.RequiredError('characterId', 'Required parameter "characterId" was null or undefined when calling getCharactersCharacterIdLocation().');
}
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-location.read_location.v1"]);
}
const response = await this.request({
path: `/v1/characters/{character_id}/location/`.replace(`{${"character_id"}}`, encodeURIComponent(String(requestParameters['characterId']))),
method: 'GET',
headers: headerParameters,
query: queryParameters,
}, initOverrides);
return new runtime.JSONApiResponse(response, (jsonValue) => GetCharactersCharacterIdLocationOkFromJSON(jsonValue));
}
/**
* Information about the characters current location. Returns the current solar system id, and also the current station or structure ID if applicable --- This route is cached for up to 5 seconds
* Get character location
*/
async getCharactersCharacterIdLocation(requestParameters, initOverrides) {
const response = await this.getCharactersCharacterIdLocationRaw(requestParameters, initOverrides);
return await response.value();
}
/**
* Checks if the character is currently online --- This route is cached for up to 60 seconds
* Get character online
*/
async getCharactersCharacterIdOnlineRaw(requestParameters, initOverrides) {
if (requestParameters['characterId'] == null) {
throw new runtime.RequiredError('characterId', 'Required parameter "characterId" was null or undefined when calling getCharactersCharacterIdOnline().');
}
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-location.read_online.v1"]);
}
const response = await this.request({
path: `/v2/characters/{character_id}/online/`.replace(`{${"character_id"}}`, encodeURIComponent(String(requestParameters['characterId']))),
method: 'GET',
headers: headerParameters,
query: queryParameters,
}, initOverrides);
return new runtime.JSONApiResponse(response, (jsonValue) => GetCharactersCharacterIdOnlineOkFromJSON(jsonValue));
}
/**
* Checks if the character is currently online --- This route is cached for up to 60 seconds
* Get character online
*/
async getCharactersCharacterIdOnline(requestParameters, initOverrides) {
const response = await this.getCharactersCharacterIdOnlineRaw(requestParameters, initOverrides);
return await response.value();
}
/**
* Get the current ship type, name and id --- This route is cached for up to 5 seconds
* Get current ship
*/
async getCharactersCharacterIdShipRaw(requestParameters, initOverrides) {
if (requestParameters['characterId'] == null) {
throw new runtime.RequiredError('characterId', 'Required parameter "characterId" was null or undefined when calling getCharactersCharacterIdShip().');
}
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-location.read_ship_type.v1"]);
}
const response = await this.request({
path: `/v1/characters/{character_id}/ship/`.replace(`{${"character_id"}}`, encodeURIComponent(String(requestParameters['characterId']))),
method: 'GET',
headers: headerParameters,
query: queryParameters,
}, initOverrides);
return new runtime.JSONApiResponse(response, (jsonValue) => GetCharactersCharacterIdShipOkFromJSON(jsonValue));
}
/**
* Get the current ship type, name and id --- This route is cached for up to 5 seconds
* Get current ship
*/
async getCharactersCharacterIdShip(requestParameters, initOverrides) {
const response = await this.getCharactersCharacterIdShipRaw(requestParameters, initOverrides);
return await response.value();
}
}
/**
* @export
*/
export const GetCharactersCharacterIdLocationDatasourceEnum = {
Tranquility: 'tranquility'
};
/**
* @export
*/
export const GetCharactersCharacterIdOnlineDatasourceEnum = {
Tranquility: 'tranquility'
};
/**
* @export
*/
export const GetCharactersCharacterIdShipDatasourceEnum = {
Tranquility: 'tranquility'
};