cybrid_api_bank_ruby 0.121.10 → 0.121.12

Sign up to get free protection for your applications and to get access to all the features.
Files changed (350) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile.lock +1 -1
  3. data/README.md +5 -5
  4. data/cybrid_api_bank_ruby.gemspec +1 -1
  5. data/docs/BanksBankApi.md +1 -1
  6. data/docs/CounterpartiesBankApi.md +1 -1
  7. data/docs/CounterpartyAddressBankModel.md +1 -1
  8. data/docs/CustomerAddressBankModel.md +1 -1
  9. data/docs/DepositBankAccountCounterpartyAddressBankModel.md +1 -1
  10. data/docs/DepositBankAccountsBankApi.md +1 -1
  11. data/docs/ExternalBankAccountPiiInnerAddressesInnerBankModel.md +1 -1
  12. data/docs/ExternalBankAccountsBankApi.md +1 -1
  13. data/docs/IdentityVerificationWithDetailsPiiAddressBankModel.md +1 -1
  14. data/docs/IdentityVerificationsBankApi.md +1 -1
  15. data/docs/PatchBankBankModel.md +2 -2
  16. data/docs/PostAccountBankModel.md +1 -1
  17. data/docs/PostBankBankModel.md +9 -9
  18. data/docs/PostCounterpartyAliasesInnerBankModel.md +1 -1
  19. data/docs/PostCounterpartyBankModel.md +4 -4
  20. data/docs/PostCounterpartyNameBankModel.md +6 -6
  21. data/docs/PostCustomerAddressBankModel.md +6 -6
  22. data/docs/PostCustomerBankModel.md +5 -5
  23. data/docs/PostCustomerNameBankModel.md +3 -3
  24. data/docs/PostDepositBankAccountBankModel.md +3 -3
  25. data/docs/PostExternalBankAccountBankModel.md +11 -11
  26. data/docs/PostExternalBankAccountCounterpartyAddressBankModel.md +6 -6
  27. data/docs/PostExternalBankAccountCounterpartyBankAccountBankModel.md +3 -3
  28. data/docs/PostExternalBankAccountCounterpartyNameBankModel.md +4 -4
  29. data/docs/PostExternalWalletBankModel.md +1 -1
  30. data/docs/PostFeeBankModel.md +2 -2
  31. data/docs/PostIdentityVerificationAddressBankModel.md +6 -6
  32. data/docs/PostIdentityVerificationBankModel.md +13 -13
  33. data/docs/PostIdentityVerificationNameBankModel.md +4 -4
  34. data/docs/PostInvoiceBankModel.md +1 -1
  35. data/docs/PostQuoteBankModel.md +12 -12
  36. data/docs/PostTransferBankModel.md +24 -22
  37. data/docs/PostTransferParticipantBankModel.md +1 -1
  38. data/docs/PostWorkflowBankModel.md +7 -7
  39. data/lib/cybrid_api_bank_ruby/api/accounts_bank_api.rb +1 -1
  40. data/lib/cybrid_api_bank_ruby/api/assets_bank_api.rb +1 -1
  41. data/lib/cybrid_api_bank_ruby/api/banks_bank_api.rb +1 -1
  42. data/lib/cybrid_api_bank_ruby/api/counterparties_bank_api.rb +1 -1
  43. data/lib/cybrid_api_bank_ruby/api/customers_bank_api.rb +1 -1
  44. data/lib/cybrid_api_bank_ruby/api/deposit_addresses_bank_api.rb +1 -1
  45. data/lib/cybrid_api_bank_ruby/api/deposit_bank_accounts_bank_api.rb +1 -1
  46. data/lib/cybrid_api_bank_ruby/api/external_bank_accounts_bank_api.rb +1 -1
  47. data/lib/cybrid_api_bank_ruby/api/external_wallets_bank_api.rb +1 -1
  48. data/lib/cybrid_api_bank_ruby/api/identity_verifications_bank_api.rb +1 -1
  49. data/lib/cybrid_api_bank_ruby/api/invoices_bank_api.rb +1 -1
  50. data/lib/cybrid_api_bank_ruby/api/payment_instructions_bank_api.rb +1 -1
  51. data/lib/cybrid_api_bank_ruby/api/prices_bank_api.rb +1 -1
  52. data/lib/cybrid_api_bank_ruby/api/quotes_bank_api.rb +1 -1
  53. data/lib/cybrid_api_bank_ruby/api/symbols_bank_api.rb +1 -1
  54. data/lib/cybrid_api_bank_ruby/api/trades_bank_api.rb +1 -1
  55. data/lib/cybrid_api_bank_ruby/api/transfers_bank_api.rb +1 -1
  56. data/lib/cybrid_api_bank_ruby/api/workflows_bank_api.rb +1 -1
  57. data/lib/cybrid_api_bank_ruby/api_client.rb +1 -1
  58. data/lib/cybrid_api_bank_ruby/api_error.rb +1 -1
  59. data/lib/cybrid_api_bank_ruby/configuration.rb +1 -1
  60. data/lib/cybrid_api_bank_ruby/models/account_bank_model.rb +1 -1
  61. data/lib/cybrid_api_bank_ruby/models/account_list_bank_model.rb +1 -1
  62. data/lib/cybrid_api_bank_ruby/models/account_state_bank_model.rb +1 -1
  63. data/lib/cybrid_api_bank_ruby/models/account_type_bank_model.rb +1 -1
  64. data/lib/cybrid_api_bank_ruby/models/activity_limit_bank_model.rb +1 -1
  65. data/lib/cybrid_api_bank_ruby/models/activity_type_bank_model.rb +1 -1
  66. data/lib/cybrid_api_bank_ruby/models/asset_bank_model.rb +1 -1
  67. data/lib/cybrid_api_bank_ruby/models/asset_list_bank_model.rb +1 -1
  68. data/lib/cybrid_api_bank_ruby/models/asset_types_bank_model.rb +1 -1
  69. data/lib/cybrid_api_bank_ruby/models/bank_bank_model.rb +1 -1
  70. data/lib/cybrid_api_bank_ruby/models/bank_feature_bank_model.rb +1 -1
  71. data/lib/cybrid_api_bank_ruby/models/bank_list_bank_model.rb +1 -1
  72. data/lib/cybrid_api_bank_ruby/models/bank_type_bank_model.rb +1 -1
  73. data/lib/cybrid_api_bank_ruby/models/compliance_check_bank_model.rb +1 -1
  74. data/lib/cybrid_api_bank_ruby/models/compliance_check_outcome_bank_model.rb +1 -1
  75. data/lib/cybrid_api_bank_ruby/models/compliance_check_type_bank_model.rb +1 -1
  76. data/lib/cybrid_api_bank_ruby/models/compliance_decision_bank_model.rb +1 -1
  77. data/lib/cybrid_api_bank_ruby/models/compliance_decision_state_bank_model.rb +1 -1
  78. data/lib/cybrid_api_bank_ruby/models/compliance_decision_type_bank_model.rb +1 -1
  79. data/lib/cybrid_api_bank_ruby/models/counterparty_address_bank_model.rb +2 -2
  80. data/lib/cybrid_api_bank_ruby/models/counterparty_aliases_inner_bank_model.rb +1 -1
  81. data/lib/cybrid_api_bank_ruby/models/counterparty_bank_model.rb +1 -1
  82. data/lib/cybrid_api_bank_ruby/models/counterparty_list_bank_model.rb +1 -1
  83. data/lib/cybrid_api_bank_ruby/models/counterparty_name_bank_model.rb +1 -1
  84. data/lib/cybrid_api_bank_ruby/models/counterparty_state_bank_model.rb +1 -1
  85. data/lib/cybrid_api_bank_ruby/models/counterparty_type_bank_model.rb +1 -1
  86. data/lib/cybrid_api_bank_ruby/models/customer_address_bank_model.rb +2 -2
  87. data/lib/cybrid_api_bank_ruby/models/customer_aliases_inner_bank_model.rb +1 -1
  88. data/lib/cybrid_api_bank_ruby/models/customer_bank_model.rb +1 -1
  89. data/lib/cybrid_api_bank_ruby/models/customer_list_bank_model.rb +1 -1
  90. data/lib/cybrid_api_bank_ruby/models/customer_name_bank_model.rb +1 -1
  91. data/lib/cybrid_api_bank_ruby/models/customer_state_bank_model.rb +1 -1
  92. data/lib/cybrid_api_bank_ruby/models/customer_type_bank_model.rb +1 -1
  93. data/lib/cybrid_api_bank_ruby/models/deposit_address_bank_model.rb +1 -1
  94. data/lib/cybrid_api_bank_ruby/models/deposit_address_format_bank_model.rb +1 -1
  95. data/lib/cybrid_api_bank_ruby/models/deposit_address_list_bank_model.rb +1 -1
  96. data/lib/cybrid_api_bank_ruby/models/deposit_address_state_bank_model.rb +1 -1
  97. data/lib/cybrid_api_bank_ruby/models/deposit_bank_account_account_details_inner_bank_model.rb +1 -1
  98. data/lib/cybrid_api_bank_ruby/models/deposit_bank_account_bank_model.rb +1 -1
  99. data/lib/cybrid_api_bank_ruby/models/deposit_bank_account_counterparty_address_bank_model.rb +2 -2
  100. data/lib/cybrid_api_bank_ruby/models/deposit_bank_account_list_bank_model.rb +1 -1
  101. data/lib/cybrid_api_bank_ruby/models/deposit_bank_account_routing_details_inner_bank_model.rb +1 -1
  102. data/lib/cybrid_api_bank_ruby/models/deposit_bank_account_routing_number_type_bank_model.rb +1 -1
  103. data/lib/cybrid_api_bank_ruby/models/deposit_bank_account_state_bank_model.rb +1 -1
  104. data/lib/cybrid_api_bank_ruby/models/error_response_bank_model.rb +1 -1
  105. data/lib/cybrid_api_bank_ruby/models/external_bank_account_balances_bank_model.rb +1 -1
  106. data/lib/cybrid_api_bank_ruby/models/external_bank_account_bank_model.rb +1 -1
  107. data/lib/cybrid_api_bank_ruby/models/external_bank_account_kind_bank_model.rb +1 -1
  108. data/lib/cybrid_api_bank_ruby/models/external_bank_account_list_bank_model.rb +1 -1
  109. data/lib/cybrid_api_bank_ruby/models/external_bank_account_pii_inner_addresses_inner_bank_model.rb +2 -2
  110. data/lib/cybrid_api_bank_ruby/models/external_bank_account_pii_inner_bank_model.rb +1 -1
  111. data/lib/cybrid_api_bank_ruby/models/external_bank_account_pii_inner_routing_details_inner_bank_model.rb +1 -1
  112. data/lib/cybrid_api_bank_ruby/models/external_bank_account_state_bank_model.rb +1 -1
  113. data/lib/cybrid_api_bank_ruby/models/external_wallet_bank_model.rb +1 -1
  114. data/lib/cybrid_api_bank_ruby/models/external_wallet_environment_bank_model.rb +1 -1
  115. data/lib/cybrid_api_bank_ruby/models/external_wallet_list_bank_model.rb +1 -1
  116. data/lib/cybrid_api_bank_ruby/models/external_wallet_state_bank_model.rb +1 -1
  117. data/lib/cybrid_api_bank_ruby/models/identification_number_bank_model.rb +1 -1
  118. data/lib/cybrid_api_bank_ruby/models/identity_verification_bank_model.rb +1 -1
  119. data/lib/cybrid_api_bank_ruby/models/identity_verification_list_bank_model.rb +1 -1
  120. data/lib/cybrid_api_bank_ruby/models/identity_verification_method_bank_model.rb +1 -1
  121. data/lib/cybrid_api_bank_ruby/models/identity_verification_outcome_bank_model.rb +1 -1
  122. data/lib/cybrid_api_bank_ruby/models/identity_verification_persona_state_bank_model.rb +1 -1
  123. data/lib/cybrid_api_bank_ruby/models/identity_verification_state_bank_model.rb +1 -1
  124. data/lib/cybrid_api_bank_ruby/models/identity_verification_type_bank_model.rb +1 -1
  125. data/lib/cybrid_api_bank_ruby/models/identity_verification_with_details_bank_model.rb +1 -1
  126. data/lib/cybrid_api_bank_ruby/models/identity_verification_with_details_pii_address_bank_model.rb +2 -2
  127. data/lib/cybrid_api_bank_ruby/models/identity_verification_with_details_pii_bank_model.rb +1 -1
  128. data/lib/cybrid_api_bank_ruby/models/identity_verification_with_details_pii_name_bank_model.rb +1 -1
  129. data/lib/cybrid_api_bank_ruby/models/invoice_bank_model.rb +1 -1
  130. data/lib/cybrid_api_bank_ruby/models/invoice_list_bank_model.rb +1 -1
  131. data/lib/cybrid_api_bank_ruby/models/patch_bank_bank_model.rb +21 -3
  132. data/lib/cybrid_api_bank_ruby/models/patch_customer_bank_model.rb +3 -1
  133. data/lib/cybrid_api_bank_ruby/models/patch_external_bank_account_bank_model.rb +2 -1
  134. data/lib/cybrid_api_bank_ruby/models/payment_instruction_bank_model.rb +1 -1
  135. data/lib/cybrid_api_bank_ruby/models/payment_instruction_list_bank_model.rb +1 -1
  136. data/lib/cybrid_api_bank_ruby/models/post_account_bank_model.rb +18 -2
  137. data/lib/cybrid_api_bank_ruby/models/post_bank_bank_model.rb +88 -54
  138. data/lib/cybrid_api_bank_ruby/models/post_counterparty_address_bank_model.rb +2 -1
  139. data/lib/cybrid_api_bank_ruby/models/post_counterparty_aliases_inner_bank_model.rb +2 -2
  140. data/lib/cybrid_api_bank_ruby/models/post_counterparty_bank_model.rb +58 -14
  141. data/lib/cybrid_api_bank_ruby/models/post_counterparty_name_bank_model.rb +21 -20
  142. data/lib/cybrid_api_bank_ruby/models/post_customer_address_bank_model.rb +11 -22
  143. data/lib/cybrid_api_bank_ruby/models/post_customer_bank_model.rb +46 -6
  144. data/lib/cybrid_api_bank_ruby/models/post_customer_name_bank_model.rb +5 -4
  145. data/lib/cybrid_api_bank_ruby/models/post_deposit_address_bank_model.rb +17 -1
  146. data/lib/cybrid_api_bank_ruby/models/post_deposit_bank_account_bank_model.rb +24 -3
  147. data/lib/cybrid_api_bank_ruby/models/post_external_bank_account_bank_model.rb +25 -48
  148. data/lib/cybrid_api_bank_ruby/models/post_external_bank_account_counterparty_address_bank_model.rb +17 -33
  149. data/lib/cybrid_api_bank_ruby/models/post_external_bank_account_counterparty_bank_account_bank_model.rb +8 -20
  150. data/lib/cybrid_api_bank_ruby/models/post_external_bank_account_counterparty_name_bank_model.rb +9 -6
  151. data/lib/cybrid_api_bank_ruby/models/post_external_wallet_bank_model.rb +3 -2
  152. data/lib/cybrid_api_bank_ruby/models/post_fee_bank_model.rb +6 -3
  153. data/lib/cybrid_api_bank_ruby/models/post_identification_number_bank_model.rb +2 -1
  154. data/lib/cybrid_api_bank_ruby/models/post_identity_verification_address_bank_model.rb +11 -51
  155. data/lib/cybrid_api_bank_ruby/models/post_identity_verification_bank_model.rb +76 -130
  156. data/lib/cybrid_api_bank_ruby/models/post_identity_verification_name_bank_model.rb +6 -6
  157. data/lib/cybrid_api_bank_ruby/models/post_invoice_bank_model.rb +18 -2
  158. data/lib/cybrid_api_bank_ruby/models/post_payment_instruction_bank_model.rb +3 -10
  159. data/lib/cybrid_api_bank_ruby/models/post_quote_bank_model.rb +103 -44
  160. data/lib/cybrid_api_bank_ruby/models/post_trade_bank_model.rb +19 -1
  161. data/lib/cybrid_api_bank_ruby/models/post_transfer_bank_model.rb +193 -260
  162. data/lib/cybrid_api_bank_ruby/models/post_transfer_participant_bank_model.rb +3 -2
  163. data/lib/cybrid_api_bank_ruby/models/post_workflow_bank_model.rb +14 -53
  164. data/lib/cybrid_api_bank_ruby/models/quote_bank_model.rb +1 -1
  165. data/lib/cybrid_api_bank_ruby/models/quote_list_bank_model.rb +1 -1
  166. data/lib/cybrid_api_bank_ruby/models/quote_side_bank_model.rb +1 -1
  167. data/lib/cybrid_api_bank_ruby/models/quote_type_bank_model.rb +1 -1
  168. data/lib/cybrid_api_bank_ruby/models/symbol_price_bank_model.rb +1 -1
  169. data/lib/cybrid_api_bank_ruby/models/trade_bank_model.rb +1 -1
  170. data/lib/cybrid_api_bank_ruby/models/trade_failure_code_bank_model.rb +1 -1
  171. data/lib/cybrid_api_bank_ruby/models/trade_list_bank_model.rb +1 -1
  172. data/lib/cybrid_api_bank_ruby/models/trade_side_bank_model.rb +1 -1
  173. data/lib/cybrid_api_bank_ruby/models/trade_state_bank_model.rb +1 -1
  174. data/lib/cybrid_api_bank_ruby/models/trade_type_bank_model.rb +1 -1
  175. data/lib/cybrid_api_bank_ruby/models/transfer_account_type_bank_model.rb +1 -1
  176. data/lib/cybrid_api_bank_ruby/models/transfer_bank_model.rb +1 -1
  177. data/lib/cybrid_api_bank_ruby/models/transfer_destination_account_bank_model.rb +1 -1
  178. data/lib/cybrid_api_bank_ruby/models/transfer_failure_code_bank_model.rb +1 -1
  179. data/lib/cybrid_api_bank_ruby/models/transfer_list_bank_model.rb +1 -1
  180. data/lib/cybrid_api_bank_ruby/models/transfer_participant_bank_model.rb +1 -1
  181. data/lib/cybrid_api_bank_ruby/models/transfer_side_bank_model.rb +1 -1
  182. data/lib/cybrid_api_bank_ruby/models/transfer_source_account_bank_model.rb +1 -1
  183. data/lib/cybrid_api_bank_ruby/models/transfer_state_bank_model.rb +1 -1
  184. data/lib/cybrid_api_bank_ruby/models/transfer_type_bank_model.rb +1 -1
  185. data/lib/cybrid_api_bank_ruby/models/workflow_bank_model.rb +1 -1
  186. data/lib/cybrid_api_bank_ruby/models/workflow_state_bank_model.rb +1 -1
  187. data/lib/cybrid_api_bank_ruby/models/workflow_type_bank_model.rb +1 -1
  188. data/lib/cybrid_api_bank_ruby/models/workflow_with_details_all_of_bank_model.rb +1 -1
  189. data/lib/cybrid_api_bank_ruby/models/workflow_with_details_bank_model.rb +1 -1
  190. data/lib/cybrid_api_bank_ruby/models/workflows_list_bank_model.rb +1 -1
  191. data/lib/cybrid_api_bank_ruby/version.rb +2 -2
  192. data/lib/cybrid_api_bank_ruby.rb +1 -1
  193. data/spec/api/accounts_bank_api_spec.rb +1 -1
  194. data/spec/api/assets_bank_api_spec.rb +1 -1
  195. data/spec/api/banks_bank_api_spec.rb +1 -1
  196. data/spec/api/counterparties_bank_api_spec.rb +1 -1
  197. data/spec/api/customers_bank_api_spec.rb +1 -1
  198. data/spec/api/deposit_addresses_bank_api_spec.rb +1 -1
  199. data/spec/api/deposit_bank_accounts_bank_api_spec.rb +1 -1
  200. data/spec/api/external_bank_accounts_bank_api_spec.rb +1 -1
  201. data/spec/api/external_wallets_bank_api_spec.rb +1 -1
  202. data/spec/api/identity_verifications_bank_api_spec.rb +1 -1
  203. data/spec/api/invoices_bank_api_spec.rb +1 -1
  204. data/spec/api/payment_instructions_bank_api_spec.rb +1 -1
  205. data/spec/api/prices_bank_api_spec.rb +1 -1
  206. data/spec/api/quotes_bank_api_spec.rb +1 -1
  207. data/spec/api/symbols_bank_api_spec.rb +1 -1
  208. data/spec/api/trades_bank_api_spec.rb +1 -1
  209. data/spec/api/transfers_bank_api_spec.rb +1 -1
  210. data/spec/api/workflows_bank_api_spec.rb +1 -1
  211. data/spec/api_client_spec.rb +1 -1
  212. data/spec/configuration_spec.rb +1 -1
  213. data/spec/models/account_bank_model_spec.rb +1 -1
  214. data/spec/models/account_list_bank_model_spec.rb +1 -1
  215. data/spec/models/account_state_bank_model_spec.rb +1 -1
  216. data/spec/models/account_type_bank_model_spec.rb +1 -1
  217. data/spec/models/activity_limit_bank_model_spec.rb +1 -1
  218. data/spec/models/activity_type_bank_model_spec.rb +1 -1
  219. data/spec/models/asset_bank_model_spec.rb +1 -1
  220. data/spec/models/asset_list_bank_model_spec.rb +1 -1
  221. data/spec/models/asset_types_bank_model_spec.rb +1 -1
  222. data/spec/models/bank_bank_model_spec.rb +1 -1
  223. data/spec/models/bank_feature_bank_model_spec.rb +1 -1
  224. data/spec/models/bank_list_bank_model_spec.rb +1 -1
  225. data/spec/models/bank_type_bank_model_spec.rb +1 -1
  226. data/spec/models/compliance_check_bank_model_spec.rb +1 -1
  227. data/spec/models/compliance_check_outcome_bank_model_spec.rb +1 -1
  228. data/spec/models/compliance_check_type_bank_model_spec.rb +1 -1
  229. data/spec/models/compliance_decision_bank_model_spec.rb +1 -1
  230. data/spec/models/compliance_decision_state_bank_model_spec.rb +1 -1
  231. data/spec/models/compliance_decision_type_bank_model_spec.rb +1 -1
  232. data/spec/models/counterparty_address_bank_model_spec.rb +1 -1
  233. data/spec/models/counterparty_aliases_inner_bank_model_spec.rb +1 -1
  234. data/spec/models/counterparty_bank_model_spec.rb +1 -1
  235. data/spec/models/counterparty_list_bank_model_spec.rb +1 -1
  236. data/spec/models/counterparty_name_bank_model_spec.rb +1 -1
  237. data/spec/models/counterparty_state_bank_model_spec.rb +1 -1
  238. data/spec/models/counterparty_type_bank_model_spec.rb +1 -1
  239. data/spec/models/customer_address_bank_model_spec.rb +1 -1
  240. data/spec/models/customer_aliases_inner_bank_model_spec.rb +1 -1
  241. data/spec/models/customer_bank_model_spec.rb +1 -1
  242. data/spec/models/customer_list_bank_model_spec.rb +1 -1
  243. data/spec/models/customer_name_bank_model_spec.rb +1 -1
  244. data/spec/models/customer_state_bank_model_spec.rb +1 -1
  245. data/spec/models/customer_type_bank_model_spec.rb +1 -1
  246. data/spec/models/deposit_address_bank_model_spec.rb +1 -1
  247. data/spec/models/deposit_address_format_bank_model_spec.rb +1 -1
  248. data/spec/models/deposit_address_list_bank_model_spec.rb +1 -1
  249. data/spec/models/deposit_address_state_bank_model_spec.rb +1 -1
  250. data/spec/models/deposit_bank_account_account_details_inner_bank_model_spec.rb +1 -1
  251. data/spec/models/deposit_bank_account_bank_model_spec.rb +1 -1
  252. data/spec/models/deposit_bank_account_counterparty_address_bank_model_spec.rb +1 -1
  253. data/spec/models/deposit_bank_account_list_bank_model_spec.rb +1 -1
  254. data/spec/models/deposit_bank_account_routing_details_inner_bank_model_spec.rb +1 -1
  255. data/spec/models/deposit_bank_account_routing_number_type_bank_model_spec.rb +1 -1
  256. data/spec/models/deposit_bank_account_state_bank_model_spec.rb +1 -1
  257. data/spec/models/error_response_bank_model_spec.rb +1 -1
  258. data/spec/models/external_bank_account_balances_bank_model_spec.rb +1 -1
  259. data/spec/models/external_bank_account_bank_model_spec.rb +1 -1
  260. data/spec/models/external_bank_account_kind_bank_model_spec.rb +1 -1
  261. data/spec/models/external_bank_account_list_bank_model_spec.rb +1 -1
  262. data/spec/models/external_bank_account_pii_inner_addresses_inner_bank_model_spec.rb +1 -1
  263. data/spec/models/external_bank_account_pii_inner_bank_model_spec.rb +1 -1
  264. data/spec/models/external_bank_account_pii_inner_routing_details_inner_bank_model_spec.rb +1 -1
  265. data/spec/models/external_bank_account_state_bank_model_spec.rb +1 -1
  266. data/spec/models/external_wallet_bank_model_spec.rb +1 -1
  267. data/spec/models/external_wallet_environment_bank_model_spec.rb +1 -1
  268. data/spec/models/external_wallet_list_bank_model_spec.rb +1 -1
  269. data/spec/models/external_wallet_state_bank_model_spec.rb +1 -1
  270. data/spec/models/identification_number_bank_model_spec.rb +1 -1
  271. data/spec/models/identity_verification_bank_model_spec.rb +1 -1
  272. data/spec/models/identity_verification_list_bank_model_spec.rb +1 -1
  273. data/spec/models/identity_verification_method_bank_model_spec.rb +1 -1
  274. data/spec/models/identity_verification_outcome_bank_model_spec.rb +1 -1
  275. data/spec/models/identity_verification_persona_state_bank_model_spec.rb +1 -1
  276. data/spec/models/identity_verification_state_bank_model_spec.rb +1 -1
  277. data/spec/models/identity_verification_type_bank_model_spec.rb +1 -1
  278. data/spec/models/identity_verification_with_details_bank_model_spec.rb +1 -1
  279. data/spec/models/identity_verification_with_details_pii_address_bank_model_spec.rb +1 -1
  280. data/spec/models/identity_verification_with_details_pii_bank_model_spec.rb +1 -1
  281. data/spec/models/identity_verification_with_details_pii_name_bank_model_spec.rb +1 -1
  282. data/spec/models/invoice_bank_model_spec.rb +1 -1
  283. data/spec/models/invoice_list_bank_model_spec.rb +1 -1
  284. data/spec/models/patch_bank_bank_model_spec.rb +1 -1
  285. data/spec/models/patch_customer_bank_model_spec.rb +1 -1
  286. data/spec/models/patch_external_bank_account_bank_model_spec.rb +1 -1
  287. data/spec/models/payment_instruction_bank_model_spec.rb +1 -1
  288. data/spec/models/payment_instruction_list_bank_model_spec.rb +1 -1
  289. data/spec/models/post_account_bank_model_spec.rb +1 -1
  290. data/spec/models/post_bank_bank_model_spec.rb +13 -13
  291. data/spec/models/post_counterparty_address_bank_model_spec.rb +1 -1
  292. data/spec/models/post_counterparty_aliases_inner_bank_model_spec.rb +1 -1
  293. data/spec/models/post_counterparty_bank_model_spec.rb +3 -3
  294. data/spec/models/post_counterparty_name_bank_model_spec.rb +5 -5
  295. data/spec/models/post_customer_address_bank_model_spec.rb +1 -1
  296. data/spec/models/post_customer_bank_model_spec.rb +1 -1
  297. data/spec/models/post_customer_name_bank_model_spec.rb +1 -1
  298. data/spec/models/post_deposit_address_bank_model_spec.rb +1 -1
  299. data/spec/models/post_deposit_bank_account_bank_model_spec.rb +1 -1
  300. data/spec/models/post_external_bank_account_bank_model_spec.rb +6 -6
  301. data/spec/models/post_external_bank_account_counterparty_address_bank_model_spec.rb +1 -1
  302. data/spec/models/post_external_bank_account_counterparty_bank_account_bank_model_spec.rb +1 -1
  303. data/spec/models/post_external_bank_account_counterparty_name_bank_model_spec.rb +1 -1
  304. data/spec/models/post_external_wallet_bank_model_spec.rb +1 -1
  305. data/spec/models/post_fee_bank_model_spec.rb +1 -1
  306. data/spec/models/post_identification_number_bank_model_spec.rb +1 -1
  307. data/spec/models/post_identity_verification_address_bank_model_spec.rb +1 -1
  308. data/spec/models/post_identity_verification_bank_model_spec.rb +19 -19
  309. data/spec/models/post_identity_verification_name_bank_model_spec.rb +1 -1
  310. data/spec/models/post_invoice_bank_model_spec.rb +1 -1
  311. data/spec/models/post_payment_instruction_bank_model_spec.rb +1 -1
  312. data/spec/models/post_quote_bank_model_spec.rb +12 -8
  313. data/spec/models/post_trade_bank_model_spec.rb +1 -1
  314. data/spec/models/post_transfer_bank_model_spec.rb +23 -13
  315. data/spec/models/post_transfer_participant_bank_model_spec.rb +1 -1
  316. data/spec/models/post_workflow_bank_model_spec.rb +1 -1
  317. data/spec/models/quote_bank_model_spec.rb +1 -1
  318. data/spec/models/quote_list_bank_model_spec.rb +1 -1
  319. data/spec/models/quote_side_bank_model_spec.rb +1 -1
  320. data/spec/models/quote_type_bank_model_spec.rb +1 -1
  321. data/spec/models/symbol_price_bank_model_spec.rb +1 -1
  322. data/spec/models/trade_bank_model_spec.rb +1 -1
  323. data/spec/models/trade_failure_code_bank_model_spec.rb +1 -1
  324. data/spec/models/trade_list_bank_model_spec.rb +1 -1
  325. data/spec/models/trade_side_bank_model_spec.rb +1 -1
  326. data/spec/models/trade_state_bank_model_spec.rb +1 -1
  327. data/spec/models/trade_type_bank_model_spec.rb +1 -1
  328. data/spec/models/transfer_account_type_bank_model_spec.rb +1 -1
  329. data/spec/models/transfer_bank_model_spec.rb +1 -1
  330. data/spec/models/transfer_destination_account_bank_model_spec.rb +1 -1
  331. data/spec/models/transfer_failure_code_bank_model_spec.rb +1 -1
  332. data/spec/models/transfer_list_bank_model_spec.rb +1 -1
  333. data/spec/models/transfer_participant_bank_model_spec.rb +1 -1
  334. data/spec/models/transfer_side_bank_model_spec.rb +1 -1
  335. data/spec/models/transfer_source_account_bank_model_spec.rb +1 -1
  336. data/spec/models/transfer_state_bank_model_spec.rb +1 -1
  337. data/spec/models/transfer_type_bank_model_spec.rb +1 -1
  338. data/spec/models/workflow_bank_model_spec.rb +1 -1
  339. data/spec/models/workflow_state_bank_model_spec.rb +1 -1
  340. data/spec/models/workflow_type_bank_model_spec.rb +1 -1
  341. data/spec/models/workflow_with_details_all_of_bank_model_spec.rb +1 -1
  342. data/spec/models/workflow_with_details_bank_model_spec.rb +1 -1
  343. data/spec/models/workflows_list_bank_model_spec.rb +1 -1
  344. data/spec/spec_helper.rb +1 -1
  345. data/vendor/bundle/ruby/3.3.0/extensions/x86_64-linux/3.3.0/byebug-11.1.3/gem_make.out +5 -5
  346. data/vendor/bundle/ruby/3.3.0/extensions/x86_64-linux/3.3.0/jaro_winkler-1.5.6/gem_make.out +5 -5
  347. data/vendor/bundle/ruby/3.3.0/extensions/x86_64-linux/3.3.0/psych-5.1.2/gem_make.out +5 -5
  348. data/vendor/bundle/ruby/3.3.0/extensions/x86_64-linux/3.3.0/racc-1.8.1/gem_make.out +5 -5
  349. data/vendor/bundle/ruby/3.3.0/extensions/x86_64-linux/3.3.0/stringio-3.1.1/gem_make.out +5 -5
  350. metadata +1 -1
@@ -3,7 +3,7 @@
3
3
 
4
4
  ## Cybrid API documentation Welcome to Cybrid, an all-in-one crypto platform that enables you to easily **build** and **launch** white-label crypto products or services. In these documents, you'll find details on how our REST API operates and generally how our platform functions. If you're looking for our UI SDK Widgets for Web or Mobile (iOS/Android), generated API clients, or demo applications, head over to our [Github repo](https://github.com/Cybrid-app). 💡 We recommend bookmarking the [Cybrid LinkTree](https://linktr.ee/cybridtechnologies) which contains many helpful links to platform resources. ## Getting Started This is Cybrid's public interactive API documentation, which allows you to fully test our APIs. If you'd like to use a different tool to exercise our APIs, you can download the [Open API 3.0 yaml](https://bank.production.cybrid.app/api/schema/v1/swagger.yaml) for import. If you're new to our APIs and the Cybrid Platform, follow the below guides to get set up and familiar with the platform: 1. [Introduction](https://docs.cybrid.xyz/docs/introduction) 2. [Platform Introduction](https://docs.cybrid.xyz/docs/how-is-cybrid-architected) 3. [Testing with Hosted Web Demo App](https://docs.cybrid.xyz/docs/testing-with-hosted-web-demo-app) In [Getting Started in the Cybrid Sandbox](https://docs.cybrid.xyz/docs/how-do-i-get-started-with-the-sandbox), we walk you through how to use the [Cybrid Sandbox](https://id.sandbox.cybrid.app/) to create a test bank and generate API keys. In [Getting Ready for Trading](https://kb.cybrid.xyz/getting-ready-for-trading), we walk through creating customers, customer identities, accounts, as well as executing quotes and trades. ## Working with the Cybrid Platform There are three primary ways you can interact with the Cybrid platform: 1. Directly via our RESTful API (this documentation) 2. Using our API clients available in a variety of languages ([Angular](https://github.com/Cybrid-app/cybrid-api-bank-angular), [Java](https://github.com/Cybrid-app/cybrid-api-bank-java), [Kotlin](https://github.com/Cybrid-app/cybrid-api-bank-kotlin), [Python](https://github.com/Cybrid-app/cybrid-api-bank-python), [Ruby](https://github.com/Cybrid-app/cybrid-api-bank-ruby), [Swift](https://github.com/Cybrid-app/cybrid-api-bank-swift) or [Typescript](https://github.com/Cybrid-app/cybrid-api-bank-typescript)) 3. Integrating a platform specific SDK ([Web](https://github.com/Cybrid-app/cybrid-sdk-web), [Android](https://github.com/Cybrid-app/cybrid-sdk-android), [iOS](https://github.com/Cybrid-app/cybrid-sdk-ios)) Our complete set of APIs allows you to manage resources across three distinct areas: your `Organization`, your `Banks` and your `Identities`. For most of your testing and interaction you'll be using the `Bank` API, which is where the majority of APIs reside. *The complete set of APIs can be found on the following pages:* | API | Description | |------------------------------------------------------------------|-------------------------------------------------------------| | [Organization API](https://organization.production.cybrid.app/api/schema/swagger-ui) | APIs to manage organizations | | [Bank API](https://bank.production.cybrid.app/api/schema/swagger-ui) | APIs to manage banks (and all downstream customer activity) | | [Identities API](https://id.production.cybrid.app/api/schema/swagger-ui) | APIs to manage organization and bank identities | For questions please contact [Support](mailto:support@cybrid.xyz) at any time for assistance, or contact the [Product Team](mailto:product@cybrid.xyz) for product suggestions. ## Authenticating with the API The Cybrid Platform uses OAuth 2.0 Bearer Tokens to authenticate requests to the platform. Credentials to create `Organization` and `Bank` tokens can be generated via the [Cybrid Sandbox](https://id.production.cybrid.app). Access tokens can be generated for a `Customer` as well via the [Cybrid IdP](https://id.production.cybrid.app) as well. An `Organization` access token applies broadly to the whole Organization and all of its `Banks`, whereas, a `Bank` access token is specific to an individual Bank. `Customer` tokens, similarly, are scoped to a specific customer in a bank. Both `Organization` and `Bank` tokens can be created using the OAuth Client Credential Grant flow. Each Organization and Bank has its own unique `Client ID` and `Secret` that allows for machine-to-machine authentication. A `Bank` can then generate `Customer` access tokens via API using our [Identities API](https://id.production.cybrid.app/api/schema/swagger-ui). <font color=\"orange\">**⚠️ Never share your Client ID or Secret publicly or in your source code repository.**</font> Your `Client ID` and `Secret` can be exchanged for a time-limited `Bearer Token` by interacting with the Cybrid Identity Provider or through interacting with the **Authorize** button in this document. The following curl command can be used to quickly generate a `Bearer Token` for use in testing the API or demo applications. ``` # Example request when using Bank credentials curl -X POST https://id.production.cybrid.app/oauth/token -d '{ \"grant_type\": \"client_credentials\", \"client_id\": \"<Your Client ID>\", \"client_secret\": \"<Your Secret>\", \"scope\": \"banks:read banks:write bank_applications:execute accounts:read accounts:execute counterparties:read counterparties:write counterparties:execute customers:read customers:write customers:execute prices:read quotes:execute quotes:read trades:execute trades:read transfers:execute transfers:read external_bank_accounts:read external_bank_accounts:write external_bank_accounts:execute external_wallets:read external_wallets:execute workflows:read workflows:execute deposit_addresses:read deposit_addresses:execute deposit_bank_accounts:read deposit_bank_accounts:execute invoices:read invoices:write invoices:execute identity_verifications:read identity_verifications:write identity_verifications:execute\" }' -H \"Content-Type: application/json\" # When using Organization credentials set `scope` to 'organizations:read organizations:write organization_applications:execute banks:read banks:write banks:execute bank_applications:execute users:read users:execute counterparties:read customers:read accounts:read prices:read quotes:execute quotes:read trades:execute trades:read transfers:read transfers:execute external_bank_accounts:read external_wallets:read workflows:read deposit_addresses:read deposit_bank_accounts:read invoices:read subscriptions:read subscriptions:write subscriptions:execute subscription_events:read subscription_events:execute identity_verifications:read' ``` <font color=\"orange\">**⚠️ Note: The above curl will create a bearer token with full scope access. Delete scopes if you'd like to restrict access.**</font> ## Authentication Scopes The Cybrid platform supports the use of scopes to control the level of access a token is limited to. Scopes do not grant access to resources; instead, they provide limits, in support of the least privilege principal. The following scopes are available on the platform and can be requested when generating either an Organization, Bank or Customer token. Generally speaking, the _Read_ scope is required to read and list resources, the _Write_ scope is required to update a resource and the _Execute_ scope is required to create a resource. | Resource | Read scope (Token Type) | Write scope (Token Type) | Execute scope (Token Type) | |-----------------------|------------------------------------------------------------|-----------------------------------------------|--------------------------------------------------| | Account | accounts:read (Organization, Bank, Customer) | | accounts:execute (Bank, Customer) | | Bank | banks:read (Organization, Bank) | banks:write (Organization, Bank) | banks:execute (Organization) | | Customer | customers:read (Organization, Bank, Customer) | customers:write (Bank, Customer) | customers:execute (Bank) | | Counterparty | counterparties:read (Organization, Bank, Customer) | counterparties:write (Bank, Customer) | counterparties:execute (Bank) | | Deposit Address | deposit_addresses:read (Organization, Bank, Customer) | deposit_addresses:write (Bank, Customer) | deposit_addresses:execute (Bank, Customer) | | External Bank Account | external_bank_accounts:read (Organization, Bank, Customer) | external_bank_accounts:write (Bank, Customer) | external_bank_accounts:execute (Bank, Customer) | | External Wallet | external_wallet:read (Organization, Bank, Customer) | | external_wallet:execute (Bank, Customer) | | Organization | organizations:read (Organization) | organizations:write (Organization) | | | User | users:read (Organization) | | users:execute (Organization) | | Price | prices:read (Bank, Customer) | | | | Quote | quotes:read (Organization, Bank, Customer) | | quotes:execute (Organization, Bank, Customer) | | Trade | trades:read (Organization, Bank, Customer) | | trades:execute (Organization, Bank, Customer) | | Transfer | transfers:read (Organization, Bank, Customer) | | transfers:execute (Organization, Bank, Customer) | | Workflow | workflows:read (Organization, Bank, Customer) | | workflows:execute (Bank, Customer) | | Invoice | invoices:read (Organization, Bank, Customer) | invoices:write (Bank, Customer) | invoices:execute (Bank, Customer) | ## Available Endpoints The available APIs for the [Identity](https://id.production.cybrid.app/api/schema/swagger-ui), [Organization](https://organization.production.cybrid.app/api/schema/swagger-ui) and [Bank](https://bank.production.cybrid.app/api/schema/swagger-ui) API services are listed below: | API Service | Model | API Endpoint Path | Description | |--------------|----------------------|--------------------------------|---------------------------------------------------------------------------------------------------| | Identity | Bank | /api/bank_applications | Create and list banks | | Identity | CustomerToken | /api/customer_tokens | Create customer JWT access tokens | | Identity | Organization | /api/organization_applications | Create and list organizations | | Identity | Organization | /api/users | Create and list organization users | | Organization | Organization | /api/organizations | APIs to retrieve and update organization name | | Bank | Account | /api/accounts | Create and list accounts, which hold a specific asset for a customers | | Bank | Asset | /api/assets | Get a list of assets supported by the platform (ex: BTC, ETH) | | Bank | Bank | /api/banks | Create, update and list banks, the parent to customers, accounts, etc | | Bank | Customer | /api/customers | Create and list customers | | Bank | Counterparty | /api/counterparties | Create and list counterparties | | Bank | DepositAddress | /api/deposit_addresses | Create, get and list deposit addresses | | Bank | ExternalBankAccount | /api/external_bank_accounts | Create, get and list external bank accounts, which connect customer bank accounts to the platform | | Bank | ExternalWallet | /api/external_wallets | Create, get, list and delete external wallets, which connect customer wallets to the platform | | Bank | IdentityVerification | /api/identity_verifications | Create and list identity verifications, which are performed on customers for KYC | | Bank | Invoice | /api/invoices | Create, get, cancel and list invoices | | Bank | PaymentInstruction | /api/payment_instructions | Create, get and list payment instructions for invoices | | Bank | Price | /api/prices | Get the current prices for assets on the platform | | Bank | Quote | /api/quotes | Create and list quotes, which are required to execute trades | | Bank | Symbol | /api/symbols | Get a list of symbols supported for trade (ex: BTC-USD) | | Bank | Trade | /api/trades | Create and list trades, which buy or sell cryptocurrency | | Bank | Transfer | /api/transfers | Create, get and list transfers (e.g., funding, book) | | Bank | Workflow | /api/workflows | Create, get and list workflows | ## Understanding Object Models & Endpoints **Organizations** An `Organization` is meant to represent the organization partnering with Cybrid to use our platform. An `Organization` typically does not directly interact with `customers`. Instead, an Organization has one or more `banks`, which encompass the financial service offerings of the platform. **Banks** A `Bank` is owned by an `Organization` and can be thought of as an environment or container for `customers` and product offerings. Banks are created in either `Sandbox` or `Production` mode, where `Sandbox` is the environment that you would test, prototype and build in prior to moving to `Production`. An `Organization` can have multiple `banks`, in either `Sandbox` or `Production` environments. A `Sandbox Bank` will be backed by stubbed data and process flows. For instance, funding source transfer processes as well as trades will be simulated rather than performed, however asset prices are representative of real-world values. You have an unlimited amount of simulated fiat currency for testing purposes. **Customers** `Customers` represent your banking users on the platform. At present, we offer support for `Individuals` as Customers. `Customers` must be verified (i.e., KYC'd) in our system before they can play any part on the platform, which means they must have an associated and a passing `Identity Verification`. See the Identity Verifications section for more details on how a customer can be verified. `Customers` must also have an `Account` to be able to transact, in the desired asset class. See the Accounts APIs for more details on setting up accounts for the customer.
5
5
 
6
- The version of the OpenAPI document: v0.121.10
6
+ The version of the OpenAPI document: v0.121.12
7
7
  Contact: support@cybrid.app
8
8
  Generated by: https://openapi-generator.tech
9
9
  OpenAPI Generator version: 6.0.0
@@ -14,6 +14,7 @@ require 'date'
14
14
  require 'time'
15
15
 
16
16
  module CybridApiBank
17
+ # Request body for invoice creation.
17
18
  class PostInvoiceBankModel
18
19
  # The asset code the customer will receive the funds in.
19
20
  attr_accessor :asset
@@ -30,7 +31,7 @@ module CybridApiBank
30
31
  # The identifier for the account to use for the transfer. Required if the customer has multiple fiat accounts. Currently only valid for invoices paid to a fiat account.
31
32
  attr_accessor :account_guid
32
33
 
33
- # The labels associated with the customer.
34
+ # The labels associated with the invoice.
34
35
  attr_accessor :labels
35
36
 
36
37
  # Attribute mapping from ruby-style variable name to JSON key.
@@ -147,6 +148,10 @@ module CybridApiBank
147
148
  invalid_properties.push('invalid value for "account_guid", the character length must be great than or equal to 32.')
148
149
  end
149
150
 
151
+ if !@labels.nil? && @labels.length > 8
152
+ invalid_properties.push('invalid value for "labels", number of items must be less than or equal to 8.')
153
+ end
154
+
150
155
  invalid_properties
151
156
  end
152
157
 
@@ -160,6 +165,7 @@ module CybridApiBank
160
165
  return false if !@customer_guid.nil? && @customer_guid.to_s.length < 32
161
166
  return false if !@account_guid.nil? && @account_guid.to_s.length > 32
162
167
  return false if !@account_guid.nil? && @account_guid.to_s.length < 32
168
+ return false if !@labels.nil? && @labels.length > 8
163
169
  true
164
170
  end
165
171
 
@@ -209,6 +215,16 @@ module CybridApiBank
209
215
  @account_guid = account_guid
210
216
  end
211
217
 
218
+ # Custom attribute writer method with validation
219
+ # @param [Object] labels Value to be assigned
220
+ def labels=(labels)
221
+ if !labels.nil? && labels.length > 8
222
+ fail ArgumentError, 'invalid value for "labels", number of items must be less than or equal to 8.'
223
+ end
224
+
225
+ @labels = labels
226
+ end
227
+
212
228
  # Checks equality by comparing each attribute.
213
229
  # @param [Object] Object to be compared
214
230
  def ==(o)
@@ -3,7 +3,7 @@
3
3
 
4
4
  ## Cybrid API documentation Welcome to Cybrid, an all-in-one crypto platform that enables you to easily **build** and **launch** white-label crypto products or services. In these documents, you'll find details on how our REST API operates and generally how our platform functions. If you're looking for our UI SDK Widgets for Web or Mobile (iOS/Android), generated API clients, or demo applications, head over to our [Github repo](https://github.com/Cybrid-app). 💡 We recommend bookmarking the [Cybrid LinkTree](https://linktr.ee/cybridtechnologies) which contains many helpful links to platform resources. ## Getting Started This is Cybrid's public interactive API documentation, which allows you to fully test our APIs. If you'd like to use a different tool to exercise our APIs, you can download the [Open API 3.0 yaml](https://bank.production.cybrid.app/api/schema/v1/swagger.yaml) for import. If you're new to our APIs and the Cybrid Platform, follow the below guides to get set up and familiar with the platform: 1. [Introduction](https://docs.cybrid.xyz/docs/introduction) 2. [Platform Introduction](https://docs.cybrid.xyz/docs/how-is-cybrid-architected) 3. [Testing with Hosted Web Demo App](https://docs.cybrid.xyz/docs/testing-with-hosted-web-demo-app) In [Getting Started in the Cybrid Sandbox](https://docs.cybrid.xyz/docs/how-do-i-get-started-with-the-sandbox), we walk you through how to use the [Cybrid Sandbox](https://id.sandbox.cybrid.app/) to create a test bank and generate API keys. In [Getting Ready for Trading](https://kb.cybrid.xyz/getting-ready-for-trading), we walk through creating customers, customer identities, accounts, as well as executing quotes and trades. ## Working with the Cybrid Platform There are three primary ways you can interact with the Cybrid platform: 1. Directly via our RESTful API (this documentation) 2. Using our API clients available in a variety of languages ([Angular](https://github.com/Cybrid-app/cybrid-api-bank-angular), [Java](https://github.com/Cybrid-app/cybrid-api-bank-java), [Kotlin](https://github.com/Cybrid-app/cybrid-api-bank-kotlin), [Python](https://github.com/Cybrid-app/cybrid-api-bank-python), [Ruby](https://github.com/Cybrid-app/cybrid-api-bank-ruby), [Swift](https://github.com/Cybrid-app/cybrid-api-bank-swift) or [Typescript](https://github.com/Cybrid-app/cybrid-api-bank-typescript)) 3. Integrating a platform specific SDK ([Web](https://github.com/Cybrid-app/cybrid-sdk-web), [Android](https://github.com/Cybrid-app/cybrid-sdk-android), [iOS](https://github.com/Cybrid-app/cybrid-sdk-ios)) Our complete set of APIs allows you to manage resources across three distinct areas: your `Organization`, your `Banks` and your `Identities`. For most of your testing and interaction you'll be using the `Bank` API, which is where the majority of APIs reside. *The complete set of APIs can be found on the following pages:* | API | Description | |------------------------------------------------------------------|-------------------------------------------------------------| | [Organization API](https://organization.production.cybrid.app/api/schema/swagger-ui) | APIs to manage organizations | | [Bank API](https://bank.production.cybrid.app/api/schema/swagger-ui) | APIs to manage banks (and all downstream customer activity) | | [Identities API](https://id.production.cybrid.app/api/schema/swagger-ui) | APIs to manage organization and bank identities | For questions please contact [Support](mailto:support@cybrid.xyz) at any time for assistance, or contact the [Product Team](mailto:product@cybrid.xyz) for product suggestions. ## Authenticating with the API The Cybrid Platform uses OAuth 2.0 Bearer Tokens to authenticate requests to the platform. Credentials to create `Organization` and `Bank` tokens can be generated via the [Cybrid Sandbox](https://id.production.cybrid.app). Access tokens can be generated for a `Customer` as well via the [Cybrid IdP](https://id.production.cybrid.app) as well. An `Organization` access token applies broadly to the whole Organization and all of its `Banks`, whereas, a `Bank` access token is specific to an individual Bank. `Customer` tokens, similarly, are scoped to a specific customer in a bank. Both `Organization` and `Bank` tokens can be created using the OAuth Client Credential Grant flow. Each Organization and Bank has its own unique `Client ID` and `Secret` that allows for machine-to-machine authentication. A `Bank` can then generate `Customer` access tokens via API using our [Identities API](https://id.production.cybrid.app/api/schema/swagger-ui). <font color=\"orange\">**⚠️ Never share your Client ID or Secret publicly or in your source code repository.**</font> Your `Client ID` and `Secret` can be exchanged for a time-limited `Bearer Token` by interacting with the Cybrid Identity Provider or through interacting with the **Authorize** button in this document. The following curl command can be used to quickly generate a `Bearer Token` for use in testing the API or demo applications. ``` # Example request when using Bank credentials curl -X POST https://id.production.cybrid.app/oauth/token -d '{ \"grant_type\": \"client_credentials\", \"client_id\": \"<Your Client ID>\", \"client_secret\": \"<Your Secret>\", \"scope\": \"banks:read banks:write bank_applications:execute accounts:read accounts:execute counterparties:read counterparties:write counterparties:execute customers:read customers:write customers:execute prices:read quotes:execute quotes:read trades:execute trades:read transfers:execute transfers:read external_bank_accounts:read external_bank_accounts:write external_bank_accounts:execute external_wallets:read external_wallets:execute workflows:read workflows:execute deposit_addresses:read deposit_addresses:execute deposit_bank_accounts:read deposit_bank_accounts:execute invoices:read invoices:write invoices:execute identity_verifications:read identity_verifications:write identity_verifications:execute\" }' -H \"Content-Type: application/json\" # When using Organization credentials set `scope` to 'organizations:read organizations:write organization_applications:execute banks:read banks:write banks:execute bank_applications:execute users:read users:execute counterparties:read customers:read accounts:read prices:read quotes:execute quotes:read trades:execute trades:read transfers:read transfers:execute external_bank_accounts:read external_wallets:read workflows:read deposit_addresses:read deposit_bank_accounts:read invoices:read subscriptions:read subscriptions:write subscriptions:execute subscription_events:read subscription_events:execute identity_verifications:read' ``` <font color=\"orange\">**⚠️ Note: The above curl will create a bearer token with full scope access. Delete scopes if you'd like to restrict access.**</font> ## Authentication Scopes The Cybrid platform supports the use of scopes to control the level of access a token is limited to. Scopes do not grant access to resources; instead, they provide limits, in support of the least privilege principal. The following scopes are available on the platform and can be requested when generating either an Organization, Bank or Customer token. Generally speaking, the _Read_ scope is required to read and list resources, the _Write_ scope is required to update a resource and the _Execute_ scope is required to create a resource. | Resource | Read scope (Token Type) | Write scope (Token Type) | Execute scope (Token Type) | |-----------------------|------------------------------------------------------------|-----------------------------------------------|--------------------------------------------------| | Account | accounts:read (Organization, Bank, Customer) | | accounts:execute (Bank, Customer) | | Bank | banks:read (Organization, Bank) | banks:write (Organization, Bank) | banks:execute (Organization) | | Customer | customers:read (Organization, Bank, Customer) | customers:write (Bank, Customer) | customers:execute (Bank) | | Counterparty | counterparties:read (Organization, Bank, Customer) | counterparties:write (Bank, Customer) | counterparties:execute (Bank) | | Deposit Address | deposit_addresses:read (Organization, Bank, Customer) | deposit_addresses:write (Bank, Customer) | deposit_addresses:execute (Bank, Customer) | | External Bank Account | external_bank_accounts:read (Organization, Bank, Customer) | external_bank_accounts:write (Bank, Customer) | external_bank_accounts:execute (Bank, Customer) | | External Wallet | external_wallet:read (Organization, Bank, Customer) | | external_wallet:execute (Bank, Customer) | | Organization | organizations:read (Organization) | organizations:write (Organization) | | | User | users:read (Organization) | | users:execute (Organization) | | Price | prices:read (Bank, Customer) | | | | Quote | quotes:read (Organization, Bank, Customer) | | quotes:execute (Organization, Bank, Customer) | | Trade | trades:read (Organization, Bank, Customer) | | trades:execute (Organization, Bank, Customer) | | Transfer | transfers:read (Organization, Bank, Customer) | | transfers:execute (Organization, Bank, Customer) | | Workflow | workflows:read (Organization, Bank, Customer) | | workflows:execute (Bank, Customer) | | Invoice | invoices:read (Organization, Bank, Customer) | invoices:write (Bank, Customer) | invoices:execute (Bank, Customer) | ## Available Endpoints The available APIs for the [Identity](https://id.production.cybrid.app/api/schema/swagger-ui), [Organization](https://organization.production.cybrid.app/api/schema/swagger-ui) and [Bank](https://bank.production.cybrid.app/api/schema/swagger-ui) API services are listed below: | API Service | Model | API Endpoint Path | Description | |--------------|----------------------|--------------------------------|---------------------------------------------------------------------------------------------------| | Identity | Bank | /api/bank_applications | Create and list banks | | Identity | CustomerToken | /api/customer_tokens | Create customer JWT access tokens | | Identity | Organization | /api/organization_applications | Create and list organizations | | Identity | Organization | /api/users | Create and list organization users | | Organization | Organization | /api/organizations | APIs to retrieve and update organization name | | Bank | Account | /api/accounts | Create and list accounts, which hold a specific asset for a customers | | Bank | Asset | /api/assets | Get a list of assets supported by the platform (ex: BTC, ETH) | | Bank | Bank | /api/banks | Create, update and list banks, the parent to customers, accounts, etc | | Bank | Customer | /api/customers | Create and list customers | | Bank | Counterparty | /api/counterparties | Create and list counterparties | | Bank | DepositAddress | /api/deposit_addresses | Create, get and list deposit addresses | | Bank | ExternalBankAccount | /api/external_bank_accounts | Create, get and list external bank accounts, which connect customer bank accounts to the platform | | Bank | ExternalWallet | /api/external_wallets | Create, get, list and delete external wallets, which connect customer wallets to the platform | | Bank | IdentityVerification | /api/identity_verifications | Create and list identity verifications, which are performed on customers for KYC | | Bank | Invoice | /api/invoices | Create, get, cancel and list invoices | | Bank | PaymentInstruction | /api/payment_instructions | Create, get and list payment instructions for invoices | | Bank | Price | /api/prices | Get the current prices for assets on the platform | | Bank | Quote | /api/quotes | Create and list quotes, which are required to execute trades | | Bank | Symbol | /api/symbols | Get a list of symbols supported for trade (ex: BTC-USD) | | Bank | Trade | /api/trades | Create and list trades, which buy or sell cryptocurrency | | Bank | Transfer | /api/transfers | Create, get and list transfers (e.g., funding, book) | | Bank | Workflow | /api/workflows | Create, get and list workflows | ## Understanding Object Models & Endpoints **Organizations** An `Organization` is meant to represent the organization partnering with Cybrid to use our platform. An `Organization` typically does not directly interact with `customers`. Instead, an Organization has one or more `banks`, which encompass the financial service offerings of the platform. **Banks** A `Bank` is owned by an `Organization` and can be thought of as an environment or container for `customers` and product offerings. Banks are created in either `Sandbox` or `Production` mode, where `Sandbox` is the environment that you would test, prototype and build in prior to moving to `Production`. An `Organization` can have multiple `banks`, in either `Sandbox` or `Production` environments. A `Sandbox Bank` will be backed by stubbed data and process flows. For instance, funding source transfer processes as well as trades will be simulated rather than performed, however asset prices are representative of real-world values. You have an unlimited amount of simulated fiat currency for testing purposes. **Customers** `Customers` represent your banking users on the platform. At present, we offer support for `Individuals` as Customers. `Customers` must be verified (i.e., KYC'd) in our system before they can play any part on the platform, which means they must have an associated and a passing `Identity Verification`. See the Identity Verifications section for more details on how a customer can be verified. `Customers` must also have an `Account` to be able to transact, in the desired asset class. See the Accounts APIs for more details on setting up accounts for the customer.
5
5
 
6
- The version of the OpenAPI document: v0.121.10
6
+ The version of the OpenAPI document: v0.121.12
7
7
  Contact: support@cybrid.app
8
8
  Generated by: https://openapi-generator.tech
9
9
  OpenAPI Generator version: 6.0.0
@@ -14,6 +14,7 @@ require 'date'
14
14
  require 'time'
15
15
 
16
16
  module CybridApiBank
17
+ # Request body for payment instruction creation.
17
18
  class PostPaymentInstructionBankModel
18
19
  # The invoice guid.
19
20
  attr_accessor :invoice_guid
@@ -67,6 +68,7 @@ module CybridApiBank
67
68
  # List of attributes with nullable: true
68
69
  def self.openapi_nullable
69
70
  Set.new([
71
+ :'expected_behaviour'
70
72
  ])
71
73
  end
72
74
 
@@ -106,10 +108,6 @@ module CybridApiBank
106
108
  invalid_properties.push('invalid value for "invoice_guid", the character length must be smaller than or equal to 32.')
107
109
  end
108
110
 
109
- if @invoice_guid.to_s.length < 32
110
- invalid_properties.push('invalid value for "invoice_guid", the character length must be great than or equal to 32.')
111
- end
112
-
113
111
  invalid_properties
114
112
  end
115
113
 
@@ -118,7 +116,6 @@ module CybridApiBank
118
116
  def valid?
119
117
  return false if @invoice_guid.nil?
120
118
  return false if @invoice_guid.to_s.length > 32
121
- return false if @invoice_guid.to_s.length < 32
122
119
  expected_behaviour_validator = EnumAttributeValidator.new('String', ["invoice_paid_immediately"])
123
120
  return false unless expected_behaviour_validator.valid?(@expected_behaviour)
124
121
  true
@@ -135,10 +132,6 @@ module CybridApiBank
135
132
  fail ArgumentError, 'invalid value for "invoice_guid", the character length must be smaller than or equal to 32.'
136
133
  end
137
134
 
138
- if invoice_guid.to_s.length < 32
139
- fail ArgumentError, 'invalid value for "invoice_guid", the character length must be great than or equal to 32.'
140
- end
141
-
142
135
  @invoice_guid = invoice_guid
143
136
  end
144
137
 
@@ -3,7 +3,7 @@
3
3
 
4
4
  ## Cybrid API documentation Welcome to Cybrid, an all-in-one crypto platform that enables you to easily **build** and **launch** white-label crypto products or services. In these documents, you'll find details on how our REST API operates and generally how our platform functions. If you're looking for our UI SDK Widgets for Web or Mobile (iOS/Android), generated API clients, or demo applications, head over to our [Github repo](https://github.com/Cybrid-app). 💡 We recommend bookmarking the [Cybrid LinkTree](https://linktr.ee/cybridtechnologies) which contains many helpful links to platform resources. ## Getting Started This is Cybrid's public interactive API documentation, which allows you to fully test our APIs. If you'd like to use a different tool to exercise our APIs, you can download the [Open API 3.0 yaml](https://bank.production.cybrid.app/api/schema/v1/swagger.yaml) for import. If you're new to our APIs and the Cybrid Platform, follow the below guides to get set up and familiar with the platform: 1. [Introduction](https://docs.cybrid.xyz/docs/introduction) 2. [Platform Introduction](https://docs.cybrid.xyz/docs/how-is-cybrid-architected) 3. [Testing with Hosted Web Demo App](https://docs.cybrid.xyz/docs/testing-with-hosted-web-demo-app) In [Getting Started in the Cybrid Sandbox](https://docs.cybrid.xyz/docs/how-do-i-get-started-with-the-sandbox), we walk you through how to use the [Cybrid Sandbox](https://id.sandbox.cybrid.app/) to create a test bank and generate API keys. In [Getting Ready for Trading](https://kb.cybrid.xyz/getting-ready-for-trading), we walk through creating customers, customer identities, accounts, as well as executing quotes and trades. ## Working with the Cybrid Platform There are three primary ways you can interact with the Cybrid platform: 1. Directly via our RESTful API (this documentation) 2. Using our API clients available in a variety of languages ([Angular](https://github.com/Cybrid-app/cybrid-api-bank-angular), [Java](https://github.com/Cybrid-app/cybrid-api-bank-java), [Kotlin](https://github.com/Cybrid-app/cybrid-api-bank-kotlin), [Python](https://github.com/Cybrid-app/cybrid-api-bank-python), [Ruby](https://github.com/Cybrid-app/cybrid-api-bank-ruby), [Swift](https://github.com/Cybrid-app/cybrid-api-bank-swift) or [Typescript](https://github.com/Cybrid-app/cybrid-api-bank-typescript)) 3. Integrating a platform specific SDK ([Web](https://github.com/Cybrid-app/cybrid-sdk-web), [Android](https://github.com/Cybrid-app/cybrid-sdk-android), [iOS](https://github.com/Cybrid-app/cybrid-sdk-ios)) Our complete set of APIs allows you to manage resources across three distinct areas: your `Organization`, your `Banks` and your `Identities`. For most of your testing and interaction you'll be using the `Bank` API, which is where the majority of APIs reside. *The complete set of APIs can be found on the following pages:* | API | Description | |------------------------------------------------------------------|-------------------------------------------------------------| | [Organization API](https://organization.production.cybrid.app/api/schema/swagger-ui) | APIs to manage organizations | | [Bank API](https://bank.production.cybrid.app/api/schema/swagger-ui) | APIs to manage banks (and all downstream customer activity) | | [Identities API](https://id.production.cybrid.app/api/schema/swagger-ui) | APIs to manage organization and bank identities | For questions please contact [Support](mailto:support@cybrid.xyz) at any time for assistance, or contact the [Product Team](mailto:product@cybrid.xyz) for product suggestions. ## Authenticating with the API The Cybrid Platform uses OAuth 2.0 Bearer Tokens to authenticate requests to the platform. Credentials to create `Organization` and `Bank` tokens can be generated via the [Cybrid Sandbox](https://id.production.cybrid.app). Access tokens can be generated for a `Customer` as well via the [Cybrid IdP](https://id.production.cybrid.app) as well. An `Organization` access token applies broadly to the whole Organization and all of its `Banks`, whereas, a `Bank` access token is specific to an individual Bank. `Customer` tokens, similarly, are scoped to a specific customer in a bank. Both `Organization` and `Bank` tokens can be created using the OAuth Client Credential Grant flow. Each Organization and Bank has its own unique `Client ID` and `Secret` that allows for machine-to-machine authentication. A `Bank` can then generate `Customer` access tokens via API using our [Identities API](https://id.production.cybrid.app/api/schema/swagger-ui). <font color=\"orange\">**⚠️ Never share your Client ID or Secret publicly or in your source code repository.**</font> Your `Client ID` and `Secret` can be exchanged for a time-limited `Bearer Token` by interacting with the Cybrid Identity Provider or through interacting with the **Authorize** button in this document. The following curl command can be used to quickly generate a `Bearer Token` for use in testing the API or demo applications. ``` # Example request when using Bank credentials curl -X POST https://id.production.cybrid.app/oauth/token -d '{ \"grant_type\": \"client_credentials\", \"client_id\": \"<Your Client ID>\", \"client_secret\": \"<Your Secret>\", \"scope\": \"banks:read banks:write bank_applications:execute accounts:read accounts:execute counterparties:read counterparties:write counterparties:execute customers:read customers:write customers:execute prices:read quotes:execute quotes:read trades:execute trades:read transfers:execute transfers:read external_bank_accounts:read external_bank_accounts:write external_bank_accounts:execute external_wallets:read external_wallets:execute workflows:read workflows:execute deposit_addresses:read deposit_addresses:execute deposit_bank_accounts:read deposit_bank_accounts:execute invoices:read invoices:write invoices:execute identity_verifications:read identity_verifications:write identity_verifications:execute\" }' -H \"Content-Type: application/json\" # When using Organization credentials set `scope` to 'organizations:read organizations:write organization_applications:execute banks:read banks:write banks:execute bank_applications:execute users:read users:execute counterparties:read customers:read accounts:read prices:read quotes:execute quotes:read trades:execute trades:read transfers:read transfers:execute external_bank_accounts:read external_wallets:read workflows:read deposit_addresses:read deposit_bank_accounts:read invoices:read subscriptions:read subscriptions:write subscriptions:execute subscription_events:read subscription_events:execute identity_verifications:read' ``` <font color=\"orange\">**⚠️ Note: The above curl will create a bearer token with full scope access. Delete scopes if you'd like to restrict access.**</font> ## Authentication Scopes The Cybrid platform supports the use of scopes to control the level of access a token is limited to. Scopes do not grant access to resources; instead, they provide limits, in support of the least privilege principal. The following scopes are available on the platform and can be requested when generating either an Organization, Bank or Customer token. Generally speaking, the _Read_ scope is required to read and list resources, the _Write_ scope is required to update a resource and the _Execute_ scope is required to create a resource. | Resource | Read scope (Token Type) | Write scope (Token Type) | Execute scope (Token Type) | |-----------------------|------------------------------------------------------------|-----------------------------------------------|--------------------------------------------------| | Account | accounts:read (Organization, Bank, Customer) | | accounts:execute (Bank, Customer) | | Bank | banks:read (Organization, Bank) | banks:write (Organization, Bank) | banks:execute (Organization) | | Customer | customers:read (Organization, Bank, Customer) | customers:write (Bank, Customer) | customers:execute (Bank) | | Counterparty | counterparties:read (Organization, Bank, Customer) | counterparties:write (Bank, Customer) | counterparties:execute (Bank) | | Deposit Address | deposit_addresses:read (Organization, Bank, Customer) | deposit_addresses:write (Bank, Customer) | deposit_addresses:execute (Bank, Customer) | | External Bank Account | external_bank_accounts:read (Organization, Bank, Customer) | external_bank_accounts:write (Bank, Customer) | external_bank_accounts:execute (Bank, Customer) | | External Wallet | external_wallet:read (Organization, Bank, Customer) | | external_wallet:execute (Bank, Customer) | | Organization | organizations:read (Organization) | organizations:write (Organization) | | | User | users:read (Organization) | | users:execute (Organization) | | Price | prices:read (Bank, Customer) | | | | Quote | quotes:read (Organization, Bank, Customer) | | quotes:execute (Organization, Bank, Customer) | | Trade | trades:read (Organization, Bank, Customer) | | trades:execute (Organization, Bank, Customer) | | Transfer | transfers:read (Organization, Bank, Customer) | | transfers:execute (Organization, Bank, Customer) | | Workflow | workflows:read (Organization, Bank, Customer) | | workflows:execute (Bank, Customer) | | Invoice | invoices:read (Organization, Bank, Customer) | invoices:write (Bank, Customer) | invoices:execute (Bank, Customer) | ## Available Endpoints The available APIs for the [Identity](https://id.production.cybrid.app/api/schema/swagger-ui), [Organization](https://organization.production.cybrid.app/api/schema/swagger-ui) and [Bank](https://bank.production.cybrid.app/api/schema/swagger-ui) API services are listed below: | API Service | Model | API Endpoint Path | Description | |--------------|----------------------|--------------------------------|---------------------------------------------------------------------------------------------------| | Identity | Bank | /api/bank_applications | Create and list banks | | Identity | CustomerToken | /api/customer_tokens | Create customer JWT access tokens | | Identity | Organization | /api/organization_applications | Create and list organizations | | Identity | Organization | /api/users | Create and list organization users | | Organization | Organization | /api/organizations | APIs to retrieve and update organization name | | Bank | Account | /api/accounts | Create and list accounts, which hold a specific asset for a customers | | Bank | Asset | /api/assets | Get a list of assets supported by the platform (ex: BTC, ETH) | | Bank | Bank | /api/banks | Create, update and list banks, the parent to customers, accounts, etc | | Bank | Customer | /api/customers | Create and list customers | | Bank | Counterparty | /api/counterparties | Create and list counterparties | | Bank | DepositAddress | /api/deposit_addresses | Create, get and list deposit addresses | | Bank | ExternalBankAccount | /api/external_bank_accounts | Create, get and list external bank accounts, which connect customer bank accounts to the platform | | Bank | ExternalWallet | /api/external_wallets | Create, get, list and delete external wallets, which connect customer wallets to the platform | | Bank | IdentityVerification | /api/identity_verifications | Create and list identity verifications, which are performed on customers for KYC | | Bank | Invoice | /api/invoices | Create, get, cancel and list invoices | | Bank | PaymentInstruction | /api/payment_instructions | Create, get and list payment instructions for invoices | | Bank | Price | /api/prices | Get the current prices for assets on the platform | | Bank | Quote | /api/quotes | Create and list quotes, which are required to execute trades | | Bank | Symbol | /api/symbols | Get a list of symbols supported for trade (ex: BTC-USD) | | Bank | Trade | /api/trades | Create and list trades, which buy or sell cryptocurrency | | Bank | Transfer | /api/transfers | Create, get and list transfers (e.g., funding, book) | | Bank | Workflow | /api/workflows | Create, get and list workflows | ## Understanding Object Models & Endpoints **Organizations** An `Organization` is meant to represent the organization partnering with Cybrid to use our platform. An `Organization` typically does not directly interact with `customers`. Instead, an Organization has one or more `banks`, which encompass the financial service offerings of the platform. **Banks** A `Bank` is owned by an `Organization` and can be thought of as an environment or container for `customers` and product offerings. Banks are created in either `Sandbox` or `Production` mode, where `Sandbox` is the environment that you would test, prototype and build in prior to moving to `Production`. An `Organization` can have multiple `banks`, in either `Sandbox` or `Production` environments. A `Sandbox Bank` will be backed by stubbed data and process flows. For instance, funding source transfer processes as well as trades will be simulated rather than performed, however asset prices are representative of real-world values. You have an unlimited amount of simulated fiat currency for testing purposes. **Customers** `Customers` represent your banking users on the platform. At present, we offer support for `Individuals` as Customers. `Customers` must be verified (i.e., KYC'd) in our system before they can play any part on the platform, which means they must have an associated and a passing `Identity Verification`. See the Identity Verifications section for more details on how a customer can be verified. `Customers` must also have an `Account` to be able to transact, in the desired asset class. See the Accounts APIs for more details on setting up accounts for the customer.
5
5
 
6
- The version of the OpenAPI document: v0.121.10
6
+ The version of the OpenAPI document: v0.121.12
7
7
  Contact: support@cybrid.app
8
8
  Generated by: https://openapi-generator.tech
9
9
  OpenAPI Generator version: 6.0.0
@@ -14,6 +14,7 @@ require 'date'
14
14
  require 'time'
15
15
 
16
16
  module CybridApiBank
17
+ # Request body for quote creation.
17
18
  class PostQuoteBankModel
18
19
  # The type of product the quote is for.
19
20
  attr_accessor :product_type
@@ -24,34 +25,34 @@ module CybridApiBank
24
25
  # The unique identifier for the customer.
25
26
  attr_accessor :customer_guid
26
27
 
27
- # The asset code the quote was requested for. Populated for funding, book transfer and crypto transfer quotes.
28
- attr_accessor :asset
29
-
30
- # The network address to pay the invoice to. Populated for lightning_transfer quotes.
31
- attr_accessor :network_address
32
-
33
- # Symbol the quote is being requested for. Format is \"asset-counter_asset\" in uppercase. See the Symbols API for a complete list of cryptocurrencies supported. Populated for trade quotes.
34
- attr_accessor :symbol
35
-
36
- # The direction for trade quotes: either 'buy' or 'sell'. The direction for funding quotes: either 'deposit' or 'withdrawal'. The direction for crypto transfer quotes: 'withdrawal'. Book transfers do not require a side. They are all 'deposit's.
37
- attr_accessor :side
38
-
39
28
  # The amount to be received in base units of the currency: currency is \"asset\" for buy and \"counter_asset\" for sell for trade quotes.
40
29
  attr_accessor :receive_amount
41
30
 
42
31
  # The amount to be delivered in base units of the currency: currency is \"counter_asset\" for buy and \"asset\" for sell for trade quotes.
43
32
  attr_accessor :deliver_amount
44
33
 
45
- # The custom fees associated with the quote
34
+ # The asset code the quote was requested for. Required when product_type is lightning_transfer, product_type is book_transfer, product_type is funding, product_type is crypto_transfer, or product_type is inter_account.
35
+ attr_accessor :asset
36
+
37
+ # The network address to pay the invoice to. Required when product_type is lightning_transfer.
38
+ attr_accessor :network_address
39
+
40
+ # The custom fees associated with the quote Optional when product_type is lightning_transfer, product_type is funding, product_type is trading, product_type is crypto_transfer, or product_type is trading_exit.
46
41
  attr_accessor :fees
47
42
 
48
- # The guid of the related trade. Only present on `exit` trades.
43
+ # The direction for trade quotes: either 'buy' or 'sell'. The direction for funding quotes: either 'deposit' or 'withdrawal'. The direction for crypto transfer quotes: 'withdrawal'. Book transfers do not require a side. They are all 'deposit's. Required when product_type is funding, product_type is trading, or product_type is crypto_transfer.
44
+ attr_accessor :side
45
+
46
+ # Symbol the quote is being requested for. Format is \"asset-counter_asset\" in uppercase. See the Symbols API for a complete list of cryptocurrencies supported. Required when product_type is trading.
47
+ attr_accessor :symbol
48
+
49
+ # The guid of the related trade. Only present on `exit` trades. Required when product_type is trading_exit.
49
50
  attr_accessor :reference_trade_guid
50
51
 
51
- # The source account's identifier. Required for inter-account transfers.
52
+ # The source account's identifier. Required when product_type is inter_account.
52
53
  attr_accessor :source_account_guid
53
54
 
54
- # The destination account's identifier. Required for inter-account transfers.
55
+ # The destination account's identifier. Required when product_type is inter_account.
55
56
  attr_accessor :destination_account_guid
56
57
 
57
58
  class EnumAttributeValidator
@@ -82,13 +83,13 @@ module CybridApiBank
82
83
  :'product_type' => :'product_type',
83
84
  :'bank_guid' => :'bank_guid',
84
85
  :'customer_guid' => :'customer_guid',
85
- :'asset' => :'asset',
86
- :'network_address' => :'network_address',
87
- :'symbol' => :'symbol',
88
- :'side' => :'side',
89
86
  :'receive_amount' => :'receive_amount',
90
87
  :'deliver_amount' => :'deliver_amount',
88
+ :'asset' => :'asset',
89
+ :'network_address' => :'network_address',
91
90
  :'fees' => :'fees',
91
+ :'side' => :'side',
92
+ :'symbol' => :'symbol',
92
93
  :'reference_trade_guid' => :'reference_trade_guid',
93
94
  :'source_account_guid' => :'source_account_guid',
94
95
  :'destination_account_guid' => :'destination_account_guid'
@@ -106,13 +107,13 @@ module CybridApiBank
106
107
  :'product_type' => :'String',
107
108
  :'bank_guid' => :'String',
108
109
  :'customer_guid' => :'String',
109
- :'asset' => :'String',
110
- :'network_address' => :'String',
111
- :'symbol' => :'String',
112
- :'side' => :'String',
113
110
  :'receive_amount' => :'Integer',
114
111
  :'deliver_amount' => :'Integer',
112
+ :'asset' => :'String',
113
+ :'network_address' => :'String',
115
114
  :'fees' => :'Array<PostFeeBankModel>',
115
+ :'side' => :'String',
116
+ :'symbol' => :'String',
116
117
  :'reference_trade_guid' => :'String',
117
118
  :'source_account_guid' => :'String',
118
119
  :'destination_account_guid' => :'String'
@@ -122,10 +123,17 @@ module CybridApiBank
122
123
  # List of attributes with nullable: true
123
124
  def self.openapi_nullable
124
125
  Set.new([
126
+ :'product_type',
125
127
  :'bank_guid',
126
128
  :'customer_guid',
129
+ :'receive_amount',
130
+ :'deliver_amount',
131
+ :'asset',
127
132
  :'network_address',
133
+ :'fees',
128
134
  :'side',
135
+ :'symbol',
136
+ :'reference_trade_guid',
129
137
  :'source_account_guid',
130
138
  :'destination_account_guid'
131
139
  ])
@@ -160,6 +168,14 @@ module CybridApiBank
160
168
  self.customer_guid = attributes[:'customer_guid']
161
169
  end
162
170
 
171
+ if attributes.key?(:'receive_amount')
172
+ self.receive_amount = attributes[:'receive_amount']
173
+ end
174
+
175
+ if attributes.key?(:'deliver_amount')
176
+ self.deliver_amount = attributes[:'deliver_amount']
177
+ end
178
+
163
179
  if attributes.key?(:'asset')
164
180
  self.asset = attributes[:'asset']
165
181
  end
@@ -168,26 +184,18 @@ module CybridApiBank
168
184
  self.network_address = attributes[:'network_address']
169
185
  end
170
186
 
171
- if attributes.key?(:'symbol')
172
- self.symbol = attributes[:'symbol']
187
+ if attributes.key?(:'fees')
188
+ if (value = attributes[:'fees']).is_a?(Array)
189
+ self.fees = value
190
+ end
173
191
  end
174
192
 
175
193
  if attributes.key?(:'side')
176
194
  self.side = attributes[:'side']
177
195
  end
178
196
 
179
- if attributes.key?(:'receive_amount')
180
- self.receive_amount = attributes[:'receive_amount']
181
- end
182
-
183
- if attributes.key?(:'deliver_amount')
184
- self.deliver_amount = attributes[:'deliver_amount']
185
- end
186
-
187
- if attributes.key?(:'fees')
188
- if (value = attributes[:'fees']).is_a?(Array)
189
- self.fees = value
190
- end
197
+ if attributes.key?(:'symbol')
198
+ self.symbol = attributes[:'symbol']
191
199
  end
192
200
 
193
201
  if attributes.key?(:'reference_trade_guid')
@@ -231,6 +239,18 @@ module CybridApiBank
231
239
  invalid_properties.push('invalid value for "asset", the character length must be great than or equal to 1.')
232
240
  end
233
241
 
242
+ if !@network_address.nil? && @network_address.to_s.length > 512
243
+ invalid_properties.push('invalid value for "network_address", the character length must be smaller than or equal to 512.')
244
+ end
245
+
246
+ if !@fees.nil? && @fees.length > 2
247
+ invalid_properties.push('invalid value for "fees", number of items must be less than or equal to 2.')
248
+ end
249
+
250
+ if !@fees.nil? && @fees.length < 0
251
+ invalid_properties.push('invalid value for "fees", number of items must be greater than or equal to 0.')
252
+ end
253
+
234
254
  if !@symbol.nil? && @symbol.to_s.length > 16
235
255
  invalid_properties.push('invalid value for "symbol", the character length must be smaller than or equal to 16.')
236
256
  end
@@ -277,6 +297,11 @@ module CybridApiBank
277
297
  return false if !@customer_guid.nil? && @customer_guid.to_s.length < 32
278
298
  return false if !@asset.nil? && @asset.to_s.length > 8
279
299
  return false if !@asset.nil? && @asset.to_s.length < 1
300
+ return false if !@network_address.nil? && @network_address.to_s.length > 512
301
+ return false if !@fees.nil? && @fees.length > 2
302
+ return false if !@fees.nil? && @fees.length < 0
303
+ side_validator = EnumAttributeValidator.new('String', ["deposit", "withdrawal", "buy", "sell"])
304
+ return false unless side_validator.valid?(@side)
280
305
  return false if !@symbol.nil? && @symbol.to_s.length > 16
281
306
  return false if !@symbol.nil? && @symbol.to_s.length < 1
282
307
  return false if !@reference_trade_guid.nil? && @reference_trade_guid.to_s.length > 32
@@ -340,6 +365,40 @@ module CybridApiBank
340
365
  @asset = asset
341
366
  end
342
367
 
368
+ # Custom attribute writer method with validation
369
+ # @param [Object] network_address Value to be assigned
370
+ def network_address=(network_address)
371
+ if !network_address.nil? && network_address.to_s.length > 512
372
+ fail ArgumentError, 'invalid value for "network_address", the character length must be smaller than or equal to 512.'
373
+ end
374
+
375
+ @network_address = network_address
376
+ end
377
+
378
+ # Custom attribute writer method with validation
379
+ # @param [Object] fees Value to be assigned
380
+ def fees=(fees)
381
+ if !fees.nil? && fees.length > 2
382
+ fail ArgumentError, 'invalid value for "fees", number of items must be less than or equal to 2.'
383
+ end
384
+
385
+ if !fees.nil? && fees.length < 0
386
+ fail ArgumentError, 'invalid value for "fees", number of items must be greater than or equal to 0.'
387
+ end
388
+
389
+ @fees = fees
390
+ end
391
+
392
+ # Custom attribute writer method checking allowed values (enum).
393
+ # @param [Object] side Object to be assigned
394
+ def side=(side)
395
+ validator = EnumAttributeValidator.new('String', ["deposit", "withdrawal", "buy", "sell"])
396
+ unless validator.valid?(side)
397
+ fail ArgumentError, "invalid value for \"side\", must be one of #{validator.allowable_values}."
398
+ end
399
+ @side = side
400
+ end
401
+
343
402
  # Custom attribute writer method with validation
344
403
  # @param [Object] symbol Value to be assigned
345
404
  def symbol=(symbol)
@@ -404,13 +463,13 @@ module CybridApiBank
404
463
  product_type == o.product_type &&
405
464
  bank_guid == o.bank_guid &&
406
465
  customer_guid == o.customer_guid &&
407
- asset == o.asset &&
408
- network_address == o.network_address &&
409
- symbol == o.symbol &&
410
- side == o.side &&
411
466
  receive_amount == o.receive_amount &&
412
467
  deliver_amount == o.deliver_amount &&
468
+ asset == o.asset &&
469
+ network_address == o.network_address &&
413
470
  fees == o.fees &&
471
+ side == o.side &&
472
+ symbol == o.symbol &&
414
473
  reference_trade_guid == o.reference_trade_guid &&
415
474
  source_account_guid == o.source_account_guid &&
416
475
  destination_account_guid == o.destination_account_guid
@@ -425,7 +484,7 @@ module CybridApiBank
425
484
  # Calculates hash code according to all attributes.
426
485
  # @return [Integer] Hash code
427
486
  def hash
428
- [product_type, bank_guid, customer_guid, asset, network_address, symbol, side, receive_amount, deliver_amount, fees, reference_trade_guid, source_account_guid, destination_account_guid].hash
487
+ [product_type, bank_guid, customer_guid, receive_amount, deliver_amount, asset, network_address, fees, side, symbol, reference_trade_guid, source_account_guid, destination_account_guid].hash
429
488
  end
430
489
 
431
490
  # Builds the object from hash
@@ -3,7 +3,7 @@
3
3
 
4
4
  ## Cybrid API documentation Welcome to Cybrid, an all-in-one crypto platform that enables you to easily **build** and **launch** white-label crypto products or services. In these documents, you'll find details on how our REST API operates and generally how our platform functions. If you're looking for our UI SDK Widgets for Web or Mobile (iOS/Android), generated API clients, or demo applications, head over to our [Github repo](https://github.com/Cybrid-app). 💡 We recommend bookmarking the [Cybrid LinkTree](https://linktr.ee/cybridtechnologies) which contains many helpful links to platform resources. ## Getting Started This is Cybrid's public interactive API documentation, which allows you to fully test our APIs. If you'd like to use a different tool to exercise our APIs, you can download the [Open API 3.0 yaml](https://bank.production.cybrid.app/api/schema/v1/swagger.yaml) for import. If you're new to our APIs and the Cybrid Platform, follow the below guides to get set up and familiar with the platform: 1. [Introduction](https://docs.cybrid.xyz/docs/introduction) 2. [Platform Introduction](https://docs.cybrid.xyz/docs/how-is-cybrid-architected) 3. [Testing with Hosted Web Demo App](https://docs.cybrid.xyz/docs/testing-with-hosted-web-demo-app) In [Getting Started in the Cybrid Sandbox](https://docs.cybrid.xyz/docs/how-do-i-get-started-with-the-sandbox), we walk you through how to use the [Cybrid Sandbox](https://id.sandbox.cybrid.app/) to create a test bank and generate API keys. In [Getting Ready for Trading](https://kb.cybrid.xyz/getting-ready-for-trading), we walk through creating customers, customer identities, accounts, as well as executing quotes and trades. ## Working with the Cybrid Platform There are three primary ways you can interact with the Cybrid platform: 1. Directly via our RESTful API (this documentation) 2. Using our API clients available in a variety of languages ([Angular](https://github.com/Cybrid-app/cybrid-api-bank-angular), [Java](https://github.com/Cybrid-app/cybrid-api-bank-java), [Kotlin](https://github.com/Cybrid-app/cybrid-api-bank-kotlin), [Python](https://github.com/Cybrid-app/cybrid-api-bank-python), [Ruby](https://github.com/Cybrid-app/cybrid-api-bank-ruby), [Swift](https://github.com/Cybrid-app/cybrid-api-bank-swift) or [Typescript](https://github.com/Cybrid-app/cybrid-api-bank-typescript)) 3. Integrating a platform specific SDK ([Web](https://github.com/Cybrid-app/cybrid-sdk-web), [Android](https://github.com/Cybrid-app/cybrid-sdk-android), [iOS](https://github.com/Cybrid-app/cybrid-sdk-ios)) Our complete set of APIs allows you to manage resources across three distinct areas: your `Organization`, your `Banks` and your `Identities`. For most of your testing and interaction you'll be using the `Bank` API, which is where the majority of APIs reside. *The complete set of APIs can be found on the following pages:* | API | Description | |------------------------------------------------------------------|-------------------------------------------------------------| | [Organization API](https://organization.production.cybrid.app/api/schema/swagger-ui) | APIs to manage organizations | | [Bank API](https://bank.production.cybrid.app/api/schema/swagger-ui) | APIs to manage banks (and all downstream customer activity) | | [Identities API](https://id.production.cybrid.app/api/schema/swagger-ui) | APIs to manage organization and bank identities | For questions please contact [Support](mailto:support@cybrid.xyz) at any time for assistance, or contact the [Product Team](mailto:product@cybrid.xyz) for product suggestions. ## Authenticating with the API The Cybrid Platform uses OAuth 2.0 Bearer Tokens to authenticate requests to the platform. Credentials to create `Organization` and `Bank` tokens can be generated via the [Cybrid Sandbox](https://id.production.cybrid.app). Access tokens can be generated for a `Customer` as well via the [Cybrid IdP](https://id.production.cybrid.app) as well. An `Organization` access token applies broadly to the whole Organization and all of its `Banks`, whereas, a `Bank` access token is specific to an individual Bank. `Customer` tokens, similarly, are scoped to a specific customer in a bank. Both `Organization` and `Bank` tokens can be created using the OAuth Client Credential Grant flow. Each Organization and Bank has its own unique `Client ID` and `Secret` that allows for machine-to-machine authentication. A `Bank` can then generate `Customer` access tokens via API using our [Identities API](https://id.production.cybrid.app/api/schema/swagger-ui). <font color=\"orange\">**⚠️ Never share your Client ID or Secret publicly or in your source code repository.**</font> Your `Client ID` and `Secret` can be exchanged for a time-limited `Bearer Token` by interacting with the Cybrid Identity Provider or through interacting with the **Authorize** button in this document. The following curl command can be used to quickly generate a `Bearer Token` for use in testing the API or demo applications. ``` # Example request when using Bank credentials curl -X POST https://id.production.cybrid.app/oauth/token -d '{ \"grant_type\": \"client_credentials\", \"client_id\": \"<Your Client ID>\", \"client_secret\": \"<Your Secret>\", \"scope\": \"banks:read banks:write bank_applications:execute accounts:read accounts:execute counterparties:read counterparties:write counterparties:execute customers:read customers:write customers:execute prices:read quotes:execute quotes:read trades:execute trades:read transfers:execute transfers:read external_bank_accounts:read external_bank_accounts:write external_bank_accounts:execute external_wallets:read external_wallets:execute workflows:read workflows:execute deposit_addresses:read deposit_addresses:execute deposit_bank_accounts:read deposit_bank_accounts:execute invoices:read invoices:write invoices:execute identity_verifications:read identity_verifications:write identity_verifications:execute\" }' -H \"Content-Type: application/json\" # When using Organization credentials set `scope` to 'organizations:read organizations:write organization_applications:execute banks:read banks:write banks:execute bank_applications:execute users:read users:execute counterparties:read customers:read accounts:read prices:read quotes:execute quotes:read trades:execute trades:read transfers:read transfers:execute external_bank_accounts:read external_wallets:read workflows:read deposit_addresses:read deposit_bank_accounts:read invoices:read subscriptions:read subscriptions:write subscriptions:execute subscription_events:read subscription_events:execute identity_verifications:read' ``` <font color=\"orange\">**⚠️ Note: The above curl will create a bearer token with full scope access. Delete scopes if you'd like to restrict access.**</font> ## Authentication Scopes The Cybrid platform supports the use of scopes to control the level of access a token is limited to. Scopes do not grant access to resources; instead, they provide limits, in support of the least privilege principal. The following scopes are available on the platform and can be requested when generating either an Organization, Bank or Customer token. Generally speaking, the _Read_ scope is required to read and list resources, the _Write_ scope is required to update a resource and the _Execute_ scope is required to create a resource. | Resource | Read scope (Token Type) | Write scope (Token Type) | Execute scope (Token Type) | |-----------------------|------------------------------------------------------------|-----------------------------------------------|--------------------------------------------------| | Account | accounts:read (Organization, Bank, Customer) | | accounts:execute (Bank, Customer) | | Bank | banks:read (Organization, Bank) | banks:write (Organization, Bank) | banks:execute (Organization) | | Customer | customers:read (Organization, Bank, Customer) | customers:write (Bank, Customer) | customers:execute (Bank) | | Counterparty | counterparties:read (Organization, Bank, Customer) | counterparties:write (Bank, Customer) | counterparties:execute (Bank) | | Deposit Address | deposit_addresses:read (Organization, Bank, Customer) | deposit_addresses:write (Bank, Customer) | deposit_addresses:execute (Bank, Customer) | | External Bank Account | external_bank_accounts:read (Organization, Bank, Customer) | external_bank_accounts:write (Bank, Customer) | external_bank_accounts:execute (Bank, Customer) | | External Wallet | external_wallet:read (Organization, Bank, Customer) | | external_wallet:execute (Bank, Customer) | | Organization | organizations:read (Organization) | organizations:write (Organization) | | | User | users:read (Organization) | | users:execute (Organization) | | Price | prices:read (Bank, Customer) | | | | Quote | quotes:read (Organization, Bank, Customer) | | quotes:execute (Organization, Bank, Customer) | | Trade | trades:read (Organization, Bank, Customer) | | trades:execute (Organization, Bank, Customer) | | Transfer | transfers:read (Organization, Bank, Customer) | | transfers:execute (Organization, Bank, Customer) | | Workflow | workflows:read (Organization, Bank, Customer) | | workflows:execute (Bank, Customer) | | Invoice | invoices:read (Organization, Bank, Customer) | invoices:write (Bank, Customer) | invoices:execute (Bank, Customer) | ## Available Endpoints The available APIs for the [Identity](https://id.production.cybrid.app/api/schema/swagger-ui), [Organization](https://organization.production.cybrid.app/api/schema/swagger-ui) and [Bank](https://bank.production.cybrid.app/api/schema/swagger-ui) API services are listed below: | API Service | Model | API Endpoint Path | Description | |--------------|----------------------|--------------------------------|---------------------------------------------------------------------------------------------------| | Identity | Bank | /api/bank_applications | Create and list banks | | Identity | CustomerToken | /api/customer_tokens | Create customer JWT access tokens | | Identity | Organization | /api/organization_applications | Create and list organizations | | Identity | Organization | /api/users | Create and list organization users | | Organization | Organization | /api/organizations | APIs to retrieve and update organization name | | Bank | Account | /api/accounts | Create and list accounts, which hold a specific asset for a customers | | Bank | Asset | /api/assets | Get a list of assets supported by the platform (ex: BTC, ETH) | | Bank | Bank | /api/banks | Create, update and list banks, the parent to customers, accounts, etc | | Bank | Customer | /api/customers | Create and list customers | | Bank | Counterparty | /api/counterparties | Create and list counterparties | | Bank | DepositAddress | /api/deposit_addresses | Create, get and list deposit addresses | | Bank | ExternalBankAccount | /api/external_bank_accounts | Create, get and list external bank accounts, which connect customer bank accounts to the platform | | Bank | ExternalWallet | /api/external_wallets | Create, get, list and delete external wallets, which connect customer wallets to the platform | | Bank | IdentityVerification | /api/identity_verifications | Create and list identity verifications, which are performed on customers for KYC | | Bank | Invoice | /api/invoices | Create, get, cancel and list invoices | | Bank | PaymentInstruction | /api/payment_instructions | Create, get and list payment instructions for invoices | | Bank | Price | /api/prices | Get the current prices for assets on the platform | | Bank | Quote | /api/quotes | Create and list quotes, which are required to execute trades | | Bank | Symbol | /api/symbols | Get a list of symbols supported for trade (ex: BTC-USD) | | Bank | Trade | /api/trades | Create and list trades, which buy or sell cryptocurrency | | Bank | Transfer | /api/transfers | Create, get and list transfers (e.g., funding, book) | | Bank | Workflow | /api/workflows | Create, get and list workflows | ## Understanding Object Models & Endpoints **Organizations** An `Organization` is meant to represent the organization partnering with Cybrid to use our platform. An `Organization` typically does not directly interact with `customers`. Instead, an Organization has one or more `banks`, which encompass the financial service offerings of the platform. **Banks** A `Bank` is owned by an `Organization` and can be thought of as an environment or container for `customers` and product offerings. Banks are created in either `Sandbox` or `Production` mode, where `Sandbox` is the environment that you would test, prototype and build in prior to moving to `Production`. An `Organization` can have multiple `banks`, in either `Sandbox` or `Production` environments. A `Sandbox Bank` will be backed by stubbed data and process flows. For instance, funding source transfer processes as well as trades will be simulated rather than performed, however asset prices are representative of real-world values. You have an unlimited amount of simulated fiat currency for testing purposes. **Customers** `Customers` represent your banking users on the platform. At present, we offer support for `Individuals` as Customers. `Customers` must be verified (i.e., KYC'd) in our system before they can play any part on the platform, which means they must have an associated and a passing `Identity Verification`. See the Identity Verifications section for more details on how a customer can be verified. `Customers` must also have an `Account` to be able to transact, in the desired asset class. See the Accounts APIs for more details on setting up accounts for the customer.
5
5
 
6
- The version of the OpenAPI document: v0.121.10
6
+ The version of the OpenAPI document: v0.121.12
7
7
  Contact: support@cybrid.app
8
8
  Generated by: https://openapi-generator.tech
9
9
  OpenAPI Generator version: 6.0.0
@@ -14,6 +14,7 @@ require 'date'
14
14
  require 'time'
15
15
 
16
16
  module CybridApiBank
17
+ # Request body for trade creation.
17
18
  class PostTradeBankModel
18
19
  # The type of trade.
19
20
  attr_accessor :trade_type
@@ -82,7 +83,9 @@ module CybridApiBank
82
83
  # List of attributes with nullable: true
83
84
  def self.openapi_nullable
84
85
  Set.new([
86
+ :'trade_type',
85
87
  :'fiat_account_guid',
88
+ :'expected_error',
86
89
  :'labels'
87
90
  ])
88
91
  end
@@ -151,6 +154,10 @@ module CybridApiBank
151
154
  invalid_properties.push('invalid value for "fiat_account_guid", the character length must be great than or equal to 32.')
152
155
  end
153
156
 
157
+ if !@labels.nil? && @labels.length > 8
158
+ invalid_properties.push('invalid value for "labels", number of items must be less than or equal to 8.')
159
+ end
160
+
154
161
  invalid_properties
155
162
  end
156
163
 
@@ -166,6 +173,7 @@ module CybridApiBank
166
173
  return false if !@fiat_account_guid.nil? && @fiat_account_guid.to_s.length < 32
167
174
  expected_error_validator = EnumAttributeValidator.new('String', ["expired_quote", "non_sufficient_funds"])
168
175
  return false unless expected_error_validator.valid?(@expected_error)
176
+ return false if !@labels.nil? && @labels.length > 8
169
177
  true
170
178
  end
171
179
 
@@ -221,6 +229,16 @@ module CybridApiBank
221
229
  @expected_error = expected_error
222
230
  end
223
231
 
232
+ # Custom attribute writer method with validation
233
+ # @param [Object] labels Value to be assigned
234
+ def labels=(labels)
235
+ if !labels.nil? && labels.length > 8
236
+ fail ArgumentError, 'invalid value for "labels", number of items must be less than or equal to 8.'
237
+ end
238
+
239
+ @labels = labels
240
+ end
241
+
224
242
  # Checks equality by comparing each attribute.
225
243
  # @param [Object] Object to be compared
226
244
  def ==(o)