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

package/dist/api.js

@@ -5,7 +5,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.
@@ -26,7 +26,7 @@ var __extends = (this && this.__extends) || (function () {
     };
 })();
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.TokensApi = exports.TokensApiFactory = exports.TokensApiFp = exports.TokensApiFetchParamCreator = exports.StatusApi = exports.StatusApiFactory = exports.StatusApiFp = exports.StatusApiFetchParamCreator = exports.TokenNotFoundResponse = exports.RequiredError = exports.BaseAPI = exports.COLLECTION_FORMATS = void 0;
+exports.TokensApi = exports.TokensApiFactory = exports.TokensApiFp = exports.TokensApiFetchParamCreator = exports.StatusApi = exports.StatusApiFactory = exports.StatusApiFp = exports.StatusApiFetchParamCreator = exports.RequiredError = exports.BaseAPI = exports.COLLECTION_FORMATS = void 0;
 var url = require("url");
 var isomorphicFetch = require("isomorphic-fetch");
 var BASE_PATH = "https://api.hiro.so/".replace(/\/+$/, "");
@@ -76,21 +76,6 @@ var RequiredError = /** @class */ (function (_super) {
     return RequiredError;
 }(Error));
 exports.RequiredError = RequiredError;
-/**
- * @export
- * @namespace TokenNotFoundResponse
- */
-var TokenNotFoundResponse;
-(function (TokenNotFoundResponse) {
-    /**
-     * @export
-     * @enum {string}
-     */
-    var ErrorEnum;
-    (function (ErrorEnum) {
-        ErrorEnum[ErrorEnum["TokenNotFound"] = 'Token not found'] = "TokenNotFound";
-    })(ErrorEnum = TokenNotFoundResponse.ErrorEnum || (TokenNotFoundResponse.ErrorEnum = {}));
-})(TokenNotFoundResponse = exports.TokenNotFoundResponse || (exports.TokenNotFoundResponse = {}));
 /**
  * StatusApi - fetch parameter creator
  * @export
@@ -229,28 +214,78 @@ exports.TokensApiFetchParamCreator = function (configuration) {
                 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: function (name, symbol, address, offset, limit, order_by, order, options) {
+            if (options === void 0) { options = {}; }
+            var localVarPath = "/metadata/v1/ft";
+            var localVarUrlObj = url.parse(localVarPath, true);
+            var localVarRequestOptions = Object.assign({ method: 'GET' }, options);
+            var localVarHeaderParameter = {};
+            var localVarQueryParameter = {};
+            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: function (principal, tokenId, locale, options) {
+        getNftMetadata: function (principal, token_id, locale, options) {
             if (options === void 0) { options = {}; }
             // 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.');
             }
             var 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)));
             var localVarUrlObj = url.parse(localVarPath, true);
             var localVarRequestOptions = Object.assign({ method: 'GET' }, options);
             var localVarHeaderParameter = {};
@@ -271,24 +306,24 @@ exports.TokensApiFetchParamCreator = function (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: function (principal, tokenId, locale, options) {
+        getSftMetadata: function (principal, token_id, locale, options) {
             if (options === void 0) { options = {}; }
             // 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.');
             }
             var 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)));
             var localVarUrlObj = url.parse(localVarPath, true);
             var localVarRequestOptions = Object.assign({ method: 'GET' }, options);
             var localVarHeaderParameter = {};
@@ -336,17 +371,45 @@ exports.TokensApiFp = function (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: function (name, symbol, address, offset, limit, order_by, order, options) {
+            var localVarFetchArgs = exports.TokensApiFetchParamCreator(configuration).getFungibleTokens(name, symbol, address, offset, limit, order_by, order, options);
+            return function (fetch, basePath) {
+                if (fetch === void 0) { fetch = isomorphicFetch; }
+                if (basePath === void 0) { basePath = BASE_PATH; }
+                return fetch(basePath + localVarFetchArgs.url, localVarFetchArgs.options).then(function (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: function (principal, tokenId, locale, options) {
-            var localVarFetchArgs = exports.TokensApiFetchParamCreator(configuration).getNftMetadata(principal, tokenId, locale, options);
+        getNftMetadata: function (principal, token_id, locale, options) {
+            var localVarFetchArgs = exports.TokensApiFetchParamCreator(configuration).getNftMetadata(principal, token_id, locale, options);
             return function (fetch, basePath) {
                 if (fetch === void 0) { fetch = isomorphicFetch; }
                 if (basePath === void 0) { basePath = BASE_PATH; }
@@ -364,13 +427,13 @@ exports.TokensApiFp = function (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: function (principal, tokenId, locale, options) {
-            var localVarFetchArgs = exports.TokensApiFetchParamCreator(configuration).getSftMetadata(principal, tokenId, locale, options);
+        getSftMetadata: function (principal, token_id, locale, options) {
+            var localVarFetchArgs = exports.TokensApiFetchParamCreator(configuration).getSftMetadata(principal, token_id, locale, options);
             return function (fetch, basePath) {
                 if (fetch === void 0) { fetch = isomorphicFetch; }
                 if (basePath === void 0) { basePath = BASE_PATH; }
@@ -403,29 +466,45 @@ exports.TokensApiFactory = function (configuration, fetch, basePath) {
         getFtMetadata: function (principal, locale, options) {
             return exports.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: function (name, symbol, address, offset, limit, order_by, order, options) {
+            return exports.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: function (principal, tokenId, locale, options) {
-            return exports.TokensApiFp(configuration).getNftMetadata(principal, tokenId, locale, options)(fetch, basePath);
+        getNftMetadata: function (principal, token_id, locale, options) {
+            return exports.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: function (principal, tokenId, locale, options) {
-            return exports.TokensApiFp(configuration).getSftMetadata(principal, tokenId, locale, options)(fetch, basePath);
+        getSftMetadata: function (principal, token_id, locale, options) {
+            return exports.TokensApiFp(configuration).getSftMetadata(principal, token_id, locale, options)(fetch, basePath);
         },
     };
 };
@@ -452,31 +531,48 @@ var TokensApi = /** @class */ (function (_super) {
     TokensApi.prototype.getFtMetadata = function (principal, locale, options) {
         return exports.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
+     */
+    TokensApi.prototype.getFungibleTokens = function (name, symbol, address, offset, limit, order_by, order, options) {
+        return exports.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
      */
-    TokensApi.prototype.getNftMetadata = function (principal, tokenId, locale, options) {
-        return exports.TokensApiFp(this.configuration).getNftMetadata(principal, tokenId, locale, options)(this.fetch, this.basePath);
+    TokensApi.prototype.getNftMetadata = function (principal, token_id, locale, options) {
+        return exports.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
      */
-    TokensApi.prototype.getSftMetadata = function (principal, tokenId, locale, options) {
-        return exports.TokensApiFp(this.configuration).getSftMetadata(principal, tokenId, locale, options)(this.fetch, this.basePath);
+    TokensApi.prototype.getSftMetadata = function (principal, token_id, locale, options) {
+        return exports.TokensApiFp(this.configuration).getSftMetadata(principal, token_id, locale, options)(this.fetch, this.basePath);
     };
     return TokensApi;
 }(BaseAPI));

package/dist/configuration.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.

package/dist/configuration.js

@@ -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.

package/dist/index.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.

package/dist/index.js

@@ -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.

package/index.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.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hirosystems/token-metadata-api-client",
-  "version": "1.0.2",
+  "version": "1.1.0",
   "description": "Client for @hirosystems/token-metadata-api",
   "author": "Hiro Systems PBC <engineering@hiro.so> (https://hiro.so)",
   "keywords": [