apimatic-plaid-sdk 0.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (542) hide show
  1. checksums.yaml +7 -0
  2. data/LICENSE +28 -0
  3. data/README.md +192 -0
  4. data/bin/console +15 -0
  5. data/lib/plaid/api_helper.rb +10 -0
  6. data/lib/plaid/apis/accounts_api.rb +70 -0
  7. data/lib/plaid/apis/application_api.rb +35 -0
  8. data/lib/plaid/apis/asset_report_api.rb +301 -0
  9. data/lib/plaid/apis/auth_api.rb +43 -0
  10. data/lib/plaid/apis/bank_transfer_api.rb +287 -0
  11. data/lib/plaid/apis/base_api.rb +65 -0
  12. data/lib/plaid/apis/categories_api.rb +34 -0
  13. data/lib/plaid/apis/deposit_switch_api.rb +106 -0
  14. data/lib/plaid/apis/employers_api.rb +40 -0
  15. data/lib/plaid/apis/identity_api.rb +38 -0
  16. data/lib/plaid/apis/income_api.rb +220 -0
  17. data/lib/plaid/apis/institutions_api.rb +92 -0
  18. data/lib/plaid/apis/investments_api.rb +61 -0
  19. data/lib/plaid/apis/item_api.rb +267 -0
  20. data/lib/plaid/apis/liabilities_api.rb +47 -0
  21. data/lib/plaid/apis/link_api.rb +62 -0
  22. data/lib/plaid/apis/payment_initiation_api.rb +236 -0
  23. data/lib/plaid/apis/processor_api.rb +189 -0
  24. data/lib/plaid/apis/sandbox_api.rb +302 -0
  25. data/lib/plaid/apis/signal_api.rb +97 -0
  26. data/lib/plaid/apis/transactions_api.rb +111 -0
  27. data/lib/plaid/apis/transfer_api.rb +214 -0
  28. data/lib/plaid/apis/webhook_verification_key_api.rb +36 -0
  29. data/lib/plaid/client.rb +208 -0
  30. data/lib/plaid/configuration.rb +198 -0
  31. data/lib/plaid/exceptions/api_exception.rb +21 -0
  32. data/lib/plaid/exceptions/error_error_exception.rb +110 -0
  33. data/lib/plaid/http/api_response.rb +19 -0
  34. data/lib/plaid/http/auth/plaid_client_id.rb +52 -0
  35. data/lib/plaid/http/auth/plaid_secret.rb +52 -0
  36. data/lib/plaid/http/auth/plaid_version.rb +52 -0
  37. data/lib/plaid/http/http_call_back.rb +10 -0
  38. data/lib/plaid/http/http_method_enum.rb +10 -0
  39. data/lib/plaid/http/http_request.rb +10 -0
  40. data/lib/plaid/http/http_response.rb +10 -0
  41. data/lib/plaid/http/proxy_settings.rb +22 -0
  42. data/lib/plaid/logging/configuration/api_logging_configuration.rb +186 -0
  43. data/lib/plaid/logging/sdk_logger.rb +17 -0
  44. data/lib/plaid/models/account.rb +185 -0
  45. data/lib/plaid/models/account_access.rb +89 -0
  46. data/lib/plaid/models/account_assets.rb +258 -0
  47. data/lib/plaid/models/account_balance.rb +189 -0
  48. data/lib/plaid/models/account_filter.rb +107 -0
  49. data/lib/plaid/models/account_filters_response.rb +106 -0
  50. data/lib/plaid/models/account_identity.rb +206 -0
  51. data/lib/plaid/models/account_selection_cardinality.rb +44 -0
  52. data/lib/plaid/models/account_subtype.rb +319 -0
  53. data/lib/plaid/models/account_subtype1.rb +36 -0
  54. data/lib/plaid/models/account_type.rb +57 -0
  55. data/lib/plaid/models/accounts_balance_get_request.rb +108 -0
  56. data/lib/plaid/models/accounts_balance_get_request_options.rb +111 -0
  57. data/lib/plaid/models/accounts_get_request.rb +107 -0
  58. data/lib/plaid/models/accounts_get_request_options.rb +76 -0
  59. data/lib/plaid/models/accounts_get_response.rb +104 -0
  60. data/lib/plaid/models/ach_class.rb +99 -0
  61. data/lib/plaid/models/address.rb +84 -0
  62. data/lib/plaid/models/address1.rb +116 -0
  63. data/lib/plaid/models/address2.rb +155 -0
  64. data/lib/plaid/models/address_data.rb +114 -0
  65. data/lib/plaid/models/address_data1.rb +120 -0
  66. data/lib/plaid/models/address_data_nullable.rb +114 -0
  67. data/lib/plaid/models/address_nullable.rb +84 -0
  68. data/lib/plaid/models/application.rb +131 -0
  69. data/lib/plaid/models/application_get_request.rb +98 -0
  70. data/lib/plaid/models/application_get_response.rb +84 -0
  71. data/lib/plaid/models/apr.rb +109 -0
  72. data/lib/plaid/models/apr_type.rb +44 -0
  73. data/lib/plaid/models/asset_report.rb +145 -0
  74. data/lib/plaid/models/asset_report_audit_copy_create_request.rb +111 -0
  75. data/lib/plaid/models/asset_report_audit_copy_create_response.rb +87 -0
  76. data/lib/plaid/models/asset_report_audit_copy_get_request.rb +101 -0
  77. data/lib/plaid/models/asset_report_audit_copy_remove_request.rb +101 -0
  78. data/lib/plaid/models/asset_report_audit_copy_remove_response.rb +85 -0
  79. data/lib/plaid/models/asset_report_create_request.rb +125 -0
  80. data/lib/plaid/models/asset_report_create_request_options.rb +104 -0
  81. data/lib/plaid/models/asset_report_create_response.rb +100 -0
  82. data/lib/plaid/models/asset_report_filter_request.rb +111 -0
  83. data/lib/plaid/models/asset_report_filter_response.rb +100 -0
  84. data/lib/plaid/models/asset_report_get_request.rb +112 -0
  85. data/lib/plaid/models/asset_report_get_response.rb +103 -0
  86. data/lib/plaid/models/asset_report_item.rb +130 -0
  87. data/lib/plaid/models/asset_report_pdf_get_request.rb +101 -0
  88. data/lib/plaid/models/asset_report_refresh_request.rb +127 -0
  89. data/lib/plaid/models/asset_report_refresh_request_options.rb +104 -0
  90. data/lib/plaid/models/asset_report_refresh_response.rb +100 -0
  91. data/lib/plaid/models/asset_report_remove_request.rb +101 -0
  92. data/lib/plaid/models/asset_report_remove_response.rb +85 -0
  93. data/lib/plaid/models/asset_report_transaction.rb +296 -0
  94. data/lib/plaid/models/asset_report_user.rb +153 -0
  95. data/lib/plaid/models/assets_error_webhook.rb +107 -0
  96. data/lib/plaid/models/assets_product_ready_webhook.rb +97 -0
  97. data/lib/plaid/models/auth_get_numbers.rb +141 -0
  98. data/lib/plaid/models/auth_get_request.rb +107 -0
  99. data/lib/plaid/models/auth_get_request_options.rb +78 -0
  100. data/lib/plaid/models/auth_get_response.rb +116 -0
  101. data/lib/plaid/models/auth_metadata.rb +77 -0
  102. data/lib/plaid/models/auth_supported_methods.rb +94 -0
  103. data/lib/plaid/models/automatically_verified_webhook.rb +102 -0
  104. data/lib/plaid/models/available_balance.rb +39 -0
  105. data/lib/plaid/models/bank_initiated_return_risk.rb +96 -0
  106. data/lib/plaid/models/bank_transfer.rb +263 -0
  107. data/lib/plaid/models/bank_transfer_balance.rb +85 -0
  108. data/lib/plaid/models/bank_transfer_balance_get_request.rb +103 -0
  109. data/lib/plaid/models/bank_transfer_balance_get_response.rb +97 -0
  110. data/lib/plaid/models/bank_transfer_cancel_request.rb +99 -0
  111. data/lib/plaid/models/bank_transfer_cancel_response.rb +76 -0
  112. data/lib/plaid/models/bank_transfer_create_request.rb +254 -0
  113. data/lib/plaid/models/bank_transfer_create_response.rb +84 -0
  114. data/lib/plaid/models/bank_transfer_direction.rb +37 -0
  115. data/lib/plaid/models/bank_transfer_direction1.rb +37 -0
  116. data/lib/plaid/models/bank_transfer_event.rb +211 -0
  117. data/lib/plaid/models/bank_transfer_event_list_request.rb +229 -0
  118. data/lib/plaid/models/bank_transfer_event_list_response.rb +94 -0
  119. data/lib/plaid/models/bank_transfer_event_sync_request.rb +110 -0
  120. data/lib/plaid/models/bank_transfer_event_sync_response.rb +94 -0
  121. data/lib/plaid/models/bank_transfer_event_type.rb +63 -0
  122. data/lib/plaid/models/bank_transfer_failure.rb +93 -0
  123. data/lib/plaid/models/bank_transfer_get_request.rb +99 -0
  124. data/lib/plaid/models/bank_transfer_get_response.rb +84 -0
  125. data/lib/plaid/models/bank_transfer_list_request.rb +175 -0
  126. data/lib/plaid/models/bank_transfer_list_response.rb +93 -0
  127. data/lib/plaid/models/bank_transfer_migrate_account_request.rb +117 -0
  128. data/lib/plaid/models/bank_transfer_migrate_account_response.rb +93 -0
  129. data/lib/plaid/models/bank_transfer_network.rb +41 -0
  130. data/lib/plaid/models/bank_transfer_receiver_details.rb +79 -0
  131. data/lib/plaid/models/bank_transfer_status.rb +48 -0
  132. data/lib/plaid/models/bank_transfer_sweep.rb +129 -0
  133. data/lib/plaid/models/bank_transfer_sweep_account.rb +84 -0
  134. data/lib/plaid/models/bank_transfer_sweep_get_request.rb +113 -0
  135. data/lib/plaid/models/bank_transfer_sweep_get_response.rb +85 -0
  136. data/lib/plaid/models/bank_transfer_sweep_list_request.rb +164 -0
  137. data/lib/plaid/models/bank_transfer_sweep_list_response.rb +94 -0
  138. data/lib/plaid/models/bank_transfer_type.rb +38 -0
  139. data/lib/plaid/models/bank_transfer_type1.rb +38 -0
  140. data/lib/plaid/models/bank_transfer_user.rb +100 -0
  141. data/lib/plaid/models/bank_transfers_events_update_webhook.rb +83 -0
  142. data/lib/plaid/models/base_model.rb +110 -0
  143. data/lib/plaid/models/branch.rb +49 -0
  144. data/lib/plaid/models/buy_type.rb +165 -0
  145. data/lib/plaid/models/canonical_description.rb +92 -0
  146. data/lib/plaid/models/cash_type.rb +305 -0
  147. data/lib/plaid/models/categories_get_response.rb +93 -0
  148. data/lib/plaid/models/category.rb +93 -0
  149. data/lib/plaid/models/cause.rb +88 -0
  150. data/lib/plaid/models/code.rb +56 -0
  151. data/lib/plaid/models/confidence.rb +45 -0
  152. data/lib/plaid/models/connected_application.rb +177 -0
  153. data/lib/plaid/models/country_code.rb +56 -0
  154. data/lib/plaid/models/country_code1.rb +36 -0
  155. data/lib/plaid/models/credit.rb +80 -0
  156. data/lib/plaid/models/credit_account.rb +83 -0
  157. data/lib/plaid/models/credit_card_liability.rb +164 -0
  158. data/lib/plaid/models/credit_filter.rb +78 -0
  159. data/lib/plaid/models/currency.rb +37 -0
  160. data/lib/plaid/models/customer_initiated_return_risk.rb +100 -0
  161. data/lib/plaid/models/decision.rb +48 -0
  162. data/lib/plaid/models/deductions.rb +103 -0
  163. data/lib/plaid/models/default_update_webhook.rb +119 -0
  164. data/lib/plaid/models/deposit_switch_address_data.rb +110 -0
  165. data/lib/plaid/models/deposit_switch_alt_create_request.rb +132 -0
  166. data/lib/plaid/models/deposit_switch_alt_create_response.rb +87 -0
  167. data/lib/plaid/models/deposit_switch_create_request.rb +133 -0
  168. data/lib/plaid/models/deposit_switch_create_request_options.rb +99 -0
  169. data/lib/plaid/models/deposit_switch_create_response.rb +87 -0
  170. data/lib/plaid/models/deposit_switch_get_request.rb +99 -0
  171. data/lib/plaid/models/deposit_switch_get_response.rb +277 -0
  172. data/lib/plaid/models/deposit_switch_state_update_webhook.rb +116 -0
  173. data/lib/plaid/models/deposit_switch_target_account.rb +106 -0
  174. data/lib/plaid/models/deposit_switch_target_user.rb +121 -0
  175. data/lib/plaid/models/deposit_switch_token_create_request.rb +100 -0
  176. data/lib/plaid/models/deposit_switch_token_create_response.rb +101 -0
  177. data/lib/plaid/models/depository.rb +80 -0
  178. data/lib/plaid/models/depository_account.rb +147 -0
  179. data/lib/plaid/models/depository_filter.rb +78 -0
  180. data/lib/plaid/models/distribution_details.rb +126 -0
  181. data/lib/plaid/models/document_metadata.rb +96 -0
  182. data/lib/plaid/models/earnings.rb +104 -0
  183. data/lib/plaid/models/earnings_total.rb +133 -0
  184. data/lib/plaid/models/email.rb +91 -0
  185. data/lib/plaid/models/employee.rb +107 -0
  186. data/lib/plaid/models/employee2.rb +85 -0
  187. data/lib/plaid/models/employee_income_summary_field_string.rb +90 -0
  188. data/lib/plaid/models/employer.rb +102 -0
  189. data/lib/plaid/models/employer2.rb +86 -0
  190. data/lib/plaid/models/employer3.rb +74 -0
  191. data/lib/plaid/models/employer_income_summary_field_string.rb +90 -0
  192. data/lib/plaid/models/employers_search_request.rb +107 -0
  193. data/lib/plaid/models/employers_search_response.rb +93 -0
  194. data/lib/plaid/models/employment_details.rb +88 -0
  195. data/lib/plaid/models/error.rb +172 -0
  196. data/lib/plaid/models/error_type.rb +76 -0
  197. data/lib/plaid/models/external_payment_refund_details.rb +92 -0
  198. data/lib/plaid/models/external_payment_schedule_base.rb +147 -0
  199. data/lib/plaid/models/external_payment_schedule_get.rb +140 -0
  200. data/lib/plaid/models/external_payment_schedule_request.rb +144 -0
  201. data/lib/plaid/models/fee_type.rb +287 -0
  202. data/lib/plaid/models/health_incident.rb +130 -0
  203. data/lib/plaid/models/historical_balance.rb +118 -0
  204. data/lib/plaid/models/historical_update_webhook.rb +124 -0
  205. data/lib/plaid/models/holding.rb +169 -0
  206. data/lib/plaid/models/holdings_default_update_webhook.rb +129 -0
  207. data/lib/plaid/models/holdings_override.rb +133 -0
  208. data/lib/plaid/models/identity_get_request.rb +107 -0
  209. data/lib/plaid/models/identity_get_request_options.rb +78 -0
  210. data/lib/plaid/models/identity_get_response.rb +101 -0
  211. data/lib/plaid/models/incident_update.rb +106 -0
  212. data/lib/plaid/models/income_breakdown.rb +106 -0
  213. data/lib/plaid/models/income_override.rb +84 -0
  214. data/lib/plaid/models/income_summary.rb +137 -0
  215. data/lib/plaid/models/income_summary_field_number.rb +90 -0
  216. data/lib/plaid/models/income_summary_field_string.rb +90 -0
  217. data/lib/plaid/models/income_verification_create_request.rb +99 -0
  218. data/lib/plaid/models/income_verification_create_response.rb +88 -0
  219. data/lib/plaid/models/income_verification_documents_download_request.rb +114 -0
  220. data/lib/plaid/models/income_verification_documents_download_response.rb +73 -0
  221. data/lib/plaid/models/income_verification_paystub_get_request.rb +114 -0
  222. data/lib/plaid/models/income_verification_paystub_get_response.rb +100 -0
  223. data/lib/plaid/models/income_verification_paystubs_get_request.rb +114 -0
  224. data/lib/plaid/models/income_verification_paystubs_get_response.rb +133 -0
  225. data/lib/plaid/models/income_verification_precheck_employer.rb +88 -0
  226. data/lib/plaid/models/income_verification_precheck_military_info.rb +90 -0
  227. data/lib/plaid/models/income_verification_precheck_request.rb +141 -0
  228. data/lib/plaid/models/income_verification_precheck_response.rb +101 -0
  229. data/lib/plaid/models/income_verification_precheck_user.rb +110 -0
  230. data/lib/plaid/models/income_verification_refresh_request.rb +114 -0
  231. data/lib/plaid/models/income_verification_refresh_response.rb +90 -0
  232. data/lib/plaid/models/income_verification_status_webhook.rb +117 -0
  233. data/lib/plaid/models/income_verification_summary_get_request.rb +114 -0
  234. data/lib/plaid/models/income_verification_summary_get_response.rb +109 -0
  235. data/lib/plaid/models/income_verification_taxforms_get_request.rb +114 -0
  236. data/lib/plaid/models/income_verification_taxforms_get_response.rb +129 -0
  237. data/lib/plaid/models/income_verification_webhook_status.rb +72 -0
  238. data/lib/plaid/models/inflow_model.rb +136 -0
  239. data/lib/plaid/models/initial_update_webhook.rb +121 -0
  240. data/lib/plaid/models/institution.rb +213 -0
  241. data/lib/plaid/models/institution_status.rb +211 -0
  242. data/lib/plaid/models/institutions_get_by_id_request.rb +120 -0
  243. data/lib/plaid/models/institutions_get_by_id_request_options.rb +131 -0
  244. data/lib/plaid/models/institutions_get_by_id_response.rb +85 -0
  245. data/lib/plaid/models/institutions_get_request.rb +125 -0
  246. data/lib/plaid/models/institutions_get_request_options.rb +154 -0
  247. data/lib/plaid/models/institutions_get_response.rb +102 -0
  248. data/lib/plaid/models/institutions_search_account_filter.rb +105 -0
  249. data/lib/plaid/models/institutions_search_payment_initiation_options.rb +77 -0
  250. data/lib/plaid/models/institutions_search_request.rb +132 -0
  251. data/lib/plaid/models/institutions_search_request_options.rb +136 -0
  252. data/lib/plaid/models/institutions_search_response.rb +94 -0
  253. data/lib/plaid/models/investment.rb +80 -0
  254. data/lib/plaid/models/investment_account_subtype.rb +501 -0
  255. data/lib/plaid/models/investment_filter.rb +78 -0
  256. data/lib/plaid/models/investment_holdings_get_request_options.rb +78 -0
  257. data/lib/plaid/models/investment_transaction.rb +231 -0
  258. data/lib/plaid/models/investments_holdings_get_request.rb +109 -0
  259. data/lib/plaid/models/investments_holdings_get_response.rb +142 -0
  260. data/lib/plaid/models/investments_transactions_get_request.rb +130 -0
  261. data/lib/plaid/models/investments_transactions_get_request_options.rb +96 -0
  262. data/lib/plaid/models/investments_transactions_get_response.rb +156 -0
  263. data/lib/plaid/models/investments_transactions_override.rb +151 -0
  264. data/lib/plaid/models/item.rb +173 -0
  265. data/lib/plaid/models/item_access_token_invalidate_request.rb +98 -0
  266. data/lib/plaid/models/item_access_token_invalidate_response.rb +86 -0
  267. data/lib/plaid/models/item_application_list_request.rb +100 -0
  268. data/lib/plaid/models/item_application_list_response.rb +95 -0
  269. data/lib/plaid/models/item_application_list_user_auth.rb +93 -0
  270. data/lib/plaid/models/item_application_scopes_update_request.rb +143 -0
  271. data/lib/plaid/models/item_application_scopes_update_response.rb +77 -0
  272. data/lib/plaid/models/item_error_webhook.rb +105 -0
  273. data/lib/plaid/models/item_get_request.rb +97 -0
  274. data/lib/plaid/models/item_get_response.rb +95 -0
  275. data/lib/plaid/models/item_import_request.rb +117 -0
  276. data/lib/plaid/models/item_import_request_options.rb +76 -0
  277. data/lib/plaid/models/item_import_request_user_auth.rb +83 -0
  278. data/lib/plaid/models/item_import_response.rb +84 -0
  279. data/lib/plaid/models/item_product_ready_webhook.rb +106 -0
  280. data/lib/plaid/models/item_public_token_create_request.rb +98 -0
  281. data/lib/plaid/models/item_public_token_create_response.rb +107 -0
  282. data/lib/plaid/models/item_public_token_exchange_request.rb +99 -0
  283. data/lib/plaid/models/item_public_token_exchange_response.rb +95 -0
  284. data/lib/plaid/models/item_remove_request.rb +97 -0
  285. data/lib/plaid/models/item_remove_response.rb +76 -0
  286. data/lib/plaid/models/item_status.rb +99 -0
  287. data/lib/plaid/models/item_status_investments.rb +114 -0
  288. data/lib/plaid/models/item_status_last_webhook.rb +98 -0
  289. data/lib/plaid/models/item_status_nullable.rb +99 -0
  290. data/lib/plaid/models/item_status_transactions.rb +114 -0
  291. data/lib/plaid/models/item_webhook_update_request.rb +107 -0
  292. data/lib/plaid/models/item_webhook_update_response.rb +85 -0
  293. data/lib/plaid/models/jwk_public_key.rb +150 -0
  294. data/lib/plaid/models/jwt_header.rb +72 -0
  295. data/lib/plaid/models/liabilities_default_update_webhook.rb +135 -0
  296. data/lib/plaid/models/liabilities_get_request.rb +108 -0
  297. data/lib/plaid/models/liabilities_get_request_options.rb +79 -0
  298. data/lib/plaid/models/liabilities_get_response.rb +111 -0
  299. data/lib/plaid/models/liabilities_object.rb +121 -0
  300. data/lib/plaid/models/liability_override.rb +326 -0
  301. data/lib/plaid/models/link_token_account_filters.rb +120 -0
  302. data/lib/plaid/models/link_token_create_request.rb +378 -0
  303. data/lib/plaid/models/link_token_create_request_account_subtypes.rb +118 -0
  304. data/lib/plaid/models/link_token_create_request_auth.rb +77 -0
  305. data/lib/plaid/models/link_token_create_request_deposit_switch.rb +77 -0
  306. data/lib/plaid/models/link_token_create_request_income_verification.rb +94 -0
  307. data/lib/plaid/models/link_token_create_request_payment_initiation.rb +77 -0
  308. data/lib/plaid/models/link_token_create_request_update.rb +82 -0
  309. data/lib/plaid/models/link_token_create_request_user.rb +201 -0
  310. data/lib/plaid/models/link_token_create_response.rb +107 -0
  311. data/lib/plaid/models/link_token_eu_config.rb +75 -0
  312. data/lib/plaid/models/link_token_get_metadata_response.rb +140 -0
  313. data/lib/plaid/models/link_token_get_request.rb +97 -0
  314. data/lib/plaid/models/link_token_get_response.rb +132 -0
  315. data/lib/plaid/models/loan.rb +80 -0
  316. data/lib/plaid/models/loan_account.rb +173 -0
  317. data/lib/plaid/models/loan_filter.rb +78 -0
  318. data/lib/plaid/models/meta.rb +90 -0
  319. data/lib/plaid/models/mfa.rb +124 -0
  320. data/lib/plaid/models/mortgage_interest_rate.rb +86 -0
  321. data/lib/plaid/models/mortgage_liability.rb +295 -0
  322. data/lib/plaid/models/mortgage_property_address.rb +114 -0
  323. data/lib/plaid/models/net_pay.rb +96 -0
  324. data/lib/plaid/models/new_accounts_available_webhook.rb +115 -0
  325. data/lib/plaid/models/new_payment_status.rb +73 -0
  326. data/lib/plaid/models/numbers.rb +157 -0
  327. data/lib/plaid/models/numbers_ach.rb +113 -0
  328. data/lib/plaid/models/numbers_ach_nullable.rb +112 -0
  329. data/lib/plaid/models/numbers_bacs.rb +92 -0
  330. data/lib/plaid/models/numbers_bacs_nullable.rb +91 -0
  331. data/lib/plaid/models/numbers_eft.rb +101 -0
  332. data/lib/plaid/models/numbers_eft_nullable.rb +100 -0
  333. data/lib/plaid/models/numbers_international.rb +91 -0
  334. data/lib/plaid/models/numbers_international_nullable.rb +90 -0
  335. data/lib/plaid/models/old_payment_status.rb +73 -0
  336. data/lib/plaid/models/override_account_type.rb +56 -0
  337. data/lib/plaid/models/override_accounts.rb +230 -0
  338. data/lib/plaid/models/owner.rb +141 -0
  339. data/lib/plaid/models/owner_override.rb +131 -0
  340. data/lib/plaid/models/pay.rb +88 -0
  341. data/lib/plaid/models/pay_frequency.rb +90 -0
  342. data/lib/plaid/models/pay_frequency1.rb +45 -0
  343. data/lib/plaid/models/pay_period_details.rb +119 -0
  344. data/lib/plaid/models/payment_amount.rb +84 -0
  345. data/lib/plaid/models/payment_channel.rb +43 -0
  346. data/lib/plaid/models/payment_initiation_address.rb +103 -0
  347. data/lib/plaid/models/payment_initiation_metadata.rb +117 -0
  348. data/lib/plaid/models/payment_initiation_optional_restriction_bacs.rb +85 -0
  349. data/lib/plaid/models/payment_initiation_payment.rb +242 -0
  350. data/lib/plaid/models/payment_initiation_payment_create_request.rb +140 -0
  351. data/lib/plaid/models/payment_initiation_payment_create_response.rb +95 -0
  352. data/lib/plaid/models/payment_initiation_payment_get_request.rb +98 -0
  353. data/lib/plaid/models/payment_initiation_payment_get_response.rb +254 -0
  354. data/lib/plaid/models/payment_initiation_payment_list_request.rb +124 -0
  355. data/lib/plaid/models/payment_initiation_payment_list_response.rb +115 -0
  356. data/lib/plaid/models/payment_initiation_payment_reverse_request.rb +98 -0
  357. data/lib/plaid/models/payment_initiation_payment_reverse_response.rb +99 -0
  358. data/lib/plaid/models/payment_initiation_payment_token_create_request.rb +98 -0
  359. data/lib/plaid/models/payment_initiation_payment_token_create_response.rb +107 -0
  360. data/lib/plaid/models/payment_initiation_recipient.rb +131 -0
  361. data/lib/plaid/models/payment_initiation_recipient_create_request.rb +133 -0
  362. data/lib/plaid/models/payment_initiation_recipient_create_response.rb +85 -0
  363. data/lib/plaid/models/payment_initiation_recipient_get_request.rb +98 -0
  364. data/lib/plaid/models/payment_initiation_recipient_get_response.rb +144 -0
  365. data/lib/plaid/models/payment_initiation_recipient_list_request.rb +89 -0
  366. data/lib/plaid/models/payment_initiation_recipient_list_response.rb +94 -0
  367. data/lib/plaid/models/payment_initiation_refund.rb +116 -0
  368. data/lib/plaid/models/payment_initiation_standing_order_metadata.rb +108 -0
  369. data/lib/plaid/models/payment_meta.rb +156 -0
  370. data/lib/plaid/models/payment_options.rb +122 -0
  371. data/lib/plaid/models/payment_schedule_interval.rb +36 -0
  372. data/lib/plaid/models/payment_status_update_webhook.rb +234 -0
  373. data/lib/plaid/models/paystub.rb +186 -0
  374. data/lib/plaid/models/paystub_deduction.rb +95 -0
  375. data/lib/plaid/models/paystub_details.rb +127 -0
  376. data/lib/plaid/models/paystub_override.rb +116 -0
  377. data/lib/plaid/models/paystub_ytd_details.rb +90 -0
  378. data/lib/plaid/models/pending_expiration_webhook.rb +112 -0
  379. data/lib/plaid/models/personal_finance_category.rb +87 -0
  380. data/lib/plaid/models/personal_finance_category2.rb +83 -0
  381. data/lib/plaid/models/phone_number.rb +91 -0
  382. data/lib/plaid/models/processor.rb +116 -0
  383. data/lib/plaid/models/processor_apex_processor_token_create_request.rb +108 -0
  384. data/lib/plaid/models/processor_auth_get_request.rb +100 -0
  385. data/lib/plaid/models/processor_auth_get_response.rb +98 -0
  386. data/lib/plaid/models/processor_balance_get_request.rb +111 -0
  387. data/lib/plaid/models/processor_balance_get_request_options.rb +98 -0
  388. data/lib/plaid/models/processor_balance_get_response.rb +85 -0
  389. data/lib/plaid/models/processor_bank_transfer_create_request.rb +248 -0
  390. data/lib/plaid/models/processor_bank_transfer_create_response.rb +84 -0
  391. data/lib/plaid/models/processor_identity_get_request.rb +101 -0
  392. data/lib/plaid/models/processor_identity_get_response.rb +85 -0
  393. data/lib/plaid/models/processor_number.rb +111 -0
  394. data/lib/plaid/models/processor_stripe_bank_account_token_create_request.rb +108 -0
  395. data/lib/plaid/models/processor_stripe_bank_account_token_create_response.rb +87 -0
  396. data/lib/plaid/models/processor_token_create_request.rb +116 -0
  397. data/lib/plaid/models/processor_token_create_response.rb +87 -0
  398. data/lib/plaid/models/product_access.rb +112 -0
  399. data/lib/plaid/models/product_data_type.rb +40 -0
  400. data/lib/plaid/models/product_status.rb +106 -0
  401. data/lib/plaid/models/products.rb +86 -0
  402. data/lib/plaid/models/projected_income_summary_field_number.rb +90 -0
  403. data/lib/plaid/models/pslf_status.rb +103 -0
  404. data/lib/plaid/models/recaptcha_required_error.rb +143 -0
  405. data/lib/plaid/models/recipient_bacs.rb +87 -0
  406. data/lib/plaid/models/recipient_bacs_nullable.rb +85 -0
  407. data/lib/plaid/models/refresh_interval.rb +42 -0
  408. data/lib/plaid/models/requested_scopes.rb +124 -0
  409. data/lib/plaid/models/sandbox_bank_transfer_fire_webhook_request.rb +97 -0
  410. data/lib/plaid/models/sandbox_bank_transfer_fire_webhook_response.rb +76 -0
  411. data/lib/plaid/models/sandbox_bank_transfer_simulate_request.rb +128 -0
  412. data/lib/plaid/models/sandbox_bank_transfer_simulate_response.rb +76 -0
  413. data/lib/plaid/models/sandbox_income_fire_webhook_request.rb +125 -0
  414. data/lib/plaid/models/sandbox_income_fire_webhook_response.rb +77 -0
  415. data/lib/plaid/models/sandbox_item_fire_webhook_request.rb +109 -0
  416. data/lib/plaid/models/sandbox_item_fire_webhook_response.rb +85 -0
  417. data/lib/plaid/models/sandbox_item_reset_login_request.rb +98 -0
  418. data/lib/plaid/models/sandbox_item_reset_login_response.rb +85 -0
  419. data/lib/plaid/models/sandbox_item_set_verification_status_request.rb +118 -0
  420. data/lib/plaid/models/sandbox_item_set_verification_status_response.rb +77 -0
  421. data/lib/plaid/models/sandbox_oauth_select_accounts_request.rb +83 -0
  422. data/lib/plaid/models/sandbox_processor_token_create_request.rb +111 -0
  423. data/lib/plaid/models/sandbox_processor_token_create_request_options.rb +92 -0
  424. data/lib/plaid/models/sandbox_processor_token_create_response.rb +85 -0
  425. data/lib/plaid/models/sandbox_public_token_create_request.rb +123 -0
  426. data/lib/plaid/models/sandbox_public_token_create_request_options.rb +116 -0
  427. data/lib/plaid/models/sandbox_public_token_create_request_options_transactions.rb +88 -0
  428. data/lib/plaid/models/sandbox_public_token_create_response.rb +86 -0
  429. data/lib/plaid/models/sandbox_transfer_simulate_request.rb +124 -0
  430. data/lib/plaid/models/sandbox_transfer_simulate_response.rb +76 -0
  431. data/lib/plaid/models/scopes.rb +109 -0
  432. data/lib/plaid/models/scopes_context.rb +38 -0
  433. data/lib/plaid/models/scopes_nullable.rb +109 -0
  434. data/lib/plaid/models/security.rb +252 -0
  435. data/lib/plaid/models/security_override.rb +131 -0
  436. data/lib/plaid/models/sell_type.rb +105 -0
  437. data/lib/plaid/models/sender_bacs_nullable.rb +85 -0
  438. data/lib/plaid/models/servicer_address_data.rb +117 -0
  439. data/lib/plaid/models/signal_decision_report_request.rb +110 -0
  440. data/lib/plaid/models/signal_decision_report_response.rb +77 -0
  441. data/lib/plaid/models/signal_evaluate_core_attributes.rb +662 -0
  442. data/lib/plaid/models/signal_evaluate_device.rb +90 -0
  443. data/lib/plaid/models/signal_evaluate_request.rb +163 -0
  444. data/lib/plaid/models/signal_evaluate_response.rb +99 -0
  445. data/lib/plaid/models/signal_evaluate_scores.rb +108 -0
  446. data/lib/plaid/models/signal_person_name.rb +122 -0
  447. data/lib/plaid/models/signal_return_report_request.rb +110 -0
  448. data/lib/plaid/models/signal_return_report_response.rb +77 -0
  449. data/lib/plaid/models/signal_user.rb +111 -0
  450. data/lib/plaid/models/standalone_account_type.rb +115 -0
  451. data/lib/plaid/models/standalone_currency_code_list.rb +86 -0
  452. data/lib/plaid/models/standalone_investment_transaction_type.rb +119 -0
  453. data/lib/plaid/models/state.rb +49 -0
  454. data/lib/plaid/models/status.rb +41 -0
  455. data/lib/plaid/models/status1.rb +48 -0
  456. data/lib/plaid/models/status2.rb +49 -0
  457. data/lib/plaid/models/status3.rb +73 -0
  458. data/lib/plaid/models/status_breakdown.rb +111 -0
  459. data/lib/plaid/models/student_loan.rb +367 -0
  460. data/lib/plaid/models/student_loan_repayment_model.rb +95 -0
  461. data/lib/plaid/models/student_loan_status.rb +86 -0
  462. data/lib/plaid/models/student_repayment_plan.rb +84 -0
  463. data/lib/plaid/models/subtype.rb +209 -0
  464. data/lib/plaid/models/switch_method.rb +45 -0
  465. data/lib/plaid/models/taxform.rb +84 -0
  466. data/lib/plaid/models/taxpayer_id.rb +89 -0
  467. data/lib/plaid/models/total.rb +110 -0
  468. data/lib/plaid/models/transaction.rb +426 -0
  469. data/lib/plaid/models/transaction_base.rb +285 -0
  470. data/lib/plaid/models/transaction_code.rb +87 -0
  471. data/lib/plaid/models/transaction_data.rb +112 -0
  472. data/lib/plaid/models/transaction_location.rb +143 -0
  473. data/lib/plaid/models/transaction_override.rb +119 -0
  474. data/lib/plaid/models/transaction_type.rb +48 -0
  475. data/lib/plaid/models/transactions_get_request.rb +128 -0
  476. data/lib/plaid/models/transactions_get_request_options.rb +139 -0
  477. data/lib/plaid/models/transactions_get_response.rb +138 -0
  478. data/lib/plaid/models/transactions_refresh_request.rb +98 -0
  479. data/lib/plaid/models/transactions_refresh_response.rb +77 -0
  480. data/lib/plaid/models/transactions_removed_webhook.rb +119 -0
  481. data/lib/plaid/models/transactions_update_investments_webhook.rb +134 -0
  482. data/lib/plaid/models/transfer.rb +229 -0
  483. data/lib/plaid/models/transfer_authorization.rb +126 -0
  484. data/lib/plaid/models/transfer_authorization_create_request.rb +197 -0
  485. data/lib/plaid/models/transfer_authorization_create_response.rb +86 -0
  486. data/lib/plaid/models/transfer_authorization_decision_rationale.rb +96 -0
  487. data/lib/plaid/models/transfer_authorization_device.rb +86 -0
  488. data/lib/plaid/models/transfer_authorization_proposed_transfer.rb +150 -0
  489. data/lib/plaid/models/transfer_cancel_request.rb +97 -0
  490. data/lib/plaid/models/transfer_cancel_response.rb +76 -0
  491. data/lib/plaid/models/transfer_create_request.rb +241 -0
  492. data/lib/plaid/models/transfer_create_response.rb +84 -0
  493. data/lib/plaid/models/transfer_event.rb +171 -0
  494. data/lib/plaid/models/transfer_event_list_request.rb +214 -0
  495. data/lib/plaid/models/transfer_event_list_response.rb +93 -0
  496. data/lib/plaid/models/transfer_event_sync_request.rb +110 -0
  497. data/lib/plaid/models/transfer_event_sync_response.rb +93 -0
  498. data/lib/plaid/models/transfer_event_type.rb +52 -0
  499. data/lib/plaid/models/transfer_failure.rb +93 -0
  500. data/lib/plaid/models/transfer_get_request.rb +97 -0
  501. data/lib/plaid/models/transfer_get_response.rb +84 -0
  502. data/lib/plaid/models/transfer_list_request.rb +163 -0
  503. data/lib/plaid/models/transfer_list_response.rb +93 -0
  504. data/lib/plaid/models/transfer_network.rb +37 -0
  505. data/lib/plaid/models/transfer_status.rb +48 -0
  506. data/lib/plaid/models/transfer_type.rb +146 -0
  507. data/lib/plaid/models/transfer_type1.rb +38 -0
  508. data/lib/plaid/models/transfer_type2.rb +38 -0
  509. data/lib/plaid/models/transfer_user_address_in_request.rb +114 -0
  510. data/lib/plaid/models/transfer_user_address_in_response.rb +114 -0
  511. data/lib/plaid/models/transfer_user_in_request.rb +105 -0
  512. data/lib/plaid/models/transfer_user_in_response.rb +104 -0
  513. data/lib/plaid/models/type.rb +52 -0
  514. data/lib/plaid/models/type1.rb +40 -0
  515. data/lib/plaid/models/type2.rb +100 -0
  516. data/lib/plaid/models/type3.rb +68 -0
  517. data/lib/plaid/models/type4.rb +60 -0
  518. data/lib/plaid/models/type5.rb +41 -0
  519. data/lib/plaid/models/unofficial_currency_code_list.rb +252 -0
  520. data/lib/plaid/models/update_type.rb +39 -0
  521. data/lib/plaid/models/user_custom_password.rb +166 -0
  522. data/lib/plaid/models/user_permission_revoked_webhook.rb +110 -0
  523. data/lib/plaid/models/value.rb +52 -0
  524. data/lib/plaid/models/verification_expired_webhook.rb +102 -0
  525. data/lib/plaid/models/verification_refresh_status.rb +29 -0
  526. data/lib/plaid/models/verification_status.rb +53 -0
  527. data/lib/plaid/models/verification_status1.rb +36 -0
  528. data/lib/plaid/models/verification_status3.rb +48 -0
  529. data/lib/plaid/models/verification_status4.rb +65 -0
  530. data/lib/plaid/models/w2.rb +346 -0
  531. data/lib/plaid/models/w2_box12.rb +88 -0
  532. data/lib/plaid/models/w2_state_and_local_wages.rb +152 -0
  533. data/lib/plaid/models/warning.rb +98 -0
  534. data/lib/plaid/models/webhook_update_acknowledged_webhook.rb +118 -0
  535. data/lib/plaid/models/webhook_verification_key_get_request.rb +98 -0
  536. data/lib/plaid/models/webhook_verification_key_get_response.rb +86 -0
  537. data/lib/plaid/models/ytd_gross_income_summary_field_number.rb +90 -0
  538. data/lib/plaid/models/ytd_net_income_summary_field_number.rb +90 -0
  539. data/lib/plaid/utilities/date_time_helper.rb +11 -0
  540. data/lib/plaid/utilities/file_wrapper.rb +28 -0
  541. data/lib/plaid.rb +565 -0
  542. metadata +625 -0
@@ -0,0 +1,65 @@
1
+ # plaid
2
+ #
3
+ # This file was automatically generated by APIMATIC v3.0 (
4
+ # https://www.apimatic.io ).
5
+
6
+ module Plaid
7
+ # BaseApi.
8
+ class BaseApi
9
+ include CoreLibrary
10
+ attr_accessor :config, :http_call_back
11
+
12
+ def self.user_agent
13
+ 'Ruby SDK, Version: 0.0.1, on OS {os-info}'
14
+ end
15
+
16
+ def self.user_agent_parameters
17
+ {
18
+ '{os-info}' => { 'value' => RUBY_PLATFORM, 'encode' => false }
19
+ }
20
+ end
21
+
22
+ GLOBAL_ERRORS = {
23
+ 'default' => ErrorCase.new
24
+ .error_message('HTTP response not OK.')
25
+ .exception_type(APIException)
26
+ }.freeze
27
+
28
+ # Initialization constructor.
29
+ # @param [GlobalConfiguration] global_configuration The instance of GlobalConfiguration.
30
+ def initialize(global_configuration)
31
+ @global_configuration = global_configuration
32
+ @config = @global_configuration.client_configuration
33
+ @http_call_back = @config.http_callback
34
+ @api_call = ApiCall.new(@global_configuration)
35
+ end
36
+
37
+ # Creates a new instance of the request builder.
38
+ # @param [String] http_method The HTTP method to use in the request.
39
+ # @param [String] path The endpoint path to use in the request.
40
+ # @param [String] server The server to extract the base uri for the request.
41
+ # @return [RequestBuilder] The instance of RequestBuilder.
42
+ def new_request_builder(http_method, path, server)
43
+ RequestBuilder.new
44
+ .http_method(http_method)
45
+ .path(path)
46
+ .server(server)
47
+ end
48
+
49
+ # Creates a new instance of the response handler.
50
+ # @return [ResponseHandler] The instance of ResponseHandler.
51
+ def new_response_handler
52
+ ResponseHandler.new
53
+ end
54
+
55
+ # Creates a new instance of the parameter.
56
+ # @param [String|optional] key The key of the parameter.
57
+ # @param [Object] value The value of the parameter.
58
+ # @return [Parameter] The instance of Parameter.
59
+ def new_parameter(value, key: nil)
60
+ Parameter.new
61
+ .key(key)
62
+ .value(value)
63
+ end
64
+ end
65
+ end
@@ -0,0 +1,34 @@
1
+ # plaid
2
+ #
3
+ # This file was automatically generated by APIMATIC v3.0 (
4
+ # https://www.apimatic.io ).
5
+
6
+ module Plaid
7
+ # CategoriesApi
8
+ class CategoriesApi < BaseApi
9
+ # Send a request to the `/categories/get` endpoint to get detailed
10
+ # information on categories returned by Plaid. This endpoint does not
11
+ # require authentication.
12
+ # @param [Object] body Required parameter: TODO: type description here
13
+ # @return [ApiResponse] Complete http response with raw body and status code.
14
+ def categories_get(body)
15
+ @api_call
16
+ .request(new_request_builder(HttpMethodEnum::POST,
17
+ '/categories/get',
18
+ Server::DEFAULT)
19
+ .header_param(new_parameter('text/plain', key: 'Content-Type'))
20
+ .body_param(new_parameter(body)
21
+ .is_required(true))
22
+ .header_param(new_parameter('application/json', key: 'accept'))
23
+ .body_serializer(APIHelper.method(:json_serialize)))
24
+ .response(new_response_handler
25
+ .deserializer(APIHelper.method(:custom_type_deserializer))
26
+ .deserialize_into(CategoriesGetResponse.method(:from_hash))
27
+ .is_api_response(true)
28
+ .local_error('default',
29
+ 'Error response.',
30
+ ErrorErrorException))
31
+ .execute
32
+ end
33
+ end
34
+ end
@@ -0,0 +1,106 @@
1
+ # plaid
2
+ #
3
+ # This file was automatically generated by APIMATIC v3.0 (
4
+ # https://www.apimatic.io ).
5
+
6
+ module Plaid
7
+ # DepositSwitchApi
8
+ class DepositSwitchApi < BaseApi
9
+ # This endpoint returns information related to how the user has configured
10
+ # their payroll allocation and the state of the switch. You can use this
11
+ # information to build logic related to the user's direct deposit allocation
12
+ # preferences.
13
+ # @param [DepositSwitchGetRequest] body Required parameter: TODO: type
14
+ # description here
15
+ # @return [ApiResponse] Complete http response with raw body and status code.
16
+ def deposit_switch_get(body)
17
+ @api_call
18
+ .request(new_request_builder(HttpMethodEnum::POST,
19
+ '/deposit_switch/get',
20
+ Server::DEFAULT)
21
+ .header_param(new_parameter('application/json', key: 'Content-Type'))
22
+ .body_param(new_parameter(body)
23
+ .is_required(true))
24
+ .header_param(new_parameter('application/json', key: 'accept'))
25
+ .body_serializer(proc do |param| param.to_json unless param.nil? end)
26
+ .auth(And.new('PLAID-CLIENT-ID', 'PLAID-SECRET', 'Plaid-Version')))
27
+ .response(new_response_handler
28
+ .deserializer(APIHelper.method(:custom_type_deserializer))
29
+ .deserialize_into(DepositSwitchGetResponse.method(:from_hash))
30
+ .is_api_response(true))
31
+ .execute
32
+ end
33
+
34
+ # This endpoint provides an alternative to `/deposit_switch/create` for
35
+ # customers who have not yet fully integrated with Plaid Exchange. Like
36
+ # `/deposit_switch/create`, it creates a deposit switch entity that will be
37
+ # persisted throughout the lifecycle of the switch.
38
+ # @param [DepositSwitchAltCreateRequest] body Required parameter: TODO: type
39
+ # description here
40
+ # @return [ApiResponse] Complete http response with raw body and status code.
41
+ def deposit_switch_alt_create(body)
42
+ @api_call
43
+ .request(new_request_builder(HttpMethodEnum::POST,
44
+ '/deposit_switch/alt/create',
45
+ Server::DEFAULT)
46
+ .header_param(new_parameter('application/json', key: 'Content-Type'))
47
+ .body_param(new_parameter(body)
48
+ .is_required(true))
49
+ .header_param(new_parameter('application/json', key: 'accept'))
50
+ .body_serializer(proc do |param| param.to_json unless param.nil? end)
51
+ .auth(And.new('PLAID-CLIENT-ID', 'PLAID-SECRET', 'Plaid-Version')))
52
+ .response(new_response_handler
53
+ .deserializer(APIHelper.method(:custom_type_deserializer))
54
+ .deserialize_into(DepositSwitchAltCreateResponse.method(:from_hash))
55
+ .is_api_response(true))
56
+ .execute
57
+ end
58
+
59
+ # This endpoint creates a deposit switch entity that will be persisted
60
+ # throughout the lifecycle of the switch.
61
+ # @param [DepositSwitchCreateRequest] body Required parameter: TODO: type
62
+ # description here
63
+ # @return [ApiResponse] Complete http response with raw body and status code.
64
+ def deposit_switch_create(body)
65
+ @api_call
66
+ .request(new_request_builder(HttpMethodEnum::POST,
67
+ '/deposit_switch/create',
68
+ Server::DEFAULT)
69
+ .header_param(new_parameter('application/json', key: 'Content-Type'))
70
+ .body_param(new_parameter(body)
71
+ .is_required(true))
72
+ .header_param(new_parameter('application/json', key: 'accept'))
73
+ .body_serializer(proc do |param| param.to_json unless param.nil? end)
74
+ .auth(And.new('PLAID-CLIENT-ID', 'PLAID-SECRET', 'Plaid-Version')))
75
+ .response(new_response_handler
76
+ .deserializer(APIHelper.method(:custom_type_deserializer))
77
+ .deserialize_into(DepositSwitchCreateResponse.method(:from_hash))
78
+ .is_api_response(true))
79
+ .execute
80
+ end
81
+
82
+ # In order for the end user to take action, you will need to create a public
83
+ # token representing the deposit switch. This token is used to initialize
84
+ # Link. It can be used one time and expires after 30 minutes.
85
+ # @param [DepositSwitchTokenCreateRequest] body Required parameter: TODO:
86
+ # type description here
87
+ # @return [ApiResponse] Complete http response with raw body and status code.
88
+ def deposit_switch_token_create(body)
89
+ @api_call
90
+ .request(new_request_builder(HttpMethodEnum::POST,
91
+ '/deposit_switch/token/create',
92
+ Server::DEFAULT)
93
+ .header_param(new_parameter('application/json', key: 'Content-Type'))
94
+ .body_param(new_parameter(body)
95
+ .is_required(true))
96
+ .header_param(new_parameter('application/json', key: 'accept'))
97
+ .body_serializer(proc do |param| param.to_json unless param.nil? end)
98
+ .auth(And.new('PLAID-CLIENT-ID', 'PLAID-SECRET', 'Plaid-Version')))
99
+ .response(new_response_handler
100
+ .deserializer(APIHelper.method(:custom_type_deserializer))
101
+ .deserialize_into(DepositSwitchTokenCreateResponse.method(:from_hash))
102
+ .is_api_response(true))
103
+ .execute
104
+ end
105
+ end
106
+ end
@@ -0,0 +1,40 @@
1
+ # plaid
2
+ #
3
+ # This file was automatically generated by APIMATIC v3.0 (
4
+ # https://www.apimatic.io ).
5
+
6
+ module Plaid
7
+ # EmployersApi
8
+ class EmployersApi < BaseApi
9
+ # `/employers/search` allows you the ability to search Plaid’s database of
10
+ # known employers, for use with Deposit Switch. You can use this endpoint to
11
+ # look up a user's employer in order to confirm that they are supported.
12
+ # Users with non-supported employers can then be routed out of the Deposit
13
+ # Switch flow.
14
+ # The data in the employer database is currently limited. As the Deposit
15
+ # Switch and Income products progress through their respective beta periods,
16
+ # more employers are being regularly added. Because the employer database is
17
+ # frequently updated, we recommend that you do not cache or store data from
18
+ # this endpoint for more than a day.
19
+ # @param [EmployersSearchRequest] body Required parameter: TODO: type
20
+ # description here
21
+ # @return [ApiResponse] Complete http response with raw body and status code.
22
+ def employers_search(body)
23
+ @api_call
24
+ .request(new_request_builder(HttpMethodEnum::POST,
25
+ '/employers/search',
26
+ Server::DEFAULT)
27
+ .header_param(new_parameter('application/json', key: 'Content-Type'))
28
+ .body_param(new_parameter(body)
29
+ .is_required(true))
30
+ .header_param(new_parameter('application/json', key: 'accept'))
31
+ .body_serializer(proc do |param| param.to_json unless param.nil? end)
32
+ .auth(And.new('PLAID-CLIENT-ID', 'PLAID-SECRET', 'Plaid-Version')))
33
+ .response(new_response_handler
34
+ .deserializer(APIHelper.method(:custom_type_deserializer))
35
+ .deserialize_into(EmployersSearchResponse.method(:from_hash))
36
+ .is_api_response(true))
37
+ .execute
38
+ end
39
+ end
40
+ end
@@ -0,0 +1,38 @@
1
+ # plaid
2
+ #
3
+ # This file was automatically generated by APIMATIC v3.0 (
4
+ # https://www.apimatic.io ).
5
+
6
+ module Plaid
7
+ # IdentityApi
8
+ class IdentityApi < BaseApi
9
+ # The `/identity/get` endpoint allows you to retrieve various account holder
10
+ # information on file with the financial institution, including names,
11
+ # emails, phone numbers, and addresses. Only name data is guaranteed to be
12
+ # returned; other fields will be empty arrays if not provided by the
13
+ # institution.
14
+ # Note: This request may take some time to complete if identity was not
15
+ # specified as an initial product when creating the Item. This is because
16
+ # Plaid must communicate directly with the institution to retrieve the data.
17
+ # @param [IdentityGetRequest] body Required parameter: TODO: type
18
+ # description here
19
+ # @return [ApiResponse] Complete http response with raw body and status code.
20
+ def identity_get(body)
21
+ @api_call
22
+ .request(new_request_builder(HttpMethodEnum::POST,
23
+ '/identity/get',
24
+ Server::DEFAULT)
25
+ .header_param(new_parameter('application/json', key: 'Content-Type'))
26
+ .body_param(new_parameter(body)
27
+ .is_required(true))
28
+ .header_param(new_parameter('application/json', key: 'accept'))
29
+ .body_serializer(proc do |param| param.to_json unless param.nil? end)
30
+ .auth(And.new('PLAID-CLIENT-ID', 'PLAID-SECRET', 'Plaid-Version')))
31
+ .response(new_response_handler
32
+ .deserializer(APIHelper.method(:custom_type_deserializer))
33
+ .deserialize_into(IdentityGetResponse.method(:from_hash))
34
+ .is_api_response(true))
35
+ .execute
36
+ end
37
+ end
38
+ end
@@ -0,0 +1,220 @@
1
+ # plaid
2
+ #
3
+ # This file was automatically generated by APIMATIC v3.0 (
4
+ # https://www.apimatic.io ).
5
+
6
+ module Plaid
7
+ # IncomeApi
8
+ class IncomeApi < BaseApi
9
+ # `/income/verification/taxforms/get` returns the information collected from
10
+ # taxforms that were used to verify an end user's. It can be called once the
11
+ # status of the verification has been set to
12
+ # `VERIFICATION_STATUS_PROCESSING_COMPLETE`, as reported by the `INCOME:
13
+ # verification_status` webhook. Attempting to call the endpoint before
14
+ # verification has been completed will result in an error.
15
+ # @param [IncomeVerificationTaxformsGetRequest] body Required parameter:
16
+ # TODO: type description here
17
+ # @return [ApiResponse] Complete http response with raw body and status code.
18
+ def income_verification_taxforms_get(body)
19
+ @api_call
20
+ .request(new_request_builder(HttpMethodEnum::POST,
21
+ '/income/verification/taxforms/get',
22
+ Server::DEFAULT)
23
+ .header_param(new_parameter('application/json', key: 'Content-Type'))
24
+ .body_param(new_parameter(body)
25
+ .is_required(true))
26
+ .header_param(new_parameter('application/json', key: 'accept'))
27
+ .body_serializer(proc do |param| param.to_json unless param.nil? end)
28
+ .auth(And.new('PLAID-CLIENT-ID', 'PLAID-SECRET', 'Plaid-Version')))
29
+ .response(new_response_handler
30
+ .deserializer(APIHelper.method(:custom_type_deserializer))
31
+ .deserialize_into(IncomeVerificationTaxformsGetResponse.method(:from_hash))
32
+ .is_api_response(true)
33
+ .local_error('default',
34
+ 'Error response.',
35
+ ErrorErrorException))
36
+ .execute
37
+ end
38
+
39
+ # (Deprecated) Retrieve information from a single paystub used for income
40
+ # verification
41
+ # @param [IncomeVerificationPaystubGetRequest] body Required parameter:
42
+ # TODO: type description here
43
+ # @return [ApiResponse] Complete http response with raw body and status code.
44
+ def income_verification_paystub_get(body)
45
+ @api_call
46
+ .request(new_request_builder(HttpMethodEnum::POST,
47
+ '/income/verification/paystub/get',
48
+ Server::DEFAULT)
49
+ .header_param(new_parameter('application/json', key: 'Content-Type'))
50
+ .body_param(new_parameter(body)
51
+ .is_required(true))
52
+ .header_param(new_parameter('application/json', key: 'accept'))
53
+ .body_serializer(proc do |param| param.to_json unless param.nil? end)
54
+ .auth(And.new('PLAID-CLIENT-ID', 'PLAID-SECRET', 'Plaid-Version')))
55
+ .response(new_response_handler
56
+ .deserializer(APIHelper.method(:custom_type_deserializer))
57
+ .deserialize_into(IncomeVerificationPaystubGetResponse.method(:from_hash))
58
+ .is_api_response(true))
59
+ .execute
60
+ end
61
+
62
+ # `/income/verification/documents/download` provides the ability to download
63
+ # the source paystub PDF that the end user uploaded via Paystub Import.
64
+ # The response to `/income/verification/documents/download` is a ZIP file in
65
+ # binary data. The `request_id` is returned in the `Plaid-Request-ID`
66
+ # header.
67
+ # For Payroll Income, the most recent file available for download with the
68
+ # payroll provider will also be available from this endpoint.
69
+ # @param [IncomeVerificationDocumentsDownloadRequest] body Required
70
+ # parameter: TODO: type description here
71
+ # @return [ApiResponse] Complete http response with raw body and status code.
72
+ def income_verification_documents_download(body)
73
+ @api_call
74
+ .request(new_request_builder(HttpMethodEnum::POST,
75
+ '/income/verification/documents/download',
76
+ Server::DEFAULT)
77
+ .header_param(new_parameter('application/json', key: 'Content-Type'))
78
+ .body_param(new_parameter(body)
79
+ .is_required(true))
80
+ .header_param(new_parameter('application/json', key: 'accept'))
81
+ .body_serializer(proc do |param| param.to_json unless param.nil? end)
82
+ .auth(And.new('PLAID-CLIENT-ID', 'PLAID-SECRET', 'Plaid-Version')))
83
+ .response(new_response_handler
84
+ .deserializer(APIHelper.method(:dynamic_deserializer))
85
+ .is_api_response(true))
86
+ .execute
87
+ end
88
+
89
+ # `/income/verification/refresh` refreshes a given income verification.
90
+ # @param [IncomeVerificationRefreshRequest] body Required parameter: TODO:
91
+ # type description here
92
+ # @return [ApiResponse] Complete http response with raw body and status code.
93
+ def income_verification_refresh(body)
94
+ @api_call
95
+ .request(new_request_builder(HttpMethodEnum::POST,
96
+ '/income/verification/refresh',
97
+ Server::DEFAULT)
98
+ .header_param(new_parameter('application/json', key: 'Content-Type'))
99
+ .body_param(new_parameter(body)
100
+ .is_required(true))
101
+ .header_param(new_parameter('application/json', key: 'accept'))
102
+ .body_serializer(proc do |param| param.to_json unless param.nil? end)
103
+ .auth(And.new('PLAID-CLIENT-ID', 'PLAID-SECRET', 'Plaid-Version')))
104
+ .response(new_response_handler
105
+ .deserializer(APIHelper.method(:custom_type_deserializer))
106
+ .deserialize_into(IncomeVerificationRefreshResponse.method(:from_hash))
107
+ .is_api_response(true)
108
+ .local_error('default',
109
+ 'Error response.',
110
+ ErrorErrorException))
111
+ .execute
112
+ end
113
+
114
+ # `/income/verification/paystubs/get` returns the information collected from
115
+ # the paystubs that were used to verify an end user's income. It can be
116
+ # called once the status of the verification has been set to
117
+ # `VERIFICATION_STATUS_PROCESSING_COMPLETE`, as reported by the `INCOME:
118
+ # verification_status` webhook. Attempting to call the endpoint before
119
+ # verification has been completed will result in an error.
120
+ # @param [IncomeVerificationPaystubsGetRequest] body Required parameter:
121
+ # TODO: type description here
122
+ # @return [ApiResponse] Complete http response with raw body and status code.
123
+ def income_verification_paystubs_get(body)
124
+ @api_call
125
+ .request(new_request_builder(HttpMethodEnum::POST,
126
+ '/income/verification/paystubs/get',
127
+ Server::DEFAULT)
128
+ .header_param(new_parameter('application/json', key: 'Content-Type'))
129
+ .body_param(new_parameter(body)
130
+ .is_required(true))
131
+ .header_param(new_parameter('application/json', key: 'accept'))
132
+ .body_serializer(proc do |param| param.to_json unless param.nil? end)
133
+ .auth(And.new('PLAID-CLIENT-ID', 'PLAID-SECRET', 'Plaid-Version')))
134
+ .response(new_response_handler
135
+ .deserializer(APIHelper.method(:custom_type_deserializer))
136
+ .deserialize_into(IncomeVerificationPaystubsGetResponse.method(:from_hash))
137
+ .is_api_response(true))
138
+ .execute
139
+ end
140
+
141
+ # `/income/verification/precheck` returns whether a given user is
142
+ # supportable by the income product
143
+ # @param [IncomeVerificationPrecheckRequest] body Required parameter: TODO:
144
+ # type description here
145
+ # @return [ApiResponse] Complete http response with raw body and status code.
146
+ def income_verification_precheck(body)
147
+ @api_call
148
+ .request(new_request_builder(HttpMethodEnum::POST,
149
+ '/income/verification/precheck',
150
+ Server::DEFAULT)
151
+ .header_param(new_parameter('application/json', key: 'Content-Type'))
152
+ .body_param(new_parameter(body)
153
+ .is_required(true))
154
+ .header_param(new_parameter('application/json', key: 'accept'))
155
+ .body_serializer(proc do |param| param.to_json unless param.nil? end)
156
+ .auth(And.new('PLAID-CLIENT-ID', 'PLAID-SECRET', 'Plaid-Version')))
157
+ .response(new_response_handler
158
+ .deserializer(APIHelper.method(:custom_type_deserializer))
159
+ .deserialize_into(IncomeVerificationPrecheckResponse.method(:from_hash))
160
+ .is_api_response(true))
161
+ .execute
162
+ end
163
+
164
+ # `/income/verification/summary/get` returns a verification summary for the
165
+ # income that was verified for an end user. It can be called once the status
166
+ # of the verification has been set to
167
+ # `VERIFICATION_STATUS_PROCESSING_COMPLETE`, as reported by the `INCOME:
168
+ # verification_status` webhook. Attempting to call the endpoint before
169
+ # verification has been completed will result in an error.
170
+ # @param [IncomeVerificationSummaryGetRequest] body Required parameter:
171
+ # TODO: type description here
172
+ # @return [ApiResponse] Complete http response with raw body and status code.
173
+ def income_verification_summary_get(body)
174
+ @api_call
175
+ .request(new_request_builder(HttpMethodEnum::POST,
176
+ '/income/verification/summary/get',
177
+ Server::DEFAULT)
178
+ .header_param(new_parameter('application/json', key: 'Content-Type'))
179
+ .body_param(new_parameter(body)
180
+ .is_required(true))
181
+ .header_param(new_parameter('application/json', key: 'accept'))
182
+ .body_serializer(proc do |param| param.to_json unless param.nil? end)
183
+ .auth(And.new('PLAID-CLIENT-ID', 'PLAID-SECRET', 'Plaid-Version')))
184
+ .response(new_response_handler
185
+ .deserializer(APIHelper.method(:custom_type_deserializer))
186
+ .deserialize_into(IncomeVerificationSummaryGetResponse.method(:from_hash))
187
+ .is_api_response(true))
188
+ .execute
189
+ end
190
+
191
+ # `/income/verification/create` begins the income verification process by
192
+ # returning an `income_verification_id`. You can then provide the
193
+ # `income_verification_id` to `/link/token/create` under the
194
+ # `income_verification` parameter in order to create a Link instance that
195
+ # will prompt the user to go through the income verification flow. Plaid
196
+ # will fire an `INCOME` webhook once the user completes the Payroll Income
197
+ # flow, or when the uploaded documents in the Document Income flow have
198
+ # finished processing.
199
+ # @param [IncomeVerificationCreateRequest] body Required parameter: TODO:
200
+ # type description here
201
+ # @return [ApiResponse] Complete http response with raw body and status code.
202
+ def income_verification_create(body)
203
+ @api_call
204
+ .request(new_request_builder(HttpMethodEnum::POST,
205
+ '/income/verification/create',
206
+ Server::DEFAULT)
207
+ .header_param(new_parameter('application/json', key: 'Content-Type'))
208
+ .body_param(new_parameter(body)
209
+ .is_required(true))
210
+ .header_param(new_parameter('application/json', key: 'accept'))
211
+ .body_serializer(proc do |param| param.to_json unless param.nil? end)
212
+ .auth(And.new('PLAID-CLIENT-ID', 'PLAID-SECRET', 'Plaid-Version')))
213
+ .response(new_response_handler
214
+ .deserializer(APIHelper.method(:custom_type_deserializer))
215
+ .deserialize_into(IncomeVerificationCreateResponse.method(:from_hash))
216
+ .is_api_response(true))
217
+ .execute
218
+ end
219
+ end
220
+ end
@@ -0,0 +1,92 @@
1
+ # plaid
2
+ #
3
+ # This file was automatically generated by APIMATIC v3.0 (
4
+ # https://www.apimatic.io ).
5
+
6
+ module Plaid
7
+ # InstitutionsApi
8
+ class InstitutionsApi < BaseApi
9
+ # Returns a JSON response containing details on a specified financial
10
+ # institution currently supported by Plaid.
11
+ # @param [InstitutionsGetByIdRequest] body Required parameter: TODO: type
12
+ # description here
13
+ # @return [ApiResponse] Complete http response with raw body and status code.
14
+ def institutions_get_by_id(body)
15
+ @api_call
16
+ .request(new_request_builder(HttpMethodEnum::POST,
17
+ '/institutions/get_by_id',
18
+ Server::DEFAULT)
19
+ .header_param(new_parameter('application/json', key: 'Content-Type'))
20
+ .body_param(new_parameter(body)
21
+ .is_required(true))
22
+ .header_param(new_parameter('application/json', key: 'accept'))
23
+ .body_serializer(proc do |param| param.to_json unless param.nil? end)
24
+ .auth(And.new('PLAID-CLIENT-ID', 'PLAID-SECRET', 'Plaid-Version')))
25
+ .response(new_response_handler
26
+ .deserializer(APIHelper.method(:custom_type_deserializer))
27
+ .deserialize_into(InstitutionsGetByIdResponse.method(:from_hash))
28
+ .is_api_response(true)
29
+ .local_error('default',
30
+ 'Error response',
31
+ ErrorErrorException))
32
+ .execute
33
+ end
34
+
35
+ # Returns a JSON response containing details on all financial institutions
36
+ # currently supported by Plaid. Because Plaid supports thousands of
37
+ # institutions, results are paginated.
38
+ # If there is no overlap between an institution’s enabled products and a
39
+ # client’s enabled products, then the institution will be filtered out from
40
+ # the response. As a result, the number of institutions returned may not
41
+ # match the count specified in the call.
42
+ # @param [InstitutionsGetRequest] body Required parameter: TODO: type
43
+ # description here
44
+ # @return [ApiResponse] Complete http response with raw body and status code.
45
+ def institutions_get(body)
46
+ @api_call
47
+ .request(new_request_builder(HttpMethodEnum::POST,
48
+ '/institutions/get',
49
+ Server::DEFAULT)
50
+ .header_param(new_parameter('application/json', key: 'Content-Type'))
51
+ .body_param(new_parameter(body)
52
+ .is_required(true))
53
+ .header_param(new_parameter('application/json', key: 'accept'))
54
+ .body_serializer(proc do |param| param.to_json unless param.nil? end)
55
+ .auth(And.new('PLAID-CLIENT-ID', 'PLAID-SECRET', 'Plaid-Version')))
56
+ .response(new_response_handler
57
+ .deserializer(APIHelper.method(:custom_type_deserializer))
58
+ .deserialize_into(InstitutionsGetResponse.method(:from_hash))
59
+ .is_api_response(true)
60
+ .local_error('default',
61
+ 'Error response',
62
+ ErrorErrorException))
63
+ .execute
64
+ end
65
+
66
+ # Returns a JSON response containing details for institutions that match the
67
+ # query parameters, up to a maximum of ten institutions per query.
68
+ # @param [InstitutionsSearchRequest] body Required parameter: TODO: type
69
+ # description here
70
+ # @return [ApiResponse] Complete http response with raw body and status code.
71
+ def institutions_search(body)
72
+ @api_call
73
+ .request(new_request_builder(HttpMethodEnum::POST,
74
+ '/institutions/search',
75
+ Server::DEFAULT)
76
+ .header_param(new_parameter('application/json', key: 'Content-Type'))
77
+ .body_param(new_parameter(body)
78
+ .is_required(true))
79
+ .header_param(new_parameter('application/json', key: 'accept'))
80
+ .body_serializer(proc do |param| param.to_json unless param.nil? end)
81
+ .auth(And.new('PLAID-CLIENT-ID', 'PLAID-SECRET', 'Plaid-Version')))
82
+ .response(new_response_handler
83
+ .deserializer(APIHelper.method(:custom_type_deserializer))
84
+ .deserialize_into(InstitutionsSearchResponse.method(:from_hash))
85
+ .is_api_response(true)
86
+ .local_error('default',
87
+ 'Error response',
88
+ ErrorErrorException))
89
+ .execute
90
+ end
91
+ end
92
+ end
@@ -0,0 +1,61 @@
1
+ # plaid
2
+ #
3
+ # This file was automatically generated by APIMATIC v3.0 (
4
+ # https://www.apimatic.io ).
5
+
6
+ module Plaid
7
+ # InvestmentsApi
8
+ class InvestmentsApi < BaseApi
9
+ # The `/investments/transactions/get` endpoint allows developers to retrieve
10
+ # user-authorized transaction data for investment accounts.
11
+ # Transactions are returned in reverse-chronological order, and the sequence
12
+ # of transaction ordering is stable and will not shift.
13
+ # Due to the potentially large number of investment transactions associated
14
+ # with an Item, results are paginated. Manipulate the count and offset
15
+ # parameters in conjunction with the `total_investment_transactions`
16
+ # response body field to fetch all available investment transactions.
17
+ # @param [InvestmentsTransactionsGetRequest] body Required parameter: TODO:
18
+ # type description here
19
+ # @return [ApiResponse] Complete http response with raw body and status code.
20
+ def investments_transactions_get(body)
21
+ @api_call
22
+ .request(new_request_builder(HttpMethodEnum::POST,
23
+ '/investments/transactions/get',
24
+ Server::DEFAULT)
25
+ .header_param(new_parameter('application/json', key: 'Content-Type'))
26
+ .body_param(new_parameter(body)
27
+ .is_required(true))
28
+ .header_param(new_parameter('application/json', key: 'accept'))
29
+ .body_serializer(proc do |param| param.to_json unless param.nil? end)
30
+ .auth(And.new('PLAID-CLIENT-ID', 'PLAID-SECRET', 'Plaid-Version')))
31
+ .response(new_response_handler
32
+ .deserializer(APIHelper.method(:custom_type_deserializer))
33
+ .deserialize_into(InvestmentsTransactionsGetResponse.method(:from_hash))
34
+ .is_api_response(true))
35
+ .execute
36
+ end
37
+
38
+ # The `/investments/holdings/get` endpoint allows developers to receive
39
+ # user-authorized stock position data for `investment`-type accounts.
40
+ # @param [InvestmentsHoldingsGetRequest] body Required parameter: TODO: type
41
+ # description here
42
+ # @return [ApiResponse] Complete http response with raw body and status code.
43
+ def investments_holdings_get(body)
44
+ @api_call
45
+ .request(new_request_builder(HttpMethodEnum::POST,
46
+ '/investments/holdings/get',
47
+ Server::DEFAULT)
48
+ .header_param(new_parameter('application/json', key: 'Content-Type'))
49
+ .body_param(new_parameter(body)
50
+ .is_required(true))
51
+ .header_param(new_parameter('application/json', key: 'accept'))
52
+ .body_serializer(proc do |param| param.to_json unless param.nil? end)
53
+ .auth(And.new('PLAID-CLIENT-ID', 'PLAID-SECRET', 'Plaid-Version')))
54
+ .response(new_response_handler
55
+ .deserializer(APIHelper.method(:custom_type_deserializer))
56
+ .deserialize_into(InvestmentsHoldingsGetResponse.method(:from_hash))
57
+ .is_api_response(true))
58
+ .execute
59
+ end
60
+ end
61
+ end