cybrid_api_bank_ruby 0.121.11 → 0.121.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 99b50e9df18f45e6d9c5a23116dd95a72dcafab6a970f1c47dd7e10ee88e0c15
-  data.tar.gz: 8eb9b76341f2844182ac9ec4e877b44884dcb9898fd3cb24eeda0bf773ebe030
+  metadata.gz: 43b20d60624d73a5e0a21d43f5c9450d585673e36240cf2bfb80588705d398ea
+  data.tar.gz: 7f130724339626aea546226822d55fe69bef2563f4e863803f61f6a4ac579a14
 SHA512:
-  metadata.gz: 7fb7388044258b969c7782c7c67db8b4445fe98373531c153238efefd33be5a6d14cf2df6196c762321c2eb8709b50f829600db40c568401f9fe8a5d2e9ca6ea
-  data.tar.gz: b5c950b882f7e28d330293546a8a24f0012feb1c99ffc82c5ab8116fbfaa7f089890fa68f14af1b0f35958a1477af9ac93f629d30454131811dd012654b1166e
+  metadata.gz: 33d7b91527d2077a57647be8a851d601c5b271ad227ceb45bcd26e2809d424b5167095f3db20ddf0c9b70cd29edfa2f55a0ab181c00418bd479d1eac8ae4c80b
+  data.tar.gz: f59ff13fca95bd6e742268e2d133463c0eed5ed32f902cc73aa977552f5609a071d01bb002b761f6fe71fcb40681320a22aed7cebc5d1ca1742a22df51fb0750

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    cybrid_api_bank_ruby (0.121.11)
+    cybrid_api_bank_ruby (0.121.12)
       typhoeus (~> 1.0, >= 1.0.1)
 
 GEM

data/README.md

@@ -151,8 +151,8 @@ An `Organization` can have multiple `banks`, in either `Sandbox` or `Production`
 
 This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
 
-- API version: v0.121.11
-- Package version: 0.121.11
+- API version: v0.121.12
+- Package version: 0.121.12
 - Build package: org.openapitools.codegen.languages.RubyClientCodegen
 
 ## Installation
@@ -168,16 +168,16 @@ gem build cybrid_api_bank_ruby.gemspec
 Then either install the gem locally:
 
 ```shell
-gem install ./cybrid_api_bank_ruby-0.121.11.gem
+gem install ./cybrid_api_bank_ruby-0.121.12.gem
 ```
 
-(for development, run `gem install --dev ./cybrid_api_bank_ruby-0.121.11.gem` to install the development dependencies)
+(for development, run `gem install --dev ./cybrid_api_bank_ruby-0.121.12.gem` to install the development dependencies)
 
 or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
 
 Finally add this to the Gemfile:
 
-    gem 'cybrid_api_bank_ruby', '~> 0.121.11'
+    gem 'cybrid_api_bank_ruby', '~> 0.121.12'
 
 ### Install from Git
 

data/cybrid_api_bank_ruby.gemspec

@@ -5,7 +5,7 @@
 
 ## Cybrid API documentation  Welcome to Cybrid, an all-in-one crypto platform that enables you to easily **build** and **launch** white-label crypto products or services.  In these documents, you'll find details on how our REST API operates and generally how our platform functions.  If you're looking for our UI SDK Widgets for Web or Mobile (iOS/Android), generated API clients, or demo applications, head over to our [Github repo](https://github.com/Cybrid-app).  💡 We recommend bookmarking the [Cybrid LinkTree](https://linktr.ee/cybridtechnologies) which contains many helpful links to platform resources.  ## Getting Started  This is Cybrid's public interactive API documentation, which allows you to fully test our APIs. If you'd like to use a different tool to exercise our APIs, you can download the [Open API 3.0 yaml](https://bank.production.cybrid.app/api/schema/v1/swagger.yaml) for import.  If you're new to our APIs and the Cybrid Platform, follow the below guides to get set up and familiar with the platform:  1. [Introduction](https://docs.cybrid.xyz/docs/introduction) 2. [Platform Introduction](https://docs.cybrid.xyz/docs/how-is-cybrid-architected) 3. [Testing with Hosted Web Demo App](https://docs.cybrid.xyz/docs/testing-with-hosted-web-demo-app)  In [Getting Started in the Cybrid Sandbox](https://docs.cybrid.xyz/docs/how-do-i-get-started-with-the-sandbox), we walk you through how to use the [Cybrid Sandbox](https://id.sandbox.cybrid.app/) to create a test bank and generate API keys. In [Getting Ready for Trading](https://kb.cybrid.xyz/getting-ready-for-trading), we walk through creating customers, customer identities, accounts, as well as executing quotes and trades.  ## Working with the Cybrid Platform  There are three primary ways you can interact with the Cybrid platform:  1. Directly via our RESTful API (this documentation) 2. Using our API clients available in a variety of languages ([Angular](https://github.com/Cybrid-app/cybrid-api-bank-angular), [Java](https://github.com/Cybrid-app/cybrid-api-bank-java), [Kotlin](https://github.com/Cybrid-app/cybrid-api-bank-kotlin), [Python](https://github.com/Cybrid-app/cybrid-api-bank-python), [Ruby](https://github.com/Cybrid-app/cybrid-api-bank-ruby), [Swift](https://github.com/Cybrid-app/cybrid-api-bank-swift) or [Typescript](https://github.com/Cybrid-app/cybrid-api-bank-typescript)) 3. Integrating a platform specific SDK ([Web](https://github.com/Cybrid-app/cybrid-sdk-web), [Android](https://github.com/Cybrid-app/cybrid-sdk-android), [iOS](https://github.com/Cybrid-app/cybrid-sdk-ios))  Our complete set of APIs allows you to manage resources across three distinct areas: your `Organization`, your `Banks` and your `Identities`. For most of your testing and interaction you'll be using the `Bank` API, which is where the majority of APIs reside.  *The complete set of APIs can be found on the following pages:*  | API                                                              | Description                                                 | |------------------------------------------------------------------|-------------------------------------------------------------| | [Organization API](https://organization.production.cybrid.app/api/schema/swagger-ui)   | APIs to manage organizations                                | | [Bank API](https://bank.production.cybrid.app/api/schema/swagger-ui)                   | APIs to manage banks (and all downstream customer activity) | | [Identities API](https://id.production.cybrid.app/api/schema/swagger-ui)                       | APIs to manage organization and bank identities             |  For questions please contact [Support](mailto:support@cybrid.xyz) at any time for assistance, or contact the [Product Team](mailto:product@cybrid.xyz) for product suggestions.  ## Authenticating with the API  The Cybrid Platform uses OAuth 2.0 Bearer Tokens to authenticate requests to the platform. Credentials to create `Organization` and `Bank` tokens can be generated via the [Cybrid Sandbox](https://id.production.cybrid.app). Access tokens can be generated for a `Customer` as well via the [Cybrid IdP](https://id.production.cybrid.app) as well.  An `Organization` access token applies broadly to the whole Organization and all of its `Banks`, whereas, a `Bank` access token is specific to an individual Bank. `Customer` tokens, similarly, are scoped to a specific customer in a bank.  Both `Organization` and `Bank` tokens can be created using the OAuth Client Credential Grant flow. Each Organization and Bank has its own unique `Client ID` and `Secret` that allows for machine-to-machine authentication.  A `Bank` can then generate `Customer` access tokens via API using our [Identities API](https://id.production.cybrid.app/api/schema/swagger-ui).  <font color=\"orange\">**⚠️ Never share your Client ID or Secret publicly or in your source code repository.**</font>  Your `Client ID` and `Secret` can be exchanged for a time-limited `Bearer Token` by interacting with the Cybrid Identity Provider or through interacting with the **Authorize** button in this document.  The following curl command can be used to quickly generate a `Bearer Token` for use in testing the API or demo applications.  ``` # Example request when using Bank credentials curl -X POST https://id.production.cybrid.app/oauth/token -d '{     \"grant_type\": \"client_credentials\",     \"client_id\": \"<Your Client ID>\",     \"client_secret\": \"<Your Secret>\",     \"scope\": \"banks:read banks:write bank_applications:execute accounts:read accounts:execute counterparties:read counterparties:write counterparties:execute customers:read customers:write customers:execute prices:read quotes:execute quotes:read trades:execute trades:read transfers:execute transfers:read external_bank_accounts:read external_bank_accounts:write external_bank_accounts:execute external_wallets:read external_wallets:execute workflows:read workflows:execute deposit_addresses:read deposit_addresses:execute deposit_bank_accounts:read deposit_bank_accounts:execute invoices:read invoices:write invoices:execute identity_verifications:read identity_verifications:write identity_verifications:execute\"   }' -H \"Content-Type: application/json\"  # When using Organization credentials set `scope` to 'organizations:read organizations:write organization_applications:execute banks:read banks:write banks:execute bank_applications:execute users:read users:execute counterparties:read customers:read accounts:read prices:read quotes:execute quotes:read trades:execute trades:read transfers:read transfers:execute external_bank_accounts:read external_wallets:read workflows:read deposit_addresses:read deposit_bank_accounts:read invoices:read subscriptions:read subscriptions:write subscriptions:execute subscription_events:read subscription_events:execute identity_verifications:read' ``` <font color=\"orange\">**⚠️ Note: The above curl will create a bearer token with full scope access. Delete scopes if you'd like to restrict access.**</font>  ## Authentication Scopes  The Cybrid platform supports the use of scopes to control the level of access a token is limited to. Scopes do not grant access to resources; instead, they provide limits, in support of the least privilege principal.  The following scopes are available on the platform and can be requested when generating either an Organization, Bank or Customer token. Generally speaking, the _Read_ scope is required to read and list resources, the _Write_ scope is required to update a resource and the _Execute_ scope is required to create a resource.  | Resource              | Read scope (Token Type)                                    | Write scope (Token Type)                      | Execute scope (Token Type)                       | |-----------------------|------------------------------------------------------------|-----------------------------------------------|--------------------------------------------------| | Account               | accounts:read (Organization, Bank, Customer)               |                                               | accounts:execute (Bank, Customer)                | | Bank                  | banks:read (Organization, Bank)                            | banks:write (Organization, Bank)              | banks:execute (Organization)                     | | Customer              | customers:read (Organization, Bank, Customer)              | customers:write (Bank, Customer)              | customers:execute (Bank)                         | | Counterparty          | counterparties:read (Organization, Bank, Customer)         | counterparties:write (Bank, Customer)         | counterparties:execute (Bank)                    | | Deposit Address       | deposit_addresses:read (Organization, Bank, Customer)      | deposit_addresses:write (Bank, Customer)      | deposit_addresses:execute (Bank, Customer)       | | External Bank Account | external_bank_accounts:read (Organization, Bank, Customer) | external_bank_accounts:write (Bank, Customer) | external_bank_accounts:execute (Bank, Customer)  | | External Wallet       | external_wallet:read (Organization, Bank, Customer)        |                                               | external_wallet:execute (Bank, Customer)         | | Organization          | organizations:read (Organization)                          | organizations:write (Organization)            |                                                  | | User                  | users:read (Organization)                                  |                                               | users:execute (Organization)                     | | Price                 | prices:read (Bank, Customer)                               |                                               |                                                  | | Quote                 | quotes:read (Organization, Bank, Customer)                 |                                               | quotes:execute (Organization, Bank, Customer)    | | Trade                 | trades:read (Organization, Bank, Customer)                 |                                               | trades:execute (Organization, Bank, Customer)    | | Transfer              | transfers:read (Organization, Bank, Customer)              |                                               | transfers:execute (Organization, Bank, Customer) | | Workflow              | workflows:read (Organization, Bank, Customer)              |                                               | workflows:execute (Bank, Customer)               | | Invoice               | invoices:read (Organization, Bank, Customer)               | invoices:write (Bank, Customer)               | invoices:execute (Bank, Customer)                |  ## Available Endpoints  The available APIs for the [Identity](https://id.production.cybrid.app/api/schema/swagger-ui), [Organization](https://organization.production.cybrid.app/api/schema/swagger-ui) and [Bank](https://bank.production.cybrid.app/api/schema/swagger-ui) API services are listed below:  | API Service  | Model                | API Endpoint Path              | Description                                                                                       | |--------------|----------------------|--------------------------------|---------------------------------------------------------------------------------------------------| | Identity     | Bank                 | /api/bank_applications         | Create and list banks                                                                             | | Identity     | CustomerToken        | /api/customer_tokens           | Create customer JWT access tokens                                                                 | | Identity     | Organization         | /api/organization_applications | Create and list organizations                                                                     | | Identity     | Organization         | /api/users                     | Create and list organization users                                                                | | Organization | Organization         | /api/organizations             | APIs to retrieve and update organization name                                                     | | Bank         | Account              | /api/accounts                  | Create and list accounts, which hold a specific asset for a customers                             | | Bank         | Asset                | /api/assets                    | Get a list of assets supported by the platform (ex: BTC, ETH)                                     | | Bank         | Bank                 | /api/banks                     | Create, update and list banks, the parent to customers, accounts, etc                             | | Bank         | Customer             | /api/customers                 | Create and list customers                                                                         | | Bank         | Counterparty         | /api/counterparties            | Create and list counterparties                                                                    | | Bank         | DepositAddress       | /api/deposit_addresses         | Create, get and list deposit addresses                                                            | | Bank         | ExternalBankAccount  | /api/external_bank_accounts    | Create, get and list external bank accounts, which connect customer bank accounts to the platform | | Bank         | ExternalWallet       | /api/external_wallets          | Create, get, list and delete external wallets, which connect customer wallets to the platform     | | Bank         | IdentityVerification | /api/identity_verifications    | Create and list identity verifications, which are performed on customers for KYC                  | | Bank         | Invoice              | /api/invoices                  | Create, get, cancel and list invoices                                                             | | Bank         | PaymentInstruction   | /api/payment_instructions      | Create, get and list payment instructions for invoices                                            | | Bank         | Price                | /api/prices                    | Get the current prices for assets on the platform                                                 | | Bank         | Quote                | /api/quotes                    | Create and list quotes, which are required to execute trades                                      | | Bank         | Symbol               | /api/symbols                   | Get a list of symbols supported for trade (ex: BTC-USD)                                           | | Bank         | Trade                | /api/trades                    | Create and list trades, which buy or sell cryptocurrency                                          | | Bank         | Transfer             | /api/transfers                 | Create, get and list transfers (e.g., funding, book)                                              | | Bank         | Workflow             | /api/workflows                 | Create, get and list workflows                                                                    |  ## Understanding Object Models & Endpoints  **Organizations**  An `Organization` is meant to represent the organization partnering with Cybrid to use our platform.  An `Organization` typically does not directly interact with `customers`. Instead, an Organization has one or more `banks`, which encompass the financial service offerings of the platform.  **Banks**  A `Bank` is owned by an `Organization` and can be thought of as an environment or container for `customers` and product offerings. Banks are created in either `Sandbox` or `Production` mode, where `Sandbox` is the environment that you would test, prototype and build in prior to moving to `Production`.  An `Organization` can have multiple `banks`, in either `Sandbox` or `Production` environments. A `Sandbox Bank` will be backed by stubbed data and process flows. For instance, funding source transfer processes as well as trades will be simulated rather than performed, however asset prices are representative of real-world values. You have an unlimited amount of simulated fiat currency for testing purposes.  **Customers**  `Customers` represent your banking users on the platform. At present, we offer support for `Individuals` as Customers.  `Customers` must be verified (i.e., KYC'd) in our system before they can play any part on the platform, which means they must have an associated and a passing `Identity Verification`. See the Identity Verifications section for more details on how a customer can be verified.  `Customers` must also have an `Account` to be able to transact, in the desired asset class. See the Accounts APIs for more details on setting up accounts for the customer. 
 
-The version of the OpenAPI document: v0.121.11
+The version of the OpenAPI document: v0.121.12
 Contact: support@cybrid.app
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 6.0.0

data/docs/BanksBankApi.md

@@ -33,7 +33,7 @@ CybridApiBank.configure do |config|
 end
 
 api_instance = CybridApiBank::BanksBankApi.new
-post_bank_bank_model = CybridApiBank::PostBankBankModel.new({name: 'name_example', type: 'sandbox', supported_trading_symbols: ['supported_trading_symbols_example'], features: ['attestation_identity_records'], supported_fiat_account_assets: ['supported_fiat_account_assets_example']}) # PostBankBankModel | 
+post_bank_bank_model = CybridApiBank::PostBankBankModel.new({type: 'sandbox', name: 'name_example', supported_trading_symbols: ['supported_trading_symbols_example'], supported_fiat_account_assets: ['supported_fiat_account_assets_example'], supported_country_codes: ['supported_country_codes_example'], features: ['attestation_identity_records']}) # PostBankBankModel | 
 
 begin
   # Create Bank

data/docs/CounterpartiesBankApi.md

@@ -32,7 +32,7 @@ CybridApiBank.configure do |config|
 end
 
 api_instance = CybridApiBank::CounterpartiesBankApi.new
-post_counterparty_bank_model = CybridApiBank::PostCounterpartyBankModel.new({type: 'business'}) # PostCounterpartyBankModel | 
+post_counterparty_bank_model = CybridApiBank::PostCounterpartyBankModel.new({type: 'business', address: CybridApiBank::PostCounterpartyAddressBankModel.new({street: 'street_example', city: 'city_example', country_code: 'country_code_example'})}) # PostCounterpartyBankModel | 
 
 begin
   # Create Counterparty

data/docs/CounterpartyAddressBankModel.md

@@ -7,7 +7,7 @@
 | **street** | **String** | The first line of the address. | [optional] |
 | **street2** | **String** | The optional second line of the address. | [optional] |
 | **city** | **String** | The city of the address. | [optional] |
-| **subdivision** | **String** | The provide/state/region of the address; not used by all countries. | [optional] |
+| **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. | [optional] |
 

data/docs/CustomerAddressBankModel.md

@@ -7,7 +7,7 @@
 | **street** | **String** | The first line of the address. | [optional] |
 | **street2** | **String** | The optional second line of the address. | [optional] |
 | **city** | **String** | The city of the address. | [optional] |
-| **subdivision** | **String** | The provide/state/region of the address; not used by all countries. | [optional] |
+| **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. | [optional] |
 

data/docs/DepositBankAccountCounterpartyAddressBankModel.md

@@ -7,7 +7,7 @@
 | **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 provide/state/region of the address; not used by all countries. | [optional] |
+| **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. |  |
 

data/docs/DepositBankAccountsBankApi.md

@@ -32,7 +32,7 @@ CybridApiBank.configure do |config|
 end
 
 api_instance = CybridApiBank::DepositBankAccountsBankApi.new
-post_deposit_bank_account_bank_model = CybridApiBank::PostDepositBankAccountBankModel.new({account_guid: 'account_guid_example'}) # PostDepositBankAccountBankModel | 
+post_deposit_bank_account_bank_model = CybridApiBank::PostDepositBankAccountBankModel.new({type: 'main', account_guid: 'account_guid_example'}) # PostDepositBankAccountBankModel | 
 
 begin
   # Create Deposit Bank Account

data/docs/ExternalBankAccountPiiInnerAddressesInnerBankModel.md

@@ -7,7 +7,7 @@
 | **street** | **String** | The first line of the address. | [optional] |
 | **street2** | **String** | The optional second line of the address. | [optional] |
 | **city** | **String** | The city of the address. | [optional] |
-| **subdivision** | **String** | The provide/state/region of the address; not used by all countries. | [optional] |
+| **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. | [optional] |
 

data/docs/ExternalBankAccountsBankApi.md

@@ -34,7 +34,7 @@ CybridApiBank.configure do |config|
 end
 
 api_instance = CybridApiBank::ExternalBankAccountsBankApi.new
-post_external_bank_account_bank_model = CybridApiBank::PostExternalBankAccountBankModel.new({name: 'name_example', account_kind: 'plaid', asset: 'asset_example'}) # PostExternalBankAccountBankModel | 
+post_external_bank_account_bank_model = CybridApiBank::PostExternalBankAccountBankModel.new({name: 'name_example', account_kind: 'plaid'}) # PostExternalBankAccountBankModel | 
 
 begin
   # Create ExternalBankAccount

data/docs/IdentityVerificationWithDetailsPiiAddressBankModel.md

@@ -7,7 +7,7 @@
 | **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 provide/state/region of the address; not used by all countries. | [optional] |
+| **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. |  |
 

data/docs/IdentityVerificationsBankApi.md

@@ -32,7 +32,7 @@ CybridApiBank.configure do |config|
 end
 
 api_instance = CybridApiBank::IdentityVerificationsBankApi.new
-post_identity_verification_bank_model = CybridApiBank::PostIdentityVerificationBankModel.new({type: 'kyc', method: 'attested'}) # PostIdentityVerificationBankModel | 
+post_identity_verification_bank_model = CybridApiBank::PostIdentityVerificationBankModel.new({type: 'kyc'}) # PostIdentityVerificationBankModel | 
 
 begin
   # Create Identity Verification

data/docs/PatchBankBankModel.md

@@ -4,8 +4,8 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **name** | **String** | The bank's name. | [optional] |
-| **supported_trading_symbols** | **Array<String>** | The bank's list of supported trading symbols. | [optional] |
+| **name** | **String** | The name of the bank. | [optional] |
+| **supported_trading_symbols** | **Array<String>** | The trading symbols supported by the bank. | [optional] |
 
 ## Example
 

data/docs/PostAccountBankModel.md

@@ -5,7 +5,7 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **type** | **String** | The account type. |  |
-| **customer_guid** | **String** | The customer identifier associated with the account. | [optional] |
+| **customer_guid** | **String** | TThe customer identifier associated with the account. | [optional] |
 | **asset** | **String** | The asset code. |  |
 | **name** | **String** | The name of the account. |  |
 | **labels** | **Array<String>** | The labels associated with the account. | [optional] |

data/docs/PostBankBankModel.md

@@ -4,12 +4,12 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **name** | **String** | The bank's name. |  |
-| **type** | **String** | The bank's type. At present, only **sandbox** is supported. |  |
-| **supported_trading_symbols** | **Array<String>** | The bank's list of supported trading symbols. |  |
-| **features** | **Array<String>** | The bank's enabled features. |  |
-| **supported_fiat_account_assets** | **Array<String>** | The bank's list of supported fiat assets. |  |
-| **supported_country_codes** | **Array<String>** | The bank's list of supported country codes. | [optional] |
+| **type** | **String** | The type of bank. |  |
+| **name** | **String** | The name of the bank. |  |
+| **supported_trading_symbols** | **Array<String>** | The trading symbols supported by the bank. |  |
+| **supported_fiat_account_assets** | **Array<String>** | The fiat account assets supported by the bank. |  |
+| **supported_country_codes** | **Array<String>** | The country codes supported by the bank. |  |
+| **features** | **Array<String>** | The features supported by the bank. |  |
 
 ## Example
 
@@ -17,12 +17,12 @@
 require 'cybrid_api_bank_ruby'
 
 instance = CybridApiBank::PostBankBankModel.new(
-  name: null,
   type: null,
+  name: null,
   supported_trading_symbols: null,
-  features: null,
   supported_fiat_account_assets: null,
-  supported_country_codes: null
+  supported_country_codes: null,
+  features: null
 )
 ```
 

data/docs/PostCounterpartyAliasesInnerBankModel.md

@@ -4,7 +4,7 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **full** | **String** | The counterparty's full name; optional for business counterparties.. | [optional] |
+| **full** | **String** | The counterparty's full name. Required when type is business. | [optional] |
 
 ## Example
 

data/docs/PostCounterpartyBankModel.md

@@ -6,10 +6,10 @@
 | ---- | ---- | ----------- | ----- |
 | **type** | **String** | The counterparty's type. |  |
 | **customer_guid** | **String** | The owning customer's identifier. | [optional] |
+| **address** | [**PostCounterpartyAddressBankModel**](PostCounterpartyAddressBankModel.md) |  |  |
 | **name** | [**PostCounterpartyNameBankModel**](PostCounterpartyNameBankModel.md) |  | [optional] |
-| **address** | [**PostCounterpartyAddressBankModel**](PostCounterpartyAddressBankModel.md) |  | [optional] |
-| **aliases** | [**Array<PostCounterpartyAliasesInnerBankModel>**](PostCounterpartyAliasesInnerBankModel.md) | The counterparty's aliases. | [optional] |
-| **date_of_birth** | **Date** | The counterparty's date of birth; optional for individual counterparties.. | [optional] |
+| **aliases** | [**Array<PostCounterpartyAliasesInnerBankModel>**](PostCounterpartyAliasesInnerBankModel.md) | The aliases of the counterparty. Optional when type is business. | [optional] |
+| **date_of_birth** | **Date** | The counterparty's date of birth. Optional when type is individual. | [optional] |
 | **labels** | **Array<String>** | The labels associated with the counterparty. | [optional] |
 
 ## Example
@@ -20,8 +20,8 @@ require 'cybrid_api_bank_ruby'
 instance = CybridApiBank::PostCounterpartyBankModel.new(
   type: null,
   customer_guid: null,
-  name: null,
   address: null,
+  name: null,
   aliases: null,
   date_of_birth: null,
   labels: null

data/docs/PostCounterpartyNameBankModel.md

@@ -4,10 +4,10 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **first** | **String** | The counterparty's first name; required for individual counterparties. | [optional] |
-| **middle** | **String** | The counterparty's middle name; optional for individual counterparties. | [optional] |
-| **last** | **String** | The counterparty's last name; required for individual counterparties. | [optional] |
-| **full** | **String** | The counterparty's full name; required for business counterparties. | [optional] |
+| **full** | **String** | The counterparty's full name. Required when type is business. | [optional] |
+| **first** | **String** | The counterparty's first name. Required when type is individual. | [optional] |
+| **middle** | **String** | The counterparty's middle name. Optional when type is individual. | [optional] |
+| **last** | **String** | The counterparty's last name. Required when type is individual. | [optional] |
 
 ## Example
 
@@ -15,10 +15,10 @@
 require 'cybrid_api_bank_ruby'
 
 instance = CybridApiBank::PostCounterpartyNameBankModel.new(
+  full: null,
   first: null,
   middle: null,
-  last: null,
-  full: null
+  last: null
 )
 ```
 

data/docs/PostCustomerAddressBankModel.md

@@ -4,12 +4,12 @@
 
 | 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 provide/state/region 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. |  |
+| **street** | **String** | The first line of the address. Required when type is individual. | [optional] |
+| **street2** | **String** | The optional second line of the address. Optional when type is individual. | [optional] |
+| **city** | **String** | The city of the address. Required when type is individual. | [optional] |
+| **subdivision** | **String** | The ISO 3166-2 subdivision code of the address; not used by all countries. Optional when type is individual. | [optional] |
+| **postal_code** | **String** | The postal/post/zip code of the address; not used by all countries. Optional when type is individual. | [optional] |
+| **country_code** | **String** | The ISO 3166 country 2-Alpha country code of the address. Required when type is individual. | [optional] |
 
 ## Example
 

data/docs/PostCustomerBankModel.md

@@ -4,13 +4,13 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **type** | **String** | The customer's type. |  |
+| **type** | **String** | The type of customer. |  |
 | **name** | [**PostCustomerNameBankModel**](PostCustomerNameBankModel.md) |  | [optional] |
 | **address** | [**PostCustomerAddressBankModel**](PostCustomerAddressBankModel.md) |  | [optional] |
-| **date_of_birth** | **Date** | The customer's date of birth. | [optional] |
-| **phone_number** | **String** | The customer's phone number. | [optional] |
-| **email_address** | **String** | The customer's email address. | [optional] |
-| **identification_numbers** | [**Array<PostIdentificationNumberBankModel>**](PostIdentificationNumberBankModel.md) | The customer's identification numbers. | [optional] |
+| **date_of_birth** | **Date** | The customer's date of birth. Optional when type is individual. | [optional] |
+| **phone_number** | **String** | The customer's phone number. Optional when type is individual. | [optional] |
+| **email_address** | **String** | The customer's email address. Optional when type is individual. | [optional] |
+| **identification_numbers** | [**Array<PostIdentificationNumberBankModel>**](PostIdentificationNumberBankModel.md) | The customer's identification numbers. Optional when type is individual. | [optional] |
 | **labels** | **Array<String>** | The labels associated with the customer. | [optional] |
 
 ## Example

data/docs/PostCustomerNameBankModel.md

@@ -4,9 +4,9 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **first** | **String** | The customer's first name. | [optional] |
-| **middle** | **String** | The customer's middle name. | [optional] |
-| **last** | **String** | The customer's last name. | [optional] |
+| **first** | **String** | The customer's first name. Required when type is individual. | [optional] |
+| **middle** | **String** | The customer's middle name. Optional when type is individual. | [optional] |
+| **last** | **String** | The customer's last name. Required when type is individual. | [optional] |
 
 ## Example
 

data/docs/PostDepositBankAccountBankModel.md

@@ -4,11 +4,11 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **type** | **String** | The account type. To generate deposit bank accounts with their own unique account number set this to \"main\". To generate deposit bank accounts with the same account number as the parent deposit bank account set this to \"sub_account\". This setting will only generate a unique identifier for the deposit bank and will not result in a unique account number being generated. \"sub_account\" is only  available for customer-level deposit bank accounts. | [optional] |
+| **type** | **String** | The account type. To generate deposit bank accounts with their own unique account number set this to \"main\". To generate deposit bank accounts with the same account number as the parent deposit bank account set this to \"sub_account\". This setting will only generate a unique identifier for the deposit bank and will not result in a unique account number being generated. \"sub_account\" is only  available for customer-level deposit bank accounts. |  |
 | **account_guid** | **String** | The fiat account guid. |  |
 | **customer_guid** | **String** | The unique identifier for the customer. | [optional] |
-| **parent_deposit_bank_account_guid** | **String** | The unique identifier for the bank-level deposit bank account. This is only required for sub-accounts. | [optional] |
-| **labels** | **Array<String>** | The labels associated with the address. | [optional] |
+| **parent_deposit_bank_account_guid** | **String** | The unique identifier for the bank-level deposit bank account. This is only required for sub-accounts. Required when type is sub_account. | [optional] |
+| **labels** | **Array<String>** | The labels associated with the bank account. | [optional] |
 
 ## Example
 

data/docs/PostExternalBankAccountBankModel.md

@@ -7,18 +7,18 @@
 | **name** | **String** | The name of the account. |  |
 | **account_kind** | **String** | The account type |  |
 | **customer_guid** | **String** | The customer identifier. | [optional] |
-| **asset** | **String** | The asset code. If not set will try and default to the Bank's configured fiat asset. |  |
-| **plaid_public_token** | **String** | The public token for the account. Required for 'plaid' accounts. | [optional] |
-| **plaid_account_id** | **String** | The account identifier in plaid. Required for 'plaid' accounts. | [optional] |
-| **plaid_processor_token** | **String** | The Plaid processor token used to access the account. Required for 'plaid_processor_token' accounts. | [optional] |
-| **plaid_institution_id** | **String** | Plaid's institution ID for the account's institution. Required for 'plaid_processor_token' accounts. | [optional] |
-| **plaid_account_mask** | **String** | The account mask for the account. Required for 'plaid_processor_token' accounts. | [optional] |
-| **plaid_account_name** | **String** | The name of the account. Required for 'plaid_processor_token' accounts. | [optional] |
+| **asset** | **String** | The asset code. If not set will try and default to the Bank's configured fiat asset. | [optional] |
+| **plaid_public_token** | **String** | The public token for the account. Required for 'plaid' accounts. Required when account_kind is plaid. | [optional] |
+| **plaid_account_id** | **String** | The account identifier in plaid. Required for 'plaid' accounts. Required when account_kind is plaid. | [optional] |
+| **plaid_processor_token** | **String** | The Plaid processor token used to access the account. Required when account_kind is plaid_processor_token. | [optional] |
+| **plaid_institution_id** | **String** | Plaid's institution ID for the account's institution. Required when account_kind is plaid_processor_token. | [optional] |
+| **plaid_account_mask** | **String** | The account mask for the account. Required when account_kind is plaid_processor_token. | [optional] |
+| **plaid_account_name** | **String** | The name of the account. Required when account_kind is plaid_processor_token. | [optional] |
+| **counterparty_guid** | **String** | The counterparty identifier. Optional when account_kind is raw_routing_details. | [optional] |
 | **counterparty_bank_account** | [**PostExternalBankAccountCounterpartyBankAccountBankModel**](PostExternalBankAccountCounterpartyBankAccountBankModel.md) |  | [optional] |
 | **counterparty_name** | [**PostExternalBankAccountCounterpartyNameBankModel**](PostExternalBankAccountCounterpartyNameBankModel.md) |  | [optional] |
 | **counterparty_address** | [**PostExternalBankAccountCounterpartyAddressBankModel**](PostExternalBankAccountCounterpartyAddressBankModel.md) |  | [optional] |
-| **counterparty_email_address** | **String** | The counterparty's email address on their checking account. | [optional] |
-| **counterparty_guid** | **String** | The counterparty identifier. | [optional] |
+| **counterparty_email_address** | **String** | The counterparty's email address on their checking account. Optional when account_kind is raw_routing_details and counterparty_guid is not present. | [optional] |
 
 ## Example
 
@@ -36,11 +36,11 @@ instance = CybridApiBank::PostExternalBankAccountBankModel.new(
   plaid_institution_id: null,
   plaid_account_mask: null,
   plaid_account_name: null,
+  counterparty_guid: null,
   counterparty_bank_account: null,
   counterparty_name: null,
   counterparty_address: null,
-  counterparty_email_address: null,
-  counterparty_guid: null
+  counterparty_email_address: null
 )
 ```
 

data/docs/PostExternalBankAccountCounterpartyAddressBankModel.md

@@ -4,12 +4,12 @@
 
 | 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 provide/state/region 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. |  |
+| **street** | **String** | The first line of the address. Required when account_kind is raw_routing_details and counterparty_guid is not present. | [optional] |
+| **street2** | **String** | The optional second line of the address. Optional when account_kind is raw_routing_details and counterparty_guid is not present. | [optional] |
+| **city** | **String** | The city of the address. Required when account_kind is raw_routing_details and counterparty_guid is not present. | [optional] |
+| **subdivision** | **String** | The ISO 3166-2 subdivision code of the address; not used by all countries. Optional when account_kind is raw_routing_details and counterparty_guid is not present. | [optional] |
+| **postal_code** | **String** | The postal/post/zip code of the address; not used by all countries. Optional when account_kind is raw_routing_details and counterparty_guid is not present. | [optional] |
+| **country_code** | **String** | The ISO 3166 country 2-Alpha country code of the address. Required when account_kind is raw_routing_details and counterparty_guid is not present. | [optional] |
 
 ## Example
 

data/docs/PostExternalBankAccountCounterpartyBankAccountBankModel.md

@@ -4,9 +4,9 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **routing_number_type** | **String** | The type of routing number. |  |
-| **routing_number** | **String** | The routing number. |  |
-| **account_number** | **String** | The account number. |  |
+| **routing_number_type** | **String** | The type of routing number. Required when account_kind is raw_routing_details. | [optional] |
+| **routing_number** | **String** | The routing number. Required when account_kind is raw_routing_details. | [optional] |
+| **account_number** | **String** | The account number. Required when account_kind is raw_routing_details. | [optional] |
 
 ## Example
 

data/docs/PostExternalBankAccountCounterpartyNameBankModel.md

@@ -4,10 +4,10 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **first** | **String** | The customer's first name. Used for individual accounts. | [optional] |
-| **middle** | **String** | The customer's middle name. Used for individual accounts. | [optional] |
-| **last** | **String** | The customer's last name. Used for individual accounts. | [optional] |
-| **full** | **String** | The customers's full name on the account. Used for business accounts. | [optional] |
+| **first** | **String** | The counterparty's first name; used for individuals. Optional when account_kind is raw_routing_details and counterparty_guid is not present. | [optional] |
+| **middle** | **String** | The counterparty's middle name; used for individuals. Optional when account_kind is raw_routing_details and counterparty_guid is not present. | [optional] |
+| **last** | **String** | The counterparty's last name; used for individuals. Optional when account_kind is raw_routing_details and counterparty_guid is not present. | [optional] |
+| **full** | **String** | The counterparty's full name; used for businesses. Optional when account_kind is raw_routing_details and counterparty_guid is not present. | [optional] |
 
 ## Example
 

data/docs/PostExternalWalletBankModel.md

@@ -4,7 +4,7 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **name** | **String** | The name of the account. |  |
+| **name** | **String** | Name of the external wallet. |  |
 | **customer_guid** | **String** | The customer identifier. | [optional] |
 | **asset** | **String** | The asset code. |  |
 | **address** | **String** | The blockchain wallet address for the wallet. |  |

data/docs/PostFeeBankModel.md

@@ -5,8 +5,8 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **type** | **String** | The fee's type |  |
-| **spread_fee** | **Integer** | The percentage amount, in basis points, to apply when charging a fee. | [optional] |
-| **fixed_fee** | **Integer** | The fixed amount to apply when charging a fee; for trades, the fiat asset is used. | [optional] |
+| **spread_fee** | **Integer** | The percentage amount, in basis points, to apply when charging a fee. Required when type is spread. | [optional] |
+| **fixed_fee** | **Integer** | The fixed amount to apply when charging a fee; for trades, the fiat asset is used. Required when type is fixed. | [optional] |
 
 ## Example
 

data/docs/PostIdentityVerificationAddressBankModel.md

@@ -4,12 +4,12 @@
 
 | 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 provide/state/region 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. |  |
+| **street** | **String** | The first line of the address. Required when type is kyc and method is attested, type is bank_account and method is attested, or type is bank_account and method is attested_ownership. | [optional] |
+| **street2** | **String** | The optional second line of the address. Optional when type is kyc and method is attested, type is bank_account and method is attested, or type is bank_account and method is attested_ownership. | [optional] |
+| **city** | **String** | The city of the address. Required when type is kyc and method is attested, type is bank_account and method is attested, or type is bank_account and method is attested_ownership. | [optional] |
+| **subdivision** | **String** | The ISO 3166-2 subdivision code of the address; not used by all countries. Optional when type is kyc and method is attested, type is bank_account and method is attested, or type is bank_account and method is attested_ownership. | [optional] |
+| **postal_code** | **String** | The postal/post/zip code of the address; not used by all countries. Optional when type is kyc and method is attested, type is bank_account and method is attested, or type is bank_account and method is attested_ownership. | [optional] |
+| **country_code** | **String** | The ISO 3166 country 2-Alpha country code of the address. Required when type is kyc and method is attested, type is bank_account and method is attested, or type is bank_account and method is attested_ownership. | [optional] |
 
 ## Example
 

data/docs/PostIdentityVerificationBankModel.md

@@ -5,18 +5,18 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **type** | **String** | The type of identity verification. |  |
-| **method** | **String** | The identity verification method. |  |
 | **customer_guid** | **String** | The customer's identifier. | [optional] |
-| **counterparty_guid** | **String** | The counterparty's identifier. | [optional] |
-| **country_code** | **String** | The ISO 3166 country 2-Alpha country the customer is being verified in; required when method is set to 'id_and_selfie'. If not present, will default to the Bank's configured country code. | [optional] |
+| **expected_behaviours** | **Array<String>** | The optional expected behaviour to simulate. | [optional] |
+| **method** | **String** | The identity verification method. Required when type is counterparty, type is kyc, or type is bank_account. | [optional] |
+| **counterparty_guid** | **String** | The counterparty's identifier. Required when type is counterparty. | [optional] |
+| **country_code** | **String** | The ISO 3166 country 2-Alpha country the customer is being verified in. If not present, will default to the Bank's configured country code. Optional when type is kyc and method is id_and_selfie, type is kyc and method is tax_id_and_selfie, or type is kyc and method is business_registration. | [optional] |
 | **name** | [**PostIdentityVerificationNameBankModel**](PostIdentityVerificationNameBankModel.md) |  | [optional] |
 | **address** | [**PostIdentityVerificationAddressBankModel**](PostIdentityVerificationAddressBankModel.md) |  | [optional] |
-| **date_of_birth** | **Date** | The customer's date of birth; required when type is set to 'kyc' and method is set to 'attested'. | [optional] |
-| **phone_number** | **String** | The customer's phone number. | [optional] |
-| **email_address** | **String** | The customer's email address. | [optional] |
-| **identification_numbers** | [**Array<PostIdentificationNumberBankModel>**](PostIdentificationNumberBankModel.md) | The customer's identification numbers; required when type is set to 'kyc' and method is set to 'attested'. | [optional] |
-| **external_bank_account_guid** | **String** | The external bank account's identifier. Required for 'bank_account' type. | [optional] |
-| **expected_behaviours** | **Array<String>** | The optional expected behaviour to simulate. | [optional] |
+| **date_of_birth** | **Date** | The customer's date of birth. Required when type is kyc and method is attested. | [optional] |
+| **identification_numbers** | [**Array<PostIdentificationNumberBankModel>**](PostIdentificationNumberBankModel.md) | The customer's identification numbers. Required when type is kyc and method is attested. | [optional] |
+| **external_bank_account_guid** | **String** | The external bank account's identifier. Required when type is bank_account. | [optional] |
+| **phone_number** | **String** | The customer's phone number. Optional when type is bank_account and method is attested or type is bank_account and method is attested_ownership. | [optional] |
+| **email_address** | **String** | The customer's email address. Optional when type is bank_account and method is attested or type is bank_account and method is attested_ownership. | [optional] |
 
 ## Example
 
@@ -25,18 +25,18 @@ require 'cybrid_api_bank_ruby'
 
 instance = CybridApiBank::PostIdentityVerificationBankModel.new(
   type: null,
-  method: null,
   customer_guid: null,
+  expected_behaviours: null,
+  method: null,
   counterparty_guid: null,
   country_code: null,
   name: null,
   address: null,
   date_of_birth: null,
-  phone_number: null,
-  email_address: null,
   identification_numbers: null,
   external_bank_account_guid: null,
-  expected_behaviours: null
+  phone_number: null,
+  email_address: null
 )
 ```