@stacks/blockchain-api-client 7.13.0-beta.1 → 7.13.0

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

@@ -175,7 +175,7 @@ export interface AccountsApiInterface {
      */
     getAccountStxBalance(requestParameters: GetAccountStxBalanceRequest, initOverrides?: RequestInit): Promise<object>;
     /**
-     * Retrieves a list of all Transactions for a given Address or Contract Identifier. More information on Transaction types can be found [here](https://docs.stacks.co/understand-stacks/transactions#types).  If you need to actively monitor new transactions for an address or contract id, we highly recommend subscribing to [WebSockets or Socket.io](https://github.com/hirosystems/stacks-blockchain-api/tree/master/client) for real-time updates.
+     * **NOTE:** This endpoint is deprecated in favor of [Get address transactions](/api/get-address-transactions).  Retrieves a list of all Transactions for a given Address or Contract Identifier. More information on Transaction types can be found [here](https://docs.stacks.co/understand-stacks/transactions#types).  If you need to actively monitor new transactions for an address or contract id, we highly recommend subscribing to [WebSockets or Socket.io](https://github.com/hirosystems/stacks-blockchain-api/tree/master/client) for real-time updates.
      * @summary Get account transactions
      * @param {string} principal Stacks address or a Contract identifier
      * @param {number} [limit] max number of account transactions to fetch
@@ -189,7 +189,7 @@ export interface AccountsApiInterface {
      */
     getAccountTransactionsRaw(requestParameters: GetAccountTransactionsRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<AddressTransactionsListResponse>>;
     /**
-     * Retrieves a list of all Transactions for a given Address or Contract Identifier. More information on Transaction types can be found [here](https://docs.stacks.co/understand-stacks/transactions#types).  If you need to actively monitor new transactions for an address or contract id, we highly recommend subscribing to [WebSockets or Socket.io](https://github.com/hirosystems/stacks-blockchain-api/tree/master/client) for real-time updates.
+     * **NOTE:** This endpoint is deprecated in favor of [Get address transactions](/api/get-address-transactions).  Retrieves a list of all Transactions for a given Address or Contract Identifier. More information on Transaction types can be found [here](https://docs.stacks.co/understand-stacks/transactions#types).  If you need to actively monitor new transactions for an address or contract id, we highly recommend subscribing to [WebSockets or Socket.io](https://github.com/hirosystems/stacks-blockchain-api/tree/master/client) for real-time updates.
      * Get account transactions
      */
     getAccountTransactions(requestParameters: GetAccountTransactionsRequest, initOverrides?: RequestInit): Promise<AddressTransactionsListResponse>;
@@ -213,7 +213,7 @@ export interface AccountsApiInterface {
      */
     getAccountTransactionsWithTransfers(requestParameters: GetAccountTransactionsWithTransfersRequest, initOverrides?: RequestInit): Promise<AddressTransactionsWithTransfersListResponse>;
     /**
-     * Retrieves transaction details for a given Transaction Id `tx_id`, for a given account or contract Identifier.
+     * **NOTE:** This endpoint is deprecated in favor of [Get events for an address transaction](/api/get-address-transaction-events).  Retrieves transaction details for a given Transaction Id `tx_id`, for a given account or contract Identifier.
      * @summary Get account transaction information for specific transaction
      * @param {string} principal Stacks address or a contract identifier
      * @param {string} txId Transaction id
@@ -223,7 +223,7 @@ export interface AccountsApiInterface {
      */
     getSingleTransactionWithTransfersRaw(requestParameters: GetSingleTransactionWithTransfersRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<AddressTransactionWithTransfers>>;
     /**
-     * Retrieves transaction details for a given Transaction Id `tx_id`, for a given account or contract Identifier.
+     * **NOTE:** This endpoint is deprecated in favor of [Get events for an address transaction](/api/get-address-transaction-events).  Retrieves transaction details for a given Transaction Id `tx_id`, for a given account or contract Identifier.
      * Get account transaction information for specific transaction
      */
     getSingleTransactionWithTransfers(requestParameters: GetSingleTransactionWithTransfersRequest, initOverrides?: RequestInit): Promise<AddressTransactionWithTransfers>;
@@ -293,12 +293,12 @@ export declare class AccountsApi extends runtime.BaseAPI implements AccountsApiI
      */
     getAccountStxBalance(requestParameters: GetAccountStxBalanceRequest, initOverrides?: RequestInit): Promise<object>;
     /**
-     * Retrieves a list of all Transactions for a given Address or Contract Identifier. More information on Transaction types can be found [here](https://docs.stacks.co/understand-stacks/transactions#types).  If you need to actively monitor new transactions for an address or contract id, we highly recommend subscribing to [WebSockets or Socket.io](https://github.com/hirosystems/stacks-blockchain-api/tree/master/client) for real-time updates.
+     * **NOTE:** This endpoint is deprecated in favor of [Get address transactions](/api/get-address-transactions).  Retrieves a list of all Transactions for a given Address or Contract Identifier. More information on Transaction types can be found [here](https://docs.stacks.co/understand-stacks/transactions#types).  If you need to actively monitor new transactions for an address or contract id, we highly recommend subscribing to [WebSockets or Socket.io](https://github.com/hirosystems/stacks-blockchain-api/tree/master/client) for real-time updates.
      * Get account transactions
      */
     getAccountTransactionsRaw(requestParameters: GetAccountTransactionsRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<AddressTransactionsListResponse>>;
     /**
-     * Retrieves a list of all Transactions for a given Address or Contract Identifier. More information on Transaction types can be found [here](https://docs.stacks.co/understand-stacks/transactions#types).  If you need to actively monitor new transactions for an address or contract id, we highly recommend subscribing to [WebSockets or Socket.io](https://github.com/hirosystems/stacks-blockchain-api/tree/master/client) for real-time updates.
+     * **NOTE:** This endpoint is deprecated in favor of [Get address transactions](/api/get-address-transactions).  Retrieves a list of all Transactions for a given Address or Contract Identifier. More information on Transaction types can be found [here](https://docs.stacks.co/understand-stacks/transactions#types).  If you need to actively monitor new transactions for an address or contract id, we highly recommend subscribing to [WebSockets or Socket.io](https://github.com/hirosystems/stacks-blockchain-api/tree/master/client) for real-time updates.
      * Get account transactions
      */
     getAccountTransactions(requestParameters: GetAccountTransactionsRequest, initOverrides?: RequestInit): Promise<AddressTransactionsListResponse>;
@@ -313,12 +313,12 @@ export declare class AccountsApi extends runtime.BaseAPI implements AccountsApiI
      */
     getAccountTransactionsWithTransfers(requestParameters: GetAccountTransactionsWithTransfersRequest, initOverrides?: RequestInit): Promise<AddressTransactionsWithTransfersListResponse>;
     /**
-     * Retrieves transaction details for a given Transaction Id `tx_id`, for a given account or contract Identifier.
+     * **NOTE:** This endpoint is deprecated in favor of [Get events for an address transaction](/api/get-address-transaction-events).  Retrieves transaction details for a given Transaction Id `tx_id`, for a given account or contract Identifier.
      * Get account transaction information for specific transaction
      */
     getSingleTransactionWithTransfersRaw(requestParameters: GetSingleTransactionWithTransfersRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<AddressTransactionWithTransfers>>;
     /**
-     * Retrieves transaction details for a given Transaction Id `tx_id`, for a given account or contract Identifier.
+     * **NOTE:** This endpoint is deprecated in favor of [Get events for an address transaction](/api/get-address-transaction-events).  Retrieves transaction details for a given Transaction Id `tx_id`, for a given account or contract Identifier.
      * Get account transaction information for specific transaction
      */
     getSingleTransactionWithTransfers(requestParameters: GetSingleTransactionWithTransfersRequest, initOverrides?: RequestInit): Promise<AddressTransactionWithTransfers>;

package/lib/generated/apis/AccountsApi.js

@@ -228,7 +228,7 @@ class AccountsApi extends runtime.BaseAPI {
         return await response.value();
     }
     /**
-     * Retrieves a list of all Transactions for a given Address or Contract Identifier. More information on Transaction types can be found [here](https://docs.stacks.co/understand-stacks/transactions#types).  If you need to actively monitor new transactions for an address or contract id, we highly recommend subscribing to [WebSockets or Socket.io](https://github.com/hirosystems/stacks-blockchain-api/tree/master/client) for real-time updates.
+     * **NOTE:** This endpoint is deprecated in favor of [Get address transactions](/api/get-address-transactions).  Retrieves a list of all Transactions for a given Address or Contract Identifier. More information on Transaction types can be found [here](https://docs.stacks.co/understand-stacks/transactions#types).  If you need to actively monitor new transactions for an address or contract id, we highly recommend subscribing to [WebSockets or Socket.io](https://github.com/hirosystems/stacks-blockchain-api/tree/master/client) for real-time updates.
      * Get account transactions
      */
     async getAccountTransactionsRaw(requestParameters, initOverrides) {
@@ -261,7 +261,7 @@ class AccountsApi extends runtime.BaseAPI {
         return new runtime.JSONApiResponse(response, (jsonValue) => (0, models_1.AddressTransactionsListResponseFromJSON)(jsonValue));
     }
     /**
-     * Retrieves a list of all Transactions for a given Address or Contract Identifier. More information on Transaction types can be found [here](https://docs.stacks.co/understand-stacks/transactions#types).  If you need to actively monitor new transactions for an address or contract id, we highly recommend subscribing to [WebSockets or Socket.io](https://github.com/hirosystems/stacks-blockchain-api/tree/master/client) for real-time updates.
+     * **NOTE:** This endpoint is deprecated in favor of [Get address transactions](/api/get-address-transactions).  Retrieves a list of all Transactions for a given Address or Contract Identifier. More information on Transaction types can be found [here](https://docs.stacks.co/understand-stacks/transactions#types).  If you need to actively monitor new transactions for an address or contract id, we highly recommend subscribing to [WebSockets or Socket.io](https://github.com/hirosystems/stacks-blockchain-api/tree/master/client) for real-time updates.
      * Get account transactions
      */
     async getAccountTransactions(requestParameters, initOverrides) {
@@ -310,7 +310,7 @@ class AccountsApi extends runtime.BaseAPI {
         return await response.value();
     }
     /**
-     * Retrieves transaction details for a given Transaction Id `tx_id`, for a given account or contract Identifier.
+     * **NOTE:** This endpoint is deprecated in favor of [Get events for an address transaction](/api/get-address-transaction-events).  Retrieves transaction details for a given Transaction Id `tx_id`, for a given account or contract Identifier.
      * Get account transaction information for specific transaction
      */
     async getSingleTransactionWithTransfersRaw(requestParameters, initOverrides) {
@@ -331,7 +331,7 @@ class AccountsApi extends runtime.BaseAPI {
         return new runtime.JSONApiResponse(response, (jsonValue) => (0, models_1.AddressTransactionWithTransfersFromJSON)(jsonValue));
     }
     /**
-     * Retrieves transaction details for a given Transaction Id `tx_id`, for a given account or contract Identifier.
+     * **NOTE:** This endpoint is deprecated in favor of [Get events for an address transaction](/api/get-address-transaction-events).  Retrieves transaction details for a given Transaction Id `tx_id`, for a given account or contract Identifier.
      * Get account transaction information for specific transaction
      */
     async getSingleTransactionWithTransfers(requestParameters, initOverrides) {

package/lib/index.umd.js

@@ -7387,7 +7387,7 @@
       }
     }
     /**
-     * Retrieves a list of all Transactions for a given Address or Contract Identifier. More information on Transaction types can be found [here](https://docs.stacks.co/understand-stacks/transactions#types).  If you need to actively monitor new transactions for an address or contract id, we highly recommend subscribing to [WebSockets or Socket.io](https://github.com/hirosystems/stacks-blockchain-api/tree/master/client) for real-time updates.
+     * **NOTE:** This endpoint is deprecated in favor of [Get address transactions](/api/get-address-transactions).  Retrieves a list of all Transactions for a given Address or Contract Identifier. More information on Transaction types can be found [here](https://docs.stacks.co/understand-stacks/transactions#types).  If you need to actively monitor new transactions for an address or contract id, we highly recommend subscribing to [WebSockets or Socket.io](https://github.com/hirosystems/stacks-blockchain-api/tree/master/client) for real-time updates.
      * Get account transactions
      */
     ;
@@ -7438,7 +7438,7 @@
       }
     }
     /**
-     * Retrieves a list of all Transactions for a given Address or Contract Identifier. More information on Transaction types can be found [here](https://docs.stacks.co/understand-stacks/transactions#types).  If you need to actively monitor new transactions for an address or contract id, we highly recommend subscribing to [WebSockets or Socket.io](https://github.com/hirosystems/stacks-blockchain-api/tree/master/client) for real-time updates.
+     * **NOTE:** This endpoint is deprecated in favor of [Get address transactions](/api/get-address-transactions).  Retrieves a list of all Transactions for a given Address or Contract Identifier. More information on Transaction types can be found [here](https://docs.stacks.co/understand-stacks/transactions#types).  If you need to actively monitor new transactions for an address or contract id, we highly recommend subscribing to [WebSockets or Socket.io](https://github.com/hirosystems/stacks-blockchain-api/tree/master/client) for real-time updates.
      * Get account transactions
      */
     ;
@@ -7523,7 +7523,7 @@
       }
     }
     /**
-     * Retrieves transaction details for a given Transaction Id `tx_id`, for a given account or contract Identifier.
+     * **NOTE:** This endpoint is deprecated in favor of [Get events for an address transaction](/api/get-address-transaction-events).  Retrieves transaction details for a given Transaction Id `tx_id`, for a given account or contract Identifier.
      * Get account transaction information for specific transaction
      */
     ;
@@ -7557,7 +7557,7 @@
       }
     }
     /**
-     * Retrieves transaction details for a given Transaction Id `tx_id`, for a given account or contract Identifier.
+     * **NOTE:** This endpoint is deprecated in favor of [Get events for an address transaction](/api/get-address-transaction-events).  Retrieves transaction details for a given Transaction Id `tx_id`, for a given account or contract Identifier.
      * Get account transaction information for specific transaction
      */
     ;