Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
318 changes: 309 additions & 9 deletions .openapi-generator/FILES

Large diffs are not rendered by default.

112 changes: 107 additions & 5 deletions README.md

Large diffs are not rendered by default.

31 changes: 31 additions & 0 deletions docs/AccountBasedAccessProviderDetails.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
# AccountBasedAccessProviderDetails


## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**manifest** | [**Manifest**](Manifest.md) | |
**connected** | **bool** | Whether the provider is currently connected |
**accounts** | [**List[AccountBase]**](AccountBase.md) | | [optional]

## Example

```python
from fireblocks.models.account_based_access_provider_details import AccountBasedAccessProviderDetails

# TODO update the JSON string below
json = "{}"
# create an instance of AccountBasedAccessProviderDetails from a JSON string
account_based_access_provider_details_instance = AccountBasedAccessProviderDetails.from_json(json)
# print the JSON string representation of the object
print(AccountBasedAccessProviderDetails.to_json())

# convert the object into a dict
account_based_access_provider_details_dict = account_based_access_provider_details_instance.to_dict()
# create an instance of AccountBasedAccessProviderDetails from a dict
account_based_access_provider_details_from_dict = AccountBasedAccessProviderDetails.from_dict(account_based_access_provider_details_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)


5 changes: 3 additions & 2 deletions docs/AccountConfig.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,15 @@
# AccountConfig

Policy source/destination configuration
Policy account configuration

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**type** | [**AccountType2**](AccountType2.md) | |
**type** | [**List[AccountType2]**](AccountType2.md) | Account types | [optional]
**sub_type** | [**List[AccountIdentifier]**](AccountIdentifier.md) | | [optional]
**ids** | [**List[AccountIdentifier]**](AccountIdentifier.md) | | [optional]
**tags** | [**List[PolicyTag]**](PolicyTag.md) | Tags for account matching | [optional]
**operator** | [**PolicyOperator**](PolicyOperator.md) | |
**match_from** | **str** | Whether to match from account or source | [optional]

Expand Down
13 changes: 13 additions & 0 deletions docs/AchAccountType.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# AchAccountType

Type of the bank account.

## Enum

* `CHECKING` (value: `'CHECKING'`)

* `SAVINGS` (value: `'SAVINGS'`)

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)


33 changes: 33 additions & 0 deletions docs/AchAddress.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
# AchAddress


## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**account_holder** | [**AccountHolderDetails**](AccountHolderDetails.md) | |
**bank_name** | **str** | Name of the bank. | [optional]
**bank_account_number** | **str** | The bank account number for the ACH transfer. |
**routing_number** | **str** | Routing number identifying the bank account. |
**account_type** | [**AchAccountType**](AchAccountType.md) | |

## Example

```python
from fireblocks.models.ach_address import AchAddress

# TODO update the JSON string below
json = "{}"
# create an instance of AchAddress from a JSON string
ach_address_instance = AchAddress.from_json(json)
# print the JSON string representation of the object
print(AchAddress.to_json())

# convert the object into a dict
ach_address_dict = ach_address_instance.to_dict()
# create an instance of AchAddress from a dict
ach_address_from_dict = AchAddress.from_dict(ach_address_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)


30 changes: 30 additions & 0 deletions docs/AchDestination.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
# AchDestination


## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**type** | **str** | |
**address** | [**AchAddress**](AchAddress.md) | |

## Example

```python
from fireblocks.models.ach_destination import AchDestination

# TODO update the JSON string below
json = "{}"
# create an instance of AchDestination from a JSON string
ach_destination_instance = AchDestination.from_json(json)
# print the JSON string representation of the object
print(AchDestination.to_json())

# convert the object into a dict
ach_destination_dict = ach_destination_instance.to_dict()
# create an instance of AchDestination from a dict
ach_destination_from_dict = AchDestination.from_dict(ach_destination_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)


13 changes: 13 additions & 0 deletions docs/AlertExposureTypeEnum.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# AlertExposureTypeEnum

Alert exposure type (AlertExposureType enum)

## Enum

* `DIRECT` (value: `'DIRECT'`)

* `INDIRECT` (value: `'INDIRECT'`)

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)


17 changes: 17 additions & 0 deletions docs/AlertLevelEnum.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# AlertLevelEnum

Alert level severity

## Enum

* `SEVERE` (value: `'SEVERE'`)

* `HIGH` (value: `'HIGH'`)

* `MEDIUM` (value: `'MEDIUM'`)

* `LOW` (value: `'LOW'`)

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)


38 changes: 38 additions & 0 deletions docs/AmlAlert.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
# AmlAlert

AML alert information

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**alert_level** | [**AlertLevelEnum**](AlertLevelEnum.md) | |
**alert_name** | **str** | Name or type of the alert | [optional]
**category** | **str** | Alert category | [optional]
**service** | **str** | Service that generated the alert | [optional]
**external_id** | **str** | External identifier for the alert |
**alert_amount** | **float** | Amount associated with the alert |
**exposure_type** | [**AlertExposureTypeEnum**](AlertExposureTypeEnum.md) | |
**policy_action** | **str** | Recommended action based on policy | [optional]
**category_id** | **float** | Category identifier | [optional]

## Example

```python
from fireblocks.models.aml_alert import AmlAlert

# TODO update the JSON string below
json = "{}"
# create an instance of AmlAlert from a JSON string
aml_alert_instance = AmlAlert.from_json(json)
# print the JSON string representation of the object
print(AmlAlert.to_json())

# convert the object into a dict
aml_alert_dict = aml_alert_instance.to_dict()
# create an instance of AmlAlert from a dict
aml_alert_from_dict = AmlAlert.from_dict(aml_alert_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)


32 changes: 32 additions & 0 deletions docs/AmlMatchedRule.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
# AmlMatchedRule

AML matched rule information

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**rule_id** | **str** | Identifier of the matched rule | [optional]
**rule_name** | **str** | Name of the matched rule | [optional]
**action** | [**PolicyVerdictActionEnum**](PolicyVerdictActionEnum.md) | | [optional]

## Example

```python
from fireblocks.models.aml_matched_rule import AmlMatchedRule

# TODO update the JSON string below
json = "{}"
# create an instance of AmlMatchedRule from a JSON string
aml_matched_rule_instance = AmlMatchedRule.from_json(json)
# print the JSON string representation of the object
print(AmlMatchedRule.to_json())

# convert the object into a dict
aml_matched_rule_dict = aml_matched_rule_instance.to_dict()
# create an instance of AmlMatchedRule from a dict
aml_matched_rule_from_dict = AmlMatchedRule.from_dict(aml_matched_rule_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)


33 changes: 33 additions & 0 deletions docs/AmlResult.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
# AmlResult

Detailed AML screening result information. Contains alerts, risk scores, and other AML-specific data from provider-specific responses.

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**alerts** | [**List[AmlAlert]**](AmlAlert.md) | List of AML alerts triggered during screening | [optional]
**provider_response** | **Dict[str, object]** | Complete response from the AML provider. This is a dynamic object that varies significantly between different AML providers (Chainalysis, Elliptic, etc.). Each provider has their own proprietary response format and schema. Examples of provider-specific structures: - Chainalysis: Contains cluster info, risk scores, sanctions data - Elliptic: Includes risk assessment, entity types, compliance flags The structure is provider-dependent and cannot be standardized as each vendor implements their own proprietary data models and response formats. | [optional]
**matched_rule** | [**AmlMatchedRule**](AmlMatchedRule.md) | | [optional]
**matched_alert** | [**AmlAlert**](AmlAlert.md) | | [optional]

## Example

```python
from fireblocks.models.aml_result import AmlResult

# TODO update the JSON string below
json = "{}"
# create an instance of AmlResult from a JSON string
aml_result_instance = AmlResult.from_json(json)
# print the JSON string representation of the object
print(AmlResult.to_json())

# convert the object into a dict
aml_result_dict = aml_result_instance.to_dict()
# create an instance of AmlResult from a dict
aml_result_from_dict = AmlResult.from_dict(aml_result_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)


19 changes: 19 additions & 0 deletions docs/AmlStatusEnum.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# AmlStatusEnum

AML screening status

## Enum

* `COMPLETED` (value: `'COMPLETED'`)

* `PENDING` (value: `'PENDING'`)

* `BYPASSED` (value: `'BYPASSED'`)

* `FAILED` (value: `'FAILED'`)

* `FROZEN` (value: `'FROZEN'`)

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)


30 changes: 30 additions & 0 deletions docs/AmountConfig.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
# AmountConfig


## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**range** | [**AmountRangeMinMax2**](AmountRangeMinMax2.md) | |
**currency** | [**PolicyCurrency**](PolicyCurrency.md) | | [optional]

## Example

```python
from fireblocks.models.amount_config import AmountConfig

# TODO update the JSON string below
json = "{}"
# create an instance of AmountConfig from a JSON string
amount_config_instance = AmountConfig.from_json(json)
# print the JSON string representation of the object
print(AmountConfig.to_json())

# convert the object into a dict
amount_config_dict = amount_config_instance.to_dict()
# create an instance of AmountConfig from a dict
amount_config_from_dict = AmountConfig.from_dict(amount_config_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)


30 changes: 30 additions & 0 deletions docs/AmountConfigCurrency.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
# AmountConfigCurrency

Currency property for amount configuration

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**currency** | [**PolicyCurrency**](PolicyCurrency.md) | | [optional]

## Example

```python
from fireblocks.models.amount_config_currency import AmountConfigCurrency

# TODO update the JSON string below
json = "{}"
# create an instance of AmountConfigCurrency from a JSON string
amount_config_currency_instance = AmountConfigCurrency.from_json(json)
# print the JSON string representation of the object
print(AmountConfigCurrency.to_json())

# convert the object into a dict
amount_config_currency_dict = amount_config_currency_instance.to_dict()
# create an instance of AmountConfigCurrency from a dict
amount_config_currency_from_dict = AmountConfigCurrency.from_dict(amount_config_currency_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)


4 changes: 2 additions & 2 deletions docs/AmountOverTimeConfig.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@ Amount over time configuration

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**range** | [**AmountOverTimeConfigRange**](AmountOverTimeConfigRange.md) | |
**currency** | **str** | Currency for the amount | [optional]
**range** | [**AmountRangeMinMax2**](AmountRangeMinMax2.md) | |
**currency** | [**PolicyCurrency**](PolicyCurrency.md) | |
**time_period** | [**TimePeriodConfig**](TimePeriodConfig.md) | |

## Example
Expand Down
31 changes: 0 additions & 31 deletions docs/AmountOverTimeConfigRange.md

This file was deleted.

Loading
Loading