cybrid_api_bank_ruby 0.123.152 → 0.123.203

Sign up to get free protection for your applications and to get access to all the features.
Files changed (363) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile.lock +1 -1
  3. data/README.md +18 -7
  4. data/cybrid_api_bank_ruby.gemspec +2 -2
  5. data/docs/ComplianceCheckBankModel.md +1 -1
  6. data/docs/ComplianceDecisionBankModel.md +1 -1
  7. data/docs/FilesBankApi.md +240 -0
  8. data/docs/IdentificationNumberBankModel.md +1 -1
  9. data/docs/IdentityVerificationBankModel.md +1 -1
  10. data/docs/IdentityVerificationWithDetailsBankModel.md +1 -1
  11. data/docs/PlatformFileBankModel.md +30 -0
  12. data/docs/PlatformFileListBankModel.md +24 -0
  13. data/docs/PostCustomerAddressBankModel.md +6 -6
  14. data/docs/PostCustomerAliasesInnerBankModel.md +18 -0
  15. data/docs/PostCustomerBankModel.md +10 -6
  16. data/docs/PostCustomerNameBankModel.md +3 -1
  17. data/docs/PostFileBankModel.md +26 -0
  18. data/docs/PostIdentityVerificationAddressBankModel.md +6 -6
  19. data/docs/PostIdentityVerificationAliasesInnerBankModel.md +18 -0
  20. data/docs/PostIdentityVerificationBankModel.md +21 -7
  21. data/docs/PostIdentityVerificationNameBankModel.md +4 -4
  22. data/docs/PostUltimateBeneficialOwnerBankModel.md +20 -0
  23. data/lib/cybrid_api_bank_ruby/api/accounts_bank_api.rb +2 -2
  24. data/lib/cybrid_api_bank_ruby/api/assets_bank_api.rb +2 -2
  25. data/lib/cybrid_api_bank_ruby/api/banks_bank_api.rb +2 -2
  26. data/lib/cybrid_api_bank_ruby/api/counterparties_bank_api.rb +2 -2
  27. data/lib/cybrid_api_bank_ruby/api/customers_bank_api.rb +2 -2
  28. data/lib/cybrid_api_bank_ruby/api/deposit_addresses_bank_api.rb +2 -2
  29. data/lib/cybrid_api_bank_ruby/api/deposit_bank_accounts_bank_api.rb +2 -2
  30. data/lib/cybrid_api_bank_ruby/api/external_bank_accounts_bank_api.rb +2 -2
  31. data/lib/cybrid_api_bank_ruby/api/external_wallets_bank_api.rb +2 -2
  32. data/lib/cybrid_api_bank_ruby/api/files_bank_api.rb +243 -0
  33. data/lib/cybrid_api_bank_ruby/api/identity_verifications_bank_api.rb +2 -2
  34. data/lib/cybrid_api_bank_ruby/api/invoices_bank_api.rb +2 -2
  35. data/lib/cybrid_api_bank_ruby/api/payment_instructions_bank_api.rb +2 -2
  36. data/lib/cybrid_api_bank_ruby/api/prices_bank_api.rb +2 -2
  37. data/lib/cybrid_api_bank_ruby/api/quotes_bank_api.rb +2 -2
  38. data/lib/cybrid_api_bank_ruby/api/symbols_bank_api.rb +2 -2
  39. data/lib/cybrid_api_bank_ruby/api/trades_bank_api.rb +2 -2
  40. data/lib/cybrid_api_bank_ruby/api/transfers_bank_api.rb +2 -2
  41. data/lib/cybrid_api_bank_ruby/api/workflows_bank_api.rb +2 -2
  42. data/lib/cybrid_api_bank_ruby/api_client.rb +2 -2
  43. data/lib/cybrid_api_bank_ruby/api_error.rb +2 -2
  44. data/lib/cybrid_api_bank_ruby/configuration.rb +2 -2
  45. data/lib/cybrid_api_bank_ruby/models/account_bank_model.rb +2 -2
  46. data/lib/cybrid_api_bank_ruby/models/account_list_bank_model.rb +2 -2
  47. data/lib/cybrid_api_bank_ruby/models/account_state_bank_model.rb +2 -2
  48. data/lib/cybrid_api_bank_ruby/models/account_type_bank_model.rb +2 -2
  49. data/lib/cybrid_api_bank_ruby/models/activity_limit_bank_model.rb +2 -2
  50. data/lib/cybrid_api_bank_ruby/models/activity_type_bank_model.rb +2 -2
  51. data/lib/cybrid_api_bank_ruby/models/asset_bank_model.rb +2 -2
  52. data/lib/cybrid_api_bank_ruby/models/asset_list_bank_model.rb +2 -2
  53. data/lib/cybrid_api_bank_ruby/models/asset_types_bank_model.rb +2 -2
  54. data/lib/cybrid_api_bank_ruby/models/bank_bank_model.rb +2 -2
  55. data/lib/cybrid_api_bank_ruby/models/bank_feature_bank_model.rb +3 -2
  56. data/lib/cybrid_api_bank_ruby/models/bank_list_bank_model.rb +2 -2
  57. data/lib/cybrid_api_bank_ruby/models/bank_supported_payout_symbols_inner_bank_model.rb +2 -2
  58. data/lib/cybrid_api_bank_ruby/models/bank_type_bank_model.rb +2 -2
  59. data/lib/cybrid_api_bank_ruby/models/compliance_check_bank_model.rb +3 -3
  60. data/lib/cybrid_api_bank_ruby/models/compliance_check_outcome_bank_model.rb +2 -2
  61. data/lib/cybrid_api_bank_ruby/models/compliance_check_type_bank_model.rb +3 -2
  62. data/lib/cybrid_api_bank_ruby/models/compliance_decision_bank_model.rb +3 -3
  63. data/lib/cybrid_api_bank_ruby/models/compliance_decision_state_bank_model.rb +2 -2
  64. data/lib/cybrid_api_bank_ruby/models/compliance_decision_type_bank_model.rb +3 -2
  65. data/lib/cybrid_api_bank_ruby/models/counterparty_address_bank_model.rb +2 -2
  66. data/lib/cybrid_api_bank_ruby/models/counterparty_aliases_inner_bank_model.rb +2 -2
  67. data/lib/cybrid_api_bank_ruby/models/counterparty_bank_model.rb +2 -2
  68. data/lib/cybrid_api_bank_ruby/models/counterparty_list_bank_model.rb +2 -2
  69. data/lib/cybrid_api_bank_ruby/models/counterparty_name_bank_model.rb +2 -2
  70. data/lib/cybrid_api_bank_ruby/models/counterparty_state_bank_model.rb +2 -2
  71. data/lib/cybrid_api_bank_ruby/models/counterparty_type_bank_model.rb +2 -2
  72. data/lib/cybrid_api_bank_ruby/models/customer_address_bank_model.rb +2 -2
  73. data/lib/cybrid_api_bank_ruby/models/customer_aliases_inner_bank_model.rb +2 -2
  74. data/lib/cybrid_api_bank_ruby/models/customer_bank_model.rb +2 -2
  75. data/lib/cybrid_api_bank_ruby/models/customer_list_bank_model.rb +2 -2
  76. data/lib/cybrid_api_bank_ruby/models/customer_name_bank_model.rb +2 -2
  77. data/lib/cybrid_api_bank_ruby/models/customer_state_bank_model.rb +2 -2
  78. data/lib/cybrid_api_bank_ruby/models/customer_type_bank_model.rb +2 -2
  79. data/lib/cybrid_api_bank_ruby/models/deposit_address_bank_model.rb +2 -2
  80. data/lib/cybrid_api_bank_ruby/models/deposit_address_format_bank_model.rb +2 -2
  81. data/lib/cybrid_api_bank_ruby/models/deposit_address_list_bank_model.rb +2 -2
  82. data/lib/cybrid_api_bank_ruby/models/deposit_address_state_bank_model.rb +2 -2
  83. data/lib/cybrid_api_bank_ruby/models/deposit_bank_account_account_details_inner_bank_model.rb +2 -2
  84. data/lib/cybrid_api_bank_ruby/models/deposit_bank_account_bank_model.rb +2 -2
  85. data/lib/cybrid_api_bank_ruby/models/deposit_bank_account_counterparty_address_bank_model.rb +2 -2
  86. data/lib/cybrid_api_bank_ruby/models/deposit_bank_account_list_bank_model.rb +2 -2
  87. data/lib/cybrid_api_bank_ruby/models/deposit_bank_account_routing_details_inner_bank_model.rb +2 -2
  88. data/lib/cybrid_api_bank_ruby/models/deposit_bank_account_routing_number_type_bank_model.rb +2 -2
  89. data/lib/cybrid_api_bank_ruby/models/deposit_bank_account_state_bank_model.rb +2 -2
  90. data/lib/cybrid_api_bank_ruby/models/error_response_bank_model.rb +2 -2
  91. data/lib/cybrid_api_bank_ruby/models/external_bank_account_balances_bank_model.rb +2 -2
  92. data/lib/cybrid_api_bank_ruby/models/external_bank_account_bank_model.rb +2 -2
  93. data/lib/cybrid_api_bank_ruby/models/external_bank_account_kind_bank_model.rb +2 -2
  94. data/lib/cybrid_api_bank_ruby/models/external_bank_account_list_bank_model.rb +2 -2
  95. data/lib/cybrid_api_bank_ruby/models/external_bank_account_pii_inner_addresses_inner_bank_model.rb +2 -2
  96. data/lib/cybrid_api_bank_ruby/models/external_bank_account_pii_inner_bank_model.rb +2 -2
  97. data/lib/cybrid_api_bank_ruby/models/external_bank_account_pii_inner_routing_details_inner_bank_model.rb +2 -2
  98. data/lib/cybrid_api_bank_ruby/models/external_bank_account_state_bank_model.rb +2 -2
  99. data/lib/cybrid_api_bank_ruby/models/external_wallet_bank_model.rb +2 -2
  100. data/lib/cybrid_api_bank_ruby/models/external_wallet_environment_bank_model.rb +2 -2
  101. data/lib/cybrid_api_bank_ruby/models/external_wallet_list_bank_model.rb +2 -2
  102. data/lib/cybrid_api_bank_ruby/models/external_wallet_state_bank_model.rb +2 -2
  103. data/lib/cybrid_api_bank_ruby/models/identification_number_bank_model.rb +3 -3
  104. data/lib/cybrid_api_bank_ruby/models/identity_verification_bank_model.rb +3 -3
  105. data/lib/cybrid_api_bank_ruby/models/identity_verification_list_bank_model.rb +2 -2
  106. data/lib/cybrid_api_bank_ruby/models/identity_verification_method_bank_model.rb +5 -3
  107. data/lib/cybrid_api_bank_ruby/models/identity_verification_outcome_bank_model.rb +2 -2
  108. data/lib/cybrid_api_bank_ruby/models/identity_verification_persona_state_bank_model.rb +2 -2
  109. data/lib/cybrid_api_bank_ruby/models/identity_verification_state_bank_model.rb +2 -2
  110. data/lib/cybrid_api_bank_ruby/models/identity_verification_type_bank_model.rb +2 -2
  111. data/lib/cybrid_api_bank_ruby/models/identity_verification_with_details_bank_model.rb +3 -3
  112. data/lib/cybrid_api_bank_ruby/models/identity_verification_with_details_pii_address_bank_model.rb +2 -2
  113. data/lib/cybrid_api_bank_ruby/models/identity_verification_with_details_pii_bank_model.rb +2 -2
  114. data/lib/cybrid_api_bank_ruby/models/identity_verification_with_details_pii_name_bank_model.rb +2 -2
  115. data/lib/cybrid_api_bank_ruby/models/invoice_bank_model.rb +2 -2
  116. data/lib/cybrid_api_bank_ruby/models/invoice_list_bank_model.rb +2 -2
  117. data/lib/cybrid_api_bank_ruby/models/patch_bank_bank_model.rb +2 -2
  118. data/lib/cybrid_api_bank_ruby/models/patch_customer_bank_model.rb +2 -2
  119. data/lib/cybrid_api_bank_ruby/models/patch_external_bank_account_bank_model.rb +2 -2
  120. data/lib/cybrid_api_bank_ruby/models/payment_instruction_bank_model.rb +2 -2
  121. data/lib/cybrid_api_bank_ruby/models/payment_instruction_list_bank_model.rb +2 -2
  122. data/lib/cybrid_api_bank_ruby/models/platform_file_bank_model.rb +363 -0
  123. data/lib/cybrid_api_bank_ruby/models/platform_file_list_bank_model.rb +329 -0
  124. data/lib/cybrid_api_bank_ruby/models/post_account_bank_model.rb +2 -2
  125. data/lib/cybrid_api_bank_ruby/models/post_bank_bank_model.rb +2 -2
  126. data/lib/cybrid_api_bank_ruby/models/post_counterparty_address_bank_model.rb +2 -2
  127. data/lib/cybrid_api_bank_ruby/models/post_counterparty_aliases_inner_bank_model.rb +2 -2
  128. data/lib/cybrid_api_bank_ruby/models/post_counterparty_bank_model.rb +2 -2
  129. data/lib/cybrid_api_bank_ruby/models/post_counterparty_name_bank_model.rb +2 -2
  130. data/lib/cybrid_api_bank_ruby/models/post_customer_address_bank_model.rb +34 -18
  131. data/lib/cybrid_api_bank_ruby/models/post_customer_aliases_inner_bank_model.rb +221 -0
  132. data/lib/cybrid_api_bank_ruby/models/post_customer_bank_model.rb +75 -27
  133. data/lib/cybrid_api_bank_ruby/models/post_customer_name_bank_model.rb +19 -8
  134. data/lib/cybrid_api_bank_ruby/models/post_deposit_address_bank_model.rb +2 -2
  135. data/lib/cybrid_api_bank_ruby/models/post_deposit_bank_account_bank_model.rb +2 -2
  136. data/lib/cybrid_api_bank_ruby/models/post_external_bank_account_bank_model.rb +2 -2
  137. data/lib/cybrid_api_bank_ruby/models/post_external_bank_account_counterparty_address_bank_model.rb +2 -2
  138. data/lib/cybrid_api_bank_ruby/models/post_external_bank_account_counterparty_bank_account_bank_model.rb +2 -2
  139. data/lib/cybrid_api_bank_ruby/models/post_external_bank_account_counterparty_name_bank_model.rb +2 -2
  140. data/lib/cybrid_api_bank_ruby/models/post_external_wallet_bank_model.rb +2 -2
  141. data/lib/cybrid_api_bank_ruby/models/post_fee_bank_model.rb +2 -2
  142. data/lib/cybrid_api_bank_ruby/models/post_file_bank_model.rb +399 -0
  143. data/lib/cybrid_api_bank_ruby/models/post_identification_number_bank_model.rb +4 -4
  144. data/lib/cybrid_api_bank_ruby/models/post_identity_verification_address_bank_model.rb +9 -9
  145. data/lib/cybrid_api_bank_ruby/models/post_identity_verification_aliases_inner_bank_model.rb +221 -0
  146. data/lib/cybrid_api_bank_ruby/models/post_identity_verification_bank_model.rb +194 -22
  147. data/lib/cybrid_api_bank_ruby/models/post_identity_verification_name_bank_model.rb +7 -7
  148. data/lib/cybrid_api_bank_ruby/models/post_invoice_bank_model.rb +2 -2
  149. data/lib/cybrid_api_bank_ruby/models/post_payment_instruction_bank_model.rb +2 -2
  150. data/lib/cybrid_api_bank_ruby/models/post_quote_bank_model.rb +2 -2
  151. data/lib/cybrid_api_bank_ruby/models/post_quote_entry_bank_model.rb +2 -2
  152. data/lib/cybrid_api_bank_ruby/models/post_trade_bank_model.rb +2 -2
  153. data/lib/cybrid_api_bank_ruby/models/post_transfer_bank_model.rb +2 -2
  154. data/lib/cybrid_api_bank_ruby/models/post_transfer_participant_bank_model.rb +2 -2
  155. data/lib/cybrid_api_bank_ruby/models/post_ultimate_beneficial_owner_bank_model.rb +269 -0
  156. data/lib/cybrid_api_bank_ruby/models/post_workflow_bank_model.rb +2 -2
  157. data/lib/cybrid_api_bank_ruby/models/quote_bank_model.rb +2 -2
  158. data/lib/cybrid_api_bank_ruby/models/quote_entry_bank_model.rb +2 -2
  159. data/lib/cybrid_api_bank_ruby/models/quote_entry_destination_account_bank_model.rb +2 -2
  160. data/lib/cybrid_api_bank_ruby/models/quote_entry_source_account_bank_model.rb +2 -2
  161. data/lib/cybrid_api_bank_ruby/models/quote_list_bank_model.rb +2 -2
  162. data/lib/cybrid_api_bank_ruby/models/quote_side_bank_model.rb +2 -2
  163. data/lib/cybrid_api_bank_ruby/models/quote_type_bank_model.rb +2 -2
  164. data/lib/cybrid_api_bank_ruby/models/symbol_price_bank_model.rb +2 -2
  165. data/lib/cybrid_api_bank_ruby/models/trade_bank_model.rb +2 -2
  166. data/lib/cybrid_api_bank_ruby/models/trade_failure_code_bank_model.rb +2 -2
  167. data/lib/cybrid_api_bank_ruby/models/trade_list_bank_model.rb +2 -2
  168. data/lib/cybrid_api_bank_ruby/models/trade_side_bank_model.rb +2 -2
  169. data/lib/cybrid_api_bank_ruby/models/trade_state_bank_model.rb +2 -2
  170. data/lib/cybrid_api_bank_ruby/models/trade_type_bank_model.rb +2 -2
  171. data/lib/cybrid_api_bank_ruby/models/transfer_account_type_bank_model.rb +2 -2
  172. data/lib/cybrid_api_bank_ruby/models/transfer_bank_model.rb +2 -2
  173. data/lib/cybrid_api_bank_ruby/models/transfer_destination_account_bank_model.rb +2 -2
  174. data/lib/cybrid_api_bank_ruby/models/transfer_entry_bank_model.rb +2 -2
  175. data/lib/cybrid_api_bank_ruby/models/transfer_entry_destination_account_bank_model.rb +2 -2
  176. data/lib/cybrid_api_bank_ruby/models/transfer_failure_code_bank_model.rb +2 -2
  177. data/lib/cybrid_api_bank_ruby/models/transfer_list_bank_model.rb +2 -2
  178. data/lib/cybrid_api_bank_ruby/models/transfer_participant_bank_model.rb +2 -2
  179. data/lib/cybrid_api_bank_ruby/models/transfer_side_bank_model.rb +2 -2
  180. data/lib/cybrid_api_bank_ruby/models/transfer_source_account_bank_model.rb +2 -2
  181. data/lib/cybrid_api_bank_ruby/models/transfer_state_bank_model.rb +2 -2
  182. data/lib/cybrid_api_bank_ruby/models/transfer_type_bank_model.rb +2 -2
  183. data/lib/cybrid_api_bank_ruby/models/workflow_bank_model.rb +2 -2
  184. data/lib/cybrid_api_bank_ruby/models/workflow_state_bank_model.rb +2 -2
  185. data/lib/cybrid_api_bank_ruby/models/workflow_type_bank_model.rb +2 -2
  186. data/lib/cybrid_api_bank_ruby/models/workflow_with_details_all_of_bank_model.rb +2 -2
  187. data/lib/cybrid_api_bank_ruby/models/workflow_with_details_bank_model.rb +2 -2
  188. data/lib/cybrid_api_bank_ruby/models/workflows_list_bank_model.rb +2 -2
  189. data/lib/cybrid_api_bank_ruby/version.rb +3 -3
  190. data/lib/cybrid_api_bank_ruby.rb +9 -2
  191. data/spec/api/accounts_bank_api_spec.rb +2 -2
  192. data/spec/api/assets_bank_api_spec.rb +2 -2
  193. data/spec/api/banks_bank_api_spec.rb +2 -2
  194. data/spec/api/counterparties_bank_api_spec.rb +2 -2
  195. data/spec/api/customers_bank_api_spec.rb +2 -2
  196. data/spec/api/deposit_addresses_bank_api_spec.rb +2 -2
  197. data/spec/api/deposit_bank_accounts_bank_api_spec.rb +2 -2
  198. data/spec/api/external_bank_accounts_bank_api_spec.rb +2 -2
  199. data/spec/api/external_wallets_bank_api_spec.rb +2 -2
  200. data/spec/api/files_bank_api_spec.rb +77 -0
  201. data/spec/api/identity_verifications_bank_api_spec.rb +2 -2
  202. data/spec/api/invoices_bank_api_spec.rb +2 -2
  203. data/spec/api/payment_instructions_bank_api_spec.rb +2 -2
  204. data/spec/api/prices_bank_api_spec.rb +2 -2
  205. data/spec/api/quotes_bank_api_spec.rb +2 -2
  206. data/spec/api/symbols_bank_api_spec.rb +2 -2
  207. data/spec/api/trades_bank_api_spec.rb +2 -2
  208. data/spec/api/transfers_bank_api_spec.rb +2 -2
  209. data/spec/api/workflows_bank_api_spec.rb +2 -2
  210. data/spec/api_client_spec.rb +2 -2
  211. data/spec/configuration_spec.rb +2 -2
  212. data/spec/models/account_bank_model_spec.rb +2 -2
  213. data/spec/models/account_list_bank_model_spec.rb +2 -2
  214. data/spec/models/account_state_bank_model_spec.rb +2 -2
  215. data/spec/models/account_type_bank_model_spec.rb +2 -2
  216. data/spec/models/activity_limit_bank_model_spec.rb +2 -2
  217. data/spec/models/activity_type_bank_model_spec.rb +2 -2
  218. data/spec/models/asset_bank_model_spec.rb +2 -2
  219. data/spec/models/asset_list_bank_model_spec.rb +2 -2
  220. data/spec/models/asset_types_bank_model_spec.rb +2 -2
  221. data/spec/models/bank_bank_model_spec.rb +2 -2
  222. data/spec/models/bank_feature_bank_model_spec.rb +2 -2
  223. data/spec/models/bank_list_bank_model_spec.rb +2 -2
  224. data/spec/models/bank_supported_payout_symbols_inner_bank_model_spec.rb +2 -2
  225. data/spec/models/bank_type_bank_model_spec.rb +2 -2
  226. data/spec/models/compliance_check_bank_model_spec.rb +2 -2
  227. data/spec/models/compliance_check_outcome_bank_model_spec.rb +2 -2
  228. data/spec/models/compliance_check_type_bank_model_spec.rb +2 -2
  229. data/spec/models/compliance_decision_bank_model_spec.rb +2 -2
  230. data/spec/models/compliance_decision_state_bank_model_spec.rb +2 -2
  231. data/spec/models/compliance_decision_type_bank_model_spec.rb +2 -2
  232. data/spec/models/counterparty_address_bank_model_spec.rb +2 -2
  233. data/spec/models/counterparty_aliases_inner_bank_model_spec.rb +2 -2
  234. data/spec/models/counterparty_bank_model_spec.rb +2 -2
  235. data/spec/models/counterparty_list_bank_model_spec.rb +2 -2
  236. data/spec/models/counterparty_name_bank_model_spec.rb +2 -2
  237. data/spec/models/counterparty_state_bank_model_spec.rb +2 -2
  238. data/spec/models/counterparty_type_bank_model_spec.rb +2 -2
  239. data/spec/models/customer_address_bank_model_spec.rb +2 -2
  240. data/spec/models/customer_aliases_inner_bank_model_spec.rb +2 -2
  241. data/spec/models/customer_bank_model_spec.rb +2 -2
  242. data/spec/models/customer_list_bank_model_spec.rb +2 -2
  243. data/spec/models/customer_name_bank_model_spec.rb +2 -2
  244. data/spec/models/customer_state_bank_model_spec.rb +2 -2
  245. data/spec/models/customer_type_bank_model_spec.rb +2 -2
  246. data/spec/models/deposit_address_bank_model_spec.rb +2 -2
  247. data/spec/models/deposit_address_format_bank_model_spec.rb +2 -2
  248. data/spec/models/deposit_address_list_bank_model_spec.rb +2 -2
  249. data/spec/models/deposit_address_state_bank_model_spec.rb +2 -2
  250. data/spec/models/deposit_bank_account_account_details_inner_bank_model_spec.rb +2 -2
  251. data/spec/models/deposit_bank_account_bank_model_spec.rb +2 -2
  252. data/spec/models/deposit_bank_account_counterparty_address_bank_model_spec.rb +2 -2
  253. data/spec/models/deposit_bank_account_list_bank_model_spec.rb +2 -2
  254. data/spec/models/deposit_bank_account_routing_details_inner_bank_model_spec.rb +2 -2
  255. data/spec/models/deposit_bank_account_routing_number_type_bank_model_spec.rb +2 -2
  256. data/spec/models/deposit_bank_account_state_bank_model_spec.rb +2 -2
  257. data/spec/models/error_response_bank_model_spec.rb +2 -2
  258. data/spec/models/external_bank_account_balances_bank_model_spec.rb +2 -2
  259. data/spec/models/external_bank_account_bank_model_spec.rb +2 -2
  260. data/spec/models/external_bank_account_kind_bank_model_spec.rb +2 -2
  261. data/spec/models/external_bank_account_list_bank_model_spec.rb +2 -2
  262. data/spec/models/external_bank_account_pii_inner_addresses_inner_bank_model_spec.rb +2 -2
  263. data/spec/models/external_bank_account_pii_inner_bank_model_spec.rb +2 -2
  264. data/spec/models/external_bank_account_pii_inner_routing_details_inner_bank_model_spec.rb +2 -2
  265. data/spec/models/external_bank_account_state_bank_model_spec.rb +2 -2
  266. data/spec/models/external_wallet_bank_model_spec.rb +2 -2
  267. data/spec/models/external_wallet_environment_bank_model_spec.rb +2 -2
  268. data/spec/models/external_wallet_list_bank_model_spec.rb +2 -2
  269. data/spec/models/external_wallet_state_bank_model_spec.rb +2 -2
  270. data/spec/models/identification_number_bank_model_spec.rb +2 -2
  271. data/spec/models/identity_verification_bank_model_spec.rb +2 -2
  272. data/spec/models/identity_verification_list_bank_model_spec.rb +2 -2
  273. data/spec/models/identity_verification_method_bank_model_spec.rb +2 -2
  274. data/spec/models/identity_verification_outcome_bank_model_spec.rb +2 -2
  275. data/spec/models/identity_verification_persona_state_bank_model_spec.rb +2 -2
  276. data/spec/models/identity_verification_state_bank_model_spec.rb +2 -2
  277. data/spec/models/identity_verification_type_bank_model_spec.rb +2 -2
  278. data/spec/models/identity_verification_with_details_bank_model_spec.rb +2 -2
  279. data/spec/models/identity_verification_with_details_pii_address_bank_model_spec.rb +2 -2
  280. data/spec/models/identity_verification_with_details_pii_bank_model_spec.rb +2 -2
  281. data/spec/models/identity_verification_with_details_pii_name_bank_model_spec.rb +2 -2
  282. data/spec/models/invoice_bank_model_spec.rb +2 -2
  283. data/spec/models/invoice_list_bank_model_spec.rb +2 -2
  284. data/spec/models/patch_bank_bank_model_spec.rb +2 -2
  285. data/spec/models/patch_customer_bank_model_spec.rb +2 -2
  286. data/spec/models/patch_external_bank_account_bank_model_spec.rb +2 -2
  287. data/spec/models/payment_instruction_bank_model_spec.rb +2 -2
  288. data/spec/models/payment_instruction_list_bank_model_spec.rb +2 -2
  289. data/spec/models/platform_file_bank_model_spec.rb +82 -0
  290. data/spec/models/platform_file_list_bank_model_spec.rb +52 -0
  291. data/spec/models/post_account_bank_model_spec.rb +2 -2
  292. data/spec/models/post_bank_bank_model_spec.rb +3 -3
  293. data/spec/models/post_counterparty_address_bank_model_spec.rb +2 -2
  294. data/spec/models/post_counterparty_aliases_inner_bank_model_spec.rb +2 -2
  295. data/spec/models/post_counterparty_bank_model_spec.rb +2 -2
  296. data/spec/models/post_counterparty_name_bank_model_spec.rb +2 -2
  297. data/spec/models/post_customer_address_bank_model_spec.rb +2 -2
  298. data/spec/models/post_customer_aliases_inner_bank_model_spec.rb +34 -0
  299. data/spec/models/post_customer_bank_model_spec.rb +20 -8
  300. data/spec/models/post_customer_name_bank_model_spec.rb +8 -2
  301. data/spec/models/post_deposit_address_bank_model_spec.rb +2 -2
  302. data/spec/models/post_deposit_bank_account_bank_model_spec.rb +2 -2
  303. data/spec/models/post_external_bank_account_bank_model_spec.rb +2 -2
  304. data/spec/models/post_external_bank_account_counterparty_address_bank_model_spec.rb +2 -2
  305. data/spec/models/post_external_bank_account_counterparty_bank_account_bank_model_spec.rb +2 -2
  306. data/spec/models/post_external_bank_account_counterparty_name_bank_model_spec.rb +2 -2
  307. data/spec/models/post_external_wallet_bank_model_spec.rb +2 -2
  308. data/spec/models/post_fee_bank_model_spec.rb +2 -2
  309. data/spec/models/post_file_bank_model_spec.rb +66 -0
  310. data/spec/models/post_identification_number_bank_model_spec.rb +3 -3
  311. data/spec/models/post_identity_verification_address_bank_model_spec.rb +2 -2
  312. data/spec/models/post_identity_verification_aliases_inner_bank_model_spec.rb +34 -0
  313. data/spec/models/post_identity_verification_bank_model_spec.rb +46 -4
  314. data/spec/models/post_identity_verification_name_bank_model_spec.rb +2 -2
  315. data/spec/models/post_invoice_bank_model_spec.rb +2 -2
  316. data/spec/models/post_payment_instruction_bank_model_spec.rb +2 -2
  317. data/spec/models/post_quote_bank_model_spec.rb +2 -2
  318. data/spec/models/post_quote_entry_bank_model_spec.rb +2 -2
  319. data/spec/models/post_trade_bank_model_spec.rb +2 -2
  320. data/spec/models/post_transfer_bank_model_spec.rb +2 -2
  321. data/spec/models/post_transfer_participant_bank_model_spec.rb +2 -2
  322. data/spec/models/post_ultimate_beneficial_owner_bank_model_spec.rb +40 -0
  323. data/spec/models/post_workflow_bank_model_spec.rb +2 -2
  324. data/spec/models/quote_bank_model_spec.rb +2 -2
  325. data/spec/models/quote_entry_bank_model_spec.rb +2 -2
  326. data/spec/models/quote_entry_destination_account_bank_model_spec.rb +2 -2
  327. data/spec/models/quote_entry_source_account_bank_model_spec.rb +2 -2
  328. data/spec/models/quote_list_bank_model_spec.rb +2 -2
  329. data/spec/models/quote_side_bank_model_spec.rb +2 -2
  330. data/spec/models/quote_type_bank_model_spec.rb +2 -2
  331. data/spec/models/symbol_price_bank_model_spec.rb +2 -2
  332. data/spec/models/trade_bank_model_spec.rb +2 -2
  333. data/spec/models/trade_failure_code_bank_model_spec.rb +2 -2
  334. data/spec/models/trade_list_bank_model_spec.rb +2 -2
  335. data/spec/models/trade_side_bank_model_spec.rb +2 -2
  336. data/spec/models/trade_state_bank_model_spec.rb +2 -2
  337. data/spec/models/trade_type_bank_model_spec.rb +2 -2
  338. data/spec/models/transfer_account_type_bank_model_spec.rb +2 -2
  339. data/spec/models/transfer_bank_model_spec.rb +2 -2
  340. data/spec/models/transfer_destination_account_bank_model_spec.rb +2 -2
  341. data/spec/models/transfer_entry_bank_model_spec.rb +2 -2
  342. data/spec/models/transfer_entry_destination_account_bank_model_spec.rb +2 -2
  343. data/spec/models/transfer_failure_code_bank_model_spec.rb +2 -2
  344. data/spec/models/transfer_list_bank_model_spec.rb +2 -2
  345. data/spec/models/transfer_participant_bank_model_spec.rb +2 -2
  346. data/spec/models/transfer_side_bank_model_spec.rb +2 -2
  347. data/spec/models/transfer_source_account_bank_model_spec.rb +2 -2
  348. data/spec/models/transfer_state_bank_model_spec.rb +2 -2
  349. data/spec/models/transfer_type_bank_model_spec.rb +2 -2
  350. data/spec/models/workflow_bank_model_spec.rb +2 -2
  351. data/spec/models/workflow_state_bank_model_spec.rb +2 -2
  352. data/spec/models/workflow_type_bank_model_spec.rb +2 -2
  353. data/spec/models/workflow_with_details_all_of_bank_model_spec.rb +2 -2
  354. data/spec/models/workflow_with_details_bank_model_spec.rb +2 -2
  355. data/spec/models/workflows_list_bank_model_spec.rb +2 -2
  356. data/spec/spec_helper.rb +2 -2
  357. data/vendor/bundle/ruby/3.3.0/extensions/x86_64-linux/3.3.0/byebug-11.1.3/gem_make.out +5 -5
  358. data/vendor/bundle/ruby/3.3.0/extensions/x86_64-linux/3.3.0/date-3.4.1/gem_make.out +5 -5
  359. data/vendor/bundle/ruby/3.3.0/extensions/x86_64-linux/3.3.0/jaro_winkler-1.5.6/gem_make.out +5 -5
  360. data/vendor/bundle/ruby/3.3.0/extensions/x86_64-linux/3.3.0/psych-5.2.3/gem_make.out +5 -5
  361. data/vendor/bundle/ruby/3.3.0/extensions/x86_64-linux/3.3.0/racc-1.8.1/gem_make.out +5 -5
  362. data/vendor/bundle/ruby/3.3.0/extensions/x86_64-linux/3.3.0/stringio-3.1.2/gem_make.out +5 -5
  363. metadata +30 -2
@@ -0,0 +1,399 @@
1
+ =begin
2
+ #Cybrid Bank API
3
+
4
+ ## Cybrid API documentation Welcome to Cybrid, an all-in-one crypto platform that enables you to easily **build** and **launch** white-label crypto products or services. In these documents, you'll find details on how our REST API operates and generally how our platform functions. If you're looking for our UI SDK Widgets for Web or Mobile (iOS/Android), generated API clients, or demo applications, head over to our [Github repo](https://github.com/Cybrid-app). 💡 We recommend bookmarking the [Cybrid LinkTree](https://linktr.ee/cybridtechnologies) which contains many helpful links to platform resources. ## Getting Started This is Cybrid's public interactive API documentation, which allows you to fully test our APIs. If you'd like to use a different tool to exercise our APIs, you can download the [Open API 3.0 yaml](https://bank.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. [Introduction](https://docs.cybrid.xyz/docs/introduction) 2. [Platform Introduction](https://docs.cybrid.xyz/docs/how-is-cybrid-architected) 3. [Testing with Hosted Web Demo App](https://docs.cybrid.xyz/docs/testing-with-hosted-web-demo-app) In [Getting Started in the Cybrid Sandbox](https://docs.cybrid.xyz/docs/how-do-i-get-started-with-the-sandbox), 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. ## 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 files:read files: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 files:read files:execute' ``` <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
+
6
+ The version of the OpenAPI document: v0.123.203
7
+ Contact: support@cybrid.app
8
+ Generated by: https://openapi-generator.tech
9
+ OpenAPI Generator version: 6.0.0
10
+
11
+ =end
12
+
13
+ require 'date'
14
+ require 'time'
15
+
16
+ module CybridApiBank
17
+ # Request body for a new file.
18
+ class PostFileBankModel
19
+ # The type of file.
20
+ attr_accessor :type
21
+
22
+ # The customer identifier.
23
+ attr_accessor :customer_guid
24
+
25
+ # The name of the file.
26
+ attr_accessor :filename
27
+
28
+ # The content type of the file.
29
+ attr_accessor :content_type
30
+
31
+ # Base64 encoded file content
32
+ attr_accessor :data
33
+
34
+ class EnumAttributeValidator
35
+ attr_reader :datatype
36
+ attr_reader :allowable_values
37
+
38
+ def initialize(datatype, allowable_values)
39
+ @allowable_values = allowable_values.map do |value|
40
+ case datatype.to_s
41
+ when /Integer/i
42
+ value.to_i
43
+ when /Float/i
44
+ value.to_f
45
+ else
46
+ value
47
+ end
48
+ end
49
+ end
50
+
51
+ def valid?(value)
52
+ !value || allowable_values.include?(value)
53
+ end
54
+ end
55
+
56
+ # Attribute mapping from ruby-style variable name to JSON key.
57
+ def self.attribute_map
58
+ {
59
+ :'type' => :'type',
60
+ :'customer_guid' => :'customer_guid',
61
+ :'filename' => :'filename',
62
+ :'content_type' => :'content_type',
63
+ :'data' => :'data'
64
+ }
65
+ end
66
+
67
+ # Returns all the JSON keys this model knows about
68
+ def self.acceptable_attributes
69
+ attribute_map.values
70
+ end
71
+
72
+ # Attribute type mapping.
73
+ def self.openapi_types
74
+ {
75
+ :'type' => :'String',
76
+ :'customer_guid' => :'String',
77
+ :'filename' => :'String',
78
+ :'content_type' => :'String',
79
+ :'data' => :'String'
80
+ }
81
+ end
82
+
83
+ # List of attributes with nullable: true
84
+ def self.openapi_nullable
85
+ Set.new([
86
+ :'data'
87
+ ])
88
+ end
89
+
90
+ # Initializes the object
91
+ # @param [Hash] attributes Model attributes in the form of hash
92
+ def initialize(attributes = {})
93
+ if (!attributes.is_a?(Hash))
94
+ fail ArgumentError, "The input argument (attributes) must be a hash in `CybridApiBank::PostFileBankModel` initialize method"
95
+ end
96
+
97
+ # check to see if the attribute exists and convert string to symbol for hash key
98
+ attributes = attributes.each_with_object({}) { |(k, v), h|
99
+ if (!self.class.attribute_map.key?(k.to_sym))
100
+ fail ArgumentError, "`#{k}` is not a valid attribute in `CybridApiBank::PostFileBankModel`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
101
+ end
102
+ h[k.to_sym] = v
103
+ }
104
+
105
+ if attributes.key?(:'type')
106
+ self.type = attributes[:'type']
107
+ end
108
+
109
+ if attributes.key?(:'customer_guid')
110
+ self.customer_guid = attributes[:'customer_guid']
111
+ end
112
+
113
+ if attributes.key?(:'filename')
114
+ self.filename = attributes[:'filename']
115
+ end
116
+
117
+ if attributes.key?(:'content_type')
118
+ self.content_type = attributes[:'content_type']
119
+ end
120
+
121
+ if attributes.key?(:'data')
122
+ self.data = attributes[:'data']
123
+ end
124
+ end
125
+
126
+ # Show invalid properties with the reasons. Usually used together with valid?
127
+ # @return Array for valid properties with the reasons
128
+ def list_invalid_properties
129
+ invalid_properties = Array.new
130
+ if @type.nil?
131
+ invalid_properties.push('invalid value for "type", type cannot be nil.')
132
+ end
133
+
134
+ if @customer_guid.nil?
135
+ invalid_properties.push('invalid value for "customer_guid", customer_guid cannot be nil.')
136
+ end
137
+
138
+ if @customer_guid.to_s.length > 32
139
+ invalid_properties.push('invalid value for "customer_guid", the character length must be smaller than or equal to 32.')
140
+ end
141
+
142
+ if @customer_guid.to_s.length < 32
143
+ invalid_properties.push('invalid value for "customer_guid", the character length must be great than or equal to 32.')
144
+ end
145
+
146
+ if @filename.nil?
147
+ invalid_properties.push('invalid value for "filename", filename cannot be nil.')
148
+ end
149
+
150
+ if @filename.to_s.length > 128
151
+ invalid_properties.push('invalid value for "filename", the character length must be smaller than or equal to 128.')
152
+ end
153
+
154
+ if @filename.to_s.length < 1
155
+ invalid_properties.push('invalid value for "filename", the character length must be great than or equal to 1.')
156
+ end
157
+
158
+ if @content_type.nil?
159
+ invalid_properties.push('invalid value for "content_type", content_type cannot be nil.')
160
+ end
161
+
162
+ if !@data.nil? && @data.to_s.length > 10485760
163
+ invalid_properties.push('invalid value for "data", the character length must be smaller than or equal to 10485760.')
164
+ end
165
+
166
+ invalid_properties
167
+ end
168
+
169
+ # Check to see if the all the properties in the model are valid
170
+ # @return true if the model is valid
171
+ def valid?
172
+ return false if @type.nil?
173
+ type_validator = EnumAttributeValidator.new('String', ["drivers_license_front", "drivers_license_back", "passport", "identification_card", "residence_card", "selfie", "selfie_left", "selfie_right", "utility_bill", "bank_statement", "property_tax", "tax_document", "ein_letter", "incorporation_certificate"])
174
+ return false unless type_validator.valid?(@type)
175
+ return false if @customer_guid.nil?
176
+ return false if @customer_guid.to_s.length > 32
177
+ return false if @customer_guid.to_s.length < 32
178
+ return false if @filename.nil?
179
+ return false if @filename.to_s.length > 128
180
+ return false if @filename.to_s.length < 1
181
+ return false if @content_type.nil?
182
+ content_type_validator = EnumAttributeValidator.new('String', ["image/jpeg", "image/png", "application/pdf"])
183
+ return false unless content_type_validator.valid?(@content_type)
184
+ return false if !@data.nil? && @data.to_s.length > 10485760
185
+ true
186
+ end
187
+
188
+ # Custom attribute writer method checking allowed values (enum).
189
+ # @param [Object] type Object to be assigned
190
+ def type=(type)
191
+ validator = EnumAttributeValidator.new('String', ["drivers_license_front", "drivers_license_back", "passport", "identification_card", "residence_card", "selfie", "selfie_left", "selfie_right", "utility_bill", "bank_statement", "property_tax", "tax_document", "ein_letter", "incorporation_certificate"])
192
+ unless validator.valid?(type)
193
+ fail ArgumentError, "invalid value for \"type\", must be one of #{validator.allowable_values}."
194
+ end
195
+ @type = type
196
+ end
197
+
198
+ # Custom attribute writer method with validation
199
+ # @param [Object] customer_guid Value to be assigned
200
+ def customer_guid=(customer_guid)
201
+ if customer_guid.nil?
202
+ fail ArgumentError, 'customer_guid cannot be nil'
203
+ end
204
+
205
+ if customer_guid.to_s.length > 32
206
+ fail ArgumentError, 'invalid value for "customer_guid", the character length must be smaller than or equal to 32.'
207
+ end
208
+
209
+ if customer_guid.to_s.length < 32
210
+ fail ArgumentError, 'invalid value for "customer_guid", the character length must be great than or equal to 32.'
211
+ end
212
+
213
+ @customer_guid = customer_guid
214
+ end
215
+
216
+ # Custom attribute writer method with validation
217
+ # @param [Object] filename Value to be assigned
218
+ def filename=(filename)
219
+ if filename.nil?
220
+ fail ArgumentError, 'filename cannot be nil'
221
+ end
222
+
223
+ if filename.to_s.length > 128
224
+ fail ArgumentError, 'invalid value for "filename", the character length must be smaller than or equal to 128.'
225
+ end
226
+
227
+ if filename.to_s.length < 1
228
+ fail ArgumentError, 'invalid value for "filename", the character length must be great than or equal to 1.'
229
+ end
230
+
231
+ @filename = filename
232
+ end
233
+
234
+ # Custom attribute writer method checking allowed values (enum).
235
+ # @param [Object] content_type Object to be assigned
236
+ def content_type=(content_type)
237
+ validator = EnumAttributeValidator.new('String', ["image/jpeg", "image/png", "application/pdf"])
238
+ unless validator.valid?(content_type)
239
+ fail ArgumentError, "invalid value for \"content_type\", must be one of #{validator.allowable_values}."
240
+ end
241
+ @content_type = content_type
242
+ end
243
+
244
+ # Custom attribute writer method with validation
245
+ # @param [Object] data Value to be assigned
246
+ def data=(data)
247
+ if !data.nil? && data.to_s.length > 10485760
248
+ fail ArgumentError, 'invalid value for "data", the character length must be smaller than or equal to 10485760.'
249
+ end
250
+
251
+ @data = data
252
+ end
253
+
254
+ # Checks equality by comparing each attribute.
255
+ # @param [Object] Object to be compared
256
+ def ==(o)
257
+ return true if self.equal?(o)
258
+ self.class == o.class &&
259
+ type == o.type &&
260
+ customer_guid == o.customer_guid &&
261
+ filename == o.filename &&
262
+ content_type == o.content_type &&
263
+ data == o.data
264
+ end
265
+
266
+ # @see the `==` method
267
+ # @param [Object] Object to be compared
268
+ def eql?(o)
269
+ self == o
270
+ end
271
+
272
+ # Calculates hash code according to all attributes.
273
+ # @return [Integer] Hash code
274
+ def hash
275
+ [type, customer_guid, filename, content_type, data].hash
276
+ end
277
+
278
+ # Builds the object from hash
279
+ # @param [Hash] attributes Model attributes in the form of hash
280
+ # @return [Object] Returns the model itself
281
+ def self.build_from_hash(attributes)
282
+ new.build_from_hash(attributes)
283
+ end
284
+
285
+ # Builds the object from hash
286
+ # @param [Hash] attributes Model attributes in the form of hash
287
+ # @return [Object] Returns the model itself
288
+ def build_from_hash(attributes)
289
+ return nil unless attributes.is_a?(Hash)
290
+ attributes = attributes.transform_keys(&:to_sym)
291
+ self.class.openapi_types.each_pair do |key, type|
292
+ if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
293
+ self.send("#{key}=", nil)
294
+ elsif type =~ /\AArray<(.*)>/i
295
+ # check to ensure the input is an array given that the attribute
296
+ # is documented as an array but the input is not
297
+ if attributes[self.class.attribute_map[key]].is_a?(Array)
298
+ self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
299
+ end
300
+ elsif !attributes[self.class.attribute_map[key]].nil?
301
+ self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
302
+ end
303
+ end
304
+
305
+ self
306
+ end
307
+
308
+ # Deserializes the data based on type
309
+ # @param string type Data type
310
+ # @param string value Value to be deserialized
311
+ # @return [Object] Deserialized data
312
+ def _deserialize(type, value)
313
+ case type.to_sym
314
+ when :Time
315
+ Time.parse(value)
316
+ when :Date
317
+ Date.parse(value)
318
+ when :String
319
+ value.to_s
320
+ when :Integer
321
+ value.to_i
322
+ when :Float
323
+ value.to_f
324
+ when :Boolean
325
+ if value.to_s =~ /\A(true|t|yes|y|1)\z/i
326
+ true
327
+ else
328
+ false
329
+ end
330
+ when :Object
331
+ # generic object (usually a Hash), return directly
332
+ value
333
+ when /\AArray<(?<inner_type>.+)>\z/
334
+ inner_type = Regexp.last_match[:inner_type]
335
+ value.map { |v| _deserialize(inner_type, v) }
336
+ when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
337
+ k_type = Regexp.last_match[:k_type]
338
+ v_type = Regexp.last_match[:v_type]
339
+ {}.tap do |hash|
340
+ value.each do |k, v|
341
+ hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
342
+ end
343
+ end
344
+ else # model
345
+ # models (e.g. Pet) or oneOf
346
+ klass = CybridApiBank.const_get(type)
347
+ klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
348
+ end
349
+ end
350
+
351
+ # Returns the string representation of the object
352
+ # @return [String] String presentation of the object
353
+ def to_s
354
+ to_hash.to_s
355
+ end
356
+
357
+ # to_body is an alias to to_hash (backward compatibility)
358
+ # @return [Hash] Returns the object in the form of hash
359
+ def to_body
360
+ to_hash
361
+ end
362
+
363
+ # Returns the object in the form of hash
364
+ # @return [Hash] Returns the object in the form of hash
365
+ def to_hash
366
+ hash = {}
367
+ self.class.attribute_map.each_pair do |attr, param|
368
+ value = self.send(attr)
369
+ if value.nil?
370
+ is_nullable = self.class.openapi_nullable.include?(attr)
371
+ next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
372
+ end
373
+
374
+ hash[param] = _to_hash(value)
375
+ end
376
+ hash
377
+ end
378
+
379
+ # Outputs non-array value in the form of hash
380
+ # For object, use to_hash. Otherwise, just return the value
381
+ # @param [Object] value Any valid value
382
+ # @return [Hash] Returns the value in the form of hash
383
+ def _to_hash(value)
384
+ if value.is_a?(Array)
385
+ value.compact.map { |v| _to_hash(v) }
386
+ elsif value.is_a?(Hash)
387
+ {}.tap do |hash|
388
+ value.each { |k, v| hash[k] = _to_hash(v) }
389
+ end
390
+ elsif value.respond_to? :to_hash
391
+ value.to_hash
392
+ else
393
+ value
394
+ end
395
+ end
396
+
397
+ end
398
+
399
+ end
@@ -1,9 +1,9 @@
1
1
  =begin
2
2
  #Cybrid Bank API
3
3
 
4
- ## Cybrid API documentation Welcome to Cybrid, an all-in-one crypto platform that enables you to easily **build** and **launch** white-label crypto products or services. In these documents, you'll find details on how our REST API operates and generally how our platform functions. If you're looking for our UI SDK Widgets for Web or Mobile (iOS/Android), generated API clients, or demo applications, head over to our [Github repo](https://github.com/Cybrid-app). 💡 We recommend bookmarking the [Cybrid LinkTree](https://linktr.ee/cybridtechnologies) which contains many helpful links to platform resources. ## Getting Started This is Cybrid's public interactive API documentation, which allows you to fully test our APIs. If you'd like to use a different tool to exercise our APIs, you can download the [Open API 3.0 yaml](https://bank.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. [Introduction](https://docs.cybrid.xyz/docs/introduction) 2. [Platform Introduction](https://docs.cybrid.xyz/docs/how-is-cybrid-architected) 3. [Testing with Hosted Web Demo App](https://docs.cybrid.xyz/docs/testing-with-hosted-web-demo-app) In [Getting Started in the Cybrid Sandbox](https://docs.cybrid.xyz/docs/how-do-i-get-started-with-the-sandbox), 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. ## 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.
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. [Introduction](https://docs.cybrid.xyz/docs/introduction) 2. [Platform Introduction](https://docs.cybrid.xyz/docs/how-is-cybrid-architected) 3. [Testing with Hosted Web Demo App](https://docs.cybrid.xyz/docs/testing-with-hosted-web-demo-app) In [Getting Started in the Cybrid Sandbox](https://docs.cybrid.xyz/docs/how-do-i-get-started-with-the-sandbox), 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. ## 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 files:read files: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 files:read files:execute' ``` <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.123.152
6
+ The version of the OpenAPI document: v0.123.203
7
7
  Contact: support@cybrid.app
8
8
  Generated by: https://openapi-generator.tech
9
9
  OpenAPI Generator version: 6.0.0
@@ -127,7 +127,7 @@ module CybridApiBank
127
127
  # @return true if the model is valid
128
128
  def valid?
129
129
  return false if @type.nil?
130
- type_validator = EnumAttributeValidator.new('String', ["drivers_license", "passport", "passport_card", "residence_card", "social_security_number", "tax_identification_number", "identification_card"])
130
+ type_validator = EnumAttributeValidator.new('String', ["drivers_license", "passport", "passport_card", "residence_card", "social_security_number", "tax_identification_number", "identification_card", "employer_identification_number", "business_registration_number"])
131
131
  return false unless type_validator.valid?(@type)
132
132
  return false if @issuing_country_code.nil?
133
133
  return false if @identification_number.nil?
@@ -137,7 +137,7 @@ module CybridApiBank
137
137
  # Custom attribute writer method checking allowed values (enum).
138
138
  # @param [Object] type Object to be assigned
139
139
  def type=(type)
140
- validator = EnumAttributeValidator.new('String', ["drivers_license", "passport", "passport_card", "residence_card", "social_security_number", "tax_identification_number", "identification_card"])
140
+ validator = EnumAttributeValidator.new('String', ["drivers_license", "passport", "passport_card", "residence_card", "social_security_number", "tax_identification_number", "identification_card", "employer_identification_number", "business_registration_number"])
141
141
  unless validator.valid?(type)
142
142
  fail ArgumentError, "invalid value for \"type\", must be one of #{validator.allowable_values}."
143
143
  end