@stacks/blockchain-api-client 7.0.0-stacks-2.1.2 → 7.1.0-beta.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stacks/blockchain-api-client",
-  "version": "7.0.0-stacks-2.1.2",
+  "version": "7.1.0-beta.1",
   "access": "public",
   "description": "Client for the Stacks Blockchain API",
   "homepage": "https://github.com/hirosystems/stacks-blockchain-api/tree/master/client#readme",

package/src/generated/apis/InfoApi.ts

@@ -134,9 +134,9 @@ export interface InfoApiInterface {
     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).
+     * Retrieves the total and unlocked STX supply. More information on Stacking can be found [here] (https://docs.stacks.co/understand-stacks/stacking). **Note:** This uses the estimated future total supply for the year 2050. 
      * @summary Get total and unlocked STX supply
-     * @param {number} [height] Supply details are queried from specified block height. If the block height is not specified, the latest block height is taken as default value.
+     * @param {number} [height] Supply details are queried from specified block height. If the block height is not specified, the latest block height is taken as default value. Note that the &#x60;block height&#x60; is referred to the stacks blockchain.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof InfoApiInterface
@@ -144,7 +144,7 @@ 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).
+     * Retrieves the total and unlocked STX supply. More information on Stacking can be found [here] (https://docs.stacks.co/understand-stacks/stacking). **Note:** This uses the estimated future total supply for the year 2050. 
      * Get total and unlocked STX supply
      */
     getStxSupply(requestParameters: GetStxSupplyRequest, initOverrides?: RequestInit): Promise<GetStxSupplyResponse>;
@@ -165,7 +165,7 @@ export interface InfoApiInterface {
     getStxSupplyCirculatingPlain(initOverrides?: RequestInit): Promise<string>;
 
     /**
-     * Retrieves the total supply for STX tokens as plain text.
+     * Retrieves the total supply for STX tokens as plain text. **Note:** this uses the estimated future total supply for the year 2050. 
      * @summary Get total STX supply in plain text format
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
@@ -174,13 +174,13 @@ export interface InfoApiInterface {
     getStxSupplyTotalSupplyPlainRaw(initOverrides?: RequestInit): Promise<runtime.ApiResponse<string>>;
 
     /**
-     * Retrieves the total supply for STX tokens as plain text.
+     * Retrieves the total supply for STX tokens as plain text. **Note:** this uses the estimated future total supply for the year 2050. 
      * 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.
+     * Retrieves total supply of STX tokens including those currently in circulation that have been unlocked. **Note:** this uses the estimated future total supply for the year 2050. 
      * @summary Get total and unlocked STX supply (results formatted the same as the legacy 1.0 API)
      * @param {number} [height] Supply details are queried from specified block height. If the block height is not specified, the latest block height is taken as default value.
      * @param {*} [options] Override http request option.
@@ -190,7 +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.
+     * Retrieves total supply of STX tokens including those currently in circulation that have been unlocked. **Note:** this uses the estimated future total supply for the year 2050. 
      * Get total and unlocked STX supply (results formatted the same as the legacy 1.0 API)
      */
     getTotalStxSupplyLegacyFormat(requestParameters: GetTotalStxSupplyLegacyFormatRequest, initOverrides?: RequestInit): Promise<GetStxSupplyLegacyFormatResponse>;
@@ -347,7 +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).
+     * Retrieves the total and unlocked STX supply. More information on Stacking can be found [here] (https://docs.stacks.co/understand-stacks/stacking). **Note:** This uses the estimated future total supply for the year 2050. 
      * Get total and unlocked STX supply
      */
     async getStxSupplyRaw(requestParameters: GetStxSupplyRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<GetStxSupplyResponse>> {
@@ -370,7 +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).
+     * Retrieves the total and unlocked STX supply. More information on Stacking can be found [here] (https://docs.stacks.co/understand-stacks/stacking). **Note:** This uses the estimated future total supply for the year 2050. 
      * Get total and unlocked STX supply
      */
     async getStxSupply(requestParameters: GetStxSupplyRequest, initOverrides?: RequestInit): Promise<GetStxSupplyResponse> {
@@ -407,7 +407,7 @@ export class InfoApi extends runtime.BaseAPI implements InfoApiInterface {
     }
 
     /**
-     * Retrieves the total supply for STX tokens as plain text.
+     * Retrieves the total supply for STX tokens as plain text. **Note:** this uses the estimated future total supply for the year 2050. 
      * Get total STX supply in plain text format
      */
     async getStxSupplyTotalSupplyPlainRaw(initOverrides?: RequestInit): Promise<runtime.ApiResponse<string>> {
@@ -426,7 +426,7 @@ export class InfoApi extends runtime.BaseAPI implements InfoApiInterface {
     }
 
     /**
-     * Retrieves the total supply for STX tokens as plain text.
+     * Retrieves the total supply for STX tokens as plain text. **Note:** this uses the estimated future total supply for the year 2050. 
      * Get total STX supply in plain text format
      */
     async getStxSupplyTotalSupplyPlain(initOverrides?: RequestInit): Promise<string> {
@@ -435,7 +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.
+     * Retrieves total supply of STX tokens including those currently in circulation that have been unlocked. **Note:** this uses the estimated future total supply for the year 2050. 
      * 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>> {
@@ -458,7 +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.
+     * Retrieves total supply of STX tokens including those currently in circulation that have been unlocked. **Note:** this uses the estimated future total supply for the year 2050. 
      * Get total and unlocked STX supply (results formatted the same as the legacy 1.0 API)
      */
     async getTotalStxSupplyLegacyFormat(requestParameters: GetTotalStxSupplyLegacyFormatRequest, initOverrides?: RequestInit): Promise<GetStxSupplyLegacyFormatResponse> {