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/PostInternalPayoutSymbolConfigurationBankModel.md DELETED Viewed

@@ -1,32 +0,0 @@
-# CybridApiBank::PostInternalPayoutSymbolConfigurationBankModel
-## Properties
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **type** | **String** | The payout symbol configuration type. |  |
-| **environment** | **String** | The environment the configuration is associated with. | [optional] |
-| **bank_guid** | **String** | The bank identifier that the configuration is associated with. | [optional] |
-| **enabled** | **Boolean** | Flag indicating if the symbol is enabled for payout on the platform. |  |
-| **symbol** | **String** | The symbol code of the configuration. |  |
-| **country_code** | **String** | The ISO 3166 2-Alpha country code. |  |
-| **participants_type** | **String** | The type of participants the symbol is enabled for. |  |
-| **route** | **String** | The route the symbol is enabled for. |  |
-## Example
-```ruby
-require 'cybrid_api_bank_ruby'
-instance = CybridApiBank::PostInternalPayoutSymbolConfigurationBankModel.new(
-  type: null,
-  environment: null,
-  bank_guid: null,
-  enabled: null,
-  symbol: null,
-  country_code: null,
-  participants_type: null,
-  route: null
-)
-```

data/docs/PostInternalReconciliationBankModel.md DELETED Viewed

@@ -1,26 +0,0 @@
-# CybridApiBank::PostInternalReconciliationBankModel
-## Properties
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **category** | **String** | The category of the reconciliation. |  |
-| **confidence** | **String** | The confidence of the reconciliation. |  |
-| **direction** | **String** | The direction of the reconciliation. |  |
-| **transaction_id** | **String** | The provider identifier. |  |
-| **transfer_guid** | **String** | The transfer identifier. |  |
-## Example
-```ruby
-require 'cybrid_api_bank_ruby'
-instance = CybridApiBank::PostInternalReconciliationBankModel.new(
-  category: null,
-  confidence: null,
-  direction: null,
-  transaction_id: null,
-  transfer_guid: null
-)
-```

data/docs/PostInternalStageBankModel.md DELETED Viewed

@@ -1,32 +0,0 @@
-# CybridApiBank::PostInternalStageBankModel
-## Properties
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **type** | **String** | The type of stage. |  |
-| **plan_guid** | **String** | The unique identifier for the  plan. |  |
-| **failure_code** | **String** | The failure code for the stage, if applicable. | [optional] |
-| **failed_at** | **Time** | The timestamp when the stage failed, if applicable. | [optional] |
-| **planned_at** | **Time** | The timestamp when the stage is planned, if applicable. | [optional] |
-| **accounts** | [**Array&lt;PostInternalAccountAssociationBankModel&gt;**](PostInternalAccountAssociationBankModel.md) | The accounts associated with the stage. |  |
-| **fees** | [**Array&lt;PostInternalFeeAssociationBankModel&gt;**](PostInternalFeeAssociationBankModel.md) | The custom fees associated with the stage |  |
-| **stage_index** | **Integer** | The index of the stage within the plan, starting from 0. |  |
-## Example
-```ruby
-require 'cybrid_api_bank_ruby'
-instance = CybridApiBank::PostInternalStageBankModel.new(
-  type: null,
-  plan_guid: null,
-  failure_code: null,
-  failed_at: null,
-  planned_at: null,
-  accounts: null,
-  fees: null,
-  stage_index: null
-)
-```

data/docs/PostInternalSystemTransactionBankModel.md DELETED Viewed

@@ -1,30 +0,0 @@
-# CybridApiBank::PostInternalSystemTransactionBankModel
-## Properties
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **guid** | **String** | The internal identifier for the system transaction. |  |
-| **provider_id** | **String** | The external identifier for the system transaction. |  |
-| **system_account_guid** | **String** | The identifier of the account the transaction is associated to. |  |
-| **amount** | **Integer** | The amount in the transaction. |  |
-| **asset_code** | **String** | The asset code. |  |
-| **direction** | **String** | The direction of the transaction: debit or credit. |  |
-| **details** | **String** | The description for the transaction. | [optional] |
-## Example
-```ruby
-require 'cybrid_api_bank_ruby'
-instance = CybridApiBank::PostInternalSystemTransactionBankModel.new(
-  guid: null,
-  provider_id: null,
-  system_account_guid: null,
-  amount: null,
-  asset_code: null,
-  direction: null,
-  details: null
-)
-```

data/docs/PostInternalTradeBankModel.md DELETED Viewed

@@ -1,28 +0,0 @@
-# CybridApiBank::PostInternalTradeBankModel
-## Properties
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **trade_type** | **String** | The type of trade. |  |
-| **fiat_account_guid** | **String** | The identifier for the fiat account to use for the trade. Required if the customer or bank has multiple fiat accounts. | [optional] |
-| **source_account_guid** | **String** | The identifier for the source account to use for the trade. Required if there are multiple cybrid accounts. | [optional] |
-| **destination_account_guid** | **String** | The identifier for the destination account to use for the trade. Required if there are multiple cybrid accounts. | [optional] |
-| **quote_guid** | **String** | The associated quote&#39;s identifier. |  |
-| **environment** | **String** | The environment the quote is for. |  |
-## Example
-```ruby
-require 'cybrid_api_bank_ruby'
-instance = CybridApiBank::PostInternalTradeBankModel.new(
-  trade_type: null,
-  fiat_account_guid: null,
-  source_account_guid: null,
-  destination_account_guid: null,
-  quote_guid: null,
-  environment: null
-)
-```

data/docs/PostInternalTradingSymbolConfigurationBankModel.md DELETED Viewed

@@ -1,28 +0,0 @@
-# CybridApiBank::PostInternalTradingSymbolConfigurationBankModel
-## Properties
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **type** | **String** | The type of the configuration. |  |
-| **environment** | **String** | The environment for the configuration. Required when type is platform. | [optional] |
-| **execution_mode** | **String** | The execution mode for the configuration Required when type is platform. Optional when type is bank. | [optional] |
-| **bank_guid** | **String** | The bank_guid for the configuration. Required when type is bank. | [optional] |
-| **enabled** | **Boolean** | Flag indicating if the symbol is enabled |  |
-| **symbol** | **String** | The trading symbol being configured |  |
-## Example
-```ruby
-require 'cybrid_api_bank_ruby'
-instance = CybridApiBank::PostInternalTradingSymbolConfigurationBankModel.new(
-  type: null,
-  environment: null,
-  execution_mode: null,
-  bank_guid: null,
-  enabled: null,
-  symbol: null
-)
-```

data/docs/PostInternalTransactionMonitorBankModel.md DELETED Viewed

@@ -1,26 +0,0 @@
-# CybridApiBank::PostInternalTransactionMonitorBankModel
-## Properties
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **type** | **String** | Type of transaction_monitor to create. |  |
-| **account_guid** | **String** | The account identifier. Required when type is account. | [optional] |
-| **direction** | **String** | The direction to monitor for transactions Optional when type is account. | [optional] |
-| **polling_interval** | **Integer** | The interval in seconds to poll for transactions. Required when type is account. | [optional] |
-| **start_date** | **Date** | The date to start monitoring transactions. Required when type is account. | [optional] |
-## Example
-```ruby
-require 'cybrid_api_bank_ruby'
-instance = CybridApiBank::PostInternalTransactionMonitorBankModel.new(
-  type: null,
-  account_guid: null,
-  direction: null,
-  polling_interval: null,
-  start_date: null
-)
-```

data/docs/PostInternalTransferBankModel.md DELETED Viewed

@@ -1,38 +0,0 @@
-# CybridApiBank::PostInternalTransferBankModel
-## Properties
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **transfer_type** | **String** | The type of internal transfer. |  |
-| **environment** | **String** | The environment to transfer funds in. |  |
-| **quote_guid** | **String** | The associated quote&#39;s identifier. | [optional] |
-| **transfer_guid** | **String** | The associated tranfer&#39;s identifier. Used for returns. | [optional] |
-| **source_account_guid** | **String** | The source account guid. | [optional] |
-| **destination_account_guid** | **String** | The destination account guid. | [optional] |
-| **supports_reconciliation** | **Boolean** | Flag indicating if the transfer supports reconciliation. | [optional] |
-| **requires_manual_confirmation** | **Boolean** | Override indicating if the transfer requires manual confirmation. | [optional] |
-| **external_id** | **String** | The external identifier for the transfer. | [optional] |
-| **labels** | **Array&lt;String&gt;** | The labels associated with the transfer. | [optional] |
-| **associations** | [**Array&lt;InternalTransferAssociationBankModel&gt;**](InternalTransferAssociationBankModel.md) | Transfers associated with this record. | [optional] |
-## Example
-```ruby
-require 'cybrid_api_bank_ruby'
-instance = CybridApiBank::PostInternalTransferBankModel.new(
-  transfer_type: null,
-  environment: null,
-  quote_guid: null,
-  transfer_guid: null,
-  source_account_guid: null,
-  destination_account_guid: null,
-  supports_reconciliation: null,
-  requires_manual_confirmation: null,
-  external_id: null,
-  labels: null,
-  associations: null
-)
-```

data/docs/PostInternalTransferRailConfigurationBankModel.md DELETED Viewed

@@ -1,26 +0,0 @@
-# CybridApiBank::PostInternalTransferRailConfigurationBankModel
-## Properties
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **type** | **String** | The type of configuration: bank or platform. |  |
-| **environment** | **String** | The environment the configuration is associated with. | [optional] |
-| **bank_guid** | **String** | The bank identifier that the configuration is associated with. | [optional] |
-| **hold_duration** | **Integer** | The amount of time that the transfer funds should be held, in seconds. |  |
-| **rail** | **String** | The payment rail. |  |
-## Example
-```ruby
-require 'cybrid_api_bank_ruby'
-instance = CybridApiBank::PostInternalTransferRailConfigurationBankModel.new(
-  type: null,
-  environment: null,
-  bank_guid: null,
-  hold_duration: null,
-  rail: null
-)
-```

data/docs/PostInternalTransferScreeningBankModel.md DELETED Viewed

@@ -1,20 +0,0 @@
-# CybridApiBank::PostInternalTransferScreeningBankModel
-## Properties
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **transfer_guid** | **String** | The identifier of the transfer being screened. |  |
-| **force_review** | **Boolean** | True if the screening should be forced to review. | [optional] |
-## Example
-```ruby
-require 'cybrid_api_bank_ruby'
-instance = CybridApiBank::PostInternalTransferScreeningBankModel.new(
-  transfer_guid: null,
-  force_review: null
-)
-```

data/docs/PostInternalWalletServiceBankModel.md DELETED Viewed

@@ -1,26 +0,0 @@
-# CybridApiBank::PostInternalWalletServiceBankModel
-## Properties
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **environment** | **String** | The account environment. |  |
-| **type** | **String** | The type of wallet service. |  |
-| **name** | **String** | The name of the wallet service. |  |
-| **provider_id** | **String** | The id of the account at the third-party service. | [optional] |
-| **guid** | **String** | The unique identifier for the wallet service. | [optional] |
-## Example
-```ruby
-require 'cybrid_api_bank_ruby'
-instance = CybridApiBank::PostInternalWalletServiceBankModel.new(
-  environment: null,
-  type: null,
-  name: null,
-  provider_id: null,
-  guid: null
-)
-```

data/docs/PostSignalInternalExternalWalletScreeningBankModel.md DELETED Viewed

@@ -1,22 +0,0 @@
-# CybridApiBank::PostSignalInternalExternalWalletScreeningBankModel
-## Properties
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **reference_id** | **String** | An internal reference to look up the case. |  |
-| **comment** | **String** | The comment to justify the manual decision. |  |
-| **outcome** | **String** | The manual decision. |  |
-## Example
-```ruby
-require 'cybrid_api_bank_ruby'
-instance = CybridApiBank::PostSignalInternalExternalWalletScreeningBankModel.new(
-  reference_id: null,
-  comment: null,
-  outcome: null
-)
-```

data/docs/PostSignalInternalIdentityVerificationBankAccountHolderAddressBankModel.md DELETED Viewed

@@ -1,28 +0,0 @@
-# CybridApiBank::PostSignalInternalIdentityVerificationBankAccountHolderAddressBankModel
-## Properties
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **street** | **String** | The first line of the address. |  |
-| **street2** | **String** | The optional second line of the address. | [optional] |
-| **city** | **String** | The city of the address. |  |
-| **subdivision** | **String** | The ISO 3166-2 subdivision code of the address; not used by all countries. | [optional] |
-| **postal_code** | **String** | The postal/post/zip code of the address; not used by all countries. | [optional] |
-| **country_code** | **String** | The ISO 3166 country 2-Alpha country code of the address. |  |
-## Example
-```ruby
-require 'cybrid_api_bank_ruby'
-instance = CybridApiBank::PostSignalInternalIdentityVerificationBankAccountHolderAddressBankModel.new(
-  street: null,
-  street2: null,
-  city: null,
-  subdivision: null,
-  postal_code: null,
-  country_code: null
-)
-```

data/docs/PostSignalInternalIdentityVerificationBankAccountHolderNameBankModel.md DELETED Viewed

@@ -1,18 +0,0 @@
-# CybridApiBank::PostSignalInternalIdentityVerificationBankAccountHolderNameBankModel
-## Properties
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **full** | **String** | The customer&#39;s first name. |  |
-## Example
-```ruby
-require 'cybrid_api_bank_ruby'
-instance = CybridApiBank::PostSignalInternalIdentityVerificationBankAccountHolderNameBankModel.new(
-  full: null
-)
-```

data/docs/PostSignalInternalIdentityVerificationBankModel.md DELETED Viewed

@@ -1,28 +0,0 @@
-# CybridApiBank::PostSignalInternalIdentityVerificationBankModel
-## Properties
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **reference_id** | **String** | An internal reference to look up the case. |  |
-| **comment** | **String** | The comment to justify the manual decision. |  |
-| **bank_account_holder_name** | [**PostSignalInternalIdentityVerificationBankAccountHolderNameBankModel**](PostSignalInternalIdentityVerificationBankAccountHolderNameBankModel.md) |  | [optional] |
-| **bank_account_holder_address** | [**PostSignalInternalIdentityVerificationBankAccountHolderAddressBankModel**](PostSignalInternalIdentityVerificationBankAccountHolderAddressBankModel.md) |  | [optional] |
-| **decision** | **String** | The manual decision. |  |
-| **failure_codes** | **Array&lt;String&gt;** | The reason codes explaining the outcome. |  |
-## Example
-```ruby
-require 'cybrid_api_bank_ruby'
-instance = CybridApiBank::PostSignalInternalIdentityVerificationBankModel.new(
-  reference_id: null,
-  comment: null,
-  bank_account_holder_name: null,
-  bank_account_holder_address: null,
-  decision: null,
-  failure_codes: null
-)
-```