cybrid_api_bank_ruby 0.68.91 → 0.70.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (202) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile.lock +2 -2
  3. data/README.md +17 -7
  4. data/cybrid_api_bank_ruby.gemspec +2 -2
  5. data/docs/ExternalWalletBankModel.md +10 -8
  6. data/docs/ExternalWalletListBankModel.md +24 -0
  7. data/docs/ExternalWalletsBankApi.md +309 -0
  8. data/docs/PostExternalWalletBankModel.md +26 -0
  9. data/docs/PostTransferBankModel.md +2 -0
  10. data/lib/cybrid_api_bank_ruby/api/accounts_bank_api.rb +2 -2
  11. data/lib/cybrid_api_bank_ruby/api/assets_bank_api.rb +2 -2
  12. data/lib/cybrid_api_bank_ruby/api/banks_bank_api.rb +2 -2
  13. data/lib/cybrid_api_bank_ruby/api/customers_bank_api.rb +2 -2
  14. data/lib/cybrid_api_bank_ruby/api/deposit_addresses_bank_api.rb +2 -2
  15. data/lib/cybrid_api_bank_ruby/api/external_bank_accounts_bank_api.rb +2 -2
  16. data/lib/cybrid_api_bank_ruby/api/external_wallets_bank_api.rb +300 -0
  17. data/lib/cybrid_api_bank_ruby/api/identity_records_bank_api.rb +2 -2
  18. data/lib/cybrid_api_bank_ruby/api/identity_verifications_bank_api.rb +2 -2
  19. data/lib/cybrid_api_bank_ruby/api/prices_bank_api.rb +2 -2
  20. data/lib/cybrid_api_bank_ruby/api/quotes_bank_api.rb +2 -2
  21. data/lib/cybrid_api_bank_ruby/api/rewards_bank_api.rb +2 -2
  22. data/lib/cybrid_api_bank_ruby/api/symbols_bank_api.rb +2 -2
  23. data/lib/cybrid_api_bank_ruby/api/trades_bank_api.rb +2 -2
  24. data/lib/cybrid_api_bank_ruby/api/transfers_bank_api.rb +2 -2
  25. data/lib/cybrid_api_bank_ruby/api/verification_keys_bank_api.rb +2 -2
  26. data/lib/cybrid_api_bank_ruby/api/workflows_bank_api.rb +2 -2
  27. data/lib/cybrid_api_bank_ruby/api_client.rb +2 -2
  28. data/lib/cybrid_api_bank_ruby/api_error.rb +2 -2
  29. data/lib/cybrid_api_bank_ruby/configuration.rb +2 -2
  30. data/lib/cybrid_api_bank_ruby/models/account_bank_model.rb +2 -2
  31. data/lib/cybrid_api_bank_ruby/models/account_list_bank_model.rb +2 -2
  32. data/lib/cybrid_api_bank_ruby/models/asset_bank_model.rb +2 -2
  33. data/lib/cybrid_api_bank_ruby/models/asset_list_bank_model.rb +2 -2
  34. data/lib/cybrid_api_bank_ruby/models/attestation_details_bank_model.rb +2 -2
  35. data/lib/cybrid_api_bank_ruby/models/bank_bank_model.rb +2 -2
  36. data/lib/cybrid_api_bank_ruby/models/bank_list_bank_model.rb +2 -2
  37. data/lib/cybrid_api_bank_ruby/models/customer_bank_model.rb +2 -2
  38. data/lib/cybrid_api_bank_ruby/models/customer_list_bank_model.rb +2 -2
  39. data/lib/cybrid_api_bank_ruby/models/deposit_address_bank_model.rb +2 -2
  40. data/lib/cybrid_api_bank_ruby/models/deposit_address_list_bank_model.rb +2 -2
  41. data/lib/cybrid_api_bank_ruby/models/error_response_bank_model.rb +2 -2
  42. data/lib/cybrid_api_bank_ruby/models/external_bank_account_bank_model.rb +2 -2
  43. data/lib/cybrid_api_bank_ruby/models/external_bank_account_list_bank_model.rb +2 -2
  44. data/lib/cybrid_api_bank_ruby/models/external_wallet_bank_model.rb +80 -51
  45. data/lib/cybrid_api_bank_ruby/models/external_wallet_list_bank_model.rb +329 -0
  46. data/lib/cybrid_api_bank_ruby/models/identity_record_bank_model.rb +2 -2
  47. data/lib/cybrid_api_bank_ruby/models/identity_record_list_bank_model.rb +2 -2
  48. data/lib/cybrid_api_bank_ruby/models/identity_verification_bank_model.rb +2 -2
  49. data/lib/cybrid_api_bank_ruby/models/identity_verification_list_bank_model.rb +2 -2
  50. data/lib/cybrid_api_bank_ruby/models/identity_verification_with_details_all_of_bank_model.rb +2 -2
  51. data/lib/cybrid_api_bank_ruby/models/identity_verification_with_details_bank_model.rb +2 -2
  52. data/lib/cybrid_api_bank_ruby/models/patch_bank_bank_model.rb +2 -2
  53. data/lib/cybrid_api_bank_ruby/models/patch_external_bank_account_bank_model.rb +2 -2
  54. data/lib/cybrid_api_bank_ruby/models/post_account_bank_model.rb +2 -2
  55. data/lib/cybrid_api_bank_ruby/models/post_bank_bank_model.rb +2 -2
  56. data/lib/cybrid_api_bank_ruby/models/post_customer_address_bank_model.rb +2 -2
  57. data/lib/cybrid_api_bank_ruby/models/post_customer_bank_model.rb +2 -2
  58. data/lib/cybrid_api_bank_ruby/models/post_customer_name_bank_model.rb +2 -2
  59. data/lib/cybrid_api_bank_ruby/models/post_deposit_address_bank_model.rb +2 -2
  60. data/lib/cybrid_api_bank_ruby/models/post_external_bank_account_bank_model.rb +2 -2
  61. data/lib/cybrid_api_bank_ruby/models/post_external_wallet_bank_model.rb +391 -0
  62. data/lib/cybrid_api_bank_ruby/models/post_identification_number_bank_model.rb +2 -2
  63. data/lib/cybrid_api_bank_ruby/models/post_identity_record_attestation_details_bank_model.rb +2 -2
  64. data/lib/cybrid_api_bank_ruby/models/post_identity_record_bank_model.rb +2 -2
  65. data/lib/cybrid_api_bank_ruby/models/post_identity_verification_address_bank_model.rb +2 -2
  66. data/lib/cybrid_api_bank_ruby/models/post_identity_verification_bank_model.rb +2 -2
  67. data/lib/cybrid_api_bank_ruby/models/post_identity_verification_name_bank_model.rb +2 -2
  68. data/lib/cybrid_api_bank_ruby/models/post_one_time_address_bank_model.rb +2 -2
  69. data/lib/cybrid_api_bank_ruby/models/post_quote_bank_model.rb +2 -2
  70. data/lib/cybrid_api_bank_ruby/models/post_reward_bank_model.rb +2 -2
  71. data/lib/cybrid_api_bank_ruby/models/post_trade_bank_model.rb +2 -2
  72. data/lib/cybrid_api_bank_ruby/models/post_transfer_bank_model.rb +37 -3
  73. data/lib/cybrid_api_bank_ruby/models/post_verification_key_bank_model.rb +2 -2
  74. data/lib/cybrid_api_bank_ruby/models/post_workflow_bank_model.rb +2 -2
  75. data/lib/cybrid_api_bank_ruby/models/quote_bank_model.rb +2 -2
  76. data/lib/cybrid_api_bank_ruby/models/quote_list_bank_model.rb +2 -2
  77. data/lib/cybrid_api_bank_ruby/models/reward_bank_model.rb +2 -2
  78. data/lib/cybrid_api_bank_ruby/models/reward_list_bank_model.rb +2 -2
  79. data/lib/cybrid_api_bank_ruby/models/symbol_price_bank_model.rb +2 -2
  80. data/lib/cybrid_api_bank_ruby/models/trade_bank_model.rb +2 -2
  81. data/lib/cybrid_api_bank_ruby/models/trade_list_bank_model.rb +2 -2
  82. data/lib/cybrid_api_bank_ruby/models/transfer_bank_model.rb +2 -2
  83. data/lib/cybrid_api_bank_ruby/models/transfer_list_bank_model.rb +2 -2
  84. data/lib/cybrid_api_bank_ruby/models/verification_key_bank_model.rb +2 -2
  85. data/lib/cybrid_api_bank_ruby/models/verification_key_list_bank_model.rb +2 -2
  86. data/lib/cybrid_api_bank_ruby/models/workflow_bank_model.rb +2 -2
  87. data/lib/cybrid_api_bank_ruby/models/workflow_with_details_all_of_bank_model.rb +2 -2
  88. data/lib/cybrid_api_bank_ruby/models/workflow_with_details_bank_model.rb +2 -2
  89. data/lib/cybrid_api_bank_ruby/models/workflows_list_bank_model.rb +2 -2
  90. data/lib/cybrid_api_bank_ruby/version.rb +3 -3
  91. data/lib/cybrid_api_bank_ruby.rb +5 -2
  92. data/spec/api/accounts_bank_api_spec.rb +2 -2
  93. data/spec/api/assets_bank_api_spec.rb +2 -2
  94. data/spec/api/banks_bank_api_spec.rb +2 -2
  95. data/spec/api/customers_bank_api_spec.rb +2 -2
  96. data/spec/api/deposit_addresses_bank_api_spec.rb +2 -2
  97. data/spec/api/external_bank_accounts_bank_api_spec.rb +2 -2
  98. data/spec/api/external_wallets_bank_api_spec.rb +87 -0
  99. data/spec/api/identity_records_bank_api_spec.rb +2 -2
  100. data/spec/api/identity_verifications_bank_api_spec.rb +2 -2
  101. data/spec/api/prices_bank_api_spec.rb +2 -2
  102. data/spec/api/quotes_bank_api_spec.rb +2 -2
  103. data/spec/api/rewards_bank_api_spec.rb +2 -2
  104. data/spec/api/symbols_bank_api_spec.rb +2 -2
  105. data/spec/api/trades_bank_api_spec.rb +2 -2
  106. data/spec/api/transfers_bank_api_spec.rb +2 -2
  107. data/spec/api/verification_keys_bank_api_spec.rb +2 -2
  108. data/spec/api/workflows_bank_api_spec.rb +2 -2
  109. data/spec/api_client_spec.rb +2 -2
  110. data/spec/configuration_spec.rb +2 -2
  111. data/spec/models/account_bank_model_spec.rb +2 -2
  112. data/spec/models/account_list_bank_model_spec.rb +2 -2
  113. data/spec/models/asset_bank_model_spec.rb +2 -2
  114. data/spec/models/asset_list_bank_model_spec.rb +2 -2
  115. data/spec/models/attestation_details_bank_model_spec.rb +2 -2
  116. data/spec/models/bank_bank_model_spec.rb +2 -2
  117. data/spec/models/bank_list_bank_model_spec.rb +2 -2
  118. data/spec/models/customer_bank_model_spec.rb +2 -2
  119. data/spec/models/customer_list_bank_model_spec.rb +2 -2
  120. data/spec/models/deposit_address_bank_model_spec.rb +2 -2
  121. data/spec/models/deposit_address_list_bank_model_spec.rb +2 -2
  122. data/spec/models/error_response_bank_model_spec.rb +2 -2
  123. data/spec/models/external_bank_account_bank_model_spec.rb +2 -2
  124. data/spec/models/external_bank_account_list_bank_model_spec.rb +2 -2
  125. data/spec/models/external_wallet_bank_model_spec.rb +14 -12
  126. data/spec/models/external_wallet_list_bank_model_spec.rb +52 -0
  127. data/spec/models/identity_record_bank_model_spec.rb +2 -2
  128. data/spec/models/identity_record_list_bank_model_spec.rb +2 -2
  129. data/spec/models/identity_verification_bank_model_spec.rb +2 -2
  130. data/spec/models/identity_verification_list_bank_model_spec.rb +2 -2
  131. data/spec/models/identity_verification_with_details_all_of_bank_model_spec.rb +2 -2
  132. data/spec/models/identity_verification_with_details_bank_model_spec.rb +2 -2
  133. data/spec/models/patch_bank_bank_model_spec.rb +2 -2
  134. data/spec/models/patch_external_bank_account_bank_model_spec.rb +2 -2
  135. data/spec/models/post_account_bank_model_spec.rb +2 -2
  136. data/spec/models/post_bank_bank_model_spec.rb +2 -2
  137. data/spec/models/post_customer_address_bank_model_spec.rb +2 -2
  138. data/spec/models/post_customer_bank_model_spec.rb +2 -2
  139. data/spec/models/post_customer_name_bank_model_spec.rb +2 -2
  140. data/spec/models/post_deposit_address_bank_model_spec.rb +2 -2
  141. data/spec/models/post_external_bank_account_bank_model_spec.rb +2 -2
  142. data/spec/models/post_external_wallet_bank_model_spec.rb +58 -0
  143. data/spec/models/post_identification_number_bank_model_spec.rb +2 -2
  144. data/spec/models/post_identity_record_attestation_details_bank_model_spec.rb +2 -2
  145. data/spec/models/post_identity_record_bank_model_spec.rb +2 -2
  146. data/spec/models/post_identity_verification_address_bank_model_spec.rb +2 -2
  147. data/spec/models/post_identity_verification_bank_model_spec.rb +2 -2
  148. data/spec/models/post_identity_verification_name_bank_model_spec.rb +2 -2
  149. data/spec/models/post_one_time_address_bank_model_spec.rb +2 -2
  150. data/spec/models/post_quote_bank_model_spec.rb +2 -2
  151. data/spec/models/post_reward_bank_model_spec.rb +2 -2
  152. data/spec/models/post_trade_bank_model_spec.rb +2 -2
  153. data/spec/models/post_transfer_bank_model_spec.rb +8 -2
  154. data/spec/models/post_verification_key_bank_model_spec.rb +2 -2
  155. data/spec/models/post_workflow_bank_model_spec.rb +2 -2
  156. data/spec/models/quote_bank_model_spec.rb +2 -2
  157. data/spec/models/quote_list_bank_model_spec.rb +2 -2
  158. data/spec/models/reward_bank_model_spec.rb +2 -2
  159. data/spec/models/reward_list_bank_model_spec.rb +2 -2
  160. data/spec/models/symbol_price_bank_model_spec.rb +2 -2
  161. data/spec/models/trade_bank_model_spec.rb +2 -2
  162. data/spec/models/trade_list_bank_model_spec.rb +2 -2
  163. data/spec/models/transfer_bank_model_spec.rb +2 -2
  164. data/spec/models/transfer_list_bank_model_spec.rb +2 -2
  165. data/spec/models/verification_key_bank_model_spec.rb +2 -2
  166. data/spec/models/verification_key_list_bank_model_spec.rb +2 -2
  167. data/spec/models/workflow_bank_model_spec.rb +2 -2
  168. data/spec/models/workflow_with_details_all_of_bank_model_spec.rb +2 -2
  169. data/spec/models/workflow_with_details_bank_model_spec.rb +2 -2
  170. data/spec/models/workflows_list_bank_model_spec.rb +2 -2
  171. data/spec/spec_helper.rb +2 -2
  172. data/vendor/bundle/ruby/3.2.0/extensions/x86_64-linux/3.2.0/byebug-11.1.3/gem_make.out +6 -6
  173. data/vendor/bundle/ruby/3.2.0/extensions/x86_64-linux/3.2.0/ffi-1.15.5/gem_make.out +6 -6
  174. data/vendor/bundle/ruby/3.2.0/extensions/x86_64-linux/3.2.0/jaro_winkler-1.5.4/gem_make.out +6 -6
  175. data/vendor/bundle/ruby/3.2.0/extensions/x86_64-linux/3.2.0/psych-5.1.0/gem_make.out +6 -6
  176. data/vendor/bundle/ruby/3.2.0/extensions/x86_64-linux/3.2.0/stringio-3.0.6/gem_make.out +6 -6
  177. data/vendor/bundle/ruby/3.2.0/specifications/ast-2.4.2.gemspec +2 -2
  178. data/vendor/bundle/ruby/3.2.0/specifications/byebug-11.1.3.gemspec +2 -2
  179. data/vendor/bundle/ruby/3.2.0/specifications/coderay-1.1.3.gemspec +2 -2
  180. data/vendor/bundle/ruby/3.2.0/specifications/diff-lcs-1.5.0.gemspec +2 -2
  181. data/vendor/bundle/ruby/3.2.0/specifications/ethon-0.16.0.gemspec +2 -2
  182. data/vendor/bundle/ruby/3.2.0/specifications/ffi-1.15.5.gemspec +2 -2
  183. data/vendor/bundle/ruby/3.2.0/specifications/jaro_winkler-1.5.4.gemspec +2 -2
  184. data/vendor/bundle/ruby/3.2.0/specifications/method_source-1.0.0.gemspec +2 -2
  185. data/vendor/bundle/ruby/3.2.0/specifications/parallel-1.23.0.gemspec +2 -2
  186. data/vendor/bundle/ruby/3.2.0/specifications/parser-3.2.2.1.gemspec +2 -2
  187. data/vendor/bundle/ruby/3.2.0/specifications/pry-0.14.2.gemspec +2 -2
  188. data/vendor/bundle/ruby/3.2.0/specifications/pry-byebug-3.10.1.gemspec +2 -2
  189. data/vendor/bundle/ruby/3.2.0/specifications/psych-5.1.0.gemspec +2 -2
  190. data/vendor/bundle/ruby/3.2.0/specifications/rainbow-3.1.1.gemspec +2 -2
  191. data/vendor/bundle/ruby/3.2.0/specifications/rake-13.0.6.gemspec +2 -2
  192. data/vendor/bundle/ruby/3.2.0/specifications/rspec-3.12.0.gemspec +2 -2
  193. data/vendor/bundle/ruby/3.2.0/specifications/rspec-core-3.12.2.gemspec +2 -2
  194. data/vendor/bundle/ruby/3.2.0/specifications/rspec-expectations-3.12.3.gemspec +2 -2
  195. data/vendor/bundle/ruby/3.2.0/specifications/rspec-mocks-3.12.5.gemspec +2 -2
  196. data/vendor/bundle/ruby/3.2.0/specifications/rspec-support-3.12.0.gemspec +2 -2
  197. data/vendor/bundle/ruby/3.2.0/specifications/rubocop-0.66.0.gemspec +2 -2
  198. data/vendor/bundle/ruby/3.2.0/specifications/ruby-progressbar-1.13.0.gemspec +2 -2
  199. data/vendor/bundle/ruby/3.2.0/specifications/stringio-3.0.6.gemspec +2 -2
  200. data/vendor/bundle/ruby/3.2.0/specifications/typhoeus-1.4.0.gemspec +2 -2
  201. data/vendor/bundle/ruby/3.2.0/specifications/unicode-display_width-1.5.0.gemspec +2 -2
  202. metadata +14 -2
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 6ebca7441c5f68a18c0f0feeab05a199eb52b2d3607a7dc3f80e1732589a525d
4
- data.tar.gz: 6b7b1b2afbf10ee0cbd28ad5f0a0d2e173679eae09254a719ecfcb13453560c8
3
+ metadata.gz: 7977eb16f129520aa436da472c20e7b3c502c253f3dd169c122c4432a2bd566d
4
+ data.tar.gz: 0d6baeaffd84e67b8dae87ef3a95fb8ccfd3e1db32089228fd4c6abc9cf1b970
5
5
  SHA512:
6
- metadata.gz: 5a94a3984fced897b62ccb4360abeb2031ceaa7f685abb413fa4079ae4ec6ff95bef45313901239139f3ddbfbc87960dab139845ebbeb88aa2fd863e90ee2080
7
- data.tar.gz: c26d8b5ebbd58f6eb2a33515d3e8917fee5bca36d662e9175025ae097b053bac69e3c4950358a3b4558b98294a0cd9c76fb21e72ae7876e447e67f47ce0f9a46
6
+ metadata.gz: a4fbc763a48c633de6be4587d9751cd2825bd9515aa8afbb22c9f3166adc13006234bbec0c29fa40be0aff41c5f1f07ed46a24a3e5d344115ab6b99fb4c2aa74
7
+ data.tar.gz: 2bce1e7d1766bfaad250aceb795c579687180bd49b5659c3d628d7a341bb101d134c09ec0adedf95f9c90fc4272737f47925681e37d463af3afd3e7d80b97b76
data/Gemfile.lock CHANGED
@@ -1,7 +1,7 @@
1
1
  PATH
2
2
  remote: .
3
3
  specs:
4
- cybrid_api_bank_ruby (0.68.91)
4
+ cybrid_api_bank_ruby (0.70.0)
5
5
  typhoeus (~> 1.0, >= 1.0.1)
6
6
 
7
7
  GEM
@@ -67,4 +67,4 @@ DEPENDENCIES
67
67
  rubocop (~> 0.66.0)
68
68
 
69
69
  BUNDLED WITH
70
- 2.4.7
70
+ 2.4.12
data/README.md CHANGED
@@ -69,10 +69,10 @@ curl -X POST https://id.sandbox.cybrid.app/oauth/token -d '{
69
69
  \"grant_type\": \"client_credentials\",
70
70
  \"client_id\": \"<Your Client ID>\",
71
71
  \"client_secret\": \"<Your Secret>\",
72
- \"scope\": \"banks:read banks:write accounts:read accounts:execute customers:read customers:write customers:execute prices:read quotes:execute quotes:read trades:execute trades:read transfers:execute transfers:read rewards:execute rewards:read external_bank_accounts:read external_bank_accounts:write external_bank_accounts:execute workflows:read workflows:execute deposit_addresses:read deposit_addresses:execute\"
72
+ \"scope\": \"banks:read banks:write accounts:read accounts:execute customers:read customers:write customers:execute prices:read quotes:execute quotes:read trades:execute trades:read transfers:execute transfers:read rewards:execute rewards:read external_bank_accounts:read external_bank_accounts:write external_bank_accounts:execute external_wallets:read external_wallets:execute workflows:read workflows:execute deposit_addresses:read deposit_addresses:execute\"
73
73
  }' -H \"Content-Type: application/json\"
74
74
 
75
- # When using Organization credentials set `scope` to 'organizations:read organizations:write banks:read banks:write banks:execute customers:read accounts:read prices:read quotes:execute quotes:read trades:execute trades:read transfers:read transfers:execute external_bank_accounts:read workflows:read deposit_addresses:read'
75
+ # When using Organization credentials set `scope` to 'organizations:read organizations:write banks:read banks:write banks:execute customers:read accounts:read prices:read quotes:execute quotes:read trades:execute trades:read transfers:read transfers:execute external_bank_accounts:read external_wallets:read workflows:read deposit_addresses:read'
76
76
  ```
77
77
  <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>
78
78
 
@@ -89,6 +89,7 @@ The following scopes are available on the platform and can be requested when gen
89
89
  | Customer | customers:read (Organization, Bank, Customer) | customers:write (Bank, Customer) | customers:execute (Bank) |
90
90
  | Deposit Address | deposit_addresses:read (Organization, Bank, Customer) | deposit_addresses:write (Bank, Customer) | deposit_addresses:execute (Bank, Customer) |
91
91
  | External Bank Account | external_bank_accounts:read (Organization, Bank, Customer) | external_bank_accounts:write (Bank, Customer) | external_bank_accounts:execute (Bank, Customer) |
92
+ | External Wallet | external_wallet:read (Organization, Bank, Customer) | | external_wallet:execute (Bank, Customer) |
92
93
  | Organization | organizations:read (Organization) | organizations:write (Organization) | |
93
94
  | Price | prices:read (Bank, Customer) | | |
94
95
  | Quote | quotes:read (Organization, Bank, Customer) | | quotes:execute (Organization, Bank, Customer) |
@@ -114,6 +115,7 @@ The available APIs for the [Identity](https://id.sandbox.cybrid.app/api/schema/s
114
115
  | Bank | Customer | /api/customers | Create and list customers |
115
116
  | Bank | DepositAddress | /api/deposit_addresses | Create, get and list deposit addresses |
116
117
  | Bank | ExternalBankAccount | /api/external_bank_accounts | Create, get and list external bank accounts, which connect customer bank accounts to the platform |
118
+ | Bank | ExternalWallet | /api/external_wallets | Create, get, list and delete external wallets, which connect customer wallets to the platform |
117
119
  | Bank | IdentityVerification | /api/identity_verifications | Create and list identity verifications, which are performed on customers for KYC |
118
120
  | Bank | Price | /api/prices | Get the current prices for assets on the platform |
119
121
  | Bank | Quote | /api/quotes | Create and list quotes, which are required to execute trades |
@@ -148,8 +150,8 @@ An `Organization` can have multiple `banks`, in either `Sandbox` or `Production`
148
150
 
149
151
  This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
150
152
 
151
- - API version: v0.68.91
152
- - Package version: 0.68.91
153
+ - API version: v0.70.0
154
+ - Package version: 0.70.0
153
155
  - Build package: org.openapitools.codegen.languages.RubyClientCodegen
154
156
 
155
157
  ## Installation
@@ -165,16 +167,16 @@ gem build cybrid_api_bank_ruby.gemspec
165
167
  Then either install the gem locally:
166
168
 
167
169
  ```shell
168
- gem install ./cybrid_api_bank_ruby-0.68.91.gem
170
+ gem install ./cybrid_api_bank_ruby-0.70.0.gem
169
171
  ```
170
172
 
171
- (for development, run `gem install --dev ./cybrid_api_bank_ruby-0.68.91.gem` to install the development dependencies)
173
+ (for development, run `gem install --dev ./cybrid_api_bank_ruby-0.70.0.gem` to install the development dependencies)
172
174
 
173
175
  or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
174
176
 
175
177
  Finally add this to the Gemfile:
176
178
 
177
- gem 'cybrid_api_bank_ruby', '~> 0.68.91'
179
+ gem 'cybrid_api_bank_ruby', '~> 0.70.0'
178
180
 
179
181
  ### Install from Git
180
182
 
@@ -245,6 +247,10 @@ Class | Method | HTTP request | Description
245
247
  *CybridApiBank::ExternalBankAccountsBankApi* | [**get_external_bank_account**](docs/ExternalBankAccountsBankApi.md#get_external_bank_account) | **GET** /api/external_bank_accounts/{external_bank_account_guid} | Get External Bank Account
246
248
  *CybridApiBank::ExternalBankAccountsBankApi* | [**list_external_bank_accounts**](docs/ExternalBankAccountsBankApi.md#list_external_bank_accounts) | **GET** /api/external_bank_accounts | Get external bank accounts list
247
249
  *CybridApiBank::ExternalBankAccountsBankApi* | [**patch_external_bank_account**](docs/ExternalBankAccountsBankApi.md#patch_external_bank_account) | **PATCH** /api/external_bank_accounts/{external_bank_account_guid} | Patch ExternalBankAccount
250
+ *CybridApiBank::ExternalWalletsBankApi* | [**create_external_wallet**](docs/ExternalWalletsBankApi.md#create_external_wallet) | **POST** /api/external_wallets | Create ExternalWallet
251
+ *CybridApiBank::ExternalWalletsBankApi* | [**delete_external_wallet**](docs/ExternalWalletsBankApi.md#delete_external_wallet) | **DELETE** /api/external_wallets/{external_wallet_guid} | Delete External Wallet
252
+ *CybridApiBank::ExternalWalletsBankApi* | [**get_external_wallet**](docs/ExternalWalletsBankApi.md#get_external_wallet) | **GET** /api/external_wallets/{external_wallet_guid} | Get External Wallet
253
+ *CybridApiBank::ExternalWalletsBankApi* | [**list_external_wallets**](docs/ExternalWalletsBankApi.md#list_external_wallets) | **GET** /api/external_wallets | Get external wallets list
248
254
  *CybridApiBank::IdentityRecordsBankApi* | [**create_identity_record**](docs/IdentityRecordsBankApi.md#create_identity_record) | **POST** /api/identity_records | Create Identity Record
249
255
  *CybridApiBank::IdentityRecordsBankApi* | [**get_identity_record**](docs/IdentityRecordsBankApi.md#get_identity_record) | **GET** /api/identity_records/{identity_record_guid} | Get Identity Record
250
256
  *CybridApiBank::IdentityRecordsBankApi* | [**list_identity_records**](docs/IdentityRecordsBankApi.md#list_identity_records) | **GET** /api/identity_records | List Identity Records
@@ -290,6 +296,7 @@ Class | Method | HTTP request | Description
290
296
  - [CybridApiBank::ExternalBankAccountBankModel](docs/ExternalBankAccountBankModel.md)
291
297
  - [CybridApiBank::ExternalBankAccountListBankModel](docs/ExternalBankAccountListBankModel.md)
292
298
  - [CybridApiBank::ExternalWalletBankModel](docs/ExternalWalletBankModel.md)
299
+ - [CybridApiBank::ExternalWalletListBankModel](docs/ExternalWalletListBankModel.md)
293
300
  - [CybridApiBank::IdentityRecordBankModel](docs/IdentityRecordBankModel.md)
294
301
  - [CybridApiBank::IdentityRecordListBankModel](docs/IdentityRecordListBankModel.md)
295
302
  - [CybridApiBank::IdentityVerificationBankModel](docs/IdentityVerificationBankModel.md)
@@ -305,6 +312,7 @@ Class | Method | HTTP request | Description
305
312
  - [CybridApiBank::PostCustomerNameBankModel](docs/PostCustomerNameBankModel.md)
306
313
  - [CybridApiBank::PostDepositAddressBankModel](docs/PostDepositAddressBankModel.md)
307
314
  - [CybridApiBank::PostExternalBankAccountBankModel](docs/PostExternalBankAccountBankModel.md)
315
+ - [CybridApiBank::PostExternalWalletBankModel](docs/PostExternalWalletBankModel.md)
308
316
  - [CybridApiBank::PostIdentificationNumberBankModel](docs/PostIdentificationNumberBankModel.md)
309
317
  - [CybridApiBank::PostIdentityRecordAttestationDetailsBankModel](docs/PostIdentityRecordAttestationDetailsBankModel.md)
310
318
  - [CybridApiBank::PostIdentityRecordBankModel](docs/PostIdentityRecordBankModel.md)
@@ -368,6 +376,8 @@ Class | Method | HTTP request | Description
368
376
  - external_bank_accounts:read: external_bank_accounts read
369
377
  - external_bank_accounts:write: external_bank_accounts write
370
378
  - external_bank_accounts:execute: external_bank_accounts execute
379
+ - external_wallets:read: external_wallets read
380
+ - external_wallets:execute: external_wallets execute
371
381
  - workflows:read: workflows read
372
382
  - workflows:execute: workflows execute
373
383
  - deposit_addresses:read: deposit_addresses read
@@ -3,9 +3,9 @@
3
3
  =begin
4
4
  #Cybrid Bank API
5
5
 
6
- ## 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://www.cybrid.xyz/guides/getting-started), 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://www.cybrid.xyz/guides/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://www.cybrid.xyz/guides/running-the-cybrid-web-demo-crypto-app) guide to test our web SDK with your sandbox `bank` and `customer`. ## Working with the Cybrid Platform There are three primary ways you can interact with the Cybrid platform: 1. Directly via our RESTful API (this documentation) 2. Using our API clients available in a variety of languages ([Angular](https://github.com/Cybrid-app/cybrid-api-bank-angular), [Java](https://github.com/Cybrid-app/cybrid-api-bank-java), [Kotlin](https://github.com/Cybrid-app/cybrid-api-bank-kotlin), [Python](https://github.com/Cybrid-app/cybrid-api-bank-python), [Ruby](https://github.com/Cybrid-app/cybrid-api-bank-ruby), [Swift](https://github.com/Cybrid-app/cybrid-api-bank-swift) or [Typescript](https://github.com/Cybrid-app/cybrid-api-bank-typescript)) 3. Integrating a platform specific SDK ([Web](https://github.com/Cybrid-app/cybrid-sdk-web), [Android](https://github.com/Cybrid-app/cybrid-sdk-android), [iOS](https://github.com/Cybrid-app/cybrid-sdk-ios)) Our complete set of APIs allows you to manage resources across three distinct areas: your `Organization`, your `Banks` and your `Identities`. For most of your testing and interaction you'll be using the `Bank` API, which is where the majority of APIs reside. *The complete set of APIs can be found on the following pages:* | API | Description | |------------------------------------------------------------------|-------------------------------------------------------------| | [Organization API](https://organization.sandbox.cybrid.app/api/schema/swagger-ui) | APIs to manage organizations | | [Bank API](https://bank.sandbox.cybrid.app/api/schema/swagger-ui) | APIs to manage banks (and all downstream customer activity) | | [Identities API](https://id.sandbox.cybrid.app/api/schema/swagger-ui) | APIs to manage organization and bank identities | For questions please contact [Support](mailto:support@cybrid.xyz) at any time for assistance, or contact the [Product Team](mailto:product@cybrid.xyz) for product suggestions. ## Authenticating with the API The Cybrid Platform uses OAuth 2.0 Bearer Tokens to authenticate requests to the platform. Credentials to create `Organization` and `Bank` tokens can be generated via the [Cybrid Sandbox](https://id.sandbox.cybrid.app). Access tokens can be generated for a `Customer` as well via the [Cybrid IdP](https://id.sandbox.cybrid.app) as well. An `Organization` access token applies broadly to the whole Organization and all of its `Banks`, whereas, a `Bank` access token is specific to an individual Bank. `Customer` tokens, similarly, are scoped to a specific customer in a bank. Both `Organization` and `Bank` tokens can be created using the OAuth Client Credential Grant flow. Each Organization and Bank has its own unique `Client ID` and `Secret` that allows for machine-to-machine authentication. A `Bank` can then generate `Customer` access tokens via API using our [Identities API](https://id.sandbox.cybrid.app/api/schema/swagger-ui). <font color=\"orange\">**⚠️ Never share your Client ID or Secret publicly or in your source code repository.**</font> Your `Client ID` and `Secret` can be exchanged for a time-limited `Bearer Token` by interacting with the Cybrid Identity Provider or through interacting with the **Authorize** button in this document. The following curl command can be used to quickly generate a `Bearer Token` for use in testing the API or demo applications. ``` # Example request when using Bank credentials curl -X POST https://id.sandbox.cybrid.app/oauth/token -d '{ \"grant_type\": \"client_credentials\", \"client_id\": \"<Your Client ID>\", \"client_secret\": \"<Your Secret>\", \"scope\": \"banks:read banks:write accounts:read accounts:execute customers:read customers:write customers:execute prices:read quotes:execute quotes:read trades:execute trades:read transfers:execute transfers:read rewards:execute rewards:read external_bank_accounts:read external_bank_accounts:write external_bank_accounts:execute workflows:read workflows:execute deposit_addresses:read deposit_addresses:execute\" }' -H \"Content-Type: application/json\" # When using Organization credentials set `scope` to 'organizations:read organizations:write banks:read banks:write banks:execute customers:read accounts:read prices:read quotes:execute quotes:read trades:execute trades:read transfers:read transfers:execute external_bank_accounts:read 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) | | Organization | organizations:read (Organization) | organizations:write (Organization) | | | Price | prices:read (Bank, Customer) | | | | Quote | quotes:read (Organization, Bank, Customer) | | quotes:execute (Organization, Bank, Customer) | | Reward | rewards:read (Bank, Customer) | | rewards:execute (Bank) | | Trade | trades:read (Organization, Bank, Customer) | | trades:execute (Organization, Bank, Customer) | | Transfer | transfers:read (Organization, Bank, Customer) | | transfers:execute (Organization, Bank, Customer) | | Workflow | workflows:read (Organization, Bank, Customer) | | workflows:execute (Bank, Customer) | ## Available Endpoints The available APIs for the [Identity](https://id.sandbox.cybrid.app/api/schema/swagger-ui), [Organization](https://organization.sandbox.cybrid.app/api/schema/swagger-ui) and [Bank](https://bank.sandbox.cybrid.app/api/schema/swagger-ui) API services are listed below: | API Service | Model | API Endpoint Path | Description | |--------------|----------------------|--------------------------------|---------------------------------------------------------------------------------------------------| | Identity | Bank | /api/bank_applications | Create and list banks | | Identity | CustomerToken | /api/customer_tokens | Create customer JWT access tokens | | Identity | Organization | /api/organization_applications | Create and list organizations | | Organization | Organization | /api/organizations | APIs to retrieve and update organization name | | Bank | Account | /api/accounts | Create and list accounts, which hold a specific asset for a customers | | Bank | Asset | /api/assets | Get a list of assets supported by the platform (ex: BTC, ETH) | | Bank | Bank | /api/banks | Create, update and list banks, the parent to customers, accounts, etc | | Bank | BankVerificationKey | /api/bank_verification_keys | Create, list and retrive verification keys, used for signing identities | | 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 | 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.
6
+ ## 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://www.cybrid.xyz/guides/getting-started), 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://www.cybrid.xyz/guides/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://www.cybrid.xyz/guides/running-the-cybrid-web-demo-crypto-app) guide to test our web SDK with your sandbox `bank` and `customer`. ## Working with the Cybrid Platform There are three primary ways you can interact with the Cybrid platform: 1. Directly via our RESTful API (this documentation) 2. Using our API clients available in a variety of languages ([Angular](https://github.com/Cybrid-app/cybrid-api-bank-angular), [Java](https://github.com/Cybrid-app/cybrid-api-bank-java), [Kotlin](https://github.com/Cybrid-app/cybrid-api-bank-kotlin), [Python](https://github.com/Cybrid-app/cybrid-api-bank-python), [Ruby](https://github.com/Cybrid-app/cybrid-api-bank-ruby), [Swift](https://github.com/Cybrid-app/cybrid-api-bank-swift) or [Typescript](https://github.com/Cybrid-app/cybrid-api-bank-typescript)) 3. Integrating a platform specific SDK ([Web](https://github.com/Cybrid-app/cybrid-sdk-web), [Android](https://github.com/Cybrid-app/cybrid-sdk-android), [iOS](https://github.com/Cybrid-app/cybrid-sdk-ios)) Our complete set of APIs allows you to manage resources across three distinct areas: your `Organization`, your `Banks` and your `Identities`. For most of your testing and interaction you'll be using the `Bank` API, which is where the majority of APIs reside. *The complete set of APIs can be found on the following pages:* | API | Description | |------------------------------------------------------------------|-------------------------------------------------------------| | [Organization API](https://organization.sandbox.cybrid.app/api/schema/swagger-ui) | APIs to manage organizations | | [Bank API](https://bank.sandbox.cybrid.app/api/schema/swagger-ui) | APIs to manage banks (and all downstream customer activity) | | [Identities API](https://id.sandbox.cybrid.app/api/schema/swagger-ui) | APIs to manage organization and bank identities | For questions please contact [Support](mailto:support@cybrid.xyz) at any time for assistance, or contact the [Product Team](mailto:product@cybrid.xyz) for product suggestions. ## Authenticating with the API The Cybrid Platform uses OAuth 2.0 Bearer Tokens to authenticate requests to the platform. Credentials to create `Organization` and `Bank` tokens can be generated via the [Cybrid Sandbox](https://id.sandbox.cybrid.app). Access tokens can be generated for a `Customer` as well via the [Cybrid IdP](https://id.sandbox.cybrid.app) as well. An `Organization` access token applies broadly to the whole Organization and all of its `Banks`, whereas, a `Bank` access token is specific to an individual Bank. `Customer` tokens, similarly, are scoped to a specific customer in a bank. Both `Organization` and `Bank` tokens can be created using the OAuth Client Credential Grant flow. Each Organization and Bank has its own unique `Client ID` and `Secret` that allows for machine-to-machine authentication. A `Bank` can then generate `Customer` access tokens via API using our [Identities API](https://id.sandbox.cybrid.app/api/schema/swagger-ui). <font color=\"orange\">**⚠️ Never share your Client ID or Secret publicly or in your source code repository.**</font> Your `Client ID` and `Secret` can be exchanged for a time-limited `Bearer Token` by interacting with the Cybrid Identity Provider or through interacting with the **Authorize** button in this document. The following curl command can be used to quickly generate a `Bearer Token` for use in testing the API or demo applications. ``` # Example request when using Bank credentials curl -X POST https://id.sandbox.cybrid.app/oauth/token -d '{ \"grant_type\": \"client_credentials\", \"client_id\": \"<Your Client ID>\", \"client_secret\": \"<Your Secret>\", \"scope\": \"banks:read banks:write accounts:read accounts:execute customers:read customers:write customers:execute prices:read quotes:execute quotes:read trades:execute trades:read transfers:execute transfers:read rewards:execute rewards:read external_bank_accounts:read external_bank_accounts:write external_bank_accounts:execute external_wallets:read external_wallets:execute workflows:read workflows:execute deposit_addresses:read deposit_addresses:execute\" }' -H \"Content-Type: application/json\" # When using Organization credentials set `scope` to 'organizations:read organizations:write banks:read banks:write banks:execute customers:read accounts:read prices:read quotes:execute quotes:read trades:execute trades:read transfers:read transfers:execute external_bank_accounts:read external_wallets:read workflows:read deposit_addresses:read' ``` <font color=\"orange\">**⚠️ Note: The above curl will create a bearer token with full scope access. Delete scopes if you'd like to restrict access.**</font> ## Authentication Scopes The Cybrid platform supports the use of scopes to control the level of access a token is limited to. Scopes do not grant access to resources; instead, they provide limits, in support of the least privilege principal. The following scopes are available on the platform and can be requested when generating either an Organization, Bank or Customer token. Generally speaking, the _Read_ scope is required to read and list resources, the _Write_ scope is required to update a resource and the _Execute_ scope is required to create a resource. | Resource | Read scope (Token Type) | Write scope (Token Type) | Execute scope (Token Type) | |-----------------------|------------------------------------------------------------|-----------------------------------------------|--------------------------------------------------| | Account | accounts:read (Organization, Bank, Customer) | | accounts:execute (Bank, Customer) | | Bank | banks:read (Organization, Bank) | banks:write (Organization, Bank) | banks:execute (Organization) | | Customer | customers:read (Organization, Bank, Customer) | customers:write (Bank, Customer) | customers:execute (Bank) | | Deposit Address | deposit_addresses:read (Organization, Bank, Customer) | deposit_addresses:write (Bank, Customer) | deposit_addresses:execute (Bank, Customer) | | External Bank Account | external_bank_accounts:read (Organization, Bank, Customer) | external_bank_accounts:write (Bank, Customer) | external_bank_accounts:execute (Bank, Customer) | | External Wallet | external_wallet:read (Organization, Bank, Customer) | | external_wallet:execute (Bank, Customer) | | Organization | organizations:read (Organization) | organizations:write (Organization) | | | Price | prices:read (Bank, Customer) | | | | Quote | quotes:read (Organization, Bank, Customer) | | quotes:execute (Organization, Bank, Customer) | | Reward | rewards:read (Bank, Customer) | | rewards:execute (Bank) | | Trade | trades:read (Organization, Bank, Customer) | | trades:execute (Organization, Bank, Customer) | | Transfer | transfers:read (Organization, Bank, Customer) | | transfers:execute (Organization, Bank, Customer) | | Workflow | workflows:read (Organization, Bank, Customer) | | workflows:execute (Bank, Customer) | ## Available Endpoints The available APIs for the [Identity](https://id.sandbox.cybrid.app/api/schema/swagger-ui), [Organization](https://organization.sandbox.cybrid.app/api/schema/swagger-ui) and [Bank](https://bank.sandbox.cybrid.app/api/schema/swagger-ui) API services are listed below: | API Service | Model | API Endpoint Path | Description | |--------------|----------------------|--------------------------------|---------------------------------------------------------------------------------------------------| | Identity | Bank | /api/bank_applications | Create and list banks | | Identity | CustomerToken | /api/customer_tokens | Create customer JWT access tokens | | Identity | Organization | /api/organization_applications | Create and list organizations | | Organization | Organization | /api/organizations | APIs to retrieve and update organization name | | Bank | Account | /api/accounts | Create and list accounts, which hold a specific asset for a customers | | Bank | Asset | /api/assets | Get a list of assets supported by the platform (ex: BTC, ETH) | | Bank | Bank | /api/banks | Create, update and list banks, the parent to customers, accounts, etc | | Bank | BankVerificationKey | /api/bank_verification_keys | Create, list and retrive verification keys, used for signing identities | | 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.
7
7
 
8
- The version of the OpenAPI document: v0.68.91
8
+ The version of the OpenAPI document: v0.70.0
9
9
  Contact: support@cybrid.app
10
10
  Generated by: https://openapi-generator.tech
11
11
  OpenAPI Generator version: 6.0.0
@@ -4,13 +4,14 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
- | **guid** | **String** | Auto-generated unique identifier for the account. | [optional] |
8
- | **name** | **String** | The name of the account. | [optional] |
7
+ | **guid** | **String** | Auto-generated unique identifier for the wallet. | [optional] |
8
+ | **name** | **String** | The name of the wallet. | [optional] |
9
9
  | **asset_code** | **String** | The asset code. | [optional] |
10
- | **account_kind** | **String** | The type of account. | [optional] |
11
- | **environment** | **String** | The environment that the exchange is operating in. | [optional] |
12
- | **exchange_guid** | **String** | The exchange identifier. | [optional] |
13
- | **created_at** | **Time** | ISO8601 datetime the exchange was created at. | [optional] |
10
+ | **environment** | **String** | The environment that the wallet is configured for. | [optional] |
11
+ | **customer_guid** | **String** | The customer identifier. | [optional] |
12
+ | **address** | **String** | The blockchain wallet address for the wallet. | [optional] |
13
+ | **tag** | **String** | The blockchain tag to use when transferring crypto to the wallet. | [optional] |
14
+ | **created_at** | **Time** | ISO8601 datetime the wallet was created at. | [optional] |
14
15
  | **state** | **String** | The state of an external wallet | [optional] |
15
16
  | **failure_code** | **String** | The failure code of an external wallet (if any) | [optional] |
16
17
 
@@ -23,9 +24,10 @@ instance = CybridApiBank::ExternalWalletBankModel.new(
23
24
  guid: null,
24
25
  name: null,
25
26
  asset_code: null,
26
- account_kind: null,
27
27
  environment: null,
28
- exchange_guid: null,
28
+ customer_guid: null,
29
+ address: null,
30
+ tag: null,
29
31
  created_at: null,
30
32
  state: null,
31
33
  failure_code: null
@@ -0,0 +1,24 @@
1
+ # CybridApiBank::ExternalWalletListBankModel
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **total** | **Integer** | The total number of records available. | |
8
+ | **page** | **Integer** | The page index to retrieve. | |
9
+ | **per_page** | **Integer** | The number of entities per page to return. | |
10
+ | **objects** | [**Array&lt;ExternalWalletBankModel&gt;**](ExternalWalletBankModel.md) | Array of external wallet entities | |
11
+
12
+ ## Example
13
+
14
+ ```ruby
15
+ require 'cybrid_api_bank_ruby'
16
+
17
+ instance = CybridApiBank::ExternalWalletListBankModel.new(
18
+ total: null,
19
+ page: null,
20
+ per_page: null,
21
+ objects: null
22
+ )
23
+ ```
24
+
@@ -0,0 +1,309 @@
1
+ # CybridApiBank::ExternalWalletsBankApi
2
+
3
+ All URIs are relative to *https://bank.sandbox.cybrid.app*
4
+
5
+ | Method | HTTP request | Description |
6
+ | ------ | ------------ | ----------- |
7
+ | [**create_external_wallet**](ExternalWalletsBankApi.md#create_external_wallet) | **POST** /api/external_wallets | Create ExternalWallet |
8
+ | [**delete_external_wallet**](ExternalWalletsBankApi.md#delete_external_wallet) | **DELETE** /api/external_wallets/{external_wallet_guid} | Delete External Wallet |
9
+ | [**get_external_wallet**](ExternalWalletsBankApi.md#get_external_wallet) | **GET** /api/external_wallets/{external_wallet_guid} | Get External Wallet |
10
+ | [**list_external_wallets**](ExternalWalletsBankApi.md#list_external_wallets) | **GET** /api/external_wallets | Get external wallets list |
11
+
12
+
13
+ ## create_external_wallet
14
+
15
+ > <ExternalWalletBankModel> create_external_wallet(post_external_wallet_bank_model)
16
+
17
+ Create ExternalWallet
18
+
19
+ Create an ExternalWallet. Required scope: **external_wallets:execute**
20
+
21
+ ### Examples
22
+
23
+ ```ruby
24
+ require 'time'
25
+ require 'cybrid_api_bank_ruby'
26
+ # setup authorization
27
+ CybridApiBank.configure do |config|
28
+ # Configure Bearer authorization (JWT): BearerAuth
29
+ config.access_token = 'YOUR_BEARER_TOKEN'
30
+
31
+ # Configure OAuth2 access token for authorization: oauth2
32
+ config.access_token = 'YOUR ACCESS TOKEN'
33
+ end
34
+
35
+ api_instance = CybridApiBank::ExternalWalletsBankApi.new
36
+ post_external_wallet_bank_model = CybridApiBank::PostExternalWalletBankModel.new({name: 'name_example', customer_guid: 'customer_guid_example', asset: 'asset_example', address: 'address_example'}) # PostExternalWalletBankModel |
37
+
38
+ begin
39
+ # Create ExternalWallet
40
+ result = api_instance.create_external_wallet(post_external_wallet_bank_model)
41
+ p result
42
+ rescue CybridApiBank::ApiError => e
43
+ puts "Error when calling ExternalWalletsBankApi->create_external_wallet: #{e}"
44
+ end
45
+ ```
46
+
47
+ #### Using the create_external_wallet_with_http_info variant
48
+
49
+ This returns an Array which contains the response data, status code and headers.
50
+
51
+ > <Array(<ExternalWalletBankModel>, Integer, Hash)> create_external_wallet_with_http_info(post_external_wallet_bank_model)
52
+
53
+ ```ruby
54
+ begin
55
+ # Create ExternalWallet
56
+ data, status_code, headers = api_instance.create_external_wallet_with_http_info(post_external_wallet_bank_model)
57
+ p status_code # => 2xx
58
+ p headers # => { ... }
59
+ p data # => <ExternalWalletBankModel>
60
+ rescue CybridApiBank::ApiError => e
61
+ puts "Error when calling ExternalWalletsBankApi->create_external_wallet_with_http_info: #{e}"
62
+ end
63
+ ```
64
+
65
+ ### Parameters
66
+
67
+ | Name | Type | Description | Notes |
68
+ | ---- | ---- | ----------- | ----- |
69
+ | **post_external_wallet_bank_model** | [**PostExternalWalletBankModel**](PostExternalWalletBankModel.md) | | |
70
+
71
+ ### Return type
72
+
73
+ [**ExternalWalletBankModel**](ExternalWalletBankModel.md)
74
+
75
+ ### Authorization
76
+
77
+ [BearerAuth](../README.md#BearerAuth), [oauth2](../README.md#oauth2)
78
+
79
+ ### HTTP request headers
80
+
81
+ - **Content-Type**: application/json
82
+ - **Accept**: application/json
83
+
84
+
85
+ ## delete_external_wallet
86
+
87
+ > <ExternalWalletBankModel> delete_external_wallet(external_wallet_guid)
88
+
89
+ Delete External Wallet
90
+
91
+ Deletes an external wallet. Required scope: **external_wallets:execute**
92
+
93
+ ### Examples
94
+
95
+ ```ruby
96
+ require 'time'
97
+ require 'cybrid_api_bank_ruby'
98
+ # setup authorization
99
+ CybridApiBank.configure do |config|
100
+ # Configure Bearer authorization (JWT): BearerAuth
101
+ config.access_token = 'YOUR_BEARER_TOKEN'
102
+
103
+ # Configure OAuth2 access token for authorization: oauth2
104
+ config.access_token = 'YOUR ACCESS TOKEN'
105
+ end
106
+
107
+ api_instance = CybridApiBank::ExternalWalletsBankApi.new
108
+ external_wallet_guid = 'external_wallet_guid_example' # String | Identifier for the external wallet.
109
+
110
+ begin
111
+ # Delete External Wallet
112
+ result = api_instance.delete_external_wallet(external_wallet_guid)
113
+ p result
114
+ rescue CybridApiBank::ApiError => e
115
+ puts "Error when calling ExternalWalletsBankApi->delete_external_wallet: #{e}"
116
+ end
117
+ ```
118
+
119
+ #### Using the delete_external_wallet_with_http_info variant
120
+
121
+ This returns an Array which contains the response data, status code and headers.
122
+
123
+ > <Array(<ExternalWalletBankModel>, Integer, Hash)> delete_external_wallet_with_http_info(external_wallet_guid)
124
+
125
+ ```ruby
126
+ begin
127
+ # Delete External Wallet
128
+ data, status_code, headers = api_instance.delete_external_wallet_with_http_info(external_wallet_guid)
129
+ p status_code # => 2xx
130
+ p headers # => { ... }
131
+ p data # => <ExternalWalletBankModel>
132
+ rescue CybridApiBank::ApiError => e
133
+ puts "Error when calling ExternalWalletsBankApi->delete_external_wallet_with_http_info: #{e}"
134
+ end
135
+ ```
136
+
137
+ ### Parameters
138
+
139
+ | Name | Type | Description | Notes |
140
+ | ---- | ---- | ----------- | ----- |
141
+ | **external_wallet_guid** | **String** | Identifier for the external wallet. | |
142
+
143
+ ### Return type
144
+
145
+ [**ExternalWalletBankModel**](ExternalWalletBankModel.md)
146
+
147
+ ### Authorization
148
+
149
+ [BearerAuth](../README.md#BearerAuth), [oauth2](../README.md#oauth2)
150
+
151
+ ### HTTP request headers
152
+
153
+ - **Content-Type**: Not defined
154
+ - **Accept**: application/json
155
+
156
+
157
+ ## get_external_wallet
158
+
159
+ > <ExternalWalletBankModel> get_external_wallet(external_wallet_guid)
160
+
161
+ Get External Wallet
162
+
163
+ Retrieves an external_wallet. Required scope: **external_wallets:read**
164
+
165
+ ### Examples
166
+
167
+ ```ruby
168
+ require 'time'
169
+ require 'cybrid_api_bank_ruby'
170
+ # setup authorization
171
+ CybridApiBank.configure do |config|
172
+ # Configure Bearer authorization (JWT): BearerAuth
173
+ config.access_token = 'YOUR_BEARER_TOKEN'
174
+
175
+ # Configure OAuth2 access token for authorization: oauth2
176
+ config.access_token = 'YOUR ACCESS TOKEN'
177
+ end
178
+
179
+ api_instance = CybridApiBank::ExternalWalletsBankApi.new
180
+ external_wallet_guid = 'external_wallet_guid_example' # String | Identifier for the external_wallet.
181
+
182
+ begin
183
+ # Get External Wallet
184
+ result = api_instance.get_external_wallet(external_wallet_guid)
185
+ p result
186
+ rescue CybridApiBank::ApiError => e
187
+ puts "Error when calling ExternalWalletsBankApi->get_external_wallet: #{e}"
188
+ end
189
+ ```
190
+
191
+ #### Using the get_external_wallet_with_http_info variant
192
+
193
+ This returns an Array which contains the response data, status code and headers.
194
+
195
+ > <Array(<ExternalWalletBankModel>, Integer, Hash)> get_external_wallet_with_http_info(external_wallet_guid)
196
+
197
+ ```ruby
198
+ begin
199
+ # Get External Wallet
200
+ data, status_code, headers = api_instance.get_external_wallet_with_http_info(external_wallet_guid)
201
+ p status_code # => 2xx
202
+ p headers # => { ... }
203
+ p data # => <ExternalWalletBankModel>
204
+ rescue CybridApiBank::ApiError => e
205
+ puts "Error when calling ExternalWalletsBankApi->get_external_wallet_with_http_info: #{e}"
206
+ end
207
+ ```
208
+
209
+ ### Parameters
210
+
211
+ | Name | Type | Description | Notes |
212
+ | ---- | ---- | ----------- | ----- |
213
+ | **external_wallet_guid** | **String** | Identifier for the external_wallet. | |
214
+
215
+ ### Return type
216
+
217
+ [**ExternalWalletBankModel**](ExternalWalletBankModel.md)
218
+
219
+ ### Authorization
220
+
221
+ [BearerAuth](../README.md#BearerAuth), [oauth2](../README.md#oauth2)
222
+
223
+ ### HTTP request headers
224
+
225
+ - **Content-Type**: Not defined
226
+ - **Accept**: application/json
227
+
228
+
229
+ ## list_external_wallets
230
+
231
+ > <ExternalWalletListBankModel> list_external_wallets(opts)
232
+
233
+ Get external wallets list
234
+
235
+ Retrieves a listing of external wallets. Required scope: **external_wallets:read**
236
+
237
+ ### Examples
238
+
239
+ ```ruby
240
+ require 'time'
241
+ require 'cybrid_api_bank_ruby'
242
+ # setup authorization
243
+ CybridApiBank.configure do |config|
244
+ # Configure Bearer authorization (JWT): BearerAuth
245
+ config.access_token = 'YOUR_BEARER_TOKEN'
246
+
247
+ # Configure OAuth2 access token for authorization: oauth2
248
+ config.access_token = 'YOUR ACCESS TOKEN'
249
+ end
250
+
251
+ api_instance = CybridApiBank::ExternalWalletsBankApi.new
252
+ opts = {
253
+ page: 56, # Integer | The page index to retrieve.
254
+ per_page: 56, # Integer | The number of entities per page to return.
255
+ guid: 'guid_example', # String | Comma separated external_wallet_guids to list external_wallets for.
256
+ bank_guid: 'bank_guid_example', # String | Comma separated bank_guids to list external_wallets for.
257
+ customer_guid: 'customer_guid_example' # String | Comma separated customer_guids to list external_wallets for.
258
+ }
259
+
260
+ begin
261
+ # Get external wallets list
262
+ result = api_instance.list_external_wallets(opts)
263
+ p result
264
+ rescue CybridApiBank::ApiError => e
265
+ puts "Error when calling ExternalWalletsBankApi->list_external_wallets: #{e}"
266
+ end
267
+ ```
268
+
269
+ #### Using the list_external_wallets_with_http_info variant
270
+
271
+ This returns an Array which contains the response data, status code and headers.
272
+
273
+ > <Array(<ExternalWalletListBankModel>, Integer, Hash)> list_external_wallets_with_http_info(opts)
274
+
275
+ ```ruby
276
+ begin
277
+ # Get external wallets list
278
+ data, status_code, headers = api_instance.list_external_wallets_with_http_info(opts)
279
+ p status_code # => 2xx
280
+ p headers # => { ... }
281
+ p data # => <ExternalWalletListBankModel>
282
+ rescue CybridApiBank::ApiError => e
283
+ puts "Error when calling ExternalWalletsBankApi->list_external_wallets_with_http_info: #{e}"
284
+ end
285
+ ```
286
+
287
+ ### Parameters
288
+
289
+ | Name | Type | Description | Notes |
290
+ | ---- | ---- | ----------- | ----- |
291
+ | **page** | **Integer** | The page index to retrieve. | [optional] |
292
+ | **per_page** | **Integer** | The number of entities per page to return. | [optional] |
293
+ | **guid** | **String** | Comma separated external_wallet_guids to list external_wallets for. | [optional] |
294
+ | **bank_guid** | **String** | Comma separated bank_guids to list external_wallets for. | [optional] |
295
+ | **customer_guid** | **String** | Comma separated customer_guids to list external_wallets for. | [optional] |
296
+
297
+ ### Return type
298
+
299
+ [**ExternalWalletListBankModel**](ExternalWalletListBankModel.md)
300
+
301
+ ### Authorization
302
+
303
+ [BearerAuth](../README.md#BearerAuth), [oauth2](../README.md#oauth2)
304
+
305
+ ### HTTP request headers
306
+
307
+ - **Content-Type**: Not defined
308
+ - **Accept**: application/json
309
+
@@ -0,0 +1,26 @@
1
+ # CybridApiBank::PostExternalWalletBankModel
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **name** | **String** | The name of the account. | |
8
+ | **customer_guid** | **String** | The customer identifier. | |
9
+ | **asset** | **String** | The asset code. | |
10
+ | **address** | **String** | The blockchain wallet address for the wallet. | |
11
+ | **tag** | **String** | The blockchain tag to use when transferring crypto to the wallet. | [optional] |
12
+
13
+ ## Example
14
+
15
+ ```ruby
16
+ require 'cybrid_api_bank_ruby'
17
+
18
+ instance = CybridApiBank::PostExternalWalletBankModel.new(
19
+ name: null,
20
+ customer_guid: null,
21
+ asset: null,
22
+ address: null,
23
+ tag: null
24
+ )
25
+ ```
26
+
@@ -6,6 +6,7 @@
6
6
  | ---- | ---- | ----------- | ----- |
7
7
  | **quote_guid** | **String** | The associated quote&#39;s identifier. | |
8
8
  | **transfer_type** | **String** | The type of transfer. | |
9
+ | **external_wallet_guid** | **String** | The customer&#39;s external wallet&#39;s identifier. | [optional] |
9
10
  | **external_bank_account_guid** | **String** | The customer&#39;s &#39;plaid&#39; or &#39;plaid_processor_token&#39; external bank account&#39;s identifier. | [optional] |
10
11
  | **one_time_address** | [**PostOneTimeAddressBankModel**](PostOneTimeAddressBankModel.md) | | [optional] |
11
12
  | **expected_error** | **String** | The optional expected error to simulate transfer failure. | [optional] |
@@ -18,6 +19,7 @@ require 'cybrid_api_bank_ruby'
18
19
  instance = CybridApiBank::PostTransferBankModel.new(
19
20
  quote_guid: null,
20
21
  transfer_type: null,
22
+ external_wallet_guid: null,
21
23
  external_bank_account_guid: null,
22
24
  one_time_address: null,
23
25
  expected_error: null