RubyGems - cybrid_api_bank_ruby - Versions diffs - 0.125.50 → 0.125.59 - Mend

cybrid_api_bank_ruby 0.125.50 → 0.125.59

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (1001) hide show

data/docs/InternalWalletServiceListBankModel.md DELETED Viewed

@@ -1,24 +0,0 @@
-# CybridApiBank::InternalWalletServiceListBankModel
-## Properties
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **total** | **Integer** | The total number of records available. |  |
-| **page** | **Integer** | The page index to retrieve. |  |
-| **per_page** | **Integer** | The number of entities per page to return. |  |
-| **objects** | [**Array&lt;InternalWalletServiceBankModel&gt;**](InternalWalletServiceBankModel.md) | Array of internal wallet entities |  |
-## Example
-```ruby
-require 'cybrid_api_bank_ruby'
-instance = CybridApiBank::InternalWalletServiceListBankModel.new(
-  total: null,
-  page: null,
-  per_page: null,
-  objects: null
-)
-```

data/docs/ParamInternalActivityLimitBankModel.md DELETED Viewed

@@ -1,26 +0,0 @@
-# CybridApiBank::ParamInternalActivityLimitBankModel
-## Properties
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **name** | **String** | The name of the limit. |  |
-| **limit_type** | **String** | The type of the limit. |  |
-| **limit_asset** | **String** | The asset of the limit. |  |
-| **limit_amount** | **Integer** | The amount of the limit. |  |
-| **limit_interval** | **Integer** | The interval of the limit. Required when limit_type is rolling. | [optional] |
-## Example
-```ruby
-require 'cybrid_api_bank_ruby'
-instance = CybridApiBank::ParamInternalActivityLimitBankModel.new(
-  name: null,
-  limit_type: null,
-  limit_asset: null,
-  limit_amount: null,
-  limit_interval: null
-)
-```

data/docs/PatchInternalAccountAssociationBankModel.md DELETED Viewed

@@ -1,22 +0,0 @@
-# CybridApiBank::PatchInternalAccountAssociationBankModel
-## Properties
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **side** | **String** | The side of the account association. |  |
-| **executed_amount** | **Integer** | The executed amount in base units of the currency. | [optional] |
-| **quoted_amount** | **Integer** | The quoted amount in base units of the currency. | [optional] |
-## Example
-```ruby
-require 'cybrid_api_bank_ruby'
-instance = CybridApiBank::PatchInternalAccountAssociationBankModel.new(
-  side: null,
-  executed_amount: null,
-  quoted_amount: null
-)
-```

data/docs/PatchInternalAccountBankModel.md DELETED Viewed

@@ -1,18 +0,0 @@
-# CybridApiBank::PatchInternalAccountBankModel
-## Properties
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **stored_at** | **Time** | ISO8601 datetime the account was stored at. | [optional] |
-## Example
-```ruby
-require 'cybrid_api_bank_ruby'
-instance = CybridApiBank::PatchInternalAccountBankModel.new(
-  stored_at: null
-)
-```

data/docs/PatchInternalActivityLimitConfigurationBankModel.md DELETED Viewed

@@ -1,18 +0,0 @@
-# CybridApiBank::PatchInternalActivityLimitConfigurationBankModel
-## Properties
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **limits** | [**Array&lt;ParamInternalActivityLimitBankModel&gt;**](ParamInternalActivityLimitBankModel.md) | The limits for the configuration. |  |
-## Example
-```ruby
-require 'cybrid_api_bank_ruby'
-instance = CybridApiBank::PatchInternalActivityLimitConfigurationBankModel.new(
-  limits: null
-)
-```

data/docs/PatchInternalBankAccountServiceBankModel.md DELETED Viewed

@@ -1,18 +0,0 @@
-# CybridApiBank::PatchInternalBankAccountServiceBankModel
-## Properties
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **stored_at** | **Time** | ISO8601 datetime the bank account service was stored at. | [optional] |
-## Example
-```ruby
-require 'cybrid_api_bank_ruby'
-instance = CybridApiBank::PatchInternalBankAccountServiceBankModel.new(
-  stored_at: null
-)
-```

data/docs/PatchInternalBankBankModel.md DELETED Viewed

@@ -1,22 +0,0 @@
-# CybridApiBank::PatchInternalBankBankModel
-## Properties
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **raw_routing_details** | **Boolean** | True if the bank supports raw routing details for external bank accounts. | [optional] |
-| **counterparty_external_accounts** | **Boolean** | True if the bank counterparty external bank accounts. | [optional] |
-| **persona_theme_id** | **String** | The persona theme ID for the bank. | [optional] |
-## Example
-```ruby
-require 'cybrid_api_bank_ruby'
-instance = CybridApiBank::PatchInternalBankBankModel.new(
-  raw_routing_details: null,
-  counterparty_external_accounts: null,
-  persona_theme_id: null
-)
-```

data/docs/PatchInternalBusinessDetailBankModel.md DELETED Viewed

@@ -1,18 +0,0 @@
-# CybridApiBank::PatchInternalBusinessDetailBankModel
-## Properties
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **stored_at** | **Time** | ISO8601 datetime the business detail was stored at. | [optional] |
-## Example
-```ruby
-require 'cybrid_api_bank_ruby'
-instance = CybridApiBank::PatchInternalBusinessDetailBankModel.new(
-  stored_at: null
-)
-```

data/docs/PatchInternalCounterpartyBankModel.md DELETED Viewed

@@ -1,18 +0,0 @@
-# CybridApiBank::PatchInternalCounterpartyBankModel
-## Properties
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **stored_at** | **Time** | ISO8601 datetime the counterparty stored at. | [optional] |
-## Example
-```ruby
-require 'cybrid_api_bank_ruby'
-instance = CybridApiBank::PatchInternalCounterpartyBankModel.new(
-  stored_at: null
-)
-```

data/docs/PatchInternalCryptoAssetConfigurationBankModel.md DELETED Viewed

@@ -1,20 +0,0 @@
-# CybridApiBank::PatchInternalCryptoAssetConfigurationBankModel
-## Properties
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **deposits_enabled** | **Boolean** | Allow deposits for the configuration. | [optional] |
-| **maximum_number_of_addresses** | **Integer** | The maximum number of addresses allowed for the configuration. | [optional] |
-## Example
-```ruby
-require 'cybrid_api_bank_ruby'
-instance = CybridApiBank::PatchInternalCryptoAssetConfigurationBankModel.new(
-  deposits_enabled: null,
-  maximum_number_of_addresses: null
-)
-```

data/docs/PatchInternalCustomerBankModel.md DELETED Viewed

@@ -1,22 +0,0 @@
-# CybridApiBank::PatchInternalCustomerBankModel
-## Properties
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **stored_at** | **Time** | ISO8601 datetime the customer stored at. | [optional] |
-| **frozen** | **Boolean** | Flag indicating if the customer is frozen or not. | [optional] |
-| **state** | **String** | The customer&#39;s state. | [optional] |
-## Example
-```ruby
-require 'cybrid_api_bank_ruby'
-instance = CybridApiBank::PatchInternalCustomerBankModel.new(
-  stored_at: null,
-  frozen: null,
-  state: null
-)
-```

data/docs/PatchInternalCybridAccountBankModel.md DELETED Viewed

@@ -1,18 +0,0 @@
-# CybridApiBank::PatchInternalCybridAccountBankModel
-## Properties
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **stored_at** | **Time** | ISO8601 datetime the account was stored at. | [optional] |
-## Example
-```ruby
-require 'cybrid_api_bank_ruby'
-instance = CybridApiBank::PatchInternalCybridAccountBankModel.new(
-  stored_at: null
-)
-```

data/docs/PatchInternalDepositAddressBankModel.md DELETED Viewed

@@ -1,24 +0,0 @@
-# CybridApiBank::PatchInternalDepositAddressBankModel
-## Properties
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **stored_at** | **Time** | ISO8601 datetime the deposit address was stored at. | [optional] |
-| **address** | **String** | The blockchain address. | [optional] |
-| **format** | **String** | The blockchain address format. | [optional] |
-| **tag** | **String** | The blockchain address tag. | [optional] |
-## Example
-```ruby
-require 'cybrid_api_bank_ruby'
-instance = CybridApiBank::PatchInternalDepositAddressBankModel.new(
-  stored_at: null,
-  address: null,
-  format: null,
-  tag: null
-)
-```

data/docs/PatchInternalDepositBankAccountBankModel.md DELETED Viewed

@@ -1,18 +0,0 @@
-# CybridApiBank::PatchInternalDepositBankAccountBankModel
-## Properties
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **stored_at** | **Time** | ISO8601 datetime the account was stored at. | [optional] |
-## Example
-```ruby
-require 'cybrid_api_bank_ruby'
-instance = CybridApiBank::PatchInternalDepositBankAccountBankModel.new(
-  stored_at: null
-)
-```

data/docs/PatchInternalExchangeAccountBankModel.md DELETED Viewed

@@ -1,18 +0,0 @@
-# CybridApiBank::PatchInternalExchangeAccountBankModel
-## Properties
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **stored_at** | **Time** | ISO8601 datetime the account was stored at. | [optional] |
-## Example
-```ruby
-require 'cybrid_api_bank_ruby'
-instance = CybridApiBank::PatchInternalExchangeAccountBankModel.new(
-  stored_at: null
-)
-```

data/docs/PatchInternalExchangeOrderBankModel.md DELETED Viewed

@@ -1,36 +0,0 @@
-# CybridApiBank::PatchInternalExchangeOrderBankModel
-## Properties
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **provider_order_guid** | **String** | The unique identifier for the order in the provider system. | [optional] |
-| **unassigned_receive_amount** | **Integer** | The unassigned receive amount in base units of the currency. | [optional] |
-| **unassigned_deliver_amount** | **Integer** | The unassigned deliver in base units of the currency. | [optional] |
-| **executed_receive_amount** | **Integer** | The executed receive amount in base units of the currency. | [optional] |
-| **executed_deliver_amount** | **Integer** | The executed deliver in base units of the currency. | [optional] |
-| **state** | **String** | The state of the resource. | [optional] |
-| **pending_at** | **Time** | The timestamp when the order was set to pending. | [optional] |
-| **failed_at** | **Time** | The timestamp when the order was set to failed. | [optional] |
-| **completed_at** | **Time** | The timestamp when the order was set to completed. | [optional] |
-| **failure_code** | **String** | The error message in case of failure. | [optional] |
-## Example
-```ruby
-require 'cybrid_api_bank_ruby'
-instance = CybridApiBank::PatchInternalExchangeOrderBankModel.new(
-  provider_order_guid: null,
-  unassigned_receive_amount: null,
-  unassigned_deliver_amount: null,
-  executed_receive_amount: null,
-  executed_deliver_amount: null,
-  state: null,
-  pending_at: null,
-  failed_at: null,
-  completed_at: null,
-  failure_code: null
-)
-```

data/docs/PatchInternalExchangeSettlementBankModel.md DELETED Viewed

@@ -1,22 +0,0 @@
-# CybridApiBank::PatchInternalExchangeSettlementBankModel
-## Properties
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **stored_at** | **Time** | ISO8601 datetime the exchange settlement was stored at. | [optional] |
-| **approved_at** | **Time** | ISO8601 datetime the exchange settlement was approved at. | [optional] |
-| **completed_at** | **Time** | ISO8601 datetime the exchange settlement was completed at. | [optional] |
-## Example
-```ruby
-require 'cybrid_api_bank_ruby'
-instance = CybridApiBank::PatchInternalExchangeSettlementBankModel.new(
-  stored_at: null,
-  approved_at: null,
-  completed_at: null
-)
-```

data/docs/PatchInternalExecutionBankModel.md DELETED Viewed

@@ -1,30 +0,0 @@
-# CybridApiBank::PatchInternalExecutionBankModel
-## Properties
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **source_executed_amount** | **Integer** | The executed amount for source account | [optional] |
-| **destination_executed_amount** | **Integer** | The executed amount for destination account | [optional] |
-| **state** | **String** | The state of the execution. |  |
-| **started_at** | **Time** | The timestamp when the plan started. | [optional] |
-| **completed_at** | **Time** | The timestamp when the plan completed. | [optional] |
-| **failed_at** | **Time** | The timestamp when the plan failed. | [optional] |
-| **failure_code** | **String** | The failure code for the plan, if applicable. | [optional] |
-## Example
-```ruby
-require 'cybrid_api_bank_ruby'
-instance = CybridApiBank::PatchInternalExecutionBankModel.new(
-  source_executed_amount: null,
-  destination_executed_amount: null,
-  state: null,
-  started_at: null,
-  completed_at: null,
-  failed_at: null,
-  failure_code: null
-)
-```

data/docs/PatchInternalExternalBankAccountBankModel.md DELETED Viewed

@@ -1,20 +0,0 @@
-# CybridApiBank::PatchInternalExternalBankAccountBankModel
-## Properties
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **state** | **String** | The state of the external bank account. |  |
-| **failure_code** | **String** | The failure code for failed external bank accounts. | [optional] |
-## Example
-```ruby
-require 'cybrid_api_bank_ruby'
-instance = CybridApiBank::PatchInternalExternalBankAccountBankModel.new(
-  state: null,
-  failure_code: null
-)
-```

data/docs/PatchInternalExternalWalletBankModel.md DELETED Viewed

@@ -1,20 +0,0 @@
-# CybridApiBank::PatchInternalExternalWalletBankModel
-## Properties
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **state** | **String** | The state of the external wallet. |  |
-| **failure_code** | **String** | The failure code for failed external wallets. | [optional] |
-## Example
-```ruby
-require 'cybrid_api_bank_ruby'
-instance = CybridApiBank::PatchInternalExternalWalletBankModel.new(
-  state: null,
-  failure_code: null
-)
-```

data/docs/PatchInternalExternalWalletScreeningBankModel.md DELETED Viewed

@@ -1,28 +0,0 @@
-# CybridApiBank::PatchInternalExternalWalletScreeningBankModel
-## Properties
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **started_at** | **Time** | ISO8601 datetime the external wallet screening was started at. | [optional] |
-| **decided_at** | **Time** | ISO8601 datetime the external wallet screening was decided at. | [optional] |
-| **outcome** | **String** | The outcome of the external wallet screening. | [optional] |
-| **comment** | **String** | The comment to justify the outcome. | [optional] |
-| **reference_id** | **String** | An internal reference to look up the case. | [optional] |
-| **failure_code** | **String** | The failure code for failed screenings. | [optional] |
-## Example
-```ruby
-require 'cybrid_api_bank_ruby'
-instance = CybridApiBank::PatchInternalExternalWalletScreeningBankModel.new(
-  started_at: null,
-  decided_at: null,
-  outcome: null,
-  comment: null,
-  reference_id: null,
-  failure_code: null
-)
-```

data/docs/PatchInternalFeeAssociationBankModel.md DELETED Viewed

@@ -1,20 +0,0 @@
-# CybridApiBank::PatchInternalFeeAssociationBankModel
-## Properties
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **step_identifier** | **String** | The unique identifier for the step. |  |
-| **executed_amount** | **Integer** | The executed fee amount in base units of the currency. |  |
-## Example
-```ruby
-require 'cybrid_api_bank_ruby'
-instance = CybridApiBank::PatchInternalFeeAssociationBankModel.new(
-  step_identifier: null,
-  executed_amount: null
-)
-```

data/docs/PatchInternalFeeChargeBankModel.md DELETED Viewed

@@ -1,26 +0,0 @@
-# CybridApiBank::PatchInternalFeeChargeBankModel
-## Properties
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **state** | **String** | The state of the resource. | [optional] |
-| **pending_at** | **Time** | The timestamp when the order was set to pending. | [optional] |
-| **failed_at** | **Time** | The timestamp when the order was set to failed. | [optional] |
-| **completed_at** | **Time** | The timestamp when the order was set to completed. | [optional] |
-| **failure_code** | **String** | The error message in case of failure. | [optional] |
-## Example
-```ruby
-require 'cybrid_api_bank_ruby'
-instance = CybridApiBank::PatchInternalFeeChargeBankModel.new(
-  state: null,
-  pending_at: null,
-  failed_at: null,
-  completed_at: null,
-  failure_code: null
-)
-```

data/docs/PatchInternalFileBankModel.md DELETED Viewed

@@ -1,20 +0,0 @@
-# CybridApiBank::PatchInternalFileBankModel
-## Properties
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **state** | **String** | File state | [optional] |
-| **failure_code** | **String** | The failure code for failed files. | [optional] |
-## Example
-```ruby
-require 'cybrid_api_bank_ruby'
-instance = CybridApiBank::PatchInternalFileBankModel.new(
-  state: null,
-  failure_code: null
-)
-```

data/docs/PatchInternalIdentityVerificationBankModel.md DELETED Viewed

@@ -1,38 +0,0 @@
-# CybridApiBank::PatchInternalIdentityVerificationBankModel
-## Properties
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **started_at** | **Time** | ISO8601 datetime the identity verification was started at. | [optional] |
-| **external_bank_account_check_guid** | **String** | The GUID of the external bank account check backing the verification. | [optional] |
-| **attested_check_guid** | **String** | The GUID of the attested check backing the verification. | [optional] |
-| **identity_workflow_guid** | **String** | The GUID of the identity workflow backing the verification. | [optional] |
-| **pending_at** | **Time** | ISO8601 datetime the identity verification was started by the user at. | [optional] |
-| **reviewing_at** | **Time** | ISO8601 datetime the identity verification was marked for review at. | [optional] |
-| **expired_at** | **Time** | ISO8601 datetime the identity verification was expired at. | [optional] |
-| **completed_at** | **Time** | ISO8601 datetime the identity verification was completed at. | [optional] |
-| **outcome** | **String** | The outcome of the identity verification. | [optional] |
-| **failure_codes** | **Array&lt;String&gt;** | The reason codes explaining the outcome. | [optional] |
-| **supporting_file_guids** | **Array&lt;String&gt;** | The GUIDs of the supporting files backing the verification. | [optional] |
-## Example
-```ruby
-require 'cybrid_api_bank_ruby'
-instance = CybridApiBank::PatchInternalIdentityVerificationBankModel.new(
-  started_at: null,
-  external_bank_account_check_guid: null,
-  attested_check_guid: null,
-  identity_workflow_guid: null,
-  pending_at: null,
-  reviewing_at: null,
-  expired_at: null,
-  completed_at: null,
-  outcome: null,
-  failure_codes: null,
-  supporting_file_guids: null
-)
-```

data/docs/PatchInternalInternalBankAccountBankModel.md DELETED Viewed

@@ -1,18 +0,0 @@
-# CybridApiBank::PatchInternalInternalBankAccountBankModel
-## Properties
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **stored_at** | **Time** | ISO8601 datetime the bank account was stored at. | [optional] |
-## Example
-```ruby
-require 'cybrid_api_bank_ruby'
-instance = CybridApiBank::PatchInternalInternalBankAccountBankModel.new(
-  stored_at: null
-)
-```

data/docs/PatchInternalInternalWalletBankModel.md DELETED Viewed

@@ -1,18 +0,0 @@
-# CybridApiBank::PatchInternalInternalWalletBankModel
-## Properties
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **stored_at** | **Time** | ISO8601 datetime the wallet was stored at. | [optional] |
-## Example
-```ruby
-require 'cybrid_api_bank_ruby'
-instance = CybridApiBank::PatchInternalInternalWalletBankModel.new(
-  stored_at: null
-)
-```

data/docs/PatchInternalInternalWalletGroupBankModel.md DELETED Viewed

@@ -1,18 +0,0 @@
-# CybridApiBank::PatchInternalInternalWalletGroupBankModel
-## Properties
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **stored_at** | **Time** | ISO8601 datetime the wallet group was stored at. | [optional] |
-## Example
-```ruby
-require 'cybrid_api_bank_ruby'
-instance = CybridApiBank::PatchInternalInternalWalletGroupBankModel.new(
-  stored_at: null
-)
-```

data/docs/PatchInternalInvoiceBankModel.md DELETED Viewed

@@ -1,20 +0,0 @@
-# CybridApiBank::PatchInternalInvoiceBankModel
-## Properties
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **state** | **String** | The state of the invoice. |  |
-| **provider_id** | **String** | The external identifier for the invoice. | [optional] |
-## Example
-```ruby
-require 'cybrid_api_bank_ruby'
-instance = CybridApiBank::PatchInternalInvoiceBankModel.new(
-  state: null,
-  provider_id: null
-)
-```