@stacks/blockchain-api-client 0.71.1 → 1.0.3

package/lib/generated/apis/RosettaApi.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
  *
@@ -78,7 +78,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.
@@ -87,12 +87,12 @@ 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.
@@ -101,7 +101,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>;
@@ -120,7 +120,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.
@@ -129,12 +129,12 @@ 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.
@@ -143,12 +143,12 @@ 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.
@@ -157,7 +157,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>;
@@ -218,7 +218,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.
@@ -227,12 +227,12 @@ 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.
@@ -241,12 +241,12 @@ 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}
@@ -254,12 +254,12 @@ 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.
@@ -268,12 +268,12 @@ 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.
@@ -284,7 +284,7 @@ export interface RosettaApiInterface {
         [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<{
@@ -306,22 +306,22 @@ export declare class RosettaApi extends runtime.BaseAPI implements RosettaApiInt
      */
     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.
      * Get a Block
      */
     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.
      * Get a Block Transaction
      */
     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>;
@@ -336,32 +336,32 @@ export declare class RosettaApi extends runtime.BaseAPI implements RosettaApiInt
      */
     rosettaConstructionCombine(requestParameters: RosettaConstructionCombineOperationRequest, initOverrides?: RequestInit): Promise<RosettaConstructionCombineResponse>;
     /**
-     * TODO
+     * Retrieves the Account Identifier information based on a Public Key for a given network
      * Derive an AccountIdentifier from a PublicKey
      */
     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.
      * Get the Hash of a Signed Transaction
      */
     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
      * Get Metadata for Transaction Construction
      */
     rosettaConstructionMetadataRaw(requestParameters: RosettaConstructionMetadataOperationRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<RosettaConstructionMetadataResponse>>;
     /**
-     * TODO
+     * To Do
      * Get Metadata for Transaction Construction
      */
     rosettaConstructionMetadata(requestParameters: RosettaConstructionMetadataOperationRequest, initOverrides?: RequestInit): Promise<RosettaConstructionMetadataResponse>;
@@ -406,54 +406,54 @@ export declare class RosettaApi extends runtime.BaseAPI implements RosettaApiInt
      */
     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.
      * Get All Mempool Transactions
      */
     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.
      * Get a Mempool Transaction
      */
     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.
      * Get List of Available Networks
      */
     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.
      * Get Network Options
      */
     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.
      * Get Network Status
      */
     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<{

package/lib/generated/apis/RosettaApi.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
  *
@@ -49,7 +49,7 @@ class RosettaApi extends runtime.BaseAPI {
         return await response.value();
     }
     /**
-     * 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, initOverrides) {
@@ -69,7 +69,7 @@ class RosettaApi extends runtime.BaseAPI {
         return new runtime.JSONApiResponse(response, (jsonValue) => models_1.RosettaBlockResponseFromJSON(jsonValue));
     }
     /**
-     * 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, initOverrides) {
@@ -77,7 +77,7 @@ class RosettaApi extends runtime.BaseAPI {
         return await response.value();
     }
     /**
-     * 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, initOverrides) {
@@ -97,7 +97,7 @@ class RosettaApi extends runtime.BaseAPI {
         return new runtime.JSONApiResponse(response, (jsonValue) => models_1.RosettaBlockTransactionResponseFromJSON(jsonValue));
     }
     /**
-     * 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, initOverrides) {
@@ -133,7 +133,7 @@ class RosettaApi extends runtime.BaseAPI {
         return await response.value();
     }
     /**
-     * TODO
+     * Retrieves the Account Identifier information based on a Public Key for a given network
      * Derive an AccountIdentifier from a PublicKey
      */
     async rosettaConstructionDeriveRaw(requestParameters, initOverrides) {
@@ -153,7 +153,7 @@ class RosettaApi extends runtime.BaseAPI {
         return new runtime.JSONApiResponse(response, (jsonValue) => models_1.RosettaConstructionDeriveResponseFromJSON(jsonValue));
     }
     /**
-     * TODO
+     * Retrieves the Account Identifier information based on a Public Key for a given network
      * Derive an AccountIdentifier from a PublicKey
      */
     async rosettaConstructionDerive(requestParameters, initOverrides) {
@@ -161,7 +161,7 @@ class RosettaApi extends runtime.BaseAPI {
         return await response.value();
     }
     /**
-     * TODO
+     * Retrieves the network-specific transaction hash for a signed transaction.
      * Get the Hash of a Signed Transaction
      */
     async rosettaConstructionHashRaw(requestParameters, initOverrides) {
@@ -181,7 +181,7 @@ class RosettaApi extends runtime.BaseAPI {
         return new runtime.JSONApiResponse(response, (jsonValue) => models_1.RosettaConstructionHashResponseFromJSON(jsonValue));
     }
     /**
-     * TODO
+     * Retrieves the network-specific transaction hash for a signed transaction.
      * Get the Hash of a Signed Transaction
      */
     async rosettaConstructionHash(requestParameters, initOverrides) {
@@ -189,7 +189,7 @@ class RosettaApi extends runtime.BaseAPI {
         return await response.value();
     }
     /**
-     * TODO
+     * To Do
      * Get Metadata for Transaction Construction
      */
     async rosettaConstructionMetadataRaw(requestParameters, initOverrides) {
@@ -209,7 +209,7 @@ class RosettaApi extends runtime.BaseAPI {
         return new runtime.JSONApiResponse(response, (jsonValue) => models_1.RosettaConstructionMetadataResponseFromJSON(jsonValue));
     }
     /**
-     * TODO
+     * To Do
      * Get Metadata for Transaction Construction
      */
     async rosettaConstructionMetadata(requestParameters, initOverrides) {
@@ -329,7 +329,7 @@ class RosettaApi extends runtime.BaseAPI {
         return await response.value();
     }
     /**
-     * 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, initOverrides) {
@@ -349,7 +349,7 @@ class RosettaApi extends runtime.BaseAPI {
         return new runtime.JSONApiResponse(response, (jsonValue) => models_1.RosettaMempoolResponseFromJSON(jsonValue));
     }
     /**
-     * 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, initOverrides) {
@@ -357,7 +357,7 @@ class RosettaApi extends runtime.BaseAPI {
         return await response.value();
     }
     /**
-     * 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, initOverrides) {
@@ -377,7 +377,7 @@ class RosettaApi extends runtime.BaseAPI {
         return new runtime.JSONApiResponse(response, (jsonValue) => models_1.RosettaMempoolTransactionResponseFromJSON(jsonValue));
     }
     /**
-     * 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, initOverrides) {
@@ -385,7 +385,7 @@ class RosettaApi extends runtime.BaseAPI {
         return await response.value();
     }
     /**
-     * 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) {
@@ -400,7 +400,7 @@ class RosettaApi extends runtime.BaseAPI {
         return new runtime.JSONApiResponse(response, (jsonValue) => models_1.RosettaNetworkListResponseFromJSON(jsonValue));
     }
     /**
-     * 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) {
@@ -408,7 +408,7 @@ class RosettaApi extends runtime.BaseAPI {
         return await response.value();
     }
     /**
-     * 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, initOverrides) {
@@ -428,7 +428,7 @@ class RosettaApi extends runtime.BaseAPI {
         return new runtime.JSONApiResponse(response, (jsonValue) => models_1.RosettaNetworkOptionsResponseFromJSON(jsonValue));
     }
     /**
-     * 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, initOverrides) {
@@ -436,7 +436,7 @@ class RosettaApi extends runtime.BaseAPI {
         return await response.value();
     }
     /**
-     * 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, initOverrides) {
@@ -456,7 +456,7 @@ class RosettaApi extends runtime.BaseAPI {
         return new runtime.JSONApiResponse(response);
     }
     /**
-     * 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, initOverrides) {

package/lib/generated/apis/SearchApi.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
  *
@@ -12,6 +12,7 @@
 import * as runtime from '../runtime';
 export interface SearchByIdRequest {
     id: string;
+    includeMetadata?: boolean;
 }
 /**
  * SearchApi - interface
@@ -24,6 +25,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

package/lib/generated/apis/SearchApi.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
  *
@@ -28,6 +28,9 @@ class SearchApi extends runtime.BaseAPI {
             throw new runtime.RequiredError('id', 'Required parameter requestParameters.id was null or undefined when calling searchById.');
         }
         const queryParameters = {};
+        if (requestParameters.includeMetadata !== undefined) {
+            queryParameters['include_metadata'] = requestParameters.includeMetadata;
+        }
         const headerParameters = {};
         const response = await this.request({
             path: `/extended/v1/search/{id}`.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters.id))),

package/lib/generated/apis/SearchApi.js.map

@@ -1 +1 @@
-{"version":3,"file":"SearchApi.js","sourceRoot":"","sources":["../../../src/generated/apis/SearchApi.ts"],"names":[],"mappings":";AAAA,oBAAoB;AACpB,oBAAoB;AACpB;;;;;;;;;;GAUG;;;AAGH,sCAAsC;AA+BtC;;GAEG;AACH,MAAa,SAAU,SAAQ,OAAO,CAAC,OAAO;IAE1C;;;OAGG;IACH,KAAK,CAAC,aAAa,CAAC,iBAAoC,EAAE,aAA2B;QACjF,IAAI,iBAAiB,CAAC,EAAE,KAAK,IAAI,IAAI,iBAAiB,CAAC,EAAE,KAAK,SAAS,EAAE;YACrE,MAAM,IAAI,OAAO,CAAC,aAAa,CAAC,IAAI,EAAC,wFAAwF,CAAC,CAAC;SAClI;QAED,MAAM,eAAe,GAAQ,EAAE,CAAC;QAEhC,MAAM,gBAAgB,GAAwB,EAAE,CAAC;QAEjD,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC;YAChC,IAAI,EAAE,0BAA0B,CAAC,OAAO,CAAC,IAAI,IAAI,GAAG,EAAE,kBAAkB,CAAC,MAAM,CAAC,iBAAiB,CAAC,EAAE,CAAC,CAAC,CAAC;YACvG,MAAM,EAAE,KAAK;YACb,OAAO,EAAE,gBAAgB;YACzB,KAAK,EAAE,eAAe;SACzB,EAAE,aAAa,CAAC,CAAC;QAElB,OAAO,IAAI,OAAO,CAAC,eAAe,CAAM,QAAQ,CAAC,CAAC;IACtD,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,UAAU,CAAC,iBAAoC,EAAE,aAA2B;QAC9E,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,iBAAiB,EAAE,aAAa,CAAC,CAAC;QAC5E,OAAO,MAAM,QAAQ,CAAC,KAAK,EAAE,CAAC;IAClC,CAAC;CAEJ;AAlCD,8BAkCC"}
+{"version":3,"file":"SearchApi.js","sourceRoot":"","sources":["../../../src/generated/apis/SearchApi.ts"],"names":[],"mappings":";AAAA,oBAAoB;AACpB,oBAAoB;AACpB;;;;;;;;;;GAUG;;;AAGH,sCAAsC;AAiCtC;;GAEG;AACH,MAAa,SAAU,SAAQ,OAAO,CAAC,OAAO;IAE1C;;;OAGG;IACH,KAAK,CAAC,aAAa,CAAC,iBAAoC,EAAE,aAA2B;QACjF,IAAI,iBAAiB,CAAC,EAAE,KAAK,IAAI,IAAI,iBAAiB,CAAC,EAAE,KAAK,SAAS,EAAE;YACrE,MAAM,IAAI,OAAO,CAAC,aAAa,CAAC,IAAI,EAAC,wFAAwF,CAAC,CAAC;SAClI;QAED,MAAM,eAAe,GAAQ,EAAE,CAAC;QAEhC,IAAI,iBAAiB,CAAC,eAAe,KAAK,SAAS,EAAE;YACjD,eAAe,CAAC,kBAAkB,CAAC,GAAG,iBAAiB,CAAC,eAAe,CAAC;SAC3E;QAED,MAAM,gBAAgB,GAAwB,EAAE,CAAC;QAEjD,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC;YAChC,IAAI,EAAE,0BAA0B,CAAC,OAAO,CAAC,IAAI,IAAI,GAAG,EAAE,kBAAkB,CAAC,MAAM,CAAC,iBAAiB,CAAC,EAAE,CAAC,CAAC,CAAC;YACvG,MAAM,EAAE,KAAK;YACb,OAAO,EAAE,gBAAgB;YACzB,KAAK,EAAE,eAAe;SACzB,EAAE,aAAa,CAAC,CAAC;QAElB,OAAO,IAAI,OAAO,CAAC,eAAe,CAAM,QAAQ,CAAC,CAAC;IACtD,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,UAAU,CAAC,iBAAoC,EAAE,aAA2B;QAC9E,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,iBAAiB,EAAE,aAAa,CAAC,CAAC;QAC5E,OAAO,MAAM,QAAQ,CAAC,KAAK,EAAE,CAAC;IAClC,CAAC;CAEJ;AAtCD,8BAsCC"}