@stacks/blockchain-api-client 0.71.2 → 1.0.0

package/src/generated/apis/InfoApi.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
  * 
@@ -58,7 +58,7 @@ export interface GetTotalStxSupplyLegacyFormatRequest {
  */
 export interface InfoApiInterface {
     /**
-     * Get Core API information
+     * Retrieves information about the Core API including the server version
      * @summary Get Core API info
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
@@ -67,13 +67,13 @@ export interface InfoApiInterface {
     getCoreApiInfoRaw(initOverrides?: RequestInit): Promise<runtime.ApiResponse<CoreNodeInfoResponse>>;
 
     /**
-     * Get Core API information
+     * Retrieves information about the Core API including the server version
      * Get Core API info
      */
     getCoreApiInfo(initOverrides?: RequestInit): Promise<CoreNodeInfoResponse>;
 
     /**
-     * 
+     * Retrieves the target block time for a given network. The network can be mainnet or testnet. The block time is hardcoded and will change throughout the implementation phases of the testnet.
      * @summary Get a given network\'s target block time
      * @param {'testnet' | 'mainnet'} network Which network to retrieve the target block time of
      * @param {*} [options] Override http request option.
@@ -83,12 +83,13 @@ export interface InfoApiInterface {
     getNetworkBlockTimeByNetworkRaw(requestParameters: GetNetworkBlockTimeByNetworkRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<NetworkBlockTimeResponse>>;
 
     /**
+     * Retrieves the target block time for a given network. The network can be mainnet or testnet. The block time is hardcoded and will change throughout the implementation phases of the testnet.
      * Get a given network\'s target block time
      */
     getNetworkBlockTimeByNetwork(requestParameters: GetNetworkBlockTimeByNetworkRequest, initOverrides?: RequestInit): Promise<NetworkBlockTimeResponse>;
 
     /**
-     * 
+     * Retrieves the target block times for mainnet and testnet. The block time is hardcoded and will change throughout the implementation phases of the testnet.
      * @summary Get the network target block time
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
@@ -97,13 +98,14 @@ export interface InfoApiInterface {
     getNetworkBlockTimesRaw(initOverrides?: RequestInit): Promise<runtime.ApiResponse<NetworkBlockTimesResponse>>;
 
     /**
+     * Retrieves the target block times for mainnet and testnet. The block time is hardcoded and will change throughout the implementation phases of the testnet.
      * Get the network target block time
      */
     getNetworkBlockTimes(initOverrides?: RequestInit): Promise<NetworkBlockTimesResponse>;
 
     /**
-     * Get Proof of Transfer (PoX) information. Can be used for Stacking.
-     * @summary Get PoX details
+     * Retrieves Proof-of-Transfer (PoX) information. Can be used for Stacking.
+     * @summary Get Proof-of-Transfer details
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof InfoApiInterface
@@ -111,13 +113,13 @@ export interface InfoApiInterface {
     getPoxInfoRaw(initOverrides?: RequestInit): Promise<runtime.ApiResponse<CoreNodePoxResponse>>;
 
     /**
-     * Get Proof of Transfer (PoX) information. Can be used for Stacking.
-     * Get PoX details
+     * Retrieves Proof-of-Transfer (PoX) information. Can be used for Stacking.
+     * Get Proof-of-Transfer details
      */
     getPoxInfo(initOverrides?: RequestInit): Promise<CoreNodePoxResponse>;
 
     /**
-     * Get Blockchain API status
+     * Retrieves the current status of the blockchain API, including the server version
      * @summary Get Blockchain API status
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
@@ -126,13 +128,13 @@ export interface InfoApiInterface {
     getStatusRaw(initOverrides?: RequestInit): Promise<runtime.ApiResponse<ServerStatusResponse>>;
 
     /**
-     * Get Blockchain API status
+     * Retrieves the current status of the blockchain API, including the server version
      * Get Blockchain API status
      */
     getStatus(initOverrides?: RequestInit): Promise<ServerStatusResponse>;
 
     /**
-     * 
+     * Retrieves the total and unlocked STX supply. More information on Stacking can be found [here] (https://docs.stacks.co/understand-stacks/stacking).
      * @summary Get total and unlocked STX supply
      * @param {number} [height] The block height at which to query supply details from, if not provided then the latest block height is used
      * @param {*} [options] Override http request option.
@@ -142,12 +144,13 @@ export interface InfoApiInterface {
     getStxSupplyRaw(requestParameters: GetStxSupplyRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<GetStxSupplyResponse>>;
 
     /**
+     * Retrieves the total and unlocked STX supply. More information on Stacking can be found [here] (https://docs.stacks.co/understand-stacks/stacking).
      * Get total and unlocked STX supply
      */
     getStxSupply(requestParameters: GetStxSupplyRequest, initOverrides?: RequestInit): Promise<GetStxSupplyResponse>;
 
     /**
-     * 
+     * Retrieves the STX tokens currently in circulation that have been unlocked as plain text.
      * @summary Get circulating STX supply in plain text format
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
@@ -156,12 +159,13 @@ export interface InfoApiInterface {
     getStxSupplyCirculatingPlainRaw(initOverrides?: RequestInit): Promise<runtime.ApiResponse<string>>;
 
     /**
+     * Retrieves the STX tokens currently in circulation that have been unlocked as plain text.
      * Get circulating STX supply in plain text format
      */
     getStxSupplyCirculatingPlain(initOverrides?: RequestInit): Promise<string>;
 
     /**
-     * 
+     * Retrieves the total supply for STX tokens as plain text.
      * @summary Get total STX supply in plain text format
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
@@ -170,12 +174,13 @@ export interface InfoApiInterface {
     getStxSupplyTotalSupplyPlainRaw(initOverrides?: RequestInit): Promise<runtime.ApiResponse<string>>;
 
     /**
+     * Retrieves the total supply for STX tokens as plain text.
      * Get total STX supply in plain text format
      */
     getStxSupplyTotalSupplyPlain(initOverrides?: RequestInit): Promise<string>;
 
     /**
-     * 
+     * Retrieves total supply of STX tokens including those currently in circulation that have been unlocked.
      * @summary Get total and unlocked STX supply (results formatted the same as the legacy 1.0 API)
      * @param {number} [height] The block height at which to query supply details from, if not provided then the latest block height is used
      * @param {*} [options] Override http request option.
@@ -185,6 +190,7 @@ export interface InfoApiInterface {
     getTotalStxSupplyLegacyFormatRaw(requestParameters: GetTotalStxSupplyLegacyFormatRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<GetStxSupplyLegacyFormatResponse>>;
 
     /**
+     * Retrieves total supply of STX tokens including those currently in circulation that have been unlocked.
      * Get total and unlocked STX supply (results formatted the same as the legacy 1.0 API)
      */
     getTotalStxSupplyLegacyFormat(requestParameters: GetTotalStxSupplyLegacyFormatRequest, initOverrides?: RequestInit): Promise<GetStxSupplyLegacyFormatResponse>;
@@ -197,7 +203,7 @@ export interface InfoApiInterface {
 export class InfoApi extends runtime.BaseAPI implements InfoApiInterface {
 
     /**
-     * Get Core API information
+     * Retrieves information about the Core API including the server version
      * Get Core API info
      */
     async getCoreApiInfoRaw(initOverrides?: RequestInit): Promise<runtime.ApiResponse<CoreNodeInfoResponse>> {
@@ -216,7 +222,7 @@ export class InfoApi extends runtime.BaseAPI implements InfoApiInterface {
     }
 
     /**
-     * Get Core API information
+     * Retrieves information about the Core API including the server version
      * Get Core API info
      */
     async getCoreApiInfo(initOverrides?: RequestInit): Promise<CoreNodeInfoResponse> {
@@ -225,6 +231,7 @@ export class InfoApi extends runtime.BaseAPI implements InfoApiInterface {
     }
 
     /**
+     * Retrieves the target block time for a given network. The network can be mainnet or testnet. The block time is hardcoded and will change throughout the implementation phases of the testnet.
      * Get a given network\'s target block time
      */
     async getNetworkBlockTimeByNetworkRaw(requestParameters: GetNetworkBlockTimeByNetworkRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<NetworkBlockTimeResponse>> {
@@ -247,6 +254,7 @@ export class InfoApi extends runtime.BaseAPI implements InfoApiInterface {
     }
 
     /**
+     * Retrieves the target block time for a given network. The network can be mainnet or testnet. The block time is hardcoded and will change throughout the implementation phases of the testnet.
      * Get a given network\'s target block time
      */
     async getNetworkBlockTimeByNetwork(requestParameters: GetNetworkBlockTimeByNetworkRequest, initOverrides?: RequestInit): Promise<NetworkBlockTimeResponse> {
@@ -255,6 +263,7 @@ export class InfoApi extends runtime.BaseAPI implements InfoApiInterface {
     }
 
     /**
+     * Retrieves the target block times for mainnet and testnet. The block time is hardcoded and will change throughout the implementation phases of the testnet.
      * Get the network target block time
      */
     async getNetworkBlockTimesRaw(initOverrides?: RequestInit): Promise<runtime.ApiResponse<NetworkBlockTimesResponse>> {
@@ -273,6 +282,7 @@ export class InfoApi extends runtime.BaseAPI implements InfoApiInterface {
     }
 
     /**
+     * Retrieves the target block times for mainnet and testnet. The block time is hardcoded and will change throughout the implementation phases of the testnet.
      * Get the network target block time
      */
     async getNetworkBlockTimes(initOverrides?: RequestInit): Promise<NetworkBlockTimesResponse> {
@@ -281,8 +291,8 @@ export class InfoApi extends runtime.BaseAPI implements InfoApiInterface {
     }
 
     /**
-     * Get Proof of Transfer (PoX) information. Can be used for Stacking.
-     * Get PoX details
+     * Retrieves Proof-of-Transfer (PoX) information. Can be used for Stacking.
+     * Get Proof-of-Transfer details
      */
     async getPoxInfoRaw(initOverrides?: RequestInit): Promise<runtime.ApiResponse<CoreNodePoxResponse>> {
         const queryParameters: any = {};
@@ -300,8 +310,8 @@ export class InfoApi extends runtime.BaseAPI implements InfoApiInterface {
     }
 
     /**
-     * Get Proof of Transfer (PoX) information. Can be used for Stacking.
-     * Get PoX details
+     * Retrieves Proof-of-Transfer (PoX) information. Can be used for Stacking.
+     * Get Proof-of-Transfer details
      */
     async getPoxInfo(initOverrides?: RequestInit): Promise<CoreNodePoxResponse> {
         const response = await this.getPoxInfoRaw(initOverrides);
@@ -309,7 +319,7 @@ export class InfoApi extends runtime.BaseAPI implements InfoApiInterface {
     }
 
     /**
-     * Get Blockchain API status
+     * Retrieves the current status of the blockchain API, including the server version
      * Get Blockchain API status
      */
     async getStatusRaw(initOverrides?: RequestInit): Promise<runtime.ApiResponse<ServerStatusResponse>> {
@@ -328,7 +338,7 @@ export class InfoApi extends runtime.BaseAPI implements InfoApiInterface {
     }
 
     /**
-     * Get Blockchain API status
+     * Retrieves the current status of the blockchain API, including the server version
      * Get Blockchain API status
      */
     async getStatus(initOverrides?: RequestInit): Promise<ServerStatusResponse> {
@@ -337,6 +347,7 @@ export class InfoApi extends runtime.BaseAPI implements InfoApiInterface {
     }
 
     /**
+     * Retrieves the total and unlocked STX supply. More information on Stacking can be found [here] (https://docs.stacks.co/understand-stacks/stacking).
      * Get total and unlocked STX supply
      */
     async getStxSupplyRaw(requestParameters: GetStxSupplyRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<GetStxSupplyResponse>> {
@@ -359,6 +370,7 @@ export class InfoApi extends runtime.BaseAPI implements InfoApiInterface {
     }
 
     /**
+     * Retrieves the total and unlocked STX supply. More information on Stacking can be found [here] (https://docs.stacks.co/understand-stacks/stacking).
      * Get total and unlocked STX supply
      */
     async getStxSupply(requestParameters: GetStxSupplyRequest, initOverrides?: RequestInit): Promise<GetStxSupplyResponse> {
@@ -367,6 +379,7 @@ export class InfoApi extends runtime.BaseAPI implements InfoApiInterface {
     }
 
     /**
+     * Retrieves the STX tokens currently in circulation that have been unlocked as plain text.
      * Get circulating STX supply in plain text format
      */
     async getStxSupplyCirculatingPlainRaw(initOverrides?: RequestInit): Promise<runtime.ApiResponse<string>> {
@@ -385,6 +398,7 @@ export class InfoApi extends runtime.BaseAPI implements InfoApiInterface {
     }
 
     /**
+     * Retrieves the STX tokens currently in circulation that have been unlocked as plain text.
      * Get circulating STX supply in plain text format
      */
     async getStxSupplyCirculatingPlain(initOverrides?: RequestInit): Promise<string> {
@@ -393,6 +407,7 @@ export class InfoApi extends runtime.BaseAPI implements InfoApiInterface {
     }
 
     /**
+     * Retrieves the total supply for STX tokens as plain text.
      * Get total STX supply in plain text format
      */
     async getStxSupplyTotalSupplyPlainRaw(initOverrides?: RequestInit): Promise<runtime.ApiResponse<string>> {
@@ -411,6 +426,7 @@ export class InfoApi extends runtime.BaseAPI implements InfoApiInterface {
     }
 
     /**
+     * Retrieves the total supply for STX tokens as plain text.
      * Get total STX supply in plain text format
      */
     async getStxSupplyTotalSupplyPlain(initOverrides?: RequestInit): Promise<string> {
@@ -419,6 +435,7 @@ export class InfoApi extends runtime.BaseAPI implements InfoApiInterface {
     }
 
     /**
+     * Retrieves total supply of STX tokens including those currently in circulation that have been unlocked.
      * Get total and unlocked STX supply (results formatted the same as the legacy 1.0 API)
      */
     async getTotalStxSupplyLegacyFormatRaw(requestParameters: GetTotalStxSupplyLegacyFormatRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<GetStxSupplyLegacyFormatResponse>> {
@@ -441,6 +458,7 @@ export class InfoApi extends runtime.BaseAPI implements InfoApiInterface {
     }
 
     /**
+     * Retrieves total supply of STX tokens including those currently in circulation that have been unlocked.
      * Get total and unlocked STX supply (results formatted the same as the legacy 1.0 API)
      */
     async getTotalStxSupplyLegacyFormat(requestParameters: GetTotalStxSupplyLegacyFormatRequest, initOverrides?: RequestInit): Promise<GetStxSupplyLegacyFormatResponse> {

package/src/generated/apis/MicroblocksApi.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
  * 
@@ -43,7 +43,7 @@ export interface GetMicroblockListRequest {
  */
 export interface MicroblocksApiInterface {
     /**
-     * Get a specific microblock by hash
+     * Retrieves a specific microblock by `hash`
      * @summary Get microblock
      * @param {string} hash Hash of the microblock
      * @param {*} [options] Override http request option.
@@ -53,13 +53,13 @@ export interface MicroblocksApiInterface {
     getMicroblockByHashRaw(requestParameters: GetMicroblockByHashRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<Microblock>>;
 
     /**
-     * Get a specific microblock by hash
+     * Retrieves a specific microblock by `hash`
      * Get microblock
      */
     getMicroblockByHash(requestParameters: GetMicroblockByHashRequest, initOverrides?: RequestInit): Promise<Microblock>;
 
     /**
-     * 
+     * Retrieves a list of microblocks.
      * @summary Get recent microblocks
      * @param {number} [limit] Max number of microblocks to fetch
      * @param {number} [offset] Index of the first microblock to fetch
@@ -70,12 +70,13 @@ export interface MicroblocksApiInterface {
     getMicroblockListRaw(requestParameters: GetMicroblockListRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<MicroblockListResponse>>;
 
     /**
+     * Retrieves a list of microblocks.
      * Get recent microblocks
      */
     getMicroblockList(requestParameters: GetMicroblockListRequest, initOverrides?: RequestInit): Promise<MicroblockListResponse>;
 
     /**
-     * This contains transactions that have been streamed in microblocks but not yet accepted or rejected in an anchor block
+     * Retrieves transactions that have been streamed in microblocks but not yet accepted or rejected in an anchor block
      * @summary Get the list of current transactions that belong to unanchored microblocks
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
@@ -84,7 +85,7 @@ export interface MicroblocksApiInterface {
     getUnanchoredTxsRaw(initOverrides?: RequestInit): Promise<runtime.ApiResponse<UnanchoredTransactionListResponse>>;
 
     /**
-     * This contains transactions that have been streamed in microblocks but not yet accepted or rejected in an anchor block
+     * Retrieves transactions that have been streamed in microblocks but not yet accepted or rejected in an anchor block
      * Get the list of current transactions that belong to unanchored microblocks
      */
     getUnanchoredTxs(initOverrides?: RequestInit): Promise<UnanchoredTransactionListResponse>;
@@ -97,7 +98,7 @@ export interface MicroblocksApiInterface {
 export class MicroblocksApi extends runtime.BaseAPI implements MicroblocksApiInterface {
 
     /**
-     * Get a specific microblock by hash
+     * Retrieves a specific microblock by `hash`
      * Get microblock
      */
     async getMicroblockByHashRaw(requestParameters: GetMicroblockByHashRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<Microblock>> {
@@ -120,7 +121,7 @@ export class MicroblocksApi extends runtime.BaseAPI implements MicroblocksApiInt
     }
 
     /**
-     * Get a specific microblock by hash
+     * Retrieves a specific microblock by `hash`
      * Get microblock
      */
     async getMicroblockByHash(requestParameters: GetMicroblockByHashRequest, initOverrides?: RequestInit): Promise<Microblock> {
@@ -129,6 +130,7 @@ export class MicroblocksApi extends runtime.BaseAPI implements MicroblocksApiInt
     }
 
     /**
+     * Retrieves a list of microblocks.
      * Get recent microblocks
      */
     async getMicroblockListRaw(requestParameters: GetMicroblockListRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<MicroblockListResponse>> {
@@ -155,6 +157,7 @@ export class MicroblocksApi extends runtime.BaseAPI implements MicroblocksApiInt
     }
 
     /**
+     * Retrieves a list of microblocks.
      * Get recent microblocks
      */
     async getMicroblockList(requestParameters: GetMicroblockListRequest, initOverrides?: RequestInit): Promise<MicroblockListResponse> {
@@ -163,7 +166,7 @@ export class MicroblocksApi extends runtime.BaseAPI implements MicroblocksApiInt
     }
 
     /**
-     * This contains transactions that have been streamed in microblocks but not yet accepted or rejected in an anchor block
+     * Retrieves transactions that have been streamed in microblocks but not yet accepted or rejected in an anchor block
      * Get the list of current transactions that belong to unanchored microblocks
      */
     async getUnanchoredTxsRaw(initOverrides?: RequestInit): Promise<runtime.ApiResponse<UnanchoredTransactionListResponse>> {
@@ -182,7 +185,7 @@ export class MicroblocksApi extends runtime.BaseAPI implements MicroblocksApiInt
     }
 
     /**
-     * This contains transactions that have been streamed in microblocks but not yet accepted or rejected in an anchor block
+     * Retrieves transactions that have been streamed in microblocks but not yet accepted or rejected in an anchor block
      * Get the list of current transactions that belong to unanchored microblocks
      */
     async getUnanchoredTxs(initOverrides?: RequestInit): Promise<UnanchoredTransactionListResponse> {