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,189 @@
1
+ # plaid
2
+ #
3
+ # This file was automatically generated by APIMATIC v3.0 (
4
+ # https://www.apimatic.io ).
5
+
6
+ module Plaid
7
+ # ProcessorApi
8
+ class ProcessorApi < BaseApi
9
+ # Use the `/processor/bank_transfer/create` endpoint to initiate a new bank
10
+ # transfer as a processor
11
+ # @param [ProcessorBankTransferCreateRequest] body Required parameter: TODO:
12
+ # type description here
13
+ # @return [ApiResponse] Complete http response with raw body and status code.
14
+ def processor_bank_transfer_create(body)
15
+ @api_call
16
+ .request(new_request_builder(HttpMethodEnum::POST,
17
+ '/processor/bank_transfer/create',
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(ProcessorBankTransferCreateResponse.method(:from_hash))
28
+ .is_api_response(true)
29
+ .local_error('default',
30
+ 'Error response',
31
+ ErrorErrorException))
32
+ .execute
33
+ end
34
+
35
+ # The `/processor/balance/get` endpoint returns the real-time balance for
36
+ # each of an Item's accounts. While other endpoints may return a balance
37
+ # object, only `/processor/balance/get` forces the available and current
38
+ # balance fields to be refreshed rather than cached.
39
+ # @param [ProcessorBalanceGetRequest] body Required parameter: The
40
+ # `/processor/balance/get` endpoint returns the real-time balance for the
41
+ # account associated with a given `processor_token`. The current balance is
42
+ # the total amount of funds in the account. The available balance is the
43
+ # current balance less any outstanding holds or debits that have not yet
44
+ # posted to the account. Note that not all institutions calculate the
45
+ # available balance. In the event that available balance is unavailable from
46
+ # the institution, Plaid will return an available balance value of `null`.
47
+ # @return [ApiResponse] Complete http response with raw body and status code.
48
+ def processor_balance_get(body)
49
+ @api_call
50
+ .request(new_request_builder(HttpMethodEnum::POST,
51
+ '/processor/balance/get',
52
+ Server::DEFAULT)
53
+ .header_param(new_parameter('application/json', key: 'Content-Type'))
54
+ .body_param(new_parameter(body)
55
+ .is_required(true))
56
+ .header_param(new_parameter('application/json', key: 'accept'))
57
+ .body_serializer(proc do |param| param.to_json unless param.nil? end)
58
+ .auth(And.new('PLAID-CLIENT-ID', 'PLAID-SECRET', 'Plaid-Version')))
59
+ .response(new_response_handler
60
+ .deserializer(APIHelper.method(:custom_type_deserializer))
61
+ .deserialize_into(ProcessorBalanceGetResponse.method(:from_hash))
62
+ .is_api_response(true))
63
+ .execute
64
+ end
65
+
66
+ # The `/processor/auth/get` endpoint returns the bank account and bank
67
+ # identification number (such as the routing number, for US accounts), for a
68
+ # checking or savings account that's associated with a given
69
+ # `processor_token`. The endpoint also returns high-level account data and
70
+ # balances when available.
71
+ # @param [ProcessorAuthGetRequest] body Required parameter: TODO: type
72
+ # description here
73
+ # @return [ApiResponse] Complete http response with raw body and status code.
74
+ def processor_auth_get(body)
75
+ @api_call
76
+ .request(new_request_builder(HttpMethodEnum::POST,
77
+ '/processor/auth/get',
78
+ Server::DEFAULT)
79
+ .header_param(new_parameter('application/json', key: 'Content-Type'))
80
+ .body_param(new_parameter(body)
81
+ .is_required(true))
82
+ .header_param(new_parameter('application/json', key: 'accept'))
83
+ .body_serializer(proc do |param| param.to_json unless param.nil? end)
84
+ .auth(And.new('PLAID-CLIENT-ID', 'PLAID-SECRET', 'Plaid-Version')))
85
+ .response(new_response_handler
86
+ .deserializer(APIHelper.method(:custom_type_deserializer))
87
+ .deserialize_into(ProcessorAuthGetResponse.method(:from_hash))
88
+ .is_api_response(true))
89
+ .execute
90
+ end
91
+
92
+ # The `/processor/identity/get` endpoint allows you to retrieve various
93
+ # account holder information on file with the financial institution,
94
+ # including names, emails, phone numbers, and addresses.
95
+ # @param [ProcessorIdentityGetRequest] body Required parameter: TODO: type
96
+ # description here
97
+ # @return [ApiResponse] Complete http response with raw body and status code.
98
+ def processor_identity_get(body)
99
+ @api_call
100
+ .request(new_request_builder(HttpMethodEnum::POST,
101
+ '/processor/identity/get',
102
+ Server::DEFAULT)
103
+ .header_param(new_parameter('application/json', key: 'Content-Type'))
104
+ .body_param(new_parameter(body)
105
+ .is_required(true))
106
+ .header_param(new_parameter('application/json', key: 'accept'))
107
+ .body_serializer(proc do |param| param.to_json unless param.nil? end)
108
+ .auth(And.new('PLAID-CLIENT-ID', 'PLAID-SECRET', 'Plaid-Version')))
109
+ .response(new_response_handler
110
+ .deserializer(APIHelper.method(:custom_type_deserializer))
111
+ .deserialize_into(ProcessorIdentityGetResponse.method(:from_hash))
112
+ .is_api_response(true))
113
+ .execute
114
+ end
115
+
116
+ # Used to create a token suitable for sending to Apex to enable Plaid-Apex
117
+ # integrations.
118
+ # @param [ProcessorApexProcessorTokenCreateRequest] body Required parameter:
119
+ # TODO: type description here
120
+ # @return [ApiResponse] Complete http response with raw body and status code.
121
+ def processor_apex_processor_token_create(body)
122
+ @api_call
123
+ .request(new_request_builder(HttpMethodEnum::POST,
124
+ '/processor/apex/processor_token/create',
125
+ Server::DEFAULT)
126
+ .header_param(new_parameter('application/json', key: 'Content-Type'))
127
+ .body_param(new_parameter(body)
128
+ .is_required(true))
129
+ .header_param(new_parameter('application/json', key: 'accept'))
130
+ .body_serializer(proc do |param| param.to_json unless param.nil? end)
131
+ .auth(And.new('PLAID-CLIENT-ID', 'PLAID-SECRET', 'Plaid-Version')))
132
+ .response(new_response_handler
133
+ .deserializer(APIHelper.method(:custom_type_deserializer))
134
+ .deserialize_into(ProcessorTokenCreateResponse.method(:from_hash))
135
+ .is_api_response(true))
136
+ .execute
137
+ end
138
+
139
+ # Used to create a token suitable for sending to one of Plaid's partners to
140
+ # enable integrations. Note that Stripe partnerships use bank account tokens
141
+ # instead; see `/processor/stripe/bank_account_token/create` for creating
142
+ # tokens for use with Stripe integrations.
143
+ # @param [ProcessorTokenCreateRequest] body Required parameter: TODO: type
144
+ # description here
145
+ # @return [ApiResponse] Complete http response with raw body and status code.
146
+ def processor_token_create(body)
147
+ @api_call
148
+ .request(new_request_builder(HttpMethodEnum::POST,
149
+ '/processor/token/create',
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(ProcessorTokenCreateResponse.method(:from_hash))
160
+ .is_api_response(true))
161
+ .execute
162
+ end
163
+
164
+ # Used to create a token suitable for sending to Stripe to enable
165
+ # Plaid-Stripe integrations. For a detailed guide on integrating Stripe, see
166
+ # [Add Stripe to your
167
+ # app](https://plaid.com/docs/auth/partnerships/stripe/).
168
+ # @param [ProcessorStripeBankAccountTokenCreateRequest] body Required
169
+ # parameter: TODO: type description here
170
+ # @return [ApiResponse] Complete http response with raw body and status code.
171
+ def processor_stripe_bank_account_token_create(body)
172
+ @api_call
173
+ .request(new_request_builder(HttpMethodEnum::POST,
174
+ '/processor/stripe/bank_account_token/create',
175
+ Server::DEFAULT)
176
+ .header_param(new_parameter('application/json', key: 'Content-Type'))
177
+ .body_param(new_parameter(body)
178
+ .is_required(true))
179
+ .header_param(new_parameter('application/json', key: 'accept'))
180
+ .body_serializer(proc do |param| param.to_json unless param.nil? end)
181
+ .auth(And.new('PLAID-CLIENT-ID', 'PLAID-SECRET', 'Plaid-Version')))
182
+ .response(new_response_handler
183
+ .deserializer(APIHelper.method(:custom_type_deserializer))
184
+ .deserialize_into(ProcessorStripeBankAccountTokenCreateResponse.method(:from_hash))
185
+ .is_api_response(true))
186
+ .execute
187
+ end
188
+ end
189
+ end
@@ -0,0 +1,302 @@
1
+ # plaid
2
+ #
3
+ # This file was automatically generated by APIMATIC v3.0 (
4
+ # https://www.apimatic.io ).
5
+
6
+ module Plaid
7
+ # SandboxApi
8
+ class SandboxApi < BaseApi
9
+ # The `/sandbox/item/set_verification_status` endpoint can be used to change
10
+ # the verification status of an Item in in the Sandbox in order to simulate
11
+ # the Automated Micro-deposit flow.
12
+ # Note that not all Plaid developer accounts are enabled for micro-deposit
13
+ # based verification by default. Your account must be enabled for this
14
+ # feature in order to test it in Sandbox. To enable this features or check
15
+ # your status, contact your account manager or [submit a product access
16
+ # Support
17
+ # ticket](https://dashboard.plaid.com/support/new/product-and-development/pr
18
+ # oduct-troubleshooting/request-product-access).
19
+ # For more information on testing Automated Micro-deposits in Sandbox, see
20
+ # [Auth full coverage
21
+ # testing](https://plaid.com/docs/auth/coverage/testing#).
22
+ # @param [SandboxItemSetVerificationStatusRequest] body Required parameter:
23
+ # TODO: type description here
24
+ # @return [ApiResponse] Complete http response with raw body and status code.
25
+ def sandbox_item_set_verification_status(body)
26
+ @api_call
27
+ .request(new_request_builder(HttpMethodEnum::POST,
28
+ '/sandbox/item/set_verification_status',
29
+ Server::DEFAULT)
30
+ .header_param(new_parameter('application/json', key: 'Content-Type'))
31
+ .body_param(new_parameter(body)
32
+ .is_required(true))
33
+ .header_param(new_parameter('application/json', key: 'accept'))
34
+ .body_serializer(proc do |param| param.to_json unless param.nil? end)
35
+ .auth(And.new('PLAID-CLIENT-ID', 'PLAID-SECRET', 'Plaid-Version')))
36
+ .response(new_response_handler
37
+ .deserializer(APIHelper.method(:custom_type_deserializer))
38
+ .deserialize_into(SandboxItemSetVerificationStatusResponse.method(:from_hash))
39
+ .is_api_response(true))
40
+ .execute
41
+ end
42
+
43
+ # Use the `/sandbox/public_token/create` endpoint to create a valid
44
+ # `public_token` for an arbitrary institution ID, initial products, and
45
+ # test credentials. The created `public_token` maps to a new Sandbox Item.
46
+ # You can then call `/item/public_token/exchange` to exchange the
47
+ # `public_token` for an `access_token` and perform all API actions.
48
+ # `/sandbox/public_token/create` can also be used with the [`user_custom`
49
+ # test username](https://plaid.com/docs/sandbox/user-custom) to generate a
50
+ # test account with custom data.
51
+ # @param [SandboxPublicTokenCreateRequest] body Required parameter: TODO:
52
+ # type description here
53
+ # @return [ApiResponse] Complete http response with raw body and status code.
54
+ def sandbox_public_token_create(body)
55
+ @api_call
56
+ .request(new_request_builder(HttpMethodEnum::POST,
57
+ '/sandbox/public_token/create',
58
+ Server::DEFAULT)
59
+ .header_param(new_parameter('application/json', key: 'Content-Type'))
60
+ .body_param(new_parameter(body)
61
+ .is_required(true))
62
+ .header_param(new_parameter('application/json', key: 'accept'))
63
+ .body_serializer(proc do |param| param.to_json unless param.nil? end)
64
+ .auth(And.new('PLAID-CLIENT-ID', 'PLAID-SECRET', 'Plaid-Version')))
65
+ .response(new_response_handler
66
+ .deserializer(APIHelper.method(:custom_type_deserializer))
67
+ .deserialize_into(SandboxPublicTokenCreateResponse.method(:from_hash))
68
+ .is_api_response(true)
69
+ .local_error('default',
70
+ 'Error response.',
71
+ ErrorErrorException))
72
+ .execute
73
+ end
74
+
75
+ # Use the `/sandbox/processor_token/create` endpoint to create a valid
76
+ # `processor_token` for an arbitrary institution ID and test credentials.
77
+ # The created `processor_token` corresponds to a new Sandbox Item. You can
78
+ # then use this `processor_token` with the `/processor/` API endpoints in
79
+ # Sandbox. You can also use `/sandbox/processor_token/create` with the
80
+ # [`user_custom` test username](https://plaid.com/docs/sandbox/user-custom)
81
+ # to generate a test account with custom data.
82
+ # @param [SandboxProcessorTokenCreateRequest] body Required parameter: TODO:
83
+ # type description here
84
+ # @return [ApiResponse] Complete http response with raw body and status code.
85
+ def sandbox_processor_token_create(body)
86
+ @api_call
87
+ .request(new_request_builder(HttpMethodEnum::POST,
88
+ '/sandbox/processor_token/create',
89
+ Server::DEFAULT)
90
+ .header_param(new_parameter('application/json', key: 'Content-Type'))
91
+ .body_param(new_parameter(body)
92
+ .is_required(true))
93
+ .header_param(new_parameter('application/json', key: 'accept'))
94
+ .body_serializer(proc do |param| param.to_json unless param.nil? end)
95
+ .auth(And.new('PLAID-CLIENT-ID', 'PLAID-SECRET', 'Plaid-Version')))
96
+ .response(new_response_handler
97
+ .deserializer(APIHelper.method(:custom_type_deserializer))
98
+ .deserialize_into(SandboxProcessorTokenCreateResponse.method(:from_hash))
99
+ .is_api_response(true)
100
+ .local_error('default',
101
+ 'Error response.',
102
+ ErrorErrorException))
103
+ .execute
104
+ end
105
+
106
+ # The `/sandbox/item/fire_webhook` endpoint is used to test that code
107
+ # correctly handles webhooks. Calling this endpoint triggers a Transactions
108
+ # `DEFAULT_UPDATE` webhook to be fired for a given Sandbox Item. If the Item
109
+ # does not support Transactions, a `SANDBOX_PRODUCT_NOT_ENABLED` error will
110
+ # result.
111
+ # @param [SandboxItemFireWebhookRequest] body Required parameter: TODO: type
112
+ # description here
113
+ # @return [ApiResponse] Complete http response with raw body and status code.
114
+ def sandbox_item_fire_webhook(body)
115
+ @api_call
116
+ .request(new_request_builder(HttpMethodEnum::POST,
117
+ '/sandbox/item/fire_webhook',
118
+ Server::DEFAULT)
119
+ .header_param(new_parameter('application/json', key: 'Content-Type'))
120
+ .body_param(new_parameter(body)
121
+ .is_required(true))
122
+ .header_param(new_parameter('application/json', key: 'accept'))
123
+ .body_serializer(proc do |param| param.to_json unless param.nil? end)
124
+ .auth(And.new('PLAID-CLIENT-ID', 'PLAID-SECRET', 'Plaid-Version')))
125
+ .response(new_response_handler
126
+ .deserializer(APIHelper.method(:custom_type_deserializer))
127
+ .deserialize_into(SandboxItemFireWebhookResponse.method(:from_hash))
128
+ .is_api_response(true)
129
+ .local_error('default',
130
+ 'Error response.',
131
+ ErrorErrorException))
132
+ .execute
133
+ end
134
+
135
+ # `/sandbox/item/reset_login/` forces an Item into an `ITEM_LOGIN_REQUIRED`
136
+ # state in order to simulate an Item whose login is no longer valid. This
137
+ # makes it easy to test Link's [update
138
+ # mode](https://plaid.com/docs/link/update-mode) flow in the Sandbox
139
+ # environment. After calling `/sandbox/item/reset_login`, You can then use
140
+ # Plaid Link update mode to restore the Item to a good state. An
141
+ # `ITEM_LOGIN_REQUIRED` webhook will also be fired after a call to this
142
+ # endpoint, if one is associated with the Item.
143
+ # In the Sandbox, Items will transition to an `ITEM_LOGIN_REQUIRED` error
144
+ # state automatically after 30 days, even if this endpoint is not called.
145
+ # @param [SandboxItemResetLoginRequest] body Required parameter: TODO: type
146
+ # description here
147
+ # @return [ApiResponse] Complete http response with raw body and status code.
148
+ def sandbox_item_reset_login(body)
149
+ @api_call
150
+ .request(new_request_builder(HttpMethodEnum::POST,
151
+ '/sandbox/item/reset_login',
152
+ Server::DEFAULT)
153
+ .header_param(new_parameter('application/json', key: 'Content-Type'))
154
+ .body_param(new_parameter(body)
155
+ .is_required(true))
156
+ .header_param(new_parameter('application/json', key: 'accept'))
157
+ .body_serializer(proc do |param| param.to_json unless param.nil? end)
158
+ .auth(And.new('PLAID-CLIENT-ID', 'PLAID-SECRET', 'Plaid-Version')))
159
+ .response(new_response_handler
160
+ .deserializer(APIHelper.method(:custom_type_deserializer))
161
+ .deserialize_into(SandboxItemResetLoginResponse.method(:from_hash))
162
+ .is_api_response(true))
163
+ .execute
164
+ end
165
+
166
+ # Use the `/sandbox/income/fire_webhook` endpoint to manually trigger an
167
+ # Income webhook in the Sandbox environment.
168
+ # @param [SandboxIncomeFireWebhookRequest] body Required parameter: TODO:
169
+ # type description here
170
+ # @return [ApiResponse] Complete http response with raw body and status code.
171
+ def sandbox_income_fire_webhook(body)
172
+ @api_call
173
+ .request(new_request_builder(HttpMethodEnum::POST,
174
+ '/sandbox/income/fire_webhook',
175
+ Server::DEFAULT)
176
+ .header_param(new_parameter('application/json', key: 'Content-Type'))
177
+ .body_param(new_parameter(body)
178
+ .is_required(true))
179
+ .header_param(new_parameter('application/json', key: 'accept'))
180
+ .body_serializer(proc do |param| param.to_json unless param.nil? end)
181
+ .auth(And.new('PLAID-CLIENT-ID', 'PLAID-SECRET', 'Plaid-Version')))
182
+ .response(new_response_handler
183
+ .deserializer(APIHelper.method(:custom_type_deserializer))
184
+ .deserialize_into(SandboxIncomeFireWebhookResponse.method(:from_hash))
185
+ .is_api_response(true)
186
+ .local_error('default',
187
+ 'Error response',
188
+ ErrorErrorException))
189
+ .execute
190
+ end
191
+
192
+ # Save the selected accounts when connecting to the Platypus Oauth
193
+ # institution
194
+ # @param [SandboxOauthSelectAccountsRequest] body Required parameter: TODO:
195
+ # type description here
196
+ # @return [ApiResponse] Complete http response with raw body and status code.
197
+ def sandbox_oauth_select_accounts(body)
198
+ @api_call
199
+ .request(new_request_builder(HttpMethodEnum::POST,
200
+ '/sandbox/oauth/select_accounts',
201
+ Server::DEFAULT)
202
+ .header_param(new_parameter('application/json', key: 'Content-Type'))
203
+ .body_param(new_parameter(body)
204
+ .is_required(true))
205
+ .header_param(new_parameter('application/json', key: 'accept'))
206
+ .body_serializer(proc do |param| param.to_json unless param.nil? end)
207
+ .auth(And.new('PLAID-CLIENT-ID', 'PLAID-SECRET', 'Plaid-Version')))
208
+ .response(new_response_handler
209
+ .deserializer(APIHelper.method(:json_deserialize))
210
+ .is_api_response(true)
211
+ .local_error('default',
212
+ 'Error response.',
213
+ ErrorErrorException))
214
+ .execute
215
+ end
216
+
217
+ # Use the `/sandbox/transfer/simulate` endpoint to simulate a transfer event
218
+ # in the Sandbox environment. Note that while an event will be simulated
219
+ # and will appear when using endpoints such as `/transfer/event/sync` or
220
+ # `/transfer/event/list`, no transactions will actually take place and funds
221
+ # will not move between accounts, even within the Sandbox.
222
+ # @param [SandboxTransferSimulateRequest] body Required parameter: TODO:
223
+ # type description here
224
+ # @return [ApiResponse] Complete http response with raw body and status code.
225
+ def sandbox_transfer_simulate(body)
226
+ @api_call
227
+ .request(new_request_builder(HttpMethodEnum::POST,
228
+ '/sandbox/transfer/simulate',
229
+ Server::DEFAULT)
230
+ .header_param(new_parameter('application/json', key: 'Content-Type'))
231
+ .body_param(new_parameter(body)
232
+ .is_required(true))
233
+ .header_param(new_parameter('application/json', key: 'accept'))
234
+ .body_serializer(proc do |param| param.to_json unless param.nil? end)
235
+ .auth(And.new('PLAID-CLIENT-ID', 'PLAID-SECRET', 'Plaid-Version')))
236
+ .response(new_response_handler
237
+ .deserializer(APIHelper.method(:custom_type_deserializer))
238
+ .deserialize_into(SandboxTransferSimulateResponse.method(:from_hash))
239
+ .is_api_response(true)
240
+ .local_error('default',
241
+ 'Error response',
242
+ ErrorErrorException))
243
+ .execute
244
+ end
245
+
246
+ # Use the `/sandbox/bank_transfer/fire_webhook` endpoint to manually trigger
247
+ # a Bank Transfers webhook in the Sandbox environment.
248
+ # @param [SandboxBankTransferFireWebhookRequest] body Required parameter:
249
+ # TODO: type description here
250
+ # @return [ApiResponse] Complete http response with raw body and status code.
251
+ def sandbox_bank_transfer_fire_webhook(body)
252
+ @api_call
253
+ .request(new_request_builder(HttpMethodEnum::POST,
254
+ '/sandbox/bank_transfer/fire_webhook',
255
+ Server::DEFAULT)
256
+ .header_param(new_parameter('application/json', key: 'Content-Type'))
257
+ .body_param(new_parameter(body)
258
+ .is_required(true))
259
+ .header_param(new_parameter('application/json', key: 'accept'))
260
+ .body_serializer(proc do |param| param.to_json unless param.nil? end)
261
+ .auth(And.new('PLAID-CLIENT-ID', 'PLAID-SECRET', 'Plaid-Version')))
262
+ .response(new_response_handler
263
+ .deserializer(APIHelper.method(:custom_type_deserializer))
264
+ .deserialize_into(SandboxBankTransferFireWebhookResponse.method(:from_hash))
265
+ .is_api_response(true)
266
+ .local_error('default',
267
+ 'Error response',
268
+ ErrorErrorException))
269
+ .execute
270
+ end
271
+
272
+ # Use the `/sandbox/bank_transfer/simulate` endpoint to simulate a bank
273
+ # transfer event in the Sandbox environment. Note that while an event will
274
+ # be simulated and will appear when using endpoints such as
275
+ # `/bank_transfer/event/sync` or `/bank_transfer/event/list`, no
276
+ # transactions will actually take place and funds will not move between
277
+ # accounts, even within the Sandbox.
278
+ # @param [SandboxBankTransferSimulateRequest] body Required parameter: TODO:
279
+ # type description here
280
+ # @return [ApiResponse] Complete http response with raw body and status code.
281
+ def sandbox_bank_transfer_simulate(body)
282
+ @api_call
283
+ .request(new_request_builder(HttpMethodEnum::POST,
284
+ '/sandbox/bank_transfer/simulate',
285
+ Server::DEFAULT)
286
+ .header_param(new_parameter('application/json', key: 'Content-Type'))
287
+ .body_param(new_parameter(body)
288
+ .is_required(true))
289
+ .header_param(new_parameter('application/json', key: 'accept'))
290
+ .body_serializer(proc do |param| param.to_json unless param.nil? end)
291
+ .auth(And.new('PLAID-CLIENT-ID', 'PLAID-SECRET', 'Plaid-Version')))
292
+ .response(new_response_handler
293
+ .deserializer(APIHelper.method(:custom_type_deserializer))
294
+ .deserialize_into(SandboxBankTransferSimulateResponse.method(:from_hash))
295
+ .is_api_response(true)
296
+ .local_error('default',
297
+ 'Error response',
298
+ ErrorErrorException))
299
+ .execute
300
+ end
301
+ end
302
+ end
@@ -0,0 +1,97 @@
1
+ # plaid
2
+ #
3
+ # This file was automatically generated by APIMATIC v3.0 (
4
+ # https://www.apimatic.io ).
5
+
6
+ module Plaid
7
+ # SignalApi
8
+ class SignalApi < BaseApi
9
+ # Use `/signal/evaluate` to evaluate a planned ACH transaction to get a
10
+ # return risk assessment (such as a risk score and risk tier) and additional
11
+ # risk signals.
12
+ # In order to obtain a valid score for an ACH transaction, Plaid must have
13
+ # an access token for the account, and the Item must be healthy (receiving
14
+ # product updates) or have recently been in a healthy state. If the
15
+ # transaction does not meet eligibility requirements, an error will be
16
+ # returned corresponding to the underlying cause.
17
+ # @param [SignalEvaluateRequest] body Required parameter: TODO: type
18
+ # description here
19
+ # @return [ApiResponse] Complete http response with raw body and status code.
20
+ def signal_evaluate(body)
21
+ @api_call
22
+ .request(new_request_builder(HttpMethodEnum::POST,
23
+ '/signal/evaluate',
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(SignalEvaluateResponse.method(:from_hash))
34
+ .is_api_response(true)
35
+ .local_error('default',
36
+ 'Error response.',
37
+ ErrorErrorException))
38
+ .execute
39
+ end
40
+
41
+ # After calling `/signal/evaluate`, call `/signal/decision/report` to report
42
+ # whether the transaction was initiated. This endpoint will return an
43
+ # `INVALID_REQUEST` error if called a second time with a different value for
44
+ # `initiated`.
45
+ # @param [SignalDecisionReportRequest] body Required parameter: TODO: type
46
+ # description here
47
+ # @return [ApiResponse] Complete http response with raw body and status code.
48
+ def signal_decision_report(body)
49
+ @api_call
50
+ .request(new_request_builder(HttpMethodEnum::POST,
51
+ '/signal/decision/report',
52
+ Server::DEFAULT)
53
+ .header_param(new_parameter('application/json', key: 'Content-Type'))
54
+ .body_param(new_parameter(body)
55
+ .is_required(true))
56
+ .header_param(new_parameter('application/json', key: 'accept'))
57
+ .body_serializer(proc do |param| param.to_json unless param.nil? end)
58
+ .auth(And.new('PLAID-CLIENT-ID', 'PLAID-SECRET', 'Plaid-Version')))
59
+ .response(new_response_handler
60
+ .deserializer(APIHelper.method(:custom_type_deserializer))
61
+ .deserialize_into(SignalDecisionReportResponse.method(:from_hash))
62
+ .is_api_response(true)
63
+ .local_error('default',
64
+ 'Error response.',
65
+ ErrorErrorException))
66
+ .execute
67
+ end
68
+
69
+ # Call the `/signal/return/report` endpoint to report a returned transaction
70
+ # that was previously sent to the `/signal/evaluate` endpoint. Your feedback
71
+ # will be used by the model to incorporate the latest risk trend in your
72
+ # portfolio.
73
+ # @param [SignalReturnReportRequest] body Required parameter: TODO: type
74
+ # description here
75
+ # @return [ApiResponse] Complete http response with raw body and status code.
76
+ def signal_return_report(body)
77
+ @api_call
78
+ .request(new_request_builder(HttpMethodEnum::POST,
79
+ '/signal/return/report',
80
+ Server::DEFAULT)
81
+ .header_param(new_parameter('application/json', key: 'Content-Type'))
82
+ .body_param(new_parameter(body)
83
+ .is_required(true))
84
+ .header_param(new_parameter('application/json', key: 'accept'))
85
+ .body_serializer(proc do |param| param.to_json unless param.nil? end)
86
+ .auth(And.new('PLAID-CLIENT-ID', 'PLAID-SECRET', 'Plaid-Version')))
87
+ .response(new_response_handler
88
+ .deserializer(APIHelper.method(:custom_type_deserializer))
89
+ .deserialize_into(SignalReturnReportResponse.method(:from_hash))
90
+ .is_api_response(true)
91
+ .local_error('default',
92
+ 'Error response.',
93
+ ErrorErrorException))
94
+ .execute
95
+ end
96
+ end
97
+ end