plaid 14.0.0.beta.5.pre.plural.pre.income.pre.breakdown → 15.3.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +405 -5
- data/CONTRIBUTING.md +1 -5
- data/Dockerfile +4 -2
- data/Gemfile.lock +10 -6
- data/Makefile +10 -1
- data/README.md +28 -21
- data/lib/plaid/api/plaid_api.rb +4490 -980
- data/lib/plaid/api_client.rb +6 -5
- data/lib/plaid/api_error.rb +4 -4
- data/lib/plaid/configuration.rb +7 -6
- data/lib/plaid/models/account_access.rb +248 -0
- data/lib/plaid/models/account_assets.rb +22 -10
- data/lib/plaid/models/account_assets_all_of.rb +19 -7
- data/lib/plaid/models/account_balance.rb +8 -12
- data/lib/plaid/models/account_base.rb +4 -5
- data/lib/plaid/models/account_filter.rb +258 -0
- data/lib/plaid/models/account_filters_response.rb +2 -2
- data/lib/plaid/models/account_identity.rb +6 -6
- data/lib/plaid/models/account_identity_all_of.rb +3 -3
- data/lib/plaid/models/account_product_access.rb +249 -0
- data/lib/plaid/models/account_product_access_nullable.rb +256 -0
- data/lib/plaid/models/account_selection_cardinality.rb +40 -0
- data/lib/plaid/models/account_subtype.rb +12 -5
- data/lib/plaid/models/account_type.rb +6 -4
- data/lib/plaid/models/accounts_balance_get_request.rb +2 -2
- data/lib/plaid/models/accounts_balance_get_request_options.rb +3 -3
- data/lib/plaid/models/accounts_get_request.rb +2 -2
- data/lib/plaid/models/accounts_get_request_options.rb +2 -2
- data/lib/plaid/models/accounts_get_response.rb +2 -2
- data/lib/plaid/models/ach_class.rb +6 -4
- data/lib/plaid/models/address.rb +2 -3
- data/lib/plaid/models/address_data.rb +5 -9
- data/lib/plaid/models/{nullable_address_data.rb → address_data_nullable.rb} +9 -12
- data/lib/plaid/models/{nullable_address.rb → address_nullable.rb} +6 -6
- data/lib/plaid/models/application.rb +98 -7
- data/lib/plaid/models/application_get_request.rb +3 -3
- data/lib/plaid/models/application_get_response.rb +3 -3
- data/lib/plaid/models/apr.rb +2 -2
- data/lib/plaid/models/asset_report.rb +5 -9
- data/lib/plaid/models/asset_report_audit_copy_create_request.rb +2 -2
- data/lib/plaid/models/asset_report_audit_copy_create_response.rb +2 -2
- data/lib/plaid/models/asset_report_audit_copy_get_request.rb +2 -2
- data/lib/plaid/models/asset_report_audit_copy_remove_request.rb +2 -2
- data/lib/plaid/models/asset_report_audit_copy_remove_response.rb +2 -2
- data/lib/plaid/models/asset_report_create_request.rb +7 -7
- data/lib/plaid/models/asset_report_create_request_options.rb +4 -2
- data/lib/plaid/models/asset_report_create_response.rb +2 -2
- data/lib/plaid/models/asset_report_filter_request.rb +2 -2
- data/lib/plaid/models/asset_report_filter_response.rb +2 -2
- data/lib/plaid/models/asset_report_get_request.rb +4 -2
- data/lib/plaid/models/asset_report_get_response.rb +2 -2
- data/lib/plaid/models/asset_report_item.rb +4 -4
- data/lib/plaid/models/asset_report_pdf_get_request.rb +2 -2
- data/lib/plaid/models/asset_report_refresh_request.rb +8 -7
- data/lib/plaid/models/asset_report_refresh_request_options.rb +4 -2
- data/lib/plaid/models/asset_report_refresh_response.rb +2 -2
- data/lib/plaid/models/asset_report_relay_create_request.rb +271 -0
- data/lib/plaid/models/asset_report_relay_create_response.rb +240 -0
- data/lib/plaid/models/asset_report_relay_get_request.rb +245 -0
- data/lib/plaid/models/asset_report_relay_refresh_request.rb +255 -0
- data/lib/plaid/models/asset_report_relay_refresh_response.rb +254 -0
- data/lib/plaid/models/asset_report_relay_remove_request.rb +245 -0
- data/lib/plaid/models/asset_report_relay_remove_response.rb +240 -0
- data/lib/plaid/models/asset_report_remove_request.rb +2 -2
- data/lib/plaid/models/asset_report_remove_response.rb +2 -2
- data/lib/plaid/models/asset_report_transaction.rb +129 -185
- data/lib/plaid/models/asset_report_transaction_all_of.rb +7 -22
- data/lib/plaid/models/asset_report_user.rb +3 -3
- data/lib/plaid/models/assets_error_webhook.rb +8 -4
- data/lib/plaid/models/assets_product_ready_webhook.rb +2 -2
- data/lib/plaid/models/assets_relay_webhook.rb +299 -0
- data/lib/plaid/models/auth_get_numbers.rb +22 -2
- data/lib/plaid/models/auth_get_request.rb +2 -2
- data/lib/plaid/models/auth_get_request_options.rb +2 -2
- data/lib/plaid/models/auth_get_response.rb +2 -2
- data/lib/plaid/models/auth_metadata.rb +220 -0
- data/lib/plaid/models/auth_supported_methods.rb +255 -0
- data/lib/plaid/models/automatically_verified_webhook.rb +2 -2
- data/lib/plaid/models/bank_initiated_return_risk.rb +300 -0
- data/lib/plaid/models/bank_transfer.rb +4 -4
- data/lib/plaid/models/bank_transfer_balance.rb +3 -2
- data/lib/plaid/models/bank_transfer_balance_get_request.rb +3 -3
- data/lib/plaid/models/bank_transfer_balance_get_response.rb +3 -3
- data/lib/plaid/models/bank_transfer_cancel_request.rb +3 -3
- data/lib/plaid/models/bank_transfer_cancel_response.rb +3 -3
- data/lib/plaid/models/bank_transfer_create_request.rb +6 -6
- data/lib/plaid/models/bank_transfer_create_response.rb +3 -3
- data/lib/plaid/models/bank_transfer_direction.rb +7 -4
- data/lib/plaid/models/bank_transfer_event.rb +8 -18
- data/lib/plaid/models/bank_transfer_event_list_bank_transfer_type.rb +40 -0
- data/lib/plaid/models/bank_transfer_event_list_direction.rb +40 -0
- data/lib/plaid/models/bank_transfer_event_list_request.rb +5 -41
- data/lib/plaid/models/bank_transfer_event_list_response.rb +3 -3
- data/lib/plaid/models/bank_transfer_event_sync_request.rb +3 -3
- data/lib/plaid/models/bank_transfer_event_sync_response.rb +3 -3
- data/lib/plaid/models/bank_transfer_event_type.rb +6 -6
- data/lib/plaid/models/bank_transfer_failure.rb +3 -3
- data/lib/plaid/models/bank_transfer_get_request.rb +3 -3
- data/lib/plaid/models/bank_transfer_get_response.rb +3 -3
- data/lib/plaid/models/bank_transfer_list_request.rb +3 -3
- data/lib/plaid/models/bank_transfer_list_response.rb +3 -3
- data/lib/plaid/models/bank_transfer_migrate_account_request.rb +14 -4
- data/lib/plaid/models/bank_transfer_migrate_account_response.rb +3 -3
- data/lib/plaid/models/bank_transfer_network.rb +6 -4
- data/lib/plaid/models/bank_transfer_status.rb +6 -4
- data/lib/plaid/models/bank_transfer_sweep.rb +270 -0
- data/lib/plaid/models/bank_transfer_sweep_get_request.rb +245 -0
- data/lib/plaid/models/bank_transfer_sweep_get_response.rb +239 -0
- data/lib/plaid/models/bank_transfer_sweep_list_request.rb +302 -0
- data/lib/plaid/models/bank_transfer_sweep_list_response.rb +241 -0
- data/lib/plaid/models/bank_transfer_type.rb +6 -4
- data/lib/plaid/models/bank_transfer_user.rb +4 -4
- data/lib/plaid/models/bank_transfers_events_update_webhook.rb +2 -2
- data/lib/plaid/models/categories_get_response.rb +2 -2
- data/lib/plaid/models/category.rb +2 -2
- data/lib/plaid/models/cause.rb +156 -15
- data/lib/plaid/models/cause_all_of.rb +219 -0
- data/lib/plaid/models/client_provided_enhanced_transaction.rb +284 -0
- data/lib/plaid/models/client_provided_raw_transaction.rb +270 -0
- data/lib/plaid/models/connected_application.rb +298 -0
- data/lib/plaid/models/country_code.rb +8 -4
- data/lib/plaid/models/credit_account_subtype.rb +40 -0
- data/lib/plaid/models/credit_bank_income.rb +273 -0
- data/lib/plaid/models/credit_bank_income_account.rb +281 -0
- data/lib/plaid/models/credit_bank_income_account_type.rb +38 -0
- data/lib/plaid/models/credit_bank_income_category.rb +48 -0
- data/lib/plaid/models/credit_bank_income_cause.rb +259 -0
- data/lib/plaid/models/credit_bank_income_error_type.rb +53 -0
- data/lib/plaid/models/credit_bank_income_get_request.rb +249 -0
- data/lib/plaid/models/credit_bank_income_get_request_options.rb +222 -0
- data/lib/plaid/models/credit_bank_income_get_response.rb +236 -0
- data/lib/plaid/models/credit_bank_income_historical_summary.rb +273 -0
- data/lib/plaid/models/credit_bank_income_item.rb +274 -0
- data/lib/plaid/models/credit_bank_income_pay_frequency.rb +42 -0
- data/lib/plaid/models/credit_bank_income_source.rb +309 -0
- data/lib/plaid/models/credit_bank_income_summary.rb +303 -0
- data/lib/plaid/models/credit_bank_income_transaction.rb +304 -0
- data/lib/plaid/models/credit_bank_income_warning.rb +237 -0
- data/lib/plaid/models/credit_bank_income_warning_code.rb +41 -0
- data/lib/plaid/models/credit_bank_income_warning_type.rb +38 -0
- data/lib/plaid/models/credit_card_liability.rb +26 -35
- data/lib/plaid/models/credit_document_metadata.rb +258 -0
- data/lib/plaid/models/credit_employer_verification.rb +221 -0
- data/lib/plaid/models/credit_employment_get_request.rb +245 -0
- data/lib/plaid/models/credit_employment_get_response.rb +242 -0
- data/lib/plaid/models/credit_employment_verification.rb +282 -0
- data/lib/plaid/models/credit_filter.rb +4 -4
- data/lib/plaid/models/credit_pay_stub.rb +329 -0
- data/lib/plaid/models/credit_pay_stub_address.rb +265 -0
- data/lib/plaid/models/credit_pay_stub_deductions.rb +240 -0
- data/lib/plaid/models/credit_pay_stub_earnings.rb +240 -0
- data/lib/plaid/models/credit_pay_stub_employee.rb +260 -0
- data/lib/plaid/models/{nullable_recipient_bacs.rb → credit_pay_stub_employer.rb} +26 -27
- data/lib/plaid/models/credit_pay_stub_net_pay.rb +265 -0
- data/lib/plaid/models/credit_pay_stub_verification.rb +237 -0
- data/lib/plaid/models/credit_payroll_income_get_request.rb +240 -0
- data/lib/plaid/models/credit_payroll_income_get_response.rb +251 -0
- data/lib/plaid/models/credit_payroll_income_precheck_request.rb +272 -0
- data/lib/plaid/models/credit_payroll_income_precheck_response.rb +239 -0
- data/lib/plaid/models/credit_platform_ids.rb +243 -0
- data/lib/plaid/models/credit_w2.rb +486 -0
- data/lib/plaid/models/customer_initiated_return_risk.rb +300 -0
- data/lib/plaid/models/deductions.rb +262 -0
- data/lib/plaid/models/deductions_breakdown.rb +265 -0
- data/lib/plaid/models/deductions_total.rb +254 -0
- data/lib/plaid/models/default_update_webhook.rb +3 -4
- data/lib/plaid/models/deposit_switch_address_data.rb +2 -2
- data/lib/plaid/models/deposit_switch_alt_create_request.rb +60 -6
- data/lib/plaid/models/deposit_switch_alt_create_response.rb +2 -2
- data/lib/plaid/models/deposit_switch_create_request.rb +60 -6
- data/lib/plaid/models/deposit_switch_create_request_options.rb +251 -0
- data/lib/plaid/models/deposit_switch_create_response.rb +2 -2
- data/lib/plaid/models/deposit_switch_get_request.rb +2 -2
- data/lib/plaid/models/deposit_switch_get_response.rb +77 -10
- data/lib/plaid/models/deposit_switch_state_update_webhook.rb +250 -0
- data/lib/plaid/models/deposit_switch_target_account.rb +3 -2
- data/lib/plaid/models/deposit_switch_target_user.rb +3 -2
- data/lib/plaid/models/deposit_switch_token_create_request.rb +2 -2
- data/lib/plaid/models/deposit_switch_token_create_response.rb +3 -3
- data/lib/plaid/models/depository_account_subtype.rb +47 -0
- data/lib/plaid/models/depository_filter.rb +4 -4
- data/lib/plaid/models/distribution_breakdown.rb +296 -0
- data/lib/plaid/models/doc_type.rb +46 -0
- data/lib/plaid/models/document_metadata.rb +249 -0
- data/lib/plaid/models/earnings.rb +252 -0
- data/lib/plaid/models/earnings_breakdown.rb +297 -0
- data/lib/plaid/models/earnings_breakdown_canonical_description.rb +47 -0
- data/lib/plaid/models/earnings_total.rb +283 -0
- data/lib/plaid/models/email.rb +2 -2
- data/lib/plaid/models/employee.rb +31 -18
- data/lib/plaid/models/employee_income_summary_field_string.rb +3 -2
- data/lib/plaid/models/employer.rb +8 -4
- data/lib/plaid/models/employer_income_summary_field_string.rb +3 -2
- data/lib/plaid/models/employer_verification.rb +221 -0
- data/lib/plaid/models/employers_search_request.rb +2 -2
- data/lib/plaid/models/employers_search_response.rb +2 -2
- data/lib/plaid/models/employment_details.rb +230 -0
- data/lib/plaid/models/employment_verification.rb +271 -0
- data/lib/plaid/models/employment_verification_get_request.rb +245 -0
- data/lib/plaid/models/employment_verification_get_response.rb +242 -0
- data/lib/plaid/models/employment_verification_status.rb +40 -0
- data/lib/plaid/models/enhancements.rb +298 -0
- data/lib/plaid/models/error.rb +7 -14
- data/lib/plaid/models/external_payment_initiation_consent_options.rb +249 -0
- data/lib/plaid/models/external_payment_options.rb +72 -8
- data/lib/plaid/models/external_payment_refund_details.rb +9 -3
- data/lib/plaid/models/{external_payment_schedule.rb → external_payment_schedule_base.rb} +23 -27
- data/lib/plaid/models/external_payment_schedule_get.rb +21 -21
- data/lib/plaid/models/external_payment_schedule_request.rb +283 -0
- data/lib/plaid/models/health_incident.rb +22 -8
- data/lib/plaid/models/historical_balance.rb +5 -5
- data/lib/plaid/models/historical_update_webhook.rb +4 -5
- data/lib/plaid/models/holding.rb +4 -4
- data/lib/plaid/models/holdings_default_update_webhook.rb +3 -4
- data/lib/plaid/models/holdings_override.rb +289 -0
- data/lib/plaid/models/identity_default_update_webhook.rb +286 -0
- data/lib/plaid/models/identity_get_request.rb +2 -2
- data/lib/plaid/models/identity_get_request_options.rb +2 -2
- data/lib/plaid/models/identity_get_response.rb +2 -2
- data/lib/plaid/models/identity_update_types.rb +41 -0
- data/lib/plaid/models/incident_update.rb +7 -6
- data/lib/plaid/models/income_breakdown.rb +4 -4
- data/lib/plaid/models/income_breakdown_type.rb +41 -0
- data/lib/plaid/models/income_override.rb +222 -0
- data/lib/plaid/models/income_summary.rb +27 -2
- data/lib/plaid/models/income_summary_field_number.rb +3 -2
- data/lib/plaid/models/income_summary_field_string.rb +3 -2
- data/lib/plaid/models/income_verification_create_request.rb +25 -6
- data/lib/plaid/models/income_verification_create_request_options.rb +222 -0
- data/lib/plaid/models/income_verification_create_response.rb +2 -2
- data/lib/plaid/models/income_verification_documents_download_request.rb +29 -11
- data/lib/plaid/models/income_verification_payroll_flow_type.rb +39 -0
- data/lib/plaid/models/{income_verification_paystub_get_request.rb → income_verification_paystubs_get_request.rb} +22 -15
- data/lib/plaid/models/income_verification_paystubs_get_response.rb +262 -0
- data/lib/plaid/models/income_verification_precheck_confidence.rb +40 -0
- data/lib/plaid/models/income_verification_precheck_employer.rb +253 -0
- data/lib/plaid/models/income_verification_precheck_employer_address.rb +267 -0
- data/lib/plaid/models/income_verification_precheck_employer_address_data.rb +260 -0
- data/lib/plaid/models/income_verification_precheck_military_info.rb +232 -0
- data/lib/plaid/models/income_verification_precheck_request.rb +281 -0
- data/lib/plaid/models/income_verification_precheck_response.rb +254 -0
- data/lib/plaid/models/income_verification_precheck_user.rb +253 -0
- data/lib/plaid/models/{income_verification_summary_get_request.rb → income_verification_refresh_request.rb} +22 -15
- data/lib/plaid/models/income_verification_refresh_response.rb +239 -0
- data/lib/plaid/models/income_verification_source_type.rb +39 -0
- data/lib/plaid/models/income_verification_status_webhook.rb +16 -16
- data/lib/plaid/models/income_verification_taxforms_get_request.rb +252 -0
- data/lib/plaid/models/income_verification_taxforms_get_response.rb +262 -0
- data/lib/plaid/models/income_verification_webhook_status.rb +3 -2
- data/lib/plaid/models/inflow_model.rb +3 -3
- data/lib/plaid/models/initial_update_webhook.rb +3 -3
- data/lib/plaid/models/institution.rb +25 -10
- data/lib/plaid/models/institution_status.rb +31 -18
- data/lib/plaid/models/institutions_get_by_id_request.rb +24 -3
- data/lib/plaid/models/institutions_get_by_id_request_options.rb +16 -4
- data/lib/plaid/models/institutions_get_by_id_response.rb +2 -2
- data/lib/plaid/models/institutions_get_request.rb +33 -3
- data/lib/plaid/models/institutions_get_request_options.rb +38 -6
- data/lib/plaid/models/institutions_get_response.rb +3 -3
- data/lib/plaid/models/institutions_search_account_filter.rb +3 -2
- data/lib/plaid/models/institutions_search_payment_initiation_options.rb +18 -6
- data/lib/plaid/models/institutions_search_request.rb +24 -11
- data/lib/plaid/models/institutions_search_request_options.rb +20 -5
- data/lib/plaid/models/institutions_search_response.rb +2 -2
- data/lib/plaid/models/investment_account_subtype.rb +85 -0
- data/lib/plaid/models/investment_filter.rb +5 -5
- data/lib/plaid/models/investment_holdings_get_request_options.rb +2 -2
- data/lib/plaid/models/investment_transaction.rb +8 -56
- data/lib/plaid/models/investment_transaction_subtype.rb +82 -0
- data/lib/plaid/models/investment_transaction_type.rb +43 -0
- data/lib/plaid/models/investments_default_update_webhook.rb +3 -4
- data/lib/plaid/models/investments_holdings_get_request.rb +2 -2
- data/lib/plaid/models/investments_holdings_get_response.rb +2 -2
- data/lib/plaid/models/investments_transactions_get_request.rb +2 -2
- data/lib/plaid/models/investments_transactions_get_request_options.rb +2 -2
- data/lib/plaid/models/investments_transactions_get_response.rb +2 -2
- data/lib/plaid/models/investments_transactions_override.rb +319 -0
- data/lib/plaid/models/item.rb +31 -7
- data/lib/plaid/models/item_access_token_invalidate_request.rb +2 -2
- data/lib/plaid/models/item_access_token_invalidate_response.rb +2 -2
- data/lib/plaid/models/item_application_list_request.rb +241 -0
- data/lib/plaid/models/item_application_list_response.rb +237 -0
- data/lib/plaid/models/item_application_list_user_auth.rb +232 -0
- data/lib/plaid/models/item_application_scopes_update_request.rb +298 -0
- data/lib/plaid/models/item_application_scopes_update_response.rb +225 -0
- data/lib/plaid/models/item_error_webhook.rb +8 -4
- data/lib/plaid/models/item_get_request.rb +2 -2
- data/lib/plaid/models/item_get_response.rb +3 -3
- data/lib/plaid/models/item_import_request.rb +2 -2
- data/lib/plaid/models/item_import_request_options.rb +2 -2
- data/lib/plaid/models/item_import_request_user_auth.rb +2 -2
- data/lib/plaid/models/item_import_response.rb +2 -2
- data/lib/plaid/models/item_product_ready_webhook.rb +3 -4
- data/lib/plaid/models/item_public_token_create_request.rb +2 -2
- data/lib/plaid/models/item_public_token_create_response.rb +2 -2
- data/lib/plaid/models/item_public_token_exchange_request.rb +2 -2
- data/lib/plaid/models/item_public_token_exchange_response.rb +2 -2
- data/lib/plaid/models/item_remove_request.rb +2 -2
- data/lib/plaid/models/item_remove_response.rb +2 -2
- data/lib/plaid/models/item_status.rb +8 -17
- data/lib/plaid/models/item_status_investments.rb +232 -0
- data/lib/plaid/models/item_status_last_webhook.rb +232 -0
- data/lib/plaid/models/{nullable_item_status.rb → item_status_nullable.rb} +12 -20
- data/lib/plaid/models/item_status_transactions.rb +232 -0
- data/lib/plaid/models/item_webhook_update_request.rb +4 -8
- data/lib/plaid/models/item_webhook_update_response.rb +2 -2
- data/lib/plaid/models/jwk_public_key.rb +4 -2
- data/lib/plaid/models/jwt_header.rb +2 -2
- data/lib/plaid/models/liabilities_default_update_webhook.rb +35 -6
- data/lib/plaid/models/liabilities_get_request.rb +2 -2
- data/lib/plaid/models/liabilities_get_request_options.rb +2 -2
- data/lib/plaid/models/liabilities_get_response.rb +2 -2
- data/lib/plaid/models/liabilities_object.rb +5 -5
- data/lib/plaid/models/liability_override.rb +5 -5
- data/lib/plaid/models/link_token_account_filters.rb +3 -3
- data/lib/plaid/models/link_token_create_credit_filter.rb +222 -0
- data/lib/plaid/models/link_token_create_depository_filter.rb +222 -0
- data/lib/plaid/models/link_token_create_institution_data.rb +220 -0
- data/lib/plaid/models/link_token_create_investment_filter.rb +222 -0
- data/lib/plaid/models/link_token_create_loan_filter.rb +222 -0
- data/lib/plaid/models/link_token_create_request.rb +56 -10
- data/lib/plaid/models/link_token_create_request_account_subtypes.rb +11 -23
- data/lib/plaid/models/link_token_create_request_auth.rb +2 -2
- data/lib/plaid/models/link_token_create_request_deposit_switch.rb +2 -2
- data/lib/plaid/models/link_token_create_request_income_verification.rb +59 -13
- data/lib/plaid/models/link_token_create_request_income_verification_bank_income.rb +220 -0
- data/lib/plaid/models/link_token_create_request_income_verification_payroll_income.rb +223 -0
- data/lib/plaid/models/link_token_create_request_payment_initiation.rb +23 -2
- data/lib/plaid/models/link_token_create_request_transfer.rb +220 -0
- data/lib/plaid/models/link_token_create_request_update.rb +222 -0
- data/lib/plaid/models/link_token_create_request_user.rb +10 -10
- data/lib/plaid/models/link_token_create_response.rb +3 -3
- data/lib/plaid/models/link_token_eu_config.rb +220 -0
- data/lib/plaid/models/link_token_get_metadata_response.rb +22 -3
- data/lib/plaid/models/link_token_get_request.rb +2 -2
- data/lib/plaid/models/link_token_get_response.rb +14 -4
- data/lib/plaid/models/loan_account_subtype.rb +49 -0
- data/lib/plaid/models/loan_filter.rb +4 -4
- data/lib/plaid/models/location.rb +4 -4
- data/lib/plaid/models/meta.rb +2 -2
- data/lib/plaid/models/mfa.rb +2 -2
- data/lib/plaid/models/mortgage_interest_rate.rb +2 -2
- data/lib/plaid/models/mortgage_liability.rb +25 -11
- data/lib/plaid/models/mortgage_property_address.rb +2 -2
- data/lib/plaid/models/net_pay.rb +274 -0
- data/lib/plaid/models/new_accounts_available_webhook.rb +249 -0
- data/lib/plaid/models/numbers.rb +2 -42
- data/lib/plaid/models/numbers_ach.rb +3 -3
- data/lib/plaid/models/{nullable_numbers_ach.rb → numbers_ach_nullable.rb} +7 -6
- data/lib/plaid/models/numbers_bacs.rb +2 -2
- data/lib/plaid/models/{nullable_numbers_bacs.rb → numbers_bacs_nullable.rb} +6 -5
- data/lib/plaid/models/numbers_eft.rb +2 -2
- data/lib/plaid/models/{nullable_numbers_eft.rb → numbers_eft_nullable.rb} +6 -5
- data/lib/plaid/models/numbers_international.rb +2 -2
- data/lib/plaid/models/{nullable_numbers_international.rb → numbers_international_nullable.rb} +6 -5
- data/lib/plaid/models/override_account_type.rb +43 -0
- data/lib/plaid/models/override_accounts.rb +34 -7
- data/lib/plaid/models/owner.rb +2 -2
- data/lib/plaid/models/owner_override.rb +2 -2
- data/lib/plaid/models/pay.rb +232 -0
- data/lib/plaid/models/pay_frequency.rb +4 -38
- data/lib/plaid/models/pay_frequency_value.rb +43 -0
- data/lib/plaid/models/pay_period_details.rb +99 -32
- data/lib/plaid/models/pay_stub_deductions_breakdown.rb +265 -0
- data/lib/plaid/models/pay_stub_deductions_total.rb +254 -0
- data/lib/plaid/models/pay_stub_distribution_breakdown.rb +287 -0
- data/lib/plaid/models/pay_stub_earnings_breakdown.rb +298 -0
- data/lib/plaid/models/pay_stub_earnings_total.rb +265 -0
- data/lib/plaid/models/pay_stub_pay_period_details.rb +314 -0
- data/lib/plaid/models/pay_stub_taxpayer_id.rb +232 -0
- data/lib/plaid/models/pay_stub_verification_attribute.rb +221 -0
- data/lib/plaid/models/payment_amount.rb +3 -38
- data/lib/plaid/models/payment_amount_currency.rb +39 -0
- data/lib/plaid/models/payment_channel.rb +40 -0
- data/lib/plaid/models/payment_consent_max_payment_amount.rb +246 -0
- data/lib/plaid/models/payment_consent_periodic_alignment.rb +39 -0
- data/lib/plaid/models/payment_consent_periodic_amount.rb +247 -0
- data/lib/plaid/models/payment_consent_periodic_amount_amount.rb +246 -0
- data/lib/plaid/models/payment_consent_periodic_interval.rb +41 -0
- data/lib/plaid/models/payment_consent_valid_date_time.rb +232 -0
- data/lib/plaid/models/payment_initiation_address.rb +119 -5
- data/lib/plaid/models/payment_initiation_consent.rb +357 -0
- data/lib/plaid/models/payment_initiation_consent_constraints.rb +241 -0
- data/lib/plaid/models/payment_initiation_consent_create_request.rb +373 -0
- data/lib/plaid/models/payment_initiation_consent_create_response.rb +254 -0
- data/lib/plaid/models/payment_initiation_consent_get_request.rb +266 -0
- data/lib/plaid/models/payment_initiation_consent_get_response.rb +380 -0
- data/lib/plaid/models/payment_initiation_consent_payment_execute_request.rb +325 -0
- data/lib/plaid/models/payment_initiation_consent_payment_execute_response.rb +254 -0
- data/lib/plaid/models/payment_initiation_consent_revoke_request.rb +266 -0
- data/lib/plaid/models/payment_initiation_consent_revoke_response.rb +220 -0
- data/lib/plaid/models/payment_initiation_consent_scope.rb +39 -0
- data/lib/plaid/models/payment_initiation_consent_status.rb +42 -0
- data/lib/plaid/models/payment_initiation_metadata.rb +18 -3
- data/lib/plaid/models/payment_initiation_optional_restriction_bacs.rb +55 -2
- data/lib/plaid/models/payment_initiation_payment.rb +55 -47
- data/lib/plaid/models/payment_initiation_payment_create_request.rb +54 -4
- data/lib/plaid/models/payment_initiation_payment_create_response.rb +3 -4
- data/lib/plaid/models/payment_initiation_payment_create_status.rb +38 -0
- data/lib/plaid/models/payment_initiation_payment_get_request.rb +23 -2
- data/lib/plaid/models/payment_initiation_payment_get_response.rb +56 -48
- data/lib/plaid/models/payment_initiation_payment_list_request.rb +12 -3
- data/lib/plaid/models/payment_initiation_payment_list_response.rb +2 -2
- data/lib/plaid/models/payment_initiation_payment_reverse_request.rb +266 -0
- data/lib/plaid/models/payment_initiation_payment_reverse_response.rb +254 -0
- data/lib/plaid/models/payment_initiation_payment_status.rb +50 -0
- data/lib/plaid/models/payment_initiation_payment_token_create_request.rb +23 -2
- data/lib/plaid/models/payment_initiation_payment_token_create_response.rb +3 -3
- data/lib/plaid/models/payment_initiation_recipient.rb +3 -3
- data/lib/plaid/models/payment_initiation_recipient_create_request.rb +50 -3
- data/lib/plaid/models/payment_initiation_recipient_create_response.rb +2 -2
- data/lib/plaid/models/payment_initiation_recipient_get_request.rb +23 -2
- data/lib/plaid/models/payment_initiation_recipient_get_response.rb +3 -3
- data/lib/plaid/models/payment_initiation_recipient_get_response_all_of.rb +2 -2
- data/lib/plaid/models/payment_initiation_recipient_list_request.rb +2 -2
- data/lib/plaid/models/payment_initiation_recipient_list_response.rb +2 -2
- data/lib/plaid/models/payment_initiation_refund.rb +268 -0
- data/lib/plaid/models/payment_initiation_refund_status.rb +41 -0
- data/lib/plaid/models/payment_initiation_standing_order_metadata.rb +17 -2
- data/lib/plaid/models/payment_meta.rb +2 -2
- data/lib/plaid/models/payment_schedule_interval.rb +6 -4
- data/lib/plaid/models/payment_scheme.rb +41 -0
- data/lib/plaid/models/payment_status_update_webhook.rb +8 -57
- data/lib/plaid/models/payroll_income_object.rb +255 -0
- data/lib/plaid/models/payroll_item.rb +251 -0
- data/lib/plaid/models/payroll_item_status.rb +221 -0
- data/lib/plaid/models/paystub.rb +90 -41
- data/lib/plaid/models/paystub_address.rb +298 -0
- data/lib/plaid/models/paystub_deduction.rb +3 -2
- data/lib/plaid/models/paystub_details.rb +264 -0
- data/lib/plaid/models/paystub_employer.rb +230 -0
- data/lib/plaid/models/paystub_override.rb +248 -0
- data/lib/plaid/models/paystub_override_employee.rb +229 -0
- data/lib/plaid/models/paystub_override_employee_address.rb +260 -0
- data/lib/plaid/models/paystub_override_employer.rb +220 -0
- data/lib/plaid/models/paystub_pay_frequency.rb +42 -0
- data/lib/plaid/models/paystub_verification.rb +236 -0
- data/lib/plaid/models/paystub_verification_status.rb +41 -0
- data/lib/plaid/models/paystub_ytd_details.rb +5 -12
- data/lib/plaid/models/pending_expiration_webhook.rb +4 -4
- data/lib/plaid/models/personal_finance_category.rb +240 -0
- data/lib/plaid/models/phone_number.rb +12 -4
- data/lib/plaid/models/plaid_error.rb +360 -0
- data/lib/plaid/models/platform_ids.rb +243 -0
- data/lib/plaid/models/processor_apex_processor_token_create_request.rb +2 -2
- data/lib/plaid/models/processor_auth_get_request.rb +2 -2
- data/lib/plaid/models/processor_auth_get_response.rb +2 -2
- data/lib/plaid/models/processor_balance_get_request.rb +15 -6
- data/lib/plaid/models/processor_balance_get_request_options.rb +220 -0
- data/lib/plaid/models/processor_balance_get_response.rb +2 -2
- data/lib/plaid/models/processor_bank_transfer_create_request.rb +459 -0
- data/lib/plaid/models/processor_bank_transfer_create_response.rb +239 -0
- data/lib/plaid/models/processor_identity_get_request.rb +2 -2
- data/lib/plaid/models/processor_identity_get_response.rb +2 -2
- data/lib/plaid/models/processor_number.rb +6 -6
- data/lib/plaid/models/processor_stripe_bank_account_token_create_request.rb +2 -2
- data/lib/plaid/models/processor_stripe_bank_account_token_create_response.rb +2 -2
- data/lib/plaid/models/processor_token_create_request.rb +37 -3
- data/lib/plaid/models/processor_token_create_response.rb +2 -2
- data/lib/plaid/models/product_access.rb +327 -0
- data/lib/plaid/models/product_status.rb +6 -6
- data/lib/plaid/models/product_status_breakdown.rb +2 -3
- data/lib/plaid/models/products.rb +10 -4
- data/lib/plaid/models/projected_income_summary_field_number.rb +3 -2
- data/lib/plaid/models/pslf_status.rb +4 -4
- data/lib/plaid/models/recaptcha_required_error.rb +2 -2
- data/lib/plaid/models/recipient_bacs.rb +55 -3
- data/lib/plaid/models/recipient_bacs_nullable.rb +289 -0
- data/lib/plaid/models/recurring_transaction_frequency.rb +42 -0
- data/lib/plaid/models/relay_event.rb +40 -0
- data/lib/plaid/models/removed_transaction.rb +220 -0
- data/lib/plaid/models/sandbox_bank_transfer_fire_webhook_request.rb +3 -3
- data/lib/plaid/models/sandbox_bank_transfer_fire_webhook_response.rb +3 -3
- data/lib/plaid/models/sandbox_bank_transfer_simulate_request.rb +3 -3
- data/lib/plaid/models/sandbox_bank_transfer_simulate_response.rb +3 -3
- data/lib/plaid/models/sandbox_income_fire_webhook_request.rb +309 -0
- data/lib/plaid/models/sandbox_income_fire_webhook_response.rb +225 -0
- data/lib/plaid/models/sandbox_item_fire_webhook_request.rb +15 -6
- data/lib/plaid/models/sandbox_item_fire_webhook_response.rb +2 -2
- data/lib/plaid/models/sandbox_item_reset_login_request.rb +2 -2
- data/lib/plaid/models/sandbox_item_reset_login_response.rb +2 -2
- data/lib/plaid/models/sandbox_item_set_verification_status_request.rb +2 -2
- data/lib/plaid/models/sandbox_item_set_verification_status_response.rb +2 -2
- data/lib/plaid/models/sandbox_oauth_select_accounts_request.rb +240 -0
- data/lib/plaid/models/sandbox_processor_token_create_request.rb +3 -2
- data/lib/plaid/models/sandbox_processor_token_create_request_options.rb +2 -2
- data/lib/plaid/models/sandbox_processor_token_create_response.rb +3 -2
- data/lib/plaid/models/sandbox_public_token_create_request.rb +2 -2
- data/lib/plaid/models/sandbox_public_token_create_request_options.rb +2 -2
- data/lib/plaid/models/sandbox_public_token_create_request_options_transactions.rb +5 -5
- data/lib/plaid/models/sandbox_public_token_create_response.rb +2 -2
- data/lib/plaid/models/sandbox_transfer_fire_webhook_request.rb +245 -0
- data/lib/plaid/models/sandbox_transfer_fire_webhook_response.rb +225 -0
- data/lib/plaid/models/sandbox_transfer_repayment_simulate_request.rb +230 -0
- data/lib/plaid/models/sandbox_transfer_repayment_simulate_response.rb +225 -0
- data/lib/plaid/models/sandbox_transfer_simulate_request.rb +270 -0
- data/lib/plaid/models/{income_verification_paystub_get_response.rb → sandbox_transfer_simulate_response.rb} +12 -16
- data/lib/plaid/models/sandbox_transfer_sweep_simulate_request.rb +230 -0
- data/lib/plaid/models/{income_verification_summary_get_response.rb → sandbox_transfer_sweep_simulate_response.rb} +13 -21
- data/lib/plaid/models/scopes.rb +243 -0
- data/lib/plaid/models/scopes_context.rb +39 -0
- data/lib/plaid/models/scopes_nullable.rb +250 -0
- data/lib/plaid/models/security.rb +4 -4
- data/lib/plaid/models/security_override.rb +270 -0
- data/lib/plaid/models/sender_bacs_nullable.rb +289 -0
- data/lib/plaid/models/servicer_address_data.rb +2 -2
- data/lib/plaid/models/signal_address_data.rb +263 -0
- data/lib/plaid/models/signal_decision_report_request.rb +318 -0
- data/lib/plaid/models/signal_decision_report_response.rb +225 -0
- data/lib/plaid/models/signal_device.rb +232 -0
- data/lib/plaid/models/signal_evaluate_core_attributes.rb +903 -0
- data/lib/plaid/models/signal_evaluate_request.rb +376 -0
- data/lib/plaid/models/signal_evaluate_response.rb +248 -0
- data/lib/plaid/models/signal_person_name.rb +265 -0
- data/lib/plaid/models/signal_return_report_request.rb +290 -0
- data/lib/plaid/models/signal_return_report_response.rb +225 -0
- data/lib/plaid/models/signal_scores.rb +228 -0
- data/lib/plaid/models/signal_user.rb +252 -0
- data/lib/plaid/models/simulated_transfer_sweep.rb +277 -0
- data/lib/plaid/models/standalone_account_type.rb +4 -4
- data/lib/plaid/models/standalone_currency_code_list.rb +2 -2
- data/lib/plaid/models/standalone_investment_transaction_type.rb +4 -4
- data/lib/plaid/models/student_loan.rb +35 -15
- data/lib/plaid/models/student_loan_repayment_model.rb +2 -2
- data/lib/plaid/models/student_loan_status.rb +4 -4
- data/lib/plaid/models/student_repayment_plan.rb +4 -4
- data/lib/plaid/models/taxform.rb +244 -0
- data/lib/plaid/models/taxpayer_id.rb +269 -0
- data/lib/plaid/models/total.rb +249 -0
- data/lib/plaid/models/total_canonical_description.rb +54 -0
- data/lib/plaid/models/transaction.rb +191 -130
- data/lib/plaid/models/transaction_all_of.rb +311 -0
- data/lib/plaid/models/transaction_base.rb +458 -0
- data/lib/plaid/models/transaction_code.rb +6 -4
- data/lib/plaid/models/transaction_data.rb +4 -4
- data/lib/plaid/models/transaction_override.rb +6 -6
- data/lib/plaid/models/transaction_stream.rb +430 -0
- data/lib/plaid/models/transaction_stream_amount.rb +242 -0
- data/lib/plaid/models/transaction_stream_status.rb +41 -0
- data/lib/plaid/models/transactions_category_rule.rb +259 -0
- data/lib/plaid/models/transactions_enhance_get_request.rb +262 -0
- data/lib/plaid/models/transactions_enhance_get_response.rb +227 -0
- data/lib/plaid/models/transactions_get_request.rb +2 -2
- data/lib/plaid/models/transactions_get_request_options.rb +43 -6
- data/lib/plaid/models/transactions_get_response.rb +2 -2
- data/lib/plaid/models/transactions_recurring_get_request.rb +271 -0
- data/lib/plaid/models/transactions_recurring_get_request_options.rb +222 -0
- data/lib/plaid/models/transactions_recurring_get_response.rb +274 -0
- data/lib/plaid/models/transactions_refresh_request.rb +2 -2
- data/lib/plaid/models/transactions_refresh_response.rb +2 -2
- data/lib/plaid/models/transactions_removed_webhook.rb +3 -4
- data/lib/plaid/models/transactions_rule_details.rb +253 -0
- data/lib/plaid/models/transactions_rule_field.rb +39 -0
- data/lib/plaid/models/transactions_rule_type.rb +39 -0
- data/lib/plaid/models/transactions_rules_create_request.rb +284 -0
- data/lib/plaid/models/transactions_rules_create_response.rb +239 -0
- data/lib/plaid/models/transactions_rules_list_request.rb +255 -0
- data/lib/plaid/models/transactions_rules_list_response.rb +242 -0
- data/lib/plaid/models/transactions_rules_remove_request.rb +270 -0
- data/lib/plaid/models/transactions_rules_remove_response.rb +225 -0
- data/lib/plaid/models/transactions_sync_request.rb +293 -0
- data/lib/plaid/models/transactions_sync_response.rb +306 -0
- data/lib/plaid/models/transfer.rb +462 -0
- data/lib/plaid/models/transfer_authorization.rb +298 -0
- data/lib/plaid/models/transfer_authorization_create_request.rb +360 -0
- data/lib/plaid/models/transfer_authorization_create_response.rb +239 -0
- data/lib/plaid/models/transfer_authorization_decision.rb +39 -0
- data/lib/plaid/models/transfer_authorization_decision_rationale.rb +239 -0
- data/lib/plaid/models/transfer_authorization_decision_rationale_code.rb +42 -0
- data/lib/plaid/models/transfer_authorization_device.rb +230 -0
- data/lib/plaid/models/transfer_authorization_guarantee_decision.rb +40 -0
- data/lib/plaid/models/transfer_authorization_guarantee_decision_rationale.rb +239 -0
- data/lib/plaid/models/transfer_authorization_guarantee_decision_rationale_code.rb +41 -0
- data/lib/plaid/models/transfer_authorization_proposed_transfer.rb +327 -0
- data/lib/plaid/models/transfer_cancel_request.rb +245 -0
- data/lib/plaid/models/transfer_cancel_response.rb +225 -0
- data/lib/plaid/models/transfer_create_request.rb +452 -0
- data/lib/plaid/models/transfer_create_response.rb +239 -0
- data/lib/plaid/models/transfer_event.rb +377 -0
- data/lib/plaid/models/transfer_event_list_request.rb +386 -0
- data/lib/plaid/models/transfer_event_list_response.rb +241 -0
- data/lib/plaid/models/transfer_event_list_transfer_type.rb +40 -0
- data/lib/plaid/models/transfer_event_sync_request.rb +305 -0
- data/lib/plaid/models/transfer_event_sync_response.rb +241 -0
- data/lib/plaid/models/transfer_event_type.rb +44 -0
- data/lib/plaid/models/transfer_events_update_webhook.rb +240 -0
- data/lib/plaid/models/transfer_failure.rb +231 -0
- data/lib/plaid/models/transfer_get_request.rb +245 -0
- data/lib/plaid/models/transfer_get_response.rb +239 -0
- data/lib/plaid/models/transfer_intent_authorization_decision.rb +39 -0
- data/lib/plaid/models/transfer_intent_create.rb +389 -0
- data/lib/plaid/models/transfer_intent_create_mode.rb +39 -0
- data/lib/plaid/models/transfer_intent_create_request.rb +396 -0
- data/lib/plaid/models/transfer_intent_create_response.rb +239 -0
- data/lib/plaid/models/transfer_intent_get.rb +430 -0
- data/lib/plaid/models/transfer_intent_get_failure_reason.rb +240 -0
- data/lib/plaid/models/transfer_intent_get_request.rb +255 -0
- data/lib/plaid/models/transfer_intent_get_response.rb +239 -0
- data/lib/plaid/models/transfer_intent_status.rb +40 -0
- data/lib/plaid/models/transfer_list_request.rb +330 -0
- data/lib/plaid/models/transfer_list_response.rb +241 -0
- data/lib/plaid/models/transfer_migrate_account_request.rb +285 -0
- data/lib/plaid/models/transfer_migrate_account_response.rb +255 -0
- data/lib/plaid/models/transfer_network.rb +39 -0
- data/lib/plaid/models/transfer_repayment.rb +270 -0
- data/lib/plaid/models/transfer_repayment_list_request.rb +320 -0
- data/lib/plaid/models/transfer_repayment_list_response.rb +241 -0
- data/lib/plaid/models/transfer_repayment_return.rb +291 -0
- data/lib/plaid/models/transfer_repayment_return_list_request.rb +313 -0
- data/lib/plaid/models/transfer_repayment_return_list_response.rb +241 -0
- data/lib/plaid/models/transfer_status.rb +42 -0
- data/lib/plaid/models/transfer_sweep.rb +270 -0
- data/lib/plaid/models/transfer_sweep_get_request.rb +245 -0
- data/lib/plaid/models/transfer_sweep_get_response.rb +239 -0
- data/lib/plaid/models/transfer_sweep_list_request.rb +320 -0
- data/lib/plaid/models/transfer_sweep_list_response.rb +241 -0
- data/lib/plaid/models/transfer_sweep_status.rb +41 -0
- data/lib/plaid/models/transfer_type.rb +39 -0
- data/lib/plaid/models/transfer_user_address_in_request.rb +260 -0
- data/lib/plaid/models/transfer_user_address_in_response.rb +265 -0
- data/lib/plaid/models/transfer_user_in_request.rb +254 -0
- data/lib/plaid/models/transfer_user_in_response.rb +257 -0
- data/lib/plaid/models/user_create_request.rb +245 -0
- data/lib/plaid/models/user_create_response.rb +254 -0
- data/lib/plaid/models/user_custom_password.rb +2 -2
- data/lib/plaid/models/user_permission_revoked_webhook.rb +3 -4
- data/lib/plaid/models/{bank_transfer_receiver_details.rb → verification_attribute.rb} +23 -23
- data/lib/plaid/models/verification_expired_webhook.rb +3 -3
- data/lib/plaid/models/verification_refresh_status.rb +40 -0
- data/lib/plaid/models/verification_status.rb +6 -4
- data/lib/plaid/models/w2.rb +437 -0
- data/lib/plaid/models/{income_verification_documents_download_response.rb → w2_box12.rb} +26 -18
- data/lib/plaid/models/w2_state_and_local_wages.rb +287 -0
- data/lib/plaid/models/wallet_balance.rb +240 -0
- data/lib/plaid/models/wallet_get_request.rb +266 -0
- data/lib/plaid/models/wallet_get_response.rb +259 -0
- data/lib/plaid/models/{nullable_access_token.rb → wallet_numbers.rb} +18 -7
- data/lib/plaid/models/wallet_transaction.rb +346 -0
- data/lib/plaid/models/wallet_transaction_amount.rb +306 -0
- data/lib/plaid/models/wallet_transaction_counterparty.rb +260 -0
- data/lib/plaid/models/wallet_transaction_counterparty_bacs.rb +289 -0
- data/lib/plaid/models/wallet_transaction_counterparty_numbers.rb +224 -0
- data/lib/plaid/models/wallet_transaction_execute_request.rb +384 -0
- data/lib/plaid/models/wallet_transaction_execute_response.rb +254 -0
- data/lib/plaid/models/wallet_transaction_status.rb +41 -0
- data/lib/plaid/models/wallet_transactions_list_request.rb +331 -0
- data/lib/plaid/models/wallet_transactions_list_response.rb +252 -0
- data/lib/plaid/models/warning.rb +36 -2
- data/lib/plaid/models/webhook_type.rb +43 -0
- data/lib/plaid/models/webhook_update_acknowledged_webhook.rb +3 -4
- data/lib/plaid/models/webhook_verification_key_get_request.rb +2 -2
- data/lib/plaid/models/webhook_verification_key_get_response.rb +2 -2
- data/lib/plaid/models/ytd_gross_income_summary_field_number.rb +3 -2
- data/lib/plaid/models/ytd_net_income_summary_field_number.rb +3 -2
- data/lib/plaid/version.rb +3 -3
- data/lib/plaid.rb +344 -19
- data/plaid.gemspec +2 -2
- data/templates/ruby/api_client.mustache +3 -2
- data/templates/ruby/api_client_faraday_partial.mustache +2 -1
- data/templates/ruby/api_error.mustache +49 -0
- data/templates/ruby/configuration.mustache +6 -4
- data/templates/ruby/partial_model_enum_class.mustache +22 -0
- data/test/test_accounts.rb +4 -8
- data/test/test_asset_report.rb +1 -1
- data/test/test_bank_transfers.rb +1 -1
- data/test/test_item.rb +0 -10
- data/test/test_payment_initiation.rb +1 -1
- data/test/test_processor.rb +1 -16
- metadata +349 -24
- data/PUBLISH.md +0 -19
- data/lib/plaid/models/standalone_investment_transaction_subtype.rb +0 -650
- data/pkg/plaid-14.2.0.gem +0 -0
data/README.md
CHANGED
@@ -1,6 +1,6 @@
|
|
1
1
|
# plaid-ruby [![Circle CI](https://circleci.com/gh/plaid/plaid-ruby.svg?style=svg&circle-token=30ee002ac2021da5b5b5a701d45fe2888af124a5)](https://circleci.com/gh/plaid/plaid-ruby) [![Gem Version](https://badge.fury.io/rb/plaid.svg)](http://badge.fury.io/rb/plaid)
|
2
2
|
|
3
|
-
The official Ruby bindings for the [Plaid API](https://plaid.com/docs).
|
3
|
+
The official Ruby bindings for the [Plaid API](https://plaid.com/docs). It's generated from our [OpenAPI schema](https://github.com/plaid/plaid-openapi).
|
4
4
|
|
5
5
|
## Installation
|
6
6
|
|
@@ -16,12 +16,14 @@ And then execute:
|
|
16
16
|
|
17
17
|
Or install it yourself as:
|
18
18
|
|
19
|
-
$ gem install plaid
|
19
|
+
$ gem install plaid
|
20
20
|
|
21
21
|
The gem supports Ruby 2.4.0+ only.
|
22
22
|
|
23
23
|
### Versioning
|
24
24
|
|
25
|
+
Versions > 14 are generated from our OpenAPI schema. For previous non-generated versions, check out [13.2.0](https://github.com/plaid/plaid-ruby/releases/tag/v13.2.0).
|
26
|
+
|
25
27
|
Each major version of `plaid-ruby` targets a specific version of the Plaid API:
|
26
28
|
|
27
29
|
| API version | plaid-ruby release |
|
@@ -33,6 +35,7 @@ Each major version of `plaid-ruby` targets a specific version of the Plaid API:
|
|
33
35
|
|
34
36
|
For information about what has changed between versions and how to update your integration, head to the [version changelog][version-changelog].
|
35
37
|
|
38
|
+
The plaid-ruby client library is typically updated on a monthly basis. The canonical source for the latest version number is the [client library changelog](https://github.com/plaid/plaid-ruby/blob/master/CHANGELOG.md).
|
36
39
|
|
37
40
|
## Usage
|
38
41
|
|
@@ -49,7 +52,6 @@ configuration = Plaid::Configuration.new
|
|
49
52
|
configuration.server_index = Plaid::Configuration::Environment["sandbox"]
|
50
53
|
configuration.api_key["PLAID-CLIENT-ID"] = "***"
|
51
54
|
configuration.api_key["PLAID-SECRET"] = "***"
|
52
|
-
configuration.api_key["Plaid-Version"] = "2020-09-14"
|
53
55
|
|
54
56
|
api_client = Plaid::ApiClient.new(
|
55
57
|
configuration
|
@@ -76,6 +78,10 @@ client = Plaid::Configuration.new do |builder|
|
|
76
78
|
builder.options[:timeout] = 60*20 # 20 minutes
|
77
79
|
end
|
78
80
|
```
|
81
|
+
## Data type differences from API and from previous versions
|
82
|
+
|
83
|
+
### Dates
|
84
|
+
Dates and date times in requests and responses, which are represented as strings in the API and in previous client library versions, are represented in this version of the library as Ruby `Date` or `DateTime` objects.
|
79
85
|
|
80
86
|
## Examples
|
81
87
|
|
@@ -114,7 +120,7 @@ An example of the function's usage if you have a `public_token` in hand:
|
|
114
120
|
request = Plaid::ItemPublicTokenExchangeRequest.new
|
115
121
|
request.public_token = public_token
|
116
122
|
|
117
|
-
response = client.
|
123
|
+
response = client.item_public_token_exchange(request)
|
118
124
|
access_token = response.access_token
|
119
125
|
```
|
120
126
|
|
@@ -124,7 +130,7 @@ access_token = response.access_token
|
|
124
130
|
request = Plaid::ItemPublicTokenExchangeRequest.new
|
125
131
|
request.public_token = public_token
|
126
132
|
|
127
|
-
response = client.
|
133
|
+
response = client.item_public_token_exchange(request)
|
128
134
|
access_token = response.access_token
|
129
135
|
|
130
136
|
# Provide the access_token for the Item you want to remove
|
@@ -139,7 +145,7 @@ client.item_remove(item_remove_request)
|
|
139
145
|
request = Plaid::ItemPublicTokenExchangeRequest.new
|
140
146
|
request.public_token = public_token
|
141
147
|
|
142
|
-
response = client.
|
148
|
+
response = client.item_public_token_exchange(request)
|
143
149
|
access_token = response.access_token
|
144
150
|
|
145
151
|
transactions_get_request = Plaid::TransactionsGetRequest.new
|
@@ -152,7 +158,7 @@ transactions = transaction_response.transactions
|
|
152
158
|
|
153
159
|
# the transactions in the response are paginated, so make multiple calls while
|
154
160
|
# increasing the offset to retrieve all transactions
|
155
|
-
while transactions.length < transaction_response
|
161
|
+
while transactions.length < transaction_response.total_transactions
|
156
162
|
options_payload = {}
|
157
163
|
options_payload[:offset] = transactions.length
|
158
164
|
|
@@ -160,6 +166,7 @@ while transactions.length < transaction_response['total_transactions']
|
|
160
166
|
transactions_get_request.access_token = access_token
|
161
167
|
transactions_get_request.start_date = "2020-01-01"
|
162
168
|
transactions_get_request.end_date = "2021-01-01"
|
169
|
+
transactions_get_request.options = options_payload
|
163
170
|
|
164
171
|
transaction_response = client.transactions_get(transactions_get_request)
|
165
172
|
transactions += transaction_response.transactions
|
@@ -174,25 +181,26 @@ If you have an `access_token`, you can use following code to retreive data:
|
|
174
181
|
request = Plaid::ItemPublicTokenExchangeRequest.new
|
175
182
|
request.public_token = public_token
|
176
183
|
|
177
|
-
response = client.
|
184
|
+
response = client.item_public_token_exchange(request)
|
178
185
|
access_token = response.access_token
|
179
186
|
|
180
187
|
auth_get_request = Plaid::AuthGetRequest.new
|
181
188
|
auth_get_request.access_token = access_token
|
182
189
|
|
183
|
-
auth_response = client.auth_get(
|
190
|
+
auth_response = client.auth_get(auth_get_request)
|
184
191
|
auth = auth_response.auth
|
185
192
|
```
|
186
193
|
|
187
194
|
There are also a number of other methods you can use to retrieve data:
|
188
195
|
|
189
|
-
* `client.accounts_get(Plaid::AccountsGetRequest({:access_token => access_token, ...}))`: accounts
|
190
|
-
* `client.accounts_balance_get(Plaid::AccountsBalanceGetRequest({:access_token => access_token, ...}))`: real-time balances
|
191
|
-
* `client.auth_get(Plaid::AuthGetRequest({:access_token => access_token, ...}))`: auth
|
192
|
-
* `client.identity_get(Plaid::IdentityGetRequest({:access_token => access_token, ...}))`: identity
|
193
|
-
* `client.transactions_get(Plaid::TransactionsGetRequest({:access_token => access_token, ...}))`: transactions
|
194
|
-
* `client.investments_transactions_get(Plaid::InvestmentsTransactionsGetRequest({:access_token => access_token, ...}))`: investment-account transactions
|
195
|
-
* `client.investments_holdings_get(Plaid::InvestmentsHoldingsGetRequest({:access_token => access_token, ...}))`: investment-account holdings
|
196
|
+
* `client.accounts_get(Plaid::AccountsGetRequest.new({:access_token => access_token, ...}))`: accounts
|
197
|
+
* `client.accounts_balance_get(Plaid::AccountsBalanceGetRequest.new({:access_token => access_token, ...}))`: real-time balances
|
198
|
+
* `client.auth_get(Plaid::AuthGetRequest.new({:access_token => access_token, ...}))`: auth
|
199
|
+
* `client.identity_get(Plaid::IdentityGetRequest.new({:access_token => access_token, ...}))`: identity
|
200
|
+
* `client.transactions_get(Plaid::TransactionsGetRequest.new({:access_token => access_token, ...}))`: transactions
|
201
|
+
* `client.investments_transactions_get(Plaid::InvestmentsTransactionsGetRequest.new({:access_token => access_token, ...}))`: investment-account transactions
|
202
|
+
* `client.investments_holdings_get(Plaid::InvestmentsHoldingsGetRequest.new({:access_token => access_token, ...}))`: investment-account holdings
|
203
|
+
|
196
204
|
|
197
205
|
All of these methods return appropriate data. More information can be found on the [API documentation](https://plaid.com/docs/api).
|
198
206
|
|
@@ -203,7 +211,7 @@ Exchange a Plaid Link `public_token` for an API `access_token` and a Stripe `ban
|
|
203
211
|
request = Plaid::ItemPublicTokenExchangeRequest.new
|
204
212
|
request.public_token = public_token
|
205
213
|
|
206
|
-
response = client.
|
214
|
+
response = client.item_public_token_exchange(request)
|
207
215
|
access_token = response.access_token
|
208
216
|
|
209
217
|
processor_token_create_request = Plaid::ProcessorStripeBankAccountTokenCreateRequest.new
|
@@ -248,14 +256,13 @@ Read more about response codes and their meaning in the
|
|
248
256
|
|
249
257
|
## Response Objects
|
250
258
|
|
251
|
-
|
252
|
-
(`response.foo.bar`)
|
253
|
-
and `response['foo']['bar']`. Expected keys for all types of responses are defined,
|
259
|
+
All API calls return a response object that is accessible only with dot notation
|
260
|
+
(i.e., `response.foo.bar`) and not with bracket notation. Expected keys for all types of responses are defined,
|
254
261
|
and any attempt to access an unknown key will cause `NoMethodError` exception.
|
255
262
|
|
256
263
|
## Contributing
|
257
264
|
|
258
|
-
Bug reports
|
265
|
+
Bug reports are welcome on GitHub at https://github.com/plaid/plaid-ruby. See also [contributing guidelines](CONTRIBUTING.md). As the library is auto-generated, pull requests are automatically closed.
|
259
266
|
|
260
267
|
## License
|
261
268
|
|