cybrid_api_bank_ruby 0.119.34 → 0.119.36

Sign up to get free protection for your applications and to get access to all the features.
Files changed (367) 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/counterparties_bank_api.rb +1 -1
  9. data/lib/cybrid_api_bank_ruby/api/customers_bank_api.rb +1 -1
  10. data/lib/cybrid_api_bank_ruby/api/deposit_addresses_bank_api.rb +1 -1
  11. data/lib/cybrid_api_bank_ruby/api/deposit_bank_accounts_bank_api.rb +1 -1
  12. data/lib/cybrid_api_bank_ruby/api/external_bank_accounts_bank_api.rb +1 -1
  13. data/lib/cybrid_api_bank_ruby/api/external_wallets_bank_api.rb +1 -1
  14. data/lib/cybrid_api_bank_ruby/api/identity_verifications_bank_api.rb +1 -1
  15. data/lib/cybrid_api_bank_ruby/api/invoices_bank_api.rb +1 -1
  16. data/lib/cybrid_api_bank_ruby/api/payment_instructions_bank_api.rb +1 -1
  17. data/lib/cybrid_api_bank_ruby/api/prices_bank_api.rb +1 -1
  18. data/lib/cybrid_api_bank_ruby/api/quotes_bank_api.rb +1 -1
  19. data/lib/cybrid_api_bank_ruby/api/symbols_bank_api.rb +1 -1
  20. data/lib/cybrid_api_bank_ruby/api/trades_bank_api.rb +1 -1
  21. data/lib/cybrid_api_bank_ruby/api/transfers_bank_api.rb +1 -1
  22. data/lib/cybrid_api_bank_ruby/api/workflows_bank_api.rb +1 -1
  23. data/lib/cybrid_api_bank_ruby/api_client.rb +1 -1
  24. data/lib/cybrid_api_bank_ruby/api_error.rb +1 -1
  25. data/lib/cybrid_api_bank_ruby/configuration.rb +1 -1
  26. data/lib/cybrid_api_bank_ruby/models/account_bank_model.rb +1 -1
  27. data/lib/cybrid_api_bank_ruby/models/account_list_bank_model.rb +1 -1
  28. data/lib/cybrid_api_bank_ruby/models/account_state_bank_model.rb +1 -1
  29. data/lib/cybrid_api_bank_ruby/models/account_type_bank_model.rb +1 -1
  30. data/lib/cybrid_api_bank_ruby/models/activity_limit_bank_model.rb +1 -1
  31. data/lib/cybrid_api_bank_ruby/models/activity_type_bank_model.rb +1 -1
  32. data/lib/cybrid_api_bank_ruby/models/asset_bank_model.rb +1 -1
  33. data/lib/cybrid_api_bank_ruby/models/asset_list_bank_model.rb +1 -1
  34. data/lib/cybrid_api_bank_ruby/models/asset_types_bank_model.rb +1 -1
  35. data/lib/cybrid_api_bank_ruby/models/bank_bank_model.rb +1 -1
  36. data/lib/cybrid_api_bank_ruby/models/bank_feature_bank_model.rb +1 -1
  37. data/lib/cybrid_api_bank_ruby/models/bank_list_bank_model.rb +1 -1
  38. data/lib/cybrid_api_bank_ruby/models/bank_type_bank_model.rb +1 -1
  39. data/lib/cybrid_api_bank_ruby/models/compliance_check_bank_model.rb +1 -1
  40. data/lib/cybrid_api_bank_ruby/models/compliance_check_outcome_bank_model.rb +1 -1
  41. data/lib/cybrid_api_bank_ruby/models/compliance_check_type_bank_model.rb +1 -1
  42. data/lib/cybrid_api_bank_ruby/models/compliance_decision_bank_model.rb +1 -1
  43. data/lib/cybrid_api_bank_ruby/models/compliance_decision_state_bank_model.rb +1 -1
  44. data/lib/cybrid_api_bank_ruby/models/compliance_decision_type_bank_model.rb +1 -1
  45. data/lib/cybrid_api_bank_ruby/models/counterparty_address_bank_model.rb +1 -1
  46. data/lib/cybrid_api_bank_ruby/models/counterparty_aliases_inner_bank_model.rb +1 -1
  47. data/lib/cybrid_api_bank_ruby/models/counterparty_bank_model.rb +1 -1
  48. data/lib/cybrid_api_bank_ruby/models/counterparty_list_bank_model.rb +1 -1
  49. data/lib/cybrid_api_bank_ruby/models/counterparty_name_bank_model.rb +1 -1
  50. data/lib/cybrid_api_bank_ruby/models/counterparty_state_bank_model.rb +1 -1
  51. data/lib/cybrid_api_bank_ruby/models/counterparty_type_bank_model.rb +1 -1
  52. data/lib/cybrid_api_bank_ruby/models/customer_address_bank_model.rb +1 -1
  53. data/lib/cybrid_api_bank_ruby/models/customer_aliases_inner_bank_model.rb +1 -1
  54. data/lib/cybrid_api_bank_ruby/models/customer_bank_model.rb +1 -1
  55. data/lib/cybrid_api_bank_ruby/models/customer_list_bank_model.rb +1 -1
  56. data/lib/cybrid_api_bank_ruby/models/customer_name_bank_model.rb +1 -1
  57. data/lib/cybrid_api_bank_ruby/models/customer_state_bank_model.rb +1 -1
  58. data/lib/cybrid_api_bank_ruby/models/customer_type_bank_model.rb +1 -1
  59. data/lib/cybrid_api_bank_ruby/models/deposit_address_bank_model.rb +1 -1
  60. data/lib/cybrid_api_bank_ruby/models/deposit_address_format_bank_model.rb +1 -1
  61. data/lib/cybrid_api_bank_ruby/models/deposit_address_list_bank_model.rb +1 -1
  62. data/lib/cybrid_api_bank_ruby/models/deposit_address_state_bank_model.rb +1 -1
  63. data/lib/cybrid_api_bank_ruby/models/deposit_bank_account_account_details_inner_bank_model.rb +1 -1
  64. data/lib/cybrid_api_bank_ruby/models/deposit_bank_account_bank_model.rb +1 -1
  65. data/lib/cybrid_api_bank_ruby/models/deposit_bank_account_counterparty_address_bank_model.rb +1 -1
  66. data/lib/cybrid_api_bank_ruby/models/deposit_bank_account_list_bank_model.rb +1 -1
  67. data/lib/cybrid_api_bank_ruby/models/deposit_bank_account_routing_details_inner_bank_model.rb +1 -1
  68. data/lib/cybrid_api_bank_ruby/models/deposit_bank_account_routing_number_type_bank_model.rb +1 -1
  69. data/lib/cybrid_api_bank_ruby/models/deposit_bank_account_state_bank_model.rb +1 -1
  70. data/lib/cybrid_api_bank_ruby/models/error_response_bank_model.rb +1 -1
  71. data/lib/cybrid_api_bank_ruby/models/external_bank_account_balances_bank_model.rb +1 -1
  72. data/lib/cybrid_api_bank_ruby/models/external_bank_account_bank_model.rb +1 -1
  73. data/lib/cybrid_api_bank_ruby/models/external_bank_account_kind_bank_model.rb +1 -1
  74. data/lib/cybrid_api_bank_ruby/models/external_bank_account_list_bank_model.rb +1 -1
  75. data/lib/cybrid_api_bank_ruby/models/external_bank_account_pii_inner_addresses_inner_bank_model.rb +1 -1
  76. data/lib/cybrid_api_bank_ruby/models/external_bank_account_pii_inner_bank_model.rb +1 -1
  77. data/lib/cybrid_api_bank_ruby/models/external_bank_account_state_bank_model.rb +1 -1
  78. data/lib/cybrid_api_bank_ruby/models/external_wallet_bank_model.rb +1 -1
  79. data/lib/cybrid_api_bank_ruby/models/external_wallet_environment_bank_model.rb +1 -1
  80. data/lib/cybrid_api_bank_ruby/models/external_wallet_list_bank_model.rb +1 -1
  81. data/lib/cybrid_api_bank_ruby/models/external_wallet_state_bank_model.rb +1 -1
  82. data/lib/cybrid_api_bank_ruby/models/identification_number_bank_model.rb +1 -1
  83. data/lib/cybrid_api_bank_ruby/models/identity_verification_bank_model.rb +1 -1
  84. data/lib/cybrid_api_bank_ruby/models/identity_verification_list_bank_model.rb +1 -1
  85. data/lib/cybrid_api_bank_ruby/models/identity_verification_method_bank_model.rb +1 -1
  86. data/lib/cybrid_api_bank_ruby/models/identity_verification_outcome_bank_model.rb +1 -1
  87. data/lib/cybrid_api_bank_ruby/models/identity_verification_persona_state_bank_model.rb +1 -1
  88. data/lib/cybrid_api_bank_ruby/models/identity_verification_state_bank_model.rb +1 -1
  89. data/lib/cybrid_api_bank_ruby/models/identity_verification_type_bank_model.rb +1 -1
  90. data/lib/cybrid_api_bank_ruby/models/identity_verification_with_details_bank_model.rb +1 -1
  91. data/lib/cybrid_api_bank_ruby/models/identity_verification_with_details_pii_address_bank_model.rb +1 -1
  92. data/lib/cybrid_api_bank_ruby/models/identity_verification_with_details_pii_bank_model.rb +1 -1
  93. data/lib/cybrid_api_bank_ruby/models/identity_verification_with_details_pii_name_bank_model.rb +1 -1
  94. data/lib/cybrid_api_bank_ruby/models/invoice_bank_model.rb +1 -1
  95. data/lib/cybrid_api_bank_ruby/models/invoice_list_bank_model.rb +1 -1
  96. data/lib/cybrid_api_bank_ruby/models/patch_bank_bank_model.rb +1 -1
  97. data/lib/cybrid_api_bank_ruby/models/patch_customer_bank_model.rb +1 -1
  98. data/lib/cybrid_api_bank_ruby/models/patch_external_bank_account_bank_model.rb +1 -1
  99. data/lib/cybrid_api_bank_ruby/models/payment_instruction_bank_model.rb +1 -1
  100. data/lib/cybrid_api_bank_ruby/models/payment_instruction_list_bank_model.rb +1 -1
  101. data/lib/cybrid_api_bank_ruby/models/post_account_bank_model.rb +1 -1
  102. data/lib/cybrid_api_bank_ruby/models/post_bank_bank_model.rb +1 -1
  103. data/lib/cybrid_api_bank_ruby/models/post_counterparty_bank_model.rb +1 -1
  104. data/lib/cybrid_api_bank_ruby/models/post_counterparty_name_bank_model.rb +1 -1
  105. data/lib/cybrid_api_bank_ruby/models/post_customer_address_bank_model.rb +1 -1
  106. data/lib/cybrid_api_bank_ruby/models/post_customer_bank_model.rb +1 -1
  107. data/lib/cybrid_api_bank_ruby/models/post_customer_name_bank_model.rb +1 -1
  108. data/lib/cybrid_api_bank_ruby/models/post_deposit_address_bank_model.rb +1 -1
  109. data/lib/cybrid_api_bank_ruby/models/post_deposit_bank_account_bank_model.rb +1 -1
  110. data/lib/cybrid_api_bank_ruby/models/post_external_bank_account_bank_model.rb +1 -1
  111. data/lib/cybrid_api_bank_ruby/models/post_external_bank_account_counterparty_address_bank_model.rb +1 -1
  112. data/lib/cybrid_api_bank_ruby/models/post_external_bank_account_counterparty_bank_account_bank_model.rb +1 -1
  113. data/lib/cybrid_api_bank_ruby/models/post_external_bank_account_counterparty_name_bank_model.rb +1 -1
  114. data/lib/cybrid_api_bank_ruby/models/post_external_wallet_bank_model.rb +1 -1
  115. data/lib/cybrid_api_bank_ruby/models/post_fee_bank_model.rb +1 -1
  116. data/lib/cybrid_api_bank_ruby/models/post_identification_number_bank_model.rb +1 -1
  117. data/lib/cybrid_api_bank_ruby/models/post_identity_verification_address_bank_model.rb +1 -1
  118. data/lib/cybrid_api_bank_ruby/models/post_identity_verification_bank_model.rb +1 -1
  119. data/lib/cybrid_api_bank_ruby/models/post_identity_verification_name_bank_model.rb +1 -1
  120. data/lib/cybrid_api_bank_ruby/models/post_invoice_bank_model.rb +1 -1
  121. data/lib/cybrid_api_bank_ruby/models/post_payment_instruction_bank_model.rb +1 -1
  122. data/lib/cybrid_api_bank_ruby/models/post_quote_bank_model.rb +1 -1
  123. data/lib/cybrid_api_bank_ruby/models/post_trade_bank_model.rb +1 -1
  124. data/lib/cybrid_api_bank_ruby/models/post_transfer_bank_model.rb +1 -1
  125. data/lib/cybrid_api_bank_ruby/models/post_transfer_participant_bank_model.rb +1 -1
  126. data/lib/cybrid_api_bank_ruby/models/post_workflow_bank_model.rb +1 -1
  127. data/lib/cybrid_api_bank_ruby/models/quote_bank_model.rb +1 -1
  128. data/lib/cybrid_api_bank_ruby/models/quote_list_bank_model.rb +1 -1
  129. data/lib/cybrid_api_bank_ruby/models/quote_side_bank_model.rb +1 -1
  130. data/lib/cybrid_api_bank_ruby/models/quote_type_bank_model.rb +1 -1
  131. data/lib/cybrid_api_bank_ruby/models/symbol_price_bank_model.rb +1 -1
  132. data/lib/cybrid_api_bank_ruby/models/trade_bank_model.rb +1 -1
  133. data/lib/cybrid_api_bank_ruby/models/trade_failure_code_bank_model.rb +1 -1
  134. data/lib/cybrid_api_bank_ruby/models/trade_list_bank_model.rb +1 -1
  135. data/lib/cybrid_api_bank_ruby/models/trade_side_bank_model.rb +1 -1
  136. data/lib/cybrid_api_bank_ruby/models/trade_state_bank_model.rb +1 -1
  137. data/lib/cybrid_api_bank_ruby/models/trade_type_bank_model.rb +1 -1
  138. data/lib/cybrid_api_bank_ruby/models/transfer_account_type_bank_model.rb +1 -1
  139. data/lib/cybrid_api_bank_ruby/models/transfer_bank_model.rb +1 -1
  140. data/lib/cybrid_api_bank_ruby/models/transfer_destination_account_bank_model.rb +1 -1
  141. data/lib/cybrid_api_bank_ruby/models/transfer_failure_code_bank_model.rb +1 -1
  142. data/lib/cybrid_api_bank_ruby/models/transfer_list_bank_model.rb +1 -1
  143. data/lib/cybrid_api_bank_ruby/models/transfer_participant_bank_model.rb +1 -1
  144. data/lib/cybrid_api_bank_ruby/models/transfer_side_bank_model.rb +1 -1
  145. data/lib/cybrid_api_bank_ruby/models/transfer_source_account_bank_model.rb +1 -1
  146. data/lib/cybrid_api_bank_ruby/models/transfer_state_bank_model.rb +1 -1
  147. data/lib/cybrid_api_bank_ruby/models/transfer_type_bank_model.rb +1 -1
  148. data/lib/cybrid_api_bank_ruby/models/workflow_bank_model.rb +1 -1
  149. data/lib/cybrid_api_bank_ruby/models/workflow_state_bank_model.rb +1 -1
  150. data/lib/cybrid_api_bank_ruby/models/workflow_type_bank_model.rb +1 -1
  151. data/lib/cybrid_api_bank_ruby/models/workflow_with_details_all_of_bank_model.rb +1 -1
  152. data/lib/cybrid_api_bank_ruby/models/workflow_with_details_bank_model.rb +1 -1
  153. data/lib/cybrid_api_bank_ruby/models/workflows_list_bank_model.rb +1 -1
  154. data/lib/cybrid_api_bank_ruby/version.rb +2 -2
  155. data/lib/cybrid_api_bank_ruby.rb +1 -1
  156. data/spec/api/accounts_bank_api_spec.rb +1 -1
  157. data/spec/api/assets_bank_api_spec.rb +1 -1
  158. data/spec/api/banks_bank_api_spec.rb +1 -1
  159. data/spec/api/counterparties_bank_api_spec.rb +1 -1
  160. data/spec/api/customers_bank_api_spec.rb +1 -1
  161. data/spec/api/deposit_addresses_bank_api_spec.rb +1 -1
  162. data/spec/api/deposit_bank_accounts_bank_api_spec.rb +1 -1
  163. data/spec/api/external_bank_accounts_bank_api_spec.rb +1 -1
  164. data/spec/api/external_wallets_bank_api_spec.rb +1 -1
  165. data/spec/api/identity_verifications_bank_api_spec.rb +1 -1
  166. data/spec/api/invoices_bank_api_spec.rb +1 -1
  167. data/spec/api/payment_instructions_bank_api_spec.rb +1 -1
  168. data/spec/api/prices_bank_api_spec.rb +1 -1
  169. data/spec/api/quotes_bank_api_spec.rb +1 -1
  170. data/spec/api/symbols_bank_api_spec.rb +1 -1
  171. data/spec/api/trades_bank_api_spec.rb +1 -1
  172. data/spec/api/transfers_bank_api_spec.rb +1 -1
  173. data/spec/api/workflows_bank_api_spec.rb +1 -1
  174. data/spec/api_client_spec.rb +1 -1
  175. data/spec/configuration_spec.rb +1 -1
  176. data/spec/models/account_bank_model_spec.rb +1 -1
  177. data/spec/models/account_list_bank_model_spec.rb +1 -1
  178. data/spec/models/account_state_bank_model_spec.rb +1 -1
  179. data/spec/models/account_type_bank_model_spec.rb +1 -1
  180. data/spec/models/activity_limit_bank_model_spec.rb +1 -1
  181. data/spec/models/activity_type_bank_model_spec.rb +1 -1
  182. data/spec/models/asset_bank_model_spec.rb +1 -1
  183. data/spec/models/asset_list_bank_model_spec.rb +1 -1
  184. data/spec/models/asset_types_bank_model_spec.rb +1 -1
  185. data/spec/models/bank_bank_model_spec.rb +1 -1
  186. data/spec/models/bank_feature_bank_model_spec.rb +1 -1
  187. data/spec/models/bank_list_bank_model_spec.rb +1 -1
  188. data/spec/models/bank_type_bank_model_spec.rb +1 -1
  189. data/spec/models/compliance_check_bank_model_spec.rb +1 -1
  190. data/spec/models/compliance_check_outcome_bank_model_spec.rb +1 -1
  191. data/spec/models/compliance_check_type_bank_model_spec.rb +1 -1
  192. data/spec/models/compliance_decision_bank_model_spec.rb +1 -1
  193. data/spec/models/compliance_decision_state_bank_model_spec.rb +1 -1
  194. data/spec/models/compliance_decision_type_bank_model_spec.rb +1 -1
  195. data/spec/models/counterparty_address_bank_model_spec.rb +1 -1
  196. data/spec/models/counterparty_aliases_inner_bank_model_spec.rb +1 -1
  197. data/spec/models/counterparty_bank_model_spec.rb +1 -1
  198. data/spec/models/counterparty_list_bank_model_spec.rb +1 -1
  199. data/spec/models/counterparty_name_bank_model_spec.rb +1 -1
  200. data/spec/models/counterparty_state_bank_model_spec.rb +1 -1
  201. data/spec/models/counterparty_type_bank_model_spec.rb +1 -1
  202. data/spec/models/customer_address_bank_model_spec.rb +1 -1
  203. data/spec/models/customer_aliases_inner_bank_model_spec.rb +1 -1
  204. data/spec/models/customer_bank_model_spec.rb +1 -1
  205. data/spec/models/customer_list_bank_model_spec.rb +1 -1
  206. data/spec/models/customer_name_bank_model_spec.rb +1 -1
  207. data/spec/models/customer_state_bank_model_spec.rb +1 -1
  208. data/spec/models/customer_type_bank_model_spec.rb +1 -1
  209. data/spec/models/deposit_address_bank_model_spec.rb +1 -1
  210. data/spec/models/deposit_address_format_bank_model_spec.rb +1 -1
  211. data/spec/models/deposit_address_list_bank_model_spec.rb +1 -1
  212. data/spec/models/deposit_address_state_bank_model_spec.rb +1 -1
  213. data/spec/models/deposit_bank_account_account_details_inner_bank_model_spec.rb +1 -1
  214. data/spec/models/deposit_bank_account_bank_model_spec.rb +1 -1
  215. data/spec/models/deposit_bank_account_counterparty_address_bank_model_spec.rb +1 -1
  216. data/spec/models/deposit_bank_account_list_bank_model_spec.rb +1 -1
  217. data/spec/models/deposit_bank_account_routing_details_inner_bank_model_spec.rb +1 -1
  218. data/spec/models/deposit_bank_account_routing_number_type_bank_model_spec.rb +1 -1
  219. data/spec/models/deposit_bank_account_state_bank_model_spec.rb +1 -1
  220. data/spec/models/error_response_bank_model_spec.rb +1 -1
  221. data/spec/models/external_bank_account_balances_bank_model_spec.rb +1 -1
  222. data/spec/models/external_bank_account_bank_model_spec.rb +1 -1
  223. data/spec/models/external_bank_account_kind_bank_model_spec.rb +1 -1
  224. data/spec/models/external_bank_account_list_bank_model_spec.rb +1 -1
  225. data/spec/models/external_bank_account_pii_inner_addresses_inner_bank_model_spec.rb +1 -1
  226. data/spec/models/external_bank_account_pii_inner_bank_model_spec.rb +1 -1
  227. data/spec/models/external_bank_account_state_bank_model_spec.rb +1 -1
  228. data/spec/models/external_wallet_bank_model_spec.rb +1 -1
  229. data/spec/models/external_wallet_environment_bank_model_spec.rb +1 -1
  230. data/spec/models/external_wallet_list_bank_model_spec.rb +1 -1
  231. data/spec/models/external_wallet_state_bank_model_spec.rb +1 -1
  232. data/spec/models/identification_number_bank_model_spec.rb +1 -1
  233. data/spec/models/identity_verification_bank_model_spec.rb +1 -1
  234. data/spec/models/identity_verification_list_bank_model_spec.rb +1 -1
  235. data/spec/models/identity_verification_method_bank_model_spec.rb +1 -1
  236. data/spec/models/identity_verification_outcome_bank_model_spec.rb +1 -1
  237. data/spec/models/identity_verification_persona_state_bank_model_spec.rb +1 -1
  238. data/spec/models/identity_verification_state_bank_model_spec.rb +1 -1
  239. data/spec/models/identity_verification_type_bank_model_spec.rb +1 -1
  240. data/spec/models/identity_verification_with_details_bank_model_spec.rb +1 -1
  241. data/spec/models/identity_verification_with_details_pii_address_bank_model_spec.rb +1 -1
  242. data/spec/models/identity_verification_with_details_pii_bank_model_spec.rb +1 -1
  243. data/spec/models/identity_verification_with_details_pii_name_bank_model_spec.rb +1 -1
  244. data/spec/models/invoice_bank_model_spec.rb +1 -1
  245. data/spec/models/invoice_list_bank_model_spec.rb +1 -1
  246. data/spec/models/patch_bank_bank_model_spec.rb +1 -1
  247. data/spec/models/patch_customer_bank_model_spec.rb +1 -1
  248. data/spec/models/patch_external_bank_account_bank_model_spec.rb +1 -1
  249. data/spec/models/payment_instruction_bank_model_spec.rb +1 -1
  250. data/spec/models/payment_instruction_list_bank_model_spec.rb +1 -1
  251. data/spec/models/post_account_bank_model_spec.rb +1 -1
  252. data/spec/models/post_bank_bank_model_spec.rb +1 -1
  253. data/spec/models/post_counterparty_bank_model_spec.rb +1 -1
  254. data/spec/models/post_counterparty_name_bank_model_spec.rb +1 -1
  255. data/spec/models/post_customer_address_bank_model_spec.rb +1 -1
  256. data/spec/models/post_customer_bank_model_spec.rb +1 -1
  257. data/spec/models/post_customer_name_bank_model_spec.rb +1 -1
  258. data/spec/models/post_deposit_address_bank_model_spec.rb +1 -1
  259. data/spec/models/post_deposit_bank_account_bank_model_spec.rb +1 -1
  260. data/spec/models/post_external_bank_account_bank_model_spec.rb +1 -1
  261. data/spec/models/post_external_bank_account_counterparty_address_bank_model_spec.rb +1 -1
  262. data/spec/models/post_external_bank_account_counterparty_bank_account_bank_model_spec.rb +1 -1
  263. data/spec/models/post_external_bank_account_counterparty_name_bank_model_spec.rb +1 -1
  264. data/spec/models/post_external_wallet_bank_model_spec.rb +1 -1
  265. data/spec/models/post_fee_bank_model_spec.rb +1 -1
  266. data/spec/models/post_identification_number_bank_model_spec.rb +1 -1
  267. data/spec/models/post_identity_verification_address_bank_model_spec.rb +1 -1
  268. data/spec/models/post_identity_verification_bank_model_spec.rb +1 -1
  269. data/spec/models/post_identity_verification_name_bank_model_spec.rb +1 -1
  270. data/spec/models/post_invoice_bank_model_spec.rb +1 -1
  271. data/spec/models/post_payment_instruction_bank_model_spec.rb +1 -1
  272. data/spec/models/post_quote_bank_model_spec.rb +1 -1
  273. data/spec/models/post_trade_bank_model_spec.rb +1 -1
  274. data/spec/models/post_transfer_bank_model_spec.rb +1 -1
  275. data/spec/models/post_transfer_participant_bank_model_spec.rb +1 -1
  276. data/spec/models/post_workflow_bank_model_spec.rb +1 -1
  277. data/spec/models/quote_bank_model_spec.rb +1 -1
  278. data/spec/models/quote_list_bank_model_spec.rb +1 -1
  279. data/spec/models/quote_side_bank_model_spec.rb +1 -1
  280. data/spec/models/quote_type_bank_model_spec.rb +1 -1
  281. data/spec/models/symbol_price_bank_model_spec.rb +1 -1
  282. data/spec/models/trade_bank_model_spec.rb +1 -1
  283. data/spec/models/trade_failure_code_bank_model_spec.rb +1 -1
  284. data/spec/models/trade_list_bank_model_spec.rb +1 -1
  285. data/spec/models/trade_side_bank_model_spec.rb +1 -1
  286. data/spec/models/trade_state_bank_model_spec.rb +1 -1
  287. data/spec/models/trade_type_bank_model_spec.rb +1 -1
  288. data/spec/models/transfer_account_type_bank_model_spec.rb +1 -1
  289. data/spec/models/transfer_bank_model_spec.rb +1 -1
  290. data/spec/models/transfer_destination_account_bank_model_spec.rb +1 -1
  291. data/spec/models/transfer_failure_code_bank_model_spec.rb +1 -1
  292. data/spec/models/transfer_list_bank_model_spec.rb +1 -1
  293. data/spec/models/transfer_participant_bank_model_spec.rb +1 -1
  294. data/spec/models/transfer_side_bank_model_spec.rb +1 -1
  295. data/spec/models/transfer_source_account_bank_model_spec.rb +1 -1
  296. data/spec/models/transfer_state_bank_model_spec.rb +1 -1
  297. data/spec/models/transfer_type_bank_model_spec.rb +1 -1
  298. data/spec/models/workflow_bank_model_spec.rb +1 -1
  299. data/spec/models/workflow_state_bank_model_spec.rb +1 -1
  300. data/spec/models/workflow_type_bank_model_spec.rb +1 -1
  301. data/spec/models/workflow_with_details_all_of_bank_model_spec.rb +1 -1
  302. data/spec/models/workflow_with_details_bank_model_spec.rb +1 -1
  303. data/spec/models/workflows_list_bank_model_spec.rb +1 -1
  304. data/spec/spec_helper.rb +1 -1
  305. data/vendor/bundle/ruby/3.2.0/cache/rspec-expectations-3.13.2.gem +0 -0
  306. data/vendor/bundle/ruby/3.2.0/extensions/x86_64-linux/3.2.0/byebug-11.1.3/gem_make.out +5 -5
  307. data/vendor/bundle/ruby/3.2.0/extensions/x86_64-linux/3.2.0/jaro_winkler-1.5.6/gem_make.out +5 -5
  308. data/vendor/bundle/ruby/3.2.0/extensions/x86_64-linux/3.2.0/psych-5.1.2/gem_make.out +5 -5
  309. data/vendor/bundle/ruby/3.2.0/extensions/x86_64-linux/3.2.0/racc-1.8.1/gem_make.out +5 -5
  310. data/vendor/bundle/ruby/3.2.0/extensions/x86_64-linux/3.2.0/stringio-3.1.1/gem_make.out +5 -5
  311. data/vendor/bundle/ruby/3.2.0/gems/{rspec-expectations-3.13.1 → rspec-expectations-3.13.2}/Changelog.md +12 -1
  312. data/vendor/bundle/ruby/3.2.0/gems/{rspec-expectations-3.13.1 → rspec-expectations-3.13.2}/lib/rspec/expectations/block_snippet_extractor.rb +2 -0
  313. data/vendor/bundle/ruby/3.2.0/gems/{rspec-expectations-3.13.1 → rspec-expectations-3.13.2}/lib/rspec/expectations/configuration.rb +5 -0
  314. data/vendor/bundle/ruby/3.2.0/gems/{rspec-expectations-3.13.1 → rspec-expectations-3.13.2}/lib/rspec/expectations/failure_aggregator.rb +7 -0
  315. data/vendor/bundle/ruby/3.2.0/gems/{rspec-expectations-3.13.1 → rspec-expectations-3.13.2}/lib/rspec/expectations/handler.rb +4 -5
  316. data/vendor/bundle/ruby/3.2.0/gems/{rspec-expectations-3.13.1 → rspec-expectations-3.13.2}/lib/rspec/expectations/version.rb +1 -1
  317. data/vendor/bundle/ruby/3.2.0/gems/{rspec-expectations-3.13.1 → rspec-expectations-3.13.2}/lib/rspec/matchers/built_in/base_matcher.rb +4 -18
  318. data/vendor/bundle/ruby/3.2.0/gems/{rspec-expectations-3.13.1 → rspec-expectations-3.13.2}/lib/rspec/matchers/built_in/change.rb +2 -0
  319. data/vendor/bundle/ruby/3.2.0/gems/{rspec-expectations-3.13.1 → rspec-expectations-3.13.2}/lib/rspec/matchers/built_in/compound.rb +4 -1
  320. data/vendor/bundle/ruby/3.2.0/gems/{rspec-expectations-3.13.1 → rspec-expectations-3.13.2}/lib/rspec/matchers/built_in/contain_exactly.rb +2 -0
  321. data/vendor/bundle/ruby/3.2.0/gems/{rspec-expectations-3.13.1 → rspec-expectations-3.13.2}/lib/rspec/matchers/built_in/count_expectation.rb +2 -0
  322. data/vendor/bundle/ruby/3.2.0/gems/{rspec-expectations-3.13.1 → rspec-expectations-3.13.2}/lib/rspec/matchers/built_in/has.rb +29 -2
  323. data/vendor/bundle/ruby/3.2.0/gems/{rspec-expectations-3.13.1 → rspec-expectations-3.13.2}/lib/rspec/matchers/built_in/include.rb +3 -0
  324. data/vendor/bundle/ruby/3.2.0/gems/{rspec-expectations-3.13.1 → rspec-expectations-3.13.2}/lib/rspec/matchers/built_in/match.rb +2 -0
  325. data/vendor/bundle/ruby/3.2.0/gems/{rspec-expectations-3.13.1 → rspec-expectations-3.13.2}/lib/rspec/matchers/built_in/satisfy.rb +2 -0
  326. data/vendor/bundle/ruby/3.2.0/gems/{rspec-expectations-3.13.1 → rspec-expectations-3.13.2}/lib/rspec/matchers/english_phrasing.rb +2 -0
  327. data/vendor/bundle/ruby/3.2.0/gems/{rspec-expectations-3.13.1 → rspec-expectations-3.13.2}/lib/rspec/matchers.rb +2 -0
  328. data/vendor/bundle/ruby/3.2.0/specifications/{rspec-expectations-3.13.1.gemspec → rspec-expectations-3.13.2.gemspec} +6 -6
  329. metadata +58 -58
  330. data/vendor/bundle/ruby/3.2.0/cache/rspec-expectations-3.13.1.gem +0 -0
  331. /data/vendor/bundle/ruby/3.2.0/gems/{rspec-expectations-3.13.1 → rspec-expectations-3.13.2}/.document +0 -0
  332. /data/vendor/bundle/ruby/3.2.0/gems/{rspec-expectations-3.13.1 → rspec-expectations-3.13.2}/.yardopts +0 -0
  333. /data/vendor/bundle/ruby/3.2.0/gems/{rspec-expectations-3.13.1 → rspec-expectations-3.13.2}/LICENSE.md +0 -0
  334. /data/vendor/bundle/ruby/3.2.0/gems/{rspec-expectations-3.13.1 → rspec-expectations-3.13.2}/README.md +0 -0
  335. /data/vendor/bundle/ruby/3.2.0/gems/{rspec-expectations-3.13.1 → rspec-expectations-3.13.2}/lib/rspec/expectations/expectation_target.rb +0 -0
  336. /data/vendor/bundle/ruby/3.2.0/gems/{rspec-expectations-3.13.1 → rspec-expectations-3.13.2}/lib/rspec/expectations/fail_with.rb +0 -0
  337. /data/vendor/bundle/ruby/3.2.0/gems/{rspec-expectations-3.13.1 → rspec-expectations-3.13.2}/lib/rspec/expectations/minitest_integration.rb +0 -0
  338. /data/vendor/bundle/ruby/3.2.0/gems/{rspec-expectations-3.13.1 → rspec-expectations-3.13.2}/lib/rspec/expectations/syntax.rb +0 -0
  339. /data/vendor/bundle/ruby/3.2.0/gems/{rspec-expectations-3.13.1 → rspec-expectations-3.13.2}/lib/rspec/expectations.rb +0 -0
  340. /data/vendor/bundle/ruby/3.2.0/gems/{rspec-expectations-3.13.1 → rspec-expectations-3.13.2}/lib/rspec/matchers/aliased_matcher.rb +0 -0
  341. /data/vendor/bundle/ruby/3.2.0/gems/{rspec-expectations-3.13.1 → rspec-expectations-3.13.2}/lib/rspec/matchers/built_in/all.rb +0 -0
  342. /data/vendor/bundle/ruby/3.2.0/gems/{rspec-expectations-3.13.1 → rspec-expectations-3.13.2}/lib/rspec/matchers/built_in/be.rb +0 -0
  343. /data/vendor/bundle/ruby/3.2.0/gems/{rspec-expectations-3.13.1 → rspec-expectations-3.13.2}/lib/rspec/matchers/built_in/be_between.rb +0 -0
  344. /data/vendor/bundle/ruby/3.2.0/gems/{rspec-expectations-3.13.1 → rspec-expectations-3.13.2}/lib/rspec/matchers/built_in/be_instance_of.rb +0 -0
  345. /data/vendor/bundle/ruby/3.2.0/gems/{rspec-expectations-3.13.1 → rspec-expectations-3.13.2}/lib/rspec/matchers/built_in/be_kind_of.rb +0 -0
  346. /data/vendor/bundle/ruby/3.2.0/gems/{rspec-expectations-3.13.1 → rspec-expectations-3.13.2}/lib/rspec/matchers/built_in/be_within.rb +0 -0
  347. /data/vendor/bundle/ruby/3.2.0/gems/{rspec-expectations-3.13.1 → rspec-expectations-3.13.2}/lib/rspec/matchers/built_in/cover.rb +0 -0
  348. /data/vendor/bundle/ruby/3.2.0/gems/{rspec-expectations-3.13.1 → rspec-expectations-3.13.2}/lib/rspec/matchers/built_in/eq.rb +0 -0
  349. /data/vendor/bundle/ruby/3.2.0/gems/{rspec-expectations-3.13.1 → rspec-expectations-3.13.2}/lib/rspec/matchers/built_in/eql.rb +0 -0
  350. /data/vendor/bundle/ruby/3.2.0/gems/{rspec-expectations-3.13.1 → rspec-expectations-3.13.2}/lib/rspec/matchers/built_in/equal.rb +0 -0
  351. /data/vendor/bundle/ruby/3.2.0/gems/{rspec-expectations-3.13.1 → rspec-expectations-3.13.2}/lib/rspec/matchers/built_in/exist.rb +0 -0
  352. /data/vendor/bundle/ruby/3.2.0/gems/{rspec-expectations-3.13.1 → rspec-expectations-3.13.2}/lib/rspec/matchers/built_in/have_attributes.rb +0 -0
  353. /data/vendor/bundle/ruby/3.2.0/gems/{rspec-expectations-3.13.1 → rspec-expectations-3.13.2}/lib/rspec/matchers/built_in/operators.rb +0 -0
  354. /data/vendor/bundle/ruby/3.2.0/gems/{rspec-expectations-3.13.1 → rspec-expectations-3.13.2}/lib/rspec/matchers/built_in/output.rb +0 -0
  355. /data/vendor/bundle/ruby/3.2.0/gems/{rspec-expectations-3.13.1 → rspec-expectations-3.13.2}/lib/rspec/matchers/built_in/raise_error.rb +0 -0
  356. /data/vendor/bundle/ruby/3.2.0/gems/{rspec-expectations-3.13.1 → rspec-expectations-3.13.2}/lib/rspec/matchers/built_in/respond_to.rb +0 -0
  357. /data/vendor/bundle/ruby/3.2.0/gems/{rspec-expectations-3.13.1 → rspec-expectations-3.13.2}/lib/rspec/matchers/built_in/start_or_end_with.rb +0 -0
  358. /data/vendor/bundle/ruby/3.2.0/gems/{rspec-expectations-3.13.1 → rspec-expectations-3.13.2}/lib/rspec/matchers/built_in/throw_symbol.rb +0 -0
  359. /data/vendor/bundle/ruby/3.2.0/gems/{rspec-expectations-3.13.1 → rspec-expectations-3.13.2}/lib/rspec/matchers/built_in/yield.rb +0 -0
  360. /data/vendor/bundle/ruby/3.2.0/gems/{rspec-expectations-3.13.1 → rspec-expectations-3.13.2}/lib/rspec/matchers/built_in.rb +0 -0
  361. /data/vendor/bundle/ruby/3.2.0/gems/{rspec-expectations-3.13.1 → rspec-expectations-3.13.2}/lib/rspec/matchers/composable.rb +0 -0
  362. /data/vendor/bundle/ruby/3.2.0/gems/{rspec-expectations-3.13.1 → rspec-expectations-3.13.2}/lib/rspec/matchers/dsl.rb +0 -0
  363. /data/vendor/bundle/ruby/3.2.0/gems/{rspec-expectations-3.13.1 → rspec-expectations-3.13.2}/lib/rspec/matchers/fail_matchers.rb +0 -0
  364. /data/vendor/bundle/ruby/3.2.0/gems/{rspec-expectations-3.13.1 → rspec-expectations-3.13.2}/lib/rspec/matchers/generated_descriptions.rb +0 -0
  365. /data/vendor/bundle/ruby/3.2.0/gems/{rspec-expectations-3.13.1 → rspec-expectations-3.13.2}/lib/rspec/matchers/matcher_delegator.rb +0 -0
  366. /data/vendor/bundle/ruby/3.2.0/gems/{rspec-expectations-3.13.1 → rspec-expectations-3.13.2}/lib/rspec/matchers/matcher_protocol.rb +0 -0
  367. /data/vendor/bundle/ruby/3.2.0/gems/{rspec-expectations-3.13.1 → rspec-expectations-3.13.2}/lib/rspec/matchers/multi_matcher_diff.rb +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.production.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.production.cybrid.app/api/schema/swagger-ui) | APIs to manage organizations | | [Bank API](https://bank.production.cybrid.app/api/schema/swagger-ui) | APIs to manage banks (and all downstream customer activity) | | [Identities API](https://id.production.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.production.cybrid.app). Access tokens can be generated for a `Customer` as well via the [Cybrid IdP](https://id.production.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.production.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.production.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 counterparties:read counterparties:write counterparties: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 invoices:read invoices:write invoices:execute identity_verifications:read identity_verifications:write identity_verifications: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 counterparties:read 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 invoices:read subscriptions:read subscriptions:write subscriptions:execute subscription_events:read subscription_events:execute identity_verifications: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) | | Counterparty | counterparties:read (Organization, Bank, Customer) | counterparties:write (Bank, Customer) | counterparties: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) | | Invoice | invoices:read (Organization, Bank, Customer) | invoices:write (Bank, Customer) | invoices:execute (Bank, Customer) | ## Available Endpoints The available APIs for the [Identity](https://id.production.cybrid.app/api/schema/swagger-ui), [Organization](https://organization.production.cybrid.app/api/schema/swagger-ui) and [Bank](https://bank.production.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 | Counterparty | /api/counterparties | Create and list counterparties | | 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 | Invoice | /api/invoices | Create, get, cancel and list invoices | | Bank | PaymentInstruction | /api/payment_instructions | Create, get and list payment instructions for invoices | | 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.119.34
6
+ The version of the OpenAPI document: v0.119.36
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.production.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.production.cybrid.app/api/schema/swagger-ui) | APIs to manage organizations | | [Bank API](https://bank.production.cybrid.app/api/schema/swagger-ui) | APIs to manage banks (and all downstream customer activity) | | [Identities API](https://id.production.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.production.cybrid.app). Access tokens can be generated for a `Customer` as well via the [Cybrid IdP](https://id.production.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.production.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.production.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 counterparties:read counterparties:write counterparties: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 invoices:read invoices:write invoices:execute identity_verifications:read identity_verifications:write identity_verifications: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 counterparties:read 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 invoices:read subscriptions:read subscriptions:write subscriptions:execute subscription_events:read subscription_events:execute identity_verifications: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) | | Counterparty | counterparties:read (Organization, Bank, Customer) | counterparties:write (Bank, Customer) | counterparties: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) | | Invoice | invoices:read (Organization, Bank, Customer) | invoices:write (Bank, Customer) | invoices:execute (Bank, Customer) | ## Available Endpoints The available APIs for the [Identity](https://id.production.cybrid.app/api/schema/swagger-ui), [Organization](https://organization.production.cybrid.app/api/schema/swagger-ui) and [Bank](https://bank.production.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 | Counterparty | /api/counterparties | Create and list counterparties | | 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 | Invoice | /api/invoices | Create, get, cancel and list invoices | | Bank | PaymentInstruction | /api/payment_instructions | Create, get and list payment instructions for invoices | | 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.119.34
6
+ The version of the OpenAPI document: v0.119.36
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.production.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.production.cybrid.app/api/schema/swagger-ui) | APIs to manage organizations | | [Bank API](https://bank.production.cybrid.app/api/schema/swagger-ui) | APIs to manage banks (and all downstream customer activity) | | [Identities API](https://id.production.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.production.cybrid.app). Access tokens can be generated for a `Customer` as well via the [Cybrid IdP](https://id.production.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.production.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.production.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 counterparties:read counterparties:write counterparties: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 invoices:read invoices:write invoices:execute identity_verifications:read identity_verifications:write identity_verifications: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 counterparties:read 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 invoices:read subscriptions:read subscriptions:write subscriptions:execute subscription_events:read subscription_events:execute identity_verifications: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) | | Counterparty | counterparties:read (Organization, Bank, Customer) | counterparties:write (Bank, Customer) | counterparties: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) | | Invoice | invoices:read (Organization, Bank, Customer) | invoices:write (Bank, Customer) | invoices:execute (Bank, Customer) | ## Available Endpoints The available APIs for the [Identity](https://id.production.cybrid.app/api/schema/swagger-ui), [Organization](https://organization.production.cybrid.app/api/schema/swagger-ui) and [Bank](https://bank.production.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 | Counterparty | /api/counterparties | Create and list counterparties | | 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 | Invoice | /api/invoices | Create, get, cancel and list invoices | | Bank | PaymentInstruction | /api/payment_instructions | Create, get and list payment instructions for invoices | | 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.119.34
6
+ The version of the OpenAPI document: v0.119.36
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.production.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.production.cybrid.app/api/schema/swagger-ui) | APIs to manage organizations | | [Bank API](https://bank.production.cybrid.app/api/schema/swagger-ui) | APIs to manage banks (and all downstream customer activity) | | [Identities API](https://id.production.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.production.cybrid.app). Access tokens can be generated for a `Customer` as well via the [Cybrid IdP](https://id.production.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.production.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.production.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 counterparties:read counterparties:write counterparties: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 invoices:read invoices:write invoices:execute identity_verifications:read identity_verifications:write identity_verifications: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 counterparties:read 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 invoices:read subscriptions:read subscriptions:write subscriptions:execute subscription_events:read subscription_events:execute identity_verifications: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) | | Counterparty | counterparties:read (Organization, Bank, Customer) | counterparties:write (Bank, Customer) | counterparties: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) | | Invoice | invoices:read (Organization, Bank, Customer) | invoices:write (Bank, Customer) | invoices:execute (Bank, Customer) | ## Available Endpoints The available APIs for the [Identity](https://id.production.cybrid.app/api/schema/swagger-ui), [Organization](https://organization.production.cybrid.app/api/schema/swagger-ui) and [Bank](https://bank.production.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 | Counterparty | /api/counterparties | Create and list counterparties | | 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 | Invoice | /api/invoices | Create, get, cancel and list invoices | | Bank | PaymentInstruction | /api/payment_instructions | Create, get and list payment instructions for invoices | | 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.119.34
6
+ The version of the OpenAPI document: v0.119.36
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.production.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.production.cybrid.app/api/schema/swagger-ui) | APIs to manage organizations | | [Bank API](https://bank.production.cybrid.app/api/schema/swagger-ui) | APIs to manage banks (and all downstream customer activity) | | [Identities API](https://id.production.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.production.cybrid.app). Access tokens can be generated for a `Customer` as well via the [Cybrid IdP](https://id.production.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.production.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.production.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 counterparties:read counterparties:write counterparties: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 invoices:read invoices:write invoices:execute identity_verifications:read identity_verifications:write identity_verifications: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 counterparties:read 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 invoices:read subscriptions:read subscriptions:write subscriptions:execute subscription_events:read subscription_events:execute identity_verifications: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) | | Counterparty | counterparties:read (Organization, Bank, Customer) | counterparties:write (Bank, Customer) | counterparties: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) | | Invoice | invoices:read (Organization, Bank, Customer) | invoices:write (Bank, Customer) | invoices:execute (Bank, Customer) | ## Available Endpoints The available APIs for the [Identity](https://id.production.cybrid.app/api/schema/swagger-ui), [Organization](https://organization.production.cybrid.app/api/schema/swagger-ui) and [Bank](https://bank.production.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 | Counterparty | /api/counterparties | Create and list counterparties | | 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 | Invoice | /api/invoices | Create, get, cancel and list invoices | | Bank | PaymentInstruction | /api/payment_instructions | Create, get and list payment instructions for invoices | | 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.119.34
6
+ The version of the OpenAPI document: v0.119.36
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.20240819-4022-riqfbb sitelibdir\=./.gem.20240819-4022-riqfbb clean
6
+ make DESTDIR\= sitearchdir\=./.gem.20240820-4028-ubw9vt sitelibdir\=./.gem.20240820-4028-ubw9vt 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.20240819-4022-riqfbb sitelibdir\=./.gem.20240819-4022-riqfbb
11
+ make DESTDIR\= sitearchdir\=./.gem.20240820-4028-ubw9vt sitelibdir\=./.gem.20240820-4028-ubw9vt
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.20240819-4022-riqfbb sitelibdir\=./.gem.20240819-4022-riqfbb install
42
+ make DESTDIR\= sitearchdir\=./.gem.20240820-4028-ubw9vt sitelibdir\=./.gem.20240820-4028-ubw9vt 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.20240819-4022-riqfbb/byebug
44
+ /usr/bin/install -c -m 0755 byebug.so ./.gem.20240820-4028-ubw9vt/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.20240819-4022-riqfbb sitelibdir\=./.gem.20240819-4022-riqfbb clean
48
+ make DESTDIR\= sitearchdir\=./.gem.20240820-4028-ubw9vt sitelibdir\=./.gem.20240820-4028-ubw9vt 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'
@@ -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.20240819-4022-vvfp5h sitelibdir\=./.gem.20240819-4022-vvfp5h clean
6
+ make DESTDIR\= sitearchdir\=./.gem.20240820-4028-ug87o8 sitelibdir\=./.gem.20240820-4028-ug87o8 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.20240819-4022-vvfp5h sitelibdir\=./.gem.20240819-4022-vvfp5h
11
+ make DESTDIR\= sitearchdir\=./.gem.20240820-4028-ug87o8 sitelibdir\=./.gem.20240820-4028-ug87o8
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.20240819-4022-vvfp5h sitelibdir\=./.gem.20240819-4022-vvfp5h install
29
+ make DESTDIR\= sitearchdir\=./.gem.20240820-4028-ug87o8 sitelibdir\=./.gem.20240820-4028-ug87o8 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.20240819-4022-vvfp5h/jaro_winkler
31
+ /usr/bin/install -c -m 0755 jaro_winkler_ext.so ./.gem.20240820-4028-ug87o8/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.20240819-4022-vvfp5h sitelibdir\=./.gem.20240819-4022-vvfp5h clean
35
+ make DESTDIR\= sitearchdir\=./.gem.20240820-4028-ug87o8 sitelibdir\=./.gem.20240820-4028-ug87o8 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.2/ext/psych
8
- make DESTDIR\= sitearchdir\=./.gem.20240819-4022-mblz67 sitelibdir\=./.gem.20240819-4022-mblz67 clean
8
+ make DESTDIR\= sitearchdir\=./.gem.20240820-4028-ukycr9 sitelibdir\=./.gem.20240820-4028-ukycr9 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.2/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.2/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.2/ext/psych
16
- make DESTDIR\= sitearchdir\=./.gem.20240819-4022-mblz67 sitelibdir\=./.gem.20240819-4022-mblz67
16
+ make DESTDIR\= sitearchdir\=./.gem.20240820-4028-ukycr9 sitelibdir\=./.gem.20240820-4028-ukycr9
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.2/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.2/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.2/ext/psych
27
- make DESTDIR\= sitearchdir\=./.gem.20240819-4022-mblz67 sitelibdir\=./.gem.20240819-4022-mblz67 install
27
+ make DESTDIR\= sitearchdir\=./.gem.20240820-4028-ukycr9 sitelibdir\=./.gem.20240820-4028-ukycr9 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.2/ext/psych'
29
- /usr/bin/install -c -m 0755 psych.so ./.gem.20240819-4022-mblz67
29
+ /usr/bin/install -c -m 0755 psych.so ./.gem.20240820-4028-ukycr9
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.2/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.2/ext/psych
33
- make DESTDIR\= sitearchdir\=./.gem.20240819-4022-mblz67 sitelibdir\=./.gem.20240819-4022-mblz67 clean
33
+ make DESTDIR\= sitearchdir\=./.gem.20240820-4028-ukycr9 sitelibdir\=./.gem.20240820-4028-ukycr9 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.2/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.8.1/ext/racc/cparse
6
- make DESTDIR\= sitearchdir\=./.gem.20240819-4022-h47zhr sitelibdir\=./.gem.20240819-4022-h47zhr clean
6
+ make DESTDIR\= sitearchdir\=./.gem.20240820-4028-tv41tj sitelibdir\=./.gem.20240820-4028-tv41tj 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.8.1/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.8.1/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.8.1/ext/racc/cparse
11
- make DESTDIR\= sitearchdir\=./.gem.20240819-4022-h47zhr sitelibdir\=./.gem.20240819-4022-h47zhr
11
+ make DESTDIR\= sitearchdir\=./.gem.20240820-4028-tv41tj sitelibdir\=./.gem.20240820-4028-tv41tj
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.8.1/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.8.1/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.8.1/ext/racc/cparse
18
- make DESTDIR\= sitearchdir\=./.gem.20240819-4022-h47zhr sitelibdir\=./.gem.20240819-4022-h47zhr install
18
+ make DESTDIR\= sitearchdir\=./.gem.20240820-4028-tv41tj sitelibdir\=./.gem.20240820-4028-tv41tj 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.8.1/ext/racc/cparse'
20
- /usr/bin/install -c -m 0755 cparse.so ./.gem.20240819-4022-h47zhr/racc
20
+ /usr/bin/install -c -m 0755 cparse.so ./.gem.20240820-4028-tv41tj/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.8.1/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.8.1/ext/racc/cparse
24
- make DESTDIR\= sitearchdir\=./.gem.20240819-4022-h47zhr sitelibdir\=./.gem.20240819-4022-h47zhr clean
24
+ make DESTDIR\= sitearchdir\=./.gem.20240820-4028-tv41tj sitelibdir\=./.gem.20240820-4028-tv41tj 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.8.1/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.8.1/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.1.1/ext/stringio
6
- make DESTDIR\= sitearchdir\=./.gem.20240819-4022-e2mkcx sitelibdir\=./.gem.20240819-4022-e2mkcx clean
6
+ make DESTDIR\= sitearchdir\=./.gem.20240820-4028-qs9rnf sitelibdir\=./.gem.20240820-4028-qs9rnf 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.1.1/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.1.1/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.1.1/ext/stringio
11
- make DESTDIR\= sitearchdir\=./.gem.20240819-4022-e2mkcx sitelibdir\=./.gem.20240819-4022-e2mkcx
11
+ make DESTDIR\= sitearchdir\=./.gem.20240820-4028-qs9rnf sitelibdir\=./.gem.20240820-4028-qs9rnf
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.1.1/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.1.1/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.1.1/ext/stringio
18
- make DESTDIR\= sitearchdir\=./.gem.20240819-4022-e2mkcx sitelibdir\=./.gem.20240819-4022-e2mkcx install
18
+ make DESTDIR\= sitearchdir\=./.gem.20240820-4028-qs9rnf sitelibdir\=./.gem.20240820-4028-qs9rnf 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.1.1/ext/stringio'
20
- /usr/bin/install -c -m 0755 stringio.so ./.gem.20240819-4022-e2mkcx
20
+ /usr/bin/install -c -m 0755 stringio.so ./.gem.20240820-4028-qs9rnf
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.1.1/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.1.1/ext/stringio
24
- make DESTDIR\= sitearchdir\=./.gem.20240819-4022-e2mkcx sitelibdir\=./.gem.20240819-4022-e2mkcx clean
24
+ make DESTDIR\= sitearchdir\=./.gem.20240820-4028-qs9rnf sitelibdir\=./.gem.20240820-4028-qs9rnf 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.1.1/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.1.1/ext/stringio'
@@ -1,5 +1,16 @@
1
1
  ### Development
2
- [Full Changelog](http://github.com/rspec/rspec-expectations/compare/v3.13.1...3-13-maintenance)
2
+ [Full Changelog](http://github.com/rspec/rspec-expectations/compare/v3.13.2...3-13-maintenance)
3
+
4
+ ### 3.13.2 / 2024-08-20
5
+ [Full Changelog](http://github.com/rspec/rspec-expectations/compare/v3.13.1...v3.13.2)
6
+
7
+ Bug Fixes:
8
+
9
+ * When using null object doubles, prevent typos triggering dynamic matchers.
10
+ (Eric Mueller, #1455)
11
+ * Use `RSpec.warning` for an expectation warning rather than `Kernel.warn`. (Jon Rowe, #1472)
12
+ * Prevent mismatched use of block and value matchers in compound expectations. (Phil Pirozhkov, #1476)
13
+ * Raise an error when passing no arguments to the `include` matcher. (Eric Mueller, #1479)
3
14
 
4
15
  ### 3.13.1 / 2024-06-13
5
16
  [Full Changelog](http://github.com/rspec/rspec-expectations/compare/v3.13.0...v3.13.1)
@@ -46,11 +46,13 @@ module RSpec
46
46
  RSpec.world.source_from_file(file_path)
47
47
  end
48
48
  else
49
+ # :nocov:
49
50
  RSpec::Support.require_rspec_support 'source'
50
51
  def source
51
52
  raise TargetNotFoundError unless File.exist?(file_path)
52
53
  @source ||= RSpec::Support::Source.from_file(file_path)
53
54
  end
55
+ # :nocov:
54
56
  end
55
57
 
56
58
  def file_path
@@ -89,6 +89,7 @@ module RSpec
89
89
  ::RSpec.configuration.color_enabled?
90
90
  end
91
91
  else
92
+ # :nocov:
92
93
  # Indicates whether or not diffs should be colored.
93
94
  # Delegates to rspec-core's color option if rspec-core
94
95
  # is loaded; otherwise you can set it here.
@@ -100,8 +101,11 @@ module RSpec
100
101
  def color?
101
102
  defined?(@color) && @color
102
103
  end
104
+ # :nocov:
103
105
  end
104
106
 
107
+ # :nocov: Because this is only really _useful_ on 1.8, and hard to test elsewhere.
108
+ #
105
109
  # Adds `should` and `should_not` to the given classes
106
110
  # or modules. This can be used to ensure `should` works
107
111
  # properly on things like proxy objects (particular
@@ -114,6 +118,7 @@ module RSpec
114
118
  Expectations::Syntax.enable_should(mod)
115
119
  end
116
120
  end
121
+ # :nocov:
117
122
 
118
123
  # Sets or gets the backtrace formatter. The backtrace formatter should
119
124
  # implement `#format_backtrace(Array<String>)`. This is used
@@ -6,6 +6,10 @@ module RSpec
6
6
 
7
7
  # @private
8
8
  class AggregatedFailure
9
+ # :nocov:
10
+ # `inspect` was apparently used by some versions early in ruby 3 while constructing
11
+ # NoMethodError, but seems to be no longer.
12
+ #
9
13
  # @private
10
14
  MESSAGE =
11
15
  'AggregatedFailure: This method caused a failure which has been ' \
@@ -15,6 +19,7 @@ module RSpec
15
19
  def inspect
16
20
  MESSAGE
17
21
  end
22
+ # :nocov:
18
23
  end
19
24
 
20
25
  AGGREGATED_FAILURE = AggregatedFailure.new
@@ -75,11 +80,13 @@ module RSpec
75
80
  # a backtrace that has a continuous common section with the raised `MultipleExpectationsNotMetError`,
76
81
  # so that rspec-core's truncation logic can work properly on it to list the backtrace
77
82
  # relative to the `aggregate_failures` block.
83
+ # :nocov:
78
84
  def assign_backtrace(failure)
79
85
  raise failure
80
86
  rescue failure.class => e
81
87
  failure.set_backtrace(e.backtrace)
82
88
  end
89
+ # :nocov:
83
90
  else
84
91
  # Using `caller` performs better (and is simpler) than `raise` on most Rubies.
85
92
  def assign_backtrace(failure)
@@ -4,11 +4,10 @@ module RSpec
4
4
  module ExpectationHelper
5
5
  def self.check_message(msg)
6
6
  unless msg.nil? || msg.respond_to?(:to_str) || msg.respond_to?(:call)
7
- ::Kernel.warn [
8
- "WARNING: ignoring the provided expectation message argument (",
9
- msg.inspect,
10
- ") since it is not a string or a proc."
11
- ].join
7
+ RSpec.warning(
8
+ "ignoring the provided expectation message argument" \
9
+ "(#{ msg.inspect }) since it is not a string or a proc"
10
+ )
12
11
  end
13
12
  end
14
13
 
@@ -2,7 +2,7 @@ module RSpec
2
2
  module Expectations
3
3
  # @private
4
4
  module Version
5
- STRING = '3.13.1'
5
+ STRING = '3.13.2'
6
6
  end
7
7
  end
8
8
  end
@@ -124,24 +124,6 @@ module RSpec
124
124
  end
125
125
  private_class_method :underscore
126
126
 
127
- private
128
-
129
- def assert_ivars(*expected_ivars)
130
- return unless (expected_ivars - present_ivars).any?
131
- ivar_list = EnglishPhrasing.list(expected_ivars)
132
- raise "#{self.class.name} needs to supply#{ivar_list}"
133
- end
134
-
135
- if RUBY_VERSION.to_f < 1.9
136
- # :nocov:
137
- def present_ivars
138
- instance_variables.map(&:to_sym)
139
- end
140
- # :nocov:
141
- else
142
- alias present_ivars instance_variables
143
- end
144
-
145
127
  # @private
146
128
  module HashFormatting
147
129
  # `{ :a => 5, :b => 2 }.inspect` produces:
@@ -174,9 +156,11 @@ module RSpec
174
156
  else
175
157
  # @api private
176
158
  # @return [Boolean] False always as the curent Ruby version does not support String encoding
159
+ # :nocov:
177
160
  def string_encoding_differs?
178
161
  false
179
162
  end
163
+ # :nocov:
180
164
  end
181
165
  module_function :string_encoding_differs?
182
166
 
@@ -193,9 +177,11 @@ module RSpec
193
177
  # Formats a String's encoding as a human readable string
194
178
  # @param _value [String]
195
179
  # @return [nil] nil as the curent Ruby version does not support String encoding
180
+ # :nocov:
196
181
  def format_encoding(_value)
197
182
  nil
198
183
  end
184
+ # :nocov:
199
185
  end
200
186
  module_function :format_encoding
201
187
  end