@fnt-eve/esi-client-typescript/dist/apis/MarketApi.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 { GetCharactersCharacterIdOrders200Ok, GetCharactersCharacterIdOrdersHistory200Ok, GetCorporationsCorporationIdOrders200Ok, GetCorporationsCorporationIdOrdersHistory200Ok, GetMarketsGroupsMarketGroupIdOk, GetMarketsPrices200Ok, GetMarketsRegionIdHistory200Ok, GetMarketsRegionIdOrders200Ok, GetMarketsStructuresStructureId200Ok } from '../models/index';
export interface GetCharactersCharacterIdOrdersRequest {
    characterId: number;
    datasource?: GetCharactersCharacterIdOrdersDatasourceEnum;
    ifNoneMatch?: string;
    token?: string;
}
export interface GetCharactersCharacterIdOrdersHistoryRequest {
    characterId: number;
    datasource?: GetCharactersCharacterIdOrdersHistoryDatasourceEnum;
    ifNoneMatch?: string;
    page?: number;
    token?: string;
}
export interface GetCorporationsCorporationIdOrdersRequest {
    corporationId: number;
    datasource?: GetCorporationsCorporationIdOrdersDatasourceEnum;
    ifNoneMatch?: string;
    page?: number;
    token?: string;
}
export interface GetCorporationsCorporationIdOrdersHistoryRequest {
    corporationId: number;
    datasource?: GetCorporationsCorporationIdOrdersHistoryDatasourceEnum;
    ifNoneMatch?: string;
    page?: number;
    token?: string;
}
export interface GetMarketsGroupsRequest {
    datasource?: GetMarketsGroupsDatasourceEnum;
    ifNoneMatch?: string;
}
export interface GetMarketsGroupsMarketGroupIdRequest {
    marketGroupId: number;
    acceptLanguage?: GetMarketsGroupsMarketGroupIdAcceptLanguageEnum;
    datasource?: GetMarketsGroupsMarketGroupIdDatasourceEnum;
    ifNoneMatch?: string;
    language?: GetMarketsGroupsMarketGroupIdLanguageEnum;
}
export interface GetMarketsPricesRequest {
    datasource?: GetMarketsPricesDatasourceEnum;
    ifNoneMatch?: string;
}
export interface GetMarketsRegionIdHistoryRequest {
    regionId: number;
    typeId: number;
    datasource?: GetMarketsRegionIdHistoryDatasourceEnum;
    ifNoneMatch?: string;
}
export interface GetMarketsRegionIdOrdersRequest {
    orderType: GetMarketsRegionIdOrdersOrderTypeEnum;
    regionId: number;
    datasource?: GetMarketsRegionIdOrdersDatasourceEnum;
    ifNoneMatch?: string;
    page?: number;
    typeId?: number;
}
export interface GetMarketsRegionIdTypesRequest {
    regionId: number;
    datasource?: GetMarketsRegionIdTypesDatasourceEnum;
    ifNoneMatch?: string;
    page?: number;
}
export interface GetMarketsStructuresStructureIdRequest {
    structureId: number;
    datasource?: GetMarketsStructuresStructureIdDatasourceEnum;
    ifNoneMatch?: string;
    page?: number;
    token?: string;
}
/**
 *
 */
export declare class MarketApi extends runtime.BaseAPI {
    /**
     * List open market orders placed by a character  ---  This route is cached for up to 1200 seconds
     * List open orders from a character
     */
    getCharactersCharacterIdOrdersRaw(requestParameters: GetCharactersCharacterIdOrdersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<GetCharactersCharacterIdOrders200Ok>>>;
    /**
     * List open market orders placed by a character  ---  This route is cached for up to 1200 seconds
     * List open orders from a character
     */
    getCharactersCharacterIdOrders(requestParameters: GetCharactersCharacterIdOrdersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<GetCharactersCharacterIdOrders200Ok>>;
    /**
     * List cancelled and expired market orders placed by a character up to 90 days in the past.  ---  This route is cached for up to 3600 seconds
     * List historical orders by a character
     */
    getCharactersCharacterIdOrdersHistoryRaw(requestParameters: GetCharactersCharacterIdOrdersHistoryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<GetCharactersCharacterIdOrdersHistory200Ok>>>;
    /**
     * List cancelled and expired market orders placed by a character up to 90 days in the past.  ---  This route is cached for up to 3600 seconds
     * List historical orders by a character
     */
    getCharactersCharacterIdOrdersHistory(requestParameters: GetCharactersCharacterIdOrdersHistoryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<GetCharactersCharacterIdOrdersHistory200Ok>>;
    /**
     * List open market orders placed on behalf of a corporation  ---  This route is cached for up to 1200 seconds  --- Requires one of the following EVE corporation role(s): Accountant, Trader
     * List open orders from a corporation
     */
    getCorporationsCorporationIdOrdersRaw(requestParameters: GetCorporationsCorporationIdOrdersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<GetCorporationsCorporationIdOrders200Ok>>>;
    /**
     * List open market orders placed on behalf of a corporation  ---  This route is cached for up to 1200 seconds  --- Requires one of the following EVE corporation role(s): Accountant, Trader
     * List open orders from a corporation
     */
    getCorporationsCorporationIdOrders(requestParameters: GetCorporationsCorporationIdOrdersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<GetCorporationsCorporationIdOrders200Ok>>;
    /**
     * List cancelled and expired market orders placed on behalf of a corporation up to 90 days in the past.  ---  This route is cached for up to 3600 seconds  --- Requires one of the following EVE corporation role(s): Accountant, Trader
     * List historical orders from a corporation
     */
    getCorporationsCorporationIdOrdersHistoryRaw(requestParameters: GetCorporationsCorporationIdOrdersHistoryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<GetCorporationsCorporationIdOrdersHistory200Ok>>>;
    /**
     * List cancelled and expired market orders placed on behalf of a corporation up to 90 days in the past.  ---  This route is cached for up to 3600 seconds  --- Requires one of the following EVE corporation role(s): Accountant, Trader
     * List historical orders from a corporation
     */
    getCorporationsCorporationIdOrdersHistory(requestParameters: GetCorporationsCorporationIdOrdersHistoryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<GetCorporationsCorporationIdOrdersHistory200Ok>>;
    /**
     * Get a list of item groups  ---  This route expires daily at 11:05
     * Get item groups
     */
    getMarketsGroupsRaw(requestParameters: GetMarketsGroupsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<number>>>;
    /**
     * Get a list of item groups  ---  This route expires daily at 11:05
     * Get item groups
     */
    getMarketsGroups(requestParameters?: GetMarketsGroupsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<number>>;
    /**
     * Get information on an item group  ---  This route expires daily at 11:05
     * Get item group information
     */
    getMarketsGroupsMarketGroupIdRaw(requestParameters: GetMarketsGroupsMarketGroupIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetMarketsGroupsMarketGroupIdOk>>;
    /**
     * Get information on an item group  ---  This route expires daily at 11:05
     * Get item group information
     */
    getMarketsGroupsMarketGroupId(requestParameters: GetMarketsGroupsMarketGroupIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetMarketsGroupsMarketGroupIdOk>;
    /**
     * Return a list of prices  ---  This route is cached for up to 3600 seconds
     * List market prices
     */
    getMarketsPricesRaw(requestParameters: GetMarketsPricesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<GetMarketsPrices200Ok>>>;
    /**
     * Return a list of prices  ---  This route is cached for up to 3600 seconds
     * List market prices
     */
    getMarketsPrices(requestParameters?: GetMarketsPricesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<GetMarketsPrices200Ok>>;
    /**
     * Return a list of historical market statistics for the specified type in a region  ---  This route expires daily at 11:05
     * List historical market statistics in a region
     */
    getMarketsRegionIdHistoryRaw(requestParameters: GetMarketsRegionIdHistoryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<GetMarketsRegionIdHistory200Ok>>>;
    /**
     * Return a list of historical market statistics for the specified type in a region  ---  This route expires daily at 11:05
     * List historical market statistics in a region
     */
    getMarketsRegionIdHistory(requestParameters: GetMarketsRegionIdHistoryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<GetMarketsRegionIdHistory200Ok>>;
    /**
     * Return a list of orders in a region  ---  This route is cached for up to 300 seconds
     * List orders in a region
     */
    getMarketsRegionIdOrdersRaw(requestParameters: GetMarketsRegionIdOrdersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<GetMarketsRegionIdOrders200Ok>>>;
    /**
     * Return a list of orders in a region  ---  This route is cached for up to 300 seconds
     * List orders in a region
     */
    getMarketsRegionIdOrders(requestParameters: GetMarketsRegionIdOrdersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<GetMarketsRegionIdOrders200Ok>>;
    /**
     * Return a list of type IDs that have active orders in the region, for efficient market indexing.  ---  This route is cached for up to 600 seconds
     * List type IDs relevant to a market
     */
    getMarketsRegionIdTypesRaw(requestParameters: GetMarketsRegionIdTypesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<number>>>;
    /**
     * Return a list of type IDs that have active orders in the region, for efficient market indexing.  ---  This route is cached for up to 600 seconds
     * List type IDs relevant to a market
     */
    getMarketsRegionIdTypes(requestParameters: GetMarketsRegionIdTypesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<number>>;
    /**
     * Return all orders in a structure  ---  This route is cached for up to 300 seconds
     * List orders in a structure
     */
    getMarketsStructuresStructureIdRaw(requestParameters: GetMarketsStructuresStructureIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<GetMarketsStructuresStructureId200Ok>>>;
    /**
     * Return all orders in a structure  ---  This route is cached for up to 300 seconds
     * List orders in a structure
     */
    getMarketsStructuresStructureId(requestParameters: GetMarketsStructuresStructureIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<GetMarketsStructuresStructureId200Ok>>;
}
/**
 * @export
 */
export declare const GetCharactersCharacterIdOrdersDatasourceEnum: {
    readonly Tranquility: "tranquility";
};
export type GetCharactersCharacterIdOrdersDatasourceEnum = typeof GetCharactersCharacterIdOrdersDatasourceEnum[keyof typeof GetCharactersCharacterIdOrdersDatasourceEnum];
/**
 * @export
 */
export declare const GetCharactersCharacterIdOrdersHistoryDatasourceEnum: {
    readonly Tranquility: "tranquility";
};
export type GetCharactersCharacterIdOrdersHistoryDatasourceEnum = typeof GetCharactersCharacterIdOrdersHistoryDatasourceEnum[keyof typeof GetCharactersCharacterIdOrdersHistoryDatasourceEnum];
/**
 * @export
 */
export declare const GetCorporationsCorporationIdOrdersDatasourceEnum: {
    readonly Tranquility: "tranquility";
};
export type GetCorporationsCorporationIdOrdersDatasourceEnum = typeof GetCorporationsCorporationIdOrdersDatasourceEnum[keyof typeof GetCorporationsCorporationIdOrdersDatasourceEnum];
/**
 * @export
 */
export declare const GetCorporationsCorporationIdOrdersHistoryDatasourceEnum: {
    readonly Tranquility: "tranquility";
};
export type GetCorporationsCorporationIdOrdersHistoryDatasourceEnum = typeof GetCorporationsCorporationIdOrdersHistoryDatasourceEnum[keyof typeof GetCorporationsCorporationIdOrdersHistoryDatasourceEnum];
/**
 * @export
 */
export declare const GetMarketsGroupsDatasourceEnum: {
    readonly Tranquility: "tranquility";
};
export type GetMarketsGroupsDatasourceEnum = typeof GetMarketsGroupsDatasourceEnum[keyof typeof GetMarketsGroupsDatasourceEnum];
/**
 * @export
 */
export declare const GetMarketsGroupsMarketGroupIdAcceptLanguageEnum: {
    readonly En: "en";
    readonly EnUs: "en-us";
    readonly De: "de";
    readonly Fr: "fr";
    readonly Ja: "ja";
    readonly Ru: "ru";
    readonly Zh: "zh";
    readonly Ko: "ko";
    readonly Es: "es";
};
export type GetMarketsGroupsMarketGroupIdAcceptLanguageEnum = typeof GetMarketsGroupsMarketGroupIdAcceptLanguageEnum[keyof typeof GetMarketsGroupsMarketGroupIdAcceptLanguageEnum];
/**
 * @export
 */
export declare const GetMarketsGroupsMarketGroupIdDatasourceEnum: {
    readonly Tranquility: "tranquility";
};
export type GetMarketsGroupsMarketGroupIdDatasourceEnum = typeof GetMarketsGroupsMarketGroupIdDatasourceEnum[keyof typeof GetMarketsGroupsMarketGroupIdDatasourceEnum];
/**
 * @export
 */
export declare const GetMarketsGroupsMarketGroupIdLanguageEnum: {
    readonly En: "en";
    readonly EnUs: "en-us";
    readonly De: "de";
    readonly Fr: "fr";
    readonly Ja: "ja";
    readonly Ru: "ru";
    readonly Zh: "zh";
    readonly Ko: "ko";
    readonly Es: "es";
};
export type GetMarketsGroupsMarketGroupIdLanguageEnum = typeof GetMarketsGroupsMarketGroupIdLanguageEnum[keyof typeof GetMarketsGroupsMarketGroupIdLanguageEnum];
/**
 * @export
 */
export declare const GetMarketsPricesDatasourceEnum: {
    readonly Tranquility: "tranquility";
};
export type GetMarketsPricesDatasourceEnum = typeof GetMarketsPricesDatasourceEnum[keyof typeof GetMarketsPricesDatasourceEnum];
/**
 * @export
 */
export declare const GetMarketsRegionIdHistoryDatasourceEnum: {
    readonly Tranquility: "tranquility";
};
export type GetMarketsRegionIdHistoryDatasourceEnum = typeof GetMarketsRegionIdHistoryDatasourceEnum[keyof typeof GetMarketsRegionIdHistoryDatasourceEnum];
/**
 * @export
 */
export declare const GetMarketsRegionIdOrdersOrderTypeEnum: {
    readonly Buy: "buy";
    readonly Sell: "sell";
    readonly All: "all";
};
export type GetMarketsRegionIdOrdersOrderTypeEnum = typeof GetMarketsRegionIdOrdersOrderTypeEnum[keyof typeof GetMarketsRegionIdOrdersOrderTypeEnum];
/**
 * @export
 */
export declare const GetMarketsRegionIdOrdersDatasourceEnum: {
    readonly Tranquility: "tranquility";
};
export type GetMarketsRegionIdOrdersDatasourceEnum = typeof GetMarketsRegionIdOrdersDatasourceEnum[keyof typeof GetMarketsRegionIdOrdersDatasourceEnum];
/**
 * @export
 */
export declare const GetMarketsRegionIdTypesDatasourceEnum: {
    readonly Tranquility: "tranquility";
};
export type GetMarketsRegionIdTypesDatasourceEnum = typeof GetMarketsRegionIdTypesDatasourceEnum[keyof typeof GetMarketsRegionIdTypesDatasourceEnum];
/**
 * @export
 */
export declare const GetMarketsStructuresStructureIdDatasourceEnum: {
    readonly Tranquility: "tranquility";
};
export type GetMarketsStructuresStructureIdDatasourceEnum = typeof GetMarketsStructuresStructureIdDatasourceEnum[keyof typeof GetMarketsStructuresStructureIdDatasourceEnum];
//# sourceMappingURL=MarketApi.d.ts.map