@fnt-eve/esi-client-typescript
Version:
[](https://www.npmjs.com/package/@fnt-eve/esi-client-typescript)
464 lines (463 loc) • 22 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 { GetAlliancesAllianceIdContacts200OkFromJSON, GetAlliancesAllianceIdContactsLabels200OkFromJSON, GetCharactersCharacterIdContacts200OkFromJSON, GetCharactersCharacterIdContactsLabels200OkFromJSON, GetCorporationsCorporationIdContacts200OkFromJSON, GetCorporationsCorporationIdContactsLabels200OkFromJSON, } from '../models/index';
/**
*
*/
export class ContactsApi extends runtime.BaseAPI {
/**
* Bulk delete contacts ---
* Delete contacts
*/
async deleteCharactersCharacterIdContactsRaw(requestParameters, initOverrides) {
if (requestParameters['characterId'] == null) {
throw new runtime.RequiredError('characterId', 'Required parameter "characterId" was null or undefined when calling deleteCharactersCharacterIdContacts().');
}
if (requestParameters['contactIds'] == null) {
throw new runtime.RequiredError('contactIds', 'Required parameter "contactIds" was null or undefined when calling deleteCharactersCharacterIdContacts().');
}
const queryParameters = {};
if (requestParameters['contactIds'] != null) {
queryParameters['contact_ids'] = requestParameters['contactIds'].join(runtime.COLLECTION_FORMATS["csv"]);
}
if (requestParameters['datasource'] != null) {
queryParameters['datasource'] = requestParameters['datasource'];
}
if (requestParameters['token'] != null) {
queryParameters['token'] = requestParameters['token'];
}
const headerParameters = {};
if (this.configuration && this.configuration.accessToken) {
// oauth required
headerParameters["Authorization"] = await this.configuration.accessToken("evesso", ["esi-characters.write_contacts.v1"]);
}
const response = await this.request({
path: `/v1/characters/{character_id}/contacts/`.replace(`{${"character_id"}}`, encodeURIComponent(String(requestParameters['characterId']))),
method: 'DELETE',
headers: headerParameters,
query: queryParameters,
}, initOverrides);
return new runtime.VoidApiResponse(response);
}
/**
* Bulk delete contacts ---
* Delete contacts
*/
async deleteCharactersCharacterIdContacts(requestParameters, initOverrides) {
await this.deleteCharactersCharacterIdContactsRaw(requestParameters, initOverrides);
}
/**
* Return contacts of an alliance --- This route is cached for up to 300 seconds
* Get alliance contacts
*/
async getAlliancesAllianceIdContactsRaw(requestParameters, initOverrides) {
if (requestParameters['allianceId'] == null) {
throw new runtime.RequiredError('allianceId', 'Required parameter "allianceId" was null or undefined when calling getAlliancesAllianceIdContacts().');
}
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-alliances.read_contacts.v1"]);
}
const response = await this.request({
path: `/v2/alliances/{alliance_id}/contacts/`.replace(`{${"alliance_id"}}`, encodeURIComponent(String(requestParameters['allianceId']))),
method: 'GET',
headers: headerParameters,
query: queryParameters,
}, initOverrides);
return new runtime.JSONApiResponse(response, (jsonValue) => jsonValue.map(GetAlliancesAllianceIdContacts200OkFromJSON));
}
/**
* Return contacts of an alliance --- This route is cached for up to 300 seconds
* Get alliance contacts
*/
async getAlliancesAllianceIdContacts(requestParameters, initOverrides) {
const response = await this.getAlliancesAllianceIdContactsRaw(requestParameters, initOverrides);
return await response.value();
}
/**
* Return custom labels for an alliance\'s contacts --- This route is cached for up to 300 seconds
* Get alliance contact labels
*/
async getAlliancesAllianceIdContactsLabelsRaw(requestParameters, initOverrides) {
if (requestParameters['allianceId'] == null) {
throw new runtime.RequiredError('allianceId', 'Required parameter "allianceId" was null or undefined when calling getAlliancesAllianceIdContactsLabels().');
}
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-alliances.read_contacts.v1"]);
}
const response = await this.request({
path: `/v1/alliances/{alliance_id}/contacts/labels/`.replace(`{${"alliance_id"}}`, encodeURIComponent(String(requestParameters['allianceId']))),
method: 'GET',
headers: headerParameters,
query: queryParameters,
}, initOverrides);
return new runtime.JSONApiResponse(response, (jsonValue) => jsonValue.map(GetAlliancesAllianceIdContactsLabels200OkFromJSON));
}
/**
* Return custom labels for an alliance\'s contacts --- This route is cached for up to 300 seconds
* Get alliance contact labels
*/
async getAlliancesAllianceIdContactsLabels(requestParameters, initOverrides) {
const response = await this.getAlliancesAllianceIdContactsLabelsRaw(requestParameters, initOverrides);
return await response.value();
}
/**
* Return contacts of a character --- This route is cached for up to 300 seconds
* Get contacts
*/
async getCharactersCharacterIdContactsRaw(requestParameters, initOverrides) {
if (requestParameters['characterId'] == null) {
throw new runtime.RequiredError('characterId', 'Required parameter "characterId" was null or undefined when calling getCharactersCharacterIdContacts().');
}
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_contacts.v1"]);
}
const response = await this.request({
path: `/v2/characters/{character_id}/contacts/`.replace(`{${"character_id"}}`, encodeURIComponent(String(requestParameters['characterId']))),
method: 'GET',
headers: headerParameters,
query: queryParameters,
}, initOverrides);
return new runtime.JSONApiResponse(response, (jsonValue) => jsonValue.map(GetCharactersCharacterIdContacts200OkFromJSON));
}
/**
* Return contacts of a character --- This route is cached for up to 300 seconds
* Get contacts
*/
async getCharactersCharacterIdContacts(requestParameters, initOverrides) {
const response = await this.getCharactersCharacterIdContactsRaw(requestParameters, initOverrides);
return await response.value();
}
/**
* Return custom labels for a character\'s contacts --- This route is cached for up to 300 seconds
* Get contact labels
*/
async getCharactersCharacterIdContactsLabelsRaw(requestParameters, initOverrides) {
if (requestParameters['characterId'] == null) {
throw new runtime.RequiredError('characterId', 'Required parameter "characterId" was null or undefined when calling getCharactersCharacterIdContactsLabels().');
}
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_contacts.v1"]);
}
const response = await this.request({
path: `/v1/characters/{character_id}/contacts/labels/`.replace(`{${"character_id"}}`, encodeURIComponent(String(requestParameters['characterId']))),
method: 'GET',
headers: headerParameters,
query: queryParameters,
}, initOverrides);
return new runtime.JSONApiResponse(response, (jsonValue) => jsonValue.map(GetCharactersCharacterIdContactsLabels200OkFromJSON));
}
/**
* Return custom labels for a character\'s contacts --- This route is cached for up to 300 seconds
* Get contact labels
*/
async getCharactersCharacterIdContactsLabels(requestParameters, initOverrides) {
const response = await this.getCharactersCharacterIdContactsLabelsRaw(requestParameters, initOverrides);
return await response.value();
}
/**
* Return contacts of a corporation --- This route is cached for up to 300 seconds
* Get corporation contacts
*/
async getCorporationsCorporationIdContactsRaw(requestParameters, initOverrides) {
if (requestParameters['corporationId'] == null) {
throw new runtime.RequiredError('corporationId', 'Required parameter "corporationId" was null or undefined when calling getCorporationsCorporationIdContacts().');
}
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-corporations.read_contacts.v1"]);
}
const response = await this.request({
path: `/v2/corporations/{corporation_id}/contacts/`.replace(`{${"corporation_id"}}`, encodeURIComponent(String(requestParameters['corporationId']))),
method: 'GET',
headers: headerParameters,
query: queryParameters,
}, initOverrides);
return new runtime.JSONApiResponse(response, (jsonValue) => jsonValue.map(GetCorporationsCorporationIdContacts200OkFromJSON));
}
/**
* Return contacts of a corporation --- This route is cached for up to 300 seconds
* Get corporation contacts
*/
async getCorporationsCorporationIdContacts(requestParameters, initOverrides) {
const response = await this.getCorporationsCorporationIdContactsRaw(requestParameters, initOverrides);
return await response.value();
}
/**
* Return custom labels for a corporation\'s contacts --- This route is cached for up to 300 seconds
* Get corporation contact labels
*/
async getCorporationsCorporationIdContactsLabelsRaw(requestParameters, initOverrides) {
if (requestParameters['corporationId'] == null) {
throw new runtime.RequiredError('corporationId', 'Required parameter "corporationId" was null or undefined when calling getCorporationsCorporationIdContactsLabels().');
}
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-corporations.read_contacts.v1"]);
}
const response = await this.request({
path: `/v1/corporations/{corporation_id}/contacts/labels/`.replace(`{${"corporation_id"}}`, encodeURIComponent(String(requestParameters['corporationId']))),
method: 'GET',
headers: headerParameters,
query: queryParameters,
}, initOverrides);
return new runtime.JSONApiResponse(response, (jsonValue) => jsonValue.map(GetCorporationsCorporationIdContactsLabels200OkFromJSON));
}
/**
* Return custom labels for a corporation\'s contacts --- This route is cached for up to 300 seconds
* Get corporation contact labels
*/
async getCorporationsCorporationIdContactsLabels(requestParameters, initOverrides) {
const response = await this.getCorporationsCorporationIdContactsLabelsRaw(requestParameters, initOverrides);
return await response.value();
}
/**
* Bulk add contacts with same settings ---
* Add contacts
*/
async postCharactersCharacterIdContactsRaw(requestParameters, initOverrides) {
if (requestParameters['characterId'] == null) {
throw new runtime.RequiredError('characterId', 'Required parameter "characterId" was null or undefined when calling postCharactersCharacterIdContacts().');
}
if (requestParameters['standing'] == null) {
throw new runtime.RequiredError('standing', 'Required parameter "standing" was null or undefined when calling postCharactersCharacterIdContacts().');
}
if (requestParameters['contactIds'] == null) {
throw new runtime.RequiredError('contactIds', 'Required parameter "contactIds" was null or undefined when calling postCharactersCharacterIdContacts().');
}
const queryParameters = {};
if (requestParameters['datasource'] != null) {
queryParameters['datasource'] = requestParameters['datasource'];
}
if (requestParameters['labelIds'] != null) {
queryParameters['label_ids'] = requestParameters['labelIds'].join(runtime.COLLECTION_FORMATS["csv"]);
}
if (requestParameters['standing'] != null) {
queryParameters['standing'] = requestParameters['standing'];
}
if (requestParameters['token'] != null) {
queryParameters['token'] = requestParameters['token'];
}
if (requestParameters['watched'] != null) {
queryParameters['watched'] = requestParameters['watched'];
}
const headerParameters = {};
headerParameters['Content-Type'] = 'application/json';
if (this.configuration && this.configuration.accessToken) {
// oauth required
headerParameters["Authorization"] = await this.configuration.accessToken("evesso", ["esi-characters.write_contacts.v1"]);
}
const response = await this.request({
path: `/v2/characters/{character_id}/contacts/`.replace(`{${"character_id"}}`, encodeURIComponent(String(requestParameters['characterId']))),
method: 'POST',
headers: headerParameters,
query: queryParameters,
body: requestParameters['contactIds'],
}, initOverrides);
return new runtime.JSONApiResponse(response);
}
/**
* Bulk add contacts with same settings ---
* Add contacts
*/
async postCharactersCharacterIdContacts(requestParameters, initOverrides) {
const response = await this.postCharactersCharacterIdContactsRaw(requestParameters, initOverrides);
return await response.value();
}
/**
* Bulk edit contacts with same settings ---
* Edit contacts
*/
async putCharactersCharacterIdContactsRaw(requestParameters, initOverrides) {
if (requestParameters['characterId'] == null) {
throw new runtime.RequiredError('characterId', 'Required parameter "characterId" was null or undefined when calling putCharactersCharacterIdContacts().');
}
if (requestParameters['standing'] == null) {
throw new runtime.RequiredError('standing', 'Required parameter "standing" was null or undefined when calling putCharactersCharacterIdContacts().');
}
if (requestParameters['contactIds'] == null) {
throw new runtime.RequiredError('contactIds', 'Required parameter "contactIds" was null or undefined when calling putCharactersCharacterIdContacts().');
}
const queryParameters = {};
if (requestParameters['datasource'] != null) {
queryParameters['datasource'] = requestParameters['datasource'];
}
if (requestParameters['labelIds'] != null) {
queryParameters['label_ids'] = requestParameters['labelIds'].join(runtime.COLLECTION_FORMATS["csv"]);
}
if (requestParameters['standing'] != null) {
queryParameters['standing'] = requestParameters['standing'];
}
if (requestParameters['token'] != null) {
queryParameters['token'] = requestParameters['token'];
}
if (requestParameters['watched'] != null) {
queryParameters['watched'] = requestParameters['watched'];
}
const headerParameters = {};
headerParameters['Content-Type'] = 'application/json';
if (this.configuration && this.configuration.accessToken) {
// oauth required
headerParameters["Authorization"] = await this.configuration.accessToken("evesso", ["esi-characters.write_contacts.v1"]);
}
const response = await this.request({
path: `/v2/characters/{character_id}/contacts/`.replace(`{${"character_id"}}`, encodeURIComponent(String(requestParameters['characterId']))),
method: 'PUT',
headers: headerParameters,
query: queryParameters,
body: requestParameters['contactIds'],
}, initOverrides);
return new runtime.VoidApiResponse(response);
}
/**
* Bulk edit contacts with same settings ---
* Edit contacts
*/
async putCharactersCharacterIdContacts(requestParameters, initOverrides) {
await this.putCharactersCharacterIdContactsRaw(requestParameters, initOverrides);
}
}
/**
* @export
*/
export const DeleteCharactersCharacterIdContactsDatasourceEnum = {
Tranquility: 'tranquility'
};
/**
* @export
*/
export const GetAlliancesAllianceIdContactsDatasourceEnum = {
Tranquility: 'tranquility'
};
/**
* @export
*/
export const GetAlliancesAllianceIdContactsLabelsDatasourceEnum = {
Tranquility: 'tranquility'
};
/**
* @export
*/
export const GetCharactersCharacterIdContactsDatasourceEnum = {
Tranquility: 'tranquility'
};
/**
* @export
*/
export const GetCharactersCharacterIdContactsLabelsDatasourceEnum = {
Tranquility: 'tranquility'
};
/**
* @export
*/
export const GetCorporationsCorporationIdContactsDatasourceEnum = {
Tranquility: 'tranquility'
};
/**
* @export
*/
export const GetCorporationsCorporationIdContactsLabelsDatasourceEnum = {
Tranquility: 'tranquility'
};
/**
* @export
*/
export const PostCharactersCharacterIdContactsDatasourceEnum = {
Tranquility: 'tranquility'
};
/**
* @export
*/
export const PutCharactersCharacterIdContactsDatasourceEnum = {
Tranquility: 'tranquility'
};