plaid 15.1.0 → 15.4.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 +170 -0
- data/Gemfile.lock +1 -1
- data/Makefile +1 -1
- data/README.md +6 -7
- data/lib/plaid/api/plaid_api.rb +615 -30
- data/lib/plaid/api_client.rb +16 -9
- data/lib/plaid/api_error.rb +2 -2
- data/lib/plaid/configuration.rb +2 -2
- data/lib/plaid/models/account_access.rb +2 -2
- data/lib/plaid/models/account_assets.rb +2 -2
- data/lib/plaid/models/account_assets_all_of.rb +2 -2
- data/lib/plaid/models/account_balance.rb +2 -2
- data/lib/plaid/models/account_base.rb +2 -2
- data/lib/plaid/models/account_filter.rb +2 -2
- data/lib/plaid/models/account_filters_response.rb +2 -2
- data/lib/plaid/models/account_identity.rb +2 -2
- data/lib/plaid/models/account_identity_all_of.rb +2 -2
- data/lib/plaid/models/account_product_access.rb +2 -2
- data/lib/plaid/models/account_product_access_nullable.rb +2 -2
- data/lib/plaid/models/account_selection_cardinality.rb +2 -2
- data/lib/plaid/models/account_subtype.rb +2 -2
- data/lib/plaid/models/account_type.rb +2 -2
- data/lib/plaid/models/accounts_balance_get_request.rb +2 -2
- data/lib/plaid/models/accounts_balance_get_request_options.rb +2 -2
- 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 +2 -2
- data/lib/plaid/models/address.rb +2 -2
- data/lib/plaid/models/address_data.rb +2 -2
- data/lib/plaid/models/address_data_nullable.rb +2 -2
- data/lib/plaid/models/address_nullable.rb +2 -2
- data/lib/plaid/models/application.rb +73 -7
- data/lib/plaid/models/application_get_request.rb +2 -2
- data/lib/plaid/models/application_get_response.rb +2 -2
- data/lib/plaid/models/apr.rb +2 -2
- data/lib/plaid/models/asset_report.rb +2 -2
- 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 +2 -2
- data/lib/plaid/models/asset_report_create_request_options.rb +2 -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 +2 -2
- data/lib/plaid/models/asset_report_get_response.rb +2 -2
- data/lib/plaid/models/asset_report_item.rb +2 -2
- data/lib/plaid/models/asset_report_pdf_get_request.rb +2 -2
- data/lib/plaid/models/asset_report_refresh_request.rb +2 -2
- data/lib/plaid/models/asset_report_refresh_request_options.rb +2 -2
- data/lib/plaid/models/asset_report_refresh_response.rb +2 -2
- data/lib/plaid/models/asset_report_relay_create_request.rb +2 -2
- data/lib/plaid/models/asset_report_relay_create_response.rb +2 -2
- data/lib/plaid/models/asset_report_relay_get_request.rb +2 -2
- data/lib/plaid/models/asset_report_relay_refresh_request.rb +2 -2
- data/lib/plaid/models/asset_report_relay_refresh_response.rb +2 -2
- data/lib/plaid/models/asset_report_relay_remove_request.rb +2 -2
- data/lib/plaid/models/asset_report_relay_remove_response.rb +2 -2
- 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 +2 -2
- data/lib/plaid/models/asset_report_transaction_all_of.rb +2 -2
- data/lib/plaid/models/asset_report_user.rb +2 -2
- data/lib/plaid/models/assets_error_webhook.rb +2 -2
- data/lib/plaid/models/assets_product_ready_webhook.rb +2 -2
- data/lib/plaid/models/assets_relay_webhook.rb +2 -2
- data/lib/plaid/models/auth_get_numbers.rb +2 -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 +2 -2
- data/lib/plaid/models/auth_supported_methods.rb +2 -2
- data/lib/plaid/models/automatically_verified_webhook.rb +2 -2
- data/lib/plaid/models/bank_initiated_return_risk.rb +2 -2
- data/lib/plaid/models/bank_transfer.rb +2 -2
- data/lib/plaid/models/bank_transfer_balance.rb +2 -2
- data/lib/plaid/models/bank_transfer_balance_get_request.rb +2 -2
- data/lib/plaid/models/bank_transfer_balance_get_response.rb +2 -2
- data/lib/plaid/models/bank_transfer_cancel_request.rb +2 -2
- data/lib/plaid/models/bank_transfer_cancel_response.rb +2 -2
- data/lib/plaid/models/bank_transfer_create_request.rb +2 -2
- data/lib/plaid/models/bank_transfer_create_response.rb +2 -2
- data/lib/plaid/models/bank_transfer_direction.rb +2 -2
- data/lib/plaid/models/bank_transfer_event.rb +2 -2
- data/lib/plaid/models/bank_transfer_event_list_bank_transfer_type.rb +2 -2
- data/lib/plaid/models/bank_transfer_event_list_direction.rb +2 -2
- data/lib/plaid/models/bank_transfer_event_list_request.rb +2 -2
- data/lib/plaid/models/bank_transfer_event_list_response.rb +2 -2
- data/lib/plaid/models/bank_transfer_event_sync_request.rb +2 -2
- data/lib/plaid/models/bank_transfer_event_sync_response.rb +2 -2
- data/lib/plaid/models/bank_transfer_event_type.rb +2 -2
- data/lib/plaid/models/bank_transfer_failure.rb +2 -2
- data/lib/plaid/models/bank_transfer_get_request.rb +2 -2
- data/lib/plaid/models/bank_transfer_get_response.rb +2 -2
- data/lib/plaid/models/bank_transfer_list_request.rb +2 -2
- data/lib/plaid/models/bank_transfer_list_response.rb +2 -2
- data/lib/plaid/models/bank_transfer_migrate_account_request.rb +13 -3
- data/lib/plaid/models/bank_transfer_migrate_account_response.rb +2 -2
- data/lib/plaid/models/bank_transfer_network.rb +2 -2
- data/lib/plaid/models/bank_transfer_status.rb +2 -2
- data/lib/plaid/models/bank_transfer_sweep.rb +2 -2
- data/lib/plaid/models/bank_transfer_sweep_get_request.rb +2 -2
- data/lib/plaid/models/bank_transfer_sweep_get_response.rb +2 -2
- data/lib/plaid/models/bank_transfer_sweep_list_request.rb +2 -2
- data/lib/plaid/models/bank_transfer_sweep_list_response.rb +2 -2
- data/lib/plaid/models/bank_transfer_type.rb +2 -2
- data/lib/plaid/models/bank_transfer_user.rb +2 -2
- 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 -19
- data/lib/plaid/models/cause_all_of.rb +219 -0
- data/lib/plaid/models/client_provided_enhanced_transaction.rb +2 -2
- data/lib/plaid/models/client_provided_raw_transaction.rb +2 -2
- data/lib/plaid/models/connected_application.rb +7 -95
- data/lib/plaid/models/country_code.rb +2 -2
- data/lib/plaid/models/credit_account_subtype.rb +2 -2
- data/lib/plaid/models/credit_bank_income.rb +2 -2
- data/lib/plaid/models/credit_bank_income_account.rb +2 -2
- data/lib/plaid/models/credit_bank_income_account_type.rb +2 -2
- data/lib/plaid/models/credit_bank_income_category.rb +2 -2
- data/lib/plaid/models/credit_bank_income_cause.rb +2 -2
- data/lib/plaid/models/credit_bank_income_error_type.rb +2 -2
- data/lib/plaid/models/credit_bank_income_get_request.rb +2 -2
- data/lib/plaid/models/credit_bank_income_get_request_options.rb +2 -2
- data/lib/plaid/models/credit_bank_income_get_response.rb +2 -2
- data/lib/plaid/models/credit_bank_income_historical_summary.rb +2 -2
- data/lib/plaid/models/credit_bank_income_item.rb +2 -2
- data/lib/plaid/models/credit_bank_income_pay_frequency.rb +2 -2
- data/lib/plaid/models/credit_bank_income_refresh_request.rb +264 -0
- data/lib/plaid/models/credit_bank_income_refresh_request_options.rb +230 -0
- data/lib/plaid/models/credit_bank_income_refresh_response.rb +225 -0
- data/lib/plaid/models/credit_bank_income_source.rb +2 -2
- data/lib/plaid/models/credit_bank_income_summary.rb +2 -2
- data/lib/plaid/models/credit_bank_income_transaction.rb +2 -2
- data/lib/plaid/models/credit_bank_income_warning.rb +2 -2
- data/lib/plaid/models/credit_bank_income_warning_code.rb +3 -2
- data/lib/plaid/models/credit_bank_income_warning_type.rb +2 -2
- data/lib/plaid/models/credit_card_liability.rb +2 -2
- 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 +255 -0
- data/lib/plaid/models/credit_employment_get_response.rb +242 -0
- data/lib/plaid/models/{requested_scopes.rb → credit_employment_item.rb} +30 -22
- data/lib/plaid/models/credit_employment_verification.rb +293 -0
- data/lib/plaid/models/credit_filter.rb +2 -2
- 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/credit_pay_stub_employer.rb +235 -0
- 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_payroll_income_refresh_request.rb +240 -0
- data/lib/plaid/models/credit_payroll_income_refresh_response.rb +240 -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 +2 -2
- data/lib/plaid/models/deductions.rb +2 -2
- data/lib/plaid/models/deductions_breakdown.rb +2 -2
- data/lib/plaid/models/deductions_total.rb +2 -2
- data/lib/plaid/models/default_update_webhook.rb +2 -2
- data/lib/plaid/models/deposit_switch_address_data.rb +2 -2
- data/lib/plaid/models/deposit_switch_alt_create_request.rb +2 -2
- data/lib/plaid/models/deposit_switch_alt_create_response.rb +2 -2
- data/lib/plaid/models/deposit_switch_create_request.rb +2 -2
- data/lib/plaid/models/deposit_switch_create_request_options.rb +2 -2
- 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 +2 -2
- data/lib/plaid/models/deposit_switch_state_update_webhook.rb +2 -2
- data/lib/plaid/models/deposit_switch_target_account.rb +2 -2
- data/lib/plaid/models/deposit_switch_target_user.rb +2 -2
- data/lib/plaid/models/deposit_switch_token_create_request.rb +2 -2
- data/lib/plaid/models/deposit_switch_token_create_response.rb +2 -2
- data/lib/plaid/models/depository_account_subtype.rb +2 -2
- data/lib/plaid/models/depository_filter.rb +2 -2
- data/lib/plaid/models/distribution_breakdown.rb +2 -2
- data/lib/plaid/models/doc_type.rb +2 -2
- data/lib/plaid/models/document_metadata.rb +2 -2
- data/lib/plaid/models/earnings.rb +2 -2
- data/lib/plaid/models/earnings_breakdown.rb +2 -2
- data/lib/plaid/models/earnings_breakdown_canonical_description.rb +2 -2
- data/lib/plaid/models/earnings_total.rb +2 -2
- data/lib/plaid/models/email.rb +2 -2
- data/lib/plaid/models/employee.rb +2 -2
- data/lib/plaid/models/employee_income_summary_field_string.rb +2 -2
- data/lib/plaid/models/employer.rb +2 -2
- data/lib/plaid/models/employer_income_summary_field_string.rb +2 -2
- data/lib/plaid/models/employer_verification.rb +2 -2
- 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 +2 -2
- data/lib/plaid/models/employment_verification.rb +2 -2
- data/lib/plaid/models/employment_verification_get_request.rb +2 -2
- data/lib/plaid/models/employment_verification_get_response.rb +2 -2
- data/lib/plaid/models/employment_verification_status.rb +2 -2
- data/lib/plaid/models/enhancements.rb +4 -4
- data/lib/plaid/models/error.rb +2 -2
- data/lib/plaid/models/external_payment_initiation_consent_options.rb +2 -2
- data/lib/plaid/models/external_payment_options.rb +2 -2
- data/lib/plaid/models/external_payment_refund_details.rb +2 -2
- data/lib/plaid/models/external_payment_schedule_base.rb +2 -2
- data/lib/plaid/models/external_payment_schedule_get.rb +2 -2
- data/lib/plaid/models/external_payment_schedule_request.rb +2 -2
- data/lib/plaid/models/health_incident.rb +2 -2
- data/lib/plaid/models/historical_balance.rb +2 -2
- data/lib/plaid/models/historical_update_webhook.rb +2 -2
- data/lib/plaid/models/holding.rb +2 -2
- data/lib/plaid/models/holdings_default_update_webhook.rb +2 -2
- data/lib/plaid/models/holdings_override.rb +2 -2
- data/lib/plaid/models/identity_default_update_webhook.rb +2 -2
- 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 +2 -2
- data/lib/plaid/models/incident_update.rb +2 -2
- data/lib/plaid/models/income_breakdown.rb +2 -2
- data/lib/plaid/models/income_breakdown_type.rb +2 -2
- data/lib/plaid/models/income_override.rb +2 -2
- data/lib/plaid/models/income_summary.rb +2 -2
- data/lib/plaid/models/income_summary_field_number.rb +2 -2
- data/lib/plaid/models/income_summary_field_string.rb +2 -2
- data/lib/plaid/models/income_verification_create_request.rb +2 -2
- data/lib/plaid/models/income_verification_create_request_options.rb +2 -2
- data/lib/plaid/models/income_verification_create_response.rb +2 -2
- data/lib/plaid/models/income_verification_documents_download_request.rb +2 -2
- data/lib/plaid/models/income_verification_payroll_flow_type.rb +2 -2
- data/lib/plaid/models/income_verification_paystubs_get_request.rb +2 -2
- data/lib/plaid/models/income_verification_paystubs_get_response.rb +2 -2
- data/lib/plaid/models/income_verification_precheck_confidence.rb +2 -2
- data/lib/plaid/models/income_verification_precheck_employer.rb +2 -2
- data/lib/plaid/models/income_verification_precheck_employer_address.rb +26 -26
- data/lib/plaid/models/income_verification_precheck_employer_address_data.rb +26 -26
- data/lib/plaid/models/income_verification_precheck_military_info.rb +2 -2
- data/lib/plaid/models/income_verification_precheck_request.rb +2 -2
- data/lib/plaid/models/income_verification_precheck_response.rb +2 -2
- data/lib/plaid/models/income_verification_precheck_user.rb +2 -2
- data/lib/plaid/models/income_verification_refresh_request.rb +2 -2
- data/lib/plaid/models/income_verification_refresh_response.rb +2 -2
- data/lib/plaid/models/income_verification_source_type.rb +2 -2
- data/lib/plaid/models/income_verification_status_webhook.rb +4 -19
- data/lib/plaid/models/income_verification_taxforms_get_request.rb +2 -2
- data/lib/plaid/models/income_verification_taxforms_get_response.rb +2 -2
- data/lib/plaid/models/income_verification_webhook_status.rb +2 -2
- data/lib/plaid/models/inflow_model.rb +2 -2
- data/lib/plaid/models/initial_update_webhook.rb +2 -2
- data/lib/plaid/models/institution.rb +2 -2
- data/lib/plaid/models/institution_status.rb +2 -22
- data/lib/plaid/models/institutions_get_by_id_request.rb +2 -2
- data/lib/plaid/models/institutions_get_by_id_request_options.rb +2 -2
- data/lib/plaid/models/institutions_get_by_id_response.rb +2 -2
- data/lib/plaid/models/institutions_get_request.rb +2 -2
- data/lib/plaid/models/institutions_get_request_options.rb +2 -2
- data/lib/plaid/models/institutions_get_response.rb +2 -2
- data/lib/plaid/models/institutions_search_account_filter.rb +2 -2
- data/lib/plaid/models/institutions_search_payment_initiation_options.rb +18 -7
- data/lib/plaid/models/institutions_search_request.rb +2 -2
- data/lib/plaid/models/institutions_search_request_options.rb +2 -2
- data/lib/plaid/models/institutions_search_response.rb +2 -2
- data/lib/plaid/models/investment_account_subtype.rb +2 -2
- data/lib/plaid/models/investment_filter.rb +2 -2
- data/lib/plaid/models/investment_holdings_get_request_options.rb +2 -2
- data/lib/plaid/models/investment_transaction.rb +2 -2
- data/lib/plaid/models/investment_transaction_subtype.rb +2 -2
- data/lib/plaid/models/investment_transaction_type.rb +2 -2
- data/lib/plaid/models/investments_default_update_webhook.rb +2 -2
- 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 +2 -2
- data/lib/plaid/models/item.rb +4 -4
- 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 +2 -2
- data/lib/plaid/models/item_application_list_response.rb +2 -2
- data/lib/plaid/models/item_application_list_user_auth.rb +2 -2
- data/lib/plaid/models/item_application_scopes_update_request.rb +2 -2
- data/lib/plaid/models/item_application_scopes_update_response.rb +2 -2
- data/lib/plaid/models/item_error_webhook.rb +2 -2
- data/lib/plaid/models/item_get_request.rb +2 -2
- data/lib/plaid/models/item_get_response.rb +2 -2
- 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 +2 -2
- 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 +2 -2
- data/lib/plaid/models/item_status_investments.rb +2 -2
- data/lib/plaid/models/item_status_last_webhook.rb +2 -2
- data/lib/plaid/models/item_status_nullable.rb +2 -2
- data/lib/plaid/models/item_status_transactions.rb +2 -2
- data/lib/plaid/models/item_webhook_update_request.rb +3 -3
- data/lib/plaid/models/item_webhook_update_response.rb +2 -2
- data/lib/plaid/models/jwk_public_key.rb +2 -2
- data/lib/plaid/models/jwt_header.rb +2 -2
- data/lib/plaid/models/liabilities_default_update_webhook.rb +2 -2
- 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 +2 -2
- data/lib/plaid/models/liability_override.rb +2 -2
- data/lib/plaid/models/link_token_account_filters.rb +2 -2
- data/lib/plaid/models/link_token_create_credit_filter.rb +2 -2
- data/lib/plaid/models/link_token_create_depository_filter.rb +2 -2
- data/lib/plaid/models/link_token_create_institution_data.rb +220 -0
- data/lib/plaid/models/link_token_create_investment_filter.rb +2 -2
- data/lib/plaid/models/link_token_create_loan_filter.rb +2 -2
- data/lib/plaid/models/link_token_create_request.rb +12 -3
- data/lib/plaid/models/link_token_create_request_account_subtypes.rb +2 -2
- 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 +2 -2
- data/lib/plaid/models/link_token_create_request_income_verification_bank_income.rb +2 -2
- data/lib/plaid/models/link_token_create_request_income_verification_payroll_income.rb +2 -2
- data/lib/plaid/models/link_token_create_request_payment_initiation.rb +2 -2
- data/lib/plaid/models/link_token_create_request_transfer.rb +2 -2
- data/lib/plaid/models/link_token_create_request_update.rb +2 -2
- data/lib/plaid/models/link_token_create_request_user.rb +2 -2
- data/lib/plaid/models/link_token_create_response.rb +2 -2
- data/lib/plaid/models/link_token_eu_config.rb +2 -2
- data/lib/plaid/models/link_token_get_metadata_response.rb +12 -3
- data/lib/plaid/models/link_token_get_request.rb +2 -2
- data/lib/plaid/models/link_token_get_response.rb +2 -2
- data/lib/plaid/models/loan_account_subtype.rb +2 -2
- data/lib/plaid/models/loan_filter.rb +2 -2
- data/lib/plaid/models/location.rb +2 -2
- 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 +2 -2
- data/lib/plaid/models/mortgage_property_address.rb +2 -2
- data/lib/plaid/models/net_pay.rb +2 -2
- data/lib/plaid/models/new_accounts_available_webhook.rb +2 -2
- data/lib/plaid/models/numbers.rb +2 -2
- data/lib/plaid/models/numbers_ach.rb +2 -2
- data/lib/plaid/models/numbers_ach_nullable.rb +2 -2
- data/lib/plaid/models/numbers_bacs.rb +2 -2
- data/lib/plaid/models/numbers_bacs_nullable.rb +2 -2
- data/lib/plaid/models/numbers_eft.rb +2 -2
- data/lib/plaid/models/numbers_eft_nullable.rb +2 -2
- data/lib/plaid/models/numbers_international.rb +2 -2
- data/lib/plaid/models/numbers_international_nullable.rb +2 -2
- data/lib/plaid/models/override_account_type.rb +2 -2
- data/lib/plaid/models/override_accounts.rb +2 -2
- data/lib/plaid/models/owner.rb +2 -2
- data/lib/plaid/models/owner_override.rb +2 -2
- data/lib/plaid/models/pay.rb +2 -2
- data/lib/plaid/models/pay_frequency.rb +2 -2
- data/lib/plaid/models/pay_frequency_value.rb +2 -2
- data/lib/plaid/models/pay_period_details.rb +2 -2
- 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 +2 -2
- data/lib/plaid/models/payment_amount_currency.rb +2 -2
- data/lib/plaid/models/payment_channel.rb +2 -2
- data/lib/plaid/models/payment_consent_max_payment_amount.rb +2 -2
- data/lib/plaid/models/payment_consent_periodic_alignment.rb +2 -2
- data/lib/plaid/models/payment_consent_periodic_amount.rb +2 -2
- data/lib/plaid/models/payment_consent_periodic_amount_amount.rb +2 -2
- data/lib/plaid/models/payment_consent_periodic_interval.rb +2 -2
- data/lib/plaid/models/payment_consent_valid_date_time.rb +4 -2
- data/lib/plaid/models/payment_initiation_address.rb +3 -3
- data/lib/plaid/models/payment_initiation_consent.rb +2 -2
- data/lib/plaid/models/payment_initiation_consent_constraints.rb +3 -2
- data/lib/plaid/models/payment_initiation_consent_create_request.rb +2 -2
- data/lib/plaid/models/payment_initiation_consent_create_response.rb +2 -2
- data/lib/plaid/models/payment_initiation_consent_get_request.rb +2 -2
- data/lib/plaid/models/payment_initiation_consent_get_response.rb +2 -2
- data/lib/plaid/models/payment_initiation_consent_payment_execute_request.rb +2 -2
- data/lib/plaid/models/payment_initiation_consent_payment_execute_response.rb +2 -2
- data/lib/plaid/models/payment_initiation_consent_revoke_request.rb +2 -2
- data/lib/plaid/models/payment_initiation_consent_revoke_response.rb +2 -2
- data/lib/plaid/models/payment_initiation_consent_scope.rb +2 -2
- data/lib/plaid/models/payment_initiation_consent_status.rb +2 -2
- data/lib/plaid/models/payment_initiation_metadata.rb +2 -2
- data/lib/plaid/models/payment_initiation_optional_restriction_bacs.rb +2 -2
- data/lib/plaid/models/payment_initiation_payment.rb +2 -2
- data/lib/plaid/models/payment_initiation_payment_create_request.rb +2 -2
- data/lib/plaid/models/payment_initiation_payment_create_response.rb +2 -2
- data/lib/plaid/models/payment_initiation_payment_create_status.rb +2 -2
- data/lib/plaid/models/payment_initiation_payment_get_request.rb +2 -2
- data/lib/plaid/models/payment_initiation_payment_get_response.rb +2 -2
- data/lib/plaid/models/payment_initiation_payment_list_request.rb +2 -2
- data/lib/plaid/models/payment_initiation_payment_list_response.rb +2 -2
- data/lib/plaid/models/payment_initiation_payment_reverse_request.rb +2 -2
- data/lib/plaid/models/payment_initiation_payment_reverse_response.rb +2 -2
- data/lib/plaid/models/payment_initiation_payment_status.rb +2 -2
- data/lib/plaid/models/payment_initiation_payment_token_create_request.rb +2 -2
- data/lib/plaid/models/payment_initiation_payment_token_create_response.rb +2 -2
- data/lib/plaid/models/payment_initiation_recipient.rb +2 -2
- data/lib/plaid/models/payment_initiation_recipient_create_request.rb +2 -2
- data/lib/plaid/models/payment_initiation_recipient_create_response.rb +2 -2
- data/lib/plaid/models/payment_initiation_recipient_get_request.rb +2 -2
- data/lib/plaid/models/payment_initiation_recipient_get_response.rb +2 -2
- 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 +2 -2
- data/lib/plaid/models/payment_initiation_refund_status.rb +2 -2
- data/lib/plaid/models/payment_initiation_standing_order_metadata.rb +2 -2
- data/lib/plaid/models/payment_meta.rb +2 -2
- data/lib/plaid/models/payment_schedule_interval.rb +2 -2
- data/lib/plaid/models/payment_scheme.rb +2 -2
- data/lib/plaid/models/payment_status_update_webhook.rb +2 -2
- 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 +2 -2
- data/lib/plaid/models/paystub_address.rb +2 -2
- data/lib/plaid/models/paystub_deduction.rb +2 -2
- data/lib/plaid/models/paystub_details.rb +2 -2
- data/lib/plaid/models/paystub_employer.rb +2 -2
- data/lib/plaid/models/paystub_override.rb +2 -2
- data/lib/plaid/models/paystub_override_employee.rb +2 -2
- data/lib/plaid/models/paystub_override_employee_address.rb +2 -2
- data/lib/plaid/models/paystub_override_employer.rb +2 -2
- data/lib/plaid/models/paystub_pay_frequency.rb +2 -2
- data/lib/plaid/models/paystub_verification.rb +2 -2
- data/lib/plaid/models/paystub_verification_status.rb +2 -2
- data/lib/plaid/models/paystub_ytd_details.rb +2 -2
- data/lib/plaid/models/pending_expiration_webhook.rb +2 -2
- data/lib/plaid/models/personal_finance_category.rb +2 -2
- data/lib/plaid/models/phone_number.rb +2 -2
- data/lib/plaid/models/plaid_error.rb +2 -2
- data/lib/plaid/models/platform_ids.rb +2 -2
- 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 +2 -2
- data/lib/plaid/models/processor_balance_get_request_options.rb +2 -2
- data/lib/plaid/models/processor_balance_get_response.rb +2 -2
- data/lib/plaid/models/processor_bank_transfer_create_request.rb +2 -2
- data/lib/plaid/models/processor_bank_transfer_create_response.rb +2 -2
- 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 +2 -2
- 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 +4 -4
- data/lib/plaid/models/processor_token_create_response.rb +2 -2
- data/lib/plaid/models/product_access.rb +2 -2
- data/lib/plaid/models/product_status.rb +2 -2
- data/lib/plaid/models/product_status_breakdown.rb +2 -2
- data/lib/plaid/models/products.rb +2 -2
- data/lib/plaid/models/projected_income_summary_field_number.rb +2 -2
- data/lib/plaid/models/pslf_status.rb +2 -2
- data/lib/plaid/models/recaptcha_required_error.rb +2 -2
- data/lib/plaid/models/recipient_bacs.rb +3 -3
- data/lib/plaid/models/recipient_bacs_nullable.rb +2 -2
- data/lib/plaid/models/recurring_transaction_frequency.rb +2 -2
- data/lib/plaid/models/relay_event.rb +2 -2
- data/lib/plaid/models/removed_transaction.rb +2 -2
- data/lib/plaid/models/sandbox_bank_transfer_fire_webhook_request.rb +2 -2
- data/lib/plaid/models/sandbox_bank_transfer_fire_webhook_response.rb +2 -2
- data/lib/plaid/models/sandbox_bank_transfer_simulate_request.rb +2 -2
- data/lib/plaid/models/sandbox_bank_transfer_simulate_response.rb +2 -2
- data/lib/plaid/models/sandbox_income_fire_webhook_request.rb +2 -2
- data/lib/plaid/models/sandbox_income_fire_webhook_response.rb +2 -2
- 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 +2 -2
- data/lib/plaid/models/sandbox_processor_token_create_request.rb +2 -2
- data/lib/plaid/models/sandbox_processor_token_create_request_options.rb +2 -2
- data/lib/plaid/models/sandbox_processor_token_create_response.rb +2 -2
- data/lib/plaid/models/sandbox_public_token_create_request.rb +16 -6
- 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 +2 -2
- 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 +2 -2
- data/lib/plaid/models/sandbox_transfer_repayment_simulate_response.rb +2 -2
- data/lib/plaid/models/sandbox_transfer_simulate_request.rb +2 -2
- data/lib/plaid/models/sandbox_transfer_simulate_response.rb +2 -2
- data/lib/plaid/models/sandbox_transfer_sweep_simulate_request.rb +2 -2
- data/lib/plaid/models/sandbox_transfer_sweep_simulate_response.rb +2 -2
- data/lib/plaid/models/scopes.rb +2 -2
- data/lib/plaid/models/scopes_context.rb +2 -2
- data/lib/plaid/models/scopes_nullable.rb +2 -2
- data/lib/plaid/models/security.rb +2 -2
- data/lib/plaid/models/security_override.rb +2 -2
- data/lib/plaid/models/sender_bacs_nullable.rb +2 -2
- data/lib/plaid/models/servicer_address_data.rb +2 -2
- data/lib/plaid/models/signal_address_data.rb +2 -2
- data/lib/plaid/models/signal_decision_report_request.rb +2 -2
- data/lib/plaid/models/signal_decision_report_response.rb +2 -2
- data/lib/plaid/models/signal_device.rb +2 -2
- data/lib/plaid/models/signal_evaluate_core_attributes.rb +326 -7
- data/lib/plaid/models/signal_evaluate_request.rb +2 -2
- data/lib/plaid/models/signal_evaluate_response.rb +2 -2
- data/lib/plaid/models/signal_person_name.rb +2 -2
- data/lib/plaid/models/signal_prepare_request.rb +245 -0
- data/lib/plaid/models/signal_prepare_response.rb +225 -0
- data/lib/plaid/models/signal_return_report_request.rb +2 -2
- data/lib/plaid/models/signal_return_report_response.rb +2 -2
- data/lib/plaid/models/signal_scores.rb +2 -2
- data/lib/plaid/models/signal_user.rb +2 -2
- data/lib/plaid/models/simulated_transfer_sweep.rb +2 -2
- data/lib/plaid/models/standalone_account_type.rb +2 -2
- data/lib/plaid/models/standalone_currency_code_list.rb +2 -2
- data/lib/plaid/models/standalone_investment_transaction_type.rb +2 -2
- data/lib/plaid/models/student_loan.rb +2 -2
- data/lib/plaid/models/student_loan_repayment_model.rb +2 -2
- data/lib/plaid/models/student_loan_status.rb +2 -2
- data/lib/plaid/models/student_repayment_plan.rb +2 -2
- data/lib/plaid/models/taxform.rb +2 -2
- data/lib/plaid/models/taxpayer_id.rb +2 -2
- data/lib/plaid/models/total.rb +2 -2
- data/lib/plaid/models/total_canonical_description.rb +2 -2
- data/lib/plaid/models/transaction.rb +2 -2
- data/lib/plaid/models/transaction_all_of.rb +2 -2
- data/lib/plaid/models/transaction_base.rb +2 -2
- data/lib/plaid/models/transaction_code.rb +2 -2
- data/lib/plaid/models/transaction_data.rb +2 -2
- data/lib/plaid/models/transaction_override.rb +2 -2
- data/lib/plaid/models/transaction_stream.rb +16 -6
- data/lib/plaid/models/transaction_stream_amount.rb +2 -2
- data/lib/plaid/models/transaction_stream_status.rb +2 -2
- data/lib/plaid/models/transactions_category_rule.rb +2 -2
- data/lib/plaid/models/transactions_enhance_get_request.rb +2 -2
- data/lib/plaid/models/transactions_enhance_get_response.rb +2 -2
- data/lib/plaid/models/transactions_get_request.rb +2 -2
- data/lib/plaid/models/transactions_get_request_options.rb +4 -4
- data/lib/plaid/models/transactions_get_response.rb +2 -2
- data/lib/plaid/models/transactions_recurring_deactivate_request.rb +255 -0
- data/lib/plaid/models/transactions_recurring_deactivate_response.rb +225 -0
- data/lib/plaid/models/transactions_recurring_get_request.rb +12 -3
- data/lib/plaid/models/transactions_recurring_get_request_options.rb +222 -0
- data/lib/plaid/models/transactions_recurring_get_response.rb +2 -2
- 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 +2 -2
- data/lib/plaid/models/transactions_rule_details.rb +2 -2
- data/lib/plaid/models/transactions_rule_field.rb +2 -2
- data/lib/plaid/models/transactions_rule_type.rb +2 -2
- data/lib/plaid/models/transactions_rules_create_request.rb +2 -2
- data/lib/plaid/models/transactions_rules_create_response.rb +2 -2
- data/lib/plaid/models/transactions_rules_list_request.rb +2 -2
- data/lib/plaid/models/transactions_rules_list_response.rb +2 -2
- data/lib/plaid/models/transactions_rules_remove_request.rb +2 -2
- data/lib/plaid/models/transactions_rules_remove_response.rb +2 -2
- data/lib/plaid/models/transactions_sync_request.rb +15 -6
- data/lib/plaid/models/transactions_sync_request_options.rb +235 -0
- data/lib/plaid/models/transactions_sync_response.rb +2 -2
- data/lib/plaid/models/transfer.rb +2 -2
- data/lib/plaid/models/transfer_authorization.rb +2 -2
- data/lib/plaid/models/transfer_authorization_create_request.rb +2 -2
- data/lib/plaid/models/transfer_authorization_create_response.rb +2 -2
- data/lib/plaid/models/transfer_authorization_decision.rb +2 -2
- data/lib/plaid/models/transfer_authorization_decision_rationale.rb +2 -2
- data/lib/plaid/models/transfer_authorization_decision_rationale_code.rb +2 -2
- data/lib/plaid/models/transfer_authorization_device.rb +2 -2
- data/lib/plaid/models/transfer_authorization_guarantee_decision.rb +2 -2
- data/lib/plaid/models/transfer_authorization_guarantee_decision_rationale.rb +2 -2
- data/lib/plaid/models/transfer_authorization_guarantee_decision_rationale_code.rb +2 -2
- data/lib/plaid/models/transfer_authorization_proposed_transfer.rb +2 -2
- data/lib/plaid/models/transfer_cancel_request.rb +2 -2
- data/lib/plaid/models/transfer_cancel_response.rb +2 -2
- data/lib/plaid/models/transfer_create_request.rb +2 -2
- data/lib/plaid/models/transfer_create_response.rb +2 -2
- data/lib/plaid/models/transfer_event.rb +2 -2
- data/lib/plaid/models/transfer_event_list_request.rb +2 -2
- data/lib/plaid/models/transfer_event_list_response.rb +2 -2
- data/lib/plaid/models/transfer_event_list_transfer_type.rb +2 -2
- data/lib/plaid/models/transfer_event_sync_request.rb +2 -2
- data/lib/plaid/models/transfer_event_sync_response.rb +2 -2
- data/lib/plaid/models/transfer_event_type.rb +2 -2
- data/lib/plaid/models/transfer_events_update_webhook.rb +240 -0
- data/lib/plaid/models/transfer_failure.rb +2 -2
- data/lib/plaid/models/transfer_get_request.rb +2 -2
- data/lib/plaid/models/transfer_get_response.rb +2 -2
- data/lib/plaid/models/transfer_intent_authorization_decision.rb +2 -2
- data/lib/plaid/models/transfer_intent_create.rb +2 -2
- data/lib/plaid/models/transfer_intent_create_mode.rb +2 -2
- data/lib/plaid/models/transfer_intent_create_request.rb +11 -12
- data/lib/plaid/models/transfer_intent_create_response.rb +2 -2
- data/lib/plaid/models/transfer_intent_get.rb +2 -2
- data/lib/plaid/models/transfer_intent_get_failure_reason.rb +2 -2
- data/lib/plaid/models/transfer_intent_get_request.rb +2 -12
- data/lib/plaid/models/transfer_intent_get_response.rb +2 -2
- data/lib/plaid/models/transfer_intent_status.rb +2 -2
- data/lib/plaid/models/transfer_list_request.rb +2 -2
- data/lib/plaid/models/transfer_list_response.rb +2 -2
- 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 +2 -2
- data/lib/plaid/models/transfer_repayment.rb +2 -2
- data/lib/plaid/models/transfer_repayment_list_request.rb +2 -2
- data/lib/plaid/models/transfer_repayment_list_response.rb +2 -2
- data/lib/plaid/models/transfer_repayment_return.rb +2 -2
- data/lib/plaid/models/transfer_repayment_return_list_request.rb +2 -2
- data/lib/plaid/models/transfer_repayment_return_list_response.rb +2 -2
- data/lib/plaid/models/transfer_status.rb +2 -2
- data/lib/plaid/models/transfer_sweep.rb +2 -2
- data/lib/plaid/models/transfer_sweep_get_request.rb +2 -2
- data/lib/plaid/models/transfer_sweep_get_response.rb +2 -2
- data/lib/plaid/models/transfer_sweep_list_request.rb +2 -2
- data/lib/plaid/models/transfer_sweep_list_response.rb +2 -2
- data/lib/plaid/models/transfer_sweep_status.rb +2 -2
- data/lib/plaid/models/transfer_type.rb +2 -2
- data/lib/plaid/models/transfer_user_address_in_request.rb +2 -2
- data/lib/plaid/models/transfer_user_address_in_response.rb +2 -2
- data/lib/plaid/models/transfer_user_in_request.rb +2 -2
- data/lib/plaid/models/transfer_user_in_response.rb +2 -2
- data/lib/plaid/models/user_create_request.rb +2 -2
- data/lib/plaid/models/user_create_response.rb +2 -2
- data/lib/plaid/models/user_custom_password.rb +2 -2
- data/lib/plaid/models/user_permission_revoked_webhook.rb +2 -2
- data/lib/plaid/models/verification_attribute.rb +2 -2
- data/lib/plaid/models/verification_expired_webhook.rb +2 -2
- data/lib/plaid/models/verification_refresh_status.rb +2 -2
- data/lib/plaid/models/verification_status.rb +2 -2
- data/lib/plaid/models/w2.rb +2 -2
- data/lib/plaid/models/w2_box12.rb +2 -2
- data/lib/plaid/models/w2_state_and_local_wages.rb +2 -2
- data/lib/plaid/models/wallet_balance.rb +2 -2
- data/lib/plaid/models/wallet_get_request.rb +2 -2
- data/lib/plaid/models/wallet_get_response.rb +15 -6
- data/lib/plaid/models/wallet_numbers.rb +220 -0
- data/lib/plaid/models/wallet_transaction.rb +2 -2
- data/lib/plaid/models/wallet_transaction_amount.rb +2 -2
- data/lib/plaid/models/wallet_transaction_counterparty.rb +2 -2
- data/lib/plaid/models/wallet_transaction_counterparty_bacs.rb +2 -2
- data/lib/plaid/models/wallet_transaction_counterparty_numbers.rb +2 -2
- data/lib/plaid/models/wallet_transaction_execute_request.rb +2 -2
- data/lib/plaid/models/wallet_transaction_execute_response.rb +2 -2
- data/lib/plaid/models/wallet_transaction_status.rb +2 -2
- data/lib/plaid/models/wallet_transactions_list_request.rb +2 -2
- data/lib/plaid/models/wallet_transactions_list_response.rb +2 -2
- data/lib/plaid/models/warning.rb +2 -2
- data/lib/plaid/models/{connected_application_status.rb → webhook_type.rb} +9 -5
- data/lib/plaid/models/webhook_update_acknowledged_webhook.rb +2 -2
- 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 +2 -2
- data/lib/plaid/models/ytd_net_income_summary_field_number.rb +2 -2
- data/lib/plaid/version.rb +3 -3
- data/lib/plaid.rb +53 -4
- data/plaid.gemspec +2 -2
- data/templates/ruby/api_client.mustache +10 -0
- data/templates/ruby/api_client_faraday_partial.mustache +3 -6
- data/test/test_api_client.rb +21 -0
- data/test/test_asset_report.rb +1 -1
- metadata +54 -5
- data/test/test_income_verifications.rb +0 -76
data/lib/plaid/api/plaid_api.rb
CHANGED
@@ -3,10 +3,10 @@
|
|
3
3
|
|
4
4
|
#The Plaid REST API. Please see https://plaid.com/docs/api for more details.
|
5
5
|
|
6
|
-
The version of the OpenAPI document: 2020-09-14_1.
|
6
|
+
The version of the OpenAPI document: 2020-09-14_1.105.1
|
7
7
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
9
|
-
OpenAPI Generator version: 5.1.
|
9
|
+
OpenAPI Generator version: 5.1.1
|
10
10
|
|
11
11
|
=end
|
12
12
|
|
@@ -85,7 +85,7 @@ module Plaid
|
|
85
85
|
end
|
86
86
|
|
87
87
|
# Retrieve accounts
|
88
|
-
# The `/accounts/get` endpoint can be used to retrieve a list of accounts associated with any linked Item. Plaid will only return active bank accounts — that is, accounts that are not closed and are capable of carrying a balance.
|
88
|
+
# The `/accounts/get` endpoint can be used to retrieve a list of accounts associated with any linked Item. Plaid will only return active bank accounts — that is, accounts that are not closed and are capable of carrying a balance. For items that went through the updated account selection pane, this endpoint only returns accounts that were permissioned by the user when they initially created the Item. If a user creates a new account after the initial link, you can capture this event through the [`NEW_ACCOUNTS_AVAILABLE`](https://plaid.com/docs/api/items/#new_accounts_available) webhook and then use Link's [update mode](https://plaid.com/docs/link/update-mode/) to request that the user share this new account with you. This endpoint retrieves cached information, rather than extracting fresh information from the institution. As a result, balances returned may not be up-to-date; for realtime balance information, use `/accounts/balance/get` instead. Note that some information is nullable.
|
89
89
|
# @param accounts_get_request [AccountsGetRequest]
|
90
90
|
# @param [Hash] opts the optional parameters
|
91
91
|
# @return [AccountsGetResponse]
|
@@ -95,7 +95,7 @@ module Plaid
|
|
95
95
|
end
|
96
96
|
|
97
97
|
# Retrieve accounts
|
98
|
-
# The `/accounts/get` endpoint can be used to retrieve a list of accounts associated with any linked Item. Plaid will only return active bank accounts — that is, accounts that are not closed and are capable of carrying a balance.
|
98
|
+
# The `/accounts/get` endpoint can be used to retrieve a list of accounts associated with any linked Item. Plaid will only return active bank accounts — that is, accounts that are not closed and are capable of carrying a balance. For items that went through the updated account selection pane, this endpoint only returns accounts that were permissioned by the user when they initially created the Item. If a user creates a new account after the initial link, you can capture this event through the [`NEW_ACCOUNTS_AVAILABLE`](https://plaid.com/docs/api/items/#new_accounts_available) webhook and then use Link's [update mode](https://plaid.com/docs/link/update-mode/) to request that the user share this new account with you. This endpoint retrieves cached information, rather than extracting fresh information from the institution. As a result, balances returned may not be up-to-date; for realtime balance information, use `/accounts/balance/get` instead. Note that some information is nullable.
|
99
99
|
# @param accounts_get_request [AccountsGetRequest]
|
100
100
|
# @param [Hash] opts the optional parameters
|
101
101
|
# @return [Array<(AccountsGetResponse, Integer, Hash)>] AccountsGetResponse data, response status code and response headers
|
@@ -1969,6 +1969,331 @@ module Plaid
|
|
1969
1969
|
return data, status_code, headers
|
1970
1970
|
end
|
1971
1971
|
|
1972
|
+
# Refresh a user's bank income information
|
1973
|
+
# `/credit/bank_income/refresh` refreshes the bank income report data for a specific user.
|
1974
|
+
# @param credit_bank_income_refresh_request [CreditBankIncomeRefreshRequest]
|
1975
|
+
# @param [Hash] opts the optional parameters
|
1976
|
+
# @return [CreditBankIncomeRefreshResponse]
|
1977
|
+
def credit_bank_income_refresh(credit_bank_income_refresh_request, opts = {})
|
1978
|
+
data, _status_code, _headers = credit_bank_income_refresh_with_http_info(credit_bank_income_refresh_request, opts)
|
1979
|
+
data
|
1980
|
+
end
|
1981
|
+
|
1982
|
+
# Refresh a user's bank income information
|
1983
|
+
# `/credit/bank_income/refresh` refreshes the bank income report data for a specific user.
|
1984
|
+
# @param credit_bank_income_refresh_request [CreditBankIncomeRefreshRequest]
|
1985
|
+
# @param [Hash] opts the optional parameters
|
1986
|
+
# @return [Array<(CreditBankIncomeRefreshResponse, Integer, Hash)>] CreditBankIncomeRefreshResponse data, response status code and response headers
|
1987
|
+
def credit_bank_income_refresh_with_http_info(credit_bank_income_refresh_request, opts = {})
|
1988
|
+
if @api_client.config.debugging
|
1989
|
+
@api_client.config.logger.debug 'Calling API: PlaidApi.credit_bank_income_refresh ...'
|
1990
|
+
end
|
1991
|
+
# verify the required parameter 'credit_bank_income_refresh_request' is set
|
1992
|
+
if @api_client.config.client_side_validation && credit_bank_income_refresh_request.nil?
|
1993
|
+
fail ArgumentError, "Missing the required parameter 'credit_bank_income_refresh_request' when calling PlaidApi.credit_bank_income_refresh"
|
1994
|
+
end
|
1995
|
+
# resource path
|
1996
|
+
local_var_path = '/credit/bank_income/refresh'
|
1997
|
+
|
1998
|
+
# query parameters
|
1999
|
+
query_params = opts[:query_params] || {}
|
2000
|
+
|
2001
|
+
# header parameters
|
2002
|
+
header_params = opts[:header_params] || {}
|
2003
|
+
# HTTP header 'Accept' (if needed)
|
2004
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
2005
|
+
# HTTP header 'Content-Type'
|
2006
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
2007
|
+
|
2008
|
+
# form parameters
|
2009
|
+
form_params = opts[:form_params] || {}
|
2010
|
+
|
2011
|
+
# http body (model)
|
2012
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(credit_bank_income_refresh_request)
|
2013
|
+
|
2014
|
+
# return_type
|
2015
|
+
return_type = opts[:debug_return_type] || 'CreditBankIncomeRefreshResponse'
|
2016
|
+
|
2017
|
+
# auth_names
|
2018
|
+
auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
|
2019
|
+
|
2020
|
+
new_options = opts.merge(
|
2021
|
+
:operation => :"PlaidApi.credit_bank_income_refresh",
|
2022
|
+
:header_params => header_params,
|
2023
|
+
:query_params => query_params,
|
2024
|
+
:form_params => form_params,
|
2025
|
+
:body => post_body,
|
2026
|
+
:auth_names => auth_names,
|
2027
|
+
:return_type => return_type
|
2028
|
+
)
|
2029
|
+
|
2030
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
2031
|
+
if @api_client.config.debugging
|
2032
|
+
@api_client.config.logger.debug "API called: PlaidApi#credit_bank_income_refresh\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
2033
|
+
end
|
2034
|
+
return data, status_code, headers
|
2035
|
+
end
|
2036
|
+
|
2037
|
+
# Retrieve a summary of an individual's employment information
|
2038
|
+
# `/credit/employment/get` returns a list of items with employment information from a user's payroll provider that was verified by an end user.
|
2039
|
+
# @param credit_employment_get_request [CreditEmploymentGetRequest]
|
2040
|
+
# @param [Hash] opts the optional parameters
|
2041
|
+
# @return [CreditEmploymentGetResponse]
|
2042
|
+
def credit_employment_get(credit_employment_get_request, opts = {})
|
2043
|
+
data, _status_code, _headers = credit_employment_get_with_http_info(credit_employment_get_request, opts)
|
2044
|
+
data
|
2045
|
+
end
|
2046
|
+
|
2047
|
+
# Retrieve a summary of an individual's employment information
|
2048
|
+
# `/credit/employment/get` returns a list of items with employment information from a user's payroll provider that was verified by an end user.
|
2049
|
+
# @param credit_employment_get_request [CreditEmploymentGetRequest]
|
2050
|
+
# @param [Hash] opts the optional parameters
|
2051
|
+
# @return [Array<(CreditEmploymentGetResponse, Integer, Hash)>] CreditEmploymentGetResponse data, response status code and response headers
|
2052
|
+
def credit_employment_get_with_http_info(credit_employment_get_request, opts = {})
|
2053
|
+
if @api_client.config.debugging
|
2054
|
+
@api_client.config.logger.debug 'Calling API: PlaidApi.credit_employment_get ...'
|
2055
|
+
end
|
2056
|
+
# verify the required parameter 'credit_employment_get_request' is set
|
2057
|
+
if @api_client.config.client_side_validation && credit_employment_get_request.nil?
|
2058
|
+
fail ArgumentError, "Missing the required parameter 'credit_employment_get_request' when calling PlaidApi.credit_employment_get"
|
2059
|
+
end
|
2060
|
+
# resource path
|
2061
|
+
local_var_path = '/credit/employment/get'
|
2062
|
+
|
2063
|
+
# query parameters
|
2064
|
+
query_params = opts[:query_params] || {}
|
2065
|
+
|
2066
|
+
# header parameters
|
2067
|
+
header_params = opts[:header_params] || {}
|
2068
|
+
# HTTP header 'Accept' (if needed)
|
2069
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
2070
|
+
# HTTP header 'Content-Type'
|
2071
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
2072
|
+
|
2073
|
+
# form parameters
|
2074
|
+
form_params = opts[:form_params] || {}
|
2075
|
+
|
2076
|
+
# http body (model)
|
2077
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(credit_employment_get_request)
|
2078
|
+
|
2079
|
+
# return_type
|
2080
|
+
return_type = opts[:debug_return_type] || 'CreditEmploymentGetResponse'
|
2081
|
+
|
2082
|
+
# auth_names
|
2083
|
+
auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
|
2084
|
+
|
2085
|
+
new_options = opts.merge(
|
2086
|
+
:operation => :"PlaidApi.credit_employment_get",
|
2087
|
+
:header_params => header_params,
|
2088
|
+
:query_params => query_params,
|
2089
|
+
:form_params => form_params,
|
2090
|
+
:body => post_body,
|
2091
|
+
:auth_names => auth_names,
|
2092
|
+
:return_type => return_type
|
2093
|
+
)
|
2094
|
+
|
2095
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
2096
|
+
if @api_client.config.debugging
|
2097
|
+
@api_client.config.logger.debug "API called: PlaidApi#credit_employment_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
2098
|
+
end
|
2099
|
+
return data, status_code, headers
|
2100
|
+
end
|
2101
|
+
|
2102
|
+
# Retrieve a user's payroll information
|
2103
|
+
# This endpoint gets payroll income information for a specific user, either as a result of the user connecting to their payroll provider or uploading a pay related document.
|
2104
|
+
# @param credit_payroll_income_get_request [CreditPayrollIncomeGetRequest]
|
2105
|
+
# @param [Hash] opts the optional parameters
|
2106
|
+
# @return [CreditPayrollIncomeGetResponse]
|
2107
|
+
def credit_payroll_income_get(credit_payroll_income_get_request, opts = {})
|
2108
|
+
data, _status_code, _headers = credit_payroll_income_get_with_http_info(credit_payroll_income_get_request, opts)
|
2109
|
+
data
|
2110
|
+
end
|
2111
|
+
|
2112
|
+
# Retrieve a user's payroll information
|
2113
|
+
# This endpoint gets payroll income information for a specific user, either as a result of the user connecting to their payroll provider or uploading a pay related document.
|
2114
|
+
# @param credit_payroll_income_get_request [CreditPayrollIncomeGetRequest]
|
2115
|
+
# @param [Hash] opts the optional parameters
|
2116
|
+
# @return [Array<(CreditPayrollIncomeGetResponse, Integer, Hash)>] CreditPayrollIncomeGetResponse data, response status code and response headers
|
2117
|
+
def credit_payroll_income_get_with_http_info(credit_payroll_income_get_request, opts = {})
|
2118
|
+
if @api_client.config.debugging
|
2119
|
+
@api_client.config.logger.debug 'Calling API: PlaidApi.credit_payroll_income_get ...'
|
2120
|
+
end
|
2121
|
+
# verify the required parameter 'credit_payroll_income_get_request' is set
|
2122
|
+
if @api_client.config.client_side_validation && credit_payroll_income_get_request.nil?
|
2123
|
+
fail ArgumentError, "Missing the required parameter 'credit_payroll_income_get_request' when calling PlaidApi.credit_payroll_income_get"
|
2124
|
+
end
|
2125
|
+
# resource path
|
2126
|
+
local_var_path = '/credit/payroll_income/get'
|
2127
|
+
|
2128
|
+
# query parameters
|
2129
|
+
query_params = opts[:query_params] || {}
|
2130
|
+
|
2131
|
+
# header parameters
|
2132
|
+
header_params = opts[:header_params] || {}
|
2133
|
+
# HTTP header 'Accept' (if needed)
|
2134
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
2135
|
+
# HTTP header 'Content-Type'
|
2136
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
2137
|
+
|
2138
|
+
# form parameters
|
2139
|
+
form_params = opts[:form_params] || {}
|
2140
|
+
|
2141
|
+
# http body (model)
|
2142
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(credit_payroll_income_get_request)
|
2143
|
+
|
2144
|
+
# return_type
|
2145
|
+
return_type = opts[:debug_return_type] || 'CreditPayrollIncomeGetResponse'
|
2146
|
+
|
2147
|
+
# auth_names
|
2148
|
+
auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
|
2149
|
+
|
2150
|
+
new_options = opts.merge(
|
2151
|
+
:operation => :"PlaidApi.credit_payroll_income_get",
|
2152
|
+
:header_params => header_params,
|
2153
|
+
:query_params => query_params,
|
2154
|
+
:form_params => form_params,
|
2155
|
+
:body => post_body,
|
2156
|
+
:auth_names => auth_names,
|
2157
|
+
:return_type => return_type
|
2158
|
+
)
|
2159
|
+
|
2160
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
2161
|
+
if @api_client.config.debugging
|
2162
|
+
@api_client.config.logger.debug "API called: PlaidApi#credit_payroll_income_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
2163
|
+
end
|
2164
|
+
return data, status_code, headers
|
2165
|
+
end
|
2166
|
+
|
2167
|
+
# Check income verification eligibility and optimize conversion
|
2168
|
+
# `/credit/payroll_income/precheck` is an optional endpoint that can be called before initializing a Link session for income verification. It evaluates whether a given user is supportable by digital income verification. If the user is eligible for digital verification, that information will be associated with the user token, and in this way will generate a Link UI optimized for the end user and their specific employer. If the user cannot be confirmed as eligible, the user can still use the income verification flow, but they may be required to manually upload a paystub to verify their income. While all request fields are optional, providing `employer` data will increase the chance of receiving a useful result.
|
2169
|
+
# @param credit_payroll_income_precheck_request [CreditPayrollIncomePrecheckRequest]
|
2170
|
+
# @param [Hash] opts the optional parameters
|
2171
|
+
# @return [CreditPayrollIncomePrecheckResponse]
|
2172
|
+
def credit_payroll_income_precheck(credit_payroll_income_precheck_request, opts = {})
|
2173
|
+
data, _status_code, _headers = credit_payroll_income_precheck_with_http_info(credit_payroll_income_precheck_request, opts)
|
2174
|
+
data
|
2175
|
+
end
|
2176
|
+
|
2177
|
+
# Check income verification eligibility and optimize conversion
|
2178
|
+
# `/credit/payroll_income/precheck` is an optional endpoint that can be called before initializing a Link session for income verification. It evaluates whether a given user is supportable by digital income verification. If the user is eligible for digital verification, that information will be associated with the user token, and in this way will generate a Link UI optimized for the end user and their specific employer. If the user cannot be confirmed as eligible, the user can still use the income verification flow, but they may be required to manually upload a paystub to verify their income. While all request fields are optional, providing `employer` data will increase the chance of receiving a useful result.
|
2179
|
+
# @param credit_payroll_income_precheck_request [CreditPayrollIncomePrecheckRequest]
|
2180
|
+
# @param [Hash] opts the optional parameters
|
2181
|
+
# @return [Array<(CreditPayrollIncomePrecheckResponse, Integer, Hash)>] CreditPayrollIncomePrecheckResponse data, response status code and response headers
|
2182
|
+
def credit_payroll_income_precheck_with_http_info(credit_payroll_income_precheck_request, opts = {})
|
2183
|
+
if @api_client.config.debugging
|
2184
|
+
@api_client.config.logger.debug 'Calling API: PlaidApi.credit_payroll_income_precheck ...'
|
2185
|
+
end
|
2186
|
+
# verify the required parameter 'credit_payroll_income_precheck_request' is set
|
2187
|
+
if @api_client.config.client_side_validation && credit_payroll_income_precheck_request.nil?
|
2188
|
+
fail ArgumentError, "Missing the required parameter 'credit_payroll_income_precheck_request' when calling PlaidApi.credit_payroll_income_precheck"
|
2189
|
+
end
|
2190
|
+
# resource path
|
2191
|
+
local_var_path = '/credit/payroll_income/precheck'
|
2192
|
+
|
2193
|
+
# query parameters
|
2194
|
+
query_params = opts[:query_params] || {}
|
2195
|
+
|
2196
|
+
# header parameters
|
2197
|
+
header_params = opts[:header_params] || {}
|
2198
|
+
# HTTP header 'Accept' (if needed)
|
2199
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
2200
|
+
# HTTP header 'Content-Type'
|
2201
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
2202
|
+
|
2203
|
+
# form parameters
|
2204
|
+
form_params = opts[:form_params] || {}
|
2205
|
+
|
2206
|
+
# http body (model)
|
2207
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(credit_payroll_income_precheck_request)
|
2208
|
+
|
2209
|
+
# return_type
|
2210
|
+
return_type = opts[:debug_return_type] || 'CreditPayrollIncomePrecheckResponse'
|
2211
|
+
|
2212
|
+
# auth_names
|
2213
|
+
auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
|
2214
|
+
|
2215
|
+
new_options = opts.merge(
|
2216
|
+
:operation => :"PlaidApi.credit_payroll_income_precheck",
|
2217
|
+
:header_params => header_params,
|
2218
|
+
:query_params => query_params,
|
2219
|
+
:form_params => form_params,
|
2220
|
+
:body => post_body,
|
2221
|
+
:auth_names => auth_names,
|
2222
|
+
:return_type => return_type
|
2223
|
+
)
|
2224
|
+
|
2225
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
2226
|
+
if @api_client.config.debugging
|
2227
|
+
@api_client.config.logger.debug "API called: PlaidApi#credit_payroll_income_precheck\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
2228
|
+
end
|
2229
|
+
return data, status_code, headers
|
2230
|
+
end
|
2231
|
+
|
2232
|
+
# Refresh a digital payroll income verification
|
2233
|
+
# `/credit/payroll_income/refresh` refreshes a given digital payroll income verification.
|
2234
|
+
# @param credit_payroll_income_refresh_request [CreditPayrollIncomeRefreshRequest]
|
2235
|
+
# @param [Hash] opts the optional parameters
|
2236
|
+
# @return [CreditPayrollIncomeRefreshResponse]
|
2237
|
+
def credit_payroll_income_refresh(credit_payroll_income_refresh_request, opts = {})
|
2238
|
+
data, _status_code, _headers = credit_payroll_income_refresh_with_http_info(credit_payroll_income_refresh_request, opts)
|
2239
|
+
data
|
2240
|
+
end
|
2241
|
+
|
2242
|
+
# Refresh a digital payroll income verification
|
2243
|
+
# `/credit/payroll_income/refresh` refreshes a given digital payroll income verification.
|
2244
|
+
# @param credit_payroll_income_refresh_request [CreditPayrollIncomeRefreshRequest]
|
2245
|
+
# @param [Hash] opts the optional parameters
|
2246
|
+
# @return [Array<(CreditPayrollIncomeRefreshResponse, Integer, Hash)>] CreditPayrollIncomeRefreshResponse data, response status code and response headers
|
2247
|
+
def credit_payroll_income_refresh_with_http_info(credit_payroll_income_refresh_request, opts = {})
|
2248
|
+
if @api_client.config.debugging
|
2249
|
+
@api_client.config.logger.debug 'Calling API: PlaidApi.credit_payroll_income_refresh ...'
|
2250
|
+
end
|
2251
|
+
# verify the required parameter 'credit_payroll_income_refresh_request' is set
|
2252
|
+
if @api_client.config.client_side_validation && credit_payroll_income_refresh_request.nil?
|
2253
|
+
fail ArgumentError, "Missing the required parameter 'credit_payroll_income_refresh_request' when calling PlaidApi.credit_payroll_income_refresh"
|
2254
|
+
end
|
2255
|
+
# resource path
|
2256
|
+
local_var_path = '/credit/payroll_income/refresh'
|
2257
|
+
|
2258
|
+
# query parameters
|
2259
|
+
query_params = opts[:query_params] || {}
|
2260
|
+
|
2261
|
+
# header parameters
|
2262
|
+
header_params = opts[:header_params] || {}
|
2263
|
+
# HTTP header 'Accept' (if needed)
|
2264
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
2265
|
+
# HTTP header 'Content-Type'
|
2266
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
2267
|
+
|
2268
|
+
# form parameters
|
2269
|
+
form_params = opts[:form_params] || {}
|
2270
|
+
|
2271
|
+
# http body (model)
|
2272
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(credit_payroll_income_refresh_request)
|
2273
|
+
|
2274
|
+
# return_type
|
2275
|
+
return_type = opts[:debug_return_type] || 'CreditPayrollIncomeRefreshResponse'
|
2276
|
+
|
2277
|
+
# auth_names
|
2278
|
+
auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
|
2279
|
+
|
2280
|
+
new_options = opts.merge(
|
2281
|
+
:operation => :"PlaidApi.credit_payroll_income_refresh",
|
2282
|
+
:header_params => header_params,
|
2283
|
+
:query_params => query_params,
|
2284
|
+
:form_params => form_params,
|
2285
|
+
:body => post_body,
|
2286
|
+
:auth_names => auth_names,
|
2287
|
+
:return_type => return_type
|
2288
|
+
)
|
2289
|
+
|
2290
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
2291
|
+
if @api_client.config.debugging
|
2292
|
+
@api_client.config.logger.debug "API called: PlaidApi#credit_payroll_income_refresh\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
2293
|
+
end
|
2294
|
+
return data, status_code, headers
|
2295
|
+
end
|
2296
|
+
|
1972
2297
|
# Create a deposit switch without using Plaid Exchange
|
1973
2298
|
# This endpoint provides an alternative to `/deposit_switch/create` for customers who have not yet fully integrated with Plaid Exchange. Like `/deposit_switch/create`, it creates a deposit switch entity that will be persisted throughout the lifecycle of the switch.
|
1974
2299
|
# @param deposit_switch_alt_create_request [DepositSwitchAltCreateRequest]
|
@@ -2294,8 +2619,8 @@ module Plaid
|
|
2294
2619
|
return data, status_code, headers
|
2295
2620
|
end
|
2296
2621
|
|
2297
|
-
# Retrieve a summary of an individual's employment information
|
2298
|
-
# `/employment/verification/get` returns a list of employments through a user payroll that was verified by an end user.
|
2622
|
+
# (Deprecated) Retrieve a summary of an individual's employment information
|
2623
|
+
# `/employment/verification/get` returns a list of employments through a user payroll that was verified by an end user. This endpoint has been deprecated; new integrations should use `/credit/employment/get` instead.
|
2299
2624
|
# @param employment_verification_get_request [EmploymentVerificationGetRequest]
|
2300
2625
|
# @param [Hash] opts the optional parameters
|
2301
2626
|
# @return [EmploymentVerificationGetResponse]
|
@@ -2304,8 +2629,8 @@ module Plaid
|
|
2304
2629
|
data
|
2305
2630
|
end
|
2306
2631
|
|
2307
|
-
# Retrieve a summary of an individual's employment information
|
2308
|
-
# `/employment/verification/get` returns a list of employments through a user payroll that was verified by an end user.
|
2632
|
+
# (Deprecated) Retrieve a summary of an individual's employment information
|
2633
|
+
# `/employment/verification/get` returns a list of employments through a user payroll that was verified by an end user. This endpoint has been deprecated; new integrations should use `/credit/employment/get` instead.
|
2309
2634
|
# @param employment_verification_get_request [EmploymentVerificationGetRequest]
|
2310
2635
|
# @param [Hash] opts the optional parameters
|
2311
2636
|
# @return [Array<(EmploymentVerificationGetResponse, Integer, Hash)>] EmploymentVerificationGetResponse data, response status code and response headers
|
@@ -2489,7 +2814,7 @@ module Plaid
|
|
2489
2814
|
return data, status_code, headers
|
2490
2815
|
end
|
2491
2816
|
|
2492
|
-
# Download the original documents used for income verification
|
2817
|
+
# (Deprecated) Download the original documents used for income verification
|
2493
2818
|
# `/income/verification/documents/download` provides the ability to download the source documents associated with the verification. If Document Income was used, the documents will be those the user provided in Link. For Payroll Income, the most recent files available for download from the payroll provider will be available from this endpoint. The response to `/income/verification/documents/download` is a ZIP file in binary data. If a `document_id` is passed, a single document will be contained in this file. If not, the response will contain all documents associated with the verification. The `request_id` is returned in the `Plaid-Request-ID` header.
|
2494
2819
|
# @param income_verification_documents_download_request [IncomeVerificationDocumentsDownloadRequest]
|
2495
2820
|
# @param [Hash] opts the optional parameters
|
@@ -2499,7 +2824,7 @@ module Plaid
|
|
2499
2824
|
data
|
2500
2825
|
end
|
2501
2826
|
|
2502
|
-
# Download the original documents used for income verification
|
2827
|
+
# (Deprecated) Download the original documents used for income verification
|
2503
2828
|
# `/income/verification/documents/download` provides the ability to download the source documents associated with the verification. If Document Income was used, the documents will be those the user provided in Link. For Payroll Income, the most recent files available for download from the payroll provider will be available from this endpoint. The response to `/income/verification/documents/download` is a ZIP file in binary data. If a `document_id` is passed, a single document will be contained in this file. If not, the response will contain all documents associated with the verification. The `request_id` is returned in the `Plaid-Request-ID` header.
|
2504
2829
|
# @param income_verification_documents_download_request [IncomeVerificationDocumentsDownloadRequest]
|
2505
2830
|
# @param [Hash] opts the optional parameters
|
@@ -2554,8 +2879,8 @@ module Plaid
|
|
2554
2879
|
return data, status_code, headers
|
2555
2880
|
end
|
2556
2881
|
|
2557
|
-
# Retrieve information from the paystubs used for income verification
|
2558
|
-
# `/income/verification/paystubs/get` returns the information collected from the paystubs that were used to verify an end user's income. It can be called once the status of the verification has been set to `VERIFICATION_STATUS_PROCESSING_COMPLETE`, as reported by the `INCOME: verification_status` webhook. Attempting to call the endpoint before verification has been completed will result in an error.
|
2882
|
+
# (Deprecated) Retrieve information from the paystubs used for income verification
|
2883
|
+
# `/income/verification/paystubs/get` returns the information collected from the paystubs that were used to verify an end user''s income. It can be called once the status of the verification has been set to `VERIFICATION_STATUS_PROCESSING_COMPLETE`, as reported by the `INCOME: verification_status` webhook. Attempting to call the endpoint before verification has been completed will result in an error. This endpoint has been deprecated; new integrations should use `/credit/payroll_income/get` instead.
|
2559
2884
|
# @param income_verification_paystubs_get_request [IncomeVerificationPaystubsGetRequest]
|
2560
2885
|
# @param [Hash] opts the optional parameters
|
2561
2886
|
# @return [IncomeVerificationPaystubsGetResponse]
|
@@ -2564,8 +2889,8 @@ module Plaid
|
|
2564
2889
|
data
|
2565
2890
|
end
|
2566
2891
|
|
2567
|
-
# Retrieve information from the paystubs used for income verification
|
2568
|
-
# `/income/verification/paystubs/get` returns the information collected from the paystubs that were used to verify an end user's income. It can be called once the status of the verification has been set to `VERIFICATION_STATUS_PROCESSING_COMPLETE`, as reported by the `INCOME: verification_status` webhook. Attempting to call the endpoint before verification has been completed will result in an error.
|
2892
|
+
# (Deprecated) Retrieve information from the paystubs used for income verification
|
2893
|
+
# `/income/verification/paystubs/get` returns the information collected from the paystubs that were used to verify an end user''s income. It can be called once the status of the verification has been set to `VERIFICATION_STATUS_PROCESSING_COMPLETE`, as reported by the `INCOME: verification_status` webhook. Attempting to call the endpoint before verification has been completed will result in an error. This endpoint has been deprecated; new integrations should use `/credit/payroll_income/get` instead.
|
2569
2894
|
# @param income_verification_paystubs_get_request [IncomeVerificationPaystubsGetRequest]
|
2570
2895
|
# @param [Hash] opts the optional parameters
|
2571
2896
|
# @return [Array<(IncomeVerificationPaystubsGetResponse, Integer, Hash)>] IncomeVerificationPaystubsGetResponse data, response status code and response headers
|
@@ -2619,8 +2944,8 @@ module Plaid
|
|
2619
2944
|
return data, status_code, headers
|
2620
2945
|
end
|
2621
2946
|
|
2622
|
-
# Check digital income verification eligibility and optimize conversion
|
2623
|
-
# `/income/verification/precheck` is an optional endpoint that can be called before initializing a Link session for income verification. It evaluates whether a given user is supportable by digital income verification and returns a `precheck_id` that can be provided to `/link/token/create`. If the user is eligible for digital verification, providing the `precheck_id` in this way will generate a Link UI optimized for the end user and their specific employer. If the user cannot be confirmed as eligible, the `precheck_id` can still be provided to `/link/token/create` and the user can still use the income verification flow, but they may be required to manually upload a paystub to verify their income. While all request fields are optional, providing either `employer` or `transactions_access_tokens` data will increase the chance of receiving a useful result.
|
2947
|
+
# (Deprecated) Check digital income verification eligibility and optimize conversion
|
2948
|
+
# `/income/verification/precheck` is an optional endpoint that can be called before initializing a Link session for income verification. It evaluates whether a given user is supportable by digital income verification and returns a `precheck_id` that can be provided to `/link/token/create`. If the user is eligible for digital verification, providing the `precheck_id` in this way will generate a Link UI optimized for the end user and their specific employer. If the user cannot be confirmed as eligible, the `precheck_id` can still be provided to `/link/token/create` and the user can still use the income verification flow, but they may be required to manually upload a paystub to verify their income. While all request fields are optional, providing either `employer` or `transactions_access_tokens` data will increase the chance of receiving a useful result. This endpoint has been deprecated; new integrations should use `/credit/payroll_income/precheck` instead.
|
2624
2949
|
# @param income_verification_precheck_request [IncomeVerificationPrecheckRequest]
|
2625
2950
|
# @param [Hash] opts the optional parameters
|
2626
2951
|
# @return [IncomeVerificationPrecheckResponse]
|
@@ -2629,8 +2954,8 @@ module Plaid
|
|
2629
2954
|
data
|
2630
2955
|
end
|
2631
2956
|
|
2632
|
-
# Check digital income verification eligibility and optimize conversion
|
2633
|
-
# `/income/verification/precheck` is an optional endpoint that can be called before initializing a Link session for income verification. It evaluates whether a given user is supportable by digital income verification and returns a `precheck_id` that can be provided to `/link/token/create`. If the user is eligible for digital verification, providing the `precheck_id` in this way will generate a Link UI optimized for the end user and their specific employer. If the user cannot be confirmed as eligible, the `precheck_id` can still be provided to `/link/token/create` and the user can still use the income verification flow, but they may be required to manually upload a paystub to verify their income. While all request fields are optional, providing either `employer` or `transactions_access_tokens` data will increase the chance of receiving a useful result.
|
2957
|
+
# (Deprecated) Check digital income verification eligibility and optimize conversion
|
2958
|
+
# `/income/verification/precheck` is an optional endpoint that can be called before initializing a Link session for income verification. It evaluates whether a given user is supportable by digital income verification and returns a `precheck_id` that can be provided to `/link/token/create`. If the user is eligible for digital verification, providing the `precheck_id` in this way will generate a Link UI optimized for the end user and their specific employer. If the user cannot be confirmed as eligible, the `precheck_id` can still be provided to `/link/token/create` and the user can still use the income verification flow, but they may be required to manually upload a paystub to verify their income. While all request fields are optional, providing either `employer` or `transactions_access_tokens` data will increase the chance of receiving a useful result. This endpoint has been deprecated; new integrations should use `/credit/payroll_income/precheck` instead.
|
2634
2959
|
# @param income_verification_precheck_request [IncomeVerificationPrecheckRequest]
|
2635
2960
|
# @param [Hash] opts the optional parameters
|
2636
2961
|
# @return [Array<(IncomeVerificationPrecheckResponse, Integer, Hash)>] IncomeVerificationPrecheckResponse data, response status code and response headers
|
@@ -2684,7 +3009,7 @@ module Plaid
|
|
2684
3009
|
return data, status_code, headers
|
2685
3010
|
end
|
2686
3011
|
|
2687
|
-
# Refresh an income verification
|
3012
|
+
# (Deprecated) Refresh an income verification
|
2688
3013
|
# `/income/verification/refresh` refreshes a given income verification.
|
2689
3014
|
# @param income_verification_refresh_request [IncomeVerificationRefreshRequest]
|
2690
3015
|
# @param [Hash] opts the optional parameters
|
@@ -2694,7 +3019,7 @@ module Plaid
|
|
2694
3019
|
data
|
2695
3020
|
end
|
2696
3021
|
|
2697
|
-
# Refresh an income verification
|
3022
|
+
# (Deprecated) Refresh an income verification
|
2698
3023
|
# `/income/verification/refresh` refreshes a given income verification.
|
2699
3024
|
# @param income_verification_refresh_request [IncomeVerificationRefreshRequest]
|
2700
3025
|
# @param [Hash] opts the optional parameters
|
@@ -2749,8 +3074,8 @@ module Plaid
|
|
2749
3074
|
return data, status_code, headers
|
2750
3075
|
end
|
2751
3076
|
|
2752
|
-
# Retrieve information from the tax documents used for income verification
|
2753
|
-
# `/income/verification/taxforms/get` returns the information collected from forms that were used to verify an end user's income. It can be called once the status of the verification has been set to `VERIFICATION_STATUS_PROCESSING_COMPLETE`, as reported by the `INCOME: verification_status` webhook. Attempting to call the endpoint before verification has been completed will result in an error.
|
3077
|
+
# (Deprecated) Retrieve information from the tax documents used for income verification
|
3078
|
+
# `/income/verification/taxforms/get` returns the information collected from forms that were used to verify an end user''s income. It can be called once the status of the verification has been set to `VERIFICATION_STATUS_PROCESSING_COMPLETE`, as reported by the `INCOME: verification_status` webhook. Attempting to call the endpoint before verification has been completed will result in an error. This endpoint has been deprecated; new integrations should use `/credit/payroll_income/get` instead.
|
2754
3079
|
# @param request_body [Hash<String, Object>]
|
2755
3080
|
# @param [Hash] opts the optional parameters
|
2756
3081
|
# @return [IncomeVerificationTaxformsGetResponse]
|
@@ -2759,8 +3084,8 @@ module Plaid
|
|
2759
3084
|
data
|
2760
3085
|
end
|
2761
3086
|
|
2762
|
-
# Retrieve information from the tax documents used for income verification
|
2763
|
-
# `/income/verification/taxforms/get` returns the information collected from forms that were used to verify an end user's income. It can be called once the status of the verification has been set to `VERIFICATION_STATUS_PROCESSING_COMPLETE`, as reported by the `INCOME: verification_status` webhook. Attempting to call the endpoint before verification has been completed will result in an error.
|
3087
|
+
# (Deprecated) Retrieve information from the tax documents used for income verification
|
3088
|
+
# `/income/verification/taxforms/get` returns the information collected from forms that were used to verify an end user''s income. It can be called once the status of the verification has been set to `VERIFICATION_STATUS_PROCESSING_COMPLETE`, as reported by the `INCOME: verification_status` webhook. Attempting to call the endpoint before verification has been completed will result in an error. This endpoint has been deprecated; new integrations should use `/credit/payroll_income/get` instead.
|
2764
3089
|
# @param request_body [Hash<String, Object>]
|
2765
3090
|
# @param [Hash] opts the optional parameters
|
2766
3091
|
# @return [Array<(IncomeVerificationTaxformsGetResponse, Integer, Hash)>] IncomeVerificationTaxformsGetResponse data, response status code and response headers
|
@@ -5285,7 +5610,7 @@ module Plaid
|
|
5285
5610
|
end
|
5286
5611
|
|
5287
5612
|
# Fire a test webhook
|
5288
|
-
# The `/sandbox/item/fire_webhook` endpoint is used to test that code correctly handles webhooks. This endpoint can trigger
|
5613
|
+
# The `/sandbox/item/fire_webhook` endpoint is used to test that code correctly handles webhooks. This endpoint can trigger the following webhooks: `DEFAULT_UPDATE`: Transactions update webhook to be fired for a given Sandbox Item. If the Item does not support Transactions, a `SANDBOX_PRODUCT_NOT_ENABLED` error will result. `NEW_ACCOUNTS_AVAILABLE`: Webhook to be fired for a given Sandbox Item created with Account Select v2. `AUTH_DATA_UPDATE`: Webhook to be fired for a given Sandbox Item created with Auth as an enabled product. Note that this endpoint is provided for developer ease-of-use and is not required for testing webhooks; webhooks will also fire in Sandbox under the same conditions that they would in Production or Development'
|
5289
5614
|
# @param sandbox_item_fire_webhook_request [SandboxItemFireWebhookRequest]
|
5290
5615
|
# @param [Hash] opts the optional parameters
|
5291
5616
|
# @return [SandboxItemFireWebhookResponse]
|
@@ -5295,7 +5620,7 @@ module Plaid
|
|
5295
5620
|
end
|
5296
5621
|
|
5297
5622
|
# Fire a test webhook
|
5298
|
-
# The `/sandbox/item/fire_webhook` endpoint is used to test that code correctly handles webhooks. This endpoint can trigger
|
5623
|
+
# The `/sandbox/item/fire_webhook` endpoint is used to test that code correctly handles webhooks. This endpoint can trigger the following webhooks: `DEFAULT_UPDATE`: Transactions update webhook to be fired for a given Sandbox Item. If the Item does not support Transactions, a `SANDBOX_PRODUCT_NOT_ENABLED` error will result. `NEW_ACCOUNTS_AVAILABLE`: Webhook to be fired for a given Sandbox Item created with Account Select v2. `AUTH_DATA_UPDATE`: Webhook to be fired for a given Sandbox Item created with Auth as an enabled product. Note that this endpoint is provided for developer ease-of-use and is not required for testing webhooks; webhooks will also fire in Sandbox under the same conditions that they would in Production or Development'
|
5299
5624
|
# @param sandbox_item_fire_webhook_request [SandboxItemFireWebhookRequest]
|
5300
5625
|
# @param [Hash] opts the optional parameters
|
5301
5626
|
# @return [Array<(SandboxItemFireWebhookResponse, Integer, Hash)>] SandboxItemFireWebhookResponse data, response status code and response headers
|
@@ -5674,6 +5999,71 @@ module Plaid
|
|
5674
5999
|
return data, status_code, headers
|
5675
6000
|
end
|
5676
6001
|
|
6002
|
+
# Manually fire a Transfer webhook
|
6003
|
+
# Use the `/sandbox/transfer/fire_webhook` endpoint to manually trigger a Transfer webhook in the Sandbox environment.
|
6004
|
+
# @param sandbox_transfer_fire_webhook_request [SandboxTransferFireWebhookRequest]
|
6005
|
+
# @param [Hash] opts the optional parameters
|
6006
|
+
# @return [SandboxTransferFireWebhookResponse]
|
6007
|
+
def sandbox_transfer_fire_webhook(sandbox_transfer_fire_webhook_request, opts = {})
|
6008
|
+
data, _status_code, _headers = sandbox_transfer_fire_webhook_with_http_info(sandbox_transfer_fire_webhook_request, opts)
|
6009
|
+
data
|
6010
|
+
end
|
6011
|
+
|
6012
|
+
# Manually fire a Transfer webhook
|
6013
|
+
# Use the `/sandbox/transfer/fire_webhook` endpoint to manually trigger a Transfer webhook in the Sandbox environment.
|
6014
|
+
# @param sandbox_transfer_fire_webhook_request [SandboxTransferFireWebhookRequest]
|
6015
|
+
# @param [Hash] opts the optional parameters
|
6016
|
+
# @return [Array<(SandboxTransferFireWebhookResponse, Integer, Hash)>] SandboxTransferFireWebhookResponse data, response status code and response headers
|
6017
|
+
def sandbox_transfer_fire_webhook_with_http_info(sandbox_transfer_fire_webhook_request, opts = {})
|
6018
|
+
if @api_client.config.debugging
|
6019
|
+
@api_client.config.logger.debug 'Calling API: PlaidApi.sandbox_transfer_fire_webhook ...'
|
6020
|
+
end
|
6021
|
+
# verify the required parameter 'sandbox_transfer_fire_webhook_request' is set
|
6022
|
+
if @api_client.config.client_side_validation && sandbox_transfer_fire_webhook_request.nil?
|
6023
|
+
fail ArgumentError, "Missing the required parameter 'sandbox_transfer_fire_webhook_request' when calling PlaidApi.sandbox_transfer_fire_webhook"
|
6024
|
+
end
|
6025
|
+
# resource path
|
6026
|
+
local_var_path = '/sandbox/transfer/fire_webhook'
|
6027
|
+
|
6028
|
+
# query parameters
|
6029
|
+
query_params = opts[:query_params] || {}
|
6030
|
+
|
6031
|
+
# header parameters
|
6032
|
+
header_params = opts[:header_params] || {}
|
6033
|
+
# HTTP header 'Accept' (if needed)
|
6034
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
6035
|
+
# HTTP header 'Content-Type'
|
6036
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
6037
|
+
|
6038
|
+
# form parameters
|
6039
|
+
form_params = opts[:form_params] || {}
|
6040
|
+
|
6041
|
+
# http body (model)
|
6042
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(sandbox_transfer_fire_webhook_request)
|
6043
|
+
|
6044
|
+
# return_type
|
6045
|
+
return_type = opts[:debug_return_type] || 'SandboxTransferFireWebhookResponse'
|
6046
|
+
|
6047
|
+
# auth_names
|
6048
|
+
auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
|
6049
|
+
|
6050
|
+
new_options = opts.merge(
|
6051
|
+
:operation => :"PlaidApi.sandbox_transfer_fire_webhook",
|
6052
|
+
:header_params => header_params,
|
6053
|
+
:query_params => query_params,
|
6054
|
+
:form_params => form_params,
|
6055
|
+
:body => post_body,
|
6056
|
+
:auth_names => auth_names,
|
6057
|
+
:return_type => return_type
|
6058
|
+
)
|
6059
|
+
|
6060
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
6061
|
+
if @api_client.config.debugging
|
6062
|
+
@api_client.config.logger.debug "API called: PlaidApi#sandbox_transfer_fire_webhook\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
6063
|
+
end
|
6064
|
+
return data, status_code, headers
|
6065
|
+
end
|
6066
|
+
|
5677
6067
|
# Trigger the creation of a repayment
|
5678
6068
|
# Use the `/sandbox/transfer/repayment/simulate` endpoint to trigger the creation of a repayment. As a side effect of calling this route, a repayment is created that includes all unreimbursed returns of guaranteed transfers. If there are no such returns, an 400 error is returned.
|
5679
6069
|
# @param sandbox_transfer_repayment_simulate_request [SandboxTransferRepaymentSimulateRequest]
|
@@ -5999,6 +6389,71 @@ module Plaid
|
|
5999
6389
|
return data, status_code, headers
|
6000
6390
|
end
|
6001
6391
|
|
6392
|
+
# Prepare the Signal product before calling `/signal/evaluate`
|
6393
|
+
# Call `/signal/prepare` with Plaid-linked bank account information at least 10 seconds before calling `/signal/evaluate` or as soon as an end-user enters the ACH deposit flow in your application.
|
6394
|
+
# @param signal_prepare_request [SignalPrepareRequest]
|
6395
|
+
# @param [Hash] opts the optional parameters
|
6396
|
+
# @return [SignalPrepareResponse]
|
6397
|
+
def signal_prepare(signal_prepare_request, opts = {})
|
6398
|
+
data, _status_code, _headers = signal_prepare_with_http_info(signal_prepare_request, opts)
|
6399
|
+
data
|
6400
|
+
end
|
6401
|
+
|
6402
|
+
# Prepare the Signal product before calling `/signal/evaluate`
|
6403
|
+
# Call `/signal/prepare` with Plaid-linked bank account information at least 10 seconds before calling `/signal/evaluate` or as soon as an end-user enters the ACH deposit flow in your application.
|
6404
|
+
# @param signal_prepare_request [SignalPrepareRequest]
|
6405
|
+
# @param [Hash] opts the optional parameters
|
6406
|
+
# @return [Array<(SignalPrepareResponse, Integer, Hash)>] SignalPrepareResponse data, response status code and response headers
|
6407
|
+
def signal_prepare_with_http_info(signal_prepare_request, opts = {})
|
6408
|
+
if @api_client.config.debugging
|
6409
|
+
@api_client.config.logger.debug 'Calling API: PlaidApi.signal_prepare ...'
|
6410
|
+
end
|
6411
|
+
# verify the required parameter 'signal_prepare_request' is set
|
6412
|
+
if @api_client.config.client_side_validation && signal_prepare_request.nil?
|
6413
|
+
fail ArgumentError, "Missing the required parameter 'signal_prepare_request' when calling PlaidApi.signal_prepare"
|
6414
|
+
end
|
6415
|
+
# resource path
|
6416
|
+
local_var_path = '/signal/prepare'
|
6417
|
+
|
6418
|
+
# query parameters
|
6419
|
+
query_params = opts[:query_params] || {}
|
6420
|
+
|
6421
|
+
# header parameters
|
6422
|
+
header_params = opts[:header_params] || {}
|
6423
|
+
# HTTP header 'Accept' (if needed)
|
6424
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
6425
|
+
# HTTP header 'Content-Type'
|
6426
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
6427
|
+
|
6428
|
+
# form parameters
|
6429
|
+
form_params = opts[:form_params] || {}
|
6430
|
+
|
6431
|
+
# http body (model)
|
6432
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(signal_prepare_request)
|
6433
|
+
|
6434
|
+
# return_type
|
6435
|
+
return_type = opts[:debug_return_type] || 'SignalPrepareResponse'
|
6436
|
+
|
6437
|
+
# auth_names
|
6438
|
+
auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
|
6439
|
+
|
6440
|
+
new_options = opts.merge(
|
6441
|
+
:operation => :"PlaidApi.signal_prepare",
|
6442
|
+
:header_params => header_params,
|
6443
|
+
:query_params => query_params,
|
6444
|
+
:form_params => form_params,
|
6445
|
+
:body => post_body,
|
6446
|
+
:auth_names => auth_names,
|
6447
|
+
:return_type => return_type
|
6448
|
+
)
|
6449
|
+
|
6450
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
6451
|
+
if @api_client.config.debugging
|
6452
|
+
@api_client.config.logger.debug "API called: PlaidApi#signal_prepare\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
6453
|
+
end
|
6454
|
+
return data, status_code, headers
|
6455
|
+
end
|
6456
|
+
|
6002
6457
|
# Report a return for an ACH transaction
|
6003
6458
|
# Call the `/signal/return/report` endpoint to report a returned transaction that was previously sent to the `/signal/evaluate` endpoint. Your feedback will be used by the model to incorporate the latest risk trend in your portfolio.
|
6004
6459
|
# @param signal_return_report_request [SignalReturnReportRequest]
|
@@ -6194,6 +6649,71 @@ module Plaid
|
|
6194
6649
|
return data, status_code, headers
|
6195
6650
|
end
|
6196
6651
|
|
6652
|
+
# Deactivate recurring transactions product for Item
|
6653
|
+
# The `/transactions/recurring/deactivate` endpoint returns returns a message indicating the success in removing the product from the Item or returns an error. The product is currently in beta. To request access, contact transactions-feedback@plaid.com.
|
6654
|
+
# @param transactions_recurring_deactivate_request [TransactionsRecurringDeactivateRequest]
|
6655
|
+
# @param [Hash] opts the optional parameters
|
6656
|
+
# @return [TransactionsRecurringDeactivateResponse]
|
6657
|
+
def transactions_recurring_deactivate(transactions_recurring_deactivate_request, opts = {})
|
6658
|
+
data, _status_code, _headers = transactions_recurring_deactivate_with_http_info(transactions_recurring_deactivate_request, opts)
|
6659
|
+
data
|
6660
|
+
end
|
6661
|
+
|
6662
|
+
# Deactivate recurring transactions product for Item
|
6663
|
+
# The `/transactions/recurring/deactivate` endpoint returns returns a message indicating the success in removing the product from the Item or returns an error. The product is currently in beta. To request access, contact transactions-feedback@plaid.com.
|
6664
|
+
# @param transactions_recurring_deactivate_request [TransactionsRecurringDeactivateRequest]
|
6665
|
+
# @param [Hash] opts the optional parameters
|
6666
|
+
# @return [Array<(TransactionsRecurringDeactivateResponse, Integer, Hash)>] TransactionsRecurringDeactivateResponse data, response status code and response headers
|
6667
|
+
def transactions_recurring_deactivate_with_http_info(transactions_recurring_deactivate_request, opts = {})
|
6668
|
+
if @api_client.config.debugging
|
6669
|
+
@api_client.config.logger.debug 'Calling API: PlaidApi.transactions_recurring_deactivate ...'
|
6670
|
+
end
|
6671
|
+
# verify the required parameter 'transactions_recurring_deactivate_request' is set
|
6672
|
+
if @api_client.config.client_side_validation && transactions_recurring_deactivate_request.nil?
|
6673
|
+
fail ArgumentError, "Missing the required parameter 'transactions_recurring_deactivate_request' when calling PlaidApi.transactions_recurring_deactivate"
|
6674
|
+
end
|
6675
|
+
# resource path
|
6676
|
+
local_var_path = '/transactions/recurring/deactivate'
|
6677
|
+
|
6678
|
+
# query parameters
|
6679
|
+
query_params = opts[:query_params] || {}
|
6680
|
+
|
6681
|
+
# header parameters
|
6682
|
+
header_params = opts[:header_params] || {}
|
6683
|
+
# HTTP header 'Accept' (if needed)
|
6684
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
6685
|
+
# HTTP header 'Content-Type'
|
6686
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
6687
|
+
|
6688
|
+
# form parameters
|
6689
|
+
form_params = opts[:form_params] || {}
|
6690
|
+
|
6691
|
+
# http body (model)
|
6692
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(transactions_recurring_deactivate_request)
|
6693
|
+
|
6694
|
+
# return_type
|
6695
|
+
return_type = opts[:debug_return_type] || 'TransactionsRecurringDeactivateResponse'
|
6696
|
+
|
6697
|
+
# auth_names
|
6698
|
+
auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
|
6699
|
+
|
6700
|
+
new_options = opts.merge(
|
6701
|
+
:operation => :"PlaidApi.transactions_recurring_deactivate",
|
6702
|
+
:header_params => header_params,
|
6703
|
+
:query_params => query_params,
|
6704
|
+
:form_params => form_params,
|
6705
|
+
:body => post_body,
|
6706
|
+
:auth_names => auth_names,
|
6707
|
+
:return_type => return_type
|
6708
|
+
)
|
6709
|
+
|
6710
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
6711
|
+
if @api_client.config.debugging
|
6712
|
+
@api_client.config.logger.debug "API called: PlaidApi#transactions_recurring_deactivate\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
6713
|
+
end
|
6714
|
+
return data, status_code, headers
|
6715
|
+
end
|
6716
|
+
|
6197
6717
|
# Get streams of recurring transactions
|
6198
6718
|
# The `/transactions/recurring/get` endpoint identifies and returns groups of transactions that occur on a regular basis for the inputted Item and accounts. The product is currently in beta. To request access, contact transactions-feedback@plaid.com.
|
6199
6719
|
# @param transactions_recurring_get_request [TransactionsRecurringGetRequest]
|
@@ -6585,7 +7105,7 @@ module Plaid
|
|
6585
7105
|
end
|
6586
7106
|
|
6587
7107
|
# Create a transfer authorization
|
6588
|
-
# Use the `/transfer/authorization/create` endpoint to determine transfer failure risk. In Plaid's sandbox environment the decisions will be returned as follows: - To approve a transfer with null rationale code, make an authorization request with an `amount` less than the available balance in the account. - To approve a transfer with the rationale code `MANUALLY_VERIFIED_ITEM`, create an Item in Link through the [Same Day Micro-deposits flow](https://plaid.com/docs/auth/coverage/testing/#testing-same-day-micro-deposits).
|
7108
|
+
# Use the `/transfer/authorization/create` endpoint to determine transfer failure risk. In Plaid's sandbox environment the decisions will be returned as follows: - To approve a transfer with null rationale code, make an authorization request with an `amount` less than the available balance in the account. - To approve a transfer with the rationale code `MANUALLY_VERIFIED_ITEM`, create an Item in Link through the [Same Day Micro-deposits flow](https://plaid.com/docs/auth/coverage/testing/#testing-same-day-micro-deposits). - To approve a transfer with the rationale code `LOGIN_REQUIRED`, [reset the login for an Item](https://plaid.com/docs/sandbox/#item_login_required). - To decline a transfer with the rationale code `NSF`, the available balance on the account must be less than the authorization `amount`. See [Create Sandbox test data](https://plaid.com/docs/sandbox/user-custom/) for details on how to customize data in Sandbox. - To decline a transfer with the rationale code `RISK`, the available balance on the account must be exactly $0. See [Create Sandbox test data](https://plaid.com/docs/sandbox/user-custom/) for details on how to customize data in Sandbox.
|
6589
7109
|
# @param transfer_authorization_create_request [TransferAuthorizationCreateRequest]
|
6590
7110
|
# @param [Hash] opts the optional parameters
|
6591
7111
|
# @return [TransferAuthorizationCreateResponse]
|
@@ -6595,7 +7115,7 @@ module Plaid
|
|
6595
7115
|
end
|
6596
7116
|
|
6597
7117
|
# Create a transfer authorization
|
6598
|
-
# Use the `/transfer/authorization/create` endpoint to determine transfer failure risk. In Plaid's sandbox environment the decisions will be returned as follows: - To approve a transfer with null rationale code, make an authorization request with an `amount` less than the available balance in the account. - To approve a transfer with the rationale code `MANUALLY_VERIFIED_ITEM`, create an Item in Link through the [Same Day Micro-deposits flow](https://plaid.com/docs/auth/coverage/testing/#testing-same-day-micro-deposits).
|
7118
|
+
# Use the `/transfer/authorization/create` endpoint to determine transfer failure risk. In Plaid's sandbox environment the decisions will be returned as follows: - To approve a transfer with null rationale code, make an authorization request with an `amount` less than the available balance in the account. - To approve a transfer with the rationale code `MANUALLY_VERIFIED_ITEM`, create an Item in Link through the [Same Day Micro-deposits flow](https://plaid.com/docs/auth/coverage/testing/#testing-same-day-micro-deposits). - To approve a transfer with the rationale code `LOGIN_REQUIRED`, [reset the login for an Item](https://plaid.com/docs/sandbox/#item_login_required). - To decline a transfer with the rationale code `NSF`, the available balance on the account must be less than the authorization `amount`. See [Create Sandbox test data](https://plaid.com/docs/sandbox/user-custom/) for details on how to customize data in Sandbox. - To decline a transfer with the rationale code `RISK`, the available balance on the account must be exactly $0. See [Create Sandbox test data](https://plaid.com/docs/sandbox/user-custom/) for details on how to customize data in Sandbox.
|
6599
7119
|
# @param transfer_authorization_create_request [TransferAuthorizationCreateRequest]
|
6600
7120
|
# @param [Hash] opts the optional parameters
|
6601
7121
|
# @return [Array<(TransferAuthorizationCreateResponse, Integer, Hash)>] TransferAuthorizationCreateResponse data, response status code and response headers
|
@@ -7169,6 +7689,71 @@ module Plaid
|
|
7169
7689
|
return data, status_code, headers
|
7170
7690
|
end
|
7171
7691
|
|
7692
|
+
# Migrate account into Transfers
|
7693
|
+
# As an alternative to adding Items via Link, you can also use the `/transfer/migrate_account` endpoint to migrate known account and routing numbers to Plaid Items. Note that Items created in this way are not compatible with endpoints for other products, such as `/accounts/balance/get`, and can only be used with Transfer endpoints. If you require access to other endpoints, create the Item through Link instead. Access to `/transfer/migrate_account` is not enabled by default; to obtain access, contact your Plaid Account Manager.
|
7694
|
+
# @param transfer_migrate_account_request [TransferMigrateAccountRequest]
|
7695
|
+
# @param [Hash] opts the optional parameters
|
7696
|
+
# @return [TransferMigrateAccountResponse]
|
7697
|
+
def transfer_migrate_account(transfer_migrate_account_request, opts = {})
|
7698
|
+
data, _status_code, _headers = transfer_migrate_account_with_http_info(transfer_migrate_account_request, opts)
|
7699
|
+
data
|
7700
|
+
end
|
7701
|
+
|
7702
|
+
# Migrate account into Transfers
|
7703
|
+
# As an alternative to adding Items via Link, you can also use the `/transfer/migrate_account` endpoint to migrate known account and routing numbers to Plaid Items. Note that Items created in this way are not compatible with endpoints for other products, such as `/accounts/balance/get`, and can only be used with Transfer endpoints. If you require access to other endpoints, create the Item through Link instead. Access to `/transfer/migrate_account` is not enabled by default; to obtain access, contact your Plaid Account Manager.
|
7704
|
+
# @param transfer_migrate_account_request [TransferMigrateAccountRequest]
|
7705
|
+
# @param [Hash] opts the optional parameters
|
7706
|
+
# @return [Array<(TransferMigrateAccountResponse, Integer, Hash)>] TransferMigrateAccountResponse data, response status code and response headers
|
7707
|
+
def transfer_migrate_account_with_http_info(transfer_migrate_account_request, opts = {})
|
7708
|
+
if @api_client.config.debugging
|
7709
|
+
@api_client.config.logger.debug 'Calling API: PlaidApi.transfer_migrate_account ...'
|
7710
|
+
end
|
7711
|
+
# verify the required parameter 'transfer_migrate_account_request' is set
|
7712
|
+
if @api_client.config.client_side_validation && transfer_migrate_account_request.nil?
|
7713
|
+
fail ArgumentError, "Missing the required parameter 'transfer_migrate_account_request' when calling PlaidApi.transfer_migrate_account"
|
7714
|
+
end
|
7715
|
+
# resource path
|
7716
|
+
local_var_path = '/transfer/migrate_account'
|
7717
|
+
|
7718
|
+
# query parameters
|
7719
|
+
query_params = opts[:query_params] || {}
|
7720
|
+
|
7721
|
+
# header parameters
|
7722
|
+
header_params = opts[:header_params] || {}
|
7723
|
+
# HTTP header 'Accept' (if needed)
|
7724
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
7725
|
+
# HTTP header 'Content-Type'
|
7726
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
7727
|
+
|
7728
|
+
# form parameters
|
7729
|
+
form_params = opts[:form_params] || {}
|
7730
|
+
|
7731
|
+
# http body (model)
|
7732
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(transfer_migrate_account_request)
|
7733
|
+
|
7734
|
+
# return_type
|
7735
|
+
return_type = opts[:debug_return_type] || 'TransferMigrateAccountResponse'
|
7736
|
+
|
7737
|
+
# auth_names
|
7738
|
+
auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
|
7739
|
+
|
7740
|
+
new_options = opts.merge(
|
7741
|
+
:operation => :"PlaidApi.transfer_migrate_account",
|
7742
|
+
:header_params => header_params,
|
7743
|
+
:query_params => query_params,
|
7744
|
+
:form_params => form_params,
|
7745
|
+
:body => post_body,
|
7746
|
+
:auth_names => auth_names,
|
7747
|
+
:return_type => return_type
|
7748
|
+
)
|
7749
|
+
|
7750
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
7751
|
+
if @api_client.config.debugging
|
7752
|
+
@api_client.config.logger.debug "API called: PlaidApi#transfer_migrate_account\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
7753
|
+
end
|
7754
|
+
return data, status_code, headers
|
7755
|
+
end
|
7756
|
+
|
7172
7757
|
# Lists historical repayments
|
7173
7758
|
# The `/transfer/repayment/list` endpoint fetches repayments matching the given filters. Repayments are returned in reverse-chronological order (most recent first) starting at the given `start_time`.
|
7174
7759
|
# @param transfer_repayment_list_request [TransferRepaymentListRequest]
|
@@ -7430,7 +8015,7 @@ module Plaid
|
|
7430
8015
|
end
|
7431
8016
|
|
7432
8017
|
# Create user
|
7433
|
-
#
|
8018
|
+
# This endpoint should be called for each of your end users before they begin a Plaid income flow. This provides you a single token to access all income data associated with the user. You should only create one per end user.
|
7434
8019
|
# @param user_create_request [UserCreateRequest]
|
7435
8020
|
# @param [Hash] opts the optional parameters
|
7436
8021
|
# @return [UserCreateResponse]
|
@@ -7440,7 +8025,7 @@ module Plaid
|
|
7440
8025
|
end
|
7441
8026
|
|
7442
8027
|
# Create user
|
7443
|
-
#
|
8028
|
+
# This endpoint should be called for each of your end users before they begin a Plaid income flow. This provides you a single token to access all income data associated with the user. You should only create one per end user.
|
7444
8029
|
# @param user_create_request [UserCreateRequest]
|
7445
8030
|
# @param [Hash] opts the optional parameters
|
7446
8031
|
# @return [Array<(UserCreateResponse, Integer, Hash)>] UserCreateResponse data, response status code and response headers
|