integration_api 1.2.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (613) hide show
  1. checksums.yaml +7 -0
  2. data/Gemfile +7 -0
  3. data/README.md +438 -0
  4. data/Rakefile +8 -0
  5. data/docs/ACHApi.md +878 -0
  6. data/docs/AccountingApi.md +633 -0
  7. data/docs/AccountingCustomerResponseVO.md +9 -0
  8. data/docs/AccountingCustomerRevenueResponseVO.md +9 -0
  9. data/docs/AccountingFinalResponseVO.md +15 -0
  10. data/docs/AccountingInvoicePaymentResponseVO.md +9 -0
  11. data/docs/AccountingInvoiceResponseVO.md +9 -0
  12. data/docs/AccountingStatsResponseVO.md +9 -0
  13. data/docs/AchBalanceResponseVO.md +13 -0
  14. data/docs/AchBankLinkRequestCO.md +10 -0
  15. data/docs/AchBankLinkResponseVO.md +14 -0
  16. data/docs/AchBusinessRequestCO.md +10 -0
  17. data/docs/AchBusinessResponseVO.md +12 -0
  18. data/docs/AchCardLinkRequestCO.md +9 -0
  19. data/docs/AchCardLinkResponseVO.md +12 -0
  20. data/docs/AchClientRequestCO.md +10 -0
  21. data/docs/AchClientResponseVO.md +12 -0
  22. data/docs/AchTransferRequestCO.md +10 -0
  23. data/docs/AchTransferResponseVO.md +14 -0
  24. data/docs/Acquiree.md +10 -0
  25. data/docs/Acquirer.md +10 -0
  26. data/docs/Address.md +15 -0
  27. data/docs/AggregationAccount.md +29 -0
  28. data/docs/AggregationAccountBalance.md +18 -0
  29. data/docs/AggregationAccountBalanceResponseVO.md +11 -0
  30. data/docs/AggregationAccountHolding.md +27 -0
  31. data/docs/AggregationAccountHoldingResponseInternalObjectVO.md +9 -0
  32. data/docs/AggregationAccountHoldingResponseVO.md +11 -0
  33. data/docs/AggregationAccountResponseInternalObjectVO.md +9 -0
  34. data/docs/AggregationAccountResponseVO.md +11 -0
  35. data/docs/AggregationAccountTransaction.md +24 -0
  36. data/docs/AggregationAccountTransactionResponseInternalObjectVO.md +9 -0
  37. data/docs/AggregationAccountTransactionResponseVO.md +12 -0
  38. data/docs/AggregationAccountsResponseVO.md +11 -0
  39. data/docs/AggregationApi.md +722 -0
  40. data/docs/AggregationRequestObject.md +12 -0
  41. data/docs/AggregationVendorRequestCO.md +10 -0
  42. data/docs/ApplePayload.md +10 -0
  43. data/docs/AsyncApi.md +262 -0
  44. data/docs/AsyncTransaction.md +12 -0
  45. data/docs/AsyncTransactionVO.md +10 -0
  46. data/docs/BaasAccountCO.md +9 -0
  47. data/docs/BaasAccountVO.md +16 -0
  48. data/docs/BaasApi.md +551 -0
  49. data/docs/BaasBalanceVO.md +12 -0
  50. data/docs/BaasBusinessVO.md +14 -0
  51. data/docs/BaasClientVO.md +14 -0
  52. data/docs/BaasStatementVO.md +13 -0
  53. data/docs/BaasStatementsVO.md +10 -0
  54. data/docs/BaasSubAccountCO.md +8 -0
  55. data/docs/BaasSubAccountVO.md +15 -0
  56. data/docs/BaasTransactionsVO.md +12 -0
  57. data/docs/BankCredit.md +15 -0
  58. data/docs/BankLink.md +29 -0
  59. data/docs/BankLinkResponseInternalObjectVO.md +9 -0
  60. data/docs/BankLinkVendorDataVO.md +9 -0
  61. data/docs/BaseResponseVO.md +10 -0
  62. data/docs/BrokerageAccountCO.md +9 -0
  63. data/docs/BrokerageAccountVO.md +12 -0
  64. data/docs/BrokerageApi.md +1170 -0
  65. data/docs/BrokerageBalanceVO.md +13 -0
  66. data/docs/BrokerageBankLinkCO.md +8 -0
  67. data/docs/BrokerageBankLinkVO.md +13 -0
  68. data/docs/BrokerageClientCO.md +9 -0
  69. data/docs/BrokerageCreateClientVO.md +12 -0
  70. data/docs/BrokerageDepositCO.md +8 -0
  71. data/docs/BrokerageDepositVO.md +12 -0
  72. data/docs/BrokerageDocumentCO.md +9 -0
  73. data/docs/BrokerageDocumentVO.md +13 -0
  74. data/docs/BrokerageHoldingVO.md +13 -0
  75. data/docs/BrokerageOrderCO.md +8 -0
  76. data/docs/BrokerageOrderVO.md +13 -0
  77. data/docs/BrokeragePerformanceVO.md +13 -0
  78. data/docs/BrokerageSecuritiesVO.md +11 -0
  79. data/docs/BrokerageStatementVO.md +10 -0
  80. data/docs/BrokerageTransactionVO.md +13 -0
  81. data/docs/BrokerageUpdateClientVO.md +13 -0
  82. data/docs/BrokerageWithdrawalCO.md +8 -0
  83. data/docs/BrokerageWithdrawalVO.md +12 -0
  84. data/docs/BusinessAddress.md +14 -0
  85. data/docs/BusinessVendorRequestDataVO.md +22 -0
  86. data/docs/CardApi.md +1684 -0
  87. data/docs/CardAutoReloadRequestCO.md +11 -0
  88. data/docs/CardAutoReloadResponseVO.md +13 -0
  89. data/docs/CardBalanceResponseVO.md +13 -0
  90. data/docs/CardBaseRequestCO.md +10 -0
  91. data/docs/CardBusinessRequestCO.md +8 -0
  92. data/docs/CardClientRequestCO.md +9 -0
  93. data/docs/CardLoadRequestCO.md +9 -0
  94. data/docs/CardLoadUnloadResponseVO.md +14 -0
  95. data/docs/CardPinRequestCO.md +11 -0
  96. data/docs/CardReplaceResponseVO.md +14 -0
  97. data/docs/CardReserveAccountResponseVO.md +14 -0
  98. data/docs/CardSpendingControlRequestCO.md +8 -0
  99. data/docs/CardSpendingControlResponseVO.md +12 -0
  100. data/docs/CardTokenRequestCO.md +11 -0
  101. data/docs/CardTokenResponseVO.md +15 -0
  102. data/docs/CardTransactionResponseVO.md +13 -0
  103. data/docs/CardUnloadRequestCO.md +9 -0
  104. data/docs/CardUpdatePinRequestCO.md +11 -0
  105. data/docs/Cash.md +10 -0
  106. data/docs/ClientAddress.md +15 -0
  107. data/docs/ClientVendorRequestDataVO.md +25 -0
  108. data/docs/CreateBaasBusinessCO.md +9 -0
  109. data/docs/CreateBaasClientCO.md +9 -0
  110. data/docs/CreateBusinessResponseVO.md +12 -0
  111. data/docs/CreateCardClientResponseVO.md +12 -0
  112. data/docs/CreateUserRequest.md +13 -0
  113. data/docs/Customer.md +21 -0
  114. data/docs/CustomerAddress.md +14 -0
  115. data/docs/CustomerRevenue.md +16 -0
  116. data/docs/Dividend.md +10 -0
  117. data/docs/DividendTax.md +9 -0
  118. data/docs/Email.md +26 -0
  119. data/docs/EmailClick.md +11 -0
  120. data/docs/EmailOpen.md +10 -0
  121. data/docs/ExchangePublicTokenVO.md +12 -0
  122. data/docs/ExchangeTokenCO.md +13 -0
  123. data/docs/FinancialStatement.md +23 -0
  124. data/docs/GetCardImageResponseVO.md +12 -0
  125. data/docs/GetCardPciDetailsResponseVO.md +14 -0
  126. data/docs/GetCardStatementResponseVO.md +15 -0
  127. data/docs/GetCardTokenResponseVO.md +15 -0
  128. data/docs/GetTransactionsResponse.md +8 -0
  129. data/docs/GooglePayload.md +8 -0
  130. data/docs/IAVApi.md +126 -0
  131. data/docs/IavAggregationResponseVo.md +9 -0
  132. data/docs/IavBankLinkResponseVo.md +9 -0
  133. data/docs/IavRequestCO.md +14 -0
  134. data/docs/IavResponseVo.md +10 -0
  135. data/docs/IavTokenExchangeVendorResponseVO.md +7 -0
  136. data/docs/IavVendorRequestCO.md +10 -0
  137. data/docs/Identification.md +14 -0
  138. data/docs/Instrument.md +10 -0
  139. data/docs/Investment.md +16 -0
  140. data/docs/Invoice.md +32 -0
  141. data/docs/InvoicePayment.md +15 -0
  142. data/docs/JsonNode.md +28 -0
  143. data/docs/KMSApi.md +314 -0
  144. data/docs/KYCApi.md +135 -0
  145. data/docs/KmsConfig.md +19 -0
  146. data/docs/KycRequestCO.md +16 -0
  147. data/docs/KycResponseVo.md +18 -0
  148. data/docs/KycVendorRequestDataVO.md +30 -0
  149. data/docs/LineItems.md +15 -0
  150. data/docs/Location.md +15 -0
  151. data/docs/Mapstringobject.md +7 -0
  152. data/docs/MarketDataApi.md +122 -0
  153. data/docs/MdHistoryItemVO.md +14 -0
  154. data/docs/MdHistoryRequestCO.md +12 -0
  155. data/docs/MdHistoryResponseVO.md +8 -0
  156. data/docs/MdQuoteItemVO.md +25 -0
  157. data/docs/MdQuoteRequestCO.md +11 -0
  158. data/docs/MdQuoteResponseVO.md +8 -0
  159. data/docs/MergerAcquisition.md +10 -0
  160. data/docs/NucleusTransferFieldsCO.md +9 -0
  161. data/docs/Ownership.md +9 -0
  162. data/docs/PageAchTransferResponseVO.md +16 -0
  163. data/docs/PageKmsConfig.md +16 -0
  164. data/docs/PageWebhook.md +16 -0
  165. data/docs/Pageobject.md +16 -0
  166. data/docs/PoliticallyExposedPersonDTO.md +11 -0
  167. data/docs/PortfolioAssetSizeLog.md +20 -0
  168. data/docs/PropertyValueResponseVO.md +12 -0
  169. data/docs/RTPApi.md +521 -0
  170. data/docs/ResponseEntity.md +10 -0
  171. data/docs/RtpBankLinkRequestCO.md +9 -0
  172. data/docs/RtpBankLinkResponseVO.md +14 -0
  173. data/docs/RtpTransferRequestCO.md +9 -0
  174. data/docs/RtpTransferResponseVO.md +13 -0
  175. data/docs/SMS.md +24 -0
  176. data/docs/SMSApi.md +128 -0
  177. data/docs/SMSResponseVO.md +13 -0
  178. data/docs/SMSVO.md +12 -0
  179. data/docs/SMTPApi.md +128 -0
  180. data/docs/SamsungPayload.md +8 -0
  181. data/docs/SmtpResponseVO.md +13 -0
  182. data/docs/SmtpVO.md +17 -0
  183. data/docs/Sort.md +13 -0
  184. data/docs/SpendingControlVendorRequestDataVO.md +16 -0
  185. data/docs/Stat.md +9 -0
  186. data/docs/Transaction.md +29 -0
  187. data/docs/UpdateBaasBusinessCO.md +8 -0
  188. data/docs/UpdateBaasClientCO.md +8 -0
  189. data/docs/UpdateBusinessResponseVO.md +12 -0
  190. data/docs/UpdateCardClientResponseVO.md +12 -0
  191. data/docs/UserResponseInterface.md +7 -0
  192. data/docs/UserResponseVO.md +13 -0
  193. data/docs/UtilsApi.md +273 -0
  194. data/docs/VendorAccessConfigVO.md +10 -0
  195. data/docs/Webhook.md +15 -0
  196. data/docs/WebhookApi.md +314 -0
  197. data/docs/WidgetUrlVO.md +9 -0
  198. data/docs/WireApi.md +521 -0
  199. data/docs/WireBankLinkRequestCO.md +9 -0
  200. data/docs/WireBankLinkResponseVO.md +14 -0
  201. data/docs/WireTransferRequestCO.md +9 -0
  202. data/docs/WireTransferResponseVO.md +13 -0
  203. data/docs/ZillowPropertyVendorResponseVO.md +12 -0
  204. data/git_push.sh +55 -0
  205. data/integration_api.gemspec +46 -0
  206. data/lib/integration_api.rb +239 -0
  207. data/lib/integration_api/api/accounting_api.rb +597 -0
  208. data/lib/integration_api/api/ach_api.rb +800 -0
  209. data/lib/integration_api/api/aggregation_api.rb +665 -0
  210. data/lib/integration_api/api/async_api.rb +269 -0
  211. data/lib/integration_api/api/baas_api.rb +518 -0
  212. data/lib/integration_api/api/brokerage_api.rb +1089 -0
  213. data/lib/integration_api/api/card_api.rb +1548 -0
  214. data/lib/integration_api/api/iav_api.rb +129 -0
  215. data/lib/integration_api/api/kms_api.rb +301 -0
  216. data/lib/integration_api/api/kyc_api.rb +138 -0
  217. data/lib/integration_api/api/market_data_api.rb +127 -0
  218. data/lib/integration_api/api/rtp_api.rb +479 -0
  219. data/lib/integration_api/api/sms_api.rb +129 -0
  220. data/lib/integration_api/api/smtp_api.rb +129 -0
  221. data/lib/integration_api/api/utils_api.rb +272 -0
  222. data/lib/integration_api/api/webhook_api.rb +301 -0
  223. data/lib/integration_api/api/wire_api.rb +479 -0
  224. data/lib/integration_api/api_client.rb +391 -0
  225. data/lib/integration_api/api_error.rb +38 -0
  226. data/lib/integration_api/auth_configuration.rb +177 -0
  227. data/lib/integration_api/configuration.rb +209 -0
  228. data/lib/integration_api/models/accounting_customer_response_vo.rb +191 -0
  229. data/lib/integration_api/models/accounting_customer_revenue_response_vo.rb +191 -0
  230. data/lib/integration_api/models/accounting_final_response_vo.rb +253 -0
  231. data/lib/integration_api/models/accounting_invoice_payment_response_vo.rb +191 -0
  232. data/lib/integration_api/models/accounting_invoice_response_vo.rb +191 -0
  233. data/lib/integration_api/models/accounting_stats_response_vo.rb +191 -0
  234. data/lib/integration_api/models/ach_balance_response_vo.rb +231 -0
  235. data/lib/integration_api/models/ach_bank_link_request_co.rb +200 -0
  236. data/lib/integration_api/models/ach_bank_link_response_vo.rb +236 -0
  237. data/lib/integration_api/models/ach_business_request_co.rb +200 -0
  238. data/lib/integration_api/models/ach_business_response_vo.rb +218 -0
  239. data/lib/integration_api/models/ach_card_link_request_co.rb +191 -0
  240. data/lib/integration_api/models/ach_card_link_response_vo.rb +218 -0
  241. data/lib/integration_api/models/ach_client_request_co.rb +200 -0
  242. data/lib/integration_api/models/ach_client_response_vo.rb +218 -0
  243. data/lib/integration_api/models/ach_transfer_request_co.rb +200 -0
  244. data/lib/integration_api/models/ach_transfer_response_vo.rb +236 -0
  245. data/lib/integration_api/models/acquiree.rb +200 -0
  246. data/lib/integration_api/models/acquirer.rb +200 -0
  247. data/lib/integration_api/models/address.rb +281 -0
  248. data/lib/integration_api/models/aggregation_account.rb +411 -0
  249. data/lib/integration_api/models/aggregation_account_balance.rb +293 -0
  250. data/lib/integration_api/models/aggregation_account_balance_response_vo.rb +209 -0
  251. data/lib/integration_api/models/aggregation_account_holding.rb +381 -0
  252. data/lib/integration_api/models/aggregation_account_holding_response_internal_object_vo.rb +191 -0
  253. data/lib/integration_api/models/aggregation_account_holding_response_vo.rb +211 -0
  254. data/lib/integration_api/models/aggregation_account_response_internal_object_vo.rb +191 -0
  255. data/lib/integration_api/models/aggregation_account_response_vo.rb +209 -0
  256. data/lib/integration_api/models/aggregation_account_transaction.rb +348 -0
  257. data/lib/integration_api/models/aggregation_account_transaction_response_internal_object_vo.rb +191 -0
  258. data/lib/integration_api/models/aggregation_account_transaction_response_vo.rb +222 -0
  259. data/lib/integration_api/models/aggregation_accounts_response_vo.rb +211 -0
  260. data/lib/integration_api/models/aggregation_request_object.rb +218 -0
  261. data/lib/integration_api/models/aggregation_vendor_request_co.rb +200 -0
  262. data/lib/integration_api/models/apple_payload.rb +200 -0
  263. data/lib/integration_api/models/async_transaction.rb +218 -0
  264. data/lib/integration_api/models/async_transaction_vo.rb +200 -0
  265. data/lib/integration_api/models/baas_account_co.rb +191 -0
  266. data/lib/integration_api/models/baas_account_vo.rb +254 -0
  267. data/lib/integration_api/models/baas_balance_vo.rb +222 -0
  268. data/lib/integration_api/models/baas_business_vo.rb +238 -0
  269. data/lib/integration_api/models/baas_client_vo.rb +238 -0
  270. data/lib/integration_api/models/baas_statement_vo.rb +227 -0
  271. data/lib/integration_api/models/baas_statements_vo.rb +202 -0
  272. data/lib/integration_api/models/baas_sub_account_co.rb +182 -0
  273. data/lib/integration_api/models/baas_sub_account_vo.rb +245 -0
  274. data/lib/integration_api/models/baas_transactions_vo.rb +222 -0
  275. data/lib/integration_api/models/bank_credit.rb +263 -0
  276. data/lib/integration_api/models/bank_link.rb +412 -0
  277. data/lib/integration_api/models/bank_link_response_internal_object_vo.rb +191 -0
  278. data/lib/integration_api/models/bank_link_vendor_data_vo.rb +191 -0
  279. data/lib/integration_api/models/base_response_vo.rb +200 -0
  280. data/lib/integration_api/models/brokerage_account_co.rb +193 -0
  281. data/lib/integration_api/models/brokerage_account_vo.rb +218 -0
  282. data/lib/integration_api/models/brokerage_balance_vo.rb +229 -0
  283. data/lib/integration_api/models/brokerage_bank_link_co.rb +182 -0
  284. data/lib/integration_api/models/brokerage_bank_link_vo.rb +227 -0
  285. data/lib/integration_api/models/brokerage_client_co.rb +193 -0
  286. data/lib/integration_api/models/brokerage_create_client_vo.rb +218 -0
  287. data/lib/integration_api/models/brokerage_deposit_co.rb +182 -0
  288. data/lib/integration_api/models/brokerage_deposit_vo.rb +218 -0
  289. data/lib/integration_api/models/brokerage_document_co.rb +191 -0
  290. data/lib/integration_api/models/brokerage_document_vo.rb +227 -0
  291. data/lib/integration_api/models/brokerage_holding_vo.rb +227 -0
  292. data/lib/integration_api/models/brokerage_order_co.rb +182 -0
  293. data/lib/integration_api/models/brokerage_order_vo.rb +227 -0
  294. data/lib/integration_api/models/brokerage_performance_vo.rb +227 -0
  295. data/lib/integration_api/models/brokerage_securities_vo.rb +209 -0
  296. data/lib/integration_api/models/brokerage_statement_vo.rb +200 -0
  297. data/lib/integration_api/models/brokerage_transaction_vo.rb +227 -0
  298. data/lib/integration_api/models/brokerage_update_client_vo.rb +227 -0
  299. data/lib/integration_api/models/brokerage_withdrawal_co.rb +182 -0
  300. data/lib/integration_api/models/brokerage_withdrawal_vo.rb +218 -0
  301. data/lib/integration_api/models/business_address.rb +244 -0
  302. data/lib/integration_api/models/business_vendor_request_data_vo.rb +314 -0
  303. data/lib/integration_api/models/card_auto_reload_request_co.rb +209 -0
  304. data/lib/integration_api/models/card_auto_reload_response_vo.rb +227 -0
  305. data/lib/integration_api/models/card_balance_response_vo.rb +231 -0
  306. data/lib/integration_api/models/card_base_request_co.rb +200 -0
  307. data/lib/integration_api/models/card_business_request_co.rb +182 -0
  308. data/lib/integration_api/models/card_client_request_co.rb +193 -0
  309. data/lib/integration_api/models/card_load_request_co.rb +191 -0
  310. data/lib/integration_api/models/card_load_unload_response_vo.rb +236 -0
  311. data/lib/integration_api/models/card_pin_request_co.rb +209 -0
  312. data/lib/integration_api/models/card_replace_response_vo.rb +236 -0
  313. data/lib/integration_api/models/card_reserve_account_response_vo.rb +236 -0
  314. data/lib/integration_api/models/card_spending_control_request_co.rb +182 -0
  315. data/lib/integration_api/models/card_spending_control_response_vo.rb +218 -0
  316. data/lib/integration_api/models/card_token_request_co.rb +243 -0
  317. data/lib/integration_api/models/card_token_response_vo.rb +279 -0
  318. data/lib/integration_api/models/card_transaction_response_vo.rb +231 -0
  319. data/lib/integration_api/models/card_unload_request_co.rb +191 -0
  320. data/lib/integration_api/models/card_update_pin_request_co.rb +209 -0
  321. data/lib/integration_api/models/cash.rb +214 -0
  322. data/lib/integration_api/models/client_address.rb +286 -0
  323. data/lib/integration_api/models/client_vendor_request_data_vo.rb +341 -0
  324. data/lib/integration_api/models/create_baas_business_co.rb +193 -0
  325. data/lib/integration_api/models/create_baas_client_co.rb +193 -0
  326. data/lib/integration_api/models/create_business_response_vo.rb +218 -0
  327. data/lib/integration_api/models/create_card_client_response_vo.rb +218 -0
  328. data/lib/integration_api/models/create_user_request.rb +227 -0
  329. data/lib/integration_api/models/customer.rb +318 -0
  330. data/lib/integration_api/models/customer_address.rb +269 -0
  331. data/lib/integration_api/models/customer_revenue.rb +285 -0
  332. data/lib/integration_api/models/dividend.rb +200 -0
  333. data/lib/integration_api/models/dividend_tax.rb +191 -0
  334. data/lib/integration_api/models/email.rb +360 -0
  335. data/lib/integration_api/models/email_click.rb +221 -0
  336. data/lib/integration_api/models/email_open.rb +206 -0
  337. data/lib/integration_api/models/exchange_public_token_vo.rb +218 -0
  338. data/lib/integration_api/models/exchange_token_co.rb +227 -0
  339. data/lib/integration_api/models/financial_statement.rb +353 -0
  340. data/lib/integration_api/models/get_card_image_response_vo.rb +218 -0
  341. data/lib/integration_api/models/get_card_pci_details_response_vo.rb +236 -0
  342. data/lib/integration_api/models/get_card_statement_response_vo.rb +247 -0
  343. data/lib/integration_api/models/get_card_token_response_vo.rb +279 -0
  344. data/lib/integration_api/models/get_transactions_response.rb +184 -0
  345. data/lib/integration_api/models/google_payload.rb +182 -0
  346. data/lib/integration_api/models/iav_aggregation_response_vo.rb +191 -0
  347. data/lib/integration_api/models/iav_bank_link_response_vo.rb +193 -0
  348. data/lib/integration_api/models/iav_request_co.rb +236 -0
  349. data/lib/integration_api/models/iav_response_vo.rb +200 -0
  350. data/lib/integration_api/models/iav_token_exchange_vendor_response_vo.rb +173 -0
  351. data/lib/integration_api/models/iav_vendor_request_co.rb +200 -0
  352. data/lib/integration_api/models/identification.rb +236 -0
  353. data/lib/integration_api/models/instrument.rb +200 -0
  354. data/lib/integration_api/models/investment.rb +284 -0
  355. data/lib/integration_api/models/invoice.rb +453 -0
  356. data/lib/integration_api/models/invoice_payment.rb +270 -0
  357. data/lib/integration_api/models/json_node.rb +396 -0
  358. data/lib/integration_api/models/kms_config.rb +308 -0
  359. data/lib/integration_api/models/kyc_request_co.rb +256 -0
  360. data/lib/integration_api/models/kyc_response_vo.rb +272 -0
  361. data/lib/integration_api/models/kyc_vendor_request_data_vo.rb +386 -0
  362. data/lib/integration_api/models/line_items.rb +279 -0
  363. data/lib/integration_api/models/location.rb +254 -0
  364. data/lib/integration_api/models/mapstringobject.rb +173 -0
  365. data/lib/integration_api/models/md_history_item_vo.rb +236 -0
  366. data/lib/integration_api/models/md_history_request_co.rb +222 -0
  367. data/lib/integration_api/models/md_history_response_vo.rb +184 -0
  368. data/lib/integration_api/models/md_quote_item_vo.rb +335 -0
  369. data/lib/integration_api/models/md_quote_request_co.rb +247 -0
  370. data/lib/integration_api/models/md_quote_response_vo.rb +184 -0
  371. data/lib/integration_api/models/merger_acquisition.rb +200 -0
  372. data/lib/integration_api/models/nucleus_transfer_fields_co.rb +191 -0
  373. data/lib/integration_api/models/ownership.rb +191 -0
  374. data/lib/integration_api/models/page_ach_transfer_response_vo.rb +259 -0
  375. data/lib/integration_api/models/page_kms_config.rb +259 -0
  376. data/lib/integration_api/models/page_webhook.rb +259 -0
  377. data/lib/integration_api/models/pageobject.rb +259 -0
  378. data/lib/integration_api/models/politically_exposed_person_dto.rb +209 -0
  379. data/lib/integration_api/models/portfolio_asset_size_log.rb +330 -0
  380. data/lib/integration_api/models/property_value_response_vo.rb +218 -0
  381. data/lib/integration_api/models/response_entity.rb +234 -0
  382. data/lib/integration_api/models/rtp_bank_link_request_co.rb +191 -0
  383. data/lib/integration_api/models/rtp_bank_link_response_vo.rb +236 -0
  384. data/lib/integration_api/models/rtp_transfer_request_co.rb +191 -0
  385. data/lib/integration_api/models/rtp_transfer_response_vo.rb +227 -0
  386. data/lib/integration_api/models/samsung_payload.rb +182 -0
  387. data/lib/integration_api/models/sms.rb +338 -0
  388. data/lib/integration_api/models/sms_response_vo.rb +227 -0
  389. data/lib/integration_api/models/smsvo.rb +218 -0
  390. data/lib/integration_api/models/smtp_response_vo.rb +227 -0
  391. data/lib/integration_api/models/smtp_vo.rb +263 -0
  392. data/lib/integration_api/models/sort.rb +234 -0
  393. data/lib/integration_api/models/spending_control_vendor_request_data_vo.rb +256 -0
  394. data/lib/integration_api/models/stat.rb +204 -0
  395. data/lib/integration_api/models/transaction.rb +371 -0
  396. data/lib/integration_api/models/update_baas_business_co.rb +184 -0
  397. data/lib/integration_api/models/update_baas_client_co.rb +184 -0
  398. data/lib/integration_api/models/update_business_response_vo.rb +218 -0
  399. data/lib/integration_api/models/update_card_client_response_vo.rb +218 -0
  400. data/lib/integration_api/models/user_response_interface.rb +173 -0
  401. data/lib/integration_api/models/user_response_vo.rb +227 -0
  402. data/lib/integration_api/models/vendor_access_config_vo.rb +203 -0
  403. data/lib/integration_api/models/webhook.rb +280 -0
  404. data/lib/integration_api/models/widget_url_vo.rb +191 -0
  405. data/lib/integration_api/models/wire_bank_link_request_co.rb +191 -0
  406. data/lib/integration_api/models/wire_bank_link_response_vo.rb +236 -0
  407. data/lib/integration_api/models/wire_transfer_request_co.rb +191 -0
  408. data/lib/integration_api/models/wire_transfer_response_vo.rb +227 -0
  409. data/lib/integration_api/models/zillow_property_vendor_response_vo.rb +218 -0
  410. data/lib/integration_api/version.rb +15 -0
  411. data/spec/api/accounting_api_spec.rb +169 -0
  412. data/spec/api/ach_api_spec.rb +207 -0
  413. data/spec/api/aggregation_api_spec.rb +181 -0
  414. data/spec/api/async_api_spec.rb +89 -0
  415. data/spec/api/baas_api_spec.rb +143 -0
  416. data/spec/api/brokerage_api_spec.rb +263 -0
  417. data/spec/api/card_api_spec.rb +363 -0
  418. data/spec/api/iav_api_spec.rb +59 -0
  419. data/spec/api/kms_api_spec.rb +100 -0
  420. data/spec/api/kyc_api_spec.rb +63 -0
  421. data/spec/api/market_data_api_spec.rb +57 -0
  422. data/spec/api/rtp_api_spec.rb +134 -0
  423. data/spec/api/sms_api_spec.rb +59 -0
  424. data/spec/api/smtp_api_spec.rb +59 -0
  425. data/spec/api/utils_api_spec.rb +96 -0
  426. data/spec/api/webhook_api_spec.rb +100 -0
  427. data/spec/api/wire_api_spec.rb +134 -0
  428. data/spec/api_client_spec.rb +243 -0
  429. data/spec/configuration_spec.rb +42 -0
  430. data/spec/models/accounting_customer_response_vo_spec.rb +47 -0
  431. data/spec/models/accounting_customer_revenue_response_vo_spec.rb +47 -0
  432. data/spec/models/accounting_final_response_vo_spec.rb +83 -0
  433. data/spec/models/accounting_invoice_payment_response_vo_spec.rb +47 -0
  434. data/spec/models/accounting_invoice_response_vo_spec.rb +47 -0
  435. data/spec/models/accounting_stats_response_vo_spec.rb +47 -0
  436. data/spec/models/ach_balance_response_vo_spec.rb +71 -0
  437. data/spec/models/ach_bank_link_request_co_spec.rb +53 -0
  438. data/spec/models/ach_bank_link_response_vo_spec.rb +77 -0
  439. data/spec/models/ach_business_request_co_spec.rb +53 -0
  440. data/spec/models/ach_business_response_vo_spec.rb +65 -0
  441. data/spec/models/ach_card_link_request_co_spec.rb +47 -0
  442. data/spec/models/ach_card_link_response_vo_spec.rb +65 -0
  443. data/spec/models/ach_client_request_co_spec.rb +53 -0
  444. data/spec/models/ach_client_response_vo_spec.rb +65 -0
  445. data/spec/models/ach_transfer_request_co_spec.rb +53 -0
  446. data/spec/models/ach_transfer_response_vo_spec.rb +77 -0
  447. data/spec/models/acquiree_spec.rb +53 -0
  448. data/spec/models/acquirer_spec.rb +53 -0
  449. data/spec/models/address_spec.rb +87 -0
  450. data/spec/models/aggregation_account_balance_response_vo_spec.rb +59 -0
  451. data/spec/models/aggregation_account_balance_spec.rb +101 -0
  452. data/spec/models/aggregation_account_holding_response_internal_object_vo_spec.rb +47 -0
  453. data/spec/models/aggregation_account_holding_response_vo_spec.rb +59 -0
  454. data/spec/models/aggregation_account_holding_spec.rb +155 -0
  455. data/spec/models/aggregation_account_response_internal_object_vo_spec.rb +47 -0
  456. data/spec/models/aggregation_account_response_vo_spec.rb +59 -0
  457. data/spec/models/aggregation_account_spec.rb +167 -0
  458. data/spec/models/aggregation_account_transaction_response_internal_object_vo_spec.rb +47 -0
  459. data/spec/models/aggregation_account_transaction_response_vo_spec.rb +65 -0
  460. data/spec/models/aggregation_account_transaction_spec.rb +137 -0
  461. data/spec/models/aggregation_accounts_response_vo_spec.rb +59 -0
  462. data/spec/models/aggregation_request_object_spec.rb +65 -0
  463. data/spec/models/aggregation_vendor_request_co_spec.rb +53 -0
  464. data/spec/models/apple_payload_spec.rb +53 -0
  465. data/spec/models/async_transaction_spec.rb +65 -0
  466. data/spec/models/async_transaction_vo_spec.rb +53 -0
  467. data/spec/models/baas_account_co_spec.rb +47 -0
  468. data/spec/models/baas_account_vo_spec.rb +89 -0
  469. data/spec/models/baas_balance_vo_spec.rb +65 -0
  470. data/spec/models/baas_business_vo_spec.rb +77 -0
  471. data/spec/models/baas_client_vo_spec.rb +77 -0
  472. data/spec/models/baas_statement_vo_spec.rb +71 -0
  473. data/spec/models/baas_statements_vo_spec.rb +53 -0
  474. data/spec/models/baas_sub_account_co_spec.rb +41 -0
  475. data/spec/models/baas_sub_account_vo_spec.rb +83 -0
  476. data/spec/models/baas_transactions_vo_spec.rb +65 -0
  477. data/spec/models/bank_credit_spec.rb +83 -0
  478. data/spec/models/bank_link_response_internal_object_vo_spec.rb +47 -0
  479. data/spec/models/bank_link_spec.rb +167 -0
  480. data/spec/models/bank_link_vendor_data_vo_spec.rb +47 -0
  481. data/spec/models/base_response_vo_spec.rb +53 -0
  482. data/spec/models/brokerage_account_co_spec.rb +47 -0
  483. data/spec/models/brokerage_account_vo_spec.rb +65 -0
  484. data/spec/models/brokerage_balance_vo_spec.rb +71 -0
  485. data/spec/models/brokerage_bank_link_co_spec.rb +41 -0
  486. data/spec/models/brokerage_bank_link_vo_spec.rb +71 -0
  487. data/spec/models/brokerage_client_co_spec.rb +47 -0
  488. data/spec/models/brokerage_create_client_vo_spec.rb +65 -0
  489. data/spec/models/brokerage_deposit_co_spec.rb +41 -0
  490. data/spec/models/brokerage_deposit_vo_spec.rb +65 -0
  491. data/spec/models/brokerage_document_co_spec.rb +47 -0
  492. data/spec/models/brokerage_document_vo_spec.rb +71 -0
  493. data/spec/models/brokerage_holding_vo_spec.rb +71 -0
  494. data/spec/models/brokerage_order_co_spec.rb +41 -0
  495. data/spec/models/brokerage_order_vo_spec.rb +71 -0
  496. data/spec/models/brokerage_performance_vo_spec.rb +71 -0
  497. data/spec/models/brokerage_securities_vo_spec.rb +59 -0
  498. data/spec/models/brokerage_statement_vo_spec.rb +53 -0
  499. data/spec/models/brokerage_transaction_vo_spec.rb +71 -0
  500. data/spec/models/brokerage_update_client_vo_spec.rb +71 -0
  501. data/spec/models/brokerage_withdrawal_co_spec.rb +41 -0
  502. data/spec/models/brokerage_withdrawal_vo_spec.rb +65 -0
  503. data/spec/models/business_address_spec.rb +77 -0
  504. data/spec/models/business_vendor_request_data_vo_spec.rb +125 -0
  505. data/spec/models/card_auto_reload_request_co_spec.rb +59 -0
  506. data/spec/models/card_auto_reload_response_vo_spec.rb +71 -0
  507. data/spec/models/card_balance_response_vo_spec.rb +71 -0
  508. data/spec/models/card_base_request_co_spec.rb +53 -0
  509. data/spec/models/card_business_request_co_spec.rb +41 -0
  510. data/spec/models/card_client_request_co_spec.rb +47 -0
  511. data/spec/models/card_load_request_co_spec.rb +47 -0
  512. data/spec/models/card_load_unload_response_vo_spec.rb +77 -0
  513. data/spec/models/card_pin_request_co_spec.rb +59 -0
  514. data/spec/models/card_replace_response_vo_spec.rb +77 -0
  515. data/spec/models/card_reserve_account_response_vo_spec.rb +77 -0
  516. data/spec/models/card_spending_control_request_co_spec.rb +41 -0
  517. data/spec/models/card_spending_control_response_vo_spec.rb +65 -0
  518. data/spec/models/card_token_request_co_spec.rb +63 -0
  519. data/spec/models/card_token_response_vo_spec.rb +87 -0
  520. data/spec/models/card_transaction_response_vo_spec.rb +71 -0
  521. data/spec/models/card_unload_request_co_spec.rb +47 -0
  522. data/spec/models/card_update_pin_request_co_spec.rb +59 -0
  523. data/spec/models/cash_spec.rb +53 -0
  524. data/spec/models/client_address_spec.rb +87 -0
  525. data/spec/models/client_vendor_request_data_vo_spec.rb +143 -0
  526. data/spec/models/create_baas_business_co_spec.rb +47 -0
  527. data/spec/models/create_baas_client_co_spec.rb +47 -0
  528. data/spec/models/create_business_response_vo_spec.rb +65 -0
  529. data/spec/models/create_card_client_response_vo_spec.rb +65 -0
  530. data/spec/models/create_user_request_spec.rb +71 -0
  531. data/spec/models/customer_address_spec.rb +77 -0
  532. data/spec/models/customer_revenue_spec.rb +89 -0
  533. data/spec/models/customer_spec.rb +119 -0
  534. data/spec/models/dividend_spec.rb +53 -0
  535. data/spec/models/dividend_tax_spec.rb +47 -0
  536. data/spec/models/email_click_spec.rb +59 -0
  537. data/spec/models/email_open_spec.rb +53 -0
  538. data/spec/models/email_spec.rb +149 -0
  539. data/spec/models/exchange_public_token_vo_spec.rb +65 -0
  540. data/spec/models/exchange_token_co_spec.rb +71 -0
  541. data/spec/models/financial_statement_spec.rb +131 -0
  542. data/spec/models/get_card_image_response_vo_spec.rb +65 -0
  543. data/spec/models/get_card_pci_details_response_vo_spec.rb +77 -0
  544. data/spec/models/get_card_statement_response_vo_spec.rb +83 -0
  545. data/spec/models/get_card_token_response_vo_spec.rb +87 -0
  546. data/spec/models/get_transactions_response_spec.rb +41 -0
  547. data/spec/models/google_payload_spec.rb +41 -0
  548. data/spec/models/iav_aggregation_response_vo_spec.rb +47 -0
  549. data/spec/models/iav_bank_link_response_vo_spec.rb +47 -0
  550. data/spec/models/iav_request_co_spec.rb +77 -0
  551. data/spec/models/iav_response_vo_spec.rb +53 -0
  552. data/spec/models/iav_token_exchange_vendor_response_vo_spec.rb +35 -0
  553. data/spec/models/iav_vendor_request_co_spec.rb +53 -0
  554. data/spec/models/identification_spec.rb +77 -0
  555. data/spec/models/instrument_spec.rb +53 -0
  556. data/spec/models/investment_spec.rb +89 -0
  557. data/spec/models/invoice_payment_spec.rb +83 -0
  558. data/spec/models/invoice_spec.rb +185 -0
  559. data/spec/models/json_node_spec.rb +165 -0
  560. data/spec/models/kms_config_spec.rb +107 -0
  561. data/spec/models/kyc_request_co_spec.rb +89 -0
  562. data/spec/models/kyc_response_vo_spec.rb +101 -0
  563. data/spec/models/kyc_vendor_request_data_vo_spec.rb +173 -0
  564. data/spec/models/line_items_spec.rb +83 -0
  565. data/spec/models/location_spec.rb +83 -0
  566. data/spec/models/mapstringobject_spec.rb +35 -0
  567. data/spec/models/md_history_item_vo_spec.rb +77 -0
  568. data/spec/models/md_history_request_co_spec.rb +65 -0
  569. data/spec/models/md_history_response_vo_spec.rb +41 -0
  570. data/spec/models/md_quote_item_vo_spec.rb +143 -0
  571. data/spec/models/md_quote_request_co_spec.rb +63 -0
  572. data/spec/models/md_quote_response_vo_spec.rb +41 -0
  573. data/spec/models/merger_acquisition_spec.rb +53 -0
  574. data/spec/models/nucleus_transfer_fields_co_spec.rb +47 -0
  575. data/spec/models/ownership_spec.rb +47 -0
  576. data/spec/models/page_ach_transfer_response_vo_spec.rb +89 -0
  577. data/spec/models/page_kms_config_spec.rb +89 -0
  578. data/spec/models/page_webhook_spec.rb +89 -0
  579. data/spec/models/pageobject_spec.rb +89 -0
  580. data/spec/models/politically_exposed_person_dto_spec.rb +59 -0
  581. data/spec/models/portfolio_asset_size_log_spec.rb +113 -0
  582. data/spec/models/property_value_response_vo_spec.rb +65 -0
  583. data/spec/models/response_entity_spec.rb +57 -0
  584. data/spec/models/rtp_bank_link_request_co_spec.rb +47 -0
  585. data/spec/models/rtp_bank_link_response_vo_spec.rb +77 -0
  586. data/spec/models/rtp_transfer_request_co_spec.rb +47 -0
  587. data/spec/models/rtp_transfer_response_vo_spec.rb +71 -0
  588. data/spec/models/samsung_payload_spec.rb +41 -0
  589. data/spec/models/sms_response_vo_spec.rb +71 -0
  590. data/spec/models/sms_spec.rb +137 -0
  591. data/spec/models/smsvo_spec.rb +65 -0
  592. data/spec/models/smtp_response_vo_spec.rb +71 -0
  593. data/spec/models/smtp_vo_spec.rb +95 -0
  594. data/spec/models/sort_spec.rb +71 -0
  595. data/spec/models/spending_control_vendor_request_data_vo_spec.rb +89 -0
  596. data/spec/models/stat_spec.rb +47 -0
  597. data/spec/models/transaction_spec.rb +167 -0
  598. data/spec/models/update_baas_business_co_spec.rb +41 -0
  599. data/spec/models/update_baas_client_co_spec.rb +41 -0
  600. data/spec/models/update_business_response_vo_spec.rb +65 -0
  601. data/spec/models/update_card_client_response_vo_spec.rb +65 -0
  602. data/spec/models/user_response_interface_spec.rb +35 -0
  603. data/spec/models/user_response_vo_spec.rb +71 -0
  604. data/spec/models/vendor_access_config_vo_spec.rb +53 -0
  605. data/spec/models/webhook_spec.rb +87 -0
  606. data/spec/models/widget_url_vo_spec.rb +47 -0
  607. data/spec/models/wire_bank_link_request_co_spec.rb +47 -0
  608. data/spec/models/wire_bank_link_response_vo_spec.rb +77 -0
  609. data/spec/models/wire_transfer_request_co_spec.rb +47 -0
  610. data/spec/models/wire_transfer_response_vo_spec.rb +71 -0
  611. data/spec/models/zillow_property_vendor_response_vo_spec.rb +65 -0
  612. data/spec/spec_helper.rb +111 -0
  613. metadata +1056 -0
@@ -0,0 +1,12 @@
1
+ # IntegrationApi::BaasBalanceVO
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **message** | **String** | | [optional]
7
+ **nucleus_asset_sizes_posted** | **Array<Object>** | | [optional]
8
+ **nucleus_asset_sizes_updated** | **Array<Object>** | | [optional]
9
+ **nucleus_portfolio_id** | **String** | | [optional]
10
+ **vendor_name** | **Object** | | [optional]
11
+
12
+
@@ -0,0 +1,14 @@
1
+ # IntegrationApi::BaasBusinessVO
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **message** | **String** | | [optional]
7
+ **nucleus_business_id** | **String** | | [optional]
8
+ **nucleus_document_id** | **Array<String>** | | [optional]
9
+ **status** | **String** | | [optional]
10
+ **vendor_name** | **String** | | [optional]
11
+ **vendor_request_data** | [**BusinessVendorRequestDataVO**](BusinessVendorRequestDataVO.md) | | [optional]
12
+ **vendor_response** | **Object** | | [optional]
13
+
14
+
@@ -0,0 +1,14 @@
1
+ # IntegrationApi::BaasClientVO
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **message** | **String** | | [optional]
7
+ **nucleus_client_id** | **String** | | [optional]
8
+ **nucleus_document_id** | **Array<String>** | | [optional]
9
+ **status** | **String** | | [optional]
10
+ **vendor_name** | **String** | | [optional]
11
+ **vendor_request_data** | [**ClientVendorRequestDataVO**](ClientVendorRequestDataVO.md) | | [optional]
12
+ **vendor_response** | **Object** | | [optional]
13
+
14
+
@@ -0,0 +1,13 @@
1
+ # IntegrationApi::BaasStatementVO
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **statement_content** | **Object** | | [optional]
7
+ **statement_content_type** | **String** | | [optional]
8
+ **statement_date** | **String** | | [optional]
9
+ **statement_link** | **String** | | [optional]
10
+ **statement_link_expiry** | **String** | | [optional]
11
+ **statement_name** | **String** | | [optional]
12
+
13
+
@@ -0,0 +1,10 @@
1
+ # IntegrationApi::BaasStatementsVO
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **nucleus_account_id** | **String** | | [optional]
7
+ **statements** | [**Array<BaasStatementVO>**](BaasStatementVO.md) | | [optional]
8
+ **vendor_name** | **Object** | | [optional]
9
+
10
+
@@ -0,0 +1,8 @@
1
+ # IntegrationApi::BaasSubAccountCO
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **nucleus_portfolio_id** | **String** | | [optional]
7
+
8
+
@@ -0,0 +1,15 @@
1
+ # IntegrationApi::BaasSubAccountVO
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **account_number** | **String** | | [optional]
7
+ **account_status** | **String** | | [optional]
8
+ **message** | **String** | | [optional]
9
+ **nucleus_client_id** | **String** | | [optional]
10
+ **nucleus_portfolio_id** | **String** | | [optional]
11
+ **status** | **String** | | [optional]
12
+ **vendor_name** | **String** | | [optional]
13
+ **vendor_response** | **Object** | | [optional]
14
+
15
+
@@ -0,0 +1,12 @@
1
+ # IntegrationApi::BaasTransactionsVO
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **message** | **String** | | [optional]
7
+ **nucleus_portfolio_id** | **String** | | [optional]
8
+ **nucleus_transactions_posted** | **Array<Object>** | | [optional]
9
+ **nucleus_transactions_updated** | **Array<Object>** | | [optional]
10
+ **vendor_name** | **Object** | | [optional]
11
+
12
+
@@ -0,0 +1,15 @@
1
+ # IntegrationApi::BankCredit
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **amount** | **Float** | amount |
7
+ **category** | **String** | category | [optional]
8
+ **description** | **String** | description | [optional]
9
+ **location** | [**Location**](Location.md) | | [optional]
10
+ **memo** | **String** | memo | [optional]
11
+ **merchant** | **String** | merchant | [optional]
12
+ **subcategory** | **String** | subcategory | [optional]
13
+ **transaction_type** | **String** | transactionType |
14
+
15
+
data/docs/BankLink.md ADDED
@@ -0,0 +1,29 @@
1
+ # IntegrationApi::BankLink
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **account_id** | **String** | accountId | [optional]
7
+ **available_balance** | **Float** | available_balance | [optional]
8
+ **balance** | **Float** | balance | [optional]
9
+ **bank_account_holder** | **String** | bankAccountHolder |
10
+ **bank_account_name** | **String** | bankAccountName | [optional]
11
+ **bank_account_number** | **String** | bankAccountNumber |
12
+ **client_id** | **String** | Bank link Client Id | [optional]
13
+ **create_date** | **DateTime** | | [optional]
14
+ **currency_code** | **String** | currency_code | [optional]
15
+ **id** | **String** | | [optional]
16
+ **is_active** | **BOOLEAN** | isActive | [optional]
17
+ **is_default** | **BOOLEAN** | isDefault | [optional]
18
+ **is_link_verified** | **BOOLEAN** | isLinkVerified | [optional]
19
+ **link_verified_date** | **Date** | linkVerifiedDate | [optional]
20
+ **mask** | **String** | mask | [optional]
21
+ **metadata** | **Hash<String, String>** | metadata | [optional]
22
+ **name** | **String** | name |
23
+ **routing** | **String** | routing |
24
+ **routing_wire** | **String** | routing_wire | [optional]
25
+ **secondary_id** | **String** | | [optional]
26
+ **type** | **String** | type | [optional]
27
+ **update_date** | **DateTime** | | [optional]
28
+
29
+
@@ -0,0 +1,9 @@
1
+ # IntegrationApi::BankLinkResponseInternalObjectVO
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **nucleus_bank_link** | [**BankLink**](BankLink.md) | | [optional]
7
+ **status_code** | **Integer** | | [optional]
8
+
9
+
@@ -0,0 +1,9 @@
1
+ # IntegrationApi::BankLinkVendorDataVO
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **bank_account_name** | **String** | | [optional]
7
+ **name** | **String** | | [optional]
8
+
9
+
@@ -0,0 +1,10 @@
1
+ # IntegrationApi::BaseResponseVO
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **message** | **String** | | [optional]
7
+ **vendor_name** | **String** | | [optional]
8
+ **vendor_response** | **Object** | | [optional]
9
+
10
+
@@ -0,0 +1,9 @@
1
+ # IntegrationApi::BrokerageAccountCO
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **nucleus_account_id** | **String** | | [optional]
7
+ **nucleus_document_ids** | **Array<String>** | | [optional]
8
+
9
+
@@ -0,0 +1,12 @@
1
+ # IntegrationApi::BrokerageAccountVO
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **message** | **String** | | [optional]
7
+ **nucleus_account_id** | **String** | | [optional]
8
+ **status** | **String** | | [optional]
9
+ **vendor_name** | **String** | | [optional]
10
+ **vendor_response** | **Object** | | [optional]
11
+
12
+
@@ -0,0 +1,1170 @@
1
+ # IntegrationApi::BrokerageApi
2
+
3
+ All URIs are relative to *https://sandbox.hydrogenplatform.com/integration/v1*
4
+
5
+ Method | HTTP request | Description
6
+ ------------- | ------------- | -------------
7
+ [**cancel_order_using_put**](BrokerageApi.md#cancel_order_using_put) | **PUT** /brokerage/order/{nucleus_order_id} | Cancel an Order
8
+ [**create_bank_link_using_post1**](BrokerageApi.md#create_bank_link_using_post1) | **POST** /brokerage/bank_link | create a Bank Link
9
+ [**create_brokerage_account_using_post**](BrokerageApi.md#create_brokerage_account_using_post) | **POST** /brokerage/account | create a Brokerage account
10
+ [**create_brokerage_client_using_post**](BrokerageApi.md#create_brokerage_client_using_post) | **POST** /brokerage/client | Create a Brokerage Client
11
+ [**create_deposit_using_post**](BrokerageApi.md#create_deposit_using_post) | **POST** /brokerage/deposit | Create a deposit
12
+ [**create_document_using_post**](BrokerageApi.md#create_document_using_post) | **POST** /brokerage/document | Create a Brokerage document
13
+ [**create_order_using_post**](BrokerageApi.md#create_order_using_post) | **POST** /brokerage/order | Create an Order
14
+ [**create_withdrawal_using_post**](BrokerageApi.md#create_withdrawal_using_post) | **POST** /brokerage/withdrawal | Create a withdrawal
15
+ [**delete_bank_link_using_delete1**](BrokerageApi.md#delete_bank_link_using_delete1) | **DELETE** /brokerage/bank_link/{nucleus_bank_link_id} | Delete a Bank Link
16
+ [**get_balance_using_get1**](BrokerageApi.md#get_balance_using_get1) | **GET** /brokerage/balance/{nucleus_portfolio_id} | Get account balance
17
+ [**get_bank_link_using_get1**](BrokerageApi.md#get_bank_link_using_get1) | **GET** /brokerage/bank_link/{nucleus_bank_link_id} | Get a Bank Link
18
+ [**get_brokerage_account_statement_using_get**](BrokerageApi.md#get_brokerage_account_statement_using_get) | **GET** /brokerage/statement/{nucleus_account_id} | Get a Brokerage account statement
19
+ [**get_document_using_get**](BrokerageApi.md#get_document_using_get) | **GET** /brokerage/document/{nucleus_document_id} | Get a Brokerage document
20
+ [**get_holding_performance_using_get**](BrokerageApi.md#get_holding_performance_using_get) | **GET** /brokerage/holding/performance/{nucleus_portfolio_id} | Get portfolio holding performance
21
+ [**get_holding_using_get**](BrokerageApi.md#get_holding_using_get) | **GET** /brokerage/holding/{nucleus_portfolio_id} | Get portfolio holdings
22
+ [**get_order_using_get**](BrokerageApi.md#get_order_using_get) | **GET** /brokerage/order/{nucleus_order_id} | Get an Order
23
+ [**get_securities_using_get**](BrokerageApi.md#get_securities_using_get) | **GET** /brokerage/securities | Get securities information
24
+ [**get_transactions_using_get**](BrokerageApi.md#get_transactions_using_get) | **GET** /brokerage/transaction/{nucleus_portfolio_id} | Get account transactions
25
+ [**update_bank_link_using_put1**](BrokerageApi.md#update_bank_link_using_put1) | **PUT** /brokerage/bank_link/{nucleus_bank_link_id} | Update a Bank Link
26
+ [**update_brokerage_client_using_put**](BrokerageApi.md#update_brokerage_client_using_put) | **PUT** /brokerage/client | Update a Brokerage client
27
+
28
+
29
+ # **cancel_order_using_put**
30
+ > cancel_order_using_put(nucleus_order_id)
31
+
32
+ Cancel an Order
33
+
34
+ ### Example
35
+ ```ruby
36
+ # load the gem
37
+ require 'integration_api'
38
+
39
+ # Setup authorization
40
+ IntegrationApi.configure do |config|
41
+ # Use one of the below method to generate oauth token
42
+ # Creating a token for grant_type=client_credentials
43
+ config.create_client_credential("CLIENT_ID", "CLIENT_SECRET");
44
+ # Creating a token for grant_type=password
45
+ config.create_password_credential("CLIENT_ID", "CLIENT_SECRET", "USERNAME", "PASSWORD");
46
+ # Creating a token using client token
47
+ config.create_client_token_credential("CLIENT_ID", "CLIENT_SECRET", "CLIENT_TOKEN");
48
+ end
49
+
50
+ api_instance = IntegrationApi::BrokerageApi.new
51
+
52
+ nucleus_order_id = 'nucleus_order_id_example' # String | nucleus_order_id
53
+
54
+
55
+ begin
56
+ #Cancel an Order
57
+ api_instance.cancel_order_using_put(nucleus_order_id)
58
+ rescue IntegrationApi::ApiError => e
59
+ puts "Exception when calling BrokerageApi->cancel_order_using_put: #{e}"
60
+ end
61
+ ```
62
+
63
+ ### Parameters
64
+
65
+ Name | Type | Description | Notes
66
+ ------------- | ------------- | ------------- | -------------
67
+ **nucleus_order_id** | [**String**](.md)| nucleus_order_id |
68
+
69
+ ### Return type
70
+
71
+ nil (empty response body)
72
+
73
+ ### Authorization
74
+
75
+ [oauth2](../README.md#oauth2)
76
+
77
+ ### HTTP request headers
78
+
79
+ - **Content-Type**: application/json
80
+ - **Accept**: */*
81
+
82
+
83
+
84
+ # **create_bank_link_using_post1**
85
+ > BrokerageBankLinkVO create_bank_link_using_post1(brokerage_bank_link_co)
86
+
87
+ create a Bank Link
88
+
89
+ ### Example
90
+ ```ruby
91
+ # load the gem
92
+ require 'integration_api'
93
+
94
+ # Setup authorization
95
+ IntegrationApi.configure do |config|
96
+ # Use one of the below method to generate oauth token
97
+ # Creating a token for grant_type=client_credentials
98
+ config.create_client_credential("CLIENT_ID", "CLIENT_SECRET");
99
+ # Creating a token for grant_type=password
100
+ config.create_password_credential("CLIENT_ID", "CLIENT_SECRET", "USERNAME", "PASSWORD");
101
+ # Creating a token using client token
102
+ config.create_client_token_credential("CLIENT_ID", "CLIENT_SECRET", "CLIENT_TOKEN");
103
+ end
104
+
105
+ api_instance = IntegrationApi::BrokerageApi.new
106
+
107
+ brokerage_bank_link_co = IntegrationApi::BrokerageBankLinkCO.new # BrokerageBankLinkCO | brokerageBankLinkCO
108
+
109
+
110
+ begin
111
+ #create a Bank Link
112
+ result = api_instance.create_bank_link_using_post1(brokerage_bank_link_co)
113
+ p result
114
+ rescue IntegrationApi::ApiError => e
115
+ puts "Exception when calling BrokerageApi->create_bank_link_using_post1: #{e}"
116
+ end
117
+ ```
118
+
119
+ ### Parameters
120
+
121
+ Name | Type | Description | Notes
122
+ ------------- | ------------- | ------------- | -------------
123
+ **brokerage_bank_link_co** | [**BrokerageBankLinkCO**](BrokerageBankLinkCO.md)| brokerageBankLinkCO |
124
+
125
+ ### Return type
126
+
127
+ [**BrokerageBankLinkVO**](BrokerageBankLinkVO.md)
128
+
129
+ ### Authorization
130
+
131
+ [oauth2](../README.md#oauth2)
132
+
133
+ ### HTTP request headers
134
+
135
+ - **Content-Type**: application/json
136
+ - **Accept**: */*
137
+
138
+
139
+
140
+ # **create_brokerage_account_using_post**
141
+ > BrokerageAccountVO create_brokerage_account_using_post(brokerage_account_co)
142
+
143
+ create a Brokerage account
144
+
145
+ ### Example
146
+ ```ruby
147
+ # load the gem
148
+ require 'integration_api'
149
+
150
+ # Setup authorization
151
+ IntegrationApi.configure do |config|
152
+ # Use one of the below method to generate oauth token
153
+ # Creating a token for grant_type=client_credentials
154
+ config.create_client_credential("CLIENT_ID", "CLIENT_SECRET");
155
+ # Creating a token for grant_type=password
156
+ config.create_password_credential("CLIENT_ID", "CLIENT_SECRET", "USERNAME", "PASSWORD");
157
+ # Creating a token using client token
158
+ config.create_client_token_credential("CLIENT_ID", "CLIENT_SECRET", "CLIENT_TOKEN");
159
+ end
160
+
161
+ api_instance = IntegrationApi::BrokerageApi.new
162
+
163
+ brokerage_account_co = IntegrationApi::BrokerageAccountCO.new # BrokerageAccountCO | brokerageAccountCO
164
+
165
+
166
+ begin
167
+ #create a Brokerage account
168
+ result = api_instance.create_brokerage_account_using_post(brokerage_account_co)
169
+ p result
170
+ rescue IntegrationApi::ApiError => e
171
+ puts "Exception when calling BrokerageApi->create_brokerage_account_using_post: #{e}"
172
+ end
173
+ ```
174
+
175
+ ### Parameters
176
+
177
+ Name | Type | Description | Notes
178
+ ------------- | ------------- | ------------- | -------------
179
+ **brokerage_account_co** | [**BrokerageAccountCO**](BrokerageAccountCO.md)| brokerageAccountCO |
180
+
181
+ ### Return type
182
+
183
+ [**BrokerageAccountVO**](BrokerageAccountVO.md)
184
+
185
+ ### Authorization
186
+
187
+ [oauth2](../README.md#oauth2)
188
+
189
+ ### HTTP request headers
190
+
191
+ - **Content-Type**: application/json
192
+ - **Accept**: */*
193
+
194
+
195
+
196
+ # **create_brokerage_client_using_post**
197
+ > BrokerageCreateClientVO create_brokerage_client_using_post(client_co)
198
+
199
+ Create a Brokerage Client
200
+
201
+ ### Example
202
+ ```ruby
203
+ # load the gem
204
+ require 'integration_api'
205
+
206
+ # Setup authorization
207
+ IntegrationApi.configure do |config|
208
+ # Use one of the below method to generate oauth token
209
+ # Creating a token for grant_type=client_credentials
210
+ config.create_client_credential("CLIENT_ID", "CLIENT_SECRET");
211
+ # Creating a token for grant_type=password
212
+ config.create_password_credential("CLIENT_ID", "CLIENT_SECRET", "USERNAME", "PASSWORD");
213
+ # Creating a token using client token
214
+ config.create_client_token_credential("CLIENT_ID", "CLIENT_SECRET", "CLIENT_TOKEN");
215
+ end
216
+
217
+ api_instance = IntegrationApi::BrokerageApi.new
218
+
219
+ client_co = IntegrationApi::BrokerageClientCO.new # BrokerageClientCO | clientCO
220
+
221
+
222
+ begin
223
+ #Create a Brokerage Client
224
+ result = api_instance.create_brokerage_client_using_post(client_co)
225
+ p result
226
+ rescue IntegrationApi::ApiError => e
227
+ puts "Exception when calling BrokerageApi->create_brokerage_client_using_post: #{e}"
228
+ end
229
+ ```
230
+
231
+ ### Parameters
232
+
233
+ Name | Type | Description | Notes
234
+ ------------- | ------------- | ------------- | -------------
235
+ **client_co** | [**BrokerageClientCO**](BrokerageClientCO.md)| clientCO |
236
+
237
+ ### Return type
238
+
239
+ [**BrokerageCreateClientVO**](BrokerageCreateClientVO.md)
240
+
241
+ ### Authorization
242
+
243
+ [oauth2](../README.md#oauth2)
244
+
245
+ ### HTTP request headers
246
+
247
+ - **Content-Type**: application/json
248
+ - **Accept**: */*
249
+
250
+
251
+
252
+ # **create_deposit_using_post**
253
+ > BrokerageDepositVO create_deposit_using_post(brokerage_deposit_co)
254
+
255
+ Create a deposit
256
+
257
+ ### Example
258
+ ```ruby
259
+ # load the gem
260
+ require 'integration_api'
261
+
262
+ # Setup authorization
263
+ IntegrationApi.configure do |config|
264
+ # Use one of the below method to generate oauth token
265
+ # Creating a token for grant_type=client_credentials
266
+ config.create_client_credential("CLIENT_ID", "CLIENT_SECRET");
267
+ # Creating a token for grant_type=password
268
+ config.create_password_credential("CLIENT_ID", "CLIENT_SECRET", "USERNAME", "PASSWORD");
269
+ # Creating a token using client token
270
+ config.create_client_token_credential("CLIENT_ID", "CLIENT_SECRET", "CLIENT_TOKEN");
271
+ end
272
+
273
+ api_instance = IntegrationApi::BrokerageApi.new
274
+
275
+ brokerage_deposit_co = IntegrationApi::BrokerageDepositCO.new # BrokerageDepositCO | brokerageDepositCO
276
+
277
+
278
+ begin
279
+ #Create a deposit
280
+ result = api_instance.create_deposit_using_post(brokerage_deposit_co)
281
+ p result
282
+ rescue IntegrationApi::ApiError => e
283
+ puts "Exception when calling BrokerageApi->create_deposit_using_post: #{e}"
284
+ end
285
+ ```
286
+
287
+ ### Parameters
288
+
289
+ Name | Type | Description | Notes
290
+ ------------- | ------------- | ------------- | -------------
291
+ **brokerage_deposit_co** | [**BrokerageDepositCO**](BrokerageDepositCO.md)| brokerageDepositCO |
292
+
293
+ ### Return type
294
+
295
+ [**BrokerageDepositVO**](BrokerageDepositVO.md)
296
+
297
+ ### Authorization
298
+
299
+ [oauth2](../README.md#oauth2)
300
+
301
+ ### HTTP request headers
302
+
303
+ - **Content-Type**: application/json
304
+ - **Accept**: */*
305
+
306
+
307
+
308
+ # **create_document_using_post**
309
+ > BrokerageDocumentVO create_document_using_post(document_co)
310
+
311
+ Create a Brokerage document
312
+
313
+ ### Example
314
+ ```ruby
315
+ # load the gem
316
+ require 'integration_api'
317
+
318
+ # Setup authorization
319
+ IntegrationApi.configure do |config|
320
+ # Use one of the below method to generate oauth token
321
+ # Creating a token for grant_type=client_credentials
322
+ config.create_client_credential("CLIENT_ID", "CLIENT_SECRET");
323
+ # Creating a token for grant_type=password
324
+ config.create_password_credential("CLIENT_ID", "CLIENT_SECRET", "USERNAME", "PASSWORD");
325
+ # Creating a token using client token
326
+ config.create_client_token_credential("CLIENT_ID", "CLIENT_SECRET", "CLIENT_TOKEN");
327
+ end
328
+
329
+ api_instance = IntegrationApi::BrokerageApi.new
330
+
331
+ document_co = IntegrationApi::BrokerageDocumentCO.new # BrokerageDocumentCO | documentCO
332
+
333
+
334
+ begin
335
+ #Create a Brokerage document
336
+ result = api_instance.create_document_using_post(document_co)
337
+ p result
338
+ rescue IntegrationApi::ApiError => e
339
+ puts "Exception when calling BrokerageApi->create_document_using_post: #{e}"
340
+ end
341
+ ```
342
+
343
+ ### Parameters
344
+
345
+ Name | Type | Description | Notes
346
+ ------------- | ------------- | ------------- | -------------
347
+ **document_co** | [**BrokerageDocumentCO**](BrokerageDocumentCO.md)| documentCO |
348
+
349
+ ### Return type
350
+
351
+ [**BrokerageDocumentVO**](BrokerageDocumentVO.md)
352
+
353
+ ### Authorization
354
+
355
+ [oauth2](../README.md#oauth2)
356
+
357
+ ### HTTP request headers
358
+
359
+ - **Content-Type**: application/json
360
+ - **Accept**: */*
361
+
362
+
363
+
364
+ # **create_order_using_post**
365
+ > BrokerageOrderVO create_order_using_post(brokerage_order_co)
366
+
367
+ Create an Order
368
+
369
+ ### Example
370
+ ```ruby
371
+ # load the gem
372
+ require 'integration_api'
373
+
374
+ # Setup authorization
375
+ IntegrationApi.configure do |config|
376
+ # Use one of the below method to generate oauth token
377
+ # Creating a token for grant_type=client_credentials
378
+ config.create_client_credential("CLIENT_ID", "CLIENT_SECRET");
379
+ # Creating a token for grant_type=password
380
+ config.create_password_credential("CLIENT_ID", "CLIENT_SECRET", "USERNAME", "PASSWORD");
381
+ # Creating a token using client token
382
+ config.create_client_token_credential("CLIENT_ID", "CLIENT_SECRET", "CLIENT_TOKEN");
383
+ end
384
+
385
+ api_instance = IntegrationApi::BrokerageApi.new
386
+
387
+ brokerage_order_co = IntegrationApi::BrokerageOrderCO.new # BrokerageOrderCO | brokerageOrderCO
388
+
389
+
390
+ begin
391
+ #Create an Order
392
+ result = api_instance.create_order_using_post(brokerage_order_co)
393
+ p result
394
+ rescue IntegrationApi::ApiError => e
395
+ puts "Exception when calling BrokerageApi->create_order_using_post: #{e}"
396
+ end
397
+ ```
398
+
399
+ ### Parameters
400
+
401
+ Name | Type | Description | Notes
402
+ ------------- | ------------- | ------------- | -------------
403
+ **brokerage_order_co** | [**BrokerageOrderCO**](BrokerageOrderCO.md)| brokerageOrderCO |
404
+
405
+ ### Return type
406
+
407
+ [**BrokerageOrderVO**](BrokerageOrderVO.md)
408
+
409
+ ### Authorization
410
+
411
+ [oauth2](../README.md#oauth2)
412
+
413
+ ### HTTP request headers
414
+
415
+ - **Content-Type**: application/json
416
+ - **Accept**: */*
417
+
418
+
419
+
420
+ # **create_withdrawal_using_post**
421
+ > BrokerageWithdrawalVO create_withdrawal_using_post(brokerage_withdrawal_co)
422
+
423
+ Create a withdrawal
424
+
425
+ ### Example
426
+ ```ruby
427
+ # load the gem
428
+ require 'integration_api'
429
+
430
+ # Setup authorization
431
+ IntegrationApi.configure do |config|
432
+ # Use one of the below method to generate oauth token
433
+ # Creating a token for grant_type=client_credentials
434
+ config.create_client_credential("CLIENT_ID", "CLIENT_SECRET");
435
+ # Creating a token for grant_type=password
436
+ config.create_password_credential("CLIENT_ID", "CLIENT_SECRET", "USERNAME", "PASSWORD");
437
+ # Creating a token using client token
438
+ config.create_client_token_credential("CLIENT_ID", "CLIENT_SECRET", "CLIENT_TOKEN");
439
+ end
440
+
441
+ api_instance = IntegrationApi::BrokerageApi.new
442
+
443
+ brokerage_withdrawal_co = IntegrationApi::BrokerageWithdrawalCO.new # BrokerageWithdrawalCO | brokerageWithdrawalCO
444
+
445
+
446
+ begin
447
+ #Create a withdrawal
448
+ result = api_instance.create_withdrawal_using_post(brokerage_withdrawal_co)
449
+ p result
450
+ rescue IntegrationApi::ApiError => e
451
+ puts "Exception when calling BrokerageApi->create_withdrawal_using_post: #{e}"
452
+ end
453
+ ```
454
+
455
+ ### Parameters
456
+
457
+ Name | Type | Description | Notes
458
+ ------------- | ------------- | ------------- | -------------
459
+ **brokerage_withdrawal_co** | [**BrokerageWithdrawalCO**](BrokerageWithdrawalCO.md)| brokerageWithdrawalCO |
460
+
461
+ ### Return type
462
+
463
+ [**BrokerageWithdrawalVO**](BrokerageWithdrawalVO.md)
464
+
465
+ ### Authorization
466
+
467
+ [oauth2](../README.md#oauth2)
468
+
469
+ ### HTTP request headers
470
+
471
+ - **Content-Type**: application/json
472
+ - **Accept**: */*
473
+
474
+
475
+
476
+ # **delete_bank_link_using_delete1**
477
+ > delete_bank_link_using_delete1(nucleus_bank_link_id)
478
+
479
+ Delete a Bank Link
480
+
481
+ ### Example
482
+ ```ruby
483
+ # load the gem
484
+ require 'integration_api'
485
+
486
+ # Setup authorization
487
+ IntegrationApi.configure do |config|
488
+ # Use one of the below method to generate oauth token
489
+ # Creating a token for grant_type=client_credentials
490
+ config.create_client_credential("CLIENT_ID", "CLIENT_SECRET");
491
+ # Creating a token for grant_type=password
492
+ config.create_password_credential("CLIENT_ID", "CLIENT_SECRET", "USERNAME", "PASSWORD");
493
+ # Creating a token using client token
494
+ config.create_client_token_credential("CLIENT_ID", "CLIENT_SECRET", "CLIENT_TOKEN");
495
+ end
496
+
497
+ api_instance = IntegrationApi::BrokerageApi.new
498
+
499
+ nucleus_bank_link_id = 'nucleus_bank_link_id_example' # String | nucleus_bank_link_id
500
+
501
+
502
+ begin
503
+ #Delete a Bank Link
504
+ api_instance.delete_bank_link_using_delete1(nucleus_bank_link_id)
505
+ rescue IntegrationApi::ApiError => e
506
+ puts "Exception when calling BrokerageApi->delete_bank_link_using_delete1: #{e}"
507
+ end
508
+ ```
509
+
510
+ ### Parameters
511
+
512
+ Name | Type | Description | Notes
513
+ ------------- | ------------- | ------------- | -------------
514
+ **nucleus_bank_link_id** | [**String**](.md)| nucleus_bank_link_id |
515
+
516
+ ### Return type
517
+
518
+ nil (empty response body)
519
+
520
+ ### Authorization
521
+
522
+ [oauth2](../README.md#oauth2)
523
+
524
+ ### HTTP request headers
525
+
526
+ - **Content-Type**: Not defined
527
+ - **Accept**: */*
528
+
529
+
530
+
531
+ # **get_balance_using_get1**
532
+ > BrokerageBalanceVO get_balance_using_get1(nucleus_portfolio_id)
533
+
534
+ Get account balance
535
+
536
+ ### Example
537
+ ```ruby
538
+ # load the gem
539
+ require 'integration_api'
540
+
541
+ # Setup authorization
542
+ IntegrationApi.configure do |config|
543
+ # Use one of the below method to generate oauth token
544
+ # Creating a token for grant_type=client_credentials
545
+ config.create_client_credential("CLIENT_ID", "CLIENT_SECRET");
546
+ # Creating a token for grant_type=password
547
+ config.create_password_credential("CLIENT_ID", "CLIENT_SECRET", "USERNAME", "PASSWORD");
548
+ # Creating a token using client token
549
+ config.create_client_token_credential("CLIENT_ID", "CLIENT_SECRET", "CLIENT_TOKEN");
550
+ end
551
+
552
+ api_instance = IntegrationApi::BrokerageApi.new
553
+
554
+ nucleus_portfolio_id = 'nucleus_portfolio_id_example' # String | nucleus_portfolio_id
555
+
556
+
557
+ begin
558
+ #Get account balance
559
+ result = api_instance.get_balance_using_get1(nucleus_portfolio_id)
560
+ p result
561
+ rescue IntegrationApi::ApiError => e
562
+ puts "Exception when calling BrokerageApi->get_balance_using_get1: #{e}"
563
+ end
564
+ ```
565
+
566
+ ### Parameters
567
+
568
+ Name | Type | Description | Notes
569
+ ------------- | ------------- | ------------- | -------------
570
+ **nucleus_portfolio_id** | [**String**](.md)| nucleus_portfolio_id |
571
+
572
+ ### Return type
573
+
574
+ [**BrokerageBalanceVO**](BrokerageBalanceVO.md)
575
+
576
+ ### Authorization
577
+
578
+ [oauth2](../README.md#oauth2)
579
+
580
+ ### HTTP request headers
581
+
582
+ - **Content-Type**: Not defined
583
+ - **Accept**: */*
584
+
585
+
586
+
587
+ # **get_bank_link_using_get1**
588
+ > BrokerageBankLinkVO get_bank_link_using_get1(nucleus_bank_link_id)
589
+
590
+ Get a Bank Link
591
+
592
+ ### Example
593
+ ```ruby
594
+ # load the gem
595
+ require 'integration_api'
596
+
597
+ # Setup authorization
598
+ IntegrationApi.configure do |config|
599
+ # Use one of the below method to generate oauth token
600
+ # Creating a token for grant_type=client_credentials
601
+ config.create_client_credential("CLIENT_ID", "CLIENT_SECRET");
602
+ # Creating a token for grant_type=password
603
+ config.create_password_credential("CLIENT_ID", "CLIENT_SECRET", "USERNAME", "PASSWORD");
604
+ # Creating a token using client token
605
+ config.create_client_token_credential("CLIENT_ID", "CLIENT_SECRET", "CLIENT_TOKEN");
606
+ end
607
+
608
+ api_instance = IntegrationApi::BrokerageApi.new
609
+
610
+ nucleus_bank_link_id = 'nucleus_bank_link_id_example' # String | nucleus_bank_link_id
611
+
612
+
613
+ begin
614
+ #Get a Bank Link
615
+ result = api_instance.get_bank_link_using_get1(nucleus_bank_link_id)
616
+ p result
617
+ rescue IntegrationApi::ApiError => e
618
+ puts "Exception when calling BrokerageApi->get_bank_link_using_get1: #{e}"
619
+ end
620
+ ```
621
+
622
+ ### Parameters
623
+
624
+ Name | Type | Description | Notes
625
+ ------------- | ------------- | ------------- | -------------
626
+ **nucleus_bank_link_id** | [**String**](.md)| nucleus_bank_link_id |
627
+
628
+ ### Return type
629
+
630
+ [**BrokerageBankLinkVO**](BrokerageBankLinkVO.md)
631
+
632
+ ### Authorization
633
+
634
+ [oauth2](../README.md#oauth2)
635
+
636
+ ### HTTP request headers
637
+
638
+ - **Content-Type**: Not defined
639
+ - **Accept**: */*
640
+
641
+
642
+
643
+ # **get_brokerage_account_statement_using_get**
644
+ > BrokerageStatementVO get_brokerage_account_statement_using_get(end_date, nucleus_account_id, start_date, statement_type)
645
+
646
+ Get a Brokerage account statement
647
+
648
+ ### Example
649
+ ```ruby
650
+ # load the gem
651
+ require 'integration_api'
652
+
653
+ # Setup authorization
654
+ IntegrationApi.configure do |config|
655
+ # Use one of the below method to generate oauth token
656
+ # Creating a token for grant_type=client_credentials
657
+ config.create_client_credential("CLIENT_ID", "CLIENT_SECRET");
658
+ # Creating a token for grant_type=password
659
+ config.create_password_credential("CLIENT_ID", "CLIENT_SECRET", "USERNAME", "PASSWORD");
660
+ # Creating a token using client token
661
+ config.create_client_token_credential("CLIENT_ID", "CLIENT_SECRET", "CLIENT_TOKEN");
662
+ end
663
+
664
+ api_instance = IntegrationApi::BrokerageApi.new
665
+
666
+ end_date = DateTime.parse('2013-10-20T19:20:30+01:00') # DateTime | end_date
667
+
668
+ nucleus_account_id = 'nucleus_account_id_example' # String | nucleus_account_id
669
+
670
+ start_date = DateTime.parse('2013-10-20T19:20:30+01:00') # DateTime | start_date
671
+
672
+ statement_type = 'statement_type_example' # String | statement_type
673
+
674
+
675
+ begin
676
+ #Get a Brokerage account statement
677
+ result = api_instance.get_brokerage_account_statement_using_get(end_date, nucleus_account_id, start_date, statement_type)
678
+ p result
679
+ rescue IntegrationApi::ApiError => e
680
+ puts "Exception when calling BrokerageApi->get_brokerage_account_statement_using_get: #{e}"
681
+ end
682
+ ```
683
+
684
+ ### Parameters
685
+
686
+ Name | Type | Description | Notes
687
+ ------------- | ------------- | ------------- | -------------
688
+ **end_date** | **DateTime**| end_date |
689
+ **nucleus_account_id** | [**String**](.md)| nucleus_account_id |
690
+ **start_date** | **DateTime**| start_date |
691
+ **statement_type** | **String**| statement_type |
692
+
693
+ ### Return type
694
+
695
+ [**BrokerageStatementVO**](BrokerageStatementVO.md)
696
+
697
+ ### Authorization
698
+
699
+ [oauth2](../README.md#oauth2)
700
+
701
+ ### HTTP request headers
702
+
703
+ - **Content-Type**: Not defined
704
+ - **Accept**: */*
705
+
706
+
707
+
708
+ # **get_document_using_get**
709
+ > BrokerageDocumentVO get_document_using_get(nucleus_document_id)
710
+
711
+ Get a Brokerage document
712
+
713
+ ### Example
714
+ ```ruby
715
+ # load the gem
716
+ require 'integration_api'
717
+
718
+ # Setup authorization
719
+ IntegrationApi.configure do |config|
720
+ # Use one of the below method to generate oauth token
721
+ # Creating a token for grant_type=client_credentials
722
+ config.create_client_credential("CLIENT_ID", "CLIENT_SECRET");
723
+ # Creating a token for grant_type=password
724
+ config.create_password_credential("CLIENT_ID", "CLIENT_SECRET", "USERNAME", "PASSWORD");
725
+ # Creating a token using client token
726
+ config.create_client_token_credential("CLIENT_ID", "CLIENT_SECRET", "CLIENT_TOKEN");
727
+ end
728
+
729
+ api_instance = IntegrationApi::BrokerageApi.new
730
+
731
+ nucleus_document_id = 'nucleus_document_id_example' # String | nucleus_document_id
732
+
733
+
734
+ begin
735
+ #Get a Brokerage document
736
+ result = api_instance.get_document_using_get(nucleus_document_id)
737
+ p result
738
+ rescue IntegrationApi::ApiError => e
739
+ puts "Exception when calling BrokerageApi->get_document_using_get: #{e}"
740
+ end
741
+ ```
742
+
743
+ ### Parameters
744
+
745
+ Name | Type | Description | Notes
746
+ ------------- | ------------- | ------------- | -------------
747
+ **nucleus_document_id** | [**String**](.md)| nucleus_document_id |
748
+
749
+ ### Return type
750
+
751
+ [**BrokerageDocumentVO**](BrokerageDocumentVO.md)
752
+
753
+ ### Authorization
754
+
755
+ [oauth2](../README.md#oauth2)
756
+
757
+ ### HTTP request headers
758
+
759
+ - **Content-Type**: Not defined
760
+ - **Accept**: */*
761
+
762
+
763
+
764
+ # **get_holding_performance_using_get**
765
+ > BrokeragePerformanceVO get_holding_performance_using_get(nucleus_portfolio_id)
766
+
767
+ Get portfolio holding performance
768
+
769
+ ### Example
770
+ ```ruby
771
+ # load the gem
772
+ require 'integration_api'
773
+
774
+ # Setup authorization
775
+ IntegrationApi.configure do |config|
776
+ # Use one of the below method to generate oauth token
777
+ # Creating a token for grant_type=client_credentials
778
+ config.create_client_credential("CLIENT_ID", "CLIENT_SECRET");
779
+ # Creating a token for grant_type=password
780
+ config.create_password_credential("CLIENT_ID", "CLIENT_SECRET", "USERNAME", "PASSWORD");
781
+ # Creating a token using client token
782
+ config.create_client_token_credential("CLIENT_ID", "CLIENT_SECRET", "CLIENT_TOKEN");
783
+ end
784
+
785
+ api_instance = IntegrationApi::BrokerageApi.new
786
+
787
+ nucleus_portfolio_id = 'nucleus_portfolio_id_example' # String | nucleus_portfolio_id
788
+
789
+
790
+ begin
791
+ #Get portfolio holding performance
792
+ result = api_instance.get_holding_performance_using_get(nucleus_portfolio_id)
793
+ p result
794
+ rescue IntegrationApi::ApiError => e
795
+ puts "Exception when calling BrokerageApi->get_holding_performance_using_get: #{e}"
796
+ end
797
+ ```
798
+
799
+ ### Parameters
800
+
801
+ Name | Type | Description | Notes
802
+ ------------- | ------------- | ------------- | -------------
803
+ **nucleus_portfolio_id** | [**String**](.md)| nucleus_portfolio_id |
804
+
805
+ ### Return type
806
+
807
+ [**BrokeragePerformanceVO**](BrokeragePerformanceVO.md)
808
+
809
+ ### Authorization
810
+
811
+ [oauth2](../README.md#oauth2)
812
+
813
+ ### HTTP request headers
814
+
815
+ - **Content-Type**: Not defined
816
+ - **Accept**: */*
817
+
818
+
819
+
820
+ # **get_holding_using_get**
821
+ > BrokerageHoldingVO get_holding_using_get(nucleus_portfolio_id)
822
+
823
+ Get portfolio holdings
824
+
825
+ ### Example
826
+ ```ruby
827
+ # load the gem
828
+ require 'integration_api'
829
+
830
+ # Setup authorization
831
+ IntegrationApi.configure do |config|
832
+ # Use one of the below method to generate oauth token
833
+ # Creating a token for grant_type=client_credentials
834
+ config.create_client_credential("CLIENT_ID", "CLIENT_SECRET");
835
+ # Creating a token for grant_type=password
836
+ config.create_password_credential("CLIENT_ID", "CLIENT_SECRET", "USERNAME", "PASSWORD");
837
+ # Creating a token using client token
838
+ config.create_client_token_credential("CLIENT_ID", "CLIENT_SECRET", "CLIENT_TOKEN");
839
+ end
840
+
841
+ api_instance = IntegrationApi::BrokerageApi.new
842
+
843
+ nucleus_portfolio_id = 'nucleus_portfolio_id_example' # String | nucleus_portfolio_id
844
+
845
+
846
+ begin
847
+ #Get portfolio holdings
848
+ result = api_instance.get_holding_using_get(nucleus_portfolio_id)
849
+ p result
850
+ rescue IntegrationApi::ApiError => e
851
+ puts "Exception when calling BrokerageApi->get_holding_using_get: #{e}"
852
+ end
853
+ ```
854
+
855
+ ### Parameters
856
+
857
+ Name | Type | Description | Notes
858
+ ------------- | ------------- | ------------- | -------------
859
+ **nucleus_portfolio_id** | [**String**](.md)| nucleus_portfolio_id |
860
+
861
+ ### Return type
862
+
863
+ [**BrokerageHoldingVO**](BrokerageHoldingVO.md)
864
+
865
+ ### Authorization
866
+
867
+ [oauth2](../README.md#oauth2)
868
+
869
+ ### HTTP request headers
870
+
871
+ - **Content-Type**: Not defined
872
+ - **Accept**: */*
873
+
874
+
875
+
876
+ # **get_order_using_get**
877
+ > BrokerageOrderVO get_order_using_get(nucleus_order_id)
878
+
879
+ Get an Order
880
+
881
+ ### Example
882
+ ```ruby
883
+ # load the gem
884
+ require 'integration_api'
885
+
886
+ # Setup authorization
887
+ IntegrationApi.configure do |config|
888
+ # Use one of the below method to generate oauth token
889
+ # Creating a token for grant_type=client_credentials
890
+ config.create_client_credential("CLIENT_ID", "CLIENT_SECRET");
891
+ # Creating a token for grant_type=password
892
+ config.create_password_credential("CLIENT_ID", "CLIENT_SECRET", "USERNAME", "PASSWORD");
893
+ # Creating a token using client token
894
+ config.create_client_token_credential("CLIENT_ID", "CLIENT_SECRET", "CLIENT_TOKEN");
895
+ end
896
+
897
+ api_instance = IntegrationApi::BrokerageApi.new
898
+
899
+ nucleus_order_id = 'nucleus_order_id_example' # String | nucleus_order_id
900
+
901
+
902
+ begin
903
+ #Get an Order
904
+ result = api_instance.get_order_using_get(nucleus_order_id)
905
+ p result
906
+ rescue IntegrationApi::ApiError => e
907
+ puts "Exception when calling BrokerageApi->get_order_using_get: #{e}"
908
+ end
909
+ ```
910
+
911
+ ### Parameters
912
+
913
+ Name | Type | Description | Notes
914
+ ------------- | ------------- | ------------- | -------------
915
+ **nucleus_order_id** | [**String**](.md)| nucleus_order_id |
916
+
917
+ ### Return type
918
+
919
+ [**BrokerageOrderVO**](BrokerageOrderVO.md)
920
+
921
+ ### Authorization
922
+
923
+ [oauth2](../README.md#oauth2)
924
+
925
+ ### HTTP request headers
926
+
927
+ - **Content-Type**: Not defined
928
+ - **Accept**: */*
929
+
930
+
931
+
932
+ # **get_securities_using_get**
933
+ > BrokerageSecuritiesVO get_securities_using_get(vendor_name, opts)
934
+
935
+ Get securities information
936
+
937
+ ### Example
938
+ ```ruby
939
+ # load the gem
940
+ require 'integration_api'
941
+
942
+ # Setup authorization
943
+ IntegrationApi.configure do |config|
944
+ # Use one of the below method to generate oauth token
945
+ # Creating a token for grant_type=client_credentials
946
+ config.create_client_credential("CLIENT_ID", "CLIENT_SECRET");
947
+ # Creating a token for grant_type=password
948
+ config.create_password_credential("CLIENT_ID", "CLIENT_SECRET", "USERNAME", "PASSWORD");
949
+ # Creating a token using client token
950
+ config.create_client_token_credential("CLIENT_ID", "CLIENT_SECRET", "CLIENT_TOKEN");
951
+ end
952
+
953
+ api_instance = IntegrationApi::BrokerageApi.new
954
+
955
+ vendor_name = 'vendor_name_example' # String | vendor_name
956
+
957
+ opts = {
958
+ get_fundamentals: false, # BOOLEAN | get_fundamentals
959
+ nucleus_security_id: 'nucleus_security_id_example' # String | nucleus_security_id
960
+ }
961
+
962
+ begin
963
+ #Get securities information
964
+ result = api_instance.get_securities_using_get(vendor_name, opts)
965
+ p result
966
+ rescue IntegrationApi::ApiError => e
967
+ puts "Exception when calling BrokerageApi->get_securities_using_get: #{e}"
968
+ end
969
+ ```
970
+
971
+ ### Parameters
972
+
973
+ Name | Type | Description | Notes
974
+ ------------- | ------------- | ------------- | -------------
975
+ **vendor_name** | **String**| vendor_name |
976
+ **get_fundamentals** | **BOOLEAN**| get_fundamentals | [optional] [default to false]
977
+ **nucleus_security_id** | [**String**](.md)| nucleus_security_id | [optional]
978
+
979
+ ### Return type
980
+
981
+ [**BrokerageSecuritiesVO**](BrokerageSecuritiesVO.md)
982
+
983
+ ### Authorization
984
+
985
+ [oauth2](../README.md#oauth2)
986
+
987
+ ### HTTP request headers
988
+
989
+ - **Content-Type**: Not defined
990
+ - **Accept**: */*
991
+
992
+
993
+
994
+ # **get_transactions_using_get**
995
+ > BrokerageTransactionVO get_transactions_using_get(drivewealth_response, end_date, nucleus_portfolio_id, start_date)
996
+
997
+ Get account transactions
998
+
999
+ ### Example
1000
+ ```ruby
1001
+ # load the gem
1002
+ require 'integration_api'
1003
+
1004
+ # Setup authorization
1005
+ IntegrationApi.configure do |config|
1006
+ # Use one of the below method to generate oauth token
1007
+ # Creating a token for grant_type=client_credentials
1008
+ config.create_client_credential("CLIENT_ID", "CLIENT_SECRET");
1009
+ # Creating a token for grant_type=password
1010
+ config.create_password_credential("CLIENT_ID", "CLIENT_SECRET", "USERNAME", "PASSWORD");
1011
+ # Creating a token using client token
1012
+ config.create_client_token_credential("CLIENT_ID", "CLIENT_SECRET", "CLIENT_TOKEN");
1013
+ end
1014
+
1015
+ api_instance = IntegrationApi::BrokerageApi.new
1016
+
1017
+ drivewealth_response = IntegrationApi::GetTransactionsResponse.new # GetTransactionsResponse | drivewealthResponse
1018
+
1019
+ end_date = Date.parse('2013-10-20') # Date | end_date
1020
+
1021
+ nucleus_portfolio_id = 'nucleus_portfolio_id_example' # String | nucleus_portfolio_id
1022
+
1023
+ start_date = Date.parse('2013-10-20') # Date | start_date
1024
+
1025
+
1026
+ begin
1027
+ #Get account transactions
1028
+ result = api_instance.get_transactions_using_get(drivewealth_response, end_date, nucleus_portfolio_id, start_date)
1029
+ p result
1030
+ rescue IntegrationApi::ApiError => e
1031
+ puts "Exception when calling BrokerageApi->get_transactions_using_get: #{e}"
1032
+ end
1033
+ ```
1034
+
1035
+ ### Parameters
1036
+
1037
+ Name | Type | Description | Notes
1038
+ ------------- | ------------- | ------------- | -------------
1039
+ **drivewealth_response** | [**GetTransactionsResponse**](GetTransactionsResponse.md)| drivewealthResponse |
1040
+ **end_date** | **Date**| end_date |
1041
+ **nucleus_portfolio_id** | [**String**](.md)| nucleus_portfolio_id |
1042
+ **start_date** | **Date**| start_date |
1043
+
1044
+ ### Return type
1045
+
1046
+ [**BrokerageTransactionVO**](BrokerageTransactionVO.md)
1047
+
1048
+ ### Authorization
1049
+
1050
+ [oauth2](../README.md#oauth2)
1051
+
1052
+ ### HTTP request headers
1053
+
1054
+ - **Content-Type**: Not defined
1055
+ - **Accept**: */*
1056
+
1057
+
1058
+
1059
+ # **update_bank_link_using_put1**
1060
+ > BrokerageBankLinkVO update_bank_link_using_put1(nucleus_bank_link_id)
1061
+
1062
+ Update a Bank Link
1063
+
1064
+ ### Example
1065
+ ```ruby
1066
+ # load the gem
1067
+ require 'integration_api'
1068
+
1069
+ # Setup authorization
1070
+ IntegrationApi.configure do |config|
1071
+ # Use one of the below method to generate oauth token
1072
+ # Creating a token for grant_type=client_credentials
1073
+ config.create_client_credential("CLIENT_ID", "CLIENT_SECRET");
1074
+ # Creating a token for grant_type=password
1075
+ config.create_password_credential("CLIENT_ID", "CLIENT_SECRET", "USERNAME", "PASSWORD");
1076
+ # Creating a token using client token
1077
+ config.create_client_token_credential("CLIENT_ID", "CLIENT_SECRET", "CLIENT_TOKEN");
1078
+ end
1079
+
1080
+ api_instance = IntegrationApi::BrokerageApi.new
1081
+
1082
+ nucleus_bank_link_id = 'nucleus_bank_link_id_example' # String | nucleus_bank_link_id
1083
+
1084
+
1085
+ begin
1086
+ #Update a Bank Link
1087
+ result = api_instance.update_bank_link_using_put1(nucleus_bank_link_id)
1088
+ p result
1089
+ rescue IntegrationApi::ApiError => e
1090
+ puts "Exception when calling BrokerageApi->update_bank_link_using_put1: #{e}"
1091
+ end
1092
+ ```
1093
+
1094
+ ### Parameters
1095
+
1096
+ Name | Type | Description | Notes
1097
+ ------------- | ------------- | ------------- | -------------
1098
+ **nucleus_bank_link_id** | [**String**](.md)| nucleus_bank_link_id |
1099
+
1100
+ ### Return type
1101
+
1102
+ [**BrokerageBankLinkVO**](BrokerageBankLinkVO.md)
1103
+
1104
+ ### Authorization
1105
+
1106
+ [oauth2](../README.md#oauth2)
1107
+
1108
+ ### HTTP request headers
1109
+
1110
+ - **Content-Type**: application/json
1111
+ - **Accept**: */*
1112
+
1113
+
1114
+
1115
+ # **update_brokerage_client_using_put**
1116
+ > BrokerageUpdateClientVO update_brokerage_client_using_put(client_co)
1117
+
1118
+ Update a Brokerage client
1119
+
1120
+ ### Example
1121
+ ```ruby
1122
+ # load the gem
1123
+ require 'integration_api'
1124
+
1125
+ # Setup authorization
1126
+ IntegrationApi.configure do |config|
1127
+ # Use one of the below method to generate oauth token
1128
+ # Creating a token for grant_type=client_credentials
1129
+ config.create_client_credential("CLIENT_ID", "CLIENT_SECRET");
1130
+ # Creating a token for grant_type=password
1131
+ config.create_password_credential("CLIENT_ID", "CLIENT_SECRET", "USERNAME", "PASSWORD");
1132
+ # Creating a token using client token
1133
+ config.create_client_token_credential("CLIENT_ID", "CLIENT_SECRET", "CLIENT_TOKEN");
1134
+ end
1135
+
1136
+ api_instance = IntegrationApi::BrokerageApi.new
1137
+
1138
+ client_co = IntegrationApi::BrokerageClientCO.new # BrokerageClientCO | clientCO
1139
+
1140
+
1141
+ begin
1142
+ #Update a Brokerage client
1143
+ result = api_instance.update_brokerage_client_using_put(client_co)
1144
+ p result
1145
+ rescue IntegrationApi::ApiError => e
1146
+ puts "Exception when calling BrokerageApi->update_brokerage_client_using_put: #{e}"
1147
+ end
1148
+ ```
1149
+
1150
+ ### Parameters
1151
+
1152
+ Name | Type | Description | Notes
1153
+ ------------- | ------------- | ------------- | -------------
1154
+ **client_co** | [**BrokerageClientCO**](BrokerageClientCO.md)| clientCO |
1155
+
1156
+ ### Return type
1157
+
1158
+ [**BrokerageUpdateClientVO**](BrokerageUpdateClientVO.md)
1159
+
1160
+ ### Authorization
1161
+
1162
+ [oauth2](../README.md#oauth2)
1163
+
1164
+ ### HTTP request headers
1165
+
1166
+ - **Content-Type**: application/json
1167
+ - **Accept**: */*
1168
+
1169
+
1170
+