cybrid_api_bank_ruby 0.129.1239 → 0.129.1240

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (477) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile.lock +2 -2
  3. data/README.md +7 -12
  4. data/cybrid_api_bank_ruby.gemspec +2 -2
  5. data/docs/AccountsBankApi.md +1 -1
  6. data/docs/InvoicesBankApi.md +0 -146
  7. data/docs/PaymentInstructionsBankApi.md +0 -73
  8. data/docs/PostQuoteBankModel.md +3 -5
  9. data/docs/PostTransferBankModel.md +4 -8
  10. data/lib/cybrid_api_bank_ruby/api/accounts_bank_api.rb +4 -4
  11. data/lib/cybrid_api_bank_ruby/api/assets_bank_api.rb +2 -2
  12. data/lib/cybrid_api_bank_ruby/api/banks_bank_api.rb +2 -2
  13. data/lib/cybrid_api_bank_ruby/api/counterparties_bank_api.rb +2 -2
  14. data/lib/cybrid_api_bank_ruby/api/customers_bank_api.rb +2 -2
  15. data/lib/cybrid_api_bank_ruby/api/deposit_addresses_bank_api.rb +2 -2
  16. data/lib/cybrid_api_bank_ruby/api/deposit_bank_accounts_bank_api.rb +2 -2
  17. data/lib/cybrid_api_bank_ruby/api/executions_bank_api.rb +2 -2
  18. data/lib/cybrid_api_bank_ruby/api/external_bank_accounts_bank_api.rb +2 -2
  19. data/lib/cybrid_api_bank_ruby/api/external_wallets_bank_api.rb +2 -2
  20. data/lib/cybrid_api_bank_ruby/api/files_bank_api.rb +2 -2
  21. data/lib/cybrid_api_bank_ruby/api/identity_verifications_bank_api.rb +2 -2
  22. data/lib/cybrid_api_bank_ruby/api/invoices_bank_api.rb +2 -133
  23. data/lib/cybrid_api_bank_ruby/api/payment_instructions_bank_api.rb +2 -70
  24. data/lib/cybrid_api_bank_ruby/api/persona_sessions_bank_api.rb +2 -2
  25. data/lib/cybrid_api_bank_ruby/api/plans_bank_api.rb +2 -2
  26. data/lib/cybrid_api_bank_ruby/api/prices_bank_api.rb +2 -2
  27. data/lib/cybrid_api_bank_ruby/api/quotes_bank_api.rb +2 -2
  28. data/lib/cybrid_api_bank_ruby/api/sardine_sessions_bank_api.rb +2 -2
  29. data/lib/cybrid_api_bank_ruby/api/symbols_bank_api.rb +2 -2
  30. data/lib/cybrid_api_bank_ruby/api/trades_bank_api.rb +2 -2
  31. data/lib/cybrid_api_bank_ruby/api/transactions_bank_api.rb +2 -2
  32. data/lib/cybrid_api_bank_ruby/api/transfers_bank_api.rb +2 -2
  33. data/lib/cybrid_api_bank_ruby/api/workflows_bank_api.rb +2 -2
  34. data/lib/cybrid_api_bank_ruby/api_client.rb +2 -2
  35. data/lib/cybrid_api_bank_ruby/api_error.rb +2 -2
  36. data/lib/cybrid_api_bank_ruby/configuration.rb +2 -2
  37. data/lib/cybrid_api_bank_ruby/models/account_association_bank_model.rb +2 -2
  38. data/lib/cybrid_api_bank_ruby/models/account_bank_model.rb +2 -2
  39. data/lib/cybrid_api_bank_ruby/models/account_list_bank_model.rb +2 -2
  40. data/lib/cybrid_api_bank_ruby/models/account_state_bank_model.rb +2 -2
  41. data/lib/cybrid_api_bank_ruby/models/account_type_bank_model.rb +2 -2
  42. data/lib/cybrid_api_bank_ruby/models/activity_limit_bank_model.rb +2 -2
  43. data/lib/cybrid_api_bank_ruby/models/activity_side_bank_model.rb +2 -2
  44. data/lib/cybrid_api_bank_ruby/models/activity_type_bank_model.rb +2 -2
  45. data/lib/cybrid_api_bank_ruby/models/asset_bank_model.rb +2 -2
  46. data/lib/cybrid_api_bank_ruby/models/asset_list_bank_model.rb +2 -2
  47. data/lib/cybrid_api_bank_ruby/models/asset_types_bank_model.rb +2 -2
  48. data/lib/cybrid_api_bank_ruby/models/balance_bank_model.rb +2 -2
  49. data/lib/cybrid_api_bank_ruby/models/bank_bank_model.rb +2 -2
  50. data/lib/cybrid_api_bank_ruby/models/bank_feature_bank_model.rb +2 -2
  51. data/lib/cybrid_api_bank_ruby/models/bank_list_bank_model.rb +2 -2
  52. data/lib/cybrid_api_bank_ruby/models/bank_supported_payout_symbols_inner_bank_model.rb +2 -2
  53. data/lib/cybrid_api_bank_ruby/models/bank_type_bank_model.rb +2 -2
  54. data/lib/cybrid_api_bank_ruby/models/compliance_check_bank_model.rb +2 -2
  55. data/lib/cybrid_api_bank_ruby/models/compliance_check_outcome_bank_model.rb +2 -2
  56. data/lib/cybrid_api_bank_ruby/models/compliance_check_type_bank_model.rb +2 -2
  57. data/lib/cybrid_api_bank_ruby/models/compliance_decision_bank_model.rb +2 -2
  58. data/lib/cybrid_api_bank_ruby/models/compliance_decision_state_bank_model.rb +2 -2
  59. data/lib/cybrid_api_bank_ruby/models/compliance_decision_type_bank_model.rb +2 -2
  60. data/lib/cybrid_api_bank_ruby/models/counterparty_address_bank_model.rb +2 -2
  61. data/lib/cybrid_api_bank_ruby/models/counterparty_aliases_inner_bank_model.rb +2 -2
  62. data/lib/cybrid_api_bank_ruby/models/counterparty_bank_model.rb +2 -2
  63. data/lib/cybrid_api_bank_ruby/models/counterparty_list_bank_model.rb +2 -2
  64. data/lib/cybrid_api_bank_ruby/models/counterparty_name_bank_model.rb +2 -2
  65. data/lib/cybrid_api_bank_ruby/models/counterparty_state_bank_model.rb +2 -2
  66. data/lib/cybrid_api_bank_ruby/models/counterparty_type_bank_model.rb +2 -2
  67. data/lib/cybrid_api_bank_ruby/models/customer_address_bank_model.rb +2 -2
  68. data/lib/cybrid_api_bank_ruby/models/customer_aliases_inner_bank_model.rb +2 -2
  69. data/lib/cybrid_api_bank_ruby/models/customer_bank_model.rb +2 -2
  70. data/lib/cybrid_api_bank_ruby/models/customer_list_bank_model.rb +2 -2
  71. data/lib/cybrid_api_bank_ruby/models/customer_name_bank_model.rb +2 -2
  72. data/lib/cybrid_api_bank_ruby/models/customer_state_bank_model.rb +2 -2
  73. data/lib/cybrid_api_bank_ruby/models/customer_type_bank_model.rb +2 -2
  74. data/lib/cybrid_api_bank_ruby/models/deposit_address_bank_model.rb +2 -2
  75. data/lib/cybrid_api_bank_ruby/models/deposit_address_format_bank_model.rb +2 -2
  76. data/lib/cybrid_api_bank_ruby/models/deposit_address_list_bank_model.rb +2 -2
  77. data/lib/cybrid_api_bank_ruby/models/deposit_address_state_bank_model.rb +2 -2
  78. data/lib/cybrid_api_bank_ruby/models/deposit_bank_account_account_details_inner_bank_model.rb +2 -2
  79. data/lib/cybrid_api_bank_ruby/models/deposit_bank_account_bank_model.rb +2 -2
  80. data/lib/cybrid_api_bank_ruby/models/deposit_bank_account_counterparty_address_bank_model.rb +2 -2
  81. data/lib/cybrid_api_bank_ruby/models/deposit_bank_account_list_bank_model.rb +2 -2
  82. data/lib/cybrid_api_bank_ruby/models/deposit_bank_account_routing_details_inner_bank_model.rb +2 -2
  83. data/lib/cybrid_api_bank_ruby/models/deposit_bank_account_routing_number_type_bank_model.rb +2 -2
  84. data/lib/cybrid_api_bank_ruby/models/deposit_bank_account_state_bank_model.rb +2 -2
  85. data/lib/cybrid_api_bank_ruby/models/effective_rate_bank_model.rb +2 -2
  86. data/lib/cybrid_api_bank_ruby/models/error_response_bank_model.rb +2 -2
  87. data/lib/cybrid_api_bank_ruby/models/execution_bank_model.rb +2 -2
  88. data/lib/cybrid_api_bank_ruby/models/execution_list_bank_model.rb +2 -2
  89. data/lib/cybrid_api_bank_ruby/models/execution_travel_rule_info_bank_model.rb +2 -2
  90. data/lib/cybrid_api_bank_ruby/models/external_bank_account_balances_bank_model.rb +2 -2
  91. data/lib/cybrid_api_bank_ruby/models/external_bank_account_bank_model.rb +2 -2
  92. data/lib/cybrid_api_bank_ruby/models/external_bank_account_kind_bank_model.rb +2 -2
  93. data/lib/cybrid_api_bank_ruby/models/external_bank_account_list_bank_model.rb +2 -2
  94. data/lib/cybrid_api_bank_ruby/models/external_bank_account_pii_inner_addresses_inner_bank_model.rb +2 -2
  95. data/lib/cybrid_api_bank_ruby/models/external_bank_account_pii_inner_bank_model.rb +2 -2
  96. data/lib/cybrid_api_bank_ruby/models/external_bank_account_pii_inner_routing_details_inner_bank_model.rb +2 -2
  97. data/lib/cybrid_api_bank_ruby/models/external_bank_account_state_bank_model.rb +2 -2
  98. data/lib/cybrid_api_bank_ruby/models/external_wallet_bank_model.rb +2 -2
  99. data/lib/cybrid_api_bank_ruby/models/external_wallet_environment_bank_model.rb +2 -2
  100. data/lib/cybrid_api_bank_ruby/models/external_wallet_list_bank_model.rb +2 -2
  101. data/lib/cybrid_api_bank_ruby/models/external_wallet_state_bank_model.rb +2 -2
  102. data/lib/cybrid_api_bank_ruby/models/fee_association_bank_model.rb +2 -2
  103. data/lib/cybrid_api_bank_ruby/models/fee_detail_bank_model.rb +2 -2
  104. data/lib/cybrid_api_bank_ruby/models/hold_detail_bank_model.rb +2 -2
  105. data/lib/cybrid_api_bank_ruby/models/identification_number_bank_model.rb +2 -2
  106. data/lib/cybrid_api_bank_ruby/models/identity_verification_bank_model.rb +2 -2
  107. data/lib/cybrid_api_bank_ruby/models/identity_verification_business_associate_bank_model.rb +2 -2
  108. data/lib/cybrid_api_bank_ruby/models/identity_verification_document_bank_model.rb +2 -2
  109. data/lib/cybrid_api_bank_ruby/models/identity_verification_document_file_bank_model.rb +2 -2
  110. data/lib/cybrid_api_bank_ruby/models/identity_verification_document_file_metadata_bank_model.rb +2 -2
  111. data/lib/cybrid_api_bank_ruby/models/identity_verification_list_bank_model.rb +2 -2
  112. data/lib/cybrid_api_bank_ruby/models/identity_verification_method_bank_model.rb +2 -2
  113. data/lib/cybrid_api_bank_ruby/models/identity_verification_options_bank_model.rb +2 -2
  114. data/lib/cybrid_api_bank_ruby/models/identity_verification_outcome_bank_model.rb +2 -2
  115. data/lib/cybrid_api_bank_ruby/models/identity_verification_persona_state_bank_model.rb +2 -2
  116. data/lib/cybrid_api_bank_ruby/models/identity_verification_state_bank_model.rb +2 -2
  117. data/lib/cybrid_api_bank_ruby/models/identity_verification_type_bank_model.rb +2 -2
  118. data/lib/cybrid_api_bank_ruby/models/identity_verification_with_details_bank_model.rb +2 -2
  119. data/lib/cybrid_api_bank_ruby/models/identity_verification_with_details_pii_address_bank_model.rb +2 -2
  120. data/lib/cybrid_api_bank_ruby/models/identity_verification_with_details_pii_aliases_inner_bank_model.rb +2 -2
  121. data/lib/cybrid_api_bank_ruby/models/identity_verification_with_details_pii_bank_model.rb +2 -2
  122. data/lib/cybrid_api_bank_ruby/models/identity_verification_with_details_pii_name_bank_model.rb +2 -2
  123. data/lib/cybrid_api_bank_ruby/models/identity_verification_with_details_pii_registered_address_bank_model.rb +2 -2
  124. data/lib/cybrid_api_bank_ruby/models/intermediate_account_bank_model.rb +2 -2
  125. data/lib/cybrid_api_bank_ruby/models/invoice_bank_model.rb +2 -2
  126. data/lib/cybrid_api_bank_ruby/models/invoice_list_bank_model.rb +2 -2
  127. data/lib/cybrid_api_bank_ruby/models/legal_entity_name_bank_model.rb +2 -2
  128. data/lib/cybrid_api_bank_ruby/models/patch_account_bank_model.rb +2 -2
  129. data/lib/cybrid_api_bank_ruby/models/patch_bank_bank_model.rb +2 -2
  130. data/lib/cybrid_api_bank_ruby/models/patch_customer_bank_model.rb +2 -2
  131. data/lib/cybrid_api_bank_ruby/models/patch_deposit_address_bank_model.rb +2 -2
  132. data/lib/cybrid_api_bank_ruby/models/patch_deposit_bank_account_bank_model.rb +2 -2
  133. data/lib/cybrid_api_bank_ruby/models/patch_external_bank_account_bank_model.rb +2 -2
  134. data/lib/cybrid_api_bank_ruby/models/patch_external_wallet_bank_model.rb +2 -2
  135. data/lib/cybrid_api_bank_ruby/models/patch_transfer_bank_model.rb +2 -2
  136. data/lib/cybrid_api_bank_ruby/models/patch_transfer_participant_bank_model.rb +2 -2
  137. data/lib/cybrid_api_bank_ruby/models/payment_instruction_bank_model.rb +2 -2
  138. data/lib/cybrid_api_bank_ruby/models/payment_instruction_list_bank_model.rb +2 -2
  139. data/lib/cybrid_api_bank_ruby/models/payout_return_details_bank_model.rb +2 -2
  140. data/lib/cybrid_api_bank_ruby/models/persona_session_bank_model.rb +2 -2
  141. data/lib/cybrid_api_bank_ruby/models/physical_address_bank_model.rb +2 -2
  142. data/lib/cybrid_api_bank_ruby/models/plan_bank_model.rb +2 -2
  143. data/lib/cybrid_api_bank_ruby/models/plan_list_bank_model.rb +2 -2
  144. data/lib/cybrid_api_bank_ruby/models/plan_reference_bank_model.rb +2 -2
  145. data/lib/cybrid_api_bank_ruby/models/plan_travel_rule_info_bank_model.rb +2 -2
  146. data/lib/cybrid_api_bank_ruby/models/plan_type_bank_model.rb +2 -2
  147. data/lib/cybrid_api_bank_ruby/models/platform_file_bank_model.rb +2 -2
  148. data/lib/cybrid_api_bank_ruby/models/platform_file_list_bank_model.rb +2 -2
  149. data/lib/cybrid_api_bank_ruby/models/post_account_bank_model.rb +4 -4
  150. data/lib/cybrid_api_bank_ruby/models/post_bank_account_details_bank_model.rb +2 -2
  151. data/lib/cybrid_api_bank_ruby/models/post_bank_bank_model.rb +2 -2
  152. data/lib/cybrid_api_bank_ruby/models/post_counterparty_address_bank_model.rb +2 -2
  153. data/lib/cybrid_api_bank_ruby/models/post_counterparty_aliases_inner_bank_model.rb +2 -2
  154. data/lib/cybrid_api_bank_ruby/models/post_counterparty_bank_model.rb +2 -2
  155. data/lib/cybrid_api_bank_ruby/models/post_counterparty_name_bank_model.rb +2 -2
  156. data/lib/cybrid_api_bank_ruby/models/post_customer_address_bank_model.rb +2 -2
  157. data/lib/cybrid_api_bank_ruby/models/post_customer_aliases_inner_bank_model.rb +2 -2
  158. data/lib/cybrid_api_bank_ruby/models/post_customer_bank_model.rb +2 -2
  159. data/lib/cybrid_api_bank_ruby/models/post_customer_name_bank_model.rb +2 -2
  160. data/lib/cybrid_api_bank_ruby/models/post_deposit_address_bank_model.rb +2 -2
  161. data/lib/cybrid_api_bank_ruby/models/post_deposit_bank_account_bank_model.rb +2 -2
  162. data/lib/cybrid_api_bank_ruby/models/post_execution_bank_model.rb +2 -2
  163. data/lib/cybrid_api_bank_ruby/models/post_external_bank_account_bank_model.rb +2 -2
  164. data/lib/cybrid_api_bank_ruby/models/post_external_bank_account_counterparty_address_bank_model.rb +2 -2
  165. data/lib/cybrid_api_bank_ruby/models/post_external_bank_account_counterparty_name_bank_model.rb +2 -2
  166. data/lib/cybrid_api_bank_ruby/models/post_external_wallet_bank_model.rb +2 -2
  167. data/lib/cybrid_api_bank_ruby/models/post_fee_bank_model.rb +2 -2
  168. data/lib/cybrid_api_bank_ruby/models/post_file_bank_model.rb +2 -2
  169. data/lib/cybrid_api_bank_ruby/models/post_file_metadata_bank_model.rb +2 -2
  170. data/lib/cybrid_api_bank_ruby/models/post_identification_number_bank_model.rb +2 -2
  171. data/lib/cybrid_api_bank_ruby/models/post_identity_verification_address_bank_model.rb +2 -2
  172. data/lib/cybrid_api_bank_ruby/models/post_identity_verification_aliases_inner_bank_model.rb +2 -2
  173. data/lib/cybrid_api_bank_ruby/models/post_identity_verification_bank_model.rb +2 -2
  174. data/lib/cybrid_api_bank_ruby/models/post_identity_verification_name_bank_model.rb +2 -2
  175. data/lib/cybrid_api_bank_ruby/models/post_identity_verification_registered_address_bank_model.rb +2 -2
  176. data/lib/cybrid_api_bank_ruby/models/post_persona_session_bank_model.rb +2 -2
  177. data/lib/cybrid_api_bank_ruby/models/post_plan_bank_model.rb +2 -2
  178. data/lib/cybrid_api_bank_ruby/models/post_plan_destination_account_bank_model.rb +2 -2
  179. data/lib/cybrid_api_bank_ruby/models/post_plan_intermediate_accounts_inner_bank_model.rb +2 -2
  180. data/lib/cybrid_api_bank_ruby/models/post_plan_source_account_bank_model.rb +2 -2
  181. data/lib/cybrid_api_bank_ruby/models/post_plan_travel_rule_info_bank_model.rb +2 -2
  182. data/lib/cybrid_api_bank_ruby/models/post_quote_bank_model.rb +24 -50
  183. data/lib/cybrid_api_bank_ruby/models/post_quote_entry_bank_model.rb +2 -2
  184. data/lib/cybrid_api_bank_ruby/models/post_sardine_session_bank_model.rb +2 -2
  185. data/lib/cybrid_api_bank_ruby/models/post_supported_payout_symbols_bank_model.rb +2 -2
  186. data/lib/cybrid_api_bank_ruby/models/post_supporting_document_bank_model.rb +2 -2
  187. data/lib/cybrid_api_bank_ruby/models/post_trade_bank_model.rb +2 -2
  188. data/lib/cybrid_api_bank_ruby/models/post_transfer_bank_model.rb +9 -61
  189. data/lib/cybrid_api_bank_ruby/models/post_transfer_participant_bank_model.rb +2 -2
  190. data/lib/cybrid_api_bank_ruby/models/post_ultimate_beneficial_owner_bank_model.rb +2 -2
  191. data/lib/cybrid_api_bank_ruby/models/post_workflow_bank_model.rb +2 -2
  192. data/lib/cybrid_api_bank_ruby/models/quote_bank_model.rb +2 -2
  193. data/lib/cybrid_api_bank_ruby/models/quote_entry_bank_model.rb +2 -2
  194. data/lib/cybrid_api_bank_ruby/models/quote_entry_destination_account_bank_model.rb +2 -2
  195. data/lib/cybrid_api_bank_ruby/models/quote_entry_source_account_bank_model.rb +2 -2
  196. data/lib/cybrid_api_bank_ruby/models/quote_list_bank_model.rb +2 -2
  197. data/lib/cybrid_api_bank_ruby/models/quote_side_bank_model.rb +2 -2
  198. data/lib/cybrid_api_bank_ruby/models/quote_type_bank_model.rb +2 -2
  199. data/lib/cybrid_api_bank_ruby/models/return_details_bank_model.rb +2 -2
  200. data/lib/cybrid_api_bank_ruby/models/sardine_session_bank_model.rb +2 -2
  201. data/lib/cybrid_api_bank_ruby/models/stage_bank_model.rb +2 -2
  202. data/lib/cybrid_api_bank_ruby/models/stage_identifier_bank_model.rb +2 -2
  203. data/lib/cybrid_api_bank_ruby/models/stage_link_bank_model.rb +2 -2
  204. data/lib/cybrid_api_bank_ruby/models/supporting_document_bank_model.rb +2 -2
  205. data/lib/cybrid_api_bank_ruby/models/supporting_document_file_bank_model.rb +2 -2
  206. data/lib/cybrid_api_bank_ruby/models/symbol_price_bank_model.rb +2 -2
  207. data/lib/cybrid_api_bank_ruby/models/trade_bank_model.rb +2 -2
  208. data/lib/cybrid_api_bank_ruby/models/trade_failure_code_bank_model.rb +2 -2
  209. data/lib/cybrid_api_bank_ruby/models/trade_list_bank_model.rb +2 -2
  210. data/lib/cybrid_api_bank_ruby/models/trade_side_bank_model.rb +2 -2
  211. data/lib/cybrid_api_bank_ruby/models/trade_state_bank_model.rb +2 -2
  212. data/lib/cybrid_api_bank_ruby/models/trade_type_bank_model.rb +2 -2
  213. data/lib/cybrid_api_bank_ruby/models/transaction_bank_model.rb +2 -2
  214. data/lib/cybrid_api_bank_ruby/models/transaction_list_bank_model.rb +2 -2
  215. data/lib/cybrid_api_bank_ruby/models/transaction_list_page_info_bank_model.rb +2 -2
  216. data/lib/cybrid_api_bank_ruby/models/transaction_resource_bank_model.rb +2 -2
  217. data/lib/cybrid_api_bank_ruby/models/transfer_account_type_bank_model.rb +2 -2
  218. data/lib/cybrid_api_bank_ruby/models/transfer_bank_model.rb +2 -2
  219. data/lib/cybrid_api_bank_ruby/models/transfer_destination_account_bank_model.rb +2 -2
  220. data/lib/cybrid_api_bank_ruby/models/transfer_entry_bank_model.rb +2 -2
  221. data/lib/cybrid_api_bank_ruby/models/transfer_entry_destination_account_bank_model.rb +2 -2
  222. data/lib/cybrid_api_bank_ruby/models/transfer_failure_code_bank_model.rb +2 -2
  223. data/lib/cybrid_api_bank_ruby/models/transfer_hold_details_bank_model.rb +2 -2
  224. data/lib/cybrid_api_bank_ruby/models/transfer_identifiers_inner_bank_model.rb +2 -2
  225. data/lib/cybrid_api_bank_ruby/models/transfer_list_bank_model.rb +2 -2
  226. data/lib/cybrid_api_bank_ruby/models/transfer_participant_bank_model.rb +2 -2
  227. data/lib/cybrid_api_bank_ruby/models/transfer_side_bank_model.rb +2 -2
  228. data/lib/cybrid_api_bank_ruby/models/transfer_source_account_bank_model.rb +2 -2
  229. data/lib/cybrid_api_bank_ruby/models/transfer_state_bank_model.rb +2 -2
  230. data/lib/cybrid_api_bank_ruby/models/transfer_type_bank_model.rb +2 -2
  231. data/lib/cybrid_api_bank_ruby/models/travel_rule_info_party_bank_model.rb +2 -2
  232. data/lib/cybrid_api_bank_ruby/models/workflow_bank_model.rb +2 -2
  233. data/lib/cybrid_api_bank_ruby/models/workflow_state_bank_model.rb +2 -2
  234. data/lib/cybrid_api_bank_ruby/models/workflow_type_bank_model.rb +2 -2
  235. data/lib/cybrid_api_bank_ruby/models/workflow_with_details_bank_model.rb +2 -2
  236. data/lib/cybrid_api_bank_ruby/models/workflows_list_bank_model.rb +2 -2
  237. data/lib/cybrid_api_bank_ruby/version.rb +3 -3
  238. data/lib/cybrid_api_bank_ruby.rb +2 -4
  239. data/spec/api/accounts_bank_api_spec.rb +3 -3
  240. data/spec/api/assets_bank_api_spec.rb +2 -2
  241. data/spec/api/banks_bank_api_spec.rb +2 -2
  242. data/spec/api/counterparties_bank_api_spec.rb +2 -2
  243. data/spec/api/customers_bank_api_spec.rb +2 -2
  244. data/spec/api/deposit_addresses_bank_api_spec.rb +2 -2
  245. data/spec/api/deposit_bank_accounts_bank_api_spec.rb +2 -2
  246. data/spec/api/executions_bank_api_spec.rb +2 -2
  247. data/spec/api/external_bank_accounts_bank_api_spec.rb +2 -2
  248. data/spec/api/external_wallets_bank_api_spec.rb +2 -2
  249. data/spec/api/files_bank_api_spec.rb +2 -2
  250. data/spec/api/identity_verifications_bank_api_spec.rb +2 -2
  251. data/spec/api/invoices_bank_api_spec.rb +2 -26
  252. data/spec/api/payment_instructions_bank_api_spec.rb +2 -14
  253. data/spec/api/persona_sessions_bank_api_spec.rb +2 -2
  254. data/spec/api/plans_bank_api_spec.rb +2 -2
  255. data/spec/api/prices_bank_api_spec.rb +2 -2
  256. data/spec/api/quotes_bank_api_spec.rb +2 -2
  257. data/spec/api/sardine_sessions_bank_api_spec.rb +2 -2
  258. data/spec/api/symbols_bank_api_spec.rb +2 -2
  259. data/spec/api/trades_bank_api_spec.rb +2 -2
  260. data/spec/api/transactions_bank_api_spec.rb +2 -2
  261. data/spec/api/transfers_bank_api_spec.rb +2 -2
  262. data/spec/api/workflows_bank_api_spec.rb +2 -2
  263. data/spec/models/account_association_bank_model_spec.rb +2 -2
  264. data/spec/models/account_bank_model_spec.rb +2 -2
  265. data/spec/models/account_list_bank_model_spec.rb +2 -2
  266. data/spec/models/account_state_bank_model_spec.rb +2 -2
  267. data/spec/models/account_type_bank_model_spec.rb +2 -2
  268. data/spec/models/activity_limit_bank_model_spec.rb +2 -2
  269. data/spec/models/activity_side_bank_model_spec.rb +2 -2
  270. data/spec/models/activity_type_bank_model_spec.rb +2 -2
  271. data/spec/models/asset_bank_model_spec.rb +2 -2
  272. data/spec/models/asset_list_bank_model_spec.rb +2 -2
  273. data/spec/models/asset_types_bank_model_spec.rb +2 -2
  274. data/spec/models/balance_bank_model_spec.rb +2 -2
  275. data/spec/models/bank_bank_model_spec.rb +2 -2
  276. data/spec/models/bank_feature_bank_model_spec.rb +2 -2
  277. data/spec/models/bank_list_bank_model_spec.rb +2 -2
  278. data/spec/models/bank_supported_payout_symbols_inner_bank_model_spec.rb +2 -2
  279. data/spec/models/bank_type_bank_model_spec.rb +2 -2
  280. data/spec/models/compliance_check_bank_model_spec.rb +2 -2
  281. data/spec/models/compliance_check_outcome_bank_model_spec.rb +2 -2
  282. data/spec/models/compliance_check_type_bank_model_spec.rb +2 -2
  283. data/spec/models/compliance_decision_bank_model_spec.rb +2 -2
  284. data/spec/models/compliance_decision_state_bank_model_spec.rb +2 -2
  285. data/spec/models/compliance_decision_type_bank_model_spec.rb +2 -2
  286. data/spec/models/counterparty_address_bank_model_spec.rb +2 -2
  287. data/spec/models/counterparty_aliases_inner_bank_model_spec.rb +2 -2
  288. data/spec/models/counterparty_bank_model_spec.rb +2 -2
  289. data/spec/models/counterparty_list_bank_model_spec.rb +2 -2
  290. data/spec/models/counterparty_name_bank_model_spec.rb +2 -2
  291. data/spec/models/counterparty_state_bank_model_spec.rb +2 -2
  292. data/spec/models/counterparty_type_bank_model_spec.rb +2 -2
  293. data/spec/models/customer_address_bank_model_spec.rb +2 -2
  294. data/spec/models/customer_aliases_inner_bank_model_spec.rb +2 -2
  295. data/spec/models/customer_bank_model_spec.rb +2 -2
  296. data/spec/models/customer_list_bank_model_spec.rb +2 -2
  297. data/spec/models/customer_name_bank_model_spec.rb +2 -2
  298. data/spec/models/customer_state_bank_model_spec.rb +2 -2
  299. data/spec/models/customer_type_bank_model_spec.rb +2 -2
  300. data/spec/models/deposit_address_bank_model_spec.rb +2 -2
  301. data/spec/models/deposit_address_format_bank_model_spec.rb +2 -2
  302. data/spec/models/deposit_address_list_bank_model_spec.rb +2 -2
  303. data/spec/models/deposit_address_state_bank_model_spec.rb +2 -2
  304. data/spec/models/deposit_bank_account_account_details_inner_bank_model_spec.rb +2 -2
  305. data/spec/models/deposit_bank_account_bank_model_spec.rb +2 -2
  306. data/spec/models/deposit_bank_account_counterparty_address_bank_model_spec.rb +2 -2
  307. data/spec/models/deposit_bank_account_list_bank_model_spec.rb +2 -2
  308. data/spec/models/deposit_bank_account_routing_details_inner_bank_model_spec.rb +2 -2
  309. data/spec/models/deposit_bank_account_routing_number_type_bank_model_spec.rb +2 -2
  310. data/spec/models/deposit_bank_account_state_bank_model_spec.rb +2 -2
  311. data/spec/models/effective_rate_bank_model_spec.rb +2 -2
  312. data/spec/models/error_response_bank_model_spec.rb +2 -2
  313. data/spec/models/execution_bank_model_spec.rb +2 -2
  314. data/spec/models/execution_list_bank_model_spec.rb +2 -2
  315. data/spec/models/execution_travel_rule_info_bank_model_spec.rb +2 -2
  316. data/spec/models/external_bank_account_balances_bank_model_spec.rb +2 -2
  317. data/spec/models/external_bank_account_bank_model_spec.rb +2 -2
  318. data/spec/models/external_bank_account_kind_bank_model_spec.rb +2 -2
  319. data/spec/models/external_bank_account_list_bank_model_spec.rb +2 -2
  320. data/spec/models/external_bank_account_pii_inner_addresses_inner_bank_model_spec.rb +2 -2
  321. data/spec/models/external_bank_account_pii_inner_bank_model_spec.rb +2 -2
  322. data/spec/models/external_bank_account_pii_inner_routing_details_inner_bank_model_spec.rb +2 -2
  323. data/spec/models/external_bank_account_state_bank_model_spec.rb +2 -2
  324. data/spec/models/external_wallet_bank_model_spec.rb +2 -2
  325. data/spec/models/external_wallet_environment_bank_model_spec.rb +2 -2
  326. data/spec/models/external_wallet_list_bank_model_spec.rb +2 -2
  327. data/spec/models/external_wallet_state_bank_model_spec.rb +2 -2
  328. data/spec/models/fee_association_bank_model_spec.rb +2 -2
  329. data/spec/models/fee_detail_bank_model_spec.rb +2 -2
  330. data/spec/models/hold_detail_bank_model_spec.rb +2 -2
  331. data/spec/models/identification_number_bank_model_spec.rb +2 -2
  332. data/spec/models/identity_verification_bank_model_spec.rb +2 -2
  333. data/spec/models/identity_verification_business_associate_bank_model_spec.rb +2 -2
  334. data/spec/models/identity_verification_document_bank_model_spec.rb +2 -2
  335. data/spec/models/identity_verification_document_file_bank_model_spec.rb +2 -2
  336. data/spec/models/identity_verification_document_file_metadata_bank_model_spec.rb +2 -2
  337. data/spec/models/identity_verification_list_bank_model_spec.rb +2 -2
  338. data/spec/models/identity_verification_method_bank_model_spec.rb +2 -2
  339. data/spec/models/identity_verification_options_bank_model_spec.rb +2 -2
  340. data/spec/models/identity_verification_outcome_bank_model_spec.rb +2 -2
  341. data/spec/models/identity_verification_persona_state_bank_model_spec.rb +2 -2
  342. data/spec/models/identity_verification_state_bank_model_spec.rb +2 -2
  343. data/spec/models/identity_verification_type_bank_model_spec.rb +2 -2
  344. data/spec/models/identity_verification_with_details_bank_model_spec.rb +2 -2
  345. data/spec/models/identity_verification_with_details_pii_address_bank_model_spec.rb +2 -2
  346. data/spec/models/identity_verification_with_details_pii_aliases_inner_bank_model_spec.rb +2 -2
  347. data/spec/models/identity_verification_with_details_pii_bank_model_spec.rb +2 -2
  348. data/spec/models/identity_verification_with_details_pii_name_bank_model_spec.rb +2 -2
  349. data/spec/models/identity_verification_with_details_pii_registered_address_bank_model_spec.rb +2 -2
  350. data/spec/models/intermediate_account_bank_model_spec.rb +2 -2
  351. data/spec/models/invoice_bank_model_spec.rb +2 -2
  352. data/spec/models/invoice_list_bank_model_spec.rb +2 -2
  353. data/spec/models/legal_entity_name_bank_model_spec.rb +2 -2
  354. data/spec/models/patch_account_bank_model_spec.rb +2 -2
  355. data/spec/models/patch_bank_bank_model_spec.rb +2 -2
  356. data/spec/models/patch_customer_bank_model_spec.rb +2 -2
  357. data/spec/models/patch_deposit_address_bank_model_spec.rb +2 -2
  358. data/spec/models/patch_deposit_bank_account_bank_model_spec.rb +2 -2
  359. data/spec/models/patch_external_bank_account_bank_model_spec.rb +2 -2
  360. data/spec/models/patch_external_wallet_bank_model_spec.rb +2 -2
  361. data/spec/models/patch_transfer_bank_model_spec.rb +2 -2
  362. data/spec/models/patch_transfer_participant_bank_model_spec.rb +2 -2
  363. data/spec/models/payment_instruction_bank_model_spec.rb +2 -2
  364. data/spec/models/payment_instruction_list_bank_model_spec.rb +2 -2
  365. data/spec/models/payout_return_details_bank_model_spec.rb +2 -2
  366. data/spec/models/persona_session_bank_model_spec.rb +2 -2
  367. data/spec/models/physical_address_bank_model_spec.rb +2 -2
  368. data/spec/models/plan_bank_model_spec.rb +2 -2
  369. data/spec/models/plan_list_bank_model_spec.rb +2 -2
  370. data/spec/models/plan_reference_bank_model_spec.rb +2 -2
  371. data/spec/models/plan_travel_rule_info_bank_model_spec.rb +2 -2
  372. data/spec/models/plan_type_bank_model_spec.rb +2 -2
  373. data/spec/models/platform_file_bank_model_spec.rb +2 -2
  374. data/spec/models/platform_file_list_bank_model_spec.rb +2 -2
  375. data/spec/models/post_account_bank_model_spec.rb +3 -3
  376. data/spec/models/post_bank_account_details_bank_model_spec.rb +2 -2
  377. data/spec/models/post_bank_bank_model_spec.rb +2 -2
  378. data/spec/models/post_counterparty_address_bank_model_spec.rb +2 -2
  379. data/spec/models/post_counterparty_aliases_inner_bank_model_spec.rb +2 -2
  380. data/spec/models/post_counterparty_bank_model_spec.rb +2 -2
  381. data/spec/models/post_counterparty_name_bank_model_spec.rb +2 -2
  382. data/spec/models/post_customer_address_bank_model_spec.rb +2 -2
  383. data/spec/models/post_customer_aliases_inner_bank_model_spec.rb +2 -2
  384. data/spec/models/post_customer_bank_model_spec.rb +2 -2
  385. data/spec/models/post_customer_name_bank_model_spec.rb +2 -2
  386. data/spec/models/post_deposit_address_bank_model_spec.rb +2 -2
  387. data/spec/models/post_deposit_bank_account_bank_model_spec.rb +2 -2
  388. data/spec/models/post_execution_bank_model_spec.rb +2 -2
  389. data/spec/models/post_external_bank_account_bank_model_spec.rb +2 -2
  390. data/spec/models/post_external_bank_account_counterparty_address_bank_model_spec.rb +2 -2
  391. data/spec/models/post_external_bank_account_counterparty_name_bank_model_spec.rb +2 -2
  392. data/spec/models/post_external_wallet_bank_model_spec.rb +2 -2
  393. data/spec/models/post_fee_bank_model_spec.rb +2 -2
  394. data/spec/models/post_file_bank_model_spec.rb +2 -2
  395. data/spec/models/post_file_metadata_bank_model_spec.rb +2 -2
  396. data/spec/models/post_identification_number_bank_model_spec.rb +2 -2
  397. data/spec/models/post_identity_verification_address_bank_model_spec.rb +2 -2
  398. data/spec/models/post_identity_verification_aliases_inner_bank_model_spec.rb +2 -2
  399. data/spec/models/post_identity_verification_bank_model_spec.rb +2 -2
  400. data/spec/models/post_identity_verification_name_bank_model_spec.rb +2 -2
  401. data/spec/models/post_identity_verification_registered_address_bank_model_spec.rb +2 -2
  402. data/spec/models/post_persona_session_bank_model_spec.rb +2 -2
  403. data/spec/models/post_plan_bank_model_spec.rb +2 -2
  404. data/spec/models/post_plan_destination_account_bank_model_spec.rb +2 -2
  405. data/spec/models/post_plan_intermediate_accounts_inner_bank_model_spec.rb +2 -2
  406. data/spec/models/post_plan_source_account_bank_model_spec.rb +2 -2
  407. data/spec/models/post_plan_travel_rule_info_bank_model_spec.rb +2 -2
  408. data/spec/models/post_quote_bank_model_spec.rb +8 -14
  409. data/spec/models/post_quote_entry_bank_model_spec.rb +2 -2
  410. data/spec/models/post_sardine_session_bank_model_spec.rb +2 -2
  411. data/spec/models/post_supported_payout_symbols_bank_model_spec.rb +2 -2
  412. data/spec/models/post_supporting_document_bank_model_spec.rb +2 -2
  413. data/spec/models/post_trade_bank_model_spec.rb +2 -2
  414. data/spec/models/post_transfer_bank_model_spec.rb +3 -15
  415. data/spec/models/post_transfer_participant_bank_model_spec.rb +2 -2
  416. data/spec/models/post_ultimate_beneficial_owner_bank_model_spec.rb +2 -2
  417. data/spec/models/post_workflow_bank_model_spec.rb +2 -2
  418. data/spec/models/quote_bank_model_spec.rb +2 -2
  419. data/spec/models/quote_entry_bank_model_spec.rb +2 -2
  420. data/spec/models/quote_entry_destination_account_bank_model_spec.rb +2 -2
  421. data/spec/models/quote_entry_source_account_bank_model_spec.rb +2 -2
  422. data/spec/models/quote_list_bank_model_spec.rb +2 -2
  423. data/spec/models/quote_side_bank_model_spec.rb +2 -2
  424. data/spec/models/quote_type_bank_model_spec.rb +2 -2
  425. data/spec/models/return_details_bank_model_spec.rb +2 -2
  426. data/spec/models/sardine_session_bank_model_spec.rb +2 -2
  427. data/spec/models/stage_bank_model_spec.rb +2 -2
  428. data/spec/models/stage_identifier_bank_model_spec.rb +2 -2
  429. data/spec/models/stage_link_bank_model_spec.rb +2 -2
  430. data/spec/models/supporting_document_bank_model_spec.rb +2 -2
  431. data/spec/models/supporting_document_file_bank_model_spec.rb +2 -2
  432. data/spec/models/symbol_price_bank_model_spec.rb +2 -2
  433. data/spec/models/trade_bank_model_spec.rb +2 -2
  434. data/spec/models/trade_failure_code_bank_model_spec.rb +2 -2
  435. data/spec/models/trade_list_bank_model_spec.rb +2 -2
  436. data/spec/models/trade_side_bank_model_spec.rb +2 -2
  437. data/spec/models/trade_state_bank_model_spec.rb +2 -2
  438. data/spec/models/trade_type_bank_model_spec.rb +2 -2
  439. data/spec/models/transaction_bank_model_spec.rb +2 -2
  440. data/spec/models/transaction_list_bank_model_spec.rb +2 -2
  441. data/spec/models/transaction_list_page_info_bank_model_spec.rb +2 -2
  442. data/spec/models/transaction_resource_bank_model_spec.rb +2 -2
  443. data/spec/models/transfer_account_type_bank_model_spec.rb +2 -2
  444. data/spec/models/transfer_bank_model_spec.rb +2 -2
  445. data/spec/models/transfer_destination_account_bank_model_spec.rb +2 -2
  446. data/spec/models/transfer_entry_bank_model_spec.rb +2 -2
  447. data/spec/models/transfer_entry_destination_account_bank_model_spec.rb +2 -2
  448. data/spec/models/transfer_failure_code_bank_model_spec.rb +2 -2
  449. data/spec/models/transfer_hold_details_bank_model_spec.rb +2 -2
  450. data/spec/models/transfer_identifiers_inner_bank_model_spec.rb +2 -2
  451. data/spec/models/transfer_list_bank_model_spec.rb +2 -2
  452. data/spec/models/transfer_participant_bank_model_spec.rb +2 -2
  453. data/spec/models/transfer_side_bank_model_spec.rb +2 -2
  454. data/spec/models/transfer_source_account_bank_model_spec.rb +2 -2
  455. data/spec/models/transfer_state_bank_model_spec.rb +2 -2
  456. data/spec/models/transfer_type_bank_model_spec.rb +2 -2
  457. data/spec/models/travel_rule_info_party_bank_model_spec.rb +2 -2
  458. data/spec/models/workflow_bank_model_spec.rb +2 -2
  459. data/spec/models/workflow_state_bank_model_spec.rb +2 -2
  460. data/spec/models/workflow_type_bank_model_spec.rb +2 -2
  461. data/spec/models/workflow_with_details_bank_model_spec.rb +2 -2
  462. data/spec/models/workflows_list_bank_model_spec.rb +2 -2
  463. data/spec/spec_helper.rb +2 -2
  464. data/vendor/bundle/ruby/4.0.0/extensions/x86_64-linux/4.0.0/byebug-13.0.0/gem_make.out +5 -5
  465. data/vendor/bundle/ruby/4.0.0/extensions/x86_64-linux/4.0.0/date-3.5.1/gem_make.out +5 -5
  466. data/vendor/bundle/ruby/4.0.0/extensions/x86_64-linux/4.0.0/io-console-0.9.4/gem_make.out +5 -5
  467. data/vendor/bundle/ruby/4.0.0/extensions/x86_64-linux/4.0.0/jaro_winkler-1.5.6/gem_make.out +5 -5
  468. data/vendor/bundle/ruby/4.0.0/extensions/x86_64-linux/4.0.0/psych-5.5.0/gem_make.out +5 -5
  469. data/vendor/bundle/ruby/4.0.0/extensions/x86_64-linux/4.0.0/racc-1.8.1/gem_make.out +5 -5
  470. data/vendor/bundle/ruby/4.0.0/extensions/x86_64-linux/4.0.0/stringio-3.2.0/gem_make.out +5 -5
  471. metadata +1 -9
  472. data/docs/PostInvoiceBankModel.md +0 -28
  473. data/docs/PostPaymentInstructionBankModel.md +0 -20
  474. data/lib/cybrid_api_bank_ruby/models/post_invoice_bank_model.rb +0 -369
  475. data/lib/cybrid_api_bank_ruby/models/post_payment_instruction_bank_model.rb +0 -287
  476. data/spec/models/post_invoice_bank_model_spec.rb +0 -66
  477. data/spec/models/post_payment_instruction_bank_model_spec.rb +0 -46
@@ -1,287 +0,0 @@
1
- =begin
2
- #Cybrid Bank API
3
-
4
- ## Cybrid API documentation Welcome to Cybrid, an all-in-one crypto platform that enables you to easily **build** and **launch** white-label crypto products or services. In these documents, you'll find details on how our REST API operates and generally how our platform functions. If you're looking for our UI SDK Widgets for Web or Mobile (iOS/Android), generated API clients, or demo applications, head over to our [Github repo](https://github.com/Cybrid-app). 💡 We recommend bookmarking the [Cybrid LinkTree](https://linktr.ee/cybridtechnologies) which contains many helpful links to platform resources. ## Getting Started This is Cybrid's public interactive API documentation, which allows you to fully test our APIs. If you'd like to use a different tool to exercise our APIs, you can download the [Open API 3.0 yaml](https://bank.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 Overview](https://docs.cybrid.xyz/docs/platform-overview) 3. [Testing with Hosted Web Demo App](https://docs.cybrid.xyz/docs/hosted-demo-app) In [Getting Started in the Cybrid Sandbox](https://docs.cybrid.xyz/docs/cybrid-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://docs.cybrid.xyz/docs/trade-process), 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:read accounts:read accounts:write accounts:execute counterparties:read counterparties:pii:read counterparties:write counterparties:execute customers:read customers:pii:read customers:write customers:execute prices:read quotes:execute quotes:read trades:execute trades:read transactions:read transfers:execute transfers:read transfers:write external_bank_accounts:read external_bank_accounts:pii:read transfers:pii:read external_bank_accounts:write external_bank_accounts:execute external_wallets:read external_wallets:write external_wallets:execute workflows:read workflows:execute deposit_addresses:read deposit_addresses:write deposit_addresses:execute deposit_bank_accounts:read deposit_bank_accounts:write deposit_bank_accounts:execute invoices:read invoices:write invoices:execute identity_verifications:read identity_verifications:pii:read identity_verifications:write identity_verifications:execute persona_sessions:execute sardine_sessions:execute plans:execute plans:read executions:execute executions:read files:read files:pii:read files:execute\" }' -H \"Content-Type: application/json\" # When using Organization credentials set `scope` to 'organizations:read organizations:write organization_applications:read banks:read banks:write banks:execute bank_applications:read users:read counterparties:read counterparties:pii:read customers:read customers:pii:read accounts:read accounts:write prices:read quotes:execute quotes:read trades:execute trades:read transactions:read transfers:read transfers:write transfers:execute external_bank_accounts:read external_bank_accounts:pii:read transfers:pii:read external_bank_accounts:write external_wallets:read external_wallets:write workflows:read deposit_addresses:read deposit_addresses:write deposit_bank_accounts:read deposit_bank_accounts:write deposit_bank_accounts:execute invoices:read subscriptions:read subscriptions:write subscriptions:execute subscription_events:read subscription_events:execute identity_verifications:read identity_verifications:pii:read identity_verifications:execute persona_sessions:execute sardine_sessions:execute plans:execute plans:read executions:execute executions:read files:read files:pii: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) | | Bank Application | bank_applications:read (Organization, Bank) | | | | 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 Application | organization_applications:read (Organization) | | | | Organization | organizations:read (Organization) | organizations:write (Organization) | | | User | users:read (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) | API keys and organization users are created, updated and deleted only in the Partner Portal. Tokens issued for an organization API key can list and get organization applications, bank applications and users, and tokens issued for a bank API key can list and get bank applications; neither can create, update or delete them. Requesting the `organization_applications:write`, `organization_applications:execute`, `bank_applications:write`, `bank_applications:execute`, `users:write` or `users:execute` scopes alongside other scopes is tolerated: they are dropped and the token is issued with the rest. ## 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 | Get and list bank API keys | | Identity | CustomerToken | /api/customer_tokens | Create customer JWT access tokens | | Identity | Organization | /api/organization_applications | Get and list organization API keys | | Identity | Organization | /api/users | Get 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.129.1239
7
- Contact: support@cybrid.app
8
- Generated by: https://openapi-generator.tech
9
- Generator version: 7.8.0
10
-
11
- =end
12
-
13
- require 'date'
14
- require 'time'
15
-
16
- module CybridApiBank
17
- # Request body for payment instruction creation.
18
- class PostPaymentInstructionBankModel
19
- # The invoice guid.
20
- attr_accessor :invoice_guid
21
-
22
- # The optional expected behaviour to simulate.
23
- attr_accessor :expected_behaviour
24
-
25
- class EnumAttributeValidator
26
- attr_reader :datatype
27
- attr_reader :allowable_values
28
-
29
- def initialize(datatype, allowable_values)
30
- @allowable_values = allowable_values.map do |value|
31
- case datatype.to_s
32
- when /Integer/i
33
- value.to_i
34
- when /Float/i
35
- value.to_f
36
- else
37
- value
38
- end
39
- end
40
- end
41
-
42
- def valid?(value)
43
- !value || allowable_values.include?(value)
44
- end
45
- end
46
-
47
- # Attribute mapping from ruby-style variable name to JSON key.
48
- def self.attribute_map
49
- {
50
- :'invoice_guid' => :'invoice_guid',
51
- :'expected_behaviour' => :'expected_behaviour'
52
- }
53
- end
54
-
55
- # Returns all the JSON keys this model knows about
56
- def self.acceptable_attributes
57
- attribute_map.values
58
- end
59
-
60
- # Attribute type mapping.
61
- def self.openapi_types
62
- {
63
- :'invoice_guid' => :'String',
64
- :'expected_behaviour' => :'String'
65
- }
66
- end
67
-
68
- # List of attributes with nullable: true
69
- def self.openapi_nullable
70
- Set.new([
71
- :'expected_behaviour'
72
- ])
73
- end
74
-
75
- # Initializes the object
76
- # @param [Hash] attributes Model attributes in the form of hash
77
- def initialize(attributes = {})
78
- if (!attributes.is_a?(Hash))
79
- fail ArgumentError, "The input argument (attributes) must be a hash in `CybridApiBank::PostPaymentInstructionBankModel` initialize method"
80
- end
81
-
82
- # check to see if the attribute exists and convert string to symbol for hash key
83
- attributes = attributes.each_with_object({}) { |(k, v), h|
84
- if (!self.class.attribute_map.key?(k.to_sym))
85
- fail ArgumentError, "`#{k}` is not a valid attribute in `CybridApiBank::PostPaymentInstructionBankModel`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
86
- end
87
- h[k.to_sym] = v
88
- }
89
-
90
- if attributes.key?(:'invoice_guid')
91
- self.invoice_guid = attributes[:'invoice_guid']
92
- else
93
- self.invoice_guid = nil
94
- end
95
-
96
- if attributes.key?(:'expected_behaviour')
97
- self.expected_behaviour = attributes[:'expected_behaviour']
98
- end
99
- end
100
-
101
- # Show invalid properties with the reasons. Usually used together with valid?
102
- # @return Array for valid properties with the reasons
103
- def list_invalid_properties
104
- warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
105
- invalid_properties = Array.new
106
- if @invoice_guid.nil?
107
- invalid_properties.push('invalid value for "invoice_guid", invoice_guid cannot be nil.')
108
- end
109
-
110
- if @invoice_guid.to_s.length > 32
111
- invalid_properties.push('invalid value for "invoice_guid", the character length must be smaller than or equal to 32.')
112
- end
113
-
114
- invalid_properties
115
- end
116
-
117
- # Check to see if the all the properties in the model are valid
118
- # @return true if the model is valid
119
- def valid?
120
- warn '[DEPRECATED] the `valid?` method is obsolete'
121
- return false if @invoice_guid.nil?
122
- return false if @invoice_guid.to_s.length > 32
123
- expected_behaviour_validator = EnumAttributeValidator.new('String', ["invoice_paid_immediately"])
124
- return false unless expected_behaviour_validator.valid?(@expected_behaviour)
125
- true
126
- end
127
-
128
- # Custom attribute writer method with validation
129
- # @param [Object] invoice_guid Value to be assigned
130
- def invoice_guid=(invoice_guid)
131
- if invoice_guid.nil?
132
- fail ArgumentError, 'invoice_guid cannot be nil'
133
- end
134
-
135
- if invoice_guid.to_s.length > 32
136
- fail ArgumentError, 'invalid value for "invoice_guid", the character length must be smaller than or equal to 32.'
137
- end
138
-
139
- @invoice_guid = invoice_guid
140
- end
141
-
142
- # Custom attribute writer method checking allowed values (enum).
143
- # @param [Object] expected_behaviour Object to be assigned
144
- def expected_behaviour=(expected_behaviour)
145
- validator = EnumAttributeValidator.new('String', ["invoice_paid_immediately"])
146
- unless validator.valid?(expected_behaviour)
147
- fail ArgumentError, "invalid value for \"expected_behaviour\", must be one of #{validator.allowable_values}."
148
- end
149
- @expected_behaviour = expected_behaviour
150
- end
151
-
152
- # Checks equality by comparing each attribute.
153
- # @param [Object] Object to be compared
154
- def ==(o)
155
- return true if self.equal?(o)
156
- self.class == o.class &&
157
- invoice_guid == o.invoice_guid &&
158
- expected_behaviour == o.expected_behaviour
159
- end
160
-
161
- # @see the `==` method
162
- # @param [Object] Object to be compared
163
- def eql?(o)
164
- self == o
165
- end
166
-
167
- # Calculates hash code according to all attributes.
168
- # @return [Integer] Hash code
169
- def hash
170
- [invoice_guid, expected_behaviour].hash
171
- end
172
-
173
- # Builds the object from hash
174
- # @param [Hash] attributes Model attributes in the form of hash
175
- # @return [Object] Returns the model itself
176
- def self.build_from_hash(attributes)
177
- return nil unless attributes.is_a?(Hash)
178
- attributes = attributes.transform_keys(&:to_sym)
179
- transformed_hash = {}
180
- openapi_types.each_pair do |key, type|
181
- if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
182
- transformed_hash["#{key}"] = nil
183
- elsif type =~ /\AArray<(.*)>/i
184
- # check to ensure the input is an array given that the attribute
185
- # is documented as an array but the input is not
186
- if attributes[attribute_map[key]].is_a?(Array)
187
- transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
188
- end
189
- elsif !attributes[attribute_map[key]].nil?
190
- transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
191
- end
192
- end
193
- new(transformed_hash)
194
- end
195
-
196
- # Deserializes the data based on type
197
- # @param string type Data type
198
- # @param string value Value to be deserialized
199
- # @return [Object] Deserialized data
200
- def self._deserialize(type, value)
201
- case type.to_sym
202
- when :Time
203
- Time.parse(value)
204
- when :Date
205
- Date.parse(value)
206
- when :String
207
- value.to_s
208
- when :Integer
209
- value.to_i
210
- when :Float
211
- value.to_f
212
- when :Boolean
213
- if value.to_s =~ /\A(true|t|yes|y|1)\z/i
214
- true
215
- else
216
- false
217
- end
218
- when :Object
219
- # generic object (usually a Hash), return directly
220
- value
221
- when /\AArray<(?<inner_type>.+)>\z/
222
- inner_type = Regexp.last_match[:inner_type]
223
- value.map { |v| _deserialize(inner_type, v) }
224
- when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
225
- k_type = Regexp.last_match[:k_type]
226
- v_type = Regexp.last_match[:v_type]
227
- {}.tap do |hash|
228
- value.each do |k, v|
229
- hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
230
- end
231
- end
232
- else # model
233
- # models (e.g. Pet) or oneOf
234
- klass = CybridApiBank.const_get(type)
235
- klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
236
- end
237
- end
238
-
239
- # Returns the string representation of the object
240
- # @return [String] String presentation of the object
241
- def to_s
242
- to_hash.to_s
243
- end
244
-
245
- # to_body is an alias to to_hash (backward compatibility)
246
- # @return [Hash] Returns the object in the form of hash
247
- def to_body
248
- to_hash
249
- end
250
-
251
- # Returns the object in the form of hash
252
- # @return [Hash] Returns the object in the form of hash
253
- def to_hash
254
- hash = {}
255
- self.class.attribute_map.each_pair do |attr, param|
256
- value = self.send(attr)
257
- if value.nil?
258
- is_nullable = self.class.openapi_nullable.include?(attr)
259
- next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
260
- end
261
-
262
- hash[param] = _to_hash(value)
263
- end
264
- hash
265
- end
266
-
267
- # Outputs non-array value in the form of hash
268
- # For object, use to_hash. Otherwise, just return the value
269
- # @param [Object] value Any valid value
270
- # @return [Hash] Returns the value in the form of hash
271
- def _to_hash(value)
272
- if value.is_a?(Array)
273
- value.compact.map { |v| _to_hash(v) }
274
- elsif value.is_a?(Hash)
275
- {}.tap do |hash|
276
- value.each { |k, v| hash[k] = _to_hash(v) }
277
- end
278
- elsif value.respond_to? :to_hash
279
- value.to_hash
280
- else
281
- value
282
- end
283
- end
284
-
285
- end
286
-
287
- end
@@ -1,66 +0,0 @@
1
- =begin
2
- #Cybrid Bank API
3
-
4
- ## Cybrid API documentation Welcome to Cybrid, an all-in-one crypto platform that enables you to easily **build** and **launch** white-label crypto products or services. In these documents, you'll find details on how our REST API operates and generally how our platform functions. If you're looking for our UI SDK Widgets for Web or Mobile (iOS/Android), generated API clients, or demo applications, head over to our [Github repo](https://github.com/Cybrid-app). 💡 We recommend bookmarking the [Cybrid LinkTree](https://linktr.ee/cybridtechnologies) which contains many helpful links to platform resources. ## Getting Started This is Cybrid's public interactive API documentation, which allows you to fully test our APIs. If you'd like to use a different tool to exercise our APIs, you can download the [Open API 3.0 yaml](https://bank.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 Overview](https://docs.cybrid.xyz/docs/platform-overview) 3. [Testing with Hosted Web Demo App](https://docs.cybrid.xyz/docs/hosted-demo-app) In [Getting Started in the Cybrid Sandbox](https://docs.cybrid.xyz/docs/cybrid-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://docs.cybrid.xyz/docs/trade-process), 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:read accounts:read accounts:write accounts:execute counterparties:read counterparties:pii:read counterparties:write counterparties:execute customers:read customers:pii:read customers:write customers:execute prices:read quotes:execute quotes:read trades:execute trades:read transactions:read transfers:execute transfers:read transfers:write external_bank_accounts:read external_bank_accounts:pii:read transfers:pii:read external_bank_accounts:write external_bank_accounts:execute external_wallets:read external_wallets:write external_wallets:execute workflows:read workflows:execute deposit_addresses:read deposit_addresses:write deposit_addresses:execute deposit_bank_accounts:read deposit_bank_accounts:write deposit_bank_accounts:execute invoices:read invoices:write invoices:execute identity_verifications:read identity_verifications:pii:read identity_verifications:write identity_verifications:execute persona_sessions:execute sardine_sessions:execute plans:execute plans:read executions:execute executions:read files:read files:pii:read files:execute\" }' -H \"Content-Type: application/json\" # When using Organization credentials set `scope` to 'organizations:read organizations:write organization_applications:read banks:read banks:write banks:execute bank_applications:read users:read counterparties:read counterparties:pii:read customers:read customers:pii:read accounts:read accounts:write prices:read quotes:execute quotes:read trades:execute trades:read transactions:read transfers:read transfers:write transfers:execute external_bank_accounts:read external_bank_accounts:pii:read transfers:pii:read external_bank_accounts:write external_wallets:read external_wallets:write workflows:read deposit_addresses:read deposit_addresses:write deposit_bank_accounts:read deposit_bank_accounts:write deposit_bank_accounts:execute invoices:read subscriptions:read subscriptions:write subscriptions:execute subscription_events:read subscription_events:execute identity_verifications:read identity_verifications:pii:read identity_verifications:execute persona_sessions:execute sardine_sessions:execute plans:execute plans:read executions:execute executions:read files:read files:pii: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) | | Bank Application | bank_applications:read (Organization, Bank) | | | | 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 Application | organization_applications:read (Organization) | | | | Organization | organizations:read (Organization) | organizations:write (Organization) | | | User | users:read (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) | API keys and organization users are created, updated and deleted only in the Partner Portal. Tokens issued for an organization API key can list and get organization applications, bank applications and users, and tokens issued for a bank API key can list and get bank applications; neither can create, update or delete them. Requesting the `organization_applications:write`, `organization_applications:execute`, `bank_applications:write`, `bank_applications:execute`, `users:write` or `users:execute` scopes alongside other scopes is tolerated: they are dropped and the token is issued with the rest. ## 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 | Get and list bank API keys | | Identity | CustomerToken | /api/customer_tokens | Create customer JWT access tokens | | Identity | Organization | /api/organization_applications | Get and list organization API keys | | Identity | Organization | /api/users | Get 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.129.1239
7
- Contact: support@cybrid.app
8
- Generated by: https://openapi-generator.tech
9
- Generator version: 7.8.0
10
-
11
- =end
12
-
13
- require 'spec_helper'
14
- require 'json'
15
- require 'date'
16
-
17
- # Unit tests for CybridApiBank::PostInvoiceBankModel
18
- # Automatically generated by openapi-generator (https://openapi-generator.tech)
19
- # Please update as you see appropriate
20
- describe CybridApiBank::PostInvoiceBankModel do
21
- let(:instance) { CybridApiBank::PostInvoiceBankModel.new }
22
-
23
- describe 'test an instance of PostInvoiceBankModel' do
24
- it 'should create an instance of PostInvoiceBankModel' do
25
- # uncomment below to test the instance creation
26
- #expect(instance).to be_instance_of(CybridApiBank::PostInvoiceBankModel)
27
- end
28
- end
29
-
30
- describe 'test attribute "asset"' do
31
- it 'should work' do
32
- # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
33
- end
34
- end
35
-
36
- describe 'test attribute "customer_guid"' do
37
- it 'should work' do
38
- # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
39
- end
40
- end
41
-
42
- describe 'test attribute "receive_amount"' do
43
- it 'should work' do
44
- # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
45
- end
46
- end
47
-
48
- describe 'test attribute "deliver_amount"' do
49
- it 'should work' do
50
- # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
51
- end
52
- end
53
-
54
- describe 'test attribute "account_guid"' do
55
- it 'should work' do
56
- # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
57
- end
58
- end
59
-
60
- describe 'test attribute "labels"' do
61
- it 'should work' do
62
- # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
63
- end
64
- end
65
-
66
- end
@@ -1,46 +0,0 @@
1
- =begin
2
- #Cybrid Bank API
3
-
4
- ## Cybrid API documentation Welcome to Cybrid, an all-in-one crypto platform that enables you to easily **build** and **launch** white-label crypto products or services. In these documents, you'll find details on how our REST API operates and generally how our platform functions. If you're looking for our UI SDK Widgets for Web or Mobile (iOS/Android), generated API clients, or demo applications, head over to our [Github repo](https://github.com/Cybrid-app). 💡 We recommend bookmarking the [Cybrid LinkTree](https://linktr.ee/cybridtechnologies) which contains many helpful links to platform resources. ## Getting Started This is Cybrid's public interactive API documentation, which allows you to fully test our APIs. If you'd like to use a different tool to exercise our APIs, you can download the [Open API 3.0 yaml](https://bank.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 Overview](https://docs.cybrid.xyz/docs/platform-overview) 3. [Testing with Hosted Web Demo App](https://docs.cybrid.xyz/docs/hosted-demo-app) In [Getting Started in the Cybrid Sandbox](https://docs.cybrid.xyz/docs/cybrid-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://docs.cybrid.xyz/docs/trade-process), 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:read accounts:read accounts:write accounts:execute counterparties:read counterparties:pii:read counterparties:write counterparties:execute customers:read customers:pii:read customers:write customers:execute prices:read quotes:execute quotes:read trades:execute trades:read transactions:read transfers:execute transfers:read transfers:write external_bank_accounts:read external_bank_accounts:pii:read transfers:pii:read external_bank_accounts:write external_bank_accounts:execute external_wallets:read external_wallets:write external_wallets:execute workflows:read workflows:execute deposit_addresses:read deposit_addresses:write deposit_addresses:execute deposit_bank_accounts:read deposit_bank_accounts:write deposit_bank_accounts:execute invoices:read invoices:write invoices:execute identity_verifications:read identity_verifications:pii:read identity_verifications:write identity_verifications:execute persona_sessions:execute sardine_sessions:execute plans:execute plans:read executions:execute executions:read files:read files:pii:read files:execute\" }' -H \"Content-Type: application/json\" # When using Organization credentials set `scope` to 'organizations:read organizations:write organization_applications:read banks:read banks:write banks:execute bank_applications:read users:read counterparties:read counterparties:pii:read customers:read customers:pii:read accounts:read accounts:write prices:read quotes:execute quotes:read trades:execute trades:read transactions:read transfers:read transfers:write transfers:execute external_bank_accounts:read external_bank_accounts:pii:read transfers:pii:read external_bank_accounts:write external_wallets:read external_wallets:write workflows:read deposit_addresses:read deposit_addresses:write deposit_bank_accounts:read deposit_bank_accounts:write deposit_bank_accounts:execute invoices:read subscriptions:read subscriptions:write subscriptions:execute subscription_events:read subscription_events:execute identity_verifications:read identity_verifications:pii:read identity_verifications:execute persona_sessions:execute sardine_sessions:execute plans:execute plans:read executions:execute executions:read files:read files:pii: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) | | Bank Application | bank_applications:read (Organization, Bank) | | | | 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 Application | organization_applications:read (Organization) | | | | Organization | organizations:read (Organization) | organizations:write (Organization) | | | User | users:read (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) | API keys and organization users are created, updated and deleted only in the Partner Portal. Tokens issued for an organization API key can list and get organization applications, bank applications and users, and tokens issued for a bank API key can list and get bank applications; neither can create, update or delete them. Requesting the `organization_applications:write`, `organization_applications:execute`, `bank_applications:write`, `bank_applications:execute`, `users:write` or `users:execute` scopes alongside other scopes is tolerated: they are dropped and the token is issued with the rest. ## 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 | Get and list bank API keys | | Identity | CustomerToken | /api/customer_tokens | Create customer JWT access tokens | | Identity | Organization | /api/organization_applications | Get and list organization API keys | | Identity | Organization | /api/users | Get 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.129.1239
7
- Contact: support@cybrid.app
8
- Generated by: https://openapi-generator.tech
9
- Generator version: 7.8.0
10
-
11
- =end
12
-
13
- require 'spec_helper'
14
- require 'json'
15
- require 'date'
16
-
17
- # Unit tests for CybridApiBank::PostPaymentInstructionBankModel
18
- # Automatically generated by openapi-generator (https://openapi-generator.tech)
19
- # Please update as you see appropriate
20
- describe CybridApiBank::PostPaymentInstructionBankModel do
21
- let(:instance) { CybridApiBank::PostPaymentInstructionBankModel.new }
22
-
23
- describe 'test an instance of PostPaymentInstructionBankModel' do
24
- it 'should create an instance of PostPaymentInstructionBankModel' do
25
- # uncomment below to test the instance creation
26
- #expect(instance).to be_instance_of(CybridApiBank::PostPaymentInstructionBankModel)
27
- end
28
- end
29
-
30
- describe 'test attribute "invoice_guid"' do
31
- it 'should work' do
32
- # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
33
- end
34
- end
35
-
36
- describe 'test attribute "expected_behaviour"' do
37
- it 'should work' do
38
- # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
39
- # validator = Petstore::EnumTest::EnumAttributeValidator.new('String', ["invoice_paid_immediately"])
40
- # validator.allowable_values.each do |value|
41
- # expect { instance.expected_behaviour = value }.not_to raise_error
42
- # end
43
- end
44
- end
45
-
46
- end