@universalis-ffxiv/universalis-client 0.1.0

package/dist/v1.d.ts

@@ -0,0 +1,1158 @@
+export interface IClient {
+    /**
+     * Returns all data centers supported by the API.
+     * @return Success
+     */
+    dataCenters(): Promise<DataCenter[]>;
+    /**
+     * Returns the IDs and names of all worlds supported by the API.
+     * @return Success
+     */
+    worlds(): Promise<World[]>;
+    /**
+     * Returns the content object associated with the provided content ID. Please note that this endpoint is largely untested,
+    and may return inconsistent data at times.
+     * @param contentId The ID of the content object to retrieve.
+     * @return Success
+     */
+    content(contentId: string): Promise<ContentView>;
+    /**
+     * Get the least-recently updated items on the specified world or data center, along with the upload times for each item.
+     * @param world (optional) The world to request data for.
+     * @param dcName (optional) The data center to request data for.
+     * @param entries (optional) The number of entries to return (default 50, max 200).
+     * @return Success
+     */
+    leastRecentlyUpdated(world?: string | undefined, dcName?: string | undefined, entries?: string | undefined): Promise<MostRecentlyUpdatedItemsView>;
+    /**
+     * Retrieves the data currently shown on the market board for the requested item and world or data center.
+    Up to 100 item IDs can be comma-separated in order to retrieve data for multiple items at once.
+     * @param itemIds The item ID or comma-separated item IDs to retrieve data for.
+     * @param worldDcRegion The world, data center, or region to retrieve data for. This may be an ID or a name. Regions should be specified as Japan, Europe, North-America, Oceania, China, or 中国.
+     * @param listings (optional) The number of listings to return per item. By default, all listings will be returned.
+     * @param entries (optional) The number of recent history entries to return per item. By default, a maximum of 5 entries will be returned.
+     * @param hq (optional) Filter for HQ listings and entries. By default, both HQ and NQ listings and entries will be returned.
+     * @param statsWithin (optional) The amount of time before now to calculate stats over, in milliseconds. By default, this is 7 days.
+     * @param entriesWithin (optional) The amount of time before now to take entries within, in seconds. Negative values will be ignored.
+     * @param fields (optional) A comma separated list of fields that should be included in the response, if omitted will return all fields.
+    For example, if you're only interested in the listings price per unit you can set this to listings.pricePerUnit.
+    Note that querying multiple items changes the response schema, which should be reflected in the value provided
+    for this field. In this case, querying the price per unit requires setting this field to
+    items.listings.pricePerUnit.
+     * @param user_Agent (optional)
+     * @param cF_Connecting_IP (optional)
+     * @return Data retrieved successfully.
+     */
+    api(itemIds: string, worldDcRegion: string, listings?: string | undefined, entries?: string | undefined, hq?: string | undefined, statsWithin?: string | undefined, entriesWithin?: string | undefined, fields?: string | undefined, user_Agent?: string | undefined, cF_Connecting_IP?: string | undefined): Promise<CurrentlyShownMultiView>;
+    /**
+     * Retrieves the history data for the requested item and world or data center.
+    Up to 100 item IDs can be comma-separated in order to retrieve data for multiple items at once.
+     * @param itemIds The item ID or comma-separated item IDs to retrieve data for.
+     * @param worldDcRegion The world or data center to retrieve data for. This may be an ID or a name. Regions should be specified as Japan, Europe, North-America, Oceania, China, or 中国.
+     * @param entries (optional) The number of entries to return per item. By default, this is set to 1800, but may be set to a maximum of 99999.
+     * @param statsWithin (optional) The amount of time before now to calculate stats over, in milliseconds. By default, this is 7 days.
+     * @param entriesWithin (optional) The amount of time before entriesUntil or now to take entries within, in seconds. Negative values will be ignored. By default, this is 7 days.
+     * @param entriesUntil (optional) The UNIX timestamp in seconds to take entries until. Negative values will be ignored. By default, this is current time.
+     * @param minSalePrice (optional) The inclusive minimum unit sale price of entries to return.
+     * @param maxSalePrice (optional) The inclusive maximum unit sale price of entries to return.
+     * @param user_Agent (optional)
+     * @param cF_Connecting_IP (optional)
+     * @return Data retrieved successfully.
+     */
+    history(itemIds: string, worldDcRegion: string, entries?: string | undefined, statsWithin?: string | undefined, entriesWithin?: string | undefined, entriesUntil?: string | undefined, minSalePrice?: number | undefined, maxSalePrice?: number | undefined, user_Agent?: string | undefined, cF_Connecting_IP?: string | undefined): Promise<HistoryMultiView>;
+    /**
+     * Retrieves the current tax rate data for the specified world. This data is provided by the Retainer Vocate in each major city.
+     * @param world (optional) The world or to retrieve data for. This may be an ID or a name.
+     * @param user_Agent (optional)
+     * @return Data retrieved successfully.
+     */
+    taxRates(world?: string | undefined, user_Agent?: string | undefined): Promise<TaxRatesView>;
+    /**
+     * Returns the set of marketable item IDs.
+     * @return Success
+     */
+    marketable(): Promise<number[]>;
+    /**
+     * Get the most-recently updated items on the specified world or data center, along with the upload times for each item.
+     * @param world (optional) The world to request data for.
+     * @param dcName (optional) The data center to request data for.
+     * @param entries (optional) The number of entries to return (default 50, max 200).
+     * @return Success
+     */
+    mostRecentlyUpdated(world?: string | undefined, dcName?: string | undefined, entries?: string | undefined): Promise<MostRecentlyUpdatedItemsView>;
+    /**
+     * Returns a list of some of the most recently updated items on the website. This endpoint
+    is a legacy endpoint and does not include any data on which worlds or data centers the updates happened on.
+     * @return Success
+     */
+    recentlyUpdated(): Promise<RecentlyUpdatedItemsView>;
+    /**
+     * @param body (optional)
+     * @return Success
+     */
+    upload(apiKey: string, body?: UploadParameters | undefined): Promise<void>;
+    /**
+     * Returns the total upload counts for each client application that uploads data to Universalis.
+     * @return Success
+     */
+    uploaderUploadCounts(): Promise<SourceUploadCountView[]>;
+    /**
+     * Returns the world upload counts and proportions of the total uploads for each world.
+     * @return Success
+     */
+    worldUploadCounts(): Promise<{
+        [key: string]: WorldUploadCountView;
+    }>;
+    /**
+     * Returns the number of uploads per day over the past 30 days.
+     * @return Success
+     */
+    uploadHistory(): Promise<UploadCountHistoryView>;
+    /**
+     * Retrieves a user list.
+     * @param listId The ID of the list to retrieve.
+     * @return Data retrieved successfully.
+     */
+    lists(listId: string): Promise<UserListView>;
+    /**
+     * Connect to the WebSocket endpoint of the API. Requires a valid WebSocket client.
+     * @return Success
+     */
+    ws(): Promise<void>;
+    /**
+     * Connect to the WebSocket dev endpoint of the API. Requires a valid WebSocket client.
+     * @return Success
+     */
+    wsDev(): Promise<void>;
+}
+export declare class Client implements IClient {
+    private http;
+    private baseUrl;
+    protected jsonParseReviver: ((key: string, value: any) => any) | undefined;
+    constructor(baseUrl?: string, http?: {
+        fetch(url: RequestInfo, init?: RequestInit): Promise<Response>;
+    });
+    /**
+     * Returns all data centers supported by the API.
+     * @return Success
+     */
+    dataCenters(): Promise<DataCenter[]>;
+    protected processDataCenters(response: Response): Promise<DataCenter[]>;
+    /**
+     * Returns the IDs and names of all worlds supported by the API.
+     * @return Success
+     */
+    worlds(): Promise<World[]>;
+    protected processWorlds(response: Response): Promise<World[]>;
+    /**
+     * Returns the content object associated with the provided content ID. Please note that this endpoint is largely untested,
+    and may return inconsistent data at times.
+     * @param contentId The ID of the content object to retrieve.
+     * @return Success
+     */
+    content(contentId: string): Promise<ContentView>;
+    protected processContent(response: Response): Promise<ContentView>;
+    /**
+     * Get the least-recently updated items on the specified world or data center, along with the upload times for each item.
+     * @param world (optional) The world to request data for.
+     * @param dcName (optional) The data center to request data for.
+     * @param entries (optional) The number of entries to return (default 50, max 200).
+     * @return Success
+     */
+    leastRecentlyUpdated(world?: string | undefined, dcName?: string | undefined, entries?: string | undefined): Promise<MostRecentlyUpdatedItemsView>;
+    protected processLeastRecentlyUpdated(response: Response): Promise<MostRecentlyUpdatedItemsView>;
+    /**
+     * Retrieves the data currently shown on the market board for the requested item and world or data center.
+    Up to 100 item IDs can be comma-separated in order to retrieve data for multiple items at once.
+     * @param itemIds The item ID or comma-separated item IDs to retrieve data for.
+     * @param worldDcRegion The world, data center, or region to retrieve data for. This may be an ID or a name. Regions should be specified as Japan, Europe, North-America, Oceania, China, or 中国.
+     * @param listings (optional) The number of listings to return per item. By default, all listings will be returned.
+     * @param entries (optional) The number of recent history entries to return per item. By default, a maximum of 5 entries will be returned.
+     * @param hq (optional) Filter for HQ listings and entries. By default, both HQ and NQ listings and entries will be returned.
+     * @param statsWithin (optional) The amount of time before now to calculate stats over, in milliseconds. By default, this is 7 days.
+     * @param entriesWithin (optional) The amount of time before now to take entries within, in seconds. Negative values will be ignored.
+     * @param fields (optional) A comma separated list of fields that should be included in the response, if omitted will return all fields.
+    For example, if you're only interested in the listings price per unit you can set this to listings.pricePerUnit.
+    Note that querying multiple items changes the response schema, which should be reflected in the value provided
+    for this field. In this case, querying the price per unit requires setting this field to
+    items.listings.pricePerUnit.
+     * @param user_Agent (optional)
+     * @param cF_Connecting_IP (optional)
+     * @return Data retrieved successfully.
+     */
+    api(itemIds: string, worldDcRegion: string, listings?: string | undefined, entries?: string | undefined, hq?: string | undefined, statsWithin?: string | undefined, entriesWithin?: string | undefined, fields?: string | undefined, user_Agent?: string | undefined, cF_Connecting_IP?: string | undefined): Promise<CurrentlyShownMultiView>;
+    protected processApi(response: Response): Promise<CurrentlyShownMultiView>;
+    /**
+     * Retrieves the history data for the requested item and world or data center.
+    Up to 100 item IDs can be comma-separated in order to retrieve data for multiple items at once.
+     * @param itemIds The item ID or comma-separated item IDs to retrieve data for.
+     * @param worldDcRegion The world or data center to retrieve data for. This may be an ID or a name. Regions should be specified as Japan, Europe, North-America, Oceania, China, or 中国.
+     * @param entries (optional) The number of entries to return per item. By default, this is set to 1800, but may be set to a maximum of 99999.
+     * @param statsWithin (optional) The amount of time before now to calculate stats over, in milliseconds. By default, this is 7 days.
+     * @param entriesWithin (optional) The amount of time before entriesUntil or now to take entries within, in seconds. Negative values will be ignored. By default, this is 7 days.
+     * @param entriesUntil (optional) The UNIX timestamp in seconds to take entries until. Negative values will be ignored. By default, this is current time.
+     * @param minSalePrice (optional) The inclusive minimum unit sale price of entries to return.
+     * @param maxSalePrice (optional) The inclusive maximum unit sale price of entries to return.
+     * @param user_Agent (optional)
+     * @param cF_Connecting_IP (optional)
+     * @return Data retrieved successfully.
+     */
+    history(itemIds: string, worldDcRegion: string, entries?: string | undefined, statsWithin?: string | undefined, entriesWithin?: string | undefined, entriesUntil?: string | undefined, minSalePrice?: number | undefined, maxSalePrice?: number | undefined, user_Agent?: string | undefined, cF_Connecting_IP?: string | undefined): Promise<HistoryMultiView>;
+    protected processHistory(response: Response): Promise<HistoryMultiView>;
+    /**
+     * Retrieves the current tax rate data for the specified world. This data is provided by the Retainer Vocate in each major city.
+     * @param world (optional) The world or to retrieve data for. This may be an ID or a name.
+     * @param user_Agent (optional)
+     * @return Data retrieved successfully.
+     */
+    taxRates(world?: string | undefined, user_Agent?: string | undefined): Promise<TaxRatesView>;
+    protected processTaxRates(response: Response): Promise<TaxRatesView>;
+    /**
+     * Returns the set of marketable item IDs.
+     * @return Success
+     */
+    marketable(): Promise<number[]>;
+    protected processMarketable(response: Response): Promise<number[]>;
+    /**
+     * Get the most-recently updated items on the specified world or data center, along with the upload times for each item.
+     * @param world (optional) The world to request data for.
+     * @param dcName (optional) The data center to request data for.
+     * @param entries (optional) The number of entries to return (default 50, max 200).
+     * @return Success
+     */
+    mostRecentlyUpdated(world?: string | undefined, dcName?: string | undefined, entries?: string | undefined): Promise<MostRecentlyUpdatedItemsView>;
+    protected processMostRecentlyUpdated(response: Response): Promise<MostRecentlyUpdatedItemsView>;
+    /**
+     * Returns a list of some of the most recently updated items on the website. This endpoint
+    is a legacy endpoint and does not include any data on which worlds or data centers the updates happened on.
+     * @return Success
+     */
+    recentlyUpdated(): Promise<RecentlyUpdatedItemsView>;
+    protected processRecentlyUpdated(response: Response): Promise<RecentlyUpdatedItemsView>;
+    /**
+     * @param body (optional)
+     * @return Success
+     */
+    upload(apiKey: string, body?: UploadParameters | undefined): Promise<void>;
+    protected processUpload(response: Response): Promise<void>;
+    /**
+     * Returns the total upload counts for each client application that uploads data to Universalis.
+     * @return Success
+     */
+    uploaderUploadCounts(): Promise<SourceUploadCountView[]>;
+    protected processUploaderUploadCounts(response: Response): Promise<SourceUploadCountView[]>;
+    /**
+     * Returns the world upload counts and proportions of the total uploads for each world.
+     * @return Success
+     */
+    worldUploadCounts(): Promise<{
+        [key: string]: WorldUploadCountView;
+    }>;
+    protected processWorldUploadCounts(response: Response): Promise<{
+        [key: string]: WorldUploadCountView;
+    }>;
+    /**
+     * Returns the number of uploads per day over the past 30 days.
+     * @return Success
+     */
+    uploadHistory(): Promise<UploadCountHistoryView>;
+    protected processUploadHistory(response: Response): Promise<UploadCountHistoryView>;
+    /**
+     * Retrieves a user list.
+     * @param listId The ID of the list to retrieve.
+     * @return Data retrieved successfully.
+     */
+    lists(listId: string): Promise<UserListView>;
+    protected processLists(response: Response): Promise<UserListView>;
+    /**
+     * Connect to the WebSocket endpoint of the API. Requires a valid WebSocket client.
+     * @return Success
+     */
+    ws(): Promise<void>;
+    protected processWs(response: Response): Promise<void>;
+    /**
+     * Connect to the WebSocket dev endpoint of the API. Requires a valid WebSocket client.
+     * @return Success
+     */
+    wsDev(): Promise<void>;
+    protected processWsDev(response: Response): Promise<void>;
+}
+export declare class ProblemDetails implements IProblemDetails {
+    type?: string | undefined;
+    title?: string | undefined;
+    status?: number | undefined;
+    detail?: string | undefined;
+    instance?: string | undefined;
+    [key: string]: any;
+    constructor(data?: IProblemDetails);
+    init(_data?: any): void;
+    static fromJS(data: any): ProblemDetails;
+    toJSON(data?: any): any;
+}
+export interface IProblemDetails {
+    type?: string | undefined;
+    title?: string | undefined;
+    status?: number | undefined;
+    detail?: string | undefined;
+    instance?: string | undefined;
+    [key: string]: any;
+}
+export declare class Listing implements IListing {
+    listingID?: any | undefined;
+    hq?: any | undefined;
+    pricePerUnit?: number | undefined;
+    quantity?: number | undefined;
+    retainerName?: string | undefined;
+    retainerID?: any | undefined;
+    retainerCity?: number | undefined;
+    creatorName?: string | undefined;
+    onMannequin?: any | undefined;
+    sellerID?: any | undefined;
+    creatorID?: any | undefined;
+    stainID?: number | undefined;
+    lastReviewTime?: number | undefined;
+    materia?: Materia[] | undefined;
+    constructor(data?: IListing);
+    init(_data?: any): void;
+    static fromJS(data: any): Listing;
+    toJSON(data?: any): any;
+}
+export interface IListing {
+    listingID?: any | undefined;
+    hq?: any | undefined;
+    pricePerUnit?: number | undefined;
+    quantity?: number | undefined;
+    retainerName?: string | undefined;
+    retainerID?: any | undefined;
+    retainerCity?: number | undefined;
+    creatorName?: string | undefined;
+    onMannequin?: any | undefined;
+    sellerID?: any | undefined;
+    creatorID?: any | undefined;
+    stainID?: number | undefined;
+    lastReviewTime?: number | undefined;
+    materia?: Materia[] | undefined;
+}
+export declare class MarketTaxRates implements IMarketTaxRates {
+    limsaLominsa?: number | undefined;
+    gridania?: number | undefined;
+    uldah?: number | undefined;
+    ishgard?: number | undefined;
+    kugane?: number | undefined;
+    crystarium?: number | undefined;
+    sharlayan?: number | undefined;
+    tuliyollal?: number | undefined;
+    constructor(data?: IMarketTaxRates);
+    init(_data?: any): void;
+    static fromJS(data: any): MarketTaxRates;
+    toJSON(data?: any): any;
+}
+export interface IMarketTaxRates {
+    limsaLominsa?: number | undefined;
+    gridania?: number | undefined;
+    uldah?: number | undefined;
+    ishgard?: number | undefined;
+    kugane?: number | undefined;
+    crystarium?: number | undefined;
+    sharlayan?: number | undefined;
+    tuliyollal?: number | undefined;
+}
+export declare class Materia implements IMateria {
+    slotID?: number | undefined;
+    materiaID?: number | undefined;
+    constructor(data?: IMateria);
+    init(_data?: any): void;
+    static fromJS(data: any): Materia;
+    toJSON(data?: any): any;
+}
+export interface IMateria {
+    slotID?: number | undefined;
+    materiaID?: number | undefined;
+}
+export declare class Sale implements ISale {
+    hq?: any | undefined;
+    pricePerUnit?: number | undefined;
+    quantity?: number | undefined;
+    buyerName?: string | undefined;
+    onMannequin?: any | undefined;
+    sellerID?: any | undefined;
+    buyerID?: any | undefined;
+    timestamp?: number | undefined;
+    constructor(data?: ISale);
+    init(_data?: any): void;
+    static fromJS(data: any): Sale;
+    toJSON(data?: any): any;
+}
+export interface ISale {
+    hq?: any | undefined;
+    pricePerUnit?: number | undefined;
+    quantity?: number | undefined;
+    buyerName?: string | undefined;
+    onMannequin?: any | undefined;
+    sellerID?: any | undefined;
+    buyerID?: any | undefined;
+    timestamp?: number | undefined;
+}
+export declare class UploadParameters implements IUploadParameters {
+    uploaderID?: any | undefined;
+    worldID?: number | undefined;
+    itemID?: number | undefined;
+    marketTaxRates: MarketTaxRates;
+    listings?: Listing[] | undefined;
+    entries?: Sale[] | undefined;
+    contentID?: any | undefined;
+    characterName?: string | undefined;
+    constructor(data?: IUploadParameters);
+    init(_data?: any): void;
+    static fromJS(data: any): UploadParameters;
+    toJSON(data?: any): any;
+}
+export interface IUploadParameters {
+    uploaderID?: any | undefined;
+    worldID?: number | undefined;
+    itemID?: number | undefined;
+    marketTaxRates: MarketTaxRates;
+    listings?: Listing[] | undefined;
+    entries?: Sale[] | undefined;
+    contentID?: any | undefined;
+    characterName?: string | undefined;
+}
+export declare class CurrentlyShownMultiView implements ICurrentlyShownMultiView {
+    /** The item IDs that were requested. */
+    itemIDs?: number[] | undefined;
+    /** The item data that was requested, as a list. Use the nested item IDs
+to pull the item you want, or consider using the v2 endpoint instead. */
+    items?: CurrentlyShownView[] | undefined;
+    /** The ID of the world requested, if applicable. */
+    worldID?: number | undefined;
+    /** The name of the DC requested, if applicable. */
+    dcName?: string | undefined;
+    /** The name of the region requested, if applicable. */
+    regionName?: string | undefined;
+    /** A list of IDs that could not be resolved to any item data. */
+    unresolvedItems?: number[] | undefined;
+    /** The name of the world requested, if applicable. */
+    worldName?: string | undefined;
+    constructor(data?: ICurrentlyShownMultiView);
+    init(_data?: any): void;
+    static fromJS(data: any): CurrentlyShownMultiView;
+    toJSON(data?: any): any;
+}
+export interface ICurrentlyShownMultiView {
+    /** The item IDs that were requested. */
+    itemIDs?: number[] | undefined;
+    /** The item data that was requested, as a list. Use the nested item IDs
+to pull the item you want, or consider using the v2 endpoint instead. */
+    items?: CurrentlyShownView[] | undefined;
+    /** The ID of the world requested, if applicable. */
+    worldID?: number | undefined;
+    /** The name of the DC requested, if applicable. */
+    dcName?: string | undefined;
+    /** The name of the region requested, if applicable. */
+    regionName?: string | undefined;
+    /** A list of IDs that could not be resolved to any item data. */
+    unresolvedItems?: number[] | undefined;
+    /** The name of the world requested, if applicable. */
+    worldName?: string | undefined;
+}
+export declare class CurrentlyShownView implements ICurrentlyShownView {
+    /** The item ID. */
+    itemID: number;
+    /** The world ID, if applicable. */
+    worldID?: number | undefined;
+    /** The last upload time for this endpoint, in milliseconds since the UNIX epoch. */
+    lastUploadTime: number;
+    /** The currently-shown listings. */
+    listings?: ListingView[] | undefined;
+    /** The currently-shown sales. */
+    recentHistory?: SaleView[] | undefined;
+    /** The DC name, if applicable. */
+    dcName?: string | undefined;
+    /** The region name, if applicable. */
+    regionName?: string | undefined;
+    /** The average listing price. */
+    currentAveragePrice: number;
+    /** The average NQ listing price. */
+    currentAveragePriceNQ: number;
+    /** The average HQ listing price. */
+    currentAveragePriceHQ: number;
+    /** The average number of sales per day, over the past seven days (or the entirety of the shown sales, whichever comes first).
+This number will tend to be the same for every item, because the number of shown sales is the same and over the same period.
+This statistic is more useful in historical queries. */
+    regularSaleVelocity: number;
+    /** The average number of NQ sales per day, over the past seven days (or the entirety of the shown sales, whichever comes first).
+This number will tend to be the same for every item, because the number of shown sales is the same and over the same period.
+This statistic is more useful in historical queries. */
+    nqSaleVelocity: number;
+    /** The average number of HQ sales per day, over the past seven days (or the entirety of the shown sales, whichever comes first).
+This number will tend to be the same for every item, because the number of shown sales is the same and over the same period.
+This statistic is more useful in historical queries. */
+    hqSaleVelocity: number;
+    /** The average sale price. */
+    averagePrice: number;
+    /** The average NQ sale price. */
+    averagePriceNQ: number;
+    /** The average HQ sale price. */
+    averagePriceHQ: number;
+    /** The minimum listing price. */
+    minPrice: number;
+    /** The minimum NQ listing price. */
+    minPriceNQ: number;
+    /** The minimum HQ listing price. */
+    minPriceHQ: number;
+    /** The maximum listing price. */
+    maxPrice: number;
+    /** The maximum NQ listing price. */
+    maxPriceNQ: number;
+    /** The maximum HQ listing price. */
+    maxPriceHQ: number;
+    /** A map of quantities to listing counts, representing the number of listings of each quantity. */
+    stackSizeHistogram?: {
+        [key: string]: number;
+    } | undefined;
+    /** A map of quantities to NQ listing counts, representing the number of listings of each quantity. */
+    stackSizeHistogramNQ?: {
+        [key: string]: number;
+    } | undefined;
+    /** A map of quantities to HQ listing counts, representing the number of listings of each quantity. */
+    stackSizeHistogramHQ?: {
+        [key: string]: number;
+    } | undefined;
+    /** The world name, if applicable. */
+    worldName?: string | undefined;
+    /** The last upload times in milliseconds since epoch for each world in the response, if this is a DC request. */
+    worldUploadTimes?: {
+        [key: string]: number;
+    } | undefined;
+    /** The number of listings retrieved for the request. When using the "listings" limit parameter, this may be
+different from the number of sale entries returned in an API response. */
+    listingsCount: number;
+    /** The number of sale entries retrieved for the request. When using the "entries" limit parameter, this may be
+different from the number of sale entries returned in an API response. */
+    recentHistoryCount: number;
+    /** The number of items (not listings) up for sale. */
+    unitsForSale: number;
+    /** The number of items (not sale entries) sold over the retrieved sales. */
+    unitsSold: number;
+    /** Whether this item has ever been updated. Useful for newly-released items. */
+    readonly hasData: boolean;
+    constructor(data?: ICurrentlyShownView);
+    init(_data?: any): void;
+    static fromJS(data: any): CurrentlyShownView;
+    toJSON(data?: any): any;
+}
+export interface ICurrentlyShownView {
+    /** The item ID. */
+    itemID: number;
+    /** The world ID, if applicable. */
+    worldID?: number | undefined;
+    /** The last upload time for this endpoint, in milliseconds since the UNIX epoch. */
+    lastUploadTime: number;
+    /** The currently-shown listings. */
+    listings?: ListingView[] | undefined;
+    /** The currently-shown sales. */
+    recentHistory?: SaleView[] | undefined;
+    /** The DC name, if applicable. */
+    dcName?: string | undefined;
+    /** The region name, if applicable. */
+    regionName?: string | undefined;
+    /** The average listing price. */
+    currentAveragePrice: number;
+    /** The average NQ listing price. */
+    currentAveragePriceNQ: number;
+    /** The average HQ listing price. */
+    currentAveragePriceHQ: number;
+    /** The average number of sales per day, over the past seven days (or the entirety of the shown sales, whichever comes first).
+This number will tend to be the same for every item, because the number of shown sales is the same and over the same period.
+This statistic is more useful in historical queries. */
+    regularSaleVelocity: number;
+    /** The average number of NQ sales per day, over the past seven days (or the entirety of the shown sales, whichever comes first).
+This number will tend to be the same for every item, because the number of shown sales is the same and over the same period.
+This statistic is more useful in historical queries. */
+    nqSaleVelocity: number;
+    /** The average number of HQ sales per day, over the past seven days (or the entirety of the shown sales, whichever comes first).
+This number will tend to be the same for every item, because the number of shown sales is the same and over the same period.
+This statistic is more useful in historical queries. */
+    hqSaleVelocity: number;
+    /** The average sale price. */
+    averagePrice: number;
+    /** The average NQ sale price. */
+    averagePriceNQ: number;
+    /** The average HQ sale price. */
+    averagePriceHQ: number;
+    /** The minimum listing price. */
+    minPrice: number;
+    /** The minimum NQ listing price. */
+    minPriceNQ: number;
+    /** The minimum HQ listing price. */
+    minPriceHQ: number;
+    /** The maximum listing price. */
+    maxPrice: number;
+    /** The maximum NQ listing price. */
+    maxPriceNQ: number;
+    /** The maximum HQ listing price. */
+    maxPriceHQ: number;
+    /** A map of quantities to listing counts, representing the number of listings of each quantity. */
+    stackSizeHistogram?: {
+        [key: string]: number;
+    } | undefined;
+    /** A map of quantities to NQ listing counts, representing the number of listings of each quantity. */
+    stackSizeHistogramNQ?: {
+        [key: string]: number;
+    } | undefined;
+    /** A map of quantities to HQ listing counts, representing the number of listings of each quantity. */
+    stackSizeHistogramHQ?: {
+        [key: string]: number;
+    } | undefined;
+    /** The world name, if applicable. */
+    worldName?: string | undefined;
+    /** The last upload times in milliseconds since epoch for each world in the response, if this is a DC request. */
+    worldUploadTimes?: {
+        [key: string]: number;
+    } | undefined;
+    /** The number of listings retrieved for the request. When using the "listings" limit parameter, this may be
+different from the number of sale entries returned in an API response. */
+    listingsCount: number;
+    /** The number of sale entries retrieved for the request. When using the "entries" limit parameter, this may be
+different from the number of sale entries returned in an API response. */
+    recentHistoryCount: number;
+    /** The number of items (not listings) up for sale. */
+    unitsForSale: number;
+    /** The number of items (not sale entries) sold over the retrieved sales. */
+    unitsSold: number;
+    /** Whether this item has ever been updated. Useful for newly-released items. */
+    hasData: boolean;
+}
+export declare class ContentView implements IContentView {
+    /** The content ID of the object. */
+    contentID?: string | undefined;
+    /** The content type of this object. */
+    contentType?: string | undefined;
+    /** The character name associated with this character object, if this is one. */
+    characterName?: string | undefined;
+    constructor(data?: IContentView);
+    init(_data?: any): void;
+    static fromJS(data: any): ContentView;
+    toJSON(data?: any): any;
+}
+export interface IContentView {
+    /** The content ID of the object. */
+    contentID?: string | undefined;
+    /** The content type of this object. */
+    contentType?: string | undefined;
+    /** The character name associated with this character object, if this is one. */
+    characterName?: string | undefined;
+}
+export declare class MostRecentlyUpdatedItemsView implements IMostRecentlyUpdatedItemsView {
+    /** A list of item upload information in timestamp-descending order. */
+    items?: WorldItemRecencyView[] | undefined;
+    constructor(data?: IMostRecentlyUpdatedItemsView);
+    init(_data?: any): void;
+    static fromJS(data: any): MostRecentlyUpdatedItemsView;
+    toJSON(data?: any): any;
+}
+export interface IMostRecentlyUpdatedItemsView {
+    /** A list of item upload information in timestamp-descending order. */
+    items?: WorldItemRecencyView[] | undefined;
+}
+export declare class RecentlyUpdatedItemsView implements IRecentlyUpdatedItemsView {
+    /** A list of item IDs, with the most recent first. */
+    items?: number[] | undefined;
+    constructor(data?: IRecentlyUpdatedItemsView);
+    init(_data?: any): void;
+    static fromJS(data: any): RecentlyUpdatedItemsView;
+    toJSON(data?: any): any;
+}
+export interface IRecentlyUpdatedItemsView {
+    /** A list of item IDs, with the most recent first. */
+    items?: number[] | undefined;
+}
+export declare class SourceUploadCountView implements ISourceUploadCountView {
+    /** The name of the client application. */
+    sourceName?: string | undefined;
+    /** The number of uploads originating from the client application. */
+    uploadCount: number;
+    constructor(data?: ISourceUploadCountView);
+    init(_data?: any): void;
+    static fromJS(data: any): SourceUploadCountView;
+    toJSON(data?: any): any;
+}
+export interface ISourceUploadCountView {
+    /** The name of the client application. */
+    sourceName?: string | undefined;
+    /** The number of uploads originating from the client application. */
+    uploadCount: number;
+}
+export declare class UploadCountHistoryView implements IUploadCountHistoryView {
+    /** The list of upload counts per day, over the past 30 days. */
+    uploadCountByDay?: number[] | undefined;
+    constructor(data?: IUploadCountHistoryView);
+    init(_data?: any): void;
+    static fromJS(data: any): UploadCountHistoryView;
+    toJSON(data?: any): any;
+}
+export interface IUploadCountHistoryView {
+    /** The list of upload counts per day, over the past 30 days. */
+    uploadCountByDay?: number[] | undefined;
+}
+export declare class WorldItemRecencyView implements IWorldItemRecencyView {
+    /** The item ID. */
+    itemID: number;
+    /** The last upload time for the item on the listed world. */
+    lastUploadTime: number;
+    /** The world ID. */
+    worldID: number;
+    /** The world name. */
+    worldName?: string | undefined;
+    constructor(data?: IWorldItemRecencyView);
+    init(_data?: any): void;
+    static fromJS(data: any): WorldItemRecencyView;
+    toJSON(data?: any): any;
+}
+export interface IWorldItemRecencyView {
+    /** The item ID. */
+    itemID: number;
+    /** The last upload time for the item on the listed world. */
+    lastUploadTime: number;
+    /** The world ID. */
+    worldID: number;
+    /** The world name. */
+    worldName?: string | undefined;
+}
+export declare class WorldUploadCountView implements IWorldUploadCountView {
+    /** The number of times an upload has occurred on this world. */
+    count: number;
+    /** The proportion of uploads on this world to the total number of uploads. */
+    proportion: number;
+    constructor(data?: IWorldUploadCountView);
+    init(_data?: any): void;
+    static fromJS(data: any): WorldUploadCountView;
+    toJSON(data?: any): any;
+}
+export interface IWorldUploadCountView {
+    /** The number of times an upload has occurred on this world. */
+    count: number;
+    /** The proportion of uploads on this world to the total number of uploads. */
+    proportion: number;
+}
+export declare class HistoryMultiView implements IHistoryMultiView {
+    /** The item IDs that were requested. */
+    itemIDs?: number[] | undefined;
+    /** The item data that was requested, as a list. Use the nested item IDs
+to pull the item you want, or consider using the v2 endpoint instead. */
+    items?: HistoryView[] | undefined;
+    /** The ID of the world requested, if applicable. */
+    worldID?: number | undefined;
+    /** The name of the DC requested, if applicable. */
+    dcName?: string | undefined;
+    /** The name of the region requested, if applicable. */
+    regionName?: string | undefined;
+    /** A list of IDs that could not be resolved to any item data. */
+    unresolvedItems?: number[] | undefined;
+    /** The name of the world requested, if applicable. */
+    worldName?: string | undefined;
+    constructor(data?: IHistoryMultiView);
+    init(_data?: any): void;
+    static fromJS(data: any): HistoryMultiView;
+    toJSON(data?: any): any;
+}
+export interface IHistoryMultiView {
+    /** The item IDs that were requested. */
+    itemIDs?: number[] | undefined;
+    /** The item data that was requested, as a list. Use the nested item IDs
+to pull the item you want, or consider using the v2 endpoint instead. */
+    items?: HistoryView[] | undefined;
+    /** The ID of the world requested, if applicable. */
+    worldID?: number | undefined;
+    /** The name of the DC requested, if applicable. */
+    dcName?: string | undefined;
+    /** The name of the region requested, if applicable. */
+    regionName?: string | undefined;
+    /** A list of IDs that could not be resolved to any item data. */
+    unresolvedItems?: number[] | undefined;
+    /** The name of the world requested, if applicable. */
+    worldName?: string | undefined;
+}
+export declare class HistoryView implements IHistoryView {
+    /** The item ID. */
+    itemID: number;
+    /** The world ID, if applicable. */
+    worldID?: number | undefined;
+    /** The last upload time for this endpoint, in milliseconds since the UNIX epoch. */
+    lastUploadTime: number;
+    /** The historical sales. */
+    entries?: MinimizedSaleView[] | undefined;
+    /** The DC name, if applicable. */
+    dcName?: string | undefined;
+    /** The region name, if applicable. */
+    regionName?: string | undefined;
+    /** A map of quantities to sale counts, representing the number of sales of each quantity. */
+    stackSizeHistogram?: {
+        [key: string]: number;
+    } | undefined;
+    /** A map of quantities to NQ sale counts, representing the number of sales of each quantity. */
+    stackSizeHistogramNQ?: {
+        [key: string]: number;
+    } | undefined;
+    /** A map of quantities to HQ sale counts, representing the number of sales of each quantity. */
+    stackSizeHistogramHQ?: {
+        [key: string]: number;
+    } | undefined;
+    /** The average number of sales per day, over the past seven days (or the entirety of the shown sales, whichever comes first). */
+    regularSaleVelocity: number;
+    /** The average number of NQ sales per day, over the past seven days (or the entirety of the shown sales, whichever comes first). */
+    nqSaleVelocity: number;
+    /** The average number of HQ sales per day, over the past seven days (or the entirety of the shown sales, whichever comes first). */
+    hqSaleVelocity: number;
+    /** The world name, if applicable. */
+    worldName?: string | undefined;
+    constructor(data?: IHistoryView);
+    init(_data?: any): void;
+    static fromJS(data: any): HistoryView;
+    toJSON(data?: any): any;
+}
+export interface IHistoryView {
+    /** The item ID. */
+    itemID: number;
+    /** The world ID, if applicable. */
+    worldID?: number | undefined;
+    /** The last upload time for this endpoint, in milliseconds since the UNIX epoch. */
+    lastUploadTime: number;
+    /** The historical sales. */
+    entries?: MinimizedSaleView[] | undefined;
+    /** The DC name, if applicable. */
+    dcName?: string | undefined;
+    /** The region name, if applicable. */
+    regionName?: string | undefined;
+    /** A map of quantities to sale counts, representing the number of sales of each quantity. */
+    stackSizeHistogram?: {
+        [key: string]: number;
+    } | undefined;
+    /** A map of quantities to NQ sale counts, representing the number of sales of each quantity. */
+    stackSizeHistogramNQ?: {
+        [key: string]: number;
+    } | undefined;
+    /** A map of quantities to HQ sale counts, representing the number of sales of each quantity. */
+    stackSizeHistogramHQ?: {
+        [key: string]: number;
+    } | undefined;
+    /** The average number of sales per day, over the past seven days (or the entirety of the shown sales, whichever comes first). */
+    regularSaleVelocity: number;
+    /** The average number of NQ sales per day, over the past seven days (or the entirety of the shown sales, whichever comes first). */
+    nqSaleVelocity: number;
+    /** The average number of HQ sales per day, over the past seven days (or the entirety of the shown sales, whichever comes first). */
+    hqSaleVelocity: number;
+    /** The world name, if applicable. */
+    worldName?: string | undefined;
+}
+export declare class ListingView implements IListingView {
+    /** The time that this listing was posted, in seconds since the UNIX epoch. */
+    lastReviewTime: number;
+    /** The price per unit sold. */
+    pricePerUnit: number;
+    /** The stack size sold. */
+    quantity: number;
+    /** The ID of the dye on this item. */
+    stainID: number;
+    /** The world name, if applicable. */
+    worldName?: string | undefined;
+    /** The world ID, if applicable. */
+    worldID?: number | undefined;
+    /** The creator's character name. */
+    creatorName?: string | undefined;
+    /** A SHA256 hash of the creator's ID. */
+    creatorID?: string | undefined;
+    /** Whether or not the item is high-quality. */
+    hq: boolean;
+    /** Whether or not the item is crafted. */
+    isCrafted: boolean;
+    /** The ID of this listing. */
+    listingID?: string | undefined;
+    /** The materia on this item. */
+    materia?: MateriaView[] | undefined;
+    /** Whether or not the item is being sold on a mannequin. */
+    onMannequin: boolean;
+    /** The city ID of the retainer. This is a game ID; all possible values can be seen at
+https://xivapi.com/Town.
+            
+Limsa Lominsa = 1
+Gridania = 2
+Ul'dah = 3
+Ishgard = 4
+Kugane = 7
+Crystarium = 10
+Old Sharlayan = 12 */
+    retainerCity: number;
+    /** The retainer's ID. */
+    retainerID?: string | undefined;
+    /** The retainer's name. */
+    retainerName?: string | undefined;
+    /** A SHA256 hash of the seller's ID. */
+    sellerID?: string | undefined;
+    /** The total price. */
+    total: number;
+    /** The Gil sales tax (GST) to be added to the total price during purchase. */
+    tax: number;
+    constructor(data?: IListingView);
+    init(_data?: any): void;
+    static fromJS(data: any): ListingView;
+    toJSON(data?: any): any;
+}
+export interface IListingView {
+    /** The time that this listing was posted, in seconds since the UNIX epoch. */
+    lastReviewTime: number;
+    /** The price per unit sold. */
+    pricePerUnit: number;
+    /** The stack size sold. */
+    quantity: number;
+    /** The ID of the dye on this item. */
+    stainID: number;
+    /** The world name, if applicable. */
+    worldName?: string | undefined;
+    /** The world ID, if applicable. */
+    worldID?: number | undefined;
+    /** The creator's character name. */
+    creatorName?: string | undefined;
+    /** A SHA256 hash of the creator's ID. */
+    creatorID?: string | undefined;
+    /** Whether or not the item is high-quality. */
+    hq: boolean;
+    /** Whether or not the item is crafted. */
+    isCrafted: boolean;
+    /** The ID of this listing. */
+    listingID?: string | undefined;
+    /** The materia on this item. */
+    materia?: MateriaView[] | undefined;
+    /** Whether or not the item is being sold on a mannequin. */
+    onMannequin: boolean;
+    /** The city ID of the retainer. This is a game ID; all possible values can be seen at
+https://xivapi.com/Town.
+            
+Limsa Lominsa = 1
+Gridania = 2
+Ul'dah = 3
+Ishgard = 4
+Kugane = 7
+Crystarium = 10
+Old Sharlayan = 12 */
+    retainerCity: number;
+    /** The retainer's ID. */
+    retainerID?: string | undefined;
+    /** The retainer's name. */
+    retainerName?: string | undefined;
+    /** A SHA256 hash of the seller's ID. */
+    sellerID?: string | undefined;
+    /** The total price. */
+    total: number;
+    /** The Gil sales tax (GST) to be added to the total price during purchase. */
+    tax: number;
+}
+export declare class MateriaView implements IMateriaView {
+    /** The materia slot. */
+    slotID: number;
+    /** The materia item ID. */
+    materiaID: number;
+    constructor(data?: IMateriaView);
+    init(_data?: any): void;
+    static fromJS(data: any): MateriaView;
+    toJSON(data?: any): any;
+}
+export interface IMateriaView {
+    /** The materia slot. */
+    slotID: number;
+    /** The materia item ID. */
+    materiaID: number;
+}
+export declare class MinimizedSaleView implements IMinimizedSaleView {
+    /** Whether or not the item was high-quality. */
+    hq: boolean;
+    /** The price per unit sold. */
+    pricePerUnit: number;
+    /** The stack size sold. */
+    quantity: number;
+    /** The buyer's character name. This may be null. */
+    buyerName?: string | undefined;
+    /** Whether or not this was purchased from a mannequin. This may be null. */
+    onMannequin?: boolean | undefined;
+    /** The sale time, in seconds since the UNIX epoch. */
+    timestamp: number;
+    /** The world name, if applicable. */
+    worldName?: string | undefined;
+    /** The world ID, if applicable. */
+    worldID?: number | undefined;
+    constructor(data?: IMinimizedSaleView);
+    init(_data?: any): void;
+    static fromJS(data: any): MinimizedSaleView;
+    toJSON(data?: any): any;
+}
+export interface IMinimizedSaleView {
+    /** Whether or not the item was high-quality. */
+    hq: boolean;
+    /** The price per unit sold. */
+    pricePerUnit: number;
+    /** The stack size sold. */
+    quantity: number;
+    /** The buyer's character name. This may be null. */
+    buyerName?: string | undefined;
+    /** Whether or not this was purchased from a mannequin. This may be null. */
+    onMannequin?: boolean | undefined;
+    /** The sale time, in seconds since the UNIX epoch. */
+    timestamp: number;
+    /** The world name, if applicable. */
+    worldName?: string | undefined;
+    /** The world ID, if applicable. */
+    worldID?: number | undefined;
+}
+export declare class SaleView implements ISaleView {
+    /** Whether or not the item was high-quality. */
+    hq: boolean;
+    /** The price per unit sold. */
+    pricePerUnit: number;
+    /** The stack size sold. */
+    quantity: number;
+    /** The sale time, in seconds since the UNIX epoch. */
+    timestamp: number;
+    /** Whether or not this was purchased from a mannequin. This may be null. */
+    onMannequin?: boolean | undefined;
+    /** The world name, if applicable. */
+    worldName?: string | undefined;
+    /** The world ID, if applicable. */
+    worldID?: number | undefined;
+    /** The buyer name. */
+    buyerName?: string | undefined;
+    /** The total price. */
+    total: number;
+    constructor(data?: ISaleView);
+    init(_data?: any): void;
+    static fromJS(data: any): SaleView;
+    toJSON(data?: any): any;
+}
+export interface ISaleView {
+    /** Whether or not the item was high-quality. */
+    hq: boolean;
+    /** The price per unit sold. */
+    pricePerUnit: number;
+    /** The stack size sold. */
+    quantity: number;
+    /** The sale time, in seconds since the UNIX epoch. */
+    timestamp: number;
+    /** Whether or not this was purchased from a mannequin. This may be null. */
+    onMannequin?: boolean | undefined;
+    /** The world name, if applicable. */
+    worldName?: string | undefined;
+    /** The world ID, if applicable. */
+    worldID?: number | undefined;
+    /** The buyer name. */
+    buyerName?: string | undefined;
+    /** The total price. */
+    total: number;
+}
+export declare class TaxRatesView implements ITaxRatesView {
+    /** The percent retainer tax in Limsa Lominsa. */
+    limsa_Lominsa: number;
+    /** The percent retainer tax in Gridania. */
+    gridania: number;
+    /** The percent retainer tax in Ul'dah. */
+    uldah: number;
+    /** The percent retainer tax in Ishgard. */
+    ishgard: number;
+    /** The percent retainer tax in Kugane. */
+    kugane: number;
+    /** The percent retainer tax in the Crystarium. */
+    crystarium: number;
+    /** The percent retainer tax in Old Sharlayan. */
+    old_Sharlayan: number;
+    /** The percent retainer tax in Tuliyollal. */
+    tuliyollal: number;
+    constructor(data?: ITaxRatesView);
+    init(_data?: any): void;
+    static fromJS(data: any): TaxRatesView;
+    toJSON(data?: any): any;
+}
+export interface ITaxRatesView {
+    /** The percent retainer tax in Limsa Lominsa. */
+    limsa_Lominsa: number;
+    /** The percent retainer tax in Gridania. */
+    gridania: number;
+    /** The percent retainer tax in Ul'dah. */
+    uldah: number;
+    /** The percent retainer tax in Ishgard. */
+    ishgard: number;
+    /** The percent retainer tax in Kugane. */
+    kugane: number;
+    /** The percent retainer tax in the Crystarium. */
+    crystarium: number;
+    /** The percent retainer tax in Old Sharlayan. */
+    old_Sharlayan: number;
+    /** The percent retainer tax in Tuliyollal. */
+    tuliyollal: number;
+}
+export declare class UserListView implements IUserListView {
+    /** The list's ID. */
+    id?: string | undefined;
+    /** The time that this list was created, in milliseconds since the UNIX epoch. */
+    created?: string | undefined;
+    /** The time that this list was updated, in milliseconds since the UNIX epoch. */
+    updated?: string | undefined;
+    /** The name of this list. */
+    name?: string | undefined;
+    /** The IDs of the list items. */
+    itemIDs?: number[] | undefined;
+    constructor(data?: IUserListView);
+    init(_data?: any): void;
+    static fromJS(data: any): UserListView;
+    toJSON(data?: any): any;
+}
+export interface IUserListView {
+    /** The list's ID. */
+    id?: string | undefined;
+    /** The time that this list was created, in milliseconds since the UNIX epoch. */
+    created?: string | undefined;
+    /** The time that this list was updated, in milliseconds since the UNIX epoch. */
+    updated?: string | undefined;
+    /** The name of this list. */
+    name?: string | undefined;
+    /** The IDs of the list items. */
+    itemIDs?: number[] | undefined;
+}
+export declare class DataCenter implements IDataCenter {
+    name?: string | undefined;
+    region?: string | undefined;
+    worlds?: number[] | undefined;
+    constructor(data?: IDataCenter);
+    init(_data?: any): void;
+    static fromJS(data: any): DataCenter;
+    toJSON(data?: any): any;
+}
+export interface IDataCenter {
+    name?: string | undefined;
+    region?: string | undefined;
+    worlds?: number[] | undefined;
+}
+export declare class World implements IWorld {
+    id: number;
+    name?: string | undefined;
+    constructor(data?: IWorld);
+    init(_data?: any): void;
+    static fromJS(data: any): World;
+    toJSON(data?: any): any;
+}
+export interface IWorld {
+    id: number;
+    name?: string | undefined;
+}
+export declare class SwaggerException extends Error {
+    message: string;
+    status: number;
+    response: string;
+    headers: {
+        [key: string]: any;
+    };
+    result: any;
+    constructor(message: string, status: number, response: string, headers: {
+        [key: string]: any;
+    }, result: any);
+    protected isSwaggerException: boolean;
+    static isSwaggerException(obj: any): obj is SwaggerException;
+}
+//# sourceMappingURL=v1.d.ts.map