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

package/api.ts

@@ -4,7 +4,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.
@@ -119,7 +119,7 @@ export interface ApiStatusResponse {
      * @type {string}
      * @memberof ApiStatusResponse
      */
-    serverVersion: string;
+    server_version: string;
     /**
      * 
      * @type {string}
@@ -137,13 +137,13 @@ export interface ApiStatusResponse {
      * @type {ApiTokenContractCount}
      * @memberof ApiStatusResponse
      */
-    tokenContracts?: ApiTokenContractCount;
+    token_contracts?: ApiTokenContractCount;
     /**
      * 
      * @type {ApiJobCount}
      * @memberof ApiStatusResponse
      */
-    jobQueue?: ApiJobCount;
+    job_queue?: ApiJobCount;
 }
 /**
  * 
@@ -156,19 +156,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;
 }
 /**
  * 
@@ -195,6 +195,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
@@ -224,13 +298,13 @@ export interface FtMetadataResponse {
      * @type {string}
      * @memberof FtMetadataResponse
      */
-    totalSupply?: string;
+    total_supply?: string;
     /**
      * 
      * @type {string}
      * @memberof FtMetadataResponse
      */
-    tokenUri?: string;
+    token_uri?: string;
     /**
      * 
      * @type {string}
@@ -242,25 +316,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}
@@ -303,7 +377,7 @@ export interface Metadata {
      * @type {string}
      * @memberof Metadata
      */
-    cachedImage?: string;
+    cached_image?: string;
     /**
      * 
      * @type {Array<MetadataAttribute>}
@@ -334,13 +408,13 @@ export interface MetadataAttribute {
      * @type {string}
      * @memberof MetadataAttribute
      */
-    traitType: string;
+    trait_type: string;
     /**
      * 
      * @type {string}
      * @memberof MetadataAttribute
      */
-    displayType?: string;
+    display_type?: string;
     /**
      * 
      * @type {any}
@@ -384,7 +458,7 @@ export interface NftMetadataResponse {
      * @type {string}
      * @memberof NftMetadataResponse
      */
-    tokenUri?: string;
+    token_uri?: string;
     /**
      * 
      * @type {Metadata}
@@ -395,67 +469,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 namespace TokenNotFoundResponse {
+    token_uri?: string;
+    /**
+     * 
+     * @type {number}
+     * @memberof SftMetadataResponse
+     */
+    decimals?: number;
     /**
-     * @export
-     * @enum {string}
+     * 
+     * @type {string}
+     * @memberof SftMetadataResponse
      */
-    export enum ErrorEnum {
-        TokenNotFound = <any> 'Token not found'
-    }
+    total_supply?: string;
+    /**
+     * 
+     * @type {Metadata}
+     * @memberof SftMetadataResponse
+     */
+    metadata?: Metadata;
 }
 /**
  * StatusApi - fetch parameter creator
@@ -593,27 +685,85 @@ export const TokensApiFetchParamCreator = function (configuration?: Configuratio
                 options: localVarRequestOptions,
             };
         },
+        /**
+         * 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 {
+            const localVarPath = `/metadata/v1/ft`;
+            const localVarUrlObj = url.parse(localVarPath, true);
+            const localVarRequestOptions = Object.assign({ method: 'GET' }, options);
+            const localVarHeaderParameter = {} as any;
+            const localVarQueryParameter = {} as any;
+
+            if (name !== undefined) {
+                localVarQueryParameter['name'] = name;
+            }
+
+            if (symbol !== undefined) {
+                localVarQueryParameter['symbol'] = symbol;
+            }
+
+            if (address !== undefined) {
+                localVarQueryParameter['address'] = address;
+            }
+
+            if (offset !== undefined) {
+                localVarQueryParameter['offset'] = offset;
+            }
+
+            if (limit !== undefined) {
+                localVarQueryParameter['limit'] = limit;
+            }
+
+            if (order_by !== undefined) {
+                localVarQueryParameter['order_by'] = order_by;
+            }
+
+            if (order !== undefined) {
+                localVarQueryParameter['order'] = order;
+            }
+
+            localVarUrlObj.query = Object.assign({}, localVarUrlObj.query, localVarQueryParameter, options.query);
+            // fix override query string Detail: https://stackoverflow.com/a/7517673/1077943
+            delete localVarUrlObj.search;
+            localVarRequestOptions.headers = Object.assign({}, localVarHeaderParameter, options.headers);
+
+            return {
+                url: url.format(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
         /**
          * 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 {
             // verify required parameter 'principal' is not null or undefined
             if (principal === null || principal === undefined) {
                 throw new RequiredError('principal','Required parameter principal was null or undefined when calling getNftMetadata.');
             }
-            // verify required parameter 'tokenId' is not null or undefined
-            if (tokenId === null || tokenId === undefined) {
-                throw new RequiredError('tokenId','Required parameter tokenId was null or undefined when calling getNftMetadata.');
+            // verify required parameter 'token_id' is not null or undefined
+            if (token_id === null || token_id === undefined) {
+                throw new RequiredError('token_id','Required parameter token_id was null or undefined when calling getNftMetadata.');
             }
             const localVarPath = `/metadata/v1/nft/{principal}/{token_id}`
                 .replace(`{${"principal"}}`, encodeURIComponent(String(principal)))
-                .replace(`{${"token_id"}}`, encodeURIComponent(String(tokenId)));
+                .replace(`{${"token_id"}}`, encodeURIComponent(String(token_id)));
             const localVarUrlObj = url.parse(localVarPath, true);
             const localVarRequestOptions = Object.assign({ method: 'GET' }, options);
             const localVarHeaderParameter = {} as any;
@@ -637,23 +787,23 @@ export const TokensApiFetchParamCreator = function (configuration?: Configuratio
          * 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 {
             // verify required parameter 'principal' is not null or undefined
             if (principal === null || principal === undefined) {
                 throw new RequiredError('principal','Required parameter principal was null or undefined when calling getSftMetadata.');
             }
-            // verify required parameter 'tokenId' is not null or undefined
-            if (tokenId === null || tokenId === undefined) {
-                throw new RequiredError('tokenId','Required parameter tokenId was null or undefined when calling getSftMetadata.');
+            // verify required parameter 'token_id' is not null or undefined
+            if (token_id === null || token_id === undefined) {
+                throw new RequiredError('token_id','Required parameter token_id was null or undefined when calling getSftMetadata.');
             }
             const localVarPath = `/metadata/v1/sft/{principal}/{token_id}`
                 .replace(`{${"principal"}}`, encodeURIComponent(String(principal)))
-                .replace(`{${"token_id"}}`, encodeURIComponent(String(tokenId)));
+                .replace(`{${"token_id"}}`, encodeURIComponent(String(token_id)));
             const localVarUrlObj = url.parse(localVarPath, true);
             const localVarRequestOptions = Object.assign({ method: 'GET' }, options);
             const localVarHeaderParameter = {} as any;
@@ -702,17 +852,42 @@ export const TokensApiFp = function(configuration?: Configuration) {
                 });
             };
         },
+        /**
+         * 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> {
+            const localVarFetchArgs = TokensApiFetchParamCreator(configuration).getFungibleTokens(name, symbol, address, offset, limit, order_by, order, options);
+            return (fetch: FetchAPI = isomorphicFetch, basePath: string = BASE_PATH) => {
+                return fetch(basePath + localVarFetchArgs.url, localVarFetchArgs.options).then((response) => {
+                    if (response.status >= 200 && response.status < 300) {
+                        return response.json();
+                    } else {
+                        throw response;
+                    }
+                });
+            };
+        },
         /**
          * 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> {
-            const localVarFetchArgs = TokensApiFetchParamCreator(configuration).getNftMetadata(principal, tokenId, locale, options);
+        getNftMetadata(principal: string, token_id: number, locale?: string, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<NftMetadataResponse> {
+            const localVarFetchArgs = TokensApiFetchParamCreator(configuration).getNftMetadata(principal, token_id, locale, options);
             return (fetch: FetchAPI = isomorphicFetch, basePath: string = BASE_PATH) => {
                 return fetch(basePath + localVarFetchArgs.url, localVarFetchArgs.options).then((response) => {
                     if (response.status >= 200 && response.status < 300) {
@@ -727,13 +902,13 @@ export const TokensApiFp = function(configuration?: Configuration) {
          * 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> {
-            const localVarFetchArgs = TokensApiFetchParamCreator(configuration).getSftMetadata(principal, tokenId, locale, options);
+        getSftMetadata(principal: string, token_id: number, locale?: string, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<SftMetadataResponse> {
+            const localVarFetchArgs = TokensApiFetchParamCreator(configuration).getSftMetadata(principal, token_id, locale, options);
             return (fetch: FetchAPI = isomorphicFetch, basePath: string = BASE_PATH) => {
                 return fetch(basePath + localVarFetchArgs.url, localVarFetchArgs.options).then((response) => {
                     if (response.status >= 200 && response.status < 300) {
@@ -764,29 +939,45 @@ export const TokensApiFactory = function (configuration?: Configuration, fetch?:
         getFtMetadata(principal: string, locale?: string, options?: any) {
             return TokensApiFp(configuration).getFtMetadata(principal, locale, options)(fetch, basePath);
         },
+        /**
+         * 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) {
+            return TokensApiFp(configuration).getFungibleTokens(name, symbol, address, offset, limit, order_by, order, options)(fetch, basePath);
+        },
         /**
          * 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) {
-            return TokensApiFp(configuration).getNftMetadata(principal, tokenId, locale, options)(fetch, basePath);
+        getNftMetadata(principal: string, token_id: number, locale?: string, options?: any) {
+            return TokensApiFp(configuration).getNftMetadata(principal, token_id, locale, options)(fetch, basePath);
         },
         /**
          * 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) {
-            return TokensApiFp(configuration).getSftMetadata(principal, tokenId, locale, options)(fetch, basePath);
+        getSftMetadata(principal: string, token_id: number, locale?: string, options?: any) {
+            return TokensApiFp(configuration).getSftMetadata(principal, token_id, locale, options)(fetch, basePath);
         },
     };
 };
@@ -811,32 +1002,50 @@ export class TokensApi extends BaseAPI {
         return TokensApiFp(this.configuration).getFtMetadata(principal, locale, options)(this.fetch, this.basePath);
     }
 
+    /**
+     * 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
+     */
+    public getFungibleTokens(name?: string, symbol?: string, address?: string, offset?: number, limit?: number, order_by?: OrderBy, order?: Order, options?: any) {
+        return TokensApiFp(this.configuration).getFungibleTokens(name, symbol, address, offset, limit, order_by, order, options)(this.fetch, this.basePath);
+    }
+
     /**
      * 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
      */
-    public getNftMetadata(principal: string, tokenId: number, locale?: string, options?: any) {
-        return TokensApiFp(this.configuration).getNftMetadata(principal, tokenId, locale, options)(this.fetch, this.basePath);
+    public getNftMetadata(principal: string, token_id: number, locale?: string, options?: any) {
+        return TokensApiFp(this.configuration).getNftMetadata(principal, token_id, locale, options)(this.fetch, this.basePath);
     }
 
     /**
      * 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
      */
-    public getSftMetadata(principal: string, tokenId: number, locale?: string, options?: any) {
-        return TokensApiFp(this.configuration).getSftMetadata(principal, tokenId, locale, options)(this.fetch, this.basePath);
+    public getSftMetadata(principal: string, token_id: number, locale?: string, options?: any) {
+        return TokensApiFp(this.configuration).getSftMetadata(principal, token_id, locale, options)(this.fetch, this.basePath);
     }
 
 }

package/configuration.ts

@@ -3,7 +3,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.