cybrid_api_bank_ruby 0.74.10 → 0.74.11

Sign up to get free protection for your applications and to get access to all the features.
Files changed (160) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile.lock +1 -1
  3. data/README.md +5 -8
  4. data/cybrid_api_bank_ruby.gemspec +1 -1
  5. data/lib/cybrid_api_bank_ruby/api/accounts_bank_api.rb +1 -1
  6. data/lib/cybrid_api_bank_ruby/api/assets_bank_api.rb +1 -1
  7. data/lib/cybrid_api_bank_ruby/api/banks_bank_api.rb +1 -1
  8. data/lib/cybrid_api_bank_ruby/api/customers_bank_api.rb +1 -1
  9. data/lib/cybrid_api_bank_ruby/api/deposit_addresses_bank_api.rb +1 -1
  10. data/lib/cybrid_api_bank_ruby/api/external_bank_accounts_bank_api.rb +1 -1
  11. data/lib/cybrid_api_bank_ruby/api/external_wallets_bank_api.rb +1 -1
  12. data/lib/cybrid_api_bank_ruby/api/identity_verifications_bank_api.rb +1 -1
  13. data/lib/cybrid_api_bank_ruby/api/prices_bank_api.rb +1 -1
  14. data/lib/cybrid_api_bank_ruby/api/quotes_bank_api.rb +1 -1
  15. data/lib/cybrid_api_bank_ruby/api/rewards_bank_api.rb +1 -1
  16. data/lib/cybrid_api_bank_ruby/api/symbols_bank_api.rb +1 -1
  17. data/lib/cybrid_api_bank_ruby/api/trades_bank_api.rb +1 -1
  18. data/lib/cybrid_api_bank_ruby/api/transfers_bank_api.rb +1 -1
  19. data/lib/cybrid_api_bank_ruby/api/workflows_bank_api.rb +1 -1
  20. data/lib/cybrid_api_bank_ruby/api_client.rb +1 -1
  21. data/lib/cybrid_api_bank_ruby/api_error.rb +1 -1
  22. data/lib/cybrid_api_bank_ruby/configuration.rb +1 -1
  23. data/lib/cybrid_api_bank_ruby/models/account_bank_model.rb +1 -1
  24. data/lib/cybrid_api_bank_ruby/models/account_list_bank_model.rb +1 -1
  25. data/lib/cybrid_api_bank_ruby/models/asset_bank_model.rb +1 -1
  26. data/lib/cybrid_api_bank_ruby/models/asset_list_bank_model.rb +1 -1
  27. data/lib/cybrid_api_bank_ruby/models/bank_bank_model.rb +1 -1
  28. data/lib/cybrid_api_bank_ruby/models/bank_list_bank_model.rb +1 -1
  29. data/lib/cybrid_api_bank_ruby/models/customer_bank_model.rb +1 -1
  30. data/lib/cybrid_api_bank_ruby/models/customer_list_bank_model.rb +1 -1
  31. data/lib/cybrid_api_bank_ruby/models/deposit_address_bank_model.rb +1 -1
  32. data/lib/cybrid_api_bank_ruby/models/deposit_address_list_bank_model.rb +1 -1
  33. data/lib/cybrid_api_bank_ruby/models/error_response_bank_model.rb +1 -1
  34. data/lib/cybrid_api_bank_ruby/models/external_bank_account_bank_model.rb +1 -1
  35. data/lib/cybrid_api_bank_ruby/models/external_bank_account_list_bank_model.rb +1 -1
  36. data/lib/cybrid_api_bank_ruby/models/external_wallet_bank_model.rb +1 -1
  37. data/lib/cybrid_api_bank_ruby/models/external_wallet_list_bank_model.rb +1 -1
  38. data/lib/cybrid_api_bank_ruby/models/identity_verification_bank_model.rb +1 -1
  39. data/lib/cybrid_api_bank_ruby/models/identity_verification_list_bank_model.rb +1 -1
  40. data/lib/cybrid_api_bank_ruby/models/identity_verification_with_details_all_of_bank_model.rb +1 -1
  41. data/lib/cybrid_api_bank_ruby/models/identity_verification_with_details_bank_model.rb +1 -1
  42. data/lib/cybrid_api_bank_ruby/models/patch_bank_bank_model.rb +1 -1
  43. data/lib/cybrid_api_bank_ruby/models/patch_external_bank_account_bank_model.rb +1 -1
  44. data/lib/cybrid_api_bank_ruby/models/post_account_bank_model.rb +1 -1
  45. data/lib/cybrid_api_bank_ruby/models/post_bank_bank_model.rb +1 -1
  46. data/lib/cybrid_api_bank_ruby/models/post_customer_address_bank_model.rb +1 -1
  47. data/lib/cybrid_api_bank_ruby/models/post_customer_bank_model.rb +1 -1
  48. data/lib/cybrid_api_bank_ruby/models/post_customer_name_bank_model.rb +1 -1
  49. data/lib/cybrid_api_bank_ruby/models/post_deposit_address_bank_model.rb +1 -1
  50. data/lib/cybrid_api_bank_ruby/models/post_external_bank_account_bank_model.rb +1 -1
  51. data/lib/cybrid_api_bank_ruby/models/post_external_wallet_bank_model.rb +1 -1
  52. data/lib/cybrid_api_bank_ruby/models/post_identification_number_bank_model.rb +1 -1
  53. data/lib/cybrid_api_bank_ruby/models/post_identity_verification_address_bank_model.rb +1 -1
  54. data/lib/cybrid_api_bank_ruby/models/post_identity_verification_bank_model.rb +1 -1
  55. data/lib/cybrid_api_bank_ruby/models/post_identity_verification_name_bank_model.rb +1 -1
  56. data/lib/cybrid_api_bank_ruby/models/post_quote_bank_model.rb +1 -1
  57. data/lib/cybrid_api_bank_ruby/models/post_reward_bank_model.rb +1 -1
  58. data/lib/cybrid_api_bank_ruby/models/post_trade_bank_model.rb +1 -1
  59. data/lib/cybrid_api_bank_ruby/models/post_transfer_bank_model.rb +1 -1
  60. data/lib/cybrid_api_bank_ruby/models/post_workflow_bank_model.rb +1 -1
  61. data/lib/cybrid_api_bank_ruby/models/quote_bank_model.rb +1 -1
  62. data/lib/cybrid_api_bank_ruby/models/quote_list_bank_model.rb +1 -1
  63. data/lib/cybrid_api_bank_ruby/models/reward_bank_model.rb +1 -1
  64. data/lib/cybrid_api_bank_ruby/models/reward_list_bank_model.rb +1 -1
  65. data/lib/cybrid_api_bank_ruby/models/symbol_price_bank_model.rb +1 -1
  66. data/lib/cybrid_api_bank_ruby/models/trade_bank_model.rb +1 -1
  67. data/lib/cybrid_api_bank_ruby/models/trade_list_bank_model.rb +1 -1
  68. data/lib/cybrid_api_bank_ruby/models/transfer_bank_model.rb +1 -1
  69. data/lib/cybrid_api_bank_ruby/models/transfer_list_bank_model.rb +1 -1
  70. data/lib/cybrid_api_bank_ruby/models/workflow_bank_model.rb +1 -1
  71. data/lib/cybrid_api_bank_ruby/models/workflow_with_details_all_of_bank_model.rb +1 -1
  72. data/lib/cybrid_api_bank_ruby/models/workflow_with_details_bank_model.rb +1 -1
  73. data/lib/cybrid_api_bank_ruby/models/workflows_list_bank_model.rb +1 -1
  74. data/lib/cybrid_api_bank_ruby/version.rb +2 -2
  75. data/lib/cybrid_api_bank_ruby.rb +1 -4
  76. data/spec/api/accounts_bank_api_spec.rb +1 -1
  77. data/spec/api/assets_bank_api_spec.rb +1 -1
  78. data/spec/api/banks_bank_api_spec.rb +1 -1
  79. data/spec/api/customers_bank_api_spec.rb +1 -1
  80. data/spec/api/deposit_addresses_bank_api_spec.rb +1 -1
  81. data/spec/api/external_bank_accounts_bank_api_spec.rb +1 -1
  82. data/spec/api/external_wallets_bank_api_spec.rb +1 -1
  83. data/spec/api/identity_verifications_bank_api_spec.rb +1 -1
  84. data/spec/api/prices_bank_api_spec.rb +1 -1
  85. data/spec/api/quotes_bank_api_spec.rb +1 -1
  86. data/spec/api/rewards_bank_api_spec.rb +1 -1
  87. data/spec/api/symbols_bank_api_spec.rb +1 -1
  88. data/spec/api/trades_bank_api_spec.rb +1 -1
  89. data/spec/api/transfers_bank_api_spec.rb +1 -1
  90. data/spec/api/workflows_bank_api_spec.rb +1 -1
  91. data/spec/api_client_spec.rb +1 -1
  92. data/spec/configuration_spec.rb +1 -1
  93. data/spec/models/account_bank_model_spec.rb +1 -1
  94. data/spec/models/account_list_bank_model_spec.rb +1 -1
  95. data/spec/models/asset_bank_model_spec.rb +1 -1
  96. data/spec/models/asset_list_bank_model_spec.rb +1 -1
  97. data/spec/models/bank_bank_model_spec.rb +1 -1
  98. data/spec/models/bank_list_bank_model_spec.rb +1 -1
  99. data/spec/models/customer_bank_model_spec.rb +1 -1
  100. data/spec/models/customer_list_bank_model_spec.rb +1 -1
  101. data/spec/models/deposit_address_bank_model_spec.rb +1 -1
  102. data/spec/models/deposit_address_list_bank_model_spec.rb +1 -1
  103. data/spec/models/error_response_bank_model_spec.rb +1 -1
  104. data/spec/models/external_bank_account_bank_model_spec.rb +1 -1
  105. data/spec/models/external_bank_account_list_bank_model_spec.rb +1 -1
  106. data/spec/models/external_wallet_bank_model_spec.rb +1 -1
  107. data/spec/models/external_wallet_list_bank_model_spec.rb +1 -1
  108. data/spec/models/identity_verification_bank_model_spec.rb +1 -1
  109. data/spec/models/identity_verification_list_bank_model_spec.rb +1 -1
  110. data/spec/models/identity_verification_with_details_all_of_bank_model_spec.rb +1 -1
  111. data/spec/models/identity_verification_with_details_bank_model_spec.rb +1 -1
  112. data/spec/models/patch_bank_bank_model_spec.rb +1 -1
  113. data/spec/models/patch_external_bank_account_bank_model_spec.rb +1 -1
  114. data/spec/models/post_account_bank_model_spec.rb +1 -1
  115. data/spec/models/post_bank_bank_model_spec.rb +1 -1
  116. data/spec/models/post_customer_address_bank_model_spec.rb +1 -1
  117. data/spec/models/post_customer_bank_model_spec.rb +1 -1
  118. data/spec/models/post_customer_name_bank_model_spec.rb +1 -1
  119. data/spec/models/post_deposit_address_bank_model_spec.rb +1 -1
  120. data/spec/models/post_external_bank_account_bank_model_spec.rb +1 -1
  121. data/spec/models/post_external_wallet_bank_model_spec.rb +1 -1
  122. data/spec/models/post_identification_number_bank_model_spec.rb +1 -1
  123. data/spec/models/post_identity_verification_address_bank_model_spec.rb +1 -1
  124. data/spec/models/post_identity_verification_bank_model_spec.rb +1 -1
  125. data/spec/models/post_identity_verification_name_bank_model_spec.rb +1 -1
  126. data/spec/models/post_quote_bank_model_spec.rb +1 -1
  127. data/spec/models/post_reward_bank_model_spec.rb +1 -1
  128. data/spec/models/post_trade_bank_model_spec.rb +1 -1
  129. data/spec/models/post_transfer_bank_model_spec.rb +1 -1
  130. data/spec/models/post_workflow_bank_model_spec.rb +1 -1
  131. data/spec/models/quote_bank_model_spec.rb +1 -1
  132. data/spec/models/quote_list_bank_model_spec.rb +1 -1
  133. data/spec/models/reward_bank_model_spec.rb +1 -1
  134. data/spec/models/reward_list_bank_model_spec.rb +1 -1
  135. data/spec/models/symbol_price_bank_model_spec.rb +1 -1
  136. data/spec/models/trade_bank_model_spec.rb +1 -1
  137. data/spec/models/trade_list_bank_model_spec.rb +1 -1
  138. data/spec/models/transfer_bank_model_spec.rb +1 -1
  139. data/spec/models/transfer_list_bank_model_spec.rb +1 -1
  140. data/spec/models/workflow_bank_model_spec.rb +1 -1
  141. data/spec/models/workflow_with_details_all_of_bank_model_spec.rb +1 -1
  142. data/spec/models/workflow_with_details_bank_model_spec.rb +1 -1
  143. data/spec/models/workflows_list_bank_model_spec.rb +1 -1
  144. data/spec/spec_helper.rb +1 -1
  145. data/vendor/bundle/ruby/3.2.0/extensions/x86_64-linux/3.2.0/byebug-11.1.3/gem_make.out +5 -5
  146. data/vendor/bundle/ruby/3.2.0/extensions/x86_64-linux/3.2.0/ffi-1.15.5/gem_make.out +5 -5
  147. data/vendor/bundle/ruby/3.2.0/extensions/x86_64-linux/3.2.0/jaro_winkler-1.5.6/gem_make.out +5 -5
  148. data/vendor/bundle/ruby/3.2.0/extensions/x86_64-linux/3.2.0/psych-5.1.0/gem_make.out +5 -5
  149. data/vendor/bundle/ruby/3.2.0/extensions/x86_64-linux/3.2.0/racc-1.7.1/gem_make.out +5 -5
  150. data/vendor/bundle/ruby/3.2.0/extensions/x86_64-linux/3.2.0/stringio-3.0.7/gem_make.out +5 -5
  151. metadata +1 -13
  152. data/docs/PostVerificationKeyBankModel.md +0 -26
  153. data/docs/VerificationKeyBankModel.md +0 -32
  154. data/docs/VerificationKeyListBankModel.md +0 -24
  155. data/lib/cybrid_api_bank_ruby/models/post_verification_key_bank_model.rb +0 -415
  156. data/lib/cybrid_api_bank_ruby/models/verification_key_bank_model.rb +0 -433
  157. data/lib/cybrid_api_bank_ruby/models/verification_key_list_bank_model.rb +0 -329
  158. data/spec/models/post_verification_key_bank_model_spec.rb +0 -66
  159. data/spec/models/verification_key_bank_model_spec.rb +0 -92
  160. data/spec/models/verification_key_list_bank_model_spec.rb +0 -52
@@ -1,433 +0,0 @@
1
- =begin
2
- #Cybrid Bank API
3
-
4
- ## 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 accounts:read accounts:execute customers:read customers:write customers:execute prices:read quotes:execute quotes:read trades:execute trades:read transfers:execute transfers:read rewards:execute rewards: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\" }' -H \"Content-Type: application/json\" # When using Organization credentials set `scope` to 'organizations:read organizations:write banks:read banks:write banks: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' ``` <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) | | | Price | prices:read (Bank, Customer) | | | | Quote | quotes:read (Organization, Bank, Customer) | | quotes:execute (Organization, Bank, Customer) | | Reward | rewards:read (Bank, Customer) | | rewards:execute (Bank) | | 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 | | 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 | Reward | /api/rewards | Create a new reward (automates quote/trade for simplicity) | | 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.
5
-
6
- The version of the OpenAPI document: v0.74.10
7
- Contact: support@cybrid.app
8
- Generated by: https://openapi-generator.tech
9
- OpenAPI Generator version: 6.0.0
10
-
11
- =end
12
-
13
- require 'date'
14
- require 'time'
15
-
16
- module CybridApiBank
17
- class VerificationKeyBankModel
18
- # Auto-generated unique identifier for the verification key.
19
- attr_accessor :guid
20
-
21
- # The banks's identifier.
22
- attr_accessor :bank_guid
23
-
24
- # The verification key's type.
25
- attr_accessor :type
26
-
27
- # The verification key's state.
28
- attr_accessor :state
29
-
30
- # The verification key's failure code (if any).
31
- attr_accessor :failure_code
32
-
33
- # The verification key's algorithm.
34
- attr_accessor :algorithm
35
-
36
- # The verification key's cryptographic fingerprint.
37
- attr_accessor :fingerprint
38
-
39
- # ISO8601 datetime the verification key was created at.
40
- attr_accessor :created_at
41
-
42
- class EnumAttributeValidator
43
- attr_reader :datatype
44
- attr_reader :allowable_values
45
-
46
- def initialize(datatype, allowable_values)
47
- @allowable_values = allowable_values.map do |value|
48
- case datatype.to_s
49
- when /Integer/i
50
- value.to_i
51
- when /Float/i
52
- value.to_f
53
- else
54
- value
55
- end
56
- end
57
- end
58
-
59
- def valid?(value)
60
- !value || allowable_values.include?(value)
61
- end
62
- end
63
-
64
- # Attribute mapping from ruby-style variable name to JSON key.
65
- def self.attribute_map
66
- {
67
- :'guid' => :'guid',
68
- :'bank_guid' => :'bank_guid',
69
- :'type' => :'type',
70
- :'state' => :'state',
71
- :'failure_code' => :'failure_code',
72
- :'algorithm' => :'algorithm',
73
- :'fingerprint' => :'fingerprint',
74
- :'created_at' => :'created_at'
75
- }
76
- end
77
-
78
- # Returns all the JSON keys this model knows about
79
- def self.acceptable_attributes
80
- attribute_map.values
81
- end
82
-
83
- # Attribute type mapping.
84
- def self.openapi_types
85
- {
86
- :'guid' => :'String',
87
- :'bank_guid' => :'String',
88
- :'type' => :'String',
89
- :'state' => :'String',
90
- :'failure_code' => :'String',
91
- :'algorithm' => :'String',
92
- :'fingerprint' => :'String',
93
- :'created_at' => :'Time'
94
- }
95
- end
96
-
97
- # List of attributes with nullable: true
98
- def self.openapi_nullable
99
- Set.new([
100
- :'failure_code',
101
- ])
102
- end
103
-
104
- # Initializes the object
105
- # @param [Hash] attributes Model attributes in the form of hash
106
- def initialize(attributes = {})
107
- if (!attributes.is_a?(Hash))
108
- fail ArgumentError, "The input argument (attributes) must be a hash in `CybridApiBank::VerificationKeyBankModel` initialize method"
109
- end
110
-
111
- # check to see if the attribute exists and convert string to symbol for hash key
112
- attributes = attributes.each_with_object({}) { |(k, v), h|
113
- if (!self.class.attribute_map.key?(k.to_sym))
114
- fail ArgumentError, "`#{k}` is not a valid attribute in `CybridApiBank::VerificationKeyBankModel`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
115
- end
116
- h[k.to_sym] = v
117
- }
118
-
119
- if attributes.key?(:'guid')
120
- self.guid = attributes[:'guid']
121
- end
122
-
123
- if attributes.key?(:'bank_guid')
124
- self.bank_guid = attributes[:'bank_guid']
125
- end
126
-
127
- if attributes.key?(:'type')
128
- self.type = attributes[:'type']
129
- end
130
-
131
- if attributes.key?(:'state')
132
- self.state = attributes[:'state']
133
- end
134
-
135
- if attributes.key?(:'failure_code')
136
- self.failure_code = attributes[:'failure_code']
137
- end
138
-
139
- if attributes.key?(:'algorithm')
140
- self.algorithm = attributes[:'algorithm']
141
- end
142
-
143
- if attributes.key?(:'fingerprint')
144
- self.fingerprint = attributes[:'fingerprint']
145
- end
146
-
147
- if attributes.key?(:'created_at')
148
- self.created_at = attributes[:'created_at']
149
- end
150
- end
151
-
152
- # Show invalid properties with the reasons. Usually used together with valid?
153
- # @return Array for valid properties with the reasons
154
- def list_invalid_properties
155
- invalid_properties = Array.new
156
- if !@guid.nil? && @guid.to_s.length > 32
157
- invalid_properties.push('invalid value for "guid", the character length must be smaller than or equal to 32.')
158
- end
159
-
160
- if !@guid.nil? && @guid.to_s.length < 32
161
- invalid_properties.push('invalid value for "guid", the character length must be great than or equal to 32.')
162
- end
163
-
164
- if !@bank_guid.nil? && @bank_guid.to_s.length > 32
165
- invalid_properties.push('invalid value for "bank_guid", the character length must be smaller than or equal to 32.')
166
- end
167
-
168
- if !@bank_guid.nil? && @bank_guid.to_s.length < 32
169
- invalid_properties.push('invalid value for "bank_guid", the character length must be great than or equal to 32.')
170
- end
171
-
172
- if !@fingerprint.nil? && @fingerprint.to_s.length > 128
173
- invalid_properties.push('invalid value for "fingerprint", the character length must be smaller than or equal to 128.')
174
- end
175
-
176
- if !@fingerprint.nil? && @fingerprint.to_s.length < 1
177
- invalid_properties.push('invalid value for "fingerprint", the character length must be great than or equal to 1.')
178
- end
179
-
180
- invalid_properties
181
- end
182
-
183
- # Check to see if the all the properties in the model are valid
184
- # @return true if the model is valid
185
- def valid?
186
- return false if !@guid.nil? && @guid.to_s.length > 32
187
- return false if !@guid.nil? && @guid.to_s.length < 32
188
- return false if !@bank_guid.nil? && @bank_guid.to_s.length > 32
189
- return false if !@bank_guid.nil? && @bank_guid.to_s.length < 32
190
- type_validator = EnumAttributeValidator.new('String', ["attestation"])
191
- return false unless type_validator.valid?(@type)
192
- state_validator = EnumAttributeValidator.new('String', ["storing", "pending", "verified", "failed"])
193
- return false unless state_validator.valid?(@state)
194
- failure_code_validator = EnumAttributeValidator.new('String', ["invalid_algorithm", "invalid_nonce", "invalid_public_key", "invalid_signature"])
195
- return false unless failure_code_validator.valid?(@failure_code)
196
- algorithm_validator = EnumAttributeValidator.new('String', ["RS512"])
197
- return false unless algorithm_validator.valid?(@algorithm)
198
- return false if !@fingerprint.nil? && @fingerprint.to_s.length > 128
199
- return false if !@fingerprint.nil? && @fingerprint.to_s.length < 1
200
- true
201
- end
202
-
203
- # Custom attribute writer method with validation
204
- # @param [Object] guid Value to be assigned
205
- def guid=(guid)
206
- if !guid.nil? && guid.to_s.length > 32
207
- fail ArgumentError, 'invalid value for "guid", the character length must be smaller than or equal to 32.'
208
- end
209
-
210
- if !guid.nil? && guid.to_s.length < 32
211
- fail ArgumentError, 'invalid value for "guid", the character length must be great than or equal to 32.'
212
- end
213
-
214
- @guid = guid
215
- end
216
-
217
- # Custom attribute writer method with validation
218
- # @param [Object] bank_guid Value to be assigned
219
- def bank_guid=(bank_guid)
220
- if !bank_guid.nil? && bank_guid.to_s.length > 32
221
- fail ArgumentError, 'invalid value for "bank_guid", the character length must be smaller than or equal to 32.'
222
- end
223
-
224
- if !bank_guid.nil? && bank_guid.to_s.length < 32
225
- fail ArgumentError, 'invalid value for "bank_guid", the character length must be great than or equal to 32.'
226
- end
227
-
228
- @bank_guid = bank_guid
229
- end
230
-
231
- # Custom attribute writer method checking allowed values (enum).
232
- # @param [Object] type Object to be assigned
233
- def type=(type)
234
- validator = EnumAttributeValidator.new('String', ["attestation"])
235
- unless validator.valid?(type)
236
- fail ArgumentError, "invalid value for \"type\", must be one of #{validator.allowable_values}."
237
- end
238
- @type = type
239
- end
240
-
241
- # Custom attribute writer method checking allowed values (enum).
242
- # @param [Object] state Object to be assigned
243
- def state=(state)
244
- validator = EnumAttributeValidator.new('String', ["storing", "pending", "verified", "failed"])
245
- unless validator.valid?(state)
246
- fail ArgumentError, "invalid value for \"state\", must be one of #{validator.allowable_values}."
247
- end
248
- @state = state
249
- end
250
-
251
- # Custom attribute writer method checking allowed values (enum).
252
- # @param [Object] failure_code Object to be assigned
253
- def failure_code=(failure_code)
254
- validator = EnumAttributeValidator.new('String', ["invalid_algorithm", "invalid_nonce", "invalid_public_key", "invalid_signature"])
255
- unless validator.valid?(failure_code)
256
- fail ArgumentError, "invalid value for \"failure_code\", must be one of #{validator.allowable_values}."
257
- end
258
- @failure_code = failure_code
259
- end
260
-
261
- # Custom attribute writer method checking allowed values (enum).
262
- # @param [Object] algorithm Object to be assigned
263
- def algorithm=(algorithm)
264
- validator = EnumAttributeValidator.new('String', ["RS512"])
265
- unless validator.valid?(algorithm)
266
- fail ArgumentError, "invalid value for \"algorithm\", must be one of #{validator.allowable_values}."
267
- end
268
- @algorithm = algorithm
269
- end
270
-
271
- # Custom attribute writer method with validation
272
- # @param [Object] fingerprint Value to be assigned
273
- def fingerprint=(fingerprint)
274
- if !fingerprint.nil? && fingerprint.to_s.length > 128
275
- fail ArgumentError, 'invalid value for "fingerprint", the character length must be smaller than or equal to 128.'
276
- end
277
-
278
- if !fingerprint.nil? && fingerprint.to_s.length < 1
279
- fail ArgumentError, 'invalid value for "fingerprint", the character length must be great than or equal to 1.'
280
- end
281
-
282
- @fingerprint = fingerprint
283
- end
284
-
285
- # Checks equality by comparing each attribute.
286
- # @param [Object] Object to be compared
287
- def ==(o)
288
- return true if self.equal?(o)
289
- self.class == o.class &&
290
- guid == o.guid &&
291
- bank_guid == o.bank_guid &&
292
- type == o.type &&
293
- state == o.state &&
294
- failure_code == o.failure_code &&
295
- algorithm == o.algorithm &&
296
- fingerprint == o.fingerprint &&
297
- created_at == o.created_at
298
- end
299
-
300
- # @see the `==` method
301
- # @param [Object] Object to be compared
302
- def eql?(o)
303
- self == o
304
- end
305
-
306
- # Calculates hash code according to all attributes.
307
- # @return [Integer] Hash code
308
- def hash
309
- [guid, bank_guid, type, state, failure_code, algorithm, fingerprint, created_at].hash
310
- end
311
-
312
- # Builds the object from hash
313
- # @param [Hash] attributes Model attributes in the form of hash
314
- # @return [Object] Returns the model itself
315
- def self.build_from_hash(attributes)
316
- new.build_from_hash(attributes)
317
- end
318
-
319
- # Builds the object from hash
320
- # @param [Hash] attributes Model attributes in the form of hash
321
- # @return [Object] Returns the model itself
322
- def build_from_hash(attributes)
323
- return nil unless attributes.is_a?(Hash)
324
- attributes = attributes.transform_keys(&:to_sym)
325
- self.class.openapi_types.each_pair do |key, type|
326
- if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
327
- self.send("#{key}=", nil)
328
- elsif type =~ /\AArray<(.*)>/i
329
- # check to ensure the input is an array given that the attribute
330
- # is documented as an array but the input is not
331
- if attributes[self.class.attribute_map[key]].is_a?(Array)
332
- self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
333
- end
334
- elsif !attributes[self.class.attribute_map[key]].nil?
335
- self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
336
- end
337
- end
338
-
339
- self
340
- end
341
-
342
- # Deserializes the data based on type
343
- # @param string type Data type
344
- # @param string value Value to be deserialized
345
- # @return [Object] Deserialized data
346
- def _deserialize(type, value)
347
- case type.to_sym
348
- when :Time
349
- Time.parse(value)
350
- when :Date
351
- Date.parse(value)
352
- when :String
353
- value.to_s
354
- when :Integer
355
- value.to_i
356
- when :Float
357
- value.to_f
358
- when :Boolean
359
- if value.to_s =~ /\A(true|t|yes|y|1)\z/i
360
- true
361
- else
362
- false
363
- end
364
- when :Object
365
- # generic object (usually a Hash), return directly
366
- value
367
- when /\AArray<(?<inner_type>.+)>\z/
368
- inner_type = Regexp.last_match[:inner_type]
369
- value.map { |v| _deserialize(inner_type, v) }
370
- when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
371
- k_type = Regexp.last_match[:k_type]
372
- v_type = Regexp.last_match[:v_type]
373
- {}.tap do |hash|
374
- value.each do |k, v|
375
- hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
376
- end
377
- end
378
- else # model
379
- # models (e.g. Pet) or oneOf
380
- klass = CybridApiBank.const_get(type)
381
- klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
382
- end
383
- end
384
-
385
- # Returns the string representation of the object
386
- # @return [String] String presentation of the object
387
- def to_s
388
- to_hash.to_s
389
- end
390
-
391
- # to_body is an alias to to_hash (backward compatibility)
392
- # @return [Hash] Returns the object in the form of hash
393
- def to_body
394
- to_hash
395
- end
396
-
397
- # Returns the object in the form of hash
398
- # @return [Hash] Returns the object in the form of hash
399
- def to_hash
400
- hash = {}
401
- self.class.attribute_map.each_pair do |attr, param|
402
- value = self.send(attr)
403
- if value.nil?
404
- is_nullable = self.class.openapi_nullable.include?(attr)
405
- next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
406
- end
407
-
408
- hash[param] = _to_hash(value)
409
- end
410
- hash
411
- end
412
-
413
- # Outputs non-array value in the form of hash
414
- # For object, use to_hash. Otherwise, just return the value
415
- # @param [Object] value Any valid value
416
- # @return [Hash] Returns the value in the form of hash
417
- def _to_hash(value)
418
- if value.is_a?(Array)
419
- value.compact.map { |v| _to_hash(v) }
420
- elsif value.is_a?(Hash)
421
- {}.tap do |hash|
422
- value.each { |k, v| hash[k] = _to_hash(v) }
423
- end
424
- elsif value.respond_to? :to_hash
425
- value.to_hash
426
- else
427
- value
428
- end
429
- end
430
-
431
- end
432
-
433
- end