plaid 13.0.0 → 14.0.0.beta.4

Sign up to get free protection for your applications and to get access to all the features.
Files changed (687) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +81 -1
  3. data/CONTRIBUTING.md +15 -59
  4. data/Dockerfile +12 -0
  5. data/Gemfile.lock +45 -36
  6. data/LICENSE.txt +1 -1
  7. data/Makefile +2 -0
  8. data/PUBLISH.md +6 -7
  9. data/README.md +100 -92
  10. data/Rakefile +8 -79
  11. data/UPGRADING.md +4 -0
  12. data/docs/ACHClass.md +15 -0
  13. data/docs/APR.md +24 -0
  14. data/docs/AccountAssets.md +40 -0
  15. data/docs/AccountAssetsAllOf.md +24 -0
  16. data/docs/AccountBalance.md +26 -0
  17. data/docs/AccountBase.md +32 -0
  18. data/docs/AccountFiltersResponse.md +24 -0
  19. data/docs/AccountIdentity.md +34 -0
  20. data/docs/AccountIdentityAllOf.md +18 -0
  21. data/docs/AccountSubtype.md +15 -0
  22. data/docs/AccountType.md +15 -0
  23. data/docs/AccountsBalanceGetRequest.md +24 -0
  24. data/docs/AccountsBalanceGetRequestOptions.md +18 -0
  25. data/docs/AccountsGetRequest.md +24 -0
  26. data/docs/AccountsGetRequestOptions.md +18 -0
  27. data/docs/AccountsGetResponse.md +22 -0
  28. data/docs/Address.md +20 -0
  29. data/docs/AddressData.md +26 -0
  30. data/docs/Amount.md +20 -0
  31. data/docs/AssetReport.md +28 -0
  32. data/docs/AssetReportAuditCopyCreateRequest.md +24 -0
  33. data/docs/AssetReportAuditCopyCreateResponse.md +20 -0
  34. data/docs/AssetReportAuditCopyGetRequest.md +22 -0
  35. data/docs/AssetReportAuditCopyRemoveRequest.md +22 -0
  36. data/docs/AssetReportAuditCopyRemoveResponse.md +20 -0
  37. data/docs/AssetReportCreateRequest.md +26 -0
  38. data/docs/AssetReportCreateRequestOptions.md +22 -0
  39. data/docs/AssetReportCreateResponse.md +22 -0
  40. data/docs/AssetReportFilterRequest.md +24 -0
  41. data/docs/AssetReportFilterResponse.md +22 -0
  42. data/docs/AssetReportGetRequest.md +24 -0
  43. data/docs/AssetReportGetResponse.md +22 -0
  44. data/docs/AssetReportItem.md +26 -0
  45. data/docs/AssetReportPDFGetRequest.md +22 -0
  46. data/docs/AssetReportRefreshRequest.md +26 -0
  47. data/docs/AssetReportRefreshRequestOptions.md +22 -0
  48. data/docs/AssetReportRefreshResponse.md +22 -0
  49. data/docs/AssetReportRemoveRequest.md +22 -0
  50. data/docs/AssetReportRemoveResponse.md +20 -0
  51. data/docs/AssetReportTransaction.md +62 -0
  52. data/docs/AssetReportTransactionAllOf.md +20 -0
  53. data/docs/AssetReportUser.md +30 -0
  54. data/docs/AssetsErrorWebhook.md +24 -0
  55. data/docs/AssetsProductReadyWebhook.md +22 -0
  56. data/docs/AuthGetNumbers.md +24 -0
  57. data/docs/AuthGetRequest.md +24 -0
  58. data/docs/AuthGetRequestOptions.md +18 -0
  59. data/docs/AuthGetResponse.md +24 -0
  60. data/docs/AutomaticallyVerifiedWebhook.md +24 -0
  61. data/docs/BankTransfer.md +50 -0
  62. data/docs/BankTransferBalance.md +20 -0
  63. data/docs/BankTransferBalanceGetRequest.md +22 -0
  64. data/docs/BankTransferBalanceGetResponse.md +22 -0
  65. data/docs/BankTransferCancelRequest.md +22 -0
  66. data/docs/BankTransferCancelResponse.md +18 -0
  67. data/docs/BankTransferCreateRequest.md +46 -0
  68. data/docs/BankTransferCreateResponse.md +20 -0
  69. data/docs/BankTransferDirection.md +15 -0
  70. data/docs/BankTransferEvent.md +40 -0
  71. data/docs/BankTransferEventListRequest.md +40 -0
  72. data/docs/BankTransferEventListResponse.md +20 -0
  73. data/docs/BankTransferEventSyncRequest.md +24 -0
  74. data/docs/BankTransferEventSyncResponse.md +20 -0
  75. data/docs/BankTransferEventType.md +15 -0
  76. data/docs/BankTransferFailure.md +20 -0
  77. data/docs/BankTransferGetRequest.md +22 -0
  78. data/docs/BankTransferGetResponse.md +20 -0
  79. data/docs/BankTransferListRequest.md +32 -0
  80. data/docs/BankTransferListResponse.md +20 -0
  81. data/docs/BankTransferMigrateAccountRequest.md +26 -0
  82. data/docs/BankTransferMigrateAccountResponse.md +22 -0
  83. data/docs/BankTransferNetwork.md +15 -0
  84. data/docs/BankTransferReceiverDetails.md +18 -0
  85. data/docs/BankTransferStatus.md +15 -0
  86. data/docs/BankTransferType.md +15 -0
  87. data/docs/BankTransferUser.md +22 -0
  88. data/docs/BankTransfersEventsUpdateWebhook.md +20 -0
  89. data/docs/CategoriesGetResponse.md +20 -0
  90. data/docs/Category.md +22 -0
  91. data/docs/Cause.md +20 -0
  92. data/docs/CountryCode.md +15 -0
  93. data/docs/CreditCardLiability.md +34 -0
  94. data/docs/CreditFilter.md +18 -0
  95. data/docs/DefaultUpdateWebhook.md +26 -0
  96. data/docs/DepositSwitchAddressData.md +26 -0
  97. data/docs/DepositSwitchAltCreateRequest.md +24 -0
  98. data/docs/DepositSwitchAltCreateResponse.md +20 -0
  99. data/docs/DepositSwitchCreateRequest.md +24 -0
  100. data/docs/DepositSwitchCreateResponse.md +20 -0
  101. data/docs/DepositSwitchGetRequest.md +22 -0
  102. data/docs/DepositSwitchGetResponse.md +38 -0
  103. data/docs/DepositSwitchTargetAccount.md +24 -0
  104. data/docs/DepositSwitchTargetUser.md +28 -0
  105. data/docs/DepositSwitchTokenCreateRequest.md +22 -0
  106. data/docs/DepositSwitchTokenCreateResponse.md +22 -0
  107. data/docs/DepositoryFilter.md +18 -0
  108. data/docs/Email.md +22 -0
  109. data/docs/Employee.md +22 -0
  110. data/docs/EmployeeIncomeSummaryFieldString.md +20 -0
  111. data/docs/Employer.md +24 -0
  112. data/docs/EmployerIncomeSummaryFieldString.md +20 -0
  113. data/docs/EmployersSearchRequest.md +24 -0
  114. data/docs/EmployersSearchResponse.md +20 -0
  115. data/docs/Error.md +34 -0
  116. data/docs/ExternalPaymentSchedule.md +24 -0
  117. data/docs/ExternalPaymentScheduleGet.md +26 -0
  118. data/docs/HealthIncident.md +24 -0
  119. data/docs/HistoricalBalance.md +24 -0
  120. data/docs/HistoricalUpdateWebhook.md +26 -0
  121. data/docs/Holding.md +34 -0
  122. data/docs/HoldingsDefaultUpdateWebhook.md +28 -0
  123. data/docs/IdentityGetRequest.md +24 -0
  124. data/docs/IdentityGetRequestOptions.md +18 -0
  125. data/docs/IdentityGetResponse.md +22 -0
  126. data/docs/IncidentUpdate.md +22 -0
  127. data/docs/IncomeBreakdown.md +24 -0
  128. data/docs/IncomeSummary.md +30 -0
  129. data/docs/IncomeSummaryFieldNumber.md +20 -0
  130. data/docs/IncomeSummaryFieldString.md +20 -0
  131. data/docs/IncomeVerificationCreateRequest.md +22 -0
  132. data/docs/IncomeVerificationCreateResponse.md +20 -0
  133. data/docs/IncomeVerificationDocumentsDownloadRequest.md +22 -0
  134. data/docs/IncomeVerificationDocumentsDownloadResponse.md +18 -0
  135. data/docs/IncomeVerificationPaystubGetRequest.md +22 -0
  136. data/docs/IncomeVerificationPaystubGetResponse.md +20 -0
  137. data/docs/IncomeVerificationStatusWebhook.md +24 -0
  138. data/docs/IncomeVerificationSummaryGetRequest.md +22 -0
  139. data/docs/IncomeVerificationSummaryGetResponse.md +20 -0
  140. data/docs/IncomeVerificationWebhookStatus.md +18 -0
  141. data/docs/InflowModel.md +26 -0
  142. data/docs/InitialUpdateWebhook.md +26 -0
  143. data/docs/Institution.md +36 -0
  144. data/docs/InstitutionStatus.md +30 -0
  145. data/docs/InstitutionsGetByIdRequest.md +26 -0
  146. data/docs/InstitutionsGetByIdRequestOptions.md +20 -0
  147. data/docs/InstitutionsGetByIdResponse.md +20 -0
  148. data/docs/InstitutionsGetRequest.md +28 -0
  149. data/docs/InstitutionsGetRequestOptions.md +24 -0
  150. data/docs/InstitutionsGetResponse.md +22 -0
  151. data/docs/InstitutionsSearchAccountFilter.md +24 -0
  152. data/docs/InstitutionsSearchRequest.md +28 -0
  153. data/docs/InstitutionsSearchRequestOptions.md +20 -0
  154. data/docs/InstitutionsSearchResponse.md +20 -0
  155. data/docs/InvestmentFilter.md +18 -0
  156. data/docs/InvestmentHoldingsGetRequestOptions.md +18 -0
  157. data/docs/InvestmentTransaction.md +44 -0
  158. data/docs/InvestmentsDefaultUpdateWebhook.md +28 -0
  159. data/docs/InvestmentsHoldingsGetRequest.md +24 -0
  160. data/docs/InvestmentsHoldingsGetResponse.md +26 -0
  161. data/docs/InvestmentsTransactionsGetRequest.md +28 -0
  162. data/docs/InvestmentsTransactionsGetRequestOptions.md +22 -0
  163. data/docs/InvestmentsTransactionsGetResponse.md +28 -0
  164. data/docs/Item.md +32 -0
  165. data/docs/ItemAccessTokenInvalidateRequest.md +22 -0
  166. data/docs/ItemAccessTokenInvalidateResponse.md +20 -0
  167. data/docs/ItemErrorWebhook.md +24 -0
  168. data/docs/ItemGetRequest.md +22 -0
  169. data/docs/ItemGetResponse.md +24 -0
  170. data/docs/ItemImportRequest.md +26 -0
  171. data/docs/ItemImportRequestOptions.md +18 -0
  172. data/docs/ItemImportRequestUserAuth.md +20 -0
  173. data/docs/ItemImportResponse.md +20 -0
  174. data/docs/ItemProductReadyWebhook.md +24 -0
  175. data/docs/ItemPublicTokenCreateRequest.md +22 -0
  176. data/docs/ItemPublicTokenCreateResponse.md +22 -0
  177. data/docs/ItemPublicTokenExchangeRequest.md +22 -0
  178. data/docs/ItemPublicTokenExchangeResponse.md +22 -0
  179. data/docs/ItemRemoveRequest.md +22 -0
  180. data/docs/ItemRemoveResponse.md +18 -0
  181. data/docs/ItemStatus.md +22 -0
  182. data/docs/ItemWebhookUpdateRequest.md +24 -0
  183. data/docs/ItemWebhookUpdateResponse.md +20 -0
  184. data/docs/JWKPublicKey.md +34 -0
  185. data/docs/JWTHeader.md +18 -0
  186. data/docs/LiabilitiesGetRequest.md +24 -0
  187. data/docs/LiabilitiesGetRequestOptions.md +18 -0
  188. data/docs/LiabilitiesGetResponse.md +24 -0
  189. data/docs/LiabilitiesObject.md +22 -0
  190. data/docs/LiabilityOverride.md +66 -0
  191. data/docs/LinkTokenAccountFilters.md +24 -0
  192. data/docs/LinkTokenCreateRequest.md +52 -0
  193. data/docs/LinkTokenCreateRequestAccountSubtypes.md +24 -0
  194. data/docs/LinkTokenCreateRequestAuth.md +18 -0
  195. data/docs/LinkTokenCreateRequestDepositSwitch.md +18 -0
  196. data/docs/LinkTokenCreateRequestIncomeVerification.md +20 -0
  197. data/docs/LinkTokenCreateRequestPaymentInitiation.md +18 -0
  198. data/docs/LinkTokenCreateRequestUser.md +32 -0
  199. data/docs/LinkTokenCreateResponse.md +22 -0
  200. data/docs/LinkTokenGetMetadataResponse.md +30 -0
  201. data/docs/LinkTokenGetRequest.md +22 -0
  202. data/docs/LinkTokenGetResponse.md +26 -0
  203. data/docs/LoanFilter.md +18 -0
  204. data/docs/Location.md +32 -0
  205. data/docs/MFA.md +26 -0
  206. data/docs/Meta.md +22 -0
  207. data/docs/MortgageInterestRate.md +20 -0
  208. data/docs/MortgageLiability.md +56 -0
  209. data/docs/MortgagePropertyAddress.md +26 -0
  210. data/docs/NullableAccessToken.md +15 -0
  211. data/docs/NullableAddress.md +20 -0
  212. data/docs/NullableAddressData.md +26 -0
  213. data/docs/NullableItemStatus.md +22 -0
  214. data/docs/NullableNumbersACH.md +24 -0
  215. data/docs/NullableNumbersBACS.md +22 -0
  216. data/docs/NullableNumbersEFT.md +24 -0
  217. data/docs/NullableNumbersInternational.md +22 -0
  218. data/docs/NullableRecipientBACS.md +20 -0
  219. data/docs/Numbers.md +32 -0
  220. data/docs/NumbersACH.md +24 -0
  221. data/docs/NumbersBACS.md +22 -0
  222. data/docs/NumbersEFT.md +24 -0
  223. data/docs/NumbersInternational.md +22 -0
  224. data/docs/OverrideAccounts.md +38 -0
  225. data/docs/Owner.md +24 -0
  226. data/docs/OwnerOverride.md +24 -0
  227. data/docs/PSLFStatus.md +22 -0
  228. data/docs/PayFrequency.md +20 -0
  229. data/docs/PayPeriodDetails.md +26 -0
  230. data/docs/PaymentAmount.md +20 -0
  231. data/docs/PaymentInitiationAddress.md +24 -0
  232. data/docs/PaymentInitiationPaymentCreateRequest.md +28 -0
  233. data/docs/PaymentInitiationPaymentCreateResponse.md +22 -0
  234. data/docs/PaymentInitiationPaymentGetRequest.md +22 -0
  235. data/docs/PaymentInitiationPaymentGetResponse.md +34 -0
  236. data/docs/PaymentInitiationPaymentListRequest.md +24 -0
  237. data/docs/PaymentInitiationPaymentListResponse.md +22 -0
  238. data/docs/PaymentInitiationPaymentTokenCreateRequest.md +22 -0
  239. data/docs/PaymentInitiationPaymentTokenCreateResponse.md +22 -0
  240. data/docs/PaymentInitiationRecipient.md +26 -0
  241. data/docs/PaymentInitiationRecipientCreateRequest.md +28 -0
  242. data/docs/PaymentInitiationRecipientCreateResponse.md +20 -0
  243. data/docs/PaymentInitiationRecipientGetRequest.md +22 -0
  244. data/docs/PaymentInitiationRecipientGetResponse.md +28 -0
  245. data/docs/PaymentInitiationRecipientListRequest.md +20 -0
  246. data/docs/PaymentInitiationRecipientListResponse.md +20 -0
  247. data/docs/PaymentMeta.md +32 -0
  248. data/docs/PaymentStatusUpdateWebhook.md +38 -0
  249. data/docs/Paystub.md +30 -0
  250. data/docs/PaystubDeduction.md +22 -0
  251. data/docs/PaystubYTDDetails.md +20 -0
  252. data/docs/PendingExpirationWebhook.md +24 -0
  253. data/docs/PhoneNumber.md +22 -0
  254. data/docs/PlaidApi.md +5660 -0
  255. data/docs/ProcessorApexProcessorTokenCreateRequest.md +24 -0
  256. data/docs/ProcessorAuthGetRequest.md +22 -0
  257. data/docs/ProcessorAuthGetResponse.md +22 -0
  258. data/docs/ProcessorBalanceGetRequest.md +22 -0
  259. data/docs/ProcessorBalanceGetResponse.md +20 -0
  260. data/docs/ProcessorIdentityGetRequest.md +22 -0
  261. data/docs/ProcessorIdentityGetResponse.md +20 -0
  262. data/docs/ProcessorNumber.md +24 -0
  263. data/docs/ProcessorStripeBankAccountTokenCreateRequest.md +24 -0
  264. data/docs/ProcessorStripeBankAccountTokenCreateResponse.md +20 -0
  265. data/docs/ProcessorTokenCreateRequest.md +26 -0
  266. data/docs/ProcessorTokenCreateResponse.md +20 -0
  267. data/docs/ProductStatus.md +22 -0
  268. data/docs/ProductStatusBreakdown.md +24 -0
  269. data/docs/Products.md +15 -0
  270. data/docs/ProjectedIncomeSummaryFieldNumber.md +20 -0
  271. data/docs/RecaptchaRequiredError.md +30 -0
  272. data/docs/RecipientBACS.md +20 -0
  273. data/docs/SandboxBankTransferFireWebhookRequest.md +22 -0
  274. data/docs/SandboxBankTransferFireWebhookResponse.md +18 -0
  275. data/docs/SandboxBankTransferSimulateRequest.md +26 -0
  276. data/docs/SandboxBankTransferSimulateResponse.md +18 -0
  277. data/docs/SandboxItemFireWebhookRequest.md +24 -0
  278. data/docs/SandboxItemFireWebhookResponse.md +20 -0
  279. data/docs/SandboxItemResetLoginRequest.md +22 -0
  280. data/docs/SandboxItemResetLoginResponse.md +20 -0
  281. data/docs/SandboxItemSetVerificationStatusRequest.md +26 -0
  282. data/docs/SandboxItemSetVerificationStatusResponse.md +18 -0
  283. data/docs/SandboxProcessorTokenCreateRequest.md +24 -0
  284. data/docs/SandboxProcessorTokenCreateRequestOptions.md +20 -0
  285. data/docs/SandboxProcessorTokenCreateResponse.md +20 -0
  286. data/docs/SandboxPublicTokenCreateRequest.md +26 -0
  287. data/docs/SandboxPublicTokenCreateRequestOptions.md +24 -0
  288. data/docs/SandboxPublicTokenCreateRequestOptionsTransactions.md +20 -0
  289. data/docs/SandboxPublicTokenCreateResponse.md +20 -0
  290. data/docs/Security.md +46 -0
  291. data/docs/ServicerAddressData.md +26 -0
  292. data/docs/StandaloneAccountType.md +26 -0
  293. data/docs/StandaloneCurrencyCodeList.md +20 -0
  294. data/docs/StandaloneInvestmentTransactionSubtype.md +104 -0
  295. data/docs/StandaloneInvestmentTransactionType.md +28 -0
  296. data/docs/StudentLoan.md +66 -0
  297. data/docs/StudentLoanRepaymentModel.md +22 -0
  298. data/docs/StudentLoanStatus.md +20 -0
  299. data/docs/StudentRepaymentPlan.md +20 -0
  300. data/docs/Transaction.md +58 -0
  301. data/docs/TransactionCode.md +15 -0
  302. data/docs/TransactionData.md +26 -0
  303. data/docs/TransactionOverride.md +26 -0
  304. data/docs/TransactionsGetRequest.md +28 -0
  305. data/docs/TransactionsGetRequestOptions.md +22 -0
  306. data/docs/TransactionsGetResponse.md +26 -0
  307. data/docs/TransactionsRefreshRequest.md +22 -0
  308. data/docs/TransactionsRefreshResponse.md +18 -0
  309. data/docs/TransactionsRemovedWebhook.md +26 -0
  310. data/docs/UserCustomPassword.md +28 -0
  311. data/docs/UserPermissionRevokedWebhook.md +24 -0
  312. data/docs/VerificationExpiredWebhook.md +24 -0
  313. data/docs/VerificationStatus.md +15 -0
  314. data/docs/Warning.md +22 -0
  315. data/docs/WebhookUpdateAcknowledgedWebhook.md +26 -0
  316. data/docs/WebhookVerificationKeyGetRequest.md +22 -0
  317. data/docs/WebhookVerificationKeyGetResponse.md +20 -0
  318. data/docs/YTDGrossIncomeSummaryFieldNumber.md +20 -0
  319. data/docs/YTDNetIncomeSummaryFieldNumber.md +20 -0
  320. data/lib/plaid.rb +340 -61
  321. data/lib/plaid/api/plaid_api.rb +4483 -0
  322. data/lib/plaid/api_client.rb +383 -0
  323. data/lib/plaid/api_error.rb +57 -0
  324. data/lib/plaid/configuration.rb +297 -0
  325. data/lib/plaid/models/account_assets.rb +406 -0
  326. data/lib/plaid/models/account_assets_all_of.rb +263 -0
  327. data/lib/plaid/models/account_balance.rb +269 -0
  328. data/lib/plaid/models/account_base.rb +345 -0
  329. data/lib/plaid/models/account_filters_response.rb +246 -0
  330. data/lib/plaid/models/account_identity.rb +369 -0
  331. data/lib/plaid/models/account_identity_all_of.rb +226 -0
  332. data/lib/plaid/models/account_subtype.rb +101 -0
  333. data/lib/plaid/models/account_type.rb +41 -0
  334. data/lib/plaid/models/accounts_balance_get_request.rb +254 -0
  335. data/lib/plaid/models/accounts_balance_get_request_options.rb +222 -0
  336. data/lib/plaid/models/accounts_get_request.rb +254 -0
  337. data/lib/plaid/models/accounts_get_request_options.rb +222 -0
  338. data/lib/plaid/models/accounts_get_response.rb +256 -0
  339. data/lib/plaid/models/ach_class.rb +50 -0
  340. data/lib/plaid/models/address.rb +235 -0
  341. data/lib/plaid/models/address_data.rb +277 -0
  342. data/lib/plaid/models/amount.rb +274 -0
  343. data/lib/plaid/models/apr.rb +296 -0
  344. data/lib/plaid/models/asset_report.rb +301 -0
  345. data/lib/plaid/models/asset_report_audit_copy_create_request.rb +260 -0
  346. data/lib/plaid/models/asset_report_audit_copy_create_response.rb +240 -0
  347. data/lib/plaid/models/asset_report_audit_copy_get_request.rb +245 -0
  348. data/lib/plaid/models/asset_report_audit_copy_remove_request.rb +245 -0
  349. data/lib/plaid/models/asset_report_audit_copy_remove_response.rb +240 -0
  350. data/lib/plaid/models/asset_report_create_request.rb +323 -0
  351. data/lib/plaid/models/asset_report_create_request_options.rb +239 -0
  352. data/lib/plaid/models/asset_report_create_response.rb +255 -0
  353. data/lib/plaid/models/asset_report_filter_request.rb +262 -0
  354. data/lib/plaid/models/asset_report_filter_response.rb +255 -0
  355. data/lib/plaid/models/asset_report_get_request.rb +255 -0
  356. data/lib/plaid/models/asset_report_get_response.rb +256 -0
  357. data/lib/plaid/models/asset_report_item.rb +287 -0
  358. data/lib/plaid/models/asset_report_pdf_get_request.rb +245 -0
  359. data/lib/plaid/models/asset_report_refresh_request.rb +290 -0
  360. data/lib/plaid/models/asset_report_refresh_request_options.rb +239 -0
  361. data/lib/plaid/models/asset_report_refresh_response.rb +255 -0
  362. data/lib/plaid/models/asset_report_remove_request.rb +245 -0
  363. data/lib/plaid/models/asset_report_remove_response.rb +240 -0
  364. data/lib/plaid/models/asset_report_transaction.rb +533 -0
  365. data/lib/plaid/models/asset_report_transaction_all_of.rb +235 -0
  366. data/lib/plaid/models/asset_report_user.rb +287 -0
  367. data/lib/plaid/models/assets_error_webhook.rb +265 -0
  368. data/lib/plaid/models/assets_product_ready_webhook.rb +255 -0
  369. data/lib/plaid/models/auth_get_numbers.rb +258 -0
  370. data/lib/plaid/models/auth_get_request.rb +254 -0
  371. data/lib/plaid/models/auth_get_request_options.rb +222 -0
  372. data/lib/plaid/models/auth_get_response.rb +270 -0
  373. data/lib/plaid/models/automatically_verified_webhook.rb +270 -0
  374. data/lib/plaid/models/bank_transfer.rb +453 -0
  375. data/lib/plaid/models/bank_transfer_balance.rb +239 -0
  376. data/lib/plaid/models/bank_transfer_balance_get_request.rb +241 -0
  377. data/lib/plaid/models/bank_transfer_balance_get_response.rb +250 -0
  378. data/lib/plaid/models/bank_transfer_cancel_request.rb +245 -0
  379. data/lib/plaid/models/bank_transfer_cancel_response.rb +225 -0
  380. data/lib/plaid/models/bank_transfer_create_request.rb +474 -0
  381. data/lib/plaid/models/bank_transfer_create_response.rb +239 -0
  382. data/lib/plaid/models/bank_transfer_direction.rb +37 -0
  383. data/lib/plaid/models/bank_transfer_event.rb +390 -0
  384. data/lib/plaid/models/bank_transfer_event_list_request.rb +422 -0
  385. data/lib/plaid/models/bank_transfer_event_list_response.rb +241 -0
  386. data/lib/plaid/models/bank_transfer_event_sync_request.rb +305 -0
  387. data/lib/plaid/models/bank_transfer_event_sync_response.rb +241 -0
  388. data/lib/plaid/models/bank_transfer_event_type.rb +42 -0
  389. data/lib/plaid/models/bank_transfer_failure.rb +231 -0
  390. data/lib/plaid/models/bank_transfer_get_request.rb +245 -0
  391. data/lib/plaid/models/bank_transfer_get_response.rb +239 -0
  392. data/lib/plaid/models/bank_transfer_list_request.rb +340 -0
  393. data/lib/plaid/models/bank_transfer_list_response.rb +241 -0
  394. data/lib/plaid/models/bank_transfer_migrate_account_request.rb +275 -0
  395. data/lib/plaid/models/bank_transfer_migrate_account_response.rb +255 -0
  396. data/lib/plaid/models/bank_transfer_network.rb +38 -0
  397. data/lib/plaid/models/bank_transfer_receiver_details.rb +255 -0
  398. data/lib/plaid/models/bank_transfer_status.rb +40 -0
  399. data/lib/plaid/models/bank_transfer_type.rb +37 -0
  400. data/lib/plaid/models/bank_transfer_user.rb +246 -0
  401. data/lib/plaid/models/bank_transfers_events_update_webhook.rb +240 -0
  402. data/lib/plaid/models/categories_get_response.rb +242 -0
  403. data/lib/plaid/models/category.rb +257 -0
  404. data/lib/plaid/models/cause.rb +235 -0
  405. data/lib/plaid/models/country_code.rb +42 -0
  406. data/lib/plaid/models/credit_card_liability.rb +339 -0
  407. data/lib/plaid/models/credit_filter.rb +227 -0
  408. data/lib/plaid/models/default_update_webhook.rb +280 -0
  409. data/lib/plaid/models/deposit_switch_address_data.rb +285 -0
  410. data/lib/plaid/models/deposit_switch_alt_create_request.rb +258 -0
  411. data/lib/plaid/models/deposit_switch_alt_create_response.rb +240 -0
  412. data/lib/plaid/models/deposit_switch_create_request.rb +260 -0
  413. data/lib/plaid/models/deposit_switch_create_response.rb +240 -0
  414. data/lib/plaid/models/deposit_switch_get_request.rb +245 -0
  415. data/lib/plaid/models/deposit_switch_get_response.rb +381 -0
  416. data/lib/plaid/models/deposit_switch_target_account.rb +303 -0
  417. data/lib/plaid/models/deposit_switch_target_user.rb +288 -0
  418. data/lib/plaid/models/deposit_switch_token_create_request.rb +245 -0
  419. data/lib/plaid/models/deposit_switch_token_create_response.rb +255 -0
  420. data/lib/plaid/models/depository_filter.rb +227 -0
  421. data/lib/plaid/models/email.rb +289 -0
  422. data/lib/plaid/models/employee.rb +242 -0
  423. data/lib/plaid/models/employee_income_summary_field_string.rb +245 -0
  424. data/lib/plaid/models/employer.rb +261 -0
  425. data/lib/plaid/models/employer_income_summary_field_string.rb +245 -0
  426. data/lib/plaid/models/employers_search_request.rb +262 -0
  427. data/lib/plaid/models/employers_search_response.rb +242 -0
  428. data/lib/plaid/models/error.rb +360 -0
  429. data/lib/plaid/models/external_payment_schedule.rb +265 -0
  430. data/lib/plaid/models/external_payment_schedule_get.rb +283 -0
  431. data/lib/plaid/models/health_incident.rb +253 -0
  432. data/lib/plaid/models/historical_balance.rb +262 -0
  433. data/lib/plaid/models/historical_update_webhook.rb +280 -0
  434. data/lib/plaid/models/holding.rb +329 -0
  435. data/lib/plaid/models/holdings_default_update_webhook.rb +295 -0
  436. data/lib/plaid/models/identity_get_request.rb +254 -0
  437. data/lib/plaid/models/identity_get_request_options.rb +222 -0
  438. data/lib/plaid/models/identity_get_response.rb +256 -0
  439. data/lib/plaid/models/incident_update.rb +273 -0
  440. data/lib/plaid/models/income_breakdown.rb +253 -0
  441. data/lib/plaid/models/income_summary.rb +275 -0
  442. data/lib/plaid/models/income_summary_field_number.rb +238 -0
  443. data/lib/plaid/models/income_summary_field_string.rb +238 -0
  444. data/lib/plaid/models/income_verification_create_request.rb +245 -0
  445. data/lib/plaid/models/income_verification_create_response.rb +240 -0
  446. data/lib/plaid/models/income_verification_documents_download_request.rb +245 -0
  447. data/lib/plaid/models/income_verification_documents_download_response.rb +224 -0
  448. data/lib/plaid/models/income_verification_paystub_get_request.rb +245 -0
  449. data/lib/plaid/models/income_verification_paystub_get_response.rb +229 -0
  450. data/lib/plaid/models/income_verification_status_webhook.rb +270 -0
  451. data/lib/plaid/models/income_verification_summary_get_request.rb +245 -0
  452. data/lib/plaid/models/income_verification_summary_get_response.rb +242 -0
  453. data/lib/plaid/models/income_verification_webhook_status.rb +223 -0
  454. data/lib/plaid/models/inflow_model.rb +285 -0
  455. data/lib/plaid/models/initial_update_webhook.rb +281 -0
  456. data/lib/plaid/models/institution.rb +344 -0
  457. data/lib/plaid/models/institution_status.rb +307 -0
  458. data/lib/plaid/models/institutions_get_by_id_request.rb +271 -0
  459. data/lib/plaid/models/institutions_get_by_id_request_options.rb +234 -0
  460. data/lib/plaid/models/institutions_get_by_id_response.rb +239 -0
  461. data/lib/plaid/models/institutions_get_request.rb +328 -0
  462. data/lib/plaid/models/institutions_get_request_options.rb +254 -0
  463. data/lib/plaid/models/institutions_get_response.rb +257 -0
  464. data/lib/plaid/models/institutions_search_account_filter.rb +253 -0
  465. data/lib/plaid/models/institutions_search_request.rb +309 -0
  466. data/lib/plaid/models/institutions_search_request_options.rb +230 -0
  467. data/lib/plaid/models/institutions_search_response.rb +242 -0
  468. data/lib/plaid/models/investment_filter.rb +227 -0
  469. data/lib/plaid/models/investment_holdings_get_request_options.rb +222 -0
  470. data/lib/plaid/models/investment_transaction.rb +446 -0
  471. data/lib/plaid/models/investments_default_update_webhook.rb +295 -0
  472. data/lib/plaid/models/investments_holdings_get_request.rb +254 -0
  473. data/lib/plaid/models/investments_holdings_get_response.rb +290 -0
  474. data/lib/plaid/models/investments_transactions_get_request.rb +284 -0
  475. data/lib/plaid/models/investments_transactions_get_request_options.rb +289 -0
  476. data/lib/plaid/models/investments_transactions_get_response.rb +305 -0
  477. data/lib/plaid/models/item.rb +351 -0
  478. data/lib/plaid/models/item_access_token_invalidate_request.rb +245 -0
  479. data/lib/plaid/models/item_access_token_invalidate_response.rb +240 -0
  480. data/lib/plaid/models/item_error_webhook.rb +265 -0
  481. data/lib/plaid/models/item_get_request.rb +245 -0
  482. data/lib/plaid/models/item_get_response.rb +259 -0
  483. data/lib/plaid/models/item_import_request.rb +291 -0
  484. data/lib/plaid/models/item_import_request_options.rb +220 -0
  485. data/lib/plaid/models/item_import_request_user_auth.rb +240 -0
  486. data/lib/plaid/models/item_import_response.rb +240 -0
  487. data/lib/plaid/models/item_product_ready_webhook.rb +265 -0
  488. data/lib/plaid/models/item_public_token_create_request.rb +245 -0
  489. data/lib/plaid/models/item_public_token_create_response.rb +249 -0
  490. data/lib/plaid/models/item_public_token_exchange_request.rb +245 -0
  491. data/lib/plaid/models/item_public_token_exchange_response.rb +255 -0
  492. data/lib/plaid/models/item_remove_request.rb +245 -0
  493. data/lib/plaid/models/item_remove_response.rb +225 -0
  494. data/lib/plaid/models/item_status.rb +249 -0
  495. data/lib/plaid/models/item_webhook_update_request.rb +260 -0
  496. data/lib/plaid/models/item_webhook_update_response.rb +239 -0
  497. data/lib/plaid/models/jwk_public_key.rb +299 -0
  498. data/lib/plaid/models/jwt_header.rb +224 -0
  499. data/lib/plaid/models/liabilities_get_request.rb +254 -0
  500. data/lib/plaid/models/liabilities_get_request_options.rb +222 -0
  501. data/lib/plaid/models/liabilities_get_response.rb +270 -0
  502. data/lib/plaid/models/liabilities_object.rb +249 -0
  503. data/lib/plaid/models/liability_override.rb +581 -0
  504. data/lib/plaid/models/link_token_account_filters.rb +246 -0
  505. data/lib/plaid/models/link_token_create_request.rb +429 -0
  506. data/lib/plaid/models/link_token_create_request_account_subtypes.rb +258 -0
  507. data/lib/plaid/models/link_token_create_request_auth.rb +259 -0
  508. data/lib/plaid/models/link_token_create_request_deposit_switch.rb +225 -0
  509. data/lib/plaid/models/link_token_create_request_income_verification.rb +236 -0
  510. data/lib/plaid/models/link_token_create_request_payment_initiation.rb +225 -0
  511. data/lib/plaid/models/link_token_create_request_user.rb +295 -0
  512. data/lib/plaid/models/link_token_create_response.rb +255 -0
  513. data/lib/plaid/models/link_token_get_metadata_response.rb +287 -0
  514. data/lib/plaid/models/link_token_get_request.rb +245 -0
  515. data/lib/plaid/models/link_token_get_response.rb +266 -0
  516. data/lib/plaid/models/loan_filter.rb +227 -0
  517. data/lib/plaid/models/location.rb +298 -0
  518. data/lib/plaid/models/meta.rb +255 -0
  519. data/lib/plaid/models/mfa.rb +285 -0
  520. data/lib/plaid/models/mortgage_interest_rate.rb +232 -0
  521. data/lib/plaid/models/mortgage_liability.rb +430 -0
  522. data/lib/plaid/models/mortgage_property_address.rb +265 -0
  523. data/lib/plaid/models/nullable_access_token.rb +209 -0
  524. data/lib/plaid/models/nullable_address.rb +241 -0
  525. data/lib/plaid/models/nullable_address_data.rb +283 -0
  526. data/lib/plaid/models/nullable_item_status.rb +255 -0
  527. data/lib/plaid/models/nullable_numbers_ach.rb +272 -0
  528. data/lib/plaid/models/nullable_numbers_bacs.rb +261 -0
  529. data/lib/plaid/models/nullable_numbers_eft.rb +276 -0
  530. data/lib/plaid/models/nullable_numbers_international.rb +261 -0
  531. data/lib/plaid/models/nullable_recipient_bacs.rb +236 -0
  532. data/lib/plaid/models/numbers.rb +330 -0
  533. data/lib/plaid/models/numbers_ach.rb +266 -0
  534. data/lib/plaid/models/numbers_bacs.rb +255 -0
  535. data/lib/plaid/models/numbers_eft.rb +270 -0
  536. data/lib/plaid/models/numbers_international.rb +255 -0
  537. data/lib/plaid/models/override_accounts.rb +366 -0
  538. data/lib/plaid/models/owner.rb +278 -0
  539. data/lib/plaid/models/owner_override.rb +278 -0
  540. data/lib/plaid/models/pay_frequency.rb +272 -0
  541. data/lib/plaid/models/pay_period_details.rb +265 -0
  542. data/lib/plaid/models/payment_amount.rb +240 -0
  543. data/lib/plaid/models/payment_initiation_address.rb +269 -0
  544. data/lib/plaid/models/payment_initiation_payment_create_request.rb +284 -0
  545. data/lib/plaid/models/payment_initiation_payment_create_response.rb +255 -0
  546. data/lib/plaid/models/payment_initiation_payment_get_request.rb +245 -0
  547. data/lib/plaid/models/payment_initiation_payment_get_response.rb +364 -0
  548. data/lib/plaid/models/payment_initiation_payment_list_request.rb +269 -0
  549. data/lib/plaid/models/payment_initiation_payment_list_response.rb +257 -0
  550. data/lib/plaid/models/payment_initiation_payment_token_create_request.rb +245 -0
  551. data/lib/plaid/models/payment_initiation_payment_token_create_response.rb +255 -0
  552. data/lib/plaid/models/payment_initiation_recipient.rb +273 -0
  553. data/lib/plaid/models/payment_initiation_recipient_create_request.rb +275 -0
  554. data/lib/plaid/models/payment_initiation_recipient_create_response.rb +240 -0
  555. data/lib/plaid/models/payment_initiation_recipient_get_request.rb +245 -0
  556. data/lib/plaid/models/payment_initiation_recipient_get_response.rb +286 -0
  557. data/lib/plaid/models/payment_initiation_recipient_list_request.rb +230 -0
  558. data/lib/plaid/models/payment_initiation_recipient_list_response.rb +242 -0
  559. data/lib/plaid/models/payment_meta.rb +298 -0
  560. data/lib/plaid/models/payment_status_update_webhook.rb +400 -0
  561. data/lib/plaid/models/paystub.rb +306 -0
  562. data/lib/plaid/models/paystub_deduction.rb +242 -0
  563. data/lib/plaid/models/paystub_ytd_details.rb +239 -0
  564. data/lib/plaid/models/pending_expiration_webhook.rb +270 -0
  565. data/lib/plaid/models/phone_number.rb +281 -0
  566. data/lib/plaid/models/processor_apex_processor_token_create_request.rb +260 -0
  567. data/lib/plaid/models/processor_auth_get_request.rb +245 -0
  568. data/lib/plaid/models/processor_auth_get_response.rb +253 -0
  569. data/lib/plaid/models/processor_balance_get_request.rb +245 -0
  570. data/lib/plaid/models/processor_balance_get_response.rb +239 -0
  571. data/lib/plaid/models/processor_identity_get_request.rb +245 -0
  572. data/lib/plaid/models/processor_identity_get_response.rb +239 -0
  573. data/lib/plaid/models/processor_number.rb +250 -0
  574. data/lib/plaid/models/processor_stripe_bank_account_token_create_request.rb +260 -0
  575. data/lib/plaid/models/processor_stripe_bank_account_token_create_response.rb +240 -0
  576. data/lib/plaid/models/processor_token_create_request.rb +275 -0
  577. data/lib/plaid/models/processor_token_create_response.rb +240 -0
  578. data/lib/plaid/models/product_status.rb +288 -0
  579. data/lib/plaid/models/product_status_breakdown.rb +300 -0
  580. data/lib/plaid/models/products.rb +46 -0
  581. data/lib/plaid/models/projected_income_summary_field_number.rb +245 -0
  582. data/lib/plaid/models/pslf_status.rb +243 -0
  583. data/lib/plaid/models/recaptcha_required_error.rb +314 -0
  584. data/lib/plaid/models/recipient_bacs.rb +230 -0
  585. data/lib/plaid/models/sandbox_bank_transfer_fire_webhook_request.rb +245 -0
  586. data/lib/plaid/models/sandbox_bank_transfer_fire_webhook_response.rb +225 -0
  587. data/lib/plaid/models/sandbox_bank_transfer_simulate_request.rb +270 -0
  588. data/lib/plaid/models/sandbox_bank_transfer_simulate_response.rb +225 -0
  589. data/lib/plaid/models/sandbox_item_fire_webhook_request.rb +289 -0
  590. data/lib/plaid/models/sandbox_item_fire_webhook_response.rb +240 -0
  591. data/lib/plaid/models/sandbox_item_reset_login_request.rb +245 -0
  592. data/lib/plaid/models/sandbox_item_reset_login_response.rb +240 -0
  593. data/lib/plaid/models/sandbox_item_set_verification_status_request.rb +309 -0
  594. data/lib/plaid/models/sandbox_item_set_verification_status_response.rb +225 -0
  595. data/lib/plaid/models/sandbox_processor_token_create_request.rb +253 -0
  596. data/lib/plaid/models/sandbox_processor_token_create_request_options.rb +236 -0
  597. data/lib/plaid/models/sandbox_processor_token_create_response.rb +239 -0
  598. data/lib/plaid/models/sandbox_public_token_create_request.rb +292 -0
  599. data/lib/plaid/models/sandbox_public_token_create_request_options.rb +255 -0
  600. data/lib/plaid/models/sandbox_public_token_create_request_options_transactions.rb +230 -0
  601. data/lib/plaid/models/sandbox_public_token_create_response.rb +240 -0
  602. data/lib/plaid/models/security.rb +382 -0
  603. data/lib/plaid/models/servicer_address_data.rb +265 -0
  604. data/lib/plaid/models/standalone_account_type.rb +285 -0
  605. data/lib/plaid/models/standalone_currency_code_list.rb +240 -0
  606. data/lib/plaid/models/standalone_investment_transaction_subtype.rb +650 -0
  607. data/lib/plaid/models/standalone_investment_transaction_type.rb +300 -0
  608. data/lib/plaid/models/student_loan.rb +483 -0
  609. data/lib/plaid/models/student_loan_repayment_model.rb +255 -0
  610. data/lib/plaid/models/student_loan_status.rb +266 -0
  611. data/lib/plaid/models/student_repayment_plan.rb +266 -0
  612. data/lib/plaid/models/transaction.rb +500 -0
  613. data/lib/plaid/models/transaction_code.rb +48 -0
  614. data/lib/plaid/models/transaction_data.rb +285 -0
  615. data/lib/plaid/models/transaction_override.rb +280 -0
  616. data/lib/plaid/models/transactions_get_request.rb +284 -0
  617. data/lib/plaid/models/transactions_get_request_options.rb +289 -0
  618. data/lib/plaid/models/transactions_get_response.rb +288 -0
  619. data/lib/plaid/models/transactions_refresh_request.rb +245 -0
  620. data/lib/plaid/models/transactions_refresh_response.rb +225 -0
  621. data/lib/plaid/models/transactions_removed_webhook.rb +282 -0
  622. data/lib/plaid/models/user_custom_password.rb +297 -0
  623. data/lib/plaid/models/user_permission_revoked_webhook.rb +265 -0
  624. data/lib/plaid/models/verification_expired_webhook.rb +270 -0
  625. data/lib/plaid/models/verification_status.rb +40 -0
  626. data/lib/plaid/models/warning.rb +254 -0
  627. data/lib/plaid/models/webhook_update_acknowledged_webhook.rb +280 -0
  628. data/lib/plaid/models/webhook_verification_key_get_request.rb +245 -0
  629. data/lib/plaid/models/webhook_verification_key_get_response.rb +239 -0
  630. data/lib/plaid/models/ytd_gross_income_summary_field_number.rb +245 -0
  631. data/lib/plaid/models/ytd_net_income_summary_field_number.rb +245 -0
  632. data/lib/plaid/version.rb +13 -2
  633. data/pkg/plaid-14.0.0.beta.4.gem +0 -0
  634. data/plaid.gemspec +44 -49
  635. data/templates/ruby/api_client.mustache +266 -0
  636. data/templates/ruby/api_client_faraday_partial.mustache +120 -0
  637. data/templates/ruby/configuration.mustache +353 -0
  638. data/templates/ruby/gemspec.mustache +41 -0
  639. data/templates/ruby/partial_model_generic.mustache +362 -0
  640. data/test/test_accounts.rb +103 -0
  641. data/test/test_asset_report.rb +147 -0
  642. data/test/test_auth.rb +61 -0
  643. data/test/test_bank_transfers.rb +220 -0
  644. data/test/test_categories.rb +10 -0
  645. data/test/test_configuration.rb +26 -0
  646. data/test/test_deposit_switch.rb +73 -0
  647. data/test/test_helper.rb +109 -0
  648. data/test/test_identity.rb +38 -0
  649. data/test/test_institutions.rb +159 -0
  650. data/test/test_investments.rb +208 -0
  651. data/test/test_item.rb +285 -0
  652. data/test/test_liabilities.rb +45 -0
  653. data/test/test_link_token.rb +97 -0
  654. data/test/test_payment_initiation.rb +95 -0
  655. data/test/test_processor.rb +67 -0
  656. data/test/test_transactions.rb +168 -0
  657. data/test/test_webhooks.rb +22 -0
  658. metadata +683 -98
  659. data/.circleci/config.yml +0 -21
  660. data/.env.sample +0 -3
  661. data/.github/workflows/add_to_project.yml +0 -21
  662. data/.rubocop.yml +0 -18
  663. data/bin/console +0 -14
  664. data/bin/setup +0 -8
  665. data/lib/plaid/client.rb +0 -190
  666. data/lib/plaid/errors.rb +0 -89
  667. data/lib/plaid/middleware.rb +0 -31
  668. data/lib/plaid/models.rb +0 -2144
  669. data/lib/plaid/products/accounts.rb +0 -63
  670. data/lib/plaid/products/asset_report.rb +0 -199
  671. data/lib/plaid/products/auth.rb +0 -42
  672. data/lib/plaid/products/base_product.rb +0 -64
  673. data/lib/plaid/products/categories.rb +0 -21
  674. data/lib/plaid/products/credit_details.rb +0 -40
  675. data/lib/plaid/products/deposit_switch.rb +0 -99
  676. data/lib/plaid/products/identity.rb +0 -31
  677. data/lib/plaid/products/income.rb +0 -31
  678. data/lib/plaid/products/institutions.rb +0 -91
  679. data/lib/plaid/products/investments.rb +0 -127
  680. data/lib/plaid/products/item.rb +0 -209
  681. data/lib/plaid/products/liabilities.rb +0 -39
  682. data/lib/plaid/products/link_token.rb +0 -74
  683. data/lib/plaid/products/payment_initiation.rb +0 -237
  684. data/lib/plaid/products/processor.rb +0 -190
  685. data/lib/plaid/products/sandbox.rb +0 -148
  686. data/lib/plaid/products/transactions.rb +0 -81
  687. data/lib/plaid/products/webhooks.rb +0 -23
@@ -0,0 +1,253 @@
1
+ =begin
2
+ #The Plaid API
3
+
4
+ #The Plaid REST API. Please see https://plaid.com/docs/api for more details.
5
+
6
+ The version of the OpenAPI document: 2020-09-14_1.11.0
7
+
8
+ Generated by: https://openapi-generator.tech
9
+ OpenAPI Generator version: 5.1.0
10
+
11
+ =end
12
+
13
+ require 'date'
14
+ require 'time'
15
+
16
+ module Plaid
17
+ class HealthIncident
18
+ # The start date of the incident, in ISO 8601 format, e.g. `\"2020-10-30T15:26:48Z\"`.
19
+ attr_accessor :start_date
20
+
21
+ # The end date of the incident, in ISO 8601 format, e.g. `\"2020-10-30T15:26:48Z\"`.
22
+ attr_accessor :end_date
23
+
24
+ # The title of the incident
25
+ attr_accessor :title
26
+
27
+ # Updates on the health incident.
28
+ attr_accessor :incident_updates
29
+
30
+ # Attribute mapping from ruby-style variable name to JSON key.
31
+ def self.attribute_map
32
+ {
33
+ :'start_date' => :'start_date',
34
+ :'end_date' => :'end_date',
35
+ :'title' => :'title',
36
+ :'incident_updates' => :'incident_updates'
37
+ }
38
+ end
39
+
40
+ # Returns all the JSON keys this model knows about
41
+ def self.acceptable_attributes
42
+ attribute_map.values
43
+ end
44
+
45
+ # Attribute type mapping.
46
+ def self.openapi_types
47
+ {
48
+ :'start_date' => :'String',
49
+ :'end_date' => :'String',
50
+ :'title' => :'String',
51
+ :'incident_updates' => :'Array<IncidentUpdate>'
52
+ }
53
+ end
54
+
55
+ # List of attributes with nullable: true
56
+ def self.openapi_nullable
57
+ Set.new([
58
+ :'start_date',
59
+ :'end_date',
60
+ ])
61
+ end
62
+
63
+ # Initializes the object
64
+ # @param [Hash] attributes Model attributes in the form of hash
65
+ def initialize(attributes = {})
66
+ if (!attributes.is_a?(Hash))
67
+ fail ArgumentError, "The input argument (attributes) must be a hash in `Plaid::HealthIncident` initialize method"
68
+ end
69
+
70
+ # check to see if the attribute exists and convert string to symbol for hash key
71
+ attributes = attributes.each_with_object({}) { |(k, v), h|
72
+ if (!self.class.attribute_map.key?(k.to_sym))
73
+ fail ArgumentError, "`#{k}` is not a valid attribute in `Plaid::HealthIncident`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
74
+ end
75
+ h[k.to_sym] = v
76
+ }
77
+
78
+ if attributes.key?(:'start_date')
79
+ self.start_date = attributes[:'start_date']
80
+ end
81
+
82
+ if attributes.key?(:'end_date')
83
+ self.end_date = attributes[:'end_date']
84
+ end
85
+
86
+ if attributes.key?(:'title')
87
+ self.title = attributes[:'title']
88
+ end
89
+
90
+ if attributes.key?(:'incident_updates')
91
+ if (value = attributes[:'incident_updates']).is_a?(Array)
92
+ self.incident_updates = value
93
+ end
94
+ end
95
+ end
96
+
97
+ # Show invalid properties with the reasons. Usually used together with valid?
98
+ # @return Array for valid properties with the reasons
99
+ def list_invalid_properties
100
+ invalid_properties = Array.new
101
+ invalid_properties
102
+ end
103
+
104
+ # Check to see if the all the properties in the model are valid
105
+ # @return true if the model is valid
106
+ def valid?
107
+ true
108
+ end
109
+
110
+ # Checks equality by comparing each attribute.
111
+ # @param [Object] Object to be compared
112
+ def ==(o)
113
+ return true if self.equal?(o)
114
+ self.class == o.class &&
115
+ start_date == o.start_date &&
116
+ end_date == o.end_date &&
117
+ title == o.title &&
118
+ incident_updates == o.incident_updates
119
+ end
120
+
121
+ # @see the `==` method
122
+ # @param [Object] Object to be compared
123
+ def eql?(o)
124
+ self == o
125
+ end
126
+
127
+ # Calculates hash code according to all attributes.
128
+ # @return [Integer] Hash code
129
+ def hash
130
+ [start_date, end_date, title, incident_updates].hash
131
+ end
132
+
133
+ # Builds the object from hash
134
+ # @param [Hash] attributes Model attributes in the form of hash
135
+ # @return [Object] Returns the model itself
136
+ def self.build_from_hash(attributes)
137
+ new.build_from_hash(attributes)
138
+ end
139
+
140
+ # Builds the object from hash
141
+ # @param [Hash] attributes Model attributes in the form of hash
142
+ # @return [Object] Returns the model itself
143
+ def build_from_hash(attributes)
144
+ return nil unless attributes.is_a?(Hash)
145
+ self.class.openapi_types.each_pair do |key, type|
146
+ if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
147
+ self.send("#{key}=", nil)
148
+ elsif type =~ /\AArray<(.*)>/i
149
+ # check to ensure the input is an array given that the attribute
150
+ # is documented as an array but the input is not
151
+ if attributes[self.class.attribute_map[key]].is_a?(Array)
152
+ self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
153
+ end
154
+ elsif !attributes[self.class.attribute_map[key]].nil?
155
+ self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
156
+ end
157
+ end
158
+
159
+ self
160
+ end
161
+
162
+ # Deserializes the data based on type
163
+ # @param string type Data type
164
+ # @param string value Value to be deserialized
165
+ # @return [Object] Deserialized data
166
+ def _deserialize(type, value)
167
+ case type.to_sym
168
+ when :Time
169
+ Time.parse(value)
170
+ when :Date
171
+ Date.parse(value)
172
+ when :String
173
+ value.to_s
174
+ when :Integer
175
+ value.to_i
176
+ when :Float
177
+ value.to_f
178
+ when :Boolean
179
+ if value.to_s =~ /\A(true|t|yes|y|1)\z/i
180
+ true
181
+ else
182
+ false
183
+ end
184
+ when :Object
185
+ # generic object (usually a Hash), return directly
186
+ value
187
+ when /\AArray<(?<inner_type>.+)>\z/
188
+ inner_type = Regexp.last_match[:inner_type]
189
+ value.map { |v| _deserialize(inner_type, v) }
190
+ when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
191
+ k_type = Regexp.last_match[:k_type]
192
+ v_type = Regexp.last_match[:v_type]
193
+ {}.tap do |hash|
194
+ value.each do |k, v|
195
+ hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
196
+ end
197
+ end
198
+ else # model
199
+ # models (e.g. Pet) or oneOf
200
+ klass = Plaid.const_get(type)
201
+ klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
202
+ end
203
+ end
204
+
205
+ # Returns the string representation of the object
206
+ # @return [String] String presentation of the object
207
+ def to_s
208
+ to_hash.to_s
209
+ end
210
+
211
+ # to_body is an alias to to_hash (backward compatibility)
212
+ # @return [Hash] Returns the object in the form of hash
213
+ def to_body
214
+ to_hash
215
+ end
216
+
217
+ # Returns the object in the form of hash
218
+ # @return [Hash] Returns the object in the form of hash
219
+ def to_hash
220
+ hash = {}
221
+ self.class.attribute_map.each_pair do |attr, param|
222
+ value = self.send(attr)
223
+ if value.nil?
224
+ is_nullable = self.class.openapi_nullable.include?(attr)
225
+ next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
226
+ end
227
+
228
+ hash[param] = _to_hash(value)
229
+ end
230
+ hash
231
+ end
232
+
233
+ # Outputs non-array value in the form of hash
234
+ # For object, use to_hash. Otherwise, just return the value
235
+ # @param [Object] value Any valid value
236
+ # @return [Hash] Returns the value in the form of hash
237
+ def _to_hash(value)
238
+ if value.is_a?(Array)
239
+ value.compact.map { |v| _to_hash(v) }
240
+ elsif value.is_a?(Hash)
241
+ {}.tap do |hash|
242
+ value.each { |k, v| hash[k] = _to_hash(v) }
243
+ end
244
+ elsif value.respond_to? :to_hash
245
+ value.to_hash
246
+ else
247
+ value
248
+ end
249
+ end
250
+
251
+ end
252
+
253
+ end
@@ -0,0 +1,262 @@
1
+ =begin
2
+ #The Plaid API
3
+
4
+ #The Plaid REST API. Please see https://plaid.com/docs/api for more details.
5
+
6
+ The version of the OpenAPI document: 2020-09-14_1.11.0
7
+
8
+ Generated by: https://openapi-generator.tech
9
+ OpenAPI Generator version: 5.1.0
10
+
11
+ =end
12
+
13
+ require 'date'
14
+ require 'time'
15
+
16
+ module Plaid
17
+ # An object representing a balance held by an account in the past
18
+ class HistoricalBalance
19
+ # The date of the calculated historical balance, in an ISO 8601 format (YYYY-MM-DD)
20
+ attr_accessor :date
21
+
22
+ # The total amount of funds in the account, calculated from the `current` balance in the `balance` object by subtracting inflows and adding back outflows according to the posted date of each transaction. If the account has any pending transactions, historical balance amounts on or after the date of the earliest pending transaction may differ if retrieved in subsequent Asset Reports as a result of those pending transactions posting.
23
+ attr_accessor :current
24
+
25
+ # The ISO-4217 currency code of the balance. Always `null` if `unofficial_currency_code` is non-`null`.
26
+ attr_accessor :iso_currency_code
27
+
28
+ # The unofficial currency code associated with the balance. Always `null` if `iso_currency_code` is non-`null`. See the [currency code schema](/docs/api/accounts#currency-code-schema) for a full listing of supported `iso_currency_code`s.
29
+ attr_accessor :unofficial_currency_code
30
+
31
+ # Attribute mapping from ruby-style variable name to JSON key.
32
+ def self.attribute_map
33
+ {
34
+ :'date' => :'date',
35
+ :'current' => :'current',
36
+ :'iso_currency_code' => :'iso_currency_code',
37
+ :'unofficial_currency_code' => :'unofficial_currency_code'
38
+ }
39
+ end
40
+
41
+ # Returns all the JSON keys this model knows about
42
+ def self.acceptable_attributes
43
+ attribute_map.values
44
+ end
45
+
46
+ # Attribute type mapping.
47
+ def self.openapi_types
48
+ {
49
+ :'date' => :'String',
50
+ :'current' => :'Float',
51
+ :'iso_currency_code' => :'String',
52
+ :'unofficial_currency_code' => :'String'
53
+ }
54
+ end
55
+
56
+ # List of attributes with nullable: true
57
+ def self.openapi_nullable
58
+ Set.new([
59
+ :'iso_currency_code',
60
+ :'unofficial_currency_code'
61
+ ])
62
+ end
63
+
64
+ # Initializes the object
65
+ # @param [Hash] attributes Model attributes in the form of hash
66
+ def initialize(attributes = {})
67
+ if (!attributes.is_a?(Hash))
68
+ fail ArgumentError, "The input argument (attributes) must be a hash in `Plaid::HistoricalBalance` initialize method"
69
+ end
70
+
71
+ # check to see if the attribute exists and convert string to symbol for hash key
72
+ attributes = attributes.each_with_object({}) { |(k, v), h|
73
+ if (!self.class.attribute_map.key?(k.to_sym))
74
+ fail ArgumentError, "`#{k}` is not a valid attribute in `Plaid::HistoricalBalance`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
75
+ end
76
+ h[k.to_sym] = v
77
+ }
78
+
79
+ if attributes.key?(:'date')
80
+ self.date = attributes[:'date']
81
+ end
82
+
83
+ if attributes.key?(:'current')
84
+ self.current = attributes[:'current']
85
+ end
86
+
87
+ if attributes.key?(:'iso_currency_code')
88
+ self.iso_currency_code = attributes[:'iso_currency_code']
89
+ end
90
+
91
+ if attributes.key?(:'unofficial_currency_code')
92
+ self.unofficial_currency_code = attributes[:'unofficial_currency_code']
93
+ end
94
+ end
95
+
96
+ # Show invalid properties with the reasons. Usually used together with valid?
97
+ # @return Array for valid properties with the reasons
98
+ def list_invalid_properties
99
+ invalid_properties = Array.new
100
+ if @date.nil?
101
+ invalid_properties.push('invalid value for "date", date cannot be nil.')
102
+ end
103
+
104
+ if @current.nil?
105
+ invalid_properties.push('invalid value for "current", current cannot be nil.')
106
+ end
107
+
108
+ invalid_properties
109
+ end
110
+
111
+ # Check to see if the all the properties in the model are valid
112
+ # @return true if the model is valid
113
+ def valid?
114
+ return false if @date.nil?
115
+ return false if @current.nil?
116
+ true
117
+ end
118
+
119
+ # Checks equality by comparing each attribute.
120
+ # @param [Object] Object to be compared
121
+ def ==(o)
122
+ return true if self.equal?(o)
123
+ self.class == o.class &&
124
+ date == o.date &&
125
+ current == o.current &&
126
+ iso_currency_code == o.iso_currency_code &&
127
+ unofficial_currency_code == o.unofficial_currency_code
128
+ end
129
+
130
+ # @see the `==` method
131
+ # @param [Object] Object to be compared
132
+ def eql?(o)
133
+ self == o
134
+ end
135
+
136
+ # Calculates hash code according to all attributes.
137
+ # @return [Integer] Hash code
138
+ def hash
139
+ [date, current, iso_currency_code, unofficial_currency_code].hash
140
+ end
141
+
142
+ # Builds the object from hash
143
+ # @param [Hash] attributes Model attributes in the form of hash
144
+ # @return [Object] Returns the model itself
145
+ def self.build_from_hash(attributes)
146
+ new.build_from_hash(attributes)
147
+ end
148
+
149
+ # Builds the object from hash
150
+ # @param [Hash] attributes Model attributes in the form of hash
151
+ # @return [Object] Returns the model itself
152
+ def build_from_hash(attributes)
153
+ return nil unless attributes.is_a?(Hash)
154
+ self.class.openapi_types.each_pair do |key, type|
155
+ if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
156
+ self.send("#{key}=", nil)
157
+ elsif type =~ /\AArray<(.*)>/i
158
+ # check to ensure the input is an array given that the attribute
159
+ # is documented as an array but the input is not
160
+ if attributes[self.class.attribute_map[key]].is_a?(Array)
161
+ self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
162
+ end
163
+ elsif !attributes[self.class.attribute_map[key]].nil?
164
+ self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
165
+ end
166
+ end
167
+
168
+ self
169
+ end
170
+
171
+ # Deserializes the data based on type
172
+ # @param string type Data type
173
+ # @param string value Value to be deserialized
174
+ # @return [Object] Deserialized data
175
+ def _deserialize(type, value)
176
+ case type.to_sym
177
+ when :Time
178
+ Time.parse(value)
179
+ when :Date
180
+ Date.parse(value)
181
+ when :String
182
+ value.to_s
183
+ when :Integer
184
+ value.to_i
185
+ when :Float
186
+ value.to_f
187
+ when :Boolean
188
+ if value.to_s =~ /\A(true|t|yes|y|1)\z/i
189
+ true
190
+ else
191
+ false
192
+ end
193
+ when :Object
194
+ # generic object (usually a Hash), return directly
195
+ value
196
+ when /\AArray<(?<inner_type>.+)>\z/
197
+ inner_type = Regexp.last_match[:inner_type]
198
+ value.map { |v| _deserialize(inner_type, v) }
199
+ when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
200
+ k_type = Regexp.last_match[:k_type]
201
+ v_type = Regexp.last_match[:v_type]
202
+ {}.tap do |hash|
203
+ value.each do |k, v|
204
+ hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
205
+ end
206
+ end
207
+ else # model
208
+ # models (e.g. Pet) or oneOf
209
+ klass = Plaid.const_get(type)
210
+ klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
211
+ end
212
+ end
213
+
214
+ # Returns the string representation of the object
215
+ # @return [String] String presentation of the object
216
+ def to_s
217
+ to_hash.to_s
218
+ end
219
+
220
+ # to_body is an alias to to_hash (backward compatibility)
221
+ # @return [Hash] Returns the object in the form of hash
222
+ def to_body
223
+ to_hash
224
+ end
225
+
226
+ # Returns the object in the form of hash
227
+ # @return [Hash] Returns the object in the form of hash
228
+ def to_hash
229
+ hash = {}
230
+ self.class.attribute_map.each_pair do |attr, param|
231
+ value = self.send(attr)
232
+ if value.nil?
233
+ is_nullable = self.class.openapi_nullable.include?(attr)
234
+ next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
235
+ end
236
+
237
+ hash[param] = _to_hash(value)
238
+ end
239
+ hash
240
+ end
241
+
242
+ # Outputs non-array value in the form of hash
243
+ # For object, use to_hash. Otherwise, just return the value
244
+ # @param [Object] value Any valid value
245
+ # @return [Hash] Returns the value in the form of hash
246
+ def _to_hash(value)
247
+ if value.is_a?(Array)
248
+ value.compact.map { |v| _to_hash(v) }
249
+ elsif value.is_a?(Hash)
250
+ {}.tap do |hash|
251
+ value.each { |k, v| hash[k] = _to_hash(v) }
252
+ end
253
+ elsif value.respond_to? :to_hash
254
+ value.to_hash
255
+ else
256
+ value
257
+ end
258
+ end
259
+
260
+ end
261
+
262
+ end