@stacks/blockchain-api-client 0.71.2 → 1.0.0

package/src/generated/apis/RosettaApi.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
  * 
@@ -194,7 +194,7 @@ export interface RosettaApiInterface {
     rosettaAccountBalance(requestParameters: RosettaAccountBalanceOperationRequest, initOverrides?: RequestInit): Promise<RosettaAccountBalanceResponse>;
 
     /**
-     * A BlockRequest is utilized to make a block request on the /block endpoint.
+     * Retrieves the Block information for a given block identifier including a list of all transactions in the block.
      * @summary Get a Block
      * @param {RosettaBlockRequest} rosettaBlockRequest 
      * @param {*} [options] Override http request option.
@@ -204,13 +204,13 @@ export interface RosettaApiInterface {
     rosettaBlockRaw(requestParameters: RosettaBlockOperationRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<RosettaBlockResponse>>;
 
     /**
-     * A BlockRequest is utilized to make a block request on the /block endpoint.
+     * Retrieves the Block information for a given block identifier including a list of all transactions in the block.
      * Get a Block
      */
     rosettaBlock(requestParameters: RosettaBlockOperationRequest, initOverrides?: RequestInit): Promise<RosettaBlockResponse>;
 
     /**
-     * A BlockTransactionRequest is used to fetch a Transaction included in a block that is not returned in a BlockResponse.
+     * Retrieves a Transaction included in a block that is not returned in a BlockResponse.
      * @summary Get a Block Transaction
      * @param {RosettaBlockTransactionRequest} rosettaBlockTransactionRequest 
      * @param {*} [options] Override http request option.
@@ -220,7 +220,7 @@ export interface RosettaApiInterface {
     rosettaBlockTransactionRaw(requestParameters: RosettaBlockTransactionOperationRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<RosettaBlockTransactionResponse>>;
 
     /**
-     * A BlockTransactionRequest is used to fetch a Transaction included in a block that is not returned in a BlockResponse.
+     * Retrieves a Transaction included in a block that is not returned in a BlockResponse.
      * Get a Block Transaction
      */
     rosettaBlockTransaction(requestParameters: RosettaBlockTransactionOperationRequest, initOverrides?: RequestInit): Promise<RosettaBlockTransactionResponse>;
@@ -242,7 +242,7 @@ export interface RosettaApiInterface {
     rosettaConstructionCombine(requestParameters: RosettaConstructionCombineOperationRequest, initOverrides?: RequestInit): Promise<RosettaConstructionCombineResponse>;
 
     /**
-     * TODO
+     * Retrieves the Account Identifier information based on a Public Key for a given network
      * @summary Derive an AccountIdentifier from a PublicKey
      * @param {RosettaConstructionDeriveRequest} rosettaConstructionDeriveRequest 
      * @param {*} [options] Override http request option.
@@ -252,13 +252,13 @@ export interface RosettaApiInterface {
     rosettaConstructionDeriveRaw(requestParameters: RosettaConstructionDeriveOperationRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<RosettaConstructionDeriveResponse>>;
 
     /**
-     * TODO
+     * Retrieves the Account Identifier information based on a Public Key for a given network
      * Derive an AccountIdentifier from a PublicKey
      */
     rosettaConstructionDerive(requestParameters: RosettaConstructionDeriveOperationRequest, initOverrides?: RequestInit): Promise<RosettaConstructionDeriveResponse>;
 
     /**
-     * TODO
+     * Retrieves the network-specific transaction hash for a signed transaction.
      * @summary Get the Hash of a Signed Transaction
      * @param {RosettaConstructionHashRequest} rosettaConstructionHashRequest 
      * @param {*} [options] Override http request option.
@@ -268,13 +268,13 @@ export interface RosettaApiInterface {
     rosettaConstructionHashRaw(requestParameters: RosettaConstructionHashOperationRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<RosettaConstructionHashResponse>>;
 
     /**
-     * TODO
+     * Retrieves the network-specific transaction hash for a signed transaction.
      * Get the Hash of a Signed Transaction
      */
     rosettaConstructionHash(requestParameters: RosettaConstructionHashOperationRequest, initOverrides?: RequestInit): Promise<RosettaConstructionHashResponse>;
 
     /**
-     * TODO
+     * To Do
      * @summary Get Metadata for Transaction Construction
      * @param {RosettaConstructionMetadataRequest} rosettaConstructionMetadataRequest 
      * @param {*} [options] Override http request option.
@@ -284,7 +284,7 @@ export interface RosettaApiInterface {
     rosettaConstructionMetadataRaw(requestParameters: RosettaConstructionMetadataOperationRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<RosettaConstructionMetadataResponse>>;
 
     /**
-     * TODO
+     * To Do
      * Get Metadata for Transaction Construction
      */
     rosettaConstructionMetadata(requestParameters: RosettaConstructionMetadataOperationRequest, initOverrides?: RequestInit): Promise<RosettaConstructionMetadataResponse>;
@@ -354,7 +354,7 @@ export interface RosettaApiInterface {
     rosettaConstructionSubmit(requestParameters: RosettaConstructionSubmitOperationRequest, initOverrides?: RequestInit): Promise<RosettaConstructionSubmitResponse>;
 
     /**
-     * Get all Transaction Identifiers in the mempool.
+     * Retrieves a list of transcations currently in the mempool for a given network.
      * @summary Get All Mempool Transactions
      * @param {RosettaMempoolRequest} rosettaMempoolRequest 
      * @param {*} [options] Override http request option.
@@ -364,13 +364,13 @@ export interface RosettaApiInterface {
     rosettaMempoolRaw(requestParameters: RosettaMempoolOperationRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<RosettaMempoolResponse>>;
 
     /**
-     * Get all Transaction Identifiers in the mempool.
+     * Retrieves a list of transcations currently in the mempool for a given network.
      * Get All Mempool Transactions
      */
     rosettaMempool(requestParameters: RosettaMempoolOperationRequest, initOverrides?: RequestInit): Promise<RosettaMempoolResponse>;
 
     /**
-     * A MempoolTransactionRequest is utilized to retrieve a transaction from the mempool.
+     * Retrieves transaction details from the mempool for a given transaction id from a given network.
      * @summary Get a Mempool Transaction
      * @param {RosettaMempoolTransactionRequest} rosettaMempoolTransactionRequest 
      * @param {*} [options] Override http request option.
@@ -380,13 +380,13 @@ export interface RosettaApiInterface {
     rosettaMempoolTransactionRaw(requestParameters: RosettaMempoolTransactionOperationRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<RosettaMempoolTransactionResponse>>;
 
     /**
-     * A MempoolTransactionRequest is utilized to retrieve a transaction from the mempool.
+     * Retrieves transaction details from the mempool for a given transaction id from a given network.
      * Get a Mempool Transaction
      */
     rosettaMempoolTransaction(requestParameters: RosettaMempoolTransactionOperationRequest, initOverrides?: RequestInit): Promise<RosettaMempoolTransactionResponse>;
 
     /**
-     * This endpoint returns a list of NetworkIdentifiers that the Rosetta server supports.
+     * Retrieves a list of NetworkIdentifiers that the Rosetta server supports.
      * @summary Get List of Available Networks
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
@@ -395,13 +395,13 @@ export interface RosettaApiInterface {
     rosettaNetworkListRaw(initOverrides?: RequestInit): Promise<runtime.ApiResponse<RosettaNetworkListResponse>>;
 
     /**
-     * This endpoint returns a list of NetworkIdentifiers that the Rosetta server supports.
+     * Retrieves a list of NetworkIdentifiers that the Rosetta server supports.
      * Get List of Available Networks
      */
     rosettaNetworkList(initOverrides?: RequestInit): Promise<RosettaNetworkListResponse>;
 
     /**
-     * This endpoint returns the version information and allowed network-specific types for a NetworkIdentifier. Any NetworkIdentifier returned by /network/list should be accessible here. Because options are retrievable in the context of a NetworkIdentifier, it is possible to define unique options for each network. 
+     * Retrieves the version information and allowed network-specific types for a NetworkIdentifier. Any NetworkIdentifier returned by /network/list should be accessible here. Because options are retrievable in the context of a NetworkIdentifier, it is possible to define unique options for each network. 
      * @summary Get Network Options
      * @param {RosettaOptionsRequest} rosettaOptionsRequest 
      * @param {*} [options] Override http request option.
@@ -411,13 +411,13 @@ export interface RosettaApiInterface {
     rosettaNetworkOptionsRaw(requestParameters: RosettaNetworkOptionsRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<RosettaNetworkOptionsResponse>>;
 
     /**
-     * This endpoint returns the version information and allowed network-specific types for a NetworkIdentifier. Any NetworkIdentifier returned by /network/list should be accessible here. Because options are retrievable in the context of a NetworkIdentifier, it is possible to define unique options for each network. 
+     * Retrieves the version information and allowed network-specific types for a NetworkIdentifier. Any NetworkIdentifier returned by /network/list should be accessible here. Because options are retrievable in the context of a NetworkIdentifier, it is possible to define unique options for each network. 
      * Get Network Options
      */
     rosettaNetworkOptions(requestParameters: RosettaNetworkOptionsRequest, initOverrides?: RequestInit): Promise<RosettaNetworkOptionsResponse>;
 
     /**
-     * This endpoint returns the current status of the network requested. Any NetworkIdentifier returned by /network/list should be accessible here. 
+     * Retrieves the current status of the network requested. Any NetworkIdentifier returned by /network/list should be accessible here. 
      * @summary Get Network Status
      * @param {RosettaStatusRequest} rosettaStatusRequest 
      * @param {*} [options] Override http request option.
@@ -427,7 +427,7 @@ export interface RosettaApiInterface {
     rosettaNetworkStatusRaw(requestParameters: RosettaNetworkStatusRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<{ [key: string]: object; }>>;
 
     /**
-     * This endpoint returns the current status of the network requested. Any NetworkIdentifier returned by /network/list should be accessible here. 
+     * Retrieves the current status of the network requested. Any NetworkIdentifier returned by /network/list should be accessible here. 
      * Get Network Status
      */
     rosettaNetworkStatus(requestParameters: RosettaNetworkStatusRequest, initOverrides?: RequestInit): Promise<{ [key: string]: object; }>;
@@ -475,7 +475,7 @@ export class RosettaApi extends runtime.BaseAPI implements RosettaApiInterface {
     }
 
     /**
-     * A BlockRequest is utilized to make a block request on the /block endpoint.
+     * Retrieves the Block information for a given block identifier including a list of all transactions in the block.
      * Get a Block
      */
     async rosettaBlockRaw(requestParameters: RosettaBlockOperationRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<RosettaBlockResponse>> {
@@ -501,7 +501,7 @@ export class RosettaApi extends runtime.BaseAPI implements RosettaApiInterface {
     }
 
     /**
-     * A BlockRequest is utilized to make a block request on the /block endpoint.
+     * Retrieves the Block information for a given block identifier including a list of all transactions in the block.
      * Get a Block
      */
     async rosettaBlock(requestParameters: RosettaBlockOperationRequest, initOverrides?: RequestInit): Promise<RosettaBlockResponse> {
@@ -510,7 +510,7 @@ export class RosettaApi extends runtime.BaseAPI implements RosettaApiInterface {
     }
 
     /**
-     * A BlockTransactionRequest is used to fetch a Transaction included in a block that is not returned in a BlockResponse.
+     * Retrieves a Transaction included in a block that is not returned in a BlockResponse.
      * Get a Block Transaction
      */
     async rosettaBlockTransactionRaw(requestParameters: RosettaBlockTransactionOperationRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<RosettaBlockTransactionResponse>> {
@@ -536,7 +536,7 @@ export class RosettaApi extends runtime.BaseAPI implements RosettaApiInterface {
     }
 
     /**
-     * A BlockTransactionRequest is used to fetch a Transaction included in a block that is not returned in a BlockResponse.
+     * Retrieves a Transaction included in a block that is not returned in a BlockResponse.
      * Get a Block Transaction
      */
     async rosettaBlockTransaction(requestParameters: RosettaBlockTransactionOperationRequest, initOverrides?: RequestInit): Promise<RosettaBlockTransactionResponse> {
@@ -580,7 +580,7 @@ export class RosettaApi extends runtime.BaseAPI implements RosettaApiInterface {
     }
 
     /**
-     * TODO
+     * Retrieves the Account Identifier information based on a Public Key for a given network
      * Derive an AccountIdentifier from a PublicKey
      */
     async rosettaConstructionDeriveRaw(requestParameters: RosettaConstructionDeriveOperationRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<RosettaConstructionDeriveResponse>> {
@@ -606,7 +606,7 @@ export class RosettaApi extends runtime.BaseAPI implements RosettaApiInterface {
     }
 
     /**
-     * TODO
+     * Retrieves the Account Identifier information based on a Public Key for a given network
      * Derive an AccountIdentifier from a PublicKey
      */
     async rosettaConstructionDerive(requestParameters: RosettaConstructionDeriveOperationRequest, initOverrides?: RequestInit): Promise<RosettaConstructionDeriveResponse> {
@@ -615,7 +615,7 @@ export class RosettaApi extends runtime.BaseAPI implements RosettaApiInterface {
     }
 
     /**
-     * TODO
+     * Retrieves the network-specific transaction hash for a signed transaction.
      * Get the Hash of a Signed Transaction
      */
     async rosettaConstructionHashRaw(requestParameters: RosettaConstructionHashOperationRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<RosettaConstructionHashResponse>> {
@@ -641,7 +641,7 @@ export class RosettaApi extends runtime.BaseAPI implements RosettaApiInterface {
     }
 
     /**
-     * TODO
+     * Retrieves the network-specific transaction hash for a signed transaction.
      * Get the Hash of a Signed Transaction
      */
     async rosettaConstructionHash(requestParameters: RosettaConstructionHashOperationRequest, initOverrides?: RequestInit): Promise<RosettaConstructionHashResponse> {
@@ -650,7 +650,7 @@ export class RosettaApi extends runtime.BaseAPI implements RosettaApiInterface {
     }
 
     /**
-     * TODO
+     * To Do
      * Get Metadata for Transaction Construction
      */
     async rosettaConstructionMetadataRaw(requestParameters: RosettaConstructionMetadataOperationRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<RosettaConstructionMetadataResponse>> {
@@ -676,7 +676,7 @@ export class RosettaApi extends runtime.BaseAPI implements RosettaApiInterface {
     }
 
     /**
-     * TODO
+     * To Do
      * Get Metadata for Transaction Construction
      */
     async rosettaConstructionMetadata(requestParameters: RosettaConstructionMetadataOperationRequest, initOverrides?: RequestInit): Promise<RosettaConstructionMetadataResponse> {
@@ -825,7 +825,7 @@ export class RosettaApi extends runtime.BaseAPI implements RosettaApiInterface {
     }
 
     /**
-     * Get all Transaction Identifiers in the mempool.
+     * Retrieves a list of transcations currently in the mempool for a given network.
      * Get All Mempool Transactions
      */
     async rosettaMempoolRaw(requestParameters: RosettaMempoolOperationRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<RosettaMempoolResponse>> {
@@ -851,7 +851,7 @@ export class RosettaApi extends runtime.BaseAPI implements RosettaApiInterface {
     }
 
     /**
-     * Get all Transaction Identifiers in the mempool.
+     * Retrieves a list of transcations currently in the mempool for a given network.
      * Get All Mempool Transactions
      */
     async rosettaMempool(requestParameters: RosettaMempoolOperationRequest, initOverrides?: RequestInit): Promise<RosettaMempoolResponse> {
@@ -860,7 +860,7 @@ export class RosettaApi extends runtime.BaseAPI implements RosettaApiInterface {
     }
 
     /**
-     * A MempoolTransactionRequest is utilized to retrieve a transaction from the mempool.
+     * Retrieves transaction details from the mempool for a given transaction id from a given network.
      * Get a Mempool Transaction
      */
     async rosettaMempoolTransactionRaw(requestParameters: RosettaMempoolTransactionOperationRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<RosettaMempoolTransactionResponse>> {
@@ -886,7 +886,7 @@ export class RosettaApi extends runtime.BaseAPI implements RosettaApiInterface {
     }
 
     /**
-     * A MempoolTransactionRequest is utilized to retrieve a transaction from the mempool.
+     * Retrieves transaction details from the mempool for a given transaction id from a given network.
      * Get a Mempool Transaction
      */
     async rosettaMempoolTransaction(requestParameters: RosettaMempoolTransactionOperationRequest, initOverrides?: RequestInit): Promise<RosettaMempoolTransactionResponse> {
@@ -895,7 +895,7 @@ export class RosettaApi extends runtime.BaseAPI implements RosettaApiInterface {
     }
 
     /**
-     * This endpoint returns a list of NetworkIdentifiers that the Rosetta server supports.
+     * Retrieves a list of NetworkIdentifiers that the Rosetta server supports.
      * Get List of Available Networks
      */
     async rosettaNetworkListRaw(initOverrides?: RequestInit): Promise<runtime.ApiResponse<RosettaNetworkListResponse>> {
@@ -914,7 +914,7 @@ export class RosettaApi extends runtime.BaseAPI implements RosettaApiInterface {
     }
 
     /**
-     * This endpoint returns a list of NetworkIdentifiers that the Rosetta server supports.
+     * Retrieves a list of NetworkIdentifiers that the Rosetta server supports.
      * Get List of Available Networks
      */
     async rosettaNetworkList(initOverrides?: RequestInit): Promise<RosettaNetworkListResponse> {
@@ -923,7 +923,7 @@ export class RosettaApi extends runtime.BaseAPI implements RosettaApiInterface {
     }
 
     /**
-     * This endpoint returns the version information and allowed network-specific types for a NetworkIdentifier. Any NetworkIdentifier returned by /network/list should be accessible here. Because options are retrievable in the context of a NetworkIdentifier, it is possible to define unique options for each network. 
+     * Retrieves the version information and allowed network-specific types for a NetworkIdentifier. Any NetworkIdentifier returned by /network/list should be accessible here. Because options are retrievable in the context of a NetworkIdentifier, it is possible to define unique options for each network. 
      * Get Network Options
      */
     async rosettaNetworkOptionsRaw(requestParameters: RosettaNetworkOptionsRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<RosettaNetworkOptionsResponse>> {
@@ -949,7 +949,7 @@ export class RosettaApi extends runtime.BaseAPI implements RosettaApiInterface {
     }
 
     /**
-     * This endpoint returns the version information and allowed network-specific types for a NetworkIdentifier. Any NetworkIdentifier returned by /network/list should be accessible here. Because options are retrievable in the context of a NetworkIdentifier, it is possible to define unique options for each network. 
+     * Retrieves the version information and allowed network-specific types for a NetworkIdentifier. Any NetworkIdentifier returned by /network/list should be accessible here. Because options are retrievable in the context of a NetworkIdentifier, it is possible to define unique options for each network. 
      * Get Network Options
      */
     async rosettaNetworkOptions(requestParameters: RosettaNetworkOptionsRequest, initOverrides?: RequestInit): Promise<RosettaNetworkOptionsResponse> {
@@ -958,7 +958,7 @@ export class RosettaApi extends runtime.BaseAPI implements RosettaApiInterface {
     }
 
     /**
-     * This endpoint returns the current status of the network requested. Any NetworkIdentifier returned by /network/list should be accessible here. 
+     * Retrieves the current status of the network requested. Any NetworkIdentifier returned by /network/list should be accessible here. 
      * Get Network Status
      */
     async rosettaNetworkStatusRaw(requestParameters: RosettaNetworkStatusRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<{ [key: string]: object; }>> {
@@ -984,7 +984,7 @@ export class RosettaApi extends runtime.BaseAPI implements RosettaApiInterface {
     }
 
     /**
-     * This endpoint returns the current status of the network requested. Any NetworkIdentifier returned by /network/list should be accessible here. 
+     * Retrieves the current status of the network requested. Any NetworkIdentifier returned by /network/list should be accessible here. 
      * Get Network Status
      */
     async rosettaNetworkStatus(requestParameters: RosettaNetworkStatusRequest, initOverrides?: RequestInit): Promise<{ [key: string]: object; }> {

package/src/generated/apis/SearchApi.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
  * 
@@ -17,6 +17,7 @@ import * as runtime from '../runtime';
 
 export interface SearchByIdRequest {
     id: string;
+    includeMetadata?: boolean;
 }
 
 /**
@@ -30,6 +31,7 @@ export interface SearchApiInterface {
      * Search blocks, transactions, contracts, or accounts by hash/ID
      * @summary Search
      * @param {string} id The hex hash string for a block or transaction, account address, or contract address
+     * @param {boolean} [includeMetadata] This includes the detailed data for purticular hash in the response
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof SearchApiInterface
@@ -60,6 +62,10 @@ export class SearchApi extends runtime.BaseAPI implements SearchApiInterface {
 
         const queryParameters: any = {};
 
+        if (requestParameters.includeMetadata !== undefined) {
+            queryParameters['include_metadata'] = requestParameters.includeMetadata;
+        }
+
         const headerParameters: runtime.HTTPHeaders = {};
 
         const response = await this.request({