@circle-fin/developer-controlled-wallets 10.1.0 → 10.3.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -924,7 +924,7 @@ interface WalletMetadata {
924
924
  */
925
925
  'name'?: string;
926
926
  /**
927
- * Reference or description used to identify the object.
927
+ * Optional user-defined reference identifier for the wallet. Not used by Circle for wallet functionality. Used for internal tracking or associating wallets with entities in your own systems (for example, a customer or account ID).
928
928
  * @type {string}
929
929
  * @memberof WalletMetadata
930
930
  */
@@ -1348,7 +1348,7 @@ interface Wallet {
1348
1348
  */
1349
1349
  'name'?: string;
1350
1350
  /**
1351
- * Reference or description used to identify the object.
1351
+ * Optional user-defined reference identifier for the wallet. Not used by Circle for wallet functionality. Used for internal tracking or associating wallets with entities in your own systems (for example, a customer or account ID).
1352
1352
  * @type {string}
1353
1353
  * @memberof Wallet
1354
1354
  */
@@ -2929,7 +2929,7 @@ interface UpdateWalletRequest {
2929
2929
  */
2930
2930
  'name'?: string;
2931
2931
  /**
2932
- * Reference or description used to identify the object.
2932
+ * Optional user-defined reference identifier for the wallet. Not used by Circle for wallet functionality. Used for internal tracking or associating wallets with entities in your own systems (for example, a customer or account ID).
2933
2933
  * @type {string}
2934
2934
  * @memberof UpdateWalletRequest
2935
2935
  */
@@ -3265,7 +3265,7 @@ declare const SigningApiAxiosParamCreator: (configuration?: Configuration) => {
3265
3265
  * Sign a delegate action from a specific developer-controlled wallet. NOTE: This endpoint is only available for NEAR and NEAR-TESTNET.
3266
3266
  * @summary Sign delegate action
3267
3267
  * @param {SignDelegateActionRequest} signDelegateActionRequest Schema for the request payload to sign a delegate action.
3268
- * @param {string} [xRequestId] Developer-provided parameter used to identify this request. Useful when communicating with Circle Support.
3268
+ * @param {string} [xRequestId] Developer-provided identifier for this request, used for tracing requests in Wallets API logs and the Developer Console, and when communicating with Circle Support. **Must be a UUID to appear in logs.** Non-UUID values are accepted by the API but are ignored by logging and tracing systems.
3269
3269
  * @param {*} [options] Override http request option.
3270
3270
  * @throws {RequiredError}
3271
3271
  */
@@ -3274,7 +3274,7 @@ declare const SigningApiAxiosParamCreator: (configuration?: Configuration) => {
3274
3274
  * Sign a message from a specified developer-controlled wallet. This endpoint supports message signing for Ethereum-based blockchains (using EIP-191), Solana and Aptos (using Ed25519 signatures). Note that Smart Contract Accounts (SCA) are specific to Ethereum and EVM-compatible chains. The difference between Ethereum\'s EOA and SCA can be found in the [account types guide](https://developers.circle.com/wallets/account-types). You can also check the list of Ethereum Dapps that support SCA: https://eip1271.io/.\" You must provide either a `walletId` or a `walletAddress` and `blockchain` pair in the request body.
3275
3275
  * @summary Sign message
3276
3276
  * @param {SignMessageRequest} signMessageRequest Schema for the request payload to sign a message.
3277
- * @param {string} [xRequestId] Developer-provided parameter used to identify this request. Useful when communicating with Circle Support.
3277
+ * @param {string} [xRequestId] Developer-provided identifier for this request, used for tracing requests in Wallets API logs and the Developer Console, and when communicating with Circle Support. **Must be a UUID to appear in logs.** Non-UUID values are accepted by the API but are ignored by logging and tracing systems.
3278
3278
  * @param {*} [options] Override http request option.
3279
3279
  * @throws {RequiredError}
3280
3280
  */
@@ -3283,7 +3283,7 @@ declare const SigningApiAxiosParamCreator: (configuration?: Configuration) => {
3283
3283
  * Sign a transaction from a specific developer-controlled wallet. You must provide either a `walletId` or a `walletAddress` and `blockchain` pair in the request body. NOTE: This endpoint is only available for the following chains: `SOL`, `SOL-DEVNET`, `NEAR`, `NEAR-TESTNET`, `EVM`, `EVM-TESTNET`. Each chain defines its own standard, please refer to [Signing APIs doc](https://learn.circle.com/w3s/signing-apis).
3284
3284
  * @summary Sign transaction
3285
3285
  * @param {SignTransactionRequest} signTransactionRequest Schema for the request payload to sign a transaction.
3286
- * @param {string} [xRequestId] Developer-provided parameter used to identify this request. Useful when communicating with Circle Support.
3286
+ * @param {string} [xRequestId] Developer-provided identifier for this request, used for tracing requests in Wallets API logs and the Developer Console, and when communicating with Circle Support. **Must be a UUID to appear in logs.** Non-UUID values are accepted by the API but are ignored by logging and tracing systems.
3287
3287
  * @param {*} [options] Override http request option.
3288
3288
  * @throws {RequiredError}
3289
3289
  */
@@ -3292,7 +3292,7 @@ declare const SigningApiAxiosParamCreator: (configuration?: Configuration) => {
3292
3292
  * | Sign the EIP-712 typed structured data from a specified developer-controlled wallet. You must provide either a `walletId` or a `walletAddress` and `blockchain` pair in the request body. This endpoint only supports Ethereum and EVM-compatible blockchains. Please note that not all apps currently support Smart Contract Accounts (SCA); the difference between Ethereum\'s EOA and SCA can be found in the [account types guide](https://developers.circle.com/wallets/account-types). You can also check the list of Ethereum apps that support SCA: https://eip1271.io/.
3293
3293
  * @summary Sign typed data
3294
3294
  * @param {SignTypedDataRequest} signTypedDataRequest Schema for the request payload to sign typed data.
3295
- * @param {string} [xRequestId] Developer-provided parameter used to identify this request. Useful when communicating with Circle Support.
3295
+ * @param {string} [xRequestId] Developer-provided identifier for this request, used for tracing requests in Wallets API logs and the Developer Console, and when communicating with Circle Support. **Must be a UUID to appear in logs.** Non-UUID values are accepted by the API but are ignored by logging and tracing systems.
3296
3296
  * @param {*} [options] Override http request option.
3297
3297
  * @throws {RequiredError}
3298
3298
  */
@@ -3307,7 +3307,7 @@ declare const SigningApiFp: (configuration?: Configuration) => {
3307
3307
  * Sign a delegate action from a specific developer-controlled wallet. NOTE: This endpoint is only available for NEAR and NEAR-TESTNET.
3308
3308
  * @summary Sign delegate action
3309
3309
  * @param {SignDelegateActionRequest} signDelegateActionRequest Schema for the request payload to sign a delegate action.
3310
- * @param {string} [xRequestId] Developer-provided parameter used to identify this request. Useful when communicating with Circle Support.
3310
+ * @param {string} [xRequestId] Developer-provided identifier for this request, used for tracing requests in Wallets API logs and the Developer Console, and when communicating with Circle Support. **Must be a UUID to appear in logs.** Non-UUID values are accepted by the API but are ignored by logging and tracing systems.
3311
3311
  * @param {*} [options] Override http request option.
3312
3312
  * @throws {RequiredError}
3313
3313
  */
@@ -3316,7 +3316,7 @@ declare const SigningApiFp: (configuration?: Configuration) => {
3316
3316
  * Sign a message from a specified developer-controlled wallet. This endpoint supports message signing for Ethereum-based blockchains (using EIP-191), Solana and Aptos (using Ed25519 signatures). Note that Smart Contract Accounts (SCA) are specific to Ethereum and EVM-compatible chains. The difference between Ethereum\'s EOA and SCA can be found in the [account types guide](https://developers.circle.com/wallets/account-types). You can also check the list of Ethereum Dapps that support SCA: https://eip1271.io/.\" You must provide either a `walletId` or a `walletAddress` and `blockchain` pair in the request body.
3317
3317
  * @summary Sign message
3318
3318
  * @param {SignMessageRequest} signMessageRequest Schema for the request payload to sign a message.
3319
- * @param {string} [xRequestId] Developer-provided parameter used to identify this request. Useful when communicating with Circle Support.
3319
+ * @param {string} [xRequestId] Developer-provided identifier for this request, used for tracing requests in Wallets API logs and the Developer Console, and when communicating with Circle Support. **Must be a UUID to appear in logs.** Non-UUID values are accepted by the API but are ignored by logging and tracing systems.
3320
3320
  * @param {*} [options] Override http request option.
3321
3321
  * @throws {RequiredError}
3322
3322
  */
@@ -3325,7 +3325,7 @@ declare const SigningApiFp: (configuration?: Configuration) => {
3325
3325
  * Sign a transaction from a specific developer-controlled wallet. You must provide either a `walletId` or a `walletAddress` and `blockchain` pair in the request body. NOTE: This endpoint is only available for the following chains: `SOL`, `SOL-DEVNET`, `NEAR`, `NEAR-TESTNET`, `EVM`, `EVM-TESTNET`. Each chain defines its own standard, please refer to [Signing APIs doc](https://learn.circle.com/w3s/signing-apis).
3326
3326
  * @summary Sign transaction
3327
3327
  * @param {SignTransactionRequest} signTransactionRequest Schema for the request payload to sign a transaction.
3328
- * @param {string} [xRequestId] Developer-provided parameter used to identify this request. Useful when communicating with Circle Support.
3328
+ * @param {string} [xRequestId] Developer-provided identifier for this request, used for tracing requests in Wallets API logs and the Developer Console, and when communicating with Circle Support. **Must be a UUID to appear in logs.** Non-UUID values are accepted by the API but are ignored by logging and tracing systems.
3329
3329
  * @param {*} [options] Override http request option.
3330
3330
  * @throws {RequiredError}
3331
3331
  */
@@ -3334,7 +3334,7 @@ declare const SigningApiFp: (configuration?: Configuration) => {
3334
3334
  * | Sign the EIP-712 typed structured data from a specified developer-controlled wallet. You must provide either a `walletId` or a `walletAddress` and `blockchain` pair in the request body. This endpoint only supports Ethereum and EVM-compatible blockchains. Please note that not all apps currently support Smart Contract Accounts (SCA); the difference between Ethereum\'s EOA and SCA can be found in the [account types guide](https://developers.circle.com/wallets/account-types). You can also check the list of Ethereum apps that support SCA: https://eip1271.io/.
3335
3335
  * @summary Sign typed data
3336
3336
  * @param {SignTypedDataRequest} signTypedDataRequest Schema for the request payload to sign typed data.
3337
- * @param {string} [xRequestId] Developer-provided parameter used to identify this request. Useful when communicating with Circle Support.
3337
+ * @param {string} [xRequestId] Developer-provided identifier for this request, used for tracing requests in Wallets API logs and the Developer Console, and when communicating with Circle Support. **Must be a UUID to appear in logs.** Non-UUID values are accepted by the API but are ignored by logging and tracing systems.
3338
3338
  * @param {*} [options] Override http request option.
3339
3339
  * @throws {RequiredError}
3340
3340
  */
@@ -3349,7 +3349,7 @@ declare const SigningApiFactory: (configuration?: Configuration, basePath?: stri
3349
3349
  * Sign a delegate action from a specific developer-controlled wallet. NOTE: This endpoint is only available for NEAR and NEAR-TESTNET.
3350
3350
  * @summary Sign delegate action
3351
3351
  * @param {SignDelegateActionRequest} signDelegateActionRequest Schema for the request payload to sign a delegate action.
3352
- * @param {string} [xRequestId] Developer-provided parameter used to identify this request. Useful when communicating with Circle Support.
3352
+ * @param {string} [xRequestId] Developer-provided identifier for this request, used for tracing requests in Wallets API logs and the Developer Console, and when communicating with Circle Support. **Must be a UUID to appear in logs.** Non-UUID values are accepted by the API but are ignored by logging and tracing systems.
3353
3353
  * @param {*} [options] Override http request option.
3354
3354
  * @throws {RequiredError}
3355
3355
  */
@@ -3358,7 +3358,7 @@ declare const SigningApiFactory: (configuration?: Configuration, basePath?: stri
3358
3358
  * Sign a message from a specified developer-controlled wallet. This endpoint supports message signing for Ethereum-based blockchains (using EIP-191), Solana and Aptos (using Ed25519 signatures). Note that Smart Contract Accounts (SCA) are specific to Ethereum and EVM-compatible chains. The difference between Ethereum\'s EOA and SCA can be found in the [account types guide](https://developers.circle.com/wallets/account-types). You can also check the list of Ethereum Dapps that support SCA: https://eip1271.io/.\" You must provide either a `walletId` or a `walletAddress` and `blockchain` pair in the request body.
3359
3359
  * @summary Sign message
3360
3360
  * @param {SignMessageRequest} signMessageRequest Schema for the request payload to sign a message.
3361
- * @param {string} [xRequestId] Developer-provided parameter used to identify this request. Useful when communicating with Circle Support.
3361
+ * @param {string} [xRequestId] Developer-provided identifier for this request, used for tracing requests in Wallets API logs and the Developer Console, and when communicating with Circle Support. **Must be a UUID to appear in logs.** Non-UUID values are accepted by the API but are ignored by logging and tracing systems.
3362
3362
  * @param {*} [options] Override http request option.
3363
3363
  * @throws {RequiredError}
3364
3364
  */
@@ -3367,7 +3367,7 @@ declare const SigningApiFactory: (configuration?: Configuration, basePath?: stri
3367
3367
  * Sign a transaction from a specific developer-controlled wallet. You must provide either a `walletId` or a `walletAddress` and `blockchain` pair in the request body. NOTE: This endpoint is only available for the following chains: `SOL`, `SOL-DEVNET`, `NEAR`, `NEAR-TESTNET`, `EVM`, `EVM-TESTNET`. Each chain defines its own standard, please refer to [Signing APIs doc](https://learn.circle.com/w3s/signing-apis).
3368
3368
  * @summary Sign transaction
3369
3369
  * @param {SignTransactionRequest} signTransactionRequest Schema for the request payload to sign a transaction.
3370
- * @param {string} [xRequestId] Developer-provided parameter used to identify this request. Useful when communicating with Circle Support.
3370
+ * @param {string} [xRequestId] Developer-provided identifier for this request, used for tracing requests in Wallets API logs and the Developer Console, and when communicating with Circle Support. **Must be a UUID to appear in logs.** Non-UUID values are accepted by the API but are ignored by logging and tracing systems.
3371
3371
  * @param {*} [options] Override http request option.
3372
3372
  * @throws {RequiredError}
3373
3373
  */
@@ -3376,7 +3376,7 @@ declare const SigningApiFactory: (configuration?: Configuration, basePath?: stri
3376
3376
  * | Sign the EIP-712 typed structured data from a specified developer-controlled wallet. You must provide either a `walletId` or a `walletAddress` and `blockchain` pair in the request body. This endpoint only supports Ethereum and EVM-compatible blockchains. Please note that not all apps currently support Smart Contract Accounts (SCA); the difference between Ethereum\'s EOA and SCA can be found in the [account types guide](https://developers.circle.com/wallets/account-types). You can also check the list of Ethereum apps that support SCA: https://eip1271.io/.
3377
3377
  * @summary Sign typed data
3378
3378
  * @param {SignTypedDataRequest} signTypedDataRequest Schema for the request payload to sign typed data.
3379
- * @param {string} [xRequestId] Developer-provided parameter used to identify this request. Useful when communicating with Circle Support.
3379
+ * @param {string} [xRequestId] Developer-provided identifier for this request, used for tracing requests in Wallets API logs and the Developer Console, and when communicating with Circle Support. **Must be a UUID to appear in logs.** Non-UUID values are accepted by the API but are ignored by logging and tracing systems.
3380
3380
  * @param {*} [options] Override http request option.
3381
3381
  * @throws {RequiredError}
3382
3382
  */
@@ -3393,7 +3393,7 @@ declare class SigningApi extends BaseAPI {
3393
3393
  * Sign a delegate action from a specific developer-controlled wallet. NOTE: This endpoint is only available for NEAR and NEAR-TESTNET.
3394
3394
  * @summary Sign delegate action
3395
3395
  * @param {SignDelegateActionRequest} signDelegateActionRequest Schema for the request payload to sign a delegate action.
3396
- * @param {string} [xRequestId] Developer-provided parameter used to identify this request. Useful when communicating with Circle Support.
3396
+ * @param {string} [xRequestId] Developer-provided identifier for this request, used for tracing requests in Wallets API logs and the Developer Console, and when communicating with Circle Support. **Must be a UUID to appear in logs.** Non-UUID values are accepted by the API but are ignored by logging and tracing systems.
3397
3397
  * @param {*} [options] Override http request option.
3398
3398
  * @throws {RequiredError}
3399
3399
  * @memberof SigningApi
@@ -3403,7 +3403,7 @@ declare class SigningApi extends BaseAPI {
3403
3403
  * Sign a message from a specified developer-controlled wallet. This endpoint supports message signing for Ethereum-based blockchains (using EIP-191), Solana and Aptos (using Ed25519 signatures). Note that Smart Contract Accounts (SCA) are specific to Ethereum and EVM-compatible chains. The difference between Ethereum\'s EOA and SCA can be found in the [account types guide](https://developers.circle.com/wallets/account-types). You can also check the list of Ethereum Dapps that support SCA: https://eip1271.io/.\" You must provide either a `walletId` or a `walletAddress` and `blockchain` pair in the request body.
3404
3404
  * @summary Sign message
3405
3405
  * @param {SignMessageRequest} signMessageRequest Schema for the request payload to sign a message.
3406
- * @param {string} [xRequestId] Developer-provided parameter used to identify this request. Useful when communicating with Circle Support.
3406
+ * @param {string} [xRequestId] Developer-provided identifier for this request, used for tracing requests in Wallets API logs and the Developer Console, and when communicating with Circle Support. **Must be a UUID to appear in logs.** Non-UUID values are accepted by the API but are ignored by logging and tracing systems.
3407
3407
  * @param {*} [options] Override http request option.
3408
3408
  * @throws {RequiredError}
3409
3409
  * @memberof SigningApi
@@ -3413,7 +3413,7 @@ declare class SigningApi extends BaseAPI {
3413
3413
  * Sign a transaction from a specific developer-controlled wallet. You must provide either a `walletId` or a `walletAddress` and `blockchain` pair in the request body. NOTE: This endpoint is only available for the following chains: `SOL`, `SOL-DEVNET`, `NEAR`, `NEAR-TESTNET`, `EVM`, `EVM-TESTNET`. Each chain defines its own standard, please refer to [Signing APIs doc](https://learn.circle.com/w3s/signing-apis).
3414
3414
  * @summary Sign transaction
3415
3415
  * @param {SignTransactionRequest} signTransactionRequest Schema for the request payload to sign a transaction.
3416
- * @param {string} [xRequestId] Developer-provided parameter used to identify this request. Useful when communicating with Circle Support.
3416
+ * @param {string} [xRequestId] Developer-provided identifier for this request, used for tracing requests in Wallets API logs and the Developer Console, and when communicating with Circle Support. **Must be a UUID to appear in logs.** Non-UUID values are accepted by the API but are ignored by logging and tracing systems.
3417
3417
  * @param {*} [options] Override http request option.
3418
3418
  * @throws {RequiredError}
3419
3419
  * @memberof SigningApi
@@ -3423,7 +3423,7 @@ declare class SigningApi extends BaseAPI {
3423
3423
  * | Sign the EIP-712 typed structured data from a specified developer-controlled wallet. You must provide either a `walletId` or a `walletAddress` and `blockchain` pair in the request body. This endpoint only supports Ethereum and EVM-compatible blockchains. Please note that not all apps currently support Smart Contract Accounts (SCA); the difference between Ethereum\'s EOA and SCA can be found in the [account types guide](https://developers.circle.com/wallets/account-types). You can also check the list of Ethereum apps that support SCA: https://eip1271.io/.
3424
3424
  * @summary Sign typed data
3425
3425
  * @param {SignTypedDataRequest} signTypedDataRequest Schema for the request payload to sign typed data.
3426
- * @param {string} [xRequestId] Developer-provided parameter used to identify this request. Useful when communicating with Circle Support.
3426
+ * @param {string} [xRequestId] Developer-provided identifier for this request, used for tracing requests in Wallets API logs and the Developer Console, and when communicating with Circle Support. **Must be a UUID to appear in logs.** Non-UUID values are accepted by the API but are ignored by logging and tracing systems.
3427
3427
  * @param {*} [options] Override http request option.
3428
3428
  * @throws {RequiredError}
3429
3429
  * @memberof SigningApi
@@ -3501,7 +3501,7 @@ declare const TransactionsApiAxiosParamCreator: (configuration?: Configuration)
3501
3501
  * @summary Accelerate a transaction
3502
3502
  * @param {string} id The universally unique identifier of the resource.
3503
3503
  * @param {AccelerateTransactionForDeveloperRequest} accelerateTransactionForDeveloperRequest Accelerate transaction for developer request
3504
- * @param {string} [xRequestId] Developer-provided parameter used to identify this request. Useful when communicating with Circle Support.
3504
+ * @param {string} [xRequestId] Developer-provided identifier for this request, used for tracing requests in Wallets API logs and the Developer Console, and when communicating with Circle Support. **Must be a UUID to appear in logs.** Non-UUID values are accepted by the API but are ignored by logging and tracing systems.
3505
3505
  * @param {*} [options] Override http request option.
3506
3506
  * @throws {RequiredError}
3507
3507
  */
@@ -3511,7 +3511,7 @@ declare const TransactionsApiAxiosParamCreator: (configuration?: Configuration)
3511
3511
  * @summary Cancel a transaction
3512
3512
  * @param {string} id The universally unique identifier of the resource.
3513
3513
  * @param {CancelTransactionForDeveloperRequest} cancelTransactionForDeveloperRequest Cancel transaction for developer request
3514
- * @param {string} [xRequestId] Developer-provided parameter used to identify this request. Useful when communicating with Circle Support.
3514
+ * @param {string} [xRequestId] Developer-provided identifier for this request, used for tracing requests in Wallets API logs and the Developer Console, and when communicating with Circle Support. **Must be a UUID to appear in logs.** Non-UUID values are accepted by the API but are ignored by logging and tracing systems.
3515
3515
  * @param {*} [options] Override http request option.
3516
3516
  * @throws {RequiredError}
3517
3517
  */
@@ -3520,7 +3520,7 @@ declare const TransactionsApiAxiosParamCreator: (configuration?: Configuration)
3520
3520
  * Creates a transaction which executes a smart contract. ABI parameters must be passed in the request. Related transactions may be submitted as a batch transaction in a single call. You must provide either a `walletId` or a `walletAddress` and `blockchain` pair in the request body.
3521
3521
  * @summary Create a contract execution transaction
3522
3522
  * @param {CreateContractExecutionTransactionForDeveloperRequest} createContractExecutionTransactionForDeveloperRequest Create transaction for developer request
3523
- * @param {string} [xRequestId] Developer-provided parameter used to identify this request. Useful when communicating with Circle Support.
3523
+ * @param {string} [xRequestId] Developer-provided identifier for this request, used for tracing requests in Wallets API logs and the Developer Console, and when communicating with Circle Support. **Must be a UUID to appear in logs.** Non-UUID values are accepted by the API but are ignored by logging and tracing systems.
3524
3524
  * @param {*} [options] Override http request option.
3525
3525
  * @throws {RequiredError}
3526
3526
  */
@@ -3529,7 +3529,7 @@ declare const TransactionsApiAxiosParamCreator: (configuration?: Configuration)
3529
3529
  * Initiates an on-chain digital asset transfer from a specified developer-controlled wallet. You must provide either a `walletId` or a `walletAddress` and `blockchain` pair in the request body.
3530
3530
  * @summary Create a transfer transaction
3531
3531
  * @param {CreateTransferTransactionForDeveloperRequest} createTransferTransactionForDeveloperRequest Create transaction for developer request
3532
- * @param {string} [xRequestId] Developer-provided parameter used to identify this request. Useful when communicating with Circle Support.
3532
+ * @param {string} [xRequestId] Developer-provided identifier for this request, used for tracing requests in Wallets API logs and the Developer Console, and when communicating with Circle Support. **Must be a UUID to appear in logs.** Non-UUID values are accepted by the API but are ignored by logging and tracing systems.
3533
3533
  * @param {*} [options] Override http request option.
3534
3534
  * @throws {RequiredError}
3535
3535
  */
@@ -3538,7 +3538,7 @@ declare const TransactionsApiAxiosParamCreator: (configuration?: Configuration)
3538
3538
  * Creates a transaction which upgrades a wallet.
3539
3539
  * @summary Create a wallet upgrade transaction
3540
3540
  * @param {CreateWalletUpgradeTransactionForDeveloperRequest} createWalletUpgradeTransactionForDeveloperRequest Creates a transaction for a developer request.
3541
- * @param {string} [xRequestId] Developer-provided parameter used to identify this request. Useful when communicating with Circle Support.
3541
+ * @param {string} [xRequestId] Developer-provided identifier for this request, used for tracing requests in Wallets API logs and the Developer Console, and when communicating with Circle Support. **Must be a UUID to appear in logs.** Non-UUID values are accepted by the API but are ignored by logging and tracing systems.
3542
3542
  * @param {*} [options] Override http request option.
3543
3543
  * @throws {RequiredError}
3544
3544
  */
@@ -3547,7 +3547,7 @@ declare const TransactionsApiAxiosParamCreator: (configuration?: Configuration)
3547
3547
  * Estimates gas fees that will be incurred for a contract execution transaction, given its ABI parameters and blockchain.
3548
3548
  * @summary Estimate fee for a contract execution transaction
3549
3549
  * @param {EstimateContractExecutionTransactionFeeRequest} estimateContractExecutionTransactionFeeRequest Estimate transaction fee request
3550
- * @param {string} [xRequestId] Developer-provided parameter used to identify this request. Useful when communicating with Circle Support.
3550
+ * @param {string} [xRequestId] Developer-provided identifier for this request, used for tracing requests in Wallets API logs and the Developer Console, and when communicating with Circle Support. **Must be a UUID to appear in logs.** Non-UUID values are accepted by the API but are ignored by logging and tracing systems.
3551
3551
  * @param {*} [options] Override http request option.
3552
3552
  * @throws {RequiredError}
3553
3553
  */
@@ -3556,7 +3556,7 @@ declare const TransactionsApiAxiosParamCreator: (configuration?: Configuration)
3556
3556
  * Estimates gas fees that will be incurred for a transfer transaction; given its amount, blockchain, and token.
3557
3557
  * @summary Estimate fee for a transfer transaction
3558
3558
  * @param {EstimateTransferTransactionFeeRequest} estimateTransferTransactionFeeRequest Estimate transaction fee request
3559
- * @param {string} [xRequestId] Developer-provided parameter used to identify this request. Useful when communicating with Circle Support.
3559
+ * @param {string} [xRequestId] Developer-provided identifier for this request, used for tracing requests in Wallets API logs and the Developer Console, and when communicating with Circle Support. **Must be a UUID to appear in logs.** Non-UUID values are accepted by the API but are ignored by logging and tracing systems.
3560
3560
  * @param {*} [options] Override http request option.
3561
3561
  * @throws {RequiredError}
3562
3562
  */
@@ -3593,7 +3593,7 @@ declare const TransactionsApiAxiosParamCreator: (configuration?: Configuration)
3593
3593
  * @summary Get a transaction
3594
3594
  * @param {string} id The universally unique identifier of the resource.
3595
3595
  * @param {TransactionType} [txType] Filter by on the transaction type.
3596
- * @param {string} [xRequestId] Developer-provided parameter used to identify this request. Useful when communicating with Circle Support.
3596
+ * @param {string} [xRequestId] Developer-provided identifier for this request, used for tracing requests in Wallets API logs and the Developer Console, and when communicating with Circle Support. **Must be a UUID to appear in logs.** Non-UUID values are accepted by the API but are ignored by logging and tracing systems.
3597
3597
  * @param {*} [options] Override http request option.
3598
3598
  * @throws {RequiredError}
3599
3599
  */
@@ -3616,7 +3616,7 @@ declare const TransactionsApiAxiosParamCreator: (configuration?: Configuration)
3616
3616
  * @param {string} [pageAfter] A collection ID value used for pagination. It marks the exclusive begin of a page. When provided, the collection resource will return the next n items after the id, with n being specified by pageSize. The items will be returned in the natural order of the collection. The resource will return the first page if neither pageAfter nor pageBefore are specified. SHOULD NOT be used in conjunction with pageBefore.
3617
3617
  * @param {number} [pageSize] Limits the number of items to be returned. Some collections have a strict upper bound that will disregard this value. In case the specified value is higher than the allowed limit, the collection limit will be used. If avoided, the collection will determine the page size itself.
3618
3618
  * @param {ListTransactionsOrderEnum} [order] Specifies the sort order of the collection by `CreateDate`. Valid values: - `ASC` – Sort results in ascending order. - `DESC` – Sort results in descending order (default).
3619
- * @param {string} [xRequestId] Developer-provided parameter used to identify this request. Useful when communicating with Circle Support.
3619
+ * @param {string} [xRequestId] Developer-provided identifier for this request, used for tracing requests in Wallets API logs and the Developer Console, and when communicating with Circle Support. **Must be a UUID to appear in logs.** Non-UUID values are accepted by the API but are ignored by logging and tracing systems.
3620
3620
  * @param {*} [options] Override http request option.
3621
3621
  * @throws {RequiredError}
3622
3622
  */
@@ -3632,7 +3632,7 @@ declare const TransactionsApiFp: (configuration?: Configuration) => {
3632
3632
  * @summary Accelerate a transaction
3633
3633
  * @param {string} id The universally unique identifier of the resource.
3634
3634
  * @param {AccelerateTransactionForDeveloperRequest} accelerateTransactionForDeveloperRequest Accelerate transaction for developer request
3635
- * @param {string} [xRequestId] Developer-provided parameter used to identify this request. Useful when communicating with Circle Support.
3635
+ * @param {string} [xRequestId] Developer-provided identifier for this request, used for tracing requests in Wallets API logs and the Developer Console, and when communicating with Circle Support. **Must be a UUID to appear in logs.** Non-UUID values are accepted by the API but are ignored by logging and tracing systems.
3636
3636
  * @param {*} [options] Override http request option.
3637
3637
  * @throws {RequiredError}
3638
3638
  */
@@ -3642,7 +3642,7 @@ declare const TransactionsApiFp: (configuration?: Configuration) => {
3642
3642
  * @summary Cancel a transaction
3643
3643
  * @param {string} id The universally unique identifier of the resource.
3644
3644
  * @param {CancelTransactionForDeveloperRequest} cancelTransactionForDeveloperRequest Cancel transaction for developer request
3645
- * @param {string} [xRequestId] Developer-provided parameter used to identify this request. Useful when communicating with Circle Support.
3645
+ * @param {string} [xRequestId] Developer-provided identifier for this request, used for tracing requests in Wallets API logs and the Developer Console, and when communicating with Circle Support. **Must be a UUID to appear in logs.** Non-UUID values are accepted by the API but are ignored by logging and tracing systems.
3646
3646
  * @param {*} [options] Override http request option.
3647
3647
  * @throws {RequiredError}
3648
3648
  */
@@ -3651,7 +3651,7 @@ declare const TransactionsApiFp: (configuration?: Configuration) => {
3651
3651
  * Creates a transaction which executes a smart contract. ABI parameters must be passed in the request. Related transactions may be submitted as a batch transaction in a single call. You must provide either a `walletId` or a `walletAddress` and `blockchain` pair in the request body.
3652
3652
  * @summary Create a contract execution transaction
3653
3653
  * @param {CreateContractExecutionTransactionForDeveloperRequest} createContractExecutionTransactionForDeveloperRequest Create transaction for developer request
3654
- * @param {string} [xRequestId] Developer-provided parameter used to identify this request. Useful when communicating with Circle Support.
3654
+ * @param {string} [xRequestId] Developer-provided identifier for this request, used for tracing requests in Wallets API logs and the Developer Console, and when communicating with Circle Support. **Must be a UUID to appear in logs.** Non-UUID values are accepted by the API but are ignored by logging and tracing systems.
3655
3655
  * @param {*} [options] Override http request option.
3656
3656
  * @throws {RequiredError}
3657
3657
  */
@@ -3660,7 +3660,7 @@ declare const TransactionsApiFp: (configuration?: Configuration) => {
3660
3660
  * Initiates an on-chain digital asset transfer from a specified developer-controlled wallet. You must provide either a `walletId` or a `walletAddress` and `blockchain` pair in the request body.
3661
3661
  * @summary Create a transfer transaction
3662
3662
  * @param {CreateTransferTransactionForDeveloperRequest} createTransferTransactionForDeveloperRequest Create transaction for developer request
3663
- * @param {string} [xRequestId] Developer-provided parameter used to identify this request. Useful when communicating with Circle Support.
3663
+ * @param {string} [xRequestId] Developer-provided identifier for this request, used for tracing requests in Wallets API logs and the Developer Console, and when communicating with Circle Support. **Must be a UUID to appear in logs.** Non-UUID values are accepted by the API but are ignored by logging and tracing systems.
3664
3664
  * @param {*} [options] Override http request option.
3665
3665
  * @throws {RequiredError}
3666
3666
  */
@@ -3669,7 +3669,7 @@ declare const TransactionsApiFp: (configuration?: Configuration) => {
3669
3669
  * Creates a transaction which upgrades a wallet.
3670
3670
  * @summary Create a wallet upgrade transaction
3671
3671
  * @param {CreateWalletUpgradeTransactionForDeveloperRequest} createWalletUpgradeTransactionForDeveloperRequest Creates a transaction for a developer request.
3672
- * @param {string} [xRequestId] Developer-provided parameter used to identify this request. Useful when communicating with Circle Support.
3672
+ * @param {string} [xRequestId] Developer-provided identifier for this request, used for tracing requests in Wallets API logs and the Developer Console, and when communicating with Circle Support. **Must be a UUID to appear in logs.** Non-UUID values are accepted by the API but are ignored by logging and tracing systems.
3673
3673
  * @param {*} [options] Override http request option.
3674
3674
  * @throws {RequiredError}
3675
3675
  */
@@ -3678,7 +3678,7 @@ declare const TransactionsApiFp: (configuration?: Configuration) => {
3678
3678
  * Estimates gas fees that will be incurred for a contract execution transaction, given its ABI parameters and blockchain.
3679
3679
  * @summary Estimate fee for a contract execution transaction
3680
3680
  * @param {EstimateContractExecutionTransactionFeeRequest} estimateContractExecutionTransactionFeeRequest Estimate transaction fee request
3681
- * @param {string} [xRequestId] Developer-provided parameter used to identify this request. Useful when communicating with Circle Support.
3681
+ * @param {string} [xRequestId] Developer-provided identifier for this request, used for tracing requests in Wallets API logs and the Developer Console, and when communicating with Circle Support. **Must be a UUID to appear in logs.** Non-UUID values are accepted by the API but are ignored by logging and tracing systems.
3682
3682
  * @param {*} [options] Override http request option.
3683
3683
  * @throws {RequiredError}
3684
3684
  */
@@ -3687,7 +3687,7 @@ declare const TransactionsApiFp: (configuration?: Configuration) => {
3687
3687
  * Estimates gas fees that will be incurred for a transfer transaction; given its amount, blockchain, and token.
3688
3688
  * @summary Estimate fee for a transfer transaction
3689
3689
  * @param {EstimateTransferTransactionFeeRequest} estimateTransferTransactionFeeRequest Estimate transaction fee request
3690
- * @param {string} [xRequestId] Developer-provided parameter used to identify this request. Useful when communicating with Circle Support.
3690
+ * @param {string} [xRequestId] Developer-provided identifier for this request, used for tracing requests in Wallets API logs and the Developer Console, and when communicating with Circle Support. **Must be a UUID to appear in logs.** Non-UUID values are accepted by the API but are ignored by logging and tracing systems.
3691
3691
  * @param {*} [options] Override http request option.
3692
3692
  * @throws {RequiredError}
3693
3693
  */
@@ -3724,7 +3724,7 @@ declare const TransactionsApiFp: (configuration?: Configuration) => {
3724
3724
  * @summary Get a transaction
3725
3725
  * @param {string} id The universally unique identifier of the resource.
3726
3726
  * @param {TransactionType} [txType] Filter by on the transaction type.
3727
- * @param {string} [xRequestId] Developer-provided parameter used to identify this request. Useful when communicating with Circle Support.
3727
+ * @param {string} [xRequestId] Developer-provided identifier for this request, used for tracing requests in Wallets API logs and the Developer Console, and when communicating with Circle Support. **Must be a UUID to appear in logs.** Non-UUID values are accepted by the API but are ignored by logging and tracing systems.
3728
3728
  * @param {*} [options] Override http request option.
3729
3729
  * @throws {RequiredError}
3730
3730
  */
@@ -3747,7 +3747,7 @@ declare const TransactionsApiFp: (configuration?: Configuration) => {
3747
3747
  * @param {string} [pageAfter] A collection ID value used for pagination. It marks the exclusive begin of a page. When provided, the collection resource will return the next n items after the id, with n being specified by pageSize. The items will be returned in the natural order of the collection. The resource will return the first page if neither pageAfter nor pageBefore are specified. SHOULD NOT be used in conjunction with pageBefore.
3748
3748
  * @param {number} [pageSize] Limits the number of items to be returned. Some collections have a strict upper bound that will disregard this value. In case the specified value is higher than the allowed limit, the collection limit will be used. If avoided, the collection will determine the page size itself.
3749
3749
  * @param {ListTransactionsOrderEnum} [order] Specifies the sort order of the collection by `CreateDate`. Valid values: - `ASC` – Sort results in ascending order. - `DESC` – Sort results in descending order (default).
3750
- * @param {string} [xRequestId] Developer-provided parameter used to identify this request. Useful when communicating with Circle Support.
3750
+ * @param {string} [xRequestId] Developer-provided identifier for this request, used for tracing requests in Wallets API logs and the Developer Console, and when communicating with Circle Support. **Must be a UUID to appear in logs.** Non-UUID values are accepted by the API but are ignored by logging and tracing systems.
3751
3751
  * @param {*} [options] Override http request option.
3752
3752
  * @throws {RequiredError}
3753
3753
  */
@@ -3763,7 +3763,7 @@ declare const TransactionsApiFactory: (configuration?: Configuration, basePath?:
3763
3763
  * @summary Accelerate a transaction
3764
3764
  * @param {string} id The universally unique identifier of the resource.
3765
3765
  * @param {AccelerateTransactionForDeveloperRequest} accelerateTransactionForDeveloperRequest Accelerate transaction for developer request
3766
- * @param {string} [xRequestId] Developer-provided parameter used to identify this request. Useful when communicating with Circle Support.
3766
+ * @param {string} [xRequestId] Developer-provided identifier for this request, used for tracing requests in Wallets API logs and the Developer Console, and when communicating with Circle Support. **Must be a UUID to appear in logs.** Non-UUID values are accepted by the API but are ignored by logging and tracing systems.
3767
3767
  * @param {*} [options] Override http request option.
3768
3768
  * @throws {RequiredError}
3769
3769
  */
@@ -3773,7 +3773,7 @@ declare const TransactionsApiFactory: (configuration?: Configuration, basePath?:
3773
3773
  * @summary Cancel a transaction
3774
3774
  * @param {string} id The universally unique identifier of the resource.
3775
3775
  * @param {CancelTransactionForDeveloperRequest} cancelTransactionForDeveloperRequest Cancel transaction for developer request
3776
- * @param {string} [xRequestId] Developer-provided parameter used to identify this request. Useful when communicating with Circle Support.
3776
+ * @param {string} [xRequestId] Developer-provided identifier for this request, used for tracing requests in Wallets API logs and the Developer Console, and when communicating with Circle Support. **Must be a UUID to appear in logs.** Non-UUID values are accepted by the API but are ignored by logging and tracing systems.
3777
3777
  * @param {*} [options] Override http request option.
3778
3778
  * @throws {RequiredError}
3779
3779
  */
@@ -3782,7 +3782,7 @@ declare const TransactionsApiFactory: (configuration?: Configuration, basePath?:
3782
3782
  * Creates a transaction which executes a smart contract. ABI parameters must be passed in the request. Related transactions may be submitted as a batch transaction in a single call. You must provide either a `walletId` or a `walletAddress` and `blockchain` pair in the request body.
3783
3783
  * @summary Create a contract execution transaction
3784
3784
  * @param {CreateContractExecutionTransactionForDeveloperRequest} createContractExecutionTransactionForDeveloperRequest Create transaction for developer request
3785
- * @param {string} [xRequestId] Developer-provided parameter used to identify this request. Useful when communicating with Circle Support.
3785
+ * @param {string} [xRequestId] Developer-provided identifier for this request, used for tracing requests in Wallets API logs and the Developer Console, and when communicating with Circle Support. **Must be a UUID to appear in logs.** Non-UUID values are accepted by the API but are ignored by logging and tracing systems.
3786
3786
  * @param {*} [options] Override http request option.
3787
3787
  * @throws {RequiredError}
3788
3788
  */
@@ -3791,7 +3791,7 @@ declare const TransactionsApiFactory: (configuration?: Configuration, basePath?:
3791
3791
  * Initiates an on-chain digital asset transfer from a specified developer-controlled wallet. You must provide either a `walletId` or a `walletAddress` and `blockchain` pair in the request body.
3792
3792
  * @summary Create a transfer transaction
3793
3793
  * @param {CreateTransferTransactionForDeveloperRequest} createTransferTransactionForDeveloperRequest Create transaction for developer request
3794
- * @param {string} [xRequestId] Developer-provided parameter used to identify this request. Useful when communicating with Circle Support.
3794
+ * @param {string} [xRequestId] Developer-provided identifier for this request, used for tracing requests in Wallets API logs and the Developer Console, and when communicating with Circle Support. **Must be a UUID to appear in logs.** Non-UUID values are accepted by the API but are ignored by logging and tracing systems.
3795
3795
  * @param {*} [options] Override http request option.
3796
3796
  * @throws {RequiredError}
3797
3797
  */
@@ -3800,7 +3800,7 @@ declare const TransactionsApiFactory: (configuration?: Configuration, basePath?:
3800
3800
  * Creates a transaction which upgrades a wallet.
3801
3801
  * @summary Create a wallet upgrade transaction
3802
3802
  * @param {CreateWalletUpgradeTransactionForDeveloperRequest} createWalletUpgradeTransactionForDeveloperRequest Creates a transaction for a developer request.
3803
- * @param {string} [xRequestId] Developer-provided parameter used to identify this request. Useful when communicating with Circle Support.
3803
+ * @param {string} [xRequestId] Developer-provided identifier for this request, used for tracing requests in Wallets API logs and the Developer Console, and when communicating with Circle Support. **Must be a UUID to appear in logs.** Non-UUID values are accepted by the API but are ignored by logging and tracing systems.
3804
3804
  * @param {*} [options] Override http request option.
3805
3805
  * @throws {RequiredError}
3806
3806
  */
@@ -3809,7 +3809,7 @@ declare const TransactionsApiFactory: (configuration?: Configuration, basePath?:
3809
3809
  * Estimates gas fees that will be incurred for a contract execution transaction, given its ABI parameters and blockchain.
3810
3810
  * @summary Estimate fee for a contract execution transaction
3811
3811
  * @param {EstimateContractExecutionTransactionFeeRequest} estimateContractExecutionTransactionFeeRequest Estimate transaction fee request
3812
- * @param {string} [xRequestId] Developer-provided parameter used to identify this request. Useful when communicating with Circle Support.
3812
+ * @param {string} [xRequestId] Developer-provided identifier for this request, used for tracing requests in Wallets API logs and the Developer Console, and when communicating with Circle Support. **Must be a UUID to appear in logs.** Non-UUID values are accepted by the API but are ignored by logging and tracing systems.
3813
3813
  * @param {*} [options] Override http request option.
3814
3814
  * @throws {RequiredError}
3815
3815
  */
@@ -3818,7 +3818,7 @@ declare const TransactionsApiFactory: (configuration?: Configuration, basePath?:
3818
3818
  * Estimates gas fees that will be incurred for a transfer transaction; given its amount, blockchain, and token.
3819
3819
  * @summary Estimate fee for a transfer transaction
3820
3820
  * @param {EstimateTransferTransactionFeeRequest} estimateTransferTransactionFeeRequest Estimate transaction fee request
3821
- * @param {string} [xRequestId] Developer-provided parameter used to identify this request. Useful when communicating with Circle Support.
3821
+ * @param {string} [xRequestId] Developer-provided identifier for this request, used for tracing requests in Wallets API logs and the Developer Console, and when communicating with Circle Support. **Must be a UUID to appear in logs.** Non-UUID values are accepted by the API but are ignored by logging and tracing systems.
3822
3822
  * @param {*} [options] Override http request option.
3823
3823
  * @throws {RequiredError}
3824
3824
  */
@@ -3855,7 +3855,7 @@ declare const TransactionsApiFactory: (configuration?: Configuration, basePath?:
3855
3855
  * @summary Get a transaction
3856
3856
  * @param {string} id The universally unique identifier of the resource.
3857
3857
  * @param {TransactionType} [txType] Filter by on the transaction type.
3858
- * @param {string} [xRequestId] Developer-provided parameter used to identify this request. Useful when communicating with Circle Support.
3858
+ * @param {string} [xRequestId] Developer-provided identifier for this request, used for tracing requests in Wallets API logs and the Developer Console, and when communicating with Circle Support. **Must be a UUID to appear in logs.** Non-UUID values are accepted by the API but are ignored by logging and tracing systems.
3859
3859
  * @param {*} [options] Override http request option.
3860
3860
  * @throws {RequiredError}
3861
3861
  */
@@ -3878,7 +3878,7 @@ declare const TransactionsApiFactory: (configuration?: Configuration, basePath?:
3878
3878
  * @param {string} [pageAfter] A collection ID value used for pagination. It marks the exclusive begin of a page. When provided, the collection resource will return the next n items after the id, with n being specified by pageSize. The items will be returned in the natural order of the collection. The resource will return the first page if neither pageAfter nor pageBefore are specified. SHOULD NOT be used in conjunction with pageBefore.
3879
3879
  * @param {number} [pageSize] Limits the number of items to be returned. Some collections have a strict upper bound that will disregard this value. In case the specified value is higher than the allowed limit, the collection limit will be used. If avoided, the collection will determine the page size itself.
3880
3880
  * @param {ListTransactionsOrderEnum} [order] Specifies the sort order of the collection by `CreateDate`. Valid values: - `ASC` – Sort results in ascending order. - `DESC` – Sort results in descending order (default).
3881
- * @param {string} [xRequestId] Developer-provided parameter used to identify this request. Useful when communicating with Circle Support.
3881
+ * @param {string} [xRequestId] Developer-provided identifier for this request, used for tracing requests in Wallets API logs and the Developer Console, and when communicating with Circle Support. **Must be a UUID to appear in logs.** Non-UUID values are accepted by the API but are ignored by logging and tracing systems.
3882
3882
  * @param {*} [options] Override http request option.
3883
3883
  * @throws {RequiredError}
3884
3884
  */
@@ -3896,7 +3896,7 @@ declare class TransactionsApi extends BaseAPI {
3896
3896
  * @summary Accelerate a transaction
3897
3897
  * @param {string} id The universally unique identifier of the resource.
3898
3898
  * @param {AccelerateTransactionForDeveloperRequest} accelerateTransactionForDeveloperRequest Accelerate transaction for developer request
3899
- * @param {string} [xRequestId] Developer-provided parameter used to identify this request. Useful when communicating with Circle Support.
3899
+ * @param {string} [xRequestId] Developer-provided identifier for this request, used for tracing requests in Wallets API logs and the Developer Console, and when communicating with Circle Support. **Must be a UUID to appear in logs.** Non-UUID values are accepted by the API but are ignored by logging and tracing systems.
3900
3900
  * @param {*} [options] Override http request option.
3901
3901
  * @throws {RequiredError}
3902
3902
  * @memberof TransactionsApi
@@ -3907,7 +3907,7 @@ declare class TransactionsApi extends BaseAPI {
3907
3907
  * @summary Cancel a transaction
3908
3908
  * @param {string} id The universally unique identifier of the resource.
3909
3909
  * @param {CancelTransactionForDeveloperRequest} cancelTransactionForDeveloperRequest Cancel transaction for developer request
3910
- * @param {string} [xRequestId] Developer-provided parameter used to identify this request. Useful when communicating with Circle Support.
3910
+ * @param {string} [xRequestId] Developer-provided identifier for this request, used for tracing requests in Wallets API logs and the Developer Console, and when communicating with Circle Support. **Must be a UUID to appear in logs.** Non-UUID values are accepted by the API but are ignored by logging and tracing systems.
3911
3911
  * @param {*} [options] Override http request option.
3912
3912
  * @throws {RequiredError}
3913
3913
  * @memberof TransactionsApi
@@ -3917,7 +3917,7 @@ declare class TransactionsApi extends BaseAPI {
3917
3917
  * Creates a transaction which executes a smart contract. ABI parameters must be passed in the request. Related transactions may be submitted as a batch transaction in a single call. You must provide either a `walletId` or a `walletAddress` and `blockchain` pair in the request body.
3918
3918
  * @summary Create a contract execution transaction
3919
3919
  * @param {CreateContractExecutionTransactionForDeveloperRequest} createContractExecutionTransactionForDeveloperRequest Create transaction for developer request
3920
- * @param {string} [xRequestId] Developer-provided parameter used to identify this request. Useful when communicating with Circle Support.
3920
+ * @param {string} [xRequestId] Developer-provided identifier for this request, used for tracing requests in Wallets API logs and the Developer Console, and when communicating with Circle Support. **Must be a UUID to appear in logs.** Non-UUID values are accepted by the API but are ignored by logging and tracing systems.
3921
3921
  * @param {*} [options] Override http request option.
3922
3922
  * @throws {RequiredError}
3923
3923
  * @memberof TransactionsApi
@@ -3927,7 +3927,7 @@ declare class TransactionsApi extends BaseAPI {
3927
3927
  * Initiates an on-chain digital asset transfer from a specified developer-controlled wallet. You must provide either a `walletId` or a `walletAddress` and `blockchain` pair in the request body.
3928
3928
  * @summary Create a transfer transaction
3929
3929
  * @param {CreateTransferTransactionForDeveloperRequest} createTransferTransactionForDeveloperRequest Create transaction for developer request
3930
- * @param {string} [xRequestId] Developer-provided parameter used to identify this request. Useful when communicating with Circle Support.
3930
+ * @param {string} [xRequestId] Developer-provided identifier for this request, used for tracing requests in Wallets API logs and the Developer Console, and when communicating with Circle Support. **Must be a UUID to appear in logs.** Non-UUID values are accepted by the API but are ignored by logging and tracing systems.
3931
3931
  * @param {*} [options] Override http request option.
3932
3932
  * @throws {RequiredError}
3933
3933
  * @memberof TransactionsApi
@@ -3937,7 +3937,7 @@ declare class TransactionsApi extends BaseAPI {
3937
3937
  * Creates a transaction which upgrades a wallet.
3938
3938
  * @summary Create a wallet upgrade transaction
3939
3939
  * @param {CreateWalletUpgradeTransactionForDeveloperRequest} createWalletUpgradeTransactionForDeveloperRequest Creates a transaction for a developer request.
3940
- * @param {string} [xRequestId] Developer-provided parameter used to identify this request. Useful when communicating with Circle Support.
3940
+ * @param {string} [xRequestId] Developer-provided identifier for this request, used for tracing requests in Wallets API logs and the Developer Console, and when communicating with Circle Support. **Must be a UUID to appear in logs.** Non-UUID values are accepted by the API but are ignored by logging and tracing systems.
3941
3941
  * @param {*} [options] Override http request option.
3942
3942
  * @throws {RequiredError}
3943
3943
  * @memberof TransactionsApi
@@ -3947,7 +3947,7 @@ declare class TransactionsApi extends BaseAPI {
3947
3947
  * Estimates gas fees that will be incurred for a contract execution transaction, given its ABI parameters and blockchain.
3948
3948
  * @summary Estimate fee for a contract execution transaction
3949
3949
  * @param {EstimateContractExecutionTransactionFeeRequest} estimateContractExecutionTransactionFeeRequest Estimate transaction fee request
3950
- * @param {string} [xRequestId] Developer-provided parameter used to identify this request. Useful when communicating with Circle Support.
3950
+ * @param {string} [xRequestId] Developer-provided identifier for this request, used for tracing requests in Wallets API logs and the Developer Console, and when communicating with Circle Support. **Must be a UUID to appear in logs.** Non-UUID values are accepted by the API but are ignored by logging and tracing systems.
3951
3951
  * @param {*} [options] Override http request option.
3952
3952
  * @throws {RequiredError}
3953
3953
  * @memberof TransactionsApi
@@ -3957,7 +3957,7 @@ declare class TransactionsApi extends BaseAPI {
3957
3957
  * Estimates gas fees that will be incurred for a transfer transaction; given its amount, blockchain, and token.
3958
3958
  * @summary Estimate fee for a transfer transaction
3959
3959
  * @param {EstimateTransferTransactionFeeRequest} estimateTransferTransactionFeeRequest Estimate transaction fee request
3960
- * @param {string} [xRequestId] Developer-provided parameter used to identify this request. Useful when communicating with Circle Support.
3960
+ * @param {string} [xRequestId] Developer-provided identifier for this request, used for tracing requests in Wallets API logs and the Developer Console, and when communicating with Circle Support. **Must be a UUID to appear in logs.** Non-UUID values are accepted by the API but are ignored by logging and tracing systems.
3961
3961
  * @param {*} [options] Override http request option.
3962
3962
  * @throws {RequiredError}
3963
3963
  * @memberof TransactionsApi
@@ -3998,7 +3998,7 @@ declare class TransactionsApi extends BaseAPI {
3998
3998
  * @summary Get a transaction
3999
3999
  * @param {string} id The universally unique identifier of the resource.
4000
4000
  * @param {TransactionType} [txType] Filter by on the transaction type.
4001
- * @param {string} [xRequestId] Developer-provided parameter used to identify this request. Useful when communicating with Circle Support.
4001
+ * @param {string} [xRequestId] Developer-provided identifier for this request, used for tracing requests in Wallets API logs and the Developer Console, and when communicating with Circle Support. **Must be a UUID to appear in logs.** Non-UUID values are accepted by the API but are ignored by logging and tracing systems.
4002
4002
  * @param {*} [options] Override http request option.
4003
4003
  * @throws {RequiredError}
4004
4004
  * @memberof TransactionsApi
@@ -4022,7 +4022,7 @@ declare class TransactionsApi extends BaseAPI {
4022
4022
  * @param {string} [pageAfter] A collection ID value used for pagination. It marks the exclusive begin of a page. When provided, the collection resource will return the next n items after the id, with n being specified by pageSize. The items will be returned in the natural order of the collection. The resource will return the first page if neither pageAfter nor pageBefore are specified. SHOULD NOT be used in conjunction with pageBefore.
4023
4023
  * @param {number} [pageSize] Limits the number of items to be returned. Some collections have a strict upper bound that will disregard this value. In case the specified value is higher than the allowed limit, the collection limit will be used. If avoided, the collection will determine the page size itself.
4024
4024
  * @param {ListTransactionsOrderEnum} [order] Specifies the sort order of the collection by `CreateDate`. Valid values: - `ASC` – Sort results in ascending order. - `DESC` – Sort results in descending order (default).
4025
- * @param {string} [xRequestId] Developer-provided parameter used to identify this request. Useful when communicating with Circle Support.
4025
+ * @param {string} [xRequestId] Developer-provided identifier for this request, used for tracing requests in Wallets API logs and the Developer Console, and when communicating with Circle Support. **Must be a UUID to appear in logs.** Non-UUID values are accepted by the API but are ignored by logging and tracing systems.
4026
4026
  * @param {*} [options] Override http request option.
4027
4027
  * @throws {RequiredError}
4028
4028
  * @memberof TransactionsApi
@@ -4056,7 +4056,7 @@ declare const WalletSetsApiAxiosParamCreator: (configuration?: Configuration) =>
4056
4056
  * Creates a new developer-controlled wallet set. **Note:** A developer account can create up to 1,000 wallet sets, with each set supporting up to 10 million wallets. To ensure EVM wallets are created with the same address across chains, see [Unified Wallet Addressing on EVM Chains](/w3s/unified-wallet-addressing-evm).
4057
4057
  * @summary Create a new wallet set
4058
4058
  * @param {CreateWalletSetRequest} createWalletSetRequest Schema for the request payload to create a new wallet set.
4059
- * @param {string} [xRequestId] Developer-provided parameter used to identify this request. Useful when communicating with Circle Support.
4059
+ * @param {string} [xRequestId] Developer-provided identifier for this request, used for tracing requests in Wallets API logs and the Developer Console, and when communicating with Circle Support. **Must be a UUID to appear in logs.** Non-UUID values are accepted by the API but are ignored by logging and tracing systems.
4060
4060
  * @param {*} [options] Override http request option.
4061
4061
  * @throws {RequiredError}
4062
4062
  */
@@ -4065,7 +4065,7 @@ declare const WalletSetsApiAxiosParamCreator: (configuration?: Configuration) =>
4065
4065
  * Retrieve an existing wallet set.
4066
4066
  * @summary Get a wallet set
4067
4067
  * @param {string} id The universally unique identifier of the resource.
4068
- * @param {string} [xRequestId] Developer-provided parameter used to identify this request. Useful when communicating with Circle Support.
4068
+ * @param {string} [xRequestId] Developer-provided identifier for this request, used for tracing requests in Wallets API logs and the Developer Console, and when communicating with Circle Support. **Must be a UUID to appear in logs.** Non-UUID values are accepted by the API but are ignored by logging and tracing systems.
4069
4069
  * @param {*} [options] Override http request option.
4070
4070
  * @throws {RequiredError}
4071
4071
  */
@@ -4073,7 +4073,7 @@ declare const WalletSetsApiAxiosParamCreator: (configuration?: Configuration) =>
4073
4073
  /**
4074
4074
  * Retrieve an array of existing wallet sets.
4075
4075
  * @summary Get all wallet sets
4076
- * @param {string} [xRequestId] Developer-provided parameter used to identify this request. Useful when communicating with Circle Support.
4076
+ * @param {string} [xRequestId] Developer-provided identifier for this request, used for tracing requests in Wallets API logs and the Developer Console, and when communicating with Circle Support. **Must be a UUID to appear in logs.** Non-UUID values are accepted by the API but are ignored by logging and tracing systems.
4077
4077
  * @param {string} [from] Queries items created since the specified date-time (inclusive) in ISO 8601 format.
4078
4078
  * @param {string} [to] Queries items created before the specified date-time (inclusive) in ISO 8601 format.
4079
4079
  * @param {string} [pageBefore] A collection ID value used for pagination. It marks the exclusive end of a page. When provided, the collection resource will return the next n items before the id, with n being specified by pageSize. The items will be returned in the natural order of the collection. The resource will return the first page if neither pageAfter nor pageBefore are specified. SHOULD NOT be used in conjunction with pageAfter.
@@ -4089,7 +4089,7 @@ declare const WalletSetsApiAxiosParamCreator: (configuration?: Configuration) =>
4089
4089
  * @summary Update a wallet set
4090
4090
  * @param {string} id The universally unique identifier of the resource.
4091
4091
  * @param {UpdateWalletSetRequest} updateWalletSetRequest Schema for the request payload to update an existing wallet set.
4092
- * @param {string} [xRequestId] Developer-provided parameter used to identify this request. Useful when communicating with Circle Support.
4092
+ * @param {string} [xRequestId] Developer-provided identifier for this request, used for tracing requests in Wallets API logs and the Developer Console, and when communicating with Circle Support. **Must be a UUID to appear in logs.** Non-UUID values are accepted by the API but are ignored by logging and tracing systems.
4093
4093
  * @param {*} [options] Override http request option.
4094
4094
  * @throws {RequiredError}
4095
4095
  */
@@ -4104,7 +4104,7 @@ declare const WalletSetsApiFp: (configuration?: Configuration) => {
4104
4104
  * Creates a new developer-controlled wallet set. **Note:** A developer account can create up to 1,000 wallet sets, with each set supporting up to 10 million wallets. To ensure EVM wallets are created with the same address across chains, see [Unified Wallet Addressing on EVM Chains](/w3s/unified-wallet-addressing-evm).
4105
4105
  * @summary Create a new wallet set
4106
4106
  * @param {CreateWalletSetRequest} createWalletSetRequest Schema for the request payload to create a new wallet set.
4107
- * @param {string} [xRequestId] Developer-provided parameter used to identify this request. Useful when communicating with Circle Support.
4107
+ * @param {string} [xRequestId] Developer-provided identifier for this request, used for tracing requests in Wallets API logs and the Developer Console, and when communicating with Circle Support. **Must be a UUID to appear in logs.** Non-UUID values are accepted by the API but are ignored by logging and tracing systems.
4108
4108
  * @param {*} [options] Override http request option.
4109
4109
  * @throws {RequiredError}
4110
4110
  */
@@ -4113,7 +4113,7 @@ declare const WalletSetsApiFp: (configuration?: Configuration) => {
4113
4113
  * Retrieve an existing wallet set.
4114
4114
  * @summary Get a wallet set
4115
4115
  * @param {string} id The universally unique identifier of the resource.
4116
- * @param {string} [xRequestId] Developer-provided parameter used to identify this request. Useful when communicating with Circle Support.
4116
+ * @param {string} [xRequestId] Developer-provided identifier for this request, used for tracing requests in Wallets API logs and the Developer Console, and when communicating with Circle Support. **Must be a UUID to appear in logs.** Non-UUID values are accepted by the API but are ignored by logging and tracing systems.
4117
4117
  * @param {*} [options] Override http request option.
4118
4118
  * @throws {RequiredError}
4119
4119
  */
@@ -4121,7 +4121,7 @@ declare const WalletSetsApiFp: (configuration?: Configuration) => {
4121
4121
  /**
4122
4122
  * Retrieve an array of existing wallet sets.
4123
4123
  * @summary Get all wallet sets
4124
- * @param {string} [xRequestId] Developer-provided parameter used to identify this request. Useful when communicating with Circle Support.
4124
+ * @param {string} [xRequestId] Developer-provided identifier for this request, used for tracing requests in Wallets API logs and the Developer Console, and when communicating with Circle Support. **Must be a UUID to appear in logs.** Non-UUID values are accepted by the API but are ignored by logging and tracing systems.
4125
4125
  * @param {string} [from] Queries items created since the specified date-time (inclusive) in ISO 8601 format.
4126
4126
  * @param {string} [to] Queries items created before the specified date-time (inclusive) in ISO 8601 format.
4127
4127
  * @param {string} [pageBefore] A collection ID value used for pagination. It marks the exclusive end of a page. When provided, the collection resource will return the next n items before the id, with n being specified by pageSize. The items will be returned in the natural order of the collection. The resource will return the first page if neither pageAfter nor pageBefore are specified. SHOULD NOT be used in conjunction with pageAfter.
@@ -4137,7 +4137,7 @@ declare const WalletSetsApiFp: (configuration?: Configuration) => {
4137
4137
  * @summary Update a wallet set
4138
4138
  * @param {string} id The universally unique identifier of the resource.
4139
4139
  * @param {UpdateWalletSetRequest} updateWalletSetRequest Schema for the request payload to update an existing wallet set.
4140
- * @param {string} [xRequestId] Developer-provided parameter used to identify this request. Useful when communicating with Circle Support.
4140
+ * @param {string} [xRequestId] Developer-provided identifier for this request, used for tracing requests in Wallets API logs and the Developer Console, and when communicating with Circle Support. **Must be a UUID to appear in logs.** Non-UUID values are accepted by the API but are ignored by logging and tracing systems.
4141
4141
  * @param {*} [options] Override http request option.
4142
4142
  * @throws {RequiredError}
4143
4143
  */
@@ -4152,7 +4152,7 @@ declare const WalletSetsApiFactory: (configuration?: Configuration, basePath?: s
4152
4152
  * Creates a new developer-controlled wallet set. **Note:** A developer account can create up to 1,000 wallet sets, with each set supporting up to 10 million wallets. To ensure EVM wallets are created with the same address across chains, see [Unified Wallet Addressing on EVM Chains](/w3s/unified-wallet-addressing-evm).
4153
4153
  * @summary Create a new wallet set
4154
4154
  * @param {CreateWalletSetRequest} createWalletSetRequest Schema for the request payload to create a new wallet set.
4155
- * @param {string} [xRequestId] Developer-provided parameter used to identify this request. Useful when communicating with Circle Support.
4155
+ * @param {string} [xRequestId] Developer-provided identifier for this request, used for tracing requests in Wallets API logs and the Developer Console, and when communicating with Circle Support. **Must be a UUID to appear in logs.** Non-UUID values are accepted by the API but are ignored by logging and tracing systems.
4156
4156
  * @param {*} [options] Override http request option.
4157
4157
  * @throws {RequiredError}
4158
4158
  */
@@ -4161,7 +4161,7 @@ declare const WalletSetsApiFactory: (configuration?: Configuration, basePath?: s
4161
4161
  * Retrieve an existing wallet set.
4162
4162
  * @summary Get a wallet set
4163
4163
  * @param {string} id The universally unique identifier of the resource.
4164
- * @param {string} [xRequestId] Developer-provided parameter used to identify this request. Useful when communicating with Circle Support.
4164
+ * @param {string} [xRequestId] Developer-provided identifier for this request, used for tracing requests in Wallets API logs and the Developer Console, and when communicating with Circle Support. **Must be a UUID to appear in logs.** Non-UUID values are accepted by the API but are ignored by logging and tracing systems.
4165
4165
  * @param {*} [options] Override http request option.
4166
4166
  * @throws {RequiredError}
4167
4167
  */
@@ -4169,7 +4169,7 @@ declare const WalletSetsApiFactory: (configuration?: Configuration, basePath?: s
4169
4169
  /**
4170
4170
  * Retrieve an array of existing wallet sets.
4171
4171
  * @summary Get all wallet sets
4172
- * @param {string} [xRequestId] Developer-provided parameter used to identify this request. Useful when communicating with Circle Support.
4172
+ * @param {string} [xRequestId] Developer-provided identifier for this request, used for tracing requests in Wallets API logs and the Developer Console, and when communicating with Circle Support. **Must be a UUID to appear in logs.** Non-UUID values are accepted by the API but are ignored by logging and tracing systems.
4173
4173
  * @param {string} [from] Queries items created since the specified date-time (inclusive) in ISO 8601 format.
4174
4174
  * @param {string} [to] Queries items created before the specified date-time (inclusive) in ISO 8601 format.
4175
4175
  * @param {string} [pageBefore] A collection ID value used for pagination. It marks the exclusive end of a page. When provided, the collection resource will return the next n items before the id, with n being specified by pageSize. The items will be returned in the natural order of the collection. The resource will return the first page if neither pageAfter nor pageBefore are specified. SHOULD NOT be used in conjunction with pageAfter.
@@ -4185,7 +4185,7 @@ declare const WalletSetsApiFactory: (configuration?: Configuration, basePath?: s
4185
4185
  * @summary Update a wallet set
4186
4186
  * @param {string} id The universally unique identifier of the resource.
4187
4187
  * @param {UpdateWalletSetRequest} updateWalletSetRequest Schema for the request payload to update an existing wallet set.
4188
- * @param {string} [xRequestId] Developer-provided parameter used to identify this request. Useful when communicating with Circle Support.
4188
+ * @param {string} [xRequestId] Developer-provided identifier for this request, used for tracing requests in Wallets API logs and the Developer Console, and when communicating with Circle Support. **Must be a UUID to appear in logs.** Non-UUID values are accepted by the API but are ignored by logging and tracing systems.
4189
4189
  * @param {*} [options] Override http request option.
4190
4190
  * @throws {RequiredError}
4191
4191
  */
@@ -4202,7 +4202,7 @@ declare class WalletSetsApi extends BaseAPI {
4202
4202
  * Creates a new developer-controlled wallet set. **Note:** A developer account can create up to 1,000 wallet sets, with each set supporting up to 10 million wallets. To ensure EVM wallets are created with the same address across chains, see [Unified Wallet Addressing on EVM Chains](/w3s/unified-wallet-addressing-evm).
4203
4203
  * @summary Create a new wallet set
4204
4204
  * @param {CreateWalletSetRequest} createWalletSetRequest Schema for the request payload to create a new wallet set.
4205
- * @param {string} [xRequestId] Developer-provided parameter used to identify this request. Useful when communicating with Circle Support.
4205
+ * @param {string} [xRequestId] Developer-provided identifier for this request, used for tracing requests in Wallets API logs and the Developer Console, and when communicating with Circle Support. **Must be a UUID to appear in logs.** Non-UUID values are accepted by the API but are ignored by logging and tracing systems.
4206
4206
  * @param {*} [options] Override http request option.
4207
4207
  * @throws {RequiredError}
4208
4208
  * @memberof WalletSetsApi
@@ -4212,7 +4212,7 @@ declare class WalletSetsApi extends BaseAPI {
4212
4212
  * Retrieve an existing wallet set.
4213
4213
  * @summary Get a wallet set
4214
4214
  * @param {string} id The universally unique identifier of the resource.
4215
- * @param {string} [xRequestId] Developer-provided parameter used to identify this request. Useful when communicating with Circle Support.
4215
+ * @param {string} [xRequestId] Developer-provided identifier for this request, used for tracing requests in Wallets API logs and the Developer Console, and when communicating with Circle Support. **Must be a UUID to appear in logs.** Non-UUID values are accepted by the API but are ignored by logging and tracing systems.
4216
4216
  * @param {*} [options] Override http request option.
4217
4217
  * @throws {RequiredError}
4218
4218
  * @memberof WalletSetsApi
@@ -4221,7 +4221,7 @@ declare class WalletSetsApi extends BaseAPI {
4221
4221
  /**
4222
4222
  * Retrieve an array of existing wallet sets.
4223
4223
  * @summary Get all wallet sets
4224
- * @param {string} [xRequestId] Developer-provided parameter used to identify this request. Useful when communicating with Circle Support.
4224
+ * @param {string} [xRequestId] Developer-provided identifier for this request, used for tracing requests in Wallets API logs and the Developer Console, and when communicating with Circle Support. **Must be a UUID to appear in logs.** Non-UUID values are accepted by the API but are ignored by logging and tracing systems.
4225
4225
  * @param {string} [from] Queries items created since the specified date-time (inclusive) in ISO 8601 format.
4226
4226
  * @param {string} [to] Queries items created before the specified date-time (inclusive) in ISO 8601 format.
4227
4227
  * @param {string} [pageBefore] A collection ID value used for pagination. It marks the exclusive end of a page. When provided, the collection resource will return the next n items before the id, with n being specified by pageSize. The items will be returned in the natural order of the collection. The resource will return the first page if neither pageAfter nor pageBefore are specified. SHOULD NOT be used in conjunction with pageAfter.
@@ -4238,7 +4238,7 @@ declare class WalletSetsApi extends BaseAPI {
4238
4238
  * @summary Update a wallet set
4239
4239
  * @param {string} id The universally unique identifier of the resource.
4240
4240
  * @param {UpdateWalletSetRequest} updateWalletSetRequest Schema for the request payload to update an existing wallet set.
4241
- * @param {string} [xRequestId] Developer-provided parameter used to identify this request. Useful when communicating with Circle Support.
4241
+ * @param {string} [xRequestId] Developer-provided identifier for this request, used for tracing requests in Wallets API logs and the Developer Console, and when communicating with Circle Support. **Must be a UUID to appear in logs.** Non-UUID values are accepted by the API but are ignored by logging and tracing systems.
4242
4242
  * @param {*} [options] Override http request option.
4243
4243
  * @throws {RequiredError}
4244
4244
  * @memberof WalletSetsApi
@@ -4263,7 +4263,7 @@ declare const WalletsApiAxiosParamCreator: (configuration?: Configuration) => {
4263
4263
  * Creates a new developer-controlled wallet or a batch of wallets within a wallet set, given the target blockchain and wallet name. **Note:** Each `walletSetId` supports a maximum of 10 million wallets.
4264
4264
  * @summary Create wallets
4265
4265
  * @param {CreateWalletRequest} createWalletRequest Schema for the request payload to create a new wallet.
4266
- * @param {string} [xRequestId] Developer-provided parameter used to identify this request. Useful when communicating with Circle Support.
4266
+ * @param {string} [xRequestId] Developer-provided identifier for this request, used for tracing requests in Wallets API logs and the Developer Console, and when communicating with Circle Support. **Must be a UUID to appear in logs.** Non-UUID values are accepted by the API but are ignored by logging and tracing systems.
4267
4267
  * @param {*} [options] Override http request option.
4268
4268
  * @throws {RequiredError}
4269
4269
  */
@@ -4273,7 +4273,7 @@ declare const WalletsApiAxiosParamCreator: (configuration?: Configuration) => {
4273
4273
  * @summary Derive a wallet
4274
4274
  * @param {string} id The universally unique identifier of the resource.
4275
4275
  * @param {EvmBlockchain} blockchain The unique identifier of the blockchains.
4276
- * @param {string} [xRequestId] Developer-provided parameter used to identify this request. Useful when communicating with Circle Support.
4276
+ * @param {string} [xRequestId] Developer-provided identifier for this request, used for tracing requests in Wallets API logs and the Developer Console, and when communicating with Circle Support. **Must be a UUID to appear in logs.** Non-UUID values are accepted by the API but are ignored by logging and tracing systems.
4277
4277
  * @param {DeriveWalletRequest} [deriveWalletRequest] Defines the request payload schema for deriving a new wallet.
4278
4278
  * @param {*} [options] Override http request option.
4279
4279
  * @throws {RequiredError}
@@ -4283,7 +4283,7 @@ declare const WalletsApiAxiosParamCreator: (configuration?: Configuration) => {
4283
4283
  * Creates a wallet on the target blockchain using the same address as the source wallet identified by source blockchain and wallet address. If the target wallet already exists, its metadata is updated.
4284
4284
  * @summary Derive wallet by address
4285
4285
  * @param {DeriveWalletByAddressRequest} deriveWalletByAddressRequest Request payload to derive a wallet by source blockchain + address onto a target blockchain.
4286
- * @param {string} [xRequestId] Developer-provided parameter used to identify this request. Useful when communicating with Circle Support.
4286
+ * @param {string} [xRequestId] Developer-provided identifier for this request, used for tracing requests in Wallets API logs and the Developer Console, and when communicating with Circle Support. **Must be a UUID to appear in logs.** Non-UUID values are accepted by the API but are ignored by logging and tracing systems.
4287
4287
  * @param {*} [options] Override http request option.
4288
4288
  * @throws {RequiredError}
4289
4289
  */
@@ -4292,7 +4292,7 @@ declare const WalletsApiAxiosParamCreator: (configuration?: Configuration) => {
4292
4292
  * Retrieve an existing wallet
4293
4293
  * @summary Retrieve a wallet
4294
4294
  * @param {string} id The universally unique identifier of the resource.
4295
- * @param {string} [xRequestId] Developer-provided parameter used to identify this request. Useful when communicating with Circle Support.
4295
+ * @param {string} [xRequestId] Developer-provided identifier for this request, used for tracing requests in Wallets API logs and the Developer Console, and when communicating with Circle Support. **Must be a UUID to appear in logs.** Non-UUID values are accepted by the API but are ignored by logging and tracing systems.
4296
4296
  * @param {*} [options] Override http request option.
4297
4297
  * @throws {RequiredError}
4298
4298
  */
@@ -4311,7 +4311,7 @@ declare const WalletsApiAxiosParamCreator: (configuration?: Configuration) => {
4311
4311
  * @param {string} [pageAfter] A collection ID value used for pagination. It marks the exclusive begin of a page. When provided, the collection resource will return the next n items after the id, with n being specified by pageSize. The items will be returned in the natural order of the collection. The resource will return the first page if neither pageAfter nor pageBefore are specified. SHOULD NOT be used in conjunction with pageBefore.
4312
4312
  * @param {number} [pageSize] Limits the number of items to be returned. Some collections have a strict upper bound that will disregard this value. In case the specified value is higher than the allowed limit, the collection limit will be used. If avoided, the collection will determine the page size itself.
4313
4313
  * @param {GetWalletsOrderEnum} [order] Specifies the sort order of the collection by `CreateDate`. Valid values: - `ASC` – Sort results in ascending order. - `DESC` – Sort results in descending order (default).
4314
- * @param {string} [xRequestId] Developer-provided parameter used to identify this request. Useful when communicating with Circle Support.
4314
+ * @param {string} [xRequestId] Developer-provided identifier for this request, used for tracing requests in Wallets API logs and the Developer Console, and when communicating with Circle Support. **Must be a UUID to appear in logs.** Non-UUID values are accepted by the API but are ignored by logging and tracing systems.
4315
4315
  * @param {*} [options] Override http request option.
4316
4316
  * @throws {RequiredError}
4317
4317
  */
@@ -4320,7 +4320,7 @@ declare const WalletsApiAxiosParamCreator: (configuration?: Configuration) => {
4320
4320
  * Retrieves a list of all wallets that match the specified parameters. Wallet balances update automatically after each transfer. **Note**: On Aptos, this endpoint only returns balances for tokens stored in primary storage. Tokens held in [AIP-21](https://github.com/aptos-labs/aptos-core/releases/tag/aptos-node-v1.5.0) secondary storage are excluded from balance queries and deposit notifications to prevent incorrect or misleading results from secondary storage-based state changes.
4321
4321
  * @summary List wallets with balances
4322
4322
  * @param {Blockchain} blockchain Filter by blockchain.
4323
- * @param {string} [xRequestId] Developer-provided parameter used to identify this request. Useful when communicating with Circle Support.
4323
+ * @param {string} [xRequestId] Developer-provided identifier for this request, used for tracing requests in Wallets API logs and the Developer Console, and when communicating with Circle Support. **Must be a UUID to appear in logs.** Non-UUID values are accepted by the API but are ignored by logging and tracing systems.
4324
4324
  * @param {string} [address] Filter by the blockchain address of the wallet.
4325
4325
  * @param {ScaCore} [scaCore] Filters results by the SCA version.
4326
4326
  * @param {string} [walletSetId] Filter by the wallet set.
@@ -4347,7 +4347,7 @@ declare const WalletsApiAxiosParamCreator: (configuration?: Configuration) => {
4347
4347
  * @param {string} [pageBefore] A collection ID value used for pagination. It marks the exclusive end of a page. When provided, the collection resource will return the next n items before the id, with n being specified by pageSize. The items will be returned in the natural order of the collection. The resource will return the first page if neither pageAfter nor pageBefore are specified. SHOULD NOT be used in conjunction with pageAfter.
4348
4348
  * @param {string} [pageAfter] A collection ID value used for pagination. It marks the exclusive begin of a page. When provided, the collection resource will return the next n items after the id, with n being specified by pageSize. The items will be returned in the natural order of the collection. The resource will return the first page if neither pageAfter nor pageBefore are specified. SHOULD NOT be used in conjunction with pageBefore.
4349
4349
  * @param {number} [pageSize] Limits the number of items to be returned. Some collections have a strict upper bound that will disregard this value. In case the specified value is higher than the allowed limit, the collection limit will be used. If avoided, the collection will determine the page size itself.
4350
- * @param {string} [xRequestId] Developer-provided parameter used to identify this request. Useful when communicating with Circle Support.
4350
+ * @param {string} [xRequestId] Developer-provided identifier for this request, used for tracing requests in Wallets API logs and the Developer Console, and when communicating with Circle Support. **Must be a UUID to appear in logs.** Non-UUID values are accepted by the API but are ignored by logging and tracing systems.
4351
4351
  * @param {*} [options] Override http request option.
4352
4352
  * @throws {RequiredError}
4353
4353
  */
@@ -4363,7 +4363,7 @@ declare const WalletsApiAxiosParamCreator: (configuration?: Configuration) => {
4363
4363
  * @param {string} [pageBefore] A collection ID value used for pagination. It marks the exclusive end of a page. When provided, the collection resource will return the next n items before the id, with n being specified by pageSize. The items will be returned in the natural order of the collection. The resource will return the first page if neither pageAfter nor pageBefore are specified. SHOULD NOT be used in conjunction with pageAfter.
4364
4364
  * @param {string} [pageAfter] A collection ID value used for pagination. It marks the exclusive begin of a page. When provided, the collection resource will return the next n items after the id, with n being specified by pageSize. The items will be returned in the natural order of the collection. The resource will return the first page if neither pageAfter nor pageBefore are specified. SHOULD NOT be used in conjunction with pageBefore.
4365
4365
  * @param {number} [pageSize] Limits the number of items to be returned. Some collections have a strict upper bound that will disregard this value. In case the specified value is higher than the allowed limit, the collection limit will be used. If avoided, the collection will determine the page size itself.
4366
- * @param {string} [xRequestId] Developer-provided parameter used to identify this request. Useful when communicating with Circle Support.
4366
+ * @param {string} [xRequestId] Developer-provided identifier for this request, used for tracing requests in Wallets API logs and the Developer Console, and when communicating with Circle Support. **Must be a UUID to appear in logs.** Non-UUID values are accepted by the API but are ignored by logging and tracing systems.
4367
4367
  * @param {*} [options] Override http request option.
4368
4368
  * @throws {RequiredError}
4369
4369
  */
@@ -4373,7 +4373,7 @@ declare const WalletsApiAxiosParamCreator: (configuration?: Configuration) => {
4373
4373
  * @summary Update a wallet
4374
4374
  * @param {string} id The universally unique identifier of the resource.
4375
4375
  * @param {UpdateWalletRequest} updateWalletRequest Schema for the request payload to update an existing wallet.
4376
- * @param {string} [xRequestId] Developer-provided parameter used to identify this request. Useful when communicating with Circle Support.
4376
+ * @param {string} [xRequestId] Developer-provided identifier for this request, used for tracing requests in Wallets API logs and the Developer Console, and when communicating with Circle Support. **Must be a UUID to appear in logs.** Non-UUID values are accepted by the API but are ignored by logging and tracing systems.
4377
4377
  * @param {*} [options] Override http request option.
4378
4378
  * @throws {RequiredError}
4379
4379
  */
@@ -4388,7 +4388,7 @@ declare const WalletsApiFp: (configuration?: Configuration) => {
4388
4388
  * Creates a new developer-controlled wallet or a batch of wallets within a wallet set, given the target blockchain and wallet name. **Note:** Each `walletSetId` supports a maximum of 10 million wallets.
4389
4389
  * @summary Create wallets
4390
4390
  * @param {CreateWalletRequest} createWalletRequest Schema for the request payload to create a new wallet.
4391
- * @param {string} [xRequestId] Developer-provided parameter used to identify this request. Useful when communicating with Circle Support.
4391
+ * @param {string} [xRequestId] Developer-provided identifier for this request, used for tracing requests in Wallets API logs and the Developer Console, and when communicating with Circle Support. **Must be a UUID to appear in logs.** Non-UUID values are accepted by the API but are ignored by logging and tracing systems.
4392
4392
  * @param {*} [options] Override http request option.
4393
4393
  * @throws {RequiredError}
4394
4394
  */
@@ -4398,7 +4398,7 @@ declare const WalletsApiFp: (configuration?: Configuration) => {
4398
4398
  * @summary Derive a wallet
4399
4399
  * @param {string} id The universally unique identifier of the resource.
4400
4400
  * @param {EvmBlockchain} blockchain The unique identifier of the blockchains.
4401
- * @param {string} [xRequestId] Developer-provided parameter used to identify this request. Useful when communicating with Circle Support.
4401
+ * @param {string} [xRequestId] Developer-provided identifier for this request, used for tracing requests in Wallets API logs and the Developer Console, and when communicating with Circle Support. **Must be a UUID to appear in logs.** Non-UUID values are accepted by the API but are ignored by logging and tracing systems.
4402
4402
  * @param {DeriveWalletRequest} [deriveWalletRequest] Defines the request payload schema for deriving a new wallet.
4403
4403
  * @param {*} [options] Override http request option.
4404
4404
  * @throws {RequiredError}
@@ -4408,7 +4408,7 @@ declare const WalletsApiFp: (configuration?: Configuration) => {
4408
4408
  * Creates a wallet on the target blockchain using the same address as the source wallet identified by source blockchain and wallet address. If the target wallet already exists, its metadata is updated.
4409
4409
  * @summary Derive wallet by address
4410
4410
  * @param {DeriveWalletByAddressRequest} deriveWalletByAddressRequest Request payload to derive a wallet by source blockchain + address onto a target blockchain.
4411
- * @param {string} [xRequestId] Developer-provided parameter used to identify this request. Useful when communicating with Circle Support.
4411
+ * @param {string} [xRequestId] Developer-provided identifier for this request, used for tracing requests in Wallets API logs and the Developer Console, and when communicating with Circle Support. **Must be a UUID to appear in logs.** Non-UUID values are accepted by the API but are ignored by logging and tracing systems.
4412
4412
  * @param {*} [options] Override http request option.
4413
4413
  * @throws {RequiredError}
4414
4414
  */
@@ -4417,7 +4417,7 @@ declare const WalletsApiFp: (configuration?: Configuration) => {
4417
4417
  * Retrieve an existing wallet
4418
4418
  * @summary Retrieve a wallet
4419
4419
  * @param {string} id The universally unique identifier of the resource.
4420
- * @param {string} [xRequestId] Developer-provided parameter used to identify this request. Useful when communicating with Circle Support.
4420
+ * @param {string} [xRequestId] Developer-provided identifier for this request, used for tracing requests in Wallets API logs and the Developer Console, and when communicating with Circle Support. **Must be a UUID to appear in logs.** Non-UUID values are accepted by the API but are ignored by logging and tracing systems.
4421
4421
  * @param {*} [options] Override http request option.
4422
4422
  * @throws {RequiredError}
4423
4423
  */
@@ -4436,7 +4436,7 @@ declare const WalletsApiFp: (configuration?: Configuration) => {
4436
4436
  * @param {string} [pageAfter] A collection ID value used for pagination. It marks the exclusive begin of a page. When provided, the collection resource will return the next n items after the id, with n being specified by pageSize. The items will be returned in the natural order of the collection. The resource will return the first page if neither pageAfter nor pageBefore are specified. SHOULD NOT be used in conjunction with pageBefore.
4437
4437
  * @param {number} [pageSize] Limits the number of items to be returned. Some collections have a strict upper bound that will disregard this value. In case the specified value is higher than the allowed limit, the collection limit will be used. If avoided, the collection will determine the page size itself.
4438
4438
  * @param {GetWalletsOrderEnum} [order] Specifies the sort order of the collection by `CreateDate`. Valid values: - `ASC` – Sort results in ascending order. - `DESC` – Sort results in descending order (default).
4439
- * @param {string} [xRequestId] Developer-provided parameter used to identify this request. Useful when communicating with Circle Support.
4439
+ * @param {string} [xRequestId] Developer-provided identifier for this request, used for tracing requests in Wallets API logs and the Developer Console, and when communicating with Circle Support. **Must be a UUID to appear in logs.** Non-UUID values are accepted by the API but are ignored by logging and tracing systems.
4440
4440
  * @param {*} [options] Override http request option.
4441
4441
  * @throws {RequiredError}
4442
4442
  */
@@ -4445,7 +4445,7 @@ declare const WalletsApiFp: (configuration?: Configuration) => {
4445
4445
  * Retrieves a list of all wallets that match the specified parameters. Wallet balances update automatically after each transfer. **Note**: On Aptos, this endpoint only returns balances for tokens stored in primary storage. Tokens held in [AIP-21](https://github.com/aptos-labs/aptos-core/releases/tag/aptos-node-v1.5.0) secondary storage are excluded from balance queries and deposit notifications to prevent incorrect or misleading results from secondary storage-based state changes.
4446
4446
  * @summary List wallets with balances
4447
4447
  * @param {Blockchain} blockchain Filter by blockchain.
4448
- * @param {string} [xRequestId] Developer-provided parameter used to identify this request. Useful when communicating with Circle Support.
4448
+ * @param {string} [xRequestId] Developer-provided identifier for this request, used for tracing requests in Wallets API logs and the Developer Console, and when communicating with Circle Support. **Must be a UUID to appear in logs.** Non-UUID values are accepted by the API but are ignored by logging and tracing systems.
4449
4449
  * @param {string} [address] Filter by the blockchain address of the wallet.
4450
4450
  * @param {ScaCore} [scaCore] Filters results by the SCA version.
4451
4451
  * @param {string} [walletSetId] Filter by the wallet set.
@@ -4472,7 +4472,7 @@ declare const WalletsApiFp: (configuration?: Configuration) => {
4472
4472
  * @param {string} [pageBefore] A collection ID value used for pagination. It marks the exclusive end of a page. When provided, the collection resource will return the next n items before the id, with n being specified by pageSize. The items will be returned in the natural order of the collection. The resource will return the first page if neither pageAfter nor pageBefore are specified. SHOULD NOT be used in conjunction with pageAfter.
4473
4473
  * @param {string} [pageAfter] A collection ID value used for pagination. It marks the exclusive begin of a page. When provided, the collection resource will return the next n items after the id, with n being specified by pageSize. The items will be returned in the natural order of the collection. The resource will return the first page if neither pageAfter nor pageBefore are specified. SHOULD NOT be used in conjunction with pageBefore.
4474
4474
  * @param {number} [pageSize] Limits the number of items to be returned. Some collections have a strict upper bound that will disregard this value. In case the specified value is higher than the allowed limit, the collection limit will be used. If avoided, the collection will determine the page size itself.
4475
- * @param {string} [xRequestId] Developer-provided parameter used to identify this request. Useful when communicating with Circle Support.
4475
+ * @param {string} [xRequestId] Developer-provided identifier for this request, used for tracing requests in Wallets API logs and the Developer Console, and when communicating with Circle Support. **Must be a UUID to appear in logs.** Non-UUID values are accepted by the API but are ignored by logging and tracing systems.
4476
4476
  * @param {*} [options] Override http request option.
4477
4477
  * @throws {RequiredError}
4478
4478
  */
@@ -4488,7 +4488,7 @@ declare const WalletsApiFp: (configuration?: Configuration) => {
4488
4488
  * @param {string} [pageBefore] A collection ID value used for pagination. It marks the exclusive end of a page. When provided, the collection resource will return the next n items before the id, with n being specified by pageSize. The items will be returned in the natural order of the collection. The resource will return the first page if neither pageAfter nor pageBefore are specified. SHOULD NOT be used in conjunction with pageAfter.
4489
4489
  * @param {string} [pageAfter] A collection ID value used for pagination. It marks the exclusive begin of a page. When provided, the collection resource will return the next n items after the id, with n being specified by pageSize. The items will be returned in the natural order of the collection. The resource will return the first page if neither pageAfter nor pageBefore are specified. SHOULD NOT be used in conjunction with pageBefore.
4490
4490
  * @param {number} [pageSize] Limits the number of items to be returned. Some collections have a strict upper bound that will disregard this value. In case the specified value is higher than the allowed limit, the collection limit will be used. If avoided, the collection will determine the page size itself.
4491
- * @param {string} [xRequestId] Developer-provided parameter used to identify this request. Useful when communicating with Circle Support.
4491
+ * @param {string} [xRequestId] Developer-provided identifier for this request, used for tracing requests in Wallets API logs and the Developer Console, and when communicating with Circle Support. **Must be a UUID to appear in logs.** Non-UUID values are accepted by the API but are ignored by logging and tracing systems.
4492
4492
  * @param {*} [options] Override http request option.
4493
4493
  * @throws {RequiredError}
4494
4494
  */
@@ -4498,7 +4498,7 @@ declare const WalletsApiFp: (configuration?: Configuration) => {
4498
4498
  * @summary Update a wallet
4499
4499
  * @param {string} id The universally unique identifier of the resource.
4500
4500
  * @param {UpdateWalletRequest} updateWalletRequest Schema for the request payload to update an existing wallet.
4501
- * @param {string} [xRequestId] Developer-provided parameter used to identify this request. Useful when communicating with Circle Support.
4501
+ * @param {string} [xRequestId] Developer-provided identifier for this request, used for tracing requests in Wallets API logs and the Developer Console, and when communicating with Circle Support. **Must be a UUID to appear in logs.** Non-UUID values are accepted by the API but are ignored by logging and tracing systems.
4502
4502
  * @param {*} [options] Override http request option.
4503
4503
  * @throws {RequiredError}
4504
4504
  */
@@ -4513,7 +4513,7 @@ declare const WalletsApiFactory: (configuration?: Configuration, basePath?: stri
4513
4513
  * Creates a new developer-controlled wallet or a batch of wallets within a wallet set, given the target blockchain and wallet name. **Note:** Each `walletSetId` supports a maximum of 10 million wallets.
4514
4514
  * @summary Create wallets
4515
4515
  * @param {CreateWalletRequest} createWalletRequest Schema for the request payload to create a new wallet.
4516
- * @param {string} [xRequestId] Developer-provided parameter used to identify this request. Useful when communicating with Circle Support.
4516
+ * @param {string} [xRequestId] Developer-provided identifier for this request, used for tracing requests in Wallets API logs and the Developer Console, and when communicating with Circle Support. **Must be a UUID to appear in logs.** Non-UUID values are accepted by the API but are ignored by logging and tracing systems.
4517
4517
  * @param {*} [options] Override http request option.
4518
4518
  * @throws {RequiredError}
4519
4519
  */
@@ -4523,7 +4523,7 @@ declare const WalletsApiFactory: (configuration?: Configuration, basePath?: stri
4523
4523
  * @summary Derive a wallet
4524
4524
  * @param {string} id The universally unique identifier of the resource.
4525
4525
  * @param {EvmBlockchain} blockchain The unique identifier of the blockchains.
4526
- * @param {string} [xRequestId] Developer-provided parameter used to identify this request. Useful when communicating with Circle Support.
4526
+ * @param {string} [xRequestId] Developer-provided identifier for this request, used for tracing requests in Wallets API logs and the Developer Console, and when communicating with Circle Support. **Must be a UUID to appear in logs.** Non-UUID values are accepted by the API but are ignored by logging and tracing systems.
4527
4527
  * @param {DeriveWalletRequest} [deriveWalletRequest] Defines the request payload schema for deriving a new wallet.
4528
4528
  * @param {*} [options] Override http request option.
4529
4529
  * @throws {RequiredError}
@@ -4533,7 +4533,7 @@ declare const WalletsApiFactory: (configuration?: Configuration, basePath?: stri
4533
4533
  * Creates a wallet on the target blockchain using the same address as the source wallet identified by source blockchain and wallet address. If the target wallet already exists, its metadata is updated.
4534
4534
  * @summary Derive wallet by address
4535
4535
  * @param {DeriveWalletByAddressRequest} deriveWalletByAddressRequest Request payload to derive a wallet by source blockchain + address onto a target blockchain.
4536
- * @param {string} [xRequestId] Developer-provided parameter used to identify this request. Useful when communicating with Circle Support.
4536
+ * @param {string} [xRequestId] Developer-provided identifier for this request, used for tracing requests in Wallets API logs and the Developer Console, and when communicating with Circle Support. **Must be a UUID to appear in logs.** Non-UUID values are accepted by the API but are ignored by logging and tracing systems.
4537
4537
  * @param {*} [options] Override http request option.
4538
4538
  * @throws {RequiredError}
4539
4539
  */
@@ -4542,7 +4542,7 @@ declare const WalletsApiFactory: (configuration?: Configuration, basePath?: stri
4542
4542
  * Retrieve an existing wallet
4543
4543
  * @summary Retrieve a wallet
4544
4544
  * @param {string} id The universally unique identifier of the resource.
4545
- * @param {string} [xRequestId] Developer-provided parameter used to identify this request. Useful when communicating with Circle Support.
4545
+ * @param {string} [xRequestId] Developer-provided identifier for this request, used for tracing requests in Wallets API logs and the Developer Console, and when communicating with Circle Support. **Must be a UUID to appear in logs.** Non-UUID values are accepted by the API but are ignored by logging and tracing systems.
4546
4546
  * @param {*} [options] Override http request option.
4547
4547
  * @throws {RequiredError}
4548
4548
  */
@@ -4561,7 +4561,7 @@ declare const WalletsApiFactory: (configuration?: Configuration, basePath?: stri
4561
4561
  * @param {string} [pageAfter] A collection ID value used for pagination. It marks the exclusive begin of a page. When provided, the collection resource will return the next n items after the id, with n being specified by pageSize. The items will be returned in the natural order of the collection. The resource will return the first page if neither pageAfter nor pageBefore are specified. SHOULD NOT be used in conjunction with pageBefore.
4562
4562
  * @param {number} [pageSize] Limits the number of items to be returned. Some collections have a strict upper bound that will disregard this value. In case the specified value is higher than the allowed limit, the collection limit will be used. If avoided, the collection will determine the page size itself.
4563
4563
  * @param {GetWalletsOrderEnum} [order] Specifies the sort order of the collection by `CreateDate`. Valid values: - `ASC` – Sort results in ascending order. - `DESC` – Sort results in descending order (default).
4564
- * @param {string} [xRequestId] Developer-provided parameter used to identify this request. Useful when communicating with Circle Support.
4564
+ * @param {string} [xRequestId] Developer-provided identifier for this request, used for tracing requests in Wallets API logs and the Developer Console, and when communicating with Circle Support. **Must be a UUID to appear in logs.** Non-UUID values are accepted by the API but are ignored by logging and tracing systems.
4565
4565
  * @param {*} [options] Override http request option.
4566
4566
  * @throws {RequiredError}
4567
4567
  */
@@ -4570,7 +4570,7 @@ declare const WalletsApiFactory: (configuration?: Configuration, basePath?: stri
4570
4570
  * Retrieves a list of all wallets that match the specified parameters. Wallet balances update automatically after each transfer. **Note**: On Aptos, this endpoint only returns balances for tokens stored in primary storage. Tokens held in [AIP-21](https://github.com/aptos-labs/aptos-core/releases/tag/aptos-node-v1.5.0) secondary storage are excluded from balance queries and deposit notifications to prevent incorrect or misleading results from secondary storage-based state changes.
4571
4571
  * @summary List wallets with balances
4572
4572
  * @param {Blockchain} blockchain Filter by blockchain.
4573
- * @param {string} [xRequestId] Developer-provided parameter used to identify this request. Useful when communicating with Circle Support.
4573
+ * @param {string} [xRequestId] Developer-provided identifier for this request, used for tracing requests in Wallets API logs and the Developer Console, and when communicating with Circle Support. **Must be a UUID to appear in logs.** Non-UUID values are accepted by the API but are ignored by logging and tracing systems.
4574
4574
  * @param {string} [address] Filter by the blockchain address of the wallet.
4575
4575
  * @param {ScaCore} [scaCore] Filters results by the SCA version.
4576
4576
  * @param {string} [walletSetId] Filter by the wallet set.
@@ -4597,7 +4597,7 @@ declare const WalletsApiFactory: (configuration?: Configuration, basePath?: stri
4597
4597
  * @param {string} [pageBefore] A collection ID value used for pagination. It marks the exclusive end of a page. When provided, the collection resource will return the next n items before the id, with n being specified by pageSize. The items will be returned in the natural order of the collection. The resource will return the first page if neither pageAfter nor pageBefore are specified. SHOULD NOT be used in conjunction with pageAfter.
4598
4598
  * @param {string} [pageAfter] A collection ID value used for pagination. It marks the exclusive begin of a page. When provided, the collection resource will return the next n items after the id, with n being specified by pageSize. The items will be returned in the natural order of the collection. The resource will return the first page if neither pageAfter nor pageBefore are specified. SHOULD NOT be used in conjunction with pageBefore.
4599
4599
  * @param {number} [pageSize] Limits the number of items to be returned. Some collections have a strict upper bound that will disregard this value. In case the specified value is higher than the allowed limit, the collection limit will be used. If avoided, the collection will determine the page size itself.
4600
- * @param {string} [xRequestId] Developer-provided parameter used to identify this request. Useful when communicating with Circle Support.
4600
+ * @param {string} [xRequestId] Developer-provided identifier for this request, used for tracing requests in Wallets API logs and the Developer Console, and when communicating with Circle Support. **Must be a UUID to appear in logs.** Non-UUID values are accepted by the API but are ignored by logging and tracing systems.
4601
4601
  * @param {*} [options] Override http request option.
4602
4602
  * @throws {RequiredError}
4603
4603
  */
@@ -4613,7 +4613,7 @@ declare const WalletsApiFactory: (configuration?: Configuration, basePath?: stri
4613
4613
  * @param {string} [pageBefore] A collection ID value used for pagination. It marks the exclusive end of a page. When provided, the collection resource will return the next n items before the id, with n being specified by pageSize. The items will be returned in the natural order of the collection. The resource will return the first page if neither pageAfter nor pageBefore are specified. SHOULD NOT be used in conjunction with pageAfter.
4614
4614
  * @param {string} [pageAfter] A collection ID value used for pagination. It marks the exclusive begin of a page. When provided, the collection resource will return the next n items after the id, with n being specified by pageSize. The items will be returned in the natural order of the collection. The resource will return the first page if neither pageAfter nor pageBefore are specified. SHOULD NOT be used in conjunction with pageBefore.
4615
4615
  * @param {number} [pageSize] Limits the number of items to be returned. Some collections have a strict upper bound that will disregard this value. In case the specified value is higher than the allowed limit, the collection limit will be used. If avoided, the collection will determine the page size itself.
4616
- * @param {string} [xRequestId] Developer-provided parameter used to identify this request. Useful when communicating with Circle Support.
4616
+ * @param {string} [xRequestId] Developer-provided identifier for this request, used for tracing requests in Wallets API logs and the Developer Console, and when communicating with Circle Support. **Must be a UUID to appear in logs.** Non-UUID values are accepted by the API but are ignored by logging and tracing systems.
4617
4617
  * @param {*} [options] Override http request option.
4618
4618
  * @throws {RequiredError}
4619
4619
  */
@@ -4623,7 +4623,7 @@ declare const WalletsApiFactory: (configuration?: Configuration, basePath?: stri
4623
4623
  * @summary Update a wallet
4624
4624
  * @param {string} id The universally unique identifier of the resource.
4625
4625
  * @param {UpdateWalletRequest} updateWalletRequest Schema for the request payload to update an existing wallet.
4626
- * @param {string} [xRequestId] Developer-provided parameter used to identify this request. Useful when communicating with Circle Support.
4626
+ * @param {string} [xRequestId] Developer-provided identifier for this request, used for tracing requests in Wallets API logs and the Developer Console, and when communicating with Circle Support. **Must be a UUID to appear in logs.** Non-UUID values are accepted by the API but are ignored by logging and tracing systems.
4627
4627
  * @param {*} [options] Override http request option.
4628
4628
  * @throws {RequiredError}
4629
4629
  */
@@ -4640,7 +4640,7 @@ declare class WalletsApi extends BaseAPI {
4640
4640
  * Creates a new developer-controlled wallet or a batch of wallets within a wallet set, given the target blockchain and wallet name. **Note:** Each `walletSetId` supports a maximum of 10 million wallets.
4641
4641
  * @summary Create wallets
4642
4642
  * @param {CreateWalletRequest} createWalletRequest Schema for the request payload to create a new wallet.
4643
- * @param {string} [xRequestId] Developer-provided parameter used to identify this request. Useful when communicating with Circle Support.
4643
+ * @param {string} [xRequestId] Developer-provided identifier for this request, used for tracing requests in Wallets API logs and the Developer Console, and when communicating with Circle Support. **Must be a UUID to appear in logs.** Non-UUID values are accepted by the API but are ignored by logging and tracing systems.
4644
4644
  * @param {*} [options] Override http request option.
4645
4645
  * @throws {RequiredError}
4646
4646
  * @memberof WalletsApi
@@ -4651,7 +4651,7 @@ declare class WalletsApi extends BaseAPI {
4651
4651
  * @summary Derive a wallet
4652
4652
  * @param {string} id The universally unique identifier of the resource.
4653
4653
  * @param {EvmBlockchain} blockchain The unique identifier of the blockchains.
4654
- * @param {string} [xRequestId] Developer-provided parameter used to identify this request. Useful when communicating with Circle Support.
4654
+ * @param {string} [xRequestId] Developer-provided identifier for this request, used for tracing requests in Wallets API logs and the Developer Console, and when communicating with Circle Support. **Must be a UUID to appear in logs.** Non-UUID values are accepted by the API but are ignored by logging and tracing systems.
4655
4655
  * @param {DeriveWalletRequest} [deriveWalletRequest] Defines the request payload schema for deriving a new wallet.
4656
4656
  * @param {*} [options] Override http request option.
4657
4657
  * @throws {RequiredError}
@@ -4662,7 +4662,7 @@ declare class WalletsApi extends BaseAPI {
4662
4662
  * Creates a wallet on the target blockchain using the same address as the source wallet identified by source blockchain and wallet address. If the target wallet already exists, its metadata is updated.
4663
4663
  * @summary Derive wallet by address
4664
4664
  * @param {DeriveWalletByAddressRequest} deriveWalletByAddressRequest Request payload to derive a wallet by source blockchain + address onto a target blockchain.
4665
- * @param {string} [xRequestId] Developer-provided parameter used to identify this request. Useful when communicating with Circle Support.
4665
+ * @param {string} [xRequestId] Developer-provided identifier for this request, used for tracing requests in Wallets API logs and the Developer Console, and when communicating with Circle Support. **Must be a UUID to appear in logs.** Non-UUID values are accepted by the API but are ignored by logging and tracing systems.
4666
4666
  * @param {*} [options] Override http request option.
4667
4667
  * @throws {RequiredError}
4668
4668
  * @memberof WalletsApi
@@ -4672,7 +4672,7 @@ declare class WalletsApi extends BaseAPI {
4672
4672
  * Retrieve an existing wallet
4673
4673
  * @summary Retrieve a wallet
4674
4674
  * @param {string} id The universally unique identifier of the resource.
4675
- * @param {string} [xRequestId] Developer-provided parameter used to identify this request. Useful when communicating with Circle Support.
4675
+ * @param {string} [xRequestId] Developer-provided identifier for this request, used for tracing requests in Wallets API logs and the Developer Console, and when communicating with Circle Support. **Must be a UUID to appear in logs.** Non-UUID values are accepted by the API but are ignored by logging and tracing systems.
4676
4676
  * @param {*} [options] Override http request option.
4677
4677
  * @throws {RequiredError}
4678
4678
  * @memberof WalletsApi
@@ -4692,7 +4692,7 @@ declare class WalletsApi extends BaseAPI {
4692
4692
  * @param {string} [pageAfter] A collection ID value used for pagination. It marks the exclusive begin of a page. When provided, the collection resource will return the next n items after the id, with n being specified by pageSize. The items will be returned in the natural order of the collection. The resource will return the first page if neither pageAfter nor pageBefore are specified. SHOULD NOT be used in conjunction with pageBefore.
4693
4693
  * @param {number} [pageSize] Limits the number of items to be returned. Some collections have a strict upper bound that will disregard this value. In case the specified value is higher than the allowed limit, the collection limit will be used. If avoided, the collection will determine the page size itself.
4694
4694
  * @param {GetWalletsOrderEnum} [order] Specifies the sort order of the collection by `CreateDate`. Valid values: - `ASC` – Sort results in ascending order. - `DESC` – Sort results in descending order (default).
4695
- * @param {string} [xRequestId] Developer-provided parameter used to identify this request. Useful when communicating with Circle Support.
4695
+ * @param {string} [xRequestId] Developer-provided identifier for this request, used for tracing requests in Wallets API logs and the Developer Console, and when communicating with Circle Support. **Must be a UUID to appear in logs.** Non-UUID values are accepted by the API but are ignored by logging and tracing systems.
4696
4696
  * @param {*} [options] Override http request option.
4697
4697
  * @throws {RequiredError}
4698
4698
  * @memberof WalletsApi
@@ -4702,7 +4702,7 @@ declare class WalletsApi extends BaseAPI {
4702
4702
  * Retrieves a list of all wallets that match the specified parameters. Wallet balances update automatically after each transfer. **Note**: On Aptos, this endpoint only returns balances for tokens stored in primary storage. Tokens held in [AIP-21](https://github.com/aptos-labs/aptos-core/releases/tag/aptos-node-v1.5.0) secondary storage are excluded from balance queries and deposit notifications to prevent incorrect or misleading results from secondary storage-based state changes.
4703
4703
  * @summary List wallets with balances
4704
4704
  * @param {Blockchain} blockchain Filter by blockchain.
4705
- * @param {string} [xRequestId] Developer-provided parameter used to identify this request. Useful when communicating with Circle Support.
4705
+ * @param {string} [xRequestId] Developer-provided identifier for this request, used for tracing requests in Wallets API logs and the Developer Console, and when communicating with Circle Support. **Must be a UUID to appear in logs.** Non-UUID values are accepted by the API but are ignored by logging and tracing systems.
4706
4706
  * @param {string} [address] Filter by the blockchain address of the wallet.
4707
4707
  * @param {ScaCore} [scaCore] Filters results by the SCA version.
4708
4708
  * @param {string} [walletSetId] Filter by the wallet set.
@@ -4730,7 +4730,7 @@ declare class WalletsApi extends BaseAPI {
4730
4730
  * @param {string} [pageBefore] A collection ID value used for pagination. It marks the exclusive end of a page. When provided, the collection resource will return the next n items before the id, with n being specified by pageSize. The items will be returned in the natural order of the collection. The resource will return the first page if neither pageAfter nor pageBefore are specified. SHOULD NOT be used in conjunction with pageAfter.
4731
4731
  * @param {string} [pageAfter] A collection ID value used for pagination. It marks the exclusive begin of a page. When provided, the collection resource will return the next n items after the id, with n being specified by pageSize. The items will be returned in the natural order of the collection. The resource will return the first page if neither pageAfter nor pageBefore are specified. SHOULD NOT be used in conjunction with pageBefore.
4732
4732
  * @param {number} [pageSize] Limits the number of items to be returned. Some collections have a strict upper bound that will disregard this value. In case the specified value is higher than the allowed limit, the collection limit will be used. If avoided, the collection will determine the page size itself.
4733
- * @param {string} [xRequestId] Developer-provided parameter used to identify this request. Useful when communicating with Circle Support.
4733
+ * @param {string} [xRequestId] Developer-provided identifier for this request, used for tracing requests in Wallets API logs and the Developer Console, and when communicating with Circle Support. **Must be a UUID to appear in logs.** Non-UUID values are accepted by the API but are ignored by logging and tracing systems.
4734
4734
  * @param {*} [options] Override http request option.
4735
4735
  * @throws {RequiredError}
4736
4736
  * @memberof WalletsApi
@@ -4747,7 +4747,7 @@ declare class WalletsApi extends BaseAPI {
4747
4747
  * @param {string} [pageBefore] A collection ID value used for pagination. It marks the exclusive end of a page. When provided, the collection resource will return the next n items before the id, with n being specified by pageSize. The items will be returned in the natural order of the collection. The resource will return the first page if neither pageAfter nor pageBefore are specified. SHOULD NOT be used in conjunction with pageAfter.
4748
4748
  * @param {string} [pageAfter] A collection ID value used for pagination. It marks the exclusive begin of a page. When provided, the collection resource will return the next n items after the id, with n being specified by pageSize. The items will be returned in the natural order of the collection. The resource will return the first page if neither pageAfter nor pageBefore are specified. SHOULD NOT be used in conjunction with pageBefore.
4749
4749
  * @param {number} [pageSize] Limits the number of items to be returned. Some collections have a strict upper bound that will disregard this value. In case the specified value is higher than the allowed limit, the collection limit will be used. If avoided, the collection will determine the page size itself.
4750
- * @param {string} [xRequestId] Developer-provided parameter used to identify this request. Useful when communicating with Circle Support.
4750
+ * @param {string} [xRequestId] Developer-provided identifier for this request, used for tracing requests in Wallets API logs and the Developer Console, and when communicating with Circle Support. **Must be a UUID to appear in logs.** Non-UUID values are accepted by the API but are ignored by logging and tracing systems.
4751
4751
  * @param {*} [options] Override http request option.
4752
4752
  * @throws {RequiredError}
4753
4753
  * @memberof WalletsApi
@@ -4758,7 +4758,7 @@ declare class WalletsApi extends BaseAPI {
4758
4758
  * @summary Update a wallet
4759
4759
  * @param {string} id The universally unique identifier of the resource.
4760
4760
  * @param {UpdateWalletRequest} updateWalletRequest Schema for the request payload to update an existing wallet.
4761
- * @param {string} [xRequestId] Developer-provided parameter used to identify this request. Useful when communicating with Circle Support.
4761
+ * @param {string} [xRequestId] Developer-provided identifier for this request, used for tracing requests in Wallets API logs and the Developer Console, and when communicating with Circle Support. **Must be a UUID to appear in logs.** Non-UUID values are accepted by the API but are ignored by logging and tracing systems.
4762
4762
  * @param {*} [options] Override http request option.
4763
4763
  * @throws {RequiredError}
4764
4764
  * @memberof WalletsApi
@@ -4803,4 +4803,5 @@ declare class DeveloperControlledWalletsClient {
4803
4803
  constructor(baseUrl: string, config: ClientConfig, headers?: Record<string, string>);
4804
4804
  }
4805
4805
 
4806
- export { type AbiParametersInner, type AccelerateTransactionForDeveloper, type AccelerateTransactionForDeveloperData, type AccelerateTransactionForDeveloperRequest, AccountType, type BadRequestResponse, type Balance, type Balances, type BalancesData, type BaseScreeningDecision, Blockchain, type CancelTransactionForDeveloper, type CancelTransactionForDeveloperRequest, ContractExecutionBlockchain, type CreateContractExecutionTransactionForDeveloper, type CreateContractExecutionTransactionForDeveloperRequest, type CreateTransferTransactionForDeveloperRequest, type CreateTransferTransactionForDeveloperRequestBlockchain, type CreateTransferTransactionForDeveloperResponse, type CreateTransferTransactionForDeveloperResponseData, type CreateWalletRequest, type CreateWalletSetRequest, type CreateWalletUpgradeTransactionForDeveloper, type CreateWalletUpgradeTransactionForDeveloperRequest, CustodyType, type DeriveWalletByAddressRequest, type DeriveWalletRequest, DeveloperControlledWalletsClient, type DeveloperWalletSet, type EOAWallet, type EOAWalletWithBalances, type EndUserWalletSet, type EstimateContractExecutionTransactionFeeRequest, type EstimateTransactionFee, type EstimateTransactionFeeData, type EstimateTransferTransactionFeeRequest, EvmBlockchain, FeeLevel, type FeeParameters, type FeeParametersResponse, type FeeParametersResponseData, type GetLowestNonceTransactionResponse, type GetLowestNonceTransactionResponseData, GetWalletSetsOrderEnum, GetWalletsOrderEnum, ListTransactionsOperationEnum, ListTransactionsOrderEnum, type LowestNonceTransactionFeeInfo, type ModelError, NewScaCore, type Nft, type Nfts, type NftsData, type NotAuthorizedResponse, type NotFoundResponse, Operation, RiskAction, RiskCategory, RiskScore, type RiskSignal, RiskSignalSourceEnum, RiskType, type SCAWallet, type SCAWalletWithBalances, ScaCore, type SignDelegateActionRequest, type SignDelegateActionResponse, type SignDelegateActionResponseData, type SignMessageRequest, type SignTransactionRequest, type SignTransactionResponse, type SignTransactionResponseData, type SignTypedDataRequest, type SignatureResponse, type SignatureResponseData, SigningApi, SigningApiAxiosParamCreator, SigningApiFactory, SigningApiFp, type Token, TokenBlockchain, TokenLookupApi, TokenLookupApiAxiosParamCreator, TokenLookupApiFactory, TokenLookupApiFp, type TokenResponse, type TokenResponseData, TokenStandard, type Transaction, type TransactionFee, type TransactionResponse, type TransactionResponseData, type TransactionScreeningDecision, TransactionState, TransactionType, type Transactions, TransactionsApi, TransactionsApiAxiosParamCreator, TransactionsApiFactory, TransactionsApiFp, type TransactionsData, TransferBlockchain, type UpdateWalletRequest, type UpdateWalletSetRequest, type ValidateAddress, type ValidateAddressData, type ValidateAddressRequest, type Wallet, type WalletMetadata, type WalletResponse, type WalletResponseData, type WalletSet, type WalletSetResponse, type WalletSetResponseData, type WalletSets, WalletSetsApi, WalletSetsApiAxiosParamCreator, WalletSetsApiFactory, WalletSetsApiFp, type WalletSetsData, type WalletSetsDataWalletSetsInner, WalletState, type Wallets, WalletsApi, WalletsApiAxiosParamCreator, WalletsApiFactory, WalletsApiFp, type WalletsData, type WalletsDataWalletsInner, type WalletsWithBalances, type WalletsWithBalancesData, type WalletsWithBalancesDataWalletsInner };
4806
+ export { AccountType, Blockchain, ContractExecutionBlockchain, CustodyType, DeveloperControlledWalletsClient, EvmBlockchain, FeeLevel, GetWalletSetsOrderEnum, GetWalletsOrderEnum, ListTransactionsOperationEnum, ListTransactionsOrderEnum, NewScaCore, Operation, RiskAction, RiskCategory, RiskScore, RiskSignalSourceEnum, RiskType, ScaCore, SigningApi, SigningApiAxiosParamCreator, SigningApiFactory, SigningApiFp, TokenBlockchain, TokenLookupApi, TokenLookupApiAxiosParamCreator, TokenLookupApiFactory, TokenLookupApiFp, TokenStandard, TransactionState, TransactionType, TransactionsApi, TransactionsApiAxiosParamCreator, TransactionsApiFactory, TransactionsApiFp, TransferBlockchain, WalletSetsApi, WalletSetsApiAxiosParamCreator, WalletSetsApiFactory, WalletSetsApiFp, WalletState, WalletsApi, WalletsApiAxiosParamCreator, WalletsApiFactory, WalletsApiFp };
4807
+ export type { AbiParametersInner, AccelerateTransactionForDeveloper, AccelerateTransactionForDeveloperData, AccelerateTransactionForDeveloperRequest, BadRequestResponse, Balance, Balances, BalancesData, BaseScreeningDecision, CancelTransactionForDeveloper, CancelTransactionForDeveloperRequest, CreateContractExecutionTransactionForDeveloper, CreateContractExecutionTransactionForDeveloperRequest, CreateTransferTransactionForDeveloperRequest, CreateTransferTransactionForDeveloperRequestBlockchain, CreateTransferTransactionForDeveloperResponse, CreateTransferTransactionForDeveloperResponseData, CreateWalletRequest, CreateWalletSetRequest, CreateWalletUpgradeTransactionForDeveloper, CreateWalletUpgradeTransactionForDeveloperRequest, DeriveWalletByAddressRequest, DeriveWalletRequest, DeveloperWalletSet, EOAWallet, EOAWalletWithBalances, EndUserWalletSet, EstimateContractExecutionTransactionFeeRequest, EstimateTransactionFee, EstimateTransactionFeeData, EstimateTransferTransactionFeeRequest, FeeParameters, FeeParametersResponse, FeeParametersResponseData, GetLowestNonceTransactionResponse, GetLowestNonceTransactionResponseData, LowestNonceTransactionFeeInfo, ModelError, Nft, Nfts, NftsData, NotAuthorizedResponse, NotFoundResponse, RiskSignal, SCAWallet, SCAWalletWithBalances, SignDelegateActionRequest, SignDelegateActionResponse, SignDelegateActionResponseData, SignMessageRequest, SignTransactionRequest, SignTransactionResponse, SignTransactionResponseData, SignTypedDataRequest, SignatureResponse, SignatureResponseData, Token, TokenResponse, TokenResponseData, Transaction, TransactionFee, TransactionResponse, TransactionResponseData, TransactionScreeningDecision, Transactions, TransactionsData, UpdateWalletRequest, UpdateWalletSetRequest, ValidateAddress, ValidateAddressData, ValidateAddressRequest, Wallet, WalletMetadata, WalletResponse, WalletResponseData, WalletSet, WalletSetResponse, WalletSetResponseData, WalletSets, WalletSetsData, WalletSetsDataWalletSetsInner, Wallets, WalletsData, WalletsDataWalletsInner, WalletsWithBalances, WalletsWithBalancesData, WalletsWithBalancesDataWalletsInner };