@cobo/cobo-waas2 1.7.0 → 1.9.0

package/docs/TravelRuleDepositExchangesOrVASPEntityInfo.md

@@ -0,0 +1,29 @@
+# CoboWaas2.TravelRuleDepositExchangesOrVASPEntityInfo
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**selected_entity_type** | **String** | Specifies the type of entity associated with the transaction. - `LEGAL`: Legal entity. - `NATURAL`: Natural person.  | 
+**legal_name** | **String** | The legal name of the entity. | 
+**date_of_incorporation** | **Date** | The date of incorporation of the entity. This field is required when either of the following conditions is met: - `is_threshold_reached` is `true` in the response of the [Retrieve transaction limitations](https://www.cobo.com/developers/v2/api-references/travelrule/retrieve-transaction-limitations) operation. - `selected_entity_type` is `LEGAL`.  | [optional] 
+**place_of_incorporation** | **String** | The place of incorporation of the entity. This field is required when either of the following conditions is met: - `is_threshold_reached` is `true` in the response of the [Retrieve transaction limitations](https://www.cobo.com/developers/v2/api-references/travelrule/retrieve-transaction-limitations) operation. - `selected_entity_type` is `LEGAL`.  | [optional] 
+**first_name** | **String** | The first name of the natural person. | 
+**last_name** | **String** | The last name of the natural person. | 
+**date_of_birth** | **Date** | The date of birth of the natural person. This field is required when either of the following conditions is met: - `is_threshold_reached` is `true` in the response of the [Retrieve transaction limitations](https://www.cobo.com/developers/v2/api-references/travelrule/retrieve-transaction-limitations) operation. - `selected_entity_type` is `NATURAL`.  | [optional] 
+**place_of_birth** | **String** | The place of birth of the natural person. This field is required when either of the following conditions is met: - `is_threshold_reached` is `true` in the response of the [Retrieve transaction limitations](https://www.cobo.com/developers/v2/api-references/travelrule/retrieve-transaction-limitations) operation. - `selected_entity_type` is `NATURAL`.  | [optional] 
+
+
+
+## Enum: SelectedEntityTypeEnum
+
+
+* `LEGAL` (value: `"LEGAL"`)
+
+* `NATURAL` (value: `"NATURAL"`)
+
+* `unknown_default_open_api` (value: `"unknown_default_open_api"`)
+
+
+
+

package/docs/TravelRuleDepositLegalEntity.md

@@ -0,0 +1,25 @@
+# CoboWaas2.TravelRuleDepositLegalEntity
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**selected_entity_type** | **String** | The entity type. Possible values include: - `LEGAL`: Legal entity. - `NATURAL`: Natural person.  | 
+**legal_name** | **String** | The legal name of the entity. | 
+**date_of_incorporation** | **Date** | The date of incorporation of the entity. This field is required when either of the following conditions is met: - `is_threshold_reached` is `true` in the response of the [Retrieve transaction limitations](https://www.cobo.com/developers/v2/api-references/travelrule/retrieve-transaction-limitations) operation. - `selected_entity_type` is `LEGAL`.  | [optional] 
+**place_of_incorporation** | **String** | The place of incorporation of the entity. This field is required when either of the following conditions is met: - `is_threshold_reached` is `true` in the response of the [Retrieve transaction limitations](https://www.cobo.com/developers/v2/api-references/travelrule/retrieve-transaction-limitations) operation. - `selected_entity_type` is `LEGAL`.  | [optional] 
+
+
+
+## Enum: SelectedEntityTypeEnum
+
+
+* `LEGAL` (value: `"LEGAL"`)
+
+* `NATURAL` (value: `"NATURAL"`)
+
+* `unknown_default_open_api` (value: `"unknown_default_open_api"`)
+
+
+
+

package/docs/TravelRuleDepositNaturalEntity.md

@@ -0,0 +1,26 @@
+# CoboWaas2.TravelRuleDepositNaturalEntity
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**selected_entity_type** | **String** | Specifies the type of entity associated with the transaction. - `LEGAL`: Legal entity. - `NATURAL`: Natural person.  | 
+**first_name** | **String** | The first name of the natural person. | 
+**last_name** | **String** | The last name of the natural person. | 
+**date_of_birth** | **Date** | The date of birth of the natural person. This field is required when either of the following conditions is met: - `is_threshold_reached` is `true` in the response of the [Retrieve transaction limitations](https://www.cobo.com/developers/v2/api-references/travelrule/retrieve-transaction-limitations) operation. - `selected_entity_type` is `NATURAL`.  | [optional] 
+**place_of_birth** | **String** | The place of birth of the natural person. This field is required when either of the following conditions is met: - `is_threshold_reached` is `true` in the response of the [Retrieve transaction limitations](https://www.cobo.com/developers/v2/api-references/travelrule/retrieve-transaction-limitations) operation. - `selected_entity_type` is `NATURAL`.  | [optional] 
+
+
+
+## Enum: SelectedEntityTypeEnum
+
+
+* `LEGAL` (value: `"LEGAL"`)
+
+* `NATURAL` (value: `"NATURAL"`)
+
+* `unknown_default_open_api` (value: `"unknown_default_open_api"`)
+
+
+
+

package/docs/TravelRuleDepositRequest.md

@@ -0,0 +1,10 @@
+# CoboWaas2.TravelRuleDepositRequest
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**transaction_id** | **String** | The transaction ID. | 
+**travel_rule_info** | [**TravelRuleDepositRequestTravelRuleInfo**](TravelRuleDepositRequestTravelRuleInfo.md) |  | 
+
+

package/docs/TravelRuleDepositRequestTravelRuleInfo.md

@@ -0,0 +1,16 @@
+# CoboWaas2.TravelRuleDepositRequestTravelRuleInfo
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**destination_wallet_type** | [**DestinationWalletType**](DestinationWalletType.md) |  | 
+**vendor_code** | **String** | The vendor code of the VASP. | 
+**vendor_vasp_id** | **String** | The unique identifier of the VASP. | 
+**vendor_vasp_name** | **String** | The vendor name. Use this field to specify the name of a vendor not listed. | [optional] 
+**entity_info** | [**TravelRuleDepositExchangesOrVASPEntityInfo**](TravelRuleDepositExchangesOrVASPEntityInfo.md) |  | 
+**self_custody_wallet_challenge** | **String** | The message obtained from the `Retrieve transaction limitations` operation. This message is used to verify wallet ownership through signing. | 
+**self_custody_wallet_address** | **String** | The address of the self-custody wallet. | 
+**self_custody_wallet_sign** | **String** | The signature created by signing the challenge message with the wallet's private key. | 
+
+

package/docs/TravelRuleWithdrawExchangesOrVASP.md

@@ -0,0 +1,12 @@
+# CoboWaas2.TravelRuleWithdrawExchangesOrVASP
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**destination_wallet_type** | [**DestinationWalletType**](DestinationWalletType.md) |  | 
+**vendor_code** | **String** | The vendor code of the exchange or virtual asset service provider (VASP). | 
+**vendor_vasp_id** | **String** | The unique identifier of the VASP. | 
+**entity_info** | [**TravelRuleWithdrawExchangesOrVASPEntityInfo**](TravelRuleWithdrawExchangesOrVASPEntityInfo.md) |  | 
+
+

package/docs/TravelRuleWithdrawExchangesOrVASPEntityInfo.md

@@ -0,0 +1,16 @@
+# CoboWaas2.TravelRuleWithdrawExchangesOrVASPEntityInfo
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**selected_entity_type** | [**SelectedEntityType**](SelectedEntityType.md) |  | 
+**legal_name** | **String** | The legal name of the entity. | 
+**date_of_incorporation** | **Date** | The date of incorporation of the entity. | [optional] 
+**place_of_incorporation** | **String** | The place of incorporation of the entity. | [optional] 
+**first_name** | **String** | The first name of the natural person. | 
+**last_name** | **String** | The last name of the natural person. | 
+**date_of_birth** | **Date** | The date of birth of the natural person. | [optional] 
+**place_of_birth** | **String** | The place of birth of the natural person. | [optional] 
+
+

package/docs/TravelRuleWithdrawLegalEntity.md

@@ -0,0 +1,12 @@
+# CoboWaas2.TravelRuleWithdrawLegalEntity
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**selected_entity_type** | [**SelectedEntityType**](SelectedEntityType.md) |  | 
+**legal_name** | **String** | The legal name of the entity. | 
+**date_of_incorporation** | **Date** | The date of incorporation of the entity. | [optional] 
+**place_of_incorporation** | **String** | The place of incorporation of the entity. | [optional] 
+
+

package/docs/TravelRuleWithdrawNaturalEntity.md

@@ -0,0 +1,13 @@
+# CoboWaas2.TravelRuleWithdrawNaturalEntity
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**selected_entity_type** | [**SelectedEntityType**](SelectedEntityType.md) |  | 
+**first_name** | **String** | The first name of the natural person. | 
+**last_name** | **String** | The last name of the natural person. | 
+**date_of_birth** | **Date** | The date of birth of the natural person. | [optional] 
+**place_of_birth** | **String** | The place of birth of the natural person. | [optional] 
+
+

package/docs/TravelRuleWithdrawRequest.md

@@ -0,0 +1,10 @@
+# CoboWaas2.TravelRuleWithdrawRequest
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**transaction_id** | **String** | The transaction ID. | 
+**travel_rule_info** | [**TravelRuleWithdrawRequestTravelRuleInfo**](TravelRuleWithdrawRequestTravelRuleInfo.md) |  | 
+
+

package/docs/TravelRuleWithdrawRequestTravelRuleInfo.md

@@ -0,0 +1,15 @@
+# CoboWaas2.TravelRuleWithdrawRequestTravelRuleInfo
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**destination_wallet_type** | [**DestinationWalletType**](DestinationWalletType.md) |  | 
+**self_custody_wallet_challenge** | **String** | The message obtained from the `Retrieve transaction limitations` operation. This message is used to verify wallet ownership through signing. | 
+**self_custody_wallet_address** | **String** | The address of the self-custody wallet. | 
+**self_custody_wallet_sign** | **String** | The signature created by signing the challenge message with the wallet's private key. | 
+**vendor_code** | **String** | The vendor code of the exchange or virtual asset service provider (VASP). | 
+**vendor_vasp_id** | **String** | The unique identifier of the VASP. | 
+**entity_info** | [**TravelRuleWithdrawExchangesOrVASPEntityInfo**](TravelRuleWithdrawExchangesOrVASPEntityInfo.md) |  | 
+
+

package/docs/TriggerTestWebhookEventRequest.md

@@ -5,6 +5,6 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **event_type** | [**WebhookEventType**](WebhookEventType.md) |  | 
-**override_data** | **Object** | An object for customization of the webhook event payload. You only need to include the fields you want to customize.   The provided fields must match the webhook event data structure, depending on the specified event type. For a complete introduction of the webhook event data structure, refer to the `data.data` property in the response of [List all webhook events](/v2/api-references/developers--webhooks/list-all-webhook-events).  If this property is not provided, a default payload will be returned.  | [optional] 
+**override_data** | **Object** | An object for customization of the webhook event payload. You only need to include the fields you want to customize.   The provided fields must match the webhook event data structure, depending on the specified event type. For a complete introduction of the webhook event data structure, refer to the `data.data` property in the response of [List all webhook events](https://www.cobo.com/developers/v2/api-references/developers--webhooks/list-all-webhook-events).  If this property is not provided, a default payload will be returned.  | [optional] 
 
 

package/docs/UpdateWebhookEndpointByIdRequest.md

@@ -4,7 +4,7 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**subscribed_events** | [**[WebhookEventType]**](WebhookEventType.md) | The new event types you want to subscribe to for this webhook endpoint. You can call [Get webhook event types](/v2/api-references/developers--webhooks/get-webhook-event-types) to retrieve all available event types. | [optional] 
+**subscribed_events** | [**[WebhookEventType]**](WebhookEventType.md) | The new event types you want to subscribe to for this webhook endpoint. You can call [Get webhook event types](https://www.cobo.com/developers/v2/api-references/developers--webhooks/get-webhook-event-types) to retrieve all available event types. | [optional] 
 **status** | **String** | The new status you want to set the webhook endpoint to. If you set `status` to `STATUS_INACTIVE`, the endpoint will be revoked, meaning it will no longer receive any webhook events. | [optional] 
 **description** | **String** | The webhook endpoint description. | [optional] 
 

package/docs/Vasp.md

@@ -0,0 +1,11 @@
+# CoboWaas2.Vasp
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | The VASP name. | 
+**vendor_code** | **String** | The vendor code of the VASP. | 
+**vendor_vasp_id** | **String** | The VASP ID. | 
+
+

package/docs/WalletInfoEventData.md

@@ -0,0 +1,29 @@
+# CoboWaas2.WalletInfoEventData
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**data_type** | **String** |  The data type of the event. - `Transaction`: The transaction event data. - `TSSRequest`: The TSS request event data. - `Addresses`: The addresses event data. - `WalletInfo`: The wallet information event data. - `MPCVault`: The MPC vault event data. | 
+**wallet** | [**WalletInfo**](WalletInfo.md) |  | [optional] 
+
+
+
+## Enum: DataTypeEnum
+
+
+* `Transaction` (value: `"Transaction"`)
+
+* `TSSRequest` (value: `"TSSRequest"`)
+
+* `Addresses` (value: `"Addresses"`)
+
+* `WalletInfo` (value: `"WalletInfo"`)
+
+* `MPCVault` (value: `"MPCVault"`)
+
+* `unknown_default_open_api` (value: `"unknown_default_open_api"`)
+
+
+
+