cybrid_api_bank_ruby 0.74.8 → 0.74.11

Sign up to get free protection for your applications and to get access to all the features.
Files changed (199) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile.lock +2 -2
  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/cache/rspec-support-3.12.1.gem +0 -0
  146. data/vendor/bundle/ruby/3.2.0/extensions/x86_64-linux/3.2.0/byebug-11.1.3/gem_make.out +5 -5
  147. data/vendor/bundle/ruby/3.2.0/extensions/x86_64-linux/3.2.0/ffi-1.15.5/gem_make.out +5 -5
  148. data/vendor/bundle/ruby/3.2.0/extensions/x86_64-linux/3.2.0/jaro_winkler-1.5.6/gem_make.out +5 -5
  149. data/vendor/bundle/ruby/3.2.0/extensions/x86_64-linux/3.2.0/psych-5.1.0/gem_make.out +5 -5
  150. data/vendor/bundle/ruby/3.2.0/extensions/x86_64-linux/3.2.0/racc-1.7.1/gem_make.out +5 -5
  151. data/vendor/bundle/ruby/3.2.0/extensions/x86_64-linux/3.2.0/stringio-3.0.7/gem_make.out +5 -5
  152. data/vendor/bundle/ruby/3.2.0/gems/{rspec-support-3.12.0 → rspec-support-3.12.1}/Changelog.md +9 -1
  153. data/vendor/bundle/ruby/3.2.0/gems/{rspec-support-3.12.0 → rspec-support-3.12.1}/lib/rspec/support/spec/shell_out.rb +3 -0
  154. data/vendor/bundle/ruby/3.2.0/gems/{rspec-support-3.12.0 → rspec-support-3.12.1}/lib/rspec/support/version.rb +1 -1
  155. data/vendor/bundle/ruby/3.2.0/gems/{rspec-support-3.12.0 → rspec-support-3.12.1}/lib/rspec/support.rb +8 -2
  156. data/vendor/bundle/ruby/3.2.0/specifications/{rspec-support-3.12.0.gemspec → rspec-support-3.12.1.gemspec} +5 -5
  157. metadata +39 -51
  158. data/docs/PostVerificationKeyBankModel.md +0 -26
  159. data/docs/VerificationKeyBankModel.md +0 -32
  160. data/docs/VerificationKeyListBankModel.md +0 -24
  161. data/lib/cybrid_api_bank_ruby/models/post_verification_key_bank_model.rb +0 -415
  162. data/lib/cybrid_api_bank_ruby/models/verification_key_bank_model.rb +0 -433
  163. data/lib/cybrid_api_bank_ruby/models/verification_key_list_bank_model.rb +0 -329
  164. data/spec/models/post_verification_key_bank_model_spec.rb +0 -66
  165. data/spec/models/verification_key_bank_model_spec.rb +0 -92
  166. data/spec/models/verification_key_list_bank_model_spec.rb +0 -52
  167. data/vendor/bundle/ruby/3.2.0/cache/rspec-support-3.12.0.gem +0 -0
  168. /data/vendor/bundle/ruby/3.2.0/gems/{rspec-support-3.12.0 → rspec-support-3.12.1}/LICENSE.md +0 -0
  169. /data/vendor/bundle/ruby/3.2.0/gems/{rspec-support-3.12.0 → rspec-support-3.12.1}/README.md +0 -0
  170. /data/vendor/bundle/ruby/3.2.0/gems/{rspec-support-3.12.0 → rspec-support-3.12.1}/lib/rspec/support/caller_filter.rb +0 -0
  171. /data/vendor/bundle/ruby/3.2.0/gems/{rspec-support-3.12.0 → rspec-support-3.12.1}/lib/rspec/support/comparable_version.rb +0 -0
  172. /data/vendor/bundle/ruby/3.2.0/gems/{rspec-support-3.12.0 → rspec-support-3.12.1}/lib/rspec/support/differ.rb +0 -0
  173. /data/vendor/bundle/ruby/3.2.0/gems/{rspec-support-3.12.0 → rspec-support-3.12.1}/lib/rspec/support/directory_maker.rb +0 -0
  174. /data/vendor/bundle/ruby/3.2.0/gems/{rspec-support-3.12.0 → rspec-support-3.12.1}/lib/rspec/support/encoded_string.rb +0 -0
  175. /data/vendor/bundle/ruby/3.2.0/gems/{rspec-support-3.12.0 → rspec-support-3.12.1}/lib/rspec/support/fuzzy_matcher.rb +0 -0
  176. /data/vendor/bundle/ruby/3.2.0/gems/{rspec-support-3.12.0 → rspec-support-3.12.1}/lib/rspec/support/hunk_generator.rb +0 -0
  177. /data/vendor/bundle/ruby/3.2.0/gems/{rspec-support-3.12.0 → rspec-support-3.12.1}/lib/rspec/support/matcher_definition.rb +0 -0
  178. /data/vendor/bundle/ruby/3.2.0/gems/{rspec-support-3.12.0 → rspec-support-3.12.1}/lib/rspec/support/method_signature_verifier.rb +0 -0
  179. /data/vendor/bundle/ruby/3.2.0/gems/{rspec-support-3.12.0 → rspec-support-3.12.1}/lib/rspec/support/mutex.rb +0 -0
  180. /data/vendor/bundle/ruby/3.2.0/gems/{rspec-support-3.12.0 → rspec-support-3.12.1}/lib/rspec/support/object_formatter.rb +0 -0
  181. /data/vendor/bundle/ruby/3.2.0/gems/{rspec-support-3.12.0 → rspec-support-3.12.1}/lib/rspec/support/recursive_const_methods.rb +0 -0
  182. /data/vendor/bundle/ruby/3.2.0/gems/{rspec-support-3.12.0 → rspec-support-3.12.1}/lib/rspec/support/reentrant_mutex.rb +0 -0
  183. /data/vendor/bundle/ruby/3.2.0/gems/{rspec-support-3.12.0 → rspec-support-3.12.1}/lib/rspec/support/ruby_features.rb +0 -0
  184. /data/vendor/bundle/ruby/3.2.0/gems/{rspec-support-3.12.0 → rspec-support-3.12.1}/lib/rspec/support/source/location.rb +0 -0
  185. /data/vendor/bundle/ruby/3.2.0/gems/{rspec-support-3.12.0 → rspec-support-3.12.1}/lib/rspec/support/source/node.rb +0 -0
  186. /data/vendor/bundle/ruby/3.2.0/gems/{rspec-support-3.12.0 → rspec-support-3.12.1}/lib/rspec/support/source/token.rb +0 -0
  187. /data/vendor/bundle/ruby/3.2.0/gems/{rspec-support-3.12.0 → rspec-support-3.12.1}/lib/rspec/support/source.rb +0 -0
  188. /data/vendor/bundle/ruby/3.2.0/gems/{rspec-support-3.12.0 → rspec-support-3.12.1}/lib/rspec/support/spec/deprecation_helpers.rb +0 -0
  189. /data/vendor/bundle/ruby/3.2.0/gems/{rspec-support-3.12.0 → rspec-support-3.12.1}/lib/rspec/support/spec/diff_helpers.rb +0 -0
  190. /data/vendor/bundle/ruby/3.2.0/gems/{rspec-support-3.12.0 → rspec-support-3.12.1}/lib/rspec/support/spec/formatting_support.rb +0 -0
  191. /data/vendor/bundle/ruby/3.2.0/gems/{rspec-support-3.12.0 → rspec-support-3.12.1}/lib/rspec/support/spec/in_sub_process.rb +0 -0
  192. /data/vendor/bundle/ruby/3.2.0/gems/{rspec-support-3.12.0 → rspec-support-3.12.1}/lib/rspec/support/spec/library_wide_checks.rb +0 -0
  193. /data/vendor/bundle/ruby/3.2.0/gems/{rspec-support-3.12.0 → rspec-support-3.12.1}/lib/rspec/support/spec/stderr_splitter.rb +0 -0
  194. /data/vendor/bundle/ruby/3.2.0/gems/{rspec-support-3.12.0 → rspec-support-3.12.1}/lib/rspec/support/spec/string_matcher.rb +0 -0
  195. /data/vendor/bundle/ruby/3.2.0/gems/{rspec-support-3.12.0 → rspec-support-3.12.1}/lib/rspec/support/spec/with_isolated_directory.rb +0 -0
  196. /data/vendor/bundle/ruby/3.2.0/gems/{rspec-support-3.12.0 → rspec-support-3.12.1}/lib/rspec/support/spec/with_isolated_stderr.rb +0 -0
  197. /data/vendor/bundle/ruby/3.2.0/gems/{rspec-support-3.12.0 → rspec-support-3.12.1}/lib/rspec/support/spec.rb +0 -0
  198. /data/vendor/bundle/ruby/3.2.0/gems/{rspec-support-3.12.0 → rspec-support-3.12.1}/lib/rspec/support/warnings.rb +0 -0
  199. /data/vendor/bundle/ruby/3.2.0/gems/{rspec-support-3.12.0 → rspec-support-3.12.1}/lib/rspec/support/with_keywords_when_needed.rb +0 -0
@@ -1,415 +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.8
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 PostVerificationKeyBankModel
18
- # The verification key's type.
19
- attr_accessor :type
20
-
21
- # The verification key's algorithm.
22
- attr_accessor :algorithm
23
-
24
- # DER encoded public key in Base64 format.
25
- attr_accessor :public_key
26
-
27
- # Value signed in the **signature** field.
28
- attr_accessor :nonce
29
-
30
- # Signature on **nonce** using PKCS1v15 padding and the SHA512 hashing algorithm in Base64 format.
31
- attr_accessor :signature
32
-
33
- class EnumAttributeValidator
34
- attr_reader :datatype
35
- attr_reader :allowable_values
36
-
37
- def initialize(datatype, allowable_values)
38
- @allowable_values = allowable_values.map do |value|
39
- case datatype.to_s
40
- when /Integer/i
41
- value.to_i
42
- when /Float/i
43
- value.to_f
44
- else
45
- value
46
- end
47
- end
48
- end
49
-
50
- def valid?(value)
51
- !value || allowable_values.include?(value)
52
- end
53
- end
54
-
55
- # Attribute mapping from ruby-style variable name to JSON key.
56
- def self.attribute_map
57
- {
58
- :'type' => :'type',
59
- :'algorithm' => :'algorithm',
60
- :'public_key' => :'public_key',
61
- :'nonce' => :'nonce',
62
- :'signature' => :'signature'
63
- }
64
- end
65
-
66
- # Returns all the JSON keys this model knows about
67
- def self.acceptable_attributes
68
- attribute_map.values
69
- end
70
-
71
- # Attribute type mapping.
72
- def self.openapi_types
73
- {
74
- :'type' => :'String',
75
- :'algorithm' => :'String',
76
- :'public_key' => :'String',
77
- :'nonce' => :'String',
78
- :'signature' => :'String'
79
- }
80
- end
81
-
82
- # List of attributes with nullable: true
83
- def self.openapi_nullable
84
- Set.new([
85
- ])
86
- end
87
-
88
- # Initializes the object
89
- # @param [Hash] attributes Model attributes in the form of hash
90
- def initialize(attributes = {})
91
- if (!attributes.is_a?(Hash))
92
- fail ArgumentError, "The input argument (attributes) must be a hash in `CybridApiBank::PostVerificationKeyBankModel` initialize method"
93
- end
94
-
95
- # check to see if the attribute exists and convert string to symbol for hash key
96
- attributes = attributes.each_with_object({}) { |(k, v), h|
97
- if (!self.class.attribute_map.key?(k.to_sym))
98
- fail ArgumentError, "`#{k}` is not a valid attribute in `CybridApiBank::PostVerificationKeyBankModel`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
99
- end
100
- h[k.to_sym] = v
101
- }
102
-
103
- if attributes.key?(:'type')
104
- self.type = attributes[:'type']
105
- end
106
-
107
- if attributes.key?(:'algorithm')
108
- self.algorithm = attributes[:'algorithm']
109
- end
110
-
111
- if attributes.key?(:'public_key')
112
- self.public_key = attributes[:'public_key']
113
- end
114
-
115
- if attributes.key?(:'nonce')
116
- self.nonce = attributes[:'nonce']
117
- end
118
-
119
- if attributes.key?(:'signature')
120
- self.signature = attributes[:'signature']
121
- end
122
- end
123
-
124
- # Show invalid properties with the reasons. Usually used together with valid?
125
- # @return Array for valid properties with the reasons
126
- def list_invalid_properties
127
- invalid_properties = Array.new
128
- if @type.nil?
129
- invalid_properties.push('invalid value for "type", type cannot be nil.')
130
- end
131
-
132
- if @algorithm.nil?
133
- invalid_properties.push('invalid value for "algorithm", algorithm cannot be nil.')
134
- end
135
-
136
- if @public_key.nil?
137
- invalid_properties.push('invalid value for "public_key", public_key cannot be nil.')
138
- end
139
-
140
- if @public_key.to_s.length > 6000
141
- invalid_properties.push('invalid value for "public_key", the character length must be smaller than or equal to 6000.')
142
- end
143
-
144
- if @public_key.to_s.length < 1
145
- invalid_properties.push('invalid value for "public_key", the character length must be great than or equal to 1.')
146
- end
147
-
148
- if @nonce.nil?
149
- invalid_properties.push('invalid value for "nonce", nonce cannot be nil.')
150
- end
151
-
152
- if @nonce.to_s.length > 256
153
- invalid_properties.push('invalid value for "nonce", the character length must be smaller than or equal to 256.')
154
- end
155
-
156
- if @nonce.to_s.length < 1
157
- invalid_properties.push('invalid value for "nonce", the character length must be great than or equal to 1.')
158
- end
159
-
160
- if @signature.nil?
161
- invalid_properties.push('invalid value for "signature", signature cannot be nil.')
162
- end
163
-
164
- if @signature.to_s.length > 6000
165
- invalid_properties.push('invalid value for "signature", the character length must be smaller than or equal to 6000.')
166
- end
167
-
168
- if @signature.to_s.length < 1
169
- invalid_properties.push('invalid value for "signature", the character length must be great than or equal to 1.')
170
- end
171
-
172
- invalid_properties
173
- end
174
-
175
- # Check to see if the all the properties in the model are valid
176
- # @return true if the model is valid
177
- def valid?
178
- return false if @type.nil?
179
- type_validator = EnumAttributeValidator.new('String', ["attestation"])
180
- return false unless type_validator.valid?(@type)
181
- return false if @algorithm.nil?
182
- algorithm_validator = EnumAttributeValidator.new('String', ["RS512"])
183
- return false unless algorithm_validator.valid?(@algorithm)
184
- return false if @public_key.nil?
185
- return false if @public_key.to_s.length > 6000
186
- return false if @public_key.to_s.length < 1
187
- return false if @nonce.nil?
188
- return false if @nonce.to_s.length > 256
189
- return false if @nonce.to_s.length < 1
190
- return false if @signature.nil?
191
- return false if @signature.to_s.length > 6000
192
- return false if @signature.to_s.length < 1
193
- true
194
- end
195
-
196
- # Custom attribute writer method checking allowed values (enum).
197
- # @param [Object] type Object to be assigned
198
- def type=(type)
199
- validator = EnumAttributeValidator.new('String', ["attestation"])
200
- unless validator.valid?(type)
201
- fail ArgumentError, "invalid value for \"type\", must be one of #{validator.allowable_values}."
202
- end
203
- @type = type
204
- end
205
-
206
- # Custom attribute writer method checking allowed values (enum).
207
- # @param [Object] algorithm Object to be assigned
208
- def algorithm=(algorithm)
209
- validator = EnumAttributeValidator.new('String', ["RS512"])
210
- unless validator.valid?(algorithm)
211
- fail ArgumentError, "invalid value for \"algorithm\", must be one of #{validator.allowable_values}."
212
- end
213
- @algorithm = algorithm
214
- end
215
-
216
- # Custom attribute writer method with validation
217
- # @param [Object] public_key Value to be assigned
218
- def public_key=(public_key)
219
- if public_key.nil?
220
- fail ArgumentError, 'public_key cannot be nil'
221
- end
222
-
223
- if public_key.to_s.length > 6000
224
- fail ArgumentError, 'invalid value for "public_key", the character length must be smaller than or equal to 6000.'
225
- end
226
-
227
- if public_key.to_s.length < 1
228
- fail ArgumentError, 'invalid value for "public_key", the character length must be great than or equal to 1.'
229
- end
230
-
231
- @public_key = public_key
232
- end
233
-
234
- # Custom attribute writer method with validation
235
- # @param [Object] nonce Value to be assigned
236
- def nonce=(nonce)
237
- if nonce.nil?
238
- fail ArgumentError, 'nonce cannot be nil'
239
- end
240
-
241
- if nonce.to_s.length > 256
242
- fail ArgumentError, 'invalid value for "nonce", the character length must be smaller than or equal to 256.'
243
- end
244
-
245
- if nonce.to_s.length < 1
246
- fail ArgumentError, 'invalid value for "nonce", the character length must be great than or equal to 1.'
247
- end
248
-
249
- @nonce = nonce
250
- end
251
-
252
- # Custom attribute writer method with validation
253
- # @param [Object] signature Value to be assigned
254
- def signature=(signature)
255
- if signature.nil?
256
- fail ArgumentError, 'signature cannot be nil'
257
- end
258
-
259
- if signature.to_s.length > 6000
260
- fail ArgumentError, 'invalid value for "signature", the character length must be smaller than or equal to 6000.'
261
- end
262
-
263
- if signature.to_s.length < 1
264
- fail ArgumentError, 'invalid value for "signature", the character length must be great than or equal to 1.'
265
- end
266
-
267
- @signature = signature
268
- end
269
-
270
- # Checks equality by comparing each attribute.
271
- # @param [Object] Object to be compared
272
- def ==(o)
273
- return true if self.equal?(o)
274
- self.class == o.class &&
275
- type == o.type &&
276
- algorithm == o.algorithm &&
277
- public_key == o.public_key &&
278
- nonce == o.nonce &&
279
- signature == o.signature
280
- end
281
-
282
- # @see the `==` method
283
- # @param [Object] Object to be compared
284
- def eql?(o)
285
- self == o
286
- end
287
-
288
- # Calculates hash code according to all attributes.
289
- # @return [Integer] Hash code
290
- def hash
291
- [type, algorithm, public_key, nonce, signature].hash
292
- end
293
-
294
- # Builds the object from hash
295
- # @param [Hash] attributes Model attributes in the form of hash
296
- # @return [Object] Returns the model itself
297
- def self.build_from_hash(attributes)
298
- new.build_from_hash(attributes)
299
- end
300
-
301
- # Builds the object from hash
302
- # @param [Hash] attributes Model attributes in the form of hash
303
- # @return [Object] Returns the model itself
304
- def build_from_hash(attributes)
305
- return nil unless attributes.is_a?(Hash)
306
- attributes = attributes.transform_keys(&:to_sym)
307
- self.class.openapi_types.each_pair do |key, type|
308
- if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
309
- self.send("#{key}=", nil)
310
- elsif type =~ /\AArray<(.*)>/i
311
- # check to ensure the input is an array given that the attribute
312
- # is documented as an array but the input is not
313
- if attributes[self.class.attribute_map[key]].is_a?(Array)
314
- self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
315
- end
316
- elsif !attributes[self.class.attribute_map[key]].nil?
317
- self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
318
- end
319
- end
320
-
321
- self
322
- end
323
-
324
- # Deserializes the data based on type
325
- # @param string type Data type
326
- # @param string value Value to be deserialized
327
- # @return [Object] Deserialized data
328
- def _deserialize(type, value)
329
- case type.to_sym
330
- when :Time
331
- Time.parse(value)
332
- when :Date
333
- Date.parse(value)
334
- when :String
335
- value.to_s
336
- when :Integer
337
- value.to_i
338
- when :Float
339
- value.to_f
340
- when :Boolean
341
- if value.to_s =~ /\A(true|t|yes|y|1)\z/i
342
- true
343
- else
344
- false
345
- end
346
- when :Object
347
- # generic object (usually a Hash), return directly
348
- value
349
- when /\AArray<(?<inner_type>.+)>\z/
350
- inner_type = Regexp.last_match[:inner_type]
351
- value.map { |v| _deserialize(inner_type, v) }
352
- when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
353
- k_type = Regexp.last_match[:k_type]
354
- v_type = Regexp.last_match[:v_type]
355
- {}.tap do |hash|
356
- value.each do |k, v|
357
- hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
358
- end
359
- end
360
- else # model
361
- # models (e.g. Pet) or oneOf
362
- klass = CybridApiBank.const_get(type)
363
- klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
364
- end
365
- end
366
-
367
- # Returns the string representation of the object
368
- # @return [String] String presentation of the object
369
- def to_s
370
- to_hash.to_s
371
- end
372
-
373
- # to_body is an alias to to_hash (backward compatibility)
374
- # @return [Hash] Returns the object in the form of hash
375
- def to_body
376
- to_hash
377
- end
378
-
379
- # Returns the object in the form of hash
380
- # @return [Hash] Returns the object in the form of hash
381
- def to_hash
382
- hash = {}
383
- self.class.attribute_map.each_pair do |attr, param|
384
- value = self.send(attr)
385
- if value.nil?
386
- is_nullable = self.class.openapi_nullable.include?(attr)
387
- next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
388
- end
389
-
390
- hash[param] = _to_hash(value)
391
- end
392
- hash
393
- end
394
-
395
- # Outputs non-array value in the form of hash
396
- # For object, use to_hash. Otherwise, just return the value
397
- # @param [Object] value Any valid value
398
- # @return [Hash] Returns the value in the form of hash
399
- def _to_hash(value)
400
- if value.is_a?(Array)
401
- value.compact.map { |v| _to_hash(v) }
402
- elsif value.is_a?(Hash)
403
- {}.tap do |hash|
404
- value.each { |k, v| hash[k] = _to_hash(v) }
405
- end
406
- elsif value.respond_to? :to_hash
407
- value.to_hash
408
- else
409
- value
410
- end
411
- end
412
-
413
- end
414
-
415
- end