@stacks/blockchain-api-client 0.71.1 → 1.0.3

package/src/generated/apis/{BNSApi.ts → NamesApi.ts}

@@ -1,8 +1,8 @@
 /* tslint:disable */
 /* eslint-disable */
 /**
- * Stacks 2.0 Blockchain API
- * This is the documentation for the Stacks 2.0 Blockchain API.  It is comprised of two parts; the Stacks Blockchain API and the Stacks Core API.  <a href=\"collection.json\" download=\"collection.json\">Download Postman collection</a> 
+ * Stacks Blockchain API
+ * Welcome to the API reference overview for the <a href=\"https://docs.hiro.so/get-started/stacks-blockchain-api\">Stacks Blockchain API</a>.  <a href=\"/collection.json\" download=\"stacks-api-collection.json\">Download Postman collection</a> 
  *
  * The version of the OpenAPI document: STACKS_API_VERSION
  * 
@@ -87,136 +87,137 @@ export interface GetSubdomainAtTransactionRequest {
 }
 
 /**
- * BNSApi - interface
+ * NamesApi - interface
  * 
  * @export
- * @interface BNSApiInterface
+ * @interface NamesApiInterface
  */
-export interface BNSApiInterface {
+export interface NamesApiInterface {
     /**
-     * Fetch a user’s raw zone file. This only works for RFC-compliant zone files. This method returns an error for names that have non-standard zone files.
-     * @summary Fetch Zone File
+     * Retrieves a user’s raw zone file. This only works for RFC-compliant zone files. This method returns an error for names that have non-standard zone files.
+     * @summary Get Zone File
      * @param {string} name fully-qualified name
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
-     * @memberof BNSApiInterface
+     * @memberof NamesApiInterface
      */
     fetchZoneFileRaw(requestParameters: FetchZoneFileRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<object>>;
 
     /**
-     * Fetch a user’s raw zone file. This only works for RFC-compliant zone files. This method returns an error for names that have non-standard zone files.
-     * Fetch Zone File
+     * Retrieves a user’s raw zone file. This only works for RFC-compliant zone files. This method returns an error for names that have non-standard zone files.
+     * Get Zone File
      */
     fetchZoneFile(requestParameters: FetchZoneFileRequest, initOverrides?: RequestInit): Promise<object>;
 
     /**
-     * Fetch a list of all names known to the node.
+     * Retrieves a list of all names known to the node.
      * @summary Get All Names
      * @param {number} page names are returned in pages of size 100, so specify the page number.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
-     * @memberof BNSApiInterface
+     * @memberof NamesApiInterface
      */
     getAllNamesRaw(requestParameters: GetAllNamesRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<Array<string>>>;
 
     /**
-     * Fetch a list of all names known to the node.
+     * Retrieves a list of all names known to the node.
      * Get All Names
      */
     getAllNames(requestParameters: GetAllNamesRequest, initOverrides?: RequestInit): Promise<Array<string>>;
 
     /**
-     * Fetch a list of all namespaces known to the node.
+     * Retrieves a list of all namespaces known to the node.
      * @summary Get All Namespaces
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
-     * @memberof BNSApiInterface
+     * @memberof NamesApiInterface
      */
     getAllNamespacesRaw(initOverrides?: RequestInit): Promise<runtime.ApiResponse<BnsGetAllNamespacesResponse>>;
 
     /**
-     * Fetch a list of all namespaces known to the node.
+     * Retrieves a list of all namespaces known to the node.
      * Get All Namespaces
      */
     getAllNamespaces(initOverrides?: RequestInit): Promise<BnsGetAllNamespacesResponse>;
 
     /**
-     * Fetch a list of all subdomains known to the node.
+     * Retrieves a list of all subdomains known to the node.
      * @summary Get All Subdomains
      * @param {number} page names are returned in pages of size 100, so specify the page number.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
-     * @memberof BNSApiInterface
+     * @memberof NamesApiInterface
      */
     getAllSubdomainsRaw(requestParameters: GetAllSubdomainsRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<Array<string>>>;
 
     /**
-     * Fetch a list of all subdomains known to the node.
+     * Retrieves a list of all subdomains known to the node.
      * Get All Subdomains
      */
     getAllSubdomains(requestParameters: GetAllSubdomainsRequest, initOverrides?: RequestInit): Promise<Array<string>>;
 
     /**
-     * Fetches the historical zonefile specified by the username and zone hash.
+     * Retrieves the historical zonefile specified by the username and zone hash.
      * @summary Get Historical Zone File
      * @param {string} name fully-qualified name
      * @param {string} zoneFileHash zone file hash
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
-     * @memberof BNSApiInterface
+     * @memberof NamesApiInterface
      */
     getHistoricalZoneFileRaw(requestParameters: GetHistoricalZoneFileRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<object>>;
 
     /**
-     * Fetches the historical zonefile specified by the username and zone hash.
+     * Retrieves the historical zonefile specified by the username and zone hash.
      * Get Historical Zone File
      */
     getHistoricalZoneFile(requestParameters: GetHistoricalZoneFileRequest, initOverrides?: RequestInit): Promise<object>;
 
     /**
-     * Get a history of all blockchain records of a registered name.
+     * Retrieves a history of all blockchain records of a registered name.
      * @summary Get Name History
      * @param {string} name name to query
      * @param {number} page the page (in 20-entry pages) of the history to fetch
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
-     * @memberof BNSApiInterface
+     * @memberof NamesApiInterface
      */
     getNameHistoryRaw(requestParameters: GetNameHistoryRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<object>>;
 
     /**
-     * Get a history of all blockchain records of a registered name.
+     * Retrieves a history of all blockchain records of a registered name.
      * Get Name History
      */
     getNameHistory(requestParameters: GetNameHistoryRequest, initOverrides?: RequestInit): Promise<object>;
 
     /**
-     * 
+     * Retrieves details of a given name including the `address`, `status` and last transaction id - `last_txid`.
      * @summary Get Name Details
      * @param {string} name fully-qualified name
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
-     * @memberof BNSApiInterface
+     * @memberof NamesApiInterface
      */
     getNameInfoRaw(requestParameters: GetNameInfoRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<BnsGetNameInfoResponse>>;
 
     /**
+     * Retrieves details of a given name including the `address`, `status` and last transaction id - `last_txid`.
      * Get Name Details
      */
     getNameInfo(requestParameters: GetNameInfoRequest, initOverrides?: RequestInit): Promise<BnsGetNameInfoResponse>;
 
     /**
-     * Get the price of a name. The `amount` given will be in the smallest possible units of the currency.
+     * Retrieves the price of a name. The `amount` given will be in the smallest possible units of the currency.
      * @summary Get Name Price
      * @param {string} name the name to query price information for
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
-     * @memberof BNSApiInterface
+     * @memberof NamesApiInterface
      */
     getNamePriceRaw(requestParameters: GetNamePriceRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<BnsGetNamePriceResponse>>;
 
     /**
-     * Get the price of a name. The `amount` given will be in the smallest possible units of the currency.
+     * Retrieves the price of a name. The `amount` given will be in the smallest possible units of the currency.
      * Get Name Price
      */
     getNamePrice(requestParameters: GetNamePriceRequest, initOverrides?: RequestInit): Promise<BnsGetNamePriceResponse>;
@@ -228,7 +229,7 @@ export interface BNSApiInterface {
      * @param {string} address the address to lookup
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
-     * @memberof BNSApiInterface
+     * @memberof NamesApiInterface
      */
     getNamesOwnedByAddressRaw(requestParameters: GetNamesOwnedByAddressRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<BnsNamesOwnByAddressResponse>>;
 
@@ -239,50 +240,50 @@ export interface BNSApiInterface {
     getNamesOwnedByAddress(requestParameters: GetNamesOwnedByAddressRequest, initOverrides?: RequestInit): Promise<BnsNamesOwnByAddressResponse>;
 
     /**
-     * Fetch a list of names from the namespace.
+     * Retrieves a list of names within a given namespace.
      * @summary Get Namespace Names
      * @param {string} tld the namespace to fetch names from
      * @param {number} page names are returned in pages of size 100, so specify the page number.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
-     * @memberof BNSApiInterface
+     * @memberof NamesApiInterface
      */
     getNamespaceNamesRaw(requestParameters: GetNamespaceNamesRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<Array<string>>>;
 
     /**
-     * Fetch a list of names from the namespace.
+     * Retrieves a list of names within a given namespace.
      * Get Namespace Names
      */
     getNamespaceNames(requestParameters: GetNamespaceNamesRequest, initOverrides?: RequestInit): Promise<Array<string>>;
 
     /**
-     * Get the price of a namespace. The `amount` given will be in the smallest possible units of the currency.
+     * Retrieves the price of a namespace. The `amount` given will be in the smallest possible units of the currency.
      * @summary Get Namespace Price
      * @param {string} tld the namespace to fetch price for
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
-     * @memberof BNSApiInterface
+     * @memberof NamesApiInterface
      */
     getNamespacePriceRaw(requestParameters: GetNamespacePriceRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<BnsGetNamespacePriceResponse>>;
 
     /**
-     * Get the price of a namespace. The `amount` given will be in the smallest possible units of the currency.
+     * Retrieves the price of a namespace. The `amount` given will be in the smallest possible units of the currency.
      * Get Namespace Price
      */
     getNamespacePrice(requestParameters: GetNamespacePriceRequest, initOverrides?: RequestInit): Promise<BnsGetNamespacePriceResponse>;
 
     /**
-     * Fetches the list of subdomain operations processed by a given transaction. The returned array includes subdomain operations that have not yet been accepted as part of any subdomain’s history (checkable via the accepted field). If the given transaction ID does not correspond to a Blockstack transaction that introduced new subdomain operations, and empty array will be returned.
+     * Retrieves the list of subdomain operations processed by a given transaction. The returned array includes subdomain operations that have not yet been accepted as part of any subdomain’s history (checkable via the accepted field). If the given transaction ID does not correspond to a Stacks transaction that introduced new subdomain operations, and empty array will be returned.
      * @summary Get Subdomain at Transaction
      * @param {string} txid transaction id
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
-     * @memberof BNSApiInterface
+     * @memberof NamesApiInterface
      */
     getSubdomainAtTransactionRaw(requestParameters: GetSubdomainAtTransactionRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<Array<InlineResponse200>>>;
 
     /**
-     * Fetches the list of subdomain operations processed by a given transaction. The returned array includes subdomain operations that have not yet been accepted as part of any subdomain’s history (checkable via the accepted field). If the given transaction ID does not correspond to a Blockstack transaction that introduced new subdomain operations, and empty array will be returned.
+     * Retrieves the list of subdomain operations processed by a given transaction. The returned array includes subdomain operations that have not yet been accepted as part of any subdomain’s history (checkable via the accepted field). If the given transaction ID does not correspond to a Stacks transaction that introduced new subdomain operations, and empty array will be returned.
      * Get Subdomain at Transaction
      */
     getSubdomainAtTransaction(requestParameters: GetSubdomainAtTransactionRequest, initOverrides?: RequestInit): Promise<Array<InlineResponse200>>;
@@ -292,11 +293,11 @@ export interface BNSApiInterface {
 /**
  * 
  */
-export class BNSApi extends runtime.BaseAPI implements BNSApiInterface {
+export class NamesApi extends runtime.BaseAPI implements NamesApiInterface {
 
     /**
-     * Fetch a user’s raw zone file. This only works for RFC-compliant zone files. This method returns an error for names that have non-standard zone files.
-     * Fetch Zone File
+     * Retrieves a user’s raw zone file. This only works for RFC-compliant zone files. This method returns an error for names that have non-standard zone files.
+     * Get Zone File
      */
     async fetchZoneFileRaw(requestParameters: FetchZoneFileRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<object>> {
         if (requestParameters.name === null || requestParameters.name === undefined) {
@@ -318,8 +319,8 @@ export class BNSApi extends runtime.BaseAPI implements BNSApiInterface {
     }
 
     /**
-     * Fetch a user’s raw zone file. This only works for RFC-compliant zone files. This method returns an error for names that have non-standard zone files.
-     * Fetch Zone File
+     * Retrieves a user’s raw zone file. This only works for RFC-compliant zone files. This method returns an error for names that have non-standard zone files.
+     * Get Zone File
      */
     async fetchZoneFile(requestParameters: FetchZoneFileRequest, initOverrides?: RequestInit): Promise<object> {
         const response = await this.fetchZoneFileRaw(requestParameters, initOverrides);
@@ -327,7 +328,7 @@ export class BNSApi extends runtime.BaseAPI implements BNSApiInterface {
     }
 
     /**
-     * Fetch a list of all names known to the node.
+     * Retrieves a list of all names known to the node.
      * Get All Names
      */
     async getAllNamesRaw(requestParameters: GetAllNamesRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<Array<string>>> {
@@ -354,7 +355,7 @@ export class BNSApi extends runtime.BaseAPI implements BNSApiInterface {
     }
 
     /**
-     * Fetch a list of all names known to the node.
+     * Retrieves a list of all names known to the node.
      * Get All Names
      */
     async getAllNames(requestParameters: GetAllNamesRequest, initOverrides?: RequestInit): Promise<Array<string>> {
@@ -363,7 +364,7 @@ export class BNSApi extends runtime.BaseAPI implements BNSApiInterface {
     }
 
     /**
-     * Fetch a list of all namespaces known to the node.
+     * Retrieves a list of all namespaces known to the node.
      * Get All Namespaces
      */
     async getAllNamespacesRaw(initOverrides?: RequestInit): Promise<runtime.ApiResponse<BnsGetAllNamespacesResponse>> {
@@ -382,7 +383,7 @@ export class BNSApi extends runtime.BaseAPI implements BNSApiInterface {
     }
 
     /**
-     * Fetch a list of all namespaces known to the node.
+     * Retrieves a list of all namespaces known to the node.
      * Get All Namespaces
      */
     async getAllNamespaces(initOverrides?: RequestInit): Promise<BnsGetAllNamespacesResponse> {
@@ -391,7 +392,7 @@ export class BNSApi extends runtime.BaseAPI implements BNSApiInterface {
     }
 
     /**
-     * Fetch a list of all subdomains known to the node.
+     * Retrieves a list of all subdomains known to the node.
      * Get All Subdomains
      */
     async getAllSubdomainsRaw(requestParameters: GetAllSubdomainsRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<Array<string>>> {
@@ -418,7 +419,7 @@ export class BNSApi extends runtime.BaseAPI implements BNSApiInterface {
     }
 
     /**
-     * Fetch a list of all subdomains known to the node.
+     * Retrieves a list of all subdomains known to the node.
      * Get All Subdomains
      */
     async getAllSubdomains(requestParameters: GetAllSubdomainsRequest, initOverrides?: RequestInit): Promise<Array<string>> {
@@ -427,7 +428,7 @@ export class BNSApi extends runtime.BaseAPI implements BNSApiInterface {
     }
 
     /**
-     * Fetches the historical zonefile specified by the username and zone hash.
+     * Retrieves the historical zonefile specified by the username and zone hash.
      * Get Historical Zone File
      */
     async getHistoricalZoneFileRaw(requestParameters: GetHistoricalZoneFileRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<object>> {
@@ -454,7 +455,7 @@ export class BNSApi extends runtime.BaseAPI implements BNSApiInterface {
     }
 
     /**
-     * Fetches the historical zonefile specified by the username and zone hash.
+     * Retrieves the historical zonefile specified by the username and zone hash.
      * Get Historical Zone File
      */
     async getHistoricalZoneFile(requestParameters: GetHistoricalZoneFileRequest, initOverrides?: RequestInit): Promise<object> {
@@ -463,7 +464,7 @@ export class BNSApi extends runtime.BaseAPI implements BNSApiInterface {
     }
 
     /**
-     * Get a history of all blockchain records of a registered name.
+     * Retrieves a history of all blockchain records of a registered name.
      * Get Name History
      */
     async getNameHistoryRaw(requestParameters: GetNameHistoryRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<object>> {
@@ -494,7 +495,7 @@ export class BNSApi extends runtime.BaseAPI implements BNSApiInterface {
     }
 
     /**
-     * Get a history of all blockchain records of a registered name.
+     * Retrieves a history of all blockchain records of a registered name.
      * Get Name History
      */
     async getNameHistory(requestParameters: GetNameHistoryRequest, initOverrides?: RequestInit): Promise<object> {
@@ -503,6 +504,7 @@ export class BNSApi extends runtime.BaseAPI implements BNSApiInterface {
     }
 
     /**
+     * Retrieves details of a given name including the `address`, `status` and last transaction id - `last_txid`.
      * Get Name Details
      */
     async getNameInfoRaw(requestParameters: GetNameInfoRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<BnsGetNameInfoResponse>> {
@@ -525,6 +527,7 @@ export class BNSApi extends runtime.BaseAPI implements BNSApiInterface {
     }
 
     /**
+     * Retrieves details of a given name including the `address`, `status` and last transaction id - `last_txid`.
      * Get Name Details
      */
     async getNameInfo(requestParameters: GetNameInfoRequest, initOverrides?: RequestInit): Promise<BnsGetNameInfoResponse> {
@@ -533,7 +536,7 @@ export class BNSApi extends runtime.BaseAPI implements BNSApiInterface {
     }
 
     /**
-     * Get the price of a name. The `amount` given will be in the smallest possible units of the currency.
+     * Retrieves the price of a name. The `amount` given will be in the smallest possible units of the currency.
      * Get Name Price
      */
     async getNamePriceRaw(requestParameters: GetNamePriceRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<BnsGetNamePriceResponse>> {
@@ -556,7 +559,7 @@ export class BNSApi extends runtime.BaseAPI implements BNSApiInterface {
     }
 
     /**
-     * Get the price of a name. The `amount` given will be in the smallest possible units of the currency.
+     * Retrieves the price of a name. The `amount` given will be in the smallest possible units of the currency.
      * Get Name Price
      */
     async getNamePrice(requestParameters: GetNamePriceRequest, initOverrides?: RequestInit): Promise<BnsGetNamePriceResponse> {
@@ -601,7 +604,7 @@ export class BNSApi extends runtime.BaseAPI implements BNSApiInterface {
     }
 
     /**
-     * Fetch a list of names from the namespace.
+     * Retrieves a list of names within a given namespace.
      * Get Namespace Names
      */
     async getNamespaceNamesRaw(requestParameters: GetNamespaceNamesRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<Array<string>>> {
@@ -632,7 +635,7 @@ export class BNSApi extends runtime.BaseAPI implements BNSApiInterface {
     }
 
     /**
-     * Fetch a list of names from the namespace.
+     * Retrieves a list of names within a given namespace.
      * Get Namespace Names
      */
     async getNamespaceNames(requestParameters: GetNamespaceNamesRequest, initOverrides?: RequestInit): Promise<Array<string>> {
@@ -641,7 +644,7 @@ export class BNSApi extends runtime.BaseAPI implements BNSApiInterface {
     }
 
     /**
-     * Get the price of a namespace. The `amount` given will be in the smallest possible units of the currency.
+     * Retrieves the price of a namespace. The `amount` given will be in the smallest possible units of the currency.
      * Get Namespace Price
      */
     async getNamespacePriceRaw(requestParameters: GetNamespacePriceRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<BnsGetNamespacePriceResponse>> {
@@ -664,7 +667,7 @@ export class BNSApi extends runtime.BaseAPI implements BNSApiInterface {
     }
 
     /**
-     * Get the price of a namespace. The `amount` given will be in the smallest possible units of the currency.
+     * Retrieves the price of a namespace. The `amount` given will be in the smallest possible units of the currency.
      * Get Namespace Price
      */
     async getNamespacePrice(requestParameters: GetNamespacePriceRequest, initOverrides?: RequestInit): Promise<BnsGetNamespacePriceResponse> {
@@ -673,7 +676,7 @@ export class BNSApi extends runtime.BaseAPI implements BNSApiInterface {
     }
 
     /**
-     * Fetches the list of subdomain operations processed by a given transaction. The returned array includes subdomain operations that have not yet been accepted as part of any subdomain’s history (checkable via the accepted field). If the given transaction ID does not correspond to a Blockstack transaction that introduced new subdomain operations, and empty array will be returned.
+     * Retrieves the list of subdomain operations processed by a given transaction. The returned array includes subdomain operations that have not yet been accepted as part of any subdomain’s history (checkable via the accepted field). If the given transaction ID does not correspond to a Stacks transaction that introduced new subdomain operations, and empty array will be returned.
      * Get Subdomain at Transaction
      */
     async getSubdomainAtTransactionRaw(requestParameters: GetSubdomainAtTransactionRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<Array<InlineResponse200>>> {
@@ -696,7 +699,7 @@ export class BNSApi extends runtime.BaseAPI implements BNSApiInterface {
     }
 
     /**
-     * Fetches the list of subdomain operations processed by a given transaction. The returned array includes subdomain operations that have not yet been accepted as part of any subdomain’s history (checkable via the accepted field). If the given transaction ID does not correspond to a Blockstack transaction that introduced new subdomain operations, and empty array will be returned.
+     * Retrieves the list of subdomain operations processed by a given transaction. The returned array includes subdomain operations that have not yet been accepted as part of any subdomain’s history (checkable via the accepted field). If the given transaction ID does not correspond to a Stacks transaction that introduced new subdomain operations, and empty array will be returned.
      * Get Subdomain at Transaction
      */
     async getSubdomainAtTransaction(requestParameters: GetSubdomainAtTransactionRequest, initOverrides?: RequestInit): Promise<Array<InlineResponse200>> {

package/src/generated/apis/NonFungibleTokensApi.ts

@@ -0,0 +1,150 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Stacks Blockchain API
+ * Welcome to the API reference overview for the <a href=\"https://docs.hiro.so/get-started/stacks-blockchain-api\">Stacks Blockchain API</a>.  <a href=\"/collection.json\" download=\"stacks-api-collection.json\">Download Postman collection</a> 
+ *
+ * The version of the OpenAPI document: STACKS_API_VERSION
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+import * as runtime from '../runtime';
+import {
+    NonFungibleTokenMetadata,
+    NonFungibleTokenMetadataFromJSON,
+    NonFungibleTokenMetadataToJSON,
+    NonFungibleTokensMetadataList,
+    NonFungibleTokensMetadataListFromJSON,
+    NonFungibleTokensMetadataListToJSON,
+} from '../models';
+
+export interface GetContractNftMetadataRequest {
+    contractId: string;
+}
+
+export interface GetNftMetadataListRequest {
+    limit?: number;
+    offset?: number;
+}
+
+/**
+ * NonFungibleTokensApi - interface
+ * 
+ * @export
+ * @interface NonFungibleTokensApiInterface
+ */
+export interface NonFungibleTokensApiInterface {
+    /**
+     * Retrieves metadata for non fungible tokens for a given contract id. More information on Non-Fungible Tokens on the Stacks blockchain can be found [here](https://docs.stacks.co/write-smart-contracts/tokens#non-fungible-tokens-nfts).
+     * @summary Non fungible tokens metadata for contract id
+     * @param {string} contractId token\&#39;s contract id
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof NonFungibleTokensApiInterface
+     */
+    getContractNftMetadataRaw(requestParameters: GetContractNftMetadataRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<NonFungibleTokenMetadata>>;
+
+    /**
+     * Retrieves metadata for non fungible tokens for a given contract id. More information on Non-Fungible Tokens on the Stacks blockchain can be found [here](https://docs.stacks.co/write-smart-contracts/tokens#non-fungible-tokens-nfts).
+     * Non fungible tokens metadata for contract id
+     */
+    getContractNftMetadata(requestParameters: GetContractNftMetadataRequest, initOverrides?: RequestInit): Promise<NonFungibleTokenMetadata>;
+
+    /**
+     * Retrieves a list of non fungible tokens with their metadata. More information on Non-Fungible Tokens on the Stacks blockchain can be found [here](https://docs.stacks.co/write-smart-contracts/tokens#non-fungible-tokens-nfts).
+     * @summary Non fungible tokens metadata list
+     * @param {number} [limit] max number of tokens to fetch
+     * @param {number} [offset] index of first tokens to fetch
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof NonFungibleTokensApiInterface
+     */
+    getNftMetadataListRaw(requestParameters: GetNftMetadataListRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<NonFungibleTokensMetadataList>>;
+
+    /**
+     * Retrieves a list of non fungible tokens with their metadata. More information on Non-Fungible Tokens on the Stacks blockchain can be found [here](https://docs.stacks.co/write-smart-contracts/tokens#non-fungible-tokens-nfts).
+     * Non fungible tokens metadata list
+     */
+    getNftMetadataList(requestParameters: GetNftMetadataListRequest, initOverrides?: RequestInit): Promise<NonFungibleTokensMetadataList>;
+
+}
+
+/**
+ * 
+ */
+export class NonFungibleTokensApi extends runtime.BaseAPI implements NonFungibleTokensApiInterface {
+
+    /**
+     * Retrieves metadata for non fungible tokens for a given contract id. More information on Non-Fungible Tokens on the Stacks blockchain can be found [here](https://docs.stacks.co/write-smart-contracts/tokens#non-fungible-tokens-nfts).
+     * Non fungible tokens metadata for contract id
+     */
+    async getContractNftMetadataRaw(requestParameters: GetContractNftMetadataRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<NonFungibleTokenMetadata>> {
+        if (requestParameters.contractId === null || requestParameters.contractId === undefined) {
+            throw new runtime.RequiredError('contractId','Required parameter requestParameters.contractId was null or undefined when calling getContractNftMetadata.');
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        const response = await this.request({
+            path: `/extended/v1/tokens/{contractId}/nft/metadata`.replace(`{${"contractId"}}`, encodeURIComponent(String(requestParameters.contractId))),
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => NonFungibleTokenMetadataFromJSON(jsonValue));
+    }
+
+    /**
+     * Retrieves metadata for non fungible tokens for a given contract id. More information on Non-Fungible Tokens on the Stacks blockchain can be found [here](https://docs.stacks.co/write-smart-contracts/tokens#non-fungible-tokens-nfts).
+     * Non fungible tokens metadata for contract id
+     */
+    async getContractNftMetadata(requestParameters: GetContractNftMetadataRequest, initOverrides?: RequestInit): Promise<NonFungibleTokenMetadata> {
+        const response = await this.getContractNftMetadataRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Retrieves a list of non fungible tokens with their metadata. More information on Non-Fungible Tokens on the Stacks blockchain can be found [here](https://docs.stacks.co/write-smart-contracts/tokens#non-fungible-tokens-nfts).
+     * Non fungible tokens metadata list
+     */
+    async getNftMetadataListRaw(requestParameters: GetNftMetadataListRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<NonFungibleTokensMetadataList>> {
+        const queryParameters: any = {};
+
+        if (requestParameters.limit !== undefined) {
+            queryParameters['limit'] = requestParameters.limit;
+        }
+
+        if (requestParameters.offset !== undefined) {
+            queryParameters['offset'] = requestParameters.offset;
+        }
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        const response = await this.request({
+            path: `/extended/v1/tokens/nft/metadata`,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => NonFungibleTokensMetadataListFromJSON(jsonValue));
+    }
+
+    /**
+     * Retrieves a list of non fungible tokens with their metadata. More information on Non-Fungible Tokens on the Stacks blockchain can be found [here](https://docs.stacks.co/write-smart-contracts/tokens#non-fungible-tokens-nfts).
+     * Non fungible tokens metadata list
+     */
+    async getNftMetadataList(requestParameters: GetNftMetadataListRequest, initOverrides?: RequestInit): Promise<NonFungibleTokensMetadataList> {
+        const response = await this.getNftMetadataListRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+}