cybrid_api_bank_ruby 0.92.4 → 0.93.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (164) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile.lock +1 -1
  3. data/README.md +5 -12
  4. data/cybrid_api_bank_ruby.gemspec +2 -2
  5. data/lib/cybrid_api_bank_ruby/api/accounts_bank_api.rb +2 -2
  6. data/lib/cybrid_api_bank_ruby/api/assets_bank_api.rb +2 -2
  7. data/lib/cybrid_api_bank_ruby/api/banks_bank_api.rb +2 -2
  8. data/lib/cybrid_api_bank_ruby/api/customers_bank_api.rb +2 -2
  9. data/lib/cybrid_api_bank_ruby/api/deposit_addresses_bank_api.rb +2 -2
  10. data/lib/cybrid_api_bank_ruby/api/external_bank_accounts_bank_api.rb +2 -2
  11. data/lib/cybrid_api_bank_ruby/api/external_wallets_bank_api.rb +2 -2
  12. data/lib/cybrid_api_bank_ruby/api/identity_verifications_bank_api.rb +2 -2
  13. data/lib/cybrid_api_bank_ruby/api/prices_bank_api.rb +2 -2
  14. data/lib/cybrid_api_bank_ruby/api/quotes_bank_api.rb +2 -2
  15. data/lib/cybrid_api_bank_ruby/api/symbols_bank_api.rb +2 -2
  16. data/lib/cybrid_api_bank_ruby/api/trades_bank_api.rb +2 -2
  17. data/lib/cybrid_api_bank_ruby/api/transfers_bank_api.rb +2 -2
  18. data/lib/cybrid_api_bank_ruby/api/workflows_bank_api.rb +2 -2
  19. data/lib/cybrid_api_bank_ruby/api_client.rb +2 -2
  20. data/lib/cybrid_api_bank_ruby/api_error.rb +2 -2
  21. data/lib/cybrid_api_bank_ruby/configuration.rb +2 -2
  22. data/lib/cybrid_api_bank_ruby/models/account_bank_model.rb +2 -2
  23. data/lib/cybrid_api_bank_ruby/models/account_list_bank_model.rb +2 -2
  24. data/lib/cybrid_api_bank_ruby/models/asset_bank_model.rb +2 -2
  25. data/lib/cybrid_api_bank_ruby/models/asset_list_bank_model.rb +2 -2
  26. data/lib/cybrid_api_bank_ruby/models/bank_bank_model.rb +2 -2
  27. data/lib/cybrid_api_bank_ruby/models/bank_list_bank_model.rb +2 -2
  28. data/lib/cybrid_api_bank_ruby/models/customer_address_bank_model.rb +2 -2
  29. data/lib/cybrid_api_bank_ruby/models/customer_bank_model.rb +2 -2
  30. data/lib/cybrid_api_bank_ruby/models/customer_list_bank_model.rb +2 -2
  31. data/lib/cybrid_api_bank_ruby/models/customer_name_bank_model.rb +2 -2
  32. data/lib/cybrid_api_bank_ruby/models/deposit_address_bank_model.rb +2 -2
  33. data/lib/cybrid_api_bank_ruby/models/deposit_address_list_bank_model.rb +2 -2
  34. data/lib/cybrid_api_bank_ruby/models/error_response_bank_model.rb +2 -2
  35. data/lib/cybrid_api_bank_ruby/models/external_bank_account_bank_model.rb +2 -2
  36. data/lib/cybrid_api_bank_ruby/models/external_bank_account_list_bank_model.rb +2 -2
  37. data/lib/cybrid_api_bank_ruby/models/external_wallet_bank_model.rb +2 -2
  38. data/lib/cybrid_api_bank_ruby/models/external_wallet_list_bank_model.rb +2 -2
  39. data/lib/cybrid_api_bank_ruby/models/identity_verification_bank_model.rb +2 -2
  40. data/lib/cybrid_api_bank_ruby/models/identity_verification_list_bank_model.rb +2 -2
  41. data/lib/cybrid_api_bank_ruby/models/identity_verification_with_details_all_of_bank_model.rb +2 -2
  42. data/lib/cybrid_api_bank_ruby/models/identity_verification_with_details_bank_model.rb +2 -2
  43. data/lib/cybrid_api_bank_ruby/models/list_request_owner_bank_model.rb +2 -2
  44. data/lib/cybrid_api_bank_ruby/models/patch_bank_bank_model.rb +2 -2
  45. data/lib/cybrid_api_bank_ruby/models/patch_external_bank_account_bank_model.rb +2 -2
  46. data/lib/cybrid_api_bank_ruby/models/post_account_bank_model.rb +2 -2
  47. data/lib/cybrid_api_bank_ruby/models/post_bank_bank_model.rb +2 -2
  48. data/lib/cybrid_api_bank_ruby/models/post_customer_address_bank_model.rb +2 -2
  49. data/lib/cybrid_api_bank_ruby/models/post_customer_bank_model.rb +2 -2
  50. data/lib/cybrid_api_bank_ruby/models/post_customer_name_bank_model.rb +2 -2
  51. data/lib/cybrid_api_bank_ruby/models/post_deposit_address_bank_model.rb +2 -2
  52. data/lib/cybrid_api_bank_ruby/models/post_external_bank_account_bank_model.rb +2 -2
  53. data/lib/cybrid_api_bank_ruby/models/post_external_wallet_bank_model.rb +2 -2
  54. data/lib/cybrid_api_bank_ruby/models/post_identification_number_bank_model.rb +2 -2
  55. data/lib/cybrid_api_bank_ruby/models/post_identity_verification_address_bank_model.rb +2 -2
  56. data/lib/cybrid_api_bank_ruby/models/post_identity_verification_bank_model.rb +2 -2
  57. data/lib/cybrid_api_bank_ruby/models/post_identity_verification_name_bank_model.rb +2 -2
  58. data/lib/cybrid_api_bank_ruby/models/post_quote_bank_model.rb +2 -2
  59. data/lib/cybrid_api_bank_ruby/models/post_reward_bank_model.rb +2 -2
  60. data/lib/cybrid_api_bank_ruby/models/post_trade_bank_model.rb +2 -2
  61. data/lib/cybrid_api_bank_ruby/models/post_transfer_bank_model.rb +2 -2
  62. data/lib/cybrid_api_bank_ruby/models/post_workflow_bank_model.rb +2 -2
  63. data/lib/cybrid_api_bank_ruby/models/quote_bank_model.rb +2 -2
  64. data/lib/cybrid_api_bank_ruby/models/quote_list_bank_model.rb +2 -2
  65. data/lib/cybrid_api_bank_ruby/models/symbol_price_bank_model.rb +2 -2
  66. data/lib/cybrid_api_bank_ruby/models/trade_bank_model.rb +2 -2
  67. data/lib/cybrid_api_bank_ruby/models/trade_list_bank_model.rb +2 -2
  68. data/lib/cybrid_api_bank_ruby/models/transfer_bank_model.rb +2 -2
  69. data/lib/cybrid_api_bank_ruby/models/transfer_destination_account_bank_model.rb +2 -2
  70. data/lib/cybrid_api_bank_ruby/models/transfer_list_bank_model.rb +2 -2
  71. data/lib/cybrid_api_bank_ruby/models/transfer_source_account_bank_model.rb +2 -2
  72. data/lib/cybrid_api_bank_ruby/models/workflow_bank_model.rb +2 -2
  73. data/lib/cybrid_api_bank_ruby/models/workflow_with_details_all_of_bank_model.rb +2 -2
  74. data/lib/cybrid_api_bank_ruby/models/workflow_with_details_bank_model.rb +2 -2
  75. data/lib/cybrid_api_bank_ruby/models/workflows_list_bank_model.rb +2 -2
  76. data/lib/cybrid_api_bank_ruby/version.rb +3 -3
  77. data/lib/cybrid_api_bank_ruby.rb +2 -5
  78. data/spec/api/accounts_bank_api_spec.rb +2 -2
  79. data/spec/api/assets_bank_api_spec.rb +2 -2
  80. data/spec/api/banks_bank_api_spec.rb +2 -2
  81. data/spec/api/customers_bank_api_spec.rb +2 -2
  82. data/spec/api/deposit_addresses_bank_api_spec.rb +2 -2
  83. data/spec/api/external_bank_accounts_bank_api_spec.rb +2 -2
  84. data/spec/api/external_wallets_bank_api_spec.rb +2 -2
  85. data/spec/api/identity_verifications_bank_api_spec.rb +2 -2
  86. data/spec/api/prices_bank_api_spec.rb +2 -2
  87. data/spec/api/quotes_bank_api_spec.rb +2 -2
  88. data/spec/api/symbols_bank_api_spec.rb +2 -2
  89. data/spec/api/trades_bank_api_spec.rb +2 -2
  90. data/spec/api/transfers_bank_api_spec.rb +2 -2
  91. data/spec/api/workflows_bank_api_spec.rb +2 -2
  92. data/spec/api_client_spec.rb +2 -2
  93. data/spec/configuration_spec.rb +2 -2
  94. data/spec/models/account_bank_model_spec.rb +2 -2
  95. data/spec/models/account_list_bank_model_spec.rb +2 -2
  96. data/spec/models/asset_bank_model_spec.rb +2 -2
  97. data/spec/models/asset_list_bank_model_spec.rb +2 -2
  98. data/spec/models/bank_bank_model_spec.rb +2 -2
  99. data/spec/models/bank_list_bank_model_spec.rb +2 -2
  100. data/spec/models/customer_address_bank_model_spec.rb +2 -2
  101. data/spec/models/customer_bank_model_spec.rb +2 -2
  102. data/spec/models/customer_list_bank_model_spec.rb +2 -2
  103. data/spec/models/customer_name_bank_model_spec.rb +2 -2
  104. data/spec/models/deposit_address_bank_model_spec.rb +2 -2
  105. data/spec/models/deposit_address_list_bank_model_spec.rb +2 -2
  106. data/spec/models/error_response_bank_model_spec.rb +2 -2
  107. data/spec/models/external_bank_account_bank_model_spec.rb +2 -2
  108. data/spec/models/external_bank_account_list_bank_model_spec.rb +2 -2
  109. data/spec/models/external_wallet_bank_model_spec.rb +2 -2
  110. data/spec/models/external_wallet_list_bank_model_spec.rb +2 -2
  111. data/spec/models/identity_verification_bank_model_spec.rb +2 -2
  112. data/spec/models/identity_verification_list_bank_model_spec.rb +2 -2
  113. data/spec/models/identity_verification_with_details_all_of_bank_model_spec.rb +2 -2
  114. data/spec/models/identity_verification_with_details_bank_model_spec.rb +2 -2
  115. data/spec/models/list_request_owner_bank_model_spec.rb +2 -2
  116. data/spec/models/patch_bank_bank_model_spec.rb +2 -2
  117. data/spec/models/patch_external_bank_account_bank_model_spec.rb +2 -2
  118. data/spec/models/post_account_bank_model_spec.rb +2 -2
  119. data/spec/models/post_bank_bank_model_spec.rb +2 -2
  120. data/spec/models/post_customer_address_bank_model_spec.rb +2 -2
  121. data/spec/models/post_customer_bank_model_spec.rb +2 -2
  122. data/spec/models/post_customer_name_bank_model_spec.rb +2 -2
  123. data/spec/models/post_deposit_address_bank_model_spec.rb +2 -2
  124. data/spec/models/post_external_bank_account_bank_model_spec.rb +2 -2
  125. data/spec/models/post_external_wallet_bank_model_spec.rb +2 -2
  126. data/spec/models/post_identification_number_bank_model_spec.rb +2 -2
  127. data/spec/models/post_identity_verification_address_bank_model_spec.rb +2 -2
  128. data/spec/models/post_identity_verification_bank_model_spec.rb +2 -2
  129. data/spec/models/post_identity_verification_name_bank_model_spec.rb +2 -2
  130. data/spec/models/post_quote_bank_model_spec.rb +2 -2
  131. data/spec/models/post_reward_bank_model_spec.rb +2 -2
  132. data/spec/models/post_trade_bank_model_spec.rb +2 -2
  133. data/spec/models/post_transfer_bank_model_spec.rb +2 -2
  134. data/spec/models/post_workflow_bank_model_spec.rb +2 -2
  135. data/spec/models/quote_bank_model_spec.rb +2 -2
  136. data/spec/models/quote_list_bank_model_spec.rb +2 -2
  137. data/spec/models/symbol_price_bank_model_spec.rb +2 -2
  138. data/spec/models/trade_bank_model_spec.rb +2 -2
  139. data/spec/models/trade_list_bank_model_spec.rb +2 -2
  140. data/spec/models/transfer_bank_model_spec.rb +2 -2
  141. data/spec/models/transfer_destination_account_bank_model_spec.rb +2 -2
  142. data/spec/models/transfer_list_bank_model_spec.rb +2 -2
  143. data/spec/models/transfer_source_account_bank_model_spec.rb +2 -2
  144. data/spec/models/workflow_bank_model_spec.rb +2 -2
  145. data/spec/models/workflow_with_details_all_of_bank_model_spec.rb +2 -2
  146. data/spec/models/workflow_with_details_bank_model_spec.rb +2 -2
  147. data/spec/models/workflows_list_bank_model_spec.rb +2 -2
  148. data/spec/spec_helper.rb +2 -2
  149. data/vendor/bundle/ruby/3.2.0/extensions/x86_64-linux/3.2.0/byebug-11.1.3/gem_make.out +5 -5
  150. data/vendor/bundle/ruby/3.2.0/extensions/x86_64-linux/3.2.0/ffi-1.15.5/gem_make.out +5 -5
  151. data/vendor/bundle/ruby/3.2.0/extensions/x86_64-linux/3.2.0/jaro_winkler-1.5.6/gem_make.out +5 -5
  152. data/vendor/bundle/ruby/3.2.0/extensions/x86_64-linux/3.2.0/psych-5.1.0/gem_make.out +5 -5
  153. data/vendor/bundle/ruby/3.2.0/extensions/x86_64-linux/3.2.0/racc-1.7.1/gem_make.out +5 -5
  154. data/vendor/bundle/ruby/3.2.0/extensions/x86_64-linux/3.2.0/stringio-3.0.8/gem_make.out +5 -5
  155. metadata +2 -14
  156. data/docs/RewardBankModel.md +0 -36
  157. data/docs/RewardListBankModel.md +0 -24
  158. data/docs/RewardsBankApi.md +0 -236
  159. data/lib/cybrid_api_bank_ruby/api/rewards_bank_api.rb +0 -237
  160. data/lib/cybrid_api_bank_ruby/models/reward_bank_model.rb +0 -440
  161. data/lib/cybrid_api_bank_ruby/models/reward_list_bank_model.rb +0 -329
  162. data/spec/api/rewards_bank_api_spec.rb +0 -75
  163. data/spec/models/reward_bank_model_spec.rb +0 -92
  164. data/spec/models/reward_list_bank_model_spec.rb +0 -52
@@ -1,236 +0,0 @@
1
- # CybridApiBank::RewardsBankApi
2
-
3
- All URIs are relative to *https://bank.sandbox.cybrid.app*
4
-
5
- | Method | HTTP request | Description |
6
- | ------ | ------------ | ----------- |
7
- | [**create_rewards**](RewardsBankApi.md#create_rewards) | **POST** /api/rewards | Create Reward |
8
- | [**get_reward**](RewardsBankApi.md#get_reward) | **GET** /api/rewards/{reward_guid} | Get Reward |
9
- | [**list_rewards**](RewardsBankApi.md#list_rewards) | **GET** /api/rewards | Get rewards list |
10
-
11
-
12
- ## create_rewards
13
-
14
- > <RewardBankModel> create_rewards(post_reward_bank_model)
15
-
16
- Create Reward
17
-
18
- Creates a reward. Required scope: **rewards:execute**
19
-
20
- ### Examples
21
-
22
- ```ruby
23
- require 'time'
24
- require 'cybrid_api_bank_ruby'
25
- # setup authorization
26
- CybridApiBank.configure do |config|
27
- # Configure Bearer authorization (JWT): BearerAuth
28
- config.access_token = 'YOUR_BEARER_TOKEN'
29
-
30
- # Configure OAuth2 access token for authorization: oauth2
31
- config.access_token = 'YOUR ACCESS TOKEN'
32
- end
33
-
34
- api_instance = CybridApiBank::RewardsBankApi.new
35
- post_reward_bank_model = CybridApiBank::PostRewardBankModel.new({customer_guid: 'customer_guid_example', symbol: 'symbol_example'}) # PostRewardBankModel |
36
-
37
- begin
38
- # Create Reward
39
- result = api_instance.create_rewards(post_reward_bank_model)
40
- p result
41
- rescue CybridApiBank::ApiError => e
42
- puts "Error when calling RewardsBankApi->create_rewards: #{e}"
43
- end
44
- ```
45
-
46
- #### Using the create_rewards_with_http_info variant
47
-
48
- This returns an Array which contains the response data, status code and headers.
49
-
50
- > <Array(<RewardBankModel>, Integer, Hash)> create_rewards_with_http_info(post_reward_bank_model)
51
-
52
- ```ruby
53
- begin
54
- # Create Reward
55
- data, status_code, headers = api_instance.create_rewards_with_http_info(post_reward_bank_model)
56
- p status_code # => 2xx
57
- p headers # => { ... }
58
- p data # => <RewardBankModel>
59
- rescue CybridApiBank::ApiError => e
60
- puts "Error when calling RewardsBankApi->create_rewards_with_http_info: #{e}"
61
- end
62
- ```
63
-
64
- ### Parameters
65
-
66
- | Name | Type | Description | Notes |
67
- | ---- | ---- | ----------- | ----- |
68
- | **post_reward_bank_model** | [**PostRewardBankModel**](PostRewardBankModel.md) | | |
69
-
70
- ### Return type
71
-
72
- [**RewardBankModel**](RewardBankModel.md)
73
-
74
- ### Authorization
75
-
76
- [BearerAuth](../README.md#BearerAuth), [oauth2](../README.md#oauth2)
77
-
78
- ### HTTP request headers
79
-
80
- - **Content-Type**: application/json
81
- - **Accept**: application/json
82
-
83
-
84
- ## get_reward
85
-
86
- > <RewardBankModel> get_reward(reward_guid)
87
-
88
- Get Reward
89
-
90
- Retrieves a reward. Required scope: **rewards:read**
91
-
92
- ### Examples
93
-
94
- ```ruby
95
- require 'time'
96
- require 'cybrid_api_bank_ruby'
97
- # setup authorization
98
- CybridApiBank.configure do |config|
99
- # Configure Bearer authorization (JWT): BearerAuth
100
- config.access_token = 'YOUR_BEARER_TOKEN'
101
-
102
- # Configure OAuth2 access token for authorization: oauth2
103
- config.access_token = 'YOUR ACCESS TOKEN'
104
- end
105
-
106
- api_instance = CybridApiBank::RewardsBankApi.new
107
- reward_guid = 'reward_guid_example' # String | Identifier for the reward.
108
-
109
- begin
110
- # Get Reward
111
- result = api_instance.get_reward(reward_guid)
112
- p result
113
- rescue CybridApiBank::ApiError => e
114
- puts "Error when calling RewardsBankApi->get_reward: #{e}"
115
- end
116
- ```
117
-
118
- #### Using the get_reward_with_http_info variant
119
-
120
- This returns an Array which contains the response data, status code and headers.
121
-
122
- > <Array(<RewardBankModel>, Integer, Hash)> get_reward_with_http_info(reward_guid)
123
-
124
- ```ruby
125
- begin
126
- # Get Reward
127
- data, status_code, headers = api_instance.get_reward_with_http_info(reward_guid)
128
- p status_code # => 2xx
129
- p headers # => { ... }
130
- p data # => <RewardBankModel>
131
- rescue CybridApiBank::ApiError => e
132
- puts "Error when calling RewardsBankApi->get_reward_with_http_info: #{e}"
133
- end
134
- ```
135
-
136
- ### Parameters
137
-
138
- | Name | Type | Description | Notes |
139
- | ---- | ---- | ----------- | ----- |
140
- | **reward_guid** | **String** | Identifier for the reward. | |
141
-
142
- ### Return type
143
-
144
- [**RewardBankModel**](RewardBankModel.md)
145
-
146
- ### Authorization
147
-
148
- [BearerAuth](../README.md#BearerAuth), [oauth2](../README.md#oauth2)
149
-
150
- ### HTTP request headers
151
-
152
- - **Content-Type**: Not defined
153
- - **Accept**: application/json
154
-
155
-
156
- ## list_rewards
157
-
158
- > <RewardListBankModel> list_rewards(opts)
159
-
160
- Get rewards list
161
-
162
- Retrieves a listing of rewards. Required scope: **rewards:read**
163
-
164
- ### Examples
165
-
166
- ```ruby
167
- require 'time'
168
- require 'cybrid_api_bank_ruby'
169
- # setup authorization
170
- CybridApiBank.configure do |config|
171
- # Configure Bearer authorization (JWT): BearerAuth
172
- config.access_token = 'YOUR_BEARER_TOKEN'
173
-
174
- # Configure OAuth2 access token for authorization: oauth2
175
- config.access_token = 'YOUR ACCESS TOKEN'
176
- end
177
-
178
- api_instance = CybridApiBank::RewardsBankApi.new
179
- opts = {
180
- page: 56, # Integer | The page index to retrieve.
181
- per_page: 56, # Integer | The number of entities per page to return.
182
- guid: 'guid_example', # String | Comma separated reward_guids to list rewards for.
183
- bank_guid: 'bank_guid_example', # String | Comma separated bank_guids to list rewards for.
184
- customer_guid: 'customer_guid_example' # String | Comma separated customer_guids to list rewards for.
185
- }
186
-
187
- begin
188
- # Get rewards list
189
- result = api_instance.list_rewards(opts)
190
- p result
191
- rescue CybridApiBank::ApiError => e
192
- puts "Error when calling RewardsBankApi->list_rewards: #{e}"
193
- end
194
- ```
195
-
196
- #### Using the list_rewards_with_http_info variant
197
-
198
- This returns an Array which contains the response data, status code and headers.
199
-
200
- > <Array(<RewardListBankModel>, Integer, Hash)> list_rewards_with_http_info(opts)
201
-
202
- ```ruby
203
- begin
204
- # Get rewards list
205
- data, status_code, headers = api_instance.list_rewards_with_http_info(opts)
206
- p status_code # => 2xx
207
- p headers # => { ... }
208
- p data # => <RewardListBankModel>
209
- rescue CybridApiBank::ApiError => e
210
- puts "Error when calling RewardsBankApi->list_rewards_with_http_info: #{e}"
211
- end
212
- ```
213
-
214
- ### Parameters
215
-
216
- | Name | Type | Description | Notes |
217
- | ---- | ---- | ----------- | ----- |
218
- | **page** | **Integer** | The page index to retrieve. | [optional] |
219
- | **per_page** | **Integer** | The number of entities per page to return. | [optional] |
220
- | **guid** | **String** | Comma separated reward_guids to list rewards for. | [optional] |
221
- | **bank_guid** | **String** | Comma separated bank_guids to list rewards for. | [optional] |
222
- | **customer_guid** | **String** | Comma separated customer_guids to list rewards for. | [optional] |
223
-
224
- ### Return type
225
-
226
- [**RewardListBankModel**](RewardListBankModel.md)
227
-
228
- ### Authorization
229
-
230
- [BearerAuth](../README.md#BearerAuth), [oauth2](../README.md#oauth2)
231
-
232
- ### HTTP request headers
233
-
234
- - **Content-Type**: Not defined
235
- - **Accept**: application/json
236
-
@@ -1,237 +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 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 organization_applications:execute banks:read banks:write banks:execute bank_applications:execute 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:execute (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 | | Identity | Organization | /api/users | Create an organization user | | 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.92.4
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 'cgi'
14
-
15
- module CybridApiBank
16
- class RewardsBankApi
17
- attr_accessor :api_client
18
-
19
- def initialize(api_client = ApiClient.default)
20
- @api_client = api_client
21
- end
22
- # Create Reward
23
- # Creates a reward. Required scope: **rewards:execute**
24
- # @param post_reward_bank_model [PostRewardBankModel]
25
- # @param [Hash] opts the optional parameters
26
- # @return [RewardBankModel]
27
- def create_rewards(post_reward_bank_model, opts = {})
28
- data, _status_code, _headers = create_rewards_with_http_info(post_reward_bank_model, opts)
29
- data
30
- end
31
-
32
- # Create Reward
33
- # Creates a reward. Required scope: **rewards:execute**
34
- # @param post_reward_bank_model [PostRewardBankModel]
35
- # @param [Hash] opts the optional parameters
36
- # @return [Array<(RewardBankModel, Integer, Hash)>] RewardBankModel data, response status code and response headers
37
- def create_rewards_with_http_info(post_reward_bank_model, opts = {})
38
- if @api_client.config.debugging
39
- @api_client.config.logger.debug 'Calling API: RewardsBankApi.create_rewards ...'
40
- end
41
- # verify the required parameter 'post_reward_bank_model' is set
42
- if @api_client.config.client_side_validation && post_reward_bank_model.nil?
43
- fail ArgumentError, "Missing the required parameter 'post_reward_bank_model' when calling RewardsBankApi.create_rewards"
44
- end
45
- # resource path
46
- local_var_path = '/api/rewards'
47
-
48
- # query parameters
49
- query_params = opts[:query_params] || {}
50
-
51
- # header parameters
52
- header_params = opts[:header_params] || {}
53
- # HTTP header 'Accept' (if needed)
54
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
55
- # HTTP header 'Content-Type'
56
- content_type = @api_client.select_header_content_type(['application/json'])
57
- if !content_type.nil?
58
- header_params['Content-Type'] = content_type
59
- end
60
-
61
- # form parameters
62
- form_params = opts[:form_params] || {}
63
-
64
- # http body (model)
65
- post_body = opts[:debug_body] || @api_client.object_to_http_body(post_reward_bank_model)
66
-
67
- # return_type
68
- return_type = opts[:debug_return_type] || 'RewardBankModel'
69
-
70
- # auth_names
71
- auth_names = opts[:debug_auth_names] || ['BearerAuth', 'oauth2']
72
-
73
- new_options = opts.merge(
74
- :operation => :"RewardsBankApi.create_rewards",
75
- :header_params => header_params,
76
- :query_params => query_params,
77
- :form_params => form_params,
78
- :body => post_body,
79
- :auth_names => auth_names,
80
- :return_type => return_type
81
- )
82
-
83
- data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
84
- if @api_client.config.debugging
85
- @api_client.config.logger.debug "API called: RewardsBankApi#create_rewards\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
86
- end
87
- return data, status_code, headers
88
- end
89
-
90
- # Get Reward
91
- # Retrieves a reward. Required scope: **rewards:read**
92
- # @param reward_guid [String] Identifier for the reward.
93
- # @param [Hash] opts the optional parameters
94
- # @return [RewardBankModel]
95
- def get_reward(reward_guid, opts = {})
96
- data, _status_code, _headers = get_reward_with_http_info(reward_guid, opts)
97
- data
98
- end
99
-
100
- # Get Reward
101
- # Retrieves a reward. Required scope: **rewards:read**
102
- # @param reward_guid [String] Identifier for the reward.
103
- # @param [Hash] opts the optional parameters
104
- # @return [Array<(RewardBankModel, Integer, Hash)>] RewardBankModel data, response status code and response headers
105
- def get_reward_with_http_info(reward_guid, opts = {})
106
- if @api_client.config.debugging
107
- @api_client.config.logger.debug 'Calling API: RewardsBankApi.get_reward ...'
108
- end
109
- # verify the required parameter 'reward_guid' is set
110
- if @api_client.config.client_side_validation && reward_guid.nil?
111
- fail ArgumentError, "Missing the required parameter 'reward_guid' when calling RewardsBankApi.get_reward"
112
- end
113
- # resource path
114
- local_var_path = '/api/rewards/{reward_guid}'.sub('{' + 'reward_guid' + '}', CGI.escape(reward_guid.to_s))
115
-
116
- # query parameters
117
- query_params = opts[:query_params] || {}
118
-
119
- # header parameters
120
- header_params = opts[:header_params] || {}
121
- # HTTP header 'Accept' (if needed)
122
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
123
-
124
- # form parameters
125
- form_params = opts[:form_params] || {}
126
-
127
- # http body (model)
128
- post_body = opts[:debug_body]
129
-
130
- # return_type
131
- return_type = opts[:debug_return_type] || 'RewardBankModel'
132
-
133
- # auth_names
134
- auth_names = opts[:debug_auth_names] || ['BearerAuth', 'oauth2']
135
-
136
- new_options = opts.merge(
137
- :operation => :"RewardsBankApi.get_reward",
138
- :header_params => header_params,
139
- :query_params => query_params,
140
- :form_params => form_params,
141
- :body => post_body,
142
- :auth_names => auth_names,
143
- :return_type => return_type
144
- )
145
-
146
- data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
147
- if @api_client.config.debugging
148
- @api_client.config.logger.debug "API called: RewardsBankApi#get_reward\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
149
- end
150
- return data, status_code, headers
151
- end
152
-
153
- # Get rewards list
154
- # Retrieves a listing of rewards. Required scope: **rewards:read**
155
- # @param [Hash] opts the optional parameters
156
- # @option opts [Integer] :page The page index to retrieve.
157
- # @option opts [Integer] :per_page The number of entities per page to return.
158
- # @option opts [String] :guid Comma separated reward_guids to list rewards for.
159
- # @option opts [String] :bank_guid Comma separated bank_guids to list rewards for.
160
- # @option opts [String] :customer_guid Comma separated customer_guids to list rewards for.
161
- # @return [RewardListBankModel]
162
- def list_rewards(opts = {})
163
- data, _status_code, _headers = list_rewards_with_http_info(opts)
164
- data
165
- end
166
-
167
- # Get rewards list
168
- # Retrieves a listing of rewards. Required scope: **rewards:read**
169
- # @param [Hash] opts the optional parameters
170
- # @option opts [Integer] :page The page index to retrieve.
171
- # @option opts [Integer] :per_page The number of entities per page to return.
172
- # @option opts [String] :guid Comma separated reward_guids to list rewards for.
173
- # @option opts [String] :bank_guid Comma separated bank_guids to list rewards for.
174
- # @option opts [String] :customer_guid Comma separated customer_guids to list rewards for.
175
- # @return [Array<(RewardListBankModel, Integer, Hash)>] RewardListBankModel data, response status code and response headers
176
- def list_rewards_with_http_info(opts = {})
177
- if @api_client.config.debugging
178
- @api_client.config.logger.debug 'Calling API: RewardsBankApi.list_rewards ...'
179
- end
180
- if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 0
181
- fail ArgumentError, 'invalid value for "opts[:"page"]" when calling RewardsBankApi.list_rewards, must be greater than or equal to 0.'
182
- end
183
-
184
- if @api_client.config.client_side_validation && !opts[:'per_page'].nil? && opts[:'per_page'] > 100
185
- fail ArgumentError, 'invalid value for "opts[:"per_page"]" when calling RewardsBankApi.list_rewards, must be smaller than or equal to 100.'
186
- end
187
-
188
- if @api_client.config.client_side_validation && !opts[:'per_page'].nil? && opts[:'per_page'] < 1
189
- fail ArgumentError, 'invalid value for "opts[:"per_page"]" when calling RewardsBankApi.list_rewards, must be greater than or equal to 1.'
190
- end
191
-
192
- # resource path
193
- local_var_path = '/api/rewards'
194
-
195
- # query parameters
196
- query_params = opts[:query_params] || {}
197
- query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
198
- query_params[:'per_page'] = opts[:'per_page'] if !opts[:'per_page'].nil?
199
- query_params[:'guid'] = opts[:'guid'] if !opts[:'guid'].nil?
200
- query_params[:'bank_guid'] = opts[:'bank_guid'] if !opts[:'bank_guid'].nil?
201
- query_params[:'customer_guid'] = opts[:'customer_guid'] if !opts[:'customer_guid'].nil?
202
-
203
- # header parameters
204
- header_params = opts[:header_params] || {}
205
- # HTTP header 'Accept' (if needed)
206
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
207
-
208
- # form parameters
209
- form_params = opts[:form_params] || {}
210
-
211
- # http body (model)
212
- post_body = opts[:debug_body]
213
-
214
- # return_type
215
- return_type = opts[:debug_return_type] || 'RewardListBankModel'
216
-
217
- # auth_names
218
- auth_names = opts[:debug_auth_names] || ['BearerAuth', 'oauth2']
219
-
220
- new_options = opts.merge(
221
- :operation => :"RewardsBankApi.list_rewards",
222
- :header_params => header_params,
223
- :query_params => query_params,
224
- :form_params => form_params,
225
- :body => post_body,
226
- :auth_names => auth_names,
227
- :return_type => return_type
228
- )
229
-
230
- data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
231
- if @api_client.config.debugging
232
- @api_client.config.logger.debug "API called: RewardsBankApi#list_rewards\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
233
- end
234
- return data, status_code, headers
235
- end
236
- end
237
- end