diff --git a/.openapi-generator/FILES b/.openapi-generator/FILES index 602afb2e..6f13fceb 100644 --- a/.openapi-generator/FILES +++ b/.openapi-generator/FILES @@ -373,6 +373,7 @@ cobo_waas2/models/list_merchant_balances200_response.py cobo_waas2/models/list_merchants200_response.py cobo_waas2/models/list_mpc_projects200_response.py cobo_waas2/models/list_mpc_vaults200_response.py +cobo_waas2/models/list_payer_transactions200_response.py cobo_waas2/models/list_payment_orders200_response.py cobo_waas2/models/list_payment_wallet_balances200_response.py cobo_waas2/models/list_payouts200_response.py @@ -434,6 +435,7 @@ cobo_waas2/models/order_link_business_info_custom_exchange_rates_inner.py cobo_waas2/models/order_link_business_info_payable_amounts_inner.py cobo_waas2/models/order_status.py cobo_waas2/models/org_info.py +cobo_waas2/models/original_main_group_handling.py cobo_waas2/models/otc_fee.py cobo_waas2/models/pagination.py cobo_waas2/models/payer_account.py @@ -813,7 +815,6 @@ cobo_waas2/models/tss_signatures.py cobo_waas2/models/tss_status.py cobo_waas2/models/unfreeze_disposition.py cobo_waas2/models/update_address_book_param.py -cobo_waas2/models/update_bank_account_by_id_request.py cobo_waas2/models/update_counterparty_request.py cobo_waas2/models/update_custodial_wallet_params.py cobo_waas2/models/update_destination_bank_account.py @@ -1198,6 +1199,7 @@ docs/ListMerchantBalances200Response.md docs/ListMerchants200Response.md docs/ListMpcProjects200Response.md docs/ListMpcVaults200Response.md +docs/ListPayerTransactions200Response.md docs/ListPaymentOrders200Response.md docs/ListPaymentWalletBalances200Response.md docs/ListPayouts200Response.md @@ -1261,6 +1263,7 @@ docs/OrderLinkBusinessInfoPayableAmountsInner.md docs/OrderStatus.md docs/OrgInfo.md docs/OrganizationsApi.md +docs/OriginalMainGroupHandling.md docs/OtcFee.md docs/Pagination.md docs/PayerAccount.md @@ -1648,7 +1651,6 @@ docs/TronContractCallDestination.md docs/UTXO.md docs/UnfreezeDisposition.md docs/UpdateAddressBookParam.md -docs/UpdateBankAccountByIdRequest.md docs/UpdateCounterpartyRequest.md docs/UpdateCustodialWalletParams.md docs/UpdateDestinationBankAccount.md @@ -2040,6 +2042,7 @@ test/test_list_merchant_balances200_response.py test/test_list_merchants200_response.py test/test_list_mpc_projects200_response.py test/test_list_mpc_vaults200_response.py +test/test_list_payer_transactions200_response.py test/test_list_payment_orders200_response.py test/test_list_payment_wallet_balances200_response.py test/test_list_payouts200_response.py @@ -2103,6 +2106,7 @@ test/test_order_link_business_info_payable_amounts_inner.py test/test_order_status.py test/test_org_info.py test/test_organizations_api.py +test/test_original_main_group_handling.py test/test_otc_fee.py test/test_pagination.py test/test_payer_account.py @@ -2489,7 +2493,6 @@ test/test_tss_signatures.py test/test_tss_status.py test/test_unfreeze_disposition.py test/test_update_address_book_param.py -test/test_update_bank_account_by_id_request.py test/test_update_counterparty_request.py test/test_update_custodial_wallet_params.py test/test_update_destination_bank_account.py diff --git a/README.md b/README.md index 71fd8d83..d19a2490 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.34.0 +- Package version: 1.35.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.34.0 +pip install cobo-waas2==1.35.0 ``` Then import the package: @@ -172,7 +172,6 @@ Class | Method | HTTP request | Description *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_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 @@ -183,6 +182,7 @@ Class | Method | HTTP request | Description *PaymentApi* | [**list_forced_sweep_requests**](docs/PaymentApi.md#list_forced_sweep_requests) | **GET** /payments/force_sweep_requests | List forced sweeps *PaymentApi* | [**list_merchant_balances**](docs/PaymentApi.md#list_merchant_balances) | **GET** /payments/balance/merchants | List merchant balances *PaymentApi* | [**list_merchants**](docs/PaymentApi.md#list_merchants) | **GET** /payments/merchants | List all merchants +*PaymentApi* | [**list_payer_transactions**](docs/PaymentApi.md#list_payer_transactions) | **GET** /payments/topup/payers/transactions | List payer transactions *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 supported tokens *PaymentApi* | [**list_payment_wallet_balances**](docs/PaymentApi.md#list_payment_wallet_balances) | **GET** /payments/balance/payment_wallets | List payment wallet balances @@ -193,7 +193,6 @@ Class | Method | HTTP request | Description *PaymentApi* | [**list_top_up_payers**](docs/PaymentApi.md#list_top_up_payers) | **GET** /payments/topup/payers | List payers *PaymentApi* | [**payment_estimate_fee**](docs/PaymentApi.md#payment_estimate_fee) | **POST** /payments/estimate_fee | Estimate fees *PaymentApi* | [**trigger_test_payments_webhook_event**](docs/PaymentApi.md#trigger_test_payments_webhook_event) | **POST** /payments/webhooks/trigger | Trigger test webhook event -*PaymentApi* | [**update_bank_account_by_id**](docs/PaymentApi.md#update_bank_account_by_id) | **PUT** /payments/bank_accounts/{bank_account_id} | Update bank account *PaymentApi* | [**update_counterparty**](docs/PaymentApi.md#update_counterparty) | **PUT** /payments/counterparty/{counterparty_id} | Update counterparty *PaymentApi* | [**update_destination**](docs/PaymentApi.md#update_destination) | **PUT** /payments/destination/{destination_id} | Update destination *PaymentApi* | [**update_destination_entry**](docs/PaymentApi.md#update_destination_entry) | **PUT** /payments/destination_entry/{destination_entry_id} | Update destination entry @@ -671,6 +670,7 @@ Class | Method | HTTP request | Description - [ListMerchants200Response](docs/ListMerchants200Response.md) - [ListMpcProjects200Response](docs/ListMpcProjects200Response.md) - [ListMpcVaults200Response](docs/ListMpcVaults200Response.md) + - [ListPayerTransactions200Response](docs/ListPayerTransactions200Response.md) - [ListPaymentOrders200Response](docs/ListPaymentOrders200Response.md) - [ListPaymentWalletBalances200Response](docs/ListPaymentWalletBalances200Response.md) - [ListPayouts200Response](docs/ListPayouts200Response.md) @@ -732,6 +732,7 @@ Class | Method | HTTP request | Description - [OrderLinkBusinessInfoPayableAmountsInner](docs/OrderLinkBusinessInfoPayableAmountsInner.md) - [OrderStatus](docs/OrderStatus.md) - [OrgInfo](docs/OrgInfo.md) + - [OriginalMainGroupHandling](docs/OriginalMainGroupHandling.md) - [OtcFee](docs/OtcFee.md) - [Pagination](docs/Pagination.md) - [PayerAccount](docs/PayerAccount.md) @@ -1112,7 +1113,6 @@ Class | Method | HTTP request | Description - [UTXO](docs/UTXO.md) - [UnfreezeDisposition](docs/UnfreezeDisposition.md) - [UpdateAddressBookParam](docs/UpdateAddressBookParam.md) - - [UpdateBankAccountByIdRequest](docs/UpdateBankAccountByIdRequest.md) - [UpdateCounterpartyRequest](docs/UpdateCounterpartyRequest.md) - [UpdateCustodialWalletParams](docs/UpdateCustodialWalletParams.md) - [UpdateDestinationBankAccount](docs/UpdateDestinationBankAccount.md) diff --git a/cobo_waas2/__init__.py b/cobo_waas2/__init__.py index 1c9b0dcc..44dca1e2 100644 --- a/cobo_waas2/__init__.py +++ b/cobo_waas2/__init__.py @@ -12,7 +12,7 @@ """ # noqa: E501 -__version__ = "1.34.0" +__version__ = "1.35.0" # import apis into sdk package from cobo_waas2.api.address_books_api import AddressBooksApi @@ -385,6 +385,7 @@ from cobo_waas2.models.list_merchants200_response import ListMerchants200Response from cobo_waas2.models.list_mpc_projects200_response import ListMpcProjects200Response from cobo_waas2.models.list_mpc_vaults200_response import ListMpcVaults200Response +from cobo_waas2.models.list_payer_transactions200_response import ListPayerTransactions200Response 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_payouts200_response import ListPayouts200Response @@ -446,6 +447,7 @@ from cobo_waas2.models.order_link_business_info_payable_amounts_inner import OrderLinkBusinessInfoPayableAmountsInner from cobo_waas2.models.order_status import OrderStatus from cobo_waas2.models.org_info import OrgInfo +from cobo_waas2.models.original_main_group_handling import OriginalMainGroupHandling from cobo_waas2.models.otc_fee import OtcFee from cobo_waas2.models.pagination import Pagination from cobo_waas2.models.payer_account import PayerAccount @@ -826,7 +828,6 @@ from cobo_waas2.models.utxo import UTXO from cobo_waas2.models.unfreeze_disposition import UnfreezeDisposition from cobo_waas2.models.update_address_book_param import UpdateAddressBookParam -from cobo_waas2.models.update_bank_account_by_id_request import UpdateBankAccountByIdRequest from cobo_waas2.models.update_counterparty_request import UpdateCounterpartyRequest from cobo_waas2.models.update_custodial_wallet_params import UpdateCustodialWalletParams from cobo_waas2.models.update_destination_bank_account import UpdateDestinationBankAccount diff --git a/cobo_waas2/api/payment_api.py b/cobo_waas2/api/payment_api.py index 9e7e301b..7c63474a 100644 --- a/cobo_waas2/api/payment_api.py +++ b/cobo_waas2/api/payment_api.py @@ -17,7 +17,6 @@ from typing import List, Optional from typing_extensions import Annotated from cobo_waas2.models.acquiring_type import AcquiringType -from cobo_waas2.models.bank_account import BankAccount from cobo_waas2.models.bank_account_status import BankAccountStatus from cobo_waas2.models.batch_allocation import BatchAllocation from cobo_waas2.models.batch_allocation_detail import BatchAllocationDetail @@ -73,6 +72,7 @@ from cobo_waas2.models.list_forced_sweep_requests200_response import ListForcedSweepRequests200Response from cobo_waas2.models.list_merchant_balances200_response import ListMerchantBalances200Response from cobo_waas2.models.list_merchants200_response import ListMerchants200Response +from cobo_waas2.models.list_payer_transactions200_response import ListPayerTransactions200Response 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_payouts200_response import ListPayouts200Response @@ -98,7 +98,6 @@ from cobo_waas2.models.top_up_address import TopUpAddress from cobo_waas2.models.trigger_test_payment_webhook_event_response import TriggerTestPaymentWebhookEventResponse from cobo_waas2.models.trigger_test_payments_webhook_event_request import TriggerTestPaymentsWebhookEventRequest -from cobo_waas2.models.update_bank_account_by_id_request import UpdateBankAccountByIdRequest from cobo_waas2.models.update_counterparty_request import UpdateCounterpartyRequest from cobo_waas2.models.update_destination_entry200_response import UpdateDestinationEntry200Response from cobo_waas2.models.update_destination_entry_request import UpdateDestinationEntryRequest @@ -7432,7 +7431,7 @@ def _get_settlement_info_by_ids_serialize( def get_top_up_address( 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` ")], - custom_payer_id: Annotated[StrictStr, Field(description="A unique identifier to track and identify individual payers in your system.")], + custom_payer_id: Annotated[StrictStr, Field(description="Unique customer identifier on the merchant side, used to allocate a dedicated top-up address ")], merchant_id: Annotated[Optional[StrictStr], Field(description="The merchant ID.")] = None, _request_timeout: Union[ None, @@ -7449,7 +7448,7 @@ def get_top_up_address( :param token_id: 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` (required) :type token_id: str - :param custom_payer_id: A unique identifier to track and identify individual payers in your system. (required) + :param custom_payer_id: Unique customer identifier on the merchant side, used to allocate a dedicated top-up address (required) :type custom_payer_id: str :param merchant_id: The merchant ID. :type merchant_id: str @@ -7486,7 +7485,7 @@ def get_top_up_address( def get_top_up_address_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` ")], - custom_payer_id: Annotated[StrictStr, Field(description="A unique identifier to track and identify individual payers in your system.")], + custom_payer_id: Annotated[StrictStr, Field(description="Unique customer identifier on the merchant side, used to allocate a dedicated top-up address ")], merchant_id: Annotated[Optional[StrictStr], Field(description="The merchant ID.")] = None, _request_timeout: Union[ None, @@ -7503,7 +7502,7 @@ def get_top_up_address_with_http_info( :param token_id: 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` (required) :type token_id: str - :param custom_payer_id: A unique identifier to track and identify individual payers in your system. (required) + :param custom_payer_id: Unique customer identifier on the merchant side, used to allocate a dedicated top-up address (required) :type custom_payer_id: str :param merchant_id: The merchant ID. :type merchant_id: str @@ -7540,7 +7539,7 @@ def get_top_up_address_with_http_info( def get_top_up_address_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` ")], - custom_payer_id: Annotated[StrictStr, Field(description="A unique identifier to track and identify individual payers in your system.")], + custom_payer_id: Annotated[StrictStr, Field(description="Unique customer identifier on the merchant side, used to allocate a dedicated top-up address ")], merchant_id: Annotated[Optional[StrictStr], Field(description="The merchant ID.")] = None, _request_timeout: Union[ None, @@ -7557,7 +7556,7 @@ def get_top_up_address_without_preload_content( :param token_id: 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` (required) :type token_id: str - :param custom_payer_id: A unique identifier to track and identify individual payers in your system. (required) + :param custom_payer_id: Unique customer identifier on the merchant side, used to allocate a dedicated top-up address (required) :type custom_payer_id: str :param merchant_id: The merchant ID. :type merchant_id: str @@ -7906,160 +7905,6 @@ def _list_allocation_items_serialize( files=_files, ) - @validate_call - def list_bank_accounts( - self, - _request_timeout: Union[ - None, - Annotated[StrictFloat, Field(gt=0)], - Tuple[ - Annotated[StrictFloat, Field(gt=0)], - Annotated[StrictFloat, Field(gt=0)] - ] - ] = None, - ) -> List[BankAccount]: - """List all bank accounts - - 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 - 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_bank_accounts_serialize( - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "List[BankAccount]", - '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_bank_accounts_with_http_info( - self, - _request_timeout: Union[ - None, - Annotated[StrictFloat, Field(gt=0)], - Tuple[ - Annotated[StrictFloat, Field(gt=0)], - Annotated[StrictFloat, Field(gt=0)] - ] - ] = None, - ) -> ApiResponse[List[BankAccount]]: - """List all bank accounts - - 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 - 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_bank_accounts_serialize( - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "List[BankAccount]", - '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_bank_accounts_without_preload_content( - self, - _request_timeout: Union[ - None, - Annotated[StrictFloat, Field(gt=0)], - Tuple[ - Annotated[StrictFloat, Field(gt=0)], - Annotated[StrictFloat, Field(gt=0)] - ] - ] = None, - ) -> RESTResponseType: - """List all bank accounts - - 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 - 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_bank_accounts_serialize( - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "List[BankAccount]", - '4XX': "ErrorResponse", - '5XX': "ErrorResponse", - } - response_data = self.api_client.call_api( - *_param, - _request_timeout=_request_timeout - ) - return response_data.response - - def _list_bank_accounts_serialize( - self, - ) -> 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 - - # 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/bank_accounts', - 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_batch_allocations( self, @@ -10465,6 +10310,296 @@ def _list_merchants_serialize( files=_files, ) + @validate_call + def list_payer_transactions( + self, + custom_payer_id: Annotated[StrictStr, Field(description="Unique customer identifier on the merchant side, used to allocate a dedicated top-up address ")], + 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, + merchant_id: Annotated[Optional[StrictStr], Field(description="The merchant ID.")] = None, + token_id: Annotated[Optional[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` ")] = None, + transaction_hashes: Annotated[Optional[StrictStr], Field(description="A list of transaction hashes, separated by comma.")] = None, + transaction_ids: Annotated[Optional[StrictStr], Field(description="A list of transaction IDs, separated by comma.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + ) -> ListPayerTransactions200Response: + """List payer transactions + + This operation retrieves on-chain transactions related to a specific top-up payer. You need to specify `custom_payer_id`, which is the merchant-defined customer identifier used when creating top-up addresses. This operation is applicable to the top-up scenario only. For more information, see [Cobo Payments Guide](https://www.cobo.com/payments/en/guides/overview). + + :param custom_payer_id: Unique customer identifier on the merchant side, used to allocate a dedicated top-up address (required) + :type custom_payer_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 merchant_id: The merchant ID. + :type merchant_id: str + :param token_id: 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` + :type token_id: str + :param transaction_hashes: A list of transaction hashes, separated by comma. + :type transaction_hashes: str + :param transaction_ids: A list of transaction IDs, separated by comma. + :type transaction_ids: 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_payer_transactions_serialize( + custom_payer_id=custom_payer_id, + limit=limit, + before=before, + after=after, + merchant_id=merchant_id, + token_id=token_id, + transaction_hashes=transaction_hashes, + transaction_ids=transaction_ids, + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ListPayerTransactions200Response", + '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_payer_transactions_with_http_info( + self, + custom_payer_id: Annotated[StrictStr, Field(description="Unique customer identifier on the merchant side, used to allocate a dedicated top-up address ")], + 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, + merchant_id: Annotated[Optional[StrictStr], Field(description="The merchant ID.")] = None, + token_id: Annotated[Optional[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` ")] = None, + transaction_hashes: Annotated[Optional[StrictStr], Field(description="A list of transaction hashes, separated by comma.")] = None, + transaction_ids: Annotated[Optional[StrictStr], Field(description="A list of transaction IDs, separated by comma.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + ) -> ApiResponse[ListPayerTransactions200Response]: + """List payer transactions + + This operation retrieves on-chain transactions related to a specific top-up payer. You need to specify `custom_payer_id`, which is the merchant-defined customer identifier used when creating top-up addresses. This operation is applicable to the top-up scenario only. For more information, see [Cobo Payments Guide](https://www.cobo.com/payments/en/guides/overview). + + :param custom_payer_id: Unique customer identifier on the merchant side, used to allocate a dedicated top-up address (required) + :type custom_payer_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 merchant_id: The merchant ID. + :type merchant_id: str + :param token_id: 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` + :type token_id: str + :param transaction_hashes: A list of transaction hashes, separated by comma. + :type transaction_hashes: str + :param transaction_ids: A list of transaction IDs, separated by comma. + :type transaction_ids: 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_payer_transactions_serialize( + custom_payer_id=custom_payer_id, + limit=limit, + before=before, + after=after, + merchant_id=merchant_id, + token_id=token_id, + transaction_hashes=transaction_hashes, + transaction_ids=transaction_ids, + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ListPayerTransactions200Response", + '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_payer_transactions_without_preload_content( + self, + custom_payer_id: Annotated[StrictStr, Field(description="Unique customer identifier on the merchant side, used to allocate a dedicated top-up address ")], + 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, + merchant_id: Annotated[Optional[StrictStr], Field(description="The merchant ID.")] = None, + token_id: Annotated[Optional[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` ")] = None, + transaction_hashes: Annotated[Optional[StrictStr], Field(description="A list of transaction hashes, separated by comma.")] = None, + transaction_ids: Annotated[Optional[StrictStr], Field(description="A list of transaction IDs, separated by comma.")] = None, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + ) -> RESTResponseType: + """List payer transactions + + This operation retrieves on-chain transactions related to a specific top-up payer. You need to specify `custom_payer_id`, which is the merchant-defined customer identifier used when creating top-up addresses. This operation is applicable to the top-up scenario only. For more information, see [Cobo Payments Guide](https://www.cobo.com/payments/en/guides/overview). + + :param custom_payer_id: Unique customer identifier on the merchant side, used to allocate a dedicated top-up address (required) + :type custom_payer_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 merchant_id: The merchant ID. + :type merchant_id: str + :param token_id: 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` + :type token_id: str + :param transaction_hashes: A list of transaction hashes, separated by comma. + :type transaction_hashes: str + :param transaction_ids: A list of transaction IDs, separated by comma. + :type transaction_ids: 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_payer_transactions_serialize( + custom_payer_id=custom_payer_id, + limit=limit, + before=before, + after=after, + merchant_id=merchant_id, + token_id=token_id, + transaction_hashes=transaction_hashes, + transaction_ids=transaction_ids, + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ListPayerTransactions200Response", + '4XX': "ErrorResponse", + '5XX': "ErrorResponse", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + def _list_payer_transactions_serialize( + self, + custom_payer_id, + limit, + before, + after, + merchant_id, + token_id, + transaction_hashes, + transaction_ids, + ) -> 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 merchant_id is not None: + + _query_params.append(('merchant_id', merchant_id)) + + if custom_payer_id is not None: + + _query_params.append(('custom_payer_id', custom_payer_id)) + + if token_id is not None: + + _query_params.append(('token_id', token_id)) + + if transaction_hashes is not None: + + _query_params.append(('transaction_hashes', transaction_hashes)) + + if transaction_ids is not None: + + _query_params.append(('transaction_ids', transaction_ids)) + + # 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/topup/payers/transactions', + 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_payment_orders( self, @@ -12004,7 +12139,7 @@ def list_top_up_payers( ) -> ListTopUpPayers200Response: """List payers - This operation retrieves the information of all payers under a merchant. You can filter the result by the payer ID. + This operation retrieves the information of all payers. You can filter the result by merchant ID and payer_id. The `transactions` field in the response returns up to the latest 200 transactions only. This field will be removed in a future version. To paginate through payer transactions, use [List payer transactions](https://www.cobo.com/payments/en/guides/overview). :param limit: The maximum number of objects to return. For most operations, the value range is [1, 50]. :type limit: int @@ -12066,7 +12201,7 @@ def list_top_up_payers_with_http_info( ) -> ApiResponse[ListTopUpPayers200Response]: """List payers - This operation retrieves the information of all payers under a merchant. You can filter the result by the payer ID. + This operation retrieves the information of all payers. You can filter the result by merchant ID and payer_id. The `transactions` field in the response returns up to the latest 200 transactions only. This field will be removed in a future version. To paginate through payer transactions, use [List payer transactions](https://www.cobo.com/payments/en/guides/overview). :param limit: The maximum number of objects to return. For most operations, the value range is [1, 50]. :type limit: int @@ -12128,7 +12263,7 @@ def list_top_up_payers_without_preload_content( ) -> RESTResponseType: """List payers - This operation retrieves the information of all payers under a merchant. You can filter the result by the payer ID. + This operation retrieves the information of all payers. You can filter the result by merchant ID and payer_id. The `transactions` field in the response returns up to the latest 200 transactions only. This field will be removed in a future version. To paginate through payer transactions, use [List payer transactions](https://www.cobo.com/payments/en/guides/overview). :param limit: The maximum number of objects to return. For most operations, the value range is [1, 50]. :type limit: int @@ -12562,190 +12697,6 @@ def _trigger_test_payments_webhook_event_serialize( files=_files, ) - @validate_call - def update_bank_account_by_id( - self, - bank_account_id: Annotated[StrictStr, Field(description="The bank account ID.")], - update_bank_account_by_id_request: Annotated[Optional[UpdateBankAccountByIdRequest], Field(description="The request body for updating an existing bank account.")] = None, - _request_timeout: Union[ - None, - Annotated[StrictFloat, Field(gt=0)], - Tuple[ - Annotated[StrictFloat, Field(gt=0)], - Annotated[StrictFloat, Field(gt=0)] - ] - ] = None, - ) -> BankAccount: - """Update bank account - - This operation has been deprecated. This operation updates the information of an existing bank account. - - :param bank_account_id: The bank account ID. (required) - :type bank_account_id: str - :param update_bank_account_by_id_request: The request body for updating an existing bank account. - :type update_bank_account_by_id_request: UpdateBankAccountByIdRequest - :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._update_bank_account_by_id_serialize( - bank_account_id=bank_account_id, - update_bank_account_by_id_request=update_bank_account_by_id_request, - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "BankAccount", - '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 update_bank_account_by_id_with_http_info( - self, - bank_account_id: Annotated[StrictStr, Field(description="The bank account ID.")], - update_bank_account_by_id_request: Annotated[Optional[UpdateBankAccountByIdRequest], Field(description="The request body for updating an existing bank account.")] = None, - _request_timeout: Union[ - None, - Annotated[StrictFloat, Field(gt=0)], - Tuple[ - Annotated[StrictFloat, Field(gt=0)], - Annotated[StrictFloat, Field(gt=0)] - ] - ] = None, - ) -> ApiResponse[BankAccount]: - """Update bank account - - This operation has been deprecated. This operation updates the information of an existing bank account. - - :param bank_account_id: The bank account ID. (required) - :type bank_account_id: str - :param update_bank_account_by_id_request: The request body for updating an existing bank account. - :type update_bank_account_by_id_request: UpdateBankAccountByIdRequest - :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._update_bank_account_by_id_serialize( - bank_account_id=bank_account_id, - update_bank_account_by_id_request=update_bank_account_by_id_request, - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "BankAccount", - '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 update_bank_account_by_id_without_preload_content( - self, - bank_account_id: Annotated[StrictStr, Field(description="The bank account ID.")], - update_bank_account_by_id_request: Annotated[Optional[UpdateBankAccountByIdRequest], Field(description="The request body for updating an existing bank account.")] = None, - _request_timeout: Union[ - None, - Annotated[StrictFloat, Field(gt=0)], - Tuple[ - Annotated[StrictFloat, Field(gt=0)], - Annotated[StrictFloat, Field(gt=0)] - ] - ] = None, - ) -> RESTResponseType: - """Update bank account - - This operation has been deprecated. This operation updates the information of an existing bank account. - - :param bank_account_id: The bank account ID. (required) - :type bank_account_id: str - :param update_bank_account_by_id_request: The request body for updating an existing bank account. - :type update_bank_account_by_id_request: UpdateBankAccountByIdRequest - :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._update_bank_account_by_id_serialize( - bank_account_id=bank_account_id, - update_bank_account_by_id_request=update_bank_account_by_id_request, - ) - - _response_types_map: Dict[str, Optional[str]] = { - '200': "BankAccount", - '4XX': "ErrorResponse", - '5XX': "ErrorResponse", - } - response_data = self.api_client.call_api( - *_param, - _request_timeout=_request_timeout - ) - return response_data.response - - def _update_bank_account_by_id_serialize( - self, - bank_account_id, - update_bank_account_by_id_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 - if bank_account_id is not None: - _path_params['bank_account_id'] = bank_account_id - # process the query parameters - # process the header parameters - # process the form parameters - # process the body parameter - if update_bank_account_by_id_request is not None: - _body_params = update_bank_account_by_id_request - - # set the HTTP header `Accept` - _header_params = { - "Accept": "application/json", - "Content-Type": "application/json" - } - - return self.api_client.param_serialize( - method='PUT', - resource_path='/payments/bank_accounts/{bank_account_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 update_counterparty( self, diff --git a/cobo_waas2/api_client.py b/cobo_waas2/api_client.py index fb2e1601..dec2909f 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.34.0' + self.user_agent = 'cobo-waas2-python-sdk/1.35.0' def __enter__(self): return self @@ -247,10 +247,27 @@ def response_deserialize( :param response_types_map: dict of response types. :return: ApiResponse """ + msg = "RESTResponse.read() must be called before passing it to response_deserialize()" + assert response_data.data is not None, msg + headers = response_data.getheaders() sig = headers.get('biz-resp-signature') timestamp = headers.get('biz-timestamp') if not sig or not timestamp: + # Responses from proxy (e.g. nginx) may lack signature headers + # since the request never reaches the business server. + proxy_errors = { + 414: "Request-URI Too Large", + 429: "Too Many Requests", + 502: "Bad Gateway", + 503: "Service Unavailable", + } + if response_data.status in proxy_errors: + raise ApiException( + status=response_data.status, + reason=proxy_errors[response_data.status], + http_resp=response_data, + ) raise ApiException("Missing resp signature or timestamp") verified = SignHelper.verify( pub_key=self.configuration.resp_pubkey, @@ -260,9 +277,6 @@ def response_deserialize( if not verified: raise ApiException("Invalid resp signature") - msg = "RESTResponse.read() must be called before passing it to response_deserialize()" - assert response_data.data is not None, msg - response_type = response_types_map.get(str(response_data.status), None) if not response_type and isinstance(response_data.status, int) and 100 <= response_data.status <= 599: # if not found, look for '1XX', '2XX', etc. diff --git a/cobo_waas2/models/__init__.py b/cobo_waas2/models/__init__.py index b3854856..4de494bf 100644 --- a/cobo_waas2/models/__init__.py +++ b/cobo_waas2/models/__init__.py @@ -348,6 +348,7 @@ from cobo_waas2.models.list_merchants200_response import ListMerchants200Response from cobo_waas2.models.list_mpc_projects200_response import ListMpcProjects200Response from cobo_waas2.models.list_mpc_vaults200_response import ListMpcVaults200Response +from cobo_waas2.models.list_payer_transactions200_response import ListPayerTransactions200Response 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_payouts200_response import ListPayouts200Response @@ -409,6 +410,7 @@ from cobo_waas2.models.order_link_business_info_payable_amounts_inner import OrderLinkBusinessInfoPayableAmountsInner from cobo_waas2.models.order_status import OrderStatus from cobo_waas2.models.org_info import OrgInfo +from cobo_waas2.models.original_main_group_handling import OriginalMainGroupHandling from cobo_waas2.models.otc_fee import OtcFee from cobo_waas2.models.pagination import Pagination from cobo_waas2.models.payer_account import PayerAccount @@ -789,7 +791,6 @@ from cobo_waas2.models.utxo import UTXO from cobo_waas2.models.unfreeze_disposition import UnfreezeDisposition from cobo_waas2.models.update_address_book_param import UpdateAddressBookParam -from cobo_waas2.models.update_bank_account_by_id_request import UpdateBankAccountByIdRequest from cobo_waas2.models.update_counterparty_request import UpdateCounterpartyRequest from cobo_waas2.models.update_custodial_wallet_params import UpdateCustodialWalletParams from cobo_waas2.models.update_destination_bank_account import UpdateDestinationBankAccount diff --git a/cobo_waas2/models/chain_info.py b/cobo_waas2/models/chain_info.py index 7920c4b4..7e7878d0 100644 --- a/cobo_waas2/models/chain_info.py +++ b/cobo_waas2/models/chain_info.py @@ -34,7 +34,8 @@ class ChainInfo(BaseModel): require_memo: Optional[StrictBool] = Field(default=None, description="Whether the chain requires a memo.") confirming_threshold: Optional[StrictInt] = Field(default=None, description="The number of confirmations required for an on-chain transaction, such as 64 for Ethereum.") coinbase_maturity: Optional[StrictInt] = Field(default=None, description="The number of confirmations required before a coinbase transaction is considered mature and can be spent, for example, 100 confirmations for BTC.") - __properties: ClassVar[List[str]] = ["chain_id", "symbol", "icon_url", "chain_identifier", "explorer_tx_url", "explorer_address_url", "require_memo", "confirming_threshold", "coinbase_maturity"] + caip2_chain_id: Optional[StrictStr] = Field(default=None, description="A standardized, unique identifier for blockchain networks (like eip155:1 for Ethereum) that combines a namespace and a reference to ensure cross-chain compatibility.") + __properties: ClassVar[List[str]] = ["chain_id", "symbol", "icon_url", "chain_identifier", "explorer_tx_url", "explorer_address_url", "require_memo", "confirming_threshold", "coinbase_maturity", "caip2_chain_id"] model_config = ConfigDict( populate_by_name=True, @@ -95,7 +96,8 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: "explorer_address_url": obj.get("explorer_address_url"), "require_memo": obj.get("require_memo"), "confirming_threshold": obj.get("confirming_threshold"), - "coinbase_maturity": obj.get("coinbase_maturity") + "coinbase_maturity": obj.get("coinbase_maturity"), + "caip2_chain_id": obj.get("caip2_chain_id") }) return _obj diff --git a/cobo_waas2/models/update_bank_account_by_id_request.py b/cobo_waas2/models/list_payer_transactions200_response.py similarity index 59% rename from cobo_waas2/models/update_bank_account_by_id_request.py rename to cobo_waas2/models/list_payer_transactions200_response.py index b51c0163..47040770 100644 --- a/cobo_waas2/models/update_bank_account_by_id_request.py +++ b/cobo_waas2/models/list_payer_transactions200_response.py @@ -15,18 +15,21 @@ import re # noqa: F401 import json -from pydantic import BaseModel, ConfigDict, Field -from typing import Any, ClassVar, Dict, List +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_transaction import PaymentTransaction from typing import Optional, Set from typing_extensions import Self -class UpdateBankAccountByIdRequest(BaseModel): +class ListPayerTransactions200Response(BaseModel): """ - UpdateBankAccountByIdRequest + ListPayerTransactions200Response """ # noqa: E501 - info: Dict[str, Any] = Field(description="JSON-formatted bank account details. The object should include the following fields: - beneficiary_name: Name of the account holder - beneficiary_address: Address of the account holder - account_number: Bank account number - bank_name: Name of the bank - bank_address: Address of the bank - iban: (Optional) International Bank Account Number - swift_or_bic: SWIFT or BIC code of the bank ") - __properties: ClassVar[List[str]] = ["info"] + data: Optional[List[PaymentTransaction]] = None + pagination: Optional[Pagination] = None + __properties: ClassVar[List[str]] = ["data", "pagination"] model_config = ConfigDict( populate_by_name=True, @@ -46,7 +49,7 @@ def to_json(self) -> str: @classmethod def from_json(cls, json_str: str) -> Optional[Self]: - """Create an instance of UpdateBankAccountByIdRequest from a JSON string""" + """Create an instance of ListPayerTransactions200Response from a JSON string""" return cls.from_dict(json.loads(json_str)) def to_dict(self) -> Dict[str, Any]: @@ -67,11 +70,21 @@ 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 data (list) + _items = [] + if self.data: + for _item in self.data: + if _item: + _items.append(_item.to_dict()) + _dict['data'] = _items + # override the default output from pydantic by calling `to_dict()` of pagination + if self.pagination: + _dict['pagination'] = self.pagination.to_dict() return _dict @classmethod def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: - """Create an instance of UpdateBankAccountByIdRequest from a dict""" + """Create an instance of ListPayerTransactions200Response from a dict""" if obj is None: return None @@ -79,7 +92,8 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: return cls.model_validate(obj) _obj = cls.model_validate({ - "info": obj.get("info") + "data": [PaymentTransaction.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_top_up_payers200_response_data_inner.py b/cobo_waas2/models/list_top_up_payers200_response_data_inner.py index e009cf71..ddf85b7a 100644 --- a/cobo_waas2/models/list_top_up_payers200_response_data_inner.py +++ b/cobo_waas2/models/list_top_up_payers200_response_data_inner.py @@ -28,11 +28,12 @@ class ListTopUpPayers200ResponseDataInner(BaseModel): """ # noqa: E501 merchant_id: StrictStr = Field(description="The merchant ID.") payer_id: StrictStr = Field(description="A unique identifier assigned by Cobo to track and identify individual payers.") + custom_payer_id: Optional[StrictStr] = Field(default=None, description="Unique user identifier on the merchant side, used to assign a dedicated deposit address. ") developer_fee_rate: StrictStr = Field(description="The developer fee rate applied to top-up transactions made by this payer. Expressed as a decimal string where \"0.1\" represents 10%.") created_timestamp: Optional[StrictInt] = Field(default=None, description="The creation time of the payer, represented as a UNIX timestamp in seconds.") updated_timestamp: Optional[StrictInt] = Field(default=None, description="The last update time of the payer, represented as a UNIX timestamp in seconds.") - transactions: Optional[List[PaymentTransaction]] = Field(default=None, description="An array of top-up transactions associated with this payer.") - __properties: ClassVar[List[str]] = ["merchant_id", "payer_id", "developer_fee_rate", "created_timestamp", "updated_timestamp", "transactions"] + transactions: Optional[List[PaymentTransaction]] = Field(default=None, description="An array of transactions associated with this payer. This field returns up to the latest 200 transactions only and will be removed in a future version. Use the dedicated payer transactions API to paginate through transactions. ") + __properties: ClassVar[List[str]] = ["merchant_id", "payer_id", "custom_payer_id", "developer_fee_rate", "created_timestamp", "updated_timestamp", "transactions"] model_config = ConfigDict( populate_by_name=True, @@ -94,6 +95,7 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: _obj = cls.model_validate({ "merchant_id": obj.get("merchant_id"), "payer_id": obj.get("payer_id"), + "custom_payer_id": obj.get("custom_payer_id"), "developer_fee_rate": obj.get("developer_fee_rate"), "created_timestamp": obj.get("created_timestamp"), "updated_timestamp": obj.get("updated_timestamp"), diff --git a/cobo_waas2/models/order_link_business_info.py b/cobo_waas2/models/order_link_business_info.py index 1b50b38f..952111ee 100644 --- a/cobo_waas2/models/order_link_business_info.py +++ b/cobo_waas2/models/order_link_business_info.py @@ -30,7 +30,7 @@ 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: 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_currency: StrictStr = Field(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//payments/en/guides/supported-chains-and-tokens#pricing-currency). ") 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: 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` ") diff --git a/cobo_waas2/models/original_main_group_handling.py b/cobo_waas2/models/original_main_group_handling.py new file mode 100644 index 00000000..8a5aef6e --- /dev/null +++ b/cobo_waas2/models/original_main_group_handling.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 OriginalMainGroupHandling(str, Enum): + """ + The action to take on the original [Main Group](https://manuals.cobo.com/en/portal/mpc-wallets/ocw/create-key-share-groups) when upgrading a Signing Group to the Main Group. Defaults to `Invalidate` if not provided. Possible values include: - `Invalidate`: The original Main Group will be permanently invalidated. - `ConvertToSigningGroup`: The original Main Group will be converted to a Signing Group. + """ + + """ + allowed enum values + """ + INVALIDATE = 'Invalidate' + CONVERTTOSIGNINGGROUP = 'ConvertToSigningGroup' + + UNKNOWN = None + + @classmethod + def from_json(cls, json_str: str) -> Self: + """Create an instance of OriginalMainGroupHandling from a JSON string""" + return cls(json.loads(json_str)) + + @classmethod + def _missing_(cls, value): + return cls.UNKNOWN + + diff --git a/cobo_waas2/models/transaction_cobo_category.py b/cobo_waas2/models/transaction_cobo_category.py index 05f3b01c..c1846c97 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. - `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. + 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. - `JustLendReceiverPrecharge`: A TRX transfer to the receiver address to activate it and compensate for bandwidth fees before the main transaction executes. - `JustLendEnergyRental`: A contract call to JustLend's rentResource() to rent TRON energy for the main transaction execution. - `JustLendEnergyReturn`: A contract call to JustLend's returnResource() to return rented energy and recover the unused deposit after the main transaction completes. - `TrxRecharge`: TRX balance top-up to cover energy and bandwidth fees for the main transaction. """ """ @@ -64,6 +64,10 @@ class TransactionCoboCategory(str, Enum): GASFEESPONSOR = 'GasFeeSponsor' GASFEESPONSORREFUND = 'GasFeeSponsorRefund' WALLETCONNECT = 'WalletConnect' + JUSTLENDRECEIVERPRECHARGE = 'JustLendReceiverPrecharge' + JUSTLENDENERGYRENTAL = 'JustLendEnergyRental' + JUSTLENDENERGYRETURN = 'JustLendEnergyReturn' + TRXRECHARGE = 'TrxRecharge' UNKNOWN = None diff --git a/cobo_waas2/models/update_key_share_holder_group_by_id_request.py b/cobo_waas2/models/update_key_share_holder_group_by_id_request.py index 63b4f792..b92ff6f5 100644 --- a/cobo_waas2/models/update_key_share_holder_group_by_id_request.py +++ b/cobo_waas2/models/update_key_share_holder_group_by_id_request.py @@ -16,7 +16,8 @@ import json from pydantic import BaseModel, ConfigDict -from typing import Any, ClassVar, Dict, List +from typing import Any, ClassVar, Dict, List, Optional +from cobo_waas2.models.original_main_group_handling import OriginalMainGroupHandling from cobo_waas2.models.update_group_action import UpdateGroupAction from typing import Optional, Set from typing_extensions import Self @@ -27,7 +28,8 @@ class UpdateKeyShareHolderGroupByIdRequest(BaseModel): UpdateKeyShareHolderGroupByIdRequest """ # noqa: E501 update_key_share_holder_group_action: UpdateGroupAction - __properties: ClassVar[List[str]] = ["update_key_share_holder_group_action"] + original_main_group_handling: Optional[OriginalMainGroupHandling] = None + __properties: ClassVar[List[str]] = ["update_key_share_holder_group_action", "original_main_group_handling"] model_config = ConfigDict( populate_by_name=True, @@ -80,7 +82,8 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: return cls.model_validate(obj) _obj = cls.model_validate({ - "update_key_share_holder_group_action": obj.get("update_key_share_holder_group_action") + "update_key_share_holder_group_action": obj.get("update_key_share_holder_group_action"), + "original_main_group_handling": obj.get("original_main_group_handling") }) return _obj diff --git a/cobo_waas2/models/webhook_event_type.py b/cobo_waas2/models/webhook_event_type.py index a5cb0e1a..fa66e78b 100644 --- a/cobo_waas2/models/webhook_event_type.py +++ b/cobo_waas2/models/webhook_event_type.py @@ -41,6 +41,7 @@ class WebhookEventType(str, Enum): FEE_STATION_DOT_TRANSACTION_DOT_UPDATED = 'fee_station.transaction.updated' FEE_STATION_DOT_TRANSACTION_DOT_FAILED = 'fee_station.transaction.failed' FEE_STATION_DOT_TRANSACTION_DOT_SUCCEEDED = 'fee_station.transaction.succeeded' + FEE_STATION_DOT_FIAT_TRANSACTION_DOT_CREATED = 'fee_station.fiat_transaction.created' WALLET_DOT_TOKEN_DOT_ENABLED = 'wallet.token.enabled' WALLET_DOT_CHAIN_DOT_ENABLED = 'wallet.chain.enabled' WALLET_DOT_MPC_DOT_BALANCE_DOT_UPDATED = 'wallet.mpc.balance.updated' diff --git a/docs/ChainInfo.md b/docs/ChainInfo.md index d5807c19..32cbdd8f 100644 --- a/docs/ChainInfo.md +++ b/docs/ChainInfo.md @@ -15,6 +15,7 @@ Name | Type | Description | Notes **require_memo** | **bool** | Whether the chain requires a memo. | [optional] **confirming_threshold** | **int** | The number of confirmations required for an on-chain transaction, such as 64 for Ethereum. | [optional] **coinbase_maturity** | **int** | The number of confirmations required before a coinbase transaction is considered mature and can be spent, for example, 100 confirmations for BTC. | [optional] +**caip2_chain_id** | **str** | A standardized, unique identifier for blockchain networks (like eip155:1 for Ethereum) that combines a namespace and a reference to ensure cross-chain compatibility. | [optional] ## Example diff --git a/docs/ListPayerTransactions200Response.md b/docs/ListPayerTransactions200Response.md new file mode 100644 index 00000000..aee838aa --- /dev/null +++ b/docs/ListPayerTransactions200Response.md @@ -0,0 +1,30 @@ +# ListPayerTransactions200Response + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | [**List[PaymentTransaction]**](PaymentTransaction.md) | | [optional] +**pagination** | [**Pagination**](Pagination.md) | | [optional] + +## Example + +```python +from cobo_waas2.models.list_payer_transactions200_response import ListPayerTransactions200Response + +# TODO update the JSON string below +json = "{}" +# create an instance of ListPayerTransactions200Response from a JSON string +list_payer_transactions200_response_instance = ListPayerTransactions200Response.from_json(json) +# print the JSON string representation of the object +print(ListPayerTransactions200Response.to_json()) + +# convert the object into a dict +list_payer_transactions200_response_dict = list_payer_transactions200_response_instance.to_dict() +# create an instance of ListPayerTransactions200Response from a dict +list_payer_transactions200_response_from_dict = ListPayerTransactions200Response.from_dict(list_payer_transactions200_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/ListTopUpPayers200ResponseDataInner.md b/docs/ListTopUpPayers200ResponseDataInner.md index 6e8975ec..9a0aa9cc 100644 --- a/docs/ListTopUpPayers200ResponseDataInner.md +++ b/docs/ListTopUpPayers200ResponseDataInner.md @@ -7,10 +7,11 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **merchant_id** | **str** | The merchant ID. | **payer_id** | **str** | A unique identifier assigned by Cobo to track and identify individual payers. | +**custom_payer_id** | **str** | Unique user identifier on the merchant side, used to assign a dedicated deposit address. | [optional] **developer_fee_rate** | **str** | The developer fee rate applied to top-up transactions made by this payer. Expressed as a decimal string where \"0.1\" represents 10%. | **created_timestamp** | **int** | The creation time of the payer, represented as a UNIX timestamp in seconds. | [optional] **updated_timestamp** | **int** | The last update time of the payer, represented as a UNIX timestamp in seconds. | [optional] -**transactions** | [**List[PaymentTransaction]**](PaymentTransaction.md) | An array of top-up transactions associated with this payer. | [optional] +**transactions** | [**List[PaymentTransaction]**](PaymentTransaction.md) | An array of transactions associated with this payer. <Note>This field returns up to the latest 200 transactions only and will be removed in a future version. Use the dedicated payer transactions API to paginate through transactions.</Note> | [optional] ## Example diff --git a/docs/OrderLinkBusinessInfo.md b/docs/OrderLinkBusinessInfo.md index 3a08d6e4..e72a5a9c 100644 --- a/docs/OrderLinkBusinessInfo.md +++ b/docs/OrderLinkBusinessInfo.md @@ -8,7 +8,7 @@ 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. | +**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//payments/en/guides/supported-chains-and-tokens#pricing-currency). | **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` | diff --git a/docs/OriginalMainGroupHandling.md b/docs/OriginalMainGroupHandling.md new file mode 100644 index 00000000..dd0fc3b3 --- /dev/null +++ b/docs/OriginalMainGroupHandling.md @@ -0,0 +1,12 @@ +# OriginalMainGroupHandling + +The action to take on the original [Main Group](https://manuals.cobo.com/en/portal/mpc-wallets/ocw/create-key-share-groups) when upgrading a Signing Group to the Main Group. Defaults to `Invalidate` if not provided. Possible values include: - `Invalidate`: The original Main Group will be permanently invalidated. - `ConvertToSigningGroup`: The original Main Group will be converted to a Signing Group. + +## 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/PaymentApi.md b/docs/PaymentApi.md index a3a05b09..4f079783 100644 --- a/docs/PaymentApi.md +++ b/docs/PaymentApi.md @@ -47,7 +47,6 @@ Method | HTTP request | Description [**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_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 @@ -58,6 +57,7 @@ Method | HTTP request | Description [**list_forced_sweep_requests**](PaymentApi.md#list_forced_sweep_requests) | **GET** /payments/force_sweep_requests | List forced sweeps [**list_merchant_balances**](PaymentApi.md#list_merchant_balances) | **GET** /payments/balance/merchants | List merchant balances [**list_merchants**](PaymentApi.md#list_merchants) | **GET** /payments/merchants | List all merchants +[**list_payer_transactions**](PaymentApi.md#list_payer_transactions) | **GET** /payments/topup/payers/transactions | List payer transactions [**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 supported tokens [**list_payment_wallet_balances**](PaymentApi.md#list_payment_wallet_balances) | **GET** /payments/balance/payment_wallets | List payment wallet balances @@ -68,7 +68,6 @@ Method | HTTP request | Description [**list_top_up_payers**](PaymentApi.md#list_top_up_payers) | **GET** /payments/topup/payers | List payers [**payment_estimate_fee**](PaymentApi.md#payment_estimate_fee) | **POST** /payments/estimate_fee | Estimate fees [**trigger_test_payments_webhook_event**](PaymentApi.md#trigger_test_payments_webhook_event) | **POST** /payments/webhooks/trigger | Trigger test webhook event -[**update_bank_account_by_id**](PaymentApi.md#update_bank_account_by_id) | **PUT** /payments/bank_accounts/{bank_account_id} | Update bank account [**update_counterparty**](PaymentApi.md#update_counterparty) | **PUT** /payments/counterparty/{counterparty_id} | Update counterparty [**update_destination**](PaymentApi.md#update_destination) | **PUT** /payments/destination/{destination_id} | Update destination [**update_destination_entry**](PaymentApi.md#update_destination_entry) | **PUT** /payments/destination_entry/{destination_entry_id} | Update destination entry @@ -3144,7 +3143,7 @@ with cobo_waas2.ApiClient(configuration) as api_client: 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` | - **custom_payer_id** | **str**| A unique identifier to track and identify individual payers in your system. | + **custom_payer_id** | **str**| Unique customer identifier on the merchant side, used to allocate a dedicated top-up address | **merchant_id** | **str**| The merchant ID. | [optional] ### Return type @@ -3254,74 +3253,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_bank_accounts** -> List[BankAccount] list_bank_accounts() - -List all bank accounts - -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 - -* OAuth Authentication (OAuth2): -* Api Key Authentication (CoboAuth): - -```python -import cobo_waas2 -from cobo_waas2.models.bank_account import BankAccount -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) - - try: - # List all bank accounts - api_response = api_instance.list_bank_accounts() - print("The response of PaymentApi->list_bank_accounts:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling PaymentApi->list_bank_accounts: %s\n" % e) -``` - - - -### Parameters - -This endpoint does not need any parameter. - -### Return type - -[**List[BankAccount]**](BankAccount.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_batch_allocations** > ListBatchAllocations200Response list_batch_allocations(limit=limit, before=before, after=after, request_id=request_id) @@ -4131,6 +4062,92 @@ 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_payer_transactions** +> ListPayerTransactions200Response list_payer_transactions(custom_payer_id, limit=limit, before=before, after=after, merchant_id=merchant_id, token_id=token_id, transaction_hashes=transaction_hashes, transaction_ids=transaction_ids) + +List payer transactions + +This operation retrieves on-chain transactions related to a specific top-up payer. You need to specify `custom_payer_id`, which is the merchant-defined customer identifier used when creating top-up addresses. This operation is applicable to the top-up scenario only. For more information, see [Cobo Payments Guide](https://www.cobo.com/payments/en/guides/overview). + +### Example + +* OAuth Authentication (OAuth2): +* Api Key Authentication (CoboAuth): + +```python +import cobo_waas2 +from cobo_waas2.models.list_payer_transactions200_response import ListPayerTransactions200Response +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) + custom_payer_id = 'payer_0001' + limit = 10 + before = 'RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGmk1' + after = 'RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGSAk' + merchant_id = 'M1001' + token_id = 'ETH_USDT' + transaction_hashes = '239861be9a4afe080c359b7fe4a1d035945ec46256b1a0f44d1267c71de8ec28' + transaction_ids = 'f47ac10b-58cc-4372-a567-0e02b2c3d479,557918d2-632a-4fe1-932f-315711f05fe3' + + try: + # List payer transactions + api_response = api_instance.list_payer_transactions(custom_payer_id, limit=limit, before=before, after=after, merchant_id=merchant_id, token_id=token_id, transaction_hashes=transaction_hashes, transaction_ids=transaction_ids) + print("The response of PaymentApi->list_payer_transactions:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling PaymentApi->list_payer_transactions: %s\n" % e) +``` + + + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **custom_payer_id** | **str**| Unique customer identifier on the merchant side, used to allocate a dedicated top-up address | + **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] + **merchant_id** | **str**| The merchant ID. | [optional] + **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` | [optional] + **transaction_hashes** | **str**| A list of transaction hashes, separated by comma. | [optional] + **transaction_ids** | **str**| A list of transaction IDs, separated by comma. | [optional] + +### Return type + +[**ListPayerTransactions200Response**](ListPayerTransactions200Response.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_payment_orders** > ListPaymentOrders200Response list_payment_orders(limit=limit, before=before, after=after, merchant_id=merchant_id, psp_order_id=psp_order_id, statuses=statuses) @@ -4676,7 +4693,7 @@ Name | Type | Description | Notes List payers -This operation retrieves the information of all payers under a merchant. You can filter the result by the payer ID. +This operation retrieves the information of all payers. You can filter the result by merchant ID and payer_id. The `transactions` field in the response returns up to the latest 200 transactions only. This field will be removed in a future version. To paginate through payer transactions, use [List payer transactions](https://www.cobo.com/payments/en/guides/overview). ### Example @@ -4896,81 +4913,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) -# **update_bank_account_by_id** -> BankAccount update_bank_account_by_id(bank_account_id, update_bank_account_by_id_request=update_bank_account_by_id_request) - -Update bank account - -This operation has been deprecated. This operation updates the information of an existing bank account. - -### Example - -* OAuth Authentication (OAuth2): -* Api Key Authentication (CoboAuth): - -```python -import cobo_waas2 -from cobo_waas2.models.bank_account import BankAccount -from cobo_waas2.models.update_bank_account_by_id_request import UpdateBankAccountByIdRequest -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) - bank_account_id = 'f47ac10b-58cc-4372-a567-0e02b2c3d479' - update_bank_account_by_id_request = cobo_waas2.UpdateBankAccountByIdRequest() - - try: - # Update bank account - api_response = api_instance.update_bank_account_by_id(bank_account_id, update_bank_account_by_id_request=update_bank_account_by_id_request) - print("The response of PaymentApi->update_bank_account_by_id:\n") - pprint(api_response) - except Exception as e: - print("Exception when calling PaymentApi->update_bank_account_by_id: %s\n" % e) -``` - - - -### Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **bank_account_id** | **str**| The bank account ID. | - **update_bank_account_by_id_request** | [**UpdateBankAccountByIdRequest**](UpdateBankAccountByIdRequest.md)| The request body for updating an existing bank account. | [optional] - -### Return type - -[**BankAccount**](BankAccount.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) - # **update_counterparty** > Counterparty update_counterparty(counterparty_id, update_counterparty_request=update_counterparty_request) diff --git a/docs/TransactionCoboCategory.md b/docs/TransactionCoboCategory.md index bd3ba72c..b2a5727c 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. - `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. +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. - `JustLendReceiverPrecharge`: A TRX transfer to the receiver address to activate it and compensate for bandwidth fees before the main transaction executes. - `JustLendEnergyRental`: A contract call to JustLend's rentResource() to rent TRON energy for the main transaction execution. - `JustLendEnergyReturn`: A contract call to JustLend's returnResource() to return rented energy and recover the unused deposit after the main transaction completes. - `TrxRecharge`: TRX balance top-up to cover energy and bandwidth fees for the main transaction. ## Properties diff --git a/docs/UpdateBankAccountByIdRequest.md b/docs/UpdateBankAccountByIdRequest.md deleted file mode 100644 index 7a533b0e..00000000 --- a/docs/UpdateBankAccountByIdRequest.md +++ /dev/null @@ -1,29 +0,0 @@ -# UpdateBankAccountByIdRequest - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**info** | **Dict[str, object]** | JSON-formatted bank account details. The object should include the following fields: - beneficiary_name: Name of the account holder - beneficiary_address: Address of the account holder - account_number: Bank account number - bank_name: Name of the bank - bank_address: Address of the bank - iban: (Optional) International Bank Account Number - swift_or_bic: SWIFT or BIC code of the bank | - -## Example - -```python -from cobo_waas2.models.update_bank_account_by_id_request import UpdateBankAccountByIdRequest - -# TODO update the JSON string below -json = "{}" -# create an instance of UpdateBankAccountByIdRequest from a JSON string -update_bank_account_by_id_request_instance = UpdateBankAccountByIdRequest.from_json(json) -# print the JSON string representation of the object -print(UpdateBankAccountByIdRequest.to_json()) - -# convert the object into a dict -update_bank_account_by_id_request_dict = update_bank_account_by_id_request_instance.to_dict() -# create an instance of UpdateBankAccountByIdRequest from a dict -update_bank_account_by_id_request_from_dict = UpdateBankAccountByIdRequest.from_dict(update_bank_account_by_id_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/UpdateKeyShareHolderGroupByIdRequest.md b/docs/UpdateKeyShareHolderGroupByIdRequest.md index 078a6097..c1cd9f83 100644 --- a/docs/UpdateKeyShareHolderGroupByIdRequest.md +++ b/docs/UpdateKeyShareHolderGroupByIdRequest.md @@ -6,6 +6,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **update_key_share_holder_group_action** | [**UpdateGroupAction**](UpdateGroupAction.md) | | +**original_main_group_handling** | [**OriginalMainGroupHandling**](OriginalMainGroupHandling.md) | | [optional] ## Example diff --git a/pyproject.toml b/pyproject.toml index 0cc9b3fe..b9d5bd59 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,6 +1,6 @@ [tool.poetry] name = "cobo_waas2" -version = "1.34.0" +version = "1.35.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 84854fde..0eb3ae6d 100644 --- a/setup.py +++ b/setup.py @@ -19,7 +19,7 @@ # prerequisite: setuptools # http://pypi.python.org/pypi/setuptools NAME = "cobo-waas2" -VERSION = "1.34.0" +VERSION = "1.35.0" PYTHON_REQUIRES = ">=3.9" REQUIRES = [ "urllib3 >= 2.6.0", diff --git a/test/test_chain_info.py b/test/test_chain_info.py index f8afb392..b5e780d1 100644 --- a/test/test_chain_info.py +++ b/test/test_chain_info.py @@ -42,7 +42,8 @@ def make_instance(self, include_optional) -> ChainInfo: explorer_address_url = 'https://etherscan.io/address/{address}', require_memo = False, confirming_threshold = 15, - coinbase_maturity = 15 + coinbase_maturity = 15, + caip2_chain_id = 'eip155:1' ) else: return ChainInfo( diff --git a/test/test_chains_event_data.py b/test/test_chains_event_data.py index 19a30bd7..d6f991f5 100644 --- a/test/test_chains_event_data.py +++ b/test/test_chains_event_data.py @@ -45,7 +45,8 @@ def make_instance(self, include_optional) -> ChainsEventData: explorer_address_url = 'https://etherscan.io/address/{address}', require_memo = False, confirming_threshold = 15, - coinbase_maturity = 15, ) + coinbase_maturity = 15, + caip2_chain_id = 'eip155:1', ) ], wallet_type = 'Custodial', wallet_subtypes = [ @@ -65,7 +66,8 @@ def make_instance(self, include_optional) -> ChainsEventData: explorer_address_url = 'https://etherscan.io/address/{address}', require_memo = False, confirming_threshold = 15, - coinbase_maturity = 15, ) + coinbase_maturity = 15, + caip2_chain_id = 'eip155:1', ) ], ) """ diff --git a/test/test_list_payer_transactions200_response.py b/test/test_list_payer_transactions200_response.py new file mode 100644 index 00000000..1c2f218c --- /dev/null +++ b/test/test_list_payer_transactions200_response.py @@ -0,0 +1,85 @@ +# 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_payer_transactions200_response import ListPayerTransactions200Response + + +class TestListPayerTransactions200Response(unittest.TestCase): + """ListPayerTransactions200Response unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> ListPayerTransactions200Response: + """Test ListPayerTransactions200Response + 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 `ListPayerTransactions200Response` + """ + model = ListPayerTransactions200Response() + if include_optional: + return ListPayerTransactions200Response( + data = [ + 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, ) + ], + pagination = cobo_waas2.models.pagination.Pagination( + before = 'RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGmk1', + after = 'RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGSAk', + total_count = 10000, ) + ) + else: + return ListPayerTransactions200Response( + ) + """ + + def testListPayerTransactions200Response(self): + """Test ListPayerTransactions200Response""" + # 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_supported_chains200_response.py b/test/test_list_supported_chains200_response.py index e32df1f0..e3eb1dc3 100644 --- a/test/test_list_supported_chains200_response.py +++ b/test/test_list_supported_chains200_response.py @@ -44,7 +44,8 @@ def make_instance(self, include_optional) -> ListSupportedChains200Response: explorer_address_url = 'https://etherscan.io/address/{address}', require_memo = False, confirming_threshold = 15, - coinbase_maturity = 15, ) + coinbase_maturity = 15, + caip2_chain_id = 'eip155:1', ) ], pagination = cobo_waas2.models.pagination.Pagination( before = 'RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGmk1', diff --git a/test/test_list_top_up_payers200_response.py b/test/test_list_top_up_payers200_response.py index c040da8f..e1f865d5 100644 --- a/test/test_list_top_up_payers200_response.py +++ b/test/test_list_top_up_payers200_response.py @@ -38,6 +38,7 @@ def make_instance(self, include_optional) -> ListTopUpPayers200Response: cobo_waas2.models.list_top_up_payers_200_response_data_inner.list_top_up_payers_200_response_data_inner( merchant_id = 'M1001', payer_id = 'P20250619T0310056d7aa', + custom_payer_id = 'user_abc_10001', developer_fee_rate = '0.01', created_timestamp = 1744689600, updated_timestamp = 1744693200, diff --git a/test/test_list_top_up_payers200_response_data_inner.py b/test/test_list_top_up_payers200_response_data_inner.py index 88cebed8..2f2ab3cb 100644 --- a/test/test_list_top_up_payers200_response_data_inner.py +++ b/test/test_list_top_up_payers200_response_data_inner.py @@ -36,6 +36,7 @@ def make_instance(self, include_optional) -> ListTopUpPayers200ResponseDataInner return ListTopUpPayers200ResponseDataInner( merchant_id = 'M1001', payer_id = 'P20250619T0310056d7aa', + custom_payer_id = 'user_abc_10001', developer_fee_rate = '0.01', created_timestamp = 1744689600, updated_timestamp = 1744693200, diff --git a/test/test_original_main_group_handling.py b/test/test_original_main_group_handling.py new file mode 100644 index 00000000..b6630c67 --- /dev/null +++ b/test/test_original_main_group_handling.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.original_main_group_handling import OriginalMainGroupHandling + + +class TestOriginalMainGroupHandling(unittest.TestCase): + """OriginalMainGroupHandling unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testOriginalMainGroupHandling(self): + """Test OriginalMainGroupHandling""" + # inst = OriginalMainGroupHandling() + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_payment_api.py b/test/test_payment_api.py index c47e8930..01ea32fa 100644 --- a/test/test_payment_api.py +++ b/test/test_payment_api.py @@ -573,17 +573,6 @@ def test_list_allocation_items(self) -> None: 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: - """ - Test case for list_bank_accounts - - List all bank accounts - """ - """ - - api_response = self.api.list_bank_accounts() - """ - def test_list_batch_allocations(self) -> None: """ Test case for list_batch_allocations @@ -745,6 +734,25 @@ def test_list_merchants(self) -> None: api_response = self.api.list_merchants(limit=limit, before=before, after=after, keyword=keyword, wallet_id=wallet_id, wallet_setup=wallet_setup) """ + def test_list_payer_transactions(self) -> None: + """ + Test case for list_payer_transactions + + List payer transactions + """ + """ + custom_payer_id = 'payer_0001' + limit = 10 + before = 'RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGmk1' + after = 'RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGSAk' + merchant_id = 'M1001' + token_id = 'ETH_USDT' + transaction_hashes = '239861be9a4afe080c359b7fe4a1d035945ec46256b1a0f44d1267c71de8ec28' + transaction_ids = 'f47ac10b-58cc-4372-a567-0e02b2c3d479,557918d2-632a-4fe1-932f-315711f05fe3' + + api_response = self.api.list_payer_transactions(custom_payer_id, limit=limit, before=before, after=after, merchant_id=merchant_id, token_id=token_id, transaction_hashes=transaction_hashes, transaction_ids=transaction_ids) + """ + def test_list_payment_orders(self) -> None: """ Test case for list_payment_orders @@ -888,19 +896,6 @@ def test_trigger_test_payments_webhook_event(self) -> None: api_response = self.api.trigger_test_payments_webhook_event(trigger_test_payments_webhook_event_request=trigger_test_payments_webhook_event_request) """ - def test_update_bank_account_by_id(self) -> None: - """ - Test case for update_bank_account_by_id - - Update bank account - """ - """ - bank_account_id = 'f47ac10b-58cc-4372-a567-0e02b2c3d479' - update_bank_account_by_id_request = cobo_waas2.UpdateBankAccountByIdRequest() - - api_response = self.api.update_bank_account_by_id(bank_account_id, update_bank_account_by_id_request=update_bank_account_by_id_request) - """ - def test_update_counterparty(self) -> None: """ Test case for update_counterparty diff --git a/test/test_update_bank_account_by_id_request.py b/test/test_update_bank_account_by_id_request.py deleted file mode 100644 index a5adeca6..00000000 --- a/test/test_update_bank_account_by_id_request.py +++ /dev/null @@ -1,52 +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.update_bank_account_by_id_request import UpdateBankAccountByIdRequest - - -class TestUpdateBankAccountByIdRequest(unittest.TestCase): - """UpdateBankAccountByIdRequest unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def make_instance(self, include_optional) -> UpdateBankAccountByIdRequest: - """Test UpdateBankAccountByIdRequest - 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 `UpdateBankAccountByIdRequest` - """ - model = UpdateBankAccountByIdRequest() - if include_optional: - return UpdateBankAccountByIdRequest( - info = {"beneficiary_name":"John Doe","beneficiary_address":"123 Main St, Anytown, USA","account_number":"4111111111111111","bank_name":"ABC Bank","bank_address":"456 Bank Ave, Cityville, USA","swift_or_bic":"ABCDEFGH"} - ) - else: - return UpdateBankAccountByIdRequest( - info = {"beneficiary_name":"John Doe","beneficiary_address":"123 Main St, Anytown, USA","account_number":"4111111111111111","bank_name":"ABC Bank","bank_address":"456 Bank Ave, Cityville, USA","swift_or_bic":"ABCDEFGH"}, - ) - """ - - def testUpdateBankAccountByIdRequest(self): - """Test UpdateBankAccountByIdRequest""" - # 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_update_key_share_holder_group_by_id_request.py b/test/test_update_key_share_holder_group_by_id_request.py index 71b6ca7e..e4abcbf7 100644 --- a/test/test_update_key_share_holder_group_by_id_request.py +++ b/test/test_update_key_share_holder_group_by_id_request.py @@ -34,7 +34,8 @@ def make_instance(self, include_optional) -> UpdateKeyShareHolderGroupByIdReques model = UpdateKeyShareHolderGroupByIdRequest() if include_optional: return UpdateKeyShareHolderGroupByIdRequest( - update_key_share_holder_group_action = 'UpgradeToMainGroup' + update_key_share_holder_group_action = 'UpgradeToMainGroup', + original_main_group_handling = 'Invalidate' ) else: return UpdateKeyShareHolderGroupByIdRequest( diff --git a/test/test_webhook_event_data.py b/test/test_webhook_event_data.py index 0fd3acbe..e5cd33cc 100644 --- a/test/test_webhook_event_data.py +++ b/test/test_webhook_event_data.py @@ -136,7 +136,8 @@ def make_instance(self, include_optional) -> WebhookEventData: explorer_address_url = 'https://etherscan.io/address/{address}', require_memo = False, confirming_threshold = 15, - coinbase_maturity = 15, ) + coinbase_maturity = 15, + caip2_chain_id = 'eip155:1', ) ], wallet_type = 'Custodial', wallet_subtypes = [ @@ -381,7 +382,8 @@ def make_instance(self, include_optional) -> WebhookEventData: explorer_address_url = 'https://etherscan.io/address/{address}', require_memo = False, confirming_threshold = 15, - coinbase_maturity = 15, ) + coinbase_maturity = 15, + caip2_chain_id = 'eip155:1', ) ], wallet_type = 'Custodial', tokens = [