cybrid_api_bank_ruby 0.113.6 → 0.113.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f6746e811434380b85ce3490a36a8acabb4f9773578c2f2c754ccd95d9acd06b
-  data.tar.gz: 36d52d67fcfa0b239467ff7404fef28227a1407f8a31703f0d276f120748a0af
+  metadata.gz: fceef4ba4ce2f58e7931f540a7120e0fb510d9ab649b4c243c59a62723e95858
+  data.tar.gz: 2723bc8d88c9c6497711701f69e280a0ba0c13647b12011e3d79e783b2735d9e
 SHA512:
-  metadata.gz: 04b50143e9f19ca1a30b352d522a4904609626d32c9ccfa4fe6515a3c5daabbbd0410b0cdbe3077786146345f095b4d25096cdcbaccc7f94ff11f5642640f697
-  data.tar.gz: 9eebcb8bda3ad66079f27d219e1d7671acfd047535d6a33645bfc6e5ce2e0b4f07468467221fc87eb9f21761cfc830ad1b5cb785a35bb717c9bd958dc0ff5697
+  metadata.gz: dfff3dd96fbfc6ea219e786b1fba16bd2193d77e01e53403f3b3c6bd257269bdd2b7ac229e00bb0dac5fca0f79f45ff762755eaa4580edc2a7401bb984c8915e
+  data.tar.gz: 7f342a4c091bbf03a9ce9a4f6f5e762e52b1978de159d816562fcf993f4fea789906a3fd0b3125d9b9a504ecb23e72533de1d1a3a4268122ae2919c6e8def491

data/Gemfile.lock

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

data/README.md

@@ -149,8 +149,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.113.6
-- Package version: 0.113.6
+- API version: v0.113.9
+- Package version: 0.113.9
 - Build package: org.openapitools.codegen.languages.RubyClientCodegen
 
 ## Installation
@@ -166,16 +166,16 @@ gem build cybrid_api_bank_ruby.gemspec
 Then either install the gem locally:
 
 ```shell
-gem install ./cybrid_api_bank_ruby-0.113.6.gem
+gem install ./cybrid_api_bank_ruby-0.113.9.gem
 ```
 
-(for development, run `gem install --dev ./cybrid_api_bank_ruby-0.113.6.gem` to install the development dependencies)
+(for development, run `gem install --dev ./cybrid_api_bank_ruby-0.113.9.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.113.6'
+    gem 'cybrid_api_bank_ruby', '~> 0.113.9'
 
 ### Install from Git
 
@@ -304,7 +304,6 @@ Class | Method | HTTP request | Description
  - [CybridApiBank::IdentityVerificationListBankModel](docs/IdentityVerificationListBankModel.md)
  - [CybridApiBank::IdentityVerificationWithDetailsAllOfBankModel](docs/IdentityVerificationWithDetailsAllOfBankModel.md)
  - [CybridApiBank::IdentityVerificationWithDetailsBankModel](docs/IdentityVerificationWithDetailsBankModel.md)
- - [CybridApiBank::ListRequestOwnerBankModel](docs/ListRequestOwnerBankModel.md)
  - [CybridApiBank::PatchBankBankModel](docs/PatchBankBankModel.md)
  - [CybridApiBank::PatchCustomerBankModel](docs/PatchCustomerBankModel.md)
  - [CybridApiBank::PatchExternalBankAccountBankModel](docs/PatchExternalBankAccountBankModel.md)

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.sandbox.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. [Understanding the Platform](https://kb.cybrid.xyz/understanding-the-platform) 2. [Getting Started in the Cybrid Sandbox](https://kb.cybrid.xyz/getting-started-guide) 3. [Getting Ready for Trading](https://kb.cybrid.xyz/getting-ready-for-trading) 4. [Running the Web Demo App](https://kb.cybrid.xyz/locally-running-the-web-demo-app) (or, alternatively, [Testing with Hosted Web Demo App](https://kb.cybrid.xyz/testing-with-hosted-web-demo-app))  In [Getting Started in the Cybrid Sandbox](https://kb.cybrid.xyz/getting-started-guide), 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.  If you've already run through the first two guides, you can follow the [Running the Web Demo App](https://kb.cybrid.xyz/locally-running-the-web-demo-app) guide to test our web SDK with your sandbox `bank` and `customer`.  ## 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.sandbox.cybrid.app/api/schema/swagger-ui)   | APIs to manage organizations                                | | [Bank API](https://bank.sandbox.cybrid.app/api/schema/swagger-ui)                   | APIs to manage banks (and all downstream customer activity) | | [Identities API](https://id.sandbox.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.sandbox.cybrid.app). Access tokens can be generated for a `Customer` as well via the [Cybrid IdP](https://id.sandbox.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.sandbox.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.sandbox.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 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\"   }' -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 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' ``` <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)                         | | 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)               |  ## Available Endpoints  The available APIs for the [Identity](https://id.sandbox.cybrid.app/api/schema/swagger-ui), [Organization](https://organization.sandbox.cybrid.app/api/schema/swagger-ui) and [Bank](https://bank.sandbox.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         | 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         | 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.113.6
+The version of the OpenAPI document: v0.113.9
 Contact: support@cybrid.app
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 6.0.0

data/docs/AccountBankModel.md

@@ -4,7 +4,7 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **type** | **String** | The account type. | [optional] |
+| **type** | **String** | The account type; one of trading, fee, fiat, or gas. | [optional] |
 | **guid** | **String** | Auto-generated unique identifier for the account. | [optional] |
 | **created_at** | **Time** | ISO8601 datetime the record was created at. | [optional] |
 | **updated_at** | **Time** | ISO8601 datetime the record was last updated at. | [optional] |
@@ -14,7 +14,7 @@
 | **customer_guid** | **String** | The customer identifier associated with the account. | [optional] |
 | **platform_balance** | **Integer** | The amount of funds that are in the account, in base units of the asset. | [optional] |
 | **platform_available** | **Integer** | The amount of funds that are in the account, in base units of the asset, that are available for use on the platform. | [optional] |
-| **state** | **String** | The account's state. | [optional] |
+| **state** | **String** | The state of the account; one of storing or created. | [optional] |
 | **labels** | **Array<String>** | The labels associated with the account. | [optional] |
 
 ## Example

data/docs/AccountsBankApi.md

@@ -179,7 +179,7 @@ api_instance = CybridApiBank::AccountsBankApi.new
 opts = {
   page: 56, # Integer | The page index to retrieve.
   per_page: 56, # Integer | The number of entities per page to return.
-  owner: CybridApiBank::ListRequestOwnerBankModel::BANK, # ListRequestOwnerBankModel | The owner of the entity.
+  owner: 'owner_example', # String | The owner of the entity.
   guid: 'guid_example', # String | Comma separated account_guids to list accounts for.
   type: 'type_example', # String | Comma separated account_types to list accounts for.
   bank_guid: 'bank_guid_example', # String | Comma separated bank_guids to list accounts for.
@@ -220,7 +220,7 @@ end
 | ---- | ---- | ----------- | ----- |
 | **page** | **Integer** | The page index to retrieve. | [optional] |
 | **per_page** | **Integer** | The number of entities per page to return. | [optional] |
-| **owner** | [**ListRequestOwnerBankModel**](.md) | The owner of the entity. | [optional] |
+| **owner** | **String** | The owner of the entity. | [optional] |
 | **guid** | **String** | Comma separated account_guids to list accounts for. | [optional] |
 | **type** | **String** | Comma separated account_types to list accounts for. | [optional] |
 | **bank_guid** | **String** | Comma separated bank_guids to list accounts for. | [optional] |

data/docs/AssetBankModel.md

@@ -4,7 +4,7 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **type** | **String** | The asset type. |  |
+| **type** | **String** | The asset type; one of fiat or crypto. |  |
 | **code** | **String** | The unique code for the asset. |  |
 | **name** | **String** | The name of the asset. |  |
 | **symbol** | **String** | The currency symbol for the asset. |  |

data/docs/BankBankModel.md

@@ -7,12 +7,12 @@
 | **guid** | **String** | Auto-generated unique identifier for the bank. |  |
 | **organization_guid** | **String** | The organization's identifier. |  |
 | **name** | **String** | The bank's name. |  |
-| **type** | **String** | The bank's type. |  |
+| **type** | **String** | The bank type; one of sandbox or production. |  |
 | **supported_trading_symbols** | **Array<String>** | The bank's list of supported trading symbols. | [optional] |
 | **supported_fiat_account_assets** | **Array<String>** | The bank's list of supported fiat symbols. | [optional] |
 | **supported_country_codes** | **Array<String>** | The bank's list of supported country codes. | [optional] |
 | **features** | **Array<String>** | The bank's enabled features. |  |
-| **routable_accounts** | **String** | Configuration for supporting creating routable bank accounts. | [optional] |
+| **routable_accounts** | **String** | Configuration for supporting creating routable bank accounts: one of unsupported, bank, or customer. | [optional] |
 | **created_at** | **Time** | ISO8601 datetime the record was created at. |  |
 | **updated_at** | **Time** | ISO8601 datetime the record was last updated at. | [optional] |
 

data/docs/CustomerBankModel.md

@@ -6,10 +6,10 @@
 | ---- | ---- | ----------- | ----- |
 | **guid** | **String** | Auto-generated unique identifier for the customer. | [optional] |
 | **bank_guid** | **String** | Auto-generated unique identifier for the customer's bank. | [optional] |
-| **type** | **String** | The customer's type. | [optional] |
+| **type** | **String** | The customer type; one of business or individual. | [optional] |
 | **created_at** | **Time** | ISO8601 datetime the record was created at. | [optional] |
 | **updated_at** | **Time** | ISO8601 datetime the record was last updated at. | [optional] |
-| **state** | **String** | The customer's state. | [optional] |
+| **state** | **String** | The customer state; one of storing, unverified, verified, rejected, or frozen. | [optional] |
 | **name** | [**CustomerNameBankModel**](CustomerNameBankModel.md) |  | [optional] |
 | **address** | [**CustomerAddressBankModel**](CustomerAddressBankModel.md) |  | [optional] |
 | **date_of_birth** | **Date** | The customer's DOB. Only available for GET operations when 'include_pii' is set. | [optional] |

data/docs/DepositAddressBankModel.md

@@ -11,9 +11,9 @@
 | **created_at** | **Time** | ISO8601 datetime the record was created at. | [optional] |
 | **updated_at** | **Time** | ISO8601 datetime the record was last updated at. | [optional] |
 | **asset** | **String** | The asset the transfer is related to, e.g., USD. | [optional] |
-| **state** | **String** | The state of the address. | [optional] |
+| **state** | **String** | The state of the address; one of storing or created. | [optional] |
 | **address** | **String** | The blockchain address. | [optional] |
-| **format** | **String** | The blockchain address format. | [optional] |
+| **format** | **String** | The blockchain address format; one of standard or legacy. | [optional] |
 | **tag** | **String** | The blockchain address tag. | [optional] |
 | **labels** | **Array<String>** | The labels associated with the address. | [optional] |
 

data/docs/DepositBankAccountBankModel.md

@@ -11,7 +11,7 @@
 | **created_at** | **Time** | ISO8601 datetime the record was created at. | [optional] |
 | **updated_at** | **Time** | ISO8601 datetime the record was last updated at. | [optional] |
 | **asset** | **String** | The asset the transfer is related to, e.g., USD. | [optional] |
-| **state** | **String** | The state of the address. | [optional] |
+| **state** | **String** | The state of the address; one of storing or created. | [optional] |
 | **unique_memo_id** | **String** | The unique memo identifier for the address. This is used to identify the recipient when sending funds to the account. This value MUST be included in all wire transfers to this account. | [optional] |
 | **counterparty_name** | **String** | The name of the account holder. | [optional] |
 | **counterparty_address** | [**DepositBankAccountCounterpartyAddressBankModel**](DepositBankAccountCounterpartyAddressBankModel.md) |  | [optional] |

data/docs/DepositBankAccountRoutingDetailsInnerBankModel.md

@@ -4,7 +4,7 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **routing_number_type** | **String** | The type of routing number. |  |
+| **routing_number_type** | **String** | The type of routing number; one of CPA, ABA, or SWIFT. |  |
 | **routing_number** | **String** | The routing number. |  |
 
 ## Example

data/docs/ExternalBankAccountBankModel.md

@@ -7,8 +7,8 @@
 | **guid** | **String** | Auto-generated unique identifier for the account. | [optional] |
 | **name** | **String** | The name of the account. | [optional] |
 | **asset** | **String** | The asset code. | [optional] |
-| **account_kind** | **String** | The type of account. | [optional] |
-| **environment** | **String** | The environment that the external bank account is operating in. | [optional] |
+| **account_kind** | **String** | The type of account; one of plaid, plaid_processor_token, or raw_routing_details. | [optional] |
+| **environment** | **String** | The environment that the external bank account is operating in; one of sandbox or production. | [optional] |
 | **bank_guid** | **String** | The bank identifier. | [optional] |
 | **customer_guid** | **String** | The customer identifier. | [optional] |
 | **created_at** | **Time** | ISO8601 datetime the record was created at. | [optional] |
@@ -16,7 +16,7 @@
 | **plaid_institution_id** | **String** | The Plaid institution ID for the account. | [optional] |
 | **plaid_account_mask** | **String** | The account number mask for the account. | [optional] |
 | **plaid_account_name** | **String** | The name for the account. | [optional] |
-| **state** | **String** | The state of the external bank account. | [optional] |
+| **state** | **String** | The state of the external bank account; one of storing, completed, failed, refresh_required, unverified, deleting, or deleted. | [optional] |
 | **failure_code** | **String** | The failure code for failed transfers. | [optional] |
 | **balance_updated_at** | **Time** | The timestamp that the balance information was last updated at. | [optional] |
 | **balances** | [**ExternalBankAccountBalancesBankModel**](ExternalBankAccountBalancesBankModel.md) |  | [optional] |

data/docs/ExternalWalletBankModel.md

@@ -7,14 +7,14 @@
 | **guid** | **String** | Auto-generated unique identifier for the wallet. | [optional] |
 | **name** | **String** | The name of the wallet. | [optional] |
 | **asset** | **String** | The asset code. | [optional] |
-| **environment** | **String** | The environment that the wallet is configured for. | [optional] |
+| **environment** | **String** | The environment that the wallet is configured for; one of sandbox or production. | [optional] |
 | **bank_guid** | **String** | The bank identifier. | [optional] |
 | **customer_guid** | **String** | The customer identifier. | [optional] |
 | **address** | **String** | The blockchain wallet address for the wallet. | [optional] |
 | **tag** | **String** | The blockchain tag to use when transferring crypto to the wallet. | [optional] |
 | **created_at** | **Time** | ISO8601 datetime the record was created at. | [optional] |
 | **updated_at** | **Time** | ISO8601 datetime the record was last updated at. | [optional] |
-| **state** | **String** | The state of an external wallet | [optional] |
+| **state** | **String** | The state of the external wallet; one of storing, pending, failed, completed, deleting, or deleted. | [optional] |
 | **failure_code** | **String** | The failure code of an external wallet (if any) | [optional] |
 
 ## Example

data/docs/ExternalWalletsBankApi.md

@@ -252,7 +252,7 @@ api_instance = CybridApiBank::ExternalWalletsBankApi.new
 opts = {
   page: 56, # Integer | The page index to retrieve.
   per_page: 56, # Integer | The number of entities per page to return.
-  owner: CybridApiBank::ListRequestOwnerBankModel::BANK, # ListRequestOwnerBankModel | The owner of the entity.
+  owner: 'owner_example', # String | The owner of the entity.
   guid: 'guid_example', # String | Comma separated external_wallet_guids to list external_wallets for.
   bank_guid: 'bank_guid_example', # String | Comma separated bank_guids to list external_wallets for.
   customer_guid: 'customer_guid_example', # String | Comma separated customer_guids to list external_wallets for.
@@ -292,7 +292,7 @@ end
 | ---- | ---- | ----------- | ----- |
 | **page** | **Integer** | The page index to retrieve. | [optional] |
 | **per_page** | **Integer** | The number of entities per page to return. | [optional] |
-| **owner** | [**ListRequestOwnerBankModel**](.md) | The owner of the entity. | [optional] |
+| **owner** | **String** | The owner of the entity. | [optional] |
 | **guid** | **String** | Comma separated external_wallet_guids to list external_wallets for. | [optional] |
 | **bank_guid** | **String** | Comma separated bank_guids to list external_wallets for. | [optional] |
 | **customer_guid** | **String** | Comma separated customer_guids to list external_wallets for. | [optional] |

data/docs/IdentityVerificationBankModel.md

@@ -5,13 +5,13 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **guid** | **String** | Auto-generated unique identifier for the identity verification. | [optional] |
-| **customer_guid** | **String** | The customer's identifier. | [optional] |
-| **type** | **String** | The type of identity verification. | [optional] |
-| **method** | **String** | The identity verification method. | [optional] |
+| **customer_guid** | **String** | The identity verification's identifier. | [optional] |
+| **type** | **String** | The identity verification type; one of kyc or bank_account. | [optional] |
+| **method** | **String** | The identity verification method; one of business_registration, id_and_selfie, attested, plaid_identity_match, or document_submission. | [optional] |
 | **created_at** | **Time** | ISO8601 datetime the record was created at. | [optional] |
 | **updated_at** | **Time** | ISO8601 datetime the record was last updated at. | [optional] |
-| **state** | **String** | The state of the verification process. | [optional] |
-| **outcome** | **String** | The outcome of the verification process. | [optional] |
+| **state** | **String** | The identity verification state; one of storing, waiting, expired, or completed. | [optional] |
+| **outcome** | **String** | The identity verification outcome; one of passed or failed. | [optional] |
 | **failure_codes** | **Array<String>** | The reason codes explaining the outcome. | [optional] |
 
 ## Example

data/docs/IdentityVerificationWithDetailsAllOfBankModel.md

@@ -5,7 +5,7 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **persona_inquiry_id** | **String** | The Persona identifier of the backing inquiry. | [optional] |
-| **persona_state** | **String** | The Persona state of the backing inquiry. | [optional] |
+| **persona_state** | **String** | The Persona state of the backing inquiry; one of waiting, pending, reviewing, processing, expired, completed, or unknown. | [optional] |
 | **external_bank_account_guid** | **String** | The external bank account's identifier. | [optional] |
 
 ## Example

data/docs/IdentityVerificationWithDetailsBankModel.md

@@ -5,16 +5,16 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **guid** | **String** | Auto-generated unique identifier for the identity verification. | [optional] |
-| **customer_guid** | **String** | The customer's identifier. | [optional] |
-| **type** | **String** | The type of identity verification. | [optional] |
-| **method** | **String** | The identity verification method. | [optional] |
+| **customer_guid** | **String** | The identity verification's identifier. | [optional] |
+| **type** | **String** | The identity verification type; one of kyc or bank_account. | [optional] |
+| **method** | **String** | The identity verification method; one of business_registration, id_and_selfie, attested, plaid_identity_match, or document_submission. | [optional] |
 | **created_at** | **Time** | ISO8601 datetime the record was created at. | [optional] |
 | **updated_at** | **Time** | ISO8601 datetime the record was last updated at. | [optional] |
-| **state** | **String** | The state of the verification process. | [optional] |
-| **outcome** | **String** | The outcome of the verification process. | [optional] |
+| **state** | **String** | The identity verification state; one of storing, waiting, expired, or completed. | [optional] |
+| **outcome** | **String** | The identity verification outcome; one of passed or failed. | [optional] |
 | **failure_codes** | **Array<String>** | The reason codes explaining the outcome. | [optional] |
 | **persona_inquiry_id** | **String** | The Persona identifier of the backing inquiry. | [optional] |
-| **persona_state** | **String** | The Persona state of the backing inquiry. | [optional] |
+| **persona_state** | **String** | The Persona state of the backing inquiry; one of waiting, pending, reviewing, processing, expired, completed, or unknown. | [optional] |
 | **external_bank_account_guid** | **String** | The external bank account's identifier. | [optional] |
 
 ## Example

data/docs/QuoteBankModel.md

@@ -5,11 +5,11 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **guid** | **String** | Auto-generated unique identifier for the quote. | [optional] |
-| **product_type** | **String** | The type of product the quote is for. | [optional] |
+| **product_type** | **String** | The type of product the quote is for; one of trading, funding, book_transfer, or crypto_transfer. | [optional] |
 | **bank_guid** | **String** | The unique identifier for the bank. | [optional] |
 | **customer_guid** | **String** | The unique identifier for the customer. | [optional] |
 | **symbol** | **String** | Symbol the quote was requested for. Format is \"asset-counter_asset\" in uppercase. Populated for trade quotes. | [optional] |
-| **side** | **String** | The direction of the quote: either 'buy' or 'sell' for trade quotes. | [optional] |
+| **side** | **String** | The direction of the quote; one of buy, sell, deposit, or withdrawal. | [optional] |
 | **receive_amount** | **Integer** | The amount to be received in base units of the currency: currency is \"asset\" for buy and \"counter_asset\" for sell for trade quotes. | [optional] |
 | **deliver_amount** | **Integer** | The amount to be delivered in base units of the currency: currency is \"counter_asset\" for buy and \"asset\" for sell for trade quotes. | [optional] |
 | **fee** | **Integer** | The fee associated with the trade. Denominated in \"counter_asset\" base units for trade quotes. | [optional] |

data/docs/TradeBankModel.md

@@ -5,12 +5,12 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **guid** | **String** | Auto-generated unique identifier for the trade. | [optional] |
-| **trade_type** | **String** | The type of trade. | [optional] |
+| **trade_type** | **String** | The type of trade; one of platform or liquidation. | [optional] |
 | **customer_guid** | **String** | The associated customer's identifier. | [optional] |
 | **quote_guid** | **String** | The associated quote's identifier. | [optional] |
 | **symbol** | **String** | The trade symbol the pricing is related to. Format is asset-counter_asset, e.g., BTC-USD. | [optional] |
-| **side** | **String** | The direction of the quote: either 'buy' or 'sell'. | [optional] |
-| **state** | **String** | The trade's state | [optional] |
+| **side** | **String** | The direction of the trade; one of buy or sell. | [optional] |
+| **state** | **String** | The state of the trade; one of storing, pending, cancelled, completed, settling, or failed. | [optional] |
 | **failure_code** | **String** | The failure code for failed trades. | [optional] |
 | **receive_amount** | **Integer** | The amount to be received in base units of the currency: currency is \"asset\" for buy and \"counter_asset\" for sell. | [optional] |
 | **deliver_amount** | **Integer** | The amount to be delivered in base units of the currency: currency is \"counter_asset\" for buy and \"asset\" for sell. | [optional] |

data/docs/TransferBankModel.md

@@ -5,14 +5,14 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **guid** | **String** | Auto-generated unique identifier for the transfer. | [optional] |
-| **transfer_type** | **String** | The type of transfer. | [optional] |
+| **transfer_type** | **String** | The type of transfer; one of funding, book, crypto, instant_funding, funding_return, or crypto_return. | [optional] |
 | **bank_guid** | **String** | The associated bank's identifier. | [optional] |
 | **customer_guid** | **String** | The associated customer's identifier. | [optional] |
 | **quote_guid** | **String** | The associated quote's identifier. | [optional] |
 | **external_bank_account_guid** | **String** | The associated external bank account's identifier. | [optional] |
 | **asset** | **String** | The asset the transfer is related to, e.g., USD. | [optional] |
-| **side** | **String** | The direction of the quote: 'deposit' or 'withdrawal'. | [optional] |
-| **state** | **String** | The transfer's state | [optional] |
+| **side** | **String** | The direction of the quote; one of deposit or withdrawal. | [optional] |
+| **state** | **String** | The state of the transfer; one of storing, pending, reviewing, completed, or failed. | [optional] |
 | **failure_code** | **String** | The failure code for failed transfers. | [optional] |
 | **amount** | **Integer** | The actual amount in base units of the asset. | [optional] |
 | **estimated_amount** | **Integer** | The estimated amount in base units of the asset. | [optional] |

data/docs/TransferDestinationAccountBankModel.md

@@ -5,7 +5,7 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **guid** | **String** | Auto-generated unique identifier for the transfer account. | [optional] |
-| **type** | **String** | The type of transfer account. | [optional] |
+| **type** | **String** | The type of transfer account; one of trading, fiat, external_bank_account, external_wallet, or one_time_address. | [optional] |
 
 ## Example
 

data/docs/TransferSourceAccountBankModel.md

@@ -5,7 +5,7 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **guid** | **String** | Auto-generated unique identifier for the transfer account. | [optional] |
-| **type** | **String** | The type of transfer account. | [optional] |
+| **type** | **String** | The type of transfer account; one of trading, fiat, external_bank_account, external_wallet, or one_time_address. | [optional] |
 
 ## Example
 

data/docs/VerificationCheckBankModel.md

@@ -4,8 +4,8 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **type** | **String** | The type of verification check. |  |
-| **state** | **String** | The state of the verification check. |  |
+| **type** | **String** | The type of verification check; one of business_watchlists, business_verification, business_tax_id_verification, person_attested, person_tax_id_attested, person_watchlists, person_verification, person_authentication, person_gov_id_verification, or person_tax_id_verification. |  |
+| **state** | **String** | The state of the verification check; one of passed, failed, expired, or invalidated. |  |
 | **failure_codes** | **Array<String>** | The reason codes explaining the outcome. | [optional] |
 
 ## Example

data/docs/WorkflowBankModel.md

@@ -6,8 +6,8 @@
 | ---- | ---- | ----------- | ----- |
 | **guid** | **String** | Auto-generated unique identifier for the workflow. | [optional] |
 | **customer_guid** | **String** | The associated customer's identifier. | [optional] |
-| **type** | **String** | The type of workflow. | [optional] |
-| **state** | **String** | The state of the workflow. | [optional] |
+| **type** | **String** | The type of workflow; one of plaid. | [optional] |
+| **state** | **String** | The state of the workflow; one of storing, completed, or failed. | [optional] |
 | **failure_code** | **String** | The failure code for failed workflows. | [optional] |
 | **created_at** | **Time** | ISO8601 datetime the record was created at. | [optional] |
 | **updated_at** | **Time** | ISO8601 datetime the record was last updated at. | [optional] |

data/docs/WorkflowWithDetailsBankModel.md

@@ -6,8 +6,8 @@
 | ---- | ---- | ----------- | ----- |
 | **guid** | **String** | Auto-generated unique identifier for the workflow. | [optional] |
 | **customer_guid** | **String** | The associated customer's identifier. | [optional] |
-| **type** | **String** | The type of workflow. | [optional] |
-| **state** | **String** | The state of the workflow. | [optional] |
+| **type** | **String** | The type of workflow; one of plaid. | [optional] |
+| **state** | **String** | The state of the workflow; one of storing, completed, or failed. | [optional] |
 | **failure_code** | **String** | The failure code for failed workflows. | [optional] |
 | **created_at** | **Time** | ISO8601 datetime the record was created at. | [optional] |
 | **updated_at** | **Time** | ISO8601 datetime the record was last updated at. | [optional] |

data/lib/cybrid_api_bank_ruby/api/accounts_bank_api.rb

@@ -3,7 +3,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.sandbox.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. [Understanding the Platform](https://kb.cybrid.xyz/understanding-the-platform) 2. [Getting Started in the Cybrid Sandbox](https://kb.cybrid.xyz/getting-started-guide) 3. [Getting Ready for Trading](https://kb.cybrid.xyz/getting-ready-for-trading) 4. [Running the Web Demo App](https://kb.cybrid.xyz/locally-running-the-web-demo-app) (or, alternatively, [Testing with Hosted Web Demo App](https://kb.cybrid.xyz/testing-with-hosted-web-demo-app))  In [Getting Started in the Cybrid Sandbox](https://kb.cybrid.xyz/getting-started-guide), 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.  If you've already run through the first two guides, you can follow the [Running the Web Demo App](https://kb.cybrid.xyz/locally-running-the-web-demo-app) guide to test our web SDK with your sandbox `bank` and `customer`.  ## 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.sandbox.cybrid.app/api/schema/swagger-ui)   | APIs to manage organizations                                | | [Bank API](https://bank.sandbox.cybrid.app/api/schema/swagger-ui)                   | APIs to manage banks (and all downstream customer activity) | | [Identities API](https://id.sandbox.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.sandbox.cybrid.app). Access tokens can be generated for a `Customer` as well via the [Cybrid IdP](https://id.sandbox.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.sandbox.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.sandbox.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 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\"   }' -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 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' ``` <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)                         | | 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)               |  ## Available Endpoints  The available APIs for the [Identity](https://id.sandbox.cybrid.app/api/schema/swagger-ui), [Organization](https://organization.sandbox.cybrid.app/api/schema/swagger-ui) and [Bank](https://bank.sandbox.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         | 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         | 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.113.6
+The version of the OpenAPI document: v0.113.9
 Contact: support@cybrid.app
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 6.0.0
@@ -155,7 +155,7 @@ module CybridApiBank
     # @param [Hash] opts the optional parameters
     # @option opts [Integer] :page The page index to retrieve.
     # @option opts [Integer] :per_page The number of entities per page to return.
-    # @option opts [ListRequestOwnerBankModel] :owner The owner of the entity.
+    # @option opts [String] :owner The owner of the entity.
     # @option opts [String] :guid Comma separated account_guids to list accounts for.
     # @option opts [String] :type Comma separated account_types to list accounts for.
     # @option opts [String] :bank_guid Comma separated bank_guids to list accounts for.
@@ -172,7 +172,7 @@ module CybridApiBank
     # @param [Hash] opts the optional parameters
     # @option opts [Integer] :page The page index to retrieve.
     # @option opts [Integer] :per_page The number of entities per page to return.
-    # @option opts [ListRequestOwnerBankModel] :owner The owner of the entity.
+    # @option opts [String] :owner The owner of the entity.
     # @option opts [String] :guid Comma separated account_guids to list accounts for.
     # @option opts [String] :type Comma separated account_types to list accounts for.
     # @option opts [String] :bank_guid Comma separated bank_guids to list accounts for.

data/lib/cybrid_api_bank_ruby/api/assets_bank_api.rb

@@ -3,7 +3,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.sandbox.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. [Understanding the Platform](https://kb.cybrid.xyz/understanding-the-platform) 2. [Getting Started in the Cybrid Sandbox](https://kb.cybrid.xyz/getting-started-guide) 3. [Getting Ready for Trading](https://kb.cybrid.xyz/getting-ready-for-trading) 4. [Running the Web Demo App](https://kb.cybrid.xyz/locally-running-the-web-demo-app) (or, alternatively, [Testing with Hosted Web Demo App](https://kb.cybrid.xyz/testing-with-hosted-web-demo-app))  In [Getting Started in the Cybrid Sandbox](https://kb.cybrid.xyz/getting-started-guide), 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.  If you've already run through the first two guides, you can follow the [Running the Web Demo App](https://kb.cybrid.xyz/locally-running-the-web-demo-app) guide to test our web SDK with your sandbox `bank` and `customer`.  ## 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.sandbox.cybrid.app/api/schema/swagger-ui)   | APIs to manage organizations                                | | [Bank API](https://bank.sandbox.cybrid.app/api/schema/swagger-ui)                   | APIs to manage banks (and all downstream customer activity) | | [Identities API](https://id.sandbox.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.sandbox.cybrid.app). Access tokens can be generated for a `Customer` as well via the [Cybrid IdP](https://id.sandbox.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.sandbox.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.sandbox.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 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\"   }' -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 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' ``` <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)                         | | 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)               |  ## Available Endpoints  The available APIs for the [Identity](https://id.sandbox.cybrid.app/api/schema/swagger-ui), [Organization](https://organization.sandbox.cybrid.app/api/schema/swagger-ui) and [Bank](https://bank.sandbox.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         | 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         | 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.113.6
+The version of the OpenAPI document: v0.113.9
 Contact: support@cybrid.app
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 6.0.0