@stacks/blockchain-api-client 7.4.0-nakamoto.4 → 7.4.0-nakamoto.6

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stacks/blockchain-api-client",
-  "version": "7.4.0-nakamoto.4",
+  "version": "7.4.0-nakamoto.6",
   "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/BlocksApi.ts

@@ -21,14 +21,24 @@ import {
     BlockListResponse,
     BlockListResponseFromJSON,
     BlockListResponseToJSON,
+    BurnBlock,
+    BurnBlockFromJSON,
+    BurnBlockToJSON,
     BurnBlockListResponse,
     BurnBlockListResponseFromJSON,
     BurnBlockListResponseToJSON,
+    NakamotoBlock,
+    NakamotoBlockFromJSON,
+    NakamotoBlockToJSON,
     NakamotoBlockListResponse,
     NakamotoBlockListResponseFromJSON,
     NakamotoBlockListResponseToJSON,
 } from '../models';
 
+export interface GetBlockRequest {
+    heightOrHash: number | string;
+}
+
 export interface GetBlockByBurnBlockHashRequest {
     burnBlockHash: string;
 }
@@ -57,11 +67,13 @@ export interface GetBlocksRequest {
     burnBlockHeight?: number;
 }
 
-export interface GetBurnBlockListRequest {
+export interface GetBurnBlockRequest {
+    heightOrHash: number | string;
+}
+
+export interface GetBurnBlocksRequest {
     limit?: number;
     offset?: number;
-    height?: number;
-    hash?: string;
 }
 
 /**
@@ -71,6 +83,22 @@ export interface GetBurnBlockListRequest {
  * @interface BlocksApiInterface
  */
 export interface BlocksApiInterface {
+    /**
+     * Retrieves a single block 
+     * @summary Get block
+     * @param {number | string} heightOrHash filter by block height, hash, index block hash or the constant `latest` to filter for the most recent block
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof BlocksApiInterface
+     */
+    getBlockRaw(requestParameters: GetBlockRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<NakamotoBlock>>;
+
+    /**
+     * Retrieves a single block 
+     * Get block
+     */
+    getBlock(requestParameters: GetBlockRequest, initOverrides?: RequestInit): Promise<NakamotoBlock>;
+
     /**
      * **NOTE:** This endpoint is deprecated in favor of [Get blocks](#operation/get_blocks).  Retrieves block details of a specific block for a given burnchain block hash 
      * @summary Get block by burnchain block hash
@@ -104,7 +132,7 @@ export interface BlocksApiInterface {
     getBlockByBurnBlockHeight(requestParameters: GetBlockByBurnBlockHeightRequest, initOverrides?: RequestInit): Promise<Block>;
 
     /**
-     * Retrieves block details of a specific block for a given chain height. You can use the hash from your latest block (\'get_block_list\' API) to get your block details.
+     * **NOTE:** This endpoint is deprecated in favor of [Get block](#operation/get_block).  Retrieves block details of a specific block for a given chain height. You can use the hash from your latest block (\'get_block_list\' API) to get your block details. 
      * @summary Get block by hash
      * @param {string} hash Hash of the block
      * @param {*} [options] Override http request option.
@@ -114,13 +142,13 @@ export interface BlocksApiInterface {
     getBlockByHashRaw(requestParameters: GetBlockByHashRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<Block>>;
 
     /**
-     * Retrieves block details of a specific block for a given chain height. You can use the hash from your latest block (\'get_block_list\' API) to get your block details.
+     * **NOTE:** This endpoint is deprecated in favor of [Get block](#operation/get_block).  Retrieves block details of a specific block for a given chain height. You can use the hash from your latest block (\'get_block_list\' API) to get your block details. 
      * Get block by hash
      */
     getBlockByHash(requestParameters: GetBlockByHashRequest, initOverrides?: RequestInit): Promise<Block>;
 
     /**
-     * Retrieves block details of a specific block at a given block height
+     * **NOTE:** This endpoint is deprecated in favor of [Get block](#operation/get_block).  Retrieves block details of a specific block at a given block height 
      * @summary Get block by height
      * @param {number} height Height of the block
      * @param {*} [options] Override http request option.
@@ -130,7 +158,7 @@ export interface BlocksApiInterface {
     getBlockByHeightRaw(requestParameters: GetBlockByHeightRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<Block>>;
 
     /**
-     * Retrieves block details of a specific block at a given block height
+     * **NOTE:** This endpoint is deprecated in favor of [Get block](#operation/get_block).  Retrieves block details of a specific block at a given block height 
      * Get block by height
      */
     getBlockByHeight(requestParameters: GetBlockByHeightRequest, initOverrides?: RequestInit): Promise<Block>;
@@ -171,24 +199,38 @@ export interface BlocksApiInterface {
      */
     getBlocks(requestParameters: GetBlocksRequest, initOverrides?: RequestInit): Promise<NakamotoBlockListResponse>;
 
+    /**
+     * Retrieves a single burn block
+     * @summary Get burn block
+     * @param {number | string} heightOrHash filter by burn block height, hash, or the constant &#x60;latest&#x60; to filter for the most recent burn block
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof BlocksApiInterface
+     */
+    getBurnBlockRaw(requestParameters: GetBurnBlockRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<BurnBlock>>;
+
+    /**
+     * Retrieves a single burn block
+     * Get burn block
+     */
+    getBurnBlock(requestParameters: GetBurnBlockRequest, initOverrides?: RequestInit): Promise<BurnBlock>;
+
     /**
      * Retrieves a list of recent burn blocks 
-     * @summary Get recent burn blocks
+     * @summary Get burn blocks
      * @param {number} [limit] max number of burn blocks to fetch
      * @param {number} [offset] index of first burn block to fetch
-     * @param {number} [height] filter by burn block height
-     * @param {string} [hash] filter by burn block hash or the constant \&#39;latest\&#39; to filter for the most recent burn block
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof BlocksApiInterface
      */
-    getBurnBlockListRaw(requestParameters: GetBurnBlockListRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<BurnBlockListResponse>>;
+    getBurnBlocksRaw(requestParameters: GetBurnBlocksRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<BurnBlockListResponse>>;
 
     /**
      * Retrieves a list of recent burn blocks 
-     * Get recent burn blocks
+     * Get burn blocks
      */
-    getBurnBlockList(requestParameters: GetBurnBlockListRequest, initOverrides?: RequestInit): Promise<BurnBlockListResponse>;
+    getBurnBlocks(requestParameters: GetBurnBlocksRequest, initOverrides?: RequestInit): Promise<BurnBlockListResponse>;
 
 }
 
@@ -197,6 +239,38 @@ export interface BlocksApiInterface {
  */
 export class BlocksApi extends runtime.BaseAPI implements BlocksApiInterface {
 
+    /**
+     * Retrieves a single block 
+     * Get block
+     */
+    async getBlockRaw(requestParameters: GetBlockRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<NakamotoBlock>> {
+        if (requestParameters.heightOrHash === null || requestParameters.heightOrHash === undefined) {
+            throw new runtime.RequiredError('heightOrHash','Required parameter requestParameters.heightOrHash was null or undefined when calling getBlock.');
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        const response = await this.request({
+            path: `/extended/v2/blocks/{height_or_hash}`.replace(`{${"height_or_hash"}}`, encodeURIComponent(String(requestParameters.heightOrHash))),
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => NakamotoBlockFromJSON(jsonValue));
+    }
+
+    /**
+     * Retrieves a single block 
+     * Get block
+     */
+    async getBlock(requestParameters: GetBlockRequest, initOverrides?: RequestInit): Promise<NakamotoBlock> {
+        const response = await this.getBlockRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
     /**
      * **NOTE:** This endpoint is deprecated in favor of [Get blocks](#operation/get_blocks).  Retrieves block details of a specific block for a given burnchain block hash 
      * Get block by burnchain block hash
@@ -262,7 +336,7 @@ export class BlocksApi extends runtime.BaseAPI implements BlocksApiInterface {
     }
 
     /**
-     * Retrieves block details of a specific block for a given chain height. You can use the hash from your latest block (\'get_block_list\' API) to get your block details.
+     * **NOTE:** This endpoint is deprecated in favor of [Get block](#operation/get_block).  Retrieves block details of a specific block for a given chain height. You can use the hash from your latest block (\'get_block_list\' API) to get your block details. 
      * Get block by hash
      */
     async getBlockByHashRaw(requestParameters: GetBlockByHashRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<Block>> {
@@ -285,7 +359,7 @@ export class BlocksApi extends runtime.BaseAPI implements BlocksApiInterface {
     }
 
     /**
-     * Retrieves block details of a specific block for a given chain height. You can use the hash from your latest block (\'get_block_list\' API) to get your block details.
+     * **NOTE:** This endpoint is deprecated in favor of [Get block](#operation/get_block).  Retrieves block details of a specific block for a given chain height. You can use the hash from your latest block (\'get_block_list\' API) to get your block details. 
      * Get block by hash
      */
     async getBlockByHash(requestParameters: GetBlockByHashRequest, initOverrides?: RequestInit): Promise<Block> {
@@ -294,7 +368,7 @@ export class BlocksApi extends runtime.BaseAPI implements BlocksApiInterface {
     }
 
     /**
-     * Retrieves block details of a specific block at a given block height
+     * **NOTE:** This endpoint is deprecated in favor of [Get block](#operation/get_block).  Retrieves block details of a specific block at a given block height 
      * Get block by height
      */
     async getBlockByHeightRaw(requestParameters: GetBlockByHeightRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<Block>> {
@@ -317,7 +391,7 @@ export class BlocksApi extends runtime.BaseAPI implements BlocksApiInterface {
     }
 
     /**
-     * Retrieves block details of a specific block at a given block height
+     * **NOTE:** This endpoint is deprecated in favor of [Get block](#operation/get_block).  Retrieves block details of a specific block at a given block height 
      * Get block by height
      */
     async getBlockByHeight(requestParameters: GetBlockByHeightRequest, initOverrides?: RequestInit): Promise<Block> {
@@ -405,11 +479,43 @@ export class BlocksApi extends runtime.BaseAPI implements BlocksApiInterface {
         return await response.value();
     }
 
+    /**
+     * Retrieves a single burn block
+     * Get burn block
+     */
+    async getBurnBlockRaw(requestParameters: GetBurnBlockRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<BurnBlock>> {
+        if (requestParameters.heightOrHash === null || requestParameters.heightOrHash === undefined) {
+            throw new runtime.RequiredError('heightOrHash','Required parameter requestParameters.heightOrHash was null or undefined when calling getBurnBlock.');
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        const response = await this.request({
+            path: `/extended/v2/burn-blocks/{height_or_hash}`.replace(`{${"height_or_hash"}}`, encodeURIComponent(String(requestParameters.heightOrHash))),
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => BurnBlockFromJSON(jsonValue));
+    }
+
+    /**
+     * Retrieves a single burn block
+     * Get burn block
+     */
+    async getBurnBlock(requestParameters: GetBurnBlockRequest, initOverrides?: RequestInit): Promise<BurnBlock> {
+        const response = await this.getBurnBlockRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
     /**
      * Retrieves a list of recent burn blocks 
-     * Get recent burn blocks
+     * Get burn blocks
      */
-    async getBurnBlockListRaw(requestParameters: GetBurnBlockListRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<BurnBlockListResponse>> {
+    async getBurnBlocksRaw(requestParameters: GetBurnBlocksRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<BurnBlockListResponse>> {
         const queryParameters: any = {};
 
         if (requestParameters.limit !== undefined) {
@@ -420,18 +526,10 @@ export class BlocksApi extends runtime.BaseAPI implements BlocksApiInterface {
             queryParameters['offset'] = requestParameters.offset;
         }
 
-        if (requestParameters.height !== undefined) {
-            queryParameters['height'] = requestParameters.height;
-        }
-
-        if (requestParameters.hash !== undefined) {
-            queryParameters['hash'] = requestParameters.hash;
-        }
-
         const headerParameters: runtime.HTTPHeaders = {};
 
         const response = await this.request({
-            path: `/extended/v1/burn_block`,
+            path: `/extended/v2/burn-blocks`,
             method: 'GET',
             headers: headerParameters,
             query: queryParameters,
@@ -442,10 +540,10 @@ export class BlocksApi extends runtime.BaseAPI implements BlocksApiInterface {
 
     /**
      * Retrieves a list of recent burn blocks 
-     * Get recent burn blocks
+     * Get burn blocks
      */
-    async getBurnBlockList(requestParameters: GetBurnBlockListRequest, initOverrides?: RequestInit): Promise<BurnBlockListResponse> {
-        const response = await this.getBurnBlockListRaw(requestParameters, initOverrides);
+    async getBurnBlocks(requestParameters: GetBurnBlocksRequest, initOverrides?: RequestInit): Promise<BurnBlockListResponse> {
+        const response = await this.getBurnBlocksRaw(requestParameters, initOverrides);
         return await response.value();
     }