@stacks/blockchain-api-client 4.1.1 → 5.0.0-beta.2

package/lib/generated/apis/NonFungibleTokensApi.d.ts

@@ -50,7 +50,7 @@ export interface GetNftMintsRequest {
 export interface NonFungibleTokensApiInterface {
     /**
      * Retrieves metadata for non fungible tokens for a given contract id. More information on Non-Fungible Tokens on the Stacks blockchain can be found [here](https://docs.stacks.co/write-smart-contracts/tokens#non-fungible-tokens-nfts).
-     * @summary Non fungible tokens metadata for contract id
+     * @summary Non fungible tokens metadata for contract ID
      * @param {string} contractId token\'s contract id
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
@@ -59,7 +59,7 @@ export interface NonFungibleTokensApiInterface {
     getContractNftMetadataRaw(requestParameters: GetContractNftMetadataRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<NonFungibleTokenMetadata>>;
     /**
      * Retrieves metadata for non fungible tokens for a given contract id. More information on Non-Fungible Tokens on the Stacks blockchain can be found [here](https://docs.stacks.co/write-smart-contracts/tokens#non-fungible-tokens-nfts).
-     * Non fungible tokens metadata for contract id
+     * Non fungible tokens metadata for contract ID
      */
     getContractNftMetadata(requestParameters: GetContractNftMetadataRequest, initOverrides?: RequestInit): Promise<NonFungibleTokenMetadata>;
     /**
@@ -140,12 +140,12 @@ export interface NonFungibleTokensApiInterface {
 export declare class NonFungibleTokensApi extends runtime.BaseAPI implements NonFungibleTokensApiInterface {
     /**
      * Retrieves metadata for non fungible tokens for a given contract id. More information on Non-Fungible Tokens on the Stacks blockchain can be found [here](https://docs.stacks.co/write-smart-contracts/tokens#non-fungible-tokens-nfts).
-     * Non fungible tokens metadata for contract id
+     * Non fungible tokens metadata for contract ID
      */
     getContractNftMetadataRaw(requestParameters: GetContractNftMetadataRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<NonFungibleTokenMetadata>>;
     /**
      * Retrieves metadata for non fungible tokens for a given contract id. More information on Non-Fungible Tokens on the Stacks blockchain can be found [here](https://docs.stacks.co/write-smart-contracts/tokens#non-fungible-tokens-nfts).
-     * Non fungible tokens metadata for contract id
+     * Non fungible tokens metadata for contract ID
      */
     getContractNftMetadata(requestParameters: GetContractNftMetadataRequest, initOverrides?: RequestInit): Promise<NonFungibleTokenMetadata>;
     /**

package/lib/generated/apis/NonFungibleTokensApi.js

@@ -22,7 +22,7 @@ const models_1 = require("../models");
 class NonFungibleTokensApi extends runtime.BaseAPI {
     /**
      * Retrieves metadata for non fungible tokens for a given contract id. More information on Non-Fungible Tokens on the Stacks blockchain can be found [here](https://docs.stacks.co/write-smart-contracts/tokens#non-fungible-tokens-nfts).
-     * Non fungible tokens metadata for contract id
+     * Non fungible tokens metadata for contract ID
      */
     async getContractNftMetadataRaw(requestParameters, initOverrides) {
         if (requestParameters.contractId === null || requestParameters.contractId === undefined) {
@@ -40,7 +40,7 @@ class NonFungibleTokensApi extends runtime.BaseAPI {
     }
     /**
      * Retrieves metadata for non fungible tokens for a given contract id. More information on Non-Fungible Tokens on the Stacks blockchain can be found [here](https://docs.stacks.co/write-smart-contracts/tokens#non-fungible-tokens-nfts).
-     * Non fungible tokens metadata for contract id
+     * Non fungible tokens metadata for contract ID
      */
     async getContractNftMetadata(requestParameters, initOverrides) {
         const response = await this.getContractNftMetadataRaw(requestParameters, initOverrides);

package/lib/generated/apis/RosettaApi.d.ts

@@ -106,7 +106,7 @@ export interface RosettaApiInterface {
      */
     rosettaBlockTransaction(requestParameters: RosettaBlockTransactionOperationRequest, initOverrides?: RequestInit): Promise<RosettaBlockTransactionResponse>;
     /**
-     * Take unsigned transaction and signature, combine both and return signed transaction
+     * Take unsigned transaction and signature, combine both and return signed transaction. The examples below are illustrative only. You\'ll need to use your wallet to generate actual values to use them in the request payload.
      * @summary Create Network Transaction from Signatures
      * @param {RosettaConstructionCombineRequest} rosettaConstructionCombineRequest
      * @param {*} [options] Override http request option.
@@ -115,7 +115,7 @@ export interface RosettaApiInterface {
      */
     rosettaConstructionCombineRaw(requestParameters: RosettaConstructionCombineOperationRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<RosettaConstructionCombineResponse>>;
     /**
-     * Take unsigned transaction and signature, combine both and return signed transaction
+     * Take unsigned transaction and signature, combine both and return signed transaction. The examples below are illustrative only. You\'ll need to use your wallet to generate actual values to use them in the request payload.
      * Create Network Transaction from Signatures
      */
     rosettaConstructionCombine(requestParameters: RosettaConstructionCombineOperationRequest, initOverrides?: RequestInit): Promise<RosettaConstructionCombineResponse>;
@@ -176,7 +176,7 @@ export interface RosettaApiInterface {
      */
     rosettaConstructionParse(requestParameters: RosettaConstructionParseOperationRequest, initOverrides?: RequestInit): Promise<RosettaConstructionParseResponse>;
     /**
-     * Generate and unsigned transaction from operations and metadata
+     * Generate an unsigned transaction from operations and metadata. The examples below are illustrative only. You\'ll need to use your wallet to generate actual values to use them in the request payload.
      * @summary Generate an Unsigned Transaction and Signing Payloads
      * @param {RosettaConstructionPayloadsRequest} rosettaConstructionPayloadsRequest
      * @param {*} [options] Override http request option.
@@ -185,7 +185,7 @@ export interface RosettaApiInterface {
      */
     rosettaConstructionPayloadsRaw(requestParameters: RosettaConstructionPayloadsOperationRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<RosettaConstructionPayloadResponse>>;
     /**
-     * Generate and unsigned transaction from operations and metadata
+     * Generate an unsigned transaction from operations and metadata. The examples below are illustrative only. You\'ll need to use your wallet to generate actual values to use them in the request payload.
      * Generate an Unsigned Transaction and Signing Payloads
      */
     rosettaConstructionPayloads(requestParameters: RosettaConstructionPayloadsOperationRequest, initOverrides?: RequestInit): Promise<RosettaConstructionPayloadResponse>;
@@ -204,7 +204,7 @@ export interface RosettaApiInterface {
      */
     rosettaConstructionPreprocess(requestParameters: RosettaConstructionPreprocessOperationRequest, initOverrides?: RequestInit): Promise<RosettaConstructionPreprocessResponse>;
     /**
-     * Submit a pre-signed transaction to the node.
+     * Submit a pre-signed transaction to the node. The examples below are illustrative only. You\'ll need to use your wallet to generate actual values to use them in the request payload.
      * @summary Submit a Signed Transaction
      * @param {RosettaConstructionSubmitRequest} rosettaConstructionSubmitRequest
      * @param {*} [options] Override http request option.
@@ -213,7 +213,7 @@ export interface RosettaApiInterface {
      */
     rosettaConstructionSubmitRaw(requestParameters: RosettaConstructionSubmitOperationRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<RosettaConstructionSubmitResponse>>;
     /**
-     * Submit a pre-signed transaction to the node.
+     * Submit a pre-signed transaction to the node. The examples below are illustrative only. You\'ll need to use your wallet to generate actual values to use them in the request payload.
      * Submit a Signed Transaction
      */
     rosettaConstructionSubmit(requestParameters: RosettaConstructionSubmitOperationRequest, initOverrides?: RequestInit): Promise<RosettaConstructionSubmitResponse>;
@@ -322,12 +322,12 @@ export declare class RosettaApi extends runtime.BaseAPI implements RosettaApiInt
      */
     rosettaBlockTransaction(requestParameters: RosettaBlockTransactionOperationRequest, initOverrides?: RequestInit): Promise<RosettaBlockTransactionResponse>;
     /**
-     * Take unsigned transaction and signature, combine both and return signed transaction
+     * Take unsigned transaction and signature, combine both and return signed transaction. The examples below are illustrative only. You\'ll need to use your wallet to generate actual values to use them in the request payload.
      * Create Network Transaction from Signatures
      */
     rosettaConstructionCombineRaw(requestParameters: RosettaConstructionCombineOperationRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<RosettaConstructionCombineResponse>>;
     /**
-     * Take unsigned transaction and signature, combine both and return signed transaction
+     * Take unsigned transaction and signature, combine both and return signed transaction. The examples below are illustrative only. You\'ll need to use your wallet to generate actual values to use them in the request payload.
      * Create Network Transaction from Signatures
      */
     rosettaConstructionCombine(requestParameters: RosettaConstructionCombineOperationRequest, initOverrides?: RequestInit): Promise<RosettaConstructionCombineResponse>;
@@ -372,12 +372,12 @@ export declare class RosettaApi extends runtime.BaseAPI implements RosettaApiInt
      */
     rosettaConstructionParse(requestParameters: RosettaConstructionParseOperationRequest, initOverrides?: RequestInit): Promise<RosettaConstructionParseResponse>;
     /**
-     * Generate and unsigned transaction from operations and metadata
+     * Generate an unsigned transaction from operations and metadata. The examples below are illustrative only. You\'ll need to use your wallet to generate actual values to use them in the request payload.
      * Generate an Unsigned Transaction and Signing Payloads
      */
     rosettaConstructionPayloadsRaw(requestParameters: RosettaConstructionPayloadsOperationRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<RosettaConstructionPayloadResponse>>;
     /**
-     * Generate and unsigned transaction from operations and metadata
+     * Generate an unsigned transaction from operations and metadata. The examples below are illustrative only. You\'ll need to use your wallet to generate actual values to use them in the request payload.
      * Generate an Unsigned Transaction and Signing Payloads
      */
     rosettaConstructionPayloads(requestParameters: RosettaConstructionPayloadsOperationRequest, initOverrides?: RequestInit): Promise<RosettaConstructionPayloadResponse>;
@@ -392,12 +392,12 @@ export declare class RosettaApi extends runtime.BaseAPI implements RosettaApiInt
      */
     rosettaConstructionPreprocess(requestParameters: RosettaConstructionPreprocessOperationRequest, initOverrides?: RequestInit): Promise<RosettaConstructionPreprocessResponse>;
     /**
-     * Submit a pre-signed transaction to the node.
+     * Submit a pre-signed transaction to the node. The examples below are illustrative only. You\'ll need to use your wallet to generate actual values to use them in the request payload.
      * Submit a Signed Transaction
      */
     rosettaConstructionSubmitRaw(requestParameters: RosettaConstructionSubmitOperationRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<RosettaConstructionSubmitResponse>>;
     /**
-     * Submit a pre-signed transaction to the node.
+     * Submit a pre-signed transaction to the node. The examples below are illustrative only. You\'ll need to use your wallet to generate actual values to use them in the request payload.
      * Submit a Signed Transaction
      */
     rosettaConstructionSubmit(requestParameters: RosettaConstructionSubmitOperationRequest, initOverrides?: RequestInit): Promise<RosettaConstructionSubmitResponse>;

package/lib/generated/apis/RosettaApi.js

@@ -105,7 +105,7 @@ class RosettaApi extends runtime.BaseAPI {
         return await response.value();
     }
     /**
-     * Take unsigned transaction and signature, combine both and return signed transaction
+     * Take unsigned transaction and signature, combine both and return signed transaction. The examples below are illustrative only. You\'ll need to use your wallet to generate actual values to use them in the request payload.
      * Create Network Transaction from Signatures
      */
     async rosettaConstructionCombineRaw(requestParameters, initOverrides) {
@@ -125,7 +125,7 @@ class RosettaApi extends runtime.BaseAPI {
         return new runtime.JSONApiResponse(response, (jsonValue) => models_1.RosettaConstructionCombineResponseFromJSON(jsonValue));
     }
     /**
-     * Take unsigned transaction and signature, combine both and return signed transaction
+     * Take unsigned transaction and signature, combine both and return signed transaction. The examples below are illustrative only. You\'ll need to use your wallet to generate actual values to use them in the request payload.
      * Create Network Transaction from Signatures
      */
     async rosettaConstructionCombine(requestParameters, initOverrides) {
@@ -245,7 +245,7 @@ class RosettaApi extends runtime.BaseAPI {
         return await response.value();
     }
     /**
-     * Generate and unsigned transaction from operations and metadata
+     * Generate an unsigned transaction from operations and metadata. The examples below are illustrative only. You\'ll need to use your wallet to generate actual values to use them in the request payload.
      * Generate an Unsigned Transaction and Signing Payloads
      */
     async rosettaConstructionPayloadsRaw(requestParameters, initOverrides) {
@@ -265,7 +265,7 @@ class RosettaApi extends runtime.BaseAPI {
         return new runtime.JSONApiResponse(response, (jsonValue) => models_1.RosettaConstructionPayloadResponseFromJSON(jsonValue));
     }
     /**
-     * Generate and unsigned transaction from operations and metadata
+     * Generate an unsigned transaction from operations and metadata. The examples below are illustrative only. You\'ll need to use your wallet to generate actual values to use them in the request payload.
      * Generate an Unsigned Transaction and Signing Payloads
      */
     async rosettaConstructionPayloads(requestParameters, initOverrides) {
@@ -301,7 +301,7 @@ class RosettaApi extends runtime.BaseAPI {
         return await response.value();
     }
     /**
-     * Submit a pre-signed transaction to the node.
+     * Submit a pre-signed transaction to the node. The examples below are illustrative only. You\'ll need to use your wallet to generate actual values to use them in the request payload.
      * Submit a Signed Transaction
      */
     async rosettaConstructionSubmitRaw(requestParameters, initOverrides) {
@@ -321,7 +321,7 @@ class RosettaApi extends runtime.BaseAPI {
         return new runtime.JSONApiResponse(response, (jsonValue) => models_1.RosettaConstructionSubmitResponseFromJSON(jsonValue));
     }
     /**
-     * Submit a pre-signed transaction to the node.
+     * Submit a pre-signed transaction to the node. The examples below are illustrative only. You\'ll need to use your wallet to generate actual values to use them in the request payload.
      * Submit a Signed Transaction
      */
     async rosettaConstructionSubmit(requestParameters, initOverrides) {

package/lib/index.umd.js

@@ -8481,7 +8481,7 @@
 
     /**
      * Retrieves metadata for non fungible tokens for a given contract id. More information on Non-Fungible Tokens on the Stacks blockchain can be found [here](https://docs.stacks.co/write-smart-contracts/tokens#non-fungible-tokens-nfts).
-     * Non fungible tokens metadata for contract id
+     * Non fungible tokens metadata for contract ID
      */
     _proto.getContractNftMetadataRaw = function getContractNftMetadataRaw(requestParameters, initOverrides) {
       try {
@@ -8509,7 +8509,7 @@
     }
     /**
      * Retrieves metadata for non fungible tokens for a given contract id. More information on Non-Fungible Tokens on the Stacks blockchain can be found [here](https://docs.stacks.co/write-smart-contracts/tokens#non-fungible-tokens-nfts).
-     * Non fungible tokens metadata for contract id
+     * Non fungible tokens metadata for contract ID
      */
     ;
 
@@ -8955,7 +8955,7 @@
       }
     }
     /**
-     * Take unsigned transaction and signature, combine both and return signed transaction
+     * Take unsigned transaction and signature, combine both and return signed transaction. The examples below are illustrative only. You\'ll need to use your wallet to generate actual values to use them in the request payload.
      * Create Network Transaction from Signatures
      */
     ;
@@ -8987,7 +8987,7 @@
       }
     }
     /**
-     * Take unsigned transaction and signature, combine both and return signed transaction
+     * Take unsigned transaction and signature, combine both and return signed transaction. The examples below are illustrative only. You\'ll need to use your wallet to generate actual values to use them in the request payload.
      * Create Network Transaction from Signatures
      */
     ;
@@ -9200,7 +9200,7 @@
       }
     }
     /**
-     * Generate and unsigned transaction from operations and metadata
+     * Generate an unsigned transaction from operations and metadata. The examples below are illustrative only. You\'ll need to use your wallet to generate actual values to use them in the request payload.
      * Generate an Unsigned Transaction and Signing Payloads
      */
     ;
@@ -9232,7 +9232,7 @@
       }
     }
     /**
-     * Generate and unsigned transaction from operations and metadata
+     * Generate an unsigned transaction from operations and metadata. The examples below are illustrative only. You\'ll need to use your wallet to generate actual values to use them in the request payload.
      * Generate an Unsigned Transaction and Signing Payloads
      */
     ;
@@ -9298,7 +9298,7 @@
       }
     }
     /**
-     * Submit a pre-signed transaction to the node.
+     * Submit a pre-signed transaction to the node. The examples below are illustrative only. You\'ll need to use your wallet to generate actual values to use them in the request payload.
      * Submit a Signed Transaction
      */
     ;
@@ -9330,7 +9330,7 @@
       }
     }
     /**
-     * Submit a pre-signed transaction to the node.
+     * Submit a pre-signed transaction to the node. The examples below are illustrative only. You\'ll need to use your wallet to generate actual values to use them in the request payload.
      * Submit a Signed Transaction
      */
     ;