diff --git a/.openapi-generator/FILES b/.openapi-generator/FILES index 959f0846..f55b5753 100644 --- a/.openapi-generator/FILES +++ b/.openapi-generator/FILES @@ -13,6 +13,7 @@ cobo_waas2/api/compliance_api.py cobo_waas2/api/developers_api.py cobo_waas2/api/developers_webhooks_api.py cobo_waas2/api/fee_station_api.py +cobo_waas2/api/graph_ql_api.py cobo_waas2/api/o_auth_api.py cobo_waas2/api/organizations_api.py cobo_waas2/api/payment_api.py @@ -55,8 +56,8 @@ cobo_waas2/models/address_transfer_destination_account_output.py cobo_waas2/models/address_transfer_destination_utxo_outputs_inner.py cobo_waas2/models/addresses_event_data.py cobo_waas2/models/addresses_event_data_all_of_addresses.py -cobo_waas2/models/allocation_record.py -cobo_waas2/models/allocation_request.py +cobo_waas2/models/allocation_item.py +cobo_waas2/models/allocation_param.py cobo_waas2/models/amount_details_inner.py cobo_waas2/models/amount_status.py cobo_waas2/models/api_log_details.py @@ -151,6 +152,8 @@ cobo_waas2/models/create_babylon_airdrop_registration_request.py cobo_waas2/models/create_babylon_staking_registration201_response.py cobo_waas2/models/create_babylon_staking_registration_request.py cobo_waas2/models/create_batch_allocation_request.py +cobo_waas2/models/create_bulk_send_request.py +cobo_waas2/models/create_bulk_send_request_payout_params_inner.py cobo_waas2/models/create_claim_activity.py cobo_waas2/models/create_claim_activity_request.py cobo_waas2/models/create_counterparty_entry201_response.py @@ -193,6 +196,8 @@ cobo_waas2/models/create_swap_activity_request.py cobo_waas2/models/create_sweep_to_address.py cobo_waas2/models/create_token_listing_request201_response.py cobo_waas2/models/create_token_listing_request_request.py +cobo_waas2/models/create_top_up_addresses.py +cobo_waas2/models/create_top_up_addresses201_response.py cobo_waas2/models/create_transfer_transaction201_response.py cobo_waas2/models/create_tss_request_request.py cobo_waas2/models/create_unstake_activity.py @@ -349,7 +354,7 @@ cobo_waas2/models/link_display_info.py cobo_waas2/models/list_address_balances_by_token200_response.py cobo_waas2/models/list_address_books200_response.py cobo_waas2/models/list_addresses200_response.py -cobo_waas2/models/list_allocations200_response.py +cobo_waas2/models/list_allocation_items200_response.py cobo_waas2/models/list_approval_requests200_response.py cobo_waas2/models/list_asset_balances_for_exchange_wallet200_response.py cobo_waas2/models/list_auto_sweep_task200_response.py @@ -359,6 +364,7 @@ cobo_waas2/models/list_babylon_eligible_stakings200_response.py cobo_waas2/models/list_babylon_eligible_stakings200_response_data_inner.py cobo_waas2/models/list_babylon_staking_registrations200_response.py cobo_waas2/models/list_batch_allocations200_response.py +cobo_waas2/models/list_bulk_send_items200_response.py cobo_waas2/models/list_callback_messages200_response.py cobo_waas2/models/list_counterparties200_response.py cobo_waas2/models/list_counterparty_entries200_response.py @@ -378,7 +384,6 @@ cobo_waas2/models/list_mpc_projects200_response.py cobo_waas2/models/list_mpc_vaults200_response.py cobo_waas2/models/list_payment_orders200_response.py cobo_waas2/models/list_payment_wallet_balances200_response.py -cobo_waas2/models/list_payout_items200_response.py cobo_waas2/models/list_payouts200_response.py cobo_waas2/models/list_settlement_details200_response.py cobo_waas2/models/list_settlement_requests200_response.py @@ -443,6 +448,13 @@ cobo_waas2/models/pagination.py cobo_waas2/models/payer_account.py cobo_waas2/models/payment_address_update_event_data.py cobo_waas2/models/payment_allocation_amount.py +cobo_waas2/models/payment_bulk_send.py +cobo_waas2/models/payment_bulk_send_event.py +cobo_waas2/models/payment_bulk_send_execution_mode.py +cobo_waas2/models/payment_bulk_send_item.py +cobo_waas2/models/payment_bulk_send_item_status.py +cobo_waas2/models/payment_bulk_send_item_validation_status.py +cobo_waas2/models/payment_bulk_send_status.py cobo_waas2/models/payment_estimate_fee.py cobo_waas2/models/payment_estimate_fee201_response.py cobo_waas2/models/payment_estimate_fee_request.py @@ -453,9 +465,8 @@ cobo_waas2/models/payment_payout.py cobo_waas2/models/payment_payout_detail.py cobo_waas2/models/payment_payout_event.py cobo_waas2/models/payment_payout_item.py -cobo_waas2/models/payment_payout_item_detail.py -cobo_waas2/models/payment_payout_item_status.py cobo_waas2/models/payment_payout_param.py +cobo_waas2/models/payment_payout_recipient_info.py cobo_waas2/models/payment_payout_status.py cobo_waas2/models/payment_refund_event_data.py cobo_waas2/models/payment_settlement_event.py @@ -744,6 +755,7 @@ cobo_waas2/models/transaction_user_approval_detail.py cobo_waas2/models/transaction_utxo.py cobo_waas2/models/transaction_utxo_change.py cobo_waas2/models/transaction_utxo_fee.py +cobo_waas2/models/transaction_wallet_connect_info.py cobo_waas2/models/transaction_webhook_event_data.py cobo_waas2/models/transfer_destination.py cobo_waas2/models/transfer_destination_type.py @@ -869,8 +881,8 @@ docs/AddressTransferDestinationAccountOutput.md docs/AddressTransferDestinationUtxoOutputsInner.md docs/AddressesEventData.md docs/AddressesEventDataAllOfAddresses.md -docs/AllocationRecord.md -docs/AllocationRequest.md +docs/AllocationItem.md +docs/AllocationParam.md docs/AmountDetailsInner.md docs/AmountStatus.md docs/ApiLogDetails.md @@ -968,6 +980,8 @@ docs/CreateBabylonAirdropRegistrationRequest.md docs/CreateBabylonStakingRegistration201Response.md docs/CreateBabylonStakingRegistrationRequest.md docs/CreateBatchAllocationRequest.md +docs/CreateBulkSendRequest.md +docs/CreateBulkSendRequestPayoutParamsInner.md docs/CreateClaimActivity.md docs/CreateClaimActivityRequest.md docs/CreateCounterpartyEntry201Response.md @@ -1010,6 +1024,8 @@ docs/CreateSwapActivityRequest.md docs/CreateSweepToAddress.md docs/CreateTokenListingRequest201Response.md docs/CreateTokenListingRequestRequest.md +docs/CreateTopUpAddresses.md +docs/CreateTopUpAddresses201Response.md docs/CreateTransferTransaction201Response.md docs/CreateTssRequestRequest.md docs/CreateUnstakeActivity.md @@ -1138,6 +1154,7 @@ docs/GetToken2XXResponse.md docs/GetToken4XXResponse.md docs/GetTokenizationAllowlistActivation200Response.md docs/GetTransactionLimitation200Response.md +docs/GraphQLApi.md docs/GraphQLError.md docs/GraphQLErrorLocationsInner.md docs/GraphQLRequest.md @@ -1169,7 +1186,7 @@ docs/LinkDisplayInfo.md docs/ListAddressBalancesByToken200Response.md docs/ListAddressBooks200Response.md docs/ListAddresses200Response.md -docs/ListAllocations200Response.md +docs/ListAllocationItems200Response.md docs/ListApprovalRequests200Response.md docs/ListAssetBalancesForExchangeWallet200Response.md docs/ListAutoSweepTask200Response.md @@ -1179,6 +1196,7 @@ docs/ListBabylonEligibleStakings200Response.md docs/ListBabylonEligibleStakings200ResponseDataInner.md docs/ListBabylonStakingRegistrations200Response.md docs/ListBatchAllocations200Response.md +docs/ListBulkSendItems200Response.md docs/ListCallbackMessages200Response.md docs/ListCounterparties200Response.md docs/ListCounterpartyEntries200Response.md @@ -1198,7 +1216,6 @@ docs/ListMpcProjects200Response.md docs/ListMpcVaults200Response.md docs/ListPaymentOrders200Response.md docs/ListPaymentWalletBalances200Response.md -docs/ListPayoutItems200Response.md docs/ListPayouts200Response.md docs/ListSettlementDetails200Response.md docs/ListSettlementRequests200Response.md @@ -1266,6 +1283,13 @@ docs/PayerAccount.md docs/PaymentAddressUpdateEventData.md docs/PaymentAllocationAmount.md docs/PaymentApi.md +docs/PaymentBulkSend.md +docs/PaymentBulkSendEvent.md +docs/PaymentBulkSendExecutionMode.md +docs/PaymentBulkSendItem.md +docs/PaymentBulkSendItemStatus.md +docs/PaymentBulkSendItemValidationStatus.md +docs/PaymentBulkSendStatus.md docs/PaymentEstimateFee.md docs/PaymentEstimateFee201Response.md docs/PaymentEstimateFeeRequest.md @@ -1276,9 +1300,8 @@ docs/PaymentPayout.md docs/PaymentPayoutDetail.md docs/PaymentPayoutEvent.md docs/PaymentPayoutItem.md -docs/PaymentPayoutItemDetail.md -docs/PaymentPayoutItemStatus.md docs/PaymentPayoutParam.md +docs/PaymentPayoutRecipientInfo.md docs/PaymentPayoutStatus.md docs/PaymentRefundEventData.md docs/PaymentSettlementEvent.md @@ -1611,6 +1634,7 @@ docs/TransactionUserApprovalDetail.md docs/TransactionUtxo.md docs/TransactionUtxoChange.md docs/TransactionUtxoFee.md +docs/TransactionWalletConnectInfo.md docs/TransactionWebhookEventData.md docs/TransactionsApi.md docs/TransferDestination.md @@ -1706,8 +1730,8 @@ test/test_address_transfer_destination_account_output.py test/test_address_transfer_destination_utxo_outputs_inner.py test/test_addresses_event_data.py test/test_addresses_event_data_all_of_addresses.py -test/test_allocation_record.py -test/test_allocation_request.py +test/test_allocation_item.py +test/test_allocation_param.py test/test_amount_details_inner.py test/test_amount_status.py test/test_api_log_details.py @@ -1805,6 +1829,8 @@ test/test_create_babylon_airdrop_registration_request.py test/test_create_babylon_staking_registration201_response.py test/test_create_babylon_staking_registration_request.py test/test_create_batch_allocation_request.py +test/test_create_bulk_send_request.py +test/test_create_bulk_send_request_payout_params_inner.py test/test_create_claim_activity.py test/test_create_claim_activity_request.py test/test_create_counterparty_entry201_response.py @@ -1847,6 +1873,8 @@ test/test_create_swap_activity_request.py test/test_create_sweep_to_address.py test/test_create_token_listing_request201_response.py test/test_create_token_listing_request_request.py +test/test_create_top_up_addresses.py +test/test_create_top_up_addresses201_response.py test/test_create_transfer_transaction201_response.py test/test_create_tss_request_request.py test/test_create_unstake_activity.py @@ -1975,6 +2003,7 @@ test/test_get_token2_xx_response.py test/test_get_token4_xx_response.py test/test_get_tokenization_allowlist_activation200_response.py test/test_get_transaction_limitation200_response.py +test/test_graph_ql_api.py test/test_graph_ql_error.py test/test_graph_ql_error_locations_inner.py test/test_graph_ql_request.py @@ -2006,7 +2035,7 @@ test/test_link_display_info.py test/test_list_address_balances_by_token200_response.py test/test_list_address_books200_response.py test/test_list_addresses200_response.py -test/test_list_allocations200_response.py +test/test_list_allocation_items200_response.py test/test_list_approval_requests200_response.py test/test_list_asset_balances_for_exchange_wallet200_response.py test/test_list_auto_sweep_task200_response.py @@ -2016,6 +2045,7 @@ test/test_list_babylon_eligible_stakings200_response.py test/test_list_babylon_eligible_stakings200_response_data_inner.py test/test_list_babylon_staking_registrations200_response.py test/test_list_batch_allocations200_response.py +test/test_list_bulk_send_items200_response.py test/test_list_callback_messages200_response.py test/test_list_counterparties200_response.py test/test_list_counterparty_entries200_response.py @@ -2035,7 +2065,6 @@ test/test_list_mpc_projects200_response.py test/test_list_mpc_vaults200_response.py test/test_list_payment_orders200_response.py test/test_list_payment_wallet_balances200_response.py -test/test_list_payout_items200_response.py test/test_list_payouts200_response.py test/test_list_settlement_details200_response.py test/test_list_settlement_requests200_response.py @@ -2103,6 +2132,13 @@ test/test_payer_account.py test/test_payment_address_update_event_data.py test/test_payment_allocation_amount.py test/test_payment_api.py +test/test_payment_bulk_send.py +test/test_payment_bulk_send_event.py +test/test_payment_bulk_send_execution_mode.py +test/test_payment_bulk_send_item.py +test/test_payment_bulk_send_item_status.py +test/test_payment_bulk_send_item_validation_status.py +test/test_payment_bulk_send_status.py test/test_payment_estimate_fee.py test/test_payment_estimate_fee201_response.py test/test_payment_estimate_fee_request.py @@ -2113,9 +2149,8 @@ test/test_payment_payout.py test/test_payment_payout_detail.py test/test_payment_payout_event.py test/test_payment_payout_item.py -test/test_payment_payout_item_detail.py -test/test_payment_payout_item_status.py test/test_payment_payout_param.py +test/test_payment_payout_recipient_info.py test/test_payment_payout_status.py test/test_payment_refund_event_data.py test/test_payment_settlement_event.py @@ -2408,6 +2443,7 @@ test/test_transaction_user_approval_detail.py test/test_transaction_utxo.py test/test_transaction_utxo_change.py test/test_transaction_utxo_fee.py +test/test_transaction_wallet_connect_info.py test/test_transaction_webhook_event_data.py test/test_transactions_api.py test/test_transfer_destination.py diff --git a/README.md b/README.md index dfcaa042..4ca56c94 100644 --- a/README.md +++ b/README.md @@ -14,7 +14,7 @@ For more information about the WaaS 2.0 API, see [Introduction to WaaS 2.0](http This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project: - API version: v2 -- Package version: 1.29.0 +- Package version: 1.30.0 - Generator version: 7.6.0 - Build package: org.openapitools.codegen.languages.PythonClientCodegen For more information, please visit [https://www.cobo.com/waas](https://www.cobo.com/waas) @@ -27,7 +27,7 @@ Python 3.7+ ### pip install ```sh -pip install cobo-waas2==1.29.0 +pip install cobo-waas2==1.30.0 ``` Then import the package: @@ -121,6 +121,7 @@ Class | Method | HTTP request | Description *FeeStationApi* | [**list_fee_station_addresses**](docs/FeeStationApi.md#list_fee_station_addresses) | **GET** /fee_station/addresses | List Fee Station addresses *FeeStationApi* | [**list_fee_station_transactions**](docs/FeeStationApi.md#list_fee_station_transactions) | **GET** /fee_station/transactions | List all Fee Station transactions *FeeStationApi* | [**list_token_balances_for_fee_station**](docs/FeeStationApi.md#list_token_balances_for_fee_station) | **GET** /fee_station/tokens | List Fee Station token balances +*GraphQLApi* | [**execute_graphql**](docs/GraphQLApi.md#execute_graphql) | **POST** /graphql | Execute a GraphQL query or mutation *OAuthApi* | [**exchange_permission_token**](docs/OAuthApi.md#exchange_permission_token) | **POST** /oauth/permission_token/exchange | Get Access Token *OAuthApi* | [**get_token**](docs/OAuthApi.md#get_token) | **GET** /oauth/token | Get Org Access Token *OAuthApi* | [**refresh_permission_token**](docs/OAuthApi.md#refresh_permission_token) | **POST** /oauth/permission_token/refresh | Refresh Access Token @@ -129,6 +130,7 @@ Class | Method | HTTP request | Description *PaymentApi* | [**batch_get_exchange_rates**](docs/PaymentApi.md#batch_get_exchange_rates) | **GET** /payments/exchange_rates | Batch get exchange rates *PaymentApi* | [**cancel_refund_by_id**](docs/PaymentApi.md#cancel_refund_by_id) | **PUT** /payments/refunds/{refund_id}/cancel | Cancel refund order *PaymentApi* | [**create_batch_allocation**](docs/PaymentApi.md#create_batch_allocation) | **POST** /payments/batch_allocations | Create batch allocation +*PaymentApi* | [**create_bulk_send**](docs/PaymentApi.md#create_bulk_send) | **POST** /payments/bulk_sends | Create bulk send *PaymentApi* | [**create_counterparty**](docs/PaymentApi.md#create_counterparty) | **POST** /payments/counterparty | Create counterparty *PaymentApi* | [**create_counterparty_entry**](docs/PaymentApi.md#create_counterparty_entry) | **POST** /payments/counterparty_entry | Create counterparty entry *PaymentApi* | [**create_counterparty_wallet_address**](docs/PaymentApi.md#create_counterparty_wallet_address) | **POST** /payments/counterparty/wallet_address | Create counterparty wallet address @@ -146,6 +148,7 @@ Class | Method | HTTP request | Description *PaymentApi* | [**create_refund_link**](docs/PaymentApi.md#create_refund_link) | **POST** /payments/links/refunds | Create refund link *PaymentApi* | [**create_report**](docs/PaymentApi.md#create_report) | **POST** /payments/reports | Generate reports *PaymentApi* | [**create_settlement_request**](docs/PaymentApi.md#create_settlement_request) | **POST** /payments/settlement_requests | Create settlement request +*PaymentApi* | [**create_top_up_addresses**](docs/PaymentApi.md#create_top_up_addresses) | **POST** /payments/topup/address | Batch create top-up addresses *PaymentApi* | [**delete_counterparty**](docs/PaymentApi.md#delete_counterparty) | **PUT** /payments/counterparty/{counterparty_id}/delete | Delete counterparty (Deprecated) *PaymentApi* | [**delete_counterparty_by_id**](docs/PaymentApi.md#delete_counterparty_by_id) | **DELETE** /payments/counterparty/{counterparty_id} | Delete counterparty *PaymentApi* | [**delete_counterparty_entry**](docs/PaymentApi.md#delete_counterparty_entry) | **DELETE** /payments/counterparty_entry/{counterparty_entry_id} | Delete counterparty entry @@ -159,6 +162,7 @@ Class | Method | HTTP request | Description *PaymentApi* | [**enable_destination_whitelist**](docs/PaymentApi.md#enable_destination_whitelist) | **POST** /payments/destination/enable_whitelist | Enable or disable destination whitelist *PaymentApi* | [**get_available_allocation_amount**](docs/PaymentApi.md#get_available_allocation_amount) | **GET** /payments/allocation_amount | Get available allocation amount *PaymentApi* | [**get_batch_allocation_by_id**](docs/PaymentApi.md#get_batch_allocation_by_id) | **GET** /payments/batch_allocations/{batch_allocation_id} | Get batch allocation information +*PaymentApi* | [**get_bulk_send_by_id**](docs/PaymentApi.md#get_bulk_send_by_id) | **GET** /payments/bulk_sends/{bulk_send_id} | Get bulk send information *PaymentApi* | [**get_counterparty**](docs/PaymentApi.md#get_counterparty) | **GET** /payments/counterparty/{counterparty_id} | Get counterparty information *PaymentApi* | [**get_counterparty_detail_by_id**](docs/PaymentApi.md#get_counterparty_detail_by_id) | **GET** /payments/counterparty/{counterparty_id}/detail | Get counterparty information (Deprecated) *PaymentApi* | [**get_counterparty_entry**](docs/PaymentApi.md#get_counterparty_entry) | **GET** /payments/counterparty_entry/{counterparty_entry_id} | Get counterparty entry information @@ -176,9 +180,10 @@ Class | Method | HTTP request | Description *PaymentApi* | [**get_settlement_by_id**](docs/PaymentApi.md#get_settlement_by_id) | **GET** /payments/settlement_requests/{settlement_request_id} | Get settlement request information *PaymentApi* | [**get_settlement_info_by_ids**](docs/PaymentApi.md#get_settlement_info_by_ids) | **GET** /payments/settlement_info | Get withdrawable balances *PaymentApi* | [**get_top_up_address**](docs/PaymentApi.md#get_top_up_address) | **GET** /payments/topup/address | Create/Get top-up address -*PaymentApi* | [**list_allocations**](docs/PaymentApi.md#list_allocations) | **GET** /payments/allocation_records | List all allocation records +*PaymentApi* | [**list_allocation_items**](docs/PaymentApi.md#list_allocation_items) | **GET** /payments/allocation_items | List all allocation items *PaymentApi* | [**list_bank_accounts**](docs/PaymentApi.md#list_bank_accounts) | **GET** /payments/bank_accounts | List all bank accounts *PaymentApi* | [**list_batch_allocations**](docs/PaymentApi.md#list_batch_allocations) | **GET** /payments/batch_allocations | List all batch allocations +*PaymentApi* | [**list_bulk_send_items**](docs/PaymentApi.md#list_bulk_send_items) | **GET** /payments/bulk_sends/{bulk_send_id}/items | List bulk send items *PaymentApi* | [**list_counterparties**](docs/PaymentApi.md#list_counterparties) | **GET** /payments/counterparty | List all counterparties *PaymentApi* | [**list_counterparty_entries**](docs/PaymentApi.md#list_counterparty_entries) | **GET** /payments/counterparty_entry | List counterparty entries *PaymentApi* | [**list_counterparty_wallet_address**](docs/PaymentApi.md#list_counterparty_wallet_address) | **GET** /payments/counterparty/wallet_address | List counterparty wallet addresses @@ -193,7 +198,6 @@ Class | Method | HTTP request | Description *PaymentApi* | [**list_payment_orders**](docs/PaymentApi.md#list_payment_orders) | **GET** /payments/orders | List all pay-in orders *PaymentApi* | [**list_payment_supported_tokens**](docs/PaymentApi.md#list_payment_supported_tokens) | **GET** /payments/supported_tokens | List all supported tokens *PaymentApi* | [**list_payment_wallet_balances**](docs/PaymentApi.md#list_payment_wallet_balances) | **GET** /payments/balance/payment_wallets | List payment wallet balances -*PaymentApi* | [**list_payout_items**](docs/PaymentApi.md#list_payout_items) | **GET** /payments/payout_items | List all payout items *PaymentApi* | [**list_payouts**](docs/PaymentApi.md#list_payouts) | **GET** /payments/payouts | List all payouts *PaymentApi* | [**list_settlement_details**](docs/PaymentApi.md#list_settlement_details) | **GET** /payments/settlement_details | List all settlement details *PaymentApi* | [**list_settlement_requests**](docs/PaymentApi.md#list_settlement_requests) | **GET** /payments/settlement_requests | List all settlement requests @@ -364,8 +368,8 @@ Class | Method | HTTP request | Description - [AddressTransferDestinationUtxoOutputsInner](docs/AddressTransferDestinationUtxoOutputsInner.md) - [AddressesEventData](docs/AddressesEventData.md) - [AddressesEventDataAllOfAddresses](docs/AddressesEventDataAllOfAddresses.md) - - [AllocationRecord](docs/AllocationRecord.md) - - [AllocationRequest](docs/AllocationRequest.md) + - [AllocationItem](docs/AllocationItem.md) + - [AllocationParam](docs/AllocationParam.md) - [AmountDetailsInner](docs/AmountDetailsInner.md) - [AmountStatus](docs/AmountStatus.md) - [ApiLogDetails](docs/ApiLogDetails.md) @@ -460,6 +464,8 @@ Class | Method | HTTP request | Description - [CreateBabylonStakingRegistration201Response](docs/CreateBabylonStakingRegistration201Response.md) - [CreateBabylonStakingRegistrationRequest](docs/CreateBabylonStakingRegistrationRequest.md) - [CreateBatchAllocationRequest](docs/CreateBatchAllocationRequest.md) + - [CreateBulkSendRequest](docs/CreateBulkSendRequest.md) + - [CreateBulkSendRequestPayoutParamsInner](docs/CreateBulkSendRequestPayoutParamsInner.md) - [CreateClaimActivity](docs/CreateClaimActivity.md) - [CreateClaimActivityRequest](docs/CreateClaimActivityRequest.md) - [CreateCounterpartyEntry201Response](docs/CreateCounterpartyEntry201Response.md) @@ -502,6 +508,8 @@ Class | Method | HTTP request | Description - [CreateSweepToAddress](docs/CreateSweepToAddress.md) - [CreateTokenListingRequest201Response](docs/CreateTokenListingRequest201Response.md) - [CreateTokenListingRequestRequest](docs/CreateTokenListingRequestRequest.md) + - [CreateTopUpAddresses](docs/CreateTopUpAddresses.md) + - [CreateTopUpAddresses201Response](docs/CreateTopUpAddresses201Response.md) - [CreateTransferTransaction201Response](docs/CreateTransferTransaction201Response.md) - [CreateTssRequestRequest](docs/CreateTssRequestRequest.md) - [CreateUnstakeActivity](docs/CreateUnstakeActivity.md) @@ -658,7 +666,7 @@ Class | Method | HTTP request | Description - [ListAddressBalancesByToken200Response](docs/ListAddressBalancesByToken200Response.md) - [ListAddressBooks200Response](docs/ListAddressBooks200Response.md) - [ListAddresses200Response](docs/ListAddresses200Response.md) - - [ListAllocations200Response](docs/ListAllocations200Response.md) + - [ListAllocationItems200Response](docs/ListAllocationItems200Response.md) - [ListApprovalRequests200Response](docs/ListApprovalRequests200Response.md) - [ListAssetBalancesForExchangeWallet200Response](docs/ListAssetBalancesForExchangeWallet200Response.md) - [ListAutoSweepTask200Response](docs/ListAutoSweepTask200Response.md) @@ -668,6 +676,7 @@ Class | Method | HTTP request | Description - [ListBabylonEligibleStakings200ResponseDataInner](docs/ListBabylonEligibleStakings200ResponseDataInner.md) - [ListBabylonStakingRegistrations200Response](docs/ListBabylonStakingRegistrations200Response.md) - [ListBatchAllocations200Response](docs/ListBatchAllocations200Response.md) + - [ListBulkSendItems200Response](docs/ListBulkSendItems200Response.md) - [ListCallbackMessages200Response](docs/ListCallbackMessages200Response.md) - [ListCounterparties200Response](docs/ListCounterparties200Response.md) - [ListCounterpartyEntries200Response](docs/ListCounterpartyEntries200Response.md) @@ -687,7 +696,6 @@ Class | Method | HTTP request | Description - [ListMpcVaults200Response](docs/ListMpcVaults200Response.md) - [ListPaymentOrders200Response](docs/ListPaymentOrders200Response.md) - [ListPaymentWalletBalances200Response](docs/ListPaymentWalletBalances200Response.md) - - [ListPayoutItems200Response](docs/ListPayoutItems200Response.md) - [ListPayouts200Response](docs/ListPayouts200Response.md) - [ListSettlementDetails200Response](docs/ListSettlementDetails200Response.md) - [ListSettlementRequests200Response](docs/ListSettlementRequests200Response.md) @@ -752,6 +760,13 @@ Class | Method | HTTP request | Description - [PayerAccount](docs/PayerAccount.md) - [PaymentAddressUpdateEventData](docs/PaymentAddressUpdateEventData.md) - [PaymentAllocationAmount](docs/PaymentAllocationAmount.md) + - [PaymentBulkSend](docs/PaymentBulkSend.md) + - [PaymentBulkSendEvent](docs/PaymentBulkSendEvent.md) + - [PaymentBulkSendExecutionMode](docs/PaymentBulkSendExecutionMode.md) + - [PaymentBulkSendItem](docs/PaymentBulkSendItem.md) + - [PaymentBulkSendItemStatus](docs/PaymentBulkSendItemStatus.md) + - [PaymentBulkSendItemValidationStatus](docs/PaymentBulkSendItemValidationStatus.md) + - [PaymentBulkSendStatus](docs/PaymentBulkSendStatus.md) - [PaymentEstimateFee](docs/PaymentEstimateFee.md) - [PaymentEstimateFee201Response](docs/PaymentEstimateFee201Response.md) - [PaymentEstimateFeeRequest](docs/PaymentEstimateFeeRequest.md) @@ -762,9 +777,8 @@ Class | Method | HTTP request | Description - [PaymentPayoutDetail](docs/PaymentPayoutDetail.md) - [PaymentPayoutEvent](docs/PaymentPayoutEvent.md) - [PaymentPayoutItem](docs/PaymentPayoutItem.md) - - [PaymentPayoutItemDetail](docs/PaymentPayoutItemDetail.md) - - [PaymentPayoutItemStatus](docs/PaymentPayoutItemStatus.md) - [PaymentPayoutParam](docs/PaymentPayoutParam.md) + - [PaymentPayoutRecipientInfo](docs/PaymentPayoutRecipientInfo.md) - [PaymentPayoutStatus](docs/PaymentPayoutStatus.md) - [PaymentRefundEventData](docs/PaymentRefundEventData.md) - [PaymentSettlementEvent](docs/PaymentSettlementEvent.md) @@ -1093,6 +1107,7 @@ Class | Method | HTTP request | Description - [TransactionUtxo](docs/TransactionUtxo.md) - [TransactionUtxoChange](docs/TransactionUtxoChange.md) - [TransactionUtxoFee](docs/TransactionUtxoFee.md) + - [TransactionWalletConnectInfo](docs/TransactionWalletConnectInfo.md) - [TransactionWebhookEventData](docs/TransactionWebhookEventData.md) - [TransferDestination](docs/TransferDestination.md) - [TransferDestinationType](docs/TransferDestinationType.md) diff --git a/cobo_waas2/__init__.py b/cobo_waas2/__init__.py index 6dd15875..b2b7c29f 100644 --- a/cobo_waas2/__init__.py +++ b/cobo_waas2/__init__.py @@ -12,7 +12,7 @@ """ # noqa: E501 -__version__ = "1.29.0" +__version__ = "1.30.0" # import apis into sdk package from cobo_waas2.api.address_books_api import AddressBooksApi @@ -22,6 +22,7 @@ from cobo_waas2.api.developers_api import DevelopersApi from cobo_waas2.api.developers_webhooks_api import DevelopersWebhooksApi from cobo_waas2.api.fee_station_api import FeeStationApi +from cobo_waas2.api.graph_ql_api import GraphQLApi from cobo_waas2.api.o_auth_api import OAuthApi from cobo_waas2.api.organizations_api import OrganizationsApi from cobo_waas2.api.payment_api import PaymentApi @@ -67,8 +68,8 @@ from cobo_waas2.models.address_transfer_destination_utxo_outputs_inner import AddressTransferDestinationUtxoOutputsInner from cobo_waas2.models.addresses_event_data import AddressesEventData from cobo_waas2.models.addresses_event_data_all_of_addresses import AddressesEventDataAllOfAddresses -from cobo_waas2.models.allocation_record import AllocationRecord -from cobo_waas2.models.allocation_request import AllocationRequest +from cobo_waas2.models.allocation_item import AllocationItem +from cobo_waas2.models.allocation_param import AllocationParam from cobo_waas2.models.amount_details_inner import AmountDetailsInner from cobo_waas2.models.amount_status import AmountStatus from cobo_waas2.models.api_log_details import ApiLogDetails @@ -163,6 +164,8 @@ from cobo_waas2.models.create_babylon_staking_registration201_response import CreateBabylonStakingRegistration201Response from cobo_waas2.models.create_babylon_staking_registration_request import CreateBabylonStakingRegistrationRequest from cobo_waas2.models.create_batch_allocation_request import CreateBatchAllocationRequest +from cobo_waas2.models.create_bulk_send_request import CreateBulkSendRequest +from cobo_waas2.models.create_bulk_send_request_payout_params_inner import CreateBulkSendRequestPayoutParamsInner from cobo_waas2.models.create_claim_activity import CreateClaimActivity from cobo_waas2.models.create_claim_activity_request import CreateClaimActivityRequest from cobo_waas2.models.create_counterparty_entry201_response import CreateCounterpartyEntry201Response @@ -205,6 +208,8 @@ from cobo_waas2.models.create_sweep_to_address import CreateSweepToAddress from cobo_waas2.models.create_token_listing_request201_response import CreateTokenListingRequest201Response from cobo_waas2.models.create_token_listing_request_request import CreateTokenListingRequestRequest +from cobo_waas2.models.create_top_up_addresses import CreateTopUpAddresses +from cobo_waas2.models.create_top_up_addresses201_response import CreateTopUpAddresses201Response from cobo_waas2.models.create_transfer_transaction201_response import CreateTransferTransaction201Response from cobo_waas2.models.create_tss_request_request import CreateTssRequestRequest from cobo_waas2.models.create_unstake_activity import CreateUnstakeActivity @@ -361,7 +366,7 @@ from cobo_waas2.models.list_address_balances_by_token200_response import ListAddressBalancesByToken200Response from cobo_waas2.models.list_address_books200_response import ListAddressBooks200Response from cobo_waas2.models.list_addresses200_response import ListAddresses200Response -from cobo_waas2.models.list_allocations200_response import ListAllocations200Response +from cobo_waas2.models.list_allocation_items200_response import ListAllocationItems200Response from cobo_waas2.models.list_approval_requests200_response import ListApprovalRequests200Response from cobo_waas2.models.list_asset_balances_for_exchange_wallet200_response import ListAssetBalancesForExchangeWallet200Response from cobo_waas2.models.list_auto_sweep_task200_response import ListAutoSweepTask200Response @@ -371,6 +376,7 @@ from cobo_waas2.models.list_babylon_eligible_stakings200_response_data_inner import ListBabylonEligibleStakings200ResponseDataInner from cobo_waas2.models.list_babylon_staking_registrations200_response import ListBabylonStakingRegistrations200Response from cobo_waas2.models.list_batch_allocations200_response import ListBatchAllocations200Response +from cobo_waas2.models.list_bulk_send_items200_response import ListBulkSendItems200Response from cobo_waas2.models.list_callback_messages200_response import ListCallbackMessages200Response from cobo_waas2.models.list_counterparties200_response import ListCounterparties200Response from cobo_waas2.models.list_counterparty_entries200_response import ListCounterpartyEntries200Response @@ -390,7 +396,6 @@ from cobo_waas2.models.list_mpc_vaults200_response import ListMpcVaults200Response from cobo_waas2.models.list_payment_orders200_response import ListPaymentOrders200Response from cobo_waas2.models.list_payment_wallet_balances200_response import ListPaymentWalletBalances200Response -from cobo_waas2.models.list_payout_items200_response import ListPayoutItems200Response from cobo_waas2.models.list_payouts200_response import ListPayouts200Response from cobo_waas2.models.list_settlement_details200_response import ListSettlementDetails200Response from cobo_waas2.models.list_settlement_requests200_response import ListSettlementRequests200Response @@ -455,6 +460,13 @@ from cobo_waas2.models.payer_account import PayerAccount from cobo_waas2.models.payment_address_update_event_data import PaymentAddressUpdateEventData from cobo_waas2.models.payment_allocation_amount import PaymentAllocationAmount +from cobo_waas2.models.payment_bulk_send import PaymentBulkSend +from cobo_waas2.models.payment_bulk_send_event import PaymentBulkSendEvent +from cobo_waas2.models.payment_bulk_send_execution_mode import PaymentBulkSendExecutionMode +from cobo_waas2.models.payment_bulk_send_item import PaymentBulkSendItem +from cobo_waas2.models.payment_bulk_send_item_status import PaymentBulkSendItemStatus +from cobo_waas2.models.payment_bulk_send_item_validation_status import PaymentBulkSendItemValidationStatus +from cobo_waas2.models.payment_bulk_send_status import PaymentBulkSendStatus from cobo_waas2.models.payment_estimate_fee import PaymentEstimateFee from cobo_waas2.models.payment_estimate_fee201_response import PaymentEstimateFee201Response from cobo_waas2.models.payment_estimate_fee_request import PaymentEstimateFeeRequest @@ -465,9 +477,8 @@ from cobo_waas2.models.payment_payout_detail import PaymentPayoutDetail from cobo_waas2.models.payment_payout_event import PaymentPayoutEvent from cobo_waas2.models.payment_payout_item import PaymentPayoutItem -from cobo_waas2.models.payment_payout_item_detail import PaymentPayoutItemDetail -from cobo_waas2.models.payment_payout_item_status import PaymentPayoutItemStatus from cobo_waas2.models.payment_payout_param import PaymentPayoutParam +from cobo_waas2.models.payment_payout_recipient_info import PaymentPayoutRecipientInfo from cobo_waas2.models.payment_payout_status import PaymentPayoutStatus from cobo_waas2.models.payment_refund_event_data import PaymentRefundEventData from cobo_waas2.models.payment_settlement_event import PaymentSettlementEvent @@ -796,6 +807,7 @@ from cobo_waas2.models.transaction_utxo import TransactionUtxo from cobo_waas2.models.transaction_utxo_change import TransactionUtxoChange from cobo_waas2.models.transaction_utxo_fee import TransactionUtxoFee +from cobo_waas2.models.transaction_wallet_connect_info import TransactionWalletConnectInfo from cobo_waas2.models.transaction_webhook_event_data import TransactionWebhookEventData from cobo_waas2.models.transfer_destination import TransferDestination from cobo_waas2.models.transfer_destination_type import TransferDestinationType diff --git a/cobo_waas2/api/__init__.py b/cobo_waas2/api/__init__.py index 562fe0ff..7ae923af 100644 --- a/cobo_waas2/api/__init__.py +++ b/cobo_waas2/api/__init__.py @@ -8,6 +8,7 @@ from cobo_waas2.api.developers_api import DevelopersApi from cobo_waas2.api.developers_webhooks_api import DevelopersWebhooksApi from cobo_waas2.api.fee_station_api import FeeStationApi +from cobo_waas2.api.graph_ql_api import GraphQLApi from cobo_waas2.api.o_auth_api import OAuthApi from cobo_waas2.api.organizations_api import OrganizationsApi from cobo_waas2.api.payment_api import PaymentApi diff --git a/cobo_waas2/api/compliance_api.py b/cobo_waas2/api/compliance_api.py index dfa48fc1..5b7d9c0d 100644 --- a/cobo_waas2/api/compliance_api.py +++ b/cobo_waas2/api/compliance_api.py @@ -61,7 +61,7 @@ def create_kya_screenings( ) -> List[KyaScreeningResult]: """Create KYA address screening requests - This operation submits up to 50 address screening requests in one request to assess address compliance and risk levels. This endpoint supports cross-chain address screening with independent idempotency for each address, enabling flexible error handling and partial retries. + This operation submits up to 50 address screening requests in one call to assess address compliance and risk levels. This endpoint supports cross-chain address screening with independent idempotency for each address, enabling flexible error handling and partial retries. :param create_kya_screenings_body: The request body to create KYA address screening requests. :type create_kya_screenings_body: CreateKyaScreeningsBody @@ -107,7 +107,7 @@ def create_kya_screenings_with_http_info( ) -> ApiResponse[List[KyaScreeningResult]]: """Create KYA address screening requests - This operation submits up to 50 address screening requests in one request to assess address compliance and risk levels. This endpoint supports cross-chain address screening with independent idempotency for each address, enabling flexible error handling and partial retries. + This operation submits up to 50 address screening requests in one call to assess address compliance and risk levels. This endpoint supports cross-chain address screening with independent idempotency for each address, enabling flexible error handling and partial retries. :param create_kya_screenings_body: The request body to create KYA address screening requests. :type create_kya_screenings_body: CreateKyaScreeningsBody @@ -153,7 +153,7 @@ def create_kya_screenings_without_preload_content( ) -> RESTResponseType: """Create KYA address screening requests - This operation submits up to 50 address screening requests in one request to assess address compliance and risk levels. This endpoint supports cross-chain address screening with independent idempotency for each address, enabling flexible error handling and partial retries. + This operation submits up to 50 address screening requests in one call to assess address compliance and risk levels. This endpoint supports cross-chain address screening with independent idempotency for each address, enabling flexible error handling and partial retries. :param create_kya_screenings_body: The request body to create KYA address screening requests. :type create_kya_screenings_body: CreateKyaScreeningsBody diff --git a/cobo_waas2/api/graph_ql_api.py b/cobo_waas2/api/graph_ql_api.py new file mode 100644 index 00000000..35b74681 --- /dev/null +++ b/cobo_waas2/api/graph_ql_api.py @@ -0,0 +1,206 @@ +# coding: utf-8 + +""" + Cobo Wallet as a Service 2.0 + + Contact: help@cobo.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + +from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt +from typing import Any, Dict, List, Optional, Tuple, Union +from typing_extensions import Annotated + +from pydantic import Field +from typing import Optional +from typing_extensions import Annotated +from cobo_waas2.models.graph_ql_request import GraphQLRequest +from cobo_waas2.models.graph_ql_response import GraphQLResponse + +from cobo_waas2.api_client import ApiClient, RequestSerialized +from cobo_waas2.api_response import ApiResponse +from cobo_waas2.rest import RESTResponseType + + +class GraphQLApi: + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client: ApiClient = None) -> None: + if api_client is None: + api_client = ApiClient.get_default() + self.api_client = api_client + + @validate_call + def execute_graphql( + self, + graph_ql_request: Annotated[Optional[GraphQLRequest], Field(description="The request body to generate addresses within a specified wallet.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + ) -> GraphQLResponse: + """Execute a GraphQL query or mutation + + This endpoint executes a GraphQL query or mutation. The request body must include a valid GraphQL query string. + + :param graph_ql_request: The request body to generate addresses within a specified wallet. + :type graph_ql_request: GraphQLRequest + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._execute_graphql_serialize( + graph_ql_request=graph_ql_request, + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "GraphQLResponse", + '4XX': "ErrorResponse", + '5XX': "ErrorResponse", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + @validate_call + def execute_graphql_with_http_info( + self, + graph_ql_request: Annotated[Optional[GraphQLRequest], Field(description="The request body to generate addresses within a specified wallet.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + ) -> ApiResponse[GraphQLResponse]: + """Execute a GraphQL query or mutation + + This endpoint executes a GraphQL query or mutation. The request body must include a valid GraphQL query string. + + :param graph_ql_request: The request body to generate addresses within a specified wallet. + :type graph_ql_request: GraphQLRequest + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._execute_graphql_serialize( + graph_ql_request=graph_ql_request, + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "GraphQLResponse", + '4XX': "ErrorResponse", + '5XX': "ErrorResponse", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + @validate_call + def execute_graphql_without_preload_content( + self, + graph_ql_request: Annotated[Optional[GraphQLRequest], Field(description="The request body to generate addresses within a specified wallet.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + ) -> RESTResponseType: + """Execute a GraphQL query or mutation + + This endpoint executes a GraphQL query or mutation. The request body must include a valid GraphQL query string. + + :param graph_ql_request: The request body to generate addresses within a specified wallet. + :type graph_ql_request: GraphQLRequest + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._execute_graphql_serialize( + graph_ql_request=graph_ql_request, + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "GraphQLResponse", + '4XX': "ErrorResponse", + '5XX': "ErrorResponse", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + def _execute_graphql_serialize( + self, + graph_ql_request, + ) -> RequestSerialized: + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, Union[str, bytes]] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if graph_ql_request is not None: + _body_params = graph_ql_request + + # set the HTTP header `Accept` + _header_params = { + "Accept": "application/json", + "Content-Type": "application/json" + } + + return self.api_client.param_serialize( + method='POST', + resource_path='/graphql', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + ) diff --git a/cobo_waas2/api/payment_api.py b/cobo_waas2/api/payment_api.py index cf5e2f57..0e6fe45e 100644 --- a/cobo_waas2/api/payment_api.py +++ b/cobo_waas2/api/payment_api.py @@ -25,6 +25,7 @@ from cobo_waas2.models.counterparty_detail import CounterpartyDetail from cobo_waas2.models.counterparty_type import CounterpartyType from cobo_waas2.models.create_batch_allocation_request import CreateBatchAllocationRequest +from cobo_waas2.models.create_bulk_send_request import CreateBulkSendRequest from cobo_waas2.models.create_counterparty_entry201_response import CreateCounterpartyEntry201Response from cobo_waas2.models.create_counterparty_entry_request import CreateCounterpartyEntryRequest from cobo_waas2.models.create_counterparty_request import CreateCounterpartyRequest @@ -43,6 +44,8 @@ from cobo_waas2.models.create_refund_request import CreateRefundRequest from cobo_waas2.models.create_report_request import CreateReportRequest from cobo_waas2.models.create_settlement_request_request import CreateSettlementRequestRequest +from cobo_waas2.models.create_top_up_addresses import CreateTopUpAddresses +from cobo_waas2.models.create_top_up_addresses201_response import CreateTopUpAddresses201Response from cobo_waas2.models.crypto_address import CryptoAddress from cobo_waas2.models.delete_counterparty200_response import DeleteCounterparty200Response from cobo_waas2.models.delete_counterparty_by_id200_response import DeleteCounterpartyById200Response @@ -71,8 +74,9 @@ from cobo_waas2.models.get_reports200_response import GetReports200Response from cobo_waas2.models.get_settlement_info_by_ids200_response import GetSettlementInfoByIds200Response from cobo_waas2.models.link import Link -from cobo_waas2.models.list_allocations200_response import ListAllocations200Response +from cobo_waas2.models.list_allocation_items200_response import ListAllocationItems200Response from cobo_waas2.models.list_batch_allocations200_response import ListBatchAllocations200Response +from cobo_waas2.models.list_bulk_send_items200_response import ListBulkSendItems200Response from cobo_waas2.models.list_counterparties200_response import ListCounterparties200Response from cobo_waas2.models.list_counterparty_entries200_response import ListCounterpartyEntries200Response from cobo_waas2.models.list_counterparty_wallet_address200_response import ListCounterpartyWalletAddress200Response @@ -85,7 +89,6 @@ from cobo_waas2.models.list_merchants200_response import ListMerchants200Response from cobo_waas2.models.list_payment_orders200_response import ListPaymentOrders200Response from cobo_waas2.models.list_payment_wallet_balances200_response import ListPaymentWalletBalances200Response -from cobo_waas2.models.list_payout_items200_response import ListPayoutItems200Response from cobo_waas2.models.list_payouts200_response import ListPayouts200Response from cobo_waas2.models.list_settlement_details200_response import ListSettlementDetails200Response from cobo_waas2.models.list_settlement_requests200_response import ListSettlementRequests200Response @@ -94,6 +97,7 @@ from cobo_waas2.models.merchant import Merchant from cobo_waas2.models.order import Order from cobo_waas2.models.payment_allocation_amount import PaymentAllocationAmount +from cobo_waas2.models.payment_bulk_send import PaymentBulkSend from cobo_waas2.models.payment_estimate_fee201_response import PaymentEstimateFee201Response from cobo_waas2.models.payment_estimate_fee_request import PaymentEstimateFeeRequest from cobo_waas2.models.payment_payout import PaymentPayout @@ -665,6 +669,175 @@ def _create_batch_allocation_serialize( files=_files, ) + @validate_call + def create_bulk_send( + self, + create_bulk_send_request: Annotated[Optional[CreateBulkSendRequest], Field(description="The request body to create a bulk send.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + ) -> PaymentBulkSend: + """Create bulk send + + This operation creates a bulk send to transfer funds to multiple recipients in a single request. + + :param create_bulk_send_request: The request body to create a bulk send. + :type create_bulk_send_request: CreateBulkSendRequest + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_bulk_send_serialize( + create_bulk_send_request=create_bulk_send_request, + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "PaymentBulkSend", + '4XX': "ErrorResponse", + '5XX': "ErrorResponse", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + @validate_call + def create_bulk_send_with_http_info( + self, + create_bulk_send_request: Annotated[Optional[CreateBulkSendRequest], Field(description="The request body to create a bulk send.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + ) -> ApiResponse[PaymentBulkSend]: + """Create bulk send + + This operation creates a bulk send to transfer funds to multiple recipients in a single request. + + :param create_bulk_send_request: The request body to create a bulk send. + :type create_bulk_send_request: CreateBulkSendRequest + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_bulk_send_serialize( + create_bulk_send_request=create_bulk_send_request, + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "PaymentBulkSend", + '4XX': "ErrorResponse", + '5XX': "ErrorResponse", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + @validate_call + def create_bulk_send_without_preload_content( + self, + create_bulk_send_request: Annotated[Optional[CreateBulkSendRequest], Field(description="The request body to create a bulk send.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + ) -> RESTResponseType: + """Create bulk send + + This operation creates a bulk send to transfer funds to multiple recipients in a single request. + + :param create_bulk_send_request: The request body to create a bulk send. + :type create_bulk_send_request: CreateBulkSendRequest + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_bulk_send_serialize( + create_bulk_send_request=create_bulk_send_request, + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "PaymentBulkSend", + '4XX': "ErrorResponse", + '5XX': "ErrorResponse", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + def _create_bulk_send_serialize( + self, + create_bulk_send_request, + ) -> RequestSerialized: + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, Union[str, bytes]] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if create_bulk_send_request is not None: + _body_params = create_bulk_send_request + + # set the HTTP header `Accept` + _header_params = { + "Accept": "application/json", + "Content-Type": "application/json" + } + + return self.api_client.param_serialize( + method='POST', + resource_path='/payments/bulk_sends', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + ) + @validate_call def create_counterparty( self, @@ -2708,7 +2881,7 @@ def create_payout( ) -> PaymentPayout: """Create payout - This operation initiates a payout, distributing funds either to cryptocurrency addresses or to bank accounts as fiat currency. + This operation creates a payout to withdraw available balances. :param create_payout_request: The request body to create a payout. :type create_payout_request: CreatePayoutRequest @@ -2754,7 +2927,7 @@ def create_payout_with_http_info( ) -> ApiResponse[PaymentPayout]: """Create payout - This operation initiates a payout, distributing funds either to cryptocurrency addresses or to bank accounts as fiat currency. + This operation creates a payout to withdraw available balances. :param create_payout_request: The request body to create a payout. :type create_payout_request: CreatePayoutRequest @@ -2800,7 +2973,7 @@ def create_payout_without_preload_content( ) -> RESTResponseType: """Create payout - This operation initiates a payout, distributing funds either to cryptocurrency addresses or to bank accounts as fiat currency. + This operation creates a payout to withdraw available balances. :param create_payout_request: The request body to create a payout. :type create_payout_request: CreatePayoutRequest @@ -3384,7 +3557,7 @@ def create_settlement_request( ) -> Settlement: """Create settlement request - This operation creates a settlement request to withdraw available balances. + This operation has been deprecated. Please use [Create payout](https://www.cobo.com/payments/en/api-references/payment/create-payout) instead. You can include multiple merchants and cryptocurrencies in a single settlement request. :param create_settlement_request_request: The request body to create a settlement request. :type create_settlement_request_request: CreateSettlementRequestRequest @@ -3430,7 +3603,7 @@ def create_settlement_request_with_http_info( ) -> ApiResponse[Settlement]: """Create settlement request - This operation creates a settlement request to withdraw available balances. + This operation has been deprecated. Please use [Create payout](https://www.cobo.com/payments/en/api-references/payment/create-payout) instead. You can include multiple merchants and cryptocurrencies in a single settlement request. :param create_settlement_request_request: The request body to create a settlement request. :type create_settlement_request_request: CreateSettlementRequestRequest @@ -3476,7 +3649,7 @@ def create_settlement_request_without_preload_content( ) -> RESTResponseType: """Create settlement request - This operation creates a settlement request to withdraw available balances. + This operation has been deprecated. Please use [Create payout](https://www.cobo.com/payments/en/api-references/payment/create-payout) instead. You can include multiple merchants and cryptocurrencies in a single settlement request. :param create_settlement_request_request: The request body to create a settlement request. :type create_settlement_request_request: CreateSettlementRequestRequest @@ -3538,6 +3711,175 @@ def _create_settlement_request_serialize( files=_files, ) + @validate_call + def create_top_up_addresses( + self, + create_top_up_addresses: Annotated[Optional[CreateTopUpAddresses], Field(description="The request body of the create top-up addresses operation.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + ) -> CreateTopUpAddresses201Response: + """Batch create top-up addresses + + This operation creates top-up addresses for multiple payers under a specific merchant and token in a single request. This operation supports batch processing of up to 50 payers per request. + + :param create_top_up_addresses: The request body of the create top-up addresses operation. + :type create_top_up_addresses: CreateTopUpAddresses + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_top_up_addresses_serialize( + create_top_up_addresses=create_top_up_addresses, + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "CreateTopUpAddresses201Response", + '4XX': "ErrorResponse", + '5XX': "ErrorResponse", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + @validate_call + def create_top_up_addresses_with_http_info( + self, + create_top_up_addresses: Annotated[Optional[CreateTopUpAddresses], Field(description="The request body of the create top-up addresses operation.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + ) -> ApiResponse[CreateTopUpAddresses201Response]: + """Batch create top-up addresses + + This operation creates top-up addresses for multiple payers under a specific merchant and token in a single request. This operation supports batch processing of up to 50 payers per request. + + :param create_top_up_addresses: The request body of the create top-up addresses operation. + :type create_top_up_addresses: CreateTopUpAddresses + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_top_up_addresses_serialize( + create_top_up_addresses=create_top_up_addresses, + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "CreateTopUpAddresses201Response", + '4XX': "ErrorResponse", + '5XX': "ErrorResponse", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + @validate_call + def create_top_up_addresses_without_preload_content( + self, + create_top_up_addresses: Annotated[Optional[CreateTopUpAddresses], Field(description="The request body of the create top-up addresses operation.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + ) -> RESTResponseType: + """Batch create top-up addresses + + This operation creates top-up addresses for multiple payers under a specific merchant and token in a single request. This operation supports batch processing of up to 50 payers per request. + + :param create_top_up_addresses: The request body of the create top-up addresses operation. + :type create_top_up_addresses: CreateTopUpAddresses + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_top_up_addresses_serialize( + create_top_up_addresses=create_top_up_addresses, + ) + + _response_types_map: Dict[str, Optional[str]] = { + '201': "CreateTopUpAddresses201Response", + '4XX': "ErrorResponse", + '5XX': "ErrorResponse", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + def _create_top_up_addresses_serialize( + self, + create_top_up_addresses, + ) -> RequestSerialized: + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, Union[str, bytes]] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if create_top_up_addresses is not None: + _body_params = create_top_up_addresses + + # set the HTTP header `Accept` + _header_params = { + "Accept": "application/json", + "Content-Type": "application/json" + } + + return self.api_client.param_serialize( + method='POST', + resource_path='/payments/topup/address', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + ) + @validate_call def delete_counterparty( self, @@ -5701,9 +6043,178 @@ def _get_available_allocation_amount_serialize( ) @validate_call - def get_batch_allocation_by_id( + def get_batch_allocation_by_id( + self, + batch_allocation_id: Annotated[StrictStr, Field(description="The batch allocation ID.")], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + ) -> BatchAllocationDetail: + """Get batch allocation information + + This operation retrieves the information of a batch allocation. + + :param batch_allocation_id: The batch allocation ID. (required) + :type batch_allocation_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_batch_allocation_by_id_serialize( + batch_allocation_id=batch_allocation_id, + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "BatchAllocationDetail", + '4XX': "ErrorResponse", + '5XX': "ErrorResponse", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + @validate_call + def get_batch_allocation_by_id_with_http_info( + self, + batch_allocation_id: Annotated[StrictStr, Field(description="The batch allocation ID.")], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + ) -> ApiResponse[BatchAllocationDetail]: + """Get batch allocation information + + This operation retrieves the information of a batch allocation. + + :param batch_allocation_id: The batch allocation ID. (required) + :type batch_allocation_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_batch_allocation_by_id_serialize( + batch_allocation_id=batch_allocation_id, + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "BatchAllocationDetail", + '4XX': "ErrorResponse", + '5XX': "ErrorResponse", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + @validate_call + def get_batch_allocation_by_id_without_preload_content( + self, + batch_allocation_id: Annotated[StrictStr, Field(description="The batch allocation ID.")], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + ) -> RESTResponseType: + """Get batch allocation information + + This operation retrieves the information of a batch allocation. + + :param batch_allocation_id: The batch allocation ID. (required) + :type batch_allocation_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._get_batch_allocation_by_id_serialize( + batch_allocation_id=batch_allocation_id, + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "BatchAllocationDetail", + '4XX': "ErrorResponse", + '5XX': "ErrorResponse", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + def _get_batch_allocation_by_id_serialize( + self, + batch_allocation_id, + ) -> RequestSerialized: + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, Union[str, bytes]] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if batch_allocation_id is not None: + _path_params['batch_allocation_id'] = batch_allocation_id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + + # set the HTTP header `Accept` + _header_params = { + "Accept": "application/json", + "Content-Type": "application/json" + } + + return self.api_client.param_serialize( + method='GET', + resource_path='/payments/batch_allocations/{batch_allocation_id}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + ) + + @validate_call + def get_bulk_send_by_id( self, - batch_allocation_id: Annotated[StrictStr, Field(description="The batch allocation ID.")], + bulk_send_id: Annotated[StrictStr, Field(description="The bulk send ID.")], _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -5712,13 +6223,13 @@ def get_batch_allocation_by_id( Annotated[StrictFloat, Field(gt=0)] ] ] = None, - ) -> BatchAllocationDetail: - """Get batch allocation information + ) -> PaymentBulkSend: + """Get bulk send information - This operation retrieves the information of a batch allocation. + This operation retrieves the information of a specific bulk send. - :param batch_allocation_id: The batch allocation ID. (required) - :type batch_allocation_id: str + :param bulk_send_id: The bulk send ID. (required) + :type bulk_send_id: str :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of @@ -5727,12 +6238,12 @@ def get_batch_allocation_by_id( :return: Returns the result object. """ # noqa: E501 - _param = self._get_batch_allocation_by_id_serialize( - batch_allocation_id=batch_allocation_id, + _param = self._get_bulk_send_by_id_serialize( + bulk_send_id=bulk_send_id, ) _response_types_map: Dict[str, Optional[str]] = { - '200': "BatchAllocationDetail", + '200': "PaymentBulkSend", '4XX': "ErrorResponse", '5XX': "ErrorResponse", } @@ -5747,9 +6258,9 @@ def get_batch_allocation_by_id( ).data @validate_call - def get_batch_allocation_by_id_with_http_info( + def get_bulk_send_by_id_with_http_info( self, - batch_allocation_id: Annotated[StrictStr, Field(description="The batch allocation ID.")], + bulk_send_id: Annotated[StrictStr, Field(description="The bulk send ID.")], _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -5758,13 +6269,13 @@ def get_batch_allocation_by_id_with_http_info( Annotated[StrictFloat, Field(gt=0)] ] ] = None, - ) -> ApiResponse[BatchAllocationDetail]: - """Get batch allocation information + ) -> ApiResponse[PaymentBulkSend]: + """Get bulk send information - This operation retrieves the information of a batch allocation. + This operation retrieves the information of a specific bulk send. - :param batch_allocation_id: The batch allocation ID. (required) - :type batch_allocation_id: str + :param bulk_send_id: The bulk send ID. (required) + :type bulk_send_id: str :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of @@ -5773,12 +6284,12 @@ def get_batch_allocation_by_id_with_http_info( :return: Returns the result object. """ # noqa: E501 - _param = self._get_batch_allocation_by_id_serialize( - batch_allocation_id=batch_allocation_id, + _param = self._get_bulk_send_by_id_serialize( + bulk_send_id=bulk_send_id, ) _response_types_map: Dict[str, Optional[str]] = { - '200': "BatchAllocationDetail", + '200': "PaymentBulkSend", '4XX': "ErrorResponse", '5XX': "ErrorResponse", } @@ -5793,9 +6304,9 @@ def get_batch_allocation_by_id_with_http_info( ) @validate_call - def get_batch_allocation_by_id_without_preload_content( + def get_bulk_send_by_id_without_preload_content( self, - batch_allocation_id: Annotated[StrictStr, Field(description="The batch allocation ID.")], + bulk_send_id: Annotated[StrictStr, Field(description="The bulk send ID.")], _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -5805,12 +6316,12 @@ def get_batch_allocation_by_id_without_preload_content( ] ] = None, ) -> RESTResponseType: - """Get batch allocation information + """Get bulk send information - This operation retrieves the information of a batch allocation. + This operation retrieves the information of a specific bulk send. - :param batch_allocation_id: The batch allocation ID. (required) - :type batch_allocation_id: str + :param bulk_send_id: The bulk send ID. (required) + :type bulk_send_id: str :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of @@ -5819,12 +6330,12 @@ def get_batch_allocation_by_id_without_preload_content( :return: Returns the result object. """ # noqa: E501 - _param = self._get_batch_allocation_by_id_serialize( - batch_allocation_id=batch_allocation_id, + _param = self._get_bulk_send_by_id_serialize( + bulk_send_id=bulk_send_id, ) _response_types_map: Dict[str, Optional[str]] = { - '200': "BatchAllocationDetail", + '200': "PaymentBulkSend", '4XX': "ErrorResponse", '5XX': "ErrorResponse", } @@ -5834,9 +6345,9 @@ def get_batch_allocation_by_id_without_preload_content( ) return response_data.response - def _get_batch_allocation_by_id_serialize( + def _get_bulk_send_by_id_serialize( self, - batch_allocation_id, + bulk_send_id, ) -> RequestSerialized: _path_params: Dict[str, str] = {} _query_params: List[Tuple[str, str]] = [] @@ -5845,8 +6356,8 @@ def _get_batch_allocation_by_id_serialize( _body_params: Optional[bytes] = None # process the path parameters - if batch_allocation_id is not None: - _path_params['batch_allocation_id'] = batch_allocation_id + if bulk_send_id is not None: + _path_params['bulk_send_id'] = bulk_send_id # process the query parameters # process the header parameters # process the form parameters @@ -5860,7 +6371,7 @@ def _get_batch_allocation_by_id_serialize( return self.api_client.param_serialize( method='GET', - resource_path='/payments/batch_allocations/{batch_allocation_id}', + resource_path='/payments/bulk_sends/{bulk_send_id}', path_params=_path_params, query_params=_query_params, header_params=_header_params, @@ -8464,7 +8975,7 @@ def get_settlement_by_id( ) -> Settlement: """Get settlement request information - This operation retrieves the information of a specific settlement request. + This operation has been deprecated. Please use [Get payout information](https://www.cobo.com/payments/en/api-references/payment/get-payout-information) instead. This operation retrieves the information of a specific settlement request. :param settlement_request_id: The settlement request ID. (required) :type settlement_request_id: str @@ -8510,7 +9021,7 @@ def get_settlement_by_id_with_http_info( ) -> ApiResponse[Settlement]: """Get settlement request information - This operation retrieves the information of a specific settlement request. + This operation has been deprecated. Please use [Get payout information](https://www.cobo.com/payments/en/api-references/payment/get-payout-information) instead. This operation retrieves the information of a specific settlement request. :param settlement_request_id: The settlement request ID. (required) :type settlement_request_id: str @@ -8556,7 +9067,7 @@ def get_settlement_by_id_without_preload_content( ) -> RESTResponseType: """Get settlement request information - This operation retrieves the information of a specific settlement request. + This operation has been deprecated. Please use [Get payout information](https://www.cobo.com/payments/en/api-references/payment/get-payout-information) instead. This operation retrieves the information of a specific settlement request. :param settlement_request_id: The settlement request ID. (required) :type settlement_request_id: str @@ -8623,7 +9134,7 @@ def get_settlement_info_by_ids( self, merchant_ids: Annotated[Optional[StrictStr], Field(description="A list of merchant IDs to query.")] = None, currency: Annotated[Optional[StrictStr], Field(description="The currency for the operation. Currently, only `USD` is supported.")] = None, - acquiring_type: Optional[AcquiringType] = None, + acquiring_type: Annotated[Optional[AcquiringType], Field(description="This parameter has been deprecated")] = None, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -8641,7 +9152,7 @@ def get_settlement_info_by_ids( :type merchant_ids: str :param currency: The currency for the operation. Currently, only `USD` is supported. :type currency: str - :param acquiring_type: + :param acquiring_type: This parameter has been deprecated :type acquiring_type: AcquiringType :param _request_timeout: timeout setting for this request. If one number provided, it will be total request @@ -8677,7 +9188,7 @@ def get_settlement_info_by_ids_with_http_info( self, merchant_ids: Annotated[Optional[StrictStr], Field(description="A list of merchant IDs to query.")] = None, currency: Annotated[Optional[StrictStr], Field(description="The currency for the operation. Currently, only `USD` is supported.")] = None, - acquiring_type: Optional[AcquiringType] = None, + acquiring_type: Annotated[Optional[AcquiringType], Field(description="This parameter has been deprecated")] = None, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -8695,7 +9206,7 @@ def get_settlement_info_by_ids_with_http_info( :type merchant_ids: str :param currency: The currency for the operation. Currently, only `USD` is supported. :type currency: str - :param acquiring_type: + :param acquiring_type: This parameter has been deprecated :type acquiring_type: AcquiringType :param _request_timeout: timeout setting for this request. If one number provided, it will be total request @@ -8731,7 +9242,7 @@ def get_settlement_info_by_ids_without_preload_content( self, merchant_ids: Annotated[Optional[StrictStr], Field(description="A list of merchant IDs to query.")] = None, currency: Annotated[Optional[StrictStr], Field(description="The currency for the operation. Currently, only `USD` is supported.")] = None, - acquiring_type: Optional[AcquiringType] = None, + acquiring_type: Annotated[Optional[AcquiringType], Field(description="This parameter has been deprecated")] = None, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -8749,7 +9260,7 @@ def get_settlement_info_by_ids_without_preload_content( :type merchant_ids: str :param currency: The currency for the operation. Currently, only `USD` is supported. :type currency: str - :param acquiring_type: + :param acquiring_type: This parameter has been deprecated :type acquiring_type: AcquiringType :param _request_timeout: timeout setting for this request. If one number provided, it will be total request @@ -9029,7 +9540,7 @@ def _get_top_up_address_serialize( ) @validate_call - def list_allocations( + def list_allocation_items( self, limit: Annotated[Optional[StrictInt], Field(description="The maximum number of objects to return. For most operations, the value range is [1, 50].")] = None, before: Annotated[Optional[StrictStr], Field(description="A cursor indicating the position before the current page. This value is generated by Cobo and returned in the response. If you are paginating forward from the beginning, you do not need to provide it on the first request. When paginating backward (to the previous page), you should pass the before value returned from the last response. ")] = None, @@ -9046,10 +9557,10 @@ def list_allocations( Annotated[StrictFloat, Field(gt=0)] ] ] = None, - ) -> ListAllocations200Response: - """List all allocation records + ) -> ListAllocationItems200Response: + """List all allocation items - This operation retrieves the information of all allocation records. One allocation record corresponds to one allocation request in a batch allocation. + This operation retrieves the information of all allocations. :param limit: The maximum number of objects to return. For most operations, the value range is [1, 50]. :type limit: int @@ -9073,7 +9584,7 @@ def list_allocations( :return: Returns the result object. """ # noqa: E501 - _param = self._list_allocations_serialize( + _param = self._list_allocation_items_serialize( limit=limit, before=before, after=after, @@ -9084,7 +9595,7 @@ def list_allocations( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "ListAllocations200Response", + '200': "ListAllocationItems200Response", '4XX': "ErrorResponse", '5XX': "ErrorResponse", } @@ -9099,7 +9610,7 @@ def list_allocations( ).data @validate_call - def list_allocations_with_http_info( + def list_allocation_items_with_http_info( self, limit: Annotated[Optional[StrictInt], Field(description="The maximum number of objects to return. For most operations, the value range is [1, 50].")] = None, before: Annotated[Optional[StrictStr], Field(description="A cursor indicating the position before the current page. This value is generated by Cobo and returned in the response. If you are paginating forward from the beginning, you do not need to provide it on the first request. When paginating backward (to the previous page), you should pass the before value returned from the last response. ")] = None, @@ -9116,10 +9627,10 @@ def list_allocations_with_http_info( Annotated[StrictFloat, Field(gt=0)] ] ] = None, - ) -> ApiResponse[ListAllocations200Response]: - """List all allocation records + ) -> ApiResponse[ListAllocationItems200Response]: + """List all allocation items - This operation retrieves the information of all allocation records. One allocation record corresponds to one allocation request in a batch allocation. + This operation retrieves the information of all allocations. :param limit: The maximum number of objects to return. For most operations, the value range is [1, 50]. :type limit: int @@ -9143,7 +9654,7 @@ def list_allocations_with_http_info( :return: Returns the result object. """ # noqa: E501 - _param = self._list_allocations_serialize( + _param = self._list_allocation_items_serialize( limit=limit, before=before, after=after, @@ -9154,7 +9665,7 @@ def list_allocations_with_http_info( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "ListAllocations200Response", + '200': "ListAllocationItems200Response", '4XX': "ErrorResponse", '5XX': "ErrorResponse", } @@ -9169,7 +9680,7 @@ def list_allocations_with_http_info( ) @validate_call - def list_allocations_without_preload_content( + def list_allocation_items_without_preload_content( self, limit: Annotated[Optional[StrictInt], Field(description="The maximum number of objects to return. For most operations, the value range is [1, 50].")] = None, before: Annotated[Optional[StrictStr], Field(description="A cursor indicating the position before the current page. This value is generated by Cobo and returned in the response. If you are paginating forward from the beginning, you do not need to provide it on the first request. When paginating backward (to the previous page), you should pass the before value returned from the last response. ")] = None, @@ -9187,9 +9698,9 @@ def list_allocations_without_preload_content( ] ] = None, ) -> RESTResponseType: - """List all allocation records + """List all allocation items - This operation retrieves the information of all allocation records. One allocation record corresponds to one allocation request in a batch allocation. + This operation retrieves the information of all allocations. :param limit: The maximum number of objects to return. For most operations, the value range is [1, 50]. :type limit: int @@ -9213,7 +9724,7 @@ def list_allocations_without_preload_content( :return: Returns the result object. """ # noqa: E501 - _param = self._list_allocations_serialize( + _param = self._list_allocation_items_serialize( limit=limit, before=before, after=after, @@ -9224,7 +9735,7 @@ def list_allocations_without_preload_content( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "ListAllocations200Response", + '200': "ListAllocationItems200Response", '4XX': "ErrorResponse", '5XX': "ErrorResponse", } @@ -9234,7 +9745,7 @@ def list_allocations_without_preload_content( ) return response_data.response - def _list_allocations_serialize( + def _list_allocation_items_serialize( self, limit, before, @@ -9292,7 +9803,7 @@ def _list_allocations_serialize( return self.api_client.param_serialize( method='GET', - resource_path='/payments/allocation_records', + resource_path='/payments/allocation_items', path_params=_path_params, query_params=_query_params, header_params=_header_params, @@ -9315,7 +9826,7 @@ def list_bank_accounts( ) -> List[BankAccount]: """List all bank accounts - This operation has been deprecated. This operation retrieves the information of all bank accounts you have registered for payment settlement. Contact our support team at [help@cobo.com](mailto:help@cobo.com) to register a new bank account. + This operation has been deprecated. Please use [List counterparty entries](https://www.cobo.com/payments/en/api-references/payment/list-counterparty-entries) instead. This operation retrieves the information of all bank accounts registered. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request @@ -9357,7 +9868,7 @@ def list_bank_accounts_with_http_info( ) -> ApiResponse[List[BankAccount]]: """List all bank accounts - This operation has been deprecated. This operation retrieves the information of all bank accounts you have registered for payment settlement. Contact our support team at [help@cobo.com](mailto:help@cobo.com) to register a new bank account. + This operation has been deprecated. Please use [List counterparty entries](https://www.cobo.com/payments/en/api-references/payment/list-counterparty-entries) instead. This operation retrieves the information of all bank accounts registered. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request @@ -9399,7 +9910,7 @@ def list_bank_accounts_without_preload_content( ) -> RESTResponseType: """List all bank accounts - This operation has been deprecated. This operation retrieves the information of all bank accounts you have registered for payment settlement. Contact our support team at [help@cobo.com](mailto:help@cobo.com) to register a new bank account. + This operation has been deprecated. Please use [List counterparty entries](https://www.cobo.com/payments/en/api-references/payment/list-counterparty-entries) instead. This operation retrieves the information of all bank accounts registered. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request @@ -9456,12 +9967,234 @@ def _list_bank_accounts_serialize( ) @validate_call - def list_batch_allocations( + def list_batch_allocations( + self, + limit: Annotated[Optional[StrictInt], Field(description="The maximum number of objects to return. For most operations, the value range is [1, 50].")] = None, + before: Annotated[Optional[StrictStr], Field(description="A cursor indicating the position before the current page. This value is generated by Cobo and returned in the response. If you are paginating forward from the beginning, you do not need to provide it on the first request. When paginating backward (to the previous page), you should pass the before value returned from the last response. ")] = None, + after: Annotated[Optional[StrictStr], Field(description="A cursor indicating the position after the current page. This value is generated by Cobo and returned in the response. You do not need to provide it on the first request. When paginating forward (to the next page), you should pass the after value returned from the last response. ")] = None, + request_id: Annotated[Optional[StrictStr], Field(description="The request ID.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + ) -> ListBatchAllocations200Response: + """List all batch allocations + + This operation retrieves the information of all batch allocations. + + :param limit: The maximum number of objects to return. For most operations, the value range is [1, 50]. + :type limit: int + :param before: A cursor indicating the position before the current page. This value is generated by Cobo and returned in the response. If you are paginating forward from the beginning, you do not need to provide it on the first request. When paginating backward (to the previous page), you should pass the before value returned from the last response. + :type before: str + :param after: A cursor indicating the position after the current page. This value is generated by Cobo and returned in the response. You do not need to provide it on the first request. When paginating forward (to the next page), you should pass the after value returned from the last response. + :type after: str + :param request_id: The request ID. + :type request_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._list_batch_allocations_serialize( + limit=limit, + before=before, + after=after, + request_id=request_id, + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ListBatchAllocations200Response", + '4XX': "ErrorResponse", + '5XX': "ErrorResponse", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + @validate_call + def list_batch_allocations_with_http_info( + self, + limit: Annotated[Optional[StrictInt], Field(description="The maximum number of objects to return. For most operations, the value range is [1, 50].")] = None, + before: Annotated[Optional[StrictStr], Field(description="A cursor indicating the position before the current page. This value is generated by Cobo and returned in the response. If you are paginating forward from the beginning, you do not need to provide it on the first request. When paginating backward (to the previous page), you should pass the before value returned from the last response. ")] = None, + after: Annotated[Optional[StrictStr], Field(description="A cursor indicating the position after the current page. This value is generated by Cobo and returned in the response. You do not need to provide it on the first request. When paginating forward (to the next page), you should pass the after value returned from the last response. ")] = None, + request_id: Annotated[Optional[StrictStr], Field(description="The request ID.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + ) -> ApiResponse[ListBatchAllocations200Response]: + """List all batch allocations + + This operation retrieves the information of all batch allocations. + + :param limit: The maximum number of objects to return. For most operations, the value range is [1, 50]. + :type limit: int + :param before: A cursor indicating the position before the current page. This value is generated by Cobo and returned in the response. If you are paginating forward from the beginning, you do not need to provide it on the first request. When paginating backward (to the previous page), you should pass the before value returned from the last response. + :type before: str + :param after: A cursor indicating the position after the current page. This value is generated by Cobo and returned in the response. You do not need to provide it on the first request. When paginating forward (to the next page), you should pass the after value returned from the last response. + :type after: str + :param request_id: The request ID. + :type request_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._list_batch_allocations_serialize( + limit=limit, + before=before, + after=after, + request_id=request_id, + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ListBatchAllocations200Response", + '4XX': "ErrorResponse", + '5XX': "ErrorResponse", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ) + + @validate_call + def list_batch_allocations_without_preload_content( + self, + limit: Annotated[Optional[StrictInt], Field(description="The maximum number of objects to return. For most operations, the value range is [1, 50].")] = None, + before: Annotated[Optional[StrictStr], Field(description="A cursor indicating the position before the current page. This value is generated by Cobo and returned in the response. If you are paginating forward from the beginning, you do not need to provide it on the first request. When paginating backward (to the previous page), you should pass the before value returned from the last response. ")] = None, + after: Annotated[Optional[StrictStr], Field(description="A cursor indicating the position after the current page. This value is generated by Cobo and returned in the response. You do not need to provide it on the first request. When paginating forward (to the next page), you should pass the after value returned from the last response. ")] = None, + request_id: Annotated[Optional[StrictStr], Field(description="The request ID.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + ) -> RESTResponseType: + """List all batch allocations + + This operation retrieves the information of all batch allocations. + + :param limit: The maximum number of objects to return. For most operations, the value range is [1, 50]. + :type limit: int + :param before: A cursor indicating the position before the current page. This value is generated by Cobo and returned in the response. If you are paginating forward from the beginning, you do not need to provide it on the first request. When paginating backward (to the previous page), you should pass the before value returned from the last response. + :type before: str + :param after: A cursor indicating the position after the current page. This value is generated by Cobo and returned in the response. You do not need to provide it on the first request. When paginating forward (to the next page), you should pass the after value returned from the last response. + :type after: str + :param request_id: The request ID. + :type request_id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._list_batch_allocations_serialize( + limit=limit, + before=before, + after=after, + request_id=request_id, + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ListBatchAllocations200Response", + '4XX': "ErrorResponse", + '5XX': "ErrorResponse", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + def _list_batch_allocations_serialize( + self, + limit, + before, + after, + request_id, + ) -> RequestSerialized: + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, Union[str, bytes]] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + if limit is not None: + + _query_params.append(('limit', limit)) + + if before is not None: + + _query_params.append(('before', before)) + + if after is not None: + + _query_params.append(('after', after)) + + if request_id is not None: + + _query_params.append(('request_id', request_id)) + + # process the header parameters + # process the form parameters + # process the body parameter + + # set the HTTP header `Accept` + _header_params = { + "Accept": "application/json", + "Content-Type": "application/json" + } + + return self.api_client.param_serialize( + method='GET', + resource_path='/payments/batch_allocations', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + ) + + @validate_call + def list_bulk_send_items( self, + bulk_send_id: Annotated[StrictStr, Field(description="The bulk send ID.")], limit: Annotated[Optional[StrictInt], Field(description="The maximum number of objects to return. For most operations, the value range is [1, 50].")] = None, before: Annotated[Optional[StrictStr], Field(description="A cursor indicating the position before the current page. This value is generated by Cobo and returned in the response. If you are paginating forward from the beginning, you do not need to provide it on the first request. When paginating backward (to the previous page), you should pass the before value returned from the last response. ")] = None, after: Annotated[Optional[StrictStr], Field(description="A cursor indicating the position after the current page. This value is generated by Cobo and returned in the response. You do not need to provide it on the first request. When paginating forward (to the next page), you should pass the after value returned from the last response. ")] = None, - request_id: Annotated[Optional[StrictStr], Field(description="The request ID.")] = None, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -9470,19 +10203,19 @@ def list_batch_allocations( Annotated[StrictFloat, Field(gt=0)] ] ] = None, - ) -> ListBatchAllocations200Response: - """List all batch allocations + ) -> ListBulkSendItems200Response: + """List bulk send items - This operation retrieves the information of all batch allocations. + This operation retrieves the list of items for a specific bulk send. + :param bulk_send_id: The bulk send ID. (required) + :type bulk_send_id: str :param limit: The maximum number of objects to return. For most operations, the value range is [1, 50]. :type limit: int :param before: A cursor indicating the position before the current page. This value is generated by Cobo and returned in the response. If you are paginating forward from the beginning, you do not need to provide it on the first request. When paginating backward (to the previous page), you should pass the before value returned from the last response. :type before: str :param after: A cursor indicating the position after the current page. This value is generated by Cobo and returned in the response. You do not need to provide it on the first request. When paginating forward (to the next page), you should pass the after value returned from the last response. :type after: str - :param request_id: The request ID. - :type request_id: str :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of @@ -9491,15 +10224,15 @@ def list_batch_allocations( :return: Returns the result object. """ # noqa: E501 - _param = self._list_batch_allocations_serialize( + _param = self._list_bulk_send_items_serialize( + bulk_send_id=bulk_send_id, limit=limit, before=before, after=after, - request_id=request_id, ) _response_types_map: Dict[str, Optional[str]] = { - '200': "ListBatchAllocations200Response", + '200': "ListBulkSendItems200Response", '4XX': "ErrorResponse", '5XX': "ErrorResponse", } @@ -9514,12 +10247,12 @@ def list_batch_allocations( ).data @validate_call - def list_batch_allocations_with_http_info( + def list_bulk_send_items_with_http_info( self, + bulk_send_id: Annotated[StrictStr, Field(description="The bulk send ID.")], limit: Annotated[Optional[StrictInt], Field(description="The maximum number of objects to return. For most operations, the value range is [1, 50].")] = None, before: Annotated[Optional[StrictStr], Field(description="A cursor indicating the position before the current page. This value is generated by Cobo and returned in the response. If you are paginating forward from the beginning, you do not need to provide it on the first request. When paginating backward (to the previous page), you should pass the before value returned from the last response. ")] = None, after: Annotated[Optional[StrictStr], Field(description="A cursor indicating the position after the current page. This value is generated by Cobo and returned in the response. You do not need to provide it on the first request. When paginating forward (to the next page), you should pass the after value returned from the last response. ")] = None, - request_id: Annotated[Optional[StrictStr], Field(description="The request ID.")] = None, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -9528,19 +10261,19 @@ def list_batch_allocations_with_http_info( Annotated[StrictFloat, Field(gt=0)] ] ] = None, - ) -> ApiResponse[ListBatchAllocations200Response]: - """List all batch allocations + ) -> ApiResponse[ListBulkSendItems200Response]: + """List bulk send items - This operation retrieves the information of all batch allocations. + This operation retrieves the list of items for a specific bulk send. + :param bulk_send_id: The bulk send ID. (required) + :type bulk_send_id: str :param limit: The maximum number of objects to return. For most operations, the value range is [1, 50]. :type limit: int :param before: A cursor indicating the position before the current page. This value is generated by Cobo and returned in the response. If you are paginating forward from the beginning, you do not need to provide it on the first request. When paginating backward (to the previous page), you should pass the before value returned from the last response. :type before: str :param after: A cursor indicating the position after the current page. This value is generated by Cobo and returned in the response. You do not need to provide it on the first request. When paginating forward (to the next page), you should pass the after value returned from the last response. :type after: str - :param request_id: The request ID. - :type request_id: str :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of @@ -9549,15 +10282,15 @@ def list_batch_allocations_with_http_info( :return: Returns the result object. """ # noqa: E501 - _param = self._list_batch_allocations_serialize( + _param = self._list_bulk_send_items_serialize( + bulk_send_id=bulk_send_id, limit=limit, before=before, after=after, - request_id=request_id, ) _response_types_map: Dict[str, Optional[str]] = { - '200': "ListBatchAllocations200Response", + '200': "ListBulkSendItems200Response", '4XX': "ErrorResponse", '5XX': "ErrorResponse", } @@ -9572,12 +10305,12 @@ def list_batch_allocations_with_http_info( ) @validate_call - def list_batch_allocations_without_preload_content( + def list_bulk_send_items_without_preload_content( self, + bulk_send_id: Annotated[StrictStr, Field(description="The bulk send ID.")], limit: Annotated[Optional[StrictInt], Field(description="The maximum number of objects to return. For most operations, the value range is [1, 50].")] = None, before: Annotated[Optional[StrictStr], Field(description="A cursor indicating the position before the current page. This value is generated by Cobo and returned in the response. If you are paginating forward from the beginning, you do not need to provide it on the first request. When paginating backward (to the previous page), you should pass the before value returned from the last response. ")] = None, after: Annotated[Optional[StrictStr], Field(description="A cursor indicating the position after the current page. This value is generated by Cobo and returned in the response. You do not need to provide it on the first request. When paginating forward (to the next page), you should pass the after value returned from the last response. ")] = None, - request_id: Annotated[Optional[StrictStr], Field(description="The request ID.")] = None, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -9587,18 +10320,18 @@ def list_batch_allocations_without_preload_content( ] ] = None, ) -> RESTResponseType: - """List all batch allocations + """List bulk send items - This operation retrieves the information of all batch allocations. + This operation retrieves the list of items for a specific bulk send. + :param bulk_send_id: The bulk send ID. (required) + :type bulk_send_id: str :param limit: The maximum number of objects to return. For most operations, the value range is [1, 50]. :type limit: int :param before: A cursor indicating the position before the current page. This value is generated by Cobo and returned in the response. If you are paginating forward from the beginning, you do not need to provide it on the first request. When paginating backward (to the previous page), you should pass the before value returned from the last response. :type before: str :param after: A cursor indicating the position after the current page. This value is generated by Cobo and returned in the response. You do not need to provide it on the first request. When paginating forward (to the next page), you should pass the after value returned from the last response. :type after: str - :param request_id: The request ID. - :type request_id: str :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of @@ -9607,15 +10340,15 @@ def list_batch_allocations_without_preload_content( :return: Returns the result object. """ # noqa: E501 - _param = self._list_batch_allocations_serialize( + _param = self._list_bulk_send_items_serialize( + bulk_send_id=bulk_send_id, limit=limit, before=before, after=after, - request_id=request_id, ) _response_types_map: Dict[str, Optional[str]] = { - '200': "ListBatchAllocations200Response", + '200': "ListBulkSendItems200Response", '4XX': "ErrorResponse", '5XX': "ErrorResponse", } @@ -9625,12 +10358,12 @@ def list_batch_allocations_without_preload_content( ) return response_data.response - def _list_batch_allocations_serialize( + def _list_bulk_send_items_serialize( self, + bulk_send_id, limit, before, after, - request_id, ) -> RequestSerialized: _path_params: Dict[str, str] = {} _query_params: List[Tuple[str, str]] = [] @@ -9639,6 +10372,8 @@ def _list_batch_allocations_serialize( _body_params: Optional[bytes] = None # process the path parameters + if bulk_send_id is not None: + _path_params['bulk_send_id'] = bulk_send_id # process the query parameters if limit is not None: @@ -9652,10 +10387,6 @@ def _list_batch_allocations_serialize( _query_params.append(('after', after)) - if request_id is not None: - - _query_params.append(('request_id', request_id)) - # process the header parameters # process the form parameters # process the body parameter @@ -9668,7 +10399,7 @@ def _list_batch_allocations_serialize( return self.api_client.param_serialize( method='GET', - resource_path='/payments/batch_allocations', + resource_path='/payments/bulk_sends/{bulk_send_id}/items', path_params=_path_params, query_params=_query_params, header_params=_header_params, @@ -11952,7 +12683,7 @@ def list_merchant_balances( self, token_id: Annotated[StrictStr, Field(description="The token ID, which is a unique identifier that specifies both the blockchain network and cryptocurrency token in the format `{CHAIN}_{TOKEN}`. Supported values include: - USDC: `ETH_USDC`, `ARBITRUM_USDCOIN`, `SOL_USDC`, `BASE_USDC`, `MATIC_USDC2`, `BSC_USDC` - USDT: `TRON_USDT`, `ETH_USDT`, `ARBITRUM_USDT`, `SOL_USDT`, `BASE_USDT`, `MATIC_USDT`, `BSC_USDT` ")], merchant_ids: Annotated[Optional[StrictStr], Field(description="A list of merchant IDs to query.")] = None, - acquiring_type: Optional[AcquiringType] = None, + acquiring_type: Annotated[Optional[AcquiringType], Field(description="This parameter has been deprecated")] = None, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -11970,7 +12701,7 @@ def list_merchant_balances( :type token_id: str :param merchant_ids: A list of merchant IDs to query. :type merchant_ids: str - :param acquiring_type: + :param acquiring_type: This parameter has been deprecated :type acquiring_type: AcquiringType :param _request_timeout: timeout setting for this request. If one number provided, it will be total request @@ -12006,7 +12737,7 @@ def list_merchant_balances_with_http_info( self, token_id: Annotated[StrictStr, Field(description="The token ID, which is a unique identifier that specifies both the blockchain network and cryptocurrency token in the format `{CHAIN}_{TOKEN}`. Supported values include: - USDC: `ETH_USDC`, `ARBITRUM_USDCOIN`, `SOL_USDC`, `BASE_USDC`, `MATIC_USDC2`, `BSC_USDC` - USDT: `TRON_USDT`, `ETH_USDT`, `ARBITRUM_USDT`, `SOL_USDT`, `BASE_USDT`, `MATIC_USDT`, `BSC_USDT` ")], merchant_ids: Annotated[Optional[StrictStr], Field(description="A list of merchant IDs to query.")] = None, - acquiring_type: Optional[AcquiringType] = None, + acquiring_type: Annotated[Optional[AcquiringType], Field(description="This parameter has been deprecated")] = None, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -12024,7 +12755,7 @@ def list_merchant_balances_with_http_info( :type token_id: str :param merchant_ids: A list of merchant IDs to query. :type merchant_ids: str - :param acquiring_type: + :param acquiring_type: This parameter has been deprecated :type acquiring_type: AcquiringType :param _request_timeout: timeout setting for this request. If one number provided, it will be total request @@ -12060,7 +12791,7 @@ def list_merchant_balances_without_preload_content( self, token_id: Annotated[StrictStr, Field(description="The token ID, which is a unique identifier that specifies both the blockchain network and cryptocurrency token in the format `{CHAIN}_{TOKEN}`. Supported values include: - USDC: `ETH_USDC`, `ARBITRUM_USDCOIN`, `SOL_USDC`, `BASE_USDC`, `MATIC_USDC2`, `BSC_USDC` - USDT: `TRON_USDT`, `ETH_USDT`, `ARBITRUM_USDT`, `SOL_USDT`, `BASE_USDT`, `MATIC_USDT`, `BSC_USDT` ")], merchant_ids: Annotated[Optional[StrictStr], Field(description="A list of merchant IDs to query.")] = None, - acquiring_type: Optional[AcquiringType] = None, + acquiring_type: Annotated[Optional[AcquiringType], Field(description="This parameter has been deprecated")] = None, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -12078,7 +12809,7 @@ def list_merchant_balances_without_preload_content( :type token_id: str :param merchant_ids: A list of merchant IDs to query. :type merchant_ids: str - :param acquiring_type: + :param acquiring_type: This parameter has been deprecated :type acquiring_type: AcquiringType :param _request_timeout: timeout setting for this request. If one number provided, it will be total request @@ -13006,245 +13737,6 @@ def _list_payment_wallet_balances_serialize( files=_files, ) - @validate_call - def list_payout_items( - self, - limit: Annotated[Optional[StrictInt], Field(description="The maximum number of objects to return. For most operations, the value range is [1, 50].")] = None, - before: Annotated[Optional[StrictStr], Field(description="A cursor indicating the position before the current page. This value is generated by Cobo and returned in the response. If you are paginating forward from the beginning, you do not need to provide it on the first request. When paginating backward (to the previous page), you should pass the before value returned from the last response. ")] = None, - after: Annotated[Optional[StrictStr], Field(description="A cursor indicating the position after the current page. This value is generated by Cobo and returned in the response. You do not need to provide it on the first request. When paginating forward (to the next page), you should pass the after value returned from the last response. ")] = None, - source_account: Annotated[Optional[StrictStr], Field(description="The source account. - If the source account is a merchant account, provide the merchant's ID (e.g., \"M1001\"). - If the source account is the developer account, use the string `\"developer\"`. ")] = None, - statuses: Annotated[Optional[StrictStr], Field(description="A list of order, refund or payout item statuses. You can refer to the following operations for the possible status values: - [Get pay-in order information](https://www.cobo.com/payments/en/api-references/payment/get-pay-in-order-information) - [Get refund order information](https://www.cobo.com/payments/en/api-references/payment/get-refund-order-information) - [List all payout items](https://www.cobo.com/payments/en/api-references/payment/list-all-payout-items) ")] = None, - _request_timeout: Union[ - None, - Annotated[StrictFloat, Field(gt=0)], - Tuple[ - Annotated[StrictFloat, Field(gt=0)], - Annotated[StrictFloat, Field(gt=0)] - ] - ] = None, - ) -> ListPayoutItems200Response: - """List all payout items - - This operation retrieves the information of all payout items. You can filter the result by source account or status. - - :param limit: The maximum number of objects to return. For most operations, the value range is [1, 50]. - :type limit: int - :param before: A cursor indicating the position before the current page. This value is generated by Cobo and returned in the response. If you are paginating forward from the beginning, you do not need to provide it on the first request. When paginating backward (to the previous page), you should pass the before value returned from the last response. - :type before: str - :param after: A cursor indicating the position after the current page. This value is generated by Cobo and returned in the response. You do not need to provide it on the first request. When paginating forward (to the next page), you should pass the after value returned from the last response. - :type after: str - :param source_account: The source account. - If the source account is a merchant account, provide the merchant's ID (e.g., \"M1001\"). - If the source account is the developer account, use the string `\"developer\"`. - :type source_account: str - :param statuses: A list of order, refund or payout item statuses. You can refer to the following operations for the possible status values: - [Get pay-in order information](https://www.cobo.com/payments/en/api-references/payment/get-pay-in-order-information) - [Get refund order information](https://www.cobo.com/payments/en/api-references/payment/get-refund-order-information) - [List all payout items](https://www.cobo.com/payments/en/api-references/payment/list-all-payout-items) - :type statuses: str - :param _request_timeout: timeout setting for this request. If one - number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. - :type _request_timeout: int, tuple(int, int), optional - :return: Returns the result object. - """ # noqa: E501 - - _param = self._list_payout_items_serialize( - limit=limit, - before=before, - after=after, - source_account=source_account, - statuses=statuses, - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "ListPayoutItems200Response", - '4XX': "ErrorResponse", - '5XX': "ErrorResponse", - } - response_data = self.api_client.call_api( - *_param, - _request_timeout=_request_timeout - ) - response_data.read() - return self.api_client.response_deserialize( - response_data=response_data, - response_types_map=_response_types_map, - ).data - - @validate_call - def list_payout_items_with_http_info( - self, - limit: Annotated[Optional[StrictInt], Field(description="The maximum number of objects to return. For most operations, the value range is [1, 50].")] = None, - before: Annotated[Optional[StrictStr], Field(description="A cursor indicating the position before the current page. This value is generated by Cobo and returned in the response. If you are paginating forward from the beginning, you do not need to provide it on the first request. When paginating backward (to the previous page), you should pass the before value returned from the last response. ")] = None, - after: Annotated[Optional[StrictStr], Field(description="A cursor indicating the position after the current page. This value is generated by Cobo and returned in the response. You do not need to provide it on the first request. When paginating forward (to the next page), you should pass the after value returned from the last response. ")] = None, - source_account: Annotated[Optional[StrictStr], Field(description="The source account. - If the source account is a merchant account, provide the merchant's ID (e.g., \"M1001\"). - If the source account is the developer account, use the string `\"developer\"`. ")] = None, - statuses: Annotated[Optional[StrictStr], Field(description="A list of order, refund or payout item statuses. You can refer to the following operations for the possible status values: - [Get pay-in order information](https://www.cobo.com/payments/en/api-references/payment/get-pay-in-order-information) - [Get refund order information](https://www.cobo.com/payments/en/api-references/payment/get-refund-order-information) - [List all payout items](https://www.cobo.com/payments/en/api-references/payment/list-all-payout-items) ")] = None, - _request_timeout: Union[ - None, - Annotated[StrictFloat, Field(gt=0)], - Tuple[ - Annotated[StrictFloat, Field(gt=0)], - Annotated[StrictFloat, Field(gt=0)] - ] - ] = None, - ) -> ApiResponse[ListPayoutItems200Response]: - """List all payout items - - This operation retrieves the information of all payout items. You can filter the result by source account or status. - - :param limit: The maximum number of objects to return. For most operations, the value range is [1, 50]. - :type limit: int - :param before: A cursor indicating the position before the current page. This value is generated by Cobo and returned in the response. If you are paginating forward from the beginning, you do not need to provide it on the first request. When paginating backward (to the previous page), you should pass the before value returned from the last response. - :type before: str - :param after: A cursor indicating the position after the current page. This value is generated by Cobo and returned in the response. You do not need to provide it on the first request. When paginating forward (to the next page), you should pass the after value returned from the last response. - :type after: str - :param source_account: The source account. - If the source account is a merchant account, provide the merchant's ID (e.g., \"M1001\"). - If the source account is the developer account, use the string `\"developer\"`. - :type source_account: str - :param statuses: A list of order, refund or payout item statuses. You can refer to the following operations for the possible status values: - [Get pay-in order information](https://www.cobo.com/payments/en/api-references/payment/get-pay-in-order-information) - [Get refund order information](https://www.cobo.com/payments/en/api-references/payment/get-refund-order-information) - [List all payout items](https://www.cobo.com/payments/en/api-references/payment/list-all-payout-items) - :type statuses: str - :param _request_timeout: timeout setting for this request. If one - number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. - :type _request_timeout: int, tuple(int, int), optional - :return: Returns the result object. - """ # noqa: E501 - - _param = self._list_payout_items_serialize( - limit=limit, - before=before, - after=after, - source_account=source_account, - statuses=statuses, - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "ListPayoutItems200Response", - '4XX': "ErrorResponse", - '5XX': "ErrorResponse", - } - response_data = self.api_client.call_api( - *_param, - _request_timeout=_request_timeout - ) - response_data.read() - return self.api_client.response_deserialize( - response_data=response_data, - response_types_map=_response_types_map, - ) - - @validate_call - def list_payout_items_without_preload_content( - self, - limit: Annotated[Optional[StrictInt], Field(description="The maximum number of objects to return. For most operations, the value range is [1, 50].")] = None, - before: Annotated[Optional[StrictStr], Field(description="A cursor indicating the position before the current page. This value is generated by Cobo and returned in the response. If you are paginating forward from the beginning, you do not need to provide it on the first request. When paginating backward (to the previous page), you should pass the before value returned from the last response. ")] = None, - after: Annotated[Optional[StrictStr], Field(description="A cursor indicating the position after the current page. This value is generated by Cobo and returned in the response. You do not need to provide it on the first request. When paginating forward (to the next page), you should pass the after value returned from the last response. ")] = None, - source_account: Annotated[Optional[StrictStr], Field(description="The source account. - If the source account is a merchant account, provide the merchant's ID (e.g., \"M1001\"). - If the source account is the developer account, use the string `\"developer\"`. ")] = None, - statuses: Annotated[Optional[StrictStr], Field(description="A list of order, refund or payout item statuses. You can refer to the following operations for the possible status values: - [Get pay-in order information](https://www.cobo.com/payments/en/api-references/payment/get-pay-in-order-information) - [Get refund order information](https://www.cobo.com/payments/en/api-references/payment/get-refund-order-information) - [List all payout items](https://www.cobo.com/payments/en/api-references/payment/list-all-payout-items) ")] = None, - _request_timeout: Union[ - None, - Annotated[StrictFloat, Field(gt=0)], - Tuple[ - Annotated[StrictFloat, Field(gt=0)], - Annotated[StrictFloat, Field(gt=0)] - ] - ] = None, - ) -> RESTResponseType: - """List all payout items - - This operation retrieves the information of all payout items. You can filter the result by source account or status. - - :param limit: The maximum number of objects to return. For most operations, the value range is [1, 50]. - :type limit: int - :param before: A cursor indicating the position before the current page. This value is generated by Cobo and returned in the response. If you are paginating forward from the beginning, you do not need to provide it on the first request. When paginating backward (to the previous page), you should pass the before value returned from the last response. - :type before: str - :param after: A cursor indicating the position after the current page. This value is generated by Cobo and returned in the response. You do not need to provide it on the first request. When paginating forward (to the next page), you should pass the after value returned from the last response. - :type after: str - :param source_account: The source account. - If the source account is a merchant account, provide the merchant's ID (e.g., \"M1001\"). - If the source account is the developer account, use the string `\"developer\"`. - :type source_account: str - :param statuses: A list of order, refund or payout item statuses. You can refer to the following operations for the possible status values: - [Get pay-in order information](https://www.cobo.com/payments/en/api-references/payment/get-pay-in-order-information) - [Get refund order information](https://www.cobo.com/payments/en/api-references/payment/get-refund-order-information) - [List all payout items](https://www.cobo.com/payments/en/api-references/payment/list-all-payout-items) - :type statuses: str - :param _request_timeout: timeout setting for this request. If one - number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. - :type _request_timeout: int, tuple(int, int), optional - :return: Returns the result object. - """ # noqa: E501 - - _param = self._list_payout_items_serialize( - limit=limit, - before=before, - after=after, - source_account=source_account, - statuses=statuses, - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "ListPayoutItems200Response", - '4XX': "ErrorResponse", - '5XX': "ErrorResponse", - } - response_data = self.api_client.call_api( - *_param, - _request_timeout=_request_timeout - ) - return response_data.response - - def _list_payout_items_serialize( - self, - limit, - before, - after, - source_account, - statuses, - ) -> RequestSerialized: - _path_params: Dict[str, str] = {} - _query_params: List[Tuple[str, str]] = [] - _form_params: List[Tuple[str, str]] = [] - _files: Dict[str, Union[str, bytes]] = {} - _body_params: Optional[bytes] = None - - # process the path parameters - # process the query parameters - if limit is not None: - - _query_params.append(('limit', limit)) - - if before is not None: - - _query_params.append(('before', before)) - - if after is not None: - - _query_params.append(('after', after)) - - if source_account is not None: - - _query_params.append(('source_account', source_account)) - - if statuses is not None: - - _query_params.append(('statuses', statuses)) - - # process the header parameters - # process the form parameters - # process the body parameter - - # set the HTTP header `Accept` - _header_params = { - "Accept": "application/json", - "Content-Type": "application/json" - } - - return self.api_client.param_serialize( - method='GET', - resource_path='/payments/payout_items', - path_params=_path_params, - query_params=_query_params, - header_params=_header_params, - body=_body_params, - post_params=_form_params, - files=_files, - ) - @validate_call def list_payouts( self, @@ -13486,7 +13978,7 @@ def list_settlement_details( ) -> ListSettlementDetails200Response: """List all settlement details - This operation retrieves the information of all settlement details. You can filter the result by merchant ID or status. + This operation has been deprecated. This operation retrieves the information of all settlement details. You can filter the result by merchant ID or status. :param limit: The maximum number of objects to return. For most operations, the value range is [1, 50]. :type limit: int @@ -13548,7 +14040,7 @@ def list_settlement_details_with_http_info( ) -> ApiResponse[ListSettlementDetails200Response]: """List all settlement details - This operation retrieves the information of all settlement details. You can filter the result by merchant ID or status. + This operation has been deprecated. This operation retrieves the information of all settlement details. You can filter the result by merchant ID or status. :param limit: The maximum number of objects to return. For most operations, the value range is [1, 50]. :type limit: int @@ -13610,7 +14102,7 @@ def list_settlement_details_without_preload_content( ) -> RESTResponseType: """List all settlement details - This operation retrieves the information of all settlement details. You can filter the result by merchant ID or status. + This operation has been deprecated. This operation retrieves the information of all settlement details. You can filter the result by merchant ID or status. :param limit: The maximum number of objects to return. For most operations, the value range is [1, 50]. :type limit: int @@ -13724,7 +14216,7 @@ def list_settlement_requests( ) -> ListSettlementRequests200Response: """List all settlement requests - This operation retrieves the information of all settlement requests. + This operation has been deprecated. Please use [List all payouts](https://www.cobo.com/payments/en/api-references/payment/list-all-payouts) instead. This operation retrieves the information of all settlement requests. :param limit: The maximum number of objects to return. For most operations, the value range is [1, 50]. :type limit: int @@ -13782,7 +14274,7 @@ def list_settlement_requests_with_http_info( ) -> ApiResponse[ListSettlementRequests200Response]: """List all settlement requests - This operation retrieves the information of all settlement requests. + This operation has been deprecated. Please use [List all payouts](https://www.cobo.com/payments/en/api-references/payment/list-all-payouts) instead. This operation retrieves the information of all settlement requests. :param limit: The maximum number of objects to return. For most operations, the value range is [1, 50]. :type limit: int @@ -13840,7 +14332,7 @@ def list_settlement_requests_without_preload_content( ) -> RESTResponseType: """List all settlement requests - This operation retrieves the information of all settlement requests. + This operation has been deprecated. Please use [List all payouts](https://www.cobo.com/payments/en/api-references/payment/list-all-payouts) instead. This operation retrieves the information of all settlement requests. :param limit: The maximum number of objects to return. For most operations, the value range is [1, 50]. :type limit: int diff --git a/cobo_waas2/api/swaps_api.py b/cobo_waas2/api/swaps_api.py index 57aac7d5..8332a961 100644 --- a/cobo_waas2/api/swaps_api.py +++ b/cobo_waas2/api/swaps_api.py @@ -792,6 +792,7 @@ def _get_swap_quote_serialize( @validate_call def list_swap_activities( self, + request_id: Annotated[Optional[StrictStr], Field(description="The request ID that is used to track a transaction request. The request ID is provided by you and must be unique within your organization.")] = None, type: Optional[SwapType] = None, status: Optional[SwapActivityStatus] = None, min_updated_timestamp: Annotated[Optional[StrictInt], Field(description="The start time of the query. All swap activities updated after the specified time will be retrieved. The time is in Unix timestamp format, measured in milliseconds.")] = None, @@ -815,6 +816,8 @@ def list_swap_activities( This operation retrieves a list of swap activities. You can filter the results by swap type, status, initiator, and time range. + :param request_id: The request ID that is used to track a transaction request. The request ID is provided by you and must be unique within your organization. + :type request_id: str :param type: :type type: SwapType :param status: @@ -844,6 +847,7 @@ def list_swap_activities( """ # noqa: E501 _param = self._list_swap_activities_serialize( + request_id=request_id, type=type, status=status, min_updated_timestamp=min_updated_timestamp, @@ -874,6 +878,7 @@ def list_swap_activities( @validate_call def list_swap_activities_with_http_info( self, + request_id: Annotated[Optional[StrictStr], Field(description="The request ID that is used to track a transaction request. The request ID is provided by you and must be unique within your organization.")] = None, type: Optional[SwapType] = None, status: Optional[SwapActivityStatus] = None, min_updated_timestamp: Annotated[Optional[StrictInt], Field(description="The start time of the query. All swap activities updated after the specified time will be retrieved. The time is in Unix timestamp format, measured in milliseconds.")] = None, @@ -897,6 +902,8 @@ def list_swap_activities_with_http_info( This operation retrieves a list of swap activities. You can filter the results by swap type, status, initiator, and time range. + :param request_id: The request ID that is used to track a transaction request. The request ID is provided by you and must be unique within your organization. + :type request_id: str :param type: :type type: SwapType :param status: @@ -926,6 +933,7 @@ def list_swap_activities_with_http_info( """ # noqa: E501 _param = self._list_swap_activities_serialize( + request_id=request_id, type=type, status=status, min_updated_timestamp=min_updated_timestamp, @@ -956,6 +964,7 @@ def list_swap_activities_with_http_info( @validate_call def list_swap_activities_without_preload_content( self, + request_id: Annotated[Optional[StrictStr], Field(description="The request ID that is used to track a transaction request. The request ID is provided by you and must be unique within your organization.")] = None, type: Optional[SwapType] = None, status: Optional[SwapActivityStatus] = None, min_updated_timestamp: Annotated[Optional[StrictInt], Field(description="The start time of the query. All swap activities updated after the specified time will be retrieved. The time is in Unix timestamp format, measured in milliseconds.")] = None, @@ -979,6 +988,8 @@ def list_swap_activities_without_preload_content( This operation retrieves a list of swap activities. You can filter the results by swap type, status, initiator, and time range. + :param request_id: The request ID that is used to track a transaction request. The request ID is provided by you and must be unique within your organization. + :type request_id: str :param type: :type type: SwapType :param status: @@ -1008,6 +1019,7 @@ def list_swap_activities_without_preload_content( """ # noqa: E501 _param = self._list_swap_activities_serialize( + request_id=request_id, type=type, status=status, min_updated_timestamp=min_updated_timestamp, @@ -1033,6 +1045,7 @@ def list_swap_activities_without_preload_content( def _list_swap_activities_serialize( self, + request_id, type, status, min_updated_timestamp, @@ -1052,6 +1065,10 @@ def _list_swap_activities_serialize( # process the path parameters # process the query parameters + if request_id is not None: + + _query_params.append(('request_id', request_id)) + if type is not None: _query_params.append(('type', type.value)) diff --git a/cobo_waas2/api/wallets_api.py b/cobo_waas2/api/wallets_api.py index 01394b3f..c527f48c 100644 --- a/cobo_waas2/api/wallets_api.py +++ b/cobo_waas2/api/wallets_api.py @@ -3115,7 +3115,7 @@ def list_enabled_chains( self, wallet_type: Annotated[Optional[WalletType], Field(description="The wallet type. - `Custodial`: [Custodial Wallets](https://manuals.cobo.com/en/portal/custodial-wallets/introduction) - `MPC`: [MPC Wallets](https://manuals.cobo.com/en/portal/mpc-wallets/introduction) - `SmartContract`: [Smart Contract Wallets](https://manuals.cobo.com/en/portal/smart-contract-wallets/introduction) - `Exchange`: [Exchange Wallets](https://manuals.cobo.com/en/portal/exchange-wallets/introduction) ")] = None, wallet_subtype: Annotated[Optional[WalletSubtype], Field(description="The wallet subtype. - `Asset`: Custodial Wallets (Asset Wallets) - `Web3`: Custodial Wallets (Web3 Wallets) - `Main`: Exchange Wallets (Main Account) - `Sub`: Exchange Wallets (Sub Account) - `Org-Controlled`: MPC Wallets (Organization-Controlled Wallets) - `User-Controlled`: MPC Wallets (User-Controlled Wallets) - `Safe{Wallet}`: Smart Contract Wallets (Safe{Wallet}) ")] = None, - limit: Annotated[Optional[StrictInt], Field(description="The maximum number of objects to return. For most operations, the value range is [1, 50].")] = None, + limit: Annotated[Optional[StrictInt], Field(description="The maximum number of objects to return. The value range is [1, 500].")] = None, before: Annotated[Optional[StrictStr], Field(description="A cursor indicating the position before the current page. This value is generated by Cobo and returned in the response. If you are paginating forward from the beginning, you do not need to provide it on the first request. When paginating backward (to the previous page), you should pass the before value returned from the last response. ")] = None, after: Annotated[Optional[StrictStr], Field(description="A cursor indicating the position after the current page. This value is generated by Cobo and returned in the response. You do not need to provide it on the first request. When paginating forward (to the next page), you should pass the after value returned from the last response. ")] = None, _request_timeout: Union[ @@ -3135,7 +3135,7 @@ def list_enabled_chains( :type wallet_type: WalletType :param wallet_subtype: The wallet subtype. - `Asset`: Custodial Wallets (Asset Wallets) - `Web3`: Custodial Wallets (Web3 Wallets) - `Main`: Exchange Wallets (Main Account) - `Sub`: Exchange Wallets (Sub Account) - `Org-Controlled`: MPC Wallets (Organization-Controlled Wallets) - `User-Controlled`: MPC Wallets (User-Controlled Wallets) - `Safe{Wallet}`: Smart Contract Wallets (Safe{Wallet}) :type wallet_subtype: WalletSubtype - :param limit: The maximum number of objects to return. For most operations, the value range is [1, 50]. + :param limit: The maximum number of objects to return. The value range is [1, 500]. :type limit: int :param before: A cursor indicating the position before the current page. This value is generated by Cobo and returned in the response. If you are paginating forward from the beginning, you do not need to provide it on the first request. When paginating backward (to the previous page), you should pass the before value returned from the last response. :type before: str @@ -3177,7 +3177,7 @@ def list_enabled_chains_with_http_info( self, wallet_type: Annotated[Optional[WalletType], Field(description="The wallet type. - `Custodial`: [Custodial Wallets](https://manuals.cobo.com/en/portal/custodial-wallets/introduction) - `MPC`: [MPC Wallets](https://manuals.cobo.com/en/portal/mpc-wallets/introduction) - `SmartContract`: [Smart Contract Wallets](https://manuals.cobo.com/en/portal/smart-contract-wallets/introduction) - `Exchange`: [Exchange Wallets](https://manuals.cobo.com/en/portal/exchange-wallets/introduction) ")] = None, wallet_subtype: Annotated[Optional[WalletSubtype], Field(description="The wallet subtype. - `Asset`: Custodial Wallets (Asset Wallets) - `Web3`: Custodial Wallets (Web3 Wallets) - `Main`: Exchange Wallets (Main Account) - `Sub`: Exchange Wallets (Sub Account) - `Org-Controlled`: MPC Wallets (Organization-Controlled Wallets) - `User-Controlled`: MPC Wallets (User-Controlled Wallets) - `Safe{Wallet}`: Smart Contract Wallets (Safe{Wallet}) ")] = None, - limit: Annotated[Optional[StrictInt], Field(description="The maximum number of objects to return. For most operations, the value range is [1, 50].")] = None, + limit: Annotated[Optional[StrictInt], Field(description="The maximum number of objects to return. The value range is [1, 500].")] = None, before: Annotated[Optional[StrictStr], Field(description="A cursor indicating the position before the current page. This value is generated by Cobo and returned in the response. If you are paginating forward from the beginning, you do not need to provide it on the first request. When paginating backward (to the previous page), you should pass the before value returned from the last response. ")] = None, after: Annotated[Optional[StrictStr], Field(description="A cursor indicating the position after the current page. This value is generated by Cobo and returned in the response. You do not need to provide it on the first request. When paginating forward (to the next page), you should pass the after value returned from the last response. ")] = None, _request_timeout: Union[ @@ -3197,7 +3197,7 @@ def list_enabled_chains_with_http_info( :type wallet_type: WalletType :param wallet_subtype: The wallet subtype. - `Asset`: Custodial Wallets (Asset Wallets) - `Web3`: Custodial Wallets (Web3 Wallets) - `Main`: Exchange Wallets (Main Account) - `Sub`: Exchange Wallets (Sub Account) - `Org-Controlled`: MPC Wallets (Organization-Controlled Wallets) - `User-Controlled`: MPC Wallets (User-Controlled Wallets) - `Safe{Wallet}`: Smart Contract Wallets (Safe{Wallet}) :type wallet_subtype: WalletSubtype - :param limit: The maximum number of objects to return. For most operations, the value range is [1, 50]. + :param limit: The maximum number of objects to return. The value range is [1, 500]. :type limit: int :param before: A cursor indicating the position before the current page. This value is generated by Cobo and returned in the response. If you are paginating forward from the beginning, you do not need to provide it on the first request. When paginating backward (to the previous page), you should pass the before value returned from the last response. :type before: str @@ -3239,7 +3239,7 @@ def list_enabled_chains_without_preload_content( self, wallet_type: Annotated[Optional[WalletType], Field(description="The wallet type. - `Custodial`: [Custodial Wallets](https://manuals.cobo.com/en/portal/custodial-wallets/introduction) - `MPC`: [MPC Wallets](https://manuals.cobo.com/en/portal/mpc-wallets/introduction) - `SmartContract`: [Smart Contract Wallets](https://manuals.cobo.com/en/portal/smart-contract-wallets/introduction) - `Exchange`: [Exchange Wallets](https://manuals.cobo.com/en/portal/exchange-wallets/introduction) ")] = None, wallet_subtype: Annotated[Optional[WalletSubtype], Field(description="The wallet subtype. - `Asset`: Custodial Wallets (Asset Wallets) - `Web3`: Custodial Wallets (Web3 Wallets) - `Main`: Exchange Wallets (Main Account) - `Sub`: Exchange Wallets (Sub Account) - `Org-Controlled`: MPC Wallets (Organization-Controlled Wallets) - `User-Controlled`: MPC Wallets (User-Controlled Wallets) - `Safe{Wallet}`: Smart Contract Wallets (Safe{Wallet}) ")] = None, - limit: Annotated[Optional[StrictInt], Field(description="The maximum number of objects to return. For most operations, the value range is [1, 50].")] = None, + limit: Annotated[Optional[StrictInt], Field(description="The maximum number of objects to return. The value range is [1, 500].")] = None, before: Annotated[Optional[StrictStr], Field(description="A cursor indicating the position before the current page. This value is generated by Cobo and returned in the response. If you are paginating forward from the beginning, you do not need to provide it on the first request. When paginating backward (to the previous page), you should pass the before value returned from the last response. ")] = None, after: Annotated[Optional[StrictStr], Field(description="A cursor indicating the position after the current page. This value is generated by Cobo and returned in the response. You do not need to provide it on the first request. When paginating forward (to the next page), you should pass the after value returned from the last response. ")] = None, _request_timeout: Union[ @@ -3259,7 +3259,7 @@ def list_enabled_chains_without_preload_content( :type wallet_type: WalletType :param wallet_subtype: The wallet subtype. - `Asset`: Custodial Wallets (Asset Wallets) - `Web3`: Custodial Wallets (Web3 Wallets) - `Main`: Exchange Wallets (Main Account) - `Sub`: Exchange Wallets (Sub Account) - `Org-Controlled`: MPC Wallets (Organization-Controlled Wallets) - `User-Controlled`: MPC Wallets (User-Controlled Wallets) - `Safe{Wallet}`: Smart Contract Wallets (Safe{Wallet}) :type wallet_subtype: WalletSubtype - :param limit: The maximum number of objects to return. For most operations, the value range is [1, 50]. + :param limit: The maximum number of objects to return. The value range is [1, 500]. :type limit: int :param before: A cursor indicating the position before the current page. This value is generated by Cobo and returned in the response. If you are paginating forward from the beginning, you do not need to provide it on the first request. When paginating backward (to the previous page), you should pass the before value returned from the last response. :type before: str @@ -3354,9 +3354,9 @@ def list_enabled_tokens( self, wallet_type: Annotated[Optional[WalletType], Field(description="The wallet type. - `Custodial`: [Custodial Wallets](https://manuals.cobo.com/en/portal/custodial-wallets/introduction) - `MPC`: [MPC Wallets](https://manuals.cobo.com/en/portal/mpc-wallets/introduction) - `SmartContract`: [Smart Contract Wallets](https://manuals.cobo.com/en/portal/smart-contract-wallets/introduction) - `Exchange`: [Exchange Wallets](https://manuals.cobo.com/en/portal/exchange-wallets/introduction) ")] = None, wallet_subtype: Annotated[Optional[WalletSubtype], Field(description="The wallet subtype. - `Asset`: Custodial Wallets (Asset Wallets) - `Web3`: Custodial Wallets (Web3 Wallets) - `Main`: Exchange Wallets (Main Account) - `Sub`: Exchange Wallets (Sub Account) - `Org-Controlled`: MPC Wallets (Organization-Controlled Wallets) - `User-Controlled`: MPC Wallets (User-Controlled Wallets) - `Safe{Wallet}`: Smart Contract Wallets (Safe{Wallet}) ")] = None, - chain_ids: Annotated[Optional[StrictStr], Field(description="A list of chain IDs, separated by comma. The chain ID is the unique identifier of a blockchain. You can retrieve the IDs of all the chains you can use by calling [List enabled chains](https://www.cobo.com/developers/v2/api-references/wallets/list-enabled-chains).")] = None, - token_ids: Annotated[Optional[StrictStr], Field(description="A list of token IDs, separated by comma. The token ID is the unique identifier of a token. You can retrieve the IDs of all the tokens you can use by calling [List enabled tokens](https://www.cobo.com/developers/v2/api-references/wallets/list-enabled-tokens).")] = None, - limit: Annotated[Optional[StrictInt], Field(description="The maximum number of objects to return. For most operations, the value range is [1, 50].")] = None, + chain_ids: Annotated[Optional[StrictStr], Field(description="A list of chain IDs(Supports up to 500), separated by comma. The chain ID is the unique identifier of a blockchain. You can retrieve the IDs of all the chains you can use by calling [List enabled chains](https://www.cobo.com/developers/v2/api-references/wallets/list-enabled-chains).")] = None, + token_ids: Annotated[Optional[StrictStr], Field(description="A list of token IDs(Supports up to 500), separated by comma. The token ID is the unique identifier of a token. You can retrieve the IDs of all the tokens you can use by calling [List enabled tokens](https://www.cobo.com/developers/v2/api-references/wallets/list-enabled-tokens).")] = None, + limit: Annotated[Optional[StrictInt], Field(description="The maximum number of objects to return. The value range is [1, 500].")] = None, before: Annotated[Optional[StrictStr], Field(description="A cursor indicating the position before the current page. This value is generated by Cobo and returned in the response. If you are paginating forward from the beginning, you do not need to provide it on the first request. When paginating backward (to the previous page), you should pass the before value returned from the last response. ")] = None, after: Annotated[Optional[StrictStr], Field(description="A cursor indicating the position after the current page. This value is generated by Cobo and returned in the response. You do not need to provide it on the first request. When paginating forward (to the next page), you should pass the after value returned from the last response. ")] = None, _request_timeout: Union[ @@ -3376,11 +3376,11 @@ def list_enabled_tokens( :type wallet_type: WalletType :param wallet_subtype: The wallet subtype. - `Asset`: Custodial Wallets (Asset Wallets) - `Web3`: Custodial Wallets (Web3 Wallets) - `Main`: Exchange Wallets (Main Account) - `Sub`: Exchange Wallets (Sub Account) - `Org-Controlled`: MPC Wallets (Organization-Controlled Wallets) - `User-Controlled`: MPC Wallets (User-Controlled Wallets) - `Safe{Wallet}`: Smart Contract Wallets (Safe{Wallet}) :type wallet_subtype: WalletSubtype - :param chain_ids: A list of chain IDs, separated by comma. The chain ID is the unique identifier of a blockchain. You can retrieve the IDs of all the chains you can use by calling [List enabled chains](https://www.cobo.com/developers/v2/api-references/wallets/list-enabled-chains). + :param chain_ids: A list of chain IDs(Supports up to 500), separated by comma. The chain ID is the unique identifier of a blockchain. You can retrieve the IDs of all the chains you can use by calling [List enabled chains](https://www.cobo.com/developers/v2/api-references/wallets/list-enabled-chains). :type chain_ids: str - :param token_ids: A list of token IDs, separated by comma. The token ID is the unique identifier of a token. You can retrieve the IDs of all the tokens you can use by calling [List enabled tokens](https://www.cobo.com/developers/v2/api-references/wallets/list-enabled-tokens). + :param token_ids: A list of token IDs(Supports up to 500), separated by comma. The token ID is the unique identifier of a token. You can retrieve the IDs of all the tokens you can use by calling [List enabled tokens](https://www.cobo.com/developers/v2/api-references/wallets/list-enabled-tokens). :type token_ids: str - :param limit: The maximum number of objects to return. For most operations, the value range is [1, 50]. + :param limit: The maximum number of objects to return. The value range is [1, 500]. :type limit: int :param before: A cursor indicating the position before the current page. This value is generated by Cobo and returned in the response. If you are paginating forward from the beginning, you do not need to provide it on the first request. When paginating backward (to the previous page), you should pass the before value returned from the last response. :type before: str @@ -3424,9 +3424,9 @@ def list_enabled_tokens_with_http_info( self, wallet_type: Annotated[Optional[WalletType], Field(description="The wallet type. - `Custodial`: [Custodial Wallets](https://manuals.cobo.com/en/portal/custodial-wallets/introduction) - `MPC`: [MPC Wallets](https://manuals.cobo.com/en/portal/mpc-wallets/introduction) - `SmartContract`: [Smart Contract Wallets](https://manuals.cobo.com/en/portal/smart-contract-wallets/introduction) - `Exchange`: [Exchange Wallets](https://manuals.cobo.com/en/portal/exchange-wallets/introduction) ")] = None, wallet_subtype: Annotated[Optional[WalletSubtype], Field(description="The wallet subtype. - `Asset`: Custodial Wallets (Asset Wallets) - `Web3`: Custodial Wallets (Web3 Wallets) - `Main`: Exchange Wallets (Main Account) - `Sub`: Exchange Wallets (Sub Account) - `Org-Controlled`: MPC Wallets (Organization-Controlled Wallets) - `User-Controlled`: MPC Wallets (User-Controlled Wallets) - `Safe{Wallet}`: Smart Contract Wallets (Safe{Wallet}) ")] = None, - chain_ids: Annotated[Optional[StrictStr], Field(description="A list of chain IDs, separated by comma. The chain ID is the unique identifier of a blockchain. You can retrieve the IDs of all the chains you can use by calling [List enabled chains](https://www.cobo.com/developers/v2/api-references/wallets/list-enabled-chains).")] = None, - token_ids: Annotated[Optional[StrictStr], Field(description="A list of token IDs, separated by comma. The token ID is the unique identifier of a token. You can retrieve the IDs of all the tokens you can use by calling [List enabled tokens](https://www.cobo.com/developers/v2/api-references/wallets/list-enabled-tokens).")] = None, - limit: Annotated[Optional[StrictInt], Field(description="The maximum number of objects to return. For most operations, the value range is [1, 50].")] = None, + chain_ids: Annotated[Optional[StrictStr], Field(description="A list of chain IDs(Supports up to 500), separated by comma. The chain ID is the unique identifier of a blockchain. You can retrieve the IDs of all the chains you can use by calling [List enabled chains](https://www.cobo.com/developers/v2/api-references/wallets/list-enabled-chains).")] = None, + token_ids: Annotated[Optional[StrictStr], Field(description="A list of token IDs(Supports up to 500), separated by comma. The token ID is the unique identifier of a token. You can retrieve the IDs of all the tokens you can use by calling [List enabled tokens](https://www.cobo.com/developers/v2/api-references/wallets/list-enabled-tokens).")] = None, + limit: Annotated[Optional[StrictInt], Field(description="The maximum number of objects to return. The value range is [1, 500].")] = None, before: Annotated[Optional[StrictStr], Field(description="A cursor indicating the position before the current page. This value is generated by Cobo and returned in the response. If you are paginating forward from the beginning, you do not need to provide it on the first request. When paginating backward (to the previous page), you should pass the before value returned from the last response. ")] = None, after: Annotated[Optional[StrictStr], Field(description="A cursor indicating the position after the current page. This value is generated by Cobo and returned in the response. You do not need to provide it on the first request. When paginating forward (to the next page), you should pass the after value returned from the last response. ")] = None, _request_timeout: Union[ @@ -3446,11 +3446,11 @@ def list_enabled_tokens_with_http_info( :type wallet_type: WalletType :param wallet_subtype: The wallet subtype. - `Asset`: Custodial Wallets (Asset Wallets) - `Web3`: Custodial Wallets (Web3 Wallets) - `Main`: Exchange Wallets (Main Account) - `Sub`: Exchange Wallets (Sub Account) - `Org-Controlled`: MPC Wallets (Organization-Controlled Wallets) - `User-Controlled`: MPC Wallets (User-Controlled Wallets) - `Safe{Wallet}`: Smart Contract Wallets (Safe{Wallet}) :type wallet_subtype: WalletSubtype - :param chain_ids: A list of chain IDs, separated by comma. The chain ID is the unique identifier of a blockchain. You can retrieve the IDs of all the chains you can use by calling [List enabled chains](https://www.cobo.com/developers/v2/api-references/wallets/list-enabled-chains). + :param chain_ids: A list of chain IDs(Supports up to 500), separated by comma. The chain ID is the unique identifier of a blockchain. You can retrieve the IDs of all the chains you can use by calling [List enabled chains](https://www.cobo.com/developers/v2/api-references/wallets/list-enabled-chains). :type chain_ids: str - :param token_ids: A list of token IDs, separated by comma. The token ID is the unique identifier of a token. You can retrieve the IDs of all the tokens you can use by calling [List enabled tokens](https://www.cobo.com/developers/v2/api-references/wallets/list-enabled-tokens). + :param token_ids: A list of token IDs(Supports up to 500), separated by comma. The token ID is the unique identifier of a token. You can retrieve the IDs of all the tokens you can use by calling [List enabled tokens](https://www.cobo.com/developers/v2/api-references/wallets/list-enabled-tokens). :type token_ids: str - :param limit: The maximum number of objects to return. For most operations, the value range is [1, 50]. + :param limit: The maximum number of objects to return. The value range is [1, 500]. :type limit: int :param before: A cursor indicating the position before the current page. This value is generated by Cobo and returned in the response. If you are paginating forward from the beginning, you do not need to provide it on the first request. When paginating backward (to the previous page), you should pass the before value returned from the last response. :type before: str @@ -3494,9 +3494,9 @@ def list_enabled_tokens_without_preload_content( self, wallet_type: Annotated[Optional[WalletType], Field(description="The wallet type. - `Custodial`: [Custodial Wallets](https://manuals.cobo.com/en/portal/custodial-wallets/introduction) - `MPC`: [MPC Wallets](https://manuals.cobo.com/en/portal/mpc-wallets/introduction) - `SmartContract`: [Smart Contract Wallets](https://manuals.cobo.com/en/portal/smart-contract-wallets/introduction) - `Exchange`: [Exchange Wallets](https://manuals.cobo.com/en/portal/exchange-wallets/introduction) ")] = None, wallet_subtype: Annotated[Optional[WalletSubtype], Field(description="The wallet subtype. - `Asset`: Custodial Wallets (Asset Wallets) - `Web3`: Custodial Wallets (Web3 Wallets) - `Main`: Exchange Wallets (Main Account) - `Sub`: Exchange Wallets (Sub Account) - `Org-Controlled`: MPC Wallets (Organization-Controlled Wallets) - `User-Controlled`: MPC Wallets (User-Controlled Wallets) - `Safe{Wallet}`: Smart Contract Wallets (Safe{Wallet}) ")] = None, - chain_ids: Annotated[Optional[StrictStr], Field(description="A list of chain IDs, separated by comma. The chain ID is the unique identifier of a blockchain. You can retrieve the IDs of all the chains you can use by calling [List enabled chains](https://www.cobo.com/developers/v2/api-references/wallets/list-enabled-chains).")] = None, - token_ids: Annotated[Optional[StrictStr], Field(description="A list of token IDs, separated by comma. The token ID is the unique identifier of a token. You can retrieve the IDs of all the tokens you can use by calling [List enabled tokens](https://www.cobo.com/developers/v2/api-references/wallets/list-enabled-tokens).")] = None, - limit: Annotated[Optional[StrictInt], Field(description="The maximum number of objects to return. For most operations, the value range is [1, 50].")] = None, + chain_ids: Annotated[Optional[StrictStr], Field(description="A list of chain IDs(Supports up to 500), separated by comma. The chain ID is the unique identifier of a blockchain. You can retrieve the IDs of all the chains you can use by calling [List enabled chains](https://www.cobo.com/developers/v2/api-references/wallets/list-enabled-chains).")] = None, + token_ids: Annotated[Optional[StrictStr], Field(description="A list of token IDs(Supports up to 500), separated by comma. The token ID is the unique identifier of a token. You can retrieve the IDs of all the tokens you can use by calling [List enabled tokens](https://www.cobo.com/developers/v2/api-references/wallets/list-enabled-tokens).")] = None, + limit: Annotated[Optional[StrictInt], Field(description="The maximum number of objects to return. The value range is [1, 500].")] = None, before: Annotated[Optional[StrictStr], Field(description="A cursor indicating the position before the current page. This value is generated by Cobo and returned in the response. If you are paginating forward from the beginning, you do not need to provide it on the first request. When paginating backward (to the previous page), you should pass the before value returned from the last response. ")] = None, after: Annotated[Optional[StrictStr], Field(description="A cursor indicating the position after the current page. This value is generated by Cobo and returned in the response. You do not need to provide it on the first request. When paginating forward (to the next page), you should pass the after value returned from the last response. ")] = None, _request_timeout: Union[ @@ -3516,11 +3516,11 @@ def list_enabled_tokens_without_preload_content( :type wallet_type: WalletType :param wallet_subtype: The wallet subtype. - `Asset`: Custodial Wallets (Asset Wallets) - `Web3`: Custodial Wallets (Web3 Wallets) - `Main`: Exchange Wallets (Main Account) - `Sub`: Exchange Wallets (Sub Account) - `Org-Controlled`: MPC Wallets (Organization-Controlled Wallets) - `User-Controlled`: MPC Wallets (User-Controlled Wallets) - `Safe{Wallet}`: Smart Contract Wallets (Safe{Wallet}) :type wallet_subtype: WalletSubtype - :param chain_ids: A list of chain IDs, separated by comma. The chain ID is the unique identifier of a blockchain. You can retrieve the IDs of all the chains you can use by calling [List enabled chains](https://www.cobo.com/developers/v2/api-references/wallets/list-enabled-chains). + :param chain_ids: A list of chain IDs(Supports up to 500), separated by comma. The chain ID is the unique identifier of a blockchain. You can retrieve the IDs of all the chains you can use by calling [List enabled chains](https://www.cobo.com/developers/v2/api-references/wallets/list-enabled-chains). :type chain_ids: str - :param token_ids: A list of token IDs, separated by comma. The token ID is the unique identifier of a token. You can retrieve the IDs of all the tokens you can use by calling [List enabled tokens](https://www.cobo.com/developers/v2/api-references/wallets/list-enabled-tokens). + :param token_ids: A list of token IDs(Supports up to 500), separated by comma. The token ID is the unique identifier of a token. You can retrieve the IDs of all the tokens you can use by calling [List enabled tokens](https://www.cobo.com/developers/v2/api-references/wallets/list-enabled-tokens). :type token_ids: str - :param limit: The maximum number of objects to return. For most operations, the value range is [1, 50]. + :param limit: The maximum number of objects to return. The value range is [1, 500]. :type limit: int :param before: A cursor indicating the position before the current page. This value is generated by Cobo and returned in the response. If you are paginating forward from the beginning, you do not need to provide it on the first request. When paginating backward (to the previous page), you should pass the before value returned from the last response. :type before: str @@ -3627,8 +3627,8 @@ def list_supported_chains( self, wallet_type: Annotated[Optional[WalletType], Field(description="The wallet type. - `Custodial`: [Custodial Wallets](https://manuals.cobo.com/en/portal/custodial-wallets/introduction) - `MPC`: [MPC Wallets](https://manuals.cobo.com/en/portal/mpc-wallets/introduction) - `SmartContract`: [Smart Contract Wallets](https://manuals.cobo.com/en/portal/smart-contract-wallets/introduction) - `Exchange`: [Exchange Wallets](https://manuals.cobo.com/en/portal/exchange-wallets/introduction) ")] = None, wallet_subtype: Annotated[Optional[WalletSubtype], Field(description="The wallet subtype. - `Asset`: Custodial Wallets (Asset Wallets) - `Web3`: Custodial Wallets (Web3 Wallets) - `Main`: Exchange Wallets (Main Account) - `Sub`: Exchange Wallets (Sub Account) - `Org-Controlled`: MPC Wallets (Organization-Controlled Wallets) - `User-Controlled`: MPC Wallets (User-Controlled Wallets) - `Safe{Wallet}`: Smart Contract Wallets (Safe{Wallet}) ")] = None, - chain_ids: Annotated[Optional[StrictStr], Field(description="A list of chain IDs, separated by comma. The chain ID is the unique identifier of a blockchain. You can retrieve the IDs of all the chains you can use by calling [List enabled chains](https://www.cobo.com/developers/v2/api-references/wallets/list-enabled-chains).")] = None, - limit: Annotated[Optional[StrictInt], Field(description="The maximum number of objects to return. For most operations, the value range is [1, 50].")] = None, + chain_ids: Annotated[Optional[StrictStr], Field(description="A list of chain IDs(Supports up to 500), separated by comma. The chain ID is the unique identifier of a blockchain. You can retrieve the IDs of all the chains you can use by calling [List enabled chains](https://www.cobo.com/developers/v2/api-references/wallets/list-enabled-chains).")] = None, + limit: Annotated[Optional[StrictInt], Field(description="The maximum number of objects to return. The value range is [1, 500].")] = None, before: Annotated[Optional[StrictStr], Field(description="A cursor indicating the position before the current page. This value is generated by Cobo and returned in the response. If you are paginating forward from the beginning, you do not need to provide it on the first request. When paginating backward (to the previous page), you should pass the before value returned from the last response. ")] = None, after: Annotated[Optional[StrictStr], Field(description="A cursor indicating the position after the current page. This value is generated by Cobo and returned in the response. You do not need to provide it on the first request. When paginating forward (to the next page), you should pass the after value returned from the last response. ")] = None, _request_timeout: Union[ @@ -3648,9 +3648,9 @@ def list_supported_chains( :type wallet_type: WalletType :param wallet_subtype: The wallet subtype. - `Asset`: Custodial Wallets (Asset Wallets) - `Web3`: Custodial Wallets (Web3 Wallets) - `Main`: Exchange Wallets (Main Account) - `Sub`: Exchange Wallets (Sub Account) - `Org-Controlled`: MPC Wallets (Organization-Controlled Wallets) - `User-Controlled`: MPC Wallets (User-Controlled Wallets) - `Safe{Wallet}`: Smart Contract Wallets (Safe{Wallet}) :type wallet_subtype: WalletSubtype - :param chain_ids: A list of chain IDs, separated by comma. The chain ID is the unique identifier of a blockchain. You can retrieve the IDs of all the chains you can use by calling [List enabled chains](https://www.cobo.com/developers/v2/api-references/wallets/list-enabled-chains). + :param chain_ids: A list of chain IDs(Supports up to 500), separated by comma. The chain ID is the unique identifier of a blockchain. You can retrieve the IDs of all the chains you can use by calling [List enabled chains](https://www.cobo.com/developers/v2/api-references/wallets/list-enabled-chains). :type chain_ids: str - :param limit: The maximum number of objects to return. For most operations, the value range is [1, 50]. + :param limit: The maximum number of objects to return. The value range is [1, 500]. :type limit: int :param before: A cursor indicating the position before the current page. This value is generated by Cobo and returned in the response. If you are paginating forward from the beginning, you do not need to provide it on the first request. When paginating backward (to the previous page), you should pass the before value returned from the last response. :type before: str @@ -3693,8 +3693,8 @@ def list_supported_chains_with_http_info( self, wallet_type: Annotated[Optional[WalletType], Field(description="The wallet type. - `Custodial`: [Custodial Wallets](https://manuals.cobo.com/en/portal/custodial-wallets/introduction) - `MPC`: [MPC Wallets](https://manuals.cobo.com/en/portal/mpc-wallets/introduction) - `SmartContract`: [Smart Contract Wallets](https://manuals.cobo.com/en/portal/smart-contract-wallets/introduction) - `Exchange`: [Exchange Wallets](https://manuals.cobo.com/en/portal/exchange-wallets/introduction) ")] = None, wallet_subtype: Annotated[Optional[WalletSubtype], Field(description="The wallet subtype. - `Asset`: Custodial Wallets (Asset Wallets) - `Web3`: Custodial Wallets (Web3 Wallets) - `Main`: Exchange Wallets (Main Account) - `Sub`: Exchange Wallets (Sub Account) - `Org-Controlled`: MPC Wallets (Organization-Controlled Wallets) - `User-Controlled`: MPC Wallets (User-Controlled Wallets) - `Safe{Wallet}`: Smart Contract Wallets (Safe{Wallet}) ")] = None, - chain_ids: Annotated[Optional[StrictStr], Field(description="A list of chain IDs, separated by comma. The chain ID is the unique identifier of a blockchain. You can retrieve the IDs of all the chains you can use by calling [List enabled chains](https://www.cobo.com/developers/v2/api-references/wallets/list-enabled-chains).")] = None, - limit: Annotated[Optional[StrictInt], Field(description="The maximum number of objects to return. For most operations, the value range is [1, 50].")] = None, + chain_ids: Annotated[Optional[StrictStr], Field(description="A list of chain IDs(Supports up to 500), separated by comma. The chain ID is the unique identifier of a blockchain. You can retrieve the IDs of all the chains you can use by calling [List enabled chains](https://www.cobo.com/developers/v2/api-references/wallets/list-enabled-chains).")] = None, + limit: Annotated[Optional[StrictInt], Field(description="The maximum number of objects to return. The value range is [1, 500].")] = None, before: Annotated[Optional[StrictStr], Field(description="A cursor indicating the position before the current page. This value is generated by Cobo and returned in the response. If you are paginating forward from the beginning, you do not need to provide it on the first request. When paginating backward (to the previous page), you should pass the before value returned from the last response. ")] = None, after: Annotated[Optional[StrictStr], Field(description="A cursor indicating the position after the current page. This value is generated by Cobo and returned in the response. You do not need to provide it on the first request. When paginating forward (to the next page), you should pass the after value returned from the last response. ")] = None, _request_timeout: Union[ @@ -3714,9 +3714,9 @@ def list_supported_chains_with_http_info( :type wallet_type: WalletType :param wallet_subtype: The wallet subtype. - `Asset`: Custodial Wallets (Asset Wallets) - `Web3`: Custodial Wallets (Web3 Wallets) - `Main`: Exchange Wallets (Main Account) - `Sub`: Exchange Wallets (Sub Account) - `Org-Controlled`: MPC Wallets (Organization-Controlled Wallets) - `User-Controlled`: MPC Wallets (User-Controlled Wallets) - `Safe{Wallet}`: Smart Contract Wallets (Safe{Wallet}) :type wallet_subtype: WalletSubtype - :param chain_ids: A list of chain IDs, separated by comma. The chain ID is the unique identifier of a blockchain. You can retrieve the IDs of all the chains you can use by calling [List enabled chains](https://www.cobo.com/developers/v2/api-references/wallets/list-enabled-chains). + :param chain_ids: A list of chain IDs(Supports up to 500), separated by comma. The chain ID is the unique identifier of a blockchain. You can retrieve the IDs of all the chains you can use by calling [List enabled chains](https://www.cobo.com/developers/v2/api-references/wallets/list-enabled-chains). :type chain_ids: str - :param limit: The maximum number of objects to return. For most operations, the value range is [1, 50]. + :param limit: The maximum number of objects to return. The value range is [1, 500]. :type limit: int :param before: A cursor indicating the position before the current page. This value is generated by Cobo and returned in the response. If you are paginating forward from the beginning, you do not need to provide it on the first request. When paginating backward (to the previous page), you should pass the before value returned from the last response. :type before: str @@ -3759,8 +3759,8 @@ def list_supported_chains_without_preload_content( self, wallet_type: Annotated[Optional[WalletType], Field(description="The wallet type. - `Custodial`: [Custodial Wallets](https://manuals.cobo.com/en/portal/custodial-wallets/introduction) - `MPC`: [MPC Wallets](https://manuals.cobo.com/en/portal/mpc-wallets/introduction) - `SmartContract`: [Smart Contract Wallets](https://manuals.cobo.com/en/portal/smart-contract-wallets/introduction) - `Exchange`: [Exchange Wallets](https://manuals.cobo.com/en/portal/exchange-wallets/introduction) ")] = None, wallet_subtype: Annotated[Optional[WalletSubtype], Field(description="The wallet subtype. - `Asset`: Custodial Wallets (Asset Wallets) - `Web3`: Custodial Wallets (Web3 Wallets) - `Main`: Exchange Wallets (Main Account) - `Sub`: Exchange Wallets (Sub Account) - `Org-Controlled`: MPC Wallets (Organization-Controlled Wallets) - `User-Controlled`: MPC Wallets (User-Controlled Wallets) - `Safe{Wallet}`: Smart Contract Wallets (Safe{Wallet}) ")] = None, - chain_ids: Annotated[Optional[StrictStr], Field(description="A list of chain IDs, separated by comma. The chain ID is the unique identifier of a blockchain. You can retrieve the IDs of all the chains you can use by calling [List enabled chains](https://www.cobo.com/developers/v2/api-references/wallets/list-enabled-chains).")] = None, - limit: Annotated[Optional[StrictInt], Field(description="The maximum number of objects to return. For most operations, the value range is [1, 50].")] = None, + chain_ids: Annotated[Optional[StrictStr], Field(description="A list of chain IDs(Supports up to 500), separated by comma. The chain ID is the unique identifier of a blockchain. You can retrieve the IDs of all the chains you can use by calling [List enabled chains](https://www.cobo.com/developers/v2/api-references/wallets/list-enabled-chains).")] = None, + limit: Annotated[Optional[StrictInt], Field(description="The maximum number of objects to return. The value range is [1, 500].")] = None, before: Annotated[Optional[StrictStr], Field(description="A cursor indicating the position before the current page. This value is generated by Cobo and returned in the response. If you are paginating forward from the beginning, you do not need to provide it on the first request. When paginating backward (to the previous page), you should pass the before value returned from the last response. ")] = None, after: Annotated[Optional[StrictStr], Field(description="A cursor indicating the position after the current page. This value is generated by Cobo and returned in the response. You do not need to provide it on the first request. When paginating forward (to the next page), you should pass the after value returned from the last response. ")] = None, _request_timeout: Union[ @@ -3780,9 +3780,9 @@ def list_supported_chains_without_preload_content( :type wallet_type: WalletType :param wallet_subtype: The wallet subtype. - `Asset`: Custodial Wallets (Asset Wallets) - `Web3`: Custodial Wallets (Web3 Wallets) - `Main`: Exchange Wallets (Main Account) - `Sub`: Exchange Wallets (Sub Account) - `Org-Controlled`: MPC Wallets (Organization-Controlled Wallets) - `User-Controlled`: MPC Wallets (User-Controlled Wallets) - `Safe{Wallet}`: Smart Contract Wallets (Safe{Wallet}) :type wallet_subtype: WalletSubtype - :param chain_ids: A list of chain IDs, separated by comma. The chain ID is the unique identifier of a blockchain. You can retrieve the IDs of all the chains you can use by calling [List enabled chains](https://www.cobo.com/developers/v2/api-references/wallets/list-enabled-chains). + :param chain_ids: A list of chain IDs(Supports up to 500), separated by comma. The chain ID is the unique identifier of a blockchain. You can retrieve the IDs of all the chains you can use by calling [List enabled chains](https://www.cobo.com/developers/v2/api-references/wallets/list-enabled-chains). :type chain_ids: str - :param limit: The maximum number of objects to return. For most operations, the value range is [1, 50]. + :param limit: The maximum number of objects to return. The value range is [1, 500]. :type limit: int :param before: A cursor indicating the position before the current page. This value is generated by Cobo and returned in the response. If you are paginating forward from the beginning, you do not need to provide it on the first request. When paginating backward (to the previous page), you should pass the before value returned from the last response. :type before: str @@ -3883,9 +3883,9 @@ def list_supported_tokens( self, wallet_type: Annotated[Optional[WalletType], Field(description="The wallet type. - `Custodial`: [Custodial Wallets](https://manuals.cobo.com/en/portal/custodial-wallets/introduction) - `MPC`: [MPC Wallets](https://manuals.cobo.com/en/portal/mpc-wallets/introduction) - `SmartContract`: [Smart Contract Wallets](https://manuals.cobo.com/en/portal/smart-contract-wallets/introduction) - `Exchange`: [Exchange Wallets](https://manuals.cobo.com/en/portal/exchange-wallets/introduction) ")] = None, wallet_subtype: Annotated[Optional[WalletSubtype], Field(description="The wallet subtype. - `Asset`: Custodial Wallets (Asset Wallets) - `Web3`: Custodial Wallets (Web3 Wallets) - `Main`: Exchange Wallets (Main Account) - `Sub`: Exchange Wallets (Sub Account) - `Org-Controlled`: MPC Wallets (Organization-Controlled Wallets) - `User-Controlled`: MPC Wallets (User-Controlled Wallets) - `Safe{Wallet}`: Smart Contract Wallets (Safe{Wallet}) ")] = None, - chain_ids: Annotated[Optional[StrictStr], Field(description="A list of chain IDs, separated by comma. The chain ID is the unique identifier of a blockchain. You can retrieve the IDs of all the chains you can use by calling [List enabled chains](https://www.cobo.com/developers/v2/api-references/wallets/list-enabled-chains).")] = None, - token_ids: Annotated[Optional[StrictStr], Field(description="A list of token IDs, separated by comma. The token ID is the unique identifier of a token. You can retrieve the IDs of all the tokens you can use by calling [List enabled tokens](https://www.cobo.com/developers/v2/api-references/wallets/list-enabled-tokens).")] = None, - limit: Annotated[Optional[StrictInt], Field(description="The maximum number of objects to return. For most operations, the value range is [1, 50].")] = None, + chain_ids: Annotated[Optional[StrictStr], Field(description="A list of chain IDs(Supports up to 500), separated by comma. The chain ID is the unique identifier of a blockchain. You can retrieve the IDs of all the chains you can use by calling [List enabled chains](https://www.cobo.com/developers/v2/api-references/wallets/list-enabled-chains).")] = None, + token_ids: Annotated[Optional[StrictStr], Field(description="A list of token IDs(Supports up to 500), separated by comma. The token ID is the unique identifier of a token. You can retrieve the IDs of all the tokens you can use by calling [List enabled tokens](https://www.cobo.com/developers/v2/api-references/wallets/list-enabled-tokens).")] = None, + limit: Annotated[Optional[StrictInt], Field(description="The maximum number of objects to return. The value range is [1, 500].")] = None, before: Annotated[Optional[StrictStr], Field(description="A cursor indicating the position before the current page. This value is generated by Cobo and returned in the response. If you are paginating forward from the beginning, you do not need to provide it on the first request. When paginating backward (to the previous page), you should pass the before value returned from the last response. ")] = None, after: Annotated[Optional[StrictStr], Field(description="A cursor indicating the position after the current page. This value is generated by Cobo and returned in the response. You do not need to provide it on the first request. When paginating forward (to the next page), you should pass the after value returned from the last response. ")] = None, _request_timeout: Union[ @@ -3905,11 +3905,11 @@ def list_supported_tokens( :type wallet_type: WalletType :param wallet_subtype: The wallet subtype. - `Asset`: Custodial Wallets (Asset Wallets) - `Web3`: Custodial Wallets (Web3 Wallets) - `Main`: Exchange Wallets (Main Account) - `Sub`: Exchange Wallets (Sub Account) - `Org-Controlled`: MPC Wallets (Organization-Controlled Wallets) - `User-Controlled`: MPC Wallets (User-Controlled Wallets) - `Safe{Wallet}`: Smart Contract Wallets (Safe{Wallet}) :type wallet_subtype: WalletSubtype - :param chain_ids: A list of chain IDs, separated by comma. The chain ID is the unique identifier of a blockchain. You can retrieve the IDs of all the chains you can use by calling [List enabled chains](https://www.cobo.com/developers/v2/api-references/wallets/list-enabled-chains). + :param chain_ids: A list of chain IDs(Supports up to 500), separated by comma. The chain ID is the unique identifier of a blockchain. You can retrieve the IDs of all the chains you can use by calling [List enabled chains](https://www.cobo.com/developers/v2/api-references/wallets/list-enabled-chains). :type chain_ids: str - :param token_ids: A list of token IDs, separated by comma. The token ID is the unique identifier of a token. You can retrieve the IDs of all the tokens you can use by calling [List enabled tokens](https://www.cobo.com/developers/v2/api-references/wallets/list-enabled-tokens). + :param token_ids: A list of token IDs(Supports up to 500), separated by comma. The token ID is the unique identifier of a token. You can retrieve the IDs of all the tokens you can use by calling [List enabled tokens](https://www.cobo.com/developers/v2/api-references/wallets/list-enabled-tokens). :type token_ids: str - :param limit: The maximum number of objects to return. For most operations, the value range is [1, 50]. + :param limit: The maximum number of objects to return. The value range is [1, 500]. :type limit: int :param before: A cursor indicating the position before the current page. This value is generated by Cobo and returned in the response. If you are paginating forward from the beginning, you do not need to provide it on the first request. When paginating backward (to the previous page), you should pass the before value returned from the last response. :type before: str @@ -3953,9 +3953,9 @@ def list_supported_tokens_with_http_info( self, wallet_type: Annotated[Optional[WalletType], Field(description="The wallet type. - `Custodial`: [Custodial Wallets](https://manuals.cobo.com/en/portal/custodial-wallets/introduction) - `MPC`: [MPC Wallets](https://manuals.cobo.com/en/portal/mpc-wallets/introduction) - `SmartContract`: [Smart Contract Wallets](https://manuals.cobo.com/en/portal/smart-contract-wallets/introduction) - `Exchange`: [Exchange Wallets](https://manuals.cobo.com/en/portal/exchange-wallets/introduction) ")] = None, wallet_subtype: Annotated[Optional[WalletSubtype], Field(description="The wallet subtype. - `Asset`: Custodial Wallets (Asset Wallets) - `Web3`: Custodial Wallets (Web3 Wallets) - `Main`: Exchange Wallets (Main Account) - `Sub`: Exchange Wallets (Sub Account) - `Org-Controlled`: MPC Wallets (Organization-Controlled Wallets) - `User-Controlled`: MPC Wallets (User-Controlled Wallets) - `Safe{Wallet}`: Smart Contract Wallets (Safe{Wallet}) ")] = None, - chain_ids: Annotated[Optional[StrictStr], Field(description="A list of chain IDs, separated by comma. The chain ID is the unique identifier of a blockchain. You can retrieve the IDs of all the chains you can use by calling [List enabled chains](https://www.cobo.com/developers/v2/api-references/wallets/list-enabled-chains).")] = None, - token_ids: Annotated[Optional[StrictStr], Field(description="A list of token IDs, separated by comma. The token ID is the unique identifier of a token. You can retrieve the IDs of all the tokens you can use by calling [List enabled tokens](https://www.cobo.com/developers/v2/api-references/wallets/list-enabled-tokens).")] = None, - limit: Annotated[Optional[StrictInt], Field(description="The maximum number of objects to return. For most operations, the value range is [1, 50].")] = None, + chain_ids: Annotated[Optional[StrictStr], Field(description="A list of chain IDs(Supports up to 500), separated by comma. The chain ID is the unique identifier of a blockchain. You can retrieve the IDs of all the chains you can use by calling [List enabled chains](https://www.cobo.com/developers/v2/api-references/wallets/list-enabled-chains).")] = None, + token_ids: Annotated[Optional[StrictStr], Field(description="A list of token IDs(Supports up to 500), separated by comma. The token ID is the unique identifier of a token. You can retrieve the IDs of all the tokens you can use by calling [List enabled tokens](https://www.cobo.com/developers/v2/api-references/wallets/list-enabled-tokens).")] = None, + limit: Annotated[Optional[StrictInt], Field(description="The maximum number of objects to return. The value range is [1, 500].")] = None, before: Annotated[Optional[StrictStr], Field(description="A cursor indicating the position before the current page. This value is generated by Cobo and returned in the response. If you are paginating forward from the beginning, you do not need to provide it on the first request. When paginating backward (to the previous page), you should pass the before value returned from the last response. ")] = None, after: Annotated[Optional[StrictStr], Field(description="A cursor indicating the position after the current page. This value is generated by Cobo and returned in the response. You do not need to provide it on the first request. When paginating forward (to the next page), you should pass the after value returned from the last response. ")] = None, _request_timeout: Union[ @@ -3975,11 +3975,11 @@ def list_supported_tokens_with_http_info( :type wallet_type: WalletType :param wallet_subtype: The wallet subtype. - `Asset`: Custodial Wallets (Asset Wallets) - `Web3`: Custodial Wallets (Web3 Wallets) - `Main`: Exchange Wallets (Main Account) - `Sub`: Exchange Wallets (Sub Account) - `Org-Controlled`: MPC Wallets (Organization-Controlled Wallets) - `User-Controlled`: MPC Wallets (User-Controlled Wallets) - `Safe{Wallet}`: Smart Contract Wallets (Safe{Wallet}) :type wallet_subtype: WalletSubtype - :param chain_ids: A list of chain IDs, separated by comma. The chain ID is the unique identifier of a blockchain. You can retrieve the IDs of all the chains you can use by calling [List enabled chains](https://www.cobo.com/developers/v2/api-references/wallets/list-enabled-chains). + :param chain_ids: A list of chain IDs(Supports up to 500), separated by comma. The chain ID is the unique identifier of a blockchain. You can retrieve the IDs of all the chains you can use by calling [List enabled chains](https://www.cobo.com/developers/v2/api-references/wallets/list-enabled-chains). :type chain_ids: str - :param token_ids: A list of token IDs, separated by comma. The token ID is the unique identifier of a token. You can retrieve the IDs of all the tokens you can use by calling [List enabled tokens](https://www.cobo.com/developers/v2/api-references/wallets/list-enabled-tokens). + :param token_ids: A list of token IDs(Supports up to 500), separated by comma. The token ID is the unique identifier of a token. You can retrieve the IDs of all the tokens you can use by calling [List enabled tokens](https://www.cobo.com/developers/v2/api-references/wallets/list-enabled-tokens). :type token_ids: str - :param limit: The maximum number of objects to return. For most operations, the value range is [1, 50]. + :param limit: The maximum number of objects to return. The value range is [1, 500]. :type limit: int :param before: A cursor indicating the position before the current page. This value is generated by Cobo and returned in the response. If you are paginating forward from the beginning, you do not need to provide it on the first request. When paginating backward (to the previous page), you should pass the before value returned from the last response. :type before: str @@ -4023,9 +4023,9 @@ def list_supported_tokens_without_preload_content( self, wallet_type: Annotated[Optional[WalletType], Field(description="The wallet type. - `Custodial`: [Custodial Wallets](https://manuals.cobo.com/en/portal/custodial-wallets/introduction) - `MPC`: [MPC Wallets](https://manuals.cobo.com/en/portal/mpc-wallets/introduction) - `SmartContract`: [Smart Contract Wallets](https://manuals.cobo.com/en/portal/smart-contract-wallets/introduction) - `Exchange`: [Exchange Wallets](https://manuals.cobo.com/en/portal/exchange-wallets/introduction) ")] = None, wallet_subtype: Annotated[Optional[WalletSubtype], Field(description="The wallet subtype. - `Asset`: Custodial Wallets (Asset Wallets) - `Web3`: Custodial Wallets (Web3 Wallets) - `Main`: Exchange Wallets (Main Account) - `Sub`: Exchange Wallets (Sub Account) - `Org-Controlled`: MPC Wallets (Organization-Controlled Wallets) - `User-Controlled`: MPC Wallets (User-Controlled Wallets) - `Safe{Wallet}`: Smart Contract Wallets (Safe{Wallet}) ")] = None, - chain_ids: Annotated[Optional[StrictStr], Field(description="A list of chain IDs, separated by comma. The chain ID is the unique identifier of a blockchain. You can retrieve the IDs of all the chains you can use by calling [List enabled chains](https://www.cobo.com/developers/v2/api-references/wallets/list-enabled-chains).")] = None, - token_ids: Annotated[Optional[StrictStr], Field(description="A list of token IDs, separated by comma. The token ID is the unique identifier of a token. You can retrieve the IDs of all the tokens you can use by calling [List enabled tokens](https://www.cobo.com/developers/v2/api-references/wallets/list-enabled-tokens).")] = None, - limit: Annotated[Optional[StrictInt], Field(description="The maximum number of objects to return. For most operations, the value range is [1, 50].")] = None, + chain_ids: Annotated[Optional[StrictStr], Field(description="A list of chain IDs(Supports up to 500), separated by comma. The chain ID is the unique identifier of a blockchain. You can retrieve the IDs of all the chains you can use by calling [List enabled chains](https://www.cobo.com/developers/v2/api-references/wallets/list-enabled-chains).")] = None, + token_ids: Annotated[Optional[StrictStr], Field(description="A list of token IDs(Supports up to 500), separated by comma. The token ID is the unique identifier of a token. You can retrieve the IDs of all the tokens you can use by calling [List enabled tokens](https://www.cobo.com/developers/v2/api-references/wallets/list-enabled-tokens).")] = None, + limit: Annotated[Optional[StrictInt], Field(description="The maximum number of objects to return. The value range is [1, 500].")] = None, before: Annotated[Optional[StrictStr], Field(description="A cursor indicating the position before the current page. This value is generated by Cobo and returned in the response. If you are paginating forward from the beginning, you do not need to provide it on the first request. When paginating backward (to the previous page), you should pass the before value returned from the last response. ")] = None, after: Annotated[Optional[StrictStr], Field(description="A cursor indicating the position after the current page. This value is generated by Cobo and returned in the response. You do not need to provide it on the first request. When paginating forward (to the next page), you should pass the after value returned from the last response. ")] = None, _request_timeout: Union[ @@ -4045,11 +4045,11 @@ def list_supported_tokens_without_preload_content( :type wallet_type: WalletType :param wallet_subtype: The wallet subtype. - `Asset`: Custodial Wallets (Asset Wallets) - `Web3`: Custodial Wallets (Web3 Wallets) - `Main`: Exchange Wallets (Main Account) - `Sub`: Exchange Wallets (Sub Account) - `Org-Controlled`: MPC Wallets (Organization-Controlled Wallets) - `User-Controlled`: MPC Wallets (User-Controlled Wallets) - `Safe{Wallet}`: Smart Contract Wallets (Safe{Wallet}) :type wallet_subtype: WalletSubtype - :param chain_ids: A list of chain IDs, separated by comma. The chain ID is the unique identifier of a blockchain. You can retrieve the IDs of all the chains you can use by calling [List enabled chains](https://www.cobo.com/developers/v2/api-references/wallets/list-enabled-chains). + :param chain_ids: A list of chain IDs(Supports up to 500), separated by comma. The chain ID is the unique identifier of a blockchain. You can retrieve the IDs of all the chains you can use by calling [List enabled chains](https://www.cobo.com/developers/v2/api-references/wallets/list-enabled-chains). :type chain_ids: str - :param token_ids: A list of token IDs, separated by comma. The token ID is the unique identifier of a token. You can retrieve the IDs of all the tokens you can use by calling [List enabled tokens](https://www.cobo.com/developers/v2/api-references/wallets/list-enabled-tokens). + :param token_ids: A list of token IDs(Supports up to 500), separated by comma. The token ID is the unique identifier of a token. You can retrieve the IDs of all the tokens you can use by calling [List enabled tokens](https://www.cobo.com/developers/v2/api-references/wallets/list-enabled-tokens). :type token_ids: str - :param limit: The maximum number of objects to return. For most operations, the value range is [1, 50]. + :param limit: The maximum number of objects to return. The value range is [1, 500]. :type limit: int :param before: A cursor indicating the position before the current page. This value is generated by Cobo and returned in the response. If you are paginating forward from the beginning, you do not need to provide it on the first request. When paginating backward (to the previous page), you should pass the before value returned from the last response. :type before: str diff --git a/cobo_waas2/api_client.py b/cobo_waas2/api_client.py index 6489d4f2..4e731f5f 100644 --- a/cobo_waas2/api_client.py +++ b/cobo_waas2/api_client.py @@ -68,7 +68,7 @@ def __init__( self.rest_client = rest.RESTClientObject(configuration) self.default_headers = {} # Set default User-Agent. - self.user_agent = 'cobo-waas2-python-sdk/1.29.0' + self.user_agent = 'cobo-waas2-python-sdk/1.30.0' def __enter__(self): return self diff --git a/cobo_waas2/models/__init__.py b/cobo_waas2/models/__init__.py index d68d8817..1203ecad 100644 --- a/cobo_waas2/models/__init__.py +++ b/cobo_waas2/models/__init__.py @@ -31,8 +31,8 @@ from cobo_waas2.models.address_transfer_destination_utxo_outputs_inner import AddressTransferDestinationUtxoOutputsInner from cobo_waas2.models.addresses_event_data import AddressesEventData from cobo_waas2.models.addresses_event_data_all_of_addresses import AddressesEventDataAllOfAddresses -from cobo_waas2.models.allocation_record import AllocationRecord -from cobo_waas2.models.allocation_request import AllocationRequest +from cobo_waas2.models.allocation_item import AllocationItem +from cobo_waas2.models.allocation_param import AllocationParam from cobo_waas2.models.amount_details_inner import AmountDetailsInner from cobo_waas2.models.amount_status import AmountStatus from cobo_waas2.models.api_log_details import ApiLogDetails @@ -127,6 +127,8 @@ from cobo_waas2.models.create_babylon_staking_registration201_response import CreateBabylonStakingRegistration201Response from cobo_waas2.models.create_babylon_staking_registration_request import CreateBabylonStakingRegistrationRequest from cobo_waas2.models.create_batch_allocation_request import CreateBatchAllocationRequest +from cobo_waas2.models.create_bulk_send_request import CreateBulkSendRequest +from cobo_waas2.models.create_bulk_send_request_payout_params_inner import CreateBulkSendRequestPayoutParamsInner from cobo_waas2.models.create_claim_activity import CreateClaimActivity from cobo_waas2.models.create_claim_activity_request import CreateClaimActivityRequest from cobo_waas2.models.create_counterparty_entry201_response import CreateCounterpartyEntry201Response @@ -169,6 +171,8 @@ from cobo_waas2.models.create_sweep_to_address import CreateSweepToAddress from cobo_waas2.models.create_token_listing_request201_response import CreateTokenListingRequest201Response from cobo_waas2.models.create_token_listing_request_request import CreateTokenListingRequestRequest +from cobo_waas2.models.create_top_up_addresses import CreateTopUpAddresses +from cobo_waas2.models.create_top_up_addresses201_response import CreateTopUpAddresses201Response from cobo_waas2.models.create_transfer_transaction201_response import CreateTransferTransaction201Response from cobo_waas2.models.create_tss_request_request import CreateTssRequestRequest from cobo_waas2.models.create_unstake_activity import CreateUnstakeActivity @@ -325,7 +329,7 @@ from cobo_waas2.models.list_address_balances_by_token200_response import ListAddressBalancesByToken200Response from cobo_waas2.models.list_address_books200_response import ListAddressBooks200Response from cobo_waas2.models.list_addresses200_response import ListAddresses200Response -from cobo_waas2.models.list_allocations200_response import ListAllocations200Response +from cobo_waas2.models.list_allocation_items200_response import ListAllocationItems200Response from cobo_waas2.models.list_approval_requests200_response import ListApprovalRequests200Response from cobo_waas2.models.list_asset_balances_for_exchange_wallet200_response import ListAssetBalancesForExchangeWallet200Response from cobo_waas2.models.list_auto_sweep_task200_response import ListAutoSweepTask200Response @@ -335,6 +339,7 @@ from cobo_waas2.models.list_babylon_eligible_stakings200_response_data_inner import ListBabylonEligibleStakings200ResponseDataInner from cobo_waas2.models.list_babylon_staking_registrations200_response import ListBabylonStakingRegistrations200Response from cobo_waas2.models.list_batch_allocations200_response import ListBatchAllocations200Response +from cobo_waas2.models.list_bulk_send_items200_response import ListBulkSendItems200Response from cobo_waas2.models.list_callback_messages200_response import ListCallbackMessages200Response from cobo_waas2.models.list_counterparties200_response import ListCounterparties200Response from cobo_waas2.models.list_counterparty_entries200_response import ListCounterpartyEntries200Response @@ -354,7 +359,6 @@ from cobo_waas2.models.list_mpc_vaults200_response import ListMpcVaults200Response from cobo_waas2.models.list_payment_orders200_response import ListPaymentOrders200Response from cobo_waas2.models.list_payment_wallet_balances200_response import ListPaymentWalletBalances200Response -from cobo_waas2.models.list_payout_items200_response import ListPayoutItems200Response from cobo_waas2.models.list_payouts200_response import ListPayouts200Response from cobo_waas2.models.list_settlement_details200_response import ListSettlementDetails200Response from cobo_waas2.models.list_settlement_requests200_response import ListSettlementRequests200Response @@ -419,6 +423,13 @@ from cobo_waas2.models.payer_account import PayerAccount from cobo_waas2.models.payment_address_update_event_data import PaymentAddressUpdateEventData from cobo_waas2.models.payment_allocation_amount import PaymentAllocationAmount +from cobo_waas2.models.payment_bulk_send import PaymentBulkSend +from cobo_waas2.models.payment_bulk_send_event import PaymentBulkSendEvent +from cobo_waas2.models.payment_bulk_send_execution_mode import PaymentBulkSendExecutionMode +from cobo_waas2.models.payment_bulk_send_item import PaymentBulkSendItem +from cobo_waas2.models.payment_bulk_send_item_status import PaymentBulkSendItemStatus +from cobo_waas2.models.payment_bulk_send_item_validation_status import PaymentBulkSendItemValidationStatus +from cobo_waas2.models.payment_bulk_send_status import PaymentBulkSendStatus from cobo_waas2.models.payment_estimate_fee import PaymentEstimateFee from cobo_waas2.models.payment_estimate_fee201_response import PaymentEstimateFee201Response from cobo_waas2.models.payment_estimate_fee_request import PaymentEstimateFeeRequest @@ -429,9 +440,8 @@ from cobo_waas2.models.payment_payout_detail import PaymentPayoutDetail from cobo_waas2.models.payment_payout_event import PaymentPayoutEvent from cobo_waas2.models.payment_payout_item import PaymentPayoutItem -from cobo_waas2.models.payment_payout_item_detail import PaymentPayoutItemDetail -from cobo_waas2.models.payment_payout_item_status import PaymentPayoutItemStatus from cobo_waas2.models.payment_payout_param import PaymentPayoutParam +from cobo_waas2.models.payment_payout_recipient_info import PaymentPayoutRecipientInfo from cobo_waas2.models.payment_payout_status import PaymentPayoutStatus from cobo_waas2.models.payment_refund_event_data import PaymentRefundEventData from cobo_waas2.models.payment_settlement_event import PaymentSettlementEvent @@ -760,6 +770,7 @@ from cobo_waas2.models.transaction_utxo import TransactionUtxo from cobo_waas2.models.transaction_utxo_change import TransactionUtxoChange from cobo_waas2.models.transaction_utxo_fee import TransactionUtxoFee +from cobo_waas2.models.transaction_wallet_connect_info import TransactionWalletConnectInfo from cobo_waas2.models.transaction_webhook_event_data import TransactionWebhookEventData from cobo_waas2.models.transfer_destination import TransferDestination from cobo_waas2.models.transfer_destination_type import TransferDestinationType diff --git a/cobo_waas2/models/addresses_event_data.py b/cobo_waas2/models/addresses_event_data.py index 4101363e..c37009bc 100644 --- a/cobo_waas2/models/addresses_event_data.py +++ b/cobo_waas2/models/addresses_event_data.py @@ -26,15 +26,15 @@ class AddressesEventData(BaseModel): """ AddressesEventData """ # noqa: E501 - data_type: StrictStr = Field(description=" The data type of the event. - `Transaction`: The transaction event data. - `TSSRequest`: The TSS request event data. - `Addresses`: The addresses event data. - `WalletInfo`: The wallet information event data. - `MPCVault`: The MPC vault event data. - `Chains`: The enabled chain event data. - `Tokens`: The enabled token event data. - `TokenListing`: The token listing event data. - `PaymentOrder`: The payment order event data. - `PaymentRefund`: The payment refund event data. - `PaymentSettlement`: The payment settlement event data. - `PaymentTransaction`: The payment transaction event data. - `PaymentAddressUpdate`: The top-up address update event data. - `PaymentPayout`: The payment payout event data. - `BalanceUpdateInfo`: The balance update event data. - `SuspendedToken`: The token suspension event data. - `ComplianceDisposition`: The compliance disposition event data. - `ComplianceKytScreenings`: The compliance KYT screenings event data. - `ComplianceKyaScreenings`: The compliance KYA screenings event data.") + data_type: StrictStr = Field(description=" The data type of the event. - `Transaction`: The transaction event data. - `TSSRequest`: The TSS request event data. - `Addresses`: The addresses event data. - `WalletInfo`: The wallet information event data. - `MPCVault`: The MPC vault event data. - `Chains`: The enabled chain event data. - `Tokens`: The enabled token event data. - `TokenListing`: The token listing event data. - `PaymentOrder`: The payment order event data. - `PaymentRefund`: The payment refund event data. - `PaymentSettlement`: The payment settlement event data. - `PaymentTransaction`: The payment transaction event data. - `PaymentAddressUpdate`: The top-up address update event data. - `PaymentPayout`: The payment payout event data. - `PaymentBulkSend`: The payment bulk send event data. - `BalanceUpdateInfo`: The balance update event data. - `SuspendedToken`: The token suspension event data. - `ComplianceDisposition`: The compliance disposition event data. - `ComplianceKytScreenings`: The compliance KYT screenings event data. - `ComplianceKyaScreenings`: The compliance KYA screenings event data.") addresses: Optional[List[AddressesEventDataAllOfAddresses]] = Field(default=None, description="A list of addresses.") __properties: ClassVar[List[str]] = ["data_type", "addresses"] @field_validator('data_type') def data_type_validate_enum(cls, value): """Validates the enum""" - if value not in set(['Transaction', 'TSSRequest', 'Addresses', 'WalletInfo', 'MPCVault', 'Chains', 'Tokens', 'TokenListing', 'PaymentOrder', 'PaymentRefund', 'PaymentSettlement', 'PaymentTransaction', 'PaymentAddressUpdate', 'PaymentPayout', 'BalanceUpdateInfo', 'SuspendedToken', 'ComplianceDisposition', 'ComplianceKytScreenings', 'ComplianceKyaScreenings']): - raise ValueError("must be one of enum values ('Transaction', 'TSSRequest', 'Addresses', 'WalletInfo', 'MPCVault', 'Chains', 'Tokens', 'TokenListing', 'PaymentOrder', 'PaymentRefund', 'PaymentSettlement', 'PaymentTransaction', 'PaymentAddressUpdate', 'PaymentPayout', 'BalanceUpdateInfo', 'SuspendedToken', 'ComplianceDisposition', 'ComplianceKytScreenings', 'ComplianceKyaScreenings')") + if value not in set(['Transaction', 'TSSRequest', 'Addresses', 'WalletInfo', 'MPCVault', 'Chains', 'Tokens', 'TokenListing', 'PaymentOrder', 'PaymentRefund', 'PaymentSettlement', 'PaymentTransaction', 'PaymentAddressUpdate', 'PaymentPayout', 'PaymentBulkSend', 'BalanceUpdateInfo', 'SuspendedToken', 'ComplianceDisposition', 'ComplianceKytScreenings', 'ComplianceKyaScreenings']): + raise ValueError("must be one of enum values ('Transaction', 'TSSRequest', 'Addresses', 'WalletInfo', 'MPCVault', 'Chains', 'Tokens', 'TokenListing', 'PaymentOrder', 'PaymentRefund', 'PaymentSettlement', 'PaymentTransaction', 'PaymentAddressUpdate', 'PaymentPayout', 'PaymentBulkSend', 'BalanceUpdateInfo', 'SuspendedToken', 'ComplianceDisposition', 'ComplianceKytScreenings', 'ComplianceKyaScreenings')") return value model_config = ConfigDict( diff --git a/cobo_waas2/models/allocation_record.py b/cobo_waas2/models/allocation_item.py similarity index 66% rename from cobo_waas2/models/allocation_record.py rename to cobo_waas2/models/allocation_item.py index 78358378..29443392 100644 --- a/cobo_waas2/models/allocation_record.py +++ b/cobo_waas2/models/allocation_item.py @@ -21,18 +21,18 @@ from typing_extensions import Self -class AllocationRecord(BaseModel): +class AllocationItem(BaseModel): """ - AllocationRecord + AllocationItem """ # noqa: E501 - allocation_record_id: StrictStr = Field(description="The allocation record ID generated by Cobo.") + allocation_item_id: StrictStr = Field(description="The allocation item ID generated by Cobo.") batch_allocation_id: StrictStr = Field(description="The batch allocation ID generated by Cobo.") - token_id: StrictStr = Field(description="The ID of the cryptocurrency to allocate. Supported values: - USDC: `ETH_USDC`, `ARBITRUM_USDC`, `SOL_USDC`, `BASE_USDC`, `MATIC_USDC`, `BSC_USDC` - USDT: `TRON_USDT`, `ETH_USDT`, `ARBITRUM_USDT`, `SOL_USDT`, `BASE_USDT`, `MATIC_USDT`, `BSC_USDT` ") - amount: StrictStr = Field(description="The amount of the cryptocurrency to allocate. ") - source_account: Optional[StrictStr] = Field(default=None, description="The source account.") - destination_account: Optional[StrictStr] = Field(default=None, description="The destination account.") - description: StrictStr = Field(description="The description of the allocation record.") - __properties: ClassVar[List[str]] = ["allocation_record_id", "batch_allocation_id", "token_id", "amount", "source_account", "destination_account", "description"] + token_id: StrictStr = Field(description="The ID of the cryptocurrency you want to allocation. Supported values: - USDC: `ETH_USDC`, `ARBITRUM_USDC`, `SOL_USDC`, `BASE_USDC`, `MATIC_USDC`, `BSC_USDC` - USDT: `TRON_USDT`, `ETH_USDT`, `ARBITRUM_USDT`, `SOL_USDT`, `BASE_USDT`, `MATIC_USDT`, `BSC_USDT` ") + amount: StrictStr = Field(description="The allocation amount. ") + source_account: Optional[StrictStr] = Field(default=None, description="The source account from which the allocation will be deducted. - If the source account is a merchant account, provide the merchant's ID (e.g., \"M1001\"). - If the source account is the developer account, use the string `\"developer\"`. ") + destination_account: Optional[StrictStr] = Field(default=None, description="The destination account to which the allocation will be credited. - If the destination account is a merchant account, provide the merchant's ID (e.g., \"M1001\"). - If the destination account is the developer account, use the string `\"developer\"`. ") + description: StrictStr = Field(description="The description of the allocation item.") + __properties: ClassVar[List[str]] = ["allocation_item_id", "batch_allocation_id", "token_id", "amount", "source_account", "destination_account", "description"] model_config = ConfigDict( populate_by_name=True, @@ -52,7 +52,7 @@ def to_json(self) -> str: @classmethod def from_json(cls, json_str: str) -> Optional[Self]: - """Create an instance of AllocationRecord from a JSON string""" + """Create an instance of AllocationItem from a JSON string""" return cls.from_dict(json.loads(json_str)) def to_dict(self) -> Dict[str, Any]: @@ -77,7 +77,7 @@ def to_dict(self) -> Dict[str, Any]: @classmethod def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: - """Create an instance of AllocationRecord from a dict""" + """Create an instance of AllocationItem from a dict""" if obj is None: return None @@ -85,7 +85,7 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: return cls.model_validate(obj) _obj = cls.model_validate({ - "allocation_record_id": obj.get("allocation_record_id"), + "allocation_item_id": obj.get("allocation_item_id"), "batch_allocation_id": obj.get("batch_allocation_id"), "token_id": obj.get("token_id"), "amount": obj.get("amount"), diff --git a/cobo_waas2/models/allocation_request.py b/cobo_waas2/models/allocation_param.py similarity index 73% rename from cobo_waas2/models/allocation_request.py rename to cobo_waas2/models/allocation_param.py index 3e98d997..9ba29cf5 100644 --- a/cobo_waas2/models/allocation_request.py +++ b/cobo_waas2/models/allocation_param.py @@ -21,15 +21,15 @@ from typing_extensions import Self -class AllocationRequest(BaseModel): +class AllocationParam(BaseModel): """ - AllocationRequest + AllocationParam """ # noqa: E501 - token_id: StrictStr = Field(description="The ID of the cryptocurrency you want to allocate. Supported values: - USDC: `ETH_USDC`, `ARBITRUM_USDC`, `SOL_USDC`, `BASE_USDC`, `MATIC_USDC`, `BSC_USDC` - USDT: `TRON_USDT`, `ETH_USDT`, `ARBITRUM_USDT`, `SOL_USDT`, `BASE_USDT`, `MATIC_USDT`, `BSC_USDT` ") - amount: StrictStr = Field(description="The amount of the cryptocurrency you want to allocate. ") - source_account: StrictStr = Field(description="The source account. - If the source account is a merchant account, provide the merchant's ID (e.g., \"M1001\"). - If the source account is the developer account, use the string `\"developer\"`. ") - destination_account: StrictStr = Field(description="The destination account. - If the destination account is a merchant account, provide the merchant's ID (e.g., \"M1001\"). - If the destination account is the developer account, use the string `\"developer\"`. ") - description: StrictStr = Field(description="The description of the allocation request.") + token_id: StrictStr = Field(description="The ID of the cryptocurrency you want to allocation. Supported values: - USDC: `ETH_USDC`, `ARBITRUM_USDC`, `SOL_USDC`, `BASE_USDC`, `MATIC_USDC`, `BSC_USDC` - USDT: `TRON_USDT`, `ETH_USDT`, `ARBITRUM_USDT`, `SOL_USDT`, `BASE_USDT`, `MATIC_USDT`, `BSC_USDT` ") + amount: StrictStr = Field(description="The allocation amount. ") + source_account: StrictStr = Field(description="The source account from which the allocation will be deducted. - If the source account is a merchant account, provide the merchant's ID (e.g., \"M1001\"). - If the source account is the developer account, use the string `\"developer\"`. ") + destination_account: StrictStr = Field(description="The destination account to which the allocation will be credited. - If the destination account is a merchant account, provide the merchant's ID (e.g., \"M1001\"). - If the destination account is the developer account, use the string `\"developer\"`. ") + description: StrictStr = Field(description="The description of the allocation.") __properties: ClassVar[List[str]] = ["token_id", "amount", "source_account", "destination_account", "description"] model_config = ConfigDict( @@ -50,7 +50,7 @@ def to_json(self) -> str: @classmethod def from_json(cls, json_str: str) -> Optional[Self]: - """Create an instance of AllocationRequest from a JSON string""" + """Create an instance of AllocationParam from a JSON string""" return cls.from_dict(json.loads(json_str)) def to_dict(self) -> Dict[str, Any]: @@ -75,7 +75,7 @@ def to_dict(self) -> Dict[str, Any]: @classmethod def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: - """Create an instance of AllocationRequest from a dict""" + """Create an instance of AllocationParam from a dict""" if obj is None: return None diff --git a/cobo_waas2/models/balance_update_info_event_data.py b/cobo_waas2/models/balance_update_info_event_data.py index 3f9ef901..43ccfbe7 100644 --- a/cobo_waas2/models/balance_update_info_event_data.py +++ b/cobo_waas2/models/balance_update_info_event_data.py @@ -26,7 +26,7 @@ class BalanceUpdateInfoEventData(BaseModel): """ BalanceUpdateInfoEventData """ # noqa: E501 - data_type: StrictStr = Field(description=" The data type of the event. - `Transaction`: The transaction event data. - `TSSRequest`: The TSS request event data. - `Addresses`: The addresses event data. - `WalletInfo`: The wallet information event data. - `MPCVault`: The MPC vault event data. - `Chains`: The enabled chain event data. - `Tokens`: The enabled token event data. - `TokenListing`: The token listing event data. - `PaymentOrder`: The payment order event data. - `PaymentRefund`: The payment refund event data. - `PaymentSettlement`: The payment settlement event data. - `PaymentTransaction`: The payment transaction event data. - `PaymentAddressUpdate`: The top-up address update event data. - `PaymentPayout`: The payment payout event data. - `BalanceUpdateInfo`: The balance update event data. - `SuspendedToken`: The token suspension event data. - `ComplianceDisposition`: The compliance disposition event data. - `ComplianceKytScreenings`: The compliance KYT screenings event data. - `ComplianceKyaScreenings`: The compliance KYA screenings event data.") + data_type: StrictStr = Field(description=" The data type of the event. - `Transaction`: The transaction event data. - `TSSRequest`: The TSS request event data. - `Addresses`: The addresses event data. - `WalletInfo`: The wallet information event data. - `MPCVault`: The MPC vault event data. - `Chains`: The enabled chain event data. - `Tokens`: The enabled token event data. - `TokenListing`: The token listing event data. - `PaymentOrder`: The payment order event data. - `PaymentRefund`: The payment refund event data. - `PaymentSettlement`: The payment settlement event data. - `PaymentTransaction`: The payment transaction event data. - `PaymentAddressUpdate`: The top-up address update event data. - `PaymentPayout`: The payment payout event data. - `PaymentBulkSend`: The payment bulk send event data. - `BalanceUpdateInfo`: The balance update event data. - `SuspendedToken`: The token suspension event data. - `ComplianceDisposition`: The compliance disposition event data. - `ComplianceKytScreenings`: The compliance KYT screenings event data. - `ComplianceKyaScreenings`: The compliance KYA screenings event data.") token_id: StrictStr = Field(description="The token ID, which is the unique identifier of a token. You can retrieve the IDs of all the tokens you can use by calling [List enabled tokens](https://www.cobo.com/developers/v2/api-references/wallets/list-enabled-tokens).") address: StrictStr = Field(description="The wallet address.") wallet_uuid: StrictStr = Field(description="The wallet ID.") @@ -37,8 +37,8 @@ class BalanceUpdateInfoEventData(BaseModel): @field_validator('data_type') def data_type_validate_enum(cls, value): """Validates the enum""" - if value not in set(['Transaction', 'TSSRequest', 'Addresses', 'WalletInfo', 'MPCVault', 'Chains', 'Tokens', 'TokenListing', 'PaymentOrder', 'PaymentRefund', 'PaymentSettlement', 'PaymentTransaction', 'PaymentAddressUpdate', 'PaymentPayout', 'BalanceUpdateInfo', 'SuspendedToken', 'ComplianceDisposition', 'ComplianceKytScreenings', 'ComplianceKyaScreenings']): - raise ValueError("must be one of enum values ('Transaction', 'TSSRequest', 'Addresses', 'WalletInfo', 'MPCVault', 'Chains', 'Tokens', 'TokenListing', 'PaymentOrder', 'PaymentRefund', 'PaymentSettlement', 'PaymentTransaction', 'PaymentAddressUpdate', 'PaymentPayout', 'BalanceUpdateInfo', 'SuspendedToken', 'ComplianceDisposition', 'ComplianceKytScreenings', 'ComplianceKyaScreenings')") + if value not in set(['Transaction', 'TSSRequest', 'Addresses', 'WalletInfo', 'MPCVault', 'Chains', 'Tokens', 'TokenListing', 'PaymentOrder', 'PaymentRefund', 'PaymentSettlement', 'PaymentTransaction', 'PaymentAddressUpdate', 'PaymentPayout', 'PaymentBulkSend', 'BalanceUpdateInfo', 'SuspendedToken', 'ComplianceDisposition', 'ComplianceKytScreenings', 'ComplianceKyaScreenings']): + raise ValueError("must be one of enum values ('Transaction', 'TSSRequest', 'Addresses', 'WalletInfo', 'MPCVault', 'Chains', 'Tokens', 'TokenListing', 'PaymentOrder', 'PaymentRefund', 'PaymentSettlement', 'PaymentTransaction', 'PaymentAddressUpdate', 'PaymentPayout', 'PaymentBulkSend', 'BalanceUpdateInfo', 'SuspendedToken', 'ComplianceDisposition', 'ComplianceKytScreenings', 'ComplianceKyaScreenings')") return value model_config = ConfigDict( diff --git a/cobo_waas2/models/batch_allocation.py b/cobo_waas2/models/batch_allocation.py index 9049bfca..221a4ce7 100644 --- a/cobo_waas2/models/batch_allocation.py +++ b/cobo_waas2/models/batch_allocation.py @@ -17,7 +17,7 @@ from pydantic import BaseModel, ConfigDict, Field, StrictInt, StrictStr from typing import Any, ClassVar, Dict, List, Optional -from cobo_waas2.models.allocation_request import AllocationRequest +from cobo_waas2.models.allocation_param import AllocationParam from typing import Optional, Set from typing_extensions import Self @@ -28,11 +28,11 @@ class BatchAllocation(BaseModel): """ # noqa: E501 batch_allocation_id: StrictStr = Field(description="The batch allocation ID generated by Cobo.") request_id: StrictStr = Field(description="The request ID provided by you when creating the batch allocation.") - allocation_requests: Optional[List[AllocationRequest]] = None + allocation_params: Optional[List[AllocationParam]] = None initiator: Optional[StrictStr] = Field(default=None, description="The initiator of this batch allocation, usually the API key you used to create the batch allocation.") created_timestamp: StrictInt = Field(description="The created time of the batch allocation, represented as a UNIX timestamp in seconds.") updated_timestamp: StrictInt = Field(description="The updated time of the batch allocation, represented as a UNIX timestamp in seconds.") - __properties: ClassVar[List[str]] = ["batch_allocation_id", "request_id", "allocation_requests", "initiator", "created_timestamp", "updated_timestamp"] + __properties: ClassVar[List[str]] = ["batch_allocation_id", "request_id", "allocation_params", "initiator", "created_timestamp", "updated_timestamp"] model_config = ConfigDict( populate_by_name=True, @@ -73,13 +73,13 @@ def to_dict(self) -> Dict[str, Any]: exclude=excluded_fields, exclude_none=True, ) - # override the default output from pydantic by calling `to_dict()` of each item in allocation_requests (list) + # override the default output from pydantic by calling `to_dict()` of each item in allocation_params (list) _items = [] - if self.allocation_requests: - for _item in self.allocation_requests: + if self.allocation_params: + for _item in self.allocation_params: if _item: _items.append(_item.to_dict()) - _dict['allocation_requests'] = _items + _dict['allocation_params'] = _items return _dict @classmethod @@ -94,7 +94,7 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: _obj = cls.model_validate({ "batch_allocation_id": obj.get("batch_allocation_id"), "request_id": obj.get("request_id"), - "allocation_requests": [AllocationRequest.from_dict(_item) for _item in obj["allocation_requests"]] if obj.get("allocation_requests") is not None else None, + "allocation_params": [AllocationParam.from_dict(_item) for _item in obj["allocation_params"]] if obj.get("allocation_params") is not None else None, "initiator": obj.get("initiator"), "created_timestamp": obj.get("created_timestamp"), "updated_timestamp": obj.get("updated_timestamp") diff --git a/cobo_waas2/models/batch_allocation_detail.py b/cobo_waas2/models/batch_allocation_detail.py index db94b565..eb7cc0a6 100644 --- a/cobo_waas2/models/batch_allocation_detail.py +++ b/cobo_waas2/models/batch_allocation_detail.py @@ -17,7 +17,7 @@ from pydantic import BaseModel, ConfigDict, Field, StrictInt, StrictStr from typing import Any, ClassVar, Dict, List, Optional -from cobo_waas2.models.allocation_record import AllocationRecord +from cobo_waas2.models.allocation_item import AllocationItem from typing import Optional, Set from typing_extensions import Self @@ -28,11 +28,11 @@ class BatchAllocationDetail(BaseModel): """ # noqa: E501 batch_allocation_id: StrictStr = Field(description="The batch allocation ID generated by Cobo.") request_id: StrictStr = Field(description="The request ID provided by you when creating the batch allocation.") - allocation_records: List[AllocationRecord] + allocation_items: Optional[List[AllocationItem]] = None initiator: Optional[StrictStr] = Field(default=None, description="The initiator of this batch allocation, usually the user's API key.") created_timestamp: Optional[StrictInt] = Field(default=None, description="The created time of the batch allocation, represented as a UNIX timestamp in seconds.") updated_timestamp: Optional[StrictInt] = Field(default=None, description="The updated time of the batch allocation, represented as a UNIX timestamp in seconds.") - __properties: ClassVar[List[str]] = ["batch_allocation_id", "request_id", "allocation_records", "initiator", "created_timestamp", "updated_timestamp"] + __properties: ClassVar[List[str]] = ["batch_allocation_id", "request_id", "allocation_items", "initiator", "created_timestamp", "updated_timestamp"] model_config = ConfigDict( populate_by_name=True, @@ -73,13 +73,13 @@ def to_dict(self) -> Dict[str, Any]: exclude=excluded_fields, exclude_none=True, ) - # override the default output from pydantic by calling `to_dict()` of each item in allocation_records (list) + # override the default output from pydantic by calling `to_dict()` of each item in allocation_items (list) _items = [] - if self.allocation_records: - for _item in self.allocation_records: + if self.allocation_items: + for _item in self.allocation_items: if _item: _items.append(_item.to_dict()) - _dict['allocation_records'] = _items + _dict['allocation_items'] = _items return _dict @classmethod @@ -94,7 +94,7 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: _obj = cls.model_validate({ "batch_allocation_id": obj.get("batch_allocation_id"), "request_id": obj.get("request_id"), - "allocation_records": [AllocationRecord.from_dict(_item) for _item in obj["allocation_records"]] if obj.get("allocation_records") is not None else None, + "allocation_items": [AllocationItem.from_dict(_item) for _item in obj["allocation_items"]] if obj.get("allocation_items") is not None else None, "initiator": obj.get("initiator"), "created_timestamp": obj.get("created_timestamp"), "updated_timestamp": obj.get("updated_timestamp") diff --git a/cobo_waas2/models/bridging_fee.py b/cobo_waas2/models/bridging_fee.py index dab4376d..91048747 100644 --- a/cobo_waas2/models/bridging_fee.py +++ b/cobo_waas2/models/bridging_fee.py @@ -25,9 +25,9 @@ class BridgingFee(BaseModel): """ BridgingFee """ # noqa: E501 - fee_amount: StrictStr = Field(description="The fee charged for bridging tokens to another blockchain during an off-ramp operation. Bridging fees apply when tokens are on a blockchain not directly supported by the off-ramp service. ") + fee_amount: StrictStr = Field(description="The fee charged for bridging tokens to another chain. ") received_token_id: Optional[StrictStr] = Field(default=None, description="The ID of the destination token received after bridging.") - received_amount: Optional[StrictStr] = Field(default=None, description="The final amount of destination tokens received after bridging.") + received_amount: Optional[StrictStr] = Field(default=None, description="The final amount of the token received after bridging.") __properties: ClassVar[List[str]] = ["fee_amount", "received_token_id", "received_amount"] model_config = ConfigDict( diff --git a/cobo_waas2/models/chains_event_data.py b/cobo_waas2/models/chains_event_data.py index c0d4dd34..22adccfe 100644 --- a/cobo_waas2/models/chains_event_data.py +++ b/cobo_waas2/models/chains_event_data.py @@ -28,7 +28,7 @@ class ChainsEventData(BaseModel): """ ChainsEventData """ # noqa: E501 - data_type: StrictStr = Field(description=" The data type of the event. - `Transaction`: The transaction event data. - `TSSRequest`: The TSS request event data. - `Addresses`: The addresses event data. - `WalletInfo`: The wallet information event data. - `MPCVault`: The MPC vault event data. - `Chains`: The enabled chain event data. - `Tokens`: The enabled token event data. - `TokenListing`: The token listing event data. - `PaymentOrder`: The payment order event data. - `PaymentRefund`: The payment refund event data. - `PaymentSettlement`: The payment settlement event data. - `PaymentTransaction`: The payment transaction event data. - `PaymentAddressUpdate`: The top-up address update event data. - `PaymentPayout`: The payment payout event data. - `BalanceUpdateInfo`: The balance update event data. - `SuspendedToken`: The token suspension event data. - `ComplianceDisposition`: The compliance disposition event data. - `ComplianceKytScreenings`: The compliance KYT screenings event data. - `ComplianceKyaScreenings`: The compliance KYA screenings event data.") + data_type: StrictStr = Field(description=" The data type of the event. - `Transaction`: The transaction event data. - `TSSRequest`: The TSS request event data. - `Addresses`: The addresses event data. - `WalletInfo`: The wallet information event data. - `MPCVault`: The MPC vault event data. - `Chains`: The enabled chain event data. - `Tokens`: The enabled token event data. - `TokenListing`: The token listing event data. - `PaymentOrder`: The payment order event data. - `PaymentRefund`: The payment refund event data. - `PaymentSettlement`: The payment settlement event data. - `PaymentTransaction`: The payment transaction event data. - `PaymentAddressUpdate`: The top-up address update event data. - `PaymentPayout`: The payment payout event data. - `PaymentBulkSend`: The payment bulk send event data. - `BalanceUpdateInfo`: The balance update event data. - `SuspendedToken`: The token suspension event data. - `ComplianceDisposition`: The compliance disposition event data. - `ComplianceKytScreenings`: The compliance KYT screenings event data. - `ComplianceKyaScreenings`: The compliance KYA screenings event data.") chains: List[ChainInfo] = Field(description="The enabled chains.") wallet_type: Optional[WalletType] = None wallet_subtypes: Optional[List[WalletSubtype]] = None @@ -37,8 +37,8 @@ class ChainsEventData(BaseModel): @field_validator('data_type') def data_type_validate_enum(cls, value): """Validates the enum""" - if value not in set(['Transaction', 'TSSRequest', 'Addresses', 'WalletInfo', 'MPCVault', 'Chains', 'Tokens', 'TokenListing', 'PaymentOrder', 'PaymentRefund', 'PaymentSettlement', 'PaymentTransaction', 'PaymentAddressUpdate', 'PaymentPayout', 'BalanceUpdateInfo', 'SuspendedToken', 'ComplianceDisposition', 'ComplianceKytScreenings', 'ComplianceKyaScreenings']): - raise ValueError("must be one of enum values ('Transaction', 'TSSRequest', 'Addresses', 'WalletInfo', 'MPCVault', 'Chains', 'Tokens', 'TokenListing', 'PaymentOrder', 'PaymentRefund', 'PaymentSettlement', 'PaymentTransaction', 'PaymentAddressUpdate', 'PaymentPayout', 'BalanceUpdateInfo', 'SuspendedToken', 'ComplianceDisposition', 'ComplianceKytScreenings', 'ComplianceKyaScreenings')") + if value not in set(['Transaction', 'TSSRequest', 'Addresses', 'WalletInfo', 'MPCVault', 'Chains', 'Tokens', 'TokenListing', 'PaymentOrder', 'PaymentRefund', 'PaymentSettlement', 'PaymentTransaction', 'PaymentAddressUpdate', 'PaymentPayout', 'PaymentBulkSend', 'BalanceUpdateInfo', 'SuspendedToken', 'ComplianceDisposition', 'ComplianceKytScreenings', 'ComplianceKyaScreenings']): + raise ValueError("must be one of enum values ('Transaction', 'TSSRequest', 'Addresses', 'WalletInfo', 'MPCVault', 'Chains', 'Tokens', 'TokenListing', 'PaymentOrder', 'PaymentRefund', 'PaymentSettlement', 'PaymentTransaction', 'PaymentAddressUpdate', 'PaymentPayout', 'PaymentBulkSend', 'BalanceUpdateInfo', 'SuspendedToken', 'ComplianceDisposition', 'ComplianceKytScreenings', 'ComplianceKyaScreenings')") return value model_config = ConfigDict( diff --git a/cobo_waas2/models/compliance_disposition_update_event_data.py b/cobo_waas2/models/compliance_disposition_update_event_data.py index 48bcaa30..c7dbcc0d 100644 --- a/cobo_waas2/models/compliance_disposition_update_event_data.py +++ b/cobo_waas2/models/compliance_disposition_update_event_data.py @@ -27,7 +27,7 @@ class ComplianceDispositionUpdateEventData(BaseModel): """ ComplianceDispositionUpdateEventData """ # noqa: E501 - data_type: StrictStr = Field(description=" The data type of the event. - `Transaction`: The transaction event data. - `TSSRequest`: The TSS request event data. - `Addresses`: The addresses event data. - `WalletInfo`: The wallet information event data. - `MPCVault`: The MPC vault event data. - `Chains`: The enabled chain event data. - `Tokens`: The enabled token event data. - `TokenListing`: The token listing event data. - `PaymentOrder`: The payment order event data. - `PaymentRefund`: The payment refund event data. - `PaymentSettlement`: The payment settlement event data. - `PaymentTransaction`: The payment transaction event data. - `PaymentAddressUpdate`: The top-up address update event data. - `PaymentPayout`: The payment payout event data. - `BalanceUpdateInfo`: The balance update event data. - `SuspendedToken`: The token suspension event data. - `ComplianceDisposition`: The compliance disposition event data. - `ComplianceKytScreenings`: The compliance KYT screenings event data. - `ComplianceKyaScreenings`: The compliance KYA screenings event data.") + data_type: StrictStr = Field(description=" The data type of the event. - `Transaction`: The transaction event data. - `TSSRequest`: The TSS request event data. - `Addresses`: The addresses event data. - `WalletInfo`: The wallet information event data. - `MPCVault`: The MPC vault event data. - `Chains`: The enabled chain event data. - `Tokens`: The enabled token event data. - `TokenListing`: The token listing event data. - `PaymentOrder`: The payment order event data. - `PaymentRefund`: The payment refund event data. - `PaymentSettlement`: The payment settlement event data. - `PaymentTransaction`: The payment transaction event data. - `PaymentAddressUpdate`: The top-up address update event data. - `PaymentPayout`: The payment payout event data. - `PaymentBulkSend`: The payment bulk send event data. - `BalanceUpdateInfo`: The balance update event data. - `SuspendedToken`: The token suspension event data. - `ComplianceDisposition`: The compliance disposition event data. - `ComplianceKytScreenings`: The compliance KYT screenings event data. - `ComplianceKyaScreenings`: The compliance KYA screenings event data.") transaction_id: StrictStr = Field(description="The transaction ID.") disposition_type: DispositionType disposition_status: DispositionStatus @@ -39,8 +39,8 @@ class ComplianceDispositionUpdateEventData(BaseModel): @field_validator('data_type') def data_type_validate_enum(cls, value): """Validates the enum""" - if value not in set(['Transaction', 'TSSRequest', 'Addresses', 'WalletInfo', 'MPCVault', 'Chains', 'Tokens', 'TokenListing', 'PaymentOrder', 'PaymentRefund', 'PaymentSettlement', 'PaymentTransaction', 'PaymentAddressUpdate', 'PaymentPayout', 'BalanceUpdateInfo', 'SuspendedToken', 'ComplianceDisposition', 'ComplianceKytScreenings', 'ComplianceKyaScreenings']): - raise ValueError("must be one of enum values ('Transaction', 'TSSRequest', 'Addresses', 'WalletInfo', 'MPCVault', 'Chains', 'Tokens', 'TokenListing', 'PaymentOrder', 'PaymentRefund', 'PaymentSettlement', 'PaymentTransaction', 'PaymentAddressUpdate', 'PaymentPayout', 'BalanceUpdateInfo', 'SuspendedToken', 'ComplianceDisposition', 'ComplianceKytScreenings', 'ComplianceKyaScreenings')") + if value not in set(['Transaction', 'TSSRequest', 'Addresses', 'WalletInfo', 'MPCVault', 'Chains', 'Tokens', 'TokenListing', 'PaymentOrder', 'PaymentRefund', 'PaymentSettlement', 'PaymentTransaction', 'PaymentAddressUpdate', 'PaymentPayout', 'PaymentBulkSend', 'BalanceUpdateInfo', 'SuspendedToken', 'ComplianceDisposition', 'ComplianceKytScreenings', 'ComplianceKyaScreenings']): + raise ValueError("must be one of enum values ('Transaction', 'TSSRequest', 'Addresses', 'WalletInfo', 'MPCVault', 'Chains', 'Tokens', 'TokenListing', 'PaymentOrder', 'PaymentRefund', 'PaymentSettlement', 'PaymentTransaction', 'PaymentAddressUpdate', 'PaymentPayout', 'PaymentBulkSend', 'BalanceUpdateInfo', 'SuspendedToken', 'ComplianceDisposition', 'ComplianceKytScreenings', 'ComplianceKyaScreenings')") return value model_config = ConfigDict( diff --git a/cobo_waas2/models/compliance_kya_screenings_update_event_data.py b/cobo_waas2/models/compliance_kya_screenings_update_event_data.py index f11b452b..61b4eda2 100644 --- a/cobo_waas2/models/compliance_kya_screenings_update_event_data.py +++ b/cobo_waas2/models/compliance_kya_screenings_update_event_data.py @@ -26,7 +26,7 @@ class ComplianceKyaScreeningsUpdateEventData(BaseModel): """ ComplianceKyaScreeningsUpdateEventData """ # noqa: E501 - data_type: StrictStr = Field(description=" The data type of the event. - `Transaction`: The transaction event data. - `TSSRequest`: The TSS request event data. - `Addresses`: The addresses event data. - `WalletInfo`: The wallet information event data. - `MPCVault`: The MPC vault event data. - `Chains`: The enabled chain event data. - `Tokens`: The enabled token event data. - `TokenListing`: The token listing event data. - `PaymentOrder`: The payment order event data. - `PaymentRefund`: The payment refund event data. - `PaymentSettlement`: The payment settlement event data. - `PaymentTransaction`: The payment transaction event data. - `PaymentAddressUpdate`: The top-up address update event data. - `PaymentPayout`: The payment payout event data. - `BalanceUpdateInfo`: The balance update event data. - `SuspendedToken`: The token suspension event data. - `ComplianceDisposition`: The compliance disposition event data. - `ComplianceKytScreenings`: The compliance KYT screenings event data. - `ComplianceKyaScreenings`: The compliance KYA screenings event data.") + data_type: StrictStr = Field(description=" The data type of the event. - `Transaction`: The transaction event data. - `TSSRequest`: The TSS request event data. - `Addresses`: The addresses event data. - `WalletInfo`: The wallet information event data. - `MPCVault`: The MPC vault event data. - `Chains`: The enabled chain event data. - `Tokens`: The enabled token event data. - `TokenListing`: The token listing event data. - `PaymentOrder`: The payment order event data. - `PaymentRefund`: The payment refund event data. - `PaymentSettlement`: The payment settlement event data. - `PaymentTransaction`: The payment transaction event data. - `PaymentAddressUpdate`: The top-up address update event data. - `PaymentPayout`: The payment payout event data. - `PaymentBulkSend`: The payment bulk send event data. - `BalanceUpdateInfo`: The balance update event data. - `SuspendedToken`: The token suspension event data. - `ComplianceDisposition`: The compliance disposition event data. - `ComplianceKytScreenings`: The compliance KYT screenings event data. - `ComplianceKyaScreenings`: The compliance KYA screenings event data.") screening_id: StrictStr = Field(description="The unique system-generated identifier for this screening request (UUID format, fixed 36 characters).") address: StrictStr = Field(description="The screened blockchain address.") chain_id: StrictStr = Field(description="The chain identifier.") @@ -38,8 +38,8 @@ class ComplianceKyaScreeningsUpdateEventData(BaseModel): @field_validator('data_type') def data_type_validate_enum(cls, value): """Validates the enum""" - if value not in set(['Transaction', 'TSSRequest', 'Addresses', 'WalletInfo', 'MPCVault', 'Chains', 'Tokens', 'TokenListing', 'PaymentOrder', 'PaymentRefund', 'PaymentSettlement', 'PaymentTransaction', 'PaymentAddressUpdate', 'PaymentPayout', 'BalanceUpdateInfo', 'SuspendedToken', 'ComplianceDisposition', 'ComplianceKytScreenings', 'ComplianceKyaScreenings']): - raise ValueError("must be one of enum values ('Transaction', 'TSSRequest', 'Addresses', 'WalletInfo', 'MPCVault', 'Chains', 'Tokens', 'TokenListing', 'PaymentOrder', 'PaymentRefund', 'PaymentSettlement', 'PaymentTransaction', 'PaymentAddressUpdate', 'PaymentPayout', 'BalanceUpdateInfo', 'SuspendedToken', 'ComplianceDisposition', 'ComplianceKytScreenings', 'ComplianceKyaScreenings')") + if value not in set(['Transaction', 'TSSRequest', 'Addresses', 'WalletInfo', 'MPCVault', 'Chains', 'Tokens', 'TokenListing', 'PaymentOrder', 'PaymentRefund', 'PaymentSettlement', 'PaymentTransaction', 'PaymentAddressUpdate', 'PaymentPayout', 'PaymentBulkSend', 'BalanceUpdateInfo', 'SuspendedToken', 'ComplianceDisposition', 'ComplianceKytScreenings', 'ComplianceKyaScreenings']): + raise ValueError("must be one of enum values ('Transaction', 'TSSRequest', 'Addresses', 'WalletInfo', 'MPCVault', 'Chains', 'Tokens', 'TokenListing', 'PaymentOrder', 'PaymentRefund', 'PaymentSettlement', 'PaymentTransaction', 'PaymentAddressUpdate', 'PaymentPayout', 'PaymentBulkSend', 'BalanceUpdateInfo', 'SuspendedToken', 'ComplianceDisposition', 'ComplianceKytScreenings', 'ComplianceKyaScreenings')") return value model_config = ConfigDict( diff --git a/cobo_waas2/models/compliance_kyt_screenings_update_event_data.py b/cobo_waas2/models/compliance_kyt_screenings_update_event_data.py index 601668c0..2f062426 100644 --- a/cobo_waas2/models/compliance_kyt_screenings_update_event_data.py +++ b/cobo_waas2/models/compliance_kyt_screenings_update_event_data.py @@ -28,7 +28,7 @@ class ComplianceKytScreeningsUpdateEventData(BaseModel): """ ComplianceKytScreeningsUpdateEventData """ # noqa: E501 - data_type: StrictStr = Field(description=" The data type of the event. - `Transaction`: The transaction event data. - `TSSRequest`: The TSS request event data. - `Addresses`: The addresses event data. - `WalletInfo`: The wallet information event data. - `MPCVault`: The MPC vault event data. - `Chains`: The enabled chain event data. - `Tokens`: The enabled token event data. - `TokenListing`: The token listing event data. - `PaymentOrder`: The payment order event data. - `PaymentRefund`: The payment refund event data. - `PaymentSettlement`: The payment settlement event data. - `PaymentTransaction`: The payment transaction event data. - `PaymentAddressUpdate`: The top-up address update event data. - `PaymentPayout`: The payment payout event data. - `BalanceUpdateInfo`: The balance update event data. - `SuspendedToken`: The token suspension event data. - `ComplianceDisposition`: The compliance disposition event data. - `ComplianceKytScreenings`: The compliance KYT screenings event data. - `ComplianceKyaScreenings`: The compliance KYA screenings event data.") + data_type: StrictStr = Field(description=" The data type of the event. - `Transaction`: The transaction event data. - `TSSRequest`: The TSS request event data. - `Addresses`: The addresses event data. - `WalletInfo`: The wallet information event data. - `MPCVault`: The MPC vault event data. - `Chains`: The enabled chain event data. - `Tokens`: The enabled token event data. - `TokenListing`: The token listing event data. - `PaymentOrder`: The payment order event data. - `PaymentRefund`: The payment refund event data. - `PaymentSettlement`: The payment settlement event data. - `PaymentTransaction`: The payment transaction event data. - `PaymentAddressUpdate`: The top-up address update event data. - `PaymentPayout`: The payment payout event data. - `PaymentBulkSend`: The payment bulk send event data. - `BalanceUpdateInfo`: The balance update event data. - `SuspendedToken`: The token suspension event data. - `ComplianceDisposition`: The compliance disposition event data. - `ComplianceKytScreenings`: The compliance KYT screenings event data. - `ComplianceKyaScreenings`: The compliance KYA screenings event data.") transaction_id: StrictStr = Field(description="The transaction ID.") transaction_type: KytScreeningsTransactionType review_status: ReviewStatusType @@ -39,8 +39,8 @@ class ComplianceKytScreeningsUpdateEventData(BaseModel): @field_validator('data_type') def data_type_validate_enum(cls, value): """Validates the enum""" - if value not in set(['Transaction', 'TSSRequest', 'Addresses', 'WalletInfo', 'MPCVault', 'Chains', 'Tokens', 'TokenListing', 'PaymentOrder', 'PaymentRefund', 'PaymentSettlement', 'PaymentTransaction', 'PaymentAddressUpdate', 'PaymentPayout', 'BalanceUpdateInfo', 'SuspendedToken', 'ComplianceDisposition', 'ComplianceKytScreenings', 'ComplianceKyaScreenings']): - raise ValueError("must be one of enum values ('Transaction', 'TSSRequest', 'Addresses', 'WalletInfo', 'MPCVault', 'Chains', 'Tokens', 'TokenListing', 'PaymentOrder', 'PaymentRefund', 'PaymentSettlement', 'PaymentTransaction', 'PaymentAddressUpdate', 'PaymentPayout', 'BalanceUpdateInfo', 'SuspendedToken', 'ComplianceDisposition', 'ComplianceKytScreenings', 'ComplianceKyaScreenings')") + if value not in set(['Transaction', 'TSSRequest', 'Addresses', 'WalletInfo', 'MPCVault', 'Chains', 'Tokens', 'TokenListing', 'PaymentOrder', 'PaymentRefund', 'PaymentSettlement', 'PaymentTransaction', 'PaymentAddressUpdate', 'PaymentPayout', 'PaymentBulkSend', 'BalanceUpdateInfo', 'SuspendedToken', 'ComplianceDisposition', 'ComplianceKytScreenings', 'ComplianceKyaScreenings']): + raise ValueError("must be one of enum values ('Transaction', 'TSSRequest', 'Addresses', 'WalletInfo', 'MPCVault', 'Chains', 'Tokens', 'TokenListing', 'PaymentOrder', 'PaymentRefund', 'PaymentSettlement', 'PaymentTransaction', 'PaymentAddressUpdate', 'PaymentPayout', 'PaymentBulkSend', 'BalanceUpdateInfo', 'SuspendedToken', 'ComplianceDisposition', 'ComplianceKytScreenings', 'ComplianceKyaScreenings')") return value model_config = ConfigDict( diff --git a/cobo_waas2/models/contract_call_params.py b/cobo_waas2/models/contract_call_params.py index beca6cdd..fbf74b57 100644 --- a/cobo_waas2/models/contract_call_params.py +++ b/cobo_waas2/models/contract_call_params.py @@ -34,7 +34,7 @@ class ContractCallParams(BaseModel): chain_id: StrictStr = Field(description="The chain ID, which is the unique identifier of a blockchain. You can retrieve the IDs of all the chains you can use by calling [List enabled chains](https://www.cobo.com/developers/v2/api-references/wallets/list-enabled-chains).") source: ContractCallSource destination: ContractCallDestination - description: Optional[StrictStr] = Field(default=None, description="The description of the contract call transaction.") + description: Optional[StrictStr] = Field(default=None, description="The description of the contract call transaction. Maximum length is 2048 characters for MPC Wallets and Custodial Wallets (Web3 Wallets), and 1000 characters for Custodial Wallets (Asset Wallets).") category_names: Optional[List[StrictStr]] = Field(default=None, description="The custom category for you to identify your transactions.") fee: Optional[TransactionRequestFee] = None transaction_process_type: Optional[TransactionProcessType] = None diff --git a/cobo_waas2/models/create_batch_allocation_request.py b/cobo_waas2/models/create_batch_allocation_request.py index 05b0a760..a2b3761c 100644 --- a/cobo_waas2/models/create_batch_allocation_request.py +++ b/cobo_waas2/models/create_batch_allocation_request.py @@ -17,7 +17,7 @@ from pydantic import BaseModel, ConfigDict, Field, StrictStr from typing import Any, ClassVar, Dict, List -from cobo_waas2.models.allocation_request import AllocationRequest +from cobo_waas2.models.allocation_param import AllocationParam from typing import Optional, Set from typing_extensions import Self @@ -27,8 +27,8 @@ class CreateBatchAllocationRequest(BaseModel): CreateBatchAllocationRequest """ # noqa: E501 request_id: StrictStr = Field(description="The request ID that is used to track a batch allocation request. The request ID is provided by you and must be unique.") - allocation_requests: List[AllocationRequest] - __properties: ClassVar[List[str]] = ["request_id", "allocation_requests"] + allocation_params: List[AllocationParam] + __properties: ClassVar[List[str]] = ["request_id", "allocation_params"] model_config = ConfigDict( populate_by_name=True, @@ -69,13 +69,13 @@ def to_dict(self) -> Dict[str, Any]: exclude=excluded_fields, exclude_none=True, ) - # override the default output from pydantic by calling `to_dict()` of each item in allocation_requests (list) + # override the default output from pydantic by calling `to_dict()` of each item in allocation_params (list) _items = [] - if self.allocation_requests: - for _item in self.allocation_requests: + if self.allocation_params: + for _item in self.allocation_params: if _item: _items.append(_item.to_dict()) - _dict['allocation_requests'] = _items + _dict['allocation_params'] = _items return _dict @classmethod @@ -89,7 +89,7 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: _obj = cls.model_validate({ "request_id": obj.get("request_id"), - "allocation_requests": [AllocationRequest.from_dict(_item) for _item in obj["allocation_requests"]] if obj.get("allocation_requests") is not None else None + "allocation_params": [AllocationParam.from_dict(_item) for _item in obj["allocation_params"]] if obj.get("allocation_params") is not None else None }) return _obj diff --git a/cobo_waas2/models/create_bulk_send_request.py b/cobo_waas2/models/create_bulk_send_request.py new file mode 100644 index 00000000..d9b73db6 --- /dev/null +++ b/cobo_waas2/models/create_bulk_send_request.py @@ -0,0 +1,101 @@ +# coding: utf-8 + +""" + Cobo Wallet as a Service 2.0 + + Contact: help@cobo.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from cobo_waas2.models.create_bulk_send_request_payout_params_inner import CreateBulkSendRequestPayoutParamsInner +from cobo_waas2.models.payment_bulk_send_execution_mode import PaymentBulkSendExecutionMode +from typing import Optional, Set +from typing_extensions import Self + + +class CreateBulkSendRequest(BaseModel): + """ + CreateBulkSendRequest + """ # noqa: E501 + source_account: StrictStr = Field(description="The source account from which the bulk send will be made. - If the source account is a merchant account, provide the merchant's ID (e.g., \"M1001\"). - If the source account is the developer account, use the string `\"developer\"`. ") + execution_mode: PaymentBulkSendExecutionMode + description: Optional[StrictStr] = Field(default=None, description="The description for the entire bulk send batch.") + payout_params: List[CreateBulkSendRequestPayoutParamsInner] = Field(description="The bulk send items.") + __properties: ClassVar[List[str]] = ["source_account", "execution_mode", "description", "payout_params"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of CreateBulkSendRequest from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in payout_params (list) + _items = [] + if self.payout_params: + for _item in self.payout_params: + if _item: + _items.append(_item.to_dict()) + _dict['payout_params'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of CreateBulkSendRequest from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "source_account": obj.get("source_account"), + "execution_mode": obj.get("execution_mode"), + "description": obj.get("description"), + "payout_params": [CreateBulkSendRequestPayoutParamsInner.from_dict(_item) for _item in obj["payout_params"]] if obj.get("payout_params") is not None else None + }) + return _obj + + diff --git a/cobo_waas2/models/create_bulk_send_request_payout_params_inner.py b/cobo_waas2/models/create_bulk_send_request_payout_params_inner.py new file mode 100644 index 00000000..c9fbbc8b --- /dev/null +++ b/cobo_waas2/models/create_bulk_send_request_payout_params_inner.py @@ -0,0 +1,92 @@ +# coding: utf-8 + +""" + Cobo Wallet as a Service 2.0 + + Contact: help@cobo.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + + +class CreateBulkSendRequestPayoutParamsInner(BaseModel): + """ + CreateBulkSendRequestPayoutParamsInner + """ # noqa: E501 + token_id: StrictStr = Field(description="The token ID of the cryptocurrency to be sent to the recipient.") + receiving_address: StrictStr = Field(description="The receiving address.") + amount: StrictStr = Field(description="The amount of the cryptocurrency to be sent to the recipient.") + description: Optional[StrictStr] = Field(default=None, description="A note or comment about the bulk send item.") + __properties: ClassVar[List[str]] = ["token_id", "receiving_address", "amount", "description"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of CreateBulkSendRequestPayoutParamsInner from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of CreateBulkSendRequestPayoutParamsInner from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "token_id": obj.get("token_id"), + "receiving_address": obj.get("receiving_address"), + "amount": obj.get("amount"), + "description": obj.get("description") + }) + return _obj + + diff --git a/cobo_waas2/models/create_kya_screenings_body.py b/cobo_waas2/models/create_kya_screenings_body.py index c26060ed..11aa0c03 100644 --- a/cobo_waas2/models/create_kya_screenings_body.py +++ b/cobo_waas2/models/create_kya_screenings_body.py @@ -25,9 +25,9 @@ class CreateKyaScreeningsBody(BaseModel): """ - Request body for batch creating address screening requests. + Information about address screening requests. """ # noqa: E501 - screenings: Annotated[List[KyaScreeningRequest], Field(min_length=1, max_length=50)] = Field(description="List of address screening requests. Maximum 50 addresses per request.") + screenings: Annotated[List[KyaScreeningRequest], Field(min_length=1, max_length=50)] = Field(description="List of address screening requests. Maximum 50 addresses per call.") __properties: ClassVar[List[str]] = ["screenings"] model_config = ConfigDict( diff --git a/cobo_waas2/models/create_payment_order_request.py b/cobo_waas2/models/create_payment_order_request.py index 4c4c6a03..112676bf 100644 --- a/cobo_waas2/models/create_payment_order_request.py +++ b/cobo_waas2/models/create_payment_order_request.py @@ -28,10 +28,10 @@ class CreatePaymentOrderRequest(BaseModel): merchant_id: StrictStr = Field(description="The merchant ID.") merchant_order_code: Optional[StrictStr] = Field(default=None, description="A unique reference code assigned by the merchant to identify this order in their system.") psp_order_code: StrictStr = Field(description="A unique reference code assigned by the developer to identify this order in their system.") - pricing_currency: Optional[StrictStr] = Field(default=None, description="The pricing currency that denominates `pricing_amount` and `fee_amount`. If left empty, both values will be denominated in `payable_currency`. Currently, only `USD` is supported.") + pricing_currency: Optional[StrictStr] = Field(default=None, description="The pricing currency that denominates `pricing_amount` and `fee_amount`. If left empty, both values will be denominated in `payable_currency`. Currently, For a complete list of supported currencies, see [Supported chains and tokens](https://www.cobo.com/developers/v2/guides/overview/supported-chains-and-tokens). ") pricing_amount: Optional[StrictStr] = Field(default=None, description="The base amount of the order, excluding the developer fee (specified in `fee_amount`). Values must be greater than `0` and contain two decimal places.") fee_amount: StrictStr = Field(description="The developer fee for the order. It is added to the base amount (`pricing_amount`) to determine the final charge. For example, if `pricing_amount` is \"100.00\" and `fee_amount` is \"2.00\", the payer will be charged \"102.00\" in total, with \"100.00\" being settled to the merchant account and \"2.00\" settled to the developer account. Values must be greater than 0 and contain two decimal places.") - payable_currency: Optional[StrictStr] = Field(default=None, description="The ID of the cryptocurrency used for payment. Supported values: - USDC: `ETH_USDC`, `ARBITRUM_USDC`, `SOL_USDC`, `BASE_USDC`, `MATIC_USDC`, `BSC_USDC` - USDT: `TRON_USDT`, `ETH_USDT`, `ARBITRUM_USDT`, `SOL_USDT`, `BASE_USDT`, `MATIC_USDT`, `BSC_USDT` ") + payable_currency: StrictStr = Field(description="The ID of the cryptocurrency used for payment. Supported values: - USDC: `ETH_USDC`, `ARBITRUM_USDC`, `SOL_USDC`, `BASE_USDC`, `MATIC_USDC`, `BSC_USDC` - USDT: `TRON_USDT`, `ETH_USDT`, `ARBITRUM_USDT`, `SOL_USDT`, `BASE_USDT`, `MATIC_USDT`, `BSC_USDT` ") payable_amount: Optional[StrictStr] = Field(default=None, description="The total amount the payer needs to pay, denominated in the specified `payable_currency`. If this field is left blank, the system will automatically calculate the amount at order creation using the following formula: (`pricing_amount` + `fee_amount`) / current exchange rate. Values must be greater than 0 and contain two decimal places. ") expired_in: Optional[StrictInt] = Field(default=None, description="The pay-in order will expire after approximately a certain number of seconds: - The order status becomes final and cannot be changed - The `received_token_amount` field will no longer be updated - Funds received after expiration will be categorized as late payments and can only be settled from the developer balance. - A late payment will trigger a `transactionLate` webhook event. ") amount_tolerance: Optional[StrictStr] = Field(default=None, description="The allowed amount deviation, with precision up to 1 decimal place. For example, if `payable_amount` is `100.00` and `amount_tolerance` is `0.50`: - Payer pays 99.55 → Success (difference of 0.45 ≤ 0.5) - Payer pays 99.40 → Underpaid (difference of 0.60 > 0.5) ") diff --git a/cobo_waas2/models/create_payout_request.py b/cobo_waas2/models/create_payout_request.py index 1ce5a273..4ee0f1c9 100644 --- a/cobo_waas2/models/create_payout_request.py +++ b/cobo_waas2/models/create_payout_request.py @@ -18,6 +18,7 @@ from pydantic import BaseModel, ConfigDict, Field, StrictStr from typing import Any, ClassVar, Dict, List, Optional from cobo_waas2.models.payment_payout_param import PaymentPayoutParam +from cobo_waas2.models.payment_payout_recipient_info import PaymentPayoutRecipientInfo from cobo_waas2.models.payout_channel import PayoutChannel from typing import Optional, Set from typing_extensions import Self @@ -28,12 +29,12 @@ class CreatePayoutRequest(BaseModel): CreatePayoutRequest """ # noqa: E501 request_id: StrictStr = Field(description="The request ID that is used to track a payout request. The request ID is provided by you and must be unique.") + source_account: StrictStr = Field(description="The source account from which the payout will be made. - If the source account is a merchant account, provide the merchant's ID (e.g., \"M1001\"). - If the source account is the developer account, use the string `\"developer\"`. ") payout_channel: PayoutChannel payout_params: List[PaymentPayoutParam] - bank_account_id: Optional[StrictStr] = Field(default=None, description="The ID of the bank account where the funds will be deposited. Specify this field when `payout_channel` is set to `OffRamp`. You can call [List all bank accounts](https://www.cobo.com/payments/en/api-references/payment/list-all-bank-accounts) to retrieve the IDs of registered bank accounts. To add a new bank account, refer to [Destinations](https://www.cobo.com/payments/en/guides/destinations). ") - currency: Optional[StrictStr] = Field(default=None, description="The fiat currency you will receive from the payout. - Required when `payout_channel` is set to `OffRamp`. - Currently, only `USD` is supported. ") - remark: Optional[StrictStr] = Field(default=None, description="The remark for the payout.") - __properties: ClassVar[List[str]] = ["request_id", "payout_channel", "payout_params", "bank_account_id", "currency", "remark"] + recipient_info: PaymentPayoutRecipientInfo + remark: Optional[StrictStr] = Field(default=None, description="An optional note or comment about the payout for your internal reference.") + __properties: ClassVar[List[str]] = ["request_id", "source_account", "payout_channel", "payout_params", "recipient_info", "remark"] model_config = ConfigDict( populate_by_name=True, @@ -81,6 +82,9 @@ def to_dict(self) -> Dict[str, Any]: if _item: _items.append(_item.to_dict()) _dict['payout_params'] = _items + # override the default output from pydantic by calling `to_dict()` of recipient_info + if self.recipient_info: + _dict['recipient_info'] = self.recipient_info.to_dict() return _dict @classmethod @@ -94,10 +98,10 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: _obj = cls.model_validate({ "request_id": obj.get("request_id"), + "source_account": obj.get("source_account"), "payout_channel": obj.get("payout_channel"), "payout_params": [PaymentPayoutParam.from_dict(_item) for _item in obj["payout_params"]] if obj.get("payout_params") is not None else None, - "bank_account_id": obj.get("bank_account_id"), - "currency": obj.get("currency"), + "recipient_info": PaymentPayoutRecipientInfo.from_dict(obj["recipient_info"]) if obj.get("recipient_info") is not None else None, "remark": obj.get("remark") }) return _obj diff --git a/cobo_waas2/models/create_top_up_addresses.py b/cobo_waas2/models/create_top_up_addresses.py new file mode 100644 index 00000000..672ae1d9 --- /dev/null +++ b/cobo_waas2/models/create_top_up_addresses.py @@ -0,0 +1,91 @@ +# coding: utf-8 + +""" + Cobo Wallet as a Service 2.0 + + Contact: help@cobo.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing_extensions import Annotated +from typing import Optional, Set +from typing_extensions import Self + + +class CreateTopUpAddresses(BaseModel): + """ + The request body to batch create top-up addresses. + """ # noqa: E501 + merchant_id: Optional[StrictStr] = Field(default=None, description="The merchant ID. If not provided, the default merchant created during organization initialization will be used.") + token_id: StrictStr = Field(description="The token ID, which identifies the cryptocurrency. ") + custom_payer_ids: Annotated[List[StrictStr], Field(max_length=50)] = Field(description="A list of unique custom payer IDs required to create top-up addresses. The maximum number of items is 50. ") + __properties: ClassVar[List[str]] = ["merchant_id", "token_id", "custom_payer_ids"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of CreateTopUpAddresses from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of CreateTopUpAddresses from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "merchant_id": obj.get("merchant_id"), + "token_id": obj.get("token_id"), + "custom_payer_ids": obj.get("custom_payer_ids") + }) + return _obj + + diff --git a/cobo_waas2/models/create_top_up_addresses201_response.py b/cobo_waas2/models/create_top_up_addresses201_response.py new file mode 100644 index 00000000..89f6eeab --- /dev/null +++ b/cobo_waas2/models/create_top_up_addresses201_response.py @@ -0,0 +1,94 @@ +# coding: utf-8 + +""" + Cobo Wallet as a Service 2.0 + + Contact: help@cobo.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict +from typing import Any, ClassVar, Dict, List, Optional +from cobo_waas2.models.top_up_address import TopUpAddress +from typing import Optional, Set +from typing_extensions import Self + + +class CreateTopUpAddresses201Response(BaseModel): + """ + CreateTopUpAddresses201Response + """ # noqa: E501 + data: Optional[List[TopUpAddress]] = None + __properties: ClassVar[List[str]] = ["data"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of CreateTopUpAddresses201Response from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in data (list) + _items = [] + if self.data: + for _item in self.data: + if _item: + _items.append(_item.to_dict()) + _dict['data'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of CreateTopUpAddresses201Response from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "data": [TopUpAddress.from_dict(_item) for _item in obj["data"]] if obj.get("data") is not None else None + }) + return _obj + + diff --git a/cobo_waas2/models/list_allocations200_response.py b/cobo_waas2/models/list_allocation_items200_response.py similarity index 85% rename from cobo_waas2/models/list_allocations200_response.py rename to cobo_waas2/models/list_allocation_items200_response.py index 96afb321..8c716985 100644 --- a/cobo_waas2/models/list_allocations200_response.py +++ b/cobo_waas2/models/list_allocation_items200_response.py @@ -17,17 +17,17 @@ from pydantic import BaseModel, ConfigDict from typing import Any, ClassVar, Dict, List, Optional -from cobo_waas2.models.allocation_record import AllocationRecord +from cobo_waas2.models.allocation_item import AllocationItem from cobo_waas2.models.pagination import Pagination from typing import Optional, Set from typing_extensions import Self -class ListAllocations200Response(BaseModel): +class ListAllocationItems200Response(BaseModel): """ - ListAllocations200Response + ListAllocationItems200Response """ # noqa: E501 - data: Optional[List[AllocationRecord]] = None + data: Optional[List[AllocationItem]] = None pagination: Optional[Pagination] = None __properties: ClassVar[List[str]] = ["data", "pagination"] @@ -49,7 +49,7 @@ def to_json(self) -> str: @classmethod def from_json(cls, json_str: str) -> Optional[Self]: - """Create an instance of ListAllocations200Response from a JSON string""" + """Create an instance of ListAllocationItems200Response from a JSON string""" return cls.from_dict(json.loads(json_str)) def to_dict(self) -> Dict[str, Any]: @@ -84,7 +84,7 @@ def to_dict(self) -> Dict[str, Any]: @classmethod def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: - """Create an instance of ListAllocations200Response from a dict""" + """Create an instance of ListAllocationItems200Response from a dict""" if obj is None: return None @@ -92,7 +92,7 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: return cls.model_validate(obj) _obj = cls.model_validate({ - "data": [AllocationRecord.from_dict(_item) for _item in obj["data"]] if obj.get("data") is not None else None, + "data": [AllocationItem.from_dict(_item) for _item in obj["data"]] if obj.get("data") is not None else None, "pagination": Pagination.from_dict(obj["pagination"]) if obj.get("pagination") is not None else None }) return _obj diff --git a/cobo_waas2/models/list_payout_items200_response.py b/cobo_waas2/models/list_bulk_send_items200_response.py similarity index 85% rename from cobo_waas2/models/list_payout_items200_response.py rename to cobo_waas2/models/list_bulk_send_items200_response.py index 08346884..8e3a4e77 100644 --- a/cobo_waas2/models/list_payout_items200_response.py +++ b/cobo_waas2/models/list_bulk_send_items200_response.py @@ -18,16 +18,16 @@ from pydantic import BaseModel, ConfigDict from typing import Any, ClassVar, Dict, List, Optional from cobo_waas2.models.pagination import Pagination -from cobo_waas2.models.payment_payout_item import PaymentPayoutItem +from cobo_waas2.models.payment_bulk_send_item import PaymentBulkSendItem from typing import Optional, Set from typing_extensions import Self -class ListPayoutItems200Response(BaseModel): +class ListBulkSendItems200Response(BaseModel): """ - ListPayoutItems200Response + ListBulkSendItems200Response """ # noqa: E501 - data: Optional[List[PaymentPayoutItem]] = None + data: Optional[List[PaymentBulkSendItem]] = None pagination: Optional[Pagination] = None __properties: ClassVar[List[str]] = ["data", "pagination"] @@ -49,7 +49,7 @@ def to_json(self) -> str: @classmethod def from_json(cls, json_str: str) -> Optional[Self]: - """Create an instance of ListPayoutItems200Response from a JSON string""" + """Create an instance of ListBulkSendItems200Response from a JSON string""" return cls.from_dict(json.loads(json_str)) def to_dict(self) -> Dict[str, Any]: @@ -84,7 +84,7 @@ def to_dict(self) -> Dict[str, Any]: @classmethod def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: - """Create an instance of ListPayoutItems200Response from a dict""" + """Create an instance of ListBulkSendItems200Response from a dict""" if obj is None: return None @@ -92,7 +92,7 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: return cls.model_validate(obj) _obj = cls.model_validate({ - "data": [PaymentPayoutItem.from_dict(_item) for _item in obj["data"]] if obj.get("data") is not None else None, + "data": [PaymentBulkSendItem.from_dict(_item) for _item in obj["data"]] if obj.get("data") is not None else None, "pagination": Pagination.from_dict(obj["pagination"]) if obj.get("pagination") is not None else None }) return _obj diff --git a/cobo_waas2/models/mpc_vault_event_data.py b/cobo_waas2/models/mpc_vault_event_data.py index 0fdd4f5e..1c42812f 100644 --- a/cobo_waas2/models/mpc_vault_event_data.py +++ b/cobo_waas2/models/mpc_vault_event_data.py @@ -27,7 +27,7 @@ class MPCVaultEventData(BaseModel): """ MPCVaultEventData """ # noqa: E501 - data_type: StrictStr = Field(description=" The data type of the event. - `Transaction`: The transaction event data. - `TSSRequest`: The TSS request event data. - `Addresses`: The addresses event data. - `WalletInfo`: The wallet information event data. - `MPCVault`: The MPC vault event data. - `Chains`: The enabled chain event data. - `Tokens`: The enabled token event data. - `TokenListing`: The token listing event data. - `PaymentOrder`: The payment order event data. - `PaymentRefund`: The payment refund event data. - `PaymentSettlement`: The payment settlement event data. - `PaymentTransaction`: The payment transaction event data. - `PaymentAddressUpdate`: The top-up address update event data. - `PaymentPayout`: The payment payout event data. - `BalanceUpdateInfo`: The balance update event data. - `SuspendedToken`: The token suspension event data. - `ComplianceDisposition`: The compliance disposition event data. - `ComplianceKytScreenings`: The compliance KYT screenings event data. - `ComplianceKyaScreenings`: The compliance KYA screenings event data.") + data_type: StrictStr = Field(description=" The data type of the event. - `Transaction`: The transaction event data. - `TSSRequest`: The TSS request event data. - `Addresses`: The addresses event data. - `WalletInfo`: The wallet information event data. - `MPCVault`: The MPC vault event data. - `Chains`: The enabled chain event data. - `Tokens`: The enabled token event data. - `TokenListing`: The token listing event data. - `PaymentOrder`: The payment order event data. - `PaymentRefund`: The payment refund event data. - `PaymentSettlement`: The payment settlement event data. - `PaymentTransaction`: The payment transaction event data. - `PaymentAddressUpdate`: The top-up address update event data. - `PaymentPayout`: The payment payout event data. - `PaymentBulkSend`: The payment bulk send event data. - `BalanceUpdateInfo`: The balance update event data. - `SuspendedToken`: The token suspension event data. - `ComplianceDisposition`: The compliance disposition event data. - `ComplianceKytScreenings`: The compliance KYT screenings event data. - `ComplianceKyaScreenings`: The compliance KYA screenings event data.") vault_id: Optional[StrictStr] = Field(default=None, description="The vault ID.") project_id: Optional[StrictStr] = Field(default=None, description="The project ID.") name: Optional[StrictStr] = Field(default=None, description="The vault name.") @@ -39,8 +39,8 @@ class MPCVaultEventData(BaseModel): @field_validator('data_type') def data_type_validate_enum(cls, value): """Validates the enum""" - if value not in set(['Transaction', 'TSSRequest', 'Addresses', 'WalletInfo', 'MPCVault', 'Chains', 'Tokens', 'TokenListing', 'PaymentOrder', 'PaymentRefund', 'PaymentSettlement', 'PaymentTransaction', 'PaymentAddressUpdate', 'PaymentPayout', 'BalanceUpdateInfo', 'SuspendedToken', 'ComplianceDisposition', 'ComplianceKytScreenings', 'ComplianceKyaScreenings']): - raise ValueError("must be one of enum values ('Transaction', 'TSSRequest', 'Addresses', 'WalletInfo', 'MPCVault', 'Chains', 'Tokens', 'TokenListing', 'PaymentOrder', 'PaymentRefund', 'PaymentSettlement', 'PaymentTransaction', 'PaymentAddressUpdate', 'PaymentPayout', 'BalanceUpdateInfo', 'SuspendedToken', 'ComplianceDisposition', 'ComplianceKytScreenings', 'ComplianceKyaScreenings')") + if value not in set(['Transaction', 'TSSRequest', 'Addresses', 'WalletInfo', 'MPCVault', 'Chains', 'Tokens', 'TokenListing', 'PaymentOrder', 'PaymentRefund', 'PaymentSettlement', 'PaymentTransaction', 'PaymentAddressUpdate', 'PaymentPayout', 'PaymentBulkSend', 'BalanceUpdateInfo', 'SuspendedToken', 'ComplianceDisposition', 'ComplianceKytScreenings', 'ComplianceKyaScreenings']): + raise ValueError("must be one of enum values ('Transaction', 'TSSRequest', 'Addresses', 'WalletInfo', 'MPCVault', 'Chains', 'Tokens', 'TokenListing', 'PaymentOrder', 'PaymentRefund', 'PaymentSettlement', 'PaymentTransaction', 'PaymentAddressUpdate', 'PaymentPayout', 'PaymentBulkSend', 'BalanceUpdateInfo', 'SuspendedToken', 'ComplianceDisposition', 'ComplianceKytScreenings', 'ComplianceKyaScreenings')") return value model_config = ConfigDict( diff --git a/cobo_waas2/models/order_link_business_info.py b/cobo_waas2/models/order_link_business_info.py index 2d332852..1b50b38f 100644 --- a/cobo_waas2/models/order_link_business_info.py +++ b/cobo_waas2/models/order_link_business_info.py @@ -30,10 +30,10 @@ class OrderLinkBusinessInfo(BaseModel): merchant_id: StrictStr = Field(description="The merchant ID.") merchant_order_code: Optional[StrictStr] = Field(default=None, description="A unique reference code assigned by the merchant to identify this order in their system. The code should have a maximum length of 128 characters.") psp_order_code: StrictStr = Field(description="A unique reference code assigned by you as a developer to identify this order in your system. This code must be unique across all orders in your system. The code should have a maximum length of 128 characters. ") - pricing_currency: Optional[StrictStr] = Field(default=None, description="The pricing currency that denominates `pricing_amount` and `fee_amount`. Currently, only `USD`/`USDT`/`USDC` are supported. This field is required. ") - pricing_amount: Optional[StrictStr] = Field(default=None, description="The base amount of the order, excluding the developer fee (specified in `fee_amount`). Values must be greater than `0` and contain two decimal places. ") + pricing_currency: StrictStr = Field(description="The pricing currency that denominates `pricing_amount` and `fee_amount`. Currently, only `USD`/`USDT`/`USDC` are supported. This field is required. ") + pricing_amount: StrictStr = Field(description="The base amount of the order, excluding the developer fee (specified in `fee_amount`). Values must be greater than `0` and contain two decimal places. ") fee_amount: StrictStr = Field(description="The developer fee for the order. It is added to the base amount (`pricing_amount`) to determine the final charge. For example, if `pricing_amount` is \"100.00\" and `fee_amount` is \"2.00\", the payer will be charged \"102.00\" in total, with \"100.00\" being settled to the merchant account and \"2.00\" settled to the developer account. Values must be greater than 0 and contain two decimal places. ") - payable_currencies: Optional[List[StrictStr]] = Field(default=None, description="The IDs of the cryptocurrencies used for payment. Supported values: - USDC: `ETH_USDC`, `ARBITRUM_USDC`, `SOL_USDC`, `BASE_USDC`, `MATIC_USDC`, `BSC_USDC` - USDT: `TRON_USDT`, `ETH_USDT`, `ARBITRUM_USDT`, `SOL_USDT`, `BASE_USDT`, `MATIC_USDT`, `BSC_USDT` ") + payable_currencies: List[StrictStr] = Field(description="The IDs of the cryptocurrencies used for payment. Supported values: - USDC: `ETH_USDC`, `ARBITRUM_USDC`, `SOL_USDC`, `BASE_USDC`, `MATIC_USDC`, `BSC_USDC` - USDT: `TRON_USDT`, `ETH_USDT`, `ARBITRUM_USDT`, `SOL_USDT`, `BASE_USDT`, `MATIC_USDT`, `BSC_USDT` ") payable_amounts: Optional[List[OrderLinkBusinessInfoPayableAmountsInner]] = Field(default=None, description="The total amounts the payer needs to pay for each currency in `payable_currencies`. If this field is left blank, the system will automatically calculate the amounts at order creation using the following formula: (`pricing_amount` + `fee_amount`) / current exchange rate. Values must be greater than 0 and contain two decimal places. ") expired_in: Optional[StrictInt] = Field(default=1800, description="The number of seconds until the pay-in order expires, counted from when the request is sent. For example, if set to `1800`, the order will expire in 30 minutes. Must be greater than zero and cannot exceed 3 hours (10800 seconds). After expiration: - The order status becomes final and cannot be changed - The `received_token_amount` field will no longer be updated - Funds received after expiration will be categorized as late payments and can only be settled from the developer balance. - A late payment will trigger a `transactionLate` webhook event. ") amount_tolerance: Optional[StrictStr] = Field(default=None, description="The allowed amount deviation, with precision up to 1 decimal place. For example, if `payable_amount` is `100.00` and `amount_tolerance` is `0.50`: - Payer pays 99.55 → Success (difference of 0.45 ≤ 0.5) - Payer pays 99.40 → Underpaid (difference of 0.60 > 0.5) ") diff --git a/cobo_waas2/models/payment_address_update_event_data.py b/cobo_waas2/models/payment_address_update_event_data.py index b04cffea..61e1d9c4 100644 --- a/cobo_waas2/models/payment_address_update_event_data.py +++ b/cobo_waas2/models/payment_address_update_event_data.py @@ -25,7 +25,7 @@ class PaymentAddressUpdateEventData(BaseModel): """ PaymentAddressUpdateEventData """ # noqa: E501 - data_type: StrictStr = Field(description=" The data type of the event. - `Transaction`: The transaction event data. - `TSSRequest`: The TSS request event data. - `Addresses`: The addresses event data. - `WalletInfo`: The wallet information event data. - `MPCVault`: The MPC vault event data. - `Chains`: The enabled chain event data. - `Tokens`: The enabled token event data. - `TokenListing`: The token listing event data. - `PaymentOrder`: The payment order event data. - `PaymentRefund`: The payment refund event data. - `PaymentSettlement`: The payment settlement event data. - `PaymentTransaction`: The payment transaction event data. - `PaymentAddressUpdate`: The top-up address update event data. - `PaymentPayout`: The payment payout event data. - `BalanceUpdateInfo`: The balance update event data. - `SuspendedToken`: The token suspension event data. - `ComplianceDisposition`: The compliance disposition event data. - `ComplianceKytScreenings`: The compliance KYT screenings event data. - `ComplianceKyaScreenings`: The compliance KYA screenings event data.") + data_type: StrictStr = Field(description=" The data type of the event. - `Transaction`: The transaction event data. - `TSSRequest`: The TSS request event data. - `Addresses`: The addresses event data. - `WalletInfo`: The wallet information event data. - `MPCVault`: The MPC vault event data. - `Chains`: The enabled chain event data. - `Tokens`: The enabled token event data. - `TokenListing`: The token listing event data. - `PaymentOrder`: The payment order event data. - `PaymentRefund`: The payment refund event data. - `PaymentSettlement`: The payment settlement event data. - `PaymentTransaction`: The payment transaction event data. - `PaymentAddressUpdate`: The top-up address update event data. - `PaymentPayout`: The payment payout event data. - `PaymentBulkSend`: The payment bulk send event data. - `BalanceUpdateInfo`: The balance update event data. - `SuspendedToken`: The token suspension event data. - `ComplianceDisposition`: The compliance disposition event data. - `ComplianceKytScreenings`: The compliance KYT screenings event data. - `ComplianceKyaScreenings`: The compliance KYA screenings event data.") custom_payer_id: StrictStr = Field(description="A unique identifier assigned by the developer to track and identify individual payers in their system.") payer_id: StrictStr = Field(description="A unique identifier assigned by Cobo to track and identify individual payers.") chain: StrictStr = Field(description="The chain ID.") @@ -36,8 +36,8 @@ class PaymentAddressUpdateEventData(BaseModel): @field_validator('data_type') def data_type_validate_enum(cls, value): """Validates the enum""" - if value not in set(['Transaction', 'TSSRequest', 'Addresses', 'WalletInfo', 'MPCVault', 'Chains', 'Tokens', 'TokenListing', 'PaymentOrder', 'PaymentRefund', 'PaymentSettlement', 'PaymentTransaction', 'PaymentAddressUpdate', 'PaymentPayout', 'BalanceUpdateInfo', 'SuspendedToken', 'ComplianceDisposition', 'ComplianceKytScreenings', 'ComplianceKyaScreenings']): - raise ValueError("must be one of enum values ('Transaction', 'TSSRequest', 'Addresses', 'WalletInfo', 'MPCVault', 'Chains', 'Tokens', 'TokenListing', 'PaymentOrder', 'PaymentRefund', 'PaymentSettlement', 'PaymentTransaction', 'PaymentAddressUpdate', 'PaymentPayout', 'BalanceUpdateInfo', 'SuspendedToken', 'ComplianceDisposition', 'ComplianceKytScreenings', 'ComplianceKyaScreenings')") + if value not in set(['Transaction', 'TSSRequest', 'Addresses', 'WalletInfo', 'MPCVault', 'Chains', 'Tokens', 'TokenListing', 'PaymentOrder', 'PaymentRefund', 'PaymentSettlement', 'PaymentTransaction', 'PaymentAddressUpdate', 'PaymentPayout', 'PaymentBulkSend', 'BalanceUpdateInfo', 'SuspendedToken', 'ComplianceDisposition', 'ComplianceKytScreenings', 'ComplianceKyaScreenings']): + raise ValueError("must be one of enum values ('Transaction', 'TSSRequest', 'Addresses', 'WalletInfo', 'MPCVault', 'Chains', 'Tokens', 'TokenListing', 'PaymentOrder', 'PaymentRefund', 'PaymentSettlement', 'PaymentTransaction', 'PaymentAddressUpdate', 'PaymentPayout', 'PaymentBulkSend', 'BalanceUpdateInfo', 'SuspendedToken', 'ComplianceDisposition', 'ComplianceKytScreenings', 'ComplianceKyaScreenings')") return value model_config = ConfigDict( diff --git a/cobo_waas2/models/payment_bulk_send.py b/cobo_waas2/models/payment_bulk_send.py new file mode 100644 index 00000000..7bf91b14 --- /dev/null +++ b/cobo_waas2/models/payment_bulk_send.py @@ -0,0 +1,100 @@ +# coding: utf-8 + +""" + Cobo Wallet as a Service 2.0 + + Contact: help@cobo.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictInt, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from cobo_waas2.models.payment_bulk_send_execution_mode import PaymentBulkSendExecutionMode +from cobo_waas2.models.payment_bulk_send_status import PaymentBulkSendStatus +from typing import Optional, Set +from typing_extensions import Self + + +class PaymentBulkSend(BaseModel): + """ + PaymentBulkSend + """ # noqa: E501 + bulk_send_id: StrictStr = Field(description="The bulk send ID.") + source_account: StrictStr = Field(description="The source account from which the bulk send will be made. - If the source account is a merchant account, provide the merchant's ID (e.g., \"M1001\"). - If the source account is the developer account, use the string `\"developer\"`. ") + description: Optional[StrictStr] = Field(default=None, description="The description for the entire bulk send batch.") + execution_mode: PaymentBulkSendExecutionMode + status: PaymentBulkSendStatus + created_timestamp: StrictInt = Field(description="The created time of the bulk send, represented as a UNIX timestamp in seconds.") + updated_timestamp: StrictInt = Field(description="The updated time of the bulk send, represented as a UNIX timestamp in seconds.") + __properties: ClassVar[List[str]] = ["bulk_send_id", "source_account", "description", "execution_mode", "status", "created_timestamp", "updated_timestamp"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of PaymentBulkSend from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of PaymentBulkSend from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "bulk_send_id": obj.get("bulk_send_id"), + "source_account": obj.get("source_account"), + "description": obj.get("description"), + "execution_mode": obj.get("execution_mode"), + "status": obj.get("status"), + "created_timestamp": obj.get("created_timestamp"), + "updated_timestamp": obj.get("updated_timestamp") + }) + return _obj + + diff --git a/cobo_waas2/models/payment_bulk_send_event.py b/cobo_waas2/models/payment_bulk_send_event.py new file mode 100644 index 00000000..bd7bdbf5 --- /dev/null +++ b/cobo_waas2/models/payment_bulk_send_event.py @@ -0,0 +1,109 @@ +# coding: utf-8 + +""" + Cobo Wallet as a Service 2.0 + + Contact: help@cobo.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictInt, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from cobo_waas2.models.payment_bulk_send_execution_mode import PaymentBulkSendExecutionMode +from cobo_waas2.models.payment_bulk_send_status import PaymentBulkSendStatus +from typing import Optional, Set +from typing_extensions import Self + + +class PaymentBulkSendEvent(BaseModel): + """ + PaymentBulkSendEvent + """ # noqa: E501 + data_type: StrictStr = Field(description=" The data type of the event. - `Transaction`: The transaction event data. - `TSSRequest`: The TSS request event data. - `Addresses`: The addresses event data. - `WalletInfo`: The wallet information event data. - `MPCVault`: The MPC vault event data. - `Chains`: The enabled chain event data. - `Tokens`: The enabled token event data. - `TokenListing`: The token listing event data. - `PaymentOrder`: The payment order event data. - `PaymentRefund`: The payment refund event data. - `PaymentSettlement`: The payment settlement event data. - `PaymentTransaction`: The payment transaction event data. - `PaymentAddressUpdate`: The top-up address update event data. - `PaymentPayout`: The payment payout event data. - `PaymentBulkSend`: The payment bulk send event data. - `BalanceUpdateInfo`: The balance update event data. - `SuspendedToken`: The token suspension event data. - `ComplianceDisposition`: The compliance disposition event data. - `ComplianceKytScreenings`: The compliance KYT screenings event data. - `ComplianceKyaScreenings`: The compliance KYA screenings event data.") + bulk_send_id: StrictStr = Field(description="The bulk send ID.") + source_account: StrictStr = Field(description="The source account from which the bulk send will be made. - If the source account is a merchant account, provide the merchant's ID (e.g., \"M1001\"). - If the source account is the developer account, use the string `\"developer\"`. ") + description: Optional[StrictStr] = Field(default=None, description="The description for the entire bulk send batch.") + execution_mode: PaymentBulkSendExecutionMode + status: PaymentBulkSendStatus + created_timestamp: StrictInt = Field(description="The created time of the bulk send, represented as a UNIX timestamp in seconds.") + updated_timestamp: StrictInt = Field(description="The updated time of the bulk send, represented as a UNIX timestamp in seconds.") + __properties: ClassVar[List[str]] = ["data_type", "bulk_send_id", "source_account", "description", "execution_mode", "status", "created_timestamp", "updated_timestamp"] + + @field_validator('data_type') + def data_type_validate_enum(cls, value): + """Validates the enum""" + if value not in set(['Transaction', 'TSSRequest', 'Addresses', 'WalletInfo', 'MPCVault', 'Chains', 'Tokens', 'TokenListing', 'PaymentOrder', 'PaymentRefund', 'PaymentSettlement', 'PaymentTransaction', 'PaymentAddressUpdate', 'PaymentPayout', 'PaymentBulkSend', 'BalanceUpdateInfo', 'SuspendedToken', 'ComplianceDisposition', 'ComplianceKytScreenings', 'ComplianceKyaScreenings']): + raise ValueError("must be one of enum values ('Transaction', 'TSSRequest', 'Addresses', 'WalletInfo', 'MPCVault', 'Chains', 'Tokens', 'TokenListing', 'PaymentOrder', 'PaymentRefund', 'PaymentSettlement', 'PaymentTransaction', 'PaymentAddressUpdate', 'PaymentPayout', 'PaymentBulkSend', 'BalanceUpdateInfo', 'SuspendedToken', 'ComplianceDisposition', 'ComplianceKytScreenings', 'ComplianceKyaScreenings')") + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of PaymentBulkSendEvent from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of PaymentBulkSendEvent from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "data_type": obj.get("data_type"), + "bulk_send_id": obj.get("bulk_send_id"), + "source_account": obj.get("source_account"), + "description": obj.get("description"), + "execution_mode": obj.get("execution_mode"), + "status": obj.get("status"), + "created_timestamp": obj.get("created_timestamp"), + "updated_timestamp": obj.get("updated_timestamp") + }) + return _obj + + diff --git a/cobo_waas2/models/payment_bulk_send_execution_mode.py b/cobo_waas2/models/payment_bulk_send_execution_mode.py new file mode 100644 index 00000000..b2db73c1 --- /dev/null +++ b/cobo_waas2/models/payment_bulk_send_execution_mode.py @@ -0,0 +1,41 @@ +# coding: utf-8 + +""" + Cobo Wallet as a Service 2.0 + + Contact: help@cobo.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import json +from enum import Enum +from typing_extensions import Self + + +class PaymentBulkSendExecutionMode(str, Enum): + """ + The execution mode of the bulk send. - `Strict`: The bulk send is executed in strict mode, which means all bulk send items should be successfully executed or all failed. - `Partial`: The bulk send is executed in partial mode, which means some bulk send items can be successfully executed and some can be failed. + """ + + """ + allowed enum values + """ + STRICT = 'Strict' + PARTIAL = 'Partial' + + UNKNOWN = None + + @classmethod + def from_json(cls, json_str: str) -> Self: + """Create an instance of PaymentBulkSendExecutionMode from a JSON string""" + return cls(json.loads(json_str)) + + @classmethod + def _missing_(cls, value): + return cls.UNKNOWN + + diff --git a/cobo_waas2/models/payment_bulk_send_item.py b/cobo_waas2/models/payment_bulk_send_item.py new file mode 100644 index 00000000..c52f872b --- /dev/null +++ b/cobo_waas2/models/payment_bulk_send_item.py @@ -0,0 +1,100 @@ +# coding: utf-8 + +""" + Cobo Wallet as a Service 2.0 + + Contact: help@cobo.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from cobo_waas2.models.payment_bulk_send_item_status import PaymentBulkSendItemStatus +from cobo_waas2.models.payment_bulk_send_item_validation_status import PaymentBulkSendItemValidationStatus +from typing import Optional, Set +from typing_extensions import Self + + +class PaymentBulkSendItem(BaseModel): + """ + PaymentBulkSendItem + """ # noqa: E501 + bulk_send_item_id: StrictStr = Field(description="The payout item ID.") + token_id: StrictStr = Field(description="The token ID of the payout item.") + receiving_address: StrictStr = Field(description="The receiving address of the payout item.") + amount: StrictStr = Field(description="The amount of the payout item.") + description: Optional[StrictStr] = Field(default=None, description="The note of the payout item.") + status: PaymentBulkSendItemStatus + validation_status: PaymentBulkSendItemValidationStatus + __properties: ClassVar[List[str]] = ["bulk_send_item_id", "token_id", "receiving_address", "amount", "description", "status", "validation_status"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of PaymentBulkSendItem from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of PaymentBulkSendItem from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "bulk_send_item_id": obj.get("bulk_send_item_id"), + "token_id": obj.get("token_id"), + "receiving_address": obj.get("receiving_address"), + "amount": obj.get("amount"), + "description": obj.get("description"), + "status": obj.get("status"), + "validation_status": obj.get("validation_status") + }) + return _obj + + diff --git a/cobo_waas2/models/payment_bulk_send_item_status.py b/cobo_waas2/models/payment_bulk_send_item_status.py new file mode 100644 index 00000000..3d1931a3 --- /dev/null +++ b/cobo_waas2/models/payment_bulk_send_item_status.py @@ -0,0 +1,44 @@ +# coding: utf-8 + +""" + Cobo Wallet as a Service 2.0 + + Contact: help@cobo.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import json +from enum import Enum +from typing_extensions import Self + + +class PaymentBulkSendItemStatus(str, Enum): + """ + The current status of the bulk send item. Possible values include: - `Pending`: The bulk send item has been created and is waiting to be processed. - `Processing`: The bulk send item is currently being processed and the transfer is in progress. - `Completed`: The bulk send item has been successfully processed and the funds have been transferred. - `Failed`: The bulk send item processing has failed and the funds were not transferred. - `NotExecuted`: The bulk send item was not executed, typically due to the bulk send being cancelled or an earlier validation failure. + """ + + """ + allowed enum values + """ + PENDING = 'Pending' + PROCESSING = 'Processing' + COMPLETED = 'Completed' + FAILED = 'Failed' + NOTEXECUTED = 'NotExecuted' + + UNKNOWN = None + + @classmethod + def from_json(cls, json_str: str) -> Self: + """Create an instance of PaymentBulkSendItemStatus from a JSON string""" + return cls(json.loads(json_str)) + + @classmethod + def _missing_(cls, value): + return cls.UNKNOWN + + diff --git a/cobo_waas2/models/payment_bulk_send_item_validation_status.py b/cobo_waas2/models/payment_bulk_send_item_validation_status.py new file mode 100644 index 00000000..c8b8a04d --- /dev/null +++ b/cobo_waas2/models/payment_bulk_send_item_validation_status.py @@ -0,0 +1,42 @@ +# coding: utf-8 + +""" + Cobo Wallet as a Service 2.0 + + Contact: help@cobo.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import json +from enum import Enum +from typing_extensions import Self + + +class PaymentBulkSendItemValidationStatus(str, Enum): + """ + The current validation status of the bulk send item. Possible values include: - `Pending`: The bulk send item has not yet been validated. - `Validated`: The bulk send item has passed validation and is ready to be processed. - `ValidationFailed`: The bulk send item has failed validation and cannot be processed. + """ + + """ + allowed enum values + """ + PENDING = 'Pending' + VALIDATED = 'Validated' + VALIDATIONFAILED = 'ValidationFailed' + + UNKNOWN = None + + @classmethod + def from_json(cls, json_str: str) -> Self: + """Create an instance of PaymentBulkSendItemValidationStatus from a JSON string""" + return cls(json.loads(json_str)) + + @classmethod + def _missing_(cls, value): + return cls.UNKNOWN + + diff --git a/cobo_waas2/models/payment_bulk_send_status.py b/cobo_waas2/models/payment_bulk_send_status.py new file mode 100644 index 00000000..6a1ff294 --- /dev/null +++ b/cobo_waas2/models/payment_bulk_send_status.py @@ -0,0 +1,45 @@ +# coding: utf-8 + +""" + Cobo Wallet as a Service 2.0 + + Contact: help@cobo.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import json +from enum import Enum +from typing_extensions import Self + + +class PaymentBulkSendStatus(str, Enum): + """ + The current status of the bulk send. Possible values include: - `Pending`: The bulk send has been created and is waiting to be processed. - `Validating`: The bulk send items are being validated. - `Transferring`: The bulk send items are being processed and funds are being transferred. - `Completed`: All items in the bulk send have been successfully processed. - `PartiallyCompleted`: Some items in the bulk send have been successfully processed, while others have failed. - `Failed`: The bulk send has failed and no items were processed successfully. + """ + + """ + allowed enum values + """ + PENDING = 'Pending' + VALIDATING = 'Validating' + TRANSFERRING = 'Transferring' + COMPLETED = 'Completed' + PARTIALLYCOMPLETED = 'PartiallyCompleted' + FAILED = 'Failed' + + UNKNOWN = None + + @classmethod + def from_json(cls, json_str: str) -> Self: + """Create an instance of PaymentBulkSendStatus from a JSON string""" + return cls(json.loads(json_str)) + + @classmethod + def _missing_(cls, value): + return cls.UNKNOWN + + diff --git a/cobo_waas2/models/payment_estimate_fee_request.py b/cobo_waas2/models/payment_estimate_fee_request.py index 6ab473ba..1b49a243 100644 --- a/cobo_waas2/models/payment_estimate_fee_request.py +++ b/cobo_waas2/models/payment_estimate_fee_request.py @@ -15,7 +15,7 @@ import re # noqa: F401 import json -from pydantic import BaseModel, ConfigDict, Field +from pydantic import BaseModel, ConfigDict, Field, StrictStr from typing import Any, ClassVar, Dict, List, Optional from cobo_waas2.models.payment_estimate_fee import PaymentEstimateFee from cobo_waas2.models.payment_fee_type import PaymentFeeType @@ -29,7 +29,8 @@ class PaymentEstimateFeeRequest(BaseModel): """ # noqa: E501 fee_type: Optional[PaymentFeeType] = None estimate_fees: List[PaymentEstimateFee] = Field(description="A list of token IDs and amounts for which fees will be calculated.") - __properties: ClassVar[List[str]] = ["fee_type", "estimate_fees"] + recipient_token_id: Optional[StrictStr] = Field(default=None, description="The token ID that the recipient will receive. Required only when `fee_type` is `CryptoPayoutBridge`.") + __properties: ClassVar[List[str]] = ["fee_type", "estimate_fees", "recipient_token_id"] model_config = ConfigDict( populate_by_name=True, @@ -90,7 +91,8 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: _obj = cls.model_validate({ "fee_type": obj.get("fee_type"), - "estimate_fees": [PaymentEstimateFee.from_dict(_item) for _item in obj["estimate_fees"]] if obj.get("estimate_fees") is not None else None + "estimate_fees": [PaymentEstimateFee.from_dict(_item) for _item in obj["estimate_fees"]] if obj.get("estimate_fees") is not None else None, + "recipient_token_id": obj.get("recipient_token_id") }) return _obj diff --git a/cobo_waas2/models/payment_fee_type.py b/cobo_waas2/models/payment_fee_type.py index d1b4c605..b3c5fb0d 100644 --- a/cobo_waas2/models/payment_fee_type.py +++ b/cobo_waas2/models/payment_fee_type.py @@ -18,7 +18,7 @@ class PaymentFeeType(str, Enum): """ - The type of fee to estimate: - `Order`: Fee for accepting a payment. - `Refund`: Fee for processing a refund. - `CryptoSettlement`: Fee for crypto payouts. - `OffRampSettlement`: Fee for fiat off-ramp. + The fee type. Possible values include: - `Order`: Fees for order processing. - `Refund`: Fees for refund processing. - `CryptoSettlement`: This fee type is deprecated. Please use `CryptoPayout` instead. - `OffRampSettlement`: This fee type is deprecated. Please use `OffRampPayout` instead. - `CryptoPayout`: Fees for crypto payouts. - `CryptoPayoutBridge`: Fees for crypto payouts with cross-chain bridging. - `OffRampPayout`: Fees for fiat off-ramp payouts. """ """ @@ -28,6 +28,9 @@ class PaymentFeeType(str, Enum): REFUND = 'Refund' CRYPTOSETTLEMENT = 'CryptoSettlement' OFFRAMPSETTLEMENT = 'OffRampSettlement' + CRYPTOPAYOUT = 'CryptoPayout' + CRYPTOPAYOUTBRIDGE = 'CryptoPayoutBridge' + OFFRAMPPAYOUT = 'OffRampPayout' UNKNOWN = None diff --git a/cobo_waas2/models/payment_order_event_data.py b/cobo_waas2/models/payment_order_event_data.py index b5b01da3..bf68584e 100644 --- a/cobo_waas2/models/payment_order_event_data.py +++ b/cobo_waas2/models/payment_order_event_data.py @@ -28,7 +28,7 @@ class PaymentOrderEventData(BaseModel): """ PaymentOrderEventData """ # noqa: E501 - data_type: StrictStr = Field(description=" The data type of the event. - `Transaction`: The transaction event data. - `TSSRequest`: The TSS request event data. - `Addresses`: The addresses event data. - `WalletInfo`: The wallet information event data. - `MPCVault`: The MPC vault event data. - `Chains`: The enabled chain event data. - `Tokens`: The enabled token event data. - `TokenListing`: The token listing event data. - `PaymentOrder`: The payment order event data. - `PaymentRefund`: The payment refund event data. - `PaymentSettlement`: The payment settlement event data. - `PaymentTransaction`: The payment transaction event data. - `PaymentAddressUpdate`: The top-up address update event data. - `PaymentPayout`: The payment payout event data. - `BalanceUpdateInfo`: The balance update event data. - `SuspendedToken`: The token suspension event data. - `ComplianceDisposition`: The compliance disposition event data. - `ComplianceKytScreenings`: The compliance KYT screenings event data. - `ComplianceKyaScreenings`: The compliance KYA screenings event data.") + data_type: StrictStr = Field(description=" The data type of the event. - `Transaction`: The transaction event data. - `TSSRequest`: The TSS request event data. - `Addresses`: The addresses event data. - `WalletInfo`: The wallet information event data. - `MPCVault`: The MPC vault event data. - `Chains`: The enabled chain event data. - `Tokens`: The enabled token event data. - `TokenListing`: The token listing event data. - `PaymentOrder`: The payment order event data. - `PaymentRefund`: The payment refund event data. - `PaymentSettlement`: The payment settlement event data. - `PaymentTransaction`: The payment transaction event data. - `PaymentAddressUpdate`: The top-up address update event data. - `PaymentPayout`: The payment payout event data. - `PaymentBulkSend`: The payment bulk send event data. - `BalanceUpdateInfo`: The balance update event data. - `SuspendedToken`: The token suspension event data. - `ComplianceDisposition`: The compliance disposition event data. - `ComplianceKytScreenings`: The compliance KYT screenings event data. - `ComplianceKyaScreenings`: The compliance KYA screenings event data.") order_id: StrictStr = Field(description="The order ID.") merchant_id: Optional[StrictStr] = Field(default=None, description="The merchant ID.") merchant_order_code: Optional[StrictStr] = Field(default=None, description="A unique reference code assigned by the merchant to identify this order in their system.") @@ -57,8 +57,8 @@ class PaymentOrderEventData(BaseModel): @field_validator('data_type') def data_type_validate_enum(cls, value): """Validates the enum""" - if value not in set(['Transaction', 'TSSRequest', 'Addresses', 'WalletInfo', 'MPCVault', 'Chains', 'Tokens', 'TokenListing', 'PaymentOrder', 'PaymentRefund', 'PaymentSettlement', 'PaymentTransaction', 'PaymentAddressUpdate', 'PaymentPayout', 'BalanceUpdateInfo', 'SuspendedToken', 'ComplianceDisposition', 'ComplianceKytScreenings', 'ComplianceKyaScreenings']): - raise ValueError("must be one of enum values ('Transaction', 'TSSRequest', 'Addresses', 'WalletInfo', 'MPCVault', 'Chains', 'Tokens', 'TokenListing', 'PaymentOrder', 'PaymentRefund', 'PaymentSettlement', 'PaymentTransaction', 'PaymentAddressUpdate', 'PaymentPayout', 'BalanceUpdateInfo', 'SuspendedToken', 'ComplianceDisposition', 'ComplianceKytScreenings', 'ComplianceKyaScreenings')") + if value not in set(['Transaction', 'TSSRequest', 'Addresses', 'WalletInfo', 'MPCVault', 'Chains', 'Tokens', 'TokenListing', 'PaymentOrder', 'PaymentRefund', 'PaymentSettlement', 'PaymentTransaction', 'PaymentAddressUpdate', 'PaymentPayout', 'PaymentBulkSend', 'BalanceUpdateInfo', 'SuspendedToken', 'ComplianceDisposition', 'ComplianceKytScreenings', 'ComplianceKyaScreenings']): + raise ValueError("must be one of enum values ('Transaction', 'TSSRequest', 'Addresses', 'WalletInfo', 'MPCVault', 'Chains', 'Tokens', 'TokenListing', 'PaymentOrder', 'PaymentRefund', 'PaymentSettlement', 'PaymentTransaction', 'PaymentAddressUpdate', 'PaymentPayout', 'PaymentBulkSend', 'BalanceUpdateInfo', 'SuspendedToken', 'ComplianceDisposition', 'ComplianceKytScreenings', 'ComplianceKyaScreenings')") return value model_config = ConfigDict( diff --git a/cobo_waas2/models/payment_payout.py b/cobo_waas2/models/payment_payout.py index 121e3666..f6ba7f52 100644 --- a/cobo_waas2/models/payment_payout.py +++ b/cobo_waas2/models/payment_payout.py @@ -17,8 +17,8 @@ from pydantic import BaseModel, ConfigDict, Field, StrictInt, StrictStr from typing import Any, ClassVar, Dict, List, Optional -from cobo_waas2.models.bank_account import BankAccount from cobo_waas2.models.payment_payout_item import PaymentPayoutItem +from cobo_waas2.models.payment_payout_recipient_info import PaymentPayoutRecipientInfo from cobo_waas2.models.payment_payout_status import PaymentPayoutStatus from cobo_waas2.models.payout_channel import PayoutChannel from typing import Optional, Set @@ -32,15 +32,16 @@ class PaymentPayout(BaseModel): payout_id: StrictStr = Field(description="The payout ID generated by Cobo.") request_id: StrictStr = Field(description="The request ID provided by you when creating the payout.") payout_channel: PayoutChannel - payout_items: Optional[List[PaymentPayoutItem]] = None + source_account: Optional[StrictStr] = Field(default=None, description="The source account from which the payout will be made. - If the source account is a merchant account, provide the merchant's ID (e.g., \"M1001\"). - If the source account is the developer account, use the string `\"developer\"`. ") + payout_items: Optional[List[PaymentPayoutItem]] = Field(default=None, description="required") + recipient_info: Optional[PaymentPayoutRecipientInfo] = None + initiator: Optional[StrictStr] = Field(default=None, description="The initiator of this payout, usually the user's API key.") + actual_payout_amount: Optional[StrictStr] = Field(default=None, description="- For `Crypto` payouts: The amount of cryptocurrency sent to the recipient's address, denominated in the token specified in `recipient_info.token_id`. - For `OffRamp` payouts: The amount of fiat currency sent to the recipient's bank account, denominated in the currency specified in `recipient_info.currency`. (Note: The actual amount received may be lower due to additional bank transfer fees.) ") status: PaymentPayoutStatus - created_timestamp: Optional[StrictInt] = Field(default=None, description="The created time of the payout, represented as a UNIX timestamp in seconds.") - updated_timestamp: Optional[StrictInt] = Field(default=None, description="The updated time of the payout, represented as a UNIX timestamp in seconds.") - initiator: Optional[StrictStr] = Field(default=None, description="The initiator of this payout, usually the API key used to create the payout.") - currency: Optional[StrictStr] = Field(default=None, description="The fiat currency you will receive from the payout.") - actual_payout_amount: Optional[StrictStr] = Field(default=None, description="The total amount of cryptocurrency actually paid out for this payout. ") - bank_account: Optional[BankAccount] = None - __properties: ClassVar[List[str]] = ["payout_id", "request_id", "payout_channel", "payout_items", "status", "created_timestamp", "updated_timestamp", "initiator", "currency", "actual_payout_amount", "bank_account"] + remark: Optional[StrictStr] = Field(default=None, description="A note or comment about the payout.") + created_timestamp: StrictInt = Field(description="The created time of the payout, represented as a UNIX timestamp in seconds.") + updated_timestamp: StrictInt = Field(description="The updated time of the payout, represented as a UNIX timestamp in seconds.") + __properties: ClassVar[List[str]] = ["payout_id", "request_id", "payout_channel", "source_account", "payout_items", "recipient_info", "initiator", "actual_payout_amount", "status", "remark", "created_timestamp", "updated_timestamp"] model_config = ConfigDict( populate_by_name=True, @@ -88,9 +89,9 @@ def to_dict(self) -> Dict[str, Any]: if _item: _items.append(_item.to_dict()) _dict['payout_items'] = _items - # override the default output from pydantic by calling `to_dict()` of bank_account - if self.bank_account: - _dict['bank_account'] = self.bank_account.to_dict() + # override the default output from pydantic by calling `to_dict()` of recipient_info + if self.recipient_info: + _dict['recipient_info'] = self.recipient_info.to_dict() return _dict @classmethod @@ -106,14 +107,15 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: "payout_id": obj.get("payout_id"), "request_id": obj.get("request_id"), "payout_channel": obj.get("payout_channel"), + "source_account": obj.get("source_account"), "payout_items": [PaymentPayoutItem.from_dict(_item) for _item in obj["payout_items"]] if obj.get("payout_items") is not None else None, - "status": obj.get("status"), - "created_timestamp": obj.get("created_timestamp"), - "updated_timestamp": obj.get("updated_timestamp"), + "recipient_info": PaymentPayoutRecipientInfo.from_dict(obj["recipient_info"]) if obj.get("recipient_info") is not None else None, "initiator": obj.get("initiator"), - "currency": obj.get("currency"), "actual_payout_amount": obj.get("actual_payout_amount"), - "bank_account": BankAccount.from_dict(obj["bank_account"]) if obj.get("bank_account") is not None else None + "status": obj.get("status"), + "remark": obj.get("remark"), + "created_timestamp": obj.get("created_timestamp"), + "updated_timestamp": obj.get("updated_timestamp") }) return _obj diff --git a/cobo_waas2/models/payment_payout_detail.py b/cobo_waas2/models/payment_payout_detail.py index d9761a4d..b0281a11 100644 --- a/cobo_waas2/models/payment_payout_detail.py +++ b/cobo_waas2/models/payment_payout_detail.py @@ -17,9 +17,10 @@ from pydantic import BaseModel, ConfigDict, Field, StrictInt, StrictStr from typing import Any, ClassVar, Dict, List, Optional -from cobo_waas2.models.bank_account import BankAccount -from cobo_waas2.models.payment_payout_item_detail import PaymentPayoutItemDetail +from cobo_waas2.models.payment_payout_item import PaymentPayoutItem +from cobo_waas2.models.payment_payout_recipient_info import PaymentPayoutRecipientInfo from cobo_waas2.models.payment_payout_status import PaymentPayoutStatus +from cobo_waas2.models.payment_transaction import PaymentTransaction from cobo_waas2.models.payout_channel import PayoutChannel from typing import Optional, Set from typing_extensions import Self @@ -31,16 +32,18 @@ class PaymentPayoutDetail(BaseModel): """ # noqa: E501 payout_id: StrictStr = Field(description="The payout ID generated by Cobo.") request_id: StrictStr = Field(description="The request ID provided by you when creating the payout.") + payout_channel: PayoutChannel + source_account: Optional[StrictStr] = Field(default=None, description="The source account from which the payout will be made. - If the source account is a merchant account, provide the merchant's ID (e.g., \"M1001\"). - If the source account is the developer account, use the string `\"developer\"`. ") + payout_items: Optional[List[PaymentPayoutItem]] = Field(default=None, description="required") + recipient_info: Optional[PaymentPayoutRecipientInfo] = None + initiator: Optional[StrictStr] = Field(default=None, description="The initiator of this payout, usually the user's API key.") + actual_payout_amount: Optional[StrictStr] = Field(default=None, description="- For `Crypto` payouts: The amount of cryptocurrency sent to the recipient's address, denominated in the token specified in `recipient_info.token_id`. - For `OffRamp` payouts: The amount of fiat currency sent to the recipient's bank account, denominated in the currency specified in `recipient_info.currency`. (Note: The actual amount received may be lower due to additional bank transfer fees.) ") status: PaymentPayoutStatus - payout_item_details: Optional[List[PaymentPayoutItemDetail]] = None - created_timestamp: Optional[StrictInt] = Field(default=None, description="The created time of the payout, represented as a UNIX timestamp in seconds.") - updated_timestamp: Optional[StrictInt] = Field(default=None, description="The updated time of the payout, represented as a UNIX timestamp in seconds.") - initiator: Optional[StrictStr] = Field(default=None, description="The initiator of this payout, usually the API key used to create the payout.") - payout_channel: Optional[PayoutChannel] = None - currency: Optional[StrictStr] = Field(default=None, description="The fiat currency you will receive from the payout.") - actual_payout_amount: Optional[StrictStr] = Field(default=None, description="The total amount of cryptocurrency actually paid out for this payout. ") - bank_account: Optional[BankAccount] = None - __properties: ClassVar[List[str]] = ["payout_id", "request_id", "status", "payout_item_details", "created_timestamp", "updated_timestamp", "initiator", "payout_channel", "currency", "actual_payout_amount", "bank_account"] + remark: Optional[StrictStr] = Field(default=None, description="A note or comment about the payout.") + created_timestamp: StrictInt = Field(description="The created time of the payout, represented as a UNIX timestamp in seconds.") + updated_timestamp: StrictInt = Field(description="The updated time of the payout, represented as a UNIX timestamp in seconds.") + transactions: Optional[List[PaymentTransaction]] = Field(default=None, description="An array of payout transactions.") + __properties: ClassVar[List[str]] = ["payout_id", "request_id", "payout_channel", "source_account", "payout_items", "recipient_info", "initiator", "actual_payout_amount", "status", "remark", "created_timestamp", "updated_timestamp", "transactions"] model_config = ConfigDict( populate_by_name=True, @@ -81,16 +84,23 @@ def to_dict(self) -> Dict[str, Any]: exclude=excluded_fields, exclude_none=True, ) - # override the default output from pydantic by calling `to_dict()` of each item in payout_item_details (list) + # override the default output from pydantic by calling `to_dict()` of each item in payout_items (list) _items = [] - if self.payout_item_details: - for _item in self.payout_item_details: + if self.payout_items: + for _item in self.payout_items: if _item: _items.append(_item.to_dict()) - _dict['payout_item_details'] = _items - # override the default output from pydantic by calling `to_dict()` of bank_account - if self.bank_account: - _dict['bank_account'] = self.bank_account.to_dict() + _dict['payout_items'] = _items + # override the default output from pydantic by calling `to_dict()` of recipient_info + if self.recipient_info: + _dict['recipient_info'] = self.recipient_info.to_dict() + # override the default output from pydantic by calling `to_dict()` of each item in transactions (list) + _items = [] + if self.transactions: + for _item in self.transactions: + if _item: + _items.append(_item.to_dict()) + _dict['transactions'] = _items return _dict @classmethod @@ -105,15 +115,17 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: _obj = cls.model_validate({ "payout_id": obj.get("payout_id"), "request_id": obj.get("request_id"), + "payout_channel": obj.get("payout_channel"), + "source_account": obj.get("source_account"), + "payout_items": [PaymentPayoutItem.from_dict(_item) for _item in obj["payout_items"]] if obj.get("payout_items") is not None else None, + "recipient_info": PaymentPayoutRecipientInfo.from_dict(obj["recipient_info"]) if obj.get("recipient_info") is not None else None, + "initiator": obj.get("initiator"), + "actual_payout_amount": obj.get("actual_payout_amount"), "status": obj.get("status"), - "payout_item_details": [PaymentPayoutItemDetail.from_dict(_item) for _item in obj["payout_item_details"]] if obj.get("payout_item_details") is not None else None, + "remark": obj.get("remark"), "created_timestamp": obj.get("created_timestamp"), "updated_timestamp": obj.get("updated_timestamp"), - "initiator": obj.get("initiator"), - "payout_channel": obj.get("payout_channel"), - "currency": obj.get("currency"), - "actual_payout_amount": obj.get("actual_payout_amount"), - "bank_account": BankAccount.from_dict(obj["bank_account"]) if obj.get("bank_account") is not None else None + "transactions": [PaymentTransaction.from_dict(_item) for _item in obj["transactions"]] if obj.get("transactions") is not None else None }) return _obj diff --git a/cobo_waas2/models/payment_payout_event.py b/cobo_waas2/models/payment_payout_event.py index 88cfa8d7..6031e8e3 100644 --- a/cobo_waas2/models/payment_payout_event.py +++ b/cobo_waas2/models/payment_payout_event.py @@ -17,9 +17,10 @@ from pydantic import BaseModel, ConfigDict, Field, StrictInt, StrictStr, field_validator from typing import Any, ClassVar, Dict, List, Optional -from cobo_waas2.models.bank_account import BankAccount -from cobo_waas2.models.payment_payout_item_detail import PaymentPayoutItemDetail +from cobo_waas2.models.payment_payout_item import PaymentPayoutItem +from cobo_waas2.models.payment_payout_recipient_info import PaymentPayoutRecipientInfo from cobo_waas2.models.payment_payout_status import PaymentPayoutStatus +from cobo_waas2.models.payment_transaction import PaymentTransaction from cobo_waas2.models.payout_channel import PayoutChannel from typing import Optional, Set from typing_extensions import Self @@ -29,25 +30,27 @@ class PaymentPayoutEvent(BaseModel): """ PaymentPayoutEvent """ # noqa: E501 - data_type: StrictStr = Field(description=" The data type of the event. - `Transaction`: The transaction event data. - `TSSRequest`: The TSS request event data. - `Addresses`: The addresses event data. - `WalletInfo`: The wallet information event data. - `MPCVault`: The MPC vault event data. - `Chains`: The enabled chain event data. - `Tokens`: The enabled token event data. - `TokenListing`: The token listing event data. - `PaymentOrder`: The payment order event data. - `PaymentRefund`: The payment refund event data. - `PaymentSettlement`: The payment settlement event data. - `PaymentTransaction`: The payment transaction event data. - `PaymentAddressUpdate`: The top-up address update event data. - `PaymentPayout`: The payment payout event data. - `BalanceUpdateInfo`: The balance update event data. - `SuspendedToken`: The token suspension event data. - `ComplianceDisposition`: The compliance disposition event data. - `ComplianceKytScreenings`: The compliance KYT screenings event data. - `ComplianceKyaScreenings`: The compliance KYA screenings event data.") + data_type: StrictStr = Field(description=" The data type of the event. - `Transaction`: The transaction event data. - `TSSRequest`: The TSS request event data. - `Addresses`: The addresses event data. - `WalletInfo`: The wallet information event data. - `MPCVault`: The MPC vault event data. - `Chains`: The enabled chain event data. - `Tokens`: The enabled token event data. - `TokenListing`: The token listing event data. - `PaymentOrder`: The payment order event data. - `PaymentRefund`: The payment refund event data. - `PaymentSettlement`: The payment settlement event data. - `PaymentTransaction`: The payment transaction event data. - `PaymentAddressUpdate`: The top-up address update event data. - `PaymentPayout`: The payment payout event data. - `PaymentBulkSend`: The payment bulk send event data. - `BalanceUpdateInfo`: The balance update event data. - `SuspendedToken`: The token suspension event data. - `ComplianceDisposition`: The compliance disposition event data. - `ComplianceKytScreenings`: The compliance KYT screenings event data. - `ComplianceKyaScreenings`: The compliance KYA screenings event data.") payout_id: StrictStr = Field(description="The payout ID generated by Cobo.") request_id: StrictStr = Field(description="The request ID provided by you when creating the payout.") + payout_channel: PayoutChannel + source_account: Optional[StrictStr] = Field(default=None, description="The source account from which the payout will be made. - If the source account is a merchant account, provide the merchant's ID (e.g., \"M1001\"). - If the source account is the developer account, use the string `\"developer\"`. ") + payout_items: Optional[List[PaymentPayoutItem]] = Field(default=None, description="required") + recipient_info: Optional[PaymentPayoutRecipientInfo] = None + initiator: Optional[StrictStr] = Field(default=None, description="The initiator of this payout, usually the user's API key.") + actual_payout_amount: Optional[StrictStr] = Field(default=None, description="- For `Crypto` payouts: The amount of cryptocurrency sent to the recipient's address, denominated in the token specified in `recipient_info.token_id`. - For `OffRamp` payouts: The amount of fiat currency sent to the recipient's bank account, denominated in the currency specified in `recipient_info.currency`. (Note: The actual amount received may be lower due to additional bank transfer fees.) ") status: PaymentPayoutStatus - payout_item_details: Optional[List[PaymentPayoutItemDetail]] = None - created_timestamp: Optional[StrictInt] = Field(default=None, description="The created time of the payout, represented as a UNIX timestamp in seconds.") - updated_timestamp: Optional[StrictInt] = Field(default=None, description="The updated time of the payout, represented as a UNIX timestamp in seconds.") - initiator: Optional[StrictStr] = Field(default=None, description="The initiator of this payout, usually the API key used to create the payout.") - payout_channel: Optional[PayoutChannel] = None - currency: Optional[StrictStr] = Field(default=None, description="The fiat currency you will receive from the payout.") - actual_payout_amount: Optional[StrictStr] = Field(default=None, description="The total amount of cryptocurrency actually paid out for this payout. ") - bank_account: Optional[BankAccount] = None - __properties: ClassVar[List[str]] = ["data_type", "payout_id", "request_id", "status", "payout_item_details", "created_timestamp", "updated_timestamp", "initiator", "payout_channel", "currency", "actual_payout_amount", "bank_account"] + remark: Optional[StrictStr] = Field(default=None, description="A note or comment about the payout.") + created_timestamp: StrictInt = Field(description="The created time of the payout, represented as a UNIX timestamp in seconds.") + updated_timestamp: StrictInt = Field(description="The updated time of the payout, represented as a UNIX timestamp in seconds.") + transactions: Optional[List[PaymentTransaction]] = Field(default=None, description="An array of payout transactions.") + __properties: ClassVar[List[str]] = ["data_type", "payout_id", "request_id", "payout_channel", "source_account", "payout_items", "recipient_info", "initiator", "actual_payout_amount", "status", "remark", "created_timestamp", "updated_timestamp", "transactions"] @field_validator('data_type') def data_type_validate_enum(cls, value): """Validates the enum""" - if value not in set(['Transaction', 'TSSRequest', 'Addresses', 'WalletInfo', 'MPCVault', 'Chains', 'Tokens', 'TokenListing', 'PaymentOrder', 'PaymentRefund', 'PaymentSettlement', 'PaymentTransaction', 'PaymentAddressUpdate', 'PaymentPayout', 'BalanceUpdateInfo', 'SuspendedToken', 'ComplianceDisposition', 'ComplianceKytScreenings', 'ComplianceKyaScreenings']): - raise ValueError("must be one of enum values ('Transaction', 'TSSRequest', 'Addresses', 'WalletInfo', 'MPCVault', 'Chains', 'Tokens', 'TokenListing', 'PaymentOrder', 'PaymentRefund', 'PaymentSettlement', 'PaymentTransaction', 'PaymentAddressUpdate', 'PaymentPayout', 'BalanceUpdateInfo', 'SuspendedToken', 'ComplianceDisposition', 'ComplianceKytScreenings', 'ComplianceKyaScreenings')") + if value not in set(['Transaction', 'TSSRequest', 'Addresses', 'WalletInfo', 'MPCVault', 'Chains', 'Tokens', 'TokenListing', 'PaymentOrder', 'PaymentRefund', 'PaymentSettlement', 'PaymentTransaction', 'PaymentAddressUpdate', 'PaymentPayout', 'PaymentBulkSend', 'BalanceUpdateInfo', 'SuspendedToken', 'ComplianceDisposition', 'ComplianceKytScreenings', 'ComplianceKyaScreenings']): + raise ValueError("must be one of enum values ('Transaction', 'TSSRequest', 'Addresses', 'WalletInfo', 'MPCVault', 'Chains', 'Tokens', 'TokenListing', 'PaymentOrder', 'PaymentRefund', 'PaymentSettlement', 'PaymentTransaction', 'PaymentAddressUpdate', 'PaymentPayout', 'PaymentBulkSend', 'BalanceUpdateInfo', 'SuspendedToken', 'ComplianceDisposition', 'ComplianceKytScreenings', 'ComplianceKyaScreenings')") return value model_config = ConfigDict( @@ -89,16 +92,23 @@ def to_dict(self) -> Dict[str, Any]: exclude=excluded_fields, exclude_none=True, ) - # override the default output from pydantic by calling `to_dict()` of each item in payout_item_details (list) + # override the default output from pydantic by calling `to_dict()` of each item in payout_items (list) _items = [] - if self.payout_item_details: - for _item in self.payout_item_details: + if self.payout_items: + for _item in self.payout_items: if _item: _items.append(_item.to_dict()) - _dict['payout_item_details'] = _items - # override the default output from pydantic by calling `to_dict()` of bank_account - if self.bank_account: - _dict['bank_account'] = self.bank_account.to_dict() + _dict['payout_items'] = _items + # override the default output from pydantic by calling `to_dict()` of recipient_info + if self.recipient_info: + _dict['recipient_info'] = self.recipient_info.to_dict() + # override the default output from pydantic by calling `to_dict()` of each item in transactions (list) + _items = [] + if self.transactions: + for _item in self.transactions: + if _item: + _items.append(_item.to_dict()) + _dict['transactions'] = _items return _dict @classmethod @@ -114,15 +124,17 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: "data_type": obj.get("data_type"), "payout_id": obj.get("payout_id"), "request_id": obj.get("request_id"), + "payout_channel": obj.get("payout_channel"), + "source_account": obj.get("source_account"), + "payout_items": [PaymentPayoutItem.from_dict(_item) for _item in obj["payout_items"]] if obj.get("payout_items") is not None else None, + "recipient_info": PaymentPayoutRecipientInfo.from_dict(obj["recipient_info"]) if obj.get("recipient_info") is not None else None, + "initiator": obj.get("initiator"), + "actual_payout_amount": obj.get("actual_payout_amount"), "status": obj.get("status"), - "payout_item_details": [PaymentPayoutItemDetail.from_dict(_item) for _item in obj["payout_item_details"]] if obj.get("payout_item_details") is not None else None, + "remark": obj.get("remark"), "created_timestamp": obj.get("created_timestamp"), "updated_timestamp": obj.get("updated_timestamp"), - "initiator": obj.get("initiator"), - "payout_channel": obj.get("payout_channel"), - "currency": obj.get("currency"), - "actual_payout_amount": obj.get("actual_payout_amount"), - "bank_account": BankAccount.from_dict(obj["bank_account"]) if obj.get("bank_account") is not None else None + "transactions": [PaymentTransaction.from_dict(_item) for _item in obj["transactions"]] if obj.get("transactions") is not None else None }) return _obj diff --git a/cobo_waas2/models/payment_payout_item.py b/cobo_waas2/models/payment_payout_item.py index ef0cad8c..d3eef89c 100644 --- a/cobo_waas2/models/payment_payout_item.py +++ b/cobo_waas2/models/payment_payout_item.py @@ -15,12 +15,9 @@ import re # noqa: F401 import json -from pydantic import BaseModel, ConfigDict, Field, StrictInt, StrictStr +from pydantic import BaseModel, ConfigDict, Field, StrictStr from typing import Any, ClassVar, Dict, List, Optional from cobo_waas2.models.bridging_fee import BridgingFee -from cobo_waas2.models.commission_fee import CommissionFee -from cobo_waas2.models.payment_payout_item_status import PaymentPayoutItemStatus -from cobo_waas2.models.payment_transaction import PaymentTransaction from typing import Optional, Set from typing_extensions import Self @@ -29,21 +26,10 @@ class PaymentPayoutItem(BaseModel): """ PaymentPayoutItem """ # noqa: E501 - payout_item_id: StrictStr = Field(description="The payout item ID generated by Cobo.") - payout_id: StrictStr = Field(description="The payout ID generated by Cobo.") - token_id: Optional[StrictStr] = Field(default=None, description="The ID of the cryptocurrency paid out.") - chain_id: Optional[StrictStr] = Field(default=None, description="The ID of the blockchain network on which the payout occurred.") - amount: StrictStr = Field(description="The amount of the cryptocurrency to pay out. ") - status: PaymentPayoutItemStatus - source_account: StrictStr = Field(description="The source account from which the payout was made. - If the source account is a merchant account, provide the merchant's ID (e.g., \"M1001\"). - If the source account is the developer account, use the string `\"developer\"`. ") - transactions: Optional[List[PaymentTransaction]] = Field(default=None, description="An array of transactions associated with this payout item. Each transaction represents a separate blockchain operation related to the payout item process.") - created_timestamp: Optional[StrictInt] = Field(default=None, description="The created time of the payout item, represented as a UNIX timestamp in seconds.") - updated_timestamp: Optional[StrictInt] = Field(default=None, description="The updated time of the payout item, represented as a UNIX timestamp in seconds.") - crypto_address_id: Optional[StrictStr] = Field(default=None, description="The ID of the crypto address used for crypto payouts.") - crypto_address: Optional[StrictStr] = Field(default=None, description="The actual blockchain address to which funds were transferred.") - commission_fee: Optional[CommissionFee] = None + token_id: StrictStr = Field(description="The token ID of the payout item.") + amount: StrictStr = Field(description="The amount of the payout item. ") bridging_fee: Optional[BridgingFee] = None - __properties: ClassVar[List[str]] = ["payout_item_id", "payout_id", "token_id", "chain_id", "amount", "status", "source_account", "transactions", "created_timestamp", "updated_timestamp", "crypto_address_id", "crypto_address", "commission_fee", "bridging_fee"] + __properties: ClassVar[List[str]] = ["token_id", "amount", "bridging_fee"] model_config = ConfigDict( populate_by_name=True, @@ -84,16 +70,6 @@ def to_dict(self) -> Dict[str, Any]: exclude=excluded_fields, exclude_none=True, ) - # override the default output from pydantic by calling `to_dict()` of each item in transactions (list) - _items = [] - if self.transactions: - for _item in self.transactions: - if _item: - _items.append(_item.to_dict()) - _dict['transactions'] = _items - # override the default output from pydantic by calling `to_dict()` of commission_fee - if self.commission_fee: - _dict['commission_fee'] = self.commission_fee.to_dict() # override the default output from pydantic by calling `to_dict()` of bridging_fee if self.bridging_fee: _dict['bridging_fee'] = self.bridging_fee.to_dict() @@ -109,19 +85,8 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: return cls.model_validate(obj) _obj = cls.model_validate({ - "payout_item_id": obj.get("payout_item_id"), - "payout_id": obj.get("payout_id"), "token_id": obj.get("token_id"), - "chain_id": obj.get("chain_id"), "amount": obj.get("amount"), - "status": obj.get("status"), - "source_account": obj.get("source_account"), - "transactions": [PaymentTransaction.from_dict(_item) for _item in obj["transactions"]] if obj.get("transactions") is not None else None, - "created_timestamp": obj.get("created_timestamp"), - "updated_timestamp": obj.get("updated_timestamp"), - "crypto_address_id": obj.get("crypto_address_id"), - "crypto_address": obj.get("crypto_address"), - "commission_fee": CommissionFee.from_dict(obj["commission_fee"]) if obj.get("commission_fee") is not None else None, "bridging_fee": BridgingFee.from_dict(obj["bridging_fee"]) if obj.get("bridging_fee") is not None else None }) return _obj diff --git a/cobo_waas2/models/payment_payout_item_detail.py b/cobo_waas2/models/payment_payout_item_detail.py deleted file mode 100644 index 4a4635f1..00000000 --- a/cobo_waas2/models/payment_payout_item_detail.py +++ /dev/null @@ -1,129 +0,0 @@ -# coding: utf-8 - -""" - Cobo Wallet as a Service 2.0 - - Contact: help@cobo.com - Generated by OpenAPI Generator (https://openapi-generator.tech) - - Do not edit the class manually. -""" # noqa: E501 - - -from __future__ import annotations -import pprint -import re # noqa: F401 -import json - -from pydantic import BaseModel, ConfigDict, Field, StrictInt, StrictStr -from typing import Any, ClassVar, Dict, List, Optional -from cobo_waas2.models.bridging_fee import BridgingFee -from cobo_waas2.models.commission_fee import CommissionFee -from cobo_waas2.models.payment_payout_status import PaymentPayoutStatus -from cobo_waas2.models.payment_transaction import PaymentTransaction -from typing import Optional, Set -from typing_extensions import Self - - -class PaymentPayoutItemDetail(BaseModel): - """ - PaymentPayoutItemDetail - """ # noqa: E501 - payout_item_id: StrictStr = Field(description="The payout item ID generated by Cobo.") - payout_id: StrictStr = Field(description="The payout ID generated by Cobo.") - token_id: Optional[StrictStr] = Field(default=None, description="The ID of the cryptocurrency paid out.") - chain_id: Optional[StrictStr] = Field(default=None, description="The ID of the blockchain network on which the payout occurred.") - source_account: StrictStr = Field(description="The source account from which the payout was made. - If the source account is a merchant account, provide the merchant's ID (e.g., \"M1001\"). - If the source account is the developer account, use the string `\"developer\"`. ") - amount: StrictStr = Field(description="The amount of the cryptocurrency paid out. ") - status: PaymentPayoutStatus - transactions: Optional[List[PaymentTransaction]] = Field(default=None, description="An array of transactions associated with this payout item. Each transaction represents a separate blockchain operation related to the payout process.") - created_timestamp: Optional[StrictInt] = Field(default=None, description="The created time of the payout, represented as a UNIX timestamp in seconds.") - updated_timestamp: Optional[StrictInt] = Field(default=None, description="The updated time of the payout, represented as a UNIX timestamp in seconds.") - crypto_address_id: Optional[StrictStr] = Field(default=None, description="The ID of the crypto address used for crypto payouts.") - crypto_address: Optional[StrictStr] = Field(default=None, description="The actual blockchain address to which funds were transferred for crypto payouts.") - commission_fee: Optional[CommissionFee] = None - bridging_fee: Optional[BridgingFee] = None - __properties: ClassVar[List[str]] = ["payout_item_id", "payout_id", "token_id", "chain_id", "source_account", "amount", "status", "transactions", "created_timestamp", "updated_timestamp", "crypto_address_id", "crypto_address", "commission_fee", "bridging_fee"] - - model_config = ConfigDict( - populate_by_name=True, - validate_assignment=True, - protected_namespaces=(), - ) - - - def to_str(self) -> str: - """Returns the string representation of the model using alias""" - return pprint.pformat(self.model_dump(by_alias=True)) - - def to_json(self) -> str: - """Returns the JSON representation of the model using alias""" - # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead - return json.dumps(self.to_dict()) - - @classmethod - def from_json(cls, json_str: str) -> Optional[Self]: - """Create an instance of PaymentPayoutItemDetail from a JSON string""" - return cls.from_dict(json.loads(json_str)) - - def to_dict(self) -> Dict[str, Any]: - """Return the dictionary representation of the model using alias. - - This has the following differences from calling pydantic's - `self.model_dump(by_alias=True)`: - - * `None` is only added to the output dict for nullable fields that - were set at model initialization. Other fields with value `None` - are ignored. - """ - excluded_fields: Set[str] = set([ - ]) - - _dict = self.model_dump( - by_alias=True, - exclude=excluded_fields, - exclude_none=True, - ) - # override the default output from pydantic by calling `to_dict()` of each item in transactions (list) - _items = [] - if self.transactions: - for _item in self.transactions: - if _item: - _items.append(_item.to_dict()) - _dict['transactions'] = _items - # override the default output from pydantic by calling `to_dict()` of commission_fee - if self.commission_fee: - _dict['commission_fee'] = self.commission_fee.to_dict() - # override the default output from pydantic by calling `to_dict()` of bridging_fee - if self.bridging_fee: - _dict['bridging_fee'] = self.bridging_fee.to_dict() - return _dict - - @classmethod - def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: - """Create an instance of PaymentPayoutItemDetail from a dict""" - if obj is None: - return None - - if not isinstance(obj, dict): - return cls.model_validate(obj) - - _obj = cls.model_validate({ - "payout_item_id": obj.get("payout_item_id"), - "payout_id": obj.get("payout_id"), - "token_id": obj.get("token_id"), - "chain_id": obj.get("chain_id"), - "source_account": obj.get("source_account"), - "amount": obj.get("amount"), - "status": obj.get("status"), - "transactions": [PaymentTransaction.from_dict(_item) for _item in obj["transactions"]] if obj.get("transactions") is not None else None, - "created_timestamp": obj.get("created_timestamp"), - "updated_timestamp": obj.get("updated_timestamp"), - "crypto_address_id": obj.get("crypto_address_id"), - "crypto_address": obj.get("crypto_address"), - "commission_fee": CommissionFee.from_dict(obj["commission_fee"]) if obj.get("commission_fee") is not None else None, - "bridging_fee": BridgingFee.from_dict(obj["bridging_fee"]) if obj.get("bridging_fee") is not None else None - }) - return _obj - - diff --git a/cobo_waas2/models/payment_payout_item_status.py b/cobo_waas2/models/payment_payout_item_status.py deleted file mode 100644 index aa7fcf83..00000000 --- a/cobo_waas2/models/payment_payout_item_status.py +++ /dev/null @@ -1,44 +0,0 @@ -# coding: utf-8 - -""" - Cobo Wallet as a Service 2.0 - - Contact: help@cobo.com - Generated by OpenAPI Generator (https://openapi-generator.tech) - - Do not edit the class manually. -""" # noqa: E501 - - -from __future__ import annotations -import json -from enum import Enum -from typing_extensions import Self - - -class PaymentPayoutItemStatus(str, Enum): - """ - The current status of the payout item: - `Pending`: The payout item has been created and is awaiting processing. - `Processing`: The payout item is being processed. - `Completed`: The funds have been successfully deposited into the bank account. - `PartiallyCompleted`: Some payout item transactions have been completed successfully, while others have failed. - `Failed`: The payout item could not be completed due to an error. - """ - - """ - allowed enum values - """ - PENDING = 'Pending' - PROCESSING = 'Processing' - COMPLETED = 'Completed' - PARTIALLYCOMPLETED = 'PartiallyCompleted' - FAILED = 'Failed' - - UNKNOWN = None - - @classmethod - def from_json(cls, json_str: str) -> Self: - """Create an instance of PaymentPayoutItemStatus from a JSON string""" - return cls(json.loads(json_str)) - - @classmethod - def _missing_(cls, value): - return cls.UNKNOWN - - diff --git a/cobo_waas2/models/payment_payout_param.py b/cobo_waas2/models/payment_payout_param.py index a486e30f..bb7071b2 100644 --- a/cobo_waas2/models/payment_payout_param.py +++ b/cobo_waas2/models/payment_payout_param.py @@ -16,7 +16,7 @@ import json from pydantic import BaseModel, ConfigDict, Field, StrictStr -from typing import Any, ClassVar, Dict, List, Optional +from typing import Any, ClassVar, Dict, List from typing import Optional, Set from typing_extensions import Self @@ -25,12 +25,9 @@ class PaymentPayoutParam(BaseModel): """ PaymentPayoutParam """ # noqa: E501 - source_account: StrictStr = Field(description="The source account from which the payout will be made. - If the source account is a merchant account, provide the merchant's ID (e.g., \"M1001\"). - If the source account is the developer account, use the string `\"developer\"`. ") token_id: StrictStr = Field(description="The ID of the cryptocurrency you want to pay out. Specify this field when `payout_channel` is set to `Crypto`. Supported values: - USDC: `ETH_USDC`, `ARBITRUM_USDC`, `SOL_USDC`, `BASE_USDC`, `MATIC_USDC`, `BSC_USDC` - USDT: `TRON_USDT`, `ETH_USDT`, `ARBITRUM_USDT`, `SOL_USDT`, `BASE_USDT`, `MATIC_USDT`, `BSC_USDT` ") - amount: StrictStr = Field(description="The amount of the cryptocurrency to pay out. ") - crypto_address_id: Optional[StrictStr] = Field(default=None, description="The ID of the crypto address used for crypto payouts. Specify this field when `payout_channel` is set to `Crypto`. Call [List crypto addresses](https://www.cobo.com/payments/en/api-references/payment/list-crypto-addresses) to retrieve registered crypto addresses. ") - crypto_address: Optional[StrictStr] = Field(default=None, description="The actual blockchain address to which funds will be transferred. Specify this field when `payout_channel` is set to `Crypto`. If you have enabled the *Use Destinations as Payout Whitelist* toggle in *Destinations*, you can only transfer to registered destinations. For more details, see [Destinations](https://www.cobo.com/payments/en/guides/destinations). ") - __properties: ClassVar[List[str]] = ["source_account", "token_id", "amount", "crypto_address_id", "crypto_address"] + amount: StrictStr = Field(description="The payout cryptocurrency amount. ") + __properties: ClassVar[List[str]] = ["token_id", "amount"] model_config = ConfigDict( populate_by_name=True, @@ -83,11 +80,8 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: return cls.model_validate(obj) _obj = cls.model_validate({ - "source_account": obj.get("source_account"), "token_id": obj.get("token_id"), - "amount": obj.get("amount"), - "crypto_address_id": obj.get("crypto_address_id"), - "crypto_address": obj.get("crypto_address") + "amount": obj.get("amount") }) return _obj diff --git a/cobo_waas2/models/payment_payout_recipient_info.py b/cobo_waas2/models/payment_payout_recipient_info.py new file mode 100644 index 00000000..cd9f0eac --- /dev/null +++ b/cobo_waas2/models/payment_payout_recipient_info.py @@ -0,0 +1,92 @@ +# coding: utf-8 + +""" + Cobo Wallet as a Service 2.0 + + Contact: help@cobo.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + + +class PaymentPayoutRecipientInfo(BaseModel): + """ + PaymentPayoutRecipientInfo + """ # noqa: E501 + address: Optional[StrictStr] = Field(default=None, description="The recipient's wallet address where the payout will be sent.") + token_id: Optional[StrictStr] = Field(default=None, description="The token ID for the cryptocurrency to be sent to the recipient. If `recipient_info.token_id` is on a different chain than `payout_param.token_id`, the token will be automatically bridged to the chain specified in `recipient_info.token_id`. ") + currency: Optional[StrictStr] = Field(default=None, description="The fiat currency of the bank account to which the payout will be sent.") + bank_account_id: Optional[StrictStr] = Field(default=None, description="The ID of the bank account to which the payout will be sent. You can retrieve the bank account ID by calling [List destination entries](https://www.cobo.com/payments/en/api-references/payment/list-destination-entries).") + __properties: ClassVar[List[str]] = ["address", "token_id", "currency", "bank_account_id"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of PaymentPayoutRecipientInfo from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of PaymentPayoutRecipientInfo from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "address": obj.get("address"), + "token_id": obj.get("token_id"), + "currency": obj.get("currency"), + "bank_account_id": obj.get("bank_account_id") + }) + return _obj + + diff --git a/cobo_waas2/models/payment_payout_status.py b/cobo_waas2/models/payment_payout_status.py index 16498321..01b50de8 100644 --- a/cobo_waas2/models/payment_payout_status.py +++ b/cobo_waas2/models/payment_payout_status.py @@ -18,18 +18,19 @@ class PaymentPayoutStatus(str, Enum): """ - The current status of the payout: - `Pending`: The payout has been created and is awaiting processing. - `Processing`: The payout is currently being processed, with at least one payout item in progress. - `Completed`: All requested payout items have been completed. - `PartiallyCompleted`: Some requested payout items have been completed successfully, while others have failed. - `Failed`: All requested payout items have failed. + The current status of the payout. Possible values include: - `Pending`: The payout has been created and is awaiting processing. - `Preparing`: The payout is being prepared for transfer. - `Transferring`: The payout is currently being transferred to the recipient's destination. - `Completed`: The payout has been successfully completed and all transactions have been processed. - `PartiallyCompleted`: The payout has been partially completed, with some transactions succeeding and others failing. - `Failed`: The payout has failed and no transactions were completed successfully. - `RejectedByBank`: The payout was rejected by the recipient's bank (applicable to OffRamp payouts only). """ """ allowed enum values """ PENDING = 'Pending' - PROCESSING = 'Processing' + PREPARING = 'Preparing' + TRANSFERRING = 'Transferring' COMPLETED = 'Completed' PARTIALLYCOMPLETED = 'PartiallyCompleted' FAILED = 'Failed' - CANCELED = 'Canceled' + REJECTEDBYBANK = 'RejectedByBank' UNKNOWN = None diff --git a/cobo_waas2/models/payment_refund_event_data.py b/cobo_waas2/models/payment_refund_event_data.py index 9276f1a5..2dfb87db 100644 --- a/cobo_waas2/models/payment_refund_event_data.py +++ b/cobo_waas2/models/payment_refund_event_data.py @@ -29,7 +29,7 @@ class PaymentRefundEventData(BaseModel): """ PaymentRefundEventData """ # noqa: E501 - data_type: StrictStr = Field(description=" The data type of the event. - `Transaction`: The transaction event data. - `TSSRequest`: The TSS request event data. - `Addresses`: The addresses event data. - `WalletInfo`: The wallet information event data. - `MPCVault`: The MPC vault event data. - `Chains`: The enabled chain event data. - `Tokens`: The enabled token event data. - `TokenListing`: The token listing event data. - `PaymentOrder`: The payment order event data. - `PaymentRefund`: The payment refund event data. - `PaymentSettlement`: The payment settlement event data. - `PaymentTransaction`: The payment transaction event data. - `PaymentAddressUpdate`: The top-up address update event data. - `PaymentPayout`: The payment payout event data. - `BalanceUpdateInfo`: The balance update event data. - `SuspendedToken`: The token suspension event data. - `ComplianceDisposition`: The compliance disposition event data. - `ComplianceKytScreenings`: The compliance KYT screenings event data. - `ComplianceKyaScreenings`: The compliance KYA screenings event data.") + data_type: StrictStr = Field(description=" The data type of the event. - `Transaction`: The transaction event data. - `TSSRequest`: The TSS request event data. - `Addresses`: The addresses event data. - `WalletInfo`: The wallet information event data. - `MPCVault`: The MPC vault event data. - `Chains`: The enabled chain event data. - `Tokens`: The enabled token event data. - `TokenListing`: The token listing event data. - `PaymentOrder`: The payment order event data. - `PaymentRefund`: The payment refund event data. - `PaymentSettlement`: The payment settlement event data. - `PaymentTransaction`: The payment transaction event data. - `PaymentAddressUpdate`: The top-up address update event data. - `PaymentPayout`: The payment payout event data. - `PaymentBulkSend`: The payment bulk send event data. - `BalanceUpdateInfo`: The balance update event data. - `SuspendedToken`: The token suspension event data. - `ComplianceDisposition`: The compliance disposition event data. - `ComplianceKytScreenings`: The compliance KYT screenings event data. - `ComplianceKyaScreenings`: The compliance KYA screenings event data.") request_id: Optional[StrictStr] = Field(default=None, description="The request ID provided by you when creating the refund request.") refund_id: StrictStr = Field(description="The refund order ID.") order_id: Optional[StrictStr] = Field(default=None, description="The ID of the pay-in order corresponding to this refund.") @@ -53,8 +53,8 @@ class PaymentRefundEventData(BaseModel): @field_validator('data_type') def data_type_validate_enum(cls, value): """Validates the enum""" - if value not in set(['Transaction', 'TSSRequest', 'Addresses', 'WalletInfo', 'MPCVault', 'Chains', 'Tokens', 'TokenListing', 'PaymentOrder', 'PaymentRefund', 'PaymentSettlement', 'PaymentTransaction', 'PaymentAddressUpdate', 'PaymentPayout', 'BalanceUpdateInfo', 'SuspendedToken', 'ComplianceDisposition', 'ComplianceKytScreenings', 'ComplianceKyaScreenings']): - raise ValueError("must be one of enum values ('Transaction', 'TSSRequest', 'Addresses', 'WalletInfo', 'MPCVault', 'Chains', 'Tokens', 'TokenListing', 'PaymentOrder', 'PaymentRefund', 'PaymentSettlement', 'PaymentTransaction', 'PaymentAddressUpdate', 'PaymentPayout', 'BalanceUpdateInfo', 'SuspendedToken', 'ComplianceDisposition', 'ComplianceKytScreenings', 'ComplianceKyaScreenings')") + if value not in set(['Transaction', 'TSSRequest', 'Addresses', 'WalletInfo', 'MPCVault', 'Chains', 'Tokens', 'TokenListing', 'PaymentOrder', 'PaymentRefund', 'PaymentSettlement', 'PaymentTransaction', 'PaymentAddressUpdate', 'PaymentPayout', 'PaymentBulkSend', 'BalanceUpdateInfo', 'SuspendedToken', 'ComplianceDisposition', 'ComplianceKytScreenings', 'ComplianceKyaScreenings']): + raise ValueError("must be one of enum values ('Transaction', 'TSSRequest', 'Addresses', 'WalletInfo', 'MPCVault', 'Chains', 'Tokens', 'TokenListing', 'PaymentOrder', 'PaymentRefund', 'PaymentSettlement', 'PaymentTransaction', 'PaymentAddressUpdate', 'PaymentPayout', 'PaymentBulkSend', 'BalanceUpdateInfo', 'SuspendedToken', 'ComplianceDisposition', 'ComplianceKytScreenings', 'ComplianceKyaScreenings')") return value model_config = ConfigDict( diff --git a/cobo_waas2/models/payment_settlement_event.py b/cobo_waas2/models/payment_settlement_event.py index ce3a744f..03526f3e 100644 --- a/cobo_waas2/models/payment_settlement_event.py +++ b/cobo_waas2/models/payment_settlement_event.py @@ -31,7 +31,7 @@ class PaymentSettlementEvent(BaseModel): """ PaymentSettlementEvent """ # noqa: E501 - data_type: StrictStr = Field(description=" The data type of the event. - `Transaction`: The transaction event data. - `TSSRequest`: The TSS request event data. - `Addresses`: The addresses event data. - `WalletInfo`: The wallet information event data. - `MPCVault`: The MPC vault event data. - `Chains`: The enabled chain event data. - `Tokens`: The enabled token event data. - `TokenListing`: The token listing event data. - `PaymentOrder`: The payment order event data. - `PaymentRefund`: The payment refund event data. - `PaymentSettlement`: The payment settlement event data. - `PaymentTransaction`: The payment transaction event data. - `PaymentAddressUpdate`: The top-up address update event data. - `PaymentPayout`: The payment payout event data. - `BalanceUpdateInfo`: The balance update event data. - `SuspendedToken`: The token suspension event data. - `ComplianceDisposition`: The compliance disposition event data. - `ComplianceKytScreenings`: The compliance KYT screenings event data. - `ComplianceKyaScreenings`: The compliance KYA screenings event data.") + data_type: StrictStr = Field(description=" The data type of the event. - `Transaction`: The transaction event data. - `TSSRequest`: The TSS request event data. - `Addresses`: The addresses event data. - `WalletInfo`: The wallet information event data. - `MPCVault`: The MPC vault event data. - `Chains`: The enabled chain event data. - `Tokens`: The enabled token event data. - `TokenListing`: The token listing event data. - `PaymentOrder`: The payment order event data. - `PaymentRefund`: The payment refund event data. - `PaymentSettlement`: The payment settlement event data. - `PaymentTransaction`: The payment transaction event data. - `PaymentAddressUpdate`: The top-up address update event data. - `PaymentPayout`: The payment payout event data. - `PaymentBulkSend`: The payment bulk send event data. - `BalanceUpdateInfo`: The balance update event data. - `SuspendedToken`: The token suspension event data. - `ComplianceDisposition`: The compliance disposition event data. - `ComplianceKytScreenings`: The compliance KYT screenings event data. - `ComplianceKyaScreenings`: The compliance KYA screenings event data.") settlement_request_id: StrictStr = Field(description="The settlement request ID generated by Cobo.") request_id: StrictStr = Field(description="The request ID provided by you when creating the settlement request.") status: SettleRequestStatus @@ -50,8 +50,8 @@ class PaymentSettlementEvent(BaseModel): @field_validator('data_type') def data_type_validate_enum(cls, value): """Validates the enum""" - if value not in set(['Transaction', 'TSSRequest', 'Addresses', 'WalletInfo', 'MPCVault', 'Chains', 'Tokens', 'TokenListing', 'PaymentOrder', 'PaymentRefund', 'PaymentSettlement', 'PaymentTransaction', 'PaymentAddressUpdate', 'PaymentPayout', 'BalanceUpdateInfo', 'SuspendedToken', 'ComplianceDisposition', 'ComplianceKytScreenings', 'ComplianceKyaScreenings']): - raise ValueError("must be one of enum values ('Transaction', 'TSSRequest', 'Addresses', 'WalletInfo', 'MPCVault', 'Chains', 'Tokens', 'TokenListing', 'PaymentOrder', 'PaymentRefund', 'PaymentSettlement', 'PaymentTransaction', 'PaymentAddressUpdate', 'PaymentPayout', 'BalanceUpdateInfo', 'SuspendedToken', 'ComplianceDisposition', 'ComplianceKytScreenings', 'ComplianceKyaScreenings')") + if value not in set(['Transaction', 'TSSRequest', 'Addresses', 'WalletInfo', 'MPCVault', 'Chains', 'Tokens', 'TokenListing', 'PaymentOrder', 'PaymentRefund', 'PaymentSettlement', 'PaymentTransaction', 'PaymentAddressUpdate', 'PaymentPayout', 'PaymentBulkSend', 'BalanceUpdateInfo', 'SuspendedToken', 'ComplianceDisposition', 'ComplianceKytScreenings', 'ComplianceKyaScreenings']): + raise ValueError("must be one of enum values ('Transaction', 'TSSRequest', 'Addresses', 'WalletInfo', 'MPCVault', 'Chains', 'Tokens', 'TokenListing', 'PaymentOrder', 'PaymentRefund', 'PaymentSettlement', 'PaymentTransaction', 'PaymentAddressUpdate', 'PaymentPayout', 'PaymentBulkSend', 'BalanceUpdateInfo', 'SuspendedToken', 'ComplianceDisposition', 'ComplianceKytScreenings', 'ComplianceKyaScreenings')") return value model_config = ConfigDict( diff --git a/cobo_waas2/models/payment_transaction_event_data.py b/cobo_waas2/models/payment_transaction_event_data.py index 563a2db0..6b281560 100644 --- a/cobo_waas2/models/payment_transaction_event_data.py +++ b/cobo_waas2/models/payment_transaction_event_data.py @@ -38,7 +38,7 @@ class PaymentTransactionEventData(BaseModel): """ PaymentTransactionEventData """ # noqa: E501 - data_type: StrictStr = Field(description=" The data type of the event. - `Transaction`: The transaction event data. - `TSSRequest`: The TSS request event data. - `Addresses`: The addresses event data. - `WalletInfo`: The wallet information event data. - `MPCVault`: The MPC vault event data. - `Chains`: The enabled chain event data. - `Tokens`: The enabled token event data. - `TokenListing`: The token listing event data. - `PaymentOrder`: The payment order event data. - `PaymentRefund`: The payment refund event data. - `PaymentSettlement`: The payment settlement event data. - `PaymentTransaction`: The payment transaction event data. - `PaymentAddressUpdate`: The top-up address update event data. - `PaymentPayout`: The payment payout event data. - `BalanceUpdateInfo`: The balance update event data. - `SuspendedToken`: The token suspension event data. - `ComplianceDisposition`: The compliance disposition event data. - `ComplianceKytScreenings`: The compliance KYT screenings event data. - `ComplianceKyaScreenings`: The compliance KYA screenings event data.") + data_type: StrictStr = Field(description=" The data type of the event. - `Transaction`: The transaction event data. - `TSSRequest`: The TSS request event data. - `Addresses`: The addresses event data. - `WalletInfo`: The wallet information event data. - `MPCVault`: The MPC vault event data. - `Chains`: The enabled chain event data. - `Tokens`: The enabled token event data. - `TokenListing`: The token listing event data. - `PaymentOrder`: The payment order event data. - `PaymentRefund`: The payment refund event data. - `PaymentSettlement`: The payment settlement event data. - `PaymentTransaction`: The payment transaction event data. - `PaymentAddressUpdate`: The top-up address update event data. - `PaymentPayout`: The payment payout event data. - `PaymentBulkSend`: The payment bulk send event data. - `BalanceUpdateInfo`: The balance update event data. - `SuspendedToken`: The token suspension event data. - `ComplianceDisposition`: The compliance disposition event data. - `ComplianceKytScreenings`: The compliance KYT screenings event data. - `ComplianceKyaScreenings`: The compliance KYA screenings event data.") transaction_id: StrictStr = Field(description="The transaction ID.") cobo_id: Optional[StrictStr] = Field(default=None, description="The Cobo ID, which can be used to track a transaction.") request_id: Optional[StrictStr] = Field(default=None, description="The request ID that is used to track a transaction request. The request ID is provided by you and must be unique within your organization.") @@ -80,8 +80,8 @@ class PaymentTransactionEventData(BaseModel): @field_validator('data_type') def data_type_validate_enum(cls, value): """Validates the enum""" - if value not in set(['Transaction', 'TSSRequest', 'Addresses', 'WalletInfo', 'MPCVault', 'Chains', 'Tokens', 'TokenListing', 'PaymentOrder', 'PaymentRefund', 'PaymentSettlement', 'PaymentTransaction', 'PaymentAddressUpdate', 'PaymentPayout', 'BalanceUpdateInfo', 'SuspendedToken', 'ComplianceDisposition', 'ComplianceKytScreenings', 'ComplianceKyaScreenings']): - raise ValueError("must be one of enum values ('Transaction', 'TSSRequest', 'Addresses', 'WalletInfo', 'MPCVault', 'Chains', 'Tokens', 'TokenListing', 'PaymentOrder', 'PaymentRefund', 'PaymentSettlement', 'PaymentTransaction', 'PaymentAddressUpdate', 'PaymentPayout', 'BalanceUpdateInfo', 'SuspendedToken', 'ComplianceDisposition', 'ComplianceKytScreenings', 'ComplianceKyaScreenings')") + if value not in set(['Transaction', 'TSSRequest', 'Addresses', 'WalletInfo', 'MPCVault', 'Chains', 'Tokens', 'TokenListing', 'PaymentOrder', 'PaymentRefund', 'PaymentSettlement', 'PaymentTransaction', 'PaymentAddressUpdate', 'PaymentPayout', 'PaymentBulkSend', 'BalanceUpdateInfo', 'SuspendedToken', 'ComplianceDisposition', 'ComplianceKytScreenings', 'ComplianceKyaScreenings']): + raise ValueError("must be one of enum values ('Transaction', 'TSSRequest', 'Addresses', 'WalletInfo', 'MPCVault', 'Chains', 'Tokens', 'TokenListing', 'PaymentOrder', 'PaymentRefund', 'PaymentSettlement', 'PaymentTransaction', 'PaymentAddressUpdate', 'PaymentPayout', 'PaymentBulkSend', 'BalanceUpdateInfo', 'SuspendedToken', 'ComplianceDisposition', 'ComplianceKytScreenings', 'ComplianceKyaScreenings')") return value model_config = ConfigDict( diff --git a/cobo_waas2/models/payout_channel.py b/cobo_waas2/models/payout_channel.py index a6fb01ae..f43ff316 100644 --- a/cobo_waas2/models/payout_channel.py +++ b/cobo_waas2/models/payout_channel.py @@ -18,7 +18,7 @@ class PayoutChannel(str, Enum): """ - The channel through which payouts will be processed. Available options: - `Crypto`: Direct withdrawal to a crypto address. - `OffRamp`: Settle to a registered bank account. + The channel through which the payout will be processed. Possible values include: - `Crypto`: The payout will be processed as a cryptocurrency transfer to a crypto address. - `OffRamp`: The payout will be processed as a fiat currency transfer to a registered bank account. """ """ diff --git a/cobo_waas2/models/suspended_token_event_data.py b/cobo_waas2/models/suspended_token_event_data.py index b7261a47..dda53cd3 100644 --- a/cobo_waas2/models/suspended_token_event_data.py +++ b/cobo_waas2/models/suspended_token_event_data.py @@ -26,7 +26,7 @@ class SuspendedTokenEventData(BaseModel): """ SuspendedTokenEventData """ # noqa: E501 - data_type: StrictStr = Field(description=" The data type of the event. - `Transaction`: The transaction event data. - `TSSRequest`: The TSS request event data. - `Addresses`: The addresses event data. - `WalletInfo`: The wallet information event data. - `MPCVault`: The MPC vault event data. - `Chains`: The enabled chain event data. - `Tokens`: The enabled token event data. - `TokenListing`: The token listing event data. - `PaymentOrder`: The payment order event data. - `PaymentRefund`: The payment refund event data. - `PaymentSettlement`: The payment settlement event data. - `PaymentTransaction`: The payment transaction event data. - `PaymentAddressUpdate`: The top-up address update event data. - `PaymentPayout`: The payment payout event data. - `BalanceUpdateInfo`: The balance update event data. - `SuspendedToken`: The token suspension event data. - `ComplianceDisposition`: The compliance disposition event data. - `ComplianceKytScreenings`: The compliance KYT screenings event data. - `ComplianceKyaScreenings`: The compliance KYA screenings event data.") + data_type: StrictStr = Field(description=" The data type of the event. - `Transaction`: The transaction event data. - `TSSRequest`: The TSS request event data. - `Addresses`: The addresses event data. - `WalletInfo`: The wallet information event data. - `MPCVault`: The MPC vault event data. - `Chains`: The enabled chain event data. - `Tokens`: The enabled token event data. - `TokenListing`: The token listing event data. - `PaymentOrder`: The payment order event data. - `PaymentRefund`: The payment refund event data. - `PaymentSettlement`: The payment settlement event data. - `PaymentTransaction`: The payment transaction event data. - `PaymentAddressUpdate`: The top-up address update event data. - `PaymentPayout`: The payment payout event data. - `PaymentBulkSend`: The payment bulk send event data. - `BalanceUpdateInfo`: The balance update event data. - `SuspendedToken`: The token suspension event data. - `ComplianceDisposition`: The compliance disposition event data. - `ComplianceKytScreenings`: The compliance KYT screenings event data. - `ComplianceKyaScreenings`: The compliance KYA screenings event data.") token_ids: StrictStr = Field(description="A list of token IDs, separated by comma.") operation_type: SuspendedTokenOperationType __properties: ClassVar[List[str]] = ["data_type", "token_ids", "operation_type"] @@ -34,8 +34,8 @@ class SuspendedTokenEventData(BaseModel): @field_validator('data_type') def data_type_validate_enum(cls, value): """Validates the enum""" - if value not in set(['Transaction', 'TSSRequest', 'Addresses', 'WalletInfo', 'MPCVault', 'Chains', 'Tokens', 'TokenListing', 'PaymentOrder', 'PaymentRefund', 'PaymentSettlement', 'PaymentTransaction', 'PaymentAddressUpdate', 'PaymentPayout', 'BalanceUpdateInfo', 'SuspendedToken', 'ComplianceDisposition', 'ComplianceKytScreenings', 'ComplianceKyaScreenings']): - raise ValueError("must be one of enum values ('Transaction', 'TSSRequest', 'Addresses', 'WalletInfo', 'MPCVault', 'Chains', 'Tokens', 'TokenListing', 'PaymentOrder', 'PaymentRefund', 'PaymentSettlement', 'PaymentTransaction', 'PaymentAddressUpdate', 'PaymentPayout', 'BalanceUpdateInfo', 'SuspendedToken', 'ComplianceDisposition', 'ComplianceKytScreenings', 'ComplianceKyaScreenings')") + if value not in set(['Transaction', 'TSSRequest', 'Addresses', 'WalletInfo', 'MPCVault', 'Chains', 'Tokens', 'TokenListing', 'PaymentOrder', 'PaymentRefund', 'PaymentSettlement', 'PaymentTransaction', 'PaymentAddressUpdate', 'PaymentPayout', 'PaymentBulkSend', 'BalanceUpdateInfo', 'SuspendedToken', 'ComplianceDisposition', 'ComplianceKytScreenings', 'ComplianceKyaScreenings']): + raise ValueError("must be one of enum values ('Transaction', 'TSSRequest', 'Addresses', 'WalletInfo', 'MPCVault', 'Chains', 'Tokens', 'TokenListing', 'PaymentOrder', 'PaymentRefund', 'PaymentSettlement', 'PaymentTransaction', 'PaymentAddressUpdate', 'PaymentPayout', 'PaymentBulkSend', 'BalanceUpdateInfo', 'SuspendedToken', 'ComplianceDisposition', 'ComplianceKytScreenings', 'ComplianceKyaScreenings')") return value model_config = ConfigDict( diff --git a/cobo_waas2/models/token_listing_event_data.py b/cobo_waas2/models/token_listing_event_data.py index b83b3bde..c14aac96 100644 --- a/cobo_waas2/models/token_listing_event_data.py +++ b/cobo_waas2/models/token_listing_event_data.py @@ -30,7 +30,7 @@ class TokenListingEventData(BaseModel): """ TokenListingEventData """ # noqa: E501 - data_type: StrictStr = Field(description=" The data type of the event. - `Transaction`: The transaction event data. - `TSSRequest`: The TSS request event data. - `Addresses`: The addresses event data. - `WalletInfo`: The wallet information event data. - `MPCVault`: The MPC vault event data. - `Chains`: The enabled chain event data. - `Tokens`: The enabled token event data. - `TokenListing`: The token listing event data. - `PaymentOrder`: The payment order event data. - `PaymentRefund`: The payment refund event data. - `PaymentSettlement`: The payment settlement event data. - `PaymentTransaction`: The payment transaction event data. - `PaymentAddressUpdate`: The top-up address update event data. - `PaymentPayout`: The payment payout event data. - `BalanceUpdateInfo`: The balance update event data. - `SuspendedToken`: The token suspension event data. - `ComplianceDisposition`: The compliance disposition event data. - `ComplianceKytScreenings`: The compliance KYT screenings event data. - `ComplianceKyaScreenings`: The compliance KYA screenings event data.") + data_type: StrictStr = Field(description=" The data type of the event. - `Transaction`: The transaction event data. - `TSSRequest`: The TSS request event data. - `Addresses`: The addresses event data. - `WalletInfo`: The wallet information event data. - `MPCVault`: The MPC vault event data. - `Chains`: The enabled chain event data. - `Tokens`: The enabled token event data. - `TokenListing`: The token listing event data. - `PaymentOrder`: The payment order event data. - `PaymentRefund`: The payment refund event data. - `PaymentSettlement`: The payment settlement event data. - `PaymentTransaction`: The payment transaction event data. - `PaymentAddressUpdate`: The top-up address update event data. - `PaymentPayout`: The payment payout event data. - `PaymentBulkSend`: The payment bulk send event data. - `BalanceUpdateInfo`: The balance update event data. - `SuspendedToken`: The token suspension event data. - `ComplianceDisposition`: The compliance disposition event data. - `ComplianceKytScreenings`: The compliance KYT screenings event data. - `ComplianceKyaScreenings`: The compliance KYA screenings event data.") request_id: StrictStr = Field(description="The unique identifier of the token listing request.") chain_id: StrictStr = Field(description="The ID of the blockchain where the token is deployed.") contract_address: StrictStr = Field(description="The token's contract address on the specified blockchain.") @@ -47,8 +47,8 @@ class TokenListingEventData(BaseModel): @field_validator('data_type') def data_type_validate_enum(cls, value): """Validates the enum""" - if value not in set(['Transaction', 'TSSRequest', 'Addresses', 'WalletInfo', 'MPCVault', 'Chains', 'Tokens', 'TokenListing', 'PaymentOrder', 'PaymentRefund', 'PaymentSettlement', 'PaymentTransaction', 'PaymentAddressUpdate', 'PaymentPayout', 'BalanceUpdateInfo', 'SuspendedToken', 'ComplianceDisposition', 'ComplianceKytScreenings', 'ComplianceKyaScreenings']): - raise ValueError("must be one of enum values ('Transaction', 'TSSRequest', 'Addresses', 'WalletInfo', 'MPCVault', 'Chains', 'Tokens', 'TokenListing', 'PaymentOrder', 'PaymentRefund', 'PaymentSettlement', 'PaymentTransaction', 'PaymentAddressUpdate', 'PaymentPayout', 'BalanceUpdateInfo', 'SuspendedToken', 'ComplianceDisposition', 'ComplianceKytScreenings', 'ComplianceKyaScreenings')") + if value not in set(['Transaction', 'TSSRequest', 'Addresses', 'WalletInfo', 'MPCVault', 'Chains', 'Tokens', 'TokenListing', 'PaymentOrder', 'PaymentRefund', 'PaymentSettlement', 'PaymentTransaction', 'PaymentAddressUpdate', 'PaymentPayout', 'PaymentBulkSend', 'BalanceUpdateInfo', 'SuspendedToken', 'ComplianceDisposition', 'ComplianceKytScreenings', 'ComplianceKyaScreenings']): + raise ValueError("must be one of enum values ('Transaction', 'TSSRequest', 'Addresses', 'WalletInfo', 'MPCVault', 'Chains', 'Tokens', 'TokenListing', 'PaymentOrder', 'PaymentRefund', 'PaymentSettlement', 'PaymentTransaction', 'PaymentAddressUpdate', 'PaymentPayout', 'PaymentBulkSend', 'BalanceUpdateInfo', 'SuspendedToken', 'ComplianceDisposition', 'ComplianceKytScreenings', 'ComplianceKyaScreenings')") return value model_config = ConfigDict( diff --git a/cobo_waas2/models/tokens_event_data.py b/cobo_waas2/models/tokens_event_data.py index 136aeb51..fc539a3a 100644 --- a/cobo_waas2/models/tokens_event_data.py +++ b/cobo_waas2/models/tokens_event_data.py @@ -28,7 +28,7 @@ class TokensEventData(BaseModel): """ TokensEventData """ # noqa: E501 - data_type: StrictStr = Field(description=" The data type of the event. - `Transaction`: The transaction event data. - `TSSRequest`: The TSS request event data. - `Addresses`: The addresses event data. - `WalletInfo`: The wallet information event data. - `MPCVault`: The MPC vault event data. - `Chains`: The enabled chain event data. - `Tokens`: The enabled token event data. - `TokenListing`: The token listing event data. - `PaymentOrder`: The payment order event data. - `PaymentRefund`: The payment refund event data. - `PaymentSettlement`: The payment settlement event data. - `PaymentTransaction`: The payment transaction event data. - `PaymentAddressUpdate`: The top-up address update event data. - `PaymentPayout`: The payment payout event data. - `BalanceUpdateInfo`: The balance update event data. - `SuspendedToken`: The token suspension event data. - `ComplianceDisposition`: The compliance disposition event data. - `ComplianceKytScreenings`: The compliance KYT screenings event data. - `ComplianceKyaScreenings`: The compliance KYA screenings event data.") + data_type: StrictStr = Field(description=" The data type of the event. - `Transaction`: The transaction event data. - `TSSRequest`: The TSS request event data. - `Addresses`: The addresses event data. - `WalletInfo`: The wallet information event data. - `MPCVault`: The MPC vault event data. - `Chains`: The enabled chain event data. - `Tokens`: The enabled token event data. - `TokenListing`: The token listing event data. - `PaymentOrder`: The payment order event data. - `PaymentRefund`: The payment refund event data. - `PaymentSettlement`: The payment settlement event data. - `PaymentTransaction`: The payment transaction event data. - `PaymentAddressUpdate`: The top-up address update event data. - `PaymentPayout`: The payment payout event data. - `PaymentBulkSend`: The payment bulk send event data. - `BalanceUpdateInfo`: The balance update event data. - `SuspendedToken`: The token suspension event data. - `ComplianceDisposition`: The compliance disposition event data. - `ComplianceKytScreenings`: The compliance KYT screenings event data. - `ComplianceKyaScreenings`: The compliance KYA screenings event data.") tokens: List[TokenInfo] = Field(description="The enabled tokens.") wallet_type: Optional[WalletType] = None wallet_subtypes: Optional[List[WalletSubtype]] = None @@ -37,8 +37,8 @@ class TokensEventData(BaseModel): @field_validator('data_type') def data_type_validate_enum(cls, value): """Validates the enum""" - if value not in set(['Transaction', 'TSSRequest', 'Addresses', 'WalletInfo', 'MPCVault', 'Chains', 'Tokens', 'TokenListing', 'PaymentOrder', 'PaymentRefund', 'PaymentSettlement', 'PaymentTransaction', 'PaymentAddressUpdate', 'PaymentPayout', 'BalanceUpdateInfo', 'SuspendedToken', 'ComplianceDisposition', 'ComplianceKytScreenings', 'ComplianceKyaScreenings']): - raise ValueError("must be one of enum values ('Transaction', 'TSSRequest', 'Addresses', 'WalletInfo', 'MPCVault', 'Chains', 'Tokens', 'TokenListing', 'PaymentOrder', 'PaymentRefund', 'PaymentSettlement', 'PaymentTransaction', 'PaymentAddressUpdate', 'PaymentPayout', 'BalanceUpdateInfo', 'SuspendedToken', 'ComplianceDisposition', 'ComplianceKytScreenings', 'ComplianceKyaScreenings')") + if value not in set(['Transaction', 'TSSRequest', 'Addresses', 'WalletInfo', 'MPCVault', 'Chains', 'Tokens', 'TokenListing', 'PaymentOrder', 'PaymentRefund', 'PaymentSettlement', 'PaymentTransaction', 'PaymentAddressUpdate', 'PaymentPayout', 'PaymentBulkSend', 'BalanceUpdateInfo', 'SuspendedToken', 'ComplianceDisposition', 'ComplianceKytScreenings', 'ComplianceKyaScreenings']): + raise ValueError("must be one of enum values ('Transaction', 'TSSRequest', 'Addresses', 'WalletInfo', 'MPCVault', 'Chains', 'Tokens', 'TokenListing', 'PaymentOrder', 'PaymentRefund', 'PaymentSettlement', 'PaymentTransaction', 'PaymentAddressUpdate', 'PaymentPayout', 'PaymentBulkSend', 'BalanceUpdateInfo', 'SuspendedToken', 'ComplianceDisposition', 'ComplianceKytScreenings', 'ComplianceKyaScreenings')") return value model_config = ConfigDict( diff --git a/cobo_waas2/models/transaction_cobo_category.py b/cobo_waas2/models/transaction_cobo_category.py index 27f01c71..05f3b01c 100644 --- a/cobo_waas2/models/transaction_cobo_category.py +++ b/cobo_waas2/models/transaction_cobo_category.py @@ -18,7 +18,7 @@ class TransactionCoboCategory(str, Enum): """ - The transaction category defined by Cobo. Possible values include: - `AutoSweep`: An auto-sweep transaction. - `AutoFueling`: A transaction where Fee Station pays transaction fees to an address within your MPC Wallets. - `AutoFuelingRefund`: A refund for an auto-fueling transaction. - `SafeTxMessage`: A message signing transaction initiated by an MPC wallet to authorize a Smart Contract Wallet (Safe\\{Wallet\\}) transaction. - `BillPayment`: A transaction to pay Cobo bills through Fee Station. - `BillRefund`: A refund for a previously made bill payment. - `CommissionFeeCharge`: A transaction for commission-fee users that charges the commission fee incurred from various services. - `CommissionFeeRefund`: A refund of previously charged commission fees. - `StakingBabylonBtcDelegation`: A transaction for delegating BTC in Babylon staking. - `StakingBabylonBtcSignBabylon`: A transaction for signing Babylon operations with BTC. - `StakingBabylonClaim`: A transaction for claiming rewards from Babylon staking. - `StakingBabylonSlashing`: A transaction related to slashing penalties in Babylon staking. - `StakingBabylonStake`: A transaction for staking assets in the Babylon platform. - `StakingBabylonUnstake`: A transaction for unstaking assets from the Babylon platform. - `StakingBabylonWithdraw`: A transaction for withdrawing assets from Babylon staking. - `StakingBithiveClaim`: A transaction for claiming rewards from BitHive staking. - `StakingBithiveStake`: A transaction for staking assets in the BitHive platform. - `StakingBithiveUnstake`: A transaction for unstaking assets from the BitHive platform. - `StakingBithiveWithdraw`: A transaction for withdrawing assets from BitHive staking. - `StakingCoreStake`: A transaction for staking assets in the Core staking platform. - `StakingCoreWithdraw`: A transaction for withdrawing assets from Core staking. - `StakingEthClaim`: A transaction for claiming rewards from ETH staking. - `StakingEthStake`: A transaction for staking ETH assets. - `StakingEthUnstake`: A transaction for unstaking ETH assets. - `StakingSkyfarmClaim`: A transaction for claiming rewards from Skyfarm staking. - `StakingSkyfarmStake`: A transaction for staking assets in the Skyfarm platform. - `StakingSkyfarmUnstake`: A transaction for unstaking assets from the Skyfarm platform. - `ScreenAppRefund`: A refund transaction initiated through the Screening App. - `ScreenAppIsolate`: An isolation transaction initiated through the Screening App. - `ComplianceRefund`: A refund transaction initiated by Cobo KYT. - `ComplianceIsolate`: An isolation transaction initiated by Cobo KYT. - `StellarChangeTrust`: A transaction for establishing a trustline on the Stellar network. - `Tokenization`: A transaction for managing tokenized assets, such as minting or wrapping tokens. - `TokenizationGasSponsor`: A transaction where gas fees are sponsored for tokenization-related operations, ensuring the transaction proceeds even if the source address lacks sufficient balance. - `TokenSwap`: A transaction for token swapping or cross-chain bridging. - `NonceAccountSign`: A transaction signed using a **Solana nonce account**, enabling deterministic and replay-safe transaction execution on the Solana network. - `FeePayerSign`: A transaction where a **designated Solana fee payer account** covers the transaction fees, separating the fee payment from the main signer or source account. - `GasFeeSponsor`: A transaction where Fee Station pays the on-chain gas fee in USD stablecoin. - `GasFeeSponsorRefund`: A transaction that refunds gas fees previously sponsored and paid by Fee Station. + The transaction category defined by Cobo. Possible values include: - `AutoSweep`: An auto-sweep transaction. - `AutoFueling`: A transaction where Fee Station pays transaction fees to an address within your MPC Wallets. - `AutoFuelingRefund`: A refund for an auto-fueling transaction. - `SafeTxMessage`: A message signing transaction initiated by an MPC wallet to authorize a Smart Contract Wallet (Safe\\{Wallet\\}) transaction. - `BillPayment`: A transaction to pay Cobo bills through Fee Station. - `BillRefund`: A refund for a previously made bill payment. - `CommissionFeeCharge`: A transaction for commission-fee users that charges the commission fee incurred from various services. - `CommissionFeeRefund`: A refund of previously charged commission fees. - `StakingBabylonBtcDelegation`: A transaction for delegating BTC in Babylon staking. - `StakingBabylonBtcSignBabylon`: A transaction for signing Babylon operations with BTC. - `StakingBabylonClaim`: A transaction for claiming rewards from Babylon staking. - `StakingBabylonSlashing`: A transaction related to slashing penalties in Babylon staking. - `StakingBabylonStake`: A transaction for staking assets in the Babylon platform. - `StakingBabylonUnstake`: A transaction for unstaking assets from the Babylon platform. - `StakingBabylonWithdraw`: A transaction for withdrawing assets from Babylon staking. - `StakingBithiveClaim`: A transaction for claiming rewards from Bithive staking. - `StakingBithiveStake`: A transaction for staking assets in the Bithive platform. - `StakingBithiveUnstake`: A transaction for unstaking assets from the Bithive platform. - `StakingBithiveWithdraw`: A transaction for withdrawing assets from Bithive staking. - `StakingCoreStake`: A transaction for staking assets in the Core staking platform. - `StakingCoreWithdraw`: A transaction for withdrawing assets from Core staking. - `StakingEthClaim`: A transaction for claiming rewards from ETH staking. - `StakingEthStake`: A transaction for staking ETH assets. - `StakingEthUnstake`: A transaction for unstaking ETH assets. - `StakingSkyfarmClaim`: A transaction for claiming rewards from Skyfarm staking. - `StakingSkyfarmStake`: A transaction for staking assets in the Skyfarm platform. - `StakingSkyfarmUnstake`: A transaction for unstaking assets from the Skyfarm platform. - `StellarChangeTrust`: A transaction for establishing a trustline on the Stellar network.. - `Tokenization`: A transaction for managing tokenized assets, such as minting or wrapping tokens. - `TokenizationGasSponsor`: A transaction where gas fees are sponsored for tokenization-related operations, ensuring the transaction proceeds even if the source address lacks sufficient balance. - `TokenSwap`: A transaction for token swapping or cross-chain bridging. - `NonceAccountSign`: A transaction signed using a **Solana nonce account**, enabling deterministic and replay-safe transaction execution on the Solana network. - `FeePayerSign`: A transaction where a **designated Solana fee payer account** covers the transaction fees, separating the fee payment from the main signer or source account. - `GasFeeSponsor`: A transaction where Fee Station pays the on-chain gas fee in USD stablecoin. - `GasFeeSponsorRefund`: A transaction that refunds gas fees previously sponsored and paid by Fee Station. - `WalletConnect`: A transaction initiated by walletconnect. """ """ @@ -63,6 +63,7 @@ class TransactionCoboCategory(str, Enum): FEEPAYERSIGN = 'FeePayerSign' GASFEESPONSOR = 'GasFeeSponsor' GASFEESPONSORREFUND = 'GasFeeSponsorRefund' + WALLETCONNECT = 'WalletConnect' UNKNOWN = None diff --git a/cobo_waas2/models/transaction_extra_type.py b/cobo_waas2/models/transaction_extra_type.py index 71188af4..2bd0fda7 100644 --- a/cobo_waas2/models/transaction_extra_type.py +++ b/cobo_waas2/models/transaction_extra_type.py @@ -18,7 +18,7 @@ class TransactionExtraType(str, Enum): """ - The transaction extra information type. Possible values include: - `BabylonBusinessInfo`: The extra information related to Babylon business logic. - `BabylonTxParameters`: The extra information for Babylon transaction parameters. - `CoreStakeInfo`: The extra information related to core staking operations. + The transaction extra information type. Possible values include: - `BabylonBusinessInfo`: The extra information of Babylon business. - `BabylonTxParameters`: The extra information of Babylon transaction parameters. - `CoreStakeInfo`: The extra information of core stake. - `WalletConnectInfo`: The extra information of transaction initiated by walletconnect. """ """ @@ -27,6 +27,7 @@ class TransactionExtraType(str, Enum): BABYLONBUSINESSINFO = 'BabylonBusinessInfo' BABYLONTXPARAMETERS = 'BabylonTxParameters' CORESTAKEINFO = 'CoreStakeInfo' + WALLETCONNECTINFO = 'WalletConnectInfo' UNKNOWN = None diff --git a/cobo_waas2/models/transaction_wallet_connect_info.py b/cobo_waas2/models/transaction_wallet_connect_info.py new file mode 100644 index 00000000..18068402 --- /dev/null +++ b/cobo_waas2/models/transaction_wallet_connect_info.py @@ -0,0 +1,93 @@ +# coding: utf-8 + +""" + Cobo Wallet as a Service 2.0 + + Contact: help@cobo.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from cobo_waas2.models.transaction_extra_type import TransactionExtraType +from typing import Optional, Set +from typing_extensions import Self + + +class TransactionWalletConnectInfo(BaseModel): + """ + The extra information of transaction initiated by walletconnect. + """ # noqa: E501 + extra_type: TransactionExtraType + dapp_name: Optional[StrictStr] = Field(default=None, description="The dapp name that initiated this transaction.") + dapp_domain: Optional[StrictStr] = Field(default=None, description="The dapp domain that initiated this transaction") + session_id: Optional[StrictStr] = Field(default=None, description="The session id that initiated this transaction") + __properties: ClassVar[List[str]] = ["extra_type", "dapp_name", "dapp_domain", "session_id"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of TransactionWalletConnectInfo from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of TransactionWalletConnectInfo from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "extra_type": obj.get("extra_type"), + "dapp_name": obj.get("dapp_name"), + "dapp_domain": obj.get("dapp_domain"), + "session_id": obj.get("session_id") + }) + return _obj + + diff --git a/cobo_waas2/models/transaction_webhook_event_data.py b/cobo_waas2/models/transaction_webhook_event_data.py index 2c98dd22..e18b6bb8 100644 --- a/cobo_waas2/models/transaction_webhook_event_data.py +++ b/cobo_waas2/models/transaction_webhook_event_data.py @@ -37,7 +37,7 @@ class TransactionWebhookEventData(BaseModel): """ TransactionWebhookEventData """ # noqa: E501 - data_type: StrictStr = Field(description=" The data type of the event. - `Transaction`: The transaction event data. - `TSSRequest`: The TSS request event data. - `Addresses`: The addresses event data. - `WalletInfo`: The wallet information event data. - `MPCVault`: The MPC vault event data. - `Chains`: The enabled chain event data. - `Tokens`: The enabled token event data. - `TokenListing`: The token listing event data. - `PaymentOrder`: The payment order event data. - `PaymentRefund`: The payment refund event data. - `PaymentSettlement`: The payment settlement event data. - `PaymentTransaction`: The payment transaction event data. - `PaymentAddressUpdate`: The top-up address update event data. - `PaymentPayout`: The payment payout event data. - `BalanceUpdateInfo`: The balance update event data. - `SuspendedToken`: The token suspension event data. - `ComplianceDisposition`: The compliance disposition event data. - `ComplianceKytScreenings`: The compliance KYT screenings event data. - `ComplianceKyaScreenings`: The compliance KYA screenings event data.") + data_type: StrictStr = Field(description=" The data type of the event. - `Transaction`: The transaction event data. - `TSSRequest`: The TSS request event data. - `Addresses`: The addresses event data. - `WalletInfo`: The wallet information event data. - `MPCVault`: The MPC vault event data. - `Chains`: The enabled chain event data. - `Tokens`: The enabled token event data. - `TokenListing`: The token listing event data. - `PaymentOrder`: The payment order event data. - `PaymentRefund`: The payment refund event data. - `PaymentSettlement`: The payment settlement event data. - `PaymentTransaction`: The payment transaction event data. - `PaymentAddressUpdate`: The top-up address update event data. - `PaymentPayout`: The payment payout event data. - `PaymentBulkSend`: The payment bulk send event data. - `BalanceUpdateInfo`: The balance update event data. - `SuspendedToken`: The token suspension event data. - `ComplianceDisposition`: The compliance disposition event data. - `ComplianceKytScreenings`: The compliance KYT screenings event data. - `ComplianceKyaScreenings`: The compliance KYA screenings event data.") transaction_id: StrictStr = Field(description="The transaction ID.") cobo_id: Optional[StrictStr] = Field(default=None, description="The Cobo ID, which can be used to track a transaction.") request_id: Optional[StrictStr] = Field(default=None, description="The request ID that is used to track a transaction request. The request ID is provided by you and must be unique within your organization.") @@ -74,8 +74,8 @@ class TransactionWebhookEventData(BaseModel): @field_validator('data_type') def data_type_validate_enum(cls, value): """Validates the enum""" - if value not in set(['Transaction', 'TSSRequest', 'Addresses', 'WalletInfo', 'MPCVault', 'Chains', 'Tokens', 'TokenListing', 'PaymentOrder', 'PaymentRefund', 'PaymentSettlement', 'PaymentTransaction', 'PaymentAddressUpdate', 'PaymentPayout', 'BalanceUpdateInfo', 'SuspendedToken', 'ComplianceDisposition', 'ComplianceKytScreenings', 'ComplianceKyaScreenings']): - raise ValueError("must be one of enum values ('Transaction', 'TSSRequest', 'Addresses', 'WalletInfo', 'MPCVault', 'Chains', 'Tokens', 'TokenListing', 'PaymentOrder', 'PaymentRefund', 'PaymentSettlement', 'PaymentTransaction', 'PaymentAddressUpdate', 'PaymentPayout', 'BalanceUpdateInfo', 'SuspendedToken', 'ComplianceDisposition', 'ComplianceKytScreenings', 'ComplianceKyaScreenings')") + if value not in set(['Transaction', 'TSSRequest', 'Addresses', 'WalletInfo', 'MPCVault', 'Chains', 'Tokens', 'TokenListing', 'PaymentOrder', 'PaymentRefund', 'PaymentSettlement', 'PaymentTransaction', 'PaymentAddressUpdate', 'PaymentPayout', 'PaymentBulkSend', 'BalanceUpdateInfo', 'SuspendedToken', 'ComplianceDisposition', 'ComplianceKytScreenings', 'ComplianceKyaScreenings']): + raise ValueError("must be one of enum values ('Transaction', 'TSSRequest', 'Addresses', 'WalletInfo', 'MPCVault', 'Chains', 'Tokens', 'TokenListing', 'PaymentOrder', 'PaymentRefund', 'PaymentSettlement', 'PaymentTransaction', 'PaymentAddressUpdate', 'PaymentPayout', 'PaymentBulkSend', 'BalanceUpdateInfo', 'SuspendedToken', 'ComplianceDisposition', 'ComplianceKytScreenings', 'ComplianceKyaScreenings')") return value model_config = ConfigDict( diff --git a/cobo_waas2/models/tss_request_webhook_event_data.py b/cobo_waas2/models/tss_request_webhook_event_data.py index 8c1613d2..f234f0bd 100644 --- a/cobo_waas2/models/tss_request_webhook_event_data.py +++ b/cobo_waas2/models/tss_request_webhook_event_data.py @@ -28,7 +28,7 @@ class TSSRequestWebhookEventData(BaseModel): """ TSSRequestWebhookEventData """ # noqa: E501 - data_type: StrictStr = Field(description=" The data type of the event. - `Transaction`: The transaction event data. - `TSSRequest`: The TSS request event data. - `Addresses`: The addresses event data. - `WalletInfo`: The wallet information event data. - `MPCVault`: The MPC vault event data. - `Chains`: The enabled chain event data. - `Tokens`: The enabled token event data. - `TokenListing`: The token listing event data. - `PaymentOrder`: The payment order event data. - `PaymentRefund`: The payment refund event data. - `PaymentSettlement`: The payment settlement event data. - `PaymentTransaction`: The payment transaction event data. - `PaymentAddressUpdate`: The top-up address update event data. - `PaymentPayout`: The payment payout event data. - `BalanceUpdateInfo`: The balance update event data. - `SuspendedToken`: The token suspension event data. - `ComplianceDisposition`: The compliance disposition event data. - `ComplianceKytScreenings`: The compliance KYT screenings event data. - `ComplianceKyaScreenings`: The compliance KYA screenings event data.") + data_type: StrictStr = Field(description=" The data type of the event. - `Transaction`: The transaction event data. - `TSSRequest`: The TSS request event data. - `Addresses`: The addresses event data. - `WalletInfo`: The wallet information event data. - `MPCVault`: The MPC vault event data. - `Chains`: The enabled chain event data. - `Tokens`: The enabled token event data. - `TokenListing`: The token listing event data. - `PaymentOrder`: The payment order event data. - `PaymentRefund`: The payment refund event data. - `PaymentSettlement`: The payment settlement event data. - `PaymentTransaction`: The payment transaction event data. - `PaymentAddressUpdate`: The top-up address update event data. - `PaymentPayout`: The payment payout event data. - `PaymentBulkSend`: The payment bulk send event data. - `BalanceUpdateInfo`: The balance update event data. - `SuspendedToken`: The token suspension event data. - `ComplianceDisposition`: The compliance disposition event data. - `ComplianceKytScreenings`: The compliance KYT screenings event data. - `ComplianceKyaScreenings`: The compliance KYA screenings event data.") tss_request_id: Optional[StrictStr] = Field(default=None, description="The TSS request ID.") source_key_share_holder_group: Optional[SourceGroup] = None target_key_share_holder_group_id: Optional[StrictStr] = Field(default=None, description="The target key share holder group ID.") @@ -41,8 +41,8 @@ class TSSRequestWebhookEventData(BaseModel): @field_validator('data_type') def data_type_validate_enum(cls, value): """Validates the enum""" - if value not in set(['Transaction', 'TSSRequest', 'Addresses', 'WalletInfo', 'MPCVault', 'Chains', 'Tokens', 'TokenListing', 'PaymentOrder', 'PaymentRefund', 'PaymentSettlement', 'PaymentTransaction', 'PaymentAddressUpdate', 'PaymentPayout', 'BalanceUpdateInfo', 'SuspendedToken', 'ComplianceDisposition', 'ComplianceKytScreenings', 'ComplianceKyaScreenings']): - raise ValueError("must be one of enum values ('Transaction', 'TSSRequest', 'Addresses', 'WalletInfo', 'MPCVault', 'Chains', 'Tokens', 'TokenListing', 'PaymentOrder', 'PaymentRefund', 'PaymentSettlement', 'PaymentTransaction', 'PaymentAddressUpdate', 'PaymentPayout', 'BalanceUpdateInfo', 'SuspendedToken', 'ComplianceDisposition', 'ComplianceKytScreenings', 'ComplianceKyaScreenings')") + if value not in set(['Transaction', 'TSSRequest', 'Addresses', 'WalletInfo', 'MPCVault', 'Chains', 'Tokens', 'TokenListing', 'PaymentOrder', 'PaymentRefund', 'PaymentSettlement', 'PaymentTransaction', 'PaymentAddressUpdate', 'PaymentPayout', 'PaymentBulkSend', 'BalanceUpdateInfo', 'SuspendedToken', 'ComplianceDisposition', 'ComplianceKytScreenings', 'ComplianceKyaScreenings']): + raise ValueError("must be one of enum values ('Transaction', 'TSSRequest', 'Addresses', 'WalletInfo', 'MPCVault', 'Chains', 'Tokens', 'TokenListing', 'PaymentOrder', 'PaymentRefund', 'PaymentSettlement', 'PaymentTransaction', 'PaymentAddressUpdate', 'PaymentPayout', 'PaymentBulkSend', 'BalanceUpdateInfo', 'SuspendedToken', 'ComplianceDisposition', 'ComplianceKytScreenings', 'ComplianceKyaScreenings')") return value model_config = ConfigDict( diff --git a/cobo_waas2/models/wallet_info_event_data.py b/cobo_waas2/models/wallet_info_event_data.py index bc71ebb6..b57873d0 100644 --- a/cobo_waas2/models/wallet_info_event_data.py +++ b/cobo_waas2/models/wallet_info_event_data.py @@ -26,15 +26,15 @@ class WalletInfoEventData(BaseModel): """ WalletInfoEventData """ # noqa: E501 - data_type: StrictStr = Field(description=" The data type of the event. - `Transaction`: The transaction event data. - `TSSRequest`: The TSS request event data. - `Addresses`: The addresses event data. - `WalletInfo`: The wallet information event data. - `MPCVault`: The MPC vault event data. - `Chains`: The enabled chain event data. - `Tokens`: The enabled token event data. - `TokenListing`: The token listing event data. - `PaymentOrder`: The payment order event data. - `PaymentRefund`: The payment refund event data. - `PaymentSettlement`: The payment settlement event data. - `PaymentTransaction`: The payment transaction event data. - `PaymentAddressUpdate`: The top-up address update event data. - `PaymentPayout`: The payment payout event data. - `BalanceUpdateInfo`: The balance update event data. - `SuspendedToken`: The token suspension event data. - `ComplianceDisposition`: The compliance disposition event data. - `ComplianceKytScreenings`: The compliance KYT screenings event data. - `ComplianceKyaScreenings`: The compliance KYA screenings event data.") + data_type: StrictStr = Field(description=" The data type of the event. - `Transaction`: The transaction event data. - `TSSRequest`: The TSS request event data. - `Addresses`: The addresses event data. - `WalletInfo`: The wallet information event data. - `MPCVault`: The MPC vault event data. - `Chains`: The enabled chain event data. - `Tokens`: The enabled token event data. - `TokenListing`: The token listing event data. - `PaymentOrder`: The payment order event data. - `PaymentRefund`: The payment refund event data. - `PaymentSettlement`: The payment settlement event data. - `PaymentTransaction`: The payment transaction event data. - `PaymentAddressUpdate`: The top-up address update event data. - `PaymentPayout`: The payment payout event data. - `PaymentBulkSend`: The payment bulk send event data. - `BalanceUpdateInfo`: The balance update event data. - `SuspendedToken`: The token suspension event data. - `ComplianceDisposition`: The compliance disposition event data. - `ComplianceKytScreenings`: The compliance KYT screenings event data. - `ComplianceKyaScreenings`: The compliance KYA screenings event data.") wallet: Optional[WalletInfo] = None __properties: ClassVar[List[str]] = ["data_type", "wallet"] @field_validator('data_type') def data_type_validate_enum(cls, value): """Validates the enum""" - if value not in set(['Transaction', 'TSSRequest', 'Addresses', 'WalletInfo', 'MPCVault', 'Chains', 'Tokens', 'TokenListing', 'PaymentOrder', 'PaymentRefund', 'PaymentSettlement', 'PaymentTransaction', 'PaymentAddressUpdate', 'PaymentPayout', 'BalanceUpdateInfo', 'SuspendedToken', 'ComplianceDisposition', 'ComplianceKytScreenings', 'ComplianceKyaScreenings']): - raise ValueError("must be one of enum values ('Transaction', 'TSSRequest', 'Addresses', 'WalletInfo', 'MPCVault', 'Chains', 'Tokens', 'TokenListing', 'PaymentOrder', 'PaymentRefund', 'PaymentSettlement', 'PaymentTransaction', 'PaymentAddressUpdate', 'PaymentPayout', 'BalanceUpdateInfo', 'SuspendedToken', 'ComplianceDisposition', 'ComplianceKytScreenings', 'ComplianceKyaScreenings')") + if value not in set(['Transaction', 'TSSRequest', 'Addresses', 'WalletInfo', 'MPCVault', 'Chains', 'Tokens', 'TokenListing', 'PaymentOrder', 'PaymentRefund', 'PaymentSettlement', 'PaymentTransaction', 'PaymentAddressUpdate', 'PaymentPayout', 'PaymentBulkSend', 'BalanceUpdateInfo', 'SuspendedToken', 'ComplianceDisposition', 'ComplianceKytScreenings', 'ComplianceKyaScreenings']): + raise ValueError("must be one of enum values ('Transaction', 'TSSRequest', 'Addresses', 'WalletInfo', 'MPCVault', 'Chains', 'Tokens', 'TokenListing', 'PaymentOrder', 'PaymentRefund', 'PaymentSettlement', 'PaymentTransaction', 'PaymentAddressUpdate', 'PaymentPayout', 'PaymentBulkSend', 'BalanceUpdateInfo', 'SuspendedToken', 'ComplianceDisposition', 'ComplianceKytScreenings', 'ComplianceKyaScreenings')") return value model_config = ConfigDict( diff --git a/cobo_waas2/models/webhook_event_data.py b/cobo_waas2/models/webhook_event_data.py index 33cc78f5..a68df02b 100644 --- a/cobo_waas2/models/webhook_event_data.py +++ b/cobo_waas2/models/webhook_event_data.py @@ -23,6 +23,7 @@ from cobo_waas2.models.compliance_kyt_screenings_update_event_data import ComplianceKytScreeningsUpdateEventData from cobo_waas2.models.mpc_vault_event_data import MPCVaultEventData from cobo_waas2.models.payment_address_update_event_data import PaymentAddressUpdateEventData +from cobo_waas2.models.payment_bulk_send_event import PaymentBulkSendEvent from cobo_waas2.models.payment_order_event_data import PaymentOrderEventData from cobo_waas2.models.payment_payout_event import PaymentPayoutEvent from cobo_waas2.models.payment_refund_event_data import PaymentRefundEventData @@ -38,7 +39,7 @@ from typing import Union, List, Set, Optional, Dict from typing_extensions import Literal, Self -WEBHOOKEVENTDATA_ONE_OF_SCHEMAS = ["AddressesEventData", "BalanceUpdateInfoEventData", "ChainsEventData", "ComplianceDispositionUpdateEventData", "ComplianceKyaScreeningsUpdateEventData", "ComplianceKytScreeningsUpdateEventData", "MPCVaultEventData", "PaymentAddressUpdateEventData", "PaymentOrderEventData", "PaymentPayoutEvent", "PaymentRefundEventData", "PaymentSettlementEvent", "PaymentTransactionEventData", "SuspendedTokenEventData", "TSSRequestWebhookEventData", "TokenListingEventData", "TokensEventData", "TransactionWebhookEventData", "WalletInfoEventData"] +WEBHOOKEVENTDATA_ONE_OF_SCHEMAS = ["AddressesEventData", "BalanceUpdateInfoEventData", "ChainsEventData", "ComplianceDispositionUpdateEventData", "ComplianceKyaScreeningsUpdateEventData", "ComplianceKytScreeningsUpdateEventData", "MPCVaultEventData", "PaymentAddressUpdateEventData", "PaymentBulkSendEvent", "PaymentOrderEventData", "PaymentPayoutEvent", "PaymentRefundEventData", "PaymentSettlementEvent", "PaymentTransactionEventData", "SuspendedTokenEventData", "TSSRequestWebhookEventData", "TokenListingEventData", "TokensEventData", "TransactionWebhookEventData", "WalletInfoEventData"] class WebhookEventData(BaseModel): """ @@ -76,14 +77,16 @@ class WebhookEventData(BaseModel): oneof_schema_15_validator: Optional[PaymentAddressUpdateEventData] = None # data type: PaymentPayoutEvent oneof_schema_16_validator: Optional[PaymentPayoutEvent] = None + # data type: PaymentBulkSendEvent + oneof_schema_17_validator: Optional[PaymentBulkSendEvent] = None # data type: ComplianceDispositionUpdateEventData - oneof_schema_17_validator: Optional[ComplianceDispositionUpdateEventData] = None + oneof_schema_18_validator: Optional[ComplianceDispositionUpdateEventData] = None # data type: ComplianceKytScreeningsUpdateEventData - oneof_schema_18_validator: Optional[ComplianceKytScreeningsUpdateEventData] = None + oneof_schema_19_validator: Optional[ComplianceKytScreeningsUpdateEventData] = None # data type: ComplianceKyaScreeningsUpdateEventData - oneof_schema_19_validator: Optional[ComplianceKyaScreeningsUpdateEventData] = None - actual_instance: Optional[Union[AddressesEventData, BalanceUpdateInfoEventData, ChainsEventData, ComplianceDispositionUpdateEventData, ComplianceKyaScreeningsUpdateEventData, ComplianceKytScreeningsUpdateEventData, MPCVaultEventData, PaymentAddressUpdateEventData, PaymentOrderEventData, PaymentPayoutEvent, PaymentRefundEventData, PaymentSettlementEvent, PaymentTransactionEventData, SuspendedTokenEventData, TSSRequestWebhookEventData, TokenListingEventData, TokensEventData, TransactionWebhookEventData, WalletInfoEventData]] = None - one_of_schemas: Set[str] = { "AddressesEventData", "BalanceUpdateInfoEventData", "ChainsEventData", "ComplianceDispositionUpdateEventData", "ComplianceKyaScreeningsUpdateEventData", "ComplianceKytScreeningsUpdateEventData", "MPCVaultEventData", "PaymentAddressUpdateEventData", "PaymentOrderEventData", "PaymentPayoutEvent", "PaymentRefundEventData", "PaymentSettlementEvent", "PaymentTransactionEventData", "SuspendedTokenEventData", "TSSRequestWebhookEventData", "TokenListingEventData", "TokensEventData", "TransactionWebhookEventData", "WalletInfoEventData" } + oneof_schema_20_validator: Optional[ComplianceKyaScreeningsUpdateEventData] = None + actual_instance: Optional[Union[AddressesEventData, BalanceUpdateInfoEventData, ChainsEventData, ComplianceDispositionUpdateEventData, ComplianceKyaScreeningsUpdateEventData, ComplianceKytScreeningsUpdateEventData, MPCVaultEventData, PaymentAddressUpdateEventData, PaymentBulkSendEvent, PaymentOrderEventData, PaymentPayoutEvent, PaymentRefundEventData, PaymentSettlementEvent, PaymentTransactionEventData, SuspendedTokenEventData, TSSRequestWebhookEventData, TokenListingEventData, TokensEventData, TransactionWebhookEventData, WalletInfoEventData]] = None + one_of_schemas: Set[str] = { "AddressesEventData", "BalanceUpdateInfoEventData", "ChainsEventData", "ComplianceDispositionUpdateEventData", "ComplianceKyaScreeningsUpdateEventData", "ComplianceKytScreeningsUpdateEventData", "MPCVaultEventData", "PaymentAddressUpdateEventData", "PaymentBulkSendEvent", "PaymentOrderEventData", "PaymentPayoutEvent", "PaymentRefundEventData", "PaymentSettlementEvent", "PaymentTransactionEventData", "SuspendedTokenEventData", "TSSRequestWebhookEventData", "TokenListingEventData", "TokensEventData", "TransactionWebhookEventData", "WalletInfoEventData" } model_config = ConfigDict( validate_assignment=True, @@ -189,6 +192,11 @@ def actual_instance_must_validate_oneof(cls, v): error_messages.append(f"Error! Input type `{type(v)}` is not `PaymentPayoutEvent`") else: match += 1 + # validate data type: PaymentBulkSendEvent + if not isinstance(v, PaymentBulkSendEvent): + error_messages.append(f"Error! Input type `{type(v)}` is not `PaymentBulkSendEvent`") + else: + match += 1 # validate data type: ComplianceDispositionUpdateEventData if not isinstance(v, ComplianceDispositionUpdateEventData): error_messages.append(f"Error! Input type `{type(v)}` is not `ComplianceDispositionUpdateEventData`") @@ -206,10 +214,10 @@ def actual_instance_must_validate_oneof(cls, v): match += 1 if match > 1: # more than 1 match - raise ValueError("Multiple matches found when setting `actual_instance` in WebhookEventData with oneOf schemas: AddressesEventData, BalanceUpdateInfoEventData, ChainsEventData, ComplianceDispositionUpdateEventData, ComplianceKyaScreeningsUpdateEventData, ComplianceKytScreeningsUpdateEventData, MPCVaultEventData, PaymentAddressUpdateEventData, PaymentOrderEventData, PaymentPayoutEvent, PaymentRefundEventData, PaymentSettlementEvent, PaymentTransactionEventData, SuspendedTokenEventData, TSSRequestWebhookEventData, TokenListingEventData, TokensEventData, TransactionWebhookEventData, WalletInfoEventData. Details: " + ", ".join(error_messages)) + raise ValueError("Multiple matches found when setting `actual_instance` in WebhookEventData with oneOf schemas: AddressesEventData, BalanceUpdateInfoEventData, ChainsEventData, ComplianceDispositionUpdateEventData, ComplianceKyaScreeningsUpdateEventData, ComplianceKytScreeningsUpdateEventData, MPCVaultEventData, PaymentAddressUpdateEventData, PaymentBulkSendEvent, PaymentOrderEventData, PaymentPayoutEvent, PaymentRefundEventData, PaymentSettlementEvent, PaymentTransactionEventData, SuspendedTokenEventData, TSSRequestWebhookEventData, TokenListingEventData, TokensEventData, TransactionWebhookEventData, WalletInfoEventData. Details: " + ", ".join(error_messages)) elif match == 0: # no match - raise ValueError("No match found when setting `actual_instance` in WebhookEventData with oneOf schemas: AddressesEventData, BalanceUpdateInfoEventData, ChainsEventData, ComplianceDispositionUpdateEventData, ComplianceKyaScreeningsUpdateEventData, ComplianceKytScreeningsUpdateEventData, MPCVaultEventData, PaymentAddressUpdateEventData, PaymentOrderEventData, PaymentPayoutEvent, PaymentRefundEventData, PaymentSettlementEvent, PaymentTransactionEventData, SuspendedTokenEventData, TSSRequestWebhookEventData, TokenListingEventData, TokensEventData, TransactionWebhookEventData, WalletInfoEventData. Details: " + ", ".join(error_messages)) + raise ValueError("No match found when setting `actual_instance` in WebhookEventData with oneOf schemas: AddressesEventData, BalanceUpdateInfoEventData, ChainsEventData, ComplianceDispositionUpdateEventData, ComplianceKyaScreeningsUpdateEventData, ComplianceKytScreeningsUpdateEventData, MPCVaultEventData, PaymentAddressUpdateEventData, PaymentBulkSendEvent, PaymentOrderEventData, PaymentPayoutEvent, PaymentRefundEventData, PaymentSettlementEvent, PaymentTransactionEventData, SuspendedTokenEventData, TSSRequestWebhookEventData, TokenListingEventData, TokensEventData, TransactionWebhookEventData, WalletInfoEventData. Details: " + ", ".join(error_messages)) else: return v @@ -269,6 +277,11 @@ def from_json(cls, json_str: str) -> Self: instance.actual_instance = PaymentAddressUpdateEventData.from_json(json_str) return instance + # check if data type is `PaymentBulkSendEvent` + if _data_type == "PaymentBulkSend": + instance.actual_instance = PaymentBulkSendEvent.from_json(json_str) + return instance + # check if data type is `PaymentOrderEventData` if _data_type == "PaymentOrder": instance.actual_instance = PaymentOrderEventData.from_json(json_str) @@ -364,6 +377,11 @@ def from_json(cls, json_str: str) -> Self: instance.actual_instance = PaymentAddressUpdateEventData.from_json(json_str) return instance + # check if data type is `PaymentBulkSendEvent` + if _data_type == "PaymentBulkSendEvent": + instance.actual_instance = PaymentBulkSendEvent.from_json(json_str) + return instance + # check if data type is `PaymentOrderEventData` if _data_type == "PaymentOrderEventData": instance.actual_instance = PaymentOrderEventData.from_json(json_str) @@ -516,6 +534,12 @@ def from_json(cls, json_str: str) -> Self: match += 1 except (ValidationError, ValueError) as e: error_messages.append(str(e)) + # deserialize data into PaymentBulkSendEvent + try: + instance.actual_instance = PaymentBulkSendEvent.from_json(json_str) + match += 1 + except (ValidationError, ValueError) as e: + error_messages.append(str(e)) # deserialize data into ComplianceDispositionUpdateEventData try: instance.actual_instance = ComplianceDispositionUpdateEventData.from_json(json_str) @@ -537,11 +561,11 @@ def from_json(cls, json_str: str) -> Self: if match > 1: # more than 1 match - raise ValueError("Multiple matches found when deserializing the JSON string into WebhookEventData with oneOf schemas: AddressesEventData, BalanceUpdateInfoEventData, ChainsEventData, ComplianceDispositionUpdateEventData, ComplianceKyaScreeningsUpdateEventData, ComplianceKytScreeningsUpdateEventData, MPCVaultEventData, PaymentAddressUpdateEventData, PaymentOrderEventData, PaymentPayoutEvent, PaymentRefundEventData, PaymentSettlementEvent, PaymentTransactionEventData, SuspendedTokenEventData, TSSRequestWebhookEventData, TokenListingEventData, TokensEventData, TransactionWebhookEventData, WalletInfoEventData. Details: " + ", ".join(error_messages)) + raise ValueError("Multiple matches found when deserializing the JSON string into WebhookEventData with oneOf schemas: AddressesEventData, BalanceUpdateInfoEventData, ChainsEventData, ComplianceDispositionUpdateEventData, ComplianceKyaScreeningsUpdateEventData, ComplianceKytScreeningsUpdateEventData, MPCVaultEventData, PaymentAddressUpdateEventData, PaymentBulkSendEvent, PaymentOrderEventData, PaymentPayoutEvent, PaymentRefundEventData, PaymentSettlementEvent, PaymentTransactionEventData, SuspendedTokenEventData, TSSRequestWebhookEventData, TokenListingEventData, TokensEventData, TransactionWebhookEventData, WalletInfoEventData. Details: " + ", ".join(error_messages)) elif match == 0: # no match return instance - # raise ValueError("No match found when deserializing the JSON string into WebhookEventData with oneOf schemas: AddressesEventData, BalanceUpdateInfoEventData, ChainsEventData, ComplianceDispositionUpdateEventData, ComplianceKyaScreeningsUpdateEventData, ComplianceKytScreeningsUpdateEventData, MPCVaultEventData, PaymentAddressUpdateEventData, PaymentOrderEventData, PaymentPayoutEvent, PaymentRefundEventData, PaymentSettlementEvent, PaymentTransactionEventData, SuspendedTokenEventData, TSSRequestWebhookEventData, TokenListingEventData, TokensEventData, TransactionWebhookEventData, WalletInfoEventData. Details: " + ", ".join(error_messages)) + # raise ValueError("No match found when deserializing the JSON string into WebhookEventData with oneOf schemas: AddressesEventData, BalanceUpdateInfoEventData, ChainsEventData, ComplianceDispositionUpdateEventData, ComplianceKyaScreeningsUpdateEventData, ComplianceKytScreeningsUpdateEventData, MPCVaultEventData, PaymentAddressUpdateEventData, PaymentBulkSendEvent, PaymentOrderEventData, PaymentPayoutEvent, PaymentRefundEventData, PaymentSettlementEvent, PaymentTransactionEventData, SuspendedTokenEventData, TSSRequestWebhookEventData, TokenListingEventData, TokensEventData, TransactionWebhookEventData, WalletInfoEventData. Details: " + ", ".join(error_messages)) else: return instance @@ -555,7 +579,7 @@ def to_json(self) -> str: else: return json.dumps(self.actual_instance) - def to_dict(self) -> Optional[Union[Dict[str, Any], AddressesEventData, BalanceUpdateInfoEventData, ChainsEventData, ComplianceDispositionUpdateEventData, ComplianceKyaScreeningsUpdateEventData, ComplianceKytScreeningsUpdateEventData, MPCVaultEventData, PaymentAddressUpdateEventData, PaymentOrderEventData, PaymentPayoutEvent, PaymentRefundEventData, PaymentSettlementEvent, PaymentTransactionEventData, SuspendedTokenEventData, TSSRequestWebhookEventData, TokenListingEventData, TokensEventData, TransactionWebhookEventData, WalletInfoEventData]]: + def to_dict(self) -> Optional[Union[Dict[str, Any], AddressesEventData, BalanceUpdateInfoEventData, ChainsEventData, ComplianceDispositionUpdateEventData, ComplianceKyaScreeningsUpdateEventData, ComplianceKytScreeningsUpdateEventData, MPCVaultEventData, PaymentAddressUpdateEventData, PaymentBulkSendEvent, PaymentOrderEventData, PaymentPayoutEvent, PaymentRefundEventData, PaymentSettlementEvent, PaymentTransactionEventData, SuspendedTokenEventData, TSSRequestWebhookEventData, TokenListingEventData, TokensEventData, TransactionWebhookEventData, WalletInfoEventData]]: """Returns the dict representation of the actual instance""" if self.actual_instance is None: return None diff --git a/cobo_waas2/models/webhook_event_data_type.py b/cobo_waas2/models/webhook_event_data_type.py index 504fc350..e43bfa14 100644 --- a/cobo_waas2/models/webhook_event_data_type.py +++ b/cobo_waas2/models/webhook_event_data_type.py @@ -25,14 +25,14 @@ class WebhookEventDataType(BaseModel): """ The data type of the event. """ # noqa: E501 - data_type: StrictStr = Field(description=" The data type of the event. - `Transaction`: The transaction event data. - `TSSRequest`: The TSS request event data. - `Addresses`: The addresses event data. - `WalletInfo`: The wallet information event data. - `MPCVault`: The MPC vault event data. - `Chains`: The enabled chain event data. - `Tokens`: The enabled token event data. - `TokenListing`: The token listing event data. - `PaymentOrder`: The payment order event data. - `PaymentRefund`: The payment refund event data. - `PaymentSettlement`: The payment settlement event data. - `PaymentTransaction`: The payment transaction event data. - `PaymentAddressUpdate`: The top-up address update event data. - `PaymentPayout`: The payment payout event data. - `BalanceUpdateInfo`: The balance update event data. - `SuspendedToken`: The token suspension event data. - `ComplianceDisposition`: The compliance disposition event data. - `ComplianceKytScreenings`: The compliance KYT screenings event data. - `ComplianceKyaScreenings`: The compliance KYA screenings event data.") + data_type: StrictStr = Field(description=" The data type of the event. - `Transaction`: The transaction event data. - `TSSRequest`: The TSS request event data. - `Addresses`: The addresses event data. - `WalletInfo`: The wallet information event data. - `MPCVault`: The MPC vault event data. - `Chains`: The enabled chain event data. - `Tokens`: The enabled token event data. - `TokenListing`: The token listing event data. - `PaymentOrder`: The payment order event data. - `PaymentRefund`: The payment refund event data. - `PaymentSettlement`: The payment settlement event data. - `PaymentTransaction`: The payment transaction event data. - `PaymentAddressUpdate`: The top-up address update event data. - `PaymentPayout`: The payment payout event data. - `PaymentBulkSend`: The payment bulk send event data. - `BalanceUpdateInfo`: The balance update event data. - `SuspendedToken`: The token suspension event data. - `ComplianceDisposition`: The compliance disposition event data. - `ComplianceKytScreenings`: The compliance KYT screenings event data. - `ComplianceKyaScreenings`: The compliance KYA screenings event data.") __properties: ClassVar[List[str]] = ["data_type"] @field_validator('data_type') def data_type_validate_enum(cls, value): """Validates the enum""" - if value not in set(['Transaction', 'TSSRequest', 'Addresses', 'WalletInfo', 'MPCVault', 'Chains', 'Tokens', 'TokenListing', 'PaymentOrder', 'PaymentRefund', 'PaymentSettlement', 'PaymentTransaction', 'PaymentAddressUpdate', 'PaymentPayout', 'BalanceUpdateInfo', 'SuspendedToken', 'ComplianceDisposition', 'ComplianceKytScreenings', 'ComplianceKyaScreenings']): - raise ValueError("must be one of enum values ('Transaction', 'TSSRequest', 'Addresses', 'WalletInfo', 'MPCVault', 'Chains', 'Tokens', 'TokenListing', 'PaymentOrder', 'PaymentRefund', 'PaymentSettlement', 'PaymentTransaction', 'PaymentAddressUpdate', 'PaymentPayout', 'BalanceUpdateInfo', 'SuspendedToken', 'ComplianceDisposition', 'ComplianceKytScreenings', 'ComplianceKyaScreenings')") + if value not in set(['Transaction', 'TSSRequest', 'Addresses', 'WalletInfo', 'MPCVault', 'Chains', 'Tokens', 'TokenListing', 'PaymentOrder', 'PaymentRefund', 'PaymentSettlement', 'PaymentTransaction', 'PaymentAddressUpdate', 'PaymentPayout', 'PaymentBulkSend', 'BalanceUpdateInfo', 'SuspendedToken', 'ComplianceDisposition', 'ComplianceKytScreenings', 'ComplianceKyaScreenings']): + raise ValueError("must be one of enum values ('Transaction', 'TSSRequest', 'Addresses', 'WalletInfo', 'MPCVault', 'Chains', 'Tokens', 'TokenListing', 'PaymentOrder', 'PaymentRefund', 'PaymentSettlement', 'PaymentTransaction', 'PaymentAddressUpdate', 'PaymentPayout', 'PaymentBulkSend', 'BalanceUpdateInfo', 'SuspendedToken', 'ComplianceDisposition', 'ComplianceKytScreenings', 'ComplianceKyaScreenings')") return value model_config = ConfigDict( diff --git a/cobo_waas2/models/webhook_event_type.py b/cobo_waas2/models/webhook_event_type.py index eed77330..ac7d977b 100644 --- a/cobo_waas2/models/webhook_event_type.py +++ b/cobo_waas2/models/webhook_event_type.py @@ -60,6 +60,8 @@ class WebhookEventType(str, Enum): PAYMENT_DOT_PAYOUT_DOT_STATUS_DOT_UPDATED = 'payment.payout.status.updated' PAYMENT_DOT_ADDRESS_DOT_UPDATED = 'payment.address.updated' PAYMENT_DOT_SUBSCRIPTION_DOT_STATUS_DOT_UPDATED = 'payment.subscription.status.updated' + PAYMENT_DOT_CHARGE_DOT_STATUS_DOT_UPDATED = 'payment.charge.status.updated' + PAYMENT_DOT_BULK_SEND_DOT_STATUS_DOT_UPDATED = 'payment.bulk_send.status.updated' COMPLIANCE_DOT_DISPOSITION_DOT_STATUS_DOT_UPDATED = 'compliance.disposition.status.updated' COMPLIANCE_DOT_KYT_DOT_SCREENINGS_DOT_STATUS_DOT_UPDATED = 'compliance.kyt.screenings.status.updated' COMPLIANCE_DOT_KYA_DOT_SCREENINGS_DOT_STATUS_DOT_UPDATED = 'compliance.kya.screenings.status.updated' diff --git a/docs/AddressesEventData.md b/docs/AddressesEventData.md index 492afb44..19d0b325 100644 --- a/docs/AddressesEventData.md +++ b/docs/AddressesEventData.md @@ -5,7 +5,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**data_type** | **str** | The data type of the event. - `Transaction`: The transaction event data. - `TSSRequest`: The TSS request event data. - `Addresses`: The addresses event data. - `WalletInfo`: The wallet information event data. - `MPCVault`: The MPC vault event data. - `Chains`: The enabled chain event data. - `Tokens`: The enabled token event data. - `TokenListing`: The token listing event data. - `PaymentOrder`: The payment order event data. - `PaymentRefund`: The payment refund event data. - `PaymentSettlement`: The payment settlement event data. - `PaymentTransaction`: The payment transaction event data. - `PaymentAddressUpdate`: The top-up address update event data. - `PaymentPayout`: The payment payout event data. - `BalanceUpdateInfo`: The balance update event data. - `SuspendedToken`: The token suspension event data. - `ComplianceDisposition`: The compliance disposition event data. - `ComplianceKytScreenings`: The compliance KYT screenings event data. - `ComplianceKyaScreenings`: The compliance KYA screenings event data. | +**data_type** | **str** | The data type of the event. - `Transaction`: The transaction event data. - `TSSRequest`: The TSS request event data. - `Addresses`: The addresses event data. - `WalletInfo`: The wallet information event data. - `MPCVault`: The MPC vault event data. - `Chains`: The enabled chain event data. - `Tokens`: The enabled token event data. - `TokenListing`: The token listing event data. - `PaymentOrder`: The payment order event data. - `PaymentRefund`: The payment refund event data. - `PaymentSettlement`: The payment settlement event data. - `PaymentTransaction`: The payment transaction event data. - `PaymentAddressUpdate`: The top-up address update event data. - `PaymentPayout`: The payment payout event data. - `PaymentBulkSend`: The payment bulk send event data. - `BalanceUpdateInfo`: The balance update event data. - `SuspendedToken`: The token suspension event data. - `ComplianceDisposition`: The compliance disposition event data. - `ComplianceKytScreenings`: The compliance KYT screenings event data. - `ComplianceKyaScreenings`: The compliance KYA screenings event data. | **addresses** | [**List[AddressesEventDataAllOfAddresses]**](AddressesEventDataAllOfAddresses.md) | A list of addresses. | [optional] ## Example diff --git a/docs/AllocationItem.md b/docs/AllocationItem.md new file mode 100644 index 00000000..b39a3bac --- /dev/null +++ b/docs/AllocationItem.md @@ -0,0 +1,35 @@ +# AllocationItem + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**allocation_item_id** | **str** | The allocation item ID generated by Cobo. | +**batch_allocation_id** | **str** | The batch allocation ID generated by Cobo. | +**token_id** | **str** | The ID of the cryptocurrency you want to allocation. Supported values: - USDC: `ETH_USDC`, `ARBITRUM_USDC`, `SOL_USDC`, `BASE_USDC`, `MATIC_USDC`, `BSC_USDC` - USDT: `TRON_USDT`, `ETH_USDT`, `ARBITRUM_USDT`, `SOL_USDT`, `BASE_USDT`, `MATIC_USDT`, `BSC_USDT` | +**amount** | **str** | The allocation amount. | +**source_account** | **str** | The source account from which the allocation will be deducted. - If the source account is a merchant account, provide the merchant's ID (e.g., \"M1001\"). - If the source account is the developer account, use the string `\"developer\"`. | [optional] +**destination_account** | **str** | The destination account to which the allocation will be credited. - If the destination account is a merchant account, provide the merchant's ID (e.g., \"M1001\"). - If the destination account is the developer account, use the string `\"developer\"`. | [optional] +**description** | **str** | The description of the allocation item. | + +## Example + +```python +from cobo_waas2.models.allocation_item import AllocationItem + +# TODO update the JSON string below +json = "{}" +# create an instance of AllocationItem from a JSON string +allocation_item_instance = AllocationItem.from_json(json) +# print the JSON string representation of the object +print(AllocationItem.to_json()) + +# convert the object into a dict +allocation_item_dict = allocation_item_instance.to_dict() +# create an instance of AllocationItem from a dict +allocation_item_from_dict = AllocationItem.from_dict(allocation_item_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/AllocationParam.md b/docs/AllocationParam.md new file mode 100644 index 00000000..ca4874eb --- /dev/null +++ b/docs/AllocationParam.md @@ -0,0 +1,33 @@ +# AllocationParam + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**token_id** | **str** | The ID of the cryptocurrency you want to allocation. Supported values: - USDC: `ETH_USDC`, `ARBITRUM_USDC`, `SOL_USDC`, `BASE_USDC`, `MATIC_USDC`, `BSC_USDC` - USDT: `TRON_USDT`, `ETH_USDT`, `ARBITRUM_USDT`, `SOL_USDT`, `BASE_USDT`, `MATIC_USDT`, `BSC_USDT` | +**amount** | **str** | The allocation amount. | +**source_account** | **str** | The source account from which the allocation will be deducted. - If the source account is a merchant account, provide the merchant's ID (e.g., \"M1001\"). - If the source account is the developer account, use the string `\"developer\"`. | +**destination_account** | **str** | The destination account to which the allocation will be credited. - If the destination account is a merchant account, provide the merchant's ID (e.g., \"M1001\"). - If the destination account is the developer account, use the string `\"developer\"`. | +**description** | **str** | The description of the allocation. | + +## Example + +```python +from cobo_waas2.models.allocation_param import AllocationParam + +# TODO update the JSON string below +json = "{}" +# create an instance of AllocationParam from a JSON string +allocation_param_instance = AllocationParam.from_json(json) +# print the JSON string representation of the object +print(AllocationParam.to_json()) + +# convert the object into a dict +allocation_param_dict = allocation_param_instance.to_dict() +# create an instance of AllocationParam from a dict +allocation_param_from_dict = AllocationParam.from_dict(allocation_param_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/AllocationRecord.md b/docs/AllocationRecord.md deleted file mode 100644 index 2b10a7ec..00000000 --- a/docs/AllocationRecord.md +++ /dev/null @@ -1,35 +0,0 @@ -# AllocationRecord - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**allocation_record_id** | **str** | The allocation record ID generated by Cobo. | -**batch_allocation_id** | **str** | The batch allocation ID generated by Cobo. | -**token_id** | **str** | The ID of the cryptocurrency to allocate. Supported values: - USDC: `ETH_USDC`, `ARBITRUM_USDC`, `SOL_USDC`, `BASE_USDC`, `MATIC_USDC`, `BSC_USDC` - USDT: `TRON_USDT`, `ETH_USDT`, `ARBITRUM_USDT`, `SOL_USDT`, `BASE_USDT`, `MATIC_USDT`, `BSC_USDT` | -**amount** | **str** | The amount of the cryptocurrency to allocate. | -**source_account** | **str** | The source account. | [optional] -**destination_account** | **str** | The destination account. | [optional] -**description** | **str** | The description of the allocation record. | - -## Example - -```python -from cobo_waas2.models.allocation_record import AllocationRecord - -# TODO update the JSON string below -json = "{}" -# create an instance of AllocationRecord from a JSON string -allocation_record_instance = AllocationRecord.from_json(json) -# print the JSON string representation of the object -print(AllocationRecord.to_json()) - -# convert the object into a dict -allocation_record_dict = allocation_record_instance.to_dict() -# create an instance of AllocationRecord from a dict -allocation_record_from_dict = AllocationRecord.from_dict(allocation_record_dict) -``` -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/AllocationRequest.md b/docs/AllocationRequest.md deleted file mode 100644 index 37f94758..00000000 --- a/docs/AllocationRequest.md +++ /dev/null @@ -1,33 +0,0 @@ -# AllocationRequest - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**token_id** | **str** | The ID of the cryptocurrency you want to allocate. Supported values: - USDC: `ETH_USDC`, `ARBITRUM_USDC`, `SOL_USDC`, `BASE_USDC`, `MATIC_USDC`, `BSC_USDC` - USDT: `TRON_USDT`, `ETH_USDT`, `ARBITRUM_USDT`, `SOL_USDT`, `BASE_USDT`, `MATIC_USDT`, `BSC_USDT` | -**amount** | **str** | The amount of the cryptocurrency you want to allocate. | -**source_account** | **str** | The source account. - If the source account is a merchant account, provide the merchant's ID (e.g., \"M1001\"). - If the source account is the developer account, use the string `\"developer\"`. | -**destination_account** | **str** | The destination account. - If the destination account is a merchant account, provide the merchant's ID (e.g., \"M1001\"). - If the destination account is the developer account, use the string `\"developer\"`. | -**description** | **str** | The description of the allocation request. | - -## Example - -```python -from cobo_waas2.models.allocation_request import AllocationRequest - -# TODO update the JSON string below -json = "{}" -# create an instance of AllocationRequest from a JSON string -allocation_request_instance = AllocationRequest.from_json(json) -# print the JSON string representation of the object -print(AllocationRequest.to_json()) - -# convert the object into a dict -allocation_request_dict = allocation_request_instance.to_dict() -# create an instance of AllocationRequest from a dict -allocation_request_from_dict = AllocationRequest.from_dict(allocation_request_dict) -``` -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/BalanceUpdateInfoEventData.md b/docs/BalanceUpdateInfoEventData.md index 9487f88c..26e4dca7 100644 --- a/docs/BalanceUpdateInfoEventData.md +++ b/docs/BalanceUpdateInfoEventData.md @@ -5,7 +5,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**data_type** | **str** | The data type of the event. - `Transaction`: The transaction event data. - `TSSRequest`: The TSS request event data. - `Addresses`: The addresses event data. - `WalletInfo`: The wallet information event data. - `MPCVault`: The MPC vault event data. - `Chains`: The enabled chain event data. - `Tokens`: The enabled token event data. - `TokenListing`: The token listing event data. - `PaymentOrder`: The payment order event data. - `PaymentRefund`: The payment refund event data. - `PaymentSettlement`: The payment settlement event data. - `PaymentTransaction`: The payment transaction event data. - `PaymentAddressUpdate`: The top-up address update event data. - `PaymentPayout`: The payment payout event data. - `BalanceUpdateInfo`: The balance update event data. - `SuspendedToken`: The token suspension event data. - `ComplianceDisposition`: The compliance disposition event data. - `ComplianceKytScreenings`: The compliance KYT screenings event data. - `ComplianceKyaScreenings`: The compliance KYA screenings event data. | +**data_type** | **str** | The data type of the event. - `Transaction`: The transaction event data. - `TSSRequest`: The TSS request event data. - `Addresses`: The addresses event data. - `WalletInfo`: The wallet information event data. - `MPCVault`: The MPC vault event data. - `Chains`: The enabled chain event data. - `Tokens`: The enabled token event data. - `TokenListing`: The token listing event data. - `PaymentOrder`: The payment order event data. - `PaymentRefund`: The payment refund event data. - `PaymentSettlement`: The payment settlement event data. - `PaymentTransaction`: The payment transaction event data. - `PaymentAddressUpdate`: The top-up address update event data. - `PaymentPayout`: The payment payout event data. - `PaymentBulkSend`: The payment bulk send event data. - `BalanceUpdateInfo`: The balance update event data. - `SuspendedToken`: The token suspension event data. - `ComplianceDisposition`: The compliance disposition event data. - `ComplianceKytScreenings`: The compliance KYT screenings event data. - `ComplianceKyaScreenings`: The compliance KYA screenings event data. | **token_id** | **str** | The token ID, which is the unique identifier of a token. You can retrieve the IDs of all the tokens you can use by calling [List enabled tokens](https://www.cobo.com/developers/v2/api-references/wallets/list-enabled-tokens). | **address** | **str** | The wallet address. | **wallet_uuid** | **str** | The wallet ID. | diff --git a/docs/BatchAllocation.md b/docs/BatchAllocation.md index 3a8c7e1a..f9d231dc 100644 --- a/docs/BatchAllocation.md +++ b/docs/BatchAllocation.md @@ -7,7 +7,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **batch_allocation_id** | **str** | The batch allocation ID generated by Cobo. | **request_id** | **str** | The request ID provided by you when creating the batch allocation. | -**allocation_requests** | [**List[AllocationRequest]**](AllocationRequest.md) | | [optional] +**allocation_params** | [**List[AllocationParam]**](AllocationParam.md) | | [optional] **initiator** | **str** | The initiator of this batch allocation, usually the API key you used to create the batch allocation. | [optional] **created_timestamp** | **int** | The created time of the batch allocation, represented as a UNIX timestamp in seconds. | **updated_timestamp** | **int** | The updated time of the batch allocation, represented as a UNIX timestamp in seconds. | diff --git a/docs/BatchAllocationDetail.md b/docs/BatchAllocationDetail.md index 87d9ac28..7f8e0a18 100644 --- a/docs/BatchAllocationDetail.md +++ b/docs/BatchAllocationDetail.md @@ -7,7 +7,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **batch_allocation_id** | **str** | The batch allocation ID generated by Cobo. | **request_id** | **str** | The request ID provided by you when creating the batch allocation. | -**allocation_records** | [**List[AllocationRecord]**](AllocationRecord.md) | | +**allocation_items** | [**List[AllocationItem]**](AllocationItem.md) | | [optional] **initiator** | **str** | The initiator of this batch allocation, usually the user's API key. | [optional] **created_timestamp** | **int** | The created time of the batch allocation, represented as a UNIX timestamp in seconds. | [optional] **updated_timestamp** | **int** | The updated time of the batch allocation, represented as a UNIX timestamp in seconds. | [optional] diff --git a/docs/BridgingFee.md b/docs/BridgingFee.md index 09f00227..fa660c04 100644 --- a/docs/BridgingFee.md +++ b/docs/BridgingFee.md @@ -5,9 +5,9 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**fee_amount** | **str** | The fee charged for bridging tokens to another blockchain during an off-ramp operation. Bridging fees apply when tokens are on a blockchain not directly supported by the off-ramp service. | +**fee_amount** | **str** | The fee charged for bridging tokens to another chain. | **received_token_id** | **str** | The ID of the destination token received after bridging. | [optional] -**received_amount** | **str** | The final amount of destination tokens received after bridging. | [optional] +**received_amount** | **str** | The final amount of the token received after bridging. | [optional] ## Example diff --git a/docs/ChainsEventData.md b/docs/ChainsEventData.md index 6b844820..8da2d962 100644 --- a/docs/ChainsEventData.md +++ b/docs/ChainsEventData.md @@ -5,7 +5,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**data_type** | **str** | The data type of the event. - `Transaction`: The transaction event data. - `TSSRequest`: The TSS request event data. - `Addresses`: The addresses event data. - `WalletInfo`: The wallet information event data. - `MPCVault`: The MPC vault event data. - `Chains`: The enabled chain event data. - `Tokens`: The enabled token event data. - `TokenListing`: The token listing event data. - `PaymentOrder`: The payment order event data. - `PaymentRefund`: The payment refund event data. - `PaymentSettlement`: The payment settlement event data. - `PaymentTransaction`: The payment transaction event data. - `PaymentAddressUpdate`: The top-up address update event data. - `PaymentPayout`: The payment payout event data. - `BalanceUpdateInfo`: The balance update event data. - `SuspendedToken`: The token suspension event data. - `ComplianceDisposition`: The compliance disposition event data. - `ComplianceKytScreenings`: The compliance KYT screenings event data. - `ComplianceKyaScreenings`: The compliance KYA screenings event data. | +**data_type** | **str** | The data type of the event. - `Transaction`: The transaction event data. - `TSSRequest`: The TSS request event data. - `Addresses`: The addresses event data. - `WalletInfo`: The wallet information event data. - `MPCVault`: The MPC vault event data. - `Chains`: The enabled chain event data. - `Tokens`: The enabled token event data. - `TokenListing`: The token listing event data. - `PaymentOrder`: The payment order event data. - `PaymentRefund`: The payment refund event data. - `PaymentSettlement`: The payment settlement event data. - `PaymentTransaction`: The payment transaction event data. - `PaymentAddressUpdate`: The top-up address update event data. - `PaymentPayout`: The payment payout event data. - `PaymentBulkSend`: The payment bulk send event data. - `BalanceUpdateInfo`: The balance update event data. - `SuspendedToken`: The token suspension event data. - `ComplianceDisposition`: The compliance disposition event data. - `ComplianceKytScreenings`: The compliance KYT screenings event data. - `ComplianceKyaScreenings`: The compliance KYA screenings event data. | **chains** | [**List[ChainInfo]**](ChainInfo.md) | The enabled chains. | **wallet_type** | [**WalletType**](WalletType.md) | | [optional] **wallet_subtypes** | [**List[WalletSubtype]**](WalletSubtype.md) | | [optional] diff --git a/docs/ComplianceApi.md b/docs/ComplianceApi.md index 83673ed2..86f2c374 100644 --- a/docs/ComplianceApi.md +++ b/docs/ComplianceApi.md @@ -21,7 +21,7 @@ Method | HTTP request | Description Create KYA address screening requests -This operation submits up to 50 address screening requests in one request to assess address compliance and risk levels. This endpoint supports cross-chain address screening with independent idempotency for each address, enabling flexible error handling and partial retries. +This operation submits up to 50 address screening requests in one call to assess address compliance and risk levels. This endpoint supports cross-chain address screening with independent idempotency for each address, enabling flexible error handling and partial retries. ### Example diff --git a/docs/ComplianceDispositionUpdateEventData.md b/docs/ComplianceDispositionUpdateEventData.md index fc9fd888..77054eb6 100644 --- a/docs/ComplianceDispositionUpdateEventData.md +++ b/docs/ComplianceDispositionUpdateEventData.md @@ -5,7 +5,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**data_type** | **str** | The data type of the event. - `Transaction`: The transaction event data. - `TSSRequest`: The TSS request event data. - `Addresses`: The addresses event data. - `WalletInfo`: The wallet information event data. - `MPCVault`: The MPC vault event data. - `Chains`: The enabled chain event data. - `Tokens`: The enabled token event data. - `TokenListing`: The token listing event data. - `PaymentOrder`: The payment order event data. - `PaymentRefund`: The payment refund event data. - `PaymentSettlement`: The payment settlement event data. - `PaymentTransaction`: The payment transaction event data. - `PaymentAddressUpdate`: The top-up address update event data. - `PaymentPayout`: The payment payout event data. - `BalanceUpdateInfo`: The balance update event data. - `SuspendedToken`: The token suspension event data. - `ComplianceDisposition`: The compliance disposition event data. - `ComplianceKytScreenings`: The compliance KYT screenings event data. - `ComplianceKyaScreenings`: The compliance KYA screenings event data. | +**data_type** | **str** | The data type of the event. - `Transaction`: The transaction event data. - `TSSRequest`: The TSS request event data. - `Addresses`: The addresses event data. - `WalletInfo`: The wallet information event data. - `MPCVault`: The MPC vault event data. - `Chains`: The enabled chain event data. - `Tokens`: The enabled token event data. - `TokenListing`: The token listing event data. - `PaymentOrder`: The payment order event data. - `PaymentRefund`: The payment refund event data. - `PaymentSettlement`: The payment settlement event data. - `PaymentTransaction`: The payment transaction event data. - `PaymentAddressUpdate`: The top-up address update event data. - `PaymentPayout`: The payment payout event data. - `PaymentBulkSend`: The payment bulk send event data. - `BalanceUpdateInfo`: The balance update event data. - `SuspendedToken`: The token suspension event data. - `ComplianceDisposition`: The compliance disposition event data. - `ComplianceKytScreenings`: The compliance KYT screenings event data. - `ComplianceKyaScreenings`: The compliance KYA screenings event data. | **transaction_id** | **str** | The transaction ID. | **disposition_type** | [**DispositionType**](DispositionType.md) | | **disposition_status** | [**DispositionStatus**](DispositionStatus.md) | | diff --git a/docs/ComplianceKyaScreeningsUpdateEventData.md b/docs/ComplianceKyaScreeningsUpdateEventData.md index 68e83137..387fe8c8 100644 --- a/docs/ComplianceKyaScreeningsUpdateEventData.md +++ b/docs/ComplianceKyaScreeningsUpdateEventData.md @@ -5,7 +5,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**data_type** | **str** | The data type of the event. - `Transaction`: The transaction event data. - `TSSRequest`: The TSS request event data. - `Addresses`: The addresses event data. - `WalletInfo`: The wallet information event data. - `MPCVault`: The MPC vault event data. - `Chains`: The enabled chain event data. - `Tokens`: The enabled token event data. - `TokenListing`: The token listing event data. - `PaymentOrder`: The payment order event data. - `PaymentRefund`: The payment refund event data. - `PaymentSettlement`: The payment settlement event data. - `PaymentTransaction`: The payment transaction event data. - `PaymentAddressUpdate`: The top-up address update event data. - `PaymentPayout`: The payment payout event data. - `BalanceUpdateInfo`: The balance update event data. - `SuspendedToken`: The token suspension event data. - `ComplianceDisposition`: The compliance disposition event data. - `ComplianceKytScreenings`: The compliance KYT screenings event data. - `ComplianceKyaScreenings`: The compliance KYA screenings event data. | +**data_type** | **str** | The data type of the event. - `Transaction`: The transaction event data. - `TSSRequest`: The TSS request event data. - `Addresses`: The addresses event data. - `WalletInfo`: The wallet information event data. - `MPCVault`: The MPC vault event data. - `Chains`: The enabled chain event data. - `Tokens`: The enabled token event data. - `TokenListing`: The token listing event data. - `PaymentOrder`: The payment order event data. - `PaymentRefund`: The payment refund event data. - `PaymentSettlement`: The payment settlement event data. - `PaymentTransaction`: The payment transaction event data. - `PaymentAddressUpdate`: The top-up address update event data. - `PaymentPayout`: The payment payout event data. - `PaymentBulkSend`: The payment bulk send event data. - `BalanceUpdateInfo`: The balance update event data. - `SuspendedToken`: The token suspension event data. - `ComplianceDisposition`: The compliance disposition event data. - `ComplianceKytScreenings`: The compliance KYT screenings event data. - `ComplianceKyaScreenings`: The compliance KYA screenings event data. | **screening_id** | **str** | The unique system-generated identifier for this screening request (UUID format, fixed 36 characters). | **address** | **str** | The screened blockchain address. | **chain_id** | **str** | The chain identifier. | diff --git a/docs/ComplianceKytScreeningsUpdateEventData.md b/docs/ComplianceKytScreeningsUpdateEventData.md index 0d357d46..28a8c5a1 100644 --- a/docs/ComplianceKytScreeningsUpdateEventData.md +++ b/docs/ComplianceKytScreeningsUpdateEventData.md @@ -5,7 +5,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**data_type** | **str** | The data type of the event. - `Transaction`: The transaction event data. - `TSSRequest`: The TSS request event data. - `Addresses`: The addresses event data. - `WalletInfo`: The wallet information event data. - `MPCVault`: The MPC vault event data. - `Chains`: The enabled chain event data. - `Tokens`: The enabled token event data. - `TokenListing`: The token listing event data. - `PaymentOrder`: The payment order event data. - `PaymentRefund`: The payment refund event data. - `PaymentSettlement`: The payment settlement event data. - `PaymentTransaction`: The payment transaction event data. - `PaymentAddressUpdate`: The top-up address update event data. - `PaymentPayout`: The payment payout event data. - `BalanceUpdateInfo`: The balance update event data. - `SuspendedToken`: The token suspension event data. - `ComplianceDisposition`: The compliance disposition event data. - `ComplianceKytScreenings`: The compliance KYT screenings event data. - `ComplianceKyaScreenings`: The compliance KYA screenings event data. | +**data_type** | **str** | The data type of the event. - `Transaction`: The transaction event data. - `TSSRequest`: The TSS request event data. - `Addresses`: The addresses event data. - `WalletInfo`: The wallet information event data. - `MPCVault`: The MPC vault event data. - `Chains`: The enabled chain event data. - `Tokens`: The enabled token event data. - `TokenListing`: The token listing event data. - `PaymentOrder`: The payment order event data. - `PaymentRefund`: The payment refund event data. - `PaymentSettlement`: The payment settlement event data. - `PaymentTransaction`: The payment transaction event data. - `PaymentAddressUpdate`: The top-up address update event data. - `PaymentPayout`: The payment payout event data. - `PaymentBulkSend`: The payment bulk send event data. - `BalanceUpdateInfo`: The balance update event data. - `SuspendedToken`: The token suspension event data. - `ComplianceDisposition`: The compliance disposition event data. - `ComplianceKytScreenings`: The compliance KYT screenings event data. - `ComplianceKyaScreenings`: The compliance KYA screenings event data. | **transaction_id** | **str** | The transaction ID. | **transaction_type** | [**KytScreeningsTransactionType**](KytScreeningsTransactionType.md) | | **review_status** | [**ReviewStatusType**](ReviewStatusType.md) | | diff --git a/docs/ContractCallParams.md b/docs/ContractCallParams.md index 5e72eb57..5ba5ef8d 100644 --- a/docs/ContractCallParams.md +++ b/docs/ContractCallParams.md @@ -10,7 +10,7 @@ Name | Type | Description | Notes **chain_id** | **str** | The chain ID, which is the unique identifier of a blockchain. You can retrieve the IDs of all the chains you can use by calling [List enabled chains](https://www.cobo.com/developers/v2/api-references/wallets/list-enabled-chains). | **source** | [**ContractCallSource**](ContractCallSource.md) | | **destination** | [**ContractCallDestination**](ContractCallDestination.md) | | -**description** | **str** | The description of the contract call transaction. | [optional] +**description** | **str** | The description of the contract call transaction. Maximum length is 2048 characters for MPC Wallets and Custodial Wallets (Web3 Wallets), and 1000 characters for Custodial Wallets (Asset Wallets). | [optional] **category_names** | **List[str]** | The custom category for you to identify your transactions. | [optional] **fee** | [**TransactionRequestFee**](TransactionRequestFee.md) | | [optional] **transaction_process_type** | [**TransactionProcessType**](TransactionProcessType.md) | | [optional] diff --git a/docs/CreateBatchAllocationRequest.md b/docs/CreateBatchAllocationRequest.md index 04e7da12..843c7e47 100644 --- a/docs/CreateBatchAllocationRequest.md +++ b/docs/CreateBatchAllocationRequest.md @@ -6,7 +6,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **request_id** | **str** | The request ID that is used to track a batch allocation request. The request ID is provided by you and must be unique. | -**allocation_requests** | [**List[AllocationRequest]**](AllocationRequest.md) | | +**allocation_params** | [**List[AllocationParam]**](AllocationParam.md) | | ## Example diff --git a/docs/CreateBulkSendRequest.md b/docs/CreateBulkSendRequest.md new file mode 100644 index 00000000..6e58df67 --- /dev/null +++ b/docs/CreateBulkSendRequest.md @@ -0,0 +1,32 @@ +# CreateBulkSendRequest + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**source_account** | **str** | The source account from which the bulk send will be made. - If the source account is a merchant account, provide the merchant's ID (e.g., \"M1001\"). - If the source account is the developer account, use the string `\"developer\"`. | +**execution_mode** | [**PaymentBulkSendExecutionMode**](PaymentBulkSendExecutionMode.md) | | +**description** | **str** | The description for the entire bulk send batch. | [optional] +**payout_params** | [**List[CreateBulkSendRequestPayoutParamsInner]**](CreateBulkSendRequestPayoutParamsInner.md) | The bulk send items. | + +## Example + +```python +from cobo_waas2.models.create_bulk_send_request import CreateBulkSendRequest + +# TODO update the JSON string below +json = "{}" +# create an instance of CreateBulkSendRequest from a JSON string +create_bulk_send_request_instance = CreateBulkSendRequest.from_json(json) +# print the JSON string representation of the object +print(CreateBulkSendRequest.to_json()) + +# convert the object into a dict +create_bulk_send_request_dict = create_bulk_send_request_instance.to_dict() +# create an instance of CreateBulkSendRequest from a dict +create_bulk_send_request_from_dict = CreateBulkSendRequest.from_dict(create_bulk_send_request_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/CreateBulkSendRequestPayoutParamsInner.md b/docs/CreateBulkSendRequestPayoutParamsInner.md new file mode 100644 index 00000000..bb4281ce --- /dev/null +++ b/docs/CreateBulkSendRequestPayoutParamsInner.md @@ -0,0 +1,32 @@ +# CreateBulkSendRequestPayoutParamsInner + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**token_id** | **str** | The token ID of the cryptocurrency to be sent to the recipient. | +**receiving_address** | **str** | The receiving address. | +**amount** | **str** | The amount of the cryptocurrency to be sent to the recipient. | +**description** | **str** | A note or comment about the bulk send item. | [optional] + +## Example + +```python +from cobo_waas2.models.create_bulk_send_request_payout_params_inner import CreateBulkSendRequestPayoutParamsInner + +# TODO update the JSON string below +json = "{}" +# create an instance of CreateBulkSendRequestPayoutParamsInner from a JSON string +create_bulk_send_request_payout_params_inner_instance = CreateBulkSendRequestPayoutParamsInner.from_json(json) +# print the JSON string representation of the object +print(CreateBulkSendRequestPayoutParamsInner.to_json()) + +# convert the object into a dict +create_bulk_send_request_payout_params_inner_dict = create_bulk_send_request_payout_params_inner_instance.to_dict() +# create an instance of CreateBulkSendRequestPayoutParamsInner from a dict +create_bulk_send_request_payout_params_inner_from_dict = CreateBulkSendRequestPayoutParamsInner.from_dict(create_bulk_send_request_payout_params_inner_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/CreateKyaScreeningsBody.md b/docs/CreateKyaScreeningsBody.md index e2527081..4f9ff91b 100644 --- a/docs/CreateKyaScreeningsBody.md +++ b/docs/CreateKyaScreeningsBody.md @@ -1,12 +1,12 @@ # CreateKyaScreeningsBody -Request body for batch creating address screening requests. +Information about address screening requests. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**screenings** | [**List[KyaScreeningRequest]**](KyaScreeningRequest.md) | List of address screening requests. Maximum 50 addresses per request. | +**screenings** | [**List[KyaScreeningRequest]**](KyaScreeningRequest.md) | List of address screening requests. Maximum 50 addresses per call. | ## Example diff --git a/docs/CreatePaymentOrderRequest.md b/docs/CreatePaymentOrderRequest.md index 0264766a..8d6d9acb 100644 --- a/docs/CreatePaymentOrderRequest.md +++ b/docs/CreatePaymentOrderRequest.md @@ -8,10 +8,10 @@ Name | Type | Description | Notes **merchant_id** | **str** | The merchant ID. | **merchant_order_code** | **str** | A unique reference code assigned by the merchant to identify this order in their system. | [optional] **psp_order_code** | **str** | A unique reference code assigned by the developer to identify this order in their system. | -**pricing_currency** | **str** | The pricing currency that denominates `pricing_amount` and `fee_amount`. If left empty, both values will be denominated in `payable_currency`. Currently, only `USD` is supported. | [optional] +**pricing_currency** | **str** | The pricing currency that denominates `pricing_amount` and `fee_amount`. If left empty, both values will be denominated in `payable_currency`. Currently, For a complete list of supported currencies, see [Supported chains and tokens](https://www.cobo.com/developers/v2/guides/overview/supported-chains-and-tokens). | [optional] **pricing_amount** | **str** | The base amount of the order, excluding the developer fee (specified in `fee_amount`). Values must be greater than `0` and contain two decimal places. | [optional] **fee_amount** | **str** | The developer fee for the order. It is added to the base amount (`pricing_amount`) to determine the final charge. For example, if `pricing_amount` is \"100.00\" and `fee_amount` is \"2.00\", the payer will be charged \"102.00\" in total, with \"100.00\" being settled to the merchant account and \"2.00\" settled to the developer account. Values must be greater than 0 and contain two decimal places. | -**payable_currency** | **str** | The ID of the cryptocurrency used for payment. Supported values: - USDC: `ETH_USDC`, `ARBITRUM_USDC`, `SOL_USDC`, `BASE_USDC`, `MATIC_USDC`, `BSC_USDC` - USDT: `TRON_USDT`, `ETH_USDT`, `ARBITRUM_USDT`, `SOL_USDT`, `BASE_USDT`, `MATIC_USDT`, `BSC_USDT` | [optional] +**payable_currency** | **str** | The ID of the cryptocurrency used for payment. Supported values: - USDC: `ETH_USDC`, `ARBITRUM_USDC`, `SOL_USDC`, `BASE_USDC`, `MATIC_USDC`, `BSC_USDC` - USDT: `TRON_USDT`, `ETH_USDT`, `ARBITRUM_USDT`, `SOL_USDT`, `BASE_USDT`, `MATIC_USDT`, `BSC_USDT` | **payable_amount** | **str** | The total amount the payer needs to pay, denominated in the specified `payable_currency`. If this field is left blank, the system will automatically calculate the amount at order creation using the following formula: (`pricing_amount` + `fee_amount`) / current exchange rate. Values must be greater than 0 and contain two decimal places. | [optional] **expired_in** | **int** | The pay-in order will expire after approximately a certain number of seconds: - The order status becomes final and cannot be changed - The `received_token_amount` field will no longer be updated - Funds received after expiration will be categorized as late payments and can only be settled from the developer balance. - A late payment will trigger a `transactionLate` webhook event. | [optional] **amount_tolerance** | **str** | The allowed amount deviation, with precision up to 1 decimal place. For example, if `payable_amount` is `100.00` and `amount_tolerance` is `0.50`: - Payer pays 99.55 → Success (difference of 0.45 ≤ 0.5) - Payer pays 99.40 → Underpaid (difference of 0.60 > 0.5) | [optional] diff --git a/docs/CreatePayoutRequest.md b/docs/CreatePayoutRequest.md index 805ed749..a94b212a 100644 --- a/docs/CreatePayoutRequest.md +++ b/docs/CreatePayoutRequest.md @@ -6,11 +6,11 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **request_id** | **str** | The request ID that is used to track a payout request. The request ID is provided by you and must be unique. | +**source_account** | **str** | The source account from which the payout will be made. - If the source account is a merchant account, provide the merchant's ID (e.g., \"M1001\"). - If the source account is the developer account, use the string `\"developer\"`. | **payout_channel** | [**PayoutChannel**](PayoutChannel.md) | | **payout_params** | [**List[PaymentPayoutParam]**](PaymentPayoutParam.md) | | -**bank_account_id** | **str** | The ID of the bank account where the funds will be deposited. Specify this field when `payout_channel` is set to `OffRamp`. You can call [List all bank accounts](https://www.cobo.com/payments/en/api-references/payment/list-all-bank-accounts) to retrieve the IDs of registered bank accounts. To add a new bank account, refer to [Destinations](https://www.cobo.com/payments/en/guides/destinations). | [optional] -**currency** | **str** | The fiat currency you will receive from the payout. - Required when `payout_channel` is set to `OffRamp`. - Currently, only `USD` is supported. | [optional] -**remark** | **str** | The remark for the payout. | [optional] +**recipient_info** | [**PaymentPayoutRecipientInfo**](PaymentPayoutRecipientInfo.md) | | +**remark** | **str** | An optional note or comment about the payout for your internal reference. | [optional] ## Example diff --git a/docs/CreateTopUpAddresses.md b/docs/CreateTopUpAddresses.md new file mode 100644 index 00000000..b6417a19 --- /dev/null +++ b/docs/CreateTopUpAddresses.md @@ -0,0 +1,32 @@ +# CreateTopUpAddresses + +The request body to batch create top-up addresses. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**merchant_id** | **str** | The merchant ID. If not provided, the default merchant created during organization initialization will be used. | [optional] +**token_id** | **str** | The token ID, which identifies the cryptocurrency. | +**custom_payer_ids** | **List[str]** | A list of unique custom payer IDs required to create top-up addresses. The maximum number of items is 50. | + +## Example + +```python +from cobo_waas2.models.create_top_up_addresses import CreateTopUpAddresses + +# TODO update the JSON string below +json = "{}" +# create an instance of CreateTopUpAddresses from a JSON string +create_top_up_addresses_instance = CreateTopUpAddresses.from_json(json) +# print the JSON string representation of the object +print(CreateTopUpAddresses.to_json()) + +# convert the object into a dict +create_top_up_addresses_dict = create_top_up_addresses_instance.to_dict() +# create an instance of CreateTopUpAddresses from a dict +create_top_up_addresses_from_dict = CreateTopUpAddresses.from_dict(create_top_up_addresses_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/CreateTopUpAddresses201Response.md b/docs/CreateTopUpAddresses201Response.md new file mode 100644 index 00000000..b5fa8187 --- /dev/null +++ b/docs/CreateTopUpAddresses201Response.md @@ -0,0 +1,29 @@ +# CreateTopUpAddresses201Response + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | [**List[TopUpAddress]**](TopUpAddress.md) | | [optional] + +## Example + +```python +from cobo_waas2.models.create_top_up_addresses201_response import CreateTopUpAddresses201Response + +# TODO update the JSON string below +json = "{}" +# create an instance of CreateTopUpAddresses201Response from a JSON string +create_top_up_addresses201_response_instance = CreateTopUpAddresses201Response.from_json(json) +# print the JSON string representation of the object +print(CreateTopUpAddresses201Response.to_json()) + +# convert the object into a dict +create_top_up_addresses201_response_dict = create_top_up_addresses201_response_instance.to_dict() +# create an instance of CreateTopUpAddresses201Response from a dict +create_top_up_addresses201_response_from_dict = CreateTopUpAddresses201Response.from_dict(create_top_up_addresses201_response_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/GraphQLApi.md b/docs/GraphQLApi.md new file mode 100644 index 00000000..ac17159c --- /dev/null +++ b/docs/GraphQLApi.md @@ -0,0 +1,84 @@ +# cobo_waas2.GraphQLApi + +All URIs are relative to *https://api.dev.cobo.com/v2* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**execute_graphql**](GraphQLApi.md#execute_graphql) | **POST** /graphql | Execute a GraphQL query or mutation + + +# **execute_graphql** +> GraphQLResponse execute_graphql(graph_ql_request=graph_ql_request) + +Execute a GraphQL query or mutation + +This endpoint executes a GraphQL query or mutation. The request body must include a valid GraphQL query string. + +### Example + +* Api Key Authentication (CoboNonce): +* OAuth Authentication (OAuth2): +* Api Key Authentication (CoboAuth): +* Api Key Authentication (CoboSignature): + +```python +import cobo_waas2 +from cobo_waas2.models.graph_ql_request import GraphQLRequest +from cobo_waas2.models.graph_ql_response import GraphQLResponse +from cobo_waas2.rest import ApiException +from pprint import pprint + +# See configuration.py for a list of all supported configurations. +configuration = cobo_waas2.Configuration( + # Replace `` with your private key + api_private_key="", + # Select the development environment. To use the production environment, change the URL to https://api.cobo.com/v2. + host="https://api.dev.cobo.com/v2" +) +# Enter a context with an instance of the API client +with cobo_waas2.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = cobo_waas2.GraphQLApi(api_client) + graph_ql_request = cobo_waas2.GraphQLRequest() + + try: + # Execute a GraphQL query or mutation + api_response = api_instance.execute_graphql(graph_ql_request=graph_ql_request) + print("The response of GraphQLApi->execute_graphql:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling GraphQLApi->execute_graphql: %s\n" % e) +``` + + + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **graph_ql_request** | [**GraphQLRequest**](GraphQLRequest.md)| The request body to generate addresses within a specified wallet. | [optional] + +### Return type + +[**GraphQLResponse**](GraphQLResponse.md) + +### Authorization + +[CoboNonce](../README.md#CoboNonce), [OAuth2](../README.md#OAuth2), [CoboAuth](../README.md#CoboAuth), [CoboSignature](../README.md#CoboSignature) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | A staking activity has been successfully retrieved. | - | +**4XX** | Bad request. Your request contains malformed syntax or invalid parameters. | - | +**5XX** | Internal server error. | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/ListAllocationItems200Response.md b/docs/ListAllocationItems200Response.md new file mode 100644 index 00000000..9d67d100 --- /dev/null +++ b/docs/ListAllocationItems200Response.md @@ -0,0 +1,30 @@ +# ListAllocationItems200Response + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | [**List[AllocationItem]**](AllocationItem.md) | | [optional] +**pagination** | [**Pagination**](Pagination.md) | | [optional] + +## Example + +```python +from cobo_waas2.models.list_allocation_items200_response import ListAllocationItems200Response + +# TODO update the JSON string below +json = "{}" +# create an instance of ListAllocationItems200Response from a JSON string +list_allocation_items200_response_instance = ListAllocationItems200Response.from_json(json) +# print the JSON string representation of the object +print(ListAllocationItems200Response.to_json()) + +# convert the object into a dict +list_allocation_items200_response_dict = list_allocation_items200_response_instance.to_dict() +# create an instance of ListAllocationItems200Response from a dict +list_allocation_items200_response_from_dict = ListAllocationItems200Response.from_dict(list_allocation_items200_response_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/ListAllocations200Response.md b/docs/ListAllocations200Response.md deleted file mode 100644 index c0e68400..00000000 --- a/docs/ListAllocations200Response.md +++ /dev/null @@ -1,30 +0,0 @@ -# ListAllocations200Response - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**data** | [**List[AllocationRecord]**](AllocationRecord.md) | | [optional] -**pagination** | [**Pagination**](Pagination.md) | | [optional] - -## Example - -```python -from cobo_waas2.models.list_allocations200_response import ListAllocations200Response - -# TODO update the JSON string below -json = "{}" -# create an instance of ListAllocations200Response from a JSON string -list_allocations200_response_instance = ListAllocations200Response.from_json(json) -# print the JSON string representation of the object -print(ListAllocations200Response.to_json()) - -# convert the object into a dict -list_allocations200_response_dict = list_allocations200_response_instance.to_dict() -# create an instance of ListAllocations200Response from a dict -list_allocations200_response_from_dict = ListAllocations200Response.from_dict(list_allocations200_response_dict) -``` -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/ListBulkSendItems200Response.md b/docs/ListBulkSendItems200Response.md new file mode 100644 index 00000000..f14ba240 --- /dev/null +++ b/docs/ListBulkSendItems200Response.md @@ -0,0 +1,30 @@ +# ListBulkSendItems200Response + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | [**List[PaymentBulkSendItem]**](PaymentBulkSendItem.md) | | [optional] +**pagination** | [**Pagination**](Pagination.md) | | [optional] + +## Example + +```python +from cobo_waas2.models.list_bulk_send_items200_response import ListBulkSendItems200Response + +# TODO update the JSON string below +json = "{}" +# create an instance of ListBulkSendItems200Response from a JSON string +list_bulk_send_items200_response_instance = ListBulkSendItems200Response.from_json(json) +# print the JSON string representation of the object +print(ListBulkSendItems200Response.to_json()) + +# convert the object into a dict +list_bulk_send_items200_response_dict = list_bulk_send_items200_response_instance.to_dict() +# create an instance of ListBulkSendItems200Response from a dict +list_bulk_send_items200_response_from_dict = ListBulkSendItems200Response.from_dict(list_bulk_send_items200_response_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/ListPayoutItems200Response.md b/docs/ListPayoutItems200Response.md deleted file mode 100644 index 4354bed6..00000000 --- a/docs/ListPayoutItems200Response.md +++ /dev/null @@ -1,30 +0,0 @@ -# ListPayoutItems200Response - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**data** | [**List[PaymentPayoutItem]**](PaymentPayoutItem.md) | | [optional] -**pagination** | [**Pagination**](Pagination.md) | | [optional] - -## Example - -```python -from cobo_waas2.models.list_payout_items200_response import ListPayoutItems200Response - -# TODO update the JSON string below -json = "{}" -# create an instance of ListPayoutItems200Response from a JSON string -list_payout_items200_response_instance = ListPayoutItems200Response.from_json(json) -# print the JSON string representation of the object -print(ListPayoutItems200Response.to_json()) - -# convert the object into a dict -list_payout_items200_response_dict = list_payout_items200_response_instance.to_dict() -# create an instance of ListPayoutItems200Response from a dict -list_payout_items200_response_from_dict = ListPayoutItems200Response.from_dict(list_payout_items200_response_dict) -``` -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/MPCVaultEventData.md b/docs/MPCVaultEventData.md index 6cf00253..dae8e333 100644 --- a/docs/MPCVaultEventData.md +++ b/docs/MPCVaultEventData.md @@ -5,7 +5,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**data_type** | **str** | The data type of the event. - `Transaction`: The transaction event data. - `TSSRequest`: The TSS request event data. - `Addresses`: The addresses event data. - `WalletInfo`: The wallet information event data. - `MPCVault`: The MPC vault event data. - `Chains`: The enabled chain event data. - `Tokens`: The enabled token event data. - `TokenListing`: The token listing event data. - `PaymentOrder`: The payment order event data. - `PaymentRefund`: The payment refund event data. - `PaymentSettlement`: The payment settlement event data. - `PaymentTransaction`: The payment transaction event data. - `PaymentAddressUpdate`: The top-up address update event data. - `PaymentPayout`: The payment payout event data. - `BalanceUpdateInfo`: The balance update event data. - `SuspendedToken`: The token suspension event data. - `ComplianceDisposition`: The compliance disposition event data. - `ComplianceKytScreenings`: The compliance KYT screenings event data. - `ComplianceKyaScreenings`: The compliance KYA screenings event data. | +**data_type** | **str** | The data type of the event. - `Transaction`: The transaction event data. - `TSSRequest`: The TSS request event data. - `Addresses`: The addresses event data. - `WalletInfo`: The wallet information event data. - `MPCVault`: The MPC vault event data. - `Chains`: The enabled chain event data. - `Tokens`: The enabled token event data. - `TokenListing`: The token listing event data. - `PaymentOrder`: The payment order event data. - `PaymentRefund`: The payment refund event data. - `PaymentSettlement`: The payment settlement event data. - `PaymentTransaction`: The payment transaction event data. - `PaymentAddressUpdate`: The top-up address update event data. - `PaymentPayout`: The payment payout event data. - `PaymentBulkSend`: The payment bulk send event data. - `BalanceUpdateInfo`: The balance update event data. - `SuspendedToken`: The token suspension event data. - `ComplianceDisposition`: The compliance disposition event data. - `ComplianceKytScreenings`: The compliance KYT screenings event data. - `ComplianceKyaScreenings`: The compliance KYA screenings event data. | **vault_id** | **str** | The vault ID. | [optional] **project_id** | **str** | The project ID. | [optional] **name** | **str** | The vault name. | [optional] diff --git a/docs/OrderLinkBusinessInfo.md b/docs/OrderLinkBusinessInfo.md index 500ae1df..3a08d6e4 100644 --- a/docs/OrderLinkBusinessInfo.md +++ b/docs/OrderLinkBusinessInfo.md @@ -8,10 +8,10 @@ Name | Type | Description | Notes **merchant_id** | **str** | The merchant ID. | **merchant_order_code** | **str** | A unique reference code assigned by the merchant to identify this order in their system. The code should have a maximum length of 128 characters. | [optional] **psp_order_code** | **str** | A unique reference code assigned by you as a developer to identify this order in your system. This code must be unique across all orders in your system. The code should have a maximum length of 128 characters. | -**pricing_currency** | **str** | The pricing currency that denominates `pricing_amount` and `fee_amount`. Currently, only `USD`/`USDT`/`USDC` are supported. This field is required. | [optional] -**pricing_amount** | **str** | The base amount of the order, excluding the developer fee (specified in `fee_amount`). Values must be greater than `0` and contain two decimal places. | [optional] +**pricing_currency** | **str** | The pricing currency that denominates `pricing_amount` and `fee_amount`. Currently, only `USD`/`USDT`/`USDC` are supported. This field is required. | +**pricing_amount** | **str** | The base amount of the order, excluding the developer fee (specified in `fee_amount`). Values must be greater than `0` and contain two decimal places. | **fee_amount** | **str** | The developer fee for the order. It is added to the base amount (`pricing_amount`) to determine the final charge. For example, if `pricing_amount` is \"100.00\" and `fee_amount` is \"2.00\", the payer will be charged \"102.00\" in total, with \"100.00\" being settled to the merchant account and \"2.00\" settled to the developer account. Values must be greater than 0 and contain two decimal places. | -**payable_currencies** | **List[str]** | The IDs of the cryptocurrencies used for payment. Supported values: - USDC: `ETH_USDC`, `ARBITRUM_USDC`, `SOL_USDC`, `BASE_USDC`, `MATIC_USDC`, `BSC_USDC` - USDT: `TRON_USDT`, `ETH_USDT`, `ARBITRUM_USDT`, `SOL_USDT`, `BASE_USDT`, `MATIC_USDT`, `BSC_USDT` | [optional] +**payable_currencies** | **List[str]** | The IDs of the cryptocurrencies used for payment. Supported values: - USDC: `ETH_USDC`, `ARBITRUM_USDC`, `SOL_USDC`, `BASE_USDC`, `MATIC_USDC`, `BSC_USDC` - USDT: `TRON_USDT`, `ETH_USDT`, `ARBITRUM_USDT`, `SOL_USDT`, `BASE_USDT`, `MATIC_USDT`, `BSC_USDT` | **payable_amounts** | [**List[OrderLinkBusinessInfoPayableAmountsInner]**](OrderLinkBusinessInfoPayableAmountsInner.md) | The total amounts the payer needs to pay for each currency in `payable_currencies`. If this field is left blank, the system will automatically calculate the amounts at order creation using the following formula: (`pricing_amount` + `fee_amount`) / current exchange rate. Values must be greater than 0 and contain two decimal places. | [optional] **expired_in** | **int** | The number of seconds until the pay-in order expires, counted from when the request is sent. For example, if set to `1800`, the order will expire in 30 minutes. Must be greater than zero and cannot exceed 3 hours (10800 seconds). After expiration: - The order status becomes final and cannot be changed - The `received_token_amount` field will no longer be updated - Funds received after expiration will be categorized as late payments and can only be settled from the developer balance. - A late payment will trigger a `transactionLate` webhook event. | [optional] [default to 1800] **amount_tolerance** | **str** | The allowed amount deviation, with precision up to 1 decimal place. For example, if `payable_amount` is `100.00` and `amount_tolerance` is `0.50`: - Payer pays 99.55 → Success (difference of 0.45 ≤ 0.5) - Payer pays 99.40 → Underpaid (difference of 0.60 > 0.5) | [optional] diff --git a/docs/PaymentAddressUpdateEventData.md b/docs/PaymentAddressUpdateEventData.md index edc7aa3d..c21ba000 100644 --- a/docs/PaymentAddressUpdateEventData.md +++ b/docs/PaymentAddressUpdateEventData.md @@ -5,7 +5,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**data_type** | **str** | The data type of the event. - `Transaction`: The transaction event data. - `TSSRequest`: The TSS request event data. - `Addresses`: The addresses event data. - `WalletInfo`: The wallet information event data. - `MPCVault`: The MPC vault event data. - `Chains`: The enabled chain event data. - `Tokens`: The enabled token event data. - `TokenListing`: The token listing event data. - `PaymentOrder`: The payment order event data. - `PaymentRefund`: The payment refund event data. - `PaymentSettlement`: The payment settlement event data. - `PaymentTransaction`: The payment transaction event data. - `PaymentAddressUpdate`: The top-up address update event data. - `PaymentPayout`: The payment payout event data. - `BalanceUpdateInfo`: The balance update event data. - `SuspendedToken`: The token suspension event data. - `ComplianceDisposition`: The compliance disposition event data. - `ComplianceKytScreenings`: The compliance KYT screenings event data. - `ComplianceKyaScreenings`: The compliance KYA screenings event data. | +**data_type** | **str** | The data type of the event. - `Transaction`: The transaction event data. - `TSSRequest`: The TSS request event data. - `Addresses`: The addresses event data. - `WalletInfo`: The wallet information event data. - `MPCVault`: The MPC vault event data. - `Chains`: The enabled chain event data. - `Tokens`: The enabled token event data. - `TokenListing`: The token listing event data. - `PaymentOrder`: The payment order event data. - `PaymentRefund`: The payment refund event data. - `PaymentSettlement`: The payment settlement event data. - `PaymentTransaction`: The payment transaction event data. - `PaymentAddressUpdate`: The top-up address update event data. - `PaymentPayout`: The payment payout event data. - `PaymentBulkSend`: The payment bulk send event data. - `BalanceUpdateInfo`: The balance update event data. - `SuspendedToken`: The token suspension event data. - `ComplianceDisposition`: The compliance disposition event data. - `ComplianceKytScreenings`: The compliance KYT screenings event data. - `ComplianceKyaScreenings`: The compliance KYA screenings event data. | **custom_payer_id** | **str** | A unique identifier assigned by the developer to track and identify individual payers in their system. | **payer_id** | **str** | A unique identifier assigned by Cobo to track and identify individual payers. | **chain** | **str** | The chain ID. | diff --git a/docs/PaymentApi.md b/docs/PaymentApi.md index 21570c00..1e5d7e4c 100644 --- a/docs/PaymentApi.md +++ b/docs/PaymentApi.md @@ -7,6 +7,7 @@ Method | HTTP request | Description [**batch_get_exchange_rates**](PaymentApi.md#batch_get_exchange_rates) | **GET** /payments/exchange_rates | Batch get exchange rates [**cancel_refund_by_id**](PaymentApi.md#cancel_refund_by_id) | **PUT** /payments/refunds/{refund_id}/cancel | Cancel refund order [**create_batch_allocation**](PaymentApi.md#create_batch_allocation) | **POST** /payments/batch_allocations | Create batch allocation +[**create_bulk_send**](PaymentApi.md#create_bulk_send) | **POST** /payments/bulk_sends | Create bulk send [**create_counterparty**](PaymentApi.md#create_counterparty) | **POST** /payments/counterparty | Create counterparty [**create_counterparty_entry**](PaymentApi.md#create_counterparty_entry) | **POST** /payments/counterparty_entry | Create counterparty entry [**create_counterparty_wallet_address**](PaymentApi.md#create_counterparty_wallet_address) | **POST** /payments/counterparty/wallet_address | Create counterparty wallet address @@ -24,6 +25,7 @@ Method | HTTP request | Description [**create_refund_link**](PaymentApi.md#create_refund_link) | **POST** /payments/links/refunds | Create refund link [**create_report**](PaymentApi.md#create_report) | **POST** /payments/reports | Generate reports [**create_settlement_request**](PaymentApi.md#create_settlement_request) | **POST** /payments/settlement_requests | Create settlement request +[**create_top_up_addresses**](PaymentApi.md#create_top_up_addresses) | **POST** /payments/topup/address | Batch create top-up addresses [**delete_counterparty**](PaymentApi.md#delete_counterparty) | **PUT** /payments/counterparty/{counterparty_id}/delete | Delete counterparty (Deprecated) [**delete_counterparty_by_id**](PaymentApi.md#delete_counterparty_by_id) | **DELETE** /payments/counterparty/{counterparty_id} | Delete counterparty [**delete_counterparty_entry**](PaymentApi.md#delete_counterparty_entry) | **DELETE** /payments/counterparty_entry/{counterparty_entry_id} | Delete counterparty entry @@ -37,6 +39,7 @@ Method | HTTP request | Description [**enable_destination_whitelist**](PaymentApi.md#enable_destination_whitelist) | **POST** /payments/destination/enable_whitelist | Enable or disable destination whitelist [**get_available_allocation_amount**](PaymentApi.md#get_available_allocation_amount) | **GET** /payments/allocation_amount | Get available allocation amount [**get_batch_allocation_by_id**](PaymentApi.md#get_batch_allocation_by_id) | **GET** /payments/batch_allocations/{batch_allocation_id} | Get batch allocation information +[**get_bulk_send_by_id**](PaymentApi.md#get_bulk_send_by_id) | **GET** /payments/bulk_sends/{bulk_send_id} | Get bulk send information [**get_counterparty**](PaymentApi.md#get_counterparty) | **GET** /payments/counterparty/{counterparty_id} | Get counterparty information [**get_counterparty_detail_by_id**](PaymentApi.md#get_counterparty_detail_by_id) | **GET** /payments/counterparty/{counterparty_id}/detail | Get counterparty information (Deprecated) [**get_counterparty_entry**](PaymentApi.md#get_counterparty_entry) | **GET** /payments/counterparty_entry/{counterparty_entry_id} | Get counterparty entry information @@ -54,9 +57,10 @@ Method | HTTP request | Description [**get_settlement_by_id**](PaymentApi.md#get_settlement_by_id) | **GET** /payments/settlement_requests/{settlement_request_id} | Get settlement request information [**get_settlement_info_by_ids**](PaymentApi.md#get_settlement_info_by_ids) | **GET** /payments/settlement_info | Get withdrawable balances [**get_top_up_address**](PaymentApi.md#get_top_up_address) | **GET** /payments/topup/address | Create/Get top-up address -[**list_allocations**](PaymentApi.md#list_allocations) | **GET** /payments/allocation_records | List all allocation records +[**list_allocation_items**](PaymentApi.md#list_allocation_items) | **GET** /payments/allocation_items | List all allocation items [**list_bank_accounts**](PaymentApi.md#list_bank_accounts) | **GET** /payments/bank_accounts | List all bank accounts [**list_batch_allocations**](PaymentApi.md#list_batch_allocations) | **GET** /payments/batch_allocations | List all batch allocations +[**list_bulk_send_items**](PaymentApi.md#list_bulk_send_items) | **GET** /payments/bulk_sends/{bulk_send_id}/items | List bulk send items [**list_counterparties**](PaymentApi.md#list_counterparties) | **GET** /payments/counterparty | List all counterparties [**list_counterparty_entries**](PaymentApi.md#list_counterparty_entries) | **GET** /payments/counterparty_entry | List counterparty entries [**list_counterparty_wallet_address**](PaymentApi.md#list_counterparty_wallet_address) | **GET** /payments/counterparty/wallet_address | List counterparty wallet addresses @@ -71,7 +75,6 @@ Method | HTTP request | Description [**list_payment_orders**](PaymentApi.md#list_payment_orders) | **GET** /payments/orders | List all pay-in orders [**list_payment_supported_tokens**](PaymentApi.md#list_payment_supported_tokens) | **GET** /payments/supported_tokens | List all supported tokens [**list_payment_wallet_balances**](PaymentApi.md#list_payment_wallet_balances) | **GET** /payments/balance/payment_wallets | List payment wallet balances -[**list_payout_items**](PaymentApi.md#list_payout_items) | **GET** /payments/payout_items | List all payout items [**list_payouts**](PaymentApi.md#list_payouts) | **GET** /payments/payouts | List all payouts [**list_settlement_details**](PaymentApi.md#list_settlement_details) | **GET** /payments/settlement_details | List all settlement details [**list_settlement_requests**](PaymentApi.md#list_settlement_requests) | **GET** /payments/settlement_requests | List all settlement requests @@ -310,6 +313,79 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) +# **create_bulk_send** +> PaymentBulkSend create_bulk_send(create_bulk_send_request=create_bulk_send_request) + +Create bulk send + +This operation creates a bulk send to transfer funds to multiple recipients in a single request. + +### Example + +* OAuth Authentication (OAuth2): +* Api Key Authentication (CoboAuth): + +```python +import cobo_waas2 +from cobo_waas2.models.create_bulk_send_request import CreateBulkSendRequest +from cobo_waas2.models.payment_bulk_send import PaymentBulkSend +from cobo_waas2.rest import ApiException +from pprint import pprint + +# See configuration.py for a list of all supported configurations. +configuration = cobo_waas2.Configuration( + # Replace `` with your private key + api_private_key="", + # Select the development environment. To use the production environment, change the URL to https://api.cobo.com/v2. + host="https://api.dev.cobo.com/v2" +) +# Enter a context with an instance of the API client +with cobo_waas2.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = cobo_waas2.PaymentApi(api_client) + create_bulk_send_request = cobo_waas2.CreateBulkSendRequest() + + try: + # Create bulk send + api_response = api_instance.create_bulk_send(create_bulk_send_request=create_bulk_send_request) + print("The response of PaymentApi->create_bulk_send:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling PaymentApi->create_bulk_send: %s\n" % e) +``` + + + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **create_bulk_send_request** | [**CreateBulkSendRequest**](CreateBulkSendRequest.md)| The request body to create a bulk send. | [optional] + +### Return type + +[**PaymentBulkSend**](PaymentBulkSend.md) + +### Authorization + +[OAuth2](../README.md#OAuth2), [CoboAuth](../README.md#CoboAuth) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**201** | The bulk send was successfully created. | - | +**4XX** | Bad request. Your request contains malformed syntax or invalid parameters. | - | +**5XX** | Internal server error. | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + # **create_counterparty** > CounterpartyDetail create_counterparty(create_counterparty_request=create_counterparty_request) @@ -1190,7 +1266,7 @@ Name | Type | Description | Notes Create payout -This operation initiates a payout, distributing funds either to cryptocurrency addresses or to bank accounts as fiat currency. +This operation creates a payout to withdraw available balances. ### Example @@ -1252,7 +1328,7 @@ Name | Type | Description | Notes | Status code | Description | Response headers | |-------------|-------------|------------------| -**201** | The create payout was successfully created. | - | +**201** | The payout request was successfully created. | - | **4XX** | Bad request. Your request contains malformed syntax or invalid parameters. | - | **5XX** | Internal server error. | - | @@ -1481,7 +1557,7 @@ Name | Type | Description | Notes Create settlement request -This operation creates a settlement request to withdraw available balances. +This operation has been deprecated. Please use [Create payout](https://www.cobo.com/payments/en/api-references/payment/create-payout) instead. You can include multiple merchants and cryptocurrencies in a single settlement request. ### Example @@ -1549,6 +1625,79 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) +# **create_top_up_addresses** +> CreateTopUpAddresses201Response create_top_up_addresses(create_top_up_addresses=create_top_up_addresses) + +Batch create top-up addresses + +This operation creates top-up addresses for multiple payers under a specific merchant and token in a single request. This operation supports batch processing of up to 50 payers per request. + +### Example + +* OAuth Authentication (OAuth2): +* Api Key Authentication (CoboAuth): + +```python +import cobo_waas2 +from cobo_waas2.models.create_top_up_addresses import CreateTopUpAddresses +from cobo_waas2.models.create_top_up_addresses201_response import CreateTopUpAddresses201Response +from cobo_waas2.rest import ApiException +from pprint import pprint + +# See configuration.py for a list of all supported configurations. +configuration = cobo_waas2.Configuration( + # Replace `` with your private key + api_private_key="", + # Select the development environment. To use the production environment, change the URL to https://api.cobo.com/v2. + host="https://api.dev.cobo.com/v2" +) +# Enter a context with an instance of the API client +with cobo_waas2.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = cobo_waas2.PaymentApi(api_client) + create_top_up_addresses = cobo_waas2.CreateTopUpAddresses() + + try: + # Batch create top-up addresses + api_response = api_instance.create_top_up_addresses(create_top_up_addresses=create_top_up_addresses) + print("The response of PaymentApi->create_top_up_addresses:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling PaymentApi->create_top_up_addresses: %s\n" % e) +``` + + + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **create_top_up_addresses** | [**CreateTopUpAddresses**](CreateTopUpAddresses.md)| The request body of the create top-up addresses operation. | [optional] + +### Return type + +[**CreateTopUpAddresses201Response**](CreateTopUpAddresses201Response.md) + +### Authorization + +[OAuth2](../README.md#OAuth2), [CoboAuth](../README.md#CoboAuth) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**201** | The information about created top-up addresses. | - | +**4XX** | Bad request. Your request contains malformed syntax or invalid parameters. | - | +**5XX** | Internal server error. | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + # **delete_counterparty** > DeleteCounterparty200Response delete_counterparty(counterparty_id) @@ -2510,6 +2659,78 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) +# **get_bulk_send_by_id** +> PaymentBulkSend get_bulk_send_by_id(bulk_send_id) + +Get bulk send information + +This operation retrieves the information of a specific bulk send. + +### Example + +* OAuth Authentication (OAuth2): +* Api Key Authentication (CoboAuth): + +```python +import cobo_waas2 +from cobo_waas2.models.payment_bulk_send import PaymentBulkSend +from cobo_waas2.rest import ApiException +from pprint import pprint + +# See configuration.py for a list of all supported configurations. +configuration = cobo_waas2.Configuration( + # Replace `` with your private key + api_private_key="", + # Select the development environment. To use the production environment, change the URL to https://api.cobo.com/v2. + host="https://api.dev.cobo.com/v2" +) +# Enter a context with an instance of the API client +with cobo_waas2.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = cobo_waas2.PaymentApi(api_client) + bulk_send_id = '123e4567-e89b-12d3-a456-426614174003' + + try: + # Get bulk send information + api_response = api_instance.get_bulk_send_by_id(bulk_send_id) + print("The response of PaymentApi->get_bulk_send_by_id:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling PaymentApi->get_bulk_send_by_id: %s\n" % e) +``` + + + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **bulk_send_id** | **str**| The bulk send ID. | + +### Return type + +[**PaymentBulkSend**](PaymentBulkSend.md) + +### Authorization + +[OAuth2](../README.md#OAuth2), [CoboAuth](../README.md#CoboAuth) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | The request was successful. | - | +**4XX** | Bad request. Your request contains malformed syntax or invalid parameters. | - | +**5XX** | Internal server error. | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + # **get_counterparty** > CounterpartyDetail get_counterparty(counterparty_id) @@ -3552,7 +3773,7 @@ Name | Type | Description | Notes Get settlement request information -This operation retrieves the information of a specific settlement request. +This operation has been deprecated. Please use [Get payout information](https://www.cobo.com/payments/en/api-references/payment/get-payout-information) instead. This operation retrieves the information of a specific settlement request. ### Example @@ -3671,7 +3892,7 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **merchant_ids** | **str**| A list of merchant IDs to query. | [optional] **currency** | **str**| The currency for the operation. Currently, only `USD` is supported. | [optional] [default to 'USD'] - **acquiring_type** | [**AcquiringType**](.md)| | [optional] + **acquiring_type** | [**AcquiringType**](.md)| This parameter has been deprecated | [optional] ### Return type @@ -3772,12 +3993,12 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **list_allocations** -> ListAllocations200Response list_allocations(limit=limit, before=before, after=after, source_account=source_account, destination_account=destination_account, token_id=token_id, batch_allocation_id=batch_allocation_id) +# **list_allocation_items** +> ListAllocationItems200Response list_allocation_items(limit=limit, before=before, after=after, source_account=source_account, destination_account=destination_account, token_id=token_id, batch_allocation_id=batch_allocation_id) -List all allocation records +List all allocation items -This operation retrieves the information of all allocation records. One allocation record corresponds to one allocation request in a batch allocation. +This operation retrieves the information of all allocations. ### Example @@ -3786,7 +4007,7 @@ This operation retrieves the information of all allocation records. One alloca ```python import cobo_waas2 -from cobo_waas2.models.list_allocations200_response import ListAllocations200Response +from cobo_waas2.models.list_allocation_items200_response import ListAllocationItems200Response from cobo_waas2.rest import ApiException from pprint import pprint @@ -3810,12 +4031,12 @@ with cobo_waas2.ApiClient(configuration) as api_client: batch_allocation_id = '5b0ed293-f728-40b4-b1f6-86b88cd51384' try: - # List all allocation records - api_response = api_instance.list_allocations(limit=limit, before=before, after=after, source_account=source_account, destination_account=destination_account, token_id=token_id, batch_allocation_id=batch_allocation_id) - print("The response of PaymentApi->list_allocations:\n") + # List all allocation items + api_response = api_instance.list_allocation_items(limit=limit, before=before, after=after, source_account=source_account, destination_account=destination_account, token_id=token_id, batch_allocation_id=batch_allocation_id) + print("The response of PaymentApi->list_allocation_items:\n") pprint(api_response) except Exception as e: - print("Exception when calling PaymentApi->list_allocations: %s\n" % e) + print("Exception when calling PaymentApi->list_allocation_items: %s\n" % e) ``` @@ -3835,7 +4056,7 @@ Name | Type | Description | Notes ### Return type -[**ListAllocations200Response**](ListAllocations200Response.md) +[**ListAllocationItems200Response**](ListAllocationItems200Response.md) ### Authorization @@ -3850,7 +4071,7 @@ Name | Type | Description | Notes | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | The allocation records were successfully retrieved. | - | +**200** | The request was successful. | - | **4XX** | Bad request. Your request contains malformed syntax or invalid parameters. | - | **5XX** | Internal server error. | - | @@ -3861,7 +4082,7 @@ Name | Type | Description | Notes List all bank accounts - This operation has been deprecated. This operation retrieves the information of all bank accounts you have registered for payment settlement. Contact our support team at [help@cobo.com](mailto:help@cobo.com) to register a new bank account. +This operation has been deprecated. Please use [List counterparty entries](https://www.cobo.com/payments/en/api-references/payment/list-counterparty-entries) instead. This operation retrieves the information of all bank accounts registered. ### Example @@ -4002,6 +4223,84 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) +# **list_bulk_send_items** +> ListBulkSendItems200Response list_bulk_send_items(bulk_send_id, limit=limit, before=before, after=after) + +List bulk send items + +This operation retrieves the list of items for a specific bulk send. + +### Example + +* OAuth Authentication (OAuth2): +* Api Key Authentication (CoboAuth): + +```python +import cobo_waas2 +from cobo_waas2.models.list_bulk_send_items200_response import ListBulkSendItems200Response +from cobo_waas2.rest import ApiException +from pprint import pprint + +# See configuration.py for a list of all supported configurations. +configuration = cobo_waas2.Configuration( + # Replace `` with your private key + api_private_key="", + # Select the development environment. To use the production environment, change the URL to https://api.cobo.com/v2. + host="https://api.dev.cobo.com/v2" +) +# Enter a context with an instance of the API client +with cobo_waas2.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = cobo_waas2.PaymentApi(api_client) + bulk_send_id = '123e4567-e89b-12d3-a456-426614174003' + limit = 10 + before = 'RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGmk1' + after = 'RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGSAk' + + try: + # List bulk send items + api_response = api_instance.list_bulk_send_items(bulk_send_id, limit=limit, before=before, after=after) + print("The response of PaymentApi->list_bulk_send_items:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling PaymentApi->list_bulk_send_items: %s\n" % e) +``` + + + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **bulk_send_id** | **str**| The bulk send ID. | + **limit** | **int**| The maximum number of objects to return. For most operations, the value range is [1, 50]. | [optional] [default to 10] + **before** | **str**| A cursor indicating the position before the current page. This value is generated by Cobo and returned in the response. If you are paginating forward from the beginning, you do not need to provide it on the first request. When paginating backward (to the previous page), you should pass the before value returned from the last response. | [optional] + **after** | **str**| A cursor indicating the position after the current page. This value is generated by Cobo and returned in the response. You do not need to provide it on the first request. When paginating forward (to the next page), you should pass the after value returned from the last response. | [optional] + +### Return type + +[**ListBulkSendItems200Response**](ListBulkSendItems200Response.md) + +### Authorization + +[OAuth2](../README.md#OAuth2), [CoboAuth](../README.md#CoboAuth) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | The request was successful. | - | +**4XX** | Bad request. Your request contains malformed syntax or invalid parameters. | - | +**5XX** | Internal server error. | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + # **list_counterparties** > ListCounterparties200Response list_counterparties(limit=limit, before=before, after=after, keyword=keyword, counterparty_type=counterparty_type, country=country) @@ -4794,7 +5093,7 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **token_id** | **str**| The token ID, which is a unique identifier that specifies both the blockchain network and cryptocurrency token in the format `{CHAIN}_{TOKEN}`. Supported values include: - USDC: `ETH_USDC`, `ARBITRUM_USDCOIN`, `SOL_USDC`, `BASE_USDC`, `MATIC_USDC2`, `BSC_USDC` - USDT: `TRON_USDT`, `ETH_USDT`, `ARBITRUM_USDT`, `SOL_USDT`, `BASE_USDT`, `MATIC_USDT`, `BSC_USDT` | **merchant_ids** | **str**| A list of merchant IDs to query. | [optional] - **acquiring_type** | [**AcquiringType**](.md)| | [optional] + **acquiring_type** | [**AcquiringType**](.md)| This parameter has been deprecated | [optional] ### Return type @@ -5126,86 +5425,6 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **list_payout_items** -> ListPayoutItems200Response list_payout_items(limit=limit, before=before, after=after, source_account=source_account, statuses=statuses) - -List all payout items - -This operation retrieves the information of all payout items. You can filter the result by source account or status. - -### Example - -* OAuth Authentication (OAuth2): -* Api Key Authentication (CoboAuth): - -```python -import cobo_waas2 -from cobo_waas2.models.list_payout_items200_response import ListPayoutItems200Response -from cobo_waas2.rest import ApiException -from pprint import pprint - -# See configuration.py for a list of all supported configurations. -configuration = cobo_waas2.Configuration( - # Replace `` with your private key - api_private_key="", - # Select the development environment. To use the production environment, change the URL to https://api.cobo.com/v2. - host="https://api.dev.cobo.com/v2" -) -# Enter a context with an instance of the API client -with cobo_waas2.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = cobo_waas2.PaymentApi(api_client) - limit = 10 - before = 'RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGmk1' - after = 'RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGSAk' - source_account = 'source_account_example' - statuses = 'Pending,Processing' - - try: - # List all payout items - api_response = api_instance.list_payout_items(limit=limit, before=before, after=after, source_account=source_account, statuses=statuses) - print("The response of PaymentApi->list_payout_items:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling PaymentApi->list_payout_items: %s\n" % e) -``` - - - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **limit** | **int**| The maximum number of objects to return. For most operations, the value range is [1, 50]. | [optional] [default to 10] - **before** | **str**| A cursor indicating the position before the current page. This value is generated by Cobo and returned in the response. If you are paginating forward from the beginning, you do not need to provide it on the first request. When paginating backward (to the previous page), you should pass the before value returned from the last response. | [optional] - **after** | **str**| A cursor indicating the position after the current page. This value is generated by Cobo and returned in the response. You do not need to provide it on the first request. When paginating forward (to the next page), you should pass the after value returned from the last response. | [optional] - **source_account** | **str**| The source account. - If the source account is a merchant account, provide the merchant's ID (e.g., \"M1001\"). - If the source account is the developer account, use the string `\"developer\"`. | [optional] - **statuses** | **str**| A list of order, refund or payout item statuses. You can refer to the following operations for the possible status values: - [Get pay-in order information](https://www.cobo.com/payments/en/api-references/payment/get-pay-in-order-information) - [Get refund order information](https://www.cobo.com/payments/en/api-references/payment/get-refund-order-information) - [List all payout items](https://www.cobo.com/payments/en/api-references/payment/list-all-payout-items) | [optional] - -### Return type - -[**ListPayoutItems200Response**](ListPayoutItems200Response.md) - -### Authorization - -[OAuth2](../README.md#OAuth2), [CoboAuth](../README.md#CoboAuth) - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - -### HTTP response details - -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | The request was successful. | - | -**4XX** | Bad request. Your request contains malformed syntax or invalid parameters. | - | -**5XX** | Internal server error. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - # **list_payouts** > ListPayouts200Response list_payouts(limit=limit, before=before, after=after, request_id=request_id) @@ -5289,7 +5508,7 @@ Name | Type | Description | Notes List all settlement details -This operation retrieves the information of all settlement details. You can filter the result by merchant ID or status. +This operation has been deprecated. This operation retrieves the information of all settlement details. You can filter the result by merchant ID or status. ### Example @@ -5369,7 +5588,7 @@ Name | Type | Description | Notes List all settlement requests -This operation retrieves the information of all settlement requests. +This operation has been deprecated. Please use [List all payouts](https://www.cobo.com/payments/en/api-references/payment/list-all-payouts) instead. This operation retrieves the information of all settlement requests. ### Example diff --git a/docs/PaymentBulkSend.md b/docs/PaymentBulkSend.md new file mode 100644 index 00000000..0fb61fb2 --- /dev/null +++ b/docs/PaymentBulkSend.md @@ -0,0 +1,35 @@ +# PaymentBulkSend + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**bulk_send_id** | **str** | The bulk send ID. | +**source_account** | **str** | The source account from which the bulk send will be made. - If the source account is a merchant account, provide the merchant's ID (e.g., \"M1001\"). - If the source account is the developer account, use the string `\"developer\"`. | +**description** | **str** | The description for the entire bulk send batch. | [optional] +**execution_mode** | [**PaymentBulkSendExecutionMode**](PaymentBulkSendExecutionMode.md) | | +**status** | [**PaymentBulkSendStatus**](PaymentBulkSendStatus.md) | | +**created_timestamp** | **int** | The created time of the bulk send, represented as a UNIX timestamp in seconds. | +**updated_timestamp** | **int** | The updated time of the bulk send, represented as a UNIX timestamp in seconds. | + +## Example + +```python +from cobo_waas2.models.payment_bulk_send import PaymentBulkSend + +# TODO update the JSON string below +json = "{}" +# create an instance of PaymentBulkSend from a JSON string +payment_bulk_send_instance = PaymentBulkSend.from_json(json) +# print the JSON string representation of the object +print(PaymentBulkSend.to_json()) + +# convert the object into a dict +payment_bulk_send_dict = payment_bulk_send_instance.to_dict() +# create an instance of PaymentBulkSend from a dict +payment_bulk_send_from_dict = PaymentBulkSend.from_dict(payment_bulk_send_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/PaymentBulkSendEvent.md b/docs/PaymentBulkSendEvent.md new file mode 100644 index 00000000..f5ea1b41 --- /dev/null +++ b/docs/PaymentBulkSendEvent.md @@ -0,0 +1,36 @@ +# PaymentBulkSendEvent + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data_type** | **str** | The data type of the event. - `Transaction`: The transaction event data. - `TSSRequest`: The TSS request event data. - `Addresses`: The addresses event data. - `WalletInfo`: The wallet information event data. - `MPCVault`: The MPC vault event data. - `Chains`: The enabled chain event data. - `Tokens`: The enabled token event data. - `TokenListing`: The token listing event data. - `PaymentOrder`: The payment order event data. - `PaymentRefund`: The payment refund event data. - `PaymentSettlement`: The payment settlement event data. - `PaymentTransaction`: The payment transaction event data. - `PaymentAddressUpdate`: The top-up address update event data. - `PaymentPayout`: The payment payout event data. - `PaymentBulkSend`: The payment bulk send event data. - `BalanceUpdateInfo`: The balance update event data. - `SuspendedToken`: The token suspension event data. - `ComplianceDisposition`: The compliance disposition event data. - `ComplianceKytScreenings`: The compliance KYT screenings event data. - `ComplianceKyaScreenings`: The compliance KYA screenings event data. | +**bulk_send_id** | **str** | The bulk send ID. | +**source_account** | **str** | The source account from which the bulk send will be made. - If the source account is a merchant account, provide the merchant's ID (e.g., \"M1001\"). - If the source account is the developer account, use the string `\"developer\"`. | +**description** | **str** | The description for the entire bulk send batch. | [optional] +**execution_mode** | [**PaymentBulkSendExecutionMode**](PaymentBulkSendExecutionMode.md) | | +**status** | [**PaymentBulkSendStatus**](PaymentBulkSendStatus.md) | | +**created_timestamp** | **int** | The created time of the bulk send, represented as a UNIX timestamp in seconds. | +**updated_timestamp** | **int** | The updated time of the bulk send, represented as a UNIX timestamp in seconds. | + +## Example + +```python +from cobo_waas2.models.payment_bulk_send_event import PaymentBulkSendEvent + +# TODO update the JSON string below +json = "{}" +# create an instance of PaymentBulkSendEvent from a JSON string +payment_bulk_send_event_instance = PaymentBulkSendEvent.from_json(json) +# print the JSON string representation of the object +print(PaymentBulkSendEvent.to_json()) + +# convert the object into a dict +payment_bulk_send_event_dict = payment_bulk_send_event_instance.to_dict() +# create an instance of PaymentBulkSendEvent from a dict +payment_bulk_send_event_from_dict = PaymentBulkSendEvent.from_dict(payment_bulk_send_event_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/PaymentBulkSendExecutionMode.md b/docs/PaymentBulkSendExecutionMode.md new file mode 100644 index 00000000..9a77b009 --- /dev/null +++ b/docs/PaymentBulkSendExecutionMode.md @@ -0,0 +1,12 @@ +# PaymentBulkSendExecutionMode + +The execution mode of the bulk send. - `Strict`: The bulk send is executed in strict mode, which means all bulk send items should be successfully executed or all failed. - `Partial`: The bulk send is executed in partial mode, which means some bulk send items can be successfully executed and some can be failed. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/PaymentBulkSendItem.md b/docs/PaymentBulkSendItem.md new file mode 100644 index 00000000..b7d0740d --- /dev/null +++ b/docs/PaymentBulkSendItem.md @@ -0,0 +1,35 @@ +# PaymentBulkSendItem + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**bulk_send_item_id** | **str** | The payout item ID. | +**token_id** | **str** | The token ID of the payout item. | +**receiving_address** | **str** | The receiving address of the payout item. | +**amount** | **str** | The amount of the payout item. | +**description** | **str** | The note of the payout item. | [optional] +**status** | [**PaymentBulkSendItemStatus**](PaymentBulkSendItemStatus.md) | | +**validation_status** | [**PaymentBulkSendItemValidationStatus**](PaymentBulkSendItemValidationStatus.md) | | + +## Example + +```python +from cobo_waas2.models.payment_bulk_send_item import PaymentBulkSendItem + +# TODO update the JSON string below +json = "{}" +# create an instance of PaymentBulkSendItem from a JSON string +payment_bulk_send_item_instance = PaymentBulkSendItem.from_json(json) +# print the JSON string representation of the object +print(PaymentBulkSendItem.to_json()) + +# convert the object into a dict +payment_bulk_send_item_dict = payment_bulk_send_item_instance.to_dict() +# create an instance of PaymentBulkSendItem from a dict +payment_bulk_send_item_from_dict = PaymentBulkSendItem.from_dict(payment_bulk_send_item_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/PaymentBulkSendItemStatus.md b/docs/PaymentBulkSendItemStatus.md new file mode 100644 index 00000000..a9e91c3a --- /dev/null +++ b/docs/PaymentBulkSendItemStatus.md @@ -0,0 +1,12 @@ +# PaymentBulkSendItemStatus + +The current status of the bulk send item. Possible values include: - `Pending`: The bulk send item has been created and is waiting to be processed. - `Processing`: The bulk send item is currently being processed and the transfer is in progress. - `Completed`: The bulk send item has been successfully processed and the funds have been transferred. - `Failed`: The bulk send item processing has failed and the funds were not transferred. - `NotExecuted`: The bulk send item was not executed, typically due to the bulk send being cancelled or an earlier validation failure. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/PaymentBulkSendItemValidationStatus.md b/docs/PaymentBulkSendItemValidationStatus.md new file mode 100644 index 00000000..5d4e331d --- /dev/null +++ b/docs/PaymentBulkSendItemValidationStatus.md @@ -0,0 +1,12 @@ +# PaymentBulkSendItemValidationStatus + +The current validation status of the bulk send item. Possible values include: - `Pending`: The bulk send item has not yet been validated. - `Validated`: The bulk send item has passed validation and is ready to be processed. - `ValidationFailed`: The bulk send item has failed validation and cannot be processed. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/PaymentBulkSendStatus.md b/docs/PaymentBulkSendStatus.md new file mode 100644 index 00000000..a11915e0 --- /dev/null +++ b/docs/PaymentBulkSendStatus.md @@ -0,0 +1,12 @@ +# PaymentBulkSendStatus + +The current status of the bulk send. Possible values include: - `Pending`: The bulk send has been created and is waiting to be processed. - `Validating`: The bulk send items are being validated. - `Transferring`: The bulk send items are being processed and funds are being transferred. - `Completed`: All items in the bulk send have been successfully processed. - `PartiallyCompleted`: Some items in the bulk send have been successfully processed, while others have failed. - `Failed`: The bulk send has failed and no items were processed successfully. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/PaymentEstimateFeeRequest.md b/docs/PaymentEstimateFeeRequest.md index 9fe80599..524125b2 100644 --- a/docs/PaymentEstimateFeeRequest.md +++ b/docs/PaymentEstimateFeeRequest.md @@ -7,6 +7,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **fee_type** | [**PaymentFeeType**](PaymentFeeType.md) | | [optional] **estimate_fees** | [**List[PaymentEstimateFee]**](PaymentEstimateFee.md) | A list of token IDs and amounts for which fees will be calculated. | +**recipient_token_id** | **str** | The token ID that the recipient will receive. Required only when `fee_type` is `CryptoPayoutBridge`. | [optional] ## Example diff --git a/docs/PaymentFeeType.md b/docs/PaymentFeeType.md index cf00ca1b..71a2103f 100644 --- a/docs/PaymentFeeType.md +++ b/docs/PaymentFeeType.md @@ -1,6 +1,6 @@ # PaymentFeeType -The type of fee to estimate: - `Order`: Fee for accepting a payment. - `Refund`: Fee for processing a refund. - `CryptoSettlement`: Fee for crypto payouts. - `OffRampSettlement`: Fee for fiat off-ramp. +The fee type. Possible values include: - `Order`: Fees for order processing. - `Refund`: Fees for refund processing. - `CryptoSettlement`: This fee type is deprecated. Please use `CryptoPayout` instead. - `OffRampSettlement`: This fee type is deprecated. Please use `OffRampPayout` instead. - `CryptoPayout`: Fees for crypto payouts. - `CryptoPayoutBridge`: Fees for crypto payouts with cross-chain bridging. - `OffRampPayout`: Fees for fiat off-ramp payouts. ## Properties diff --git a/docs/PaymentOrderEventData.md b/docs/PaymentOrderEventData.md index e762bd32..965eb656 100644 --- a/docs/PaymentOrderEventData.md +++ b/docs/PaymentOrderEventData.md @@ -5,7 +5,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**data_type** | **str** | The data type of the event. - `Transaction`: The transaction event data. - `TSSRequest`: The TSS request event data. - `Addresses`: The addresses event data. - `WalletInfo`: The wallet information event data. - `MPCVault`: The MPC vault event data. - `Chains`: The enabled chain event data. - `Tokens`: The enabled token event data. - `TokenListing`: The token listing event data. - `PaymentOrder`: The payment order event data. - `PaymentRefund`: The payment refund event data. - `PaymentSettlement`: The payment settlement event data. - `PaymentTransaction`: The payment transaction event data. - `PaymentAddressUpdate`: The top-up address update event data. - `PaymentPayout`: The payment payout event data. - `BalanceUpdateInfo`: The balance update event data. - `SuspendedToken`: The token suspension event data. - `ComplianceDisposition`: The compliance disposition event data. - `ComplianceKytScreenings`: The compliance KYT screenings event data. - `ComplianceKyaScreenings`: The compliance KYA screenings event data. | +**data_type** | **str** | The data type of the event. - `Transaction`: The transaction event data. - `TSSRequest`: The TSS request event data. - `Addresses`: The addresses event data. - `WalletInfo`: The wallet information event data. - `MPCVault`: The MPC vault event data. - `Chains`: The enabled chain event data. - `Tokens`: The enabled token event data. - `TokenListing`: The token listing event data. - `PaymentOrder`: The payment order event data. - `PaymentRefund`: The payment refund event data. - `PaymentSettlement`: The payment settlement event data. - `PaymentTransaction`: The payment transaction event data. - `PaymentAddressUpdate`: The top-up address update event data. - `PaymentPayout`: The payment payout event data. - `PaymentBulkSend`: The payment bulk send event data. - `BalanceUpdateInfo`: The balance update event data. - `SuspendedToken`: The token suspension event data. - `ComplianceDisposition`: The compliance disposition event data. - `ComplianceKytScreenings`: The compliance KYT screenings event data. - `ComplianceKyaScreenings`: The compliance KYA screenings event data. | **order_id** | **str** | The order ID. | **merchant_id** | **str** | The merchant ID. | [optional] **merchant_order_code** | **str** | A unique reference code assigned by the merchant to identify this order in their system. | [optional] diff --git a/docs/PaymentPayout.md b/docs/PaymentPayout.md index 7cfb5a8b..1d74ea67 100644 --- a/docs/PaymentPayout.md +++ b/docs/PaymentPayout.md @@ -8,14 +8,15 @@ Name | Type | Description | Notes **payout_id** | **str** | The payout ID generated by Cobo. | **request_id** | **str** | The request ID provided by you when creating the payout. | **payout_channel** | [**PayoutChannel**](PayoutChannel.md) | | -**payout_items** | [**List[PaymentPayoutItem]**](PaymentPayoutItem.md) | | [optional] +**source_account** | **str** | The source account from which the payout will be made. - If the source account is a merchant account, provide the merchant's ID (e.g., \"M1001\"). - If the source account is the developer account, use the string `\"developer\"`. | [optional] +**payout_items** | [**List[PaymentPayoutItem]**](PaymentPayoutItem.md) | required | [optional] +**recipient_info** | [**PaymentPayoutRecipientInfo**](PaymentPayoutRecipientInfo.md) | | [optional] +**initiator** | **str** | The initiator of this payout, usually the user's API key. | [optional] +**actual_payout_amount** | **str** | - For `Crypto` payouts: The amount of cryptocurrency sent to the recipient's address, denominated in the token specified in `recipient_info.token_id`. - For `OffRamp` payouts: The amount of fiat currency sent to the recipient's bank account, denominated in the currency specified in `recipient_info.currency`. (Note: The actual amount received may be lower due to additional bank transfer fees.) | [optional] **status** | [**PaymentPayoutStatus**](PaymentPayoutStatus.md) | | -**created_timestamp** | **int** | The created time of the payout, represented as a UNIX timestamp in seconds. | [optional] -**updated_timestamp** | **int** | The updated time of the payout, represented as a UNIX timestamp in seconds. | [optional] -**initiator** | **str** | The initiator of this payout, usually the API key used to create the payout. | [optional] -**currency** | **str** | The fiat currency you will receive from the payout. | [optional] -**actual_payout_amount** | **str** | The total amount of cryptocurrency actually paid out for this payout. | [optional] -**bank_account** | [**BankAccount**](BankAccount.md) | | [optional] +**remark** | **str** | A note or comment about the payout. | [optional] +**created_timestamp** | **int** | The created time of the payout, represented as a UNIX timestamp in seconds. | +**updated_timestamp** | **int** | The updated time of the payout, represented as a UNIX timestamp in seconds. | ## Example diff --git a/docs/PaymentPayoutDetail.md b/docs/PaymentPayoutDetail.md index dfe61352..297495c8 100644 --- a/docs/PaymentPayoutDetail.md +++ b/docs/PaymentPayoutDetail.md @@ -7,15 +7,17 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **payout_id** | **str** | The payout ID generated by Cobo. | **request_id** | **str** | The request ID provided by you when creating the payout. | +**payout_channel** | [**PayoutChannel**](PayoutChannel.md) | | +**source_account** | **str** | The source account from which the payout will be made. - If the source account is a merchant account, provide the merchant's ID (e.g., \"M1001\"). - If the source account is the developer account, use the string `\"developer\"`. | [optional] +**payout_items** | [**List[PaymentPayoutItem]**](PaymentPayoutItem.md) | required | [optional] +**recipient_info** | [**PaymentPayoutRecipientInfo**](PaymentPayoutRecipientInfo.md) | | [optional] +**initiator** | **str** | The initiator of this payout, usually the user's API key. | [optional] +**actual_payout_amount** | **str** | - For `Crypto` payouts: The amount of cryptocurrency sent to the recipient's address, denominated in the token specified in `recipient_info.token_id`. - For `OffRamp` payouts: The amount of fiat currency sent to the recipient's bank account, denominated in the currency specified in `recipient_info.currency`. (Note: The actual amount received may be lower due to additional bank transfer fees.) | [optional] **status** | [**PaymentPayoutStatus**](PaymentPayoutStatus.md) | | -**payout_item_details** | [**List[PaymentPayoutItemDetail]**](PaymentPayoutItemDetail.md) | | [optional] -**created_timestamp** | **int** | The created time of the payout, represented as a UNIX timestamp in seconds. | [optional] -**updated_timestamp** | **int** | The updated time of the payout, represented as a UNIX timestamp in seconds. | [optional] -**initiator** | **str** | The initiator of this payout, usually the API key used to create the payout. | [optional] -**payout_channel** | [**PayoutChannel**](PayoutChannel.md) | | [optional] -**currency** | **str** | The fiat currency you will receive from the payout. | [optional] -**actual_payout_amount** | **str** | The total amount of cryptocurrency actually paid out for this payout. | [optional] -**bank_account** | [**BankAccount**](BankAccount.md) | | [optional] +**remark** | **str** | A note or comment about the payout. | [optional] +**created_timestamp** | **int** | The created time of the payout, represented as a UNIX timestamp in seconds. | +**updated_timestamp** | **int** | The updated time of the payout, represented as a UNIX timestamp in seconds. | +**transactions** | [**List[PaymentTransaction]**](PaymentTransaction.md) | An array of payout transactions. | [optional] ## Example diff --git a/docs/PaymentPayoutEvent.md b/docs/PaymentPayoutEvent.md index 811d44ad..df15b59b 100644 --- a/docs/PaymentPayoutEvent.md +++ b/docs/PaymentPayoutEvent.md @@ -5,18 +5,20 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**data_type** | **str** | The data type of the event. - `Transaction`: The transaction event data. - `TSSRequest`: The TSS request event data. - `Addresses`: The addresses event data. - `WalletInfo`: The wallet information event data. - `MPCVault`: The MPC vault event data. - `Chains`: The enabled chain event data. - `Tokens`: The enabled token event data. - `TokenListing`: The token listing event data. - `PaymentOrder`: The payment order event data. - `PaymentRefund`: The payment refund event data. - `PaymentSettlement`: The payment settlement event data. - `PaymentTransaction`: The payment transaction event data. - `PaymentAddressUpdate`: The top-up address update event data. - `PaymentPayout`: The payment payout event data. - `BalanceUpdateInfo`: The balance update event data. - `SuspendedToken`: The token suspension event data. - `ComplianceDisposition`: The compliance disposition event data. - `ComplianceKytScreenings`: The compliance KYT screenings event data. - `ComplianceKyaScreenings`: The compliance KYA screenings event data. | +**data_type** | **str** | The data type of the event. - `Transaction`: The transaction event data. - `TSSRequest`: The TSS request event data. - `Addresses`: The addresses event data. - `WalletInfo`: The wallet information event data. - `MPCVault`: The MPC vault event data. - `Chains`: The enabled chain event data. - `Tokens`: The enabled token event data. - `TokenListing`: The token listing event data. - `PaymentOrder`: The payment order event data. - `PaymentRefund`: The payment refund event data. - `PaymentSettlement`: The payment settlement event data. - `PaymentTransaction`: The payment transaction event data. - `PaymentAddressUpdate`: The top-up address update event data. - `PaymentPayout`: The payment payout event data. - `PaymentBulkSend`: The payment bulk send event data. - `BalanceUpdateInfo`: The balance update event data. - `SuspendedToken`: The token suspension event data. - `ComplianceDisposition`: The compliance disposition event data. - `ComplianceKytScreenings`: The compliance KYT screenings event data. - `ComplianceKyaScreenings`: The compliance KYA screenings event data. | **payout_id** | **str** | The payout ID generated by Cobo. | **request_id** | **str** | The request ID provided by you when creating the payout. | +**payout_channel** | [**PayoutChannel**](PayoutChannel.md) | | +**source_account** | **str** | The source account from which the payout will be made. - If the source account is a merchant account, provide the merchant's ID (e.g., \"M1001\"). - If the source account is the developer account, use the string `\"developer\"`. | [optional] +**payout_items** | [**List[PaymentPayoutItem]**](PaymentPayoutItem.md) | required | [optional] +**recipient_info** | [**PaymentPayoutRecipientInfo**](PaymentPayoutRecipientInfo.md) | | [optional] +**initiator** | **str** | The initiator of this payout, usually the user's API key. | [optional] +**actual_payout_amount** | **str** | - For `Crypto` payouts: The amount of cryptocurrency sent to the recipient's address, denominated in the token specified in `recipient_info.token_id`. - For `OffRamp` payouts: The amount of fiat currency sent to the recipient's bank account, denominated in the currency specified in `recipient_info.currency`. (Note: The actual amount received may be lower due to additional bank transfer fees.) | [optional] **status** | [**PaymentPayoutStatus**](PaymentPayoutStatus.md) | | -**payout_item_details** | [**List[PaymentPayoutItemDetail]**](PaymentPayoutItemDetail.md) | | [optional] -**created_timestamp** | **int** | The created time of the payout, represented as a UNIX timestamp in seconds. | [optional] -**updated_timestamp** | **int** | The updated time of the payout, represented as a UNIX timestamp in seconds. | [optional] -**initiator** | **str** | The initiator of this payout, usually the API key used to create the payout. | [optional] -**payout_channel** | [**PayoutChannel**](PayoutChannel.md) | | [optional] -**currency** | **str** | The fiat currency you will receive from the payout. | [optional] -**actual_payout_amount** | **str** | The total amount of cryptocurrency actually paid out for this payout. | [optional] -**bank_account** | [**BankAccount**](BankAccount.md) | | [optional] +**remark** | **str** | A note or comment about the payout. | [optional] +**created_timestamp** | **int** | The created time of the payout, represented as a UNIX timestamp in seconds. | +**updated_timestamp** | **int** | The updated time of the payout, represented as a UNIX timestamp in seconds. | +**transactions** | [**List[PaymentTransaction]**](PaymentTransaction.md) | An array of payout transactions. | [optional] ## Example diff --git a/docs/PaymentPayoutItem.md b/docs/PaymentPayoutItem.md index b9ae28d6..f1bad269 100644 --- a/docs/PaymentPayoutItem.md +++ b/docs/PaymentPayoutItem.md @@ -5,19 +5,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**payout_item_id** | **str** | The payout item ID generated by Cobo. | -**payout_id** | **str** | The payout ID generated by Cobo. | -**token_id** | **str** | The ID of the cryptocurrency paid out. | [optional] -**chain_id** | **str** | The ID of the blockchain network on which the payout occurred. | [optional] -**amount** | **str** | The amount of the cryptocurrency to pay out. | -**status** | [**PaymentPayoutItemStatus**](PaymentPayoutItemStatus.md) | | -**source_account** | **str** | The source account from which the payout was made. - If the source account is a merchant account, provide the merchant's ID (e.g., \"M1001\"). - If the source account is the developer account, use the string `\"developer\"`. | -**transactions** | [**List[PaymentTransaction]**](PaymentTransaction.md) | An array of transactions associated with this payout item. Each transaction represents a separate blockchain operation related to the payout item process. | [optional] -**created_timestamp** | **int** | The created time of the payout item, represented as a UNIX timestamp in seconds. | [optional] -**updated_timestamp** | **int** | The updated time of the payout item, represented as a UNIX timestamp in seconds. | [optional] -**crypto_address_id** | **str** | The ID of the crypto address used for crypto payouts. | [optional] -**crypto_address** | **str** | The actual blockchain address to which funds were transferred. | [optional] -**commission_fee** | [**CommissionFee**](CommissionFee.md) | | [optional] +**token_id** | **str** | The token ID of the payout item. | +**amount** | **str** | The amount of the payout item. | **bridging_fee** | [**BridgingFee**](BridgingFee.md) | | [optional] ## Example diff --git a/docs/PaymentPayoutItemDetail.md b/docs/PaymentPayoutItemDetail.md deleted file mode 100644 index dc140c77..00000000 --- a/docs/PaymentPayoutItemDetail.md +++ /dev/null @@ -1,42 +0,0 @@ -# PaymentPayoutItemDetail - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**payout_item_id** | **str** | The payout item ID generated by Cobo. | -**payout_id** | **str** | The payout ID generated by Cobo. | -**token_id** | **str** | The ID of the cryptocurrency paid out. | [optional] -**chain_id** | **str** | The ID of the blockchain network on which the payout occurred. | [optional] -**source_account** | **str** | The source account from which the payout was made. - If the source account is a merchant account, provide the merchant's ID (e.g., \"M1001\"). - If the source account is the developer account, use the string `\"developer\"`. | -**amount** | **str** | The amount of the cryptocurrency paid out. | -**status** | [**PaymentPayoutStatus**](PaymentPayoutStatus.md) | | -**transactions** | [**List[PaymentTransaction]**](PaymentTransaction.md) | An array of transactions associated with this payout item. Each transaction represents a separate blockchain operation related to the payout process. | [optional] -**created_timestamp** | **int** | The created time of the payout, represented as a UNIX timestamp in seconds. | [optional] -**updated_timestamp** | **int** | The updated time of the payout, represented as a UNIX timestamp in seconds. | [optional] -**crypto_address_id** | **str** | The ID of the crypto address used for crypto payouts. | [optional] -**crypto_address** | **str** | The actual blockchain address to which funds were transferred for crypto payouts. | [optional] -**commission_fee** | [**CommissionFee**](CommissionFee.md) | | [optional] -**bridging_fee** | [**BridgingFee**](BridgingFee.md) | | [optional] - -## Example - -```python -from cobo_waas2.models.payment_payout_item_detail import PaymentPayoutItemDetail - -# TODO update the JSON string below -json = "{}" -# create an instance of PaymentPayoutItemDetail from a JSON string -payment_payout_item_detail_instance = PaymentPayoutItemDetail.from_json(json) -# print the JSON string representation of the object -print(PaymentPayoutItemDetail.to_json()) - -# convert the object into a dict -payment_payout_item_detail_dict = payment_payout_item_detail_instance.to_dict() -# create an instance of PaymentPayoutItemDetail from a dict -payment_payout_item_detail_from_dict = PaymentPayoutItemDetail.from_dict(payment_payout_item_detail_dict) -``` -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/PaymentPayoutItemStatus.md b/docs/PaymentPayoutItemStatus.md deleted file mode 100644 index 244b5c42..00000000 --- a/docs/PaymentPayoutItemStatus.md +++ /dev/null @@ -1,12 +0,0 @@ -# PaymentPayoutItemStatus - -The current status of the payout item: - `Pending`: The payout item has been created and is awaiting processing. - `Processing`: The payout item is being processed. - `Completed`: The funds have been successfully deposited into the bank account. - `PartiallyCompleted`: Some payout item transactions have been completed successfully, while others have failed. - `Failed`: The payout item could not be completed due to an error. - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/PaymentPayoutParam.md b/docs/PaymentPayoutParam.md index def07d5a..6a4d961b 100644 --- a/docs/PaymentPayoutParam.md +++ b/docs/PaymentPayoutParam.md @@ -5,11 +5,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**source_account** | **str** | The source account from which the payout will be made. - If the source account is a merchant account, provide the merchant's ID (e.g., \"M1001\"). - If the source account is the developer account, use the string `\"developer\"`. | **token_id** | **str** | The ID of the cryptocurrency you want to pay out. Specify this field when `payout_channel` is set to `Crypto`. Supported values: - USDC: `ETH_USDC`, `ARBITRUM_USDC`, `SOL_USDC`, `BASE_USDC`, `MATIC_USDC`, `BSC_USDC` - USDT: `TRON_USDT`, `ETH_USDT`, `ARBITRUM_USDT`, `SOL_USDT`, `BASE_USDT`, `MATIC_USDT`, `BSC_USDT` | -**amount** | **str** | The amount of the cryptocurrency to pay out. | -**crypto_address_id** | **str** | The ID of the crypto address used for crypto payouts. Specify this field when `payout_channel` is set to `Crypto`. Call [List crypto addresses](https://www.cobo.com/payments/en/api-references/payment/list-crypto-addresses) to retrieve registered crypto addresses. | [optional] -**crypto_address** | **str** | The actual blockchain address to which funds will be transferred. Specify this field when `payout_channel` is set to `Crypto`. <Note> If you have enabled the *Use Destinations as Payout Whitelist* toggle in *Destinations*, you can only transfer to registered destinations. For more details, see [Destinations](https://www.cobo.com/payments/en/guides/destinations). </Note> | [optional] +**amount** | **str** | The payout cryptocurrency amount. | ## Example diff --git a/docs/PaymentPayoutRecipientInfo.md b/docs/PaymentPayoutRecipientInfo.md new file mode 100644 index 00000000..7770701d --- /dev/null +++ b/docs/PaymentPayoutRecipientInfo.md @@ -0,0 +1,32 @@ +# PaymentPayoutRecipientInfo + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**address** | **str** | The recipient's wallet address where the payout will be sent. | [optional] +**token_id** | **str** | The token ID for the cryptocurrency to be sent to the recipient. If `recipient_info.token_id` is on a different chain than `payout_param.token_id`, the token will be automatically bridged to the chain specified in `recipient_info.token_id`. | [optional] +**currency** | **str** | The fiat currency of the bank account to which the payout will be sent. | [optional] +**bank_account_id** | **str** | The ID of the bank account to which the payout will be sent. You can retrieve the bank account ID by calling [List destination entries](https://www.cobo.com/payments/en/api-references/payment/list-destination-entries). | [optional] + +## Example + +```python +from cobo_waas2.models.payment_payout_recipient_info import PaymentPayoutRecipientInfo + +# TODO update the JSON string below +json = "{}" +# create an instance of PaymentPayoutRecipientInfo from a JSON string +payment_payout_recipient_info_instance = PaymentPayoutRecipientInfo.from_json(json) +# print the JSON string representation of the object +print(PaymentPayoutRecipientInfo.to_json()) + +# convert the object into a dict +payment_payout_recipient_info_dict = payment_payout_recipient_info_instance.to_dict() +# create an instance of PaymentPayoutRecipientInfo from a dict +payment_payout_recipient_info_from_dict = PaymentPayoutRecipientInfo.from_dict(payment_payout_recipient_info_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/PaymentPayoutStatus.md b/docs/PaymentPayoutStatus.md index 7cb481a6..4e69cc06 100644 --- a/docs/PaymentPayoutStatus.md +++ b/docs/PaymentPayoutStatus.md @@ -1,6 +1,6 @@ # PaymentPayoutStatus -The current status of the payout: - `Pending`: The payout has been created and is awaiting processing. - `Processing`: The payout is currently being processed, with at least one payout item in progress. - `Completed`: All requested payout items have been completed. - `PartiallyCompleted`: Some requested payout items have been completed successfully, while others have failed. - `Failed`: All requested payout items have failed. +The current status of the payout. Possible values include: - `Pending`: The payout has been created and is awaiting processing. - `Preparing`: The payout is being prepared for transfer. - `Transferring`: The payout is currently being transferred to the recipient's destination. - `Completed`: The payout has been successfully completed and all transactions have been processed. - `PartiallyCompleted`: The payout has been partially completed, with some transactions succeeding and others failing. - `Failed`: The payout has failed and no transactions were completed successfully. - `RejectedByBank`: The payout was rejected by the recipient's bank (applicable to OffRamp payouts only). ## Properties diff --git a/docs/PaymentRefundEventData.md b/docs/PaymentRefundEventData.md index 26f1a38f..ed68c7f1 100644 --- a/docs/PaymentRefundEventData.md +++ b/docs/PaymentRefundEventData.md @@ -5,7 +5,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**data_type** | **str** | The data type of the event. - `Transaction`: The transaction event data. - `TSSRequest`: The TSS request event data. - `Addresses`: The addresses event data. - `WalletInfo`: The wallet information event data. - `MPCVault`: The MPC vault event data. - `Chains`: The enabled chain event data. - `Tokens`: The enabled token event data. - `TokenListing`: The token listing event data. - `PaymentOrder`: The payment order event data. - `PaymentRefund`: The payment refund event data. - `PaymentSettlement`: The payment settlement event data. - `PaymentTransaction`: The payment transaction event data. - `PaymentAddressUpdate`: The top-up address update event data. - `PaymentPayout`: The payment payout event data. - `BalanceUpdateInfo`: The balance update event data. - `SuspendedToken`: The token suspension event data. - `ComplianceDisposition`: The compliance disposition event data. - `ComplianceKytScreenings`: The compliance KYT screenings event data. - `ComplianceKyaScreenings`: The compliance KYA screenings event data. | +**data_type** | **str** | The data type of the event. - `Transaction`: The transaction event data. - `TSSRequest`: The TSS request event data. - `Addresses`: The addresses event data. - `WalletInfo`: The wallet information event data. - `MPCVault`: The MPC vault event data. - `Chains`: The enabled chain event data. - `Tokens`: The enabled token event data. - `TokenListing`: The token listing event data. - `PaymentOrder`: The payment order event data. - `PaymentRefund`: The payment refund event data. - `PaymentSettlement`: The payment settlement event data. - `PaymentTransaction`: The payment transaction event data. - `PaymentAddressUpdate`: The top-up address update event data. - `PaymentPayout`: The payment payout event data. - `PaymentBulkSend`: The payment bulk send event data. - `BalanceUpdateInfo`: The balance update event data. - `SuspendedToken`: The token suspension event data. - `ComplianceDisposition`: The compliance disposition event data. - `ComplianceKytScreenings`: The compliance KYT screenings event data. - `ComplianceKyaScreenings`: The compliance KYA screenings event data. | **request_id** | **str** | The request ID provided by you when creating the refund request. | [optional] **refund_id** | **str** | The refund order ID. | **order_id** | **str** | The ID of the pay-in order corresponding to this refund. | [optional] diff --git a/docs/PaymentSettlementEvent.md b/docs/PaymentSettlementEvent.md index 1046dfb4..64446ae9 100644 --- a/docs/PaymentSettlementEvent.md +++ b/docs/PaymentSettlementEvent.md @@ -5,7 +5,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**data_type** | **str** | The data type of the event. - `Transaction`: The transaction event data. - `TSSRequest`: The TSS request event data. - `Addresses`: The addresses event data. - `WalletInfo`: The wallet information event data. - `MPCVault`: The MPC vault event data. - `Chains`: The enabled chain event data. - `Tokens`: The enabled token event data. - `TokenListing`: The token listing event data. - `PaymentOrder`: The payment order event data. - `PaymentRefund`: The payment refund event data. - `PaymentSettlement`: The payment settlement event data. - `PaymentTransaction`: The payment transaction event data. - `PaymentAddressUpdate`: The top-up address update event data. - `PaymentPayout`: The payment payout event data. - `BalanceUpdateInfo`: The balance update event data. - `SuspendedToken`: The token suspension event data. - `ComplianceDisposition`: The compliance disposition event data. - `ComplianceKytScreenings`: The compliance KYT screenings event data. - `ComplianceKyaScreenings`: The compliance KYA screenings event data. | +**data_type** | **str** | The data type of the event. - `Transaction`: The transaction event data. - `TSSRequest`: The TSS request event data. - `Addresses`: The addresses event data. - `WalletInfo`: The wallet information event data. - `MPCVault`: The MPC vault event data. - `Chains`: The enabled chain event data. - `Tokens`: The enabled token event data. - `TokenListing`: The token listing event data. - `PaymentOrder`: The payment order event data. - `PaymentRefund`: The payment refund event data. - `PaymentSettlement`: The payment settlement event data. - `PaymentTransaction`: The payment transaction event data. - `PaymentAddressUpdate`: The top-up address update event data. - `PaymentPayout`: The payment payout event data. - `PaymentBulkSend`: The payment bulk send event data. - `BalanceUpdateInfo`: The balance update event data. - `SuspendedToken`: The token suspension event data. - `ComplianceDisposition`: The compliance disposition event data. - `ComplianceKytScreenings`: The compliance KYT screenings event data. - `ComplianceKyaScreenings`: The compliance KYA screenings event data. | **settlement_request_id** | **str** | The settlement request ID generated by Cobo. | **request_id** | **str** | The request ID provided by you when creating the settlement request. | **status** | [**SettleRequestStatus**](SettleRequestStatus.md) | | diff --git a/docs/PaymentTransactionEventData.md b/docs/PaymentTransactionEventData.md index c88eb9a3..36a35526 100644 --- a/docs/PaymentTransactionEventData.md +++ b/docs/PaymentTransactionEventData.md @@ -5,7 +5,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**data_type** | **str** | The data type of the event. - `Transaction`: The transaction event data. - `TSSRequest`: The TSS request event data. - `Addresses`: The addresses event data. - `WalletInfo`: The wallet information event data. - `MPCVault`: The MPC vault event data. - `Chains`: The enabled chain event data. - `Tokens`: The enabled token event data. - `TokenListing`: The token listing event data. - `PaymentOrder`: The payment order event data. - `PaymentRefund`: The payment refund event data. - `PaymentSettlement`: The payment settlement event data. - `PaymentTransaction`: The payment transaction event data. - `PaymentAddressUpdate`: The top-up address update event data. - `PaymentPayout`: The payment payout event data. - `BalanceUpdateInfo`: The balance update event data. - `SuspendedToken`: The token suspension event data. - `ComplianceDisposition`: The compliance disposition event data. - `ComplianceKytScreenings`: The compliance KYT screenings event data. - `ComplianceKyaScreenings`: The compliance KYA screenings event data. | +**data_type** | **str** | The data type of the event. - `Transaction`: The transaction event data. - `TSSRequest`: The TSS request event data. - `Addresses`: The addresses event data. - `WalletInfo`: The wallet information event data. - `MPCVault`: The MPC vault event data. - `Chains`: The enabled chain event data. - `Tokens`: The enabled token event data. - `TokenListing`: The token listing event data. - `PaymentOrder`: The payment order event data. - `PaymentRefund`: The payment refund event data. - `PaymentSettlement`: The payment settlement event data. - `PaymentTransaction`: The payment transaction event data. - `PaymentAddressUpdate`: The top-up address update event data. - `PaymentPayout`: The payment payout event data. - `PaymentBulkSend`: The payment bulk send event data. - `BalanceUpdateInfo`: The balance update event data. - `SuspendedToken`: The token suspension event data. - `ComplianceDisposition`: The compliance disposition event data. - `ComplianceKytScreenings`: The compliance KYT screenings event data. - `ComplianceKyaScreenings`: The compliance KYA screenings event data. | **transaction_id** | **str** | The transaction ID. | **cobo_id** | **str** | The Cobo ID, which can be used to track a transaction. | [optional] **request_id** | **str** | The request ID that is used to track a transaction request. The request ID is provided by you and must be unique within your organization. | [optional] diff --git a/docs/PayoutChannel.md b/docs/PayoutChannel.md index c1849151..bf61d1ae 100644 --- a/docs/PayoutChannel.md +++ b/docs/PayoutChannel.md @@ -1,6 +1,6 @@ # PayoutChannel -The channel through which payouts will be processed. Available options: - `Crypto`: Direct withdrawal to a crypto address. - `OffRamp`: Settle to a registered bank account. +The channel through which the payout will be processed. Possible values include: - `Crypto`: The payout will be processed as a cryptocurrency transfer to a crypto address. - `OffRamp`: The payout will be processed as a fiat currency transfer to a registered bank account. ## Properties diff --git a/docs/SuspendedTokenEventData.md b/docs/SuspendedTokenEventData.md index 88327ff6..3589e42a 100644 --- a/docs/SuspendedTokenEventData.md +++ b/docs/SuspendedTokenEventData.md @@ -5,7 +5,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**data_type** | **str** | The data type of the event. - `Transaction`: The transaction event data. - `TSSRequest`: The TSS request event data. - `Addresses`: The addresses event data. - `WalletInfo`: The wallet information event data. - `MPCVault`: The MPC vault event data. - `Chains`: The enabled chain event data. - `Tokens`: The enabled token event data. - `TokenListing`: The token listing event data. - `PaymentOrder`: The payment order event data. - `PaymentRefund`: The payment refund event data. - `PaymentSettlement`: The payment settlement event data. - `PaymentTransaction`: The payment transaction event data. - `PaymentAddressUpdate`: The top-up address update event data. - `PaymentPayout`: The payment payout event data. - `BalanceUpdateInfo`: The balance update event data. - `SuspendedToken`: The token suspension event data. - `ComplianceDisposition`: The compliance disposition event data. - `ComplianceKytScreenings`: The compliance KYT screenings event data. - `ComplianceKyaScreenings`: The compliance KYA screenings event data. | +**data_type** | **str** | The data type of the event. - `Transaction`: The transaction event data. - `TSSRequest`: The TSS request event data. - `Addresses`: The addresses event data. - `WalletInfo`: The wallet information event data. - `MPCVault`: The MPC vault event data. - `Chains`: The enabled chain event data. - `Tokens`: The enabled token event data. - `TokenListing`: The token listing event data. - `PaymentOrder`: The payment order event data. - `PaymentRefund`: The payment refund event data. - `PaymentSettlement`: The payment settlement event data. - `PaymentTransaction`: The payment transaction event data. - `PaymentAddressUpdate`: The top-up address update event data. - `PaymentPayout`: The payment payout event data. - `PaymentBulkSend`: The payment bulk send event data. - `BalanceUpdateInfo`: The balance update event data. - `SuspendedToken`: The token suspension event data. - `ComplianceDisposition`: The compliance disposition event data. - `ComplianceKytScreenings`: The compliance KYT screenings event data. - `ComplianceKyaScreenings`: The compliance KYA screenings event data. | **token_ids** | **str** | A list of token IDs, separated by comma. | **operation_type** | [**SuspendedTokenOperationType**](SuspendedTokenOperationType.md) | | diff --git a/docs/SwapsApi.md b/docs/SwapsApi.md index 3599437b..32273bfa 100644 --- a/docs/SwapsApi.md +++ b/docs/SwapsApi.md @@ -309,7 +309,7 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **list_swap_activities** -> ListSwapActivities200Response list_swap_activities(type=type, status=status, min_updated_timestamp=min_updated_timestamp, max_updated_timestamp=max_updated_timestamp, initiator=initiator, limit=limit, before=before, after=after, sort_by=sort_by, direction=direction) +> ListSwapActivities200Response list_swap_activities(request_id=request_id, type=type, status=status, min_updated_timestamp=min_updated_timestamp, max_updated_timestamp=max_updated_timestamp, initiator=initiator, limit=limit, before=before, after=after, sort_by=sort_by, direction=direction) List swap activities @@ -338,6 +338,7 @@ configuration = cobo_waas2.Configuration( with cobo_waas2.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = cobo_waas2.SwapsApi(api_client) + request_id = 'web_send_by_user_327_1610444045047' type = cobo_waas2.SwapType() status = cobo_waas2.SwapActivityStatus() min_updated_timestamp = 1635744000000 @@ -351,7 +352,7 @@ with cobo_waas2.ApiClient(configuration) as api_client: try: # List swap activities - api_response = api_instance.list_swap_activities(type=type, status=status, min_updated_timestamp=min_updated_timestamp, max_updated_timestamp=max_updated_timestamp, initiator=initiator, limit=limit, before=before, after=after, sort_by=sort_by, direction=direction) + api_response = api_instance.list_swap_activities(request_id=request_id, type=type, status=status, min_updated_timestamp=min_updated_timestamp, max_updated_timestamp=max_updated_timestamp, initiator=initiator, limit=limit, before=before, after=after, sort_by=sort_by, direction=direction) print("The response of SwapsApi->list_swap_activities:\n") pprint(api_response) except Exception as e: @@ -365,6 +366,7 @@ with cobo_waas2.ApiClient(configuration) as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- + **request_id** | **str**| The request ID that is used to track a transaction request. The request ID is provided by you and must be unique within your organization. | [optional] **type** | [**SwapType**](.md)| | [optional] **status** | [**SwapActivityStatus**](.md)| | [optional] **min_updated_timestamp** | **int**| The start time of the query. All swap activities updated after the specified time will be retrieved. The time is in Unix timestamp format, measured in milliseconds. | [optional] diff --git a/docs/TSSRequestWebhookEventData.md b/docs/TSSRequestWebhookEventData.md index b4060df1..ba56ce83 100644 --- a/docs/TSSRequestWebhookEventData.md +++ b/docs/TSSRequestWebhookEventData.md @@ -5,7 +5,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**data_type** | **str** | The data type of the event. - `Transaction`: The transaction event data. - `TSSRequest`: The TSS request event data. - `Addresses`: The addresses event data. - `WalletInfo`: The wallet information event data. - `MPCVault`: The MPC vault event data. - `Chains`: The enabled chain event data. - `Tokens`: The enabled token event data. - `TokenListing`: The token listing event data. - `PaymentOrder`: The payment order event data. - `PaymentRefund`: The payment refund event data. - `PaymentSettlement`: The payment settlement event data. - `PaymentTransaction`: The payment transaction event data. - `PaymentAddressUpdate`: The top-up address update event data. - `PaymentPayout`: The payment payout event data. - `BalanceUpdateInfo`: The balance update event data. - `SuspendedToken`: The token suspension event data. - `ComplianceDisposition`: The compliance disposition event data. - `ComplianceKytScreenings`: The compliance KYT screenings event data. - `ComplianceKyaScreenings`: The compliance KYA screenings event data. | +**data_type** | **str** | The data type of the event. - `Transaction`: The transaction event data. - `TSSRequest`: The TSS request event data. - `Addresses`: The addresses event data. - `WalletInfo`: The wallet information event data. - `MPCVault`: The MPC vault event data. - `Chains`: The enabled chain event data. - `Tokens`: The enabled token event data. - `TokenListing`: The token listing event data. - `PaymentOrder`: The payment order event data. - `PaymentRefund`: The payment refund event data. - `PaymentSettlement`: The payment settlement event data. - `PaymentTransaction`: The payment transaction event data. - `PaymentAddressUpdate`: The top-up address update event data. - `PaymentPayout`: The payment payout event data. - `PaymentBulkSend`: The payment bulk send event data. - `BalanceUpdateInfo`: The balance update event data. - `SuspendedToken`: The token suspension event data. - `ComplianceDisposition`: The compliance disposition event data. - `ComplianceKytScreenings`: The compliance KYT screenings event data. - `ComplianceKyaScreenings`: The compliance KYA screenings event data. | **tss_request_id** | **str** | The TSS request ID. | [optional] **source_key_share_holder_group** | [**SourceGroup**](SourceGroup.md) | | [optional] **target_key_share_holder_group_id** | **str** | The target key share holder group ID. | [optional] diff --git a/docs/TokenListingEventData.md b/docs/TokenListingEventData.md index b0902a6a..841d4475 100644 --- a/docs/TokenListingEventData.md +++ b/docs/TokenListingEventData.md @@ -5,7 +5,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**data_type** | **str** | The data type of the event. - `Transaction`: The transaction event data. - `TSSRequest`: The TSS request event data. - `Addresses`: The addresses event data. - `WalletInfo`: The wallet information event data. - `MPCVault`: The MPC vault event data. - `Chains`: The enabled chain event data. - `Tokens`: The enabled token event data. - `TokenListing`: The token listing event data. - `PaymentOrder`: The payment order event data. - `PaymentRefund`: The payment refund event data. - `PaymentSettlement`: The payment settlement event data. - `PaymentTransaction`: The payment transaction event data. - `PaymentAddressUpdate`: The top-up address update event data. - `PaymentPayout`: The payment payout event data. - `BalanceUpdateInfo`: The balance update event data. - `SuspendedToken`: The token suspension event data. - `ComplianceDisposition`: The compliance disposition event data. - `ComplianceKytScreenings`: The compliance KYT screenings event data. - `ComplianceKyaScreenings`: The compliance KYA screenings event data. | +**data_type** | **str** | The data type of the event. - `Transaction`: The transaction event data. - `TSSRequest`: The TSS request event data. - `Addresses`: The addresses event data. - `WalletInfo`: The wallet information event data. - `MPCVault`: The MPC vault event data. - `Chains`: The enabled chain event data. - `Tokens`: The enabled token event data. - `TokenListing`: The token listing event data. - `PaymentOrder`: The payment order event data. - `PaymentRefund`: The payment refund event data. - `PaymentSettlement`: The payment settlement event data. - `PaymentTransaction`: The payment transaction event data. - `PaymentAddressUpdate`: The top-up address update event data. - `PaymentPayout`: The payment payout event data. - `PaymentBulkSend`: The payment bulk send event data. - `BalanceUpdateInfo`: The balance update event data. - `SuspendedToken`: The token suspension event data. - `ComplianceDisposition`: The compliance disposition event data. - `ComplianceKytScreenings`: The compliance KYT screenings event data. - `ComplianceKyaScreenings`: The compliance KYA screenings event data. | **request_id** | **str** | The unique identifier of the token listing request. | **chain_id** | **str** | The ID of the blockchain where the token is deployed. | **contract_address** | **str** | The token's contract address on the specified blockchain. | diff --git a/docs/TokensEventData.md b/docs/TokensEventData.md index 58087020..c94dc805 100644 --- a/docs/TokensEventData.md +++ b/docs/TokensEventData.md @@ -5,7 +5,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**data_type** | **str** | The data type of the event. - `Transaction`: The transaction event data. - `TSSRequest`: The TSS request event data. - `Addresses`: The addresses event data. - `WalletInfo`: The wallet information event data. - `MPCVault`: The MPC vault event data. - `Chains`: The enabled chain event data. - `Tokens`: The enabled token event data. - `TokenListing`: The token listing event data. - `PaymentOrder`: The payment order event data. - `PaymentRefund`: The payment refund event data. - `PaymentSettlement`: The payment settlement event data. - `PaymentTransaction`: The payment transaction event data. - `PaymentAddressUpdate`: The top-up address update event data. - `PaymentPayout`: The payment payout event data. - `BalanceUpdateInfo`: The balance update event data. - `SuspendedToken`: The token suspension event data. - `ComplianceDisposition`: The compliance disposition event data. - `ComplianceKytScreenings`: The compliance KYT screenings event data. - `ComplianceKyaScreenings`: The compliance KYA screenings event data. | +**data_type** | **str** | The data type of the event. - `Transaction`: The transaction event data. - `TSSRequest`: The TSS request event data. - `Addresses`: The addresses event data. - `WalletInfo`: The wallet information event data. - `MPCVault`: The MPC vault event data. - `Chains`: The enabled chain event data. - `Tokens`: The enabled token event data. - `TokenListing`: The token listing event data. - `PaymentOrder`: The payment order event data. - `PaymentRefund`: The payment refund event data. - `PaymentSettlement`: The payment settlement event data. - `PaymentTransaction`: The payment transaction event data. - `PaymentAddressUpdate`: The top-up address update event data. - `PaymentPayout`: The payment payout event data. - `PaymentBulkSend`: The payment bulk send event data. - `BalanceUpdateInfo`: The balance update event data. - `SuspendedToken`: The token suspension event data. - `ComplianceDisposition`: The compliance disposition event data. - `ComplianceKytScreenings`: The compliance KYT screenings event data. - `ComplianceKyaScreenings`: The compliance KYA screenings event data. | **tokens** | [**List[TokenInfo]**](TokenInfo.md) | The enabled tokens. | **wallet_type** | [**WalletType**](WalletType.md) | | [optional] **wallet_subtypes** | [**List[WalletSubtype]**](WalletSubtype.md) | | [optional] diff --git a/docs/TransactionCoboCategory.md b/docs/TransactionCoboCategory.md index 252a1264..bd3ba72c 100644 --- a/docs/TransactionCoboCategory.md +++ b/docs/TransactionCoboCategory.md @@ -1,6 +1,6 @@ # TransactionCoboCategory -The transaction category defined by Cobo. Possible values include: - `AutoSweep`: An auto-sweep transaction. - `AutoFueling`: A transaction where Fee Station pays transaction fees to an address within your MPC Wallets. - `AutoFuelingRefund`: A refund for an auto-fueling transaction. - `SafeTxMessage`: A message signing transaction initiated by an MPC wallet to authorize a Smart Contract Wallet (Safe\\{Wallet\\}) transaction. - `BillPayment`: A transaction to pay Cobo bills through Fee Station. - `BillRefund`: A refund for a previously made bill payment. - `CommissionFeeCharge`: A transaction for commission-fee users that charges the commission fee incurred from various services. - `CommissionFeeRefund`: A refund of previously charged commission fees. - `StakingBabylonBtcDelegation`: A transaction for delegating BTC in Babylon staking. - `StakingBabylonBtcSignBabylon`: A transaction for signing Babylon operations with BTC. - `StakingBabylonClaim`: A transaction for claiming rewards from Babylon staking. - `StakingBabylonSlashing`: A transaction related to slashing penalties in Babylon staking. - `StakingBabylonStake`: A transaction for staking assets in the Babylon platform. - `StakingBabylonUnstake`: A transaction for unstaking assets from the Babylon platform. - `StakingBabylonWithdraw`: A transaction for withdrawing assets from Babylon staking. - `StakingBithiveClaim`: A transaction for claiming rewards from BitHive staking. - `StakingBithiveStake`: A transaction for staking assets in the BitHive platform. - `StakingBithiveUnstake`: A transaction for unstaking assets from the BitHive platform. - `StakingBithiveWithdraw`: A transaction for withdrawing assets from BitHive staking. - `StakingCoreStake`: A transaction for staking assets in the Core staking platform. - `StakingCoreWithdraw`: A transaction for withdrawing assets from Core staking. - `StakingEthClaim`: A transaction for claiming rewards from ETH staking. - `StakingEthStake`: A transaction for staking ETH assets. - `StakingEthUnstake`: A transaction for unstaking ETH assets. - `StakingSkyfarmClaim`: A transaction for claiming rewards from Skyfarm staking. - `StakingSkyfarmStake`: A transaction for staking assets in the Skyfarm platform. - `StakingSkyfarmUnstake`: A transaction for unstaking assets from the Skyfarm platform. - `ScreenAppRefund`: A refund transaction initiated through the Screening App. - `ScreenAppIsolate`: An isolation transaction initiated through the Screening App. - `ComplianceRefund`: A refund transaction initiated by Cobo KYT. - `ComplianceIsolate`: An isolation transaction initiated by Cobo KYT. - `StellarChangeTrust`: A transaction for establishing a trustline on the Stellar network. - `Tokenization`: A transaction for managing tokenized assets, such as minting or wrapping tokens. - `TokenizationGasSponsor`: A transaction where gas fees are sponsored for tokenization-related operations, ensuring the transaction proceeds even if the source address lacks sufficient balance. - `TokenSwap`: A transaction for token swapping or cross-chain bridging. - `NonceAccountSign`: A transaction signed using a **Solana nonce account**, enabling deterministic and replay-safe transaction execution on the Solana network. - `FeePayerSign`: A transaction where a **designated Solana fee payer account** covers the transaction fees, separating the fee payment from the main signer or source account. - `GasFeeSponsor`: A transaction where Fee Station pays the on-chain gas fee in USD stablecoin. - `GasFeeSponsorRefund`: A transaction that refunds gas fees previously sponsored and paid by Fee Station. +The transaction category defined by Cobo. Possible values include: - `AutoSweep`: An auto-sweep transaction. - `AutoFueling`: A transaction where Fee Station pays transaction fees to an address within your MPC Wallets. - `AutoFuelingRefund`: A refund for an auto-fueling transaction. - `SafeTxMessage`: A message signing transaction initiated by an MPC wallet to authorize a Smart Contract Wallet (Safe\\{Wallet\\}) transaction. - `BillPayment`: A transaction to pay Cobo bills through Fee Station. - `BillRefund`: A refund for a previously made bill payment. - `CommissionFeeCharge`: A transaction for commission-fee users that charges the commission fee incurred from various services. - `CommissionFeeRefund`: A refund of previously charged commission fees. - `StakingBabylonBtcDelegation`: A transaction for delegating BTC in Babylon staking. - `StakingBabylonBtcSignBabylon`: A transaction for signing Babylon operations with BTC. - `StakingBabylonClaim`: A transaction for claiming rewards from Babylon staking. - `StakingBabylonSlashing`: A transaction related to slashing penalties in Babylon staking. - `StakingBabylonStake`: A transaction for staking assets in the Babylon platform. - `StakingBabylonUnstake`: A transaction for unstaking assets from the Babylon platform. - `StakingBabylonWithdraw`: A transaction for withdrawing assets from Babylon staking. - `StakingBithiveClaim`: A transaction for claiming rewards from Bithive staking. - `StakingBithiveStake`: A transaction for staking assets in the Bithive platform. - `StakingBithiveUnstake`: A transaction for unstaking assets from the Bithive platform. - `StakingBithiveWithdraw`: A transaction for withdrawing assets from Bithive staking. - `StakingCoreStake`: A transaction for staking assets in the Core staking platform. - `StakingCoreWithdraw`: A transaction for withdrawing assets from Core staking. - `StakingEthClaim`: A transaction for claiming rewards from ETH staking. - `StakingEthStake`: A transaction for staking ETH assets. - `StakingEthUnstake`: A transaction for unstaking ETH assets. - `StakingSkyfarmClaim`: A transaction for claiming rewards from Skyfarm staking. - `StakingSkyfarmStake`: A transaction for staking assets in the Skyfarm platform. - `StakingSkyfarmUnstake`: A transaction for unstaking assets from the Skyfarm platform. - `StellarChangeTrust`: A transaction for establishing a trustline on the Stellar network.. - `Tokenization`: A transaction for managing tokenized assets, such as minting or wrapping tokens. - `TokenizationGasSponsor`: A transaction where gas fees are sponsored for tokenization-related operations, ensuring the transaction proceeds even if the source address lacks sufficient balance. - `TokenSwap`: A transaction for token swapping or cross-chain bridging. - `NonceAccountSign`: A transaction signed using a **Solana nonce account**, enabling deterministic and replay-safe transaction execution on the Solana network. - `FeePayerSign`: A transaction where a **designated Solana fee payer account** covers the transaction fees, separating the fee payment from the main signer or source account. - `GasFeeSponsor`: A transaction where Fee Station pays the on-chain gas fee in USD stablecoin. - `GasFeeSponsorRefund`: A transaction that refunds gas fees previously sponsored and paid by Fee Station. - `WalletConnect`: A transaction initiated by walletconnect. ## Properties diff --git a/docs/TransactionExtraType.md b/docs/TransactionExtraType.md index b69957a4..9f70b921 100644 --- a/docs/TransactionExtraType.md +++ b/docs/TransactionExtraType.md @@ -1,6 +1,6 @@ # TransactionExtraType -The transaction extra information type. Possible values include: - `BabylonBusinessInfo`: The extra information related to Babylon business logic. - `BabylonTxParameters`: The extra information for Babylon transaction parameters. - `CoreStakeInfo`: The extra information related to core staking operations. +The transaction extra information type. Possible values include: - `BabylonBusinessInfo`: The extra information of Babylon business. - `BabylonTxParameters`: The extra information of Babylon transaction parameters. - `CoreStakeInfo`: The extra information of core stake. - `WalletConnectInfo`: The extra information of transaction initiated by walletconnect. ## Properties diff --git a/docs/TransactionWalletConnectInfo.md b/docs/TransactionWalletConnectInfo.md new file mode 100644 index 00000000..f6d1e53f --- /dev/null +++ b/docs/TransactionWalletConnectInfo.md @@ -0,0 +1,33 @@ +# TransactionWalletConnectInfo + +The extra information of transaction initiated by walletconnect. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**extra_type** | [**TransactionExtraType**](TransactionExtraType.md) | | +**dapp_name** | **str** | The dapp name that initiated this transaction. | [optional] +**dapp_domain** | **str** | The dapp domain that initiated this transaction | [optional] +**session_id** | **str** | The session id that initiated this transaction | [optional] + +## Example + +```python +from cobo_waas2.models.transaction_wallet_connect_info import TransactionWalletConnectInfo + +# TODO update the JSON string below +json = "{}" +# create an instance of TransactionWalletConnectInfo from a JSON string +transaction_wallet_connect_info_instance = TransactionWalletConnectInfo.from_json(json) +# print the JSON string representation of the object +print(TransactionWalletConnectInfo.to_json()) + +# convert the object into a dict +transaction_wallet_connect_info_dict = transaction_wallet_connect_info_instance.to_dict() +# create an instance of TransactionWalletConnectInfo from a dict +transaction_wallet_connect_info_from_dict = TransactionWalletConnectInfo.from_dict(transaction_wallet_connect_info_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/TransactionWebhookEventData.md b/docs/TransactionWebhookEventData.md index 2eb68bc2..bd739560 100644 --- a/docs/TransactionWebhookEventData.md +++ b/docs/TransactionWebhookEventData.md @@ -5,7 +5,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**data_type** | **str** | The data type of the event. - `Transaction`: The transaction event data. - `TSSRequest`: The TSS request event data. - `Addresses`: The addresses event data. - `WalletInfo`: The wallet information event data. - `MPCVault`: The MPC vault event data. - `Chains`: The enabled chain event data. - `Tokens`: The enabled token event data. - `TokenListing`: The token listing event data. - `PaymentOrder`: The payment order event data. - `PaymentRefund`: The payment refund event data. - `PaymentSettlement`: The payment settlement event data. - `PaymentTransaction`: The payment transaction event data. - `PaymentAddressUpdate`: The top-up address update event data. - `PaymentPayout`: The payment payout event data. - `BalanceUpdateInfo`: The balance update event data. - `SuspendedToken`: The token suspension event data. - `ComplianceDisposition`: The compliance disposition event data. - `ComplianceKytScreenings`: The compliance KYT screenings event data. - `ComplianceKyaScreenings`: The compliance KYA screenings event data. | +**data_type** | **str** | The data type of the event. - `Transaction`: The transaction event data. - `TSSRequest`: The TSS request event data. - `Addresses`: The addresses event data. - `WalletInfo`: The wallet information event data. - `MPCVault`: The MPC vault event data. - `Chains`: The enabled chain event data. - `Tokens`: The enabled token event data. - `TokenListing`: The token listing event data. - `PaymentOrder`: The payment order event data. - `PaymentRefund`: The payment refund event data. - `PaymentSettlement`: The payment settlement event data. - `PaymentTransaction`: The payment transaction event data. - `PaymentAddressUpdate`: The top-up address update event data. - `PaymentPayout`: The payment payout event data. - `PaymentBulkSend`: The payment bulk send event data. - `BalanceUpdateInfo`: The balance update event data. - `SuspendedToken`: The token suspension event data. - `ComplianceDisposition`: The compliance disposition event data. - `ComplianceKytScreenings`: The compliance KYT screenings event data. - `ComplianceKyaScreenings`: The compliance KYA screenings event data. | **transaction_id** | **str** | The transaction ID. | **cobo_id** | **str** | The Cobo ID, which can be used to track a transaction. | [optional] **request_id** | **str** | The request ID that is used to track a transaction request. The request ID is provided by you and must be unique within your organization. | [optional] diff --git a/docs/WalletInfoEventData.md b/docs/WalletInfoEventData.md index 97bf3283..45293c9b 100644 --- a/docs/WalletInfoEventData.md +++ b/docs/WalletInfoEventData.md @@ -5,7 +5,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**data_type** | **str** | The data type of the event. - `Transaction`: The transaction event data. - `TSSRequest`: The TSS request event data. - `Addresses`: The addresses event data. - `WalletInfo`: The wallet information event data. - `MPCVault`: The MPC vault event data. - `Chains`: The enabled chain event data. - `Tokens`: The enabled token event data. - `TokenListing`: The token listing event data. - `PaymentOrder`: The payment order event data. - `PaymentRefund`: The payment refund event data. - `PaymentSettlement`: The payment settlement event data. - `PaymentTransaction`: The payment transaction event data. - `PaymentAddressUpdate`: The top-up address update event data. - `PaymentPayout`: The payment payout event data. - `BalanceUpdateInfo`: The balance update event data. - `SuspendedToken`: The token suspension event data. - `ComplianceDisposition`: The compliance disposition event data. - `ComplianceKytScreenings`: The compliance KYT screenings event data. - `ComplianceKyaScreenings`: The compliance KYA screenings event data. | +**data_type** | **str** | The data type of the event. - `Transaction`: The transaction event data. - `TSSRequest`: The TSS request event data. - `Addresses`: The addresses event data. - `WalletInfo`: The wallet information event data. - `MPCVault`: The MPC vault event data. - `Chains`: The enabled chain event data. - `Tokens`: The enabled token event data. - `TokenListing`: The token listing event data. - `PaymentOrder`: The payment order event data. - `PaymentRefund`: The payment refund event data. - `PaymentSettlement`: The payment settlement event data. - `PaymentTransaction`: The payment transaction event data. - `PaymentAddressUpdate`: The top-up address update event data. - `PaymentPayout`: The payment payout event data. - `PaymentBulkSend`: The payment bulk send event data. - `BalanceUpdateInfo`: The balance update event data. - `SuspendedToken`: The token suspension event data. - `ComplianceDisposition`: The compliance disposition event data. - `ComplianceKytScreenings`: The compliance KYT screenings event data. - `ComplianceKyaScreenings`: The compliance KYA screenings event data. | **wallet** | [**WalletInfo**](WalletInfo.md) | | [optional] ## Example diff --git a/docs/WalletsApi.md b/docs/WalletsApi.md index acdc3896..84a462e6 100644 --- a/docs/WalletsApi.md +++ b/docs/WalletsApi.md @@ -1281,7 +1281,7 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **wallet_type** | [**WalletType**](.md)| The wallet type. - `Custodial`: [Custodial Wallets](https://manuals.cobo.com/en/portal/custodial-wallets/introduction) - `MPC`: [MPC Wallets](https://manuals.cobo.com/en/portal/mpc-wallets/introduction) - `SmartContract`: [Smart Contract Wallets](https://manuals.cobo.com/en/portal/smart-contract-wallets/introduction) - `Exchange`: [Exchange Wallets](https://manuals.cobo.com/en/portal/exchange-wallets/introduction) | [optional] **wallet_subtype** | [**WalletSubtype**](.md)| The wallet subtype. - `Asset`: Custodial Wallets (Asset Wallets) - `Web3`: Custodial Wallets (Web3 Wallets) - `Main`: Exchange Wallets (Main Account) - `Sub`: Exchange Wallets (Sub Account) - `Org-Controlled`: MPC Wallets (Organization-Controlled Wallets) - `User-Controlled`: MPC Wallets (User-Controlled Wallets) - `Safe{Wallet}`: Smart Contract Wallets (Safe{Wallet}) | [optional] - **limit** | **int**| The maximum number of objects to return. For most operations, the value range is [1, 50]. | [optional] [default to 10] + **limit** | **int**| The maximum number of objects to return. The value range is [1, 500]. | [optional] [default to 10] **before** | **str**| A cursor indicating the position before the current page. This value is generated by Cobo and returned in the response. If you are paginating forward from the beginning, you do not need to provide it on the first request. When paginating backward (to the previous page), you should pass the before value returned from the last response. | [optional] **after** | **str**| A cursor indicating the position after the current page. This value is generated by Cobo and returned in the response. You do not need to provide it on the first request. When paginating forward (to the next page), you should pass the after value returned from the last response. | [optional] @@ -1364,9 +1364,9 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **wallet_type** | [**WalletType**](.md)| The wallet type. - `Custodial`: [Custodial Wallets](https://manuals.cobo.com/en/portal/custodial-wallets/introduction) - `MPC`: [MPC Wallets](https://manuals.cobo.com/en/portal/mpc-wallets/introduction) - `SmartContract`: [Smart Contract Wallets](https://manuals.cobo.com/en/portal/smart-contract-wallets/introduction) - `Exchange`: [Exchange Wallets](https://manuals.cobo.com/en/portal/exchange-wallets/introduction) | [optional] **wallet_subtype** | [**WalletSubtype**](.md)| The wallet subtype. - `Asset`: Custodial Wallets (Asset Wallets) - `Web3`: Custodial Wallets (Web3 Wallets) - `Main`: Exchange Wallets (Main Account) - `Sub`: Exchange Wallets (Sub Account) - `Org-Controlled`: MPC Wallets (Organization-Controlled Wallets) - `User-Controlled`: MPC Wallets (User-Controlled Wallets) - `Safe{Wallet}`: Smart Contract Wallets (Safe{Wallet}) | [optional] - **chain_ids** | **str**| A list of chain IDs, separated by comma. The chain ID is the unique identifier of a blockchain. You can retrieve the IDs of all the chains you can use by calling [List enabled chains](https://www.cobo.com/developers/v2/api-references/wallets/list-enabled-chains). | [optional] - **token_ids** | **str**| A list of token IDs, separated by comma. The token ID is the unique identifier of a token. You can retrieve the IDs of all the tokens you can use by calling [List enabled tokens](https://www.cobo.com/developers/v2/api-references/wallets/list-enabled-tokens). | [optional] - **limit** | **int**| The maximum number of objects to return. For most operations, the value range is [1, 50]. | [optional] [default to 10] + **chain_ids** | **str**| A list of chain IDs(Supports up to 500), separated by comma. The chain ID is the unique identifier of a blockchain. You can retrieve the IDs of all the chains you can use by calling [List enabled chains](https://www.cobo.com/developers/v2/api-references/wallets/list-enabled-chains). | [optional] + **token_ids** | **str**| A list of token IDs(Supports up to 500), separated by comma. The token ID is the unique identifier of a token. You can retrieve the IDs of all the tokens you can use by calling [List enabled tokens](https://www.cobo.com/developers/v2/api-references/wallets/list-enabled-tokens). | [optional] + **limit** | **int**| The maximum number of objects to return. The value range is [1, 500]. | [optional] [default to 10] **before** | **str**| A cursor indicating the position before the current page. This value is generated by Cobo and returned in the response. If you are paginating forward from the beginning, you do not need to provide it on the first request. When paginating backward (to the previous page), you should pass the before value returned from the last response. | [optional] **after** | **str**| A cursor indicating the position after the current page. This value is generated by Cobo and returned in the response. You do not need to provide it on the first request. When paginating forward (to the next page), you should pass the after value returned from the last response. | [optional] @@ -1448,8 +1448,8 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **wallet_type** | [**WalletType**](.md)| The wallet type. - `Custodial`: [Custodial Wallets](https://manuals.cobo.com/en/portal/custodial-wallets/introduction) - `MPC`: [MPC Wallets](https://manuals.cobo.com/en/portal/mpc-wallets/introduction) - `SmartContract`: [Smart Contract Wallets](https://manuals.cobo.com/en/portal/smart-contract-wallets/introduction) - `Exchange`: [Exchange Wallets](https://manuals.cobo.com/en/portal/exchange-wallets/introduction) | [optional] **wallet_subtype** | [**WalletSubtype**](.md)| The wallet subtype. - `Asset`: Custodial Wallets (Asset Wallets) - `Web3`: Custodial Wallets (Web3 Wallets) - `Main`: Exchange Wallets (Main Account) - `Sub`: Exchange Wallets (Sub Account) - `Org-Controlled`: MPC Wallets (Organization-Controlled Wallets) - `User-Controlled`: MPC Wallets (User-Controlled Wallets) - `Safe{Wallet}`: Smart Contract Wallets (Safe{Wallet}) | [optional] - **chain_ids** | **str**| A list of chain IDs, separated by comma. The chain ID is the unique identifier of a blockchain. You can retrieve the IDs of all the chains you can use by calling [List enabled chains](https://www.cobo.com/developers/v2/api-references/wallets/list-enabled-chains). | [optional] - **limit** | **int**| The maximum number of objects to return. For most operations, the value range is [1, 50]. | [optional] [default to 10] + **chain_ids** | **str**| A list of chain IDs(Supports up to 500), separated by comma. The chain ID is the unique identifier of a blockchain. You can retrieve the IDs of all the chains you can use by calling [List enabled chains](https://www.cobo.com/developers/v2/api-references/wallets/list-enabled-chains). | [optional] + **limit** | **int**| The maximum number of objects to return. The value range is [1, 500]. | [optional] [default to 10] **before** | **str**| A cursor indicating the position before the current page. This value is generated by Cobo and returned in the response. If you are paginating forward from the beginning, you do not need to provide it on the first request. When paginating backward (to the previous page), you should pass the before value returned from the last response. | [optional] **after** | **str**| A cursor indicating the position after the current page. This value is generated by Cobo and returned in the response. You do not need to provide it on the first request. When paginating forward (to the next page), you should pass the after value returned from the last response. | [optional] @@ -1532,9 +1532,9 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **wallet_type** | [**WalletType**](.md)| The wallet type. - `Custodial`: [Custodial Wallets](https://manuals.cobo.com/en/portal/custodial-wallets/introduction) - `MPC`: [MPC Wallets](https://manuals.cobo.com/en/portal/mpc-wallets/introduction) - `SmartContract`: [Smart Contract Wallets](https://manuals.cobo.com/en/portal/smart-contract-wallets/introduction) - `Exchange`: [Exchange Wallets](https://manuals.cobo.com/en/portal/exchange-wallets/introduction) | [optional] **wallet_subtype** | [**WalletSubtype**](.md)| The wallet subtype. - `Asset`: Custodial Wallets (Asset Wallets) - `Web3`: Custodial Wallets (Web3 Wallets) - `Main`: Exchange Wallets (Main Account) - `Sub`: Exchange Wallets (Sub Account) - `Org-Controlled`: MPC Wallets (Organization-Controlled Wallets) - `User-Controlled`: MPC Wallets (User-Controlled Wallets) - `Safe{Wallet}`: Smart Contract Wallets (Safe{Wallet}) | [optional] - **chain_ids** | **str**| A list of chain IDs, separated by comma. The chain ID is the unique identifier of a blockchain. You can retrieve the IDs of all the chains you can use by calling [List enabled chains](https://www.cobo.com/developers/v2/api-references/wallets/list-enabled-chains). | [optional] - **token_ids** | **str**| A list of token IDs, separated by comma. The token ID is the unique identifier of a token. You can retrieve the IDs of all the tokens you can use by calling [List enabled tokens](https://www.cobo.com/developers/v2/api-references/wallets/list-enabled-tokens). | [optional] - **limit** | **int**| The maximum number of objects to return. For most operations, the value range is [1, 50]. | [optional] [default to 10] + **chain_ids** | **str**| A list of chain IDs(Supports up to 500), separated by comma. The chain ID is the unique identifier of a blockchain. You can retrieve the IDs of all the chains you can use by calling [List enabled chains](https://www.cobo.com/developers/v2/api-references/wallets/list-enabled-chains). | [optional] + **token_ids** | **str**| A list of token IDs(Supports up to 500), separated by comma. The token ID is the unique identifier of a token. You can retrieve the IDs of all the tokens you can use by calling [List enabled tokens](https://www.cobo.com/developers/v2/api-references/wallets/list-enabled-tokens). | [optional] + **limit** | **int**| The maximum number of objects to return. The value range is [1, 500]. | [optional] [default to 10] **before** | **str**| A cursor indicating the position before the current page. This value is generated by Cobo and returned in the response. If you are paginating forward from the beginning, you do not need to provide it on the first request. When paginating backward (to the previous page), you should pass the before value returned from the last response. | [optional] **after** | **str**| A cursor indicating the position after the current page. This value is generated by Cobo and returned in the response. You do not need to provide it on the first request. When paginating forward (to the next page), you should pass the after value returned from the last response. | [optional] diff --git a/docs/WebhookEventData.md b/docs/WebhookEventData.md index 6f70cfdf..63d7a6dd 100644 --- a/docs/WebhookEventData.md +++ b/docs/WebhookEventData.md @@ -5,7 +5,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**data_type** | **str** | The data type of the event. - `Transaction`: The transaction event data. - `TSSRequest`: The TSS request event data. - `Addresses`: The addresses event data. - `WalletInfo`: The wallet information event data. - `MPCVault`: The MPC vault event data. - `Chains`: The enabled chain event data. - `Tokens`: The enabled token event data. - `TokenListing`: The token listing event data. - `PaymentOrder`: The payment order event data. - `PaymentRefund`: The payment refund event data. - `PaymentSettlement`: The payment settlement event data. - `PaymentTransaction`: The payment transaction event data. - `PaymentAddressUpdate`: The top-up address update event data. - `PaymentPayout`: The payment payout event data. - `BalanceUpdateInfo`: The balance update event data. - `SuspendedToken`: The token suspension event data. - `ComplianceDisposition`: The compliance disposition event data. - `ComplianceKytScreenings`: The compliance KYT screenings event data. - `ComplianceKyaScreenings`: The compliance KYA screenings event data. | +**data_type** | **str** | The data type of the event. - `Transaction`: The transaction event data. - `TSSRequest`: The TSS request event data. - `Addresses`: The addresses event data. - `WalletInfo`: The wallet information event data. - `MPCVault`: The MPC vault event data. - `Chains`: The enabled chain event data. - `Tokens`: The enabled token event data. - `TokenListing`: The token listing event data. - `PaymentOrder`: The payment order event data. - `PaymentRefund`: The payment refund event data. - `PaymentSettlement`: The payment settlement event data. - `PaymentTransaction`: The payment transaction event data. - `PaymentAddressUpdate`: The top-up address update event data. - `PaymentPayout`: The payment payout event data. - `PaymentBulkSend`: The payment bulk send event data. - `BalanceUpdateInfo`: The balance update event data. - `SuspendedToken`: The token suspension event data. - `ComplianceDisposition`: The compliance disposition event data. - `ComplianceKytScreenings`: The compliance KYT screenings event data. - `ComplianceKyaScreenings`: The compliance KYA screenings event data. | **transaction_id** | **str** | The transaction ID. | **cobo_id** | **str** | The Cobo ID, which can be used to track a transaction. | [optional] **request_id** | **str** | The request ID provided by you when creating the payout. | @@ -21,7 +21,7 @@ Name | Type | Description | Notes **destination** | [**TransactionDestination**](TransactionDestination.md) | | **result** | [**TransactionResult**](TransactionResult.md) | | [optional] **fee** | [**TransactionFee**](TransactionFee.md) | | [optional] -**initiator** | **str** | The initiator of this payout, usually the API key used to create the payout. | [optional] +**initiator** | **str** | The initiator of this payout, usually the user's API key. | [optional] **initiator_type** | [**TransactionInitiatorType**](TransactionInitiatorType.md) | | **confirmed_num** | **int** | The number of confirmations this transaction has received. | [optional] **confirming_threshold** | **int** | The minimum number of confirmations required to deem a transaction secure. The common threshold is 6 for a Bitcoin transaction. | [optional] @@ -30,7 +30,7 @@ Name | Type | Description | Notes **raw_tx_info** | [**TransactionRawTxInfo**](TransactionRawTxInfo.md) | | [optional] **replacement** | [**TransactionReplacement**](TransactionReplacement.md) | | [optional] **category** | **List[str]** | A custom transaction category for you to identify your transfers more easily. | [optional] -**description** | **str** | The description for your transaction. | [optional] +**description** | **str** | The description for the entire bulk send batch. | [optional] **is_loop** | **bool** | Whether the transaction was executed as a [Cobo Loop](https://manuals.cobo.com/en/portal/custodial-wallets/cobo-loop) transfer. - `true`: The transaction was executed as a Cobo Loop transfer. - `false`: The transaction was not executed as a Cobo Loop transfer. | [optional] **cobo_category** | **List[str]** | The transaction category defined by Cobo. For more details, refer to [Cobo-defined categories](/v2/guides/transactions/manage-transactions#cobo-defined-categories). | [optional] **extra** | **List[str]** | A list of JSON-encoded strings containing structured, business-specific extra information for the transaction. Each item corresponds to a specific data type, indicated by the `extra_type` field in the JSON object (for example, \"BabylonBusinessInfo\", \"BtcAddressInfo\"). | [optional] @@ -73,8 +73,8 @@ Name | Type | Description | Notes **receive_address** | **str** | The recipient wallet address to be used for the payment transaction. | **received_token_amount** | **str** | The total cryptocurrency amount received for this order. Updates until the expiration time. Precision matches the token standard (e.g., 6 decimals for USDT). | **expired_at** | **int** | The expiration time of the pay-in order, represented as a UNIX timestamp in seconds. | [optional] -**transactions** | [**List[PaymentTransaction]**](PaymentTransaction.md) | An array of transactions associated with this refund order. Each transaction represents a separate blockchain operation related to the refund process. | [optional] -**currency** | **str** | The fiat currency you will receive from the payout. | [optional] +**transactions** | [**List[PaymentTransaction]**](PaymentTransaction.md) | An array of payout transactions. | [optional] +**currency** | **str** | The fiat currency for the off-ramp. | [optional] **order_amount** | **str** | This field has been deprecated. Please use `pricing_amount` instead. | [optional] **settlement_status** | [**SettleStatus**](SettleStatus.md) | | [optional] **refund_id** | **str** | The refund order ID. | @@ -88,7 +88,7 @@ Name | Type | Description | Notes **settlement_request_id** | **str** | The settlement request ID generated by Cobo. | **settlements** | [**List[SettlementDetail]**](SettlementDetail.md) | | **acquiring_type** | [**AcquiringType**](AcquiringType.md) | | -**payout_channel** | [**PayoutChannel**](PayoutChannel.md) | | [optional] +**payout_channel** | [**PayoutChannel**](PayoutChannel.md) | | **settlement_type** | [**SettlementType**](SettlementType.md) | | [optional] **received_amount_fiat** | **str** | The estimated amount of the fiat currency to receive after off-ramping. This amount is subject to change due to bank transfer fees. | [optional] **bank_account** | [**BankAccount**](BankAccount.md) | | [optional] @@ -98,8 +98,13 @@ Name | Type | Description | Notes **previous_address** | **str** | The previous top-up address that was assigned to the payer. | **updated_address** | **str** | The new top-up address that has been assigned to the payer. | **payout_id** | **str** | The payout ID generated by Cobo. | -**payout_item_details** | [**List[PaymentPayoutItemDetail]**](PaymentPayoutItemDetail.md) | | [optional] -**actual_payout_amount** | **str** | The total amount of cryptocurrency actually paid out for this payout. | [optional] +**source_account** | **str** | The source account from which the bulk send will be made. - If the source account is a merchant account, provide the merchant's ID (e.g., \"M1001\"). - If the source account is the developer account, use the string `\"developer\"`. | +**payout_items** | [**List[PaymentPayoutItem]**](PaymentPayoutItem.md) | required | [optional] +**recipient_info** | [**PaymentPayoutRecipientInfo**](PaymentPayoutRecipientInfo.md) | | [optional] +**actual_payout_amount** | **str** | - For `Crypto` payouts: The amount of cryptocurrency sent to the recipient's address, denominated in the token specified in `recipient_info.token_id`. - For `OffRamp` payouts: The amount of fiat currency sent to the recipient's bank account, denominated in the currency specified in `recipient_info.currency`. (Note: The actual amount received may be lower due to additional bank transfer fees.) | [optional] +**remark** | **str** | A note or comment about the payout. | [optional] +**bulk_send_id** | **str** | The bulk send ID. | +**execution_mode** | [**PaymentBulkSendExecutionMode**](PaymentBulkSendExecutionMode.md) | | **disposition_type** | [**DispositionType**](DispositionType.md) | | **disposition_status** | [**DispositionStatus**](DispositionStatus.md) | | **destination_address** | **str** | The blockchain address to receive the refunded/isolated funds. | [optional] diff --git a/docs/WebhookEventDataType.md b/docs/WebhookEventDataType.md index 6e1e55ba..922d6670 100644 --- a/docs/WebhookEventDataType.md +++ b/docs/WebhookEventDataType.md @@ -6,7 +6,7 @@ The data type of the event. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**data_type** | **str** | The data type of the event. - `Transaction`: The transaction event data. - `TSSRequest`: The TSS request event data. - `Addresses`: The addresses event data. - `WalletInfo`: The wallet information event data. - `MPCVault`: The MPC vault event data. - `Chains`: The enabled chain event data. - `Tokens`: The enabled token event data. - `TokenListing`: The token listing event data. - `PaymentOrder`: The payment order event data. - `PaymentRefund`: The payment refund event data. - `PaymentSettlement`: The payment settlement event data. - `PaymentTransaction`: The payment transaction event data. - `PaymentAddressUpdate`: The top-up address update event data. - `PaymentPayout`: The payment payout event data. - `BalanceUpdateInfo`: The balance update event data. - `SuspendedToken`: The token suspension event data. - `ComplianceDisposition`: The compliance disposition event data. - `ComplianceKytScreenings`: The compliance KYT screenings event data. - `ComplianceKyaScreenings`: The compliance KYA screenings event data. | +**data_type** | **str** | The data type of the event. - `Transaction`: The transaction event data. - `TSSRequest`: The TSS request event data. - `Addresses`: The addresses event data. - `WalletInfo`: The wallet information event data. - `MPCVault`: The MPC vault event data. - `Chains`: The enabled chain event data. - `Tokens`: The enabled token event data. - `TokenListing`: The token listing event data. - `PaymentOrder`: The payment order event data. - `PaymentRefund`: The payment refund event data. - `PaymentSettlement`: The payment settlement event data. - `PaymentTransaction`: The payment transaction event data. - `PaymentAddressUpdate`: The top-up address update event data. - `PaymentPayout`: The payment payout event data. - `PaymentBulkSend`: The payment bulk send event data. - `BalanceUpdateInfo`: The balance update event data. - `SuspendedToken`: The token suspension event data. - `ComplianceDisposition`: The compliance disposition event data. - `ComplianceKytScreenings`: The compliance KYT screenings event data. - `ComplianceKyaScreenings`: The compliance KYA screenings event data. | ## Example diff --git a/pyproject.toml b/pyproject.toml index edb83c53..287992e1 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,6 +1,6 @@ [tool.poetry] name = "cobo_waas2" -version = "1.29.0" +version = "1.30.0" description = "Cobo Wallet as a Service 2.0" authors = ["Cobo WaaS "] license = "Apache 2.0" diff --git a/setup.py b/setup.py index 0e0bca83..c7948264 100644 --- a/setup.py +++ b/setup.py @@ -19,7 +19,7 @@ # prerequisite: setuptools # http://pypi.python.org/pypi/setuptools NAME = "cobo-waas2" -VERSION = "1.29.0" +VERSION = "1.30.0" PYTHON_REQUIRES = ">=3.9" REQUIRES = [ "urllib3 >= 2.6.0", diff --git a/test/test_allocation_record.py b/test/test_allocation_item.py similarity index 64% rename from test/test_allocation_record.py rename to test/test_allocation_item.py index 01c1bd53..baf84c71 100644 --- a/test/test_allocation_record.py +++ b/test/test_allocation_item.py @@ -12,11 +12,11 @@ import unittest -from cobo_waas2.models.allocation_record import AllocationRecord +from cobo_waas2.models.allocation_item import AllocationItem -class TestAllocationRecord(unittest.TestCase): - """AllocationRecord unit test stubs""" +class TestAllocationItem(unittest.TestCase): + """AllocationItem unit test stubs""" def setUp(self): pass @@ -24,17 +24,17 @@ def setUp(self): def tearDown(self): pass - def make_instance(self, include_optional) -> AllocationRecord: - """Test AllocationRecord + def make_instance(self, include_optional) -> AllocationItem: + """Test AllocationItem include_option is a boolean, when False only required params are included, when True both required and optional params are included """ - # uncomment below to create an instance of `AllocationRecord` + # uncomment below to create an instance of `AllocationItem` """ - model = AllocationRecord() + model = AllocationItem() if include_optional: - return AllocationRecord( - allocation_record_id = '123e457-e89b-12d3-a456-426614174004', + return AllocationItem( + allocation_item_id = '123e457-e89b-12d3-a456-426614174004', batch_allocation_id = '123e457-e89b-12d3-a456-426614174004', token_id = 'ETH_USDT', amount = '500.00', @@ -43,8 +43,8 @@ def make_instance(self, include_optional) -> AllocationRecord: description = '' ) else: - return AllocationRecord( - allocation_record_id = '123e457-e89b-12d3-a456-426614174004', + return AllocationItem( + allocation_item_id = '123e457-e89b-12d3-a456-426614174004', batch_allocation_id = '123e457-e89b-12d3-a456-426614174004', token_id = 'ETH_USDT', amount = '500.00', @@ -52,8 +52,8 @@ def make_instance(self, include_optional) -> AllocationRecord: ) """ - def testAllocationRecord(self): - """Test AllocationRecord""" + def testAllocationItem(self): + """Test AllocationItem""" # inst_req_only = self.make_instance(include_optional=False) # inst_req_and_optional = self.make_instance(include_optional=True) diff --git a/test/test_allocation_request.py b/test/test_allocation_param.py similarity index 52% rename from test/test_allocation_request.py rename to test/test_allocation_param.py index 559aeef9..93effa56 100644 --- a/test/test_allocation_request.py +++ b/test/test_allocation_param.py @@ -12,11 +12,11 @@ import unittest -from cobo_waas2.models.allocation_request import AllocationRequest +from cobo_waas2.models.allocation_param import AllocationParam -class TestAllocationRequest(unittest.TestCase): - """AllocationRequest unit test stubs""" +class TestAllocationParam(unittest.TestCase): + """AllocationParam unit test stubs""" def setUp(self): pass @@ -24,34 +24,34 @@ def setUp(self): def tearDown(self): pass - def make_instance(self, include_optional) -> AllocationRequest: - """Test AllocationRequest + def make_instance(self, include_optional) -> AllocationParam: + """Test AllocationParam include_option is a boolean, when False only required params are included, when True both required and optional params are included """ - # uncomment below to create an instance of `AllocationRequest` + # uncomment below to create an instance of `AllocationParam` """ - model = AllocationRequest() + model = AllocationParam() if include_optional: - return AllocationRequest( + return AllocationParam( token_id = 'ETH_USDT', amount = '500.00', - source_account = 'M1001', - destination_account = 'M1001', - description = 'Allocation for merchant M1001' + source_account = '', + destination_account = '', + description = '' ) else: - return AllocationRequest( + return AllocationParam( token_id = 'ETH_USDT', amount = '500.00', - source_account = 'M1001', - destination_account = 'M1001', - description = 'Allocation for merchant M1001', + source_account = '', + destination_account = '', + description = '', ) """ - def testAllocationRequest(self): - """Test AllocationRequest""" + def testAllocationParam(self): + """Test AllocationParam""" # inst_req_only = self.make_instance(include_optional=False) # inst_req_and_optional = self.make_instance(include_optional=True) diff --git a/test/test_batch_allocation.py b/test/test_batch_allocation.py index 48507b89..8084165a 100644 --- a/test/test_batch_allocation.py +++ b/test/test_batch_allocation.py @@ -36,13 +36,13 @@ def make_instance(self, include_optional) -> BatchAllocation: return BatchAllocation( batch_allocation_id = '123e457-e89b-12d3-a456-426614174004', request_id = '123e457-e89b-12d3-a456-426614174004', - allocation_requests = [ - cobo_waas2.models.allocation_request.AllocationRequest( + allocation_params = [ + cobo_waas2.models.allocation_param.AllocationParam( token_id = 'ETH_USDT', amount = '500.00', - source_account = 'M1001', - destination_account = 'M1001', - description = 'Allocation for merchant M1001', ) + source_account = '', + destination_account = '', + description = '', ) ], initiator = 'b2ae1b5aaade686c968ef2bbd31cc75ba94e5a85fd9cb0b35b81dcc15f520e9d', created_timestamp = 1744689600, diff --git a/test/test_batch_allocation_detail.py b/test/test_batch_allocation_detail.py index 2dcbebc7..83c8e42f 100644 --- a/test/test_batch_allocation_detail.py +++ b/test/test_batch_allocation_detail.py @@ -36,9 +36,9 @@ def make_instance(self, include_optional) -> BatchAllocationDetail: return BatchAllocationDetail( batch_allocation_id = '123e457-e89b-12d3-a456-426614174004', request_id = '123e457-e89b-12d3-a456-426614174004', - allocation_records = [ - cobo_waas2.models.allocation_record.AllocationRecord( - allocation_record_id = '123e457-e89b-12d3-a456-426614174004', + allocation_items = [ + cobo_waas2.models.allocation_item.AllocationItem( + allocation_item_id = '123e457-e89b-12d3-a456-426614174004', batch_allocation_id = '123e457-e89b-12d3-a456-426614174004', token_id = 'ETH_USDT', amount = '500.00', @@ -54,16 +54,6 @@ def make_instance(self, include_optional) -> BatchAllocationDetail: return BatchAllocationDetail( batch_allocation_id = '123e457-e89b-12d3-a456-426614174004', request_id = '123e457-e89b-12d3-a456-426614174004', - allocation_records = [ - cobo_waas2.models.allocation_record.AllocationRecord( - allocation_record_id = '123e457-e89b-12d3-a456-426614174004', - batch_allocation_id = '123e457-e89b-12d3-a456-426614174004', - token_id = 'ETH_USDT', - amount = '500.00', - source_account = '', - destination_account = '', - description = '', ) - ], ) """ diff --git a/test/test_create_batch_allocation_request.py b/test/test_create_batch_allocation_request.py index e74311f6..f68640a7 100644 --- a/test/test_create_batch_allocation_request.py +++ b/test/test_create_batch_allocation_request.py @@ -35,25 +35,25 @@ def make_instance(self, include_optional) -> CreateBatchAllocationRequest: if include_optional: return CreateBatchAllocationRequest( request_id = '123e457-e89b-12d3-a456-426614174004', - allocation_requests = [ - cobo_waas2.models.allocation_request.AllocationRequest( + allocation_params = [ + cobo_waas2.models.allocation_param.AllocationParam( token_id = 'ETH_USDT', amount = '500.00', - source_account = 'M1001', - destination_account = 'M1001', - description = 'Allocation for merchant M1001', ) + source_account = '', + destination_account = '', + description = '', ) ] ) else: return CreateBatchAllocationRequest( request_id = '123e457-e89b-12d3-a456-426614174004', - allocation_requests = [ - cobo_waas2.models.allocation_request.AllocationRequest( + allocation_params = [ + cobo_waas2.models.allocation_param.AllocationParam( token_id = 'ETH_USDT', amount = '500.00', - source_account = 'M1001', - destination_account = 'M1001', - description = 'Allocation for merchant M1001', ) + source_account = '', + destination_account = '', + description = '', ) ], ) """ diff --git a/test/test_create_bulk_send_request.py b/test/test_create_bulk_send_request.py new file mode 100644 index 00000000..bcd32581 --- /dev/null +++ b/test/test_create_bulk_send_request.py @@ -0,0 +1,69 @@ +# coding: utf-8 + +""" + Cobo Wallet as a Service 2.0 + + Contact: help@cobo.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from cobo_waas2.models.create_bulk_send_request import CreateBulkSendRequest + + +class TestCreateBulkSendRequest(unittest.TestCase): + """CreateBulkSendRequest unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> CreateBulkSendRequest: + """Test CreateBulkSendRequest + include_option is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `CreateBulkSendRequest` + """ + model = CreateBulkSendRequest() + if include_optional: + return CreateBulkSendRequest( + source_account = 'M1001', + execution_mode = 'Strict', + description = 'Monthly vendor payments - January 2024', + payout_params = [ + cobo_waas2.models.create_bulk_send_request_payout_params_inner.create_bulk_send_request_payout_params_inner( + token_id = 'ETH_USDT', + receiving_address = '0xabc123456789def0000000000000000000000000', + amount = '500.00', + description = 'Invoice #INV-2024-001', ) + ] + ) + else: + return CreateBulkSendRequest( + source_account = 'M1001', + execution_mode = 'Strict', + payout_params = [ + cobo_waas2.models.create_bulk_send_request_payout_params_inner.create_bulk_send_request_payout_params_inner( + token_id = 'ETH_USDT', + receiving_address = '0xabc123456789def0000000000000000000000000', + amount = '500.00', + description = 'Invoice #INV-2024-001', ) + ], + ) + """ + + def testCreateBulkSendRequest(self): + """Test CreateBulkSendRequest""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_create_bulk_send_request_payout_params_inner.py b/test/test_create_bulk_send_request_payout_params_inner.py new file mode 100644 index 00000000..62217e7f --- /dev/null +++ b/test/test_create_bulk_send_request_payout_params_inner.py @@ -0,0 +1,57 @@ +# coding: utf-8 + +""" + Cobo Wallet as a Service 2.0 + + Contact: help@cobo.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from cobo_waas2.models.create_bulk_send_request_payout_params_inner import CreateBulkSendRequestPayoutParamsInner + + +class TestCreateBulkSendRequestPayoutParamsInner(unittest.TestCase): + """CreateBulkSendRequestPayoutParamsInner unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> CreateBulkSendRequestPayoutParamsInner: + """Test CreateBulkSendRequestPayoutParamsInner + include_option is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `CreateBulkSendRequestPayoutParamsInner` + """ + model = CreateBulkSendRequestPayoutParamsInner() + if include_optional: + return CreateBulkSendRequestPayoutParamsInner( + token_id = 'ETH_USDT', + receiving_address = '0xabc123456789def0000000000000000000000000', + amount = '500.00', + description = 'Invoice #INV-2024-001' + ) + else: + return CreateBulkSendRequestPayoutParamsInner( + token_id = 'ETH_USDT', + receiving_address = '0xabc123456789def0000000000000000000000000', + amount = '500.00', + ) + """ + + def testCreateBulkSendRequestPayoutParamsInner(self): + """Test CreateBulkSendRequestPayoutParamsInner""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_create_payment_order_request.py b/test/test_create_payment_order_request.py index 1cd11ae9..b667c245 100644 --- a/test/test_create_payment_order_request.py +++ b/test/test_create_payment_order_request.py @@ -55,6 +55,7 @@ def make_instance(self, include_optional) -> CreatePaymentOrderRequest: merchant_id = '1001', psp_order_code = 'P20240201001', fee_amount = '2.00', + payable_currency = 'ETH_USDT', ) """ diff --git a/test/test_create_payout_request.py b/test/test_create_payout_request.py index 32635de2..6fbd6960 100644 --- a/test/test_create_payout_request.py +++ b/test/test_create_payout_request.py @@ -35,31 +35,35 @@ def make_instance(self, include_optional) -> CreatePayoutRequest: if include_optional: return CreatePayoutRequest( request_id = '123e457-e89b-12d3-a456-426614174004', + source_account = '', payout_channel = 'Crypto', payout_params = [ cobo_waas2.models.payment_payout_param.PaymentPayoutParam( - source_account = 'M1001', token_id = 'ETH_USDT', - amount = '500.00', - crypto_address_id = 'addr_ethusdt_20250506T123456_ab12cd', - crypto_address = '0xabc123456789def0000000000000000000000000', ) + amount = '500.00', ) ], - bank_account_id = '0123e457-e89b-12d3-a456-426614174004', - currency = 'USD', + recipient_info = cobo_waas2.models.payment_payout_recipient_info.PaymentPayoutRecipientInfo( + address = '0x9876543210abcdef1234567890abcdef12345678', + token_id = 'TRON_USDT', + currency = 'USD', + bank_account_id = '123e4567-e89b-12d3-a456-426614174003', ), remark = 'Create payouts for customer 123' ) else: return CreatePayoutRequest( request_id = '123e457-e89b-12d3-a456-426614174004', + source_account = '', payout_channel = 'Crypto', payout_params = [ cobo_waas2.models.payment_payout_param.PaymentPayoutParam( - source_account = 'M1001', token_id = 'ETH_USDT', - amount = '500.00', - crypto_address_id = 'addr_ethusdt_20250506T123456_ab12cd', - crypto_address = '0xabc123456789def0000000000000000000000000', ) + amount = '500.00', ) ], + recipient_info = cobo_waas2.models.payment_payout_recipient_info.PaymentPayoutRecipientInfo( + address = '0x9876543210abcdef1234567890abcdef12345678', + token_id = 'TRON_USDT', + currency = 'USD', + bank_account_id = '123e4567-e89b-12d3-a456-426614174003', ), ) """ diff --git a/test/test_create_top_up_addresses.py b/test/test_create_top_up_addresses.py new file mode 100644 index 00000000..e409400f --- /dev/null +++ b/test/test_create_top_up_addresses.py @@ -0,0 +1,59 @@ +# coding: utf-8 + +""" + Cobo Wallet as a Service 2.0 + + Contact: help@cobo.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from cobo_waas2.models.create_top_up_addresses import CreateTopUpAddresses + + +class TestCreateTopUpAddresses(unittest.TestCase): + """CreateTopUpAddresses unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> CreateTopUpAddresses: + """Test CreateTopUpAddresses + include_option is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `CreateTopUpAddresses` + """ + model = CreateTopUpAddresses() + if include_optional: + return CreateTopUpAddresses( + merchant_id = 'M1001', + token_id = 'ETH_USDT', + custom_payer_ids = [ + 'O20250304-P1001-1001' + ] + ) + else: + return CreateTopUpAddresses( + token_id = 'ETH_USDT', + custom_payer_ids = [ + 'O20250304-P1001-1001' + ], + ) + """ + + def testCreateTopUpAddresses(self): + """Test CreateTopUpAddresses""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_create_top_up_addresses201_response.py b/test/test_create_top_up_addresses201_response.py new file mode 100644 index 00000000..327b6d49 --- /dev/null +++ b/test/test_create_top_up_addresses201_response.py @@ -0,0 +1,63 @@ +# coding: utf-8 + +""" + Cobo Wallet as a Service 2.0 + + Contact: help@cobo.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from cobo_waas2.models.create_top_up_addresses201_response import CreateTopUpAddresses201Response + + +class TestCreateTopUpAddresses201Response(unittest.TestCase): + """CreateTopUpAddresses201Response unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> CreateTopUpAddresses201Response: + """Test CreateTopUpAddresses201Response + include_option is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `CreateTopUpAddresses201Response` + """ + model = CreateTopUpAddresses201Response() + if include_optional: + return CreateTopUpAddresses201Response( + data = [ + cobo_waas2.models.top_up_address.TopUpAddress( + address = '0x1234567890abcdef...', + payer_id = 'P20250619T0310056d7aa', + custom_payer_id = 'user_abc_10001', + merchant_id = 'M1001', + token_id = 'ETH_USDT', + chain = 'ETH', + developer_fee_rate = '0.01', + min_amount = '0.1', + created_timestamp = 1744689600, + updated_timestamp = 1744689600, ) + ] + ) + else: + return CreateTopUpAddresses201Response( + ) + """ + + def testCreateTopUpAddresses201Response(self): + """Test CreateTopUpAddresses201Response""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_graph_ql_api.py b/test/test_graph_ql_api.py new file mode 100644 index 00000000..defe0292 --- /dev/null +++ b/test/test_graph_ql_api.py @@ -0,0 +1,46 @@ +# coding: utf-8 + +""" + Cobo Wallet as a Service 2.0 + + Contact: help@cobo.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from cobo_waas2 import Configuration +from cobo_waas2.api.graph_ql_api import GraphQLApi + + +class TestGraphQLApi(unittest.TestCase): + """GraphQLApi unit test stubs""" + + def setUp(self) -> None: + Configuration.set_default(Configuration( + api_private_key="c203fccc02a2269ec486d9c32ff74b5ba6ab0cdb461ee1fb0dfc616109115c06", + host="https://api.sandbox.cobo.com/v2" + )) + self.api = GraphQLApi() + + def tearDown(self) -> None: + pass + + def test_execute_graphql(self) -> None: + """ + Test case for execute_graphql + + Execute a GraphQL query or mutation + """ + """ + graph_ql_request = cobo_waas2.GraphQLRequest() + + api_response = self.api.execute_graphql(graph_ql_request=graph_ql_request) + """ + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_list_allocations200_response.py b/test/test_list_allocation_items200_response.py similarity index 65% rename from test/test_list_allocations200_response.py rename to test/test_list_allocation_items200_response.py index 8bbb31b4..7893f307 100644 --- a/test/test_list_allocations200_response.py +++ b/test/test_list_allocation_items200_response.py @@ -12,11 +12,11 @@ import unittest -from cobo_waas2.models.list_allocations200_response import ListAllocations200Response +from cobo_waas2.models.list_allocation_items200_response import ListAllocationItems200Response -class TestListAllocations200Response(unittest.TestCase): - """ListAllocations200Response unit test stubs""" +class TestListAllocationItems200Response(unittest.TestCase): + """ListAllocationItems200Response unit test stubs""" def setUp(self): pass @@ -24,19 +24,19 @@ def setUp(self): def tearDown(self): pass - def make_instance(self, include_optional) -> ListAllocations200Response: - """Test ListAllocations200Response + def make_instance(self, include_optional) -> ListAllocationItems200Response: + """Test ListAllocationItems200Response include_option is a boolean, when False only required params are included, when True both required and optional params are included """ - # uncomment below to create an instance of `ListAllocations200Response` + # uncomment below to create an instance of `ListAllocationItems200Response` """ - model = ListAllocations200Response() + model = ListAllocationItems200Response() if include_optional: - return ListAllocations200Response( + return ListAllocationItems200Response( data = [ - cobo_waas2.models.allocation_record.AllocationRecord( - allocation_record_id = '123e457-e89b-12d3-a456-426614174004', + cobo_waas2.models.allocation_item.AllocationItem( + allocation_item_id = '123e457-e89b-12d3-a456-426614174004', batch_allocation_id = '123e457-e89b-12d3-a456-426614174004', token_id = 'ETH_USDT', amount = '500.00', @@ -50,12 +50,12 @@ def make_instance(self, include_optional) -> ListAllocations200Response: total_count = 10000, ) ) else: - return ListAllocations200Response( + return ListAllocationItems200Response( ) """ - def testListAllocations200Response(self): - """Test ListAllocations200Response""" + def testListAllocationItems200Response(self): + """Test ListAllocationItems200Response""" # inst_req_only = self.make_instance(include_optional=False) # inst_req_and_optional = self.make_instance(include_optional=True) diff --git a/test/test_list_batch_allocations200_response.py b/test/test_list_batch_allocations200_response.py index b787e095..fb474712 100644 --- a/test/test_list_batch_allocations200_response.py +++ b/test/test_list_batch_allocations200_response.py @@ -38,13 +38,13 @@ def make_instance(self, include_optional) -> ListBatchAllocations200Response: cobo_waas2.models.batch_allocation.BatchAllocation( batch_allocation_id = '123e457-e89b-12d3-a456-426614174004', request_id = '123e457-e89b-12d3-a456-426614174004', - allocation_requests = [ - cobo_waas2.models.allocation_request.AllocationRequest( + allocation_params = [ + cobo_waas2.models.allocation_param.AllocationParam( token_id = 'ETH_USDT', amount = '500.00', - source_account = 'M1001', - destination_account = 'M1001', - description = 'Allocation for merchant M1001', ) + source_account = '', + destination_account = '', + description = '', ) ], initiator = 'b2ae1b5aaade686c968ef2bbd31cc75ba94e5a85fd9cb0b35b81dcc15f520e9d', created_timestamp = 1744689600, diff --git a/test/test_list_bulk_send_items200_response.py b/test/test_list_bulk_send_items200_response.py new file mode 100644 index 00000000..57b52572 --- /dev/null +++ b/test/test_list_bulk_send_items200_response.py @@ -0,0 +1,64 @@ +# coding: utf-8 + +""" + Cobo Wallet as a Service 2.0 + + Contact: help@cobo.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from cobo_waas2.models.list_bulk_send_items200_response import ListBulkSendItems200Response + + +class TestListBulkSendItems200Response(unittest.TestCase): + """ListBulkSendItems200Response unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> ListBulkSendItems200Response: + """Test ListBulkSendItems200Response + include_option is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `ListBulkSendItems200Response` + """ + model = ListBulkSendItems200Response() + if include_optional: + return ListBulkSendItems200Response( + data = [ + cobo_waas2.models.payment_bulk_send_item.PaymentBulkSendItem( + bulk_send_item_id = '123e4567-e89b-12d3-a456-426614174003', + token_id = 'ETH_USDT', + receiving_address = '0xabc123456789def0000000000000000000000000', + amount = '500.00', + description = 'Invoice #INV-2024-001', + status = 'Pending', + validation_status = 'Pending', ) + ], + pagination = cobo_waas2.models.pagination.Pagination( + before = 'RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGmk1', + after = 'RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGSAk', + total_count = 10000, ) + ) + else: + return ListBulkSendItems200Response( + ) + """ + + def testListBulkSendItems200Response(self): + """Test ListBulkSendItems200Response""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_list_payout_items200_response.py b/test/test_list_payout_items200_response.py deleted file mode 100644 index 3c02a67e..00000000 --- a/test/test_list_payout_items200_response.py +++ /dev/null @@ -1,105 +0,0 @@ -# coding: utf-8 - -""" - Cobo Wallet as a Service 2.0 - - Contact: help@cobo.com - Generated by OpenAPI Generator (https://openapi-generator.tech) - - Do not edit the class manually. -""" # noqa: E501 - - -import unittest - -from cobo_waas2.models.list_payout_items200_response import ListPayoutItems200Response - - -class TestListPayoutItems200Response(unittest.TestCase): - """ListPayoutItems200Response unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def make_instance(self, include_optional) -> ListPayoutItems200Response: - """Test ListPayoutItems200Response - include_option is a boolean, when False only required - params are included, when True both required and - optional params are included """ - # uncomment below to create an instance of `ListPayoutItems200Response` - """ - model = ListPayoutItems200Response() - if include_optional: - return ListPayoutItems200Response( - data = [ - cobo_waas2.models.payment_payout_item.PaymentPayoutItem( - payout_item_id = '123e457-e89b-12d3-a456-426614174004', - payout_id = '123e457-e89b-12d3-a456-426614174004', - token_id = 'ETH_USDT', - chain_id = 'ETH', - amount = '500.00', - status = 'Pending', - source_account = 'M1001', - transactions = [ - cobo_waas2.models.payment_transaction.PaymentTransaction( - tx_id = 'tx_123e4567-e89b-12d3-a456-426614174003', - tx_hash = '0x742d35Cc6634C0532925a3b844Bc454e4438f44e', - token_id = 'ETH_USDT', - from_address = '0xF8e4bfc10A2821DF52D3322cB5170E5E9276b537', - to_address = '0x15B95A2D8af95D9F48148667B6b8B3CdF89e4F15', - amount = '0.15', - status = 'Submitted', - counterparty = cobo_waas2.models.counterparty.Counterparty( - counterparty_id = '123e4567-e89b-12d3-a456-426614174003', - counterparty_type = 'Individual', - counterparty_name = 'Counterparty A', - country = 'USA', - email = 'counterparty@example.com', - contact_address = '123 Main St, Anytown, USA', - created_timestamp = 1744689600, - updated_timestamp = 1744689600, ), - destination = cobo_waas2.models.destination.Destination( - destination_id = '123e4567-e89b-12d3-a456-426614174003', - destination_type = 'Individual', - destination_name = 'Destination A', - country = 'USA', - email = 'destination@example.com', - contact_address = '123 Main St, Anytown, USA', - merchant_id = 'M1001', - created_timestamp = 1744689600, - updated_timestamp = 1744689600, ), - created_timestamp = 1610445878970, - updated_timestamp = 1610445878970, ) - ], - created_timestamp = 1744689600, - updated_timestamp = 1744689600, - crypto_address_id = 'addr_ethusdt_20250429T134512_a8c31f', - crypto_address = '0xabc123456789def0000000000000000000000000', - commission_fee = cobo_waas2.models.commission_fee.CommissionFee( - fee_amount = '', ), - bridging_fee = cobo_waas2.models.bridging_fee.BridgingFee( - fee_amount = '', - received_token_id = '', - received_amount = '', ), ) - ], - pagination = cobo_waas2.models.pagination.Pagination( - before = 'RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGmk1', - after = 'RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGSAk', - total_count = 10000, ) - ) - else: - return ListPayoutItems200Response( - ) - """ - - def testListPayoutItems200Response(self): - """Test ListPayoutItems200Response""" - # inst_req_only = self.make_instance(include_optional=False) - # inst_req_and_optional = self.make_instance(include_optional=True) - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_list_payouts200_response.py b/test/test_list_payouts200_response.py index 0013a961..5366c835 100644 --- a/test/test_list_payouts200_response.py +++ b/test/test_list_payouts200_response.py @@ -39,68 +39,27 @@ def make_instance(self, include_optional) -> ListPayouts200Response: payout_id = '123e457-e89b-12d3-a456-426614174004', request_id = '123e457-e89b-12d3-a456-426614174004', payout_channel = 'Crypto', + source_account = '', payout_items = [ cobo_waas2.models.payment_payout_item.PaymentPayoutItem( - payout_item_id = '123e457-e89b-12d3-a456-426614174004', - payout_id = '123e457-e89b-12d3-a456-426614174004', token_id = 'ETH_USDT', - chain_id = 'ETH', amount = '500.00', - status = 'Pending', - source_account = 'M1001', - transactions = [ - cobo_waas2.models.payment_transaction.PaymentTransaction( - tx_id = 'tx_123e4567-e89b-12d3-a456-426614174003', - tx_hash = '0x742d35Cc6634C0532925a3b844Bc454e4438f44e', - token_id = 'ETH_USDT', - from_address = '0xF8e4bfc10A2821DF52D3322cB5170E5E9276b537', - to_address = '0x15B95A2D8af95D9F48148667B6b8B3CdF89e4F15', - amount = '0.15', - status = 'Submitted', - counterparty = cobo_waas2.models.counterparty.Counterparty( - counterparty_id = '123e4567-e89b-12d3-a456-426614174003', - counterparty_type = 'Individual', - counterparty_name = 'Counterparty A', - country = 'USA', - email = 'counterparty@example.com', - contact_address = '123 Main St, Anytown, USA', - created_timestamp = 1744689600, - updated_timestamp = 1744689600, ), - destination = cobo_waas2.models.destination.Destination( - destination_id = '123e4567-e89b-12d3-a456-426614174003', - destination_type = 'Individual', - destination_name = 'Destination A', - country = 'USA', - email = 'destination@example.com', - contact_address = '123 Main St, Anytown, USA', - merchant_id = 'M1001', - created_timestamp = 1744689600, - updated_timestamp = 1744689600, ), - created_timestamp = 1610445878970, - updated_timestamp = 1610445878970, ) - ], - created_timestamp = 1744689600, - updated_timestamp = 1744689600, - crypto_address_id = 'addr_ethusdt_20250429T134512_a8c31f', - crypto_address = '0xabc123456789def0000000000000000000000000', - commission_fee = cobo_waas2.models.commission_fee.CommissionFee( - fee_amount = '', ), bridging_fee = cobo_waas2.models.bridging_fee.BridgingFee( fee_amount = '', received_token_id = '', received_amount = '', ), ) ], - status = 'Pending', - created_timestamp = 1744689600, - updated_timestamp = 1744689600, + recipient_info = cobo_waas2.models.payment_payout_recipient_info.PaymentPayoutRecipientInfo( + address = '0x9876543210abcdef1234567890abcdef12345678', + token_id = 'TRON_USDT', + currency = 'USD', + bank_account_id = '123e4567-e89b-12d3-a456-426614174003', ), initiator = 'b2ae1b5aaade686c968ef2bbd31cc75ba94e5a85fd9cb0b35b81dcc15f520e9d', - currency = 'USD', actual_payout_amount = '500.00', - bank_account = cobo_waas2.models.bank_account.BankAccount( - bank_account_id = '123e4567-e89b-12d3-a456-426614174003', - info = {"beneficiary_name":"John Doe","beneficiary_address":"123 Main St, Anytown, USA","account_number":"4111111111111111","bank_name":"ABC Bank","bank_country":"USA","bank_address":"456 Bank Ave, Cityville, USA","swift_or_bic":"ABCDEFGH"}, - created_timestamp = 1744689600, - updated_timestamp = 1744689600, ), ) + status = 'Pending', + remark = 'Payout for customer 123', + created_timestamp = 1744689600, + updated_timestamp = 1744689600, ) ], pagination = cobo_waas2.models.pagination.Pagination( before = 'RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGmk1', diff --git a/test/test_order_link_business_info.py b/test/test_order_link_business_info.py index beef68c5..fdc0bd1b 100644 --- a/test/test_order_link_business_info.py +++ b/test/test_order_link_business_info.py @@ -60,7 +60,10 @@ def make_instance(self, include_optional) -> OrderLinkBusinessInfo: return OrderLinkBusinessInfo( merchant_id = '1001', psp_order_code = 'P20240201001', + pricing_currency = 'USD', + pricing_amount = '100.00', fee_amount = '2.00', + payable_currencies = ["ETH_USDT","SOL_USDC","TRON_USDT"], ) """ diff --git a/test/test_payment_api.py b/test/test_payment_api.py index 450537b8..9eca2046 100644 --- a/test/test_payment_api.py +++ b/test/test_payment_api.py @@ -66,6 +66,18 @@ def test_create_batch_allocation(self) -> None: api_response = self.api.create_batch_allocation(create_batch_allocation_request=create_batch_allocation_request) """ + def test_create_bulk_send(self) -> None: + """ + Test case for create_bulk_send + + Create bulk send + """ + """ + create_bulk_send_request = cobo_waas2.CreateBulkSendRequest() + + api_response = self.api.create_bulk_send(create_bulk_send_request=create_bulk_send_request) + """ + def test_create_counterparty(self) -> None: """ Test case for create_counterparty @@ -270,6 +282,18 @@ def test_create_settlement_request(self) -> None: api_response = self.api.create_settlement_request(create_settlement_request_request=create_settlement_request_request) """ + def test_create_top_up_addresses(self) -> None: + """ + Test case for create_top_up_addresses + + Batch create top-up addresses + """ + """ + create_top_up_addresses = cobo_waas2.CreateTopUpAddresses() + + api_response = self.api.create_top_up_addresses(create_top_up_addresses=create_top_up_addresses) + """ + def test_delete_counterparty(self) -> None: """ Test case for delete_counterparty @@ -432,6 +456,18 @@ def test_get_batch_allocation_by_id(self) -> None: api_response = self.api.get_batch_allocation_by_id(batch_allocation_id) """ + def test_get_bulk_send_by_id(self) -> None: + """ + Test case for get_bulk_send_by_id + + Get bulk send information + """ + """ + bulk_send_id = '123e4567-e89b-12d3-a456-426614174003' + + api_response = self.api.get_bulk_send_by_id(bulk_send_id) + """ + def test_get_counterparty(self) -> None: """ Test case for get_counterparty @@ -652,11 +688,11 @@ def test_get_top_up_address(self) -> None: api_response = self.api.get_top_up_address(token_id, custom_payer_id, merchant_id=merchant_id) """ - def test_list_allocations(self) -> None: + def test_list_allocation_items(self) -> None: """ - Test case for list_allocations + Test case for list_allocation_items - List all allocation records + List all allocation items """ """ limit = 10 @@ -667,7 +703,7 @@ def test_list_allocations(self) -> None: token_id = 'ETH_USDT' batch_allocation_id = '5b0ed293-f728-40b4-b1f6-86b88cd51384' - api_response = self.api.list_allocations(limit=limit, before=before, after=after, source_account=source_account, destination_account=destination_account, token_id=token_id, batch_allocation_id=batch_allocation_id) + api_response = self.api.list_allocation_items(limit=limit, before=before, after=after, source_account=source_account, destination_account=destination_account, token_id=token_id, batch_allocation_id=batch_allocation_id) """ def test_list_bank_accounts(self) -> None: @@ -696,6 +732,21 @@ def test_list_batch_allocations(self) -> None: api_response = self.api.list_batch_allocations(limit=limit, before=before, after=after, request_id=request_id) """ + def test_list_bulk_send_items(self) -> None: + """ + Test case for list_bulk_send_items + + List bulk send items + """ + """ + bulk_send_id = '123e4567-e89b-12d3-a456-426614174003' + limit = 10 + before = 'RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGmk1' + after = 'RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGSAk' + + api_response = self.api.list_bulk_send_items(bulk_send_id, limit=limit, before=before, after=after) + """ + def test_list_counterparties(self) -> None: """ Test case for list_counterparties @@ -919,22 +970,6 @@ def test_list_payment_wallet_balances(self) -> None: api_response = self.api.list_payment_wallet_balances(token_id, wallet_ids=wallet_ids) """ - def test_list_payout_items(self) -> None: - """ - Test case for list_payout_items - - List all payout items - """ - """ - limit = 10 - before = 'RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGmk1' - after = 'RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGSAk' - source_account = 'source_account_example' - statuses = 'Pending,Processing' - - api_response = self.api.list_payout_items(limit=limit, before=before, after=after, source_account=source_account, statuses=statuses) - """ - def test_list_payouts(self) -> None: """ Test case for list_payouts diff --git a/test/test_payment_bulk_send.py b/test/test_payment_bulk_send.py new file mode 100644 index 00000000..bfe9e2c9 --- /dev/null +++ b/test/test_payment_bulk_send.py @@ -0,0 +1,63 @@ +# coding: utf-8 + +""" + Cobo Wallet as a Service 2.0 + + Contact: help@cobo.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from cobo_waas2.models.payment_bulk_send import PaymentBulkSend + + +class TestPaymentBulkSend(unittest.TestCase): + """PaymentBulkSend unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> PaymentBulkSend: + """Test PaymentBulkSend + include_option is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `PaymentBulkSend` + """ + model = PaymentBulkSend() + if include_optional: + return PaymentBulkSend( + bulk_send_id = '123e4567-e89b-12d3-a456-426614174003', + source_account = 'M1001', + description = 'Monthly vendor payments - January 2024', + execution_mode = 'Strict', + status = 'Pending', + created_timestamp = 1744689600, + updated_timestamp = 1744689600 + ) + else: + return PaymentBulkSend( + bulk_send_id = '123e4567-e89b-12d3-a456-426614174003', + source_account = 'M1001', + execution_mode = 'Strict', + status = 'Pending', + created_timestamp = 1744689600, + updated_timestamp = 1744689600, + ) + """ + + def testPaymentBulkSend(self): + """Test PaymentBulkSend""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_payment_bulk_send_event.py b/test/test_payment_bulk_send_event.py new file mode 100644 index 00000000..9679847f --- /dev/null +++ b/test/test_payment_bulk_send_event.py @@ -0,0 +1,65 @@ +# coding: utf-8 + +""" + Cobo Wallet as a Service 2.0 + + Contact: help@cobo.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from cobo_waas2.models.payment_bulk_send_event import PaymentBulkSendEvent + + +class TestPaymentBulkSendEvent(unittest.TestCase): + """PaymentBulkSendEvent unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> PaymentBulkSendEvent: + """Test PaymentBulkSendEvent + include_option is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `PaymentBulkSendEvent` + """ + model = PaymentBulkSendEvent() + if include_optional: + return PaymentBulkSendEvent( + data_type = 'Transaction', + bulk_send_id = '123e4567-e89b-12d3-a456-426614174003', + source_account = 'M1001', + description = 'Monthly vendor payments - January 2024', + execution_mode = 'Strict', + status = 'Pending', + created_timestamp = 1744689600, + updated_timestamp = 1744689600 + ) + else: + return PaymentBulkSendEvent( + data_type = 'Transaction', + bulk_send_id = '123e4567-e89b-12d3-a456-426614174003', + source_account = 'M1001', + execution_mode = 'Strict', + status = 'Pending', + created_timestamp = 1744689600, + updated_timestamp = 1744689600, + ) + """ + + def testPaymentBulkSendEvent(self): + """Test PaymentBulkSendEvent""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_payment_bulk_send_execution_mode.py b/test/test_payment_bulk_send_execution_mode.py new file mode 100644 index 00000000..1997ad34 --- /dev/null +++ b/test/test_payment_bulk_send_execution_mode.py @@ -0,0 +1,33 @@ +# coding: utf-8 + +""" + Cobo Wallet as a Service 2.0 + + Contact: help@cobo.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from cobo_waas2.models.payment_bulk_send_execution_mode import PaymentBulkSendExecutionMode + + +class TestPaymentBulkSendExecutionMode(unittest.TestCase): + """PaymentBulkSendExecutionMode unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testPaymentBulkSendExecutionMode(self): + """Test PaymentBulkSendExecutionMode""" + # inst = PaymentBulkSendExecutionMode() + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_payment_bulk_send_item.py b/test/test_payment_bulk_send_item.py new file mode 100644 index 00000000..39ec8337 --- /dev/null +++ b/test/test_payment_bulk_send_item.py @@ -0,0 +1,63 @@ +# coding: utf-8 + +""" + Cobo Wallet as a Service 2.0 + + Contact: help@cobo.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from cobo_waas2.models.payment_bulk_send_item import PaymentBulkSendItem + + +class TestPaymentBulkSendItem(unittest.TestCase): + """PaymentBulkSendItem unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> PaymentBulkSendItem: + """Test PaymentBulkSendItem + include_option is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `PaymentBulkSendItem` + """ + model = PaymentBulkSendItem() + if include_optional: + return PaymentBulkSendItem( + bulk_send_item_id = '123e4567-e89b-12d3-a456-426614174003', + token_id = 'ETH_USDT', + receiving_address = '0xabc123456789def0000000000000000000000000', + amount = '500.00', + description = 'Invoice #INV-2024-001', + status = 'Pending', + validation_status = 'Pending' + ) + else: + return PaymentBulkSendItem( + bulk_send_item_id = '123e4567-e89b-12d3-a456-426614174003', + token_id = 'ETH_USDT', + receiving_address = '0xabc123456789def0000000000000000000000000', + amount = '500.00', + status = 'Pending', + validation_status = 'Pending', + ) + """ + + def testPaymentBulkSendItem(self): + """Test PaymentBulkSendItem""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_payment_bulk_send_item_status.py b/test/test_payment_bulk_send_item_status.py new file mode 100644 index 00000000..3f49d7fe --- /dev/null +++ b/test/test_payment_bulk_send_item_status.py @@ -0,0 +1,33 @@ +# coding: utf-8 + +""" + Cobo Wallet as a Service 2.0 + + Contact: help@cobo.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from cobo_waas2.models.payment_bulk_send_item_status import PaymentBulkSendItemStatus + + +class TestPaymentBulkSendItemStatus(unittest.TestCase): + """PaymentBulkSendItemStatus unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testPaymentBulkSendItemStatus(self): + """Test PaymentBulkSendItemStatus""" + # inst = PaymentBulkSendItemStatus() + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_payment_bulk_send_item_validation_status.py b/test/test_payment_bulk_send_item_validation_status.py new file mode 100644 index 00000000..1f3f3cce --- /dev/null +++ b/test/test_payment_bulk_send_item_validation_status.py @@ -0,0 +1,33 @@ +# coding: utf-8 + +""" + Cobo Wallet as a Service 2.0 + + Contact: help@cobo.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from cobo_waas2.models.payment_bulk_send_item_validation_status import PaymentBulkSendItemValidationStatus + + +class TestPaymentBulkSendItemValidationStatus(unittest.TestCase): + """PaymentBulkSendItemValidationStatus unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testPaymentBulkSendItemValidationStatus(self): + """Test PaymentBulkSendItemValidationStatus""" + # inst = PaymentBulkSendItemValidationStatus() + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_payment_payout_item_status.py b/test/test_payment_bulk_send_status.py similarity index 52% rename from test/test_payment_payout_item_status.py rename to test/test_payment_bulk_send_status.py index b9a6c8e4..4dbcd95c 100644 --- a/test/test_payment_payout_item_status.py +++ b/test/test_payment_bulk_send_status.py @@ -12,11 +12,11 @@ import unittest -from cobo_waas2.models.payment_payout_item_status import PaymentPayoutItemStatus +from cobo_waas2.models.payment_bulk_send_status import PaymentBulkSendStatus -class TestPaymentPayoutItemStatus(unittest.TestCase): - """PaymentPayoutItemStatus unit test stubs""" +class TestPaymentBulkSendStatus(unittest.TestCase): + """PaymentBulkSendStatus unit test stubs""" def setUp(self): pass @@ -24,9 +24,9 @@ def setUp(self): def tearDown(self): pass - def testPaymentPayoutItemStatus(self): - """Test PaymentPayoutItemStatus""" - # inst = PaymentPayoutItemStatus() + def testPaymentBulkSendStatus(self): + """Test PaymentBulkSendStatus""" + # inst = PaymentBulkSendStatus() if __name__ == '__main__': diff --git a/test/test_payment_estimate_fee_request.py b/test/test_payment_estimate_fee_request.py index 13e363df..c488cb81 100644 --- a/test/test_payment_estimate_fee_request.py +++ b/test/test_payment_estimate_fee_request.py @@ -39,7 +39,8 @@ def make_instance(self, include_optional) -> PaymentEstimateFeeRequest: cobo_waas2.models.payment_estimate_fee.PaymentEstimateFee( token_id = '', amount = '500.00', ) - ] + ], + recipient_token_id = '' ) else: return PaymentEstimateFeeRequest( diff --git a/test/test_payment_payout.py b/test/test_payment_payout.py index 40f312d7..52354c0a 100644 --- a/test/test_payment_payout.py +++ b/test/test_payment_payout.py @@ -37,68 +37,27 @@ def make_instance(self, include_optional) -> PaymentPayout: payout_id = '123e457-e89b-12d3-a456-426614174004', request_id = '123e457-e89b-12d3-a456-426614174004', payout_channel = 'Crypto', + source_account = '', payout_items = [ cobo_waas2.models.payment_payout_item.PaymentPayoutItem( - payout_item_id = '123e457-e89b-12d3-a456-426614174004', - payout_id = '123e457-e89b-12d3-a456-426614174004', token_id = 'ETH_USDT', - chain_id = 'ETH', amount = '500.00', - status = 'Pending', - source_account = 'M1001', - transactions = [ - cobo_waas2.models.payment_transaction.PaymentTransaction( - tx_id = 'tx_123e4567-e89b-12d3-a456-426614174003', - tx_hash = '0x742d35Cc6634C0532925a3b844Bc454e4438f44e', - token_id = 'ETH_USDT', - from_address = '0xF8e4bfc10A2821DF52D3322cB5170E5E9276b537', - to_address = '0x15B95A2D8af95D9F48148667B6b8B3CdF89e4F15', - amount = '0.15', - status = 'Submitted', - counterparty = cobo_waas2.models.counterparty.Counterparty( - counterparty_id = '123e4567-e89b-12d3-a456-426614174003', - counterparty_type = 'Individual', - counterparty_name = 'Counterparty A', - country = 'USA', - email = 'counterparty@example.com', - contact_address = '123 Main St, Anytown, USA', - created_timestamp = 1744689600, - updated_timestamp = 1744689600, ), - destination = cobo_waas2.models.destination.Destination( - destination_id = '123e4567-e89b-12d3-a456-426614174003', - destination_type = 'Individual', - destination_name = 'Destination A', - country = 'USA', - email = 'destination@example.com', - contact_address = '123 Main St, Anytown, USA', - merchant_id = 'M1001', - created_timestamp = 1744689600, - updated_timestamp = 1744689600, ), - created_timestamp = 1610445878970, - updated_timestamp = 1610445878970, ) - ], - created_timestamp = 1744689600, - updated_timestamp = 1744689600, - crypto_address_id = 'addr_ethusdt_20250429T134512_a8c31f', - crypto_address = '0xabc123456789def0000000000000000000000000', - commission_fee = cobo_waas2.models.commission_fee.CommissionFee( - fee_amount = '', ), bridging_fee = cobo_waas2.models.bridging_fee.BridgingFee( fee_amount = '', received_token_id = '', received_amount = '', ), ) ], - status = 'Pending', - created_timestamp = 1744689600, - updated_timestamp = 1744689600, + recipient_info = cobo_waas2.models.payment_payout_recipient_info.PaymentPayoutRecipientInfo( + address = '0x9876543210abcdef1234567890abcdef12345678', + token_id = 'TRON_USDT', + currency = 'USD', + bank_account_id = '123e4567-e89b-12d3-a456-426614174003', ), initiator = 'b2ae1b5aaade686c968ef2bbd31cc75ba94e5a85fd9cb0b35b81dcc15f520e9d', - currency = 'USD', actual_payout_amount = '500.00', - bank_account = cobo_waas2.models.bank_account.BankAccount( - bank_account_id = '123e4567-e89b-12d3-a456-426614174003', - info = {"beneficiary_name":"John Doe","beneficiary_address":"123 Main St, Anytown, USA","account_number":"4111111111111111","bank_name":"ABC Bank","bank_country":"USA","bank_address":"456 Bank Ave, Cityville, USA","swift_or_bic":"ABCDEFGH"}, - created_timestamp = 1744689600, - updated_timestamp = 1744689600, ) + status = 'Pending', + remark = 'Payout for customer 123', + created_timestamp = 1744689600, + updated_timestamp = 1744689600 ) else: return PaymentPayout( @@ -106,6 +65,8 @@ def make_instance(self, include_optional) -> PaymentPayout: request_id = '123e457-e89b-12d3-a456-426614174004', payout_channel = 'Crypto', status = 'Pending', + created_timestamp = 1744689600, + updated_timestamp = 1744689600, ) """ diff --git a/test/test_payment_payout_detail.py b/test/test_payment_payout_detail.py index 01b10d65..1e54617e 100644 --- a/test/test_payment_payout_detail.py +++ b/test/test_payment_payout_detail.py @@ -36,75 +36,68 @@ def make_instance(self, include_optional) -> PaymentPayoutDetail: return PaymentPayoutDetail( payout_id = '123e457-e89b-12d3-a456-426614174004', request_id = '123e457-e89b-12d3-a456-426614174004', - status = 'Pending', - payout_item_details = [ - cobo_waas2.models.payment_payout_item_detail.PaymentPayoutItemDetail( - payout_item_id = '123e457-e89b-12d3-a456-426614174004', - payout_id = '123e457-e89b-12d3-a456-426614174004', + payout_channel = 'Crypto', + source_account = '', + payout_items = [ + cobo_waas2.models.payment_payout_item.PaymentPayoutItem( token_id = 'ETH_USDT', - chain_id = 'ETH', - source_account = 'M1001', amount = '500.00', - status = 'Pending', - transactions = [ - cobo_waas2.models.payment_transaction.PaymentTransaction( - tx_id = 'tx_123e4567-e89b-12d3-a456-426614174003', - tx_hash = '0x742d35Cc6634C0532925a3b844Bc454e4438f44e', - token_id = 'ETH_USDT', - from_address = '0xF8e4bfc10A2821DF52D3322cB5170E5E9276b537', - to_address = '0x15B95A2D8af95D9F48148667B6b8B3CdF89e4F15', - amount = '0.15', - status = 'Submitted', - counterparty = cobo_waas2.models.counterparty.Counterparty( - counterparty_id = '123e4567-e89b-12d3-a456-426614174003', - counterparty_type = 'Individual', - counterparty_name = 'Counterparty A', - country = 'USA', - email = 'counterparty@example.com', - contact_address = '123 Main St, Anytown, USA', - created_timestamp = 1744689600, - updated_timestamp = 1744689600, ), - destination = cobo_waas2.models.destination.Destination( - destination_id = '123e4567-e89b-12d3-a456-426614174003', - destination_type = 'Individual', - destination_name = 'Destination A', - country = 'USA', - email = 'destination@example.com', - contact_address = '123 Main St, Anytown, USA', - merchant_id = 'M1001', - created_timestamp = 1744689600, - updated_timestamp = 1744689600, ), - created_timestamp = 1610445878970, - updated_timestamp = 1610445878970, ) - ], - created_timestamp = 1744689600, - updated_timestamp = 1744689600, - crypto_address_id = 'addr_ethusdt_20250429T134512_a8c31f', - crypto_address = '0xabc123456789def0000000000000000000000000', - commission_fee = cobo_waas2.models.commission_fee.CommissionFee( - fee_amount = '', ), bridging_fee = cobo_waas2.models.bridging_fee.BridgingFee( fee_amount = '', received_token_id = '', received_amount = '', ), ) ], - created_timestamp = 1744689600, - updated_timestamp = 1744689600, + recipient_info = cobo_waas2.models.payment_payout_recipient_info.PaymentPayoutRecipientInfo( + address = '0x9876543210abcdef1234567890abcdef12345678', + token_id = 'TRON_USDT', + currency = 'USD', + bank_account_id = '123e4567-e89b-12d3-a456-426614174003', ), initiator = 'b2ae1b5aaade686c968ef2bbd31cc75ba94e5a85fd9cb0b35b81dcc15f520e9d', - payout_channel = 'Crypto', - currency = 'USD', actual_payout_amount = '500.00', - bank_account = cobo_waas2.models.bank_account.BankAccount( - bank_account_id = '123e4567-e89b-12d3-a456-426614174003', - info = {"beneficiary_name":"John Doe","beneficiary_address":"123 Main St, Anytown, USA","account_number":"4111111111111111","bank_name":"ABC Bank","bank_country":"USA","bank_address":"456 Bank Ave, Cityville, USA","swift_or_bic":"ABCDEFGH"}, - created_timestamp = 1744689600, - updated_timestamp = 1744689600, ) + status = 'Pending', + remark = 'Payout for customer 123', + created_timestamp = 1744689600, + updated_timestamp = 1744689600, + transactions = [ + cobo_waas2.models.payment_transaction.PaymentTransaction( + tx_id = 'tx_123e4567-e89b-12d3-a456-426614174003', + tx_hash = '0x742d35Cc6634C0532925a3b844Bc454e4438f44e', + token_id = 'ETH_USDT', + from_address = '0xF8e4bfc10A2821DF52D3322cB5170E5E9276b537', + to_address = '0x15B95A2D8af95D9F48148667B6b8B3CdF89e4F15', + amount = '0.15', + status = 'Submitted', + counterparty = cobo_waas2.models.counterparty.Counterparty( + counterparty_id = '123e4567-e89b-12d3-a456-426614174003', + counterparty_type = 'Individual', + counterparty_name = 'Counterparty A', + country = 'USA', + email = 'counterparty@example.com', + contact_address = '123 Main St, Anytown, USA', + created_timestamp = 1744689600, + updated_timestamp = 1744689600, ), + destination = cobo_waas2.models.destination.Destination( + destination_id = '123e4567-e89b-12d3-a456-426614174003', + destination_type = 'Individual', + destination_name = 'Destination A', + country = 'USA', + email = 'destination@example.com', + contact_address = '123 Main St, Anytown, USA', + merchant_id = 'M1001', + created_timestamp = 1744689600, + updated_timestamp = 1744689600, ), + created_timestamp = 1610445878970, + updated_timestamp = 1610445878970, ) + ] ) else: return PaymentPayoutDetail( payout_id = '123e457-e89b-12d3-a456-426614174004', request_id = '123e457-e89b-12d3-a456-426614174004', + payout_channel = 'Crypto', status = 'Pending', + created_timestamp = 1744689600, + updated_timestamp = 1744689600, ) """ diff --git a/test/test_payment_payout_event.py b/test/test_payment_payout_event.py index 9d240151..f541e74f 100644 --- a/test/test_payment_payout_event.py +++ b/test/test_payment_payout_event.py @@ -37,76 +37,69 @@ def make_instance(self, include_optional) -> PaymentPayoutEvent: data_type = 'Transaction', payout_id = '123e457-e89b-12d3-a456-426614174004', request_id = '123e457-e89b-12d3-a456-426614174004', - status = 'Pending', - payout_item_details = [ - cobo_waas2.models.payment_payout_item_detail.PaymentPayoutItemDetail( - payout_item_id = '123e457-e89b-12d3-a456-426614174004', - payout_id = '123e457-e89b-12d3-a456-426614174004', + payout_channel = 'Crypto', + source_account = '', + payout_items = [ + cobo_waas2.models.payment_payout_item.PaymentPayoutItem( token_id = 'ETH_USDT', - chain_id = 'ETH', - source_account = 'M1001', amount = '500.00', - status = 'Pending', - transactions = [ - cobo_waas2.models.payment_transaction.PaymentTransaction( - tx_id = 'tx_123e4567-e89b-12d3-a456-426614174003', - tx_hash = '0x742d35Cc6634C0532925a3b844Bc454e4438f44e', - token_id = 'ETH_USDT', - from_address = '0xF8e4bfc10A2821DF52D3322cB5170E5E9276b537', - to_address = '0x15B95A2D8af95D9F48148667B6b8B3CdF89e4F15', - amount = '0.15', - status = 'Submitted', - counterparty = cobo_waas2.models.counterparty.Counterparty( - counterparty_id = '123e4567-e89b-12d3-a456-426614174003', - counterparty_type = 'Individual', - counterparty_name = 'Counterparty A', - country = 'USA', - email = 'counterparty@example.com', - contact_address = '123 Main St, Anytown, USA', - created_timestamp = 1744689600, - updated_timestamp = 1744689600, ), - destination = cobo_waas2.models.destination.Destination( - destination_id = '123e4567-e89b-12d3-a456-426614174003', - destination_type = 'Individual', - destination_name = 'Destination A', - country = 'USA', - email = 'destination@example.com', - contact_address = '123 Main St, Anytown, USA', - merchant_id = 'M1001', - created_timestamp = 1744689600, - updated_timestamp = 1744689600, ), - created_timestamp = 1610445878970, - updated_timestamp = 1610445878970, ) - ], - created_timestamp = 1744689600, - updated_timestamp = 1744689600, - crypto_address_id = 'addr_ethusdt_20250429T134512_a8c31f', - crypto_address = '0xabc123456789def0000000000000000000000000', - commission_fee = cobo_waas2.models.commission_fee.CommissionFee( - fee_amount = '', ), bridging_fee = cobo_waas2.models.bridging_fee.BridgingFee( fee_amount = '', received_token_id = '', received_amount = '', ), ) ], - created_timestamp = 1744689600, - updated_timestamp = 1744689600, + recipient_info = cobo_waas2.models.payment_payout_recipient_info.PaymentPayoutRecipientInfo( + address = '0x9876543210abcdef1234567890abcdef12345678', + token_id = 'TRON_USDT', + currency = 'USD', + bank_account_id = '123e4567-e89b-12d3-a456-426614174003', ), initiator = 'b2ae1b5aaade686c968ef2bbd31cc75ba94e5a85fd9cb0b35b81dcc15f520e9d', - payout_channel = 'Crypto', - currency = 'USD', actual_payout_amount = '500.00', - bank_account = cobo_waas2.models.bank_account.BankAccount( - bank_account_id = '123e4567-e89b-12d3-a456-426614174003', - info = {"beneficiary_name":"John Doe","beneficiary_address":"123 Main St, Anytown, USA","account_number":"4111111111111111","bank_name":"ABC Bank","bank_country":"USA","bank_address":"456 Bank Ave, Cityville, USA","swift_or_bic":"ABCDEFGH"}, - created_timestamp = 1744689600, - updated_timestamp = 1744689600, ) + status = 'Pending', + remark = 'Payout for customer 123', + created_timestamp = 1744689600, + updated_timestamp = 1744689600, + transactions = [ + cobo_waas2.models.payment_transaction.PaymentTransaction( + tx_id = 'tx_123e4567-e89b-12d3-a456-426614174003', + tx_hash = '0x742d35Cc6634C0532925a3b844Bc454e4438f44e', + token_id = 'ETH_USDT', + from_address = '0xF8e4bfc10A2821DF52D3322cB5170E5E9276b537', + to_address = '0x15B95A2D8af95D9F48148667B6b8B3CdF89e4F15', + amount = '0.15', + status = 'Submitted', + counterparty = cobo_waas2.models.counterparty.Counterparty( + counterparty_id = '123e4567-e89b-12d3-a456-426614174003', + counterparty_type = 'Individual', + counterparty_name = 'Counterparty A', + country = 'USA', + email = 'counterparty@example.com', + contact_address = '123 Main St, Anytown, USA', + created_timestamp = 1744689600, + updated_timestamp = 1744689600, ), + destination = cobo_waas2.models.destination.Destination( + destination_id = '123e4567-e89b-12d3-a456-426614174003', + destination_type = 'Individual', + destination_name = 'Destination A', + country = 'USA', + email = 'destination@example.com', + contact_address = '123 Main St, Anytown, USA', + merchant_id = 'M1001', + created_timestamp = 1744689600, + updated_timestamp = 1744689600, ), + created_timestamp = 1610445878970, + updated_timestamp = 1610445878970, ) + ] ) else: return PaymentPayoutEvent( data_type = 'Transaction', payout_id = '123e457-e89b-12d3-a456-426614174004', request_id = '123e457-e89b-12d3-a456-426614174004', + payout_channel = 'Crypto', status = 'Pending', + created_timestamp = 1744689600, + updated_timestamp = 1744689600, ) """ diff --git a/test/test_payment_payout_item.py b/test/test_payment_payout_item.py index 95f71fc9..ef0a2f59 100644 --- a/test/test_payment_payout_item.py +++ b/test/test_payment_payout_item.py @@ -34,50 +34,8 @@ def make_instance(self, include_optional) -> PaymentPayoutItem: model = PaymentPayoutItem() if include_optional: return PaymentPayoutItem( - payout_item_id = '123e457-e89b-12d3-a456-426614174004', - payout_id = '123e457-e89b-12d3-a456-426614174004', token_id = 'ETH_USDT', - chain_id = 'ETH', amount = '500.00', - status = 'Pending', - source_account = 'M1001', - transactions = [ - cobo_waas2.models.payment_transaction.PaymentTransaction( - tx_id = 'tx_123e4567-e89b-12d3-a456-426614174003', - tx_hash = '0x742d35Cc6634C0532925a3b844Bc454e4438f44e', - token_id = 'ETH_USDT', - from_address = '0xF8e4bfc10A2821DF52D3322cB5170E5E9276b537', - to_address = '0x15B95A2D8af95D9F48148667B6b8B3CdF89e4F15', - amount = '0.15', - status = 'Submitted', - counterparty = cobo_waas2.models.counterparty.Counterparty( - counterparty_id = '123e4567-e89b-12d3-a456-426614174003', - counterparty_type = 'Individual', - counterparty_name = 'Counterparty A', - country = 'USA', - email = 'counterparty@example.com', - contact_address = '123 Main St, Anytown, USA', - created_timestamp = 1744689600, - updated_timestamp = 1744689600, ), - destination = cobo_waas2.models.destination.Destination( - destination_id = '123e4567-e89b-12d3-a456-426614174003', - destination_type = 'Individual', - destination_name = 'Destination A', - country = 'USA', - email = 'destination@example.com', - contact_address = '123 Main St, Anytown, USA', - merchant_id = 'M1001', - created_timestamp = 1744689600, - updated_timestamp = 1744689600, ), - created_timestamp = 1610445878970, - updated_timestamp = 1610445878970, ) - ], - created_timestamp = 1744689600, - updated_timestamp = 1744689600, - crypto_address_id = 'addr_ethusdt_20250429T134512_a8c31f', - crypto_address = '0xabc123456789def0000000000000000000000000', - commission_fee = cobo_waas2.models.commission_fee.CommissionFee( - fee_amount = '', ), bridging_fee = cobo_waas2.models.bridging_fee.BridgingFee( fee_amount = '', received_token_id = '', @@ -85,11 +43,8 @@ def make_instance(self, include_optional) -> PaymentPayoutItem: ) else: return PaymentPayoutItem( - payout_item_id = '123e457-e89b-12d3-a456-426614174004', - payout_id = '123e457-e89b-12d3-a456-426614174004', + token_id = 'ETH_USDT', amount = '500.00', - status = 'Pending', - source_account = 'M1001', ) """ diff --git a/test/test_payment_payout_item_detail.py b/test/test_payment_payout_item_detail.py deleted file mode 100644 index f0608493..00000000 --- a/test/test_payment_payout_item_detail.py +++ /dev/null @@ -1,103 +0,0 @@ -# coding: utf-8 - -""" - Cobo Wallet as a Service 2.0 - - Contact: help@cobo.com - Generated by OpenAPI Generator (https://openapi-generator.tech) - - Do not edit the class manually. -""" # noqa: E501 - - -import unittest - -from cobo_waas2.models.payment_payout_item_detail import PaymentPayoutItemDetail - - -class TestPaymentPayoutItemDetail(unittest.TestCase): - """PaymentPayoutItemDetail unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def make_instance(self, include_optional) -> PaymentPayoutItemDetail: - """Test PaymentPayoutItemDetail - include_option is a boolean, when False only required - params are included, when True both required and - optional params are included """ - # uncomment below to create an instance of `PaymentPayoutItemDetail` - """ - model = PaymentPayoutItemDetail() - if include_optional: - return PaymentPayoutItemDetail( - payout_item_id = '123e457-e89b-12d3-a456-426614174004', - payout_id = '123e457-e89b-12d3-a456-426614174004', - token_id = 'ETH_USDT', - chain_id = 'ETH', - source_account = 'M1001', - amount = '500.00', - status = 'Pending', - transactions = [ - cobo_waas2.models.payment_transaction.PaymentTransaction( - tx_id = 'tx_123e4567-e89b-12d3-a456-426614174003', - tx_hash = '0x742d35Cc6634C0532925a3b844Bc454e4438f44e', - token_id = 'ETH_USDT', - from_address = '0xF8e4bfc10A2821DF52D3322cB5170E5E9276b537', - to_address = '0x15B95A2D8af95D9F48148667B6b8B3CdF89e4F15', - amount = '0.15', - status = 'Submitted', - counterparty = cobo_waas2.models.counterparty.Counterparty( - counterparty_id = '123e4567-e89b-12d3-a456-426614174003', - counterparty_type = 'Individual', - counterparty_name = 'Counterparty A', - country = 'USA', - email = 'counterparty@example.com', - contact_address = '123 Main St, Anytown, USA', - created_timestamp = 1744689600, - updated_timestamp = 1744689600, ), - destination = cobo_waas2.models.destination.Destination( - destination_id = '123e4567-e89b-12d3-a456-426614174003', - destination_type = 'Individual', - destination_name = 'Destination A', - country = 'USA', - email = 'destination@example.com', - contact_address = '123 Main St, Anytown, USA', - merchant_id = 'M1001', - created_timestamp = 1744689600, - updated_timestamp = 1744689600, ), - created_timestamp = 1610445878970, - updated_timestamp = 1610445878970, ) - ], - created_timestamp = 1744689600, - updated_timestamp = 1744689600, - crypto_address_id = 'addr_ethusdt_20250429T134512_a8c31f', - crypto_address = '0xabc123456789def0000000000000000000000000', - commission_fee = cobo_waas2.models.commission_fee.CommissionFee( - fee_amount = '', ), - bridging_fee = cobo_waas2.models.bridging_fee.BridgingFee( - fee_amount = '', - received_token_id = '', - received_amount = '', ) - ) - else: - return PaymentPayoutItemDetail( - payout_item_id = '123e457-e89b-12d3-a456-426614174004', - payout_id = '123e457-e89b-12d3-a456-426614174004', - source_account = 'M1001', - amount = '500.00', - status = 'Pending', - ) - """ - - def testPaymentPayoutItemDetail(self): - """Test PaymentPayoutItemDetail""" - # inst_req_only = self.make_instance(include_optional=False) - # inst_req_and_optional = self.make_instance(include_optional=True) - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_payment_payout_param.py b/test/test_payment_payout_param.py index 12b7aa98..a870cfba 100644 --- a/test/test_payment_payout_param.py +++ b/test/test_payment_payout_param.py @@ -34,15 +34,11 @@ def make_instance(self, include_optional) -> PaymentPayoutParam: model = PaymentPayoutParam() if include_optional: return PaymentPayoutParam( - source_account = 'M1001', token_id = 'ETH_USDT', - amount = '500.00', - crypto_address_id = 'addr_ethusdt_20250506T123456_ab12cd', - crypto_address = '0xabc123456789def0000000000000000000000000' + amount = '500.00' ) else: return PaymentPayoutParam( - source_account = 'M1001', token_id = 'ETH_USDT', amount = '500.00', ) diff --git a/test/test_payment_payout_recipient_info.py b/test/test_payment_payout_recipient_info.py new file mode 100644 index 00000000..e56296fd --- /dev/null +++ b/test/test_payment_payout_recipient_info.py @@ -0,0 +1,54 @@ +# coding: utf-8 + +""" + Cobo Wallet as a Service 2.0 + + Contact: help@cobo.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from cobo_waas2.models.payment_payout_recipient_info import PaymentPayoutRecipientInfo + + +class TestPaymentPayoutRecipientInfo(unittest.TestCase): + """PaymentPayoutRecipientInfo unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> PaymentPayoutRecipientInfo: + """Test PaymentPayoutRecipientInfo + include_option is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `PaymentPayoutRecipientInfo` + """ + model = PaymentPayoutRecipientInfo() + if include_optional: + return PaymentPayoutRecipientInfo( + address = '0x9876543210abcdef1234567890abcdef12345678', + token_id = 'TRON_USDT', + currency = 'USD', + bank_account_id = '123e4567-e89b-12d3-a456-426614174003' + ) + else: + return PaymentPayoutRecipientInfo( + ) + """ + + def testPaymentPayoutRecipientInfo(self): + """Test PaymentPayoutRecipientInfo""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_swaps_api.py b/test/test_swaps_api.py index f04b7bba..f004465e 100644 --- a/test/test_swaps_api.py +++ b/test/test_swaps_api.py @@ -88,6 +88,7 @@ def test_list_swap_activities(self) -> None: List swap activities """ """ + request_id = 'web_send_by_user_327_1610444045047' type = cobo_waas2.SwapType() status = cobo_waas2.SwapActivityStatus() min_updated_timestamp = 1635744000000 @@ -99,7 +100,7 @@ def test_list_swap_activities(self) -> None: sort_by = 'created_timestamp' direction = 'ASC' - api_response = self.api.list_swap_activities(type=type, status=status, min_updated_timestamp=min_updated_timestamp, max_updated_timestamp=max_updated_timestamp, initiator=initiator, limit=limit, before=before, after=after, sort_by=sort_by, direction=direction) + api_response = self.api.list_swap_activities(request_id=request_id, type=type, status=status, min_updated_timestamp=min_updated_timestamp, max_updated_timestamp=max_updated_timestamp, initiator=initiator, limit=limit, before=before, after=after, sort_by=sort_by, direction=direction) """ def test_list_swap_enabled_tokens(self) -> None: diff --git a/test/test_transaction_wallet_connect_info.py b/test/test_transaction_wallet_connect_info.py new file mode 100644 index 00000000..49a8b787 --- /dev/null +++ b/test/test_transaction_wallet_connect_info.py @@ -0,0 +1,55 @@ +# coding: utf-8 + +""" + Cobo Wallet as a Service 2.0 + + Contact: help@cobo.com + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +import unittest + +from cobo_waas2.models.transaction_wallet_connect_info import TransactionWalletConnectInfo + + +class TestTransactionWalletConnectInfo(unittest.TestCase): + """TransactionWalletConnectInfo unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> TransactionWalletConnectInfo: + """Test TransactionWalletConnectInfo + include_option is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # uncomment below to create an instance of `TransactionWalletConnectInfo` + """ + model = TransactionWalletConnectInfo() + if include_optional: + return TransactionWalletConnectInfo( + extra_type = 'BabylonBusinessInfo', + dapp_name = '', + dapp_domain = '', + session_id = '' + ) + else: + return TransactionWalletConnectInfo( + extra_type = 'BabylonBusinessInfo', + ) + """ + + def testTransactionWalletConnectInfo(self): + """Test TransactionWalletConnectInfo""" + # inst_req_only = self.make_instance(include_optional=False) + # inst_req_and_optional = self.make_instance(include_optional=True) + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_webhook_event_data.py b/test/test_webhook_event_data.py index 0bd389a9..b85ea82d 100644 --- a/test/test_webhook_event_data.py +++ b/test/test_webhook_event_data.py @@ -85,7 +85,7 @@ def make_instance(self, include_optional) -> WebhookEventData: category = [ 'Payment' ], - description = 'withdrawal to exchange trading account', + description = 'Monthly vendor payments - January 2024', is_loop = False, cobo_category = [ 'AutoFueling' @@ -314,58 +314,25 @@ def make_instance(self, include_optional) -> WebhookEventData: previous_address = '0xAbC123...DEF', updated_address = '0x789xyz...456', payout_id = '123e457-e89b-12d3-a456-426614174004', - payout_item_details = [ - cobo_waas2.models.payment_payout_item_detail.PaymentPayoutItemDetail( - payout_item_id = '123e457-e89b-12d3-a456-426614174004', - payout_id = '123e457-e89b-12d3-a456-426614174004', + source_account = 'M1001', + payout_items = [ + cobo_waas2.models.payment_payout_item.PaymentPayoutItem( token_id = 'ETH_USDT', - chain_id = 'ETH', - source_account = 'M1001', amount = '500.00', - status = 'Pending', - transactions = [ - cobo_waas2.models.payment_transaction.PaymentTransaction( - tx_id = 'tx_123e4567-e89b-12d3-a456-426614174003', - tx_hash = '0x742d35Cc6634C0532925a3b844Bc454e4438f44e', - token_id = 'ETH_USDT', - from_address = '0xF8e4bfc10A2821DF52D3322cB5170E5E9276b537', - to_address = '0x15B95A2D8af95D9F48148667B6b8B3CdF89e4F15', - amount = '0.15', - status = 'Submitted', - counterparty = cobo_waas2.models.counterparty.Counterparty( - counterparty_id = '123e4567-e89b-12d3-a456-426614174003', - counterparty_type = 'Individual', - counterparty_name = 'Counterparty A', - country = 'USA', - email = 'counterparty@example.com', - contact_address = '123 Main St, Anytown, USA', - created_timestamp = 1744689600, - updated_timestamp = 1744689600, ), - destination = cobo_waas2.models.destination.Destination( - destination_id = '123e4567-e89b-12d3-a456-426614174003', - destination_type = 'Individual', - destination_name = 'Destination A', - country = 'USA', - email = 'destination@example.com', - contact_address = '123 Main St, Anytown, USA', - merchant_id = 'M1001', - created_timestamp = 1744689600, - updated_timestamp = 1744689600, ), - created_timestamp = 1610445878970, - updated_timestamp = 1610445878970, ) - ], - created_timestamp = 1744689600, - updated_timestamp = 1744689600, - crypto_address_id = 'addr_ethusdt_20250429T134512_a8c31f', - crypto_address = '0xabc123456789def0000000000000000000000000', - commission_fee = cobo_waas2.models.commission_fee.CommissionFee( - fee_amount = '', ), bridging_fee = cobo_waas2.models.bridging_fee.BridgingFee( fee_amount = '', received_token_id = '', received_amount = '', ), ) ], + recipient_info = cobo_waas2.models.payment_payout_recipient_info.PaymentPayoutRecipientInfo( + address = '0x9876543210abcdef1234567890abcdef12345678', + token_id = 'TRON_USDT', + currency = 'USD', + bank_account_id = '123e4567-e89b-12d3-a456-426614174003', ), actual_payout_amount = '500.00', + remark = 'Payout for customer 123', + bulk_send_id = '123e4567-e89b-12d3-a456-426614174003', + execution_mode = 'Strict', disposition_type = 'Refund', disposition_status = 'Submitted', destination_address = '0x742d35Cc6634C0532925a3b844Bc9e7595f0bEb7', @@ -504,12 +471,16 @@ def make_instance(self, include_optional) -> WebhookEventData: received_amount = '', ), ) ], acquiring_type = 'Order', + payout_channel = 'Crypto', payer_id = 'P20250619T0310056d7aa', custom_payer_id = 'user_abc_10001', chain = 'ETH', previous_address = '0xAbC123...DEF', updated_address = '0x789xyz...456', payout_id = '123e457-e89b-12d3-a456-426614174004', + source_account = 'M1001', + bulk_send_id = '123e4567-e89b-12d3-a456-426614174003', + execution_mode = 'Strict', disposition_type = 'Refund', disposition_status = 'Submitted', transaction_type = 'Deposit',