fuse_client 0.3.1 → 0.3.4

Sign up to get free protection for your applications and to get access to all the features.
Files changed (254) hide show
  1. checksums.yaml +4 -4
  2. data/{fuse-ruby-openapi/Gemfile → Gemfile} +0 -0
  3. data/Gemfile.lock +70 -0
  4. data/LICENSE +21 -0
  5. data/README.md +1 -0
  6. data/{fuse-ruby-openapi/Rakefile → Rakefile} +0 -0
  7. data/docs/Aggregator.md +15 -0
  8. data/{fuse-ruby-openapi/docs → docs}/CreateAssetReportRequest.md +3 -1
  9. data/{fuse-ruby-openapi/docs → docs}/CreateAssetReportResponse.md +0 -0
  10. data/docs/CreateEntityRequest.md +24 -0
  11. data/docs/CreateEntityResponse.md +24 -0
  12. data/{fuse-ruby-openapi/docs → docs}/CreateLinkTokenRequest.md +5 -5
  13. data/{fuse-ruby-openapi/docs → docs}/CreateLinkTokenRequestMx.md +1 -1
  14. data/docs/CreateLinkTokenRequestPlaid.md +18 -0
  15. data/{fuse-ruby-openapi/docs → docs}/CreateLinkTokenResponse.md +0 -0
  16. data/docs/CreateSessionRequest.md +20 -0
  17. data/{fuse-ruby-openapi/docs → docs}/CreateSessionResponse.md +0 -0
  18. data/{fuse-ruby-openapi/docs → docs}/ExchangeFinancialConnectionsPublicTokenRequest.md +0 -0
  19. data/{fuse-ruby-openapi/docs → docs}/ExchangeFinancialConnectionsPublicTokenResponse.md +0 -0
  20. data/{fuse-ruby-openapi/docs → docs}/FinancialConnectionsAccount.md +0 -0
  21. data/{fuse-ruby-openapi/docs → docs}/FinancialConnectionsAccountBalance.md +0 -0
  22. data/{fuse-ruby-openapi/docs → docs}/FinancialConnectionsAccountDetails.md +1 -3
  23. data/{fuse-ruby-openapi/docs → docs}/FinancialConnectionsAccountDetailsAch.md +0 -0
  24. data/{fuse-ruby-openapi/docs → docs}/FinancialConnectionsAccountInstitution.md +0 -0
  25. data/{fuse-ruby-openapi/docs → docs}/FinancialConnectionsAccountLiability.md +0 -0
  26. data/{fuse-ruby-openapi/docs → docs}/FinancialConnectionsAccountLiabilityAllOf.md +0 -0
  27. data/{fuse-ruby-openapi/docs → docs}/FinancialConnectionsAccountLiabilityAllOfAprs.md +0 -0
  28. data/{fuse-ruby-openapi/docs → docs}/FinancialConnectionsHolding.md +2 -0
  29. data/{fuse-ruby-openapi/docs → docs}/FinancialConnectionsInvestmentAccount.md +0 -0
  30. data/{fuse-ruby-openapi/docs → docs}/FinancialConnectionsInvestmentSecurity.md +0 -0
  31. data/{fuse-ruby-openapi/docs → docs}/FinancialConnectionsInvestmentTransaction.md +0 -0
  32. data/{fuse-ruby-openapi/docs → docs}/FinancialConnectionsInvestmentTransactionDataInner.md +0 -0
  33. data/{fuse-ruby-openapi/docs → docs}/FinancialConnectionsOwner.md +0 -0
  34. data/{fuse-ruby-openapi/docs → docs}/FinancialConnectionsOwnerAddressesInner.md +0 -0
  35. data/{fuse-ruby-openapi/docs → docs}/FinancialConnectionsOwnerAddressesInnerData.md +0 -0
  36. data/{fuse-ruby-openapi/docs → docs}/FinancialConnectionsOwnerEmailsInner.md +0 -0
  37. data/{fuse-ruby-openapi/docs → docs}/FinancialConnectionsOwnerNamesInner.md +0 -0
  38. data/{fuse-ruby-openapi/docs → docs}/FinancialConnectionsOwnerPhoneNumbersInner.md +0 -0
  39. data/{fuse-ruby-openapi/docs → docs}/FuseApi.md +307 -1
  40. data/{fuse-ruby-openapi/docs → docs}/FuseApiError.md +0 -0
  41. data/{fuse-ruby-openapi/docs → docs}/FuseApiErrorData.md +0 -0
  42. data/{fuse-ruby-openapi/docs → docs}/FuseApiWarning.md +0 -0
  43. data/{fuse-ruby-openapi/docs → docs}/FuseApiWarningData.md +0 -0
  44. data/{fuse-ruby-openapi/docs → docs}/GetAssetReportRequest.md +0 -0
  45. data/{fuse-ruby-openapi/docs → docs}/GetAssetReportResponse.md +0 -0
  46. data/{fuse-ruby-openapi/docs → docs}/GetAssetReportResponseReport.md +0 -0
  47. data/{fuse-ruby-openapi/docs → docs}/GetAssetReportResponseReportAccountsInner.md +0 -0
  48. data/{fuse-ruby-openapi/docs → docs}/GetAssetReportResponseReportAccountsInnerBalances.md +0 -0
  49. data/{fuse-ruby-openapi/docs → docs}/GetAssetReportResponseReportAccountsInnerHistoricalBalancesInner.md +0 -0
  50. data/docs/GetEntityResponse.md +24 -0
  51. data/{fuse-ruby-openapi/docs → docs}/GetFinancialConnectionsAccountBalanceResponse.md +0 -0
  52. data/{fuse-ruby-openapi/docs → docs}/GetFinancialConnectionsAccountDetailsRequest.md +0 -0
  53. data/{fuse-ruby-openapi/docs → docs}/GetFinancialConnectionsAccountDetailsResponse.md +0 -0
  54. data/{fuse-ruby-openapi/docs → docs}/GetFinancialConnectionsAccountsRequest.md +0 -0
  55. data/{fuse-ruby-openapi/docs → docs}/GetFinancialConnectionsAccountsResponse.md +0 -0
  56. data/{fuse-ruby-openapi/docs → docs}/GetFinancialConnectionsBalanceRequest.md +0 -0
  57. data/{fuse-ruby-openapi/docs → docs}/GetFinancialConnectionsOwnersRequest.md +0 -0
  58. data/{fuse-ruby-openapi/docs → docs}/GetFinancialConnectionsOwnersResponse.md +0 -0
  59. data/{fuse-ruby-openapi/docs → docs}/GetFinancialConnectionsOwnersResponseAccountsInner.md +0 -0
  60. data/{fuse-ruby-openapi/docs → docs}/GetInvestmentHoldingsRequest.md +3 -1
  61. data/{fuse-ruby-openapi/docs → docs}/GetInvestmentHoldingsResponse.md +1 -3
  62. data/{fuse-ruby-openapi/docs → docs}/GetInvestmentTransactionsRequest.md +0 -0
  63. data/{fuse-ruby-openapi/docs → docs}/GetInvestmentTransactionsResponse.md +1 -3
  64. data/{fuse-ruby-openapi/docs → docs}/GetLiabilitiesRequest.md +0 -0
  65. data/{fuse-ruby-openapi/docs → docs}/GetLiabilitiesResponse.md +1 -3
  66. data/{fuse-ruby-openapi/docs → docs}/GetTransactionsRequest.md +0 -0
  67. data/{fuse-ruby-openapi/docs → docs}/GetTransactionsResponse.md +0 -0
  68. data/{fuse-ruby-openapi/docs → docs}/GetTransactionsResponseDataInner.md +1 -3
  69. data/{fuse-ruby-openapi/docs → docs}/GetTransactionsResponseDataInnerMerchant.md +0 -0
  70. data/docs/Product.md +15 -0
  71. data/docs/RefreshAssetReportRequest.md +22 -0
  72. data/{fuse-ruby-openapi/docs → docs}/SyncFinancialConnectionsDataResponse.md +0 -0
  73. data/{fuse-ruby-openapi/docs → docs}/SyncTransactionsRequest.md +0 -0
  74. data/{fuse-ruby-openapi/docs → docs}/SyncTransactionsResponse.md +0 -0
  75. data/{fuse-ruby-openapi/docs → docs}/SyncTransactionsResponseRemovedInner.md +0 -0
  76. data/{fuse-ruby-openapi/docs → docs}/TransactionCommonModel.md +0 -0
  77. data/docs/UpdateEntityRequest.md +22 -0
  78. data/docs/UpdateEntityResponse.md +24 -0
  79. data/{fuse-ruby-openapi/fuse_client.gemspec → fuse_client.gemspec} +0 -0
  80. data/{fuse-ruby-openapi/git_push.sh → git_push.sh} +0 -0
  81. data/{fuse-ruby-openapi/lib → lib}/fuse_client/api/fuse_api.rb +261 -0
  82. data/{fuse-ruby-openapi/lib → lib}/fuse_client/api_client.rb +0 -0
  83. data/{fuse-ruby-openapi/lib → lib}/fuse_client/api_error.rb +0 -0
  84. data/{fuse-ruby-openapi/lib → lib}/fuse_client/configuration.rb +2 -2
  85. data/lib/fuse_client/models/aggregator.rb +42 -0
  86. data/{fuse-ruby-openapi/lib → lib}/fuse_client/models/create_asset_report_request.rb +16 -4
  87. data/{fuse-ruby-openapi/lib → lib}/fuse_client/models/create_asset_report_response.rb +0 -0
  88. data/lib/fuse_client/models/create_entity_request.rb +268 -0
  89. data/lib/fuse_client/models/create_entity_response.rb +268 -0
  90. data/{fuse-ruby-openapi/lib → lib}/fuse_client/models/create_link_token_request.rb +21 -20
  91. data/{fuse-ruby-openapi/lib → lib}/fuse_client/models/create_link_token_request_mx.rb +1 -1
  92. data/{fuse-ruby-openapi/lib → lib}/fuse_client/models/create_link_token_request_plaid.rb +3 -2
  93. data/{fuse-ruby-openapi/lib → lib}/fuse_client/models/create_link_token_response.rb +0 -0
  94. data/{fuse-ruby-openapi/lib → lib}/fuse_client/models/create_session_request.rb +36 -39
  95. data/{fuse-ruby-openapi/lib → lib}/fuse_client/models/create_session_response.rb +0 -0
  96. data/{fuse-ruby-openapi/lib → lib}/fuse_client/models/exchange_financial_connections_public_token_request.rb +0 -0
  97. data/{fuse-ruby-openapi/lib → lib}/fuse_client/models/exchange_financial_connections_public_token_response.rb +0 -0
  98. data/{fuse-ruby-openapi/lib → lib}/fuse_client/models/financial_connections_account.rb +0 -0
  99. data/{fuse-ruby-openapi/lib → lib}/fuse_client/models/financial_connections_account_balance.rb +0 -0
  100. data/{fuse-ruby-openapi/lib → lib}/fuse_client/models/financial_connections_account_details.rb +4 -14
  101. data/{fuse-ruby-openapi/lib → lib}/fuse_client/models/financial_connections_account_details_ach.rb +0 -0
  102. data/{fuse-ruby-openapi/lib → lib}/fuse_client/models/financial_connections_account_institution.rb +0 -0
  103. data/{fuse-ruby-openapi/lib → lib}/fuse_client/models/financial_connections_account_liability.rb +0 -0
  104. data/{fuse-ruby-openapi/lib → lib}/fuse_client/models/financial_connections_account_liability_all_of.rb +0 -0
  105. data/{fuse-ruby-openapi/lib → lib}/fuse_client/models/financial_connections_account_liability_all_of_aprs.rb +0 -0
  106. data/{fuse-ruby-openapi/lib → lib}/fuse_client/models/financial_connections_holding.rb +11 -1
  107. data/{fuse-ruby-openapi/lib → lib}/fuse_client/models/financial_connections_investment_account.rb +0 -0
  108. data/{fuse-ruby-openapi/lib → lib}/fuse_client/models/financial_connections_investment_security.rb +0 -0
  109. data/{fuse-ruby-openapi/lib → lib}/fuse_client/models/financial_connections_investment_transaction.rb +0 -0
  110. data/{fuse-ruby-openapi/lib → lib}/fuse_client/models/financial_connections_investment_transaction_data_inner.rb +0 -0
  111. data/{fuse-ruby-openapi/lib → lib}/fuse_client/models/financial_connections_owner.rb +0 -0
  112. data/{fuse-ruby-openapi/lib → lib}/fuse_client/models/financial_connections_owner_addresses_inner.rb +0 -0
  113. data/{fuse-ruby-openapi/lib → lib}/fuse_client/models/financial_connections_owner_addresses_inner_data.rb +0 -0
  114. data/{fuse-ruby-openapi/lib → lib}/fuse_client/models/financial_connections_owner_emails_inner.rb +0 -0
  115. data/{fuse-ruby-openapi/lib → lib}/fuse_client/models/financial_connections_owner_names_inner.rb +0 -0
  116. data/{fuse-ruby-openapi/lib → lib}/fuse_client/models/financial_connections_owner_phone_numbers_inner.rb +0 -0
  117. data/{fuse-ruby-openapi/lib → lib}/fuse_client/models/fuse_api_error.rb +0 -0
  118. data/{fuse-ruby-openapi/lib → lib}/fuse_client/models/fuse_api_error_data.rb +0 -0
  119. data/{fuse-ruby-openapi/lib → lib}/fuse_client/models/fuse_api_warning.rb +0 -0
  120. data/{fuse-ruby-openapi/lib → lib}/fuse_client/models/fuse_api_warning_data.rb +0 -0
  121. data/{fuse-ruby-openapi/lib → lib}/fuse_client/models/get_asset_report_request.rb +0 -0
  122. data/{fuse-ruby-openapi/lib → lib}/fuse_client/models/get_asset_report_response.rb +0 -0
  123. data/{fuse-ruby-openapi/lib → lib}/fuse_client/models/get_asset_report_response_report.rb +0 -0
  124. data/{fuse-ruby-openapi/lib → lib}/fuse_client/models/get_asset_report_response_report_accounts_inner.rb +0 -0
  125. data/{fuse-ruby-openapi/lib → lib}/fuse_client/models/get_asset_report_response_report_accounts_inner_balances.rb +0 -0
  126. data/{fuse-ruby-openapi/lib → lib}/fuse_client/models/get_asset_report_response_report_accounts_inner_historical_balances_inner.rb +0 -0
  127. data/lib/fuse_client/models/get_entity_response.rb +268 -0
  128. data/{fuse-ruby-openapi/lib → lib}/fuse_client/models/get_financial_connections_account_balance_response.rb +0 -0
  129. data/{fuse-ruby-openapi/lib → lib}/fuse_client/models/get_financial_connections_account_details_request.rb +0 -0
  130. data/{fuse-ruby-openapi/lib → lib}/fuse_client/models/get_financial_connections_account_details_response.rb +0 -0
  131. data/{fuse-ruby-openapi/lib → lib}/fuse_client/models/get_financial_connections_accounts_request.rb +0 -0
  132. data/{fuse-ruby-openapi/lib → lib}/fuse_client/models/get_financial_connections_accounts_response.rb +0 -0
  133. data/{fuse-ruby-openapi/lib → lib}/fuse_client/models/get_financial_connections_balance_request.rb +0 -0
  134. data/{fuse-ruby-openapi/lib → lib}/fuse_client/models/get_financial_connections_owners_request.rb +0 -0
  135. data/{fuse-ruby-openapi/lib → lib}/fuse_client/models/get_financial_connections_owners_response.rb +0 -0
  136. data/{fuse-ruby-openapi/lib → lib}/fuse_client/models/get_financial_connections_owners_response_accounts_inner.rb +0 -0
  137. data/{fuse-ruby-openapi/lib → lib}/fuse_client/models/get_investment_holdings_request.rb +14 -4
  138. data/{fuse-ruby-openapi/lib → lib}/fuse_client/models/get_investment_holdings_response.rb +4 -14
  139. data/{fuse-ruby-openapi/lib → lib}/fuse_client/models/get_investment_transactions_request.rb +0 -0
  140. data/{fuse-ruby-openapi/lib → lib}/fuse_client/models/get_investment_transactions_response.rb +4 -14
  141. data/{fuse-ruby-openapi/lib → lib}/fuse_client/models/get_liabilities_request.rb +0 -0
  142. data/{fuse-ruby-openapi/lib → lib}/fuse_client/models/get_liabilities_response.rb +4 -14
  143. data/{fuse-ruby-openapi/lib → lib}/fuse_client/models/get_transactions_request.rb +0 -0
  144. data/{fuse-ruby-openapi/lib → lib}/fuse_client/models/get_transactions_response.rb +0 -0
  145. data/{fuse-ruby-openapi/lib → lib}/fuse_client/models/get_transactions_response_data_inner.rb +4 -14
  146. data/{fuse-ruby-openapi/lib → lib}/fuse_client/models/get_transactions_response_data_inner_merchant.rb +0 -0
  147. data/lib/fuse_client/models/product.rb +44 -0
  148. data/lib/fuse_client/models/refresh_asset_report_request.rb +275 -0
  149. data/{fuse-ruby-openapi/lib → lib}/fuse_client/models/sync_financial_connections_data_response.rb +0 -0
  150. data/{fuse-ruby-openapi/lib → lib}/fuse_client/models/sync_transactions_request.rb +0 -0
  151. data/{fuse-ruby-openapi/lib → lib}/fuse_client/models/sync_transactions_response.rb +0 -0
  152. data/{fuse-ruby-openapi/lib → lib}/fuse_client/models/sync_transactions_response_removed_inner.rb +0 -0
  153. data/{fuse-ruby-openapi/lib → lib}/fuse_client/models/transaction_common_model.rb +0 -0
  154. data/{fuse-ruby-openapi/lib/fuse_client/models/create_session_request_plaid.rb → lib/fuse_client/models/update_entity_request.rb} +41 -21
  155. data/lib/fuse_client/models/update_entity_response.rb +268 -0
  156. data/{fuse-ruby-openapi/lib → lib}/fuse_client/version.rb +1 -1
  157. data/{fuse-ruby-openapi/lib → lib}/fuse_client.rb +8 -3
  158. data/{fuse-ruby-openapi/spec → spec}/api/fuse_api_spec.rb +45 -0
  159. data/{fuse-ruby-openapi/spec → spec}/api_client_spec.rb +0 -0
  160. data/{fuse-ruby-openapi/spec → spec}/configuration_spec.rb +3 -3
  161. data/spec/models/aggregator_spec.rb +28 -0
  162. data/{fuse-ruby-openapi/spec → spec}/models/create_asset_report_request_spec.rb +6 -0
  163. data/{fuse-ruby-openapi/spec → spec}/models/create_asset_report_response_spec.rb +0 -0
  164. data/{fuse-ruby-openapi/spec/models/create_session_request_mx_spec.rb → spec/models/create_entity_request_spec.rb} +10 -10
  165. data/spec/models/create_entity_response_spec.rb +52 -0
  166. data/{fuse-ruby-openapi/spec → spec}/models/create_link_token_request_mx_spec.rb +0 -0
  167. data/{fuse-ruby-openapi/spec → spec}/models/create_link_token_request_plaid_spec.rb +0 -0
  168. data/{fuse-ruby-openapi/spec → spec}/models/create_link_token_request_spec.rb +5 -5
  169. data/{fuse-ruby-openapi/spec → spec}/models/create_link_token_response_spec.rb +0 -0
  170. data/{fuse-ruby-openapi/spec → spec}/models/create_session_request_spec.rb +1 -11
  171. data/{fuse-ruby-openapi/spec → spec}/models/create_session_response_spec.rb +0 -0
  172. data/{fuse-ruby-openapi/spec → spec}/models/exchange_financial_connections_public_token_request_spec.rb +0 -0
  173. data/{fuse-ruby-openapi/spec → spec}/models/exchange_financial_connections_public_token_response_spec.rb +0 -0
  174. data/{fuse-ruby-openapi/spec → spec}/models/financial_connections_account_balance_spec.rb +0 -0
  175. data/{fuse-ruby-openapi/spec → spec}/models/financial_connections_account_details_ach_spec.rb +0 -0
  176. data/{fuse-ruby-openapi/spec → spec}/models/financial_connections_account_details_spec.rb +0 -6
  177. data/{fuse-ruby-openapi/spec → spec}/models/financial_connections_account_institution_spec.rb +0 -0
  178. data/{fuse-ruby-openapi/spec → spec}/models/financial_connections_account_liability_all_of_aprs_spec.rb +0 -0
  179. data/{fuse-ruby-openapi/spec → spec}/models/financial_connections_account_liability_all_of_spec.rb +0 -0
  180. data/{fuse-ruby-openapi/spec → spec}/models/financial_connections_account_liability_spec.rb +0 -0
  181. data/{fuse-ruby-openapi/spec → spec}/models/financial_connections_account_spec.rb +0 -0
  182. data/{fuse-ruby-openapi/spec → spec}/models/financial_connections_holding_spec.rb +6 -0
  183. data/{fuse-ruby-openapi/spec → spec}/models/financial_connections_investment_account_spec.rb +0 -0
  184. data/{fuse-ruby-openapi/spec → spec}/models/financial_connections_investment_security_spec.rb +0 -0
  185. data/{fuse-ruby-openapi/spec → spec}/models/financial_connections_investment_transaction_data_inner_spec.rb +0 -0
  186. data/{fuse-ruby-openapi/spec → spec}/models/financial_connections_investment_transaction_spec.rb +0 -0
  187. data/{fuse-ruby-openapi/spec → spec}/models/financial_connections_owner_addresses_inner_data_spec.rb +0 -0
  188. data/{fuse-ruby-openapi/spec → spec}/models/financial_connections_owner_addresses_inner_spec.rb +0 -0
  189. data/{fuse-ruby-openapi/spec → spec}/models/financial_connections_owner_emails_inner_spec.rb +0 -0
  190. data/{fuse-ruby-openapi/spec → spec}/models/financial_connections_owner_names_inner_spec.rb +0 -0
  191. data/{fuse-ruby-openapi/spec → spec}/models/financial_connections_owner_phone_numbers_inner_spec.rb +0 -0
  192. data/{fuse-ruby-openapi/spec → spec}/models/financial_connections_owner_spec.rb +0 -0
  193. data/{fuse-ruby-openapi/spec → spec}/models/fuse_api_error_data_spec.rb +0 -0
  194. data/{fuse-ruby-openapi/spec → spec}/models/fuse_api_error_spec.rb +0 -0
  195. data/{fuse-ruby-openapi/spec → spec}/models/fuse_api_warning_data_spec.rb +0 -0
  196. data/{fuse-ruby-openapi/spec → spec}/models/fuse_api_warning_spec.rb +0 -0
  197. data/{fuse-ruby-openapi/spec → spec}/models/get_asset_report_request_spec.rb +0 -0
  198. data/{fuse-ruby-openapi/spec → spec}/models/get_asset_report_response_report_accounts_inner_balances_spec.rb +0 -0
  199. data/{fuse-ruby-openapi/spec → spec}/models/get_asset_report_response_report_accounts_inner_historical_balances_inner_spec.rb +0 -0
  200. data/{fuse-ruby-openapi/spec → spec}/models/get_asset_report_response_report_accounts_inner_spec.rb +0 -0
  201. data/{fuse-ruby-openapi/spec → spec}/models/get_asset_report_response_report_spec.rb +0 -0
  202. data/{fuse-ruby-openapi/spec → spec}/models/get_asset_report_response_spec.rb +0 -0
  203. data/spec/models/get_entity_response_spec.rb +52 -0
  204. data/{fuse-ruby-openapi/spec → spec}/models/get_financial_connections_account_balance_response_spec.rb +0 -0
  205. data/{fuse-ruby-openapi/spec → spec}/models/get_financial_connections_account_details_request_spec.rb +0 -0
  206. data/{fuse-ruby-openapi/spec → spec}/models/get_financial_connections_account_details_response_spec.rb +0 -0
  207. data/{fuse-ruby-openapi/spec → spec}/models/get_financial_connections_accounts_request_spec.rb +0 -0
  208. data/{fuse-ruby-openapi/spec → spec}/models/get_financial_connections_accounts_response_spec.rb +0 -0
  209. data/{fuse-ruby-openapi/spec → spec}/models/get_financial_connections_balance_request_spec.rb +0 -0
  210. data/{fuse-ruby-openapi/spec → spec}/models/get_financial_connections_owners_request_spec.rb +0 -0
  211. data/{fuse-ruby-openapi/spec → spec}/models/get_financial_connections_owners_response_accounts_inner_spec.rb +0 -0
  212. data/{fuse-ruby-openapi/spec → spec}/models/get_financial_connections_owners_response_spec.rb +0 -0
  213. data/{fuse-ruby-openapi/spec → spec}/models/get_investment_holdings_request_spec.rb +6 -0
  214. data/{fuse-ruby-openapi/spec → spec}/models/get_investment_holdings_response_spec.rb +0 -6
  215. data/{fuse-ruby-openapi/spec → spec}/models/get_investment_transactions_request_spec.rb +0 -0
  216. data/{fuse-ruby-openapi/spec → spec}/models/get_investment_transactions_response_spec.rb +0 -6
  217. data/{fuse-ruby-openapi/spec → spec}/models/get_liabilities_request_spec.rb +0 -0
  218. data/{fuse-ruby-openapi/spec → spec}/models/get_liabilities_response_spec.rb +0 -6
  219. data/{fuse-ruby-openapi/spec → spec}/models/get_transactions_request_spec.rb +0 -0
  220. data/{fuse-ruby-openapi/spec → spec}/models/get_transactions_response_data_inner_merchant_spec.rb +0 -0
  221. data/{fuse-ruby-openapi/spec → spec}/models/get_transactions_response_data_inner_spec.rb +0 -6
  222. data/{fuse-ruby-openapi/spec → spec}/models/get_transactions_response_spec.rb +0 -0
  223. data/spec/models/product_spec.rb +28 -0
  224. data/spec/models/refresh_asset_report_request_spec.rb +46 -0
  225. data/{fuse-ruby-openapi/spec → spec}/models/sync_financial_connections_data_response_spec.rb +0 -0
  226. data/{fuse-ruby-openapi/spec → spec}/models/sync_transactions_request_spec.rb +0 -0
  227. data/{fuse-ruby-openapi/spec → spec}/models/sync_transactions_response_removed_inner_spec.rb +0 -0
  228. data/{fuse-ruby-openapi/spec → spec}/models/sync_transactions_response_spec.rb +0 -0
  229. data/{fuse-ruby-openapi/spec → spec}/models/transaction_common_model_spec.rb +0 -0
  230. data/spec/models/update_entity_request_spec.rb +46 -0
  231. data/spec/models/update_entity_response_spec.rb +52 -0
  232. data/{fuse-ruby-openapi/spec → spec}/spec_helper.rb +0 -0
  233. metadata +309 -228
  234. data/2023-01-25.json +0 -1736
  235. data/fuse-ruby-openapi/.gitignore +0 -39
  236. data/fuse-ruby-openapi/.gitlab-ci.yml +0 -26
  237. data/fuse-ruby-openapi/.openapi-generator/FILES +0 -220
  238. data/fuse-ruby-openapi/.openapi-generator/VERSION +0 -1
  239. data/fuse-ruby-openapi/.openapi-generator-ignore +0 -23
  240. data/fuse-ruby-openapi/.rspec +0 -2
  241. data/fuse-ruby-openapi/.rubocop.yml +0 -148
  242. data/fuse-ruby-openapi/.travis.yml +0 -14
  243. data/fuse-ruby-openapi/README.md +0 -258
  244. data/fuse-ruby-openapi/docs/CreateLinkTokenRequestPlaid.md +0 -18
  245. data/fuse-ruby-openapi/docs/CreateLinkTokenRequestPlaidConfig.md +0 -18
  246. data/fuse-ruby-openapi/docs/CreateSessionRequest.md +0 -22
  247. data/fuse-ruby-openapi/docs/CreateSessionRequestMx.md +0 -24
  248. data/fuse-ruby-openapi/docs/CreateSessionRequestPlaid.md +0 -18
  249. data/fuse-ruby-openapi/lib/fuse_client/models/create_link_token_request_plaid_config.rb +0 -225
  250. data/fuse-ruby-openapi/lib/fuse_client/models/create_session_request_mx.rb +0 -247
  251. data/fuse-ruby-openapi/spec/models/create_link_token_request_plaid_config_spec.rb +0 -34
  252. data/fuse-ruby-openapi/spec/models/create_session_request_plaid_spec.rb +0 -34
  253. data/fuse_client-0.3.0.gem +0 -0
  254. data/generate-fuse-openapi-spec.js +0 -136
data/2023-01-25.json DELETED
@@ -1,1736 +0,0 @@
1
- {
2
- "openapi": "3.0.0",
3
- "info": {
4
- "title": "Fuse",
5
- "version": "1.0.0"
6
- },
7
- "tags": [
8
- {
9
- "name": "Fuse"
10
- }
11
- ],
12
- "servers": [
13
- {
14
- "url": "https://yz9sph5c42.execute-api.us-east-1.amazonaws.com",
15
- "description": "sandbox"
16
- }
17
- ],
18
- "security": [
19
- {
20
- "fuseApiKey": []
21
- },
22
- {
23
- "fuseClientId": []
24
- }
25
- ],
26
- "paths": {
27
- "/v1/financial_connections/accounts/details": {
28
- "summary": "Get account details",
29
- "post": {
30
- "operationId": "getFinancialConnectionsAccountDetails",
31
- "tags": ["Fuse"],
32
- "summary": "Get account details",
33
- "requestBody": {
34
- "required": true,
35
- "content": {
36
- "application/json": {
37
- "schema": {
38
- "$ref": "#/components/schemas/GetFinancialConnectionsAccountDetailsRequest"
39
- }
40
- }
41
- }
42
- },
43
- "responses": {
44
- "200": {
45
- "description": "Success",
46
- "content": {
47
- "application/json": {
48
- "schema": {
49
- "$ref": "#/components/schemas/GetFinancialConnectionsAccountDetailsResponse"
50
- }
51
- }
52
- }
53
- }
54
- }
55
- }
56
- },
57
- "/v1/financial_connections/owners": {
58
- "post": {
59
- "tags": ["Fuse"],
60
- "summary": "Get account owners",
61
- "operationId": "getFinancialConnectionsOwners",
62
- "requestBody": {
63
- "required": true,
64
- "content": {
65
- "application/json": {
66
- "schema": {
67
- "$ref": "#/components/schemas/GetFinancialConnectionsOwnersRequest"
68
- }
69
- }
70
- }
71
- },
72
- "responses": {
73
- "200": {
74
- "description": "Success",
75
- "content": {
76
- "application/json": {
77
- "schema": {
78
- "$ref": "#/components/schemas/GetFinancialConnectionsOwnersResponse"
79
- }
80
- }
81
- }
82
- }
83
- }
84
- }
85
- },
86
- "/v1/financial_connections/accounts": {
87
- "post": {
88
- "tags": ["Fuse"],
89
- "summary": "Get accounts",
90
- "operationId": "getFinancialConnectionsAccounts",
91
- "requestBody": {
92
- "required": true,
93
- "content": {
94
- "application/json": {
95
- "schema": {
96
- "$ref": "#/components/schemas/GetFinancialConnectionsAccountsRequest"
97
- }
98
- }
99
- }
100
- },
101
- "responses": {
102
- "200": {
103
- "description": "Successful response",
104
- "content": {
105
- "application/json": {
106
- "schema": {
107
- "$ref": "#/components/schemas/GetFinancialConnectionsAccountsResponse"
108
- }
109
- }
110
- }
111
- }
112
- }
113
- }
114
- },
115
- "/v1/asset_report/create": {
116
- "summary": "Create an Asset Report",
117
- "post": {
118
- "tags": ["Fuse"],
119
- "description": "Use this endpoint to generate an Asset Report for a user.",
120
- "operationId": "createAssetReport",
121
- "requestBody": {
122
- "content": {
123
- "application/json": {
124
- "schema": {
125
- "$ref": "#/components/schemas/CreateAssetReportRequest"
126
- },
127
- "examples": {
128
- "0": {
129
- "value": "{\n\t\"access_token\": \"3e0cc775-3588-460d-863a-a4baee8ac7c5\",\n\t\"days_requested\": 90,\n}"
130
- }
131
- }
132
- }
133
- }
134
- },
135
- "responses": {
136
- "200": {
137
- "description": "Response",
138
- "content": {
139
- "application/json": {
140
- "schema": {
141
- "$ref": "#/components/schemas/CreateAssetReportResponse"
142
- },
143
- "examples": {
144
- "0": {
145
- "value": "{\"asset_report_token\":\"fuse_ar_dev_1MV8sa\",\"asset_report_id\":\"3256bf0f-6881-4ff4-9f27-54c396572320\"}"
146
- }
147
- }
148
- }
149
- }
150
- }
151
- }
152
- }
153
- },
154
- "/v1/asset_report": {
155
- "summary": "Get an asset report",
156
- "post": {
157
- "tags": ["Fuse"],
158
- "description": "Retrieves the Asset Report in JSON format.",
159
- "operationId": "getAssetReport",
160
- "requestBody": {
161
- "content": {
162
- "application/json": {
163
- "schema": {
164
- "$ref": "#/components/schemas/GetAssetReportRequest"
165
- },
166
- "examples": {
167
- "0": {
168
- "value": "{\n\t\"asset_report_token\": \"fuse_ar_dev_1MV8sa\"\n}"
169
- }
170
- }
171
- }
172
- }
173
- },
174
- "responses": {
175
- "200": {
176
- "description": "Response",
177
- "content": {
178
- "application/json": {
179
- "schema": {
180
- "$ref": "#/components/schemas/GetAssetReportResponse"
181
- }
182
- }
183
- }
184
- }
185
- }
186
- }
187
- },
188
- "/v1/financial_connections/balances": {
189
- "post": {
190
- "tags": ["Fuse"],
191
- "summary": "Get balances",
192
- "operationId": "getFinancialConnectionsBalances",
193
- "requestBody": {
194
- "required": true,
195
- "content": {
196
- "application/json": {
197
- "schema": {
198
- "$ref": "#/components/schemas/GetFinancialConnectionsBalanceRequest"
199
- }
200
- }
201
- }
202
- },
203
- "responses": {
204
- "200": {
205
- "description": "Successful response",
206
- "content": {
207
- "application/json": {
208
- "schema": {
209
- "$ref": "#/components/schemas/GetFinancialConnectionsAccountBalanceResponse"
210
- }
211
- }
212
- }
213
- }
214
- }
215
- }
216
- },
217
- "/v1/financial_connections/public_token/exchange": {
218
- "summary": "Exchange public token",
219
- "post": {
220
- "tags": ["Fuse"],
221
- "description": "API to exchange a public token for an access token and financial connection id",
222
- "operationId": "exchangePublicToken",
223
- "requestBody": {
224
- "content": {
225
- "application/json": {
226
- "schema": {
227
- "$ref": "#/components/schemas/ExchangeFinancialConnectionsPublicTokenRequest"
228
- }
229
- }
230
- }
231
- },
232
- "responses": {
233
- "200": {
234
- "description": "Response",
235
- "content": {
236
- "application/json": {
237
- "schema": {
238
- "$ref": "#/components/schemas/ExchangeFinancialConnectionsPublicTokenResponse"
239
- }
240
- }
241
- }
242
- }
243
- }
244
- }
245
- },
246
- "/v1/financial_connections/sync": {
247
- "post": {
248
- "tags": ["Fuse"],
249
- "summary": "Sync financial connections data",
250
- "description": "Call this endpoint upon receiving a SYNC_REQUIRED webhook. This will keep the financial connections data up to date.",
251
- "operationId": "syncFinancialConnectionsData",
252
- "requestBody": {
253
- "required": true,
254
- "content": {
255
- "application/json": {
256
- "schema": {
257
- "$ref": "#/components/schemas/SyncFinancialConnectionsDataRequest"
258
- }
259
- }
260
- }
261
- },
262
- "responses": {
263
- "200": {
264
- "description": "Successfully synchronized transactions",
265
- "content": {
266
- "application/json": {
267
- "schema": {
268
- "$ref": "#/components/schemas/SyncFinancialConnectionsDataResponse"
269
- }
270
- }
271
- }
272
- }
273
- }
274
- }
275
- },
276
- "/v1/financial_connections/investments/holdings": {
277
- "post": {
278
- "tags": ["Fuse"],
279
- "summary": "Get investment holdings",
280
- "operationId": "getInvestmentHoldings",
281
- "requestBody": {
282
- "required": true,
283
- "content": {
284
- "application/json": {
285
- "schema": {
286
- "$ref": "#/components/schemas/GetInvestmentHoldingsRequest"
287
- }
288
- }
289
- }
290
- },
291
- "responses": {
292
- "200": {
293
- "description": "Successful response",
294
- "content": {
295
- "application/json": {
296
- "schema": {
297
- "$ref": "#/components/schemas/GetInvestmentHoldingsResponse"
298
- }
299
- }
300
- }
301
- }
302
- }
303
- }
304
- },
305
- "/v1/financial_connections/investments/transactions": {
306
- "post": {
307
- "tags": ["Fuse"],
308
- "summary": "Get investment holdings",
309
- "operationId": "getInvestmentTransactions",
310
- "requestBody": {
311
- "required": true,
312
- "content": {
313
- "application/json": {
314
- "schema": {
315
- "$ref": "#/components/schemas/GetInvestmentTransactionsRequest"
316
- }
317
- }
318
- }
319
- },
320
- "responses": {
321
- "200": {
322
- "description": "Successful response",
323
- "content": {
324
- "application/json": {
325
- "schema": {
326
- "$ref": "#/components/schemas/GetInvestmentTransactionsResponse"
327
- }
328
- }
329
- }
330
- }
331
- }
332
- }
333
- },
334
- "/v1/financial_connections/liabilities": {
335
- "post": {
336
- "tags": ["Fuse"],
337
- "summary": "Get liabilities",
338
- "requestBody": {
339
- "required": true,
340
- "content": {
341
- "application/json": {
342
- "schema": {
343
- "$ref": "#/components/schemas/GetLiabilitiesRequest"
344
- }
345
- }
346
- }
347
- },
348
- "responses": {
349
- "200": {
350
- "description": "Successful response",
351
- "content": {
352
- "application/json": {
353
- "schema": {
354
- "$ref": "#/components/schemas/GetLiabilitiesResponse"
355
- }
356
- }
357
- }
358
- }
359
- }
360
- }
361
- },
362
- "/v1/link/token": {
363
- "summary": "Create link token",
364
- "post": {
365
- "tags": ["Fuse"],
366
- "description": "Create a link token to start the process of a user connecting to a specific financial institution.",
367
- "operationId": "createLinkToken",
368
- "requestBody": {
369
- "content": {
370
- "application/json": {
371
- "schema": {
372
- "$ref": "#/components/schemas/CreateLinkTokenRequest"
373
- }
374
- }
375
- }
376
- },
377
- "responses": {
378
- "200": {
379
- "description": "Response",
380
- "content": {
381
- "application/json": {
382
- "schema": {
383
- "$ref": "#/components/schemas/CreateLinkTokenResponse"
384
- }
385
- }
386
- }
387
- }
388
- }
389
- }
390
- },
391
- "/v1/session": {
392
- "summary": "Create session",
393
- "post": {
394
- "tags": ["Fuse"],
395
- "description": "Creates a session that returns a client_secret which is required as a parameter when initializing the Fuse SDK.",
396
- "operationId": "createSession",
397
- "requestBody": {
398
- "content": {
399
- "application/json": {
400
- "schema": {
401
- "$ref": "#/components/schemas/CreateSessionRequest"
402
- }
403
- }
404
- }
405
- },
406
- "responses": {
407
- "200": {
408
- "description": "Response",
409
- "content": {
410
- "application/json": {
411
- "schema": {
412
- "$ref": "#/components/schemas/CreateSessionResponse"
413
- }
414
- }
415
- }
416
- }
417
- }
418
- }
419
- },
420
- "/v1/financial_connections/transactions": {
421
- "summary": "Get transactions",
422
- "post": {
423
- "tags": ["Fuse"],
424
- "summary": "Get transactions",
425
- "operationId": "getFinancialConnectionsTransactions",
426
- "requestBody": {
427
- "required": true,
428
- "content": {
429
- "application/json": {
430
- "schema": {
431
- "$ref": "#/components/schemas/GetTransactionsRequest"
432
- }
433
- }
434
- }
435
- },
436
- "responses": {
437
- "200": {
438
- "description": "Success",
439
- "content": {
440
- "application/json": {
441
- "schema": {
442
- "$ref": "#/components/schemas/GetTransactionsResponse"
443
- }
444
- }
445
- }
446
- }
447
- }
448
- }
449
- },
450
- "/v1/financial_connections/transactions/sync": {
451
- "post": {
452
- "tags": ["Fuse"],
453
- "summary": "Sync transactions",
454
- "operationId": "syncFinancialConnectionsTransactions",
455
- "requestBody": {
456
- "required": true,
457
- "content": {
458
- "application/json": {
459
- "schema": {
460
- "$ref": "#/components/schemas/SyncTransactionsRequest"
461
- }
462
- }
463
- }
464
- },
465
- "responses": {
466
- "200": {
467
- "description": "Successfully synchronized transactions",
468
- "content": {
469
- "application/json": {
470
- "schema": {
471
- "$ref": "#/components/schemas/SyncTransactionsResponse"
472
- }
473
- }
474
- }
475
- }
476
- }
477
- }
478
- }
479
- },
480
- "components": {
481
- "securitySchemes": {
482
- "fuseApiKey": {
483
- "type": "apiKey",
484
- "name": "Fuse-Api-Key",
485
- "in": "header"
486
- },
487
- "fuseClientId": {
488
- "type": "apiKey",
489
- "name": "Fuse-Client-Id",
490
- "in": "header"
491
- },
492
- "plaidClientId": {
493
- "type": "apiKey",
494
- "name": "Plaid-Client-Id",
495
- "in": "header"
496
- },
497
- "plaidSecret": {
498
- "type": "apiKey",
499
- "name": "Plaid-Secret",
500
- "in": "header"
501
- },
502
- "tellerApplicationId": {
503
- "type": "apiKey",
504
- "name": "Teller-Application-Id",
505
- "in": "header"
506
- },
507
- "tellerCertificate": {
508
- "type": "apiKey",
509
- "name": "Teller-Certificate",
510
- "in": "header"
511
- },
512
- "tellerPrivateKey": {
513
- "type": "apiKey",
514
- "name": "Teller-Private-Key",
515
- "in": "header"
516
- },
517
- "tellerTokenSigningKey": {
518
- "type": "apiKey",
519
- "name": "Teller-Token-Signing-Key",
520
- "in": "header"
521
- },
522
- "tellerSigningSecret": {
523
- "type": "apiKey",
524
- "name": "Teller-Signing-Secret",
525
- "in": "header"
526
- },
527
- "mxClientId": {
528
- "type": "apiKey",
529
- "name": "Mx-Client-Id",
530
- "in": "header"
531
- },
532
- "mxApiKey": {
533
- "type": "apiKey",
534
- "name": "Mx-Api-Key",
535
- "in": "header"
536
- }
537
- },
538
- "schemas": {
539
- "FinancialConnectionsAccount": {
540
- "type": "object",
541
- "properties": {
542
- "remote_id": {
543
- "type": "string",
544
- "description": "Remote Id of the account, ie Plaid or Teller account id"
545
- },
546
- "fingerprint": {
547
- "type": "string",
548
- "description": "Uniquely identifies this account across all accounts associated with your organization. See more information here: https://letsfuse.readme.io/docs/duplicate-accounts"
549
- },
550
- "institution": {
551
- "type": "object",
552
- "properties": {
553
- "name": {
554
- "type": "string"
555
- }
556
- }
557
- },
558
- "last_four": {
559
- "type": "string",
560
- "description": "The last four digits of the account number."
561
- },
562
- "name": {
563
- "type": "string",
564
- "description": "The account's name, ie 'My Checking'"
565
- },
566
- "type": {
567
- "type": "string",
568
- "description": "The account's type e.g depository."
569
- },
570
- "subtype": {
571
- "type": "string",
572
- "description": "The account's subtype"
573
- },
574
- "balance": {
575
- "type": "object",
576
- "properties": {
577
- "available": {
578
- "type": "string",
579
- "description": "The amount of funds available to be withdrawn from the account, as determined by the financial institution\nAvailable balance may be cached and is not guaranteed to be up-to-date in realtime unless the value was returned by /financial_connections/balances."
580
- },
581
- "current": {
582
- "type": "number",
583
- "description": "Amount without factoring in pending balances"
584
- },
585
- "iso_currency_code": {
586
- "type": "string",
587
- "description": "The ISO-4217 currency code of the balance."
588
- },
589
- "last_updated_date": {
590
- "type": "string",
591
- "description": "The date of the last update to the balance."
592
- }
593
- }
594
- }
595
- }
596
- },
597
- "FinancialConnectionsOwner": {
598
- "type": "object",
599
- "properties": {
600
- "addresses": {
601
- "type": "array",
602
- "items": {
603
- "type": "object",
604
- "properties": {
605
- "data": {
606
- "type": "object",
607
- "properties": {
608
- "city": {
609
- "type": "string",
610
- "description": "City of the address"
611
- },
612
- "country": {
613
- "type": "string",
614
- "description": "Country of the address"
615
- },
616
- "postal_code": {
617
- "type": "string",
618
- "description": "Postal code of the address"
619
- },
620
- "region": {
621
- "type": "string",
622
- "description": "Region of the address"
623
- },
624
- "street": {
625
- "type": "string",
626
- "description": "Street of the address"
627
- }
628
- }
629
- },
630
- "primary": {
631
- "type": "boolean",
632
- "description": "Indicating if it is the primary address"
633
- }
634
- }
635
- }
636
- },
637
- "emails": {
638
- "type": "array",
639
- "items": {
640
- "type": "object",
641
- "properties": {
642
- "data": {
643
- "type": "string",
644
- "description": "Email address"
645
- },
646
- "primary": {
647
- "type": "boolean",
648
- "description": "Indicating if it is the primary email"
649
- },
650
- "type": {
651
- "type": "string",
652
- "enum": ["primary", "secondary", "other"],
653
- "description": "Type of the email"
654
- }
655
- }
656
- }
657
- },
658
- "names": {
659
- "type": "array",
660
- "description": "List of names associated with the owner",
661
- "items": {
662
- "type": "object",
663
- "properties": {
664
- "data": {
665
- "type": "string",
666
- "description": "Name of the owner"
667
- },
668
- "type": {
669
- "type": "string",
670
- "description": "Type of name. Possible values are \"name\" or \"alias\""
671
- }
672
- }
673
- }
674
- },
675
- "phone_numbers": {
676
- "type": "array",
677
- "items": {
678
- "type": "object",
679
- "properties": {
680
- "data": {
681
- "type": "string",
682
- "description": "The phone number"
683
- },
684
- "primary": {
685
- "type": "boolean",
686
- "description": "Indicating if it is the primary phone number"
687
- },
688
- "type": {
689
- "type": "string",
690
- "enum": ["home", "work", "mobile"],
691
- "description": "Type of the phone number"
692
- }
693
- }
694
- }
695
- }
696
- }
697
- },
698
- "FuseApiError": {
699
- "type": "object",
700
- "properties": {
701
- "title": {
702
- "type": "string"
703
- },
704
- "details": {
705
- "type": "string"
706
- },
707
- "code": {
708
- "type": "string"
709
- },
710
- "type": {
711
- "type": "string"
712
- },
713
- "source": {
714
- "type": "string",
715
- "enum": ["internal", "aggregator"]
716
- },
717
- "data": {
718
- "type": "object",
719
- "properties": {
720
- "aggregator": {
721
- "type": "string"
722
- },
723
- "errors": {
724
- "type": "array",
725
- "items": {
726
- "$ref": "#/components/schemas/FuseApiError"
727
- }
728
- }
729
- }
730
- }
731
- }
732
- },
733
- "FuseApiWarning": {
734
- "type": "object",
735
- "properties": {
736
- "title": {
737
- "type": "string"
738
- },
739
- "details": {
740
- "type": "string"
741
- },
742
- "code": {
743
- "type": "string"
744
- },
745
- "type": {
746
- "type": "string"
747
- },
748
- "source": {
749
- "type": "string",
750
- "enum": ["internal", "aggregator"]
751
- },
752
- "data": {
753
- "type": "object",
754
- "properties": {
755
- "aggregator": {
756
- "type": "string"
757
- },
758
- "errors": {
759
- "type": "array",
760
- "items": {
761
- "$ref": "#/components/schemas/FuseApiWarning"
762
- }
763
- }
764
- }
765
- }
766
- }
767
- },
768
- "GetFinancialConnectionsAccountDetailsRequest": {
769
- "type": "object",
770
- "required": ["access_token"],
771
- "properties": {
772
- "access_token": {
773
- "type": "string",
774
- "description": "Access token for authentication"
775
- }
776
- }
777
- },
778
- "FinancialConnectionsAccountDetails": {
779
- "type": "object",
780
- "properties": {
781
- "remote_id": {
782
- "type": "string",
783
- "description": "Remote Id of the account, ie Plaid or Teller account id"
784
- },
785
- "ach": {
786
- "type": "object",
787
- "properties": {
788
- "account": {
789
- "type": "string",
790
- "description": "Account number"
791
- },
792
- "routing": {
793
- "type": "string",
794
- "description": "Routing number"
795
- },
796
- "wire_routing": {
797
- "type": "string",
798
- "description": "Wire routing number"
799
- },
800
- "bacs_routing": {
801
- "type": "string",
802
- "description": "BACS routing number"
803
- }
804
- }
805
- },
806
- "remote_data": {
807
- "type": "object",
808
- "description": "The exact data from the aggregator (ie plaid) that we retrieved the information from"
809
- }
810
- }
811
- },
812
- "GetFinancialConnectionsAccountDetailsResponse": {
813
- "type": "object",
814
- "properties": {
815
- "account_details": {
816
- "type": "array",
817
- "items": {
818
- "$ref": "#/components/schemas/FinancialConnectionsAccountDetails"
819
- }
820
- }
821
- }
822
- },
823
- "GetFinancialConnectionsOwnersRequest": {
824
- "type": "object",
825
- "required": ["access_token"],
826
- "properties": {
827
- "access_token": {
828
- "type": "string",
829
- "description": "Access token for authentication"
830
- }
831
- }
832
- },
833
- "GetFinancialConnectionsOwnersResponse": {
834
- "type": "object",
835
- "properties": {
836
- "accounts": {
837
- "type": "array",
838
- "items": {
839
- "type": "object",
840
- "properties": {
841
- "remote_account_id": {
842
- "type": "string",
843
- "description": "The remote account id of the account"
844
- },
845
- "owners": {
846
- "type": "array",
847
- "items": {
848
- "$ref": "#/components/schemas/FinancialConnectionsOwner"
849
- }
850
- }
851
- }
852
- }
853
- }
854
- }
855
- },
856
- "GetFinancialConnectionsAccountsRequest": {
857
- "type": "object",
858
- "required": ["access_token"],
859
- "properties": {
860
- "access_token": {
861
- "type": "string",
862
- "description": "Access token for authentication"
863
- }
864
- }
865
- },
866
- "GetFinancialConnectionsAccountsResponse": {
867
- "type": "object",
868
- "properties": {
869
- "accounts": {
870
- "type": "array",
871
- "items": {
872
- "$ref": "#/components/schemas/FinancialConnectionsAccount"
873
- }
874
- }
875
- }
876
- },
877
- "CreateAssetReportRequest": {
878
- "type": "object",
879
- "required": ["access_token", "days_requested"],
880
- "properties": {
881
- "access_token": {
882
- "type": "string",
883
- "description": "Access token for the entity to create report for."
884
- },
885
- "days_requested": {
886
- "type": "number",
887
- "description": "The maximum integer number of days of history to include in the Asset Report",
888
- "minimum": 1,
889
- "maximum": 365
890
- }
891
- }
892
- },
893
- "CreateAssetReportResponse": {
894
- "type": "object",
895
- "properties": {
896
- "asset_report_token": {
897
- "type": "string",
898
- "description": "A token that can be provided to endpoints such as /asset_report or /asset_report/pdf to fetch an Asset Report."
899
- },
900
- "asset_report_id": {
901
- "type": "string",
902
- "description": "A unique ID identifying an Asset Report. "
903
- }
904
- }
905
- },
906
- "GetAssetReportRequest": {
907
- "type": "object",
908
- "required": ["asset_report_token"],
909
- "properties": {
910
- "asset_report_token": {
911
- "type": "string",
912
- "description": "The token associated with the Asset Report to retrieve."
913
- }
914
- }
915
- },
916
- "GetAssetReportResponse": {
917
- "type": "object",
918
- "properties": {
919
- "report": {
920
- "type": "object",
921
- "description": "The Asset Report in JSON format.",
922
- "properties": {
923
- "asset_report_id": {
924
- "type": "string",
925
- "description": "A unique ID identifying an Asset Report."
926
- },
927
- "client_report_id": {
928
- "type": "string",
929
- "description": "An identifier you determine and submit for the Asset Report.\n"
930
- },
931
- "date_generated": {
932
- "type": "string",
933
- "description": "The date and time when the Asset Report was created, in ISO 8601 format"
934
- },
935
- "days_requested": {
936
- "type": "integer",
937
- "description": "The duration of transaction history you requested"
938
- },
939
- "accounts": {
940
- "type": "array",
941
- "description": "An array of Asset Reports, one for each account in the Asset Report.",
942
- "items": {
943
- "type": "object",
944
- "properties": {
945
- "remote_account_id": {
946
- "type": "string",
947
- "description": "\"The remote account ID of the account.\","
948
- },
949
- "balances": {
950
- "type": "object",
951
- "properties": {
952
- "available": {
953
- "type": "number",
954
- "description": "Amount after factoring in pending balances"
955
- },
956
- "current": {
957
- "type": "number",
958
- "description": "Amount without factoring in pending balances"
959
- },
960
- "iso_currency_code": {
961
- "type": "string",
962
- "description": "The ISO-4217 currency code of the balance."
963
- }
964
- }
965
- },
966
- "historical_balances": {
967
- "type": "array",
968
- "description": "An array of historical balances for the account.",
969
- "items": {
970
- "type": "object",
971
- "properties": {
972
- "date": {
973
- "type": "string",
974
- "description": "The date of the calculated historical balance, in an ISO 8601 format (YYYY-MM-DD)"
975
- },
976
- "current": {
977
- "type": "number",
978
- "description": "The total amount of funds in the account, calculated from the current balance in the balance object by subtracting inflows and adding back outflows according to the posted date of each transaction."
979
- },
980
- "iso_currency_code": {
981
- "type": "string",
982
- "description": "The ISO-4217 currency code of the balance."
983
- }
984
- }
985
- }
986
- },
987
- "owners": {
988
- "type": "array",
989
- "items": {
990
- "$ref": "#/components/schemas/FinancialConnectionsOwner"
991
- }
992
- }
993
- }
994
- }
995
- },
996
- "warnings": {
997
- "type": "array",
998
- "description": "If the Asset Report generation was successful but identity information cannot be returned, this array will contain information about the errors causing identity information to be missing",
999
- "items": {
1000
- "$ref": "#/components/schemas/FuseApiWarning"
1001
- }
1002
- }
1003
- }
1004
- }
1005
- }
1006
- },
1007
- "GetFinancialConnectionsBalanceRequest": {
1008
- "type": "object",
1009
- "required": ["access_token"],
1010
- "properties": {
1011
- "access_token": {
1012
- "type": "string",
1013
- "description": "Access token for authentication"
1014
- }
1015
- }
1016
- },
1017
- "FinancialConnectionsAccountBalance": {
1018
- "type": "object",
1019
- "properties": {
1020
- "remote_account_id": {
1021
- "type": "string",
1022
- "description": "Remote Account Id of the transaction, ie Plaid Account Id"
1023
- },
1024
- "available": {
1025
- "type": "number",
1026
- "description": "Amount after factoring in pending balances"
1027
- },
1028
- "current": {
1029
- "type": "number",
1030
- "description": "Amount without factoring in pending balances"
1031
- },
1032
- "iso_currency_code": {
1033
- "type": "string",
1034
- "description": "The ISO-4217 currency code of the balance."
1035
- },
1036
- "remote_data": {
1037
- "type": "object",
1038
- "description": "The exact data from the aggregator (ie plaid) that we retrieved the information from"
1039
- }
1040
- }
1041
- },
1042
- "GetFinancialConnectionsAccountBalanceResponse": {
1043
- "type": "object",
1044
- "properties": {
1045
- "balances": {
1046
- "type": "array",
1047
- "items": {
1048
- "$ref": "#/components/schemas/FinancialConnectionsAccountBalance"
1049
- }
1050
- }
1051
- }
1052
- },
1053
- "ExchangeFinancialConnectionsPublicTokenRequest": {
1054
- "type": "object",
1055
- "properties": {
1056
- "public_token": {
1057
- "type": "string",
1058
- "description": "The public token created after a user connects with their financial institution"
1059
- }
1060
- }
1061
- },
1062
- "ExchangeFinancialConnectionsPublicTokenResponse": {
1063
- "type": "object",
1064
- "properties": {
1065
- "access_token": {
1066
- "type": "string",
1067
- "description": "Token used for querying data on the user"
1068
- },
1069
- "financial_connection_id": {
1070
- "type": "string",
1071
- "description": "The id of the new financial connection. Every webhook will be sent with this id."
1072
- },
1073
- "request_id": {
1074
- "type": "string",
1075
- "description": "Used for debugging purposes"
1076
- }
1077
- }
1078
- },
1079
- "SyncFinancialConnectionsDataRequest": {
1080
- "type": "object",
1081
- "description": "Unified webhook data"
1082
- },
1083
- "SyncFinancialConnectionsDataResponse": {
1084
- "type": "object",
1085
- "properties": {
1086
- "message": {
1087
- "type": "string",
1088
- "description": "Response message"
1089
- }
1090
- }
1091
- },
1092
- "GetInvestmentHoldingsRequest": {
1093
- "type": "object",
1094
- "required": ["access_token"],
1095
- "properties": {
1096
- "access_token": {
1097
- "type": "string",
1098
- "description": "Access token for authentication"
1099
- }
1100
- }
1101
- },
1102
- "GetInvestmentTransactionsRequest": {
1103
- "type": "object",
1104
- "required": ["access_token"],
1105
- "properties": {
1106
- "access_token": {
1107
- "type": "string",
1108
- "description": "Access token for authentication"
1109
- }
1110
- }
1111
- },
1112
- "FinancialConnectionsHolding": {
1113
- "type": "object",
1114
- "properties": {
1115
- "cost_basis": {
1116
- "type": "number",
1117
- "description": "The original total value of the holding."
1118
- },
1119
- "value": {
1120
- "type": "number",
1121
- "description": "The value of the holding"
1122
- },
1123
- "iso_currency_code": {
1124
- "type": "string",
1125
- "description": "The ISO-4217 currency code of the holding."
1126
- },
1127
- "quantity": {
1128
- "type": "number",
1129
- "description": "The number of units of the security involved in this transaction."
1130
- },
1131
- "security_id": {
1132
- "type": "string",
1133
- "description": "The security_id associated with the holding."
1134
- }
1135
- }
1136
- },
1137
- "FinancialConnectionsInvestmentAccount": {
1138
- "type": "object",
1139
- "properties": {
1140
- "remote_id": {
1141
- "type": "string",
1142
- "description": "Remote Id of the account, ie Plaid or Teller account id"
1143
- },
1144
- "fingerprint": {
1145
- "type": "string",
1146
- "description": "Uniquely identifies this account across all accounts associated with your organization. See more information here: https://letsfuse.readme.io/docs/duplicate-accounts"
1147
- },
1148
- "institution": {
1149
- "type": "object",
1150
- "properties": {
1151
- "name": {
1152
- "type": "string"
1153
- }
1154
- }
1155
- },
1156
- "last_four": {
1157
- "type": "string",
1158
- "description": "The last four digits of the account number."
1159
- },
1160
- "name": {
1161
- "type": "string",
1162
- "description": "The account's name, ie 'My Checking'"
1163
- },
1164
- "type": {
1165
- "type": "string",
1166
- "description": "The account's type e.g depository."
1167
- },
1168
- "subtype": {
1169
- "type": "string",
1170
- "description": "The account's subtype e.g checking"
1171
- },
1172
- "balance": {
1173
- "type": "object",
1174
- "properties": {
1175
- "available": {
1176
- "type": "string",
1177
- "description": "The amount of funds available to be withdrawn from the account, as determined by the financial institution\nAvailable balance may be cached and is not guaranteed to be up-to-date in realtime unless the value was returned by /financial_connections/balances."
1178
- },
1179
- "current": {
1180
- "type": "number",
1181
- "description": "Amount without factoring in pending balances"
1182
- },
1183
- "iso_currency_code": {
1184
- "type": "string",
1185
- "description": "The ISO-4217 currency code of the balance."
1186
- },
1187
- "last_updated_date": {
1188
- "type": "string",
1189
- "description": "The date of the last update to the balance."
1190
- }
1191
- }
1192
- }
1193
- }
1194
- },
1195
- "FinancialConnectionsInvestmentTransaction": {
1196
- "type": "object",
1197
- "properties": {
1198
- "data": {
1199
- "type": "array",
1200
- "items": {
1201
- "type": "object",
1202
- "properties": {
1203
- "id": {
1204
- "type": "string",
1205
- "description": "Fuse Id of the investment transaction"
1206
- },
1207
- "remote_investment_transaction_id": {
1208
- "type": "string",
1209
- "description": "The remote ID of the Investment transaction"
1210
- },
1211
- "remote_account_id": {
1212
- "type": "string",
1213
- "description": "Remote Account Id of the transaction, ie Plaid Account Id"
1214
- },
1215
- "amount": {
1216
- "type": "number",
1217
- "description": "The complete value of the transaction. Positive values when cash is debited, e.g. purchases of stock; negative values when cash is credited, e.g. sales of stock."
1218
- },
1219
- "quantity": {
1220
- "type": "string",
1221
- "description": "The number of units of the security involved in this transaction. Positive for buy transactions; negative for sell transactions."
1222
- },
1223
- "name": {
1224
- "type": "string",
1225
- "description": "The institution’s description of the transaction."
1226
- },
1227
- "type": {
1228
- "type": "string",
1229
- "description": "Type of the transaction, ie buy, sell"
1230
- },
1231
- "date": {
1232
- "type": "string",
1233
- "description": "Date of the transaction"
1234
- }
1235
- }
1236
- }
1237
- }
1238
- }
1239
- },
1240
- "FinancialConnectionsInvestmentSecurity": {
1241
- "type": "object",
1242
- "properties": {
1243
- "type": {
1244
- "type": "string",
1245
- "description": "The security type of the holding."
1246
- },
1247
- "cusip": {
1248
- "type": "string",
1249
- "description": "9-character CUSIP, an identifier assigned to North American securities."
1250
- },
1251
- "name": {
1252
- "type": "string",
1253
- "description": "A descriptive name for the security, suitable for display."
1254
- },
1255
- "ticker_symbol": {
1256
- "type": "string",
1257
- "description": "The security’s trading symbol for publicly traded securities, and otherwise a short identifier if available."
1258
- },
1259
- "id": {
1260
- "type": "string",
1261
- "description": "A unique identity for the security"
1262
- }
1263
- }
1264
- },
1265
- "GetInvestmentHoldingsResponse": {
1266
- "type": "object",
1267
- "properties": {
1268
- "accounts": {
1269
- "type": "array",
1270
- "items": {
1271
- "$ref": "#/components/schemas/FinancialConnectionsInvestmentAccount"
1272
- }
1273
- },
1274
- "holdings": {
1275
- "type": "array",
1276
- "items": {
1277
- "$ref": "#/components/schemas/FinancialConnectionsHolding"
1278
- }
1279
- },
1280
- "securities": {
1281
- "type": "array",
1282
- "items": {
1283
- "$ref": "#/components/schemas/FinancialConnectionsInvestmentSecurity"
1284
- }
1285
- },
1286
- "remote_data": {
1287
- "type": "object",
1288
- "description": "The exact data from the aggregator (ie plaid) that we retrieved the information from."
1289
- }
1290
- }
1291
- },
1292
- "GetInvestmentTransactionsResponse": {
1293
- "type": "object",
1294
- "properties": {
1295
- "accounts": {
1296
- "type": "array",
1297
- "items": {
1298
- "$ref": "#/components/schemas/FinancialConnectionsInvestmentAccount"
1299
- }
1300
- },
1301
- "investment_transactions": {
1302
- "type": "array",
1303
- "items": {
1304
- "$ref": "#/components/schemas/FinancialConnectionsInvestmentTransaction"
1305
- }
1306
- },
1307
- "securities": {
1308
- "type": "array",
1309
- "items": {
1310
- "$ref": "#/components/schemas/FinancialConnectionsInvestmentSecurity"
1311
- }
1312
- },
1313
- "remote_data": {
1314
- "type": "object",
1315
- "description": "The exact data from the aggregator (ie plaid) that we retrieved the information from."
1316
- }
1317
- }
1318
- },
1319
- "GetLiabilitiesRequest": {
1320
- "type": "object",
1321
- "required": ["access_token"],
1322
- "properties": {
1323
- "access_token": {
1324
- "type": "string",
1325
- "description": "Access token for authentication"
1326
- }
1327
- }
1328
- },
1329
- "FinancialConnectionsAccountLiability": {
1330
- "allOf": [
1331
- {
1332
- "$ref": "#/components/schemas/FinancialConnectionsAccount"
1333
- },
1334
- {
1335
- "type": "object",
1336
- "properties": {
1337
- "aprs": {
1338
- "type": "array",
1339
- "description": "The various interest rates that apply to the account. If APR data is not available, this array will be empty.",
1340
- "items": {
1341
- "type": "object",
1342
- "properties": {
1343
- "apr_percentage": {
1344
- "type": "number",
1345
- "description": "Annual Percentage Rate applied."
1346
- },
1347
- "apr_type": {
1348
- "type": "string",
1349
- "description": "The type of balance to which the APR applies."
1350
- }
1351
- }
1352
- }
1353
- },
1354
- "interest_rate_percentage": {
1355
- "type": "number",
1356
- "description": "The interest rate on the loan as a percentage."
1357
- },
1358
- "origination_principal_amount": {
1359
- "type": "number",
1360
- "description": "The original principal balance of the loan."
1361
- },
1362
- "next_payment_due_date": {
1363
- "type": "string",
1364
- "description": "The due date for the next payment. The due date is null if a payment is not expected."
1365
- },
1366
- "last_payment_date": {
1367
- "type": "string",
1368
- "description": "The date of the last payment. Dates are returned in an ISO 8601 format (YYYY-MM-DD)."
1369
- },
1370
- "last_payment_amount": {
1371
- "type": "number",
1372
- "description": "The amount of the last payment."
1373
- },
1374
- "minimum_payment_amount": {
1375
- "type": "number",
1376
- "description": "The minimum payment required for an account. This can apply to any debt account."
1377
- }
1378
- }
1379
- }
1380
- ]
1381
- },
1382
- "GetLiabilitiesResponse": {
1383
- "type": "object",
1384
- "properties": {
1385
- "liabilities": {
1386
- "type": "array",
1387
- "items": {
1388
- "$ref": "#/components/schemas/FinancialConnectionsAccountLiability"
1389
- }
1390
- },
1391
- "remote_data": {
1392
- "type": "object",
1393
- "description": "The exact data from the aggregator (ie plaid) that we retrieved the information from."
1394
- }
1395
- }
1396
- },
1397
- "CreateLinkTokenRequest": {
1398
- "type": "object",
1399
- "required": ["user_id", "session_client_secret"],
1400
- "properties": {
1401
- "webhook_url": {
1402
- "type": "string",
1403
- "description": "The destination URL to which any webhooks should be sent.",
1404
- "example": "www.myserver.com/webhook"
1405
- },
1406
- "user_id": {
1407
- "type": "string",
1408
- "description": "An id that is unique for a user of your application."
1409
- },
1410
- "session_client_secret": {
1411
- "type": "string",
1412
- "description": "The session client secret created from the 'Create session client secret' endpoint"
1413
- },
1414
- "mx": {
1415
- "type": "object",
1416
- "description": "An object specifying information about the MX configuration to use for deciding which MX supported financial institutions to display.",
1417
- "properties": {
1418
- "config": {
1419
- "type": "object",
1420
- "properties": {},
1421
- "description": "Follows the same schema as MX's request a connect url(https://docs.mx.com/api#connect_request_a_url) schema. This is a stringified version of the config."
1422
- }
1423
- }
1424
- },
1425
- "plaid": {
1426
- "type": "object",
1427
- "description": "An object specifying information about the Plaid configuration to use when creating a link token. This option is required if Plaid was enabled when displaying the financial institutions to the user.",
1428
- "properties": {
1429
- "config": {
1430
- "type": "object",
1431
- "required": ["client_name"],
1432
- "description": "Follows the same schema as Plaid's Link Token Create Schema(https://plaid.com/docs/api/tokens/#linktokencreate). This parameter takes a stringified version of the config. 'products', 'client_id', 'secret', 'client_user_id', 'webhook', 'institution_data' and 'country_codes' (only US supported right now) will be set by Fuse and override any values you set.",
1433
- "properties": {
1434
- "client_name": {
1435
- "type": "string"
1436
- }
1437
- }
1438
- }
1439
- }
1440
- },
1441
- "institution_id": {
1442
- "type": "string"
1443
- }
1444
- }
1445
- },
1446
- "CreateLinkTokenResponse": {
1447
- "type": "object",
1448
- "properties": {
1449
- "link_token": {
1450
- "type": "string",
1451
- "description": "Token needed by the frontend sdk to initiate the connection"
1452
- },
1453
- "request_id": {
1454
- "type": "string",
1455
- "description": "Used for debugging purposes"
1456
- }
1457
- }
1458
- },
1459
- "CreateSessionRequest": {
1460
- "type": "object",
1461
- "properties": {
1462
- "supported_financial_institution_aggregators": {
1463
- "type": "array",
1464
- "minItems": 1,
1465
- "items": {
1466
- "type": "string",
1467
- "enum": ["PLAID", "TELLER", "MX"]
1468
- }
1469
- },
1470
- "mx": {
1471
- "type": "object",
1472
- "description": "This can be left empty even if MX is in the list of supported_financial_institution_aggregators, although we would recommend having a look at what each field means to see if you want to override the default value of 'false'. These fields are described here(https://docs.mx.com/api#core_resources_institutions_list_institutions). An object specifying information about the MX configuration to use for deciding which MX supported financial institutions to display.",
1473
- "properties": {
1474
- "supports_account_identification": {
1475
- "type": "boolean"
1476
- },
1477
- "supports_account_statement": {
1478
- "type": "boolean"
1479
- },
1480
- "supports_account_verification": {
1481
- "type": "boolean"
1482
- },
1483
- "supports_transaction_history": {
1484
- "type": "boolean"
1485
- }
1486
- }
1487
- },
1488
- "plaid": {
1489
- "type": "object",
1490
- "description": "This field is REQUIRED if PLAID is in the list of supported_financial_institution_aggregators. An object specifying information about the Plaid configuration to use for deciding which Plaid supported financial institutions to display.",
1491
- "properties": {
1492
- "products": {
1493
- "type": "array",
1494
- "description": "For a comprehensive list of supported plaid products, see https://plaid.com/docs/api/tokens/#link-token-create-request-products",
1495
- "minItems": 1,
1496
- "items": {
1497
- "type": "string"
1498
- }
1499
- }
1500
- }
1501
- }
1502
- }
1503
- },
1504
- "CreateSessionResponse": {
1505
- "type": "object",
1506
- "properties": {
1507
- "expiration": {
1508
- "type": "string",
1509
- "description": "4 hours from the point of creation"
1510
- },
1511
- "client_secret": {
1512
- "type": "string",
1513
- "description": "Token needed by the frontend sdk to start the process"
1514
- },
1515
- "request_id": {
1516
- "type": "string",
1517
- "description": "Used for debugging purposes"
1518
- }
1519
- }
1520
- },
1521
- "GetTransactionsRequest": {
1522
- "type": "object",
1523
- "required": ["access_token"],
1524
- "properties": {
1525
- "access_token": {
1526
- "type": "string",
1527
- "description": "Access token for authentication"
1528
- },
1529
- "cursor": {
1530
- "type": "string",
1531
- "description": "Cursor for pagination"
1532
- },
1533
- "count": {
1534
- "type": "integer",
1535
- "description": "Number of items per page"
1536
- }
1537
- }
1538
- },
1539
- "GetTransactionsResponse": {
1540
- "type": "object",
1541
- "properties": {
1542
- "data": {
1543
- "type": "array",
1544
- "items": {
1545
- "type": "object",
1546
- "properties": {
1547
- "id": {
1548
- "type": "string",
1549
- "description": "Fuse Id of the transaction"
1550
- },
1551
- "remote_id": {
1552
- "type": "string",
1553
- "description": "Remote Id of the transaction, ie Plaid or Teller Id"
1554
- },
1555
- "remote_account_id": {
1556
- "type": "string",
1557
- "description": "Remote Account Id of the transaction, ie Plaid Account Id"
1558
- },
1559
- "amount": {
1560
- "type": "number",
1561
- "description": "Amount in cents associated with the transaction"
1562
- },
1563
- "date": {
1564
- "type": "string",
1565
- "description": "Date of the transaction"
1566
- },
1567
- "description": {
1568
- "type": "string",
1569
- "description": "Description of the transaction"
1570
- },
1571
- "category": {
1572
- "type": "array",
1573
- "description": "Categories of the transaction, ie Computers and Electronics",
1574
- "items": {
1575
- "type": "string"
1576
- }
1577
- },
1578
- "merchant": {
1579
- "type": "object",
1580
- "properties": {
1581
- "name": {
1582
- "type": "string",
1583
- "description": "Merchant name"
1584
- }
1585
- }
1586
- },
1587
- "status": {
1588
- "type": "string",
1589
- "description": "The status of the transaction. This will be either POSTED or PENDING."
1590
- },
1591
- "type": {
1592
- "type": "string",
1593
- "description": "Type of the transaction, ie adjustment"
1594
- },
1595
- "remote_data": {
1596
- "type": "object",
1597
- "description": "The exact data from the aggregator (ie plaid) that we retrieved the information from"
1598
- }
1599
- }
1600
- }
1601
- },
1602
- "cursor": {
1603
- "type": "string",
1604
- "description": "The cursor of the last item returned"
1605
- },
1606
- "has_next": {
1607
- "type": "boolean",
1608
- "description": "Indicates if there are more pages to navigate through"
1609
- }
1610
- }
1611
- },
1612
- "SyncTransactionsRequest": {
1613
- "type": "object",
1614
- "required": ["access_token"],
1615
- "properties": {
1616
- "access_token": {
1617
- "type": "string",
1618
- "description": "The access token of the financial institution connection"
1619
- },
1620
- "cursor": {
1621
- "type": "string",
1622
- "description": "The cursor value represents the last update requested. Providing it will cause the response to only return changes after this update. If omitted, the entire history of updates will be returned, starting with the first-added transactions on the item."
1623
- },
1624
- "count": {
1625
- "type": "integer",
1626
- "description": "The number of transaction updates to fetch."
1627
- }
1628
- }
1629
- },
1630
- "SyncTransactionsResponse": {
1631
- "type": "object",
1632
- "properties": {
1633
- "added": {
1634
- "type": "array",
1635
- "items": {
1636
- "$ref": "#/components/schemas/TransactionCommonModel"
1637
- },
1638
- "description": "Transactions that have been added to the item since `cursor` ordered by ascending last modified time."
1639
- },
1640
- "modified": {
1641
- "type": "array",
1642
- "items": {
1643
- "$ref": "#/components/schemas/TransactionCommonModel"
1644
- },
1645
- "description": "Transactions that have been modified on the item since `cursor` ordered by ascending last modified time."
1646
- },
1647
- "removed": {
1648
- "type": "array",
1649
- "items": {
1650
- "type": "object",
1651
- "properties": {
1652
- "transaction_id": {
1653
- "type": "string"
1654
- }
1655
- }
1656
- },
1657
- "description": "Transactions that have been removed from the item since `cursor` ordered by ascending last modified time."
1658
- },
1659
- "next_cursor": {
1660
- "type": "string",
1661
- "description": "Cursor used for fetching any future updates after the latest update provided in this response. The cursor obtained after all pages have been pulled (indicated by `has_next` being `false`) will be valid for at least 1 year. This cursor should be persisted for later calls."
1662
- },
1663
- "has_next": {
1664
- "type": "boolean",
1665
- "description": "Represents if more than requested count of transaction updates exist. If true, the additional updates can be fetched by making an additional request with `cursor` set to `next_cursor`. If `has_next` is true, it's important to pull all available pages, to make it less likely for underlying data changes to conflict with pagination."
1666
- }
1667
- }
1668
- },
1669
- "TransactionCommonModel": {
1670
- "type": "object",
1671
- "properties": {
1672
- "data": {
1673
- "type": "array",
1674
- "items": {
1675
- "type": "object",
1676
- "properties": {
1677
- "id": {
1678
- "type": "string",
1679
- "description": "Fuse Id of the transaction"
1680
- },
1681
- "remote_id": {
1682
- "type": "string",
1683
- "description": "Remote Id of the transaction, ie Plaid or Teller Id"
1684
- },
1685
- "remote_account_id": {
1686
- "type": "string",
1687
- "description": "Remote Account Id of the transaction, ie Plaid Account Id"
1688
- },
1689
- "amount": {
1690
- "type": "number",
1691
- "description": "Amount in cents associated with the transaction"
1692
- },
1693
- "date": {
1694
- "type": "string",
1695
- "description": "Date of the transaction"
1696
- },
1697
- "description": {
1698
- "type": "string",
1699
- "description": "Description of the transaction"
1700
- },
1701
- "category": {
1702
- "type": "array",
1703
- "description": "Categories of the transaction, ie Computers and Electronics",
1704
- "items": {
1705
- "type": "string"
1706
- }
1707
- },
1708
- "merchant": {
1709
- "type": "object",
1710
- "properties": {
1711
- "name": {
1712
- "type": "string",
1713
- "description": "Merchant name"
1714
- }
1715
- }
1716
- },
1717
- "status": {
1718
- "type": "string",
1719
- "description": "The status of the transaction. This will be either POSTED or PENDING."
1720
- },
1721
- "type": {
1722
- "type": "string",
1723
- "description": "Type of the transaction, ie adjustment"
1724
- },
1725
- "remote_data": {
1726
- "type": "object",
1727
- "description": "The exact data from the aggregator (ie plaid) that we retrieved the information from"
1728
- }
1729
- }
1730
- }
1731
- }
1732
- }
1733
- }
1734
- }
1735
- }
1736
- }