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

package/dist/api.d.ts

@@ -2,7 +2,7 @@
  * 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
+ * OpenAPI spec version: v0.3.0
  *
  *
  * NOTE: This file is auto generated by the swagger code generator program.
@@ -102,7 +102,7 @@ export interface ApiStatusResponse {
      * @type {string}
      * @memberof ApiStatusResponse
      */
-    serverVersion: string;
+    server_version: string;
     /**
      *
      * @type {string}
@@ -120,13 +120,13 @@ export interface ApiStatusResponse {
      * @type {ApiTokenContractCount}
      * @memberof ApiStatusResponse
      */
-    tokenContracts?: ApiTokenContractCount;
+    token_contracts?: ApiTokenContractCount;
     /**
      *
      * @type {ApiJobCount}
      * @memberof ApiStatusResponse
      */
-    jobQueue?: ApiJobCount;
+    job_queue?: ApiJobCount;
 }
 /**
  *
@@ -139,19 +139,19 @@ export interface ApiTokenContractCount {
      * @type {number}
      * @memberof ApiTokenContractCount
      */
-    sip009?: number;
+    sip_009?: number;
     /**
      *
      * @type {number}
      * @memberof ApiTokenContractCount
      */
-    sip010?: number;
+    sip_010?: number;
     /**
      *
      * @type {number}
      * @memberof ApiTokenContractCount
      */
-    sip013?: number;
+    sip_013?: number;
 }
 /**
  *
@@ -178,6 +178,80 @@ export interface 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_canonical_uri?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof FtBasicMetadataResponse
+     */
+    tx_id: string;
+    /**
+     *
+     * @type {string}
+     * @memberof FtBasicMetadataResponse
+     */
+    sender_address: string;
+}
 /**
  *
  * @export
@@ -207,13 +281,13 @@ export interface FtMetadataResponse {
      * @type {string}
      * @memberof FtMetadataResponse
      */
-    totalSupply?: string;
+    total_supply?: string;
     /**
      *
      * @type {string}
      * @memberof FtMetadataResponse
      */
-    tokenUri?: string;
+    token_uri?: string;
     /**
      *
      * @type {string}
@@ -225,25 +299,25 @@ export interface FtMetadataResponse {
      * @type {string}
      * @memberof FtMetadataResponse
      */
-    imageUri?: string;
+    image_uri?: string;
     /**
      *
      * @type {string}
      * @memberof FtMetadataResponse
      */
-    imageCanonicalUri?: string;
+    image_canonical_uri?: string;
     /**
      *
      * @type {string}
      * @memberof FtMetadataResponse
      */
-    txId: string;
+    tx_id: string;
     /**
      *
      * @type {string}
      * @memberof FtMetadataResponse
      */
-    senderAddress: string;
+    sender_address: string;
     /**
      *
      * @type {Metadata}
@@ -286,7 +360,7 @@ export interface Metadata {
      * @type {string}
      * @memberof Metadata
      */
-    cachedImage?: string;
+    cached_image?: string;
     /**
      *
      * @type {Array<MetadataAttribute>}
@@ -319,13 +393,13 @@ export interface MetadataAttribute {
      * @type {string}
      * @memberof MetadataAttribute
      */
-    traitType: string;
+    trait_type: string;
     /**
      *
      * @type {string}
      * @memberof MetadataAttribute
      */
-    displayType?: string;
+    display_type?: string;
     /**
      *
      * @type {any}
@@ -369,7 +443,7 @@ export interface NftMetadataResponse {
      * @type {string}
      * @memberof NftMetadataResponse
      */
-    tokenUri?: string;
+    token_uri?: string;
     /**
      *
      * @type {Metadata}
@@ -380,66 +454,85 @@ export interface NftMetadataResponse {
 /**
  *
  * @export
- * @interface SftMetadataResponse
+ * @interface NotFoundErrorResponse
  */
-export interface SftMetadataResponse {
+export interface NotFoundErrorResponse {
+}
+/**
+ *
+ * @export
+ * @interface Order
+ */
+export interface Order {
+}
+/**
+ *
+ * @export
+ * @interface OrderBy
+ */
+export interface OrderBy {
+}
+/**
+ *
+ * @export
+ * @interface PaginatedFtBasicMetadataResponse
+ */
+export interface PaginatedFtBasicMetadataResponse {
     /**
      *
-     * @type {string}
-     * @memberof SftMetadataResponse
+     * @type {number}
+     * @memberof PaginatedFtBasicMetadataResponse
      */
-    tokenUri?: string;
+    limit: number;
     /**
      *
      * @type {number}
-     * @memberof SftMetadataResponse
+     * @memberof PaginatedFtBasicMetadataResponse
      */
-    decimals?: number;
+    offset: number;
     /**
      *
-     * @type {string}
-     * @memberof SftMetadataResponse
+     * @type {number}
+     * @memberof PaginatedFtBasicMetadataResponse
      */
-    totalSupply?: string;
+    total: number;
     /**
      *
-     * @type {Metadata}
-     * @memberof SftMetadataResponse
+     * @type {Array<FtBasicMetadataResponse>}
+     * @memberof PaginatedFtBasicMetadataResponse
      */
-    metadata?: Metadata;
-}
-/**
- *
- * @export
- * @interface TokenErrorResponse
- */
-export interface TokenErrorResponse {
+    results: Array<FtBasicMetadataResponse>;
 }
 /**
  *
  * @export
- * @interface TokenNotFoundResponse
+ * @interface SftMetadataResponse
  */
-export interface TokenNotFoundResponse {
+export interface SftMetadataResponse {
     /**
      *
      * @type {string}
-     * @memberof TokenNotFoundResponse
+     * @memberof SftMetadataResponse
      */
-    error: TokenNotFoundResponse.ErrorEnum;
-}
-/**
- * @export
- * @namespace TokenNotFoundResponse
- */
-export declare namespace TokenNotFoundResponse {
+    token_uri?: string;
     /**
-     * @export
-     * @enum {string}
+     *
+     * @type {number}
+     * @memberof SftMetadataResponse
+     */
+    decimals?: number;
+    /**
+     *
+     * @type {string}
+     * @memberof SftMetadataResponse
      */
-    enum ErrorEnum {
-        TokenNotFound
-    }
+    total_supply?: string;
+    /**
+     *
+     * @type {Metadata}
+     * @memberof SftMetadataResponse
+     */
+    metadata?: Metadata;
 }
 /**
  * StatusApi - fetch parameter creator
@@ -510,26 +603,40 @@ export declare const TokensApiFetchParamCreator: (configuration?: Configuration)
      * @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} tokenId Token ID to retrieve
+     * @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, tokenId: number, locale?: string, options?: any): FetchArgs;
+    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} tokenId Token ID to retrieve
+     * @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, tokenId: number, locale?: string, options?: any): FetchArgs;
+    getSftMetadata(principal: string, token_id: number, locale?: string, options?: any): FetchArgs;
 };
 /**
  * TokensApi - functional programming interface
@@ -545,26 +652,40 @@ export declare const TokensApiFp: (configuration?: Configuration) => {
      * @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} tokenId Token ID to retrieve
+     * @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, tokenId: number, locale?: string, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<NftMetadataResponse>;
+    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} tokenId Token ID to retrieve
+     * @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, tokenId: number, locale?: string, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<SftMetadataResponse>;
+    getSftMetadata(principal: string, token_id: number, locale?: string, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<SftMetadataResponse>;
 };
 /**
  * TokensApi - factory interface
@@ -580,26 +701,40 @@ export declare const TokensApiFactory: (configuration?: Configuration, fetch?: F
      * @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} tokenId Token ID to retrieve
+     * @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, tokenId: number, locale?: string, options?: any): Promise<NftMetadataResponse>;
+    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} tokenId Token ID to retrieve
+     * @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, tokenId: number, locale?: string, options?: any): Promise<SftMetadataResponse>;
+    getSftMetadata(principal: string, token_id: number, locale?: string, options?: any): Promise<SftMetadataResponse>;
 };
 /**
  * TokensApi - object-oriented interface
@@ -618,26 +753,41 @@ export declare class TokensApi extends BaseAPI {
      * @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} tokenId Token ID to retrieve
+     * @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, tokenId: number, locale?: string, options?: any): Promise<NftMetadataResponse>;
+    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} tokenId Token ID to retrieve
+     * @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, tokenId: number, locale?: string, options?: any): Promise<SftMetadataResponse>;
+    getSftMetadata(principal: string, token_id: number, locale?: string, options?: any): Promise<SftMetadataResponse>;
 }