@hirosystems/token-metadata-api-client 1.0.1 → 1.0.2

package/dist/api.d.ts

@@ -0,0 +1,643 @@
+/**
+ * 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.1.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: "RequiredError";
+    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
+     */
+    serverVersion: string;
+    /**
+     *
+     * @type {string}
+     * @memberof ApiStatusResponse
+     */
+    status: string;
+    /**
+     *
+     * @type {ApiTokenCount}
+     * @memberof ApiStatusResponse
+     */
+    tokens?: ApiTokenCount;
+    /**
+     *
+     * @type {ApiTokenContractCount}
+     * @memberof ApiStatusResponse
+     */
+    tokenContracts?: ApiTokenContractCount;
+    /**
+     *
+     * @type {ApiJobCount}
+     * @memberof ApiStatusResponse
+     */
+    jobQueue?: ApiJobCount;
+}
+/**
+ *
+ * @export
+ * @interface ApiTokenContractCount
+ */
+export interface ApiTokenContractCount {
+    /**
+     *
+     * @type {number}
+     * @memberof ApiTokenContractCount
+     */
+    sip009?: number;
+    /**
+     *
+     * @type {number}
+     * @memberof ApiTokenContractCount
+     */
+    sip010?: number;
+    /**
+     *
+     * @type {number}
+     * @memberof ApiTokenContractCount
+     */
+    sip013?: 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 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
+     */
+    totalSupply?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof FtMetadataResponse
+     */
+    tokenUri?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof FtMetadataResponse
+     */
+    description?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof FtMetadataResponse
+     */
+    imageUri?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof FtMetadataResponse
+     */
+    imageCanonicalUri?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof FtMetadataResponse
+     */
+    txId: string;
+    /**
+     *
+     * @type {string}
+     * @memberof FtMetadataResponse
+     */
+    senderAddress: 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
+     */
+    cachedImage?: 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
+     */
+    traitType: string;
+    /**
+     *
+     * @type {string}
+     * @memberof MetadataAttribute
+     */
+    displayType?: 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
+     */
+    tokenUri?: string;
+    /**
+     *
+     * @type {Metadata}
+     * @memberof NftMetadataResponse
+     */
+    metadata?: Metadata;
+}
+/**
+ *
+ * @export
+ * @interface SftMetadataResponse
+ */
+export interface SftMetadataResponse {
+    /**
+     *
+     * @type {string}
+     * @memberof SftMetadataResponse
+     */
+    tokenUri?: string;
+    /**
+     *
+     * @type {number}
+     * @memberof SftMetadataResponse
+     */
+    decimals?: number;
+    /**
+     *
+     * @type {string}
+     * @memberof SftMetadataResponse
+     */
+    totalSupply?: string;
+    /**
+     *
+     * @type {Metadata}
+     * @memberof SftMetadataResponse
+     */
+    metadata?: Metadata;
+}
+/**
+ *
+ * @export
+ * @interface TokenErrorResponse
+ */
+export interface TokenErrorResponse {
+}
+/**
+ *
+ * @export
+ * @interface TokenNotFoundResponse
+ */
+export interface TokenNotFoundResponse {
+    /**
+     *
+     * @type {string}
+     * @memberof TokenNotFoundResponse
+     */
+    error: TokenNotFoundResponse.ErrorEnum;
+}
+/**
+ * @export
+ * @namespace TokenNotFoundResponse
+ */
+export declare namespace TokenNotFoundResponse {
+    /**
+     * @export
+     * @enum {string}
+     */
+    enum ErrorEnum {
+        TokenNotFound
+    }
+}
+/**
+ * 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 metadata for a SIP-009 Non-Fungible Token
+     * @summary Non-Fungible Token Metadata
+     * @param {string} principal SIP-009 compliant smart contract principal
+     * @param {number} tokenId Token ID to retrieve
+     * @param {string} [locale] Metadata localization to retrieve
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getNftMetadata(principal: string, tokenId: 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} tokenId Token ID to retrieve
+     * @param {string} [locale] Metadata localization to retrieve
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getSftMetadata(principal: string, tokenId: 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 metadata for a SIP-009 Non-Fungible Token
+     * @summary Non-Fungible Token Metadata
+     * @param {string} principal SIP-009 compliant smart contract principal
+     * @param {number} tokenId Token ID to retrieve
+     * @param {string} [locale] Metadata localization to retrieve
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getNftMetadata(principal: string, tokenId: 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} tokenId Token ID to retrieve
+     * @param {string} [locale] Metadata localization to retrieve
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getSftMetadata(principal: string, tokenId: 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 metadata for a SIP-009 Non-Fungible Token
+     * @summary Non-Fungible Token Metadata
+     * @param {string} principal SIP-009 compliant smart contract principal
+     * @param {number} tokenId Token ID to retrieve
+     * @param {string} [locale] Metadata localization to retrieve
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getNftMetadata(principal: string, tokenId: 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} tokenId Token ID to retrieve
+     * @param {string} [locale] Metadata localization to retrieve
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getSftMetadata(principal: string, tokenId: 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 metadata for a SIP-009 Non-Fungible Token
+     * @summary Non-Fungible Token Metadata
+     * @param {string} principal SIP-009 compliant smart contract principal
+     * @param {number} tokenId Token ID to retrieve
+     * @param {string} [locale] Metadata localization to retrieve
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof TokensApi
+     */
+    getNftMetadata(principal: string, tokenId: 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} tokenId Token ID to retrieve
+     * @param {string} [locale] Metadata localization to retrieve
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof TokensApi
+     */
+    getSftMetadata(principal: string, tokenId: number, locale?: string, options?: any): Promise<SftMetadataResponse>;
+}