@hirosystems/token-metadata-api-client 1.3.0 → 2.0.0

package/dist/api.d.ts

@@ -1,821 +0,0 @@
-/**
- * Token Metadata API
- * Welcome to the API reference overview for the [Token Metadata API](https://docs.hiro.so/token-metadata-api). Service that indexes metadata for every SIP-009, SIP-010, and SIP-013 Token in the Stacks blockchain and exposes it via REST API endpoints.
- *
- * OpenAPI spec version: v0.4.0
- *
- *
- * NOTE: This file is auto generated by the swagger code generator program.
- * https://github.com/swagger-api/swagger-codegen.git
- * Do not edit the file manually.
- */
-/// <reference path="../custom.d.ts" />
-import { Configuration } from "./configuration";
-/**
- *
- * @export
- */
-export declare const COLLECTION_FORMATS: {
-    csv: string;
-    ssv: string;
-    tsv: string;
-    pipes: string;
-};
-/**
- *
- * @export
- * @interface FetchAPI
- */
-export interface FetchAPI {
-    (url: string, init?: any): Promise<Response>;
-}
-/**
- *
- * @export
- * @interface FetchArgs
- */
-export interface FetchArgs {
-    url: string;
-    options: any;
-}
-/**
- *
- * @export
- * @class BaseAPI
- */
-export declare class BaseAPI {
-    protected basePath: string;
-    protected fetch: FetchAPI;
-    protected configuration: Configuration;
-    constructor(configuration?: Configuration, basePath?: string, fetch?: FetchAPI);
-}
-/**
- *
- * @export
- * @class RequiredError
- * @extends {Error}
- */
-export declare class RequiredError extends Error {
-    field: string;
-    name: string;
-    constructor(field: string, msg?: string);
-}
-/**
- *
- * @export
- * @interface ApiJobCount
- */
-export interface ApiJobCount {
-    /**
-     *
-     * @type {number}
-     * @memberof ApiJobCount
-     */
-    pending?: number;
-    /**
-     *
-     * @type {number}
-     * @memberof ApiJobCount
-     */
-    queued?: number;
-    /**
-     *
-     * @type {number}
-     * @memberof ApiJobCount
-     */
-    done?: number;
-    /**
-     *
-     * @type {number}
-     * @memberof ApiJobCount
-     */
-    failed?: number;
-}
-/**
- *
- * @export
- * @interface ApiStatusResponse
- */
-export interface ApiStatusResponse {
-    /**
-     *
-     * @type {string}
-     * @memberof ApiStatusResponse
-     */
-    server_version: string;
-    /**
-     *
-     * @type {string}
-     * @memberof ApiStatusResponse
-     */
-    status: string;
-    /**
-     *
-     * @type {ApiTokenCount}
-     * @memberof ApiStatusResponse
-     */
-    tokens?: ApiTokenCount;
-    /**
-     *
-     * @type {ApiTokenContractCount}
-     * @memberof ApiStatusResponse
-     */
-    token_contracts?: ApiTokenContractCount;
-    /**
-     *
-     * @type {ApiJobCount}
-     * @memberof ApiStatusResponse
-     */
-    job_queue?: ApiJobCount;
-}
-/**
- *
- * @export
- * @interface ApiTokenContractCount
- */
-export interface ApiTokenContractCount {
-    /**
-     *
-     * @type {number}
-     * @memberof ApiTokenContractCount
-     */
-    sip_009?: number;
-    /**
-     *
-     * @type {number}
-     * @memberof ApiTokenContractCount
-     */
-    sip_010?: number;
-    /**
-     *
-     * @type {number}
-     * @memberof ApiTokenContractCount
-     */
-    sip_013?: number;
-}
-/**
- *
- * @export
- * @interface ApiTokenCount
- */
-export interface ApiTokenCount {
-    /**
-     *
-     * @type {number}
-     * @memberof ApiTokenCount
-     */
-    ft?: number;
-    /**
-     *
-     * @type {number}
-     * @memberof ApiTokenCount
-     */
-    nft?: number;
-    /**
-     *
-     * @type {number}
-     * @memberof ApiTokenCount
-     */
-    sft?: number;
-}
-/**
- *
- * @export
- * @interface ErrorResponse
- */
-export interface ErrorResponse {
-}
-/**
- *
- * @export
- * @interface FtBasicMetadataResponse
- */
-export interface FtBasicMetadataResponse {
-    /**
-     *
-     * @type {string}
-     * @memberof FtBasicMetadataResponse
-     */
-    name?: string;
-    /**
-     *
-     * @type {string}
-     * @memberof FtBasicMetadataResponse
-     */
-    symbol?: string;
-    /**
-     *
-     * @type {number}
-     * @memberof FtBasicMetadataResponse
-     */
-    decimals?: number;
-    /**
-     *
-     * @type {string}
-     * @memberof FtBasicMetadataResponse
-     */
-    total_supply?: string;
-    /**
-     *
-     * @type {string}
-     * @memberof FtBasicMetadataResponse
-     */
-    token_uri?: string;
-    /**
-     *
-     * @type {string}
-     * @memberof FtBasicMetadataResponse
-     */
-    description?: string;
-    /**
-     *
-     * @type {string}
-     * @memberof FtBasicMetadataResponse
-     */
-    image_uri?: string;
-    /**
-     *
-     * @type {string}
-     * @memberof FtBasicMetadataResponse
-     */
-    image_thumbnail_uri?: string;
-    /**
-     *
-     * @type {string}
-     * @memberof FtBasicMetadataResponse
-     */
-    image_canonical_uri?: string;
-    /**
-     *
-     * @type {string}
-     * @memberof FtBasicMetadataResponse
-     */
-    tx_id: string;
-    /**
-     *
-     * @type {string}
-     * @memberof FtBasicMetadataResponse
-     */
-    sender_address: string;
-    /**
-     *
-     * @type {string}
-     * @memberof FtBasicMetadataResponse
-     */
-    contract_principal: string;
-}
-/**
- *
- * @export
- * @interface FtMetadataResponse
- */
-export interface FtMetadataResponse {
-    /**
-     *
-     * @type {string}
-     * @memberof FtMetadataResponse
-     */
-    name?: string;
-    /**
-     *
-     * @type {string}
-     * @memberof FtMetadataResponse
-     */
-    symbol?: string;
-    /**
-     *
-     * @type {number}
-     * @memberof FtMetadataResponse
-     */
-    decimals?: number;
-    /**
-     *
-     * @type {string}
-     * @memberof FtMetadataResponse
-     */
-    total_supply?: string;
-    /**
-     *
-     * @type {string}
-     * @memberof FtMetadataResponse
-     */
-    token_uri?: string;
-    /**
-     *
-     * @type {string}
-     * @memberof FtMetadataResponse
-     */
-    description?: string;
-    /**
-     *
-     * @type {string}
-     * @memberof FtMetadataResponse
-     */
-    image_uri?: string;
-    /**
-     *
-     * @type {string}
-     * @memberof FtMetadataResponse
-     */
-    image_thumbnail_uri?: string;
-    /**
-     *
-     * @type {string}
-     * @memberof FtMetadataResponse
-     */
-    image_canonical_uri?: string;
-    /**
-     *
-     * @type {string}
-     * @memberof FtMetadataResponse
-     */
-    tx_id: string;
-    /**
-     *
-     * @type {string}
-     * @memberof FtMetadataResponse
-     */
-    sender_address: string;
-    /**
-     *
-     * @type {Metadata}
-     * @memberof FtMetadataResponse
-     */
-    metadata?: Metadata;
-}
-/**
- *
- * @export
- * @interface Metadata
- */
-export interface Metadata {
-    /**
-     *
-     * @type {number}
-     * @memberof Metadata
-     */
-    sip: number;
-    /**
-     *
-     * @type {string}
-     * @memberof Metadata
-     */
-    name?: string;
-    /**
-     *
-     * @type {string}
-     * @memberof Metadata
-     */
-    description?: string;
-    /**
-     *
-     * @type {string}
-     * @memberof Metadata
-     */
-    image?: string;
-    /**
-     *
-     * @type {string}
-     * @memberof Metadata
-     */
-    cached_image?: string;
-    /**
-     *
-     * @type {string}
-     * @memberof Metadata
-     */
-    cached_thumbnail_image?: string;
-    /**
-     *
-     * @type {Array<MetadataAttribute>}
-     * @memberof Metadata
-     */
-    attributes?: Array<MetadataAttribute>;
-    /**
-     *
-     * @type {{ [key: string]: any; }}
-     * @memberof Metadata
-     */
-    properties?: {
-        [key: string]: any;
-    };
-    /**
-     *
-     * @type {MetadataLocalization}
-     * @memberof Metadata
-     */
-    localization?: MetadataLocalization;
-}
-/**
- *
- * @export
- * @interface MetadataAttribute
- */
-export interface MetadataAttribute {
-    /**
-     *
-     * @type {string}
-     * @memberof MetadataAttribute
-     */
-    trait_type: string;
-    /**
-     *
-     * @type {string}
-     * @memberof MetadataAttribute
-     */
-    display_type?: string;
-    /**
-     *
-     * @type {any}
-     * @memberof MetadataAttribute
-     */
-    value: any;
-}
-/**
- *
- * @export
- * @interface MetadataLocalization
- */
-export interface MetadataLocalization {
-    /**
-     *
-     * @type {string}
-     * @memberof MetadataLocalization
-     */
-    uri: string;
-    /**
-     *
-     * @type {string}
-     * @memberof MetadataLocalization
-     */
-    _default: string;
-    /**
-     *
-     * @type {Array<string>}
-     * @memberof MetadataLocalization
-     */
-    locales: Array<string>;
-}
-/**
- *
- * @export
- * @interface NftMetadataResponse
- */
-export interface NftMetadataResponse {
-    /**
-     *
-     * @type {string}
-     * @memberof NftMetadataResponse
-     */
-    token_uri?: string;
-    /**
-     *
-     * @type {Metadata}
-     * @memberof NftMetadataResponse
-     */
-    metadata?: Metadata;
-}
-/**
- *
- * @export
- * @interface NotFoundErrorResponse
- */
-export interface NotFoundErrorResponse {
-}
-/**
- *
- * @export
- * @interface Order
- */
-export declare enum Order {
-    asc = "asc",
-    desc = "desc"
-}
-/**
- *
- * @export
- * @interface OrderBy
- */
-export declare enum OrderBy {
-    name = "name",
-    symbol = "symbol"
-}
-/**
- *
- * @export
- * @interface PaginatedFtBasicMetadataResponse
- */
-export interface PaginatedFtBasicMetadataResponse {
-    /**
-     *
-     * @type {number}
-     * @memberof PaginatedFtBasicMetadataResponse
-     */
-    limit: number;
-    /**
-     *
-     * @type {number}
-     * @memberof PaginatedFtBasicMetadataResponse
-     */
-    offset: number;
-    /**
-     *
-     * @type {number}
-     * @memberof PaginatedFtBasicMetadataResponse
-     */
-    total: number;
-    /**
-     *
-     * @type {Array<FtBasicMetadataResponse>}
-     * @memberof PaginatedFtBasicMetadataResponse
-     */
-    results: Array<FtBasicMetadataResponse>;
-}
-/**
- *
- * @export
- * @interface SftMetadataResponse
- */
-export interface SftMetadataResponse {
-    /**
-     *
-     * @type {string}
-     * @memberof SftMetadataResponse
-     */
-    token_uri?: string;
-    /**
-     *
-     * @type {number}
-     * @memberof SftMetadataResponse
-     */
-    decimals?: number;
-    /**
-     *
-     * @type {string}
-     * @memberof SftMetadataResponse
-     */
-    total_supply?: string;
-    /**
-     *
-     * @type {Metadata}
-     * @memberof SftMetadataResponse
-     */
-    metadata?: Metadata;
-}
-/**
- * StatusApi - fetch parameter creator
- * @export
- */
-export declare const StatusApiFetchParamCreator: (configuration?: Configuration) => {
-    /**
-     * Displays the status of the API and its current workload
-     * @summary API Status
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    getApiStatus(options?: any): FetchArgs;
-};
-/**
- * StatusApi - functional programming interface
- * @export
- */
-export declare const StatusApiFp: (configuration?: Configuration) => {
-    /**
-     * Displays the status of the API and its current workload
-     * @summary API Status
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    getApiStatus(options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<ApiStatusResponse>;
-};
-/**
- * StatusApi - factory interface
- * @export
- */
-export declare const StatusApiFactory: (configuration?: Configuration, fetch?: FetchAPI, basePath?: string) => {
-    /**
-     * Displays the status of the API and its current workload
-     * @summary API Status
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    getApiStatus(options?: any): Promise<ApiStatusResponse>;
-};
-/**
- * StatusApi - object-oriented interface
- * @export
- * @class StatusApi
- * @extends {BaseAPI}
- */
-export declare class StatusApi extends BaseAPI {
-    /**
-     * Displays the status of the API and its current workload
-     * @summary API Status
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     * @memberof StatusApi
-     */
-    getApiStatus(options?: any): Promise<ApiStatusResponse>;
-}
-/**
- * TokensApi - fetch parameter creator
- * @export
- */
-export declare const TokensApiFetchParamCreator: (configuration?: Configuration) => {
-    /**
-     * Retrieves metadata for a SIP-010 Fungible Token
-     * @summary Fungible Token Metadata
-     * @param {string} principal Principal for the contract which owns the SIP-010 token
-     * @param {string} [locale] Metadata localization to retrieve
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    getFtMetadata(principal: string, locale?: string, options?: any): FetchArgs;
-    /**
-     * Retrieves a list of Fungible Tokens
-     * @summary Fungible Tokens
-     * @param {string} [name]
-     * @param {string} [symbol]
-     * @param {string} [address] Stacks Address
-     * @param {number} [offset] Result offset
-     * @param {number} [limit] Results per page
-     * @param {OrderBy} [order_by] Parameter to order results by
-     * @param {Order} [order] Results order
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    getFungibleTokens(name?: string, symbol?: string, address?: string, offset?: number, limit?: number, order_by?: OrderBy, order?: Order, options?: any): FetchArgs;
-    /**
-     * Retrieves metadata for a SIP-009 Non-Fungible Token
-     * @summary Non-Fungible Token Metadata
-     * @param {string} principal SIP-009 compliant smart contract principal
-     * @param {number} token_id Token ID to retrieve
-     * @param {string} [locale] Metadata localization to retrieve
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    getNftMetadata(principal: string, token_id: number, locale?: string, options?: any): FetchArgs;
-    /**
-     * Retrieves metadata for a SIP-013 Semi-Fungible Token
-     * @summary Semi-Fungible Token Metadata
-     * @param {string} principal SIP-013 compliant smart contract principal
-     * @param {number} token_id Token ID to retrieve
-     * @param {string} [locale] Metadata localization to retrieve
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    getSftMetadata(principal: string, token_id: number, locale?: string, options?: any): FetchArgs;
-};
-/**
- * TokensApi - functional programming interface
- * @export
- */
-export declare const TokensApiFp: (configuration?: Configuration) => {
-    /**
-     * Retrieves metadata for a SIP-010 Fungible Token
-     * @summary Fungible Token Metadata
-     * @param {string} principal Principal for the contract which owns the SIP-010 token
-     * @param {string} [locale] Metadata localization to retrieve
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    getFtMetadata(principal: string, locale?: string, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<FtMetadataResponse>;
-    /**
-     * Retrieves a list of Fungible Tokens
-     * @summary Fungible Tokens
-     * @param {string} [name]
-     * @param {string} [symbol]
-     * @param {string} [address] Stacks Address
-     * @param {number} [offset] Result offset
-     * @param {number} [limit] Results per page
-     * @param {OrderBy} [order_by] Parameter to order results by
-     * @param {Order} [order] Results order
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    getFungibleTokens(name?: string, symbol?: string, address?: string, offset?: number, limit?: number, order_by?: OrderBy, order?: Order, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<PaginatedFtBasicMetadataResponse>;
-    /**
-     * Retrieves metadata for a SIP-009 Non-Fungible Token
-     * @summary Non-Fungible Token Metadata
-     * @param {string} principal SIP-009 compliant smart contract principal
-     * @param {number} token_id Token ID to retrieve
-     * @param {string} [locale] Metadata localization to retrieve
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    getNftMetadata(principal: string, token_id: number, locale?: string, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<NftMetadataResponse>;
-    /**
-     * Retrieves metadata for a SIP-013 Semi-Fungible Token
-     * @summary Semi-Fungible Token Metadata
-     * @param {string} principal SIP-013 compliant smart contract principal
-     * @param {number} token_id Token ID to retrieve
-     * @param {string} [locale] Metadata localization to retrieve
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    getSftMetadata(principal: string, token_id: number, locale?: string, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<SftMetadataResponse>;
-};
-/**
- * TokensApi - factory interface
- * @export
- */
-export declare const TokensApiFactory: (configuration?: Configuration, fetch?: FetchAPI, basePath?: string) => {
-    /**
-     * Retrieves metadata for a SIP-010 Fungible Token
-     * @summary Fungible Token Metadata
-     * @param {string} principal Principal for the contract which owns the SIP-010 token
-     * @param {string} [locale] Metadata localization to retrieve
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    getFtMetadata(principal: string, locale?: string, options?: any): Promise<FtMetadataResponse>;
-    /**
-     * Retrieves a list of Fungible Tokens
-     * @summary Fungible Tokens
-     * @param {string} [name]
-     * @param {string} [symbol]
-     * @param {string} [address] Stacks Address
-     * @param {number} [offset] Result offset
-     * @param {number} [limit] Results per page
-     * @param {OrderBy} [order_by] Parameter to order results by
-     * @param {Order} [order] Results order
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    getFungibleTokens(name?: string, symbol?: string, address?: string, offset?: number, limit?: number, order_by?: OrderBy, order?: Order, options?: any): Promise<PaginatedFtBasicMetadataResponse>;
-    /**
-     * Retrieves metadata for a SIP-009 Non-Fungible Token
-     * @summary Non-Fungible Token Metadata
-     * @param {string} principal SIP-009 compliant smart contract principal
-     * @param {number} token_id Token ID to retrieve
-     * @param {string} [locale] Metadata localization to retrieve
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    getNftMetadata(principal: string, token_id: number, locale?: string, options?: any): Promise<NftMetadataResponse>;
-    /**
-     * Retrieves metadata for a SIP-013 Semi-Fungible Token
-     * @summary Semi-Fungible Token Metadata
-     * @param {string} principal SIP-013 compliant smart contract principal
-     * @param {number} token_id Token ID to retrieve
-     * @param {string} [locale] Metadata localization to retrieve
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    getSftMetadata(principal: string, token_id: number, locale?: string, options?: any): Promise<SftMetadataResponse>;
-};
-/**
- * TokensApi - object-oriented interface
- * @export
- * @class TokensApi
- * @extends {BaseAPI}
- */
-export declare class TokensApi extends BaseAPI {
-    /**
-     * Retrieves metadata for a SIP-010 Fungible Token
-     * @summary Fungible Token Metadata
-     * @param {string} principal Principal for the contract which owns the SIP-010 token
-     * @param {string} [locale] Metadata localization to retrieve
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     * @memberof TokensApi
-     */
-    getFtMetadata(principal: string, locale?: string, options?: any): Promise<FtMetadataResponse>;
-    /**
-     * Retrieves a list of Fungible Tokens
-     * @summary Fungible Tokens
-     * @param {string} [name]
-     * @param {string} [symbol]
-     * @param {string} [address] Stacks Address
-     * @param {number} [offset] Result offset
-     * @param {number} [limit] Results per page
-     * @param {OrderBy} [order_by] Parameter to order results by
-     * @param {Order} [order] Results order
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     * @memberof TokensApi
-     */
-    getFungibleTokens(name?: string, symbol?: string, address?: string, offset?: number, limit?: number, order_by?: OrderBy, order?: Order, options?: any): Promise<PaginatedFtBasicMetadataResponse>;
-    /**
-     * Retrieves metadata for a SIP-009 Non-Fungible Token
-     * @summary Non-Fungible Token Metadata
-     * @param {string} principal SIP-009 compliant smart contract principal
-     * @param {number} token_id Token ID to retrieve
-     * @param {string} [locale] Metadata localization to retrieve
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     * @memberof TokensApi
-     */
-    getNftMetadata(principal: string, token_id: number, locale?: string, options?: any): Promise<NftMetadataResponse>;
-    /**
-     * Retrieves metadata for a SIP-013 Semi-Fungible Token
-     * @summary Semi-Fungible Token Metadata
-     * @param {string} principal SIP-013 compliant smart contract principal
-     * @param {number} token_id Token ID to retrieve
-     * @param {string} [locale] Metadata localization to retrieve
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     * @memberof TokensApi
-     */
-    getSftMetadata(principal: string, token_id: number, locale?: string, options?: any): Promise<SftMetadataResponse>;
-}