@stacks/blockchain-api-client 0.71.2 → 1.0.0

package/lib/generated/apis/AccountsApi.d.ts

@@ -1,6 +1,6 @@
 /**
- * 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
  *
@@ -16,10 +16,12 @@ export interface GetAccountAssetsRequest {
     limit?: number;
     offset?: number;
     unanchored?: boolean;
+    untilBlock?: string;
 }
 export interface GetAccountBalanceRequest {
     principal: string;
     unanchored?: boolean;
+    untilBlock?: string;
 }
 export interface GetAccountInboundRequest {
     principal: string;
@@ -27,6 +29,7 @@ export interface GetAccountInboundRequest {
     offset?: number;
     height?: number;
     unanchored?: boolean;
+    untilBlock?: string;
 }
 export interface GetAccountInfoRequest {
     principal: string;
@@ -38,6 +41,7 @@ export interface GetAccountNftRequest {
     limit?: number;
     offset?: number;
     unanchored?: boolean;
+    untilBlock?: string;
 }
 export interface GetAccountNoncesRequest {
     principal: string;
@@ -45,6 +49,7 @@ export interface GetAccountNoncesRequest {
 export interface GetAccountStxBalanceRequest {
     principal: string;
     unanchored?: boolean;
+    untilBlock?: string;
 }
 export interface GetAccountTransactionsRequest {
     principal: string;
@@ -52,6 +57,7 @@ export interface GetAccountTransactionsRequest {
     offset?: number;
     height?: number;
     unanchored?: boolean;
+    untilBlock?: string;
 }
 export interface GetAccountTransactionsWithTransfersRequest {
     principal: string;
@@ -59,6 +65,7 @@ export interface GetAccountTransactionsWithTransfersRequest {
     offset?: number;
     height?: number;
     unanchored?: boolean;
+    untilBlock?: string;
 }
 export interface GetSingleTransactionWithTransfersRequest {
     principal: string;
@@ -72,55 +79,60 @@ export interface GetSingleTransactionWithTransfersRequest {
  */
 export interface AccountsApiInterface {
     /**
-     *
+     * Retrieves a list of all assets events associated with an account or a Contract Identifier. This includes Transfers, Mints.
      * @summary Get account assets
      * @param {string} principal Stacks address or a Contract identifier (e.g. &#x60;SP31DA6FTSJX2WGTZ69SFY11BH51NZMB0ZW97B5P0.get-info&#x60;)
      * @param {number} [limit] max number of account assets to fetch
      * @param {number} [offset] index of first account assets to fetch
      * @param {boolean} [unanchored] Include transaction data from unanchored (i.e. unconfirmed) microblocks
+     * @param {string} [untilBlock] returned data representing the state at that point in time, rather than the current block.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof AccountsApiInterface
      */
     getAccountAssetsRaw(requestParameters: GetAccountAssetsRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<AddressAssetsListResponse>>;
     /**
+     * Retrieves a list of all assets events associated with an account or a Contract Identifier. This includes Transfers, Mints.
      * Get account assets
      */
     getAccountAssets(requestParameters: GetAccountAssetsRequest, initOverrides?: RequestInit): Promise<AddressAssetsListResponse>;
     /**
-     *
+     * Retrieves total account balance information for a given Address or Contract Identifier. This includes the balances of  STX Tokens, Fungible Tokens and Non-Fungible Tokens for the account.
      * @summary Get account balances
      * @param {string} principal Stacks address or a Contract identifier (e.g. &#x60;SP31DA6FTSJX2WGTZ69SFY11BH51NZMB0ZW97B5P0.get-info&#x60;)
      * @param {boolean} [unanchored] Include transaction data from unanchored (i.e. unconfirmed) microblocks
+     * @param {string} [untilBlock] returned data representing the state up until that point in time, rather than the current block.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof AccountsApiInterface
      */
     getAccountBalanceRaw(requestParameters: GetAccountBalanceRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<AddressBalanceResponse>>;
     /**
+     * Retrieves total account balance information for a given Address or Contract Identifier. This includes the balances of  STX Tokens, Fungible Tokens and Non-Fungible Tokens for the account.
      * Get account balances
      */
     getAccountBalance(requestParameters: GetAccountBalanceRequest, initOverrides?: RequestInit): Promise<AddressBalanceResponse>;
     /**
-     * Get a list of STX transfers with memos to the given principal. This includes regular transfers from a stx-transfer transaction type,  and transfers from contract-call transactions a the `send-many-memo` bulk sending contract.
+     * Retrieves a list of STX transfers with memos to the given principal. This includes regular transfers from a stx-transfer transaction type, and transfers from contract-call transactions a the `send-many-memo` bulk sending contract.
      * @summary Get inbound STX transfers
      * @param {string} principal Stacks address or a Contract identifier (e.g. &#x60;SP31DA6FTSJX2WGTZ69SFY11BH51NZMB0ZW97B5P0.get-info&#x60;)
      * @param {number} [limit] number of items to return
      * @param {number} [offset] number of items to skip
      * @param {number} [height] Filter for transfers only at this given block height
      * @param {boolean} [unanchored] Include transaction data from unanchored (i.e. unconfirmed) microblocks
+     * @param {string} [untilBlock] returned data representing the state up until that point in time, rather than the current block.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof AccountsApiInterface
      */
     getAccountInboundRaw(requestParameters: GetAccountInboundRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<AddressStxInboundListResponse>>;
     /**
-     * Get a list of STX transfers with memos to the given principal. This includes regular transfers from a stx-transfer transaction type,  and transfers from contract-call transactions a the `send-many-memo` bulk sending contract.
+     * Retrieves a list of STX transfers with memos to the given principal. This includes regular transfers from a stx-transfer transaction type, and transfers from contract-call transactions a the `send-many-memo` bulk sending contract.
      * Get inbound STX transfers
      */
     getAccountInbound(requestParameters: GetAccountInboundRequest, initOverrides?: RequestInit): Promise<AddressStxInboundListResponse>;
     /**
-     * Get the account data for the provided principal  Where balance is the hex encoding of a unsigned 128-bit integer (big-endian), nonce is a unsigned 64-bit integer, and the proofs are provided as hex strings.  For non-existent accounts, this does not 404, rather it returns an object with balance and nonce of 0.
+     * Retrieves the account data for a given Account or a Contract Identifier  Where balance is the hex encoding of a unsigned 128-bit integer (big-endian), nonce is an unsigned 64-bit integer, and the proofs are provided as hex strings.  For non-existent accounts, this does not return a 404 error, rather it returns an object with balance and nonce of 0.
      * @summary Get account info
      * @param {string} principal Stacks address or a Contract identifier (e.g. &#x60;SP31DA6FTSJX2WGTZ69SFY11BH51NZMB0ZW97B5P0.get-info&#x60;)
      * @param {number} [proof] Returns object without the proof field if set to 0
@@ -131,30 +143,31 @@ export interface AccountsApiInterface {
      */
     getAccountInfoRaw(requestParameters: GetAccountInfoRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<AccountDataResponse>>;
     /**
-     * Get the account data for the provided principal  Where balance is the hex encoding of a unsigned 128-bit integer (big-endian), nonce is a unsigned 64-bit integer, and the proofs are provided as hex strings.  For non-existent accounts, this does not 404, rather it returns an object with balance and nonce of 0.
+     * Retrieves the account data for a given Account or a Contract Identifier  Where balance is the hex encoding of a unsigned 128-bit integer (big-endian), nonce is an unsigned 64-bit integer, and the proofs are provided as hex strings.  For non-existent accounts, this does not return a 404 error, rather it returns an object with balance and nonce of 0.
      * Get account info
      */
     getAccountInfo(requestParameters: GetAccountInfoRequest, initOverrides?: RequestInit): Promise<AccountDataResponse>;
     /**
-     * Get list of all nfts owned by an address, contains the clarity value of the identifier of the nft
+     * Retrieves a list of all nfts owned by an address, contains the clarity value of the identifier of the nft
      * @summary Get nft events
      * @param {string} principal Stacks address or a Contract identifier (e.g. &#x60;SP31DA6FTSJX2WGTZ69SFY11BH51NZMB0ZW97B5P0.get-info&#x60;)
      * @param {number} [limit] number of items to return
      * @param {number} [offset] number of items to skip
      * @param {boolean} [unanchored] Include transaction data from unanchored (i.e. unconfirmed) microblocks
+     * @param {string} [untilBlock] returned data representing the state up until that point in time, rather than the current block.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof AccountsApiInterface
      */
     getAccountNftRaw(requestParameters: GetAccountNftRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<AddressNftListResponse>>;
     /**
-     * Get list of all nfts owned by an address, contains the clarity value of the identifier of the nft
+     * Retrieves a list of all nfts owned by an address, contains the clarity value of the identifier of the nft
      * Get nft events
      */
     getAccountNft(requestParameters: GetAccountNftRequest, initOverrides?: RequestInit): Promise<AddressNftListResponse>;
     /**
-     *
-     * @summary Get the latest nonce values used by an account by inspecting the mempool, microblock transactions, and anchored transactions.
+     * Retrieves the latest nonce values used by an account by inspecting the mempool, microblock transactions, and anchored transactions.
+     * @summary Get the latest nonce used by an account
      * @param {string} principal Stacks address (e.g. &#x60;SP31DA6FTSJX2WGTZ69SFY11BH51NZMB0ZW97B5P0&#x60;)
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
@@ -162,59 +175,66 @@ export interface AccountsApiInterface {
      */
     getAccountNoncesRaw(requestParameters: GetAccountNoncesRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<AddressNonces>>;
     /**
-     * Get the latest nonce values used by an account by inspecting the mempool, microblock transactions, and anchored transactions.
+     * Retrieves the latest nonce values used by an account by inspecting the mempool, microblock transactions, and anchored transactions.
+     * Get the latest nonce used by an account
      */
     getAccountNonces(requestParameters: GetAccountNoncesRequest, initOverrides?: RequestInit): Promise<AddressNonces>;
     /**
-     *
+     * Retrieves STX token balance for a given Address or Contract Identifier.
      * @summary Get account STX balance
      * @param {string} principal Stacks address or a Contract identifier (e.g. &#x60;SP31DA6FTSJX2WGTZ69SFY11BH51NZMB0ZW97B5P0.get-info&#x60;)
      * @param {boolean} [unanchored] Include transaction data from unanchored (i.e. unconfirmed) microblocks
+     * @param {string} [untilBlock] returned data representing the state up until that point in time, rather than the current block.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof AccountsApiInterface
      */
     getAccountStxBalanceRaw(requestParameters: GetAccountStxBalanceRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<object>>;
     /**
+     * Retrieves STX token balance for a given Address or Contract Identifier.
      * Get account STX balance
      */
     getAccountStxBalance(requestParameters: GetAccountStxBalanceRequest, initOverrides?: RequestInit): Promise<object>;
     /**
-     *
+     * Retrieves a list of all Transactions for a given Address or Contract Identifier. More information on Transaction types can be found [here](https://docs.stacks.co/understand-stacks/transactions#types).
      * @summary Get account transactions
      * @param {string} principal Stacks address or a Contract identifier (e.g. &#x60;SP31DA6FTSJX2WGTZ69SFY11BH51NZMB0ZW97B5P0.get-info&#x60;)
      * @param {number} [limit] max number of account transactions to fetch
      * @param {number} [offset] index of first account transaction to fetch
      * @param {number} [height] Filter for transactions only at this given block height
      * @param {boolean} [unanchored] Include transaction data from unanchored (i.e. unconfirmed) microblocks
+     * @param {string} [untilBlock] returned data representing the state up until that point in time, rather than the current block.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof AccountsApiInterface
      */
     getAccountTransactionsRaw(requestParameters: GetAccountTransactionsRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<AddressTransactionsListResponse>>;
     /**
+     * Retrieves a list of all Transactions for a given Address or Contract Identifier. More information on Transaction types can be found [here](https://docs.stacks.co/understand-stacks/transactions#types).
      * Get account transactions
      */
     getAccountTransactions(requestParameters: GetAccountTransactionsRequest, initOverrides?: RequestInit): Promise<AddressTransactionsListResponse>;
     /**
-     *
+     * Retrieve all transactions for an account or contract identifier including STX transfers for each transaction.
      * @summary Get account transactions including STX transfers for each transaction.
      * @param {string} principal Stacks address or a Contract identifier (e.g. &#x60;SP31DA6FTSJX2WGTZ69SFY11BH51NZMB0ZW97B5P0.get-info&#x60;)
      * @param {number} [limit] max number of account transactions to fetch
      * @param {number} [offset] index of first account transaction to fetch
      * @param {number} [height] Filter for transactions only at this given block height
      * @param {boolean} [unanchored] Include transaction data from unanchored (i.e. unconfirmed) microblocks
+     * @param {string} [untilBlock] returned data representing the state up until that point in time, rather than the current block.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof AccountsApiInterface
      */
     getAccountTransactionsWithTransfersRaw(requestParameters: GetAccountTransactionsWithTransfersRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<AddressTransactionsWithTransfersListResponse>>;
     /**
+     * Retrieve all transactions for an account or contract identifier including STX transfers for each transaction.
      * Get account transactions including STX transfers for each transaction.
      */
     getAccountTransactionsWithTransfers(requestParameters: GetAccountTransactionsWithTransfersRequest, initOverrides?: RequestInit): Promise<AddressTransactionsWithTransfersListResponse>;
     /**
-     *
+     * Retrieves transaction details for a given Transcation Id `tx_id`, for a given account or contract Identifier.
      * @summary Get account transaction information for specific transaction
      * @param {string} principal Stacks address or a contract identifier
      * @param {string} txId Transaction id
@@ -224,6 +244,7 @@ export interface AccountsApiInterface {
      */
     getSingleTransactionWithTransfersRaw(requestParameters: GetSingleTransactionWithTransfersRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<AddressTransactionWithTransfers>>;
     /**
+     * Retrieves transaction details for a given Transcation Id `tx_id`, for a given account or contract Identifier.
      * Get account transaction information for specific transaction
      */
     getSingleTransactionWithTransfers(requestParameters: GetSingleTransactionWithTransfersRequest, initOverrides?: RequestInit): Promise<AddressTransactionWithTransfers>;
@@ -233,88 +254,102 @@ export interface AccountsApiInterface {
  */
 export declare class AccountsApi extends runtime.BaseAPI implements AccountsApiInterface {
     /**
+     * Retrieves a list of all assets events associated with an account or a Contract Identifier. This includes Transfers, Mints.
      * Get account assets
      */
     getAccountAssetsRaw(requestParameters: GetAccountAssetsRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<AddressAssetsListResponse>>;
     /**
+     * Retrieves a list of all assets events associated with an account or a Contract Identifier. This includes Transfers, Mints.
      * Get account assets
      */
     getAccountAssets(requestParameters: GetAccountAssetsRequest, initOverrides?: RequestInit): Promise<AddressAssetsListResponse>;
     /**
+     * Retrieves total account balance information for a given Address or Contract Identifier. This includes the balances of  STX Tokens, Fungible Tokens and Non-Fungible Tokens for the account.
      * Get account balances
      */
     getAccountBalanceRaw(requestParameters: GetAccountBalanceRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<AddressBalanceResponse>>;
     /**
+     * Retrieves total account balance information for a given Address or Contract Identifier. This includes the balances of  STX Tokens, Fungible Tokens and Non-Fungible Tokens for the account.
      * Get account balances
      */
     getAccountBalance(requestParameters: GetAccountBalanceRequest, initOverrides?: RequestInit): Promise<AddressBalanceResponse>;
     /**
-     * Get a list of STX transfers with memos to the given principal. This includes regular transfers from a stx-transfer transaction type,  and transfers from contract-call transactions a the `send-many-memo` bulk sending contract.
+     * Retrieves a list of STX transfers with memos to the given principal. This includes regular transfers from a stx-transfer transaction type, and transfers from contract-call transactions a the `send-many-memo` bulk sending contract.
      * Get inbound STX transfers
      */
     getAccountInboundRaw(requestParameters: GetAccountInboundRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<AddressStxInboundListResponse>>;
     /**
-     * Get a list of STX transfers with memos to the given principal. This includes regular transfers from a stx-transfer transaction type,  and transfers from contract-call transactions a the `send-many-memo` bulk sending contract.
+     * Retrieves a list of STX transfers with memos to the given principal. This includes regular transfers from a stx-transfer transaction type, and transfers from contract-call transactions a the `send-many-memo` bulk sending contract.
      * Get inbound STX transfers
      */
     getAccountInbound(requestParameters: GetAccountInboundRequest, initOverrides?: RequestInit): Promise<AddressStxInboundListResponse>;
     /**
-     * Get the account data for the provided principal  Where balance is the hex encoding of a unsigned 128-bit integer (big-endian), nonce is a unsigned 64-bit integer, and the proofs are provided as hex strings.  For non-existent accounts, this does not 404, rather it returns an object with balance and nonce of 0.
+     * Retrieves the account data for a given Account or a Contract Identifier  Where balance is the hex encoding of a unsigned 128-bit integer (big-endian), nonce is an unsigned 64-bit integer, and the proofs are provided as hex strings.  For non-existent accounts, this does not return a 404 error, rather it returns an object with balance and nonce of 0.
      * Get account info
      */
     getAccountInfoRaw(requestParameters: GetAccountInfoRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<AccountDataResponse>>;
     /**
-     * Get the account data for the provided principal  Where balance is the hex encoding of a unsigned 128-bit integer (big-endian), nonce is a unsigned 64-bit integer, and the proofs are provided as hex strings.  For non-existent accounts, this does not 404, rather it returns an object with balance and nonce of 0.
+     * Retrieves the account data for a given Account or a Contract Identifier  Where balance is the hex encoding of a unsigned 128-bit integer (big-endian), nonce is an unsigned 64-bit integer, and the proofs are provided as hex strings.  For non-existent accounts, this does not return a 404 error, rather it returns an object with balance and nonce of 0.
      * Get account info
      */
     getAccountInfo(requestParameters: GetAccountInfoRequest, initOverrides?: RequestInit): Promise<AccountDataResponse>;
     /**
-     * Get list of all nfts owned by an address, contains the clarity value of the identifier of the nft
+     * Retrieves a list of all nfts owned by an address, contains the clarity value of the identifier of the nft
      * Get nft events
      */
     getAccountNftRaw(requestParameters: GetAccountNftRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<AddressNftListResponse>>;
     /**
-     * Get list of all nfts owned by an address, contains the clarity value of the identifier of the nft
+     * Retrieves a list of all nfts owned by an address, contains the clarity value of the identifier of the nft
      * Get nft events
      */
     getAccountNft(requestParameters: GetAccountNftRequest, initOverrides?: RequestInit): Promise<AddressNftListResponse>;
     /**
-     * Get the latest nonce values used by an account by inspecting the mempool, microblock transactions, and anchored transactions.
+     * Retrieves the latest nonce values used by an account by inspecting the mempool, microblock transactions, and anchored transactions.
+     * Get the latest nonce used by an account
      */
     getAccountNoncesRaw(requestParameters: GetAccountNoncesRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<AddressNonces>>;
     /**
-     * Get the latest nonce values used by an account by inspecting the mempool, microblock transactions, and anchored transactions.
+     * Retrieves the latest nonce values used by an account by inspecting the mempool, microblock transactions, and anchored transactions.
+     * Get the latest nonce used by an account
      */
     getAccountNonces(requestParameters: GetAccountNoncesRequest, initOverrides?: RequestInit): Promise<AddressNonces>;
     /**
+     * Retrieves STX token balance for a given Address or Contract Identifier.
      * Get account STX balance
      */
     getAccountStxBalanceRaw(requestParameters: GetAccountStxBalanceRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<object>>;
     /**
+     * Retrieves STX token balance for a given Address or Contract Identifier.
      * Get account STX balance
      */
     getAccountStxBalance(requestParameters: GetAccountStxBalanceRequest, initOverrides?: RequestInit): Promise<object>;
     /**
+     * Retrieves a list of all Transactions for a given Address or Contract Identifier. More information on Transaction types can be found [here](https://docs.stacks.co/understand-stacks/transactions#types).
      * Get account transactions
      */
     getAccountTransactionsRaw(requestParameters: GetAccountTransactionsRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<AddressTransactionsListResponse>>;
     /**
+     * Retrieves a list of all Transactions for a given Address or Contract Identifier. More information on Transaction types can be found [here](https://docs.stacks.co/understand-stacks/transactions#types).
      * Get account transactions
      */
     getAccountTransactions(requestParameters: GetAccountTransactionsRequest, initOverrides?: RequestInit): Promise<AddressTransactionsListResponse>;
     /**
+     * Retrieve all transactions for an account or contract identifier including STX transfers for each transaction.
      * Get account transactions including STX transfers for each transaction.
      */
     getAccountTransactionsWithTransfersRaw(requestParameters: GetAccountTransactionsWithTransfersRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<AddressTransactionsWithTransfersListResponse>>;
     /**
+     * Retrieve all transactions for an account or contract identifier including STX transfers for each transaction.
      * Get account transactions including STX transfers for each transaction.
      */
     getAccountTransactionsWithTransfers(requestParameters: GetAccountTransactionsWithTransfersRequest, initOverrides?: RequestInit): Promise<AddressTransactionsWithTransfersListResponse>;
     /**
+     * Retrieves transaction details for a given Transcation Id `tx_id`, for a given account or contract Identifier.
      * Get account transaction information for specific transaction
      */
     getSingleTransactionWithTransfersRaw(requestParameters: GetSingleTransactionWithTransfersRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<AddressTransactionWithTransfers>>;
     /**
+     * Retrieves transaction details for a given Transcation Id `tx_id`, for a given account or contract Identifier.
      * Get account transaction information for specific transaction
      */
     getSingleTransactionWithTransfers(requestParameters: GetSingleTransactionWithTransfersRequest, initOverrides?: RequestInit): Promise<AddressTransactionWithTransfers>;

package/lib/generated/apis/AccountsApi.js

@@ -2,8 +2,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
  *
@@ -21,6 +21,7 @@ const models_1 = require("../models");
  */
 class AccountsApi extends runtime.BaseAPI {
     /**
+     * Retrieves a list of all assets events associated with an account or a Contract Identifier. This includes Transfers, Mints.
      * Get account assets
      */
     async getAccountAssetsRaw(requestParameters, initOverrides) {
@@ -37,6 +38,9 @@ class AccountsApi extends runtime.BaseAPI {
         if (requestParameters.unanchored !== undefined) {
             queryParameters['unanchored'] = requestParameters.unanchored;
         }
+        if (requestParameters.untilBlock !== undefined) {
+            queryParameters['until_block'] = requestParameters.untilBlock;
+        }
         const headerParameters = {};
         const response = await this.request({
             path: `/extended/v1/address/{principal}/assets`.replace(`{${"principal"}}`, encodeURIComponent(String(requestParameters.principal))),
@@ -47,6 +51,7 @@ class AccountsApi extends runtime.BaseAPI {
         return new runtime.JSONApiResponse(response, (jsonValue) => models_1.AddressAssetsListResponseFromJSON(jsonValue));
     }
     /**
+     * Retrieves a list of all assets events associated with an account or a Contract Identifier. This includes Transfers, Mints.
      * Get account assets
      */
     async getAccountAssets(requestParameters, initOverrides) {
@@ -54,6 +59,7 @@ class AccountsApi extends runtime.BaseAPI {
         return await response.value();
     }
     /**
+     * Retrieves total account balance information for a given Address or Contract Identifier. This includes the balances of  STX Tokens, Fungible Tokens and Non-Fungible Tokens for the account.
      * Get account balances
      */
     async getAccountBalanceRaw(requestParameters, initOverrides) {
@@ -64,6 +70,9 @@ class AccountsApi extends runtime.BaseAPI {
         if (requestParameters.unanchored !== undefined) {
             queryParameters['unanchored'] = requestParameters.unanchored;
         }
+        if (requestParameters.untilBlock !== undefined) {
+            queryParameters['until_block'] = requestParameters.untilBlock;
+        }
         const headerParameters = {};
         const response = await this.request({
             path: `/extended/v1/address/{principal}/balances`.replace(`{${"principal"}}`, encodeURIComponent(String(requestParameters.principal))),
@@ -74,6 +83,7 @@ class AccountsApi extends runtime.BaseAPI {
         return new runtime.JSONApiResponse(response, (jsonValue) => models_1.AddressBalanceResponseFromJSON(jsonValue));
     }
     /**
+     * Retrieves total account balance information for a given Address or Contract Identifier. This includes the balances of  STX Tokens, Fungible Tokens and Non-Fungible Tokens for the account.
      * Get account balances
      */
     async getAccountBalance(requestParameters, initOverrides) {
@@ -81,7 +91,7 @@ class AccountsApi extends runtime.BaseAPI {
         return await response.value();
     }
     /**
-     * Get a list of STX transfers with memos to the given principal. This includes regular transfers from a stx-transfer transaction type,  and transfers from contract-call transactions a the `send-many-memo` bulk sending contract.
+     * Retrieves a list of STX transfers with memos to the given principal. This includes regular transfers from a stx-transfer transaction type, and transfers from contract-call transactions a the `send-many-memo` bulk sending contract.
      * Get inbound STX transfers
      */
     async getAccountInboundRaw(requestParameters, initOverrides) {
@@ -101,6 +111,9 @@ class AccountsApi extends runtime.BaseAPI {
         if (requestParameters.unanchored !== undefined) {
             queryParameters['unanchored'] = requestParameters.unanchored;
         }
+        if (requestParameters.untilBlock !== undefined) {
+            queryParameters['until_block'] = requestParameters.untilBlock;
+        }
         const headerParameters = {};
         const response = await this.request({
             path: `/extended/v1/address/{principal}/stx_inbound`.replace(`{${"principal"}}`, encodeURIComponent(String(requestParameters.principal))),
@@ -111,7 +124,7 @@ class AccountsApi extends runtime.BaseAPI {
         return new runtime.JSONApiResponse(response, (jsonValue) => models_1.AddressStxInboundListResponseFromJSON(jsonValue));
     }
     /**
-     * Get a list of STX transfers with memos to the given principal. This includes regular transfers from a stx-transfer transaction type,  and transfers from contract-call transactions a the `send-many-memo` bulk sending contract.
+     * Retrieves a list of STX transfers with memos to the given principal. This includes regular transfers from a stx-transfer transaction type, and transfers from contract-call transactions a the `send-many-memo` bulk sending contract.
      * Get inbound STX transfers
      */
     async getAccountInbound(requestParameters, initOverrides) {
@@ -119,7 +132,7 @@ class AccountsApi extends runtime.BaseAPI {
         return await response.value();
     }
     /**
-     * Get the account data for the provided principal  Where balance is the hex encoding of a unsigned 128-bit integer (big-endian), nonce is a unsigned 64-bit integer, and the proofs are provided as hex strings.  For non-existent accounts, this does not 404, rather it returns an object with balance and nonce of 0.
+     * Retrieves the account data for a given Account or a Contract Identifier  Where balance is the hex encoding of a unsigned 128-bit integer (big-endian), nonce is an unsigned 64-bit integer, and the proofs are provided as hex strings.  For non-existent accounts, this does not return a 404 error, rather it returns an object with balance and nonce of 0.
      * Get account info
      */
     async getAccountInfoRaw(requestParameters, initOverrides) {
@@ -143,7 +156,7 @@ class AccountsApi extends runtime.BaseAPI {
         return new runtime.JSONApiResponse(response, (jsonValue) => models_1.AccountDataResponseFromJSON(jsonValue));
     }
     /**
-     * Get the account data for the provided principal  Where balance is the hex encoding of a unsigned 128-bit integer (big-endian), nonce is a unsigned 64-bit integer, and the proofs are provided as hex strings.  For non-existent accounts, this does not 404, rather it returns an object with balance and nonce of 0.
+     * Retrieves the account data for a given Account or a Contract Identifier  Where balance is the hex encoding of a unsigned 128-bit integer (big-endian), nonce is an unsigned 64-bit integer, and the proofs are provided as hex strings.  For non-existent accounts, this does not return a 404 error, rather it returns an object with balance and nonce of 0.
      * Get account info
      */
     async getAccountInfo(requestParameters, initOverrides) {
@@ -151,7 +164,7 @@ class AccountsApi extends runtime.BaseAPI {
         return await response.value();
     }
     /**
-     * Get list of all nfts owned by an address, contains the clarity value of the identifier of the nft
+     * Retrieves a list of all nfts owned by an address, contains the clarity value of the identifier of the nft
      * Get nft events
      */
     async getAccountNftRaw(requestParameters, initOverrides) {
@@ -168,6 +181,9 @@ class AccountsApi extends runtime.BaseAPI {
         if (requestParameters.unanchored !== undefined) {
             queryParameters['unanchored'] = requestParameters.unanchored;
         }
+        if (requestParameters.untilBlock !== undefined) {
+            queryParameters['until_block'] = requestParameters.untilBlock;
+        }
         const headerParameters = {};
         const response = await this.request({
             path: `/extended/v1/address/{principal}/nft_events`.replace(`{${"principal"}}`, encodeURIComponent(String(requestParameters.principal))),
@@ -178,7 +194,7 @@ class AccountsApi extends runtime.BaseAPI {
         return new runtime.JSONApiResponse(response, (jsonValue) => models_1.AddressNftListResponseFromJSON(jsonValue));
     }
     /**
-     * Get list of all nfts owned by an address, contains the clarity value of the identifier of the nft
+     * Retrieves a list of all nfts owned by an address, contains the clarity value of the identifier of the nft
      * Get nft events
      */
     async getAccountNft(requestParameters, initOverrides) {
@@ -186,7 +202,8 @@ class AccountsApi extends runtime.BaseAPI {
         return await response.value();
     }
     /**
-     * Get the latest nonce values used by an account by inspecting the mempool, microblock transactions, and anchored transactions.
+     * Retrieves the latest nonce values used by an account by inspecting the mempool, microblock transactions, and anchored transactions.
+     * Get the latest nonce used by an account
      */
     async getAccountNoncesRaw(requestParameters, initOverrides) {
         if (requestParameters.principal === null || requestParameters.principal === undefined) {
@@ -203,13 +220,15 @@ class AccountsApi extends runtime.BaseAPI {
         return new runtime.JSONApiResponse(response, (jsonValue) => models_1.AddressNoncesFromJSON(jsonValue));
     }
     /**
-     * Get the latest nonce values used by an account by inspecting the mempool, microblock transactions, and anchored transactions.
+     * Retrieves the latest nonce values used by an account by inspecting the mempool, microblock transactions, and anchored transactions.
+     * Get the latest nonce used by an account
      */
     async getAccountNonces(requestParameters, initOverrides) {
         const response = await this.getAccountNoncesRaw(requestParameters, initOverrides);
         return await response.value();
     }
     /**
+     * Retrieves STX token balance for a given Address or Contract Identifier.
      * Get account STX balance
      */
     async getAccountStxBalanceRaw(requestParameters, initOverrides) {
@@ -220,6 +239,9 @@ class AccountsApi extends runtime.BaseAPI {
         if (requestParameters.unanchored !== undefined) {
             queryParameters['unanchored'] = requestParameters.unanchored;
         }
+        if (requestParameters.untilBlock !== undefined) {
+            queryParameters['until_block'] = requestParameters.untilBlock;
+        }
         const headerParameters = {};
         const response = await this.request({
             path: `/extended/v1/address/{principal}/stx`.replace(`{${"principal"}}`, encodeURIComponent(String(requestParameters.principal))),
@@ -230,6 +252,7 @@ class AccountsApi extends runtime.BaseAPI {
         return new runtime.JSONApiResponse(response);
     }
     /**
+     * Retrieves STX token balance for a given Address or Contract Identifier.
      * Get account STX balance
      */
     async getAccountStxBalance(requestParameters, initOverrides) {
@@ -237,6 +260,7 @@ class AccountsApi extends runtime.BaseAPI {
         return await response.value();
     }
     /**
+     * Retrieves a list of all Transactions for a given Address or Contract Identifier. More information on Transaction types can be found [here](https://docs.stacks.co/understand-stacks/transactions#types).
      * Get account transactions
      */
     async getAccountTransactionsRaw(requestParameters, initOverrides) {
@@ -256,6 +280,9 @@ class AccountsApi extends runtime.BaseAPI {
         if (requestParameters.unanchored !== undefined) {
             queryParameters['unanchored'] = requestParameters.unanchored;
         }
+        if (requestParameters.untilBlock !== undefined) {
+            queryParameters['until_block'] = requestParameters.untilBlock;
+        }
         const headerParameters = {};
         const response = await this.request({
             path: `/extended/v1/address/{principal}/transactions`.replace(`{${"principal"}}`, encodeURIComponent(String(requestParameters.principal))),
@@ -266,6 +293,7 @@ class AccountsApi extends runtime.BaseAPI {
         return new runtime.JSONApiResponse(response, (jsonValue) => models_1.AddressTransactionsListResponseFromJSON(jsonValue));
     }
     /**
+     * Retrieves a list of all Transactions for a given Address or Contract Identifier. More information on Transaction types can be found [here](https://docs.stacks.co/understand-stacks/transactions#types).
      * Get account transactions
      */
     async getAccountTransactions(requestParameters, initOverrides) {
@@ -273,6 +301,7 @@ class AccountsApi extends runtime.BaseAPI {
         return await response.value();
     }
     /**
+     * Retrieve all transactions for an account or contract identifier including STX transfers for each transaction.
      * Get account transactions including STX transfers for each transaction.
      */
     async getAccountTransactionsWithTransfersRaw(requestParameters, initOverrides) {
@@ -292,6 +321,9 @@ class AccountsApi extends runtime.BaseAPI {
         if (requestParameters.unanchored !== undefined) {
             queryParameters['unanchored'] = requestParameters.unanchored;
         }
+        if (requestParameters.untilBlock !== undefined) {
+            queryParameters['until_block'] = requestParameters.untilBlock;
+        }
         const headerParameters = {};
         const response = await this.request({
             path: `/extended/v1/address/{principal}/transactions_with_transfers`.replace(`{${"principal"}}`, encodeURIComponent(String(requestParameters.principal))),
@@ -302,6 +334,7 @@ class AccountsApi extends runtime.BaseAPI {
         return new runtime.JSONApiResponse(response, (jsonValue) => models_1.AddressTransactionsWithTransfersListResponseFromJSON(jsonValue));
     }
     /**
+     * Retrieve all transactions for an account or contract identifier including STX transfers for each transaction.
      * Get account transactions including STX transfers for each transaction.
      */
     async getAccountTransactionsWithTransfers(requestParameters, initOverrides) {
@@ -309,6 +342,7 @@ class AccountsApi extends runtime.BaseAPI {
         return await response.value();
     }
     /**
+     * Retrieves transaction details for a given Transcation Id `tx_id`, for a given account or contract Identifier.
      * Get account transaction information for specific transaction
      */
     async getSingleTransactionWithTransfersRaw(requestParameters, initOverrides) {
@@ -329,6 +363,7 @@ class AccountsApi extends runtime.BaseAPI {
         return new runtime.JSONApiResponse(response, (jsonValue) => models_1.AddressTransactionWithTransfersFromJSON(jsonValue));
     }
     /**
+     * Retrieves transaction details for a given Transcation Id `tx_id`, for a given account or contract Identifier.
      * Get account transaction information for specific transaction
      */
     async getSingleTransactionWithTransfers(requestParameters, initOverrides) {