cybrid_api_bank_ruby 0.109.61 → 0.110.0

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