cybrid_api_bank_ruby 0.129.1029 → 0.129.1031

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 (476) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile.lock +2 -2
  3. data/README.md +11 -5
  4. data/cybrid_api_bank_ruby.gemspec +1 -1
  5. data/docs/BalanceBankModel.md +22 -0
  6. data/docs/CustomerBankModel.md +2 -0
  7. data/docs/PostIdentityVerificationBankModel.md +1 -1
  8. data/docs/TransactionBankModel.md +38 -0
  9. data/docs/TransactionListBankModel.md +20 -0
  10. data/docs/TransactionListPageInfoBankModel.md +18 -0
  11. data/docs/TransactionResourceBankModel.md +20 -0
  12. data/docs/TransactionsBankApi.md +94 -0
  13. data/lib/cybrid_api_bank_ruby/api/accounts_bank_api.rb +1 -1
  14. data/lib/cybrid_api_bank_ruby/api/assets_bank_api.rb +1 -1
  15. data/lib/cybrid_api_bank_ruby/api/banks_bank_api.rb +1 -1
  16. data/lib/cybrid_api_bank_ruby/api/counterparties_bank_api.rb +1 -1
  17. data/lib/cybrid_api_bank_ruby/api/customers_bank_api.rb +1 -1
  18. data/lib/cybrid_api_bank_ruby/api/deposit_addresses_bank_api.rb +1 -1
  19. data/lib/cybrid_api_bank_ruby/api/deposit_bank_accounts_bank_api.rb +1 -1
  20. data/lib/cybrid_api_bank_ruby/api/executions_bank_api.rb +1 -1
  21. data/lib/cybrid_api_bank_ruby/api/external_bank_accounts_bank_api.rb +1 -1
  22. data/lib/cybrid_api_bank_ruby/api/external_wallets_bank_api.rb +1 -1
  23. data/lib/cybrid_api_bank_ruby/api/files_bank_api.rb +1 -1
  24. data/lib/cybrid_api_bank_ruby/api/identity_verifications_bank_api.rb +1 -1
  25. data/lib/cybrid_api_bank_ruby/api/invoices_bank_api.rb +1 -1
  26. data/lib/cybrid_api_bank_ruby/api/payment_instructions_bank_api.rb +1 -1
  27. data/lib/cybrid_api_bank_ruby/api/persona_sessions_bank_api.rb +1 -1
  28. data/lib/cybrid_api_bank_ruby/api/plans_bank_api.rb +1 -1
  29. data/lib/cybrid_api_bank_ruby/api/prices_bank_api.rb +1 -1
  30. data/lib/cybrid_api_bank_ruby/api/quotes_bank_api.rb +1 -1
  31. data/lib/cybrid_api_bank_ruby/api/sardine_sessions_bank_api.rb +1 -1
  32. data/lib/cybrid_api_bank_ruby/api/symbols_bank_api.rb +1 -1
  33. data/lib/cybrid_api_bank_ruby/api/trades_bank_api.rb +1 -1
  34. data/lib/cybrid_api_bank_ruby/api/transactions_bank_api.rb +116 -0
  35. data/lib/cybrid_api_bank_ruby/api/transfers_bank_api.rb +1 -1
  36. data/lib/cybrid_api_bank_ruby/api/workflows_bank_api.rb +1 -1
  37. data/lib/cybrid_api_bank_ruby/api_client.rb +1 -1
  38. data/lib/cybrid_api_bank_ruby/api_error.rb +1 -1
  39. data/lib/cybrid_api_bank_ruby/configuration.rb +1 -1
  40. data/lib/cybrid_api_bank_ruby/models/account_association_bank_model.rb +1 -1
  41. data/lib/cybrid_api_bank_ruby/models/account_bank_model.rb +1 -1
  42. data/lib/cybrid_api_bank_ruby/models/account_list_bank_model.rb +1 -1
  43. data/lib/cybrid_api_bank_ruby/models/account_state_bank_model.rb +1 -1
  44. data/lib/cybrid_api_bank_ruby/models/account_type_bank_model.rb +1 -1
  45. data/lib/cybrid_api_bank_ruby/models/activity_limit_bank_model.rb +1 -1
  46. data/lib/cybrid_api_bank_ruby/models/activity_side_bank_model.rb +1 -1
  47. data/lib/cybrid_api_bank_ruby/models/activity_type_bank_model.rb +1 -1
  48. data/lib/cybrid_api_bank_ruby/models/asset_bank_model.rb +1 -1
  49. data/lib/cybrid_api_bank_ruby/models/asset_list_bank_model.rb +1 -1
  50. data/lib/cybrid_api_bank_ruby/models/asset_types_bank_model.rb +1 -1
  51. data/lib/cybrid_api_bank_ruby/models/balance_bank_model.rb +255 -0
  52. data/lib/cybrid_api_bank_ruby/models/bank_bank_model.rb +1 -1
  53. data/lib/cybrid_api_bank_ruby/models/bank_feature_bank_model.rb +1 -1
  54. data/lib/cybrid_api_bank_ruby/models/bank_list_bank_model.rb +1 -1
  55. data/lib/cybrid_api_bank_ruby/models/bank_supported_payout_symbols_inner_bank_model.rb +1 -1
  56. data/lib/cybrid_api_bank_ruby/models/bank_type_bank_model.rb +1 -1
  57. data/lib/cybrid_api_bank_ruby/models/compliance_check_bank_model.rb +1 -1
  58. data/lib/cybrid_api_bank_ruby/models/compliance_check_outcome_bank_model.rb +1 -1
  59. data/lib/cybrid_api_bank_ruby/models/compliance_check_type_bank_model.rb +1 -1
  60. data/lib/cybrid_api_bank_ruby/models/compliance_decision_bank_model.rb +1 -1
  61. data/lib/cybrid_api_bank_ruby/models/compliance_decision_state_bank_model.rb +1 -1
  62. data/lib/cybrid_api_bank_ruby/models/compliance_decision_type_bank_model.rb +1 -1
  63. data/lib/cybrid_api_bank_ruby/models/counterparty_address_bank_model.rb +1 -1
  64. data/lib/cybrid_api_bank_ruby/models/counterparty_aliases_inner_bank_model.rb +1 -1
  65. data/lib/cybrid_api_bank_ruby/models/counterparty_bank_model.rb +1 -1
  66. data/lib/cybrid_api_bank_ruby/models/counterparty_list_bank_model.rb +1 -1
  67. data/lib/cybrid_api_bank_ruby/models/counterparty_name_bank_model.rb +1 -1
  68. data/lib/cybrid_api_bank_ruby/models/counterparty_state_bank_model.rb +1 -1
  69. data/lib/cybrid_api_bank_ruby/models/counterparty_type_bank_model.rb +1 -1
  70. data/lib/cybrid_api_bank_ruby/models/customer_address_bank_model.rb +1 -1
  71. data/lib/cybrid_api_bank_ruby/models/customer_aliases_inner_bank_model.rb +1 -1
  72. data/lib/cybrid_api_bank_ruby/models/customer_bank_model.rb +13 -2
  73. data/lib/cybrid_api_bank_ruby/models/customer_list_bank_model.rb +1 -1
  74. data/lib/cybrid_api_bank_ruby/models/customer_name_bank_model.rb +1 -1
  75. data/lib/cybrid_api_bank_ruby/models/customer_state_bank_model.rb +1 -1
  76. data/lib/cybrid_api_bank_ruby/models/customer_type_bank_model.rb +1 -1
  77. data/lib/cybrid_api_bank_ruby/models/deposit_address_bank_model.rb +1 -1
  78. data/lib/cybrid_api_bank_ruby/models/deposit_address_format_bank_model.rb +1 -1
  79. data/lib/cybrid_api_bank_ruby/models/deposit_address_list_bank_model.rb +1 -1
  80. data/lib/cybrid_api_bank_ruby/models/deposit_address_state_bank_model.rb +1 -1
  81. data/lib/cybrid_api_bank_ruby/models/deposit_bank_account_account_details_inner_bank_model.rb +1 -1
  82. data/lib/cybrid_api_bank_ruby/models/deposit_bank_account_bank_model.rb +1 -1
  83. data/lib/cybrid_api_bank_ruby/models/deposit_bank_account_counterparty_address_bank_model.rb +1 -1
  84. data/lib/cybrid_api_bank_ruby/models/deposit_bank_account_list_bank_model.rb +1 -1
  85. data/lib/cybrid_api_bank_ruby/models/deposit_bank_account_routing_details_inner_bank_model.rb +1 -1
  86. data/lib/cybrid_api_bank_ruby/models/deposit_bank_account_routing_number_type_bank_model.rb +1 -1
  87. data/lib/cybrid_api_bank_ruby/models/deposit_bank_account_state_bank_model.rb +1 -1
  88. data/lib/cybrid_api_bank_ruby/models/effective_rate_bank_model.rb +1 -1
  89. data/lib/cybrid_api_bank_ruby/models/error_response_bank_model.rb +1 -1
  90. data/lib/cybrid_api_bank_ruby/models/execution_bank_model.rb +1 -1
  91. data/lib/cybrid_api_bank_ruby/models/execution_list_bank_model.rb +1 -1
  92. data/lib/cybrid_api_bank_ruby/models/execution_travel_rule_info_bank_model.rb +1 -1
  93. data/lib/cybrid_api_bank_ruby/models/external_bank_account_balances_bank_model.rb +1 -1
  94. data/lib/cybrid_api_bank_ruby/models/external_bank_account_bank_model.rb +1 -1
  95. data/lib/cybrid_api_bank_ruby/models/external_bank_account_kind_bank_model.rb +1 -1
  96. data/lib/cybrid_api_bank_ruby/models/external_bank_account_list_bank_model.rb +1 -1
  97. data/lib/cybrid_api_bank_ruby/models/external_bank_account_pii_inner_addresses_inner_bank_model.rb +1 -1
  98. data/lib/cybrid_api_bank_ruby/models/external_bank_account_pii_inner_bank_model.rb +1 -1
  99. data/lib/cybrid_api_bank_ruby/models/external_bank_account_pii_inner_routing_details_inner_bank_model.rb +1 -1
  100. data/lib/cybrid_api_bank_ruby/models/external_bank_account_state_bank_model.rb +1 -1
  101. data/lib/cybrid_api_bank_ruby/models/external_wallet_bank_model.rb +1 -1
  102. data/lib/cybrid_api_bank_ruby/models/external_wallet_environment_bank_model.rb +1 -1
  103. data/lib/cybrid_api_bank_ruby/models/external_wallet_list_bank_model.rb +1 -1
  104. data/lib/cybrid_api_bank_ruby/models/external_wallet_state_bank_model.rb +1 -1
  105. data/lib/cybrid_api_bank_ruby/models/fee_association_bank_model.rb +1 -1
  106. data/lib/cybrid_api_bank_ruby/models/fee_detail_bank_model.rb +1 -1
  107. data/lib/cybrid_api_bank_ruby/models/hold_detail_bank_model.rb +1 -1
  108. data/lib/cybrid_api_bank_ruby/models/identification_number_bank_model.rb +1 -1
  109. data/lib/cybrid_api_bank_ruby/models/identity_verification_bank_model.rb +1 -1
  110. data/lib/cybrid_api_bank_ruby/models/identity_verification_business_associate_bank_model.rb +1 -1
  111. data/lib/cybrid_api_bank_ruby/models/identity_verification_document_bank_model.rb +1 -1
  112. data/lib/cybrid_api_bank_ruby/models/identity_verification_document_file_bank_model.rb +1 -1
  113. data/lib/cybrid_api_bank_ruby/models/identity_verification_document_file_metadata_bank_model.rb +1 -1
  114. data/lib/cybrid_api_bank_ruby/models/identity_verification_list_bank_model.rb +1 -1
  115. data/lib/cybrid_api_bank_ruby/models/identity_verification_method_bank_model.rb +1 -1
  116. data/lib/cybrid_api_bank_ruby/models/identity_verification_options_bank_model.rb +1 -1
  117. data/lib/cybrid_api_bank_ruby/models/identity_verification_outcome_bank_model.rb +1 -1
  118. data/lib/cybrid_api_bank_ruby/models/identity_verification_persona_state_bank_model.rb +1 -1
  119. data/lib/cybrid_api_bank_ruby/models/identity_verification_state_bank_model.rb +1 -1
  120. data/lib/cybrid_api_bank_ruby/models/identity_verification_type_bank_model.rb +1 -1
  121. data/lib/cybrid_api_bank_ruby/models/identity_verification_with_details_bank_model.rb +1 -1
  122. data/lib/cybrid_api_bank_ruby/models/identity_verification_with_details_pii_address_bank_model.rb +1 -1
  123. data/lib/cybrid_api_bank_ruby/models/identity_verification_with_details_pii_aliases_inner_bank_model.rb +1 -1
  124. data/lib/cybrid_api_bank_ruby/models/identity_verification_with_details_pii_bank_model.rb +1 -1
  125. data/lib/cybrid_api_bank_ruby/models/identity_verification_with_details_pii_name_bank_model.rb +1 -1
  126. data/lib/cybrid_api_bank_ruby/models/identity_verification_with_details_pii_registered_address_bank_model.rb +1 -1
  127. data/lib/cybrid_api_bank_ruby/models/invoice_bank_model.rb +1 -1
  128. data/lib/cybrid_api_bank_ruby/models/invoice_list_bank_model.rb +1 -1
  129. data/lib/cybrid_api_bank_ruby/models/legal_entity_name_bank_model.rb +1 -1
  130. data/lib/cybrid_api_bank_ruby/models/patch_account_bank_model.rb +1 -1
  131. data/lib/cybrid_api_bank_ruby/models/patch_bank_bank_model.rb +1 -1
  132. data/lib/cybrid_api_bank_ruby/models/patch_customer_bank_model.rb +1 -1
  133. data/lib/cybrid_api_bank_ruby/models/patch_deposit_address_bank_model.rb +1 -1
  134. data/lib/cybrid_api_bank_ruby/models/patch_deposit_bank_account_bank_model.rb +1 -1
  135. data/lib/cybrid_api_bank_ruby/models/patch_external_bank_account_bank_model.rb +1 -1
  136. data/lib/cybrid_api_bank_ruby/models/patch_external_wallet_bank_model.rb +1 -1
  137. data/lib/cybrid_api_bank_ruby/models/patch_transfer_bank_model.rb +1 -1
  138. data/lib/cybrid_api_bank_ruby/models/patch_transfer_participant_bank_model.rb +1 -1
  139. data/lib/cybrid_api_bank_ruby/models/payment_instruction_bank_model.rb +1 -1
  140. data/lib/cybrid_api_bank_ruby/models/payment_instruction_list_bank_model.rb +1 -1
  141. data/lib/cybrid_api_bank_ruby/models/payout_return_details_bank_model.rb +1 -1
  142. data/lib/cybrid_api_bank_ruby/models/persona_session_bank_model.rb +1 -1
  143. data/lib/cybrid_api_bank_ruby/models/physical_address_bank_model.rb +1 -1
  144. data/lib/cybrid_api_bank_ruby/models/plan_bank_model.rb +1 -1
  145. data/lib/cybrid_api_bank_ruby/models/plan_list_bank_model.rb +1 -1
  146. data/lib/cybrid_api_bank_ruby/models/plan_reference_bank_model.rb +1 -1
  147. data/lib/cybrid_api_bank_ruby/models/plan_travel_rule_info_bank_model.rb +1 -1
  148. data/lib/cybrid_api_bank_ruby/models/platform_file_bank_model.rb +1 -1
  149. data/lib/cybrid_api_bank_ruby/models/platform_file_list_bank_model.rb +1 -1
  150. data/lib/cybrid_api_bank_ruby/models/post_account_bank_model.rb +1 -1
  151. data/lib/cybrid_api_bank_ruby/models/post_bank_account_details_bank_model.rb +1 -1
  152. data/lib/cybrid_api_bank_ruby/models/post_bank_bank_model.rb +1 -1
  153. data/lib/cybrid_api_bank_ruby/models/post_counterparty_address_bank_model.rb +1 -1
  154. data/lib/cybrid_api_bank_ruby/models/post_counterparty_aliases_inner_bank_model.rb +1 -1
  155. data/lib/cybrid_api_bank_ruby/models/post_counterparty_bank_model.rb +1 -1
  156. data/lib/cybrid_api_bank_ruby/models/post_counterparty_name_bank_model.rb +1 -1
  157. data/lib/cybrid_api_bank_ruby/models/post_customer_address_bank_model.rb +1 -1
  158. data/lib/cybrid_api_bank_ruby/models/post_customer_aliases_inner_bank_model.rb +1 -1
  159. data/lib/cybrid_api_bank_ruby/models/post_customer_bank_model.rb +1 -1
  160. data/lib/cybrid_api_bank_ruby/models/post_customer_name_bank_model.rb +1 -1
  161. data/lib/cybrid_api_bank_ruby/models/post_deposit_address_bank_model.rb +1 -1
  162. data/lib/cybrid_api_bank_ruby/models/post_deposit_bank_account_bank_model.rb +1 -1
  163. data/lib/cybrid_api_bank_ruby/models/post_execution_bank_model.rb +1 -1
  164. data/lib/cybrid_api_bank_ruby/models/post_external_bank_account_bank_model.rb +1 -1
  165. data/lib/cybrid_api_bank_ruby/models/post_external_bank_account_counterparty_address_bank_model.rb +1 -1
  166. data/lib/cybrid_api_bank_ruby/models/post_external_bank_account_counterparty_name_bank_model.rb +1 -1
  167. data/lib/cybrid_api_bank_ruby/models/post_external_wallet_bank_model.rb +1 -1
  168. data/lib/cybrid_api_bank_ruby/models/post_fee_bank_model.rb +1 -1
  169. data/lib/cybrid_api_bank_ruby/models/post_file_bank_model.rb +1 -1
  170. data/lib/cybrid_api_bank_ruby/models/post_file_metadata_bank_model.rb +1 -1
  171. data/lib/cybrid_api_bank_ruby/models/post_identification_number_bank_model.rb +1 -1
  172. data/lib/cybrid_api_bank_ruby/models/post_identity_verification_address_bank_model.rb +1 -1
  173. data/lib/cybrid_api_bank_ruby/models/post_identity_verification_aliases_inner_bank_model.rb +1 -1
  174. data/lib/cybrid_api_bank_ruby/models/post_identity_verification_bank_model.rb +2 -2
  175. data/lib/cybrid_api_bank_ruby/models/post_identity_verification_name_bank_model.rb +1 -1
  176. data/lib/cybrid_api_bank_ruby/models/post_identity_verification_registered_address_bank_model.rb +1 -1
  177. data/lib/cybrid_api_bank_ruby/models/post_invoice_bank_model.rb +1 -1
  178. data/lib/cybrid_api_bank_ruby/models/post_payment_instruction_bank_model.rb +1 -1
  179. data/lib/cybrid_api_bank_ruby/models/post_persona_session_bank_model.rb +1 -1
  180. data/lib/cybrid_api_bank_ruby/models/post_plan_bank_model.rb +1 -1
  181. data/lib/cybrid_api_bank_ruby/models/post_plan_destination_account_bank_model.rb +1 -1
  182. data/lib/cybrid_api_bank_ruby/models/post_plan_source_account_bank_model.rb +1 -1
  183. data/lib/cybrid_api_bank_ruby/models/post_plan_travel_rule_info_bank_model.rb +1 -1
  184. data/lib/cybrid_api_bank_ruby/models/post_quote_bank_model.rb +1 -1
  185. data/lib/cybrid_api_bank_ruby/models/post_quote_entry_bank_model.rb +1 -1
  186. data/lib/cybrid_api_bank_ruby/models/post_sardine_session_bank_model.rb +1 -1
  187. data/lib/cybrid_api_bank_ruby/models/post_supported_payout_symbols_bank_model.rb +1 -1
  188. data/lib/cybrid_api_bank_ruby/models/post_supporting_document_bank_model.rb +1 -1
  189. data/lib/cybrid_api_bank_ruby/models/post_trade_bank_model.rb +1 -1
  190. data/lib/cybrid_api_bank_ruby/models/post_transfer_bank_model.rb +1 -1
  191. data/lib/cybrid_api_bank_ruby/models/post_transfer_participant_bank_model.rb +1 -1
  192. data/lib/cybrid_api_bank_ruby/models/post_ultimate_beneficial_owner_bank_model.rb +1 -1
  193. data/lib/cybrid_api_bank_ruby/models/post_workflow_bank_model.rb +1 -1
  194. data/lib/cybrid_api_bank_ruby/models/quote_bank_model.rb +1 -1
  195. data/lib/cybrid_api_bank_ruby/models/quote_entry_bank_model.rb +1 -1
  196. data/lib/cybrid_api_bank_ruby/models/quote_entry_destination_account_bank_model.rb +1 -1
  197. data/lib/cybrid_api_bank_ruby/models/quote_entry_source_account_bank_model.rb +1 -1
  198. data/lib/cybrid_api_bank_ruby/models/quote_list_bank_model.rb +1 -1
  199. data/lib/cybrid_api_bank_ruby/models/quote_side_bank_model.rb +1 -1
  200. data/lib/cybrid_api_bank_ruby/models/quote_type_bank_model.rb +1 -1
  201. data/lib/cybrid_api_bank_ruby/models/return_details_bank_model.rb +1 -1
  202. data/lib/cybrid_api_bank_ruby/models/sardine_session_bank_model.rb +1 -1
  203. data/lib/cybrid_api_bank_ruby/models/stage_bank_model.rb +1 -1
  204. data/lib/cybrid_api_bank_ruby/models/stage_identifier_bank_model.rb +1 -1
  205. data/lib/cybrid_api_bank_ruby/models/stage_link_bank_model.rb +1 -1
  206. data/lib/cybrid_api_bank_ruby/models/supporting_document_bank_model.rb +1 -1
  207. data/lib/cybrid_api_bank_ruby/models/supporting_document_file_bank_model.rb +1 -1
  208. data/lib/cybrid_api_bank_ruby/models/symbol_price_bank_model.rb +1 -1
  209. data/lib/cybrid_api_bank_ruby/models/trade_bank_model.rb +1 -1
  210. data/lib/cybrid_api_bank_ruby/models/trade_failure_code_bank_model.rb +1 -1
  211. data/lib/cybrid_api_bank_ruby/models/trade_list_bank_model.rb +1 -1
  212. data/lib/cybrid_api_bank_ruby/models/trade_side_bank_model.rb +1 -1
  213. data/lib/cybrid_api_bank_ruby/models/trade_state_bank_model.rb +1 -1
  214. data/lib/cybrid_api_bank_ruby/models/trade_type_bank_model.rb +1 -1
  215. data/lib/cybrid_api_bank_ruby/models/transaction_bank_model.rb +469 -0
  216. data/lib/cybrid_api_bank_ruby/models/transaction_list_bank_model.rb +240 -0
  217. data/lib/cybrid_api_bank_ruby/models/transaction_list_page_info_bank_model.rb +221 -0
  218. data/lib/cybrid_api_bank_ruby/models/transaction_resource_bank_model.rb +240 -0
  219. data/lib/cybrid_api_bank_ruby/models/transfer_account_type_bank_model.rb +1 -1
  220. data/lib/cybrid_api_bank_ruby/models/transfer_bank_model.rb +1 -1
  221. data/lib/cybrid_api_bank_ruby/models/transfer_destination_account_bank_model.rb +1 -1
  222. data/lib/cybrid_api_bank_ruby/models/transfer_entry_bank_model.rb +1 -1
  223. data/lib/cybrid_api_bank_ruby/models/transfer_entry_destination_account_bank_model.rb +1 -1
  224. data/lib/cybrid_api_bank_ruby/models/transfer_failure_code_bank_model.rb +1 -1
  225. data/lib/cybrid_api_bank_ruby/models/transfer_hold_details_bank_model.rb +1 -1
  226. data/lib/cybrid_api_bank_ruby/models/transfer_identifiers_inner_bank_model.rb +1 -1
  227. data/lib/cybrid_api_bank_ruby/models/transfer_list_bank_model.rb +1 -1
  228. data/lib/cybrid_api_bank_ruby/models/transfer_participant_bank_model.rb +1 -1
  229. data/lib/cybrid_api_bank_ruby/models/transfer_side_bank_model.rb +1 -1
  230. data/lib/cybrid_api_bank_ruby/models/transfer_source_account_bank_model.rb +1 -1
  231. data/lib/cybrid_api_bank_ruby/models/transfer_state_bank_model.rb +1 -1
  232. data/lib/cybrid_api_bank_ruby/models/transfer_type_bank_model.rb +1 -1
  233. data/lib/cybrid_api_bank_ruby/models/travel_rule_info_party_bank_model.rb +1 -1
  234. data/lib/cybrid_api_bank_ruby/models/workflow_bank_model.rb +1 -1
  235. data/lib/cybrid_api_bank_ruby/models/workflow_state_bank_model.rb +1 -1
  236. data/lib/cybrid_api_bank_ruby/models/workflow_type_bank_model.rb +1 -1
  237. data/lib/cybrid_api_bank_ruby/models/workflow_with_details_all_of_bank_model.rb +1 -1
  238. data/lib/cybrid_api_bank_ruby/models/workflow_with_details_bank_model.rb +1 -1
  239. data/lib/cybrid_api_bank_ruby/models/workflows_list_bank_model.rb +1 -1
  240. data/lib/cybrid_api_bank_ruby/version.rb +2 -2
  241. data/lib/cybrid_api_bank_ruby.rb +7 -1
  242. data/spec/api/accounts_bank_api_spec.rb +1 -1
  243. data/spec/api/assets_bank_api_spec.rb +1 -1
  244. data/spec/api/banks_bank_api_spec.rb +1 -1
  245. data/spec/api/counterparties_bank_api_spec.rb +1 -1
  246. data/spec/api/customers_bank_api_spec.rb +1 -1
  247. data/spec/api/deposit_addresses_bank_api_spec.rb +1 -1
  248. data/spec/api/deposit_bank_accounts_bank_api_spec.rb +1 -1
  249. data/spec/api/executions_bank_api_spec.rb +1 -1
  250. data/spec/api/external_bank_accounts_bank_api_spec.rb +1 -1
  251. data/spec/api/external_wallets_bank_api_spec.rb +1 -1
  252. data/spec/api/files_bank_api_spec.rb +1 -1
  253. data/spec/api/identity_verifications_bank_api_spec.rb +1 -1
  254. data/spec/api/invoices_bank_api_spec.rb +1 -1
  255. data/spec/api/payment_instructions_bank_api_spec.rb +1 -1
  256. data/spec/api/persona_sessions_bank_api_spec.rb +1 -1
  257. data/spec/api/plans_bank_api_spec.rb +1 -1
  258. data/spec/api/prices_bank_api_spec.rb +1 -1
  259. data/spec/api/quotes_bank_api_spec.rb +1 -1
  260. data/spec/api/sardine_sessions_bank_api_spec.rb +1 -1
  261. data/spec/api/symbols_bank_api_spec.rb +1 -1
  262. data/spec/api/trades_bank_api_spec.rb +1 -1
  263. data/spec/api/transactions_bank_api_spec.rb +53 -0
  264. data/spec/api/transfers_bank_api_spec.rb +1 -1
  265. data/spec/api/workflows_bank_api_spec.rb +1 -1
  266. data/spec/api_client_spec.rb +1 -1
  267. data/spec/configuration_spec.rb +1 -1
  268. data/spec/models/account_association_bank_model_spec.rb +1 -1
  269. data/spec/models/account_bank_model_spec.rb +1 -1
  270. data/spec/models/account_list_bank_model_spec.rb +1 -1
  271. data/spec/models/account_state_bank_model_spec.rb +1 -1
  272. data/spec/models/account_type_bank_model_spec.rb +1 -1
  273. data/spec/models/activity_limit_bank_model_spec.rb +1 -1
  274. data/spec/models/activity_side_bank_model_spec.rb +1 -1
  275. data/spec/models/activity_type_bank_model_spec.rb +1 -1
  276. data/spec/models/asset_bank_model_spec.rb +1 -1
  277. data/spec/models/asset_list_bank_model_spec.rb +1 -1
  278. data/spec/models/asset_types_bank_model_spec.rb +1 -1
  279. data/spec/models/balance_bank_model_spec.rb +46 -0
  280. data/spec/models/bank_bank_model_spec.rb +1 -1
  281. data/spec/models/bank_feature_bank_model_spec.rb +1 -1
  282. data/spec/models/bank_list_bank_model_spec.rb +1 -1
  283. data/spec/models/bank_supported_payout_symbols_inner_bank_model_spec.rb +1 -1
  284. data/spec/models/bank_type_bank_model_spec.rb +1 -1
  285. data/spec/models/compliance_check_bank_model_spec.rb +1 -1
  286. data/spec/models/compliance_check_outcome_bank_model_spec.rb +1 -1
  287. data/spec/models/compliance_check_type_bank_model_spec.rb +1 -1
  288. data/spec/models/compliance_decision_bank_model_spec.rb +1 -1
  289. data/spec/models/compliance_decision_state_bank_model_spec.rb +1 -1
  290. data/spec/models/compliance_decision_type_bank_model_spec.rb +1 -1
  291. data/spec/models/counterparty_address_bank_model_spec.rb +1 -1
  292. data/spec/models/counterparty_aliases_inner_bank_model_spec.rb +1 -1
  293. data/spec/models/counterparty_bank_model_spec.rb +1 -1
  294. data/spec/models/counterparty_list_bank_model_spec.rb +1 -1
  295. data/spec/models/counterparty_name_bank_model_spec.rb +1 -1
  296. data/spec/models/counterparty_state_bank_model_spec.rb +1 -1
  297. data/spec/models/counterparty_type_bank_model_spec.rb +1 -1
  298. data/spec/models/customer_address_bank_model_spec.rb +1 -1
  299. data/spec/models/customer_aliases_inner_bank_model_spec.rb +1 -1
  300. data/spec/models/customer_bank_model_spec.rb +7 -1
  301. data/spec/models/customer_list_bank_model_spec.rb +1 -1
  302. data/spec/models/customer_name_bank_model_spec.rb +1 -1
  303. data/spec/models/customer_state_bank_model_spec.rb +1 -1
  304. data/spec/models/customer_type_bank_model_spec.rb +1 -1
  305. data/spec/models/deposit_address_bank_model_spec.rb +1 -1
  306. data/spec/models/deposit_address_format_bank_model_spec.rb +1 -1
  307. data/spec/models/deposit_address_list_bank_model_spec.rb +1 -1
  308. data/spec/models/deposit_address_state_bank_model_spec.rb +1 -1
  309. data/spec/models/deposit_bank_account_account_details_inner_bank_model_spec.rb +1 -1
  310. data/spec/models/deposit_bank_account_bank_model_spec.rb +1 -1
  311. data/spec/models/deposit_bank_account_counterparty_address_bank_model_spec.rb +1 -1
  312. data/spec/models/deposit_bank_account_list_bank_model_spec.rb +1 -1
  313. data/spec/models/deposit_bank_account_routing_details_inner_bank_model_spec.rb +1 -1
  314. data/spec/models/deposit_bank_account_routing_number_type_bank_model_spec.rb +1 -1
  315. data/spec/models/deposit_bank_account_state_bank_model_spec.rb +1 -1
  316. data/spec/models/effective_rate_bank_model_spec.rb +1 -1
  317. data/spec/models/error_response_bank_model_spec.rb +1 -1
  318. data/spec/models/execution_bank_model_spec.rb +1 -1
  319. data/spec/models/execution_list_bank_model_spec.rb +1 -1
  320. data/spec/models/execution_travel_rule_info_bank_model_spec.rb +1 -1
  321. data/spec/models/external_bank_account_balances_bank_model_spec.rb +1 -1
  322. data/spec/models/external_bank_account_bank_model_spec.rb +1 -1
  323. data/spec/models/external_bank_account_kind_bank_model_spec.rb +1 -1
  324. data/spec/models/external_bank_account_list_bank_model_spec.rb +1 -1
  325. data/spec/models/external_bank_account_pii_inner_addresses_inner_bank_model_spec.rb +1 -1
  326. data/spec/models/external_bank_account_pii_inner_bank_model_spec.rb +1 -1
  327. data/spec/models/external_bank_account_pii_inner_routing_details_inner_bank_model_spec.rb +1 -1
  328. data/spec/models/external_bank_account_state_bank_model_spec.rb +1 -1
  329. data/spec/models/external_wallet_bank_model_spec.rb +1 -1
  330. data/spec/models/external_wallet_environment_bank_model_spec.rb +1 -1
  331. data/spec/models/external_wallet_list_bank_model_spec.rb +1 -1
  332. data/spec/models/external_wallet_state_bank_model_spec.rb +1 -1
  333. data/spec/models/fee_association_bank_model_spec.rb +1 -1
  334. data/spec/models/fee_detail_bank_model_spec.rb +1 -1
  335. data/spec/models/hold_detail_bank_model_spec.rb +1 -1
  336. data/spec/models/identification_number_bank_model_spec.rb +1 -1
  337. data/spec/models/identity_verification_bank_model_spec.rb +1 -1
  338. data/spec/models/identity_verification_business_associate_bank_model_spec.rb +1 -1
  339. data/spec/models/identity_verification_document_bank_model_spec.rb +1 -1
  340. data/spec/models/identity_verification_document_file_bank_model_spec.rb +1 -1
  341. data/spec/models/identity_verification_document_file_metadata_bank_model_spec.rb +1 -1
  342. data/spec/models/identity_verification_list_bank_model_spec.rb +1 -1
  343. data/spec/models/identity_verification_method_bank_model_spec.rb +1 -1
  344. data/spec/models/identity_verification_options_bank_model_spec.rb +1 -1
  345. data/spec/models/identity_verification_outcome_bank_model_spec.rb +1 -1
  346. data/spec/models/identity_verification_persona_state_bank_model_spec.rb +1 -1
  347. data/spec/models/identity_verification_state_bank_model_spec.rb +1 -1
  348. data/spec/models/identity_verification_type_bank_model_spec.rb +1 -1
  349. data/spec/models/identity_verification_with_details_bank_model_spec.rb +1 -1
  350. data/spec/models/identity_verification_with_details_pii_address_bank_model_spec.rb +1 -1
  351. data/spec/models/identity_verification_with_details_pii_aliases_inner_bank_model_spec.rb +1 -1
  352. data/spec/models/identity_verification_with_details_pii_bank_model_spec.rb +1 -1
  353. data/spec/models/identity_verification_with_details_pii_name_bank_model_spec.rb +1 -1
  354. data/spec/models/identity_verification_with_details_pii_registered_address_bank_model_spec.rb +1 -1
  355. data/spec/models/invoice_bank_model_spec.rb +1 -1
  356. data/spec/models/invoice_list_bank_model_spec.rb +1 -1
  357. data/spec/models/legal_entity_name_bank_model_spec.rb +1 -1
  358. data/spec/models/patch_account_bank_model_spec.rb +1 -1
  359. data/spec/models/patch_bank_bank_model_spec.rb +1 -1
  360. data/spec/models/patch_customer_bank_model_spec.rb +1 -1
  361. data/spec/models/patch_deposit_address_bank_model_spec.rb +1 -1
  362. data/spec/models/patch_deposit_bank_account_bank_model_spec.rb +1 -1
  363. data/spec/models/patch_external_bank_account_bank_model_spec.rb +1 -1
  364. data/spec/models/patch_external_wallet_bank_model_spec.rb +1 -1
  365. data/spec/models/patch_transfer_bank_model_spec.rb +1 -1
  366. data/spec/models/patch_transfer_participant_bank_model_spec.rb +1 -1
  367. data/spec/models/payment_instruction_bank_model_spec.rb +1 -1
  368. data/spec/models/payment_instruction_list_bank_model_spec.rb +1 -1
  369. data/spec/models/payout_return_details_bank_model_spec.rb +1 -1
  370. data/spec/models/persona_session_bank_model_spec.rb +1 -1
  371. data/spec/models/physical_address_bank_model_spec.rb +1 -1
  372. data/spec/models/plan_bank_model_spec.rb +1 -1
  373. data/spec/models/plan_list_bank_model_spec.rb +1 -1
  374. data/spec/models/plan_reference_bank_model_spec.rb +1 -1
  375. data/spec/models/plan_travel_rule_info_bank_model_spec.rb +1 -1
  376. data/spec/models/platform_file_bank_model_spec.rb +1 -1
  377. data/spec/models/platform_file_list_bank_model_spec.rb +1 -1
  378. data/spec/models/post_account_bank_model_spec.rb +1 -1
  379. data/spec/models/post_bank_account_details_bank_model_spec.rb +1 -1
  380. data/spec/models/post_bank_bank_model_spec.rb +1 -1
  381. data/spec/models/post_counterparty_address_bank_model_spec.rb +1 -1
  382. data/spec/models/post_counterparty_aliases_inner_bank_model_spec.rb +1 -1
  383. data/spec/models/post_counterparty_bank_model_spec.rb +1 -1
  384. data/spec/models/post_counterparty_name_bank_model_spec.rb +1 -1
  385. data/spec/models/post_customer_address_bank_model_spec.rb +1 -1
  386. data/spec/models/post_customer_aliases_inner_bank_model_spec.rb +1 -1
  387. data/spec/models/post_customer_bank_model_spec.rb +1 -1
  388. data/spec/models/post_customer_name_bank_model_spec.rb +1 -1
  389. data/spec/models/post_deposit_address_bank_model_spec.rb +1 -1
  390. data/spec/models/post_deposit_bank_account_bank_model_spec.rb +1 -1
  391. data/spec/models/post_execution_bank_model_spec.rb +1 -1
  392. data/spec/models/post_external_bank_account_bank_model_spec.rb +1 -1
  393. data/spec/models/post_external_bank_account_counterparty_address_bank_model_spec.rb +1 -1
  394. data/spec/models/post_external_bank_account_counterparty_name_bank_model_spec.rb +1 -1
  395. data/spec/models/post_external_wallet_bank_model_spec.rb +1 -1
  396. data/spec/models/post_fee_bank_model_spec.rb +1 -1
  397. data/spec/models/post_file_bank_model_spec.rb +1 -1
  398. data/spec/models/post_file_metadata_bank_model_spec.rb +1 -1
  399. data/spec/models/post_identification_number_bank_model_spec.rb +1 -1
  400. data/spec/models/post_identity_verification_address_bank_model_spec.rb +1 -1
  401. data/spec/models/post_identity_verification_aliases_inner_bank_model_spec.rb +1 -1
  402. data/spec/models/post_identity_verification_bank_model_spec.rb +1 -1
  403. data/spec/models/post_identity_verification_name_bank_model_spec.rb +1 -1
  404. data/spec/models/post_identity_verification_registered_address_bank_model_spec.rb +1 -1
  405. data/spec/models/post_invoice_bank_model_spec.rb +1 -1
  406. data/spec/models/post_payment_instruction_bank_model_spec.rb +1 -1
  407. data/spec/models/post_persona_session_bank_model_spec.rb +1 -1
  408. data/spec/models/post_plan_bank_model_spec.rb +1 -1
  409. data/spec/models/post_plan_destination_account_bank_model_spec.rb +1 -1
  410. data/spec/models/post_plan_source_account_bank_model_spec.rb +1 -1
  411. data/spec/models/post_plan_travel_rule_info_bank_model_spec.rb +1 -1
  412. data/spec/models/post_quote_bank_model_spec.rb +1 -1
  413. data/spec/models/post_quote_entry_bank_model_spec.rb +1 -1
  414. data/spec/models/post_sardine_session_bank_model_spec.rb +1 -1
  415. data/spec/models/post_supported_payout_symbols_bank_model_spec.rb +1 -1
  416. data/spec/models/post_supporting_document_bank_model_spec.rb +1 -1
  417. data/spec/models/post_trade_bank_model_spec.rb +1 -1
  418. data/spec/models/post_transfer_bank_model_spec.rb +1 -1
  419. data/spec/models/post_transfer_participant_bank_model_spec.rb +1 -1
  420. data/spec/models/post_ultimate_beneficial_owner_bank_model_spec.rb +1 -1
  421. data/spec/models/post_workflow_bank_model_spec.rb +1 -1
  422. data/spec/models/quote_bank_model_spec.rb +1 -1
  423. data/spec/models/quote_entry_bank_model_spec.rb +1 -1
  424. data/spec/models/quote_entry_destination_account_bank_model_spec.rb +1 -1
  425. data/spec/models/quote_entry_source_account_bank_model_spec.rb +1 -1
  426. data/spec/models/quote_list_bank_model_spec.rb +1 -1
  427. data/spec/models/quote_side_bank_model_spec.rb +1 -1
  428. data/spec/models/quote_type_bank_model_spec.rb +1 -1
  429. data/spec/models/return_details_bank_model_spec.rb +1 -1
  430. data/spec/models/sardine_session_bank_model_spec.rb +1 -1
  431. data/spec/models/stage_bank_model_spec.rb +1 -1
  432. data/spec/models/stage_identifier_bank_model_spec.rb +1 -1
  433. data/spec/models/stage_link_bank_model_spec.rb +1 -1
  434. data/spec/models/supporting_document_bank_model_spec.rb +1 -1
  435. data/spec/models/supporting_document_file_bank_model_spec.rb +1 -1
  436. data/spec/models/symbol_price_bank_model_spec.rb +1 -1
  437. data/spec/models/trade_bank_model_spec.rb +1 -1
  438. data/spec/models/trade_failure_code_bank_model_spec.rb +1 -1
  439. data/spec/models/trade_list_bank_model_spec.rb +1 -1
  440. data/spec/models/trade_side_bank_model_spec.rb +1 -1
  441. data/spec/models/trade_state_bank_model_spec.rb +1 -1
  442. data/spec/models/trade_type_bank_model_spec.rb +1 -1
  443. data/spec/models/transaction_bank_model_spec.rb +98 -0
  444. data/spec/models/transaction_list_bank_model_spec.rb +40 -0
  445. data/spec/models/transaction_list_page_info_bank_model_spec.rb +34 -0
  446. data/spec/models/transaction_resource_bank_model_spec.rb +40 -0
  447. data/spec/models/transfer_account_type_bank_model_spec.rb +1 -1
  448. data/spec/models/transfer_bank_model_spec.rb +1 -1
  449. data/spec/models/transfer_destination_account_bank_model_spec.rb +1 -1
  450. data/spec/models/transfer_entry_bank_model_spec.rb +1 -1
  451. data/spec/models/transfer_entry_destination_account_bank_model_spec.rb +1 -1
  452. data/spec/models/transfer_failure_code_bank_model_spec.rb +1 -1
  453. data/spec/models/transfer_hold_details_bank_model_spec.rb +1 -1
  454. data/spec/models/transfer_identifiers_inner_bank_model_spec.rb +1 -1
  455. data/spec/models/transfer_list_bank_model_spec.rb +1 -1
  456. data/spec/models/transfer_participant_bank_model_spec.rb +1 -1
  457. data/spec/models/transfer_side_bank_model_spec.rb +1 -1
  458. data/spec/models/transfer_source_account_bank_model_spec.rb +1 -1
  459. data/spec/models/transfer_state_bank_model_spec.rb +1 -1
  460. data/spec/models/transfer_type_bank_model_spec.rb +1 -1
  461. data/spec/models/travel_rule_info_party_bank_model_spec.rb +1 -1
  462. data/spec/models/workflow_bank_model_spec.rb +1 -1
  463. data/spec/models/workflow_state_bank_model_spec.rb +1 -1
  464. data/spec/models/workflow_type_bank_model_spec.rb +1 -1
  465. data/spec/models/workflow_with_details_all_of_bank_model_spec.rb +1 -1
  466. data/spec/models/workflow_with_details_bank_model_spec.rb +1 -1
  467. data/spec/models/workflows_list_bank_model_spec.rb +1 -1
  468. data/spec/spec_helper.rb +1 -1
  469. data/vendor/bundle/ruby/4.0.0/extensions/x86_64-linux/4.0.0/byebug-13.0.0/gem_make.out +5 -5
  470. data/vendor/bundle/ruby/4.0.0/extensions/x86_64-linux/4.0.0/date-3.5.1/gem_make.out +5 -5
  471. data/vendor/bundle/ruby/4.0.0/extensions/x86_64-linux/4.0.0/io-console-0.9.2/gem_make.out +5 -5
  472. data/vendor/bundle/ruby/4.0.0/extensions/x86_64-linux/4.0.0/jaro_winkler-1.5.6/gem_make.out +5 -5
  473. data/vendor/bundle/ruby/4.0.0/extensions/x86_64-linux/4.0.0/psych-5.5.0/gem_make.out +5 -5
  474. data/vendor/bundle/ruby/4.0.0/extensions/x86_64-linux/4.0.0/racc-1.8.1/gem_make.out +5 -5
  475. data/vendor/bundle/ruby/4.0.0/extensions/x86_64-linux/4.0.0/stringio-3.2.0/gem_make.out +5 -5
  476. metadata +25 -1
@@ -0,0 +1,240 @@
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 bank_applications:write bank_applications:execute 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 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 organization_applications:write organization_applications:execute banks:read banks:write banks:execute bank_applications:read bank_applications:write bank_applications:execute users:read users:write users:execute 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 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) | | Customer | customers:read (Organization, Bank, Customer) | customers:write (Bank, Customer) | customers:execute (Bank) | | Counterparty | counterparties:read (Organization, Bank, Customer) | counterparties:write (Bank, Customer) | counterparties:execute (Bank) | | Deposit Address | deposit_addresses:read (Organization, Bank, Customer) | deposit_addresses:write (Bank, Customer) | deposit_addresses:execute (Bank, Customer) | | External Bank Account | external_bank_accounts:read (Organization, Bank, Customer) | external_bank_accounts:write (Bank, Customer) | external_bank_accounts:execute (Bank, Customer) | | External Wallet | external_wallet:read (Organization, Bank, Customer) | | external_wallet:execute (Bank, Customer) | | Organization | organizations:read (Organization) | organizations:write (Organization) | | | User | users:read (Organization) | | users:execute (Organization) | | Price | prices:read (Bank, Customer) | | | | Quote | quotes:read (Organization, Bank, Customer) | | quotes:execute (Organization, Bank, Customer) | | Trade | trades:read (Organization, Bank, Customer) | | trades:execute (Organization, Bank, Customer) | | Transfer | transfers:read (Organization, Bank, Customer) | | transfers:execute (Organization, Bank, Customer) | | Workflow | workflows:read (Organization, Bank, Customer) | | workflows:execute (Bank, Customer) | | Invoice | invoices:read (Organization, Bank, Customer) | invoices:write (Bank, Customer) | invoices:execute (Bank, Customer) | ## Available Endpoints The available APIs for the [Identity](https://id.production.cybrid.app/api/schema/swagger-ui), [Organization](https://organization.production.cybrid.app/api/schema/swagger-ui) and [Bank](https://bank.production.cybrid.app/api/schema/swagger-ui) API services are listed below: | API Service | Model | API Endpoint Path | Description | |--------------|----------------------|--------------------------------|---------------------------------------------------------------------------------------------------| | Identity | Bank | /api/bank_applications | Create and list banks | | Identity | CustomerToken | /api/customer_tokens | Create customer JWT access tokens | | Identity | Organization | /api/organization_applications | Create and list organizations | | Identity | Organization | /api/users | Create and list organization users | | Organization | Organization | /api/organizations | APIs to retrieve and update organization name | | Bank | Account | /api/accounts | Create and list accounts, which hold a specific asset for a customers | | Bank | Asset | /api/assets | Get a list of assets supported by the platform (ex: BTC, ETH) | | Bank | Bank | /api/banks | Create, update and list banks, the parent to customers, accounts, etc | | Bank | Customer | /api/customers | Create and list customers | | Bank | Counterparty | /api/counterparties | Create and list counterparties | | Bank | DepositAddress | /api/deposit_addresses | Create, get and list deposit addresses | | Bank | ExternalBankAccount | /api/external_bank_accounts | Create, get and list external bank accounts, which connect customer bank accounts to the platform | | Bank | ExternalWallet | /api/external_wallets | Create, get, list and delete external wallets, which connect customer wallets to the platform | | Bank | IdentityVerification | /api/identity_verifications | Create and list identity verifications, which are performed on customers for KYC | | Bank | Invoice | /api/invoices | Create, get, cancel and list invoices | | Bank | PaymentInstruction | /api/payment_instructions | Create, get and list payment instructions for invoices | | Bank | Price | /api/prices | Get the current prices for assets on the platform | | Bank | Quote | /api/quotes | Create and list quotes, which are required to execute trades | | Bank | Symbol | /api/symbols | Get a list of symbols supported for trade (ex: BTC-USD) | | Bank | Trade | /api/trades | Create and list trades, which buy or sell cryptocurrency | | Bank | Transfer | /api/transfers | Create, get and list transfers (e.g., funding, book) | | Bank | Workflow | /api/workflows | Create, get and list workflows | ## Understanding Object Models & Endpoints **Organizations** An `Organization` is meant to represent the organization partnering with Cybrid to use our platform. An `Organization` typically does not directly interact with `customers`. Instead, an Organization has one or more `banks`, which encompass the financial service offerings of the platform. **Banks** A `Bank` is owned by an `Organization` and can be thought of as an environment or container for `customers` and product offerings. Banks are created in either `Sandbox` or `Production` mode, where `Sandbox` is the environment that you would test, prototype and build in prior to moving to `Production`. An `Organization` can have multiple `banks`, in either `Sandbox` or `Production` environments. A `Sandbox Bank` will be backed by stubbed data and process flows. For instance, funding source transfer processes as well as trades will be simulated rather than performed, however asset prices are representative of real-world values. You have an unlimited amount of simulated fiat currency for testing purposes. **Customers** `Customers` represent your banking users on the platform. At present, we offer support for `Individuals` as Customers. `Customers` must be verified (i.e., KYC'd) in our system before they can play any part on the platform, which means they must have an associated and a passing `Identity Verification`. See the Identity Verifications section for more details on how a customer can be verified. `Customers` must also have an `Account` to be able to transact, in the desired asset class. See the Accounts APIs for more details on setting up accounts for the customer.
5
+
6
+ The version of the OpenAPI document: v0.129.1031
7
+ Contact: support@cybrid.app
8
+ Generated by: https://openapi-generator.tech
9
+ OpenAPI Generator version: 6.0.0
10
+
11
+ =end
12
+
13
+ require 'date'
14
+ require 'time'
15
+
16
+ module CybridApiBank
17
+ class TransactionListBankModel
18
+ attr_accessor :page_info
19
+
20
+ attr_accessor :objects
21
+
22
+ # Attribute mapping from ruby-style variable name to JSON key.
23
+ def self.attribute_map
24
+ {
25
+ :'page_info' => :'page_info',
26
+ :'objects' => :'objects'
27
+ }
28
+ end
29
+
30
+ # Returns all the JSON keys this model knows about
31
+ def self.acceptable_attributes
32
+ attribute_map.values
33
+ end
34
+
35
+ # Attribute type mapping.
36
+ def self.openapi_types
37
+ {
38
+ :'page_info' => :'TransactionListPageInfoBankModel',
39
+ :'objects' => :'Array<TransactionBankModel>'
40
+ }
41
+ end
42
+
43
+ # List of attributes with nullable: true
44
+ def self.openapi_nullable
45
+ Set.new([
46
+ ])
47
+ end
48
+
49
+ # Initializes the object
50
+ # @param [Hash] attributes Model attributes in the form of hash
51
+ def initialize(attributes = {})
52
+ if (!attributes.is_a?(Hash))
53
+ fail ArgumentError, "The input argument (attributes) must be a hash in `CybridApiBank::TransactionListBankModel` initialize method"
54
+ end
55
+
56
+ # check to see if the attribute exists and convert string to symbol for hash key
57
+ attributes = attributes.each_with_object({}) { |(k, v), h|
58
+ if (!self.class.attribute_map.key?(k.to_sym))
59
+ fail ArgumentError, "`#{k}` is not a valid attribute in `CybridApiBank::TransactionListBankModel`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
60
+ end
61
+ h[k.to_sym] = v
62
+ }
63
+
64
+ if attributes.key?(:'page_info')
65
+ self.page_info = attributes[:'page_info']
66
+ end
67
+
68
+ if attributes.key?(:'objects')
69
+ if (value = attributes[:'objects']).is_a?(Array)
70
+ self.objects = value
71
+ end
72
+ end
73
+ end
74
+
75
+ # Show invalid properties with the reasons. Usually used together with valid?
76
+ # @return Array for valid properties with the reasons
77
+ def list_invalid_properties
78
+ invalid_properties = Array.new
79
+ if @page_info.nil?
80
+ invalid_properties.push('invalid value for "page_info", page_info cannot be nil.')
81
+ end
82
+
83
+ if @objects.nil?
84
+ invalid_properties.push('invalid value for "objects", objects cannot be nil.')
85
+ end
86
+
87
+ invalid_properties
88
+ end
89
+
90
+ # Check to see if the all the properties in the model are valid
91
+ # @return true if the model is valid
92
+ def valid?
93
+ return false if @page_info.nil?
94
+ return false if @objects.nil?
95
+ true
96
+ end
97
+
98
+ # Checks equality by comparing each attribute.
99
+ # @param [Object] Object to be compared
100
+ def ==(o)
101
+ return true if self.equal?(o)
102
+ self.class == o.class &&
103
+ page_info == o.page_info &&
104
+ objects == o.objects
105
+ end
106
+
107
+ # @see the `==` method
108
+ # @param [Object] Object to be compared
109
+ def eql?(o)
110
+ self == o
111
+ end
112
+
113
+ # Calculates hash code according to all attributes.
114
+ # @return [Integer] Hash code
115
+ def hash
116
+ [page_info, objects].hash
117
+ end
118
+
119
+ # Builds the object from hash
120
+ # @param [Hash] attributes Model attributes in the form of hash
121
+ # @return [Object] Returns the model itself
122
+ def self.build_from_hash(attributes)
123
+ new.build_from_hash(attributes)
124
+ end
125
+
126
+ # Builds the object from hash
127
+ # @param [Hash] attributes Model attributes in the form of hash
128
+ # @return [Object] Returns the model itself
129
+ def build_from_hash(attributes)
130
+ return nil unless attributes.is_a?(Hash)
131
+ attributes = attributes.transform_keys(&:to_sym)
132
+ self.class.openapi_types.each_pair do |key, type|
133
+ if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
134
+ self.send("#{key}=", nil)
135
+ elsif type =~ /\AArray<(.*)>/i
136
+ # check to ensure the input is an array given that the attribute
137
+ # is documented as an array but the input is not
138
+ if attributes[self.class.attribute_map[key]].is_a?(Array)
139
+ self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
140
+ end
141
+ elsif !attributes[self.class.attribute_map[key]].nil?
142
+ self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
143
+ end
144
+ end
145
+
146
+ self
147
+ end
148
+
149
+ # Deserializes the data based on type
150
+ # @param string type Data type
151
+ # @param string value Value to be deserialized
152
+ # @return [Object] Deserialized data
153
+ def _deserialize(type, value)
154
+ case type.to_sym
155
+ when :Time
156
+ Time.parse(value)
157
+ when :Date
158
+ Date.parse(value)
159
+ when :String
160
+ value.to_s
161
+ when :Integer
162
+ value.to_i
163
+ when :Float
164
+ value.to_f
165
+ when :Boolean
166
+ if value.to_s =~ /\A(true|t|yes|y|1)\z/i
167
+ true
168
+ else
169
+ false
170
+ end
171
+ when :Object
172
+ # generic object (usually a Hash), return directly
173
+ value
174
+ when /\AArray<(?<inner_type>.+)>\z/
175
+ inner_type = Regexp.last_match[:inner_type]
176
+ value.map { |v| _deserialize(inner_type, v) }
177
+ when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
178
+ k_type = Regexp.last_match[:k_type]
179
+ v_type = Regexp.last_match[:v_type]
180
+ {}.tap do |hash|
181
+ value.each do |k, v|
182
+ hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
183
+ end
184
+ end
185
+ else # model
186
+ # models (e.g. Pet) or oneOf
187
+ klass = CybridApiBank.const_get(type)
188
+ klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
189
+ end
190
+ end
191
+
192
+ # Returns the string representation of the object
193
+ # @return [String] String presentation of the object
194
+ def to_s
195
+ to_hash.to_s
196
+ end
197
+
198
+ # to_body is an alias to to_hash (backward compatibility)
199
+ # @return [Hash] Returns the object in the form of hash
200
+ def to_body
201
+ to_hash
202
+ end
203
+
204
+ # Returns the object in the form of hash
205
+ # @return [Hash] Returns the object in the form of hash
206
+ def to_hash
207
+ hash = {}
208
+ self.class.attribute_map.each_pair do |attr, param|
209
+ value = self.send(attr)
210
+ if value.nil?
211
+ is_nullable = self.class.openapi_nullable.include?(attr)
212
+ next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
213
+ end
214
+
215
+ hash[param] = _to_hash(value)
216
+ end
217
+ hash
218
+ end
219
+
220
+ # Outputs non-array value in the form of hash
221
+ # For object, use to_hash. Otherwise, just return the value
222
+ # @param [Object] value Any valid value
223
+ # @return [Hash] Returns the value in the form of hash
224
+ def _to_hash(value)
225
+ if value.is_a?(Array)
226
+ value.compact.map { |v| _to_hash(v) }
227
+ elsif value.is_a?(Hash)
228
+ {}.tap do |hash|
229
+ value.each { |k, v| hash[k] = _to_hash(v) }
230
+ end
231
+ elsif value.respond_to? :to_hash
232
+ value.to_hash
233
+ else
234
+ value
235
+ end
236
+ end
237
+
238
+ end
239
+
240
+ end
@@ -0,0 +1,221 @@
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 bank_applications:write bank_applications:execute 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 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 organization_applications:write organization_applications:execute banks:read banks:write banks:execute bank_applications:read bank_applications:write bank_applications:execute users:read users:write users:execute 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 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) | | Customer | customers:read (Organization, Bank, Customer) | customers:write (Bank, Customer) | customers:execute (Bank) | | Counterparty | counterparties:read (Organization, Bank, Customer) | counterparties:write (Bank, Customer) | counterparties:execute (Bank) | | Deposit Address | deposit_addresses:read (Organization, Bank, Customer) | deposit_addresses:write (Bank, Customer) | deposit_addresses:execute (Bank, Customer) | | External Bank Account | external_bank_accounts:read (Organization, Bank, Customer) | external_bank_accounts:write (Bank, Customer) | external_bank_accounts:execute (Bank, Customer) | | External Wallet | external_wallet:read (Organization, Bank, Customer) | | external_wallet:execute (Bank, Customer) | | Organization | organizations:read (Organization) | organizations:write (Organization) | | | User | users:read (Organization) | | users:execute (Organization) | | Price | prices:read (Bank, Customer) | | | | Quote | quotes:read (Organization, Bank, Customer) | | quotes:execute (Organization, Bank, Customer) | | Trade | trades:read (Organization, Bank, Customer) | | trades:execute (Organization, Bank, Customer) | | Transfer | transfers:read (Organization, Bank, Customer) | | transfers:execute (Organization, Bank, Customer) | | Workflow | workflows:read (Organization, Bank, Customer) | | workflows:execute (Bank, Customer) | | Invoice | invoices:read (Organization, Bank, Customer) | invoices:write (Bank, Customer) | invoices:execute (Bank, Customer) | ## Available Endpoints The available APIs for the [Identity](https://id.production.cybrid.app/api/schema/swagger-ui), [Organization](https://organization.production.cybrid.app/api/schema/swagger-ui) and [Bank](https://bank.production.cybrid.app/api/schema/swagger-ui) API services are listed below: | API Service | Model | API Endpoint Path | Description | |--------------|----------------------|--------------------------------|---------------------------------------------------------------------------------------------------| | Identity | Bank | /api/bank_applications | Create and list banks | | Identity | CustomerToken | /api/customer_tokens | Create customer JWT access tokens | | Identity | Organization | /api/organization_applications | Create and list organizations | | Identity | Organization | /api/users | Create and list organization users | | Organization | Organization | /api/organizations | APIs to retrieve and update organization name | | Bank | Account | /api/accounts | Create and list accounts, which hold a specific asset for a customers | | Bank | Asset | /api/assets | Get a list of assets supported by the platform (ex: BTC, ETH) | | Bank | Bank | /api/banks | Create, update and list banks, the parent to customers, accounts, etc | | Bank | Customer | /api/customers | Create and list customers | | Bank | Counterparty | /api/counterparties | Create and list counterparties | | Bank | DepositAddress | /api/deposit_addresses | Create, get and list deposit addresses | | Bank | ExternalBankAccount | /api/external_bank_accounts | Create, get and list external bank accounts, which connect customer bank accounts to the platform | | Bank | ExternalWallet | /api/external_wallets | Create, get, list and delete external wallets, which connect customer wallets to the platform | | Bank | IdentityVerification | /api/identity_verifications | Create and list identity verifications, which are performed on customers for KYC | | Bank | Invoice | /api/invoices | Create, get, cancel and list invoices | | Bank | PaymentInstruction | /api/payment_instructions | Create, get and list payment instructions for invoices | | Bank | Price | /api/prices | Get the current prices for assets on the platform | | Bank | Quote | /api/quotes | Create and list quotes, which are required to execute trades | | Bank | Symbol | /api/symbols | Get a list of symbols supported for trade (ex: BTC-USD) | | Bank | Trade | /api/trades | Create and list trades, which buy or sell cryptocurrency | | Bank | Transfer | /api/transfers | Create, get and list transfers (e.g., funding, book) | | Bank | Workflow | /api/workflows | Create, get and list workflows | ## Understanding Object Models & Endpoints **Organizations** An `Organization` is meant to represent the organization partnering with Cybrid to use our platform. An `Organization` typically does not directly interact with `customers`. Instead, an Organization has one or more `banks`, which encompass the financial service offerings of the platform. **Banks** A `Bank` is owned by an `Organization` and can be thought of as an environment or container for `customers` and product offerings. Banks are created in either `Sandbox` or `Production` mode, where `Sandbox` is the environment that you would test, prototype and build in prior to moving to `Production`. An `Organization` can have multiple `banks`, in either `Sandbox` or `Production` environments. A `Sandbox Bank` will be backed by stubbed data and process flows. For instance, funding source transfer processes as well as trades will be simulated rather than performed, however asset prices are representative of real-world values. You have an unlimited amount of simulated fiat currency for testing purposes. **Customers** `Customers` represent your banking users on the platform. At present, we offer support for `Individuals` as Customers. `Customers` must be verified (i.e., KYC'd) in our system before they can play any part on the platform, which means they must have an associated and a passing `Identity Verification`. See the Identity Verifications section for more details on how a customer can be verified. `Customers` must also have an `Account` to be able to transact, in the desired asset class. See the Accounts APIs for more details on setting up accounts for the customer.
5
+
6
+ The version of the OpenAPI document: v0.129.1031
7
+ Contact: support@cybrid.app
8
+ Generated by: https://openapi-generator.tech
9
+ OpenAPI Generator version: 6.0.0
10
+
11
+ =end
12
+
13
+ require 'date'
14
+ require 'time'
15
+
16
+ module CybridApiBank
17
+ class TransactionListPageInfoBankModel
18
+ # The cursor to retrieve the next page of records, or null if there is none.
19
+ attr_accessor :next_cursor
20
+
21
+ # Attribute mapping from ruby-style variable name to JSON key.
22
+ def self.attribute_map
23
+ {
24
+ :'next_cursor' => :'next_cursor'
25
+ }
26
+ end
27
+
28
+ # Returns all the JSON keys this model knows about
29
+ def self.acceptable_attributes
30
+ attribute_map.values
31
+ end
32
+
33
+ # Attribute type mapping.
34
+ def self.openapi_types
35
+ {
36
+ :'next_cursor' => :'String'
37
+ }
38
+ end
39
+
40
+ # List of attributes with nullable: true
41
+ def self.openapi_nullable
42
+ Set.new([
43
+ :'next_cursor'
44
+ ])
45
+ end
46
+
47
+ # Initializes the object
48
+ # @param [Hash] attributes Model attributes in the form of hash
49
+ def initialize(attributes = {})
50
+ if (!attributes.is_a?(Hash))
51
+ fail ArgumentError, "The input argument (attributes) must be a hash in `CybridApiBank::TransactionListPageInfoBankModel` initialize method"
52
+ end
53
+
54
+ # check to see if the attribute exists and convert string to symbol for hash key
55
+ attributes = attributes.each_with_object({}) { |(k, v), h|
56
+ if (!self.class.attribute_map.key?(k.to_sym))
57
+ fail ArgumentError, "`#{k}` is not a valid attribute in `CybridApiBank::TransactionListPageInfoBankModel`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
58
+ end
59
+ h[k.to_sym] = v
60
+ }
61
+
62
+ if attributes.key?(:'next_cursor')
63
+ self.next_cursor = attributes[:'next_cursor']
64
+ end
65
+ end
66
+
67
+ # Show invalid properties with the reasons. Usually used together with valid?
68
+ # @return Array for valid properties with the reasons
69
+ def list_invalid_properties
70
+ invalid_properties = Array.new
71
+ invalid_properties
72
+ end
73
+
74
+ # Check to see if the all the properties in the model are valid
75
+ # @return true if the model is valid
76
+ def valid?
77
+ true
78
+ end
79
+
80
+ # Checks equality by comparing each attribute.
81
+ # @param [Object] Object to be compared
82
+ def ==(o)
83
+ return true if self.equal?(o)
84
+ self.class == o.class &&
85
+ next_cursor == o.next_cursor
86
+ end
87
+
88
+ # @see the `==` method
89
+ # @param [Object] Object to be compared
90
+ def eql?(o)
91
+ self == o
92
+ end
93
+
94
+ # Calculates hash code according to all attributes.
95
+ # @return [Integer] Hash code
96
+ def hash
97
+ [next_cursor].hash
98
+ end
99
+
100
+ # Builds the object from hash
101
+ # @param [Hash] attributes Model attributes in the form of hash
102
+ # @return [Object] Returns the model itself
103
+ def self.build_from_hash(attributes)
104
+ new.build_from_hash(attributes)
105
+ end
106
+
107
+ # Builds the object from hash
108
+ # @param [Hash] attributes Model attributes in the form of hash
109
+ # @return [Object] Returns the model itself
110
+ def build_from_hash(attributes)
111
+ return nil unless attributes.is_a?(Hash)
112
+ attributes = attributes.transform_keys(&:to_sym)
113
+ self.class.openapi_types.each_pair do |key, type|
114
+ if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
115
+ self.send("#{key}=", nil)
116
+ elsif type =~ /\AArray<(.*)>/i
117
+ # check to ensure the input is an array given that the attribute
118
+ # is documented as an array but the input is not
119
+ if attributes[self.class.attribute_map[key]].is_a?(Array)
120
+ self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
121
+ end
122
+ elsif !attributes[self.class.attribute_map[key]].nil?
123
+ self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
124
+ end
125
+ end
126
+
127
+ self
128
+ end
129
+
130
+ # Deserializes the data based on type
131
+ # @param string type Data type
132
+ # @param string value Value to be deserialized
133
+ # @return [Object] Deserialized data
134
+ def _deserialize(type, value)
135
+ case type.to_sym
136
+ when :Time
137
+ Time.parse(value)
138
+ when :Date
139
+ Date.parse(value)
140
+ when :String
141
+ value.to_s
142
+ when :Integer
143
+ value.to_i
144
+ when :Float
145
+ value.to_f
146
+ when :Boolean
147
+ if value.to_s =~ /\A(true|t|yes|y|1)\z/i
148
+ true
149
+ else
150
+ false
151
+ end
152
+ when :Object
153
+ # generic object (usually a Hash), return directly
154
+ value
155
+ when /\AArray<(?<inner_type>.+)>\z/
156
+ inner_type = Regexp.last_match[:inner_type]
157
+ value.map { |v| _deserialize(inner_type, v) }
158
+ when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
159
+ k_type = Regexp.last_match[:k_type]
160
+ v_type = Regexp.last_match[:v_type]
161
+ {}.tap do |hash|
162
+ value.each do |k, v|
163
+ hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
164
+ end
165
+ end
166
+ else # model
167
+ # models (e.g. Pet) or oneOf
168
+ klass = CybridApiBank.const_get(type)
169
+ klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
170
+ end
171
+ end
172
+
173
+ # Returns the string representation of the object
174
+ # @return [String] String presentation of the object
175
+ def to_s
176
+ to_hash.to_s
177
+ end
178
+
179
+ # to_body is an alias to to_hash (backward compatibility)
180
+ # @return [Hash] Returns the object in the form of hash
181
+ def to_body
182
+ to_hash
183
+ end
184
+
185
+ # Returns the object in the form of hash
186
+ # @return [Hash] Returns the object in the form of hash
187
+ def to_hash
188
+ hash = {}
189
+ self.class.attribute_map.each_pair do |attr, param|
190
+ value = self.send(attr)
191
+ if value.nil?
192
+ is_nullable = self.class.openapi_nullable.include?(attr)
193
+ next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
194
+ end
195
+
196
+ hash[param] = _to_hash(value)
197
+ end
198
+ hash
199
+ end
200
+
201
+ # Outputs non-array value in the form of hash
202
+ # For object, use to_hash. Otherwise, just return the value
203
+ # @param [Object] value Any valid value
204
+ # @return [Hash] Returns the value in the form of hash
205
+ def _to_hash(value)
206
+ if value.is_a?(Array)
207
+ value.compact.map { |v| _to_hash(v) }
208
+ elsif value.is_a?(Hash)
209
+ {}.tap do |hash|
210
+ value.each { |k, v| hash[k] = _to_hash(v) }
211
+ end
212
+ elsif value.respond_to? :to_hash
213
+ value.to_hash
214
+ else
215
+ value
216
+ end
217
+ end
218
+
219
+ end
220
+
221
+ end