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,266 @@
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 the repayment plan for the student loan
18
+ class StudentRepaymentPlan
19
+ # The description of the repayment plan as provided by the servicer.
20
+ attr_accessor :description
21
+
22
+ # The type of the repayment plan.
23
+ attr_accessor :type
24
+
25
+ class EnumAttributeValidator
26
+ attr_reader :datatype
27
+ attr_reader :allowable_values
28
+
29
+ def initialize(datatype, allowable_values)
30
+ @allowable_values = allowable_values.map do |value|
31
+ case datatype.to_s
32
+ when /Integer/i
33
+ value.to_i
34
+ when /Float/i
35
+ value.to_f
36
+ else
37
+ value
38
+ end
39
+ end
40
+ end
41
+
42
+ def valid?(value)
43
+ !value || allowable_values.include?(value)
44
+ end
45
+ end
46
+
47
+ # Attribute mapping from ruby-style variable name to JSON key.
48
+ def self.attribute_map
49
+ {
50
+ :'description' => :'description',
51
+ :'type' => :'type'
52
+ }
53
+ end
54
+
55
+ # Returns all the JSON keys this model knows about
56
+ def self.acceptable_attributes
57
+ attribute_map.values
58
+ end
59
+
60
+ # Attribute type mapping.
61
+ def self.openapi_types
62
+ {
63
+ :'description' => :'String',
64
+ :'type' => :'String'
65
+ }
66
+ end
67
+
68
+ # List of attributes with nullable: true
69
+ def self.openapi_nullable
70
+ Set.new([
71
+ :'description',
72
+ :'type'
73
+ ])
74
+ end
75
+
76
+ # Initializes the object
77
+ # @param [Hash] attributes Model attributes in the form of hash
78
+ def initialize(attributes = {})
79
+ if (!attributes.is_a?(Hash))
80
+ fail ArgumentError, "The input argument (attributes) must be a hash in `Plaid::StudentRepaymentPlan` initialize method"
81
+ end
82
+
83
+ # check to see if the attribute exists and convert string to symbol for hash key
84
+ attributes = attributes.each_with_object({}) { |(k, v), h|
85
+ if (!self.class.attribute_map.key?(k.to_sym))
86
+ fail ArgumentError, "`#{k}` is not a valid attribute in `Plaid::StudentRepaymentPlan`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
87
+ end
88
+ h[k.to_sym] = v
89
+ }
90
+
91
+ if attributes.key?(:'description')
92
+ self.description = attributes[:'description']
93
+ end
94
+
95
+ if attributes.key?(:'type')
96
+ self.type = attributes[:'type']
97
+ end
98
+ end
99
+
100
+ # Show invalid properties with the reasons. Usually used together with valid?
101
+ # @return Array for valid properties with the reasons
102
+ def list_invalid_properties
103
+ invalid_properties = Array.new
104
+ invalid_properties
105
+ end
106
+
107
+ # Check to see if the all the properties in the model are valid
108
+ # @return true if the model is valid
109
+ def valid?
110
+ type_validator = EnumAttributeValidator.new('String', ["extended graduated", "extended standard", "graduated", "income-contingent repayment", "income-based repayment", "interest-only", "other", "pay as you earn", "revised pay as you earn", "standard"])
111
+ return false unless type_validator.valid?(@type)
112
+ true
113
+ end
114
+
115
+ # Custom attribute writer method checking allowed values (enum).
116
+ # @param [Object] type Object to be assigned
117
+ def type=(type)
118
+ validator = EnumAttributeValidator.new('String', ["extended graduated", "extended standard", "graduated", "income-contingent repayment", "income-based repayment", "interest-only", "other", "pay as you earn", "revised pay as you earn", "standard"])
119
+ unless validator.valid?(type)
120
+ fail ArgumentError, "invalid value for \"type\", must be one of #{validator.allowable_values}."
121
+ end
122
+ @type = type
123
+ end
124
+
125
+ # Checks equality by comparing each attribute.
126
+ # @param [Object] Object to be compared
127
+ def ==(o)
128
+ return true if self.equal?(o)
129
+ self.class == o.class &&
130
+ description == o.description &&
131
+ type == o.type
132
+ end
133
+
134
+ # @see the `==` method
135
+ # @param [Object] Object to be compared
136
+ def eql?(o)
137
+ self == o
138
+ end
139
+
140
+ # Calculates hash code according to all attributes.
141
+ # @return [Integer] Hash code
142
+ def hash
143
+ [description, type].hash
144
+ end
145
+
146
+ # Builds the object from hash
147
+ # @param [Hash] attributes Model attributes in the form of hash
148
+ # @return [Object] Returns the model itself
149
+ def self.build_from_hash(attributes)
150
+ new.build_from_hash(attributes)
151
+ end
152
+
153
+ # Builds the object from hash
154
+ # @param [Hash] attributes Model attributes in the form of hash
155
+ # @return [Object] Returns the model itself
156
+ def build_from_hash(attributes)
157
+ return nil unless attributes.is_a?(Hash)
158
+ self.class.openapi_types.each_pair do |key, type|
159
+ if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
160
+ self.send("#{key}=", nil)
161
+ elsif type =~ /\AArray<(.*)>/i
162
+ # check to ensure the input is an array given that the attribute
163
+ # is documented as an array but the input is not
164
+ if attributes[self.class.attribute_map[key]].is_a?(Array)
165
+ self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
166
+ end
167
+ elsif !attributes[self.class.attribute_map[key]].nil?
168
+ self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
169
+ end
170
+ end
171
+
172
+ self
173
+ end
174
+
175
+ # Deserializes the data based on type
176
+ # @param string type Data type
177
+ # @param string value Value to be deserialized
178
+ # @return [Object] Deserialized data
179
+ def _deserialize(type, value)
180
+ case type.to_sym
181
+ when :Time
182
+ Time.parse(value)
183
+ when :Date
184
+ Date.parse(value)
185
+ when :String
186
+ value.to_s
187
+ when :Integer
188
+ value.to_i
189
+ when :Float
190
+ value.to_f
191
+ when :Boolean
192
+ if value.to_s =~ /\A(true|t|yes|y|1)\z/i
193
+ true
194
+ else
195
+ false
196
+ end
197
+ when :Object
198
+ # generic object (usually a Hash), return directly
199
+ value
200
+ when /\AArray<(?<inner_type>.+)>\z/
201
+ inner_type = Regexp.last_match[:inner_type]
202
+ value.map { |v| _deserialize(inner_type, v) }
203
+ when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
204
+ k_type = Regexp.last_match[:k_type]
205
+ v_type = Regexp.last_match[:v_type]
206
+ {}.tap do |hash|
207
+ value.each do |k, v|
208
+ hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
209
+ end
210
+ end
211
+ else # model
212
+ # models (e.g. Pet) or oneOf
213
+ klass = Plaid.const_get(type)
214
+ klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
215
+ end
216
+ end
217
+
218
+ # Returns the string representation of the object
219
+ # @return [String] String presentation of the object
220
+ def to_s
221
+ to_hash.to_s
222
+ end
223
+
224
+ # to_body is an alias to to_hash (backward compatibility)
225
+ # @return [Hash] Returns the object in the form of hash
226
+ def to_body
227
+ to_hash
228
+ end
229
+
230
+ # Returns the object in the form of hash
231
+ # @return [Hash] Returns the object in the form of hash
232
+ def to_hash
233
+ hash = {}
234
+ self.class.attribute_map.each_pair do |attr, param|
235
+ value = self.send(attr)
236
+ if value.nil?
237
+ is_nullable = self.class.openapi_nullable.include?(attr)
238
+ next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
239
+ end
240
+
241
+ hash[param] = _to_hash(value)
242
+ end
243
+ hash
244
+ end
245
+
246
+ # Outputs non-array value in the form of hash
247
+ # For object, use to_hash. Otherwise, just return the value
248
+ # @param [Object] value Any valid value
249
+ # @return [Hash] Returns the value in the form of hash
250
+ def _to_hash(value)
251
+ if value.is_a?(Array)
252
+ value.compact.map { |v| _to_hash(v) }
253
+ elsif value.is_a?(Hash)
254
+ {}.tap do |hash|
255
+ value.each { |k, v| hash[k] = _to_hash(v) }
256
+ end
257
+ elsif value.respond_to? :to_hash
258
+ value.to_hash
259
+ else
260
+ value
261
+ end
262
+ end
263
+
264
+ end
265
+
266
+ end
@@ -0,0 +1,500 @@
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
+ # A representation of a transaction
18
+ class Transaction
19
+ # Please use the `payment_channel` field, `transaction_type` will be deprecated in the future. `digital:` transactions that took place online. `place:` transactions that were made at a physical location. `special:` transactions that relate to banks, e.g. fees or deposits. `unresolved:` transactions that do not fit into the other three types.
20
+ attr_accessor :transaction_type
21
+
22
+ # The unique ID of the transaction. Like all Plaid identifiers, the `transaction_id` is case sensitive.
23
+ attr_accessor :transaction_id
24
+
25
+ # The name of the account owner. This field is not typically populated and only relevant when dealing with sub-accounts.
26
+ attr_accessor :account_owner
27
+
28
+ # The ID of a posted transaction's associated pending transaction, where applicable.
29
+ attr_accessor :pending_transaction_id
30
+
31
+ # When `true`, identifies the transaction as pending or unsettled. Pending transaction details (name, type, amount, category ID) may change before they are settled.
32
+ attr_accessor :pending
33
+
34
+ # The channel used to make a payment. `online:` transactions that took place online. `in store:` transactions that were made at a physical location. `other:` transactions that relate to banks, e.g. fees or deposits. This field replaces the `transaction_type` field.
35
+ attr_accessor :payment_channel
36
+
37
+ attr_accessor :payment_meta
38
+
39
+ # The merchant name or transaction description. If the `transaction` object was returned by a Transactions endpoint such as `/transactions/get`, this field will always appear. If the `transaction` object was returned by an Assets endpoint such as `/asset_report/get/` or `/asset_report/pdf/get`, this field will only appear in an Asset Report with Insights.
40
+ attr_accessor :name
41
+
42
+ # The merchant name, as extracted by Plaid from the `name` field.
43
+ attr_accessor :merchant_name
44
+
45
+ attr_accessor :location
46
+
47
+ # The date that the transaction was authorized. Dates are returned in an ISO 8601 format ( `YYYY-MM-DD` ).
48
+ attr_accessor :authorized_date
49
+
50
+ # Date and time when a transaction was authorized in ISO 8601 format ( `YYYY-MM-DDTHH:mm:ssZ` ). This field is only populated for UK institutions. For institutions in other countries, will be `null`.
51
+ attr_accessor :authorized_datetime
52
+
53
+ # For pending transactions, the date that the transaction occurred; for posted transactions, the date that the transaction posted. Both dates are returned in an ISO 8601 format ( `YYYY-MM-DD` ).
54
+ attr_accessor :date
55
+
56
+ # Date and time when a transaction was posted in ISO 8601 format ( `YYYY-MM-DDTHH:mm:ssZ` ). This field is only populated for UK institutions. For institutions in other countries, will be `null`.
57
+ attr_accessor :datetime
58
+
59
+ # The ID of the category to which this transaction belongs. See [Categories](https://plaid.com/docs/#category-overview). If the `transaction` object was returned by an Assets endpoint such as `/asset_report/get/` or `/asset_report/pdf/get`, this field will only appear in an Asset Report with Insights.
60
+ attr_accessor :category_id
61
+
62
+ # A hierarchical array of the categories to which this transaction belongs. See [Categories](https://plaid.com/docs/#category-overview). If the `transaction` object was returned by an Assets endpoint such as `/asset_report/get/` or `/asset_report/pdf/get`, this field will only appear in an Asset Report with Insights.
63
+ attr_accessor :category
64
+
65
+ # The unofficial currency code associated with the transaction. Always `null` if `iso_currency_code` is non-`null`. Unofficial currency codes are used for currencies that do not have official ISO currency codes, such as cryptocurrencies and the currencies of certain countries. See the [currency code schema](/docs/api/accounts#currency-code-schema) for a full listing of supported `iso_currency_code`s.
66
+ attr_accessor :unofficial_currency_code
67
+
68
+ # The ISO-4217 currency code of the transaction. Always `null` if `unofficial_currency_code` is non-null.
69
+ attr_accessor :iso_currency_code
70
+
71
+ # The settled value of the transaction, denominated in the account's currency, as stated in `iso_currency_code` or `unofficial_currency_code`. Positive values when money moves out of the account; negative values when money moves in. For example, debit card purchases are positive; credit card payments, direct deposits, and refunds are negative.
72
+ attr_accessor :amount
73
+
74
+ # The ID of the account in which this transaction occurred.
75
+ attr_accessor :account_id
76
+
77
+ attr_accessor :transaction_code
78
+
79
+ class EnumAttributeValidator
80
+ attr_reader :datatype
81
+ attr_reader :allowable_values
82
+
83
+ def initialize(datatype, allowable_values)
84
+ @allowable_values = allowable_values.map do |value|
85
+ case datatype.to_s
86
+ when /Integer/i
87
+ value.to_i
88
+ when /Float/i
89
+ value.to_f
90
+ else
91
+ value
92
+ end
93
+ end
94
+ end
95
+
96
+ def valid?(value)
97
+ !value || allowable_values.include?(value)
98
+ end
99
+ end
100
+
101
+ # Attribute mapping from ruby-style variable name to JSON key.
102
+ def self.attribute_map
103
+ {
104
+ :'transaction_type' => :'transaction_type',
105
+ :'transaction_id' => :'transaction_id',
106
+ :'account_owner' => :'account_owner',
107
+ :'pending_transaction_id' => :'pending_transaction_id',
108
+ :'pending' => :'pending',
109
+ :'payment_channel' => :'payment_channel',
110
+ :'payment_meta' => :'payment_meta',
111
+ :'name' => :'name',
112
+ :'merchant_name' => :'merchant_name',
113
+ :'location' => :'location',
114
+ :'authorized_date' => :'authorized_date',
115
+ :'authorized_datetime' => :'authorized_datetime',
116
+ :'date' => :'date',
117
+ :'datetime' => :'datetime',
118
+ :'category_id' => :'category_id',
119
+ :'category' => :'category',
120
+ :'unofficial_currency_code' => :'unofficial_currency_code',
121
+ :'iso_currency_code' => :'iso_currency_code',
122
+ :'amount' => :'amount',
123
+ :'account_id' => :'account_id',
124
+ :'transaction_code' => :'transaction_code'
125
+ }
126
+ end
127
+
128
+ # Returns all the JSON keys this model knows about
129
+ def self.acceptable_attributes
130
+ attribute_map.values
131
+ end
132
+
133
+ # Attribute type mapping.
134
+ def self.openapi_types
135
+ {
136
+ :'transaction_type' => :'String',
137
+ :'transaction_id' => :'String',
138
+ :'account_owner' => :'String',
139
+ :'pending_transaction_id' => :'String',
140
+ :'pending' => :'Boolean',
141
+ :'payment_channel' => :'String',
142
+ :'payment_meta' => :'PaymentMeta',
143
+ :'name' => :'String',
144
+ :'merchant_name' => :'String',
145
+ :'location' => :'Location',
146
+ :'authorized_date' => :'String',
147
+ :'authorized_datetime' => :'String',
148
+ :'date' => :'String',
149
+ :'datetime' => :'String',
150
+ :'category_id' => :'String',
151
+ :'category' => :'Array<String>',
152
+ :'unofficial_currency_code' => :'String',
153
+ :'iso_currency_code' => :'String',
154
+ :'amount' => :'Float',
155
+ :'account_id' => :'String',
156
+ :'transaction_code' => :'TransactionCode'
157
+ }
158
+ end
159
+
160
+ # List of attributes with nullable: true
161
+ def self.openapi_nullable
162
+ Set.new([
163
+ :'account_owner',
164
+ :'pending_transaction_id',
165
+ :'merchant_name',
166
+ :'authorized_date',
167
+ :'authorized_datetime',
168
+ :'datetime',
169
+ :'category',
170
+ :'unofficial_currency_code',
171
+ :'iso_currency_code',
172
+ :'transaction_code'
173
+ ])
174
+ end
175
+
176
+ # Initializes the object
177
+ # @param [Hash] attributes Model attributes in the form of hash
178
+ def initialize(attributes = {})
179
+ if (!attributes.is_a?(Hash))
180
+ fail ArgumentError, "The input argument (attributes) must be a hash in `Plaid::Transaction` initialize method"
181
+ end
182
+
183
+ # check to see if the attribute exists and convert string to symbol for hash key
184
+ attributes = attributes.each_with_object({}) { |(k, v), h|
185
+ if (!self.class.attribute_map.key?(k.to_sym))
186
+ fail ArgumentError, "`#{k}` is not a valid attribute in `Plaid::Transaction`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
187
+ end
188
+ h[k.to_sym] = v
189
+ }
190
+
191
+ if attributes.key?(:'transaction_type')
192
+ self.transaction_type = attributes[:'transaction_type']
193
+ end
194
+
195
+ if attributes.key?(:'transaction_id')
196
+ self.transaction_id = attributes[:'transaction_id']
197
+ end
198
+
199
+ if attributes.key?(:'account_owner')
200
+ self.account_owner = attributes[:'account_owner']
201
+ end
202
+
203
+ if attributes.key?(:'pending_transaction_id')
204
+ self.pending_transaction_id = attributes[:'pending_transaction_id']
205
+ end
206
+
207
+ if attributes.key?(:'pending')
208
+ self.pending = attributes[:'pending']
209
+ end
210
+
211
+ if attributes.key?(:'payment_channel')
212
+ self.payment_channel = attributes[:'payment_channel']
213
+ end
214
+
215
+ if attributes.key?(:'payment_meta')
216
+ self.payment_meta = attributes[:'payment_meta']
217
+ end
218
+
219
+ if attributes.key?(:'name')
220
+ self.name = attributes[:'name']
221
+ end
222
+
223
+ if attributes.key?(:'merchant_name')
224
+ self.merchant_name = attributes[:'merchant_name']
225
+ end
226
+
227
+ if attributes.key?(:'location')
228
+ self.location = attributes[:'location']
229
+ end
230
+
231
+ if attributes.key?(:'authorized_date')
232
+ self.authorized_date = attributes[:'authorized_date']
233
+ end
234
+
235
+ if attributes.key?(:'authorized_datetime')
236
+ self.authorized_datetime = attributes[:'authorized_datetime']
237
+ end
238
+
239
+ if attributes.key?(:'date')
240
+ self.date = attributes[:'date']
241
+ end
242
+
243
+ if attributes.key?(:'datetime')
244
+ self.datetime = attributes[:'datetime']
245
+ end
246
+
247
+ if attributes.key?(:'category_id')
248
+ self.category_id = attributes[:'category_id']
249
+ end
250
+
251
+ if attributes.key?(:'category')
252
+ if (value = attributes[:'category']).is_a?(Array)
253
+ self.category = value
254
+ end
255
+ end
256
+
257
+ if attributes.key?(:'unofficial_currency_code')
258
+ self.unofficial_currency_code = attributes[:'unofficial_currency_code']
259
+ end
260
+
261
+ if attributes.key?(:'iso_currency_code')
262
+ self.iso_currency_code = attributes[:'iso_currency_code']
263
+ end
264
+
265
+ if attributes.key?(:'amount')
266
+ self.amount = attributes[:'amount']
267
+ end
268
+
269
+ if attributes.key?(:'account_id')
270
+ self.account_id = attributes[:'account_id']
271
+ end
272
+
273
+ if attributes.key?(:'transaction_code')
274
+ self.transaction_code = attributes[:'transaction_code']
275
+ end
276
+ end
277
+
278
+ # Show invalid properties with the reasons. Usually used together with valid?
279
+ # @return Array for valid properties with the reasons
280
+ def list_invalid_properties
281
+ invalid_properties = Array.new
282
+ if @transaction_id.nil?
283
+ invalid_properties.push('invalid value for "transaction_id", transaction_id cannot be nil.')
284
+ end
285
+
286
+ if @pending.nil?
287
+ invalid_properties.push('invalid value for "pending", pending cannot be nil.')
288
+ end
289
+
290
+ if @date.nil?
291
+ invalid_properties.push('invalid value for "date", date cannot be nil.')
292
+ end
293
+
294
+ if @amount.nil?
295
+ invalid_properties.push('invalid value for "amount", amount cannot be nil.')
296
+ end
297
+
298
+ if @account_id.nil?
299
+ invalid_properties.push('invalid value for "account_id", account_id cannot be nil.')
300
+ end
301
+
302
+ invalid_properties
303
+ end
304
+
305
+ # Check to see if the all the properties in the model are valid
306
+ # @return true if the model is valid
307
+ def valid?
308
+ transaction_type_validator = EnumAttributeValidator.new('String', ["digital", "place", "special", "unresolved"])
309
+ return false unless transaction_type_validator.valid?(@transaction_type)
310
+ return false if @transaction_id.nil?
311
+ return false if @pending.nil?
312
+ payment_channel_validator = EnumAttributeValidator.new('String', ["online", "in store", "other"])
313
+ return false unless payment_channel_validator.valid?(@payment_channel)
314
+ return false if @date.nil?
315
+ return false if @amount.nil?
316
+ return false if @account_id.nil?
317
+ true
318
+ end
319
+
320
+ # Custom attribute writer method checking allowed values (enum).
321
+ # @param [Object] transaction_type Object to be assigned
322
+ def transaction_type=(transaction_type)
323
+ validator = EnumAttributeValidator.new('String', ["digital", "place", "special", "unresolved"])
324
+ unless validator.valid?(transaction_type)
325
+ fail ArgumentError, "invalid value for \"transaction_type\", must be one of #{validator.allowable_values}."
326
+ end
327
+ @transaction_type = transaction_type
328
+ end
329
+
330
+ # Custom attribute writer method checking allowed values (enum).
331
+ # @param [Object] payment_channel Object to be assigned
332
+ def payment_channel=(payment_channel)
333
+ validator = EnumAttributeValidator.new('String', ["online", "in store", "other"])
334
+ unless validator.valid?(payment_channel)
335
+ fail ArgumentError, "invalid value for \"payment_channel\", must be one of #{validator.allowable_values}."
336
+ end
337
+ @payment_channel = payment_channel
338
+ end
339
+
340
+ # Checks equality by comparing each attribute.
341
+ # @param [Object] Object to be compared
342
+ def ==(o)
343
+ return true if self.equal?(o)
344
+ self.class == o.class &&
345
+ transaction_type == o.transaction_type &&
346
+ transaction_id == o.transaction_id &&
347
+ account_owner == o.account_owner &&
348
+ pending_transaction_id == o.pending_transaction_id &&
349
+ pending == o.pending &&
350
+ payment_channel == o.payment_channel &&
351
+ payment_meta == o.payment_meta &&
352
+ name == o.name &&
353
+ merchant_name == o.merchant_name &&
354
+ location == o.location &&
355
+ authorized_date == o.authorized_date &&
356
+ authorized_datetime == o.authorized_datetime &&
357
+ date == o.date &&
358
+ datetime == o.datetime &&
359
+ category_id == o.category_id &&
360
+ category == o.category &&
361
+ unofficial_currency_code == o.unofficial_currency_code &&
362
+ iso_currency_code == o.iso_currency_code &&
363
+ amount == o.amount &&
364
+ account_id == o.account_id &&
365
+ transaction_code == o.transaction_code
366
+ end
367
+
368
+ # @see the `==` method
369
+ # @param [Object] Object to be compared
370
+ def eql?(o)
371
+ self == o
372
+ end
373
+
374
+ # Calculates hash code according to all attributes.
375
+ # @return [Integer] Hash code
376
+ def hash
377
+ [transaction_type, transaction_id, account_owner, pending_transaction_id, pending, payment_channel, payment_meta, name, merchant_name, location, authorized_date, authorized_datetime, date, datetime, category_id, category, unofficial_currency_code, iso_currency_code, amount, account_id, transaction_code].hash
378
+ end
379
+
380
+ # Builds the object from hash
381
+ # @param [Hash] attributes Model attributes in the form of hash
382
+ # @return [Object] Returns the model itself
383
+ def self.build_from_hash(attributes)
384
+ new.build_from_hash(attributes)
385
+ end
386
+
387
+ # Builds the object from hash
388
+ # @param [Hash] attributes Model attributes in the form of hash
389
+ # @return [Object] Returns the model itself
390
+ def build_from_hash(attributes)
391
+ return nil unless attributes.is_a?(Hash)
392
+ self.class.openapi_types.each_pair do |key, type|
393
+ if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
394
+ self.send("#{key}=", nil)
395
+ elsif type =~ /\AArray<(.*)>/i
396
+ # check to ensure the input is an array given that the attribute
397
+ # is documented as an array but the input is not
398
+ if attributes[self.class.attribute_map[key]].is_a?(Array)
399
+ self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
400
+ end
401
+ elsif !attributes[self.class.attribute_map[key]].nil?
402
+ self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
403
+ end
404
+ end
405
+
406
+ self
407
+ end
408
+
409
+ # Deserializes the data based on type
410
+ # @param string type Data type
411
+ # @param string value Value to be deserialized
412
+ # @return [Object] Deserialized data
413
+ def _deserialize(type, value)
414
+ case type.to_sym
415
+ when :Time
416
+ Time.parse(value)
417
+ when :Date
418
+ Date.parse(value)
419
+ when :String
420
+ value.to_s
421
+ when :Integer
422
+ value.to_i
423
+ when :Float
424
+ value.to_f
425
+ when :Boolean
426
+ if value.to_s =~ /\A(true|t|yes|y|1)\z/i
427
+ true
428
+ else
429
+ false
430
+ end
431
+ when :Object
432
+ # generic object (usually a Hash), return directly
433
+ value
434
+ when /\AArray<(?<inner_type>.+)>\z/
435
+ inner_type = Regexp.last_match[:inner_type]
436
+ value.map { |v| _deserialize(inner_type, v) }
437
+ when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
438
+ k_type = Regexp.last_match[:k_type]
439
+ v_type = Regexp.last_match[:v_type]
440
+ {}.tap do |hash|
441
+ value.each do |k, v|
442
+ hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
443
+ end
444
+ end
445
+ else # model
446
+ # models (e.g. Pet) or oneOf
447
+ klass = Plaid.const_get(type)
448
+ klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
449
+ end
450
+ end
451
+
452
+ # Returns the string representation of the object
453
+ # @return [String] String presentation of the object
454
+ def to_s
455
+ to_hash.to_s
456
+ end
457
+
458
+ # to_body is an alias to to_hash (backward compatibility)
459
+ # @return [Hash] Returns the object in the form of hash
460
+ def to_body
461
+ to_hash
462
+ end
463
+
464
+ # Returns the object in the form of hash
465
+ # @return [Hash] Returns the object in the form of hash
466
+ def to_hash
467
+ hash = {}
468
+ self.class.attribute_map.each_pair do |attr, param|
469
+ value = self.send(attr)
470
+ if value.nil?
471
+ is_nullable = self.class.openapi_nullable.include?(attr)
472
+ next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
473
+ end
474
+
475
+ hash[param] = _to_hash(value)
476
+ end
477
+ hash
478
+ end
479
+
480
+ # Outputs non-array value in the form of hash
481
+ # For object, use to_hash. Otherwise, just return the value
482
+ # @param [Object] value Any valid value
483
+ # @return [Hash] Returns the value in the form of hash
484
+ def _to_hash(value)
485
+ if value.is_a?(Array)
486
+ value.compact.map { |v| _to_hash(v) }
487
+ elsif value.is_a?(Hash)
488
+ {}.tap do |hash|
489
+ value.each { |k, v| hash[k] = _to_hash(v) }
490
+ end
491
+ elsif value.respond_to? :to_hash
492
+ value.to_hash
493
+ else
494
+ value
495
+ end
496
+ end
497
+
498
+ end
499
+
500
+ end