@stacks/blockchain-api-client 0.71.1 → 1.0.3

package/lib/generated/apis/MicroblocksApi.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
  *
@@ -26,7 +26,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.
@@ -35,12 +35,12 @@ 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
@@ -50,11 +50,12 @@ 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}
@@ -62,7 +63,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>;
@@ -72,30 +73,32 @@ export interface MicroblocksApiInterface {
  */
 export declare class MicroblocksApi extends runtime.BaseAPI implements MicroblocksApiInterface {
     /**
-     * Get a specific microblock by hash
+     * Retrieves a specific microblock by `hash`
      * Get microblock
      */
     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.
      * Get recent microblocks
      */
     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
      * Get the list of current transactions that belong to unanchored microblocks
      */
     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>;

package/lib/generated/apis/MicroblocksApi.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
  *
@@ -21,7 +21,7 @@ const models_1 = require("../models");
  */
 class MicroblocksApi extends runtime.BaseAPI {
     /**
-     * Get a specific microblock by hash
+     * Retrieves a specific microblock by `hash`
      * Get microblock
      */
     async getMicroblockByHashRaw(requestParameters, initOverrides) {
@@ -39,7 +39,7 @@ class MicroblocksApi extends runtime.BaseAPI {
         return new runtime.JSONApiResponse(response, (jsonValue) => models_1.MicroblockFromJSON(jsonValue));
     }
     /**
-     * Get a specific microblock by hash
+     * Retrieves a specific microblock by `hash`
      * Get microblock
      */
     async getMicroblockByHash(requestParameters, initOverrides) {
@@ -47,6 +47,7 @@ class MicroblocksApi extends runtime.BaseAPI {
         return await response.value();
     }
     /**
+     * Retrieves a list of microblocks.
      * Get recent microblocks
      */
     async getMicroblockListRaw(requestParameters, initOverrides) {
@@ -67,6 +68,7 @@ class MicroblocksApi extends runtime.BaseAPI {
         return new runtime.JSONApiResponse(response, (jsonValue) => models_1.MicroblockListResponseFromJSON(jsonValue));
     }
     /**
+     * Retrieves a list of microblocks.
      * Get recent microblocks
      */
     async getMicroblockList(requestParameters, initOverrides) {
@@ -74,7 +76,7 @@ class MicroblocksApi extends runtime.BaseAPI {
         return await response.value();
     }
     /**
-     * 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) {
@@ -89,7 +91,7 @@ class MicroblocksApi extends runtime.BaseAPI {
         return new runtime.JSONApiResponse(response, (jsonValue) => models_1.UnanchoredTransactionListResponseFromJSON(jsonValue));
     }
     /**
-     * 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) {

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

@@ -1 +1 @@
-{"version":3,"file":"MicroblocksApi.js","sourceRoot":"","sources":["../../../src/generated/apis/MicroblocksApi.ts"],"names":[],"mappings":";AAAA,oBAAoB;AACpB,oBAAoB;AACpB;;;;;;;;;;GAUG;;;AAGH,sCAAsC;AACtC,sCAUmB;AAmEnB;;GAEG;AACH,MAAa,cAAe,SAAQ,OAAO,CAAC,OAAO;IAE/C;;;OAGG;IACH,KAAK,CAAC,sBAAsB,CAAC,iBAA6C,EAAE,aAA2B;QACnG,IAAI,iBAAiB,CAAC,IAAI,KAAK,IAAI,IAAI,iBAAiB,CAAC,IAAI,KAAK,SAAS,EAAE;YACzE,MAAM,IAAI,OAAO,CAAC,aAAa,CAAC,MAAM,EAAC,mGAAmG,CAAC,CAAC;SAC/I;QAED,MAAM,eAAe,GAAQ,EAAE,CAAC;QAEhC,MAAM,gBAAgB,GAAwB,EAAE,CAAC;QAEjD,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC;YAChC,IAAI,EAAE,gCAAgC,CAAC,OAAO,CAAC,IAAI,MAAM,GAAG,EAAE,kBAAkB,CAAC,MAAM,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAC,CAAC;YACjH,MAAM,EAAE,KAAK;YACb,OAAO,EAAE,gBAAgB;YACzB,KAAK,EAAE,eAAe;SACzB,EAAE,aAAa,CAAC,CAAC;QAElB,OAAO,IAAI,OAAO,CAAC,eAAe,CAAC,QAAQ,EAAE,CAAC,SAAS,EAAE,EAAE,CAAC,2BAAkB,CAAC,SAAS,CAAC,CAAC,CAAC;IAC/F,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,mBAAmB,CAAC,iBAA6C,EAAE,aAA2B;QAChG,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,sBAAsB,CAAC,iBAAiB,EAAE,aAAa,CAAC,CAAC;QACrF,OAAO,MAAM,QAAQ,CAAC,KAAK,EAAE,CAAC;IAClC,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,oBAAoB,CAAC,iBAA2C,EAAE,aAA2B;QAC/F,MAAM,eAAe,GAAQ,EAAE,CAAC;QAEhC,IAAI,iBAAiB,CAAC,KAAK,KAAK,SAAS,EAAE;YACvC,eAAe,CAAC,OAAO,CAAC,GAAG,iBAAiB,CAAC,KAAK,CAAC;SACtD;QAED,IAAI,iBAAiB,CAAC,MAAM,KAAK,SAAS,EAAE;YACxC,eAAe,CAAC,QAAQ,CAAC,GAAG,iBAAiB,CAAC,MAAM,CAAC;SACxD;QAED,MAAM,gBAAgB,GAAwB,EAAE,CAAC;QAEjD,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC;YAChC,IAAI,EAAE,yBAAyB;YAC/B,MAAM,EAAE,KAAK;YACb,OAAO,EAAE,gBAAgB;YACzB,KAAK,EAAE,eAAe;SACzB,EAAE,aAAa,CAAC,CAAC;QAElB,OAAO,IAAI,OAAO,CAAC,eAAe,CAAC,QAAQ,EAAE,CAAC,SAAS,EAAE,EAAE,CAAC,uCAA8B,CAAC,SAAS,CAAC,CAAC,CAAC;IAC3G,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,iBAAiB,CAAC,iBAA2C,EAAE,aAA2B;QAC5F,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,oBAAoB,CAAC,iBAAiB,EAAE,aAAa,CAAC,CAAC;QACnF,OAAO,MAAM,QAAQ,CAAC,KAAK,EAAE,CAAC;IAClC,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,mBAAmB,CAAC,aAA2B;QACjD,MAAM,eAAe,GAAQ,EAAE,CAAC;QAEhC,MAAM,gBAAgB,GAAwB,EAAE,CAAC;QAEjD,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC;YAChC,IAAI,EAAE,wCAAwC;YAC9C,MAAM,EAAE,KAAK;YACb,OAAO,EAAE,gBAAgB;YACzB,KAAK,EAAE,eAAe;SACzB,EAAE,aAAa,CAAC,CAAC;QAElB,OAAO,IAAI,OAAO,CAAC,eAAe,CAAC,QAAQ,EAAE,CAAC,SAAS,EAAE,EAAE,CAAC,kDAAyC,CAAC,SAAS,CAAC,CAAC,CAAC;IACtH,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,gBAAgB,CAAC,aAA2B;QAC9C,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,mBAAmB,CAAC,aAAa,CAAC,CAAC;QAC/D,OAAO,MAAM,QAAQ,CAAC,KAAK,EAAE,CAAC;IAClC,CAAC;CAEJ;AAhGD,wCAgGC"}
+{"version":3,"file":"MicroblocksApi.js","sourceRoot":"","sources":["../../../src/generated/apis/MicroblocksApi.ts"],"names":[],"mappings":";AAAA,oBAAoB;AACpB,oBAAoB;AACpB;;;;;;;;;;GAUG;;;AAGH,sCAAsC;AACtC,sCAUmB;AAoEnB;;GAEG;AACH,MAAa,cAAe,SAAQ,OAAO,CAAC,OAAO;IAE/C;;;OAGG;IACH,KAAK,CAAC,sBAAsB,CAAC,iBAA6C,EAAE,aAA2B;QACnG,IAAI,iBAAiB,CAAC,IAAI,KAAK,IAAI,IAAI,iBAAiB,CAAC,IAAI,KAAK,SAAS,EAAE;YACzE,MAAM,IAAI,OAAO,CAAC,aAAa,CAAC,MAAM,EAAC,mGAAmG,CAAC,CAAC;SAC/I;QAED,MAAM,eAAe,GAAQ,EAAE,CAAC;QAEhC,MAAM,gBAAgB,GAAwB,EAAE,CAAC;QAEjD,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC;YAChC,IAAI,EAAE,gCAAgC,CAAC,OAAO,CAAC,IAAI,MAAM,GAAG,EAAE,kBAAkB,CAAC,MAAM,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAC,CAAC;YACjH,MAAM,EAAE,KAAK;YACb,OAAO,EAAE,gBAAgB;YACzB,KAAK,EAAE,eAAe;SACzB,EAAE,aAAa,CAAC,CAAC;QAElB,OAAO,IAAI,OAAO,CAAC,eAAe,CAAC,QAAQ,EAAE,CAAC,SAAS,EAAE,EAAE,CAAC,2BAAkB,CAAC,SAAS,CAAC,CAAC,CAAC;IAC/F,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,mBAAmB,CAAC,iBAA6C,EAAE,aAA2B;QAChG,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,sBAAsB,CAAC,iBAAiB,EAAE,aAAa,CAAC,CAAC;QACrF,OAAO,MAAM,QAAQ,CAAC,KAAK,EAAE,CAAC;IAClC,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,oBAAoB,CAAC,iBAA2C,EAAE,aAA2B;QAC/F,MAAM,eAAe,GAAQ,EAAE,CAAC;QAEhC,IAAI,iBAAiB,CAAC,KAAK,KAAK,SAAS,EAAE;YACvC,eAAe,CAAC,OAAO,CAAC,GAAG,iBAAiB,CAAC,KAAK,CAAC;SACtD;QAED,IAAI,iBAAiB,CAAC,MAAM,KAAK,SAAS,EAAE;YACxC,eAAe,CAAC,QAAQ,CAAC,GAAG,iBAAiB,CAAC,MAAM,CAAC;SACxD;QAED,MAAM,gBAAgB,GAAwB,EAAE,CAAC;QAEjD,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC;YAChC,IAAI,EAAE,yBAAyB;YAC/B,MAAM,EAAE,KAAK;YACb,OAAO,EAAE,gBAAgB;YACzB,KAAK,EAAE,eAAe;SACzB,EAAE,aAAa,CAAC,CAAC;QAElB,OAAO,IAAI,OAAO,CAAC,eAAe,CAAC,QAAQ,EAAE,CAAC,SAAS,EAAE,EAAE,CAAC,uCAA8B,CAAC,SAAS,CAAC,CAAC,CAAC;IAC3G,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,iBAAiB,CAAC,iBAA2C,EAAE,aAA2B;QAC5F,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,oBAAoB,CAAC,iBAAiB,EAAE,aAAa,CAAC,CAAC;QACnF,OAAO,MAAM,QAAQ,CAAC,KAAK,EAAE,CAAC;IAClC,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,mBAAmB,CAAC,aAA2B;QACjD,MAAM,eAAe,GAAQ,EAAE,CAAC;QAEhC,MAAM,gBAAgB,GAAwB,EAAE,CAAC;QAEjD,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC;YAChC,IAAI,EAAE,wCAAwC;YAC9C,MAAM,EAAE,KAAK;YACb,OAAO,EAAE,gBAAgB;YACzB,KAAK,EAAE,eAAe;SACzB,EAAE,aAAa,CAAC,CAAC;QAElB,OAAO,IAAI,OAAO,CAAC,eAAe,CAAC,QAAQ,EAAE,CAAC,SAAS,EAAE,EAAE,CAAC,kDAAyC,CAAC,SAAS,CAAC,CAAC,CAAC;IACtH,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,gBAAgB,CAAC,aAA2B;QAC9C,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,mBAAmB,CAAC,aAAa,CAAC,CAAC;QAC/D,OAAO,MAAM,QAAQ,CAAC,KAAK,EAAE,CAAC;IAClC,CAAC;CAEJ;AAlGD,wCAkGC"}

package/lib/generated/apis/{BNSApi.d.ts → NamesApi.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
  *
@@ -49,121 +49,122 @@ export interface GetSubdomainAtTransactionRequest {
     txid: string;
 }
 /**
- * BNSApi - interface
+ * NamesApi - interface
  *
  * @export
- * @interface BNSApiInterface
+ * @interface NamesApiInterface
  */
-export interface BNSApiInterface {
+export interface NamesApiInterface {
     /**
-     * Fetch a user’s raw zone file. This only works for RFC-compliant zone files. This method returns an error for names that have non-standard zone files.
-     * @summary Fetch Zone File
+     * Retrieves a user’s raw zone file. This only works for RFC-compliant zone files. This method returns an error for names that have non-standard zone files.
+     * @summary Get Zone File
      * @param {string} name fully-qualified name
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
-     * @memberof BNSApiInterface
+     * @memberof NamesApiInterface
      */
     fetchZoneFileRaw(requestParameters: FetchZoneFileRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<object>>;
     /**
-     * Fetch a user’s raw zone file. This only works for RFC-compliant zone files. This method returns an error for names that have non-standard zone files.
-     * Fetch Zone File
+     * Retrieves a user’s raw zone file. This only works for RFC-compliant zone files. This method returns an error for names that have non-standard zone files.
+     * Get Zone File
      */
     fetchZoneFile(requestParameters: FetchZoneFileRequest, initOverrides?: RequestInit): Promise<object>;
     /**
-     * Fetch a list of all names known to the node.
+     * Retrieves a list of all names known to the node.
      * @summary Get All Names
      * @param {number} page names are returned in pages of size 100, so specify the page number.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
-     * @memberof BNSApiInterface
+     * @memberof NamesApiInterface
      */
     getAllNamesRaw(requestParameters: GetAllNamesRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<Array<string>>>;
     /**
-     * Fetch a list of all names known to the node.
+     * Retrieves a list of all names known to the node.
      * Get All Names
      */
     getAllNames(requestParameters: GetAllNamesRequest, initOverrides?: RequestInit): Promise<Array<string>>;
     /**
-     * Fetch a list of all namespaces known to the node.
+     * Retrieves a list of all namespaces known to the node.
      * @summary Get All Namespaces
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
-     * @memberof BNSApiInterface
+     * @memberof NamesApiInterface
      */
     getAllNamespacesRaw(initOverrides?: RequestInit): Promise<runtime.ApiResponse<BnsGetAllNamespacesResponse>>;
     /**
-     * Fetch a list of all namespaces known to the node.
+     * Retrieves a list of all namespaces known to the node.
      * Get All Namespaces
      */
     getAllNamespaces(initOverrides?: RequestInit): Promise<BnsGetAllNamespacesResponse>;
     /**
-     * Fetch a list of all subdomains known to the node.
+     * Retrieves a list of all subdomains known to the node.
      * @summary Get All Subdomains
      * @param {number} page names are returned in pages of size 100, so specify the page number.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
-     * @memberof BNSApiInterface
+     * @memberof NamesApiInterface
      */
     getAllSubdomainsRaw(requestParameters: GetAllSubdomainsRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<Array<string>>>;
     /**
-     * Fetch a list of all subdomains known to the node.
+     * Retrieves a list of all subdomains known to the node.
      * Get All Subdomains
      */
     getAllSubdomains(requestParameters: GetAllSubdomainsRequest, initOverrides?: RequestInit): Promise<Array<string>>;
     /**
-     * Fetches the historical zonefile specified by the username and zone hash.
+     * Retrieves the historical zonefile specified by the username and zone hash.
      * @summary Get Historical Zone File
      * @param {string} name fully-qualified name
      * @param {string} zoneFileHash zone file hash
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
-     * @memberof BNSApiInterface
+     * @memberof NamesApiInterface
      */
     getHistoricalZoneFileRaw(requestParameters: GetHistoricalZoneFileRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<object>>;
     /**
-     * Fetches the historical zonefile specified by the username and zone hash.
+     * Retrieves the historical zonefile specified by the username and zone hash.
      * Get Historical Zone File
      */
     getHistoricalZoneFile(requestParameters: GetHistoricalZoneFileRequest, initOverrides?: RequestInit): Promise<object>;
     /**
-     * Get a history of all blockchain records of a registered name.
+     * Retrieves a history of all blockchain records of a registered name.
      * @summary Get Name History
      * @param {string} name name to query
      * @param {number} page the page (in 20-entry pages) of the history to fetch
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
-     * @memberof BNSApiInterface
+     * @memberof NamesApiInterface
      */
     getNameHistoryRaw(requestParameters: GetNameHistoryRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<object>>;
     /**
-     * Get a history of all blockchain records of a registered name.
+     * Retrieves a history of all blockchain records of a registered name.
      * Get Name History
      */
     getNameHistory(requestParameters: GetNameHistoryRequest, initOverrides?: RequestInit): Promise<object>;
     /**
-     *
+     * Retrieves details of a given name including the `address`, `status` and last transaction id - `last_txid`.
      * @summary Get Name Details
      * @param {string} name fully-qualified name
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
-     * @memberof BNSApiInterface
+     * @memberof NamesApiInterface
      */
     getNameInfoRaw(requestParameters: GetNameInfoRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<BnsGetNameInfoResponse>>;
     /**
+     * Retrieves details of a given name including the `address`, `status` and last transaction id - `last_txid`.
      * Get Name Details
      */
     getNameInfo(requestParameters: GetNameInfoRequest, initOverrides?: RequestInit): Promise<BnsGetNameInfoResponse>;
     /**
-     * Get the price of a name. The `amount` given will be in the smallest possible units of the currency.
+     * Retrieves the price of a name. The `amount` given will be in the smallest possible units of the currency.
      * @summary Get Name Price
      * @param {string} name the name to query price information for
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
-     * @memberof BNSApiInterface
+     * @memberof NamesApiInterface
      */
     getNamePriceRaw(requestParameters: GetNamePriceRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<BnsGetNamePriceResponse>>;
     /**
-     * Get the price of a name. The `amount` given will be in the smallest possible units of the currency.
+     * Retrieves the price of a name. The `amount` given will be in the smallest possible units of the currency.
      * Get Name Price
      */
     getNamePrice(requestParameters: GetNamePriceRequest, initOverrides?: RequestInit): Promise<BnsGetNamePriceResponse>;
@@ -174,7 +175,7 @@ export interface BNSApiInterface {
      * @param {string} address the address to lookup
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
-     * @memberof BNSApiInterface
+     * @memberof NamesApiInterface
      */
     getNamesOwnedByAddressRaw(requestParameters: GetNamesOwnedByAddressRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<BnsNamesOwnByAddressResponse>>;
     /**
@@ -183,45 +184,45 @@ export interface BNSApiInterface {
      */
     getNamesOwnedByAddress(requestParameters: GetNamesOwnedByAddressRequest, initOverrides?: RequestInit): Promise<BnsNamesOwnByAddressResponse>;
     /**
-     * Fetch a list of names from the namespace.
+     * Retrieves a list of names within a given namespace.
      * @summary Get Namespace Names
      * @param {string} tld the namespace to fetch names from
      * @param {number} page names are returned in pages of size 100, so specify the page number.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
-     * @memberof BNSApiInterface
+     * @memberof NamesApiInterface
      */
     getNamespaceNamesRaw(requestParameters: GetNamespaceNamesRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<Array<string>>>;
     /**
-     * Fetch a list of names from the namespace.
+     * Retrieves a list of names within a given namespace.
      * Get Namespace Names
      */
     getNamespaceNames(requestParameters: GetNamespaceNamesRequest, initOverrides?: RequestInit): Promise<Array<string>>;
     /**
-     * Get the price of a namespace. The `amount` given will be in the smallest possible units of the currency.
+     * Retrieves the price of a namespace. The `amount` given will be in the smallest possible units of the currency.
      * @summary Get Namespace Price
      * @param {string} tld the namespace to fetch price for
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
-     * @memberof BNSApiInterface
+     * @memberof NamesApiInterface
      */
     getNamespacePriceRaw(requestParameters: GetNamespacePriceRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<BnsGetNamespacePriceResponse>>;
     /**
-     * Get the price of a namespace. The `amount` given will be in the smallest possible units of the currency.
+     * Retrieves the price of a namespace. The `amount` given will be in the smallest possible units of the currency.
      * Get Namespace Price
      */
     getNamespacePrice(requestParameters: GetNamespacePriceRequest, initOverrides?: RequestInit): Promise<BnsGetNamespacePriceResponse>;
     /**
-     * Fetches the list of subdomain operations processed by a given transaction. The returned array includes subdomain operations that have not yet been accepted as part of any subdomain’s history (checkable via the accepted field). If the given transaction ID does not correspond to a Blockstack transaction that introduced new subdomain operations, and empty array will be returned.
+     * Retrieves the list of subdomain operations processed by a given transaction. The returned array includes subdomain operations that have not yet been accepted as part of any subdomain’s history (checkable via the accepted field). If the given transaction ID does not correspond to a Stacks transaction that introduced new subdomain operations, and empty array will be returned.
      * @summary Get Subdomain at Transaction
      * @param {string} txid transaction id
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
-     * @memberof BNSApiInterface
+     * @memberof NamesApiInterface
      */
     getSubdomainAtTransactionRaw(requestParameters: GetSubdomainAtTransactionRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<Array<InlineResponse200>>>;
     /**
-     * Fetches the list of subdomain operations processed by a given transaction. The returned array includes subdomain operations that have not yet been accepted as part of any subdomain’s history (checkable via the accepted field). If the given transaction ID does not correspond to a Blockstack transaction that introduced new subdomain operations, and empty array will be returned.
+     * Retrieves the list of subdomain operations processed by a given transaction. The returned array includes subdomain operations that have not yet been accepted as part of any subdomain’s history (checkable via the accepted field). If the given transaction ID does not correspond to a Stacks transaction that introduced new subdomain operations, and empty array will be returned.
      * Get Subdomain at Transaction
      */
     getSubdomainAtTransaction(requestParameters: GetSubdomainAtTransactionRequest, initOverrides?: RequestInit): Promise<Array<InlineResponse200>>;
@@ -229,82 +230,84 @@ export interface BNSApiInterface {
 /**
  *
  */
-export declare class BNSApi extends runtime.BaseAPI implements BNSApiInterface {
+export declare class NamesApi extends runtime.BaseAPI implements NamesApiInterface {
     /**
-     * Fetch a user’s raw zone file. This only works for RFC-compliant zone files. This method returns an error for names that have non-standard zone files.
-     * Fetch Zone File
+     * Retrieves a user’s raw zone file. This only works for RFC-compliant zone files. This method returns an error for names that have non-standard zone files.
+     * Get Zone File
      */
     fetchZoneFileRaw(requestParameters: FetchZoneFileRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<object>>;
     /**
-     * Fetch a user’s raw zone file. This only works for RFC-compliant zone files. This method returns an error for names that have non-standard zone files.
-     * Fetch Zone File
+     * Retrieves a user’s raw zone file. This only works for RFC-compliant zone files. This method returns an error for names that have non-standard zone files.
+     * Get Zone File
      */
     fetchZoneFile(requestParameters: FetchZoneFileRequest, initOverrides?: RequestInit): Promise<object>;
     /**
-     * Fetch a list of all names known to the node.
+     * Retrieves a list of all names known to the node.
      * Get All Names
      */
     getAllNamesRaw(requestParameters: GetAllNamesRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<Array<string>>>;
     /**
-     * Fetch a list of all names known to the node.
+     * Retrieves a list of all names known to the node.
      * Get All Names
      */
     getAllNames(requestParameters: GetAllNamesRequest, initOverrides?: RequestInit): Promise<Array<string>>;
     /**
-     * Fetch a list of all namespaces known to the node.
+     * Retrieves a list of all namespaces known to the node.
      * Get All Namespaces
      */
     getAllNamespacesRaw(initOverrides?: RequestInit): Promise<runtime.ApiResponse<BnsGetAllNamespacesResponse>>;
     /**
-     * Fetch a list of all namespaces known to the node.
+     * Retrieves a list of all namespaces known to the node.
      * Get All Namespaces
      */
     getAllNamespaces(initOverrides?: RequestInit): Promise<BnsGetAllNamespacesResponse>;
     /**
-     * Fetch a list of all subdomains known to the node.
+     * Retrieves a list of all subdomains known to the node.
      * Get All Subdomains
      */
     getAllSubdomainsRaw(requestParameters: GetAllSubdomainsRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<Array<string>>>;
     /**
-     * Fetch a list of all subdomains known to the node.
+     * Retrieves a list of all subdomains known to the node.
      * Get All Subdomains
      */
     getAllSubdomains(requestParameters: GetAllSubdomainsRequest, initOverrides?: RequestInit): Promise<Array<string>>;
     /**
-     * Fetches the historical zonefile specified by the username and zone hash.
+     * Retrieves the historical zonefile specified by the username and zone hash.
      * Get Historical Zone File
      */
     getHistoricalZoneFileRaw(requestParameters: GetHistoricalZoneFileRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<object>>;
     /**
-     * Fetches the historical zonefile specified by the username and zone hash.
+     * Retrieves the historical zonefile specified by the username and zone hash.
      * Get Historical Zone File
      */
     getHistoricalZoneFile(requestParameters: GetHistoricalZoneFileRequest, initOverrides?: RequestInit): Promise<object>;
     /**
-     * Get a history of all blockchain records of a registered name.
+     * Retrieves a history of all blockchain records of a registered name.
      * Get Name History
      */
     getNameHistoryRaw(requestParameters: GetNameHistoryRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<object>>;
     /**
-     * Get a history of all blockchain records of a registered name.
+     * Retrieves a history of all blockchain records of a registered name.
      * Get Name History
      */
     getNameHistory(requestParameters: GetNameHistoryRequest, initOverrides?: RequestInit): Promise<object>;
     /**
+     * Retrieves details of a given name including the `address`, `status` and last transaction id - `last_txid`.
      * Get Name Details
      */
     getNameInfoRaw(requestParameters: GetNameInfoRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<BnsGetNameInfoResponse>>;
     /**
+     * Retrieves details of a given name including the `address`, `status` and last transaction id - `last_txid`.
      * Get Name Details
      */
     getNameInfo(requestParameters: GetNameInfoRequest, initOverrides?: RequestInit): Promise<BnsGetNameInfoResponse>;
     /**
-     * Get the price of a name. The `amount` given will be in the smallest possible units of the currency.
+     * Retrieves the price of a name. The `amount` given will be in the smallest possible units of the currency.
      * Get Name Price
      */
     getNamePriceRaw(requestParameters: GetNamePriceRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<BnsGetNamePriceResponse>>;
     /**
-     * Get the price of a name. The `amount` given will be in the smallest possible units of the currency.
+     * Retrieves the price of a name. The `amount` given will be in the smallest possible units of the currency.
      * Get Name Price
      */
     getNamePrice(requestParameters: GetNamePriceRequest, initOverrides?: RequestInit): Promise<BnsGetNamePriceResponse>;
@@ -319,32 +322,32 @@ export declare class BNSApi extends runtime.BaseAPI implements BNSApiInterface {
      */
     getNamesOwnedByAddress(requestParameters: GetNamesOwnedByAddressRequest, initOverrides?: RequestInit): Promise<BnsNamesOwnByAddressResponse>;
     /**
-     * Fetch a list of names from the namespace.
+     * Retrieves a list of names within a given namespace.
      * Get Namespace Names
      */
     getNamespaceNamesRaw(requestParameters: GetNamespaceNamesRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<Array<string>>>;
     /**
-     * Fetch a list of names from the namespace.
+     * Retrieves a list of names within a given namespace.
      * Get Namespace Names
      */
     getNamespaceNames(requestParameters: GetNamespaceNamesRequest, initOverrides?: RequestInit): Promise<Array<string>>;
     /**
-     * Get the price of a namespace. The `amount` given will be in the smallest possible units of the currency.
+     * Retrieves the price of a namespace. The `amount` given will be in the smallest possible units of the currency.
      * Get Namespace Price
      */
     getNamespacePriceRaw(requestParameters: GetNamespacePriceRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<BnsGetNamespacePriceResponse>>;
     /**
-     * Get the price of a namespace. The `amount` given will be in the smallest possible units of the currency.
+     * Retrieves the price of a namespace. The `amount` given will be in the smallest possible units of the currency.
      * Get Namespace Price
      */
     getNamespacePrice(requestParameters: GetNamespacePriceRequest, initOverrides?: RequestInit): Promise<BnsGetNamespacePriceResponse>;
     /**
-     * Fetches the list of subdomain operations processed by a given transaction. The returned array includes subdomain operations that have not yet been accepted as part of any subdomain’s history (checkable via the accepted field). If the given transaction ID does not correspond to a Blockstack transaction that introduced new subdomain operations, and empty array will be returned.
+     * Retrieves the list of subdomain operations processed by a given transaction. The returned array includes subdomain operations that have not yet been accepted as part of any subdomain’s history (checkable via the accepted field). If the given transaction ID does not correspond to a Stacks transaction that introduced new subdomain operations, and empty array will be returned.
      * Get Subdomain at Transaction
      */
     getSubdomainAtTransactionRaw(requestParameters: GetSubdomainAtTransactionRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<Array<InlineResponse200>>>;
     /**
-     * Fetches the list of subdomain operations processed by a given transaction. The returned array includes subdomain operations that have not yet been accepted as part of any subdomain’s history (checkable via the accepted field). If the given transaction ID does not correspond to a Blockstack transaction that introduced new subdomain operations, and empty array will be returned.
+     * Retrieves the list of subdomain operations processed by a given transaction. The returned array includes subdomain operations that have not yet been accepted as part of any subdomain’s history (checkable via the accepted field). If the given transaction ID does not correspond to a Stacks transaction that introduced new subdomain operations, and empty array will be returned.
      * Get Subdomain at Transaction
      */
     getSubdomainAtTransaction(requestParameters: GetSubdomainAtTransactionRequest, initOverrides?: RequestInit): Promise<Array<InlineResponse200>>;