@fnt-eve/esi-client-typescript/dist/apis/CharacterApi.d.ts

[](https://www.npmjs.com/package/@fnt-eve/esi-client-typescript)

/**
 * EVE Swagger Interface
 * An OpenAPI for EVE Online
 *
 * The version of the OpenAPI document: 1.33
 *
 *
 * 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 type { GetCharactersCharacterIdAgentsResearch200Ok, GetCharactersCharacterIdBlueprints200Ok, GetCharactersCharacterIdCorporationhistory200Ok, GetCharactersCharacterIdFatigueOk, GetCharactersCharacterIdMedals200Ok, GetCharactersCharacterIdNotifications200Ok, GetCharactersCharacterIdNotificationsContacts200Ok, GetCharactersCharacterIdOk, GetCharactersCharacterIdPortraitOk, GetCharactersCharacterIdRolesOk, GetCharactersCharacterIdStandings200Ok, GetCharactersCharacterIdTitles200Ok, PostCharactersAffiliation200Ok } from '../models/index';
export interface GetCharactersCharacterIdRequest {
    characterId: number;
    datasource?: GetCharactersCharacterIdDatasourceEnum;
    ifNoneMatch?: string;
}
export interface GetCharactersCharacterIdAgentsResearchRequest {
    characterId: number;
    datasource?: GetCharactersCharacterIdAgentsResearchDatasourceEnum;
    ifNoneMatch?: string;
    token?: string;
}
export interface GetCharactersCharacterIdBlueprintsRequest {
    characterId: number;
    datasource?: GetCharactersCharacterIdBlueprintsDatasourceEnum;
    ifNoneMatch?: string;
    page?: number;
    token?: string;
}
export interface GetCharactersCharacterIdCorporationhistoryRequest {
    characterId: number;
    datasource?: GetCharactersCharacterIdCorporationhistoryDatasourceEnum;
    ifNoneMatch?: string;
}
export interface GetCharactersCharacterIdFatigueRequest {
    characterId: number;
    datasource?: GetCharactersCharacterIdFatigueDatasourceEnum;
    ifNoneMatch?: string;
    token?: string;
}
export interface GetCharactersCharacterIdMedalsRequest {
    characterId: number;
    datasource?: GetCharactersCharacterIdMedalsDatasourceEnum;
    ifNoneMatch?: string;
    token?: string;
}
export interface GetCharactersCharacterIdNotificationsRequest {
    characterId: number;
    datasource?: GetCharactersCharacterIdNotificationsDatasourceEnum;
    ifNoneMatch?: string;
    token?: string;
}
export interface GetCharactersCharacterIdNotificationsContactsRequest {
    characterId: number;
    datasource?: GetCharactersCharacterIdNotificationsContactsDatasourceEnum;
    ifNoneMatch?: string;
    token?: string;
}
export interface GetCharactersCharacterIdPortraitRequest {
    characterId: number;
    datasource?: GetCharactersCharacterIdPortraitDatasourceEnum;
    ifNoneMatch?: string;
}
export interface GetCharactersCharacterIdRolesRequest {
    characterId: number;
    datasource?: GetCharactersCharacterIdRolesDatasourceEnum;
    ifNoneMatch?: string;
    token?: string;
}
export interface GetCharactersCharacterIdStandingsRequest {
    characterId: number;
    datasource?: GetCharactersCharacterIdStandingsDatasourceEnum;
    ifNoneMatch?: string;
    token?: string;
}
export interface GetCharactersCharacterIdTitlesRequest {
    characterId: number;
    datasource?: GetCharactersCharacterIdTitlesDatasourceEnum;
    ifNoneMatch?: string;
    token?: string;
}
export interface PostCharactersAffiliationRequest {
    characters: Set<number>;
    datasource?: PostCharactersAffiliationDatasourceEnum;
}
export interface PostCharactersCharacterIdCspaRequest {
    characterId: number;
    characters: Set<number>;
    datasource?: PostCharactersCharacterIdCspaDatasourceEnum;
    token?: string;
}
/**
 *
 */
export declare class CharacterApi extends runtime.BaseAPI {
    /**
     * Public information about a character  ---  This route is cached for up to 604800 seconds
     * Get character\'s public information
     */
    getCharactersCharacterIdRaw(requestParameters: GetCharactersCharacterIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetCharactersCharacterIdOk>>;
    /**
     * Public information about a character  ---  This route is cached for up to 604800 seconds
     * Get character\'s public information
     */
    getCharactersCharacterId(requestParameters: GetCharactersCharacterIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetCharactersCharacterIdOk>;
    /**
     * 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
     */
    getCharactersCharacterIdAgentsResearchRaw(requestParameters: GetCharactersCharacterIdAgentsResearchRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<GetCharactersCharacterIdAgentsResearch200Ok>>>;
    /**
     * 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
     */
    getCharactersCharacterIdAgentsResearch(requestParameters: GetCharactersCharacterIdAgentsResearchRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<GetCharactersCharacterIdAgentsResearch200Ok>>;
    /**
     * Return a list of blueprints the character owns  ---  This route is cached for up to 3600 seconds
     * Get blueprints
     */
    getCharactersCharacterIdBlueprintsRaw(requestParameters: GetCharactersCharacterIdBlueprintsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<GetCharactersCharacterIdBlueprints200Ok>>>;
    /**
     * Return a list of blueprints the character owns  ---  This route is cached for up to 3600 seconds
     * Get blueprints
     */
    getCharactersCharacterIdBlueprints(requestParameters: GetCharactersCharacterIdBlueprintsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<GetCharactersCharacterIdBlueprints200Ok>>;
    /**
     * 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
     */
    getCharactersCharacterIdCorporationhistoryRaw(requestParameters: GetCharactersCharacterIdCorporationhistoryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<GetCharactersCharacterIdCorporationhistory200Ok>>>;
    /**
     * 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
     */
    getCharactersCharacterIdCorporationhistory(requestParameters: GetCharactersCharacterIdCorporationhistoryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<GetCharactersCharacterIdCorporationhistory200Ok>>;
    /**
     * Return a character\'s jump activation and fatigue information  ---  This route is cached for up to 300 seconds
     * Get jump fatigue
     */
    getCharactersCharacterIdFatigueRaw(requestParameters: GetCharactersCharacterIdFatigueRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetCharactersCharacterIdFatigueOk>>;
    /**
     * Return a character\'s jump activation and fatigue information  ---  This route is cached for up to 300 seconds
     * Get jump fatigue
     */
    getCharactersCharacterIdFatigue(requestParameters: GetCharactersCharacterIdFatigueRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetCharactersCharacterIdFatigueOk>;
    /**
     * Return a list of medals the character has  ---  This route is cached for up to 3600 seconds
     * Get medals
     */
    getCharactersCharacterIdMedalsRaw(requestParameters: GetCharactersCharacterIdMedalsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<GetCharactersCharacterIdMedals200Ok>>>;
    /**
     * Return a list of medals the character has  ---  This route is cached for up to 3600 seconds
     * Get medals
     */
    getCharactersCharacterIdMedals(requestParameters: GetCharactersCharacterIdMedalsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<GetCharactersCharacterIdMedals200Ok>>;
    /**
     * Return character notifications  ---  This route is cached for up to 600 seconds
     * Get character notifications
     */
    getCharactersCharacterIdNotificationsRaw(requestParameters: GetCharactersCharacterIdNotificationsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<GetCharactersCharacterIdNotifications200Ok>>>;
    /**
     * Return character notifications  ---  This route is cached for up to 600 seconds
     * Get character notifications
     */
    getCharactersCharacterIdNotifications(requestParameters: GetCharactersCharacterIdNotificationsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<GetCharactersCharacterIdNotifications200Ok>>;
    /**
     * Return notifications about having been added to someone\'s contact list  ---  This route is cached for up to 600 seconds
     * Get new contact notifications
     */
    getCharactersCharacterIdNotificationsContactsRaw(requestParameters: GetCharactersCharacterIdNotificationsContactsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<GetCharactersCharacterIdNotificationsContacts200Ok>>>;
    /**
     * Return notifications about having been added to someone\'s contact list  ---  This route is cached for up to 600 seconds
     * Get new contact notifications
     */
    getCharactersCharacterIdNotificationsContacts(requestParameters: GetCharactersCharacterIdNotificationsContactsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<GetCharactersCharacterIdNotificationsContacts200Ok>>;
    /**
     * Get portrait urls for a character  ---  This route expires daily at 11:05
     * Get character portraits
     */
    getCharactersCharacterIdPortraitRaw(requestParameters: GetCharactersCharacterIdPortraitRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetCharactersCharacterIdPortraitOk>>;
    /**
     * Get portrait urls for a character  ---  This route expires daily at 11:05
     * Get character portraits
     */
    getCharactersCharacterIdPortrait(requestParameters: GetCharactersCharacterIdPortraitRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetCharactersCharacterIdPortraitOk>;
    /**
     * Returns a character\'s corporation roles  ---  This route is cached for up to 3600 seconds
     * Get character corporation roles
     */
    getCharactersCharacterIdRolesRaw(requestParameters: GetCharactersCharacterIdRolesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetCharactersCharacterIdRolesOk>>;
    /**
     * Returns a character\'s corporation roles  ---  This route is cached for up to 3600 seconds
     * Get character corporation roles
     */
    getCharactersCharacterIdRoles(requestParameters: GetCharactersCharacterIdRolesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetCharactersCharacterIdRolesOk>;
    /**
     * Return character standings from agents, NPC corporations, and factions  ---  This route is cached for up to 3600 seconds
     * Get standings
     */
    getCharactersCharacterIdStandingsRaw(requestParameters: GetCharactersCharacterIdStandingsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<GetCharactersCharacterIdStandings200Ok>>>;
    /**
     * Return character standings from agents, NPC corporations, and factions  ---  This route is cached for up to 3600 seconds
     * Get standings
     */
    getCharactersCharacterIdStandings(requestParameters: GetCharactersCharacterIdStandingsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<GetCharactersCharacterIdStandings200Ok>>;
    /**
     * Returns a character\'s titles  ---  This route is cached for up to 3600 seconds
     * Get character corporation titles
     */
    getCharactersCharacterIdTitlesRaw(requestParameters: GetCharactersCharacterIdTitlesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<GetCharactersCharacterIdTitles200Ok>>>;
    /**
     * Returns a character\'s titles  ---  This route is cached for up to 3600 seconds
     * Get character corporation titles
     */
    getCharactersCharacterIdTitles(requestParameters: GetCharactersCharacterIdTitlesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<GetCharactersCharacterIdTitles200Ok>>;
    /**
     * Bulk lookup of character IDs to corporation, alliance and faction  ---  This route is cached for up to 3600 seconds
     * Character affiliation
     */
    postCharactersAffiliationRaw(requestParameters: PostCharactersAffiliationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<PostCharactersAffiliation200Ok>>>;
    /**
     * Bulk lookup of character IDs to corporation, alliance and faction  ---  This route is cached for up to 3600 seconds
     * Character affiliation
     */
    postCharactersAffiliation(requestParameters: PostCharactersAffiliationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<PostCharactersAffiliation200Ok>>;
    /**
     * 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
     */
    postCharactersCharacterIdCspaRaw(requestParameters: PostCharactersCharacterIdCspaRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<number>>;
    /**
     * 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
     */
    postCharactersCharacterIdCspa(requestParameters: PostCharactersCharacterIdCspaRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<number>;
}
/**
 * @export
 */
export declare const GetCharactersCharacterIdDatasourceEnum: {
    readonly Tranquility: "tranquility";
};
export type GetCharactersCharacterIdDatasourceEnum = typeof GetCharactersCharacterIdDatasourceEnum[keyof typeof GetCharactersCharacterIdDatasourceEnum];
/**
 * @export
 */
export declare const GetCharactersCharacterIdAgentsResearchDatasourceEnum: {
    readonly Tranquility: "tranquility";
};
export type GetCharactersCharacterIdAgentsResearchDatasourceEnum = typeof GetCharactersCharacterIdAgentsResearchDatasourceEnum[keyof typeof GetCharactersCharacterIdAgentsResearchDatasourceEnum];
/**
 * @export
 */
export declare const GetCharactersCharacterIdBlueprintsDatasourceEnum: {
    readonly Tranquility: "tranquility";
};
export type GetCharactersCharacterIdBlueprintsDatasourceEnum = typeof GetCharactersCharacterIdBlueprintsDatasourceEnum[keyof typeof GetCharactersCharacterIdBlueprintsDatasourceEnum];
/**
 * @export
 */
export declare const GetCharactersCharacterIdCorporationhistoryDatasourceEnum: {
    readonly Tranquility: "tranquility";
};
export type GetCharactersCharacterIdCorporationhistoryDatasourceEnum = typeof GetCharactersCharacterIdCorporationhistoryDatasourceEnum[keyof typeof GetCharactersCharacterIdCorporationhistoryDatasourceEnum];
/**
 * @export
 */
export declare const GetCharactersCharacterIdFatigueDatasourceEnum: {
    readonly Tranquility: "tranquility";
};
export type GetCharactersCharacterIdFatigueDatasourceEnum = typeof GetCharactersCharacterIdFatigueDatasourceEnum[keyof typeof GetCharactersCharacterIdFatigueDatasourceEnum];
/**
 * @export
 */
export declare const GetCharactersCharacterIdMedalsDatasourceEnum: {
    readonly Tranquility: "tranquility";
};
export type GetCharactersCharacterIdMedalsDatasourceEnum = typeof GetCharactersCharacterIdMedalsDatasourceEnum[keyof typeof GetCharactersCharacterIdMedalsDatasourceEnum];
/**
 * @export
 */
export declare const GetCharactersCharacterIdNotificationsDatasourceEnum: {
    readonly Tranquility: "tranquility";
};
export type GetCharactersCharacterIdNotificationsDatasourceEnum = typeof GetCharactersCharacterIdNotificationsDatasourceEnum[keyof typeof GetCharactersCharacterIdNotificationsDatasourceEnum];
/**
 * @export
 */
export declare const GetCharactersCharacterIdNotificationsContactsDatasourceEnum: {
    readonly Tranquility: "tranquility";
};
export type GetCharactersCharacterIdNotificationsContactsDatasourceEnum = typeof GetCharactersCharacterIdNotificationsContactsDatasourceEnum[keyof typeof GetCharactersCharacterIdNotificationsContactsDatasourceEnum];
/**
 * @export
 */
export declare const GetCharactersCharacterIdPortraitDatasourceEnum: {
    readonly Tranquility: "tranquility";
};
export type GetCharactersCharacterIdPortraitDatasourceEnum = typeof GetCharactersCharacterIdPortraitDatasourceEnum[keyof typeof GetCharactersCharacterIdPortraitDatasourceEnum];
/**
 * @export
 */
export declare const GetCharactersCharacterIdRolesDatasourceEnum: {
    readonly Tranquility: "tranquility";
};
export type GetCharactersCharacterIdRolesDatasourceEnum = typeof GetCharactersCharacterIdRolesDatasourceEnum[keyof typeof GetCharactersCharacterIdRolesDatasourceEnum];
/**
 * @export
 */
export declare const GetCharactersCharacterIdStandingsDatasourceEnum: {
    readonly Tranquility: "tranquility";
};
export type GetCharactersCharacterIdStandingsDatasourceEnum = typeof GetCharactersCharacterIdStandingsDatasourceEnum[keyof typeof GetCharactersCharacterIdStandingsDatasourceEnum];
/**
 * @export
 */
export declare const GetCharactersCharacterIdTitlesDatasourceEnum: {
    readonly Tranquility: "tranquility";
};
export type GetCharactersCharacterIdTitlesDatasourceEnum = typeof GetCharactersCharacterIdTitlesDatasourceEnum[keyof typeof GetCharactersCharacterIdTitlesDatasourceEnum];
/**
 * @export
 */
export declare const PostCharactersAffiliationDatasourceEnum: {
    readonly Tranquility: "tranquility";
};
export type PostCharactersAffiliationDatasourceEnum = typeof PostCharactersAffiliationDatasourceEnum[keyof typeof PostCharactersAffiliationDatasourceEnum];
/**
 * @export
 */
export declare const PostCharactersCharacterIdCspaDatasourceEnum: {
    readonly Tranquility: "tranquility";
};
export type PostCharactersCharacterIdCspaDatasourceEnum = typeof PostCharactersCharacterIdCspaDatasourceEnum[keyof typeof PostCharactersCharacterIdCspaDatasourceEnum];
//# sourceMappingURL=CharacterApi.d.ts.map