cybrid_api_bank_ruby 0.110.6 → 0.110.9

Sign up to get free protection for your applications and to get access to all the features.
Files changed (282) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile.lock +2 -2
  3. data/README.md +5 -5
  4. data/cybrid_api_bank_ruby.gemspec +1 -1
  5. data/lib/cybrid_api_bank_ruby/api/accounts_bank_api.rb +1 -1
  6. data/lib/cybrid_api_bank_ruby/api/assets_bank_api.rb +1 -1
  7. data/lib/cybrid_api_bank_ruby/api/banks_bank_api.rb +1 -1
  8. data/lib/cybrid_api_bank_ruby/api/customers_bank_api.rb +1 -1
  9. data/lib/cybrid_api_bank_ruby/api/deposit_addresses_bank_api.rb +1 -1
  10. data/lib/cybrid_api_bank_ruby/api/deposit_bank_accounts_bank_api.rb +1 -1
  11. data/lib/cybrid_api_bank_ruby/api/external_bank_accounts_bank_api.rb +1 -1
  12. data/lib/cybrid_api_bank_ruby/api/external_wallets_bank_api.rb +1 -1
  13. data/lib/cybrid_api_bank_ruby/api/identity_verifications_bank_api.rb +1 -1
  14. data/lib/cybrid_api_bank_ruby/api/prices_bank_api.rb +1 -1
  15. data/lib/cybrid_api_bank_ruby/api/quotes_bank_api.rb +1 -1
  16. data/lib/cybrid_api_bank_ruby/api/symbols_bank_api.rb +1 -1
  17. data/lib/cybrid_api_bank_ruby/api/trades_bank_api.rb +1 -1
  18. data/lib/cybrid_api_bank_ruby/api/transfers_bank_api.rb +1 -1
  19. data/lib/cybrid_api_bank_ruby/api/workflows_bank_api.rb +1 -1
  20. data/lib/cybrid_api_bank_ruby/api_client.rb +1 -1
  21. data/lib/cybrid_api_bank_ruby/api_error.rb +1 -1
  22. data/lib/cybrid_api_bank_ruby/configuration.rb +1 -1
  23. data/lib/cybrid_api_bank_ruby/models/account_bank_model.rb +1 -1
  24. data/lib/cybrid_api_bank_ruby/models/account_list_bank_model.rb +1 -1
  25. data/lib/cybrid_api_bank_ruby/models/asset_bank_model.rb +1 -1
  26. data/lib/cybrid_api_bank_ruby/models/asset_list_bank_model.rb +1 -1
  27. data/lib/cybrid_api_bank_ruby/models/bank_bank_model.rb +1 -1
  28. data/lib/cybrid_api_bank_ruby/models/bank_list_bank_model.rb +1 -1
  29. data/lib/cybrid_api_bank_ruby/models/customer_address_bank_model.rb +1 -1
  30. data/lib/cybrid_api_bank_ruby/models/customer_bank_model.rb +1 -1
  31. data/lib/cybrid_api_bank_ruby/models/customer_list_bank_model.rb +1 -1
  32. data/lib/cybrid_api_bank_ruby/models/customer_name_bank_model.rb +1 -1
  33. data/lib/cybrid_api_bank_ruby/models/deposit_address_bank_model.rb +1 -1
  34. data/lib/cybrid_api_bank_ruby/models/deposit_address_list_bank_model.rb +1 -1
  35. data/lib/cybrid_api_bank_ruby/models/deposit_bank_account_account_details_inner_bank_model.rb +1 -1
  36. data/lib/cybrid_api_bank_ruby/models/deposit_bank_account_bank_model.rb +1 -1
  37. data/lib/cybrid_api_bank_ruby/models/deposit_bank_account_counterparty_address_bank_model.rb +1 -1
  38. data/lib/cybrid_api_bank_ruby/models/deposit_bank_account_list_bank_model.rb +1 -1
  39. data/lib/cybrid_api_bank_ruby/models/deposit_bank_account_routing_details_inner_bank_model.rb +1 -1
  40. data/lib/cybrid_api_bank_ruby/models/error_response_bank_model.rb +1 -1
  41. data/lib/cybrid_api_bank_ruby/models/external_bank_account_balances_bank_model.rb +1 -1
  42. data/lib/cybrid_api_bank_ruby/models/external_bank_account_bank_model.rb +1 -1
  43. data/lib/cybrid_api_bank_ruby/models/external_bank_account_list_bank_model.rb +1 -1
  44. data/lib/cybrid_api_bank_ruby/models/external_bank_account_pii_inner_addresses_inner_bank_model.rb +1 -1
  45. data/lib/cybrid_api_bank_ruby/models/external_bank_account_pii_inner_bank_model.rb +1 -1
  46. data/lib/cybrid_api_bank_ruby/models/external_wallet_bank_model.rb +1 -1
  47. data/lib/cybrid_api_bank_ruby/models/external_wallet_list_bank_model.rb +1 -1
  48. data/lib/cybrid_api_bank_ruby/models/identity_verification_bank_model.rb +1 -1
  49. data/lib/cybrid_api_bank_ruby/models/identity_verification_list_bank_model.rb +1 -1
  50. data/lib/cybrid_api_bank_ruby/models/identity_verification_with_details_all_of_bank_model.rb +1 -1
  51. data/lib/cybrid_api_bank_ruby/models/identity_verification_with_details_bank_model.rb +1 -1
  52. data/lib/cybrid_api_bank_ruby/models/list_request_owner_bank_model.rb +1 -1
  53. data/lib/cybrid_api_bank_ruby/models/patch_bank_bank_model.rb +1 -1
  54. data/lib/cybrid_api_bank_ruby/models/patch_customer_bank_model.rb +1 -1
  55. data/lib/cybrid_api_bank_ruby/models/patch_external_bank_account_bank_model.rb +1 -1
  56. data/lib/cybrid_api_bank_ruby/models/post_account_bank_model.rb +1 -1
  57. data/lib/cybrid_api_bank_ruby/models/post_bank_bank_model.rb +1 -1
  58. data/lib/cybrid_api_bank_ruby/models/post_customer_address_bank_model.rb +1 -1
  59. data/lib/cybrid_api_bank_ruby/models/post_customer_bank_model.rb +1 -1
  60. data/lib/cybrid_api_bank_ruby/models/post_customer_name_bank_model.rb +1 -1
  61. data/lib/cybrid_api_bank_ruby/models/post_deposit_address_bank_model.rb +1 -1
  62. data/lib/cybrid_api_bank_ruby/models/post_deposit_bank_account_bank_model.rb +1 -1
  63. data/lib/cybrid_api_bank_ruby/models/post_external_bank_account_bank_model.rb +1 -1
  64. data/lib/cybrid_api_bank_ruby/models/post_external_bank_account_counterparty_address_bank_model.rb +1 -1
  65. data/lib/cybrid_api_bank_ruby/models/post_external_bank_account_counterparty_bank_account_bank_model.rb +1 -1
  66. data/lib/cybrid_api_bank_ruby/models/post_external_bank_account_counterparty_name_bank_model.rb +1 -1
  67. data/lib/cybrid_api_bank_ruby/models/post_external_wallet_bank_model.rb +1 -1
  68. data/lib/cybrid_api_bank_ruby/models/post_identification_number_bank_model.rb +1 -1
  69. data/lib/cybrid_api_bank_ruby/models/post_identity_verification_address_bank_model.rb +1 -1
  70. data/lib/cybrid_api_bank_ruby/models/post_identity_verification_bank_model.rb +1 -1
  71. data/lib/cybrid_api_bank_ruby/models/post_identity_verification_name_bank_model.rb +1 -1
  72. data/lib/cybrid_api_bank_ruby/models/post_quote_bank_model.rb +1 -1
  73. data/lib/cybrid_api_bank_ruby/models/post_trade_bank_model.rb +1 -1
  74. data/lib/cybrid_api_bank_ruby/models/post_transfer_bank_model.rb +1 -1
  75. data/lib/cybrid_api_bank_ruby/models/post_workflow_bank_model.rb +1 -1
  76. data/lib/cybrid_api_bank_ruby/models/quote_bank_model.rb +1 -1
  77. data/lib/cybrid_api_bank_ruby/models/quote_list_bank_model.rb +1 -1
  78. data/lib/cybrid_api_bank_ruby/models/symbol_price_bank_model.rb +1 -1
  79. data/lib/cybrid_api_bank_ruby/models/trade_bank_model.rb +1 -1
  80. data/lib/cybrid_api_bank_ruby/models/trade_list_bank_model.rb +1 -1
  81. data/lib/cybrid_api_bank_ruby/models/transfer_bank_model.rb +1 -1
  82. data/lib/cybrid_api_bank_ruby/models/transfer_destination_account_bank_model.rb +1 -1
  83. data/lib/cybrid_api_bank_ruby/models/transfer_list_bank_model.rb +1 -1
  84. data/lib/cybrid_api_bank_ruby/models/transfer_source_account_bank_model.rb +1 -1
  85. data/lib/cybrid_api_bank_ruby/models/workflow_bank_model.rb +1 -1
  86. data/lib/cybrid_api_bank_ruby/models/workflow_with_details_all_of_bank_model.rb +1 -1
  87. data/lib/cybrid_api_bank_ruby/models/workflow_with_details_bank_model.rb +1 -1
  88. data/lib/cybrid_api_bank_ruby/models/workflows_list_bank_model.rb +1 -1
  89. data/lib/cybrid_api_bank_ruby/version.rb +2 -2
  90. data/lib/cybrid_api_bank_ruby.rb +1 -1
  91. data/spec/api/accounts_bank_api_spec.rb +1 -1
  92. data/spec/api/assets_bank_api_spec.rb +1 -1
  93. data/spec/api/banks_bank_api_spec.rb +1 -1
  94. data/spec/api/customers_bank_api_spec.rb +1 -1
  95. data/spec/api/deposit_addresses_bank_api_spec.rb +1 -1
  96. data/spec/api/deposit_bank_accounts_bank_api_spec.rb +1 -1
  97. data/spec/api/external_bank_accounts_bank_api_spec.rb +1 -1
  98. data/spec/api/external_wallets_bank_api_spec.rb +1 -1
  99. data/spec/api/identity_verifications_bank_api_spec.rb +1 -1
  100. data/spec/api/prices_bank_api_spec.rb +1 -1
  101. data/spec/api/quotes_bank_api_spec.rb +1 -1
  102. data/spec/api/symbols_bank_api_spec.rb +1 -1
  103. data/spec/api/trades_bank_api_spec.rb +1 -1
  104. data/spec/api/transfers_bank_api_spec.rb +1 -1
  105. data/spec/api/workflows_bank_api_spec.rb +1 -1
  106. data/spec/api_client_spec.rb +1 -1
  107. data/spec/configuration_spec.rb +1 -1
  108. data/spec/models/account_bank_model_spec.rb +1 -1
  109. data/spec/models/account_list_bank_model_spec.rb +1 -1
  110. data/spec/models/asset_bank_model_spec.rb +1 -1
  111. data/spec/models/asset_list_bank_model_spec.rb +1 -1
  112. data/spec/models/bank_bank_model_spec.rb +1 -1
  113. data/spec/models/bank_list_bank_model_spec.rb +1 -1
  114. data/spec/models/customer_address_bank_model_spec.rb +1 -1
  115. data/spec/models/customer_bank_model_spec.rb +1 -1
  116. data/spec/models/customer_list_bank_model_spec.rb +1 -1
  117. data/spec/models/customer_name_bank_model_spec.rb +1 -1
  118. data/spec/models/deposit_address_bank_model_spec.rb +1 -1
  119. data/spec/models/deposit_address_list_bank_model_spec.rb +1 -1
  120. data/spec/models/deposit_bank_account_account_details_inner_bank_model_spec.rb +1 -1
  121. data/spec/models/deposit_bank_account_bank_model_spec.rb +1 -1
  122. data/spec/models/deposit_bank_account_counterparty_address_bank_model_spec.rb +1 -1
  123. data/spec/models/deposit_bank_account_list_bank_model_spec.rb +1 -1
  124. data/spec/models/deposit_bank_account_routing_details_inner_bank_model_spec.rb +1 -1
  125. data/spec/models/error_response_bank_model_spec.rb +1 -1
  126. data/spec/models/external_bank_account_balances_bank_model_spec.rb +1 -1
  127. data/spec/models/external_bank_account_bank_model_spec.rb +1 -1
  128. data/spec/models/external_bank_account_list_bank_model_spec.rb +1 -1
  129. data/spec/models/external_bank_account_pii_inner_addresses_inner_bank_model_spec.rb +1 -1
  130. data/spec/models/external_bank_account_pii_inner_bank_model_spec.rb +1 -1
  131. data/spec/models/external_wallet_bank_model_spec.rb +1 -1
  132. data/spec/models/external_wallet_list_bank_model_spec.rb +1 -1
  133. data/spec/models/identity_verification_bank_model_spec.rb +1 -1
  134. data/spec/models/identity_verification_list_bank_model_spec.rb +1 -1
  135. data/spec/models/identity_verification_with_details_all_of_bank_model_spec.rb +1 -1
  136. data/spec/models/identity_verification_with_details_bank_model_spec.rb +1 -1
  137. data/spec/models/list_request_owner_bank_model_spec.rb +1 -1
  138. data/spec/models/patch_bank_bank_model_spec.rb +1 -1
  139. data/spec/models/patch_customer_bank_model_spec.rb +1 -1
  140. data/spec/models/patch_external_bank_account_bank_model_spec.rb +1 -1
  141. data/spec/models/post_account_bank_model_spec.rb +1 -1
  142. data/spec/models/post_bank_bank_model_spec.rb +1 -1
  143. data/spec/models/post_customer_address_bank_model_spec.rb +1 -1
  144. data/spec/models/post_customer_bank_model_spec.rb +1 -1
  145. data/spec/models/post_customer_name_bank_model_spec.rb +1 -1
  146. data/spec/models/post_deposit_address_bank_model_spec.rb +1 -1
  147. data/spec/models/post_deposit_bank_account_bank_model_spec.rb +1 -1
  148. data/spec/models/post_external_bank_account_bank_model_spec.rb +1 -1
  149. data/spec/models/post_external_bank_account_counterparty_address_bank_model_spec.rb +1 -1
  150. data/spec/models/post_external_bank_account_counterparty_bank_account_bank_model_spec.rb +1 -1
  151. data/spec/models/post_external_bank_account_counterparty_name_bank_model_spec.rb +1 -1
  152. data/spec/models/post_external_wallet_bank_model_spec.rb +1 -1
  153. data/spec/models/post_identification_number_bank_model_spec.rb +1 -1
  154. data/spec/models/post_identity_verification_address_bank_model_spec.rb +1 -1
  155. data/spec/models/post_identity_verification_bank_model_spec.rb +1 -1
  156. data/spec/models/post_identity_verification_name_bank_model_spec.rb +1 -1
  157. data/spec/models/post_quote_bank_model_spec.rb +1 -1
  158. data/spec/models/post_trade_bank_model_spec.rb +1 -1
  159. data/spec/models/post_transfer_bank_model_spec.rb +1 -1
  160. data/spec/models/post_workflow_bank_model_spec.rb +1 -1
  161. data/spec/models/quote_bank_model_spec.rb +1 -1
  162. data/spec/models/quote_list_bank_model_spec.rb +1 -1
  163. data/spec/models/symbol_price_bank_model_spec.rb +1 -1
  164. data/spec/models/trade_bank_model_spec.rb +1 -1
  165. data/spec/models/trade_list_bank_model_spec.rb +1 -1
  166. data/spec/models/transfer_bank_model_spec.rb +1 -1
  167. data/spec/models/transfer_destination_account_bank_model_spec.rb +1 -1
  168. data/spec/models/transfer_list_bank_model_spec.rb +1 -1
  169. data/spec/models/transfer_source_account_bank_model_spec.rb +1 -1
  170. data/spec/models/workflow_bank_model_spec.rb +1 -1
  171. data/spec/models/workflow_with_details_all_of_bank_model_spec.rb +1 -1
  172. data/spec/models/workflow_with_details_bank_model_spec.rb +1 -1
  173. data/spec/models/workflows_list_bank_model_spec.rb +1 -1
  174. data/spec/spec_helper.rb +1 -1
  175. data/vendor/bundle/ruby/3.2.0/cache/typhoeus-1.4.1.gem +0 -0
  176. data/vendor/bundle/ruby/3.2.0/extensions/x86_64-linux/3.2.0/byebug-11.1.3/gem_make.out +5 -5
  177. data/vendor/bundle/ruby/3.2.0/extensions/x86_64-linux/3.2.0/ffi-1.16.3/gem_make.out +5 -5
  178. data/vendor/bundle/ruby/3.2.0/extensions/x86_64-linux/3.2.0/jaro_winkler-1.5.6/gem_make.out +5 -5
  179. data/vendor/bundle/ruby/3.2.0/extensions/x86_64-linux/3.2.0/psych-5.1.1.1/gem_make.out +5 -5
  180. data/vendor/bundle/ruby/3.2.0/extensions/x86_64-linux/3.2.0/racc-1.7.3/gem_make.out +5 -5
  181. data/vendor/bundle/ruby/3.2.0/extensions/x86_64-linux/3.2.0/stringio-3.0.9/gem_make.out +5 -5
  182. data/vendor/bundle/ruby/3.2.0/gems/typhoeus-1.4.1/.github/workflows/ci.yml +30 -0
  183. data/vendor/bundle/ruby/3.2.0/gems/typhoeus-1.4.1/.github/workflows/experimental.yml +33 -0
  184. data/vendor/bundle/ruby/3.2.0/gems/{typhoeus-1.4.0 → typhoeus-1.4.1}/CHANGELOG.md +5 -1
  185. data/vendor/bundle/ruby/3.2.0/gems/{typhoeus-1.4.0 → typhoeus-1.4.1}/Gemfile +5 -1
  186. data/vendor/bundle/ruby/3.2.0/gems/{typhoeus-1.4.0 → typhoeus-1.4.1}/README.md +10 -6
  187. data/vendor/bundle/ruby/3.2.0/gems/{typhoeus-1.4.0 → typhoeus-1.4.1}/lib/typhoeus/config.rb +16 -0
  188. data/vendor/bundle/ruby/3.2.0/gems/{typhoeus-1.4.0 → typhoeus-1.4.1}/lib/typhoeus/easy_factory.rb +26 -0
  189. data/vendor/bundle/ruby/3.2.0/gems/{typhoeus-1.4.0 → typhoeus-1.4.1}/lib/typhoeus/request.rb +2 -0
  190. data/vendor/bundle/ruby/3.2.0/gems/{typhoeus-1.4.0 → typhoeus-1.4.1}/lib/typhoeus/response/informations.rb +57 -0
  191. data/vendor/bundle/ruby/3.2.0/gems/{typhoeus-1.4.0 → typhoeus-1.4.1}/lib/typhoeus/version.rb +1 -1
  192. data/vendor/bundle/ruby/3.2.0/gems/{typhoeus-1.4.0 → typhoeus-1.4.1}/spec/typhoeus/request_spec.rb +25 -1
  193. data/vendor/bundle/ruby/3.2.0/gems/{typhoeus-1.4.0 → typhoeus-1.4.1}/spec/typhoeus/response/informations_spec.rb +40 -0
  194. data/vendor/bundle/ruby/3.2.0/specifications/{typhoeus-1.4.0.gemspec → typhoeus-1.4.1.gemspec} +3 -3
  195. metadata +101 -100
  196. data/vendor/bundle/ruby/3.2.0/cache/typhoeus-1.4.0.gem +0 -0
  197. data/vendor/bundle/ruby/3.2.0/gems/typhoeus-1.4.0/.travis.yml +0 -26
  198. /data/vendor/bundle/ruby/3.2.0/gems/{typhoeus-1.4.0 → typhoeus-1.4.1}/.gitignore +0 -0
  199. /data/vendor/bundle/ruby/3.2.0/gems/{typhoeus-1.4.0 → typhoeus-1.4.1}/.rspec +0 -0
  200. /data/vendor/bundle/ruby/3.2.0/gems/{typhoeus-1.4.0 → typhoeus-1.4.1}/CONTRIBUTING.md +0 -0
  201. /data/vendor/bundle/ruby/3.2.0/gems/{typhoeus-1.4.0 → typhoeus-1.4.1}/Guardfile +0 -0
  202. /data/vendor/bundle/ruby/3.2.0/gems/{typhoeus-1.4.0 → typhoeus-1.4.1}/LICENSE +0 -0
  203. /data/vendor/bundle/ruby/3.2.0/gems/{typhoeus-1.4.0 → typhoeus-1.4.1}/Rakefile +0 -0
  204. /data/vendor/bundle/ruby/3.2.0/gems/{typhoeus-1.4.0 → typhoeus-1.4.1}/UPGRADE.md +0 -0
  205. /data/vendor/bundle/ruby/3.2.0/gems/{typhoeus-1.4.0 → typhoeus-1.4.1}/lib/rack/typhoeus/middleware/params_decoder/helper.rb +0 -0
  206. /data/vendor/bundle/ruby/3.2.0/gems/{typhoeus-1.4.0 → typhoeus-1.4.1}/lib/rack/typhoeus/middleware/params_decoder.rb +0 -0
  207. /data/vendor/bundle/ruby/3.2.0/gems/{typhoeus-1.4.0 → typhoeus-1.4.1}/lib/rack/typhoeus.rb +0 -0
  208. /data/vendor/bundle/ruby/3.2.0/gems/{typhoeus-1.4.0 → typhoeus-1.4.1}/lib/typhoeus/adapters/faraday.rb +0 -0
  209. /data/vendor/bundle/ruby/3.2.0/gems/{typhoeus-1.4.0 → typhoeus-1.4.1}/lib/typhoeus/cache/dalli.rb +0 -0
  210. /data/vendor/bundle/ruby/3.2.0/gems/{typhoeus-1.4.0 → typhoeus-1.4.1}/lib/typhoeus/cache/rails.rb +0 -0
  211. /data/vendor/bundle/ruby/3.2.0/gems/{typhoeus-1.4.0 → typhoeus-1.4.1}/lib/typhoeus/cache/redis.rb +0 -0
  212. /data/vendor/bundle/ruby/3.2.0/gems/{typhoeus-1.4.0 → typhoeus-1.4.1}/lib/typhoeus/errors/no_stub.rb +0 -0
  213. /data/vendor/bundle/ruby/3.2.0/gems/{typhoeus-1.4.0 → typhoeus-1.4.1}/lib/typhoeus/errors/typhoeus_error.rb +0 -0
  214. /data/vendor/bundle/ruby/3.2.0/gems/{typhoeus-1.4.0 → typhoeus-1.4.1}/lib/typhoeus/errors.rb +0 -0
  215. /data/vendor/bundle/ruby/3.2.0/gems/{typhoeus-1.4.0 → typhoeus-1.4.1}/lib/typhoeus/expectation.rb +0 -0
  216. /data/vendor/bundle/ruby/3.2.0/gems/{typhoeus-1.4.0 → typhoeus-1.4.1}/lib/typhoeus/hydra/addable.rb +0 -0
  217. /data/vendor/bundle/ruby/3.2.0/gems/{typhoeus-1.4.0 → typhoeus-1.4.1}/lib/typhoeus/hydra/before.rb +0 -0
  218. /data/vendor/bundle/ruby/3.2.0/gems/{typhoeus-1.4.0 → typhoeus-1.4.1}/lib/typhoeus/hydra/block_connection.rb +0 -0
  219. /data/vendor/bundle/ruby/3.2.0/gems/{typhoeus-1.4.0 → typhoeus-1.4.1}/lib/typhoeus/hydra/cacheable.rb +0 -0
  220. /data/vendor/bundle/ruby/3.2.0/gems/{typhoeus-1.4.0 → typhoeus-1.4.1}/lib/typhoeus/hydra/memoizable.rb +0 -0
  221. /data/vendor/bundle/ruby/3.2.0/gems/{typhoeus-1.4.0 → typhoeus-1.4.1}/lib/typhoeus/hydra/queueable.rb +0 -0
  222. /data/vendor/bundle/ruby/3.2.0/gems/{typhoeus-1.4.0 → typhoeus-1.4.1}/lib/typhoeus/hydra/runnable.rb +0 -0
  223. /data/vendor/bundle/ruby/3.2.0/gems/{typhoeus-1.4.0 → typhoeus-1.4.1}/lib/typhoeus/hydra/stubbable.rb +0 -0
  224. /data/vendor/bundle/ruby/3.2.0/gems/{typhoeus-1.4.0 → typhoeus-1.4.1}/lib/typhoeus/hydra.rb +0 -0
  225. /data/vendor/bundle/ruby/3.2.0/gems/{typhoeus-1.4.0 → typhoeus-1.4.1}/lib/typhoeus/pool.rb +0 -0
  226. /data/vendor/bundle/ruby/3.2.0/gems/{typhoeus-1.4.0 → typhoeus-1.4.1}/lib/typhoeus/railtie.rb +0 -0
  227. /data/vendor/bundle/ruby/3.2.0/gems/{typhoeus-1.4.0 → typhoeus-1.4.1}/lib/typhoeus/request/actions.rb +0 -0
  228. /data/vendor/bundle/ruby/3.2.0/gems/{typhoeus-1.4.0 → typhoeus-1.4.1}/lib/typhoeus/request/before.rb +0 -0
  229. /data/vendor/bundle/ruby/3.2.0/gems/{typhoeus-1.4.0 → typhoeus-1.4.1}/lib/typhoeus/request/block_connection.rb +0 -0
  230. /data/vendor/bundle/ruby/3.2.0/gems/{typhoeus-1.4.0 → typhoeus-1.4.1}/lib/typhoeus/request/cacheable.rb +0 -0
  231. /data/vendor/bundle/ruby/3.2.0/gems/{typhoeus-1.4.0 → typhoeus-1.4.1}/lib/typhoeus/request/callbacks.rb +0 -0
  232. /data/vendor/bundle/ruby/3.2.0/gems/{typhoeus-1.4.0 → typhoeus-1.4.1}/lib/typhoeus/request/marshal.rb +0 -0
  233. /data/vendor/bundle/ruby/3.2.0/gems/{typhoeus-1.4.0 → typhoeus-1.4.1}/lib/typhoeus/request/memoizable.rb +0 -0
  234. /data/vendor/bundle/ruby/3.2.0/gems/{typhoeus-1.4.0 → typhoeus-1.4.1}/lib/typhoeus/request/operations.rb +0 -0
  235. /data/vendor/bundle/ruby/3.2.0/gems/{typhoeus-1.4.0 → typhoeus-1.4.1}/lib/typhoeus/request/responseable.rb +0 -0
  236. /data/vendor/bundle/ruby/3.2.0/gems/{typhoeus-1.4.0 → typhoeus-1.4.1}/lib/typhoeus/request/streamable.rb +0 -0
  237. /data/vendor/bundle/ruby/3.2.0/gems/{typhoeus-1.4.0 → typhoeus-1.4.1}/lib/typhoeus/request/stubbable.rb +0 -0
  238. /data/vendor/bundle/ruby/3.2.0/gems/{typhoeus-1.4.0 → typhoeus-1.4.1}/lib/typhoeus/response/cacheable.rb +0 -0
  239. /data/vendor/bundle/ruby/3.2.0/gems/{typhoeus-1.4.0 → typhoeus-1.4.1}/lib/typhoeus/response/header.rb +0 -0
  240. /data/vendor/bundle/ruby/3.2.0/gems/{typhoeus-1.4.0 → typhoeus-1.4.1}/lib/typhoeus/response/status.rb +0 -0
  241. /data/vendor/bundle/ruby/3.2.0/gems/{typhoeus-1.4.0 → typhoeus-1.4.1}/lib/typhoeus/response.rb +0 -0
  242. /data/vendor/bundle/ruby/3.2.0/gems/{typhoeus-1.4.0 → typhoeus-1.4.1}/lib/typhoeus.rb +0 -0
  243. /data/vendor/bundle/ruby/3.2.0/gems/{typhoeus-1.4.0 → typhoeus-1.4.1}/perf/profile.rb +0 -0
  244. /data/vendor/bundle/ruby/3.2.0/gems/{typhoeus-1.4.0 → typhoeus-1.4.1}/perf/vs_nethttp.rb +0 -0
  245. /data/vendor/bundle/ruby/3.2.0/gems/{typhoeus-1.4.0 → typhoeus-1.4.1}/spec/rack/typhoeus/middleware/params_decoder/helper_spec.rb +0 -0
  246. /data/vendor/bundle/ruby/3.2.0/gems/{typhoeus-1.4.0 → typhoeus-1.4.1}/spec/rack/typhoeus/middleware/params_decoder_spec.rb +0 -0
  247. /data/vendor/bundle/ruby/3.2.0/gems/{typhoeus-1.4.0 → typhoeus-1.4.1}/spec/spec_helper.rb +0 -0
  248. /data/vendor/bundle/ruby/3.2.0/gems/{typhoeus-1.4.0 → typhoeus-1.4.1}/spec/support/localhost_server.rb +0 -0
  249. /data/vendor/bundle/ruby/3.2.0/gems/{typhoeus-1.4.0 → typhoeus-1.4.1}/spec/support/memory_cache.rb +0 -0
  250. /data/vendor/bundle/ruby/3.2.0/gems/{typhoeus-1.4.0 → typhoeus-1.4.1}/spec/support/server.rb +0 -0
  251. /data/vendor/bundle/ruby/3.2.0/gems/{typhoeus-1.4.0 → typhoeus-1.4.1}/spec/typhoeus/adapters/faraday_spec.rb +0 -0
  252. /data/vendor/bundle/ruby/3.2.0/gems/{typhoeus-1.4.0 → typhoeus-1.4.1}/spec/typhoeus/cache/dalli_spec.rb +0 -0
  253. /data/vendor/bundle/ruby/3.2.0/gems/{typhoeus-1.4.0 → typhoeus-1.4.1}/spec/typhoeus/cache/redis_spec.rb +0 -0
  254. /data/vendor/bundle/ruby/3.2.0/gems/{typhoeus-1.4.0 → typhoeus-1.4.1}/spec/typhoeus/config_spec.rb +0 -0
  255. /data/vendor/bundle/ruby/3.2.0/gems/{typhoeus-1.4.0 → typhoeus-1.4.1}/spec/typhoeus/easy_factory_spec.rb +0 -0
  256. /data/vendor/bundle/ruby/3.2.0/gems/{typhoeus-1.4.0 → typhoeus-1.4.1}/spec/typhoeus/errors/no_stub_spec.rb +0 -0
  257. /data/vendor/bundle/ruby/3.2.0/gems/{typhoeus-1.4.0 → typhoeus-1.4.1}/spec/typhoeus/expectation_spec.rb +0 -0
  258. /data/vendor/bundle/ruby/3.2.0/gems/{typhoeus-1.4.0 → typhoeus-1.4.1}/spec/typhoeus/hydra/addable_spec.rb +0 -0
  259. /data/vendor/bundle/ruby/3.2.0/gems/{typhoeus-1.4.0 → typhoeus-1.4.1}/spec/typhoeus/hydra/before_spec.rb +0 -0
  260. /data/vendor/bundle/ruby/3.2.0/gems/{typhoeus-1.4.0 → typhoeus-1.4.1}/spec/typhoeus/hydra/block_connection_spec.rb +0 -0
  261. /data/vendor/bundle/ruby/3.2.0/gems/{typhoeus-1.4.0 → typhoeus-1.4.1}/spec/typhoeus/hydra/cacheable_spec.rb +0 -0
  262. /data/vendor/bundle/ruby/3.2.0/gems/{typhoeus-1.4.0 → typhoeus-1.4.1}/spec/typhoeus/hydra/memoizable_spec.rb +0 -0
  263. /data/vendor/bundle/ruby/3.2.0/gems/{typhoeus-1.4.0 → typhoeus-1.4.1}/spec/typhoeus/hydra/queueable_spec.rb +0 -0
  264. /data/vendor/bundle/ruby/3.2.0/gems/{typhoeus-1.4.0 → typhoeus-1.4.1}/spec/typhoeus/hydra/runnable_spec.rb +0 -0
  265. /data/vendor/bundle/ruby/3.2.0/gems/{typhoeus-1.4.0 → typhoeus-1.4.1}/spec/typhoeus/hydra/stubbable_spec.rb +0 -0
  266. /data/vendor/bundle/ruby/3.2.0/gems/{typhoeus-1.4.0 → typhoeus-1.4.1}/spec/typhoeus/hydra_spec.rb +0 -0
  267. /data/vendor/bundle/ruby/3.2.0/gems/{typhoeus-1.4.0 → typhoeus-1.4.1}/spec/typhoeus/pool_spec.rb +0 -0
  268. /data/vendor/bundle/ruby/3.2.0/gems/{typhoeus-1.4.0 → typhoeus-1.4.1}/spec/typhoeus/request/actions_spec.rb +0 -0
  269. /data/vendor/bundle/ruby/3.2.0/gems/{typhoeus-1.4.0 → typhoeus-1.4.1}/spec/typhoeus/request/before_spec.rb +0 -0
  270. /data/vendor/bundle/ruby/3.2.0/gems/{typhoeus-1.4.0 → typhoeus-1.4.1}/spec/typhoeus/request/block_connection_spec.rb +0 -0
  271. /data/vendor/bundle/ruby/3.2.0/gems/{typhoeus-1.4.0 → typhoeus-1.4.1}/spec/typhoeus/request/cacheable_spec.rb +0 -0
  272. /data/vendor/bundle/ruby/3.2.0/gems/{typhoeus-1.4.0 → typhoeus-1.4.1}/spec/typhoeus/request/callbacks_spec.rb +0 -0
  273. /data/vendor/bundle/ruby/3.2.0/gems/{typhoeus-1.4.0 → typhoeus-1.4.1}/spec/typhoeus/request/marshal_spec.rb +0 -0
  274. /data/vendor/bundle/ruby/3.2.0/gems/{typhoeus-1.4.0 → typhoeus-1.4.1}/spec/typhoeus/request/memoizable_spec.rb +0 -0
  275. /data/vendor/bundle/ruby/3.2.0/gems/{typhoeus-1.4.0 → typhoeus-1.4.1}/spec/typhoeus/request/operations_spec.rb +0 -0
  276. /data/vendor/bundle/ruby/3.2.0/gems/{typhoeus-1.4.0 → typhoeus-1.4.1}/spec/typhoeus/request/responseable_spec.rb +0 -0
  277. /data/vendor/bundle/ruby/3.2.0/gems/{typhoeus-1.4.0 → typhoeus-1.4.1}/spec/typhoeus/request/stubbable_spec.rb +0 -0
  278. /data/vendor/bundle/ruby/3.2.0/gems/{typhoeus-1.4.0 → typhoeus-1.4.1}/spec/typhoeus/response/header_spec.rb +0 -0
  279. /data/vendor/bundle/ruby/3.2.0/gems/{typhoeus-1.4.0 → typhoeus-1.4.1}/spec/typhoeus/response/status_spec.rb +0 -0
  280. /data/vendor/bundle/ruby/3.2.0/gems/{typhoeus-1.4.0 → typhoeus-1.4.1}/spec/typhoeus/response_spec.rb +0 -0
  281. /data/vendor/bundle/ruby/3.2.0/gems/{typhoeus-1.4.0 → typhoeus-1.4.1}/spec/typhoeus_spec.rb +0 -0
  282. /data/vendor/bundle/ruby/3.2.0/gems/{typhoeus-1.4.0 → typhoeus-1.4.1}/typhoeus.gemspec +0 -0
@@ -3,7 +3,7 @@
3
3
 
4
4
  ## Cybrid API documentation Welcome to Cybrid, an all-in-one crypto platform that enables you to easily **build** and **launch** white-label crypto products or services. In these documents, you'll find details on how our REST API operates and generally how our platform functions. If you're looking for our UI SDK Widgets for Web or Mobile (iOS/Android), generated API clients, or demo applications, head over to our [Github repo](https://github.com/Cybrid-app). 💡 We recommend bookmarking the [Cybrid LinkTree](https://linktr.ee/cybridtechnologies) which contains many helpful links to platform resources. ## Getting Started This is Cybrid's public interactive API documentation, which allows you to fully test our APIs. If you'd like to use a different tool to exercise our APIs, you can download the [Open API 3.0 yaml](https://bank.sandbox.cybrid.app/api/schema/v1/swagger.yaml) for import. If you're new to our APIs and the Cybrid Platform, follow the below guides to get set up and familiar with the platform: 1. [Understanding the Platform](https://kb.cybrid.xyz/understanding-the-platform) 2. [Getting Started in the Cybrid Sandbox](https://kb.cybrid.xyz/getting-started-guide) 3. [Getting Ready for Trading](https://kb.cybrid.xyz/getting-ready-for-trading) 4. [Running the Web Demo App](https://kb.cybrid.xyz/locally-running-the-web-demo-app) (or, alternatively, [Testing with Hosted Web Demo App](https://kb.cybrid.xyz/testing-with-hosted-web-demo-app)) In [Getting Started in the Cybrid Sandbox](https://kb.cybrid.xyz/getting-started-guide), we walk you through how to use the [Cybrid Sandbox](https://id.sandbox.cybrid.app/) to create a test bank and generate API keys. In [Getting Ready for Trading](https://kb.cybrid.xyz/getting-ready-for-trading), we walk through creating customers, customer identities, accounts, as well as executing quotes and trades. If you've already run through the first two guides, you can follow the [Running the Web Demo App](https://kb.cybrid.xyz/locally-running-the-web-demo-app) guide to test our web SDK with your sandbox `bank` and `customer`. ## Working with the Cybrid Platform There are three primary ways you can interact with the Cybrid platform: 1. Directly via our RESTful API (this documentation) 2. Using our API clients available in a variety of languages ([Angular](https://github.com/Cybrid-app/cybrid-api-bank-angular), [Java](https://github.com/Cybrid-app/cybrid-api-bank-java), [Kotlin](https://github.com/Cybrid-app/cybrid-api-bank-kotlin), [Python](https://github.com/Cybrid-app/cybrid-api-bank-python), [Ruby](https://github.com/Cybrid-app/cybrid-api-bank-ruby), [Swift](https://github.com/Cybrid-app/cybrid-api-bank-swift) or [Typescript](https://github.com/Cybrid-app/cybrid-api-bank-typescript)) 3. Integrating a platform specific SDK ([Web](https://github.com/Cybrid-app/cybrid-sdk-web), [Android](https://github.com/Cybrid-app/cybrid-sdk-android), [iOS](https://github.com/Cybrid-app/cybrid-sdk-ios)) Our complete set of APIs allows you to manage resources across three distinct areas: your `Organization`, your `Banks` and your `Identities`. For most of your testing and interaction you'll be using the `Bank` API, which is where the majority of APIs reside. *The complete set of APIs can be found on the following pages:* | API | Description | |------------------------------------------------------------------|-------------------------------------------------------------| | [Organization API](https://organization.sandbox.cybrid.app/api/schema/swagger-ui) | APIs to manage organizations | | [Bank API](https://bank.sandbox.cybrid.app/api/schema/swagger-ui) | APIs to manage banks (and all downstream customer activity) | | [Identities API](https://id.sandbox.cybrid.app/api/schema/swagger-ui) | APIs to manage organization and bank identities | For questions please contact [Support](mailto:support@cybrid.xyz) at any time for assistance, or contact the [Product Team](mailto:product@cybrid.xyz) for product suggestions. ## Authenticating with the API The Cybrid Platform uses OAuth 2.0 Bearer Tokens to authenticate requests to the platform. Credentials to create `Organization` and `Bank` tokens can be generated via the [Cybrid Sandbox](https://id.sandbox.cybrid.app). Access tokens can be generated for a `Customer` as well via the [Cybrid IdP](https://id.sandbox.cybrid.app) as well. An `Organization` access token applies broadly to the whole Organization and all of its `Banks`, whereas, a `Bank` access token is specific to an individual Bank. `Customer` tokens, similarly, are scoped to a specific customer in a bank. Both `Organization` and `Bank` tokens can be created using the OAuth Client Credential Grant flow. Each Organization and Bank has its own unique `Client ID` and `Secret` that allows for machine-to-machine authentication. A `Bank` can then generate `Customer` access tokens via API using our [Identities API](https://id.sandbox.cybrid.app/api/schema/swagger-ui). <font color=\"orange\">**⚠️ Never share your Client ID or Secret publicly or in your source code repository.**</font> Your `Client ID` and `Secret` can be exchanged for a time-limited `Bearer Token` by interacting with the Cybrid Identity Provider or through interacting with the **Authorize** button in this document. The following curl command can be used to quickly generate a `Bearer Token` for use in testing the API or demo applications. ``` # Example request when using Bank credentials curl -X POST https://id.sandbox.cybrid.app/oauth/token -d '{ \"grant_type\": \"client_credentials\", \"client_id\": \"<Your Client ID>\", \"client_secret\": \"<Your Secret>\", \"scope\": \"banks:read banks:write bank_applications:execute accounts:read accounts:execute customers:read customers:write customers:execute prices:read quotes:execute quotes:read trades:execute trades:read transfers:execute transfers:read external_bank_accounts:read external_bank_accounts:write external_bank_accounts:execute external_wallets:read external_wallets:execute workflows:read workflows:execute deposit_addresses:read deposit_addresses:execute deposit_bank_accounts:read deposit_bank_accounts:execute\" }' -H \"Content-Type: application/json\" # When using Organization credentials set `scope` to 'organizations:read organizations:write organization_applications:execute banks:read banks:write banks:execute bank_applications:execute users:read users:execute customers:read accounts:read prices:read quotes:execute quotes:read trades:execute trades:read transfers:read transfers:execute external_bank_accounts:read external_wallets:read workflows:read deposit_addresses:read deposit_bank_accounts:read' ``` <font color=\"orange\">**⚠️ Note: The above curl will create a bearer token with full scope access. Delete scopes if you'd like to restrict access.**</font> ## Authentication Scopes The Cybrid platform supports the use of scopes to control the level of access a token is limited to. Scopes do not grant access to resources; instead, they provide limits, in support of the least privilege principal. The following scopes are available on the platform and can be requested when generating either an Organization, Bank or Customer token. Generally speaking, the _Read_ scope is required to read and list resources, the _Write_ scope is required to update a resource and the _Execute_ scope is required to create a resource. | Resource | Read scope (Token Type) | Write scope (Token Type) | Execute scope (Token Type) | |-----------------------|------------------------------------------------------------|-----------------------------------------------|--------------------------------------------------| | Account | accounts:read (Organization, Bank, Customer) | | accounts:execute (Bank, Customer) | | Bank | banks:read (Organization, Bank) | banks:write (Organization, Bank) | banks:execute (Organization) | | Customer | customers:read (Organization, Bank, Customer) | customers:write (Bank, Customer) | customers:execute (Bank) | | Deposit Address | deposit_addresses:read (Organization, Bank, Customer) | deposit_addresses:write (Bank, Customer) | deposit_addresses:execute (Bank, Customer) | | External Bank Account | external_bank_accounts:read (Organization, Bank, Customer) | external_bank_accounts:write (Bank, Customer) | external_bank_accounts:execute (Bank, Customer) | | External Wallet | external_wallet:read (Organization, Bank, Customer) | | external_wallet:execute (Bank, Customer) | | Organization | organizations:read (Organization) | organizations:write (Organization) | | | User | users:read (Organization) | | users:execute (Organization) | | Price | prices:read (Bank, Customer) | | | | Quote | quotes:read (Organization, Bank, Customer) | | quotes:execute (Organization, Bank, Customer) | | Trade | trades:read (Organization, Bank, Customer) | | trades:execute (Organization, Bank, Customer) | | Transfer | transfers:read (Organization, Bank, Customer) | | transfers:execute (Organization, Bank, Customer) | | Workflow | workflows:read (Organization, Bank, Customer) | | workflows:execute (Bank, Customer) | ## Available Endpoints The available APIs for the [Identity](https://id.sandbox.cybrid.app/api/schema/swagger-ui), [Organization](https://organization.sandbox.cybrid.app/api/schema/swagger-ui) and [Bank](https://bank.sandbox.cybrid.app/api/schema/swagger-ui) API services are listed below: | API Service | Model | API Endpoint Path | Description | |--------------|----------------------|--------------------------------|---------------------------------------------------------------------------------------------------| | Identity | Bank | /api/bank_applications | Create and list banks | | Identity | CustomerToken | /api/customer_tokens | Create customer JWT access tokens | | Identity | Organization | /api/organization_applications | Create and list organizations | | Identity | Organization | /api/users | Create and list organization users | | Organization | Organization | /api/organizations | APIs to retrieve and update organization name | | Bank | Account | /api/accounts | Create and list accounts, which hold a specific asset for a customers | | Bank | Asset | /api/assets | Get a list of assets supported by the platform (ex: BTC, ETH) | | Bank | Bank | /api/banks | Create, update and list banks, the parent to customers, accounts, etc | | Bank | Customer | /api/customers | Create and list customers | | Bank | DepositAddress | /api/deposit_addresses | Create, get and list deposit addresses | | Bank | ExternalBankAccount | /api/external_bank_accounts | Create, get and list external bank accounts, which connect customer bank accounts to the platform | | Bank | ExternalWallet | /api/external_wallets | Create, get, list and delete external wallets, which connect customer wallets to the platform | | Bank | IdentityVerification | /api/identity_verifications | Create and list identity verifications, which are performed on customers for KYC | | Bank | Price | /api/prices | Get the current prices for assets on the platform | | Bank | Quote | /api/quotes | Create and list quotes, which are required to execute trades | | Bank | Symbol | /api/symbols | Get a list of symbols supported for trade (ex: BTC-USD) | | Bank | Trade | /api/trades | Create and list trades, which buy or sell cryptocurrency | | Bank | Transfer | /api/transfers | Create, get and list transfers (e.g., funding, book) | | Bank | Workflow | /api/workflows | Create, get and list workflows | ## Understanding Object Models & Endpoints **Organizations** An `Organization` is meant to represent the organization partnering with Cybrid to use our platform. An `Organization` typically does not directly interact with `customers`. Instead, an Organization has one or more `banks`, which encompass the financial service offerings of the platform. **Banks** A `Bank` is owned by an `Organization` and can be thought of as an environment or container for `customers` and product offerings. Banks are created in either `Sandbox` or `Production` mode, where `Sandbox` is the environment that you would test, prototype and build in prior to moving to `Production`. An `Organization` can have multiple `banks`, in either `Sandbox` or `Production` environments. A `Sandbox Bank` will be backed by stubbed data and process flows. For instance, funding source transfer processes as well as trades will be simulated rather than performed, however asset prices are representative of real-world values. You have an unlimited amount of simulated fiat currency for testing purposes. **Customers** `Customers` represent your banking users on the platform. At present, we offer support for `Individuals` as Customers. `Customers` must be verified (i.e., KYC'd) in our system before they can play any part on the platform, which means they must have an associated and a passing `Identity Verification`. See the Identity Verifications section for more details on how a customer can be verified. `Customers` must also have an `Account` to be able to transact, in the desired asset class. See the Accounts APIs for more details on setting up accounts for the customer.
5
5
 
6
- The version of the OpenAPI document: v0.110.6
6
+ The version of the OpenAPI document: v0.110.9
7
7
  Contact: support@cybrid.app
8
8
  Generated by: https://openapi-generator.tech
9
9
  OpenAPI Generator version: 6.0.0
@@ -3,7 +3,7 @@
3
3
 
4
4
  ## Cybrid API documentation Welcome to Cybrid, an all-in-one crypto platform that enables you to easily **build** and **launch** white-label crypto products or services. In these documents, you'll find details on how our REST API operates and generally how our platform functions. If you're looking for our UI SDK Widgets for Web or Mobile (iOS/Android), generated API clients, or demo applications, head over to our [Github repo](https://github.com/Cybrid-app). 💡 We recommend bookmarking the [Cybrid LinkTree](https://linktr.ee/cybridtechnologies) which contains many helpful links to platform resources. ## Getting Started This is Cybrid's public interactive API documentation, which allows you to fully test our APIs. If you'd like to use a different tool to exercise our APIs, you can download the [Open API 3.0 yaml](https://bank.sandbox.cybrid.app/api/schema/v1/swagger.yaml) for import. If you're new to our APIs and the Cybrid Platform, follow the below guides to get set up and familiar with the platform: 1. [Understanding the Platform](https://kb.cybrid.xyz/understanding-the-platform) 2. [Getting Started in the Cybrid Sandbox](https://kb.cybrid.xyz/getting-started-guide) 3. [Getting Ready for Trading](https://kb.cybrid.xyz/getting-ready-for-trading) 4. [Running the Web Demo App](https://kb.cybrid.xyz/locally-running-the-web-demo-app) (or, alternatively, [Testing with Hosted Web Demo App](https://kb.cybrid.xyz/testing-with-hosted-web-demo-app)) In [Getting Started in the Cybrid Sandbox](https://kb.cybrid.xyz/getting-started-guide), we walk you through how to use the [Cybrid Sandbox](https://id.sandbox.cybrid.app/) to create a test bank and generate API keys. In [Getting Ready for Trading](https://kb.cybrid.xyz/getting-ready-for-trading), we walk through creating customers, customer identities, accounts, as well as executing quotes and trades. If you've already run through the first two guides, you can follow the [Running the Web Demo App](https://kb.cybrid.xyz/locally-running-the-web-demo-app) guide to test our web SDK with your sandbox `bank` and `customer`. ## Working with the Cybrid Platform There are three primary ways you can interact with the Cybrid platform: 1. Directly via our RESTful API (this documentation) 2. Using our API clients available in a variety of languages ([Angular](https://github.com/Cybrid-app/cybrid-api-bank-angular), [Java](https://github.com/Cybrid-app/cybrid-api-bank-java), [Kotlin](https://github.com/Cybrid-app/cybrid-api-bank-kotlin), [Python](https://github.com/Cybrid-app/cybrid-api-bank-python), [Ruby](https://github.com/Cybrid-app/cybrid-api-bank-ruby), [Swift](https://github.com/Cybrid-app/cybrid-api-bank-swift) or [Typescript](https://github.com/Cybrid-app/cybrid-api-bank-typescript)) 3. Integrating a platform specific SDK ([Web](https://github.com/Cybrid-app/cybrid-sdk-web), [Android](https://github.com/Cybrid-app/cybrid-sdk-android), [iOS](https://github.com/Cybrid-app/cybrid-sdk-ios)) Our complete set of APIs allows you to manage resources across three distinct areas: your `Organization`, your `Banks` and your `Identities`. For most of your testing and interaction you'll be using the `Bank` API, which is where the majority of APIs reside. *The complete set of APIs can be found on the following pages:* | API | Description | |------------------------------------------------------------------|-------------------------------------------------------------| | [Organization API](https://organization.sandbox.cybrid.app/api/schema/swagger-ui) | APIs to manage organizations | | [Bank API](https://bank.sandbox.cybrid.app/api/schema/swagger-ui) | APIs to manage banks (and all downstream customer activity) | | [Identities API](https://id.sandbox.cybrid.app/api/schema/swagger-ui) | APIs to manage organization and bank identities | For questions please contact [Support](mailto:support@cybrid.xyz) at any time for assistance, or contact the [Product Team](mailto:product@cybrid.xyz) for product suggestions. ## Authenticating with the API The Cybrid Platform uses OAuth 2.0 Bearer Tokens to authenticate requests to the platform. Credentials to create `Organization` and `Bank` tokens can be generated via the [Cybrid Sandbox](https://id.sandbox.cybrid.app). Access tokens can be generated for a `Customer` as well via the [Cybrid IdP](https://id.sandbox.cybrid.app) as well. An `Organization` access token applies broadly to the whole Organization and all of its `Banks`, whereas, a `Bank` access token is specific to an individual Bank. `Customer` tokens, similarly, are scoped to a specific customer in a bank. Both `Organization` and `Bank` tokens can be created using the OAuth Client Credential Grant flow. Each Organization and Bank has its own unique `Client ID` and `Secret` that allows for machine-to-machine authentication. A `Bank` can then generate `Customer` access tokens via API using our [Identities API](https://id.sandbox.cybrid.app/api/schema/swagger-ui). <font color=\"orange\">**⚠️ Never share your Client ID or Secret publicly or in your source code repository.**</font> Your `Client ID` and `Secret` can be exchanged for a time-limited `Bearer Token` by interacting with the Cybrid Identity Provider or through interacting with the **Authorize** button in this document. The following curl command can be used to quickly generate a `Bearer Token` for use in testing the API or demo applications. ``` # Example request when using Bank credentials curl -X POST https://id.sandbox.cybrid.app/oauth/token -d '{ \"grant_type\": \"client_credentials\", \"client_id\": \"<Your Client ID>\", \"client_secret\": \"<Your Secret>\", \"scope\": \"banks:read banks:write bank_applications:execute accounts:read accounts:execute customers:read customers:write customers:execute prices:read quotes:execute quotes:read trades:execute trades:read transfers:execute transfers:read external_bank_accounts:read external_bank_accounts:write external_bank_accounts:execute external_wallets:read external_wallets:execute workflows:read workflows:execute deposit_addresses:read deposit_addresses:execute deposit_bank_accounts:read deposit_bank_accounts:execute\" }' -H \"Content-Type: application/json\" # When using Organization credentials set `scope` to 'organizations:read organizations:write organization_applications:execute banks:read banks:write banks:execute bank_applications:execute users:read users:execute customers:read accounts:read prices:read quotes:execute quotes:read trades:execute trades:read transfers:read transfers:execute external_bank_accounts:read external_wallets:read workflows:read deposit_addresses:read deposit_bank_accounts:read' ``` <font color=\"orange\">**⚠️ Note: The above curl will create a bearer token with full scope access. Delete scopes if you'd like to restrict access.**</font> ## Authentication Scopes The Cybrid platform supports the use of scopes to control the level of access a token is limited to. Scopes do not grant access to resources; instead, they provide limits, in support of the least privilege principal. The following scopes are available on the platform and can be requested when generating either an Organization, Bank or Customer token. Generally speaking, the _Read_ scope is required to read and list resources, the _Write_ scope is required to update a resource and the _Execute_ scope is required to create a resource. | Resource | Read scope (Token Type) | Write scope (Token Type) | Execute scope (Token Type) | |-----------------------|------------------------------------------------------------|-----------------------------------------------|--------------------------------------------------| | Account | accounts:read (Organization, Bank, Customer) | | accounts:execute (Bank, Customer) | | Bank | banks:read (Organization, Bank) | banks:write (Organization, Bank) | banks:execute (Organization) | | Customer | customers:read (Organization, Bank, Customer) | customers:write (Bank, Customer) | customers:execute (Bank) | | Deposit Address | deposit_addresses:read (Organization, Bank, Customer) | deposit_addresses:write (Bank, Customer) | deposit_addresses:execute (Bank, Customer) | | External Bank Account | external_bank_accounts:read (Organization, Bank, Customer) | external_bank_accounts:write (Bank, Customer) | external_bank_accounts:execute (Bank, Customer) | | External Wallet | external_wallet:read (Organization, Bank, Customer) | | external_wallet:execute (Bank, Customer) | | Organization | organizations:read (Organization) | organizations:write (Organization) | | | User | users:read (Organization) | | users:execute (Organization) | | Price | prices:read (Bank, Customer) | | | | Quote | quotes:read (Organization, Bank, Customer) | | quotes:execute (Organization, Bank, Customer) | | Trade | trades:read (Organization, Bank, Customer) | | trades:execute (Organization, Bank, Customer) | | Transfer | transfers:read (Organization, Bank, Customer) | | transfers:execute (Organization, Bank, Customer) | | Workflow | workflows:read (Organization, Bank, Customer) | | workflows:execute (Bank, Customer) | ## Available Endpoints The available APIs for the [Identity](https://id.sandbox.cybrid.app/api/schema/swagger-ui), [Organization](https://organization.sandbox.cybrid.app/api/schema/swagger-ui) and [Bank](https://bank.sandbox.cybrid.app/api/schema/swagger-ui) API services are listed below: | API Service | Model | API Endpoint Path | Description | |--------------|----------------------|--------------------------------|---------------------------------------------------------------------------------------------------| | Identity | Bank | /api/bank_applications | Create and list banks | | Identity | CustomerToken | /api/customer_tokens | Create customer JWT access tokens | | Identity | Organization | /api/organization_applications | Create and list organizations | | Identity | Organization | /api/users | Create and list organization users | | Organization | Organization | /api/organizations | APIs to retrieve and update organization name | | Bank | Account | /api/accounts | Create and list accounts, which hold a specific asset for a customers | | Bank | Asset | /api/assets | Get a list of assets supported by the platform (ex: BTC, ETH) | | Bank | Bank | /api/banks | Create, update and list banks, the parent to customers, accounts, etc | | Bank | Customer | /api/customers | Create and list customers | | Bank | DepositAddress | /api/deposit_addresses | Create, get and list deposit addresses | | Bank | ExternalBankAccount | /api/external_bank_accounts | Create, get and list external bank accounts, which connect customer bank accounts to the platform | | Bank | ExternalWallet | /api/external_wallets | Create, get, list and delete external wallets, which connect customer wallets to the platform | | Bank | IdentityVerification | /api/identity_verifications | Create and list identity verifications, which are performed on customers for KYC | | Bank | Price | /api/prices | Get the current prices for assets on the platform | | Bank | Quote | /api/quotes | Create and list quotes, which are required to execute trades | | Bank | Symbol | /api/symbols | Get a list of symbols supported for trade (ex: BTC-USD) | | Bank | Trade | /api/trades | Create and list trades, which buy or sell cryptocurrency | | Bank | Transfer | /api/transfers | Create, get and list transfers (e.g., funding, book) | | Bank | Workflow | /api/workflows | Create, get and list workflows | ## Understanding Object Models & Endpoints **Organizations** An `Organization` is meant to represent the organization partnering with Cybrid to use our platform. An `Organization` typically does not directly interact with `customers`. Instead, an Organization has one or more `banks`, which encompass the financial service offerings of the platform. **Banks** A `Bank` is owned by an `Organization` and can be thought of as an environment or container for `customers` and product offerings. Banks are created in either `Sandbox` or `Production` mode, where `Sandbox` is the environment that you would test, prototype and build in prior to moving to `Production`. An `Organization` can have multiple `banks`, in either `Sandbox` or `Production` environments. A `Sandbox Bank` will be backed by stubbed data and process flows. For instance, funding source transfer processes as well as trades will be simulated rather than performed, however asset prices are representative of real-world values. You have an unlimited amount of simulated fiat currency for testing purposes. **Customers** `Customers` represent your banking users on the platform. At present, we offer support for `Individuals` as Customers. `Customers` must be verified (i.e., KYC'd) in our system before they can play any part on the platform, which means they must have an associated and a passing `Identity Verification`. See the Identity Verifications section for more details on how a customer can be verified. `Customers` must also have an `Account` to be able to transact, in the desired asset class. See the Accounts APIs for more details on setting up accounts for the customer.
5
5
 
6
- The version of the OpenAPI document: v0.110.6
6
+ The version of the OpenAPI document: v0.110.9
7
7
  Contact: support@cybrid.app
8
8
  Generated by: https://openapi-generator.tech
9
9
  OpenAPI Generator version: 6.0.0
@@ -3,7 +3,7 @@
3
3
 
4
4
  ## Cybrid API documentation Welcome to Cybrid, an all-in-one crypto platform that enables you to easily **build** and **launch** white-label crypto products or services. In these documents, you'll find details on how our REST API operates and generally how our platform functions. If you're looking for our UI SDK Widgets for Web or Mobile (iOS/Android), generated API clients, or demo applications, head over to our [Github repo](https://github.com/Cybrid-app). 💡 We recommend bookmarking the [Cybrid LinkTree](https://linktr.ee/cybridtechnologies) which contains many helpful links to platform resources. ## Getting Started This is Cybrid's public interactive API documentation, which allows you to fully test our APIs. If you'd like to use a different tool to exercise our APIs, you can download the [Open API 3.0 yaml](https://bank.sandbox.cybrid.app/api/schema/v1/swagger.yaml) for import. If you're new to our APIs and the Cybrid Platform, follow the below guides to get set up and familiar with the platform: 1. [Understanding the Platform](https://kb.cybrid.xyz/understanding-the-platform) 2. [Getting Started in the Cybrid Sandbox](https://kb.cybrid.xyz/getting-started-guide) 3. [Getting Ready for Trading](https://kb.cybrid.xyz/getting-ready-for-trading) 4. [Running the Web Demo App](https://kb.cybrid.xyz/locally-running-the-web-demo-app) (or, alternatively, [Testing with Hosted Web Demo App](https://kb.cybrid.xyz/testing-with-hosted-web-demo-app)) In [Getting Started in the Cybrid Sandbox](https://kb.cybrid.xyz/getting-started-guide), we walk you through how to use the [Cybrid Sandbox](https://id.sandbox.cybrid.app/) to create a test bank and generate API keys. In [Getting Ready for Trading](https://kb.cybrid.xyz/getting-ready-for-trading), we walk through creating customers, customer identities, accounts, as well as executing quotes and trades. If you've already run through the first two guides, you can follow the [Running the Web Demo App](https://kb.cybrid.xyz/locally-running-the-web-demo-app) guide to test our web SDK with your sandbox `bank` and `customer`. ## Working with the Cybrid Platform There are three primary ways you can interact with the Cybrid platform: 1. Directly via our RESTful API (this documentation) 2. Using our API clients available in a variety of languages ([Angular](https://github.com/Cybrid-app/cybrid-api-bank-angular), [Java](https://github.com/Cybrid-app/cybrid-api-bank-java), [Kotlin](https://github.com/Cybrid-app/cybrid-api-bank-kotlin), [Python](https://github.com/Cybrid-app/cybrid-api-bank-python), [Ruby](https://github.com/Cybrid-app/cybrid-api-bank-ruby), [Swift](https://github.com/Cybrid-app/cybrid-api-bank-swift) or [Typescript](https://github.com/Cybrid-app/cybrid-api-bank-typescript)) 3. Integrating a platform specific SDK ([Web](https://github.com/Cybrid-app/cybrid-sdk-web), [Android](https://github.com/Cybrid-app/cybrid-sdk-android), [iOS](https://github.com/Cybrid-app/cybrid-sdk-ios)) Our complete set of APIs allows you to manage resources across three distinct areas: your `Organization`, your `Banks` and your `Identities`. For most of your testing and interaction you'll be using the `Bank` API, which is where the majority of APIs reside. *The complete set of APIs can be found on the following pages:* | API | Description | |------------------------------------------------------------------|-------------------------------------------------------------| | [Organization API](https://organization.sandbox.cybrid.app/api/schema/swagger-ui) | APIs to manage organizations | | [Bank API](https://bank.sandbox.cybrid.app/api/schema/swagger-ui) | APIs to manage banks (and all downstream customer activity) | | [Identities API](https://id.sandbox.cybrid.app/api/schema/swagger-ui) | APIs to manage organization and bank identities | For questions please contact [Support](mailto:support@cybrid.xyz) at any time for assistance, or contact the [Product Team](mailto:product@cybrid.xyz) for product suggestions. ## Authenticating with the API The Cybrid Platform uses OAuth 2.0 Bearer Tokens to authenticate requests to the platform. Credentials to create `Organization` and `Bank` tokens can be generated via the [Cybrid Sandbox](https://id.sandbox.cybrid.app). Access tokens can be generated for a `Customer` as well via the [Cybrid IdP](https://id.sandbox.cybrid.app) as well. An `Organization` access token applies broadly to the whole Organization and all of its `Banks`, whereas, a `Bank` access token is specific to an individual Bank. `Customer` tokens, similarly, are scoped to a specific customer in a bank. Both `Organization` and `Bank` tokens can be created using the OAuth Client Credential Grant flow. Each Organization and Bank has its own unique `Client ID` and `Secret` that allows for machine-to-machine authentication. A `Bank` can then generate `Customer` access tokens via API using our [Identities API](https://id.sandbox.cybrid.app/api/schema/swagger-ui). <font color=\"orange\">**⚠️ Never share your Client ID or Secret publicly or in your source code repository.**</font> Your `Client ID` and `Secret` can be exchanged for a time-limited `Bearer Token` by interacting with the Cybrid Identity Provider or through interacting with the **Authorize** button in this document. The following curl command can be used to quickly generate a `Bearer Token` for use in testing the API or demo applications. ``` # Example request when using Bank credentials curl -X POST https://id.sandbox.cybrid.app/oauth/token -d '{ \"grant_type\": \"client_credentials\", \"client_id\": \"<Your Client ID>\", \"client_secret\": \"<Your Secret>\", \"scope\": \"banks:read banks:write bank_applications:execute accounts:read accounts:execute customers:read customers:write customers:execute prices:read quotes:execute quotes:read trades:execute trades:read transfers:execute transfers:read external_bank_accounts:read external_bank_accounts:write external_bank_accounts:execute external_wallets:read external_wallets:execute workflows:read workflows:execute deposit_addresses:read deposit_addresses:execute deposit_bank_accounts:read deposit_bank_accounts:execute\" }' -H \"Content-Type: application/json\" # When using Organization credentials set `scope` to 'organizations:read organizations:write organization_applications:execute banks:read banks:write banks:execute bank_applications:execute users:read users:execute customers:read accounts:read prices:read quotes:execute quotes:read trades:execute trades:read transfers:read transfers:execute external_bank_accounts:read external_wallets:read workflows:read deposit_addresses:read deposit_bank_accounts:read' ``` <font color=\"orange\">**⚠️ Note: The above curl will create a bearer token with full scope access. Delete scopes if you'd like to restrict access.**</font> ## Authentication Scopes The Cybrid platform supports the use of scopes to control the level of access a token is limited to. Scopes do not grant access to resources; instead, they provide limits, in support of the least privilege principal. The following scopes are available on the platform and can be requested when generating either an Organization, Bank or Customer token. Generally speaking, the _Read_ scope is required to read and list resources, the _Write_ scope is required to update a resource and the _Execute_ scope is required to create a resource. | Resource | Read scope (Token Type) | Write scope (Token Type) | Execute scope (Token Type) | |-----------------------|------------------------------------------------------------|-----------------------------------------------|--------------------------------------------------| | Account | accounts:read (Organization, Bank, Customer) | | accounts:execute (Bank, Customer) | | Bank | banks:read (Organization, Bank) | banks:write (Organization, Bank) | banks:execute (Organization) | | Customer | customers:read (Organization, Bank, Customer) | customers:write (Bank, Customer) | customers:execute (Bank) | | Deposit Address | deposit_addresses:read (Organization, Bank, Customer) | deposit_addresses:write (Bank, Customer) | deposit_addresses:execute (Bank, Customer) | | External Bank Account | external_bank_accounts:read (Organization, Bank, Customer) | external_bank_accounts:write (Bank, Customer) | external_bank_accounts:execute (Bank, Customer) | | External Wallet | external_wallet:read (Organization, Bank, Customer) | | external_wallet:execute (Bank, Customer) | | Organization | organizations:read (Organization) | organizations:write (Organization) | | | User | users:read (Organization) | | users:execute (Organization) | | Price | prices:read (Bank, Customer) | | | | Quote | quotes:read (Organization, Bank, Customer) | | quotes:execute (Organization, Bank, Customer) | | Trade | trades:read (Organization, Bank, Customer) | | trades:execute (Organization, Bank, Customer) | | Transfer | transfers:read (Organization, Bank, Customer) | | transfers:execute (Organization, Bank, Customer) | | Workflow | workflows:read (Organization, Bank, Customer) | | workflows:execute (Bank, Customer) | ## Available Endpoints The available APIs for the [Identity](https://id.sandbox.cybrid.app/api/schema/swagger-ui), [Organization](https://organization.sandbox.cybrid.app/api/schema/swagger-ui) and [Bank](https://bank.sandbox.cybrid.app/api/schema/swagger-ui) API services are listed below: | API Service | Model | API Endpoint Path | Description | |--------------|----------------------|--------------------------------|---------------------------------------------------------------------------------------------------| | Identity | Bank | /api/bank_applications | Create and list banks | | Identity | CustomerToken | /api/customer_tokens | Create customer JWT access tokens | | Identity | Organization | /api/organization_applications | Create and list organizations | | Identity | Organization | /api/users | Create and list organization users | | Organization | Organization | /api/organizations | APIs to retrieve and update organization name | | Bank | Account | /api/accounts | Create and list accounts, which hold a specific asset for a customers | | Bank | Asset | /api/assets | Get a list of assets supported by the platform (ex: BTC, ETH) | | Bank | Bank | /api/banks | Create, update and list banks, the parent to customers, accounts, etc | | Bank | Customer | /api/customers | Create and list customers | | Bank | DepositAddress | /api/deposit_addresses | Create, get and list deposit addresses | | Bank | ExternalBankAccount | /api/external_bank_accounts | Create, get and list external bank accounts, which connect customer bank accounts to the platform | | Bank | ExternalWallet | /api/external_wallets | Create, get, list and delete external wallets, which connect customer wallets to the platform | | Bank | IdentityVerification | /api/identity_verifications | Create and list identity verifications, which are performed on customers for KYC | | Bank | Price | /api/prices | Get the current prices for assets on the platform | | Bank | Quote | /api/quotes | Create and list quotes, which are required to execute trades | | Bank | Symbol | /api/symbols | Get a list of symbols supported for trade (ex: BTC-USD) | | Bank | Trade | /api/trades | Create and list trades, which buy or sell cryptocurrency | | Bank | Transfer | /api/transfers | Create, get and list transfers (e.g., funding, book) | | Bank | Workflow | /api/workflows | Create, get and list workflows | ## Understanding Object Models & Endpoints **Organizations** An `Organization` is meant to represent the organization partnering with Cybrid to use our platform. An `Organization` typically does not directly interact with `customers`. Instead, an Organization has one or more `banks`, which encompass the financial service offerings of the platform. **Banks** A `Bank` is owned by an `Organization` and can be thought of as an environment or container for `customers` and product offerings. Banks are created in either `Sandbox` or `Production` mode, where `Sandbox` is the environment that you would test, prototype and build in prior to moving to `Production`. An `Organization` can have multiple `banks`, in either `Sandbox` or `Production` environments. A `Sandbox Bank` will be backed by stubbed data and process flows. For instance, funding source transfer processes as well as trades will be simulated rather than performed, however asset prices are representative of real-world values. You have an unlimited amount of simulated fiat currency for testing purposes. **Customers** `Customers` represent your banking users on the platform. At present, we offer support for `Individuals` as Customers. `Customers` must be verified (i.e., KYC'd) in our system before they can play any part on the platform, which means they must have an associated and a passing `Identity Verification`. See the Identity Verifications section for more details on how a customer can be verified. `Customers` must also have an `Account` to be able to transact, in the desired asset class. See the Accounts APIs for more details on setting up accounts for the customer.
5
5
 
6
- The version of the OpenAPI document: v0.110.6
6
+ The version of the OpenAPI document: v0.110.9
7
7
  Contact: support@cybrid.app
8
8
  Generated by: https://openapi-generator.tech
9
9
  OpenAPI Generator version: 6.0.0
data/spec/spec_helper.rb CHANGED
@@ -3,7 +3,7 @@
3
3
 
4
4
  ## Cybrid API documentation Welcome to Cybrid, an all-in-one crypto platform that enables you to easily **build** and **launch** white-label crypto products or services. In these documents, you'll find details on how our REST API operates and generally how our platform functions. If you're looking for our UI SDK Widgets for Web or Mobile (iOS/Android), generated API clients, or demo applications, head over to our [Github repo](https://github.com/Cybrid-app). 💡 We recommend bookmarking the [Cybrid LinkTree](https://linktr.ee/cybridtechnologies) which contains many helpful links to platform resources. ## Getting Started This is Cybrid's public interactive API documentation, which allows you to fully test our APIs. If you'd like to use a different tool to exercise our APIs, you can download the [Open API 3.0 yaml](https://bank.sandbox.cybrid.app/api/schema/v1/swagger.yaml) for import. If you're new to our APIs and the Cybrid Platform, follow the below guides to get set up and familiar with the platform: 1. [Understanding the Platform](https://kb.cybrid.xyz/understanding-the-platform) 2. [Getting Started in the Cybrid Sandbox](https://kb.cybrid.xyz/getting-started-guide) 3. [Getting Ready for Trading](https://kb.cybrid.xyz/getting-ready-for-trading) 4. [Running the Web Demo App](https://kb.cybrid.xyz/locally-running-the-web-demo-app) (or, alternatively, [Testing with Hosted Web Demo App](https://kb.cybrid.xyz/testing-with-hosted-web-demo-app)) In [Getting Started in the Cybrid Sandbox](https://kb.cybrid.xyz/getting-started-guide), we walk you through how to use the [Cybrid Sandbox](https://id.sandbox.cybrid.app/) to create a test bank and generate API keys. In [Getting Ready for Trading](https://kb.cybrid.xyz/getting-ready-for-trading), we walk through creating customers, customer identities, accounts, as well as executing quotes and trades. If you've already run through the first two guides, you can follow the [Running the Web Demo App](https://kb.cybrid.xyz/locally-running-the-web-demo-app) guide to test our web SDK with your sandbox `bank` and `customer`. ## Working with the Cybrid Platform There are three primary ways you can interact with the Cybrid platform: 1. Directly via our RESTful API (this documentation) 2. Using our API clients available in a variety of languages ([Angular](https://github.com/Cybrid-app/cybrid-api-bank-angular), [Java](https://github.com/Cybrid-app/cybrid-api-bank-java), [Kotlin](https://github.com/Cybrid-app/cybrid-api-bank-kotlin), [Python](https://github.com/Cybrid-app/cybrid-api-bank-python), [Ruby](https://github.com/Cybrid-app/cybrid-api-bank-ruby), [Swift](https://github.com/Cybrid-app/cybrid-api-bank-swift) or [Typescript](https://github.com/Cybrid-app/cybrid-api-bank-typescript)) 3. Integrating a platform specific SDK ([Web](https://github.com/Cybrid-app/cybrid-sdk-web), [Android](https://github.com/Cybrid-app/cybrid-sdk-android), [iOS](https://github.com/Cybrid-app/cybrid-sdk-ios)) Our complete set of APIs allows you to manage resources across three distinct areas: your `Organization`, your `Banks` and your `Identities`. For most of your testing and interaction you'll be using the `Bank` API, which is where the majority of APIs reside. *The complete set of APIs can be found on the following pages:* | API | Description | |------------------------------------------------------------------|-------------------------------------------------------------| | [Organization API](https://organization.sandbox.cybrid.app/api/schema/swagger-ui) | APIs to manage organizations | | [Bank API](https://bank.sandbox.cybrid.app/api/schema/swagger-ui) | APIs to manage banks (and all downstream customer activity) | | [Identities API](https://id.sandbox.cybrid.app/api/schema/swagger-ui) | APIs to manage organization and bank identities | For questions please contact [Support](mailto:support@cybrid.xyz) at any time for assistance, or contact the [Product Team](mailto:product@cybrid.xyz) for product suggestions. ## Authenticating with the API The Cybrid Platform uses OAuth 2.0 Bearer Tokens to authenticate requests to the platform. Credentials to create `Organization` and `Bank` tokens can be generated via the [Cybrid Sandbox](https://id.sandbox.cybrid.app). Access tokens can be generated for a `Customer` as well via the [Cybrid IdP](https://id.sandbox.cybrid.app) as well. An `Organization` access token applies broadly to the whole Organization and all of its `Banks`, whereas, a `Bank` access token is specific to an individual Bank. `Customer` tokens, similarly, are scoped to a specific customer in a bank. Both `Organization` and `Bank` tokens can be created using the OAuth Client Credential Grant flow. Each Organization and Bank has its own unique `Client ID` and `Secret` that allows for machine-to-machine authentication. A `Bank` can then generate `Customer` access tokens via API using our [Identities API](https://id.sandbox.cybrid.app/api/schema/swagger-ui). <font color=\"orange\">**⚠️ Never share your Client ID or Secret publicly or in your source code repository.**</font> Your `Client ID` and `Secret` can be exchanged for a time-limited `Bearer Token` by interacting with the Cybrid Identity Provider or through interacting with the **Authorize** button in this document. The following curl command can be used to quickly generate a `Bearer Token` for use in testing the API or demo applications. ``` # Example request when using Bank credentials curl -X POST https://id.sandbox.cybrid.app/oauth/token -d '{ \"grant_type\": \"client_credentials\", \"client_id\": \"<Your Client ID>\", \"client_secret\": \"<Your Secret>\", \"scope\": \"banks:read banks:write bank_applications:execute accounts:read accounts:execute customers:read customers:write customers:execute prices:read quotes:execute quotes:read trades:execute trades:read transfers:execute transfers:read external_bank_accounts:read external_bank_accounts:write external_bank_accounts:execute external_wallets:read external_wallets:execute workflows:read workflows:execute deposit_addresses:read deposit_addresses:execute deposit_bank_accounts:read deposit_bank_accounts:execute\" }' -H \"Content-Type: application/json\" # When using Organization credentials set `scope` to 'organizations:read organizations:write organization_applications:execute banks:read banks:write banks:execute bank_applications:execute users:read users:execute customers:read accounts:read prices:read quotes:execute quotes:read trades:execute trades:read transfers:read transfers:execute external_bank_accounts:read external_wallets:read workflows:read deposit_addresses:read deposit_bank_accounts:read' ``` <font color=\"orange\">**⚠️ Note: The above curl will create a bearer token with full scope access. Delete scopes if you'd like to restrict access.**</font> ## Authentication Scopes The Cybrid platform supports the use of scopes to control the level of access a token is limited to. Scopes do not grant access to resources; instead, they provide limits, in support of the least privilege principal. The following scopes are available on the platform and can be requested when generating either an Organization, Bank or Customer token. Generally speaking, the _Read_ scope is required to read and list resources, the _Write_ scope is required to update a resource and the _Execute_ scope is required to create a resource. | Resource | Read scope (Token Type) | Write scope (Token Type) | Execute scope (Token Type) | |-----------------------|------------------------------------------------------------|-----------------------------------------------|--------------------------------------------------| | Account | accounts:read (Organization, Bank, Customer) | | accounts:execute (Bank, Customer) | | Bank | banks:read (Organization, Bank) | banks:write (Organization, Bank) | banks:execute (Organization) | | Customer | customers:read (Organization, Bank, Customer) | customers:write (Bank, Customer) | customers:execute (Bank) | | Deposit Address | deposit_addresses:read (Organization, Bank, Customer) | deposit_addresses:write (Bank, Customer) | deposit_addresses:execute (Bank, Customer) | | External Bank Account | external_bank_accounts:read (Organization, Bank, Customer) | external_bank_accounts:write (Bank, Customer) | external_bank_accounts:execute (Bank, Customer) | | External Wallet | external_wallet:read (Organization, Bank, Customer) | | external_wallet:execute (Bank, Customer) | | Organization | organizations:read (Organization) | organizations:write (Organization) | | | User | users:read (Organization) | | users:execute (Organization) | | Price | prices:read (Bank, Customer) | | | | Quote | quotes:read (Organization, Bank, Customer) | | quotes:execute (Organization, Bank, Customer) | | Trade | trades:read (Organization, Bank, Customer) | | trades:execute (Organization, Bank, Customer) | | Transfer | transfers:read (Organization, Bank, Customer) | | transfers:execute (Organization, Bank, Customer) | | Workflow | workflows:read (Organization, Bank, Customer) | | workflows:execute (Bank, Customer) | ## Available Endpoints The available APIs for the [Identity](https://id.sandbox.cybrid.app/api/schema/swagger-ui), [Organization](https://organization.sandbox.cybrid.app/api/schema/swagger-ui) and [Bank](https://bank.sandbox.cybrid.app/api/schema/swagger-ui) API services are listed below: | API Service | Model | API Endpoint Path | Description | |--------------|----------------------|--------------------------------|---------------------------------------------------------------------------------------------------| | Identity | Bank | /api/bank_applications | Create and list banks | | Identity | CustomerToken | /api/customer_tokens | Create customer JWT access tokens | | Identity | Organization | /api/organization_applications | Create and list organizations | | Identity | Organization | /api/users | Create and list organization users | | Organization | Organization | /api/organizations | APIs to retrieve and update organization name | | Bank | Account | /api/accounts | Create and list accounts, which hold a specific asset for a customers | | Bank | Asset | /api/assets | Get a list of assets supported by the platform (ex: BTC, ETH) | | Bank | Bank | /api/banks | Create, update and list banks, the parent to customers, accounts, etc | | Bank | Customer | /api/customers | Create and list customers | | Bank | DepositAddress | /api/deposit_addresses | Create, get and list deposit addresses | | Bank | ExternalBankAccount | /api/external_bank_accounts | Create, get and list external bank accounts, which connect customer bank accounts to the platform | | Bank | ExternalWallet | /api/external_wallets | Create, get, list and delete external wallets, which connect customer wallets to the platform | | Bank | IdentityVerification | /api/identity_verifications | Create and list identity verifications, which are performed on customers for KYC | | Bank | Price | /api/prices | Get the current prices for assets on the platform | | Bank | Quote | /api/quotes | Create and list quotes, which are required to execute trades | | Bank | Symbol | /api/symbols | Get a list of symbols supported for trade (ex: BTC-USD) | | Bank | Trade | /api/trades | Create and list trades, which buy or sell cryptocurrency | | Bank | Transfer | /api/transfers | Create, get and list transfers (e.g., funding, book) | | Bank | Workflow | /api/workflows | Create, get and list workflows | ## Understanding Object Models & Endpoints **Organizations** An `Organization` is meant to represent the organization partnering with Cybrid to use our platform. An `Organization` typically does not directly interact with `customers`. Instead, an Organization has one or more `banks`, which encompass the financial service offerings of the platform. **Banks** A `Bank` is owned by an `Organization` and can be thought of as an environment or container for `customers` and product offerings. Banks are created in either `Sandbox` or `Production` mode, where `Sandbox` is the environment that you would test, prototype and build in prior to moving to `Production`. An `Organization` can have multiple `banks`, in either `Sandbox` or `Production` environments. A `Sandbox Bank` will be backed by stubbed data and process flows. For instance, funding source transfer processes as well as trades will be simulated rather than performed, however asset prices are representative of real-world values. You have an unlimited amount of simulated fiat currency for testing purposes. **Customers** `Customers` represent your banking users on the platform. At present, we offer support for `Individuals` as Customers. `Customers` must be verified (i.e., KYC'd) in our system before they can play any part on the platform, which means they must have an associated and a passing `Identity Verification`. See the Identity Verifications section for more details on how a customer can be verified. `Customers` must also have an `Account` to be able to transact, in the desired asset class. See the Accounts APIs for more details on setting up accounts for the customer.
5
5
 
6
- The version of the OpenAPI document: v0.110.6
6
+ The version of the OpenAPI document: v0.110.9
7
7
  Contact: support@cybrid.app
8
8
  Generated by: https://openapi-generator.tech
9
9
  OpenAPI Generator version: 6.0.0
@@ -3,12 +3,12 @@ current directory: /home/circleci/project/api-service-clients/api-platform-bank/
3
3
  creating Makefile
4
4
 
5
5
  current directory: /home/circleci/project/api-service-clients/api-platform-bank/ruby/vendor/bundle/ruby/3.2.0/gems/byebug-11.1.3/ext/byebug
6
- make DESTDIR\= sitearchdir\=./.gem.20231117-3581-vctdog sitelibdir\=./.gem.20231117-3581-vctdog clean
6
+ make DESTDIR\= sitearchdir\=./.gem.20231120-3580-4t91t3 sitelibdir\=./.gem.20231120-3580-4t91t3 clean
7
7
  make[1]: Entering directory '/home/circleci/project/api-service-clients/api-platform-bank/ruby/vendor/bundle/ruby/3.2.0/gems/byebug-11.1.3/ext/byebug'
8
8
  make[1]: Leaving directory '/home/circleci/project/api-service-clients/api-platform-bank/ruby/vendor/bundle/ruby/3.2.0/gems/byebug-11.1.3/ext/byebug'
9
9
 
10
10
  current directory: /home/circleci/project/api-service-clients/api-platform-bank/ruby/vendor/bundle/ruby/3.2.0/gems/byebug-11.1.3/ext/byebug
11
- make DESTDIR\= sitearchdir\=./.gem.20231117-3581-vctdog sitelibdir\=./.gem.20231117-3581-vctdog
11
+ make DESTDIR\= sitearchdir\=./.gem.20231120-3580-4t91t3 sitelibdir\=./.gem.20231120-3580-4t91t3
12
12
  make[1]: Entering directory '/home/circleci/project/api-service-clients/api-platform-bank/ruby/vendor/bundle/ruby/3.2.0/gems/byebug-11.1.3/ext/byebug'
13
13
  compiling breakpoint.c
14
14
  compiling byebug.c
@@ -39,12 +39,12 @@ linking shared-object byebug/byebug.so
39
39
  make[1]: Leaving directory '/home/circleci/project/api-service-clients/api-platform-bank/ruby/vendor/bundle/ruby/3.2.0/gems/byebug-11.1.3/ext/byebug'
40
40
 
41
41
  current directory: /home/circleci/project/api-service-clients/api-platform-bank/ruby/vendor/bundle/ruby/3.2.0/gems/byebug-11.1.3/ext/byebug
42
- make DESTDIR\= sitearchdir\=./.gem.20231117-3581-vctdog sitelibdir\=./.gem.20231117-3581-vctdog install
42
+ make DESTDIR\= sitearchdir\=./.gem.20231120-3580-4t91t3 sitelibdir\=./.gem.20231120-3580-4t91t3 install
43
43
  make[1]: Entering directory '/home/circleci/project/api-service-clients/api-platform-bank/ruby/vendor/bundle/ruby/3.2.0/gems/byebug-11.1.3/ext/byebug'
44
- /usr/bin/install -c -m 0755 byebug.so ./.gem.20231117-3581-vctdog/byebug
44
+ /usr/bin/install -c -m 0755 byebug.so ./.gem.20231120-3580-4t91t3/byebug
45
45
  make[1]: Leaving directory '/home/circleci/project/api-service-clients/api-platform-bank/ruby/vendor/bundle/ruby/3.2.0/gems/byebug-11.1.3/ext/byebug'
46
46
 
47
47
  current directory: /home/circleci/project/api-service-clients/api-platform-bank/ruby/vendor/bundle/ruby/3.2.0/gems/byebug-11.1.3/ext/byebug
48
- make DESTDIR\= sitearchdir\=./.gem.20231117-3581-vctdog sitelibdir\=./.gem.20231117-3581-vctdog clean
48
+ make DESTDIR\= sitearchdir\=./.gem.20231120-3580-4t91t3 sitelibdir\=./.gem.20231120-3580-4t91t3 clean
49
49
  make[1]: Entering directory '/home/circleci/project/api-service-clients/api-platform-bank/ruby/vendor/bundle/ruby/3.2.0/gems/byebug-11.1.3/ext/byebug'
50
50
  make[1]: Leaving directory '/home/circleci/project/api-service-clients/api-platform-bank/ruby/vendor/bundle/ruby/3.2.0/gems/byebug-11.1.3/ext/byebug'
@@ -10,12 +10,12 @@ creating extconf.h
10
10
  creating Makefile
11
11
 
12
12
  current directory: /home/circleci/project/api-service-clients/api-platform-bank/ruby/vendor/bundle/ruby/3.2.0/gems/ffi-1.16.3/ext/ffi_c
13
- make DESTDIR\= sitearchdir\=./.gem.20231117-3581-1zcz0c sitelibdir\=./.gem.20231117-3581-1zcz0c clean
13
+ make DESTDIR\= sitearchdir\=./.gem.20231120-3580-zbp9zp sitelibdir\=./.gem.20231120-3580-zbp9zp clean
14
14
  make[1]: Entering directory '/home/circleci/project/api-service-clients/api-platform-bank/ruby/vendor/bundle/ruby/3.2.0/gems/ffi-1.16.3/ext/ffi_c'
15
15
  make[1]: Leaving directory '/home/circleci/project/api-service-clients/api-platform-bank/ruby/vendor/bundle/ruby/3.2.0/gems/ffi-1.16.3/ext/ffi_c'
16
16
 
17
17
  current directory: /home/circleci/project/api-service-clients/api-platform-bank/ruby/vendor/bundle/ruby/3.2.0/gems/ffi-1.16.3/ext/ffi_c
18
- make DESTDIR\= sitearchdir\=./.gem.20231117-3581-1zcz0c sitelibdir\=./.gem.20231117-3581-1zcz0c
18
+ make DESTDIR\= sitearchdir\=./.gem.20231120-3580-zbp9zp sitelibdir\=./.gem.20231120-3580-zbp9zp
19
19
  make[1]: Entering directory '/home/circleci/project/api-service-clients/api-platform-bank/ruby/vendor/bundle/ruby/3.2.0/gems/ffi-1.16.3/ext/ffi_c'
20
20
  compiling AbstractMemory.c
21
21
  compiling ArrayType.c
@@ -44,12 +44,12 @@ linking shared-object ffi_c.so
44
44
  make[1]: Leaving directory '/home/circleci/project/api-service-clients/api-platform-bank/ruby/vendor/bundle/ruby/3.2.0/gems/ffi-1.16.3/ext/ffi_c'
45
45
 
46
46
  current directory: /home/circleci/project/api-service-clients/api-platform-bank/ruby/vendor/bundle/ruby/3.2.0/gems/ffi-1.16.3/ext/ffi_c
47
- make DESTDIR\= sitearchdir\=./.gem.20231117-3581-1zcz0c sitelibdir\=./.gem.20231117-3581-1zcz0c install
47
+ make DESTDIR\= sitearchdir\=./.gem.20231120-3580-zbp9zp sitelibdir\=./.gem.20231120-3580-zbp9zp install
48
48
  make[1]: Entering directory '/home/circleci/project/api-service-clients/api-platform-bank/ruby/vendor/bundle/ruby/3.2.0/gems/ffi-1.16.3/ext/ffi_c'
49
- /usr/bin/install -c -m 0755 ffi_c.so ./.gem.20231117-3581-1zcz0c
49
+ /usr/bin/install -c -m 0755 ffi_c.so ./.gem.20231120-3580-zbp9zp
50
50
  make[1]: Leaving directory '/home/circleci/project/api-service-clients/api-platform-bank/ruby/vendor/bundle/ruby/3.2.0/gems/ffi-1.16.3/ext/ffi_c'
51
51
 
52
52
  current directory: /home/circleci/project/api-service-clients/api-platform-bank/ruby/vendor/bundle/ruby/3.2.0/gems/ffi-1.16.3/ext/ffi_c
53
- make DESTDIR\= sitearchdir\=./.gem.20231117-3581-1zcz0c sitelibdir\=./.gem.20231117-3581-1zcz0c clean
53
+ make DESTDIR\= sitearchdir\=./.gem.20231120-3580-zbp9zp sitelibdir\=./.gem.20231120-3580-zbp9zp clean
54
54
  make[1]: Entering directory '/home/circleci/project/api-service-clients/api-platform-bank/ruby/vendor/bundle/ruby/3.2.0/gems/ffi-1.16.3/ext/ffi_c'
55
55
  make[1]: Leaving directory '/home/circleci/project/api-service-clients/api-platform-bank/ruby/vendor/bundle/ruby/3.2.0/gems/ffi-1.16.3/ext/ffi_c'
@@ -3,12 +3,12 @@ current directory: /home/circleci/project/api-service-clients/api-platform-bank/
3
3
  creating Makefile
4
4
 
5
5
  current directory: /home/circleci/project/api-service-clients/api-platform-bank/ruby/vendor/bundle/ruby/3.2.0/gems/jaro_winkler-1.5.6/ext/jaro_winkler
6
- make DESTDIR\= sitearchdir\=./.gem.20231117-3581-qsquol sitelibdir\=./.gem.20231117-3581-qsquol clean
6
+ make DESTDIR\= sitearchdir\=./.gem.20231120-3580-vy6nsp sitelibdir\=./.gem.20231120-3580-vy6nsp clean
7
7
  make[1]: Entering directory '/home/circleci/project/api-service-clients/api-platform-bank/ruby/vendor/bundle/ruby/3.2.0/gems/jaro_winkler-1.5.6/ext/jaro_winkler'
8
8
  make[1]: Leaving directory '/home/circleci/project/api-service-clients/api-platform-bank/ruby/vendor/bundle/ruby/3.2.0/gems/jaro_winkler-1.5.6/ext/jaro_winkler'
9
9
 
10
10
  current directory: /home/circleci/project/api-service-clients/api-platform-bank/ruby/vendor/bundle/ruby/3.2.0/gems/jaro_winkler-1.5.6/ext/jaro_winkler
11
- make DESTDIR\= sitearchdir\=./.gem.20231117-3581-qsquol sitelibdir\=./.gem.20231117-3581-qsquol
11
+ make DESTDIR\= sitearchdir\=./.gem.20231120-3580-vy6nsp sitelibdir\=./.gem.20231120-3580-vy6nsp
12
12
  make[1]: Entering directory '/home/circleci/project/api-service-clients/api-platform-bank/ruby/vendor/bundle/ruby/3.2.0/gems/jaro_winkler-1.5.6/ext/jaro_winkler'
13
13
  compiling adj_matrix.c
14
14
  adj_matrix.c: In function ‘adj_matrix_default’:
@@ -26,12 +26,12 @@ linking shared-object jaro_winkler/jaro_winkler_ext.so
26
26
  make[1]: Leaving directory '/home/circleci/project/api-service-clients/api-platform-bank/ruby/vendor/bundle/ruby/3.2.0/gems/jaro_winkler-1.5.6/ext/jaro_winkler'
27
27
 
28
28
  current directory: /home/circleci/project/api-service-clients/api-platform-bank/ruby/vendor/bundle/ruby/3.2.0/gems/jaro_winkler-1.5.6/ext/jaro_winkler
29
- make DESTDIR\= sitearchdir\=./.gem.20231117-3581-qsquol sitelibdir\=./.gem.20231117-3581-qsquol install
29
+ make DESTDIR\= sitearchdir\=./.gem.20231120-3580-vy6nsp sitelibdir\=./.gem.20231120-3580-vy6nsp install
30
30
  make[1]: Entering directory '/home/circleci/project/api-service-clients/api-platform-bank/ruby/vendor/bundle/ruby/3.2.0/gems/jaro_winkler-1.5.6/ext/jaro_winkler'
31
- /usr/bin/install -c -m 0755 jaro_winkler_ext.so ./.gem.20231117-3581-qsquol/jaro_winkler
31
+ /usr/bin/install -c -m 0755 jaro_winkler_ext.so ./.gem.20231120-3580-vy6nsp/jaro_winkler
32
32
  make[1]: Leaving directory '/home/circleci/project/api-service-clients/api-platform-bank/ruby/vendor/bundle/ruby/3.2.0/gems/jaro_winkler-1.5.6/ext/jaro_winkler'
33
33
 
34
34
  current directory: /home/circleci/project/api-service-clients/api-platform-bank/ruby/vendor/bundle/ruby/3.2.0/gems/jaro_winkler-1.5.6/ext/jaro_winkler
35
- make DESTDIR\= sitearchdir\=./.gem.20231117-3581-qsquol sitelibdir\=./.gem.20231117-3581-qsquol clean
35
+ make DESTDIR\= sitearchdir\=./.gem.20231120-3580-vy6nsp sitelibdir\=./.gem.20231120-3580-vy6nsp clean
36
36
  make[1]: Entering directory '/home/circleci/project/api-service-clients/api-platform-bank/ruby/vendor/bundle/ruby/3.2.0/gems/jaro_winkler-1.5.6/ext/jaro_winkler'
37
37
  make[1]: Leaving directory '/home/circleci/project/api-service-clients/api-platform-bank/ruby/vendor/bundle/ruby/3.2.0/gems/jaro_winkler-1.5.6/ext/jaro_winkler'
@@ -5,7 +5,7 @@ checking for yaml_get_version() in -lyaml... yes
5
5
  creating Makefile
6
6
 
7
7
  current directory: /home/circleci/project/api-service-clients/api-platform-bank/ruby/vendor/bundle/ruby/3.2.0/gems/psych-5.1.1.1/ext/psych
8
- make DESTDIR\= sitearchdir\=./.gem.20231117-3581-faumfb sitelibdir\=./.gem.20231117-3581-faumfb clean
8
+ make DESTDIR\= sitearchdir\=./.gem.20231120-3580-ui9atf sitelibdir\=./.gem.20231120-3580-ui9atf clean
9
9
  make[1]: Entering directory '/home/circleci/project/api-service-clients/api-platform-bank/ruby/vendor/bundle/ruby/3.2.0/gems/psych-5.1.1.1/ext/psych'
10
10
  cd libyaml && make clean
11
11
  /bin/sh: 1: cd: can't cd to libyaml
@@ -13,7 +13,7 @@ make[1]: [Makefile:283: clean-so] Error 2 (ignored)
13
13
  make[1]: Leaving directory '/home/circleci/project/api-service-clients/api-platform-bank/ruby/vendor/bundle/ruby/3.2.0/gems/psych-5.1.1.1/ext/psych'
14
14
 
15
15
  current directory: /home/circleci/project/api-service-clients/api-platform-bank/ruby/vendor/bundle/ruby/3.2.0/gems/psych-5.1.1.1/ext/psych
16
- make DESTDIR\= sitearchdir\=./.gem.20231117-3581-faumfb sitelibdir\=./.gem.20231117-3581-faumfb
16
+ make DESTDIR\= sitearchdir\=./.gem.20231120-3580-ui9atf sitelibdir\=./.gem.20231120-3580-ui9atf
17
17
  make[1]: Entering directory '/home/circleci/project/api-service-clients/api-platform-bank/ruby/vendor/bundle/ruby/3.2.0/gems/psych-5.1.1.1/ext/psych'
18
18
  compiling psych.c
19
19
  compiling psych_emitter.c
@@ -24,13 +24,13 @@ linking shared-object psych.so
24
24
  make[1]: Leaving directory '/home/circleci/project/api-service-clients/api-platform-bank/ruby/vendor/bundle/ruby/3.2.0/gems/psych-5.1.1.1/ext/psych'
25
25
 
26
26
  current directory: /home/circleci/project/api-service-clients/api-platform-bank/ruby/vendor/bundle/ruby/3.2.0/gems/psych-5.1.1.1/ext/psych
27
- make DESTDIR\= sitearchdir\=./.gem.20231117-3581-faumfb sitelibdir\=./.gem.20231117-3581-faumfb install
27
+ make DESTDIR\= sitearchdir\=./.gem.20231120-3580-ui9atf sitelibdir\=./.gem.20231120-3580-ui9atf install
28
28
  make[1]: Entering directory '/home/circleci/project/api-service-clients/api-platform-bank/ruby/vendor/bundle/ruby/3.2.0/gems/psych-5.1.1.1/ext/psych'
29
- /usr/bin/install -c -m 0755 psych.so ./.gem.20231117-3581-faumfb
29
+ /usr/bin/install -c -m 0755 psych.so ./.gem.20231120-3580-ui9atf
30
30
  make[1]: Leaving directory '/home/circleci/project/api-service-clients/api-platform-bank/ruby/vendor/bundle/ruby/3.2.0/gems/psych-5.1.1.1/ext/psych'
31
31
 
32
32
  current directory: /home/circleci/project/api-service-clients/api-platform-bank/ruby/vendor/bundle/ruby/3.2.0/gems/psych-5.1.1.1/ext/psych
33
- make DESTDIR\= sitearchdir\=./.gem.20231117-3581-faumfb sitelibdir\=./.gem.20231117-3581-faumfb clean
33
+ make DESTDIR\= sitearchdir\=./.gem.20231120-3580-ui9atf sitelibdir\=./.gem.20231120-3580-ui9atf clean
34
34
  make[1]: Entering directory '/home/circleci/project/api-service-clients/api-platform-bank/ruby/vendor/bundle/ruby/3.2.0/gems/psych-5.1.1.1/ext/psych'
35
35
  cd libyaml && make clean
36
36
  /bin/sh: 1: cd: can't cd to libyaml
@@ -3,24 +3,24 @@ current directory: /home/circleci/project/api-service-clients/api-platform-bank/
3
3
  creating Makefile
4
4
 
5
5
  current directory: /home/circleci/project/api-service-clients/api-platform-bank/ruby/vendor/bundle/ruby/3.2.0/gems/racc-1.7.3/ext/racc/cparse
6
- make DESTDIR\= sitearchdir\=./.gem.20231117-3581-tcl9h7 sitelibdir\=./.gem.20231117-3581-tcl9h7 clean
6
+ make DESTDIR\= sitearchdir\=./.gem.20231120-3580-ihno0s sitelibdir\=./.gem.20231120-3580-ihno0s clean
7
7
  make[1]: Entering directory '/home/circleci/project/api-service-clients/api-platform-bank/ruby/vendor/bundle/ruby/3.2.0/gems/racc-1.7.3/ext/racc/cparse'
8
8
  make[1]: Leaving directory '/home/circleci/project/api-service-clients/api-platform-bank/ruby/vendor/bundle/ruby/3.2.0/gems/racc-1.7.3/ext/racc/cparse'
9
9
 
10
10
  current directory: /home/circleci/project/api-service-clients/api-platform-bank/ruby/vendor/bundle/ruby/3.2.0/gems/racc-1.7.3/ext/racc/cparse
11
- make DESTDIR\= sitearchdir\=./.gem.20231117-3581-tcl9h7 sitelibdir\=./.gem.20231117-3581-tcl9h7
11
+ make DESTDIR\= sitearchdir\=./.gem.20231120-3580-ihno0s sitelibdir\=./.gem.20231120-3580-ihno0s
12
12
  make[1]: Entering directory '/home/circleci/project/api-service-clients/api-platform-bank/ruby/vendor/bundle/ruby/3.2.0/gems/racc-1.7.3/ext/racc/cparse'
13
13
  compiling cparse.c
14
14
  linking shared-object racc/cparse.so
15
15
  make[1]: Leaving directory '/home/circleci/project/api-service-clients/api-platform-bank/ruby/vendor/bundle/ruby/3.2.0/gems/racc-1.7.3/ext/racc/cparse'
16
16
 
17
17
  current directory: /home/circleci/project/api-service-clients/api-platform-bank/ruby/vendor/bundle/ruby/3.2.0/gems/racc-1.7.3/ext/racc/cparse
18
- make DESTDIR\= sitearchdir\=./.gem.20231117-3581-tcl9h7 sitelibdir\=./.gem.20231117-3581-tcl9h7 install
18
+ make DESTDIR\= sitearchdir\=./.gem.20231120-3580-ihno0s sitelibdir\=./.gem.20231120-3580-ihno0s install
19
19
  make[1]: Entering directory '/home/circleci/project/api-service-clients/api-platform-bank/ruby/vendor/bundle/ruby/3.2.0/gems/racc-1.7.3/ext/racc/cparse'
20
- /usr/bin/install -c -m 0755 cparse.so ./.gem.20231117-3581-tcl9h7/racc
20
+ /usr/bin/install -c -m 0755 cparse.so ./.gem.20231120-3580-ihno0s/racc
21
21
  make[1]: Leaving directory '/home/circleci/project/api-service-clients/api-platform-bank/ruby/vendor/bundle/ruby/3.2.0/gems/racc-1.7.3/ext/racc/cparse'
22
22
 
23
23
  current directory: /home/circleci/project/api-service-clients/api-platform-bank/ruby/vendor/bundle/ruby/3.2.0/gems/racc-1.7.3/ext/racc/cparse
24
- make DESTDIR\= sitearchdir\=./.gem.20231117-3581-tcl9h7 sitelibdir\=./.gem.20231117-3581-tcl9h7 clean
24
+ make DESTDIR\= sitearchdir\=./.gem.20231120-3580-ihno0s sitelibdir\=./.gem.20231120-3580-ihno0s clean
25
25
  make[1]: Entering directory '/home/circleci/project/api-service-clients/api-platform-bank/ruby/vendor/bundle/ruby/3.2.0/gems/racc-1.7.3/ext/racc/cparse'
26
26
  make[1]: Leaving directory '/home/circleci/project/api-service-clients/api-platform-bank/ruby/vendor/bundle/ruby/3.2.0/gems/racc-1.7.3/ext/racc/cparse'
@@ -3,24 +3,24 @@ current directory: /home/circleci/project/api-service-clients/api-platform-bank/
3
3
  creating Makefile
4
4
 
5
5
  current directory: /home/circleci/project/api-service-clients/api-platform-bank/ruby/vendor/bundle/ruby/3.2.0/gems/stringio-3.0.9/ext/stringio
6
- make DESTDIR\= sitearchdir\=./.gem.20231117-3581-3thrn5 sitelibdir\=./.gem.20231117-3581-3thrn5 clean
6
+ make DESTDIR\= sitearchdir\=./.gem.20231120-3580-d9cbv7 sitelibdir\=./.gem.20231120-3580-d9cbv7 clean
7
7
  make[1]: Entering directory '/home/circleci/project/api-service-clients/api-platform-bank/ruby/vendor/bundle/ruby/3.2.0/gems/stringio-3.0.9/ext/stringio'
8
8
  make[1]: Leaving directory '/home/circleci/project/api-service-clients/api-platform-bank/ruby/vendor/bundle/ruby/3.2.0/gems/stringio-3.0.9/ext/stringio'
9
9
 
10
10
  current directory: /home/circleci/project/api-service-clients/api-platform-bank/ruby/vendor/bundle/ruby/3.2.0/gems/stringio-3.0.9/ext/stringio
11
- make DESTDIR\= sitearchdir\=./.gem.20231117-3581-3thrn5 sitelibdir\=./.gem.20231117-3581-3thrn5
11
+ make DESTDIR\= sitearchdir\=./.gem.20231120-3580-d9cbv7 sitelibdir\=./.gem.20231120-3580-d9cbv7
12
12
  make[1]: Entering directory '/home/circleci/project/api-service-clients/api-platform-bank/ruby/vendor/bundle/ruby/3.2.0/gems/stringio-3.0.9/ext/stringio'
13
13
  compiling stringio.c
14
14
  linking shared-object stringio.so
15
15
  make[1]: Leaving directory '/home/circleci/project/api-service-clients/api-platform-bank/ruby/vendor/bundle/ruby/3.2.0/gems/stringio-3.0.9/ext/stringio'
16
16
 
17
17
  current directory: /home/circleci/project/api-service-clients/api-platform-bank/ruby/vendor/bundle/ruby/3.2.0/gems/stringio-3.0.9/ext/stringio
18
- make DESTDIR\= sitearchdir\=./.gem.20231117-3581-3thrn5 sitelibdir\=./.gem.20231117-3581-3thrn5 install
18
+ make DESTDIR\= sitearchdir\=./.gem.20231120-3580-d9cbv7 sitelibdir\=./.gem.20231120-3580-d9cbv7 install
19
19
  make[1]: Entering directory '/home/circleci/project/api-service-clients/api-platform-bank/ruby/vendor/bundle/ruby/3.2.0/gems/stringio-3.0.9/ext/stringio'
20
- /usr/bin/install -c -m 0755 stringio.so ./.gem.20231117-3581-3thrn5
20
+ /usr/bin/install -c -m 0755 stringio.so ./.gem.20231120-3580-d9cbv7
21
21
  make[1]: Leaving directory '/home/circleci/project/api-service-clients/api-platform-bank/ruby/vendor/bundle/ruby/3.2.0/gems/stringio-3.0.9/ext/stringio'
22
22
 
23
23
  current directory: /home/circleci/project/api-service-clients/api-platform-bank/ruby/vendor/bundle/ruby/3.2.0/gems/stringio-3.0.9/ext/stringio
24
- make DESTDIR\= sitearchdir\=./.gem.20231117-3581-3thrn5 sitelibdir\=./.gem.20231117-3581-3thrn5 clean
24
+ make DESTDIR\= sitearchdir\=./.gem.20231120-3580-d9cbv7 sitelibdir\=./.gem.20231120-3580-d9cbv7 clean
25
25
  make[1]: Entering directory '/home/circleci/project/api-service-clients/api-platform-bank/ruby/vendor/bundle/ruby/3.2.0/gems/stringio-3.0.9/ext/stringio'
26
26
  make[1]: Leaving directory '/home/circleci/project/api-service-clients/api-platform-bank/ruby/vendor/bundle/ruby/3.2.0/gems/stringio-3.0.9/ext/stringio'
@@ -0,0 +1,30 @@
1
+ name: CI
2
+ on: [push, pull_request]
3
+ jobs:
4
+ build:
5
+ env:
6
+ BUNDLE_GEMFILE: Gemfile
7
+ runs-on: ${{ matrix.os }}-latest
8
+ strategy:
9
+ fail-fast: false
10
+ matrix:
11
+ os: [ubuntu, macos]
12
+ ruby-version: ['2.5', '2.6', '2.7', '3.0', '3.1', truffleruby]
13
+ steps:
14
+ - uses: actions/checkout@v3
15
+ - name: Install libcurl header
16
+ run: |
17
+ if ${{ matrix.os == 'macos' }}
18
+ then
19
+ brew install curl
20
+ else
21
+ sudo apt update && sudo apt install -y --no-install-recommends libcurl4-openssl-dev
22
+ fi
23
+ - name: Set up Ruby ${{ matrix.ruby-version }}
24
+ uses: ruby/setup-ruby@v1
25
+ with:
26
+ ruby-version: ${{ matrix.ruby-version }}
27
+ bundler-cache: true
28
+ - name: Run tests
29
+ run: |
30
+ bundle exec rake
@@ -0,0 +1,33 @@
1
+ name: Experimental
2
+ on: [push, pull_request]
3
+ jobs:
4
+ build:
5
+ env:
6
+ BUNDLE_GEMFILE: Gemfile
7
+ runs-on: ${{ matrix.os }}-latest
8
+ strategy:
9
+ fail-fast: false
10
+ matrix:
11
+ os: [ubuntu, macos]
12
+ ruby-version:
13
+ - ruby-head
14
+ - jruby-head
15
+ - truffleruby-head
16
+ steps:
17
+ - uses: actions/checkout@v3
18
+ - name: Install libcurl header
19
+ run: |
20
+ if ${{ matrix.os == 'macos' }}
21
+ then
22
+ brew install curl
23
+ else
24
+ sudo apt update && sudo apt install -y --no-install-recommends libcurl4-openssl-dev
25
+ fi
26
+ - name: Set up Ruby ${{ matrix.ruby-version }}
27
+ uses: ruby/setup-ruby@v1
28
+ with:
29
+ ruby-version: ${{ matrix.ruby-version }}
30
+ bundler-cache: true
31
+ - name: Run tests
32
+ run: |
33
+ bundle exec rake
@@ -2,7 +2,11 @@
2
2
 
3
3
  ## Master
4
4
 
5
- [Full Changelog](http://github.com/typhoeus/typhoeus/compare/v1.4.0...master)
5
+ [Full Changelog](http://github.com/typhoeus/typhoeus/compare/v1.4.1...master)
6
+
7
+ ## 1.4.1
8
+
9
+ [Full Changelog](http://github.com/typhoeus/typhoeus/compare/v1.4.0...v1.4.1)
6
10
 
7
11
  ## 1.4.0
8
12
 
@@ -15,10 +15,14 @@ group :development, :test do
15
15
  gem "sinatra", "~> 1.3"
16
16
 
17
17
  if Gem.ruby_version >= Gem::Version.new("1.9.0")
18
- gem "faraday", ">= 0.9"
18
+ gem "faraday", ">= 0.9", "< 2.0"
19
19
  gem "dalli", "~> 2.0"
20
20
  end
21
21
 
22
+ if Gem.ruby_version >= Gem::Version.new("3.0.0")
23
+ gem 'webrick'
24
+ end
25
+
22
26
  gem "redis", "~> 3.0"
23
27
 
24
28
  if RUBY_PLATFORM == "java"
@@ -1,4 +1,4 @@
1
- # Typhoeus [![Build Status](https://img.shields.io/travis/typhoeus/typhoeus/master.svg)](https://travis-ci.org/typhoeus/typhoeus) [![Code Climate](https://img.shields.io/codeclimate/maintainability/typhoeus/typhoeus.svg)](https://codeclimate.com/github/typhoeus/typhoeus) [![Gem Version](https://img.shields.io/gem/v/typhoeus.svg)](https://rubygems.org/gems/typhoeus)
1
+ # Typhoeus [![CI](https://github.com/typhoeus/typhoeus/actions/workflows/ci.yml/badge.svg)](https://github.com/typhoeus/typhoeus/actions/workflows/ci.yml) [![Experimental](https://github.com/typhoeus/typhoeus/actions/workflows/experimental.yml/badge.svg)](https://github.com/typhoeus/typhoeus/actions/workflows/experimental.yml) [![Code Climate](https://img.shields.io/codeclimate/maintainability/typhoeus/typhoeus.svg)](https://codeclimate.com/github/typhoeus/typhoeus) [![Gem Version](https://img.shields.io/gem/v/typhoeus.svg)](https://rubygems.org/gems/typhoeus)
2
2
 
3
3
  Like a modern code version of the mythical beast with 100 serpent heads, Typhoeus runs HTTP requests in parallel while cleanly encapsulating handling logic.
4
4
 
@@ -19,11 +19,10 @@ hydra.run
19
19
  ```
20
20
 
21
21
  ## Installation
22
- Add the following line to your Gemfile:
22
+ Run:
23
23
  ```
24
- gem "typhoeus"
24
+ bundle add typhoeus
25
25
  ```
26
- Then run `bundle install`
27
26
 
28
27
  Or install it yourself as:
29
28
 
@@ -33,8 +32,7 @@ gem install typhoeus
33
32
 
34
33
  ## Project Tracking
35
34
 
36
- * [Documentation](http://rubydoc.info/github/typhoeus/typhoeus/frames/Typhoeus) (GitHub master)
37
- * [Mailing list](http://groups.google.com/group/typhoeus)
35
+ * [API Documentation](https://rubydoc.info/github/typhoeus/typhoeus/frames/Typhoeus) (GitHub master)
38
36
 
39
37
  ## Usage
40
38
 
@@ -350,6 +348,8 @@ Typhoeus.get("www.example.com").cached?
350
348
  For use with [Dalli](https://github.com/mperham/dalli):
351
349
 
352
350
  ```ruby
351
+ require "typhoeus/cache/dalli"
352
+
353
353
  dalli = Dalli::Client.new(...)
354
354
  Typhoeus::Config.cache = Typhoeus::Cache::Dalli.new(dalli)
355
355
  ```
@@ -357,12 +357,16 @@ Typhoeus::Config.cache = Typhoeus::Cache::Dalli.new(dalli)
357
357
  For use with Rails:
358
358
 
359
359
  ```ruby
360
+ require "typhoeus/cache/rails"
361
+
360
362
  Typhoeus::Config.cache = Typhoeus::Cache::Rails.new
361
363
  ```
362
364
 
363
365
  For use with [Redis](https://github.com/redis/redis-rb):
364
366
 
365
367
  ```ruby
368
+ require "typhoeus/cache/redis"
369
+
366
370
  redis = Redis.new(...)
367
371
  Typhoeus::Config.cache = Typhoeus::Cache::Redis.new(redis)
368
372
  ```
@@ -44,6 +44,22 @@ module Typhoeus
44
44
  # @see http://curl.haxx.se/libcurl/c/curl_easy_setopt.html#CURLOPTVERBOSE
45
45
  attr_accessor :verbose
46
46
 
47
+ # Defines the default HTTP timeout for the entire request in seconds
48
+ # See README for more details about timeouts
49
+ #
50
+ # @return [ Integer, Float ]
51
+ #
52
+ # @see https://curl.haxx.se/libcurl/c/curl_easy_setopt#CURLOPTTIMEOUT
53
+ attr_accessor :timeout
54
+
55
+ # Defines the default HTTP timeout for the connection phase in seconds
56
+ # See README for more details about timeouts
57
+ #
58
+ # @return [ Integer, Float ]
59
+ #
60
+ # @see https://curl.haxx.se/libcurl/c/curl_easy_setopt.html#CURLOPTCONNECTTIMEOUT
61
+ attr_accessor :connecttimeout
62
+
47
63
  # Defines whether requests are cached.
48
64
  #
49
65
  # @return [ Object ]