cybrid_api_bank_ruby 0.97.0 → 0.98.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (163) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile.lock +1 -1
  3. data/README.md +5 -6
  4. data/cybrid_api_bank_ruby.gemspec +1 -1
  5. data/docs/TradeBankModel.md +2 -0
  6. data/lib/cybrid_api_bank_ruby/api/accounts_bank_api.rb +1 -1
  7. data/lib/cybrid_api_bank_ruby/api/assets_bank_api.rb +1 -1
  8. data/lib/cybrid_api_bank_ruby/api/banks_bank_api.rb +1 -1
  9. data/lib/cybrid_api_bank_ruby/api/customers_bank_api.rb +1 -1
  10. data/lib/cybrid_api_bank_ruby/api/deposit_addresses_bank_api.rb +1 -1
  11. data/lib/cybrid_api_bank_ruby/api/external_bank_accounts_bank_api.rb +1 -1
  12. data/lib/cybrid_api_bank_ruby/api/external_wallets_bank_api.rb +1 -1
  13. data/lib/cybrid_api_bank_ruby/api/identity_verifications_bank_api.rb +1 -1
  14. data/lib/cybrid_api_bank_ruby/api/prices_bank_api.rb +1 -1
  15. data/lib/cybrid_api_bank_ruby/api/quotes_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_address_bank_model.rb +1 -1
  30. data/lib/cybrid_api_bank_ruby/models/customer_bank_model.rb +1 -1
  31. data/lib/cybrid_api_bank_ruby/models/customer_list_bank_model.rb +1 -1
  32. data/lib/cybrid_api_bank_ruby/models/customer_name_bank_model.rb +1 -1
  33. data/lib/cybrid_api_bank_ruby/models/deposit_address_bank_model.rb +1 -1
  34. data/lib/cybrid_api_bank_ruby/models/deposit_address_list_bank_model.rb +1 -1
  35. data/lib/cybrid_api_bank_ruby/models/error_response_bank_model.rb +1 -1
  36. data/lib/cybrid_api_bank_ruby/models/external_bank_account_bank_model.rb +1 -1
  37. data/lib/cybrid_api_bank_ruby/models/external_bank_account_list_bank_model.rb +1 -1
  38. data/lib/cybrid_api_bank_ruby/models/external_wallet_bank_model.rb +1 -1
  39. data/lib/cybrid_api_bank_ruby/models/external_wallet_list_bank_model.rb +1 -1
  40. data/lib/cybrid_api_bank_ruby/models/identity_verification_bank_model.rb +1 -1
  41. data/lib/cybrid_api_bank_ruby/models/identity_verification_list_bank_model.rb +1 -1
  42. data/lib/cybrid_api_bank_ruby/models/identity_verification_with_details_all_of_bank_model.rb +1 -1
  43. data/lib/cybrid_api_bank_ruby/models/identity_verification_with_details_bank_model.rb +1 -1
  44. data/lib/cybrid_api_bank_ruby/models/list_request_owner_bank_model.rb +1 -1
  45. data/lib/cybrid_api_bank_ruby/models/patch_bank_bank_model.rb +1 -1
  46. data/lib/cybrid_api_bank_ruby/models/patch_external_bank_account_bank_model.rb +1 -1
  47. data/lib/cybrid_api_bank_ruby/models/post_account_bank_model.rb +1 -1
  48. data/lib/cybrid_api_bank_ruby/models/post_bank_bank_model.rb +1 -1
  49. data/lib/cybrid_api_bank_ruby/models/post_customer_address_bank_model.rb +1 -1
  50. data/lib/cybrid_api_bank_ruby/models/post_customer_bank_model.rb +1 -1
  51. data/lib/cybrid_api_bank_ruby/models/post_customer_name_bank_model.rb +1 -1
  52. data/lib/cybrid_api_bank_ruby/models/post_deposit_address_bank_model.rb +1 -1
  53. data/lib/cybrid_api_bank_ruby/models/post_external_bank_account_bank_model.rb +1 -1
  54. data/lib/cybrid_api_bank_ruby/models/post_external_bank_account_counterparty_address_bank_model.rb +1 -1
  55. data/lib/cybrid_api_bank_ruby/models/post_external_bank_account_counterparty_bank_account_bank_model.rb +1 -1
  56. data/lib/cybrid_api_bank_ruby/models/post_external_bank_account_counterparty_name_bank_model.rb +1 -1
  57. data/lib/cybrid_api_bank_ruby/models/post_external_wallet_bank_model.rb +1 -1
  58. data/lib/cybrid_api_bank_ruby/models/post_identification_number_bank_model.rb +1 -1
  59. data/lib/cybrid_api_bank_ruby/models/post_identity_verification_address_bank_model.rb +1 -1
  60. data/lib/cybrid_api_bank_ruby/models/post_identity_verification_bank_model.rb +1 -1
  61. data/lib/cybrid_api_bank_ruby/models/post_identity_verification_name_bank_model.rb +1 -1
  62. data/lib/cybrid_api_bank_ruby/models/post_quote_bank_model.rb +1 -1
  63. data/lib/cybrid_api_bank_ruby/models/post_trade_bank_model.rb +1 -1
  64. data/lib/cybrid_api_bank_ruby/models/post_transfer_bank_model.rb +1 -1
  65. data/lib/cybrid_api_bank_ruby/models/post_workflow_bank_model.rb +1 -1
  66. data/lib/cybrid_api_bank_ruby/models/quote_bank_model.rb +1 -1
  67. data/lib/cybrid_api_bank_ruby/models/quote_list_bank_model.rb +1 -1
  68. data/lib/cybrid_api_bank_ruby/models/symbol_price_bank_model.rb +1 -1
  69. data/lib/cybrid_api_bank_ruby/models/trade_bank_model.rb +24 -2
  70. data/lib/cybrid_api_bank_ruby/models/trade_list_bank_model.rb +1 -1
  71. data/lib/cybrid_api_bank_ruby/models/transfer_bank_model.rb +1 -1
  72. data/lib/cybrid_api_bank_ruby/models/transfer_destination_account_bank_model.rb +1 -1
  73. data/lib/cybrid_api_bank_ruby/models/transfer_list_bank_model.rb +1 -1
  74. data/lib/cybrid_api_bank_ruby/models/transfer_source_account_bank_model.rb +1 -1
  75. data/lib/cybrid_api_bank_ruby/models/workflow_bank_model.rb +1 -1
  76. data/lib/cybrid_api_bank_ruby/models/workflow_with_details_all_of_bank_model.rb +1 -1
  77. data/lib/cybrid_api_bank_ruby/models/workflow_with_details_bank_model.rb +1 -1
  78. data/lib/cybrid_api_bank_ruby/models/workflows_list_bank_model.rb +1 -1
  79. data/lib/cybrid_api_bank_ruby/version.rb +2 -2
  80. data/lib/cybrid_api_bank_ruby.rb +1 -2
  81. data/spec/api/accounts_bank_api_spec.rb +1 -1
  82. data/spec/api/assets_bank_api_spec.rb +1 -1
  83. data/spec/api/banks_bank_api_spec.rb +1 -1
  84. data/spec/api/customers_bank_api_spec.rb +1 -1
  85. data/spec/api/deposit_addresses_bank_api_spec.rb +1 -1
  86. data/spec/api/external_bank_accounts_bank_api_spec.rb +1 -1
  87. data/spec/api/external_wallets_bank_api_spec.rb +1 -1
  88. data/spec/api/identity_verifications_bank_api_spec.rb +1 -1
  89. data/spec/api/prices_bank_api_spec.rb +1 -1
  90. data/spec/api/quotes_bank_api_spec.rb +1 -1
  91. data/spec/api/symbols_bank_api_spec.rb +1 -1
  92. data/spec/api/trades_bank_api_spec.rb +1 -1
  93. data/spec/api/transfers_bank_api_spec.rb +1 -1
  94. data/spec/api/workflows_bank_api_spec.rb +1 -1
  95. data/spec/api_client_spec.rb +1 -1
  96. data/spec/configuration_spec.rb +1 -1
  97. data/spec/models/account_bank_model_spec.rb +1 -1
  98. data/spec/models/account_list_bank_model_spec.rb +1 -1
  99. data/spec/models/asset_bank_model_spec.rb +1 -1
  100. data/spec/models/asset_list_bank_model_spec.rb +1 -1
  101. data/spec/models/bank_bank_model_spec.rb +1 -1
  102. data/spec/models/bank_list_bank_model_spec.rb +1 -1
  103. data/spec/models/customer_address_bank_model_spec.rb +1 -1
  104. data/spec/models/customer_bank_model_spec.rb +1 -1
  105. data/spec/models/customer_list_bank_model_spec.rb +1 -1
  106. data/spec/models/customer_name_bank_model_spec.rb +1 -1
  107. data/spec/models/deposit_address_bank_model_spec.rb +1 -1
  108. data/spec/models/deposit_address_list_bank_model_spec.rb +1 -1
  109. data/spec/models/error_response_bank_model_spec.rb +1 -1
  110. data/spec/models/external_bank_account_bank_model_spec.rb +1 -1
  111. data/spec/models/external_bank_account_list_bank_model_spec.rb +1 -1
  112. data/spec/models/external_wallet_bank_model_spec.rb +1 -1
  113. data/spec/models/external_wallet_list_bank_model_spec.rb +1 -1
  114. data/spec/models/identity_verification_bank_model_spec.rb +1 -1
  115. data/spec/models/identity_verification_list_bank_model_spec.rb +1 -1
  116. data/spec/models/identity_verification_with_details_all_of_bank_model_spec.rb +1 -1
  117. data/spec/models/identity_verification_with_details_bank_model_spec.rb +1 -1
  118. data/spec/models/list_request_owner_bank_model_spec.rb +1 -1
  119. data/spec/models/patch_bank_bank_model_spec.rb +1 -1
  120. data/spec/models/patch_external_bank_account_bank_model_spec.rb +1 -1
  121. data/spec/models/post_account_bank_model_spec.rb +1 -1
  122. data/spec/models/post_bank_bank_model_spec.rb +1 -1
  123. data/spec/models/post_customer_address_bank_model_spec.rb +1 -1
  124. data/spec/models/post_customer_bank_model_spec.rb +1 -1
  125. data/spec/models/post_customer_name_bank_model_spec.rb +1 -1
  126. data/spec/models/post_deposit_address_bank_model_spec.rb +1 -1
  127. data/spec/models/post_external_bank_account_bank_model_spec.rb +1 -1
  128. data/spec/models/post_external_bank_account_counterparty_address_bank_model_spec.rb +1 -1
  129. data/spec/models/post_external_bank_account_counterparty_bank_account_bank_model_spec.rb +1 -1
  130. data/spec/models/post_external_bank_account_counterparty_name_bank_model_spec.rb +1 -1
  131. data/spec/models/post_external_wallet_bank_model_spec.rb +1 -1
  132. data/spec/models/post_identification_number_bank_model_spec.rb +1 -1
  133. data/spec/models/post_identity_verification_address_bank_model_spec.rb +1 -1
  134. data/spec/models/post_identity_verification_bank_model_spec.rb +1 -1
  135. data/spec/models/post_identity_verification_name_bank_model_spec.rb +1 -1
  136. data/spec/models/post_quote_bank_model_spec.rb +1 -1
  137. data/spec/models/post_trade_bank_model_spec.rb +1 -1
  138. data/spec/models/post_transfer_bank_model_spec.rb +1 -1
  139. data/spec/models/post_workflow_bank_model_spec.rb +1 -1
  140. data/spec/models/quote_bank_model_spec.rb +1 -1
  141. data/spec/models/quote_list_bank_model_spec.rb +1 -1
  142. data/spec/models/symbol_price_bank_model_spec.rb +1 -1
  143. data/spec/models/trade_bank_model_spec.rb +11 -1
  144. data/spec/models/trade_list_bank_model_spec.rb +1 -1
  145. data/spec/models/transfer_bank_model_spec.rb +1 -1
  146. data/spec/models/transfer_destination_account_bank_model_spec.rb +1 -1
  147. data/spec/models/transfer_list_bank_model_spec.rb +1 -1
  148. data/spec/models/transfer_source_account_bank_model_spec.rb +1 -1
  149. data/spec/models/workflow_bank_model_spec.rb +1 -1
  150. data/spec/models/workflow_with_details_all_of_bank_model_spec.rb +1 -1
  151. data/spec/models/workflow_with_details_bank_model_spec.rb +1 -1
  152. data/spec/models/workflows_list_bank_model_spec.rb +1 -1
  153. data/spec/spec_helper.rb +1 -1
  154. data/vendor/bundle/ruby/3.2.0/extensions/x86_64-linux/3.2.0/byebug-11.1.3/gem_make.out +5 -5
  155. data/vendor/bundle/ruby/3.2.0/extensions/x86_64-linux/3.2.0/ffi-1.16.3/gem_make.out +5 -5
  156. data/vendor/bundle/ruby/3.2.0/extensions/x86_64-linux/3.2.0/jaro_winkler-1.5.6/gem_make.out +5 -5
  157. data/vendor/bundle/ruby/3.2.0/extensions/x86_64-linux/3.2.0/psych-5.1.0/gem_make.out +5 -5
  158. data/vendor/bundle/ruby/3.2.0/extensions/x86_64-linux/3.2.0/racc-1.7.1/gem_make.out +5 -5
  159. data/vendor/bundle/ruby/3.2.0/extensions/x86_64-linux/3.2.0/stringio-3.0.8/gem_make.out +5 -5
  160. metadata +1 -5
  161. data/docs/PostRewardBankModel.md +0 -24
  162. data/lib/cybrid_api_bank_ruby/models/post_reward_bank_model.rb +0 -316
  163. data/spec/models/post_reward_bank_model_spec.rb +0 -52
@@ -3,24 +3,24 @@ current directory: /home/circleci/project/api-service-clients/api-platform-bank/
3
3
  creating Makefile
4
4
 
5
5
  current directory: /home/circleci/project/api-service-clients/api-platform-bank/ruby/vendor/bundle/ruby/3.2.0/gems/stringio-3.0.8/ext/stringio
6
- make DESTDIR\= sitearchdir\=./.gem.20231006-3614-xtmbs8 sitelibdir\=./.gem.20231006-3614-xtmbs8 clean
6
+ make DESTDIR\= sitearchdir\=./.gem.20231006-3612-g95d51 sitelibdir\=./.gem.20231006-3612-g95d51 clean
7
7
  make[1]: Entering directory '/home/circleci/project/api-service-clients/api-platform-bank/ruby/vendor/bundle/ruby/3.2.0/gems/stringio-3.0.8/ext/stringio'
8
8
  make[1]: Leaving directory '/home/circleci/project/api-service-clients/api-platform-bank/ruby/vendor/bundle/ruby/3.2.0/gems/stringio-3.0.8/ext/stringio'
9
9
 
10
10
  current directory: /home/circleci/project/api-service-clients/api-platform-bank/ruby/vendor/bundle/ruby/3.2.0/gems/stringio-3.0.8/ext/stringio
11
- make DESTDIR\= sitearchdir\=./.gem.20231006-3614-xtmbs8 sitelibdir\=./.gem.20231006-3614-xtmbs8
11
+ make DESTDIR\= sitearchdir\=./.gem.20231006-3612-g95d51 sitelibdir\=./.gem.20231006-3612-g95d51
12
12
  make[1]: Entering directory '/home/circleci/project/api-service-clients/api-platform-bank/ruby/vendor/bundle/ruby/3.2.0/gems/stringio-3.0.8/ext/stringio'
13
13
  compiling stringio.c
14
14
  linking shared-object stringio.so
15
15
  make[1]: Leaving directory '/home/circleci/project/api-service-clients/api-platform-bank/ruby/vendor/bundle/ruby/3.2.0/gems/stringio-3.0.8/ext/stringio'
16
16
 
17
17
  current directory: /home/circleci/project/api-service-clients/api-platform-bank/ruby/vendor/bundle/ruby/3.2.0/gems/stringio-3.0.8/ext/stringio
18
- make DESTDIR\= sitearchdir\=./.gem.20231006-3614-xtmbs8 sitelibdir\=./.gem.20231006-3614-xtmbs8 install
18
+ make DESTDIR\= sitearchdir\=./.gem.20231006-3612-g95d51 sitelibdir\=./.gem.20231006-3612-g95d51 install
19
19
  make[1]: Entering directory '/home/circleci/project/api-service-clients/api-platform-bank/ruby/vendor/bundle/ruby/3.2.0/gems/stringio-3.0.8/ext/stringio'
20
- /usr/bin/install -c -m 0755 stringio.so ./.gem.20231006-3614-xtmbs8
20
+ /usr/bin/install -c -m 0755 stringio.so ./.gem.20231006-3612-g95d51
21
21
  make[1]: Leaving directory '/home/circleci/project/api-service-clients/api-platform-bank/ruby/vendor/bundle/ruby/3.2.0/gems/stringio-3.0.8/ext/stringio'
22
22
 
23
23
  current directory: /home/circleci/project/api-service-clients/api-platform-bank/ruby/vendor/bundle/ruby/3.2.0/gems/stringio-3.0.8/ext/stringio
24
- make DESTDIR\= sitearchdir\=./.gem.20231006-3614-xtmbs8 sitelibdir\=./.gem.20231006-3614-xtmbs8 clean
24
+ make DESTDIR\= sitearchdir\=./.gem.20231006-3612-g95d51 sitelibdir\=./.gem.20231006-3612-g95d51 clean
25
25
  make[1]: Entering directory '/home/circleci/project/api-service-clients/api-platform-bank/ruby/vendor/bundle/ruby/3.2.0/gems/stringio-3.0.8/ext/stringio'
26
26
  make[1]: Leaving directory '/home/circleci/project/api-service-clients/api-platform-bank/ruby/vendor/bundle/ruby/3.2.0/gems/stringio-3.0.8/ext/stringio'
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: cybrid_api_bank_ruby
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.97.0
4
+ version: 0.98.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Cybrid
@@ -110,7 +110,6 @@ files:
110
110
  - docs/PostIdentityVerificationBankModel.md
111
111
  - docs/PostIdentityVerificationNameBankModel.md
112
112
  - docs/PostQuoteBankModel.md
113
- - docs/PostRewardBankModel.md
114
113
  - docs/PostTradeBankModel.md
115
114
  - docs/PostTransferBankModel.md
116
115
  - docs/PostWorkflowBankModel.md
@@ -192,7 +191,6 @@ files:
192
191
  - lib/cybrid_api_bank_ruby/models/post_identity_verification_bank_model.rb
193
192
  - lib/cybrid_api_bank_ruby/models/post_identity_verification_name_bank_model.rb
194
193
  - lib/cybrid_api_bank_ruby/models/post_quote_bank_model.rb
195
- - lib/cybrid_api_bank_ruby/models/post_reward_bank_model.rb
196
194
  - lib/cybrid_api_bank_ruby/models/post_trade_bank_model.rb
197
195
  - lib/cybrid_api_bank_ruby/models/post_transfer_bank_model.rb
198
196
  - lib/cybrid_api_bank_ruby/models/post_workflow_bank_model.rb
@@ -266,7 +264,6 @@ files:
266
264
  - spec/models/post_identity_verification_bank_model_spec.rb
267
265
  - spec/models/post_identity_verification_name_bank_model_spec.rb
268
266
  - spec/models/post_quote_bank_model_spec.rb
269
- - spec/models/post_reward_bank_model_spec.rb
270
267
  - spec/models/post_trade_bank_model_spec.rb
271
268
  - spec/models/post_transfer_bank_model_spec.rb
272
269
  - spec/models/post_workflow_bank_model_spec.rb
@@ -2900,7 +2897,6 @@ test_files:
2900
2897
  - spec/models/post_identity_verification_bank_model_spec.rb
2901
2898
  - spec/models/post_identity_verification_name_bank_model_spec.rb
2902
2899
  - spec/models/post_quote_bank_model_spec.rb
2903
- - spec/models/post_reward_bank_model_spec.rb
2904
2900
  - spec/models/post_trade_bank_model_spec.rb
2905
2901
  - spec/models/post_transfer_bank_model_spec.rb
2906
2902
  - spec/models/post_workflow_bank_model_spec.rb
@@ -1,24 +0,0 @@
1
- # CybridApiBank::PostRewardBankModel
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **customer_guid** | **String** | The unique identifier for the customer. | |
8
- | **symbol** | **String** | Symbol the quote is being requested for. Format is \"asset-counter_asset\" in uppercase. See the Symbols API for a complete list of cryptocurrencies supported. | |
9
- | **receive_amount** | **Integer** | The amount to be received in base units of the currency: currency is \"asset\" for buy and \"counter_asset\" for sell. | [optional] |
10
- | **deliver_amount** | **Integer** | The amount to be delivered in base units of the currency: currency is \"counter_asset\" for buy and \"asset\" for sell. | [optional] |
11
-
12
- ## Example
13
-
14
- ```ruby
15
- require 'cybrid_api_bank_ruby'
16
-
17
- instance = CybridApiBank::PostRewardBankModel.new(
18
- customer_guid: null,
19
- symbol: null,
20
- receive_amount: null,
21
- deliver_amount: null
22
- )
23
- ```
24
-
@@ -1,316 +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 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\" }' -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' ``` <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.97.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 PostRewardBankModel
18
- # The unique identifier for the customer.
19
- attr_accessor :customer_guid
20
-
21
- # Symbol the quote is being requested for. Format is \"asset-counter_asset\" in uppercase. See the Symbols API for a complete list of cryptocurrencies supported.
22
- attr_accessor :symbol
23
-
24
- # The amount to be received in base units of the currency: currency is \"asset\" for buy and \"counter_asset\" for sell.
25
- attr_accessor :receive_amount
26
-
27
- # The amount to be delivered in base units of the currency: currency is \"counter_asset\" for buy and \"asset\" for sell.
28
- attr_accessor :deliver_amount
29
-
30
- # Attribute mapping from ruby-style variable name to JSON key.
31
- def self.attribute_map
32
- {
33
- :'customer_guid' => :'customer_guid',
34
- :'symbol' => :'symbol',
35
- :'receive_amount' => :'receive_amount',
36
- :'deliver_amount' => :'deliver_amount'
37
- }
38
- end
39
-
40
- # Returns all the JSON keys this model knows about
41
- def self.acceptable_attributes
42
- attribute_map.values
43
- end
44
-
45
- # Attribute type mapping.
46
- def self.openapi_types
47
- {
48
- :'customer_guid' => :'String',
49
- :'symbol' => :'String',
50
- :'receive_amount' => :'Integer',
51
- :'deliver_amount' => :'Integer'
52
- }
53
- end
54
-
55
- # List of attributes with nullable: true
56
- def self.openapi_nullable
57
- Set.new([
58
- ])
59
- end
60
-
61
- # Initializes the object
62
- # @param [Hash] attributes Model attributes in the form of hash
63
- def initialize(attributes = {})
64
- if (!attributes.is_a?(Hash))
65
- fail ArgumentError, "The input argument (attributes) must be a hash in `CybridApiBank::PostRewardBankModel` initialize method"
66
- end
67
-
68
- # check to see if the attribute exists and convert string to symbol for hash key
69
- attributes = attributes.each_with_object({}) { |(k, v), h|
70
- if (!self.class.attribute_map.key?(k.to_sym))
71
- fail ArgumentError, "`#{k}` is not a valid attribute in `CybridApiBank::PostRewardBankModel`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
72
- end
73
- h[k.to_sym] = v
74
- }
75
-
76
- if attributes.key?(:'customer_guid')
77
- self.customer_guid = attributes[:'customer_guid']
78
- end
79
-
80
- if attributes.key?(:'symbol')
81
- self.symbol = attributes[:'symbol']
82
- end
83
-
84
- if attributes.key?(:'receive_amount')
85
- self.receive_amount = attributes[:'receive_amount']
86
- end
87
-
88
- if attributes.key?(:'deliver_amount')
89
- self.deliver_amount = attributes[:'deliver_amount']
90
- end
91
- end
92
-
93
- # Show invalid properties with the reasons. Usually used together with valid?
94
- # @return Array for valid properties with the reasons
95
- def list_invalid_properties
96
- invalid_properties = Array.new
97
- if @customer_guid.nil?
98
- invalid_properties.push('invalid value for "customer_guid", customer_guid cannot be nil.')
99
- end
100
-
101
- if @customer_guid.to_s.length > 32
102
- invalid_properties.push('invalid value for "customer_guid", the character length must be smaller than or equal to 32.')
103
- end
104
-
105
- if @customer_guid.to_s.length < 32
106
- invalid_properties.push('invalid value for "customer_guid", the character length must be great than or equal to 32.')
107
- end
108
-
109
- if @symbol.nil?
110
- invalid_properties.push('invalid value for "symbol", symbol cannot be nil.')
111
- end
112
-
113
- if @symbol.to_s.length > 16
114
- invalid_properties.push('invalid value for "symbol", the character length must be smaller than or equal to 16.')
115
- end
116
-
117
- if @symbol.to_s.length < 1
118
- invalid_properties.push('invalid value for "symbol", the character length must be great than or equal to 1.')
119
- end
120
-
121
- invalid_properties
122
- end
123
-
124
- # Check to see if the all the properties in the model are valid
125
- # @return true if the model is valid
126
- def valid?
127
- return false if @customer_guid.nil?
128
- return false if @customer_guid.to_s.length > 32
129
- return false if @customer_guid.to_s.length < 32
130
- return false if @symbol.nil?
131
- return false if @symbol.to_s.length > 16
132
- return false if @symbol.to_s.length < 1
133
- true
134
- end
135
-
136
- # Custom attribute writer method with validation
137
- # @param [Object] customer_guid Value to be assigned
138
- def customer_guid=(customer_guid)
139
- if customer_guid.nil?
140
- fail ArgumentError, 'customer_guid cannot be nil'
141
- end
142
-
143
- if customer_guid.to_s.length > 32
144
- fail ArgumentError, 'invalid value for "customer_guid", the character length must be smaller than or equal to 32.'
145
- end
146
-
147
- if customer_guid.to_s.length < 32
148
- fail ArgumentError, 'invalid value for "customer_guid", the character length must be great than or equal to 32.'
149
- end
150
-
151
- @customer_guid = customer_guid
152
- end
153
-
154
- # Custom attribute writer method with validation
155
- # @param [Object] symbol Value to be assigned
156
- def symbol=(symbol)
157
- if symbol.nil?
158
- fail ArgumentError, 'symbol cannot be nil'
159
- end
160
-
161
- if symbol.to_s.length > 16
162
- fail ArgumentError, 'invalid value for "symbol", the character length must be smaller than or equal to 16.'
163
- end
164
-
165
- if symbol.to_s.length < 1
166
- fail ArgumentError, 'invalid value for "symbol", the character length must be great than or equal to 1.'
167
- end
168
-
169
- @symbol = symbol
170
- end
171
-
172
- # Checks equality by comparing each attribute.
173
- # @param [Object] Object to be compared
174
- def ==(o)
175
- return true if self.equal?(o)
176
- self.class == o.class &&
177
- customer_guid == o.customer_guid &&
178
- symbol == o.symbol &&
179
- receive_amount == o.receive_amount &&
180
- deliver_amount == o.deliver_amount
181
- end
182
-
183
- # @see the `==` method
184
- # @param [Object] Object to be compared
185
- def eql?(o)
186
- self == o
187
- end
188
-
189
- # Calculates hash code according to all attributes.
190
- # @return [Integer] Hash code
191
- def hash
192
- [customer_guid, symbol, receive_amount, deliver_amount].hash
193
- end
194
-
195
- # Builds the object from hash
196
- # @param [Hash] attributes Model attributes in the form of hash
197
- # @return [Object] Returns the model itself
198
- def self.build_from_hash(attributes)
199
- new.build_from_hash(attributes)
200
- end
201
-
202
- # Builds the object from hash
203
- # @param [Hash] attributes Model attributes in the form of hash
204
- # @return [Object] Returns the model itself
205
- def build_from_hash(attributes)
206
- return nil unless attributes.is_a?(Hash)
207
- attributes = attributes.transform_keys(&:to_sym)
208
- self.class.openapi_types.each_pair do |key, type|
209
- if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
210
- self.send("#{key}=", nil)
211
- elsif type =~ /\AArray<(.*)>/i
212
- # check to ensure the input is an array given that the attribute
213
- # is documented as an array but the input is not
214
- if attributes[self.class.attribute_map[key]].is_a?(Array)
215
- self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
216
- end
217
- elsif !attributes[self.class.attribute_map[key]].nil?
218
- self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
219
- end
220
- end
221
-
222
- self
223
- end
224
-
225
- # Deserializes the data based on type
226
- # @param string type Data type
227
- # @param string value Value to be deserialized
228
- # @return [Object] Deserialized data
229
- def _deserialize(type, value)
230
- case type.to_sym
231
- when :Time
232
- Time.parse(value)
233
- when :Date
234
- Date.parse(value)
235
- when :String
236
- value.to_s
237
- when :Integer
238
- value.to_i
239
- when :Float
240
- value.to_f
241
- when :Boolean
242
- if value.to_s =~ /\A(true|t|yes|y|1)\z/i
243
- true
244
- else
245
- false
246
- end
247
- when :Object
248
- # generic object (usually a Hash), return directly
249
- value
250
- when /\AArray<(?<inner_type>.+)>\z/
251
- inner_type = Regexp.last_match[:inner_type]
252
- value.map { |v| _deserialize(inner_type, v) }
253
- when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
254
- k_type = Regexp.last_match[:k_type]
255
- v_type = Regexp.last_match[:v_type]
256
- {}.tap do |hash|
257
- value.each do |k, v|
258
- hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
259
- end
260
- end
261
- else # model
262
- # models (e.g. Pet) or oneOf
263
- klass = CybridApiBank.const_get(type)
264
- klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
265
- end
266
- end
267
-
268
- # Returns the string representation of the object
269
- # @return [String] String presentation of the object
270
- def to_s
271
- to_hash.to_s
272
- end
273
-
274
- # to_body is an alias to to_hash (backward compatibility)
275
- # @return [Hash] Returns the object in the form of hash
276
- def to_body
277
- to_hash
278
- end
279
-
280
- # Returns the object in the form of hash
281
- # @return [Hash] Returns the object in the form of hash
282
- def to_hash
283
- hash = {}
284
- self.class.attribute_map.each_pair do |attr, param|
285
- value = self.send(attr)
286
- if value.nil?
287
- is_nullable = self.class.openapi_nullable.include?(attr)
288
- next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
289
- end
290
-
291
- hash[param] = _to_hash(value)
292
- end
293
- hash
294
- end
295
-
296
- # Outputs non-array value in the form of hash
297
- # For object, use to_hash. Otherwise, just return the value
298
- # @param [Object] value Any valid value
299
- # @return [Hash] Returns the value in the form of hash
300
- def _to_hash(value)
301
- if value.is_a?(Array)
302
- value.compact.map { |v| _to_hash(v) }
303
- elsif value.is_a?(Hash)
304
- {}.tap do |hash|
305
- value.each { |k, v| hash[k] = _to_hash(v) }
306
- end
307
- elsif value.respond_to? :to_hash
308
- value.to_hash
309
- else
310
- value
311
- end
312
- end
313
-
314
- end
315
-
316
- end
@@ -1,52 +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 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\" }' -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' ``` <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.97.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 'spec_helper'
14
- require 'json'
15
- require 'date'
16
-
17
- # Unit tests for CybridApiBank::PostRewardBankModel
18
- # Automatically generated by openapi-generator (https://openapi-generator.tech)
19
- # Please update as you see appropriate
20
- describe CybridApiBank::PostRewardBankModel do
21
- let(:instance) { CybridApiBank::PostRewardBankModel.new }
22
-
23
- describe 'test an instance of PostRewardBankModel' do
24
- it 'should create an instance of PostRewardBankModel' do
25
- expect(instance).to be_instance_of(CybridApiBank::PostRewardBankModel)
26
- end
27
- end
28
- describe 'test attribute "customer_guid"' do
29
- it 'should work' do
30
- # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
31
- end
32
- end
33
-
34
- describe 'test attribute "symbol"' do
35
- it 'should work' do
36
- # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
37
- end
38
- end
39
-
40
- describe 'test attribute "receive_amount"' do
41
- it 'should work' do
42
- # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
43
- end
44
- end
45
-
46
- describe 'test attribute "deliver_amount"' do
47
- it 'should work' do
48
- # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
49
- end
50
- end
51
-
52
- end