plaid 18.1.0 → 19.0.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 +125 -0
- data/Gemfile.lock +1 -1
- data/Makefile +1 -1
- data/lib/plaid/api/plaid_api.rb +853 -138
- data/lib/plaid/api_client.rb +2 -2
- data/lib/plaid/api_error.rb +1 -1
- data/lib/plaid/configuration.rb +1 -1
- data/lib/plaid/models/account_access.rb +1 -1
- data/lib/plaid/models/account_assets.rb +1 -1
- data/lib/plaid/models/account_assets_all_of.rb +1 -1
- data/lib/plaid/models/account_balance.rb +1 -1
- data/lib/plaid/models/account_base.rb +1 -1
- data/lib/plaid/models/account_filter.rb +1 -1
- data/lib/plaid/models/account_filters_response.rb +1 -1
- data/lib/plaid/models/account_identity.rb +1 -1
- data/lib/plaid/models/account_identity_all_of.rb +1 -1
- data/lib/plaid/models/account_identity_match_score.rb +1 -1
- data/lib/plaid/models/account_identity_match_score_all_of.rb +1 -1
- data/lib/plaid/models/account_product_access.rb +1 -1
- data/lib/plaid/models/account_product_access_nullable.rb +1 -1
- data/lib/plaid/models/account_selection_cardinality.rb +1 -1
- data/lib/plaid/models/account_subtype.rb +1 -1
- data/lib/plaid/models/account_type.rb +1 -1
- data/lib/plaid/models/accounts_balance_get_request.rb +1 -1
- data/lib/plaid/models/accounts_balance_get_request_options.rb +1 -1
- data/lib/plaid/models/accounts_get_request.rb +1 -1
- data/lib/plaid/models/accounts_get_request_options.rb +1 -1
- data/lib/plaid/models/accounts_get_response.rb +1 -1
- data/lib/plaid/models/ach_class.rb +1 -1
- data/lib/plaid/models/action_state.rb +1 -1
- data/lib/plaid/models/activity.rb +3 -3
- data/lib/plaid/models/activity_type.rb +1 -1
- data/lib/plaid/models/address.rb +1 -1
- data/lib/plaid/models/address_data.rb +1 -1
- data/lib/plaid/models/address_data_nullable.rb +1 -1
- data/lib/plaid/models/address_match_score.rb +2 -2
- data/lib/plaid/models/address_nullable.rb +1 -1
- data/lib/plaid/models/address_purpose_label.rb +1 -1
- data/lib/plaid/models/application.rb +1 -1
- data/lib/plaid/models/application_get_request.rb +1 -1
- data/lib/plaid/models/application_get_response.rb +1 -1
- data/lib/plaid/models/apr.rb +1 -1
- data/lib/plaid/models/asset.rb +1 -1
- data/lib/plaid/models/asset_detail.rb +1 -1
- data/lib/plaid/models/asset_holder.rb +1 -1
- data/lib/plaid/models/asset_holder_name.rb +1 -1
- data/lib/plaid/models/asset_owner.rb +1 -1
- data/lib/plaid/models/asset_owners.rb +1 -1
- data/lib/plaid/models/asset_report.rb +1 -1
- data/lib/plaid/models/asset_report_add_ons.rb +1 -1
- data/lib/plaid/models/asset_report_audit_copy_create_request.rb +1 -1
- data/lib/plaid/models/asset_report_audit_copy_create_response.rb +1 -1
- data/lib/plaid/models/asset_report_audit_copy_get_request.rb +1 -1
- data/lib/plaid/models/asset_report_audit_copy_remove_request.rb +1 -1
- data/lib/plaid/models/asset_report_audit_copy_remove_response.rb +1 -1
- data/lib/plaid/models/asset_report_create_request.rb +1 -1
- data/lib/plaid/models/asset_report_create_request_options.rb +1 -1
- data/lib/plaid/models/asset_report_create_response.rb +1 -1
- data/lib/plaid/models/asset_report_filter_request.rb +1 -1
- data/lib/plaid/models/asset_report_filter_response.rb +1 -1
- data/lib/plaid/models/asset_report_freddie.rb +1 -1
- data/lib/plaid/models/asset_report_freddie_get_request.rb +1 -1
- data/lib/plaid/models/asset_report_freddie_get_response.rb +1 -1
- data/lib/plaid/models/asset_report_get_request.rb +1 -1
- data/lib/plaid/models/asset_report_get_request_options.rb +1 -1
- data/lib/plaid/models/asset_report_get_response.rb +1 -1
- data/lib/plaid/models/asset_report_item.rb +1 -1
- data/lib/plaid/models/asset_report_pdf_get_request.rb +1 -1
- data/lib/plaid/models/asset_report_pdf_get_request_options.rb +1 -1
- data/lib/plaid/models/asset_report_refresh_request.rb +1 -1
- data/lib/plaid/models/asset_report_refresh_request_options.rb +1 -1
- data/lib/plaid/models/asset_report_refresh_response.rb +1 -1
- data/lib/plaid/models/asset_report_remove_request.rb +1 -1
- data/lib/plaid/models/asset_report_remove_response.rb +1 -1
- data/lib/plaid/models/asset_report_transaction.rb +1 -1
- data/lib/plaid/models/asset_report_transaction_all_of.rb +1 -1
- data/lib/plaid/models/asset_report_user.rb +1 -1
- data/lib/plaid/models/asset_transaction.rb +1 -1
- data/lib/plaid/models/asset_transaction_category_type.rb +1 -1
- data/lib/plaid/models/asset_transaction_description.rb +1 -1
- data/lib/plaid/models/asset_transaction_detail.rb +1 -1
- data/lib/plaid/models/asset_transaction_type.rb +1 -1
- data/lib/plaid/models/asset_transactions.rb +1 -1
- data/lib/plaid/models/asset_type.rb +1 -1
- data/lib/plaid/models/assets.rb +1 -1
- data/lib/plaid/models/assets_error_webhook.rb +1 -1
- data/lib/plaid/models/assets_product_ready_webhook.rb +1 -1
- data/lib/plaid/models/auth_get_numbers.rb +1 -1
- data/lib/plaid/models/auth_get_request.rb +1 -1
- data/lib/plaid/models/auth_get_request_options.rb +1 -1
- data/lib/plaid/models/auth_get_response.rb +1 -1
- data/lib/plaid/models/auth_metadata.rb +1 -1
- data/lib/plaid/models/auth_supported_methods.rb +1 -1
- data/lib/plaid/models/automatically_verified_webhook.rb +1 -1
- data/lib/plaid/models/bank_initiated_return_risk.rb +1 -1
- data/lib/plaid/models/bank_transfer.rb +1 -1
- data/lib/plaid/models/bank_transfer_balance.rb +1 -1
- data/lib/plaid/models/bank_transfer_balance_get_request.rb +1 -1
- data/lib/plaid/models/bank_transfer_balance_get_response.rb +1 -1
- data/lib/plaid/models/bank_transfer_cancel_request.rb +1 -1
- data/lib/plaid/models/bank_transfer_cancel_response.rb +1 -1
- data/lib/plaid/models/bank_transfer_create_request.rb +1 -1
- data/lib/plaid/models/bank_transfer_create_response.rb +1 -1
- data/lib/plaid/models/bank_transfer_direction.rb +1 -1
- data/lib/plaid/models/bank_transfer_event.rb +1 -1
- data/lib/plaid/models/bank_transfer_event_list_bank_transfer_type.rb +1 -1
- data/lib/plaid/models/bank_transfer_event_list_direction.rb +1 -1
- data/lib/plaid/models/bank_transfer_event_list_request.rb +1 -1
- data/lib/plaid/models/bank_transfer_event_list_response.rb +1 -1
- data/lib/plaid/models/bank_transfer_event_sync_request.rb +1 -1
- data/lib/plaid/models/bank_transfer_event_sync_response.rb +1 -1
- data/lib/plaid/models/bank_transfer_event_type.rb +1 -1
- data/lib/plaid/models/bank_transfer_failure.rb +1 -1
- data/lib/plaid/models/bank_transfer_get_request.rb +1 -1
- data/lib/plaid/models/bank_transfer_get_response.rb +1 -1
- data/lib/plaid/models/bank_transfer_list_request.rb +1 -1
- data/lib/plaid/models/bank_transfer_list_response.rb +1 -1
- data/lib/plaid/models/bank_transfer_migrate_account_request.rb +1 -1
- data/lib/plaid/models/bank_transfer_migrate_account_response.rb +1 -1
- data/lib/plaid/models/bank_transfer_network.rb +1 -1
- data/lib/plaid/models/bank_transfer_status.rb +1 -1
- data/lib/plaid/models/bank_transfer_sweep.rb +1 -1
- data/lib/plaid/models/bank_transfer_sweep_get_request.rb +1 -1
- data/lib/plaid/models/bank_transfer_sweep_get_response.rb +1 -1
- data/lib/plaid/models/bank_transfer_sweep_list_request.rb +1 -1
- data/lib/plaid/models/bank_transfer_sweep_list_response.rb +1 -1
- data/lib/plaid/models/bank_transfer_type.rb +1 -1
- data/lib/plaid/models/bank_transfer_user.rb +1 -1
- data/lib/plaid/models/bank_transfers_events_update_webhook.rb +1 -1
- data/lib/plaid/models/bank_transfers_events_update_webhook_for_auth.rb +1 -1
- data/lib/plaid/models/categories_get_response.rb +1 -1
- data/lib/plaid/models/category.rb +1 -1
- data/lib/plaid/models/cause.rb +2 -2
- data/lib/plaid/models/cause_all_of.rb +1 -1
- data/lib/plaid/models/client_provided_enhanced_transaction.rb +1 -1
- data/lib/plaid/models/client_provided_enriched_transaction.rb +1 -1
- data/lib/plaid/models/client_provided_raw_transaction.rb +1 -1
- data/lib/plaid/models/client_provided_transaction.rb +1 -1
- data/lib/plaid/models/client_provided_transaction_location.rb +1 -1
- data/lib/plaid/models/connected_application.rb +1 -1
- data/lib/plaid/models/counterparty.rb +1 -1
- data/lib/plaid/models/counterparty_type.rb +1 -1
- data/lib/plaid/models/country_code.rb +1 -1
- data/lib/plaid/models/credit1099.rb +1 -1
- data/lib/plaid/models/credit1099_filer.rb +1 -1
- data/lib/plaid/models/credit1099_payer.rb +1 -1
- data/lib/plaid/models/credit1099_recipient.rb +1 -1
- data/lib/plaid/models/credit_account_subtype.rb +1 -1
- data/lib/plaid/models/credit_amount_with_currency.rb +1 -1
- data/lib/plaid/models/credit_audit_copy_token_create_request.rb +1 -1
- data/lib/plaid/models/credit_audit_copy_token_create_response.rb +1 -1
- data/lib/plaid/models/credit_audit_copy_token_remove_request.rb +1 -1
- data/lib/plaid/models/credit_audit_copy_token_remove_response.rb +1 -1
- data/lib/plaid/models/credit_audit_copy_token_update_request.rb +1 -1
- data/lib/plaid/models/credit_audit_copy_token_update_response.rb +1 -1
- data/lib/plaid/models/credit_bank_employer.rb +1 -1
- data/lib/plaid/models/credit_bank_employment.rb +1 -1
- data/lib/plaid/models/credit_bank_employment_get_request.rb +1 -1
- data/lib/plaid/models/credit_bank_employment_get_response.rb +1 -1
- data/lib/plaid/models/credit_bank_employment_item.rb +1 -1
- data/lib/plaid/models/credit_bank_employment_report.rb +1 -1
- data/lib/plaid/models/credit_bank_employment_warning.rb +1 -1
- data/lib/plaid/models/credit_bank_employment_warning_type.rb +1 -1
- data/lib/plaid/models/credit_bank_income.rb +1 -1
- data/lib/plaid/models/credit_bank_income_account.rb +1 -1
- data/lib/plaid/models/credit_bank_income_account_type.rb +1 -1
- data/lib/plaid/models/credit_bank_income_category.rb +2 -1
- data/lib/plaid/models/credit_bank_income_cause.rb +1 -1
- data/lib/plaid/models/credit_bank_income_error_type.rb +1 -1
- data/lib/plaid/models/credit_bank_income_get_request.rb +1 -1
- data/lib/plaid/models/credit_bank_income_get_request_options.rb +1 -1
- data/lib/plaid/models/credit_bank_income_get_response.rb +1 -1
- data/lib/plaid/models/credit_bank_income_historical_summary.rb +1 -1
- data/lib/plaid/models/credit_bank_income_item.rb +1 -1
- data/lib/plaid/models/credit_bank_income_pay_frequency.rb +1 -1
- data/lib/plaid/models/credit_bank_income_pdf_get_request.rb +1 -1
- data/lib/plaid/models/credit_bank_income_refresh_request.rb +1 -1
- data/lib/plaid/models/credit_bank_income_refresh_request_options.rb +1 -1
- data/lib/plaid/models/credit_bank_income_refresh_response.rb +1 -1
- data/lib/plaid/models/credit_bank_income_source.rb +1 -1
- data/lib/plaid/models/credit_bank_income_summary.rb +1 -1
- data/lib/plaid/models/credit_bank_income_transaction.rb +1 -1
- data/lib/plaid/models/credit_bank_income_warning.rb +1 -1
- data/lib/plaid/models/credit_bank_income_warning_code.rb +1 -1
- data/lib/plaid/models/credit_bank_income_warning_type.rb +1 -1
- data/lib/plaid/models/credit_card_liability.rb +1 -1
- data/lib/plaid/models/credit_category.rb +1 -1
- data/lib/plaid/models/credit_document_metadata.rb +1 -1
- data/lib/plaid/models/credit_employer_verification.rb +1 -1
- data/lib/plaid/models/credit_employment_get_request.rb +1 -1
- data/lib/plaid/models/credit_employment_get_response.rb +1 -1
- data/lib/plaid/models/credit_employment_item.rb +1 -1
- data/lib/plaid/models/credit_employment_verification.rb +1 -1
- data/lib/plaid/models/credit_filter.rb +1 -1
- data/lib/plaid/models/credit_freddie_mac_asset_detail_voe25.rb +1 -1
- data/lib/plaid/models/credit_freddie_mac_asset_transaction_detail_voe25.rb +1 -1
- data/lib/plaid/models/credit_freddie_mac_asset_transaction_voa24.rb +1 -1
- data/lib/plaid/models/credit_freddie_mac_asset_transaction_voe25.rb +1 -1
- data/lib/plaid/models/credit_freddie_mac_asset_transactions_voa24.rb +1 -1
- data/lib/plaid/models/credit_freddie_mac_asset_transactions_voe25.rb +1 -1
- data/lib/plaid/models/credit_freddie_mac_asset_voa24.rb +1 -1
- data/lib/plaid/models/credit_freddie_mac_asset_voe25.rb +1 -1
- data/lib/plaid/models/credit_freddie_mac_assets_voa24.rb +1 -1
- data/lib/plaid/models/credit_freddie_mac_assets_voe25.rb +1 -1
- data/lib/plaid/models/credit_freddie_mac_individual_name_voa24.rb +1 -1
- data/lib/plaid/models/credit_freddie_mac_loan_identifiers_voa24.rb +1 -1
- data/lib/plaid/models/credit_freddie_mac_loan_voa24.rb +1 -1
- data/lib/plaid/models/credit_freddie_mac_loans_voa24.rb +1 -1
- data/lib/plaid/models/credit_freddie_mac_parties_voa24.rb +1 -1
- data/lib/plaid/models/credit_freddie_mac_party_individual_voa24.rb +1 -1
- data/lib/plaid/models/credit_freddie_mac_party_voa24.rb +1 -1
- data/lib/plaid/models/credit_freddie_mac_reporting_information_voa24.rb +1 -1
- data/lib/plaid/models/credit_freddie_mac_reports_get_request.rb +1 -1
- data/lib/plaid/models/credit_freddie_mac_reports_get_response.rb +1 -1
- data/lib/plaid/models/credit_freddie_mac_service_voa24.rb +1 -1
- data/lib/plaid/models/credit_freddie_mac_service_voe25.rb +1 -1
- data/lib/plaid/models/credit_freddie_mac_services_voa24.rb +1 -1
- data/lib/plaid/models/credit_freddie_mac_services_voe25.rb +1 -1
- data/lib/plaid/models/credit_freddie_mac_verification_of_asset_response_voa24.rb +1 -1
- data/lib/plaid/models/credit_freddie_mac_verification_of_asset_response_voe25.rb +1 -1
- data/lib/plaid/models/credit_freddie_mac_verification_of_asset_voa24.rb +1 -1
- data/lib/plaid/models/credit_freddie_mac_verification_of_asset_voe25.rb +1 -1
- data/lib/plaid/models/credit_freddie_mac_verification_of_assets_deal_voa24.rb +1 -1
- data/lib/plaid/models/credit_freddie_mac_verification_of_assets_voa24.rb +1 -1
- data/lib/plaid/models/credit_freddie_verification_of_employment_deal_voe25.rb +1 -1
- data/lib/plaid/models/credit_freddie_verification_of_employment_voe25.rb +1 -1
- data/lib/plaid/models/credit_pay_stub.rb +1 -1
- data/lib/plaid/models/credit_pay_stub_address.rb +1 -1
- data/lib/plaid/models/credit_pay_stub_deductions.rb +1 -1
- data/lib/plaid/models/credit_pay_stub_earnings.rb +1 -1
- data/lib/plaid/models/credit_pay_stub_employee.rb +1 -1
- data/lib/plaid/models/credit_pay_stub_employer.rb +1 -1
- data/lib/plaid/models/credit_pay_stub_net_pay.rb +1 -1
- data/lib/plaid/models/credit_pay_stub_pay_basis_type.rb +1 -1
- data/lib/plaid/models/credit_payroll_income_get_request.rb +1 -1
- data/lib/plaid/models/credit_payroll_income_get_response.rb +1 -1
- data/lib/plaid/models/credit_payroll_income_precheck_request.rb +1 -1
- data/lib/plaid/models/credit_payroll_income_precheck_response.rb +1 -1
- data/lib/plaid/models/credit_payroll_income_refresh_request.rb +1 -1
- data/lib/plaid/models/credit_payroll_income_refresh_request_options.rb +1 -1
- data/lib/plaid/models/credit_payroll_income_refresh_response.rb +1 -1
- data/lib/plaid/models/credit_payroll_income_risk_signals_get_request.rb +2 -2
- data/lib/plaid/models/credit_payroll_income_risk_signals_get_response.rb +2 -2
- data/lib/plaid/models/credit_platform_ids.rb +1 -1
- data/lib/plaid/models/credit_relay_create_request.rb +1 -1
- data/lib/plaid/models/credit_relay_create_response.rb +1 -1
- data/lib/plaid/models/credit_relay_get_request.rb +1 -1
- data/lib/plaid/models/credit_relay_refresh_request.rb +1 -1
- data/lib/plaid/models/credit_relay_refresh_response.rb +1 -1
- data/lib/plaid/models/credit_relay_remove_request.rb +1 -1
- data/lib/plaid/models/credit_relay_remove_response.rb +1 -1
- data/lib/plaid/models/credit_session.rb +1 -1
- data/lib/plaid/models/credit_session_bank_employment_result.rb +1 -1
- data/lib/plaid/models/credit_session_bank_employment_status.rb +1 -1
- data/lib/plaid/models/credit_session_bank_income_result.rb +1 -1
- data/lib/plaid/models/credit_session_bank_income_status.rb +1 -1
- data/lib/plaid/models/credit_session_document_income_result.rb +1 -1
- data/lib/plaid/models/credit_session_error.rb +1 -1
- data/lib/plaid/models/credit_session_item_add_result.rb +1 -1
- data/lib/plaid/models/credit_session_payroll_income_result.rb +1 -1
- data/lib/plaid/models/credit_session_results.rb +1 -1
- data/lib/plaid/models/credit_sessions_get_request.rb +1 -1
- data/lib/plaid/models/credit_sessions_get_response.rb +1 -1
- data/lib/plaid/models/credit_w2.rb +1 -1
- data/lib/plaid/models/customer_initiated_return_risk.rb +1 -1
- data/lib/plaid/models/dashboard_user.rb +1 -1
- data/lib/plaid/models/dashboard_user_get_request.rb +1 -1
- data/lib/plaid/models/dashboard_user_get_response.rb +1 -1
- data/lib/plaid/models/dashboard_user_list_request.rb +1 -1
- data/lib/plaid/models/dashboard_user_list_response.rb +1 -1
- data/lib/plaid/models/dashboard_user_status.rb +1 -1
- data/lib/plaid/models/date_range.rb +1 -1
- data/lib/plaid/models/deductions.rb +1 -1
- data/lib/plaid/models/deductions_breakdown.rb +1 -1
- data/lib/plaid/models/deductions_total.rb +1 -1
- data/lib/plaid/models/default_update_webhook.rb +1 -1
- data/lib/plaid/models/deposit_switch_address_data.rb +1 -1
- data/lib/plaid/models/deposit_switch_alt_create_request.rb +1 -1
- data/lib/plaid/models/deposit_switch_alt_create_response.rb +1 -1
- data/lib/plaid/models/deposit_switch_create_request.rb +1 -1
- data/lib/plaid/models/deposit_switch_create_request_options.rb +1 -1
- data/lib/plaid/models/deposit_switch_create_response.rb +1 -1
- data/lib/plaid/models/deposit_switch_get_request.rb +1 -1
- data/lib/plaid/models/deposit_switch_get_response.rb +1 -1
- data/lib/plaid/models/deposit_switch_state_update_webhook.rb +1 -1
- data/lib/plaid/models/deposit_switch_target_account.rb +1 -1
- data/lib/plaid/models/deposit_switch_target_user.rb +1 -1
- data/lib/plaid/models/deposit_switch_token_create_request.rb +1 -1
- data/lib/plaid/models/deposit_switch_token_create_response.rb +1 -1
- data/lib/plaid/models/depository_account_subtype.rb +1 -1
- data/lib/plaid/models/depository_filter.rb +1 -1
- data/lib/plaid/models/detailed_originator.rb +1 -1
- data/lib/plaid/models/distribution_breakdown.rb +1 -1
- data/lib/plaid/models/doc_type.rb +1 -1
- data/lib/plaid/models/document_analysis.rb +1 -1
- data/lib/plaid/models/document_authenticity_match_code.rb +1 -1
- data/lib/plaid/models/document_date_of_birth_match_code.rb +1 -1
- data/lib/plaid/models/document_metadata.rb +2 -2
- data/lib/plaid/models/document_name_match_code.rb +1 -1
- data/lib/plaid/models/document_risk_signal.rb +1 -1
- data/lib/plaid/models/document_risk_signal_institution_metadata.rb +1 -1
- data/lib/plaid/models/document_risk_signals_object.rb +1 -1
- data/lib/plaid/models/document_risk_summary.rb +1 -1
- data/lib/plaid/models/document_status.rb +1 -1
- data/lib/plaid/models/documentary_verification.rb +1 -1
- data/lib/plaid/models/documentary_verification_document.rb +2 -2
- data/lib/plaid/models/earnings.rb +1 -1
- data/lib/plaid/models/earnings_breakdown.rb +1 -1
- data/lib/plaid/models/earnings_breakdown_canonical_description.rb +1 -1
- data/lib/plaid/models/earnings_total.rb +1 -1
- data/lib/plaid/models/email.rb +1 -1
- data/lib/plaid/models/email_address_match_score.rb +2 -2
- data/lib/plaid/models/employee.rb +1 -1
- data/lib/plaid/models/employee_income_summary_field_string.rb +1 -1
- data/lib/plaid/models/employer.rb +1 -1
- data/lib/plaid/models/employer_income_summary_field_string.rb +1 -1
- data/lib/plaid/models/employer_verification.rb +1 -1
- data/lib/plaid/models/employers_search_request.rb +1 -1
- data/lib/plaid/models/employers_search_response.rb +1 -1
- data/lib/plaid/models/employment_details.rb +1 -1
- data/lib/plaid/models/employment_source_type.rb +1 -1
- data/lib/plaid/models/employment_verification.rb +1 -1
- data/lib/plaid/models/employment_verification_get_request.rb +1 -1
- data/lib/plaid/models/employment_verification_get_response.rb +1 -1
- data/lib/plaid/models/employment_verification_status.rb +1 -1
- data/lib/plaid/models/enhancements.rb +1 -1
- data/lib/plaid/models/enrich_transaction_direction.rb +1 -1
- data/lib/plaid/models/enrichments.rb +1 -1
- data/lib/plaid/models/entity_document.rb +1 -1
- data/lib/plaid/models/entity_document_type.rb +1 -1
- data/lib/plaid/models/entity_screening_hit_analysis.rb +2 -2
- data/lib/plaid/models/entity_screening_hit_data.rb +1 -1
- data/lib/plaid/models/entity_screening_hit_documents_items.rb +1 -1
- data/lib/plaid/models/entity_screening_hit_emails.rb +1 -1
- data/lib/plaid/models/entity_screening_hit_emails_items.rb +1 -1
- data/lib/plaid/models/entity_screening_hit_names.rb +1 -1
- data/lib/plaid/models/entity_screening_hit_names_items.rb +1 -1
- data/lib/plaid/models/entity_screening_hit_phone_numbers.rb +1 -1
- data/lib/plaid/models/entity_screening_hit_urls.rb +1 -1
- data/lib/plaid/models/entity_screening_hit_urls_items.rb +1 -1
- data/lib/plaid/models/entity_screening_hits_phone_number_items.rb +1 -1
- data/lib/plaid/models/entity_screening_status_updated_webhook.rb +1 -1
- data/lib/plaid/models/entity_watchlist_code.rb +1 -1
- data/lib/plaid/models/entity_watchlist_program.rb +1 -1
- data/lib/plaid/models/entity_watchlist_screening.rb +2 -2
- data/lib/plaid/models/entity_watchlist_screening_hit.rb +1 -1
- data/lib/plaid/models/entity_watchlist_screening_review.rb +1 -1
- data/lib/plaid/models/entity_watchlist_screening_search_terms.rb +2 -2
- data/lib/plaid/models/entity_watchlist_search_terms.rb +1 -1
- data/lib/plaid/models/expiration_date.rb +1 -1
- data/lib/plaid/models/external_payment_initiation_consent_options.rb +1 -1
- data/lib/plaid/models/external_payment_options.rb +1 -1
- data/lib/plaid/models/external_payment_refund_details.rb +1 -1
- data/lib/plaid/models/external_payment_schedule_base.rb +1 -1
- data/lib/plaid/models/external_payment_schedule_get.rb +1 -1
- data/lib/plaid/models/external_payment_schedule_request.rb +1 -1
- data/lib/plaid/models/fallback_auth_microdeposit_auto_verified_webhook.rb +1 -1
- data/lib/plaid/models/fallback_auth_microdeposit_verification_expired_webhook.rb +1 -1
- data/lib/plaid/models/fdx_content_types.rb +1 -1
- data/lib/plaid/models/fdx_hateoas_link.rb +1 -1
- data/lib/plaid/models/fdx_hateoas_link_action.rb +1 -1
- data/lib/plaid/models/fdx_initiator_fi_attribute.rb +228 -0
- data/lib/plaid/models/fdx_notification.rb +1 -1
- data/lib/plaid/models/fdx_notification_category.rb +1 -1
- data/lib/plaid/models/fdx_notification_payload.rb +5 -3
- data/lib/plaid/models/fdx_notification_payload_id_type.rb +1 -1
- data/lib/plaid/models/fdx_notification_priority.rb +1 -1
- data/lib/plaid/models/fdx_notification_severity.rb +1 -1
- data/lib/plaid/models/fdx_notification_type.rb +1 -1
- data/lib/plaid/models/fdx_party.rb +1 -1
- data/lib/plaid/models/fdx_party_registry.rb +1 -1
- data/lib/plaid/models/fdx_party_type.rb +1 -1
- data/lib/plaid/models/fdxfi_attribute.rb +11 -1
- data/lib/plaid/models/form1099_type.rb +1 -1
- data/lib/plaid/models/generic_screening_hit_location_items.rb +1 -1
- data/lib/plaid/models/health_incident.rb +1 -1
- data/lib/plaid/models/historical_balance.rb +1 -1
- data/lib/plaid/models/historical_update_webhook.rb +1 -1
- data/lib/plaid/models/holding.rb +1 -1
- data/lib/plaid/models/holdings_default_update_webhook.rb +1 -1
- data/lib/plaid/models/holdings_override.rb +1 -1
- data/lib/plaid/models/id_number_type.rb +1 -1
- data/lib/plaid/models/identity_default_update_webhook.rb +1 -1
- data/lib/plaid/models/identity_get_request.rb +1 -1
- data/lib/plaid/models/identity_get_request_options.rb +1 -1
- data/lib/plaid/models/identity_get_response.rb +1 -1
- data/lib/plaid/models/identity_match_request.rb +2 -12
- data/lib/plaid/models/identity_match_request_options.rb +1 -1
- data/lib/plaid/models/identity_match_response.rb +1 -1
- data/lib/plaid/models/identity_match_user.rb +2 -2
- data/lib/plaid/models/identity_update_types.rb +1 -1
- data/lib/plaid/models/identity_verification.rb +13 -3
- data/lib/plaid/models/identity_verification_create_request.rb +1 -1
- data/lib/plaid/models/identity_verification_create_response.rb +13 -3
- data/lib/plaid/models/identity_verification_get_request.rb +1 -1
- data/lib/plaid/models/identity_verification_get_response.rb +13 -3
- data/lib/plaid/models/identity_verification_list_request.rb +2 -2
- data/lib/plaid/models/identity_verification_list_response.rb +1 -1
- data/lib/plaid/models/identity_verification_request_user.rb +3 -3
- data/lib/plaid/models/identity_verification_request_user_name.rb +1 -1
- data/lib/plaid/models/identity_verification_response_user_name.rb +1 -1
- data/lib/plaid/models/identity_verification_retried_webhook.rb +1 -1
- data/lib/plaid/models/identity_verification_retry_request.rb +2 -2
- data/lib/plaid/models/identity_verification_retry_request_steps_object.rb +1 -1
- data/lib/plaid/models/identity_verification_retry_response.rb +13 -3
- data/lib/plaid/models/identity_verification_status.rb +1 -1
- data/lib/plaid/models/identity_verification_status_updated_webhook.rb +1 -1
- data/lib/plaid/models/identity_verification_step_status.rb +1 -1
- data/lib/plaid/models/identity_verification_step_summary.rb +1 -1
- data/lib/plaid/models/identity_verification_step_updated_webhook.rb +1 -1
- data/lib/plaid/models/identity_verification_template_reference.rb +2 -2
- data/lib/plaid/models/identity_verification_user_address.rb +1 -1
- data/lib/plaid/models/identity_verification_user_data.rb +1 -1
- data/lib/plaid/models/image_quality.rb +1 -1
- data/lib/plaid/models/incident_update.rb +1 -1
- data/lib/plaid/models/income_breakdown.rb +1 -1
- data/lib/plaid/models/income_breakdown_type.rb +1 -1
- data/lib/plaid/models/income_override.rb +1 -1
- data/lib/plaid/models/income_summary.rb +1 -1
- data/lib/plaid/models/income_summary_field_number.rb +1 -1
- data/lib/plaid/models/income_summary_field_string.rb +1 -1
- data/lib/plaid/models/income_verification_create_request.rb +1 -1
- data/lib/plaid/models/income_verification_create_request_options.rb +1 -1
- data/lib/plaid/models/income_verification_create_response.rb +1 -1
- data/lib/plaid/models/income_verification_documents_download_request.rb +1 -1
- data/lib/plaid/models/income_verification_payroll_flow_type.rb +1 -1
- data/lib/plaid/models/income_verification_paystubs_get_request.rb +1 -1
- data/lib/plaid/models/income_verification_paystubs_get_response.rb +1 -1
- data/lib/plaid/models/income_verification_precheck_confidence.rb +1 -1
- data/lib/plaid/models/income_verification_precheck_employer.rb +1 -1
- data/lib/plaid/models/income_verification_precheck_employer_address.rb +1 -1
- data/lib/plaid/models/income_verification_precheck_employer_address_data.rb +1 -1
- data/lib/plaid/models/income_verification_precheck_military_info.rb +1 -1
- data/lib/plaid/models/income_verification_precheck_payroll_institution.rb +1 -1
- data/lib/plaid/models/income_verification_precheck_request.rb +1 -1
- data/lib/plaid/models/income_verification_precheck_response.rb +1 -1
- data/lib/plaid/models/income_verification_precheck_user.rb +1 -1
- data/lib/plaid/models/income_verification_risk_signals_status_webhook.rb +289 -0
- data/lib/plaid/models/income_verification_source_type.rb +1 -1
- data/lib/plaid/models/income_verification_status_webhook.rb +1 -1
- data/lib/plaid/models/income_verification_taxforms_get_request.rb +1 -1
- data/lib/plaid/models/income_verification_taxforms_get_response.rb +1 -1
- data/lib/plaid/models/income_verification_webhook_status.rb +1 -1
- data/lib/plaid/models/individual_name.rb +1 -1
- data/lib/plaid/models/individual_screening_hit_names.rb +1 -1
- data/lib/plaid/models/individual_watchlist_code.rb +1 -1
- data/lib/plaid/models/individual_watchlist_program.rb +1 -1
- data/lib/plaid/models/inflow_model.rb +1 -1
- data/lib/plaid/models/initial_update_webhook.rb +1 -1
- data/lib/plaid/models/institution.rb +1 -1
- data/lib/plaid/models/institution_status.rb +1 -1
- data/lib/plaid/models/institution_supported_networks.rb +1 -1
- data/lib/plaid/models/institutions_get_by_id_request.rb +1 -1
- data/lib/plaid/models/institutions_get_by_id_request_options.rb +1 -1
- data/lib/plaid/models/institutions_get_by_id_response.rb +1 -1
- data/lib/plaid/models/institutions_get_request.rb +1 -1
- data/lib/plaid/models/institutions_get_request_options.rb +1 -1
- data/lib/plaid/models/institutions_get_response.rb +1 -1
- data/lib/plaid/models/institutions_search_account_filter.rb +1 -1
- data/lib/plaid/models/institutions_search_payment_initiation_options.rb +1 -1
- data/lib/plaid/models/institutions_search_request.rb +1 -1
- data/lib/plaid/models/institutions_search_request_options.rb +1 -1
- data/lib/plaid/models/institutions_search_response.rb +1 -1
- data/lib/plaid/models/investment_account_subtype.rb +1 -1
- data/lib/plaid/models/investment_filter.rb +1 -1
- data/lib/plaid/models/investment_holdings_get_request_options.rb +1 -1
- data/lib/plaid/models/investment_transaction.rb +1 -1
- data/lib/plaid/models/investment_transaction_subtype.rb +1 -1
- data/lib/plaid/models/investment_transaction_type.rb +1 -1
- data/lib/plaid/models/investments_default_update_webhook.rb +1 -1
- data/lib/plaid/models/investments_holdings_get_request.rb +1 -1
- data/lib/plaid/models/investments_holdings_get_response.rb +1 -1
- data/lib/plaid/models/investments_refresh_request.rb +245 -0
- data/lib/plaid/models/investments_refresh_response.rb +225 -0
- data/lib/plaid/models/investments_transactions_get_request.rb +1 -1
- data/lib/plaid/models/investments_transactions_get_request_options.rb +1 -1
- data/lib/plaid/models/investments_transactions_get_response.rb +1 -1
- data/lib/plaid/models/investments_transactions_override.rb +1 -1
- data/lib/plaid/models/issuing_country.rb +1 -1
- data/lib/plaid/models/item.rb +1 -1
- data/lib/plaid/models/item_access_token_invalidate_request.rb +1 -1
- data/lib/plaid/models/item_access_token_invalidate_response.rb +1 -1
- data/lib/plaid/models/item_activity_list_request.rb +1 -1
- data/lib/plaid/models/item_activity_list_response.rb +1 -1
- data/lib/plaid/models/item_application_list_request.rb +1 -1
- data/lib/plaid/models/item_application_list_response.rb +1 -1
- data/lib/plaid/models/item_application_list_user_auth.rb +1 -1
- data/lib/plaid/models/item_application_scopes_update_request.rb +1 -1
- data/lib/plaid/models/item_application_scopes_update_response.rb +1 -1
- data/lib/plaid/models/item_error_webhook.rb +1 -1
- data/lib/plaid/models/item_get_request.rb +1 -1
- data/lib/plaid/models/item_get_response.rb +1 -1
- data/lib/plaid/models/item_import_request.rb +1 -1
- data/lib/plaid/models/item_import_request_options.rb +1 -1
- data/lib/plaid/models/item_import_request_user_auth.rb +1 -1
- data/lib/plaid/models/item_import_response.rb +1 -1
- data/lib/plaid/models/item_login_repaired_webhook.rb +1 -1
- data/lib/plaid/models/item_product_ready_webhook.rb +1 -1
- data/lib/plaid/models/item_public_token_create_request.rb +1 -1
- data/lib/plaid/models/item_public_token_create_response.rb +1 -1
- data/lib/plaid/models/item_public_token_exchange_request.rb +1 -1
- data/lib/plaid/models/item_public_token_exchange_response.rb +1 -1
- data/lib/plaid/models/item_remove_request.rb +1 -1
- data/lib/plaid/models/item_remove_response.rb +1 -1
- data/lib/plaid/models/item_status.rb +1 -1
- data/lib/plaid/models/item_status_investments.rb +1 -1
- data/lib/plaid/models/item_status_last_webhook.rb +1 -1
- data/lib/plaid/models/item_status_nullable.rb +1 -1
- data/lib/plaid/models/item_status_transactions.rb +1 -1
- data/lib/plaid/models/item_webhook_update_request.rb +1 -1
- data/lib/plaid/models/item_webhook_update_response.rb +1 -1
- data/lib/plaid/models/jwk_public_key.rb +1 -1
- data/lib/plaid/models/jwt_header.rb +1 -1
- data/lib/plaid/models/kyc_check_address_summary.rb +1 -1
- data/lib/plaid/models/kyc_check_date_of_birth_summary.rb +1 -1
- data/lib/plaid/models/kyc_check_details.rb +1 -1
- data/lib/plaid/models/kyc_check_id_number_summary.rb +1 -1
- data/lib/plaid/models/kyc_check_name_summary.rb +1 -1
- data/lib/plaid/models/kyc_check_phone_summary.rb +1 -1
- data/lib/plaid/models/last_data_access_times.rb +1 -1
- data/lib/plaid/models/liabilities_default_update_webhook.rb +1 -1
- data/lib/plaid/models/liabilities_get_request.rb +1 -1
- data/lib/plaid/models/liabilities_get_request_options.rb +1 -1
- data/lib/plaid/models/liabilities_get_response.rb +1 -1
- data/lib/plaid/models/liabilities_object.rb +1 -1
- data/lib/plaid/models/liability_override.rb +1 -1
- data/lib/plaid/models/link_callback_metadata.rb +1 -1
- data/lib/plaid/models/link_delivery_account.rb +1 -1
- data/lib/plaid/models/link_delivery_callback_webhook.rb +1 -1
- data/lib/plaid/models/link_delivery_communication_method.rb +1 -1
- data/lib/plaid/models/link_delivery_create_request.rb +1 -1
- data/lib/plaid/models/link_delivery_create_response.rb +1 -1
- data/lib/plaid/models/link_delivery_delivery_method.rb +1 -1
- data/lib/plaid/models/link_delivery_get_request.rb +1 -1
- data/lib/plaid/models/link_delivery_get_response.rb +1 -1
- data/lib/plaid/models/link_delivery_institution.rb +1 -1
- data/lib/plaid/models/link_delivery_metadata.rb +1 -1
- data/lib/plaid/models/link_delivery_options.rb +1 -1
- data/lib/plaid/models/link_delivery_recipient.rb +1 -1
- data/lib/plaid/models/link_delivery_session_status.rb +1 -1
- data/lib/plaid/models/link_delivery_verification_status.rb +1 -1
- data/lib/plaid/models/link_delivery_webhook_callback_type.rb +1 -1
- data/lib/plaid/models/link_delivery_webhook_communication_method.rb +1 -1
- data/lib/plaid/models/link_delivery_webhook_delivery_status.rb +1 -1
- data/lib/plaid/models/link_event.rb +255 -0
- data/lib/plaid/models/link_event_metadata.rb +365 -0
- data/lib/plaid/models/link_event_name.rb +1 -1
- data/lib/plaid/models/link_events_webhook.rb +287 -0
- data/lib/plaid/models/link_o_auth_correlation_id_exchange_request.rb +1 -1
- data/lib/plaid/models/link_o_auth_correlation_id_exchange_response.rb +1 -1
- data/lib/plaid/models/link_token_account_filters.rb +1 -1
- data/lib/plaid/models/link_token_create_credit_filter.rb +1 -1
- data/lib/plaid/models/link_token_create_depository_filter.rb +1 -1
- data/lib/plaid/models/link_token_create_institution_data.rb +1 -1
- data/lib/plaid/models/link_token_create_investment_filter.rb +1 -1
- data/lib/plaid/models/link_token_create_loan_filter.rb +1 -1
- data/lib/plaid/models/link_token_create_request.rb +1 -1
- data/lib/plaid/models/link_token_create_request_account_subtypes.rb +1 -1
- data/lib/plaid/models/link_token_create_request_auth.rb +1 -1
- data/lib/plaid/models/link_token_create_request_deposit_switch.rb +1 -1
- data/lib/plaid/models/link_token_create_request_employment.rb +1 -1
- data/lib/plaid/models/link_token_create_request_employment_bank_income.rb +1 -1
- data/lib/plaid/models/link_token_create_request_identity_verification.rb +1 -1
- data/lib/plaid/models/link_token_create_request_income_verification.rb +1 -1
- data/lib/plaid/models/link_token_create_request_income_verification_bank_income.rb +1 -1
- data/lib/plaid/models/link_token_create_request_income_verification_payroll_income.rb +1 -1
- data/lib/plaid/models/link_token_create_request_payment_initiation.rb +1 -1
- data/lib/plaid/models/link_token_create_request_transfer.rb +1 -1
- data/lib/plaid/models/link_token_create_request_update.rb +1 -1
- data/lib/plaid/models/link_token_create_request_user.rb +5 -7
- data/lib/plaid/models/link_token_create_request_user_stated_income_source.rb +1 -1
- data/lib/plaid/models/link_token_create_response.rb +1 -1
- data/lib/plaid/models/link_token_eu_config.rb +1 -1
- data/lib/plaid/models/link_token_get_metadata_response.rb +1 -1
- data/lib/plaid/models/link_token_get_request.rb +1 -1
- data/lib/plaid/models/link_token_get_response.rb +1 -1
- data/lib/plaid/models/link_token_investments.rb +1 -1
- data/lib/plaid/models/link_user_delivery_status_webhook.rb +1 -1
- data/lib/plaid/models/loan.rb +1 -1
- data/lib/plaid/models/loan_account_subtype.rb +1 -1
- data/lib/plaid/models/loan_filter.rb +1 -1
- data/lib/plaid/models/loan_identifier.rb +1 -1
- data/lib/plaid/models/loan_identifier_type.rb +1 -1
- data/lib/plaid/models/loan_identifiers.rb +1 -1
- data/lib/plaid/models/loans.rb +1 -1
- data/lib/plaid/models/location.rb +1 -1
- data/lib/plaid/models/match_summary.rb +1 -1
- data/lib/plaid/models/match_summary_code.rb +1 -1
- data/lib/plaid/models/meta.rb +1 -1
- data/lib/plaid/models/mfa.rb +1 -1
- data/lib/plaid/models/mortgage_interest_rate.rb +1 -1
- data/lib/plaid/models/mortgage_liability.rb +1 -1
- data/lib/plaid/models/mortgage_property_address.rb +1 -1
- data/lib/plaid/models/multi_document_risk_signal.rb +1 -1
- data/lib/plaid/models/name_match_score.rb +2 -2
- data/lib/plaid/models/net_pay.rb +1 -1
- data/lib/plaid/models/new_accounts_available_webhook.rb +1 -1
- data/lib/plaid/models/numbers.rb +1 -1
- data/lib/plaid/models/numbers_ach.rb +1 -1
- data/lib/plaid/models/numbers_ach_nullable.rb +1 -1
- data/lib/plaid/models/numbers_bacs.rb +1 -1
- data/lib/plaid/models/numbers_bacs_nullable.rb +1 -1
- data/lib/plaid/models/numbers_eft.rb +1 -1
- data/lib/plaid/models/numbers_eft_nullable.rb +1 -1
- data/lib/plaid/models/numbers_iban_nullable.rb +1 -1
- data/lib/plaid/models/numbers_international.rb +1 -1
- data/lib/plaid/models/numbers_international_iban.rb +1 -1
- data/lib/plaid/models/numbers_international_nullable.rb +1 -1
- data/lib/plaid/models/originator.rb +1 -1
- data/lib/plaid/models/originator_expected_transfer_frequency.rb +41 -0
- data/lib/plaid/models/override_account_type.rb +1 -1
- data/lib/plaid/models/override_accounts.rb +1 -1
- data/lib/plaid/models/owner.rb +1 -1
- data/lib/plaid/models/owner_override.rb +1 -1
- data/lib/plaid/models/ownership_type.rb +1 -1
- data/lib/plaid/models/parties.rb +1 -1
- data/lib/plaid/models/partner_customer_create_request.rb +1 -1
- data/lib/plaid/models/partner_customer_create_response.rb +1 -1
- data/lib/plaid/models/partner_customer_enable_request.rb +1 -1
- data/lib/plaid/models/partner_customer_enable_response.rb +1 -1
- data/lib/plaid/models/partner_customer_get_request.rb +1 -1
- data/lib/plaid/models/partner_customer_get_response.rb +1 -1
- data/lib/plaid/models/partner_customer_o_auth_institutions_get_request.rb +1 -1
- data/lib/plaid/models/partner_customer_o_auth_institutions_get_response.rb +1 -1
- data/lib/plaid/models/partner_customer_remove_request.rb +1 -1
- data/lib/plaid/models/partner_customer_remove_response.rb +1 -1
- data/lib/plaid/models/partner_end_customer.rb +1 -1
- data/lib/plaid/models/partner_end_customer_address.rb +1 -1
- data/lib/plaid/models/partner_end_customer_assets_under_management.rb +1 -1
- data/lib/plaid/models/partner_end_customer_billing_contact.rb +1 -1
- data/lib/plaid/models/partner_end_customer_customer_support_info.rb +1 -1
- data/lib/plaid/models/partner_end_customer_flowdown_status.rb +1 -1
- data/lib/plaid/models/partner_end_customer_o_auth_institution.rb +1 -1
- data/lib/plaid/models/partner_end_customer_o_auth_institution_application_status.rb +1 -1
- data/lib/plaid/models/partner_end_customer_o_auth_institution_environments.rb +1 -1
- data/lib/plaid/models/partner_end_customer_o_auth_status_updated_values.rb +1 -1
- data/lib/plaid/models/partner_end_customer_o_auth_status_updated_webhook.rb +1 -1
- data/lib/plaid/models/partner_end_customer_questionnaire_status.rb +1 -1
- data/lib/plaid/models/partner_end_customer_secrets.rb +1 -1
- data/lib/plaid/models/partner_end_customer_status.rb +1 -1
- data/lib/plaid/models/partner_end_customer_technical_contact.rb +1 -1
- data/lib/plaid/models/partner_end_customer_with_secrets.rb +1 -1
- data/lib/plaid/models/partner_end_customer_with_secrets_all_of.rb +1 -1
- data/lib/plaid/models/party.rb +1 -1
- data/lib/plaid/models/party_individual.rb +1 -1
- data/lib/plaid/models/party_role_type.rb +1 -1
- data/lib/plaid/models/pay.rb +1 -1
- data/lib/plaid/models/pay_frequency.rb +1 -1
- data/lib/plaid/models/pay_frequency_value.rb +1 -1
- data/lib/plaid/models/pay_period_details.rb +1 -1
- data/lib/plaid/models/pay_stub_deductions_breakdown.rb +1 -1
- data/lib/plaid/models/pay_stub_deductions_total.rb +1 -1
- data/lib/plaid/models/pay_stub_distribution_breakdown.rb +1 -1
- data/lib/plaid/models/pay_stub_earnings_breakdown.rb +1 -1
- data/lib/plaid/models/pay_stub_earnings_total.rb +1 -1
- data/lib/plaid/models/pay_stub_pay_period_details.rb +1 -1
- data/lib/plaid/models/pay_stub_taxpayer_id.rb +1 -1
- data/lib/plaid/models/payment_amount.rb +1 -1
- data/lib/plaid/models/payment_amount_currency.rb +1 -1
- data/lib/plaid/models/payment_amount_nullable.rb +1 -1
- data/lib/plaid/models/payment_amount_refunded.rb +1 -1
- data/lib/plaid/models/payment_amount_to_refund.rb +1 -1
- data/lib/plaid/models/payment_channel.rb +1 -1
- data/lib/plaid/models/payment_consent_max_payment_amount.rb +1 -1
- data/lib/plaid/models/payment_consent_periodic_alignment.rb +1 -1
- data/lib/plaid/models/payment_consent_periodic_amount.rb +1 -1
- data/lib/plaid/models/payment_consent_periodic_amount_amount.rb +1 -1
- data/lib/plaid/models/payment_consent_periodic_interval.rb +1 -1
- data/lib/plaid/models/payment_consent_valid_date_time.rb +1 -1
- data/lib/plaid/models/payment_initiation_address.rb +2 -2
- data/lib/plaid/models/payment_initiation_consent.rb +1 -1
- data/lib/plaid/models/payment_initiation_consent_constraints.rb +1 -1
- data/lib/plaid/models/payment_initiation_consent_create_request.rb +1 -1
- data/lib/plaid/models/payment_initiation_consent_create_response.rb +1 -1
- data/lib/plaid/models/payment_initiation_consent_get_request.rb +1 -1
- data/lib/plaid/models/payment_initiation_consent_get_response.rb +1 -1
- data/lib/plaid/models/payment_initiation_consent_payment_execute_request.rb +1 -1
- data/lib/plaid/models/payment_initiation_consent_payment_execute_response.rb +1 -1
- data/lib/plaid/models/payment_initiation_consent_revoke_request.rb +1 -1
- data/lib/plaid/models/payment_initiation_consent_revoke_response.rb +1 -1
- data/lib/plaid/models/payment_initiation_consent_scope.rb +1 -1
- data/lib/plaid/models/payment_initiation_consent_status.rb +1 -1
- data/lib/plaid/models/payment_initiation_metadata.rb +1 -1
- data/lib/plaid/models/payment_initiation_optional_restriction_bacs.rb +1 -1
- data/lib/plaid/models/payment_initiation_payment.rb +1 -1
- data/lib/plaid/models/payment_initiation_payment_create_request.rb +1 -1
- data/lib/plaid/models/payment_initiation_payment_create_response.rb +1 -1
- data/lib/plaid/models/payment_initiation_payment_create_status.rb +1 -1
- data/lib/plaid/models/payment_initiation_payment_get_request.rb +1 -1
- data/lib/plaid/models/payment_initiation_payment_get_response.rb +1 -1
- data/lib/plaid/models/payment_initiation_payment_list_request.rb +1 -1
- data/lib/plaid/models/payment_initiation_payment_list_response.rb +1 -1
- data/lib/plaid/models/payment_initiation_payment_reverse_request.rb +1 -1
- data/lib/plaid/models/payment_initiation_payment_reverse_response.rb +1 -1
- data/lib/plaid/models/payment_initiation_payment_status.rb +1 -1
- data/lib/plaid/models/payment_initiation_payment_token_create_request.rb +1 -1
- data/lib/plaid/models/payment_initiation_payment_token_create_response.rb +1 -1
- data/lib/plaid/models/payment_initiation_recipient.rb +1 -1
- data/lib/plaid/models/payment_initiation_recipient_create_request.rb +1 -1
- data/lib/plaid/models/payment_initiation_recipient_create_response.rb +1 -1
- data/lib/plaid/models/payment_initiation_recipient_get_request.rb +1 -1
- data/lib/plaid/models/payment_initiation_recipient_get_response.rb +1 -1
- data/lib/plaid/models/payment_initiation_recipient_get_response_all_of.rb +1 -1
- data/lib/plaid/models/payment_initiation_recipient_list_request.rb +1 -1
- data/lib/plaid/models/payment_initiation_recipient_list_response.rb +1 -1
- data/lib/plaid/models/payment_initiation_standing_order_metadata.rb +1 -1
- data/lib/plaid/models/payment_meta.rb +1 -1
- data/lib/plaid/models/payment_profile_create_request.rb +1 -1
- data/lib/plaid/models/payment_profile_create_response.rb +1 -1
- data/lib/plaid/models/payment_profile_get_request.rb +1 -1
- data/lib/plaid/models/payment_profile_get_response.rb +1 -1
- data/lib/plaid/models/payment_profile_remove_request.rb +1 -1
- data/lib/plaid/models/payment_profile_remove_response.rb +1 -1
- data/lib/plaid/models/payment_profile_status.rb +1 -1
- data/lib/plaid/models/payment_schedule_interval.rb +1 -1
- data/lib/plaid/models/payment_scheme.rb +1 -1
- data/lib/plaid/models/payment_status_update_webhook.rb +1 -1
- data/lib/plaid/models/payroll_income_account_data.rb +1 -1
- data/lib/plaid/models/payroll_income_object.rb +1 -1
- data/lib/plaid/models/payroll_income_rate_of_pay.rb +1 -1
- data/lib/plaid/models/payroll_item.rb +1 -1
- data/lib/plaid/models/payroll_item_status.rb +1 -1
- data/lib/plaid/models/payroll_risk_signals_item.rb +1 -1
- data/lib/plaid/models/paystub.rb +1 -1
- data/lib/plaid/models/paystub_address.rb +1 -1
- data/lib/plaid/models/paystub_deduction.rb +1 -1
- data/lib/plaid/models/paystub_details.rb +1 -1
- data/lib/plaid/models/paystub_employer.rb +1 -1
- data/lib/plaid/models/paystub_override.rb +1 -1
- data/lib/plaid/models/paystub_override_employee.rb +1 -1
- data/lib/plaid/models/paystub_override_employee_address.rb +1 -1
- data/lib/plaid/models/paystub_override_employer.rb +1 -1
- data/lib/plaid/models/paystub_pay_frequency.rb +1 -1
- data/lib/plaid/models/paystub_ytd_details.rb +1 -1
- data/lib/plaid/models/pending_expiration_webhook.rb +1 -1
- data/lib/plaid/models/personal_finance_category.rb +1 -1
- data/lib/plaid/models/phone_number.rb +1 -1
- data/lib/plaid/models/phone_number_match_score.rb +2 -2
- data/lib/plaid/models/phone_type.rb +1 -1
- data/lib/plaid/models/physical_document_category.rb +1 -1
- data/lib/plaid/models/physical_document_extracted_data.rb +1 -1
- data/lib/plaid/models/physical_document_extracted_data_analysis.rb +1 -1
- data/lib/plaid/models/physical_document_images.rb +1 -1
- data/lib/plaid/models/plaid_error.rb +2 -2
- data/lib/plaid/models/plaid_error_type.rb +1 -1
- data/lib/plaid/models/platform_ids.rb +1 -1
- data/lib/plaid/models/po_box_status.rb +1 -1
- data/lib/plaid/models/processor_apex_processor_token_create_request.rb +1 -1
- data/lib/plaid/models/processor_auth_get_request.rb +1 -1
- data/lib/plaid/models/processor_auth_get_response.rb +1 -1
- data/lib/plaid/models/processor_balance_get_request.rb +1 -1
- data/lib/plaid/models/processor_balance_get_request_options.rb +1 -1
- data/lib/plaid/models/processor_balance_get_response.rb +1 -1
- data/lib/plaid/models/processor_bank_transfer_create_request.rb +1 -1
- data/lib/plaid/models/processor_bank_transfer_create_response.rb +1 -1
- data/lib/plaid/models/processor_identity_get_request.rb +1 -1
- data/lib/plaid/models/processor_identity_get_response.rb +1 -1
- data/lib/plaid/models/processor_identity_match_request.rb +254 -0
- data/lib/plaid/models/{transfer_expected_settlement_schedule_item.rb → processor_identity_match_response.rb} +25 -26
- data/lib/plaid/models/processor_number.rb +1 -1
- data/lib/plaid/models/processor_signal_decision_report_request.rb +1 -1
- data/lib/plaid/models/processor_signal_decision_report_response.rb +1 -1
- data/lib/plaid/models/processor_signal_evaluate_request.rb +1 -1
- data/lib/plaid/models/processor_signal_evaluate_response.rb +17 -5
- data/lib/plaid/models/processor_signal_return_report_request.rb +1 -1
- data/lib/plaid/models/processor_signal_return_report_response.rb +1 -1
- data/lib/plaid/models/processor_stripe_bank_account_token_create_request.rb +1 -1
- data/lib/plaid/models/processor_stripe_bank_account_token_create_response.rb +1 -1
- data/lib/plaid/models/processor_token_create_request.rb +3 -3
- data/lib/plaid/models/processor_token_create_response.rb +1 -1
- data/lib/plaid/models/processor_token_permissions_get_request.rb +245 -0
- data/lib/plaid/models/processor_token_permissions_get_response.rb +242 -0
- data/lib/plaid/models/processor_token_permissions_set_request.rb +262 -0
- data/lib/plaid/models/processor_token_permissions_set_response.rb +225 -0
- data/lib/plaid/models/processor_transactions_get_request.rb +284 -0
- data/lib/plaid/models/processor_transactions_get_response.rb +288 -0
- data/lib/plaid/models/processor_transactions_recurring_get_request.rb +271 -0
- data/lib/plaid/models/processor_transactions_recurring_get_response.rb +274 -0
- data/lib/plaid/models/processor_transactions_refresh_request.rb +245 -0
- data/lib/plaid/models/processor_transactions_refresh_response.rb +225 -0
- data/lib/plaid/models/processor_transactions_sync_request.rb +302 -0
- data/lib/plaid/models/processor_transactions_sync_response.rb +306 -0
- data/lib/plaid/models/product_access.rb +1 -1
- data/lib/plaid/models/product_status.rb +1 -1
- data/lib/plaid/models/product_status_breakdown.rb +1 -1
- data/lib/plaid/models/products.rb +1 -1
- data/lib/plaid/models/program_name_sensitivity.rb +1 -1
- data/lib/plaid/models/projected_income_summary_field_number.rb +1 -1
- data/lib/plaid/models/proxy_type.rb +1 -1
- data/lib/plaid/models/pslf_status.rb +3 -3
- data/lib/plaid/models/recaptcha_required_error.rb +1 -1
- data/lib/plaid/models/recipient_bacs.rb +1 -1
- data/lib/plaid/models/recipient_bacs_nullable.rb +1 -1
- data/lib/plaid/models/recurrence.rb +1 -1
- data/lib/plaid/models/recurring_cancelled_webhook.rb +1 -1
- data/lib/plaid/models/recurring_new_transfer_webhook.rb +1 -1
- data/lib/plaid/models/recurring_transaction_frequency.rb +1 -1
- data/lib/plaid/models/recurring_transactions_update_webhook.rb +1 -1
- data/lib/plaid/models/recurring_transfer.rb +1 -1
- data/lib/plaid/models/recurring_transfer_nullable.rb +1 -1
- data/lib/plaid/models/recurring_transfer_skipped_webhook.rb +1 -1
- data/lib/plaid/models/removed_transaction.rb +1 -1
- data/lib/plaid/models/report_type.rb +1 -1
- data/lib/plaid/models/reporting_information.rb +1 -1
- data/lib/plaid/models/risk_check_behavior.rb +1 -1
- data/lib/plaid/models/risk_check_behavior_bot_detected_label.rb +1 -1
- data/lib/plaid/models/risk_check_behavior_fraud_ring_detected_label.rb +1 -1
- data/lib/plaid/models/risk_check_behavior_user_interactions_label.rb +1 -1
- data/lib/plaid/models/risk_check_details.rb +1 -1
- data/lib/plaid/models/risk_check_device.rb +1 -1
- data/lib/plaid/models/risk_check_email.rb +2 -1
- data/lib/plaid/models/risk_check_email_domain_is_custom.rb +1 -1
- data/lib/plaid/models/risk_check_email_domain_is_disposable.rb +1 -1
- data/lib/plaid/models/risk_check_email_domain_is_free_provider.rb +1 -1
- data/lib/plaid/models/risk_check_email_is_deliverable_status.rb +1 -1
- data/lib/plaid/models/risk_check_email_top_level_domain_is_suspicious.rb +1 -1
- data/lib/plaid/models/risk_check_linked_service.rb +1 -1
- data/lib/plaid/models/risk_check_phone.rb +2 -1
- data/lib/plaid/models/risk_signal_document_reference.rb +1 -1
- data/lib/plaid/models/role.rb +1 -1
- data/lib/plaid/models/role_detail.rb +1 -1
- data/lib/plaid/models/roles.rb +1 -1
- data/lib/plaid/models/sandbox_bank_transfer_fire_webhook_request.rb +1 -1
- data/lib/plaid/models/sandbox_bank_transfer_fire_webhook_response.rb +1 -1
- data/lib/plaid/models/sandbox_bank_transfer_simulate_request.rb +1 -1
- data/lib/plaid/models/sandbox_bank_transfer_simulate_response.rb +1 -1
- data/lib/plaid/models/sandbox_income_fire_webhook_request.rb +1 -1
- data/lib/plaid/models/sandbox_income_fire_webhook_response.rb +1 -1
- data/lib/plaid/models/sandbox_item_fire_webhook_request.rb +3 -3
- data/lib/plaid/models/sandbox_item_fire_webhook_response.rb +1 -1
- data/lib/plaid/models/sandbox_item_reset_login_request.rb +1 -1
- data/lib/plaid/models/sandbox_item_reset_login_response.rb +1 -1
- data/lib/plaid/models/sandbox_item_set_verification_status_request.rb +1 -1
- data/lib/plaid/models/sandbox_item_set_verification_status_response.rb +1 -1
- data/lib/plaid/models/sandbox_oauth_select_accounts_request.rb +1 -1
- data/lib/plaid/models/sandbox_payment_profile_reset_login_request.rb +1 -1
- data/lib/plaid/models/sandbox_payment_profile_reset_login_response.rb +1 -1
- data/lib/plaid/models/sandbox_processor_token_create_request.rb +1 -1
- data/lib/plaid/models/sandbox_processor_token_create_request_options.rb +1 -1
- data/lib/plaid/models/sandbox_processor_token_create_response.rb +1 -1
- data/lib/plaid/models/sandbox_public_token_create_request.rb +1 -1
- data/lib/plaid/models/sandbox_public_token_create_request_income_verification_bank_income.rb +1 -1
- data/lib/plaid/models/sandbox_public_token_create_request_options.rb +1 -1
- data/lib/plaid/models/sandbox_public_token_create_request_options_income_verification.rb +1 -1
- data/lib/plaid/models/sandbox_public_token_create_request_options_transactions.rb +1 -1
- data/lib/plaid/models/sandbox_public_token_create_response.rb +1 -1
- data/lib/plaid/models/sandbox_transfer_fire_webhook_request.rb +1 -1
- data/lib/plaid/models/sandbox_transfer_fire_webhook_response.rb +1 -1
- data/lib/plaid/models/sandbox_transfer_repayment_simulate_request.rb +1 -1
- data/lib/plaid/models/sandbox_transfer_repayment_simulate_response.rb +1 -1
- data/lib/plaid/models/sandbox_transfer_simulate_request.rb +1 -1
- data/lib/plaid/models/sandbox_transfer_simulate_response.rb +1 -1
- data/lib/plaid/models/sandbox_transfer_sweep_simulate_request.rb +1 -1
- data/lib/plaid/models/sandbox_transfer_sweep_simulate_response.rb +1 -1
- data/lib/plaid/models/sandbox_transfer_test_clock_advance_request.rb +1 -1
- data/lib/plaid/models/sandbox_transfer_test_clock_advance_response.rb +1 -1
- data/lib/plaid/models/sandbox_transfer_test_clock_create_request.rb +1 -1
- data/lib/plaid/models/sandbox_transfer_test_clock_create_response.rb +1 -1
- data/lib/plaid/models/sandbox_transfer_test_clock_get_request.rb +1 -1
- data/lib/plaid/models/sandbox_transfer_test_clock_get_response.rb +1 -1
- data/lib/plaid/models/sandbox_transfer_test_clock_list_request.rb +1 -1
- data/lib/plaid/models/sandbox_transfer_test_clock_list_response.rb +1 -1
- data/lib/plaid/models/scopes.rb +1 -1
- data/lib/plaid/models/scopes_context.rb +1 -1
- data/lib/plaid/models/scopes_nullable.rb +1 -1
- data/lib/plaid/models/screening_hit_analysis.rb +2 -2
- data/lib/plaid/models/screening_hit_data.rb +1 -1
- data/lib/plaid/models/screening_hit_date_of_birth_item.rb +1 -1
- data/lib/plaid/models/screening_hit_documents_items.rb +1 -1
- data/lib/plaid/models/screening_hit_names_items.rb +1 -1
- data/lib/plaid/models/screening_status_updated_webhook.rb +1 -1
- data/lib/plaid/models/security.rb +1 -1
- data/lib/plaid/models/security_override.rb +1 -1
- data/lib/plaid/models/selfie_analysis.rb +224 -0
- data/lib/plaid/models/selfie_analysis_document_comparison.rb +40 -0
- data/lib/plaid/models/selfie_capture.rb +232 -0
- data/lib/plaid/models/selfie_check.rb +241 -0
- data/lib/plaid/models/selfie_check_selfie.rb +267 -0
- data/lib/plaid/models/selfie_check_status.rb +39 -0
- data/lib/plaid/models/selfie_status.rb +39 -0
- data/lib/plaid/models/sender_bacs_nullable.rb +1 -1
- data/lib/plaid/models/service.rb +1 -1
- data/lib/plaid/models/service_product_fulfillment.rb +1 -1
- data/lib/plaid/models/service_product_fulfillment_detail.rb +1 -1
- data/lib/plaid/models/service_product_fulfillment_identifier.rb +1 -1
- data/lib/plaid/models/servicer_address_data.rb +1 -1
- data/lib/plaid/models/services.rb +1 -1
- data/lib/plaid/models/signal_address_data.rb +1 -1
- data/lib/plaid/models/signal_decision_outcome.rb +1 -1
- data/lib/plaid/models/signal_decision_report_request.rb +1 -1
- data/lib/plaid/models/signal_decision_report_response.rb +1 -1
- data/lib/plaid/models/signal_device.rb +1 -1
- data/lib/plaid/models/signal_evaluate_core_attributes.rb +1 -1
- data/lib/plaid/models/signal_evaluate_request.rb +1 -1
- data/lib/plaid/models/signal_evaluate_response.rb +7 -2
- data/lib/plaid/models/signal_payment_method.rb +1 -1
- data/lib/plaid/models/signal_person_name.rb +1 -1
- data/lib/plaid/models/signal_prepare_request.rb +1 -1
- data/lib/plaid/models/signal_prepare_response.rb +1 -1
- data/lib/plaid/models/signal_return_report_request.rb +1 -1
- data/lib/plaid/models/signal_return_report_response.rb +1 -1
- data/lib/plaid/models/signal_scores.rb +1 -1
- data/lib/plaid/models/signal_user.rb +1 -1
- data/lib/plaid/models/signal_warning.rb +4 -4
- data/lib/plaid/models/simulated_transfer_sweep.rb +1 -1
- data/lib/plaid/models/single_document_risk_signal.rb +1 -1
- data/lib/plaid/models/source.rb +1 -1
- data/lib/plaid/models/standalone_account_type.rb +1 -1
- data/lib/plaid/models/standalone_currency_code_list.rb +1 -1
- data/lib/plaid/models/standalone_investment_transaction_type.rb +1 -1
- data/lib/plaid/models/status.rb +1 -1
- data/lib/plaid/models/statuses.rb +1 -1
- data/lib/plaid/models/strategy.rb +1 -1
- data/lib/plaid/models/student_loan.rb +1 -1
- data/lib/plaid/models/student_loan_repayment_model.rb +1 -1
- data/lib/plaid/models/student_loan_status.rb +1 -1
- data/lib/plaid/models/student_repayment_plan.rb +1 -1
- data/lib/plaid/models/sync_updates_available_webhook.rb +1 -1
- data/lib/plaid/models/taxform.rb +1 -1
- data/lib/plaid/models/taxpayer_id.rb +1 -1
- data/lib/plaid/models/taxpayer_identifier.rb +1 -1
- data/lib/plaid/models/taxpayer_identifier_type.rb +1 -1
- data/lib/plaid/models/taxpayer_identifiers.rb +1 -1
- data/lib/plaid/models/total.rb +1 -1
- data/lib/plaid/models/total_canonical_description.rb +1 -1
- data/lib/plaid/models/transaction.rb +1 -1
- data/lib/plaid/models/transaction_all_of.rb +1 -1
- data/lib/plaid/models/transaction_base.rb +1 -1
- data/lib/plaid/models/transaction_code.rb +1 -1
- data/lib/plaid/models/transaction_counterparty.rb +1 -1
- data/lib/plaid/models/transaction_data.rb +1 -1
- data/lib/plaid/models/transaction_override.rb +1 -1
- data/lib/plaid/models/transaction_stream.rb +1 -1
- data/lib/plaid/models/transaction_stream_amount.rb +1 -1
- data/lib/plaid/models/transaction_stream_status.rb +1 -1
- data/lib/plaid/models/transactions_category_rule.rb +1 -1
- data/lib/plaid/models/transactions_enhance_get_request.rb +1 -1
- data/lib/plaid/models/transactions_enhance_get_response.rb +1 -1
- data/lib/plaid/models/transactions_enrich_get_request.rb +1 -1
- data/lib/plaid/models/transactions_enrich_get_response.rb +1 -1
- data/lib/plaid/models/transactions_enrich_request_options.rb +1 -1
- data/lib/plaid/models/transactions_get_request.rb +1 -1
- data/lib/plaid/models/transactions_get_request_options.rb +1 -1
- data/lib/plaid/models/transactions_get_response.rb +1 -1
- data/lib/plaid/models/transactions_recurring_get_request.rb +1 -1
- data/lib/plaid/models/transactions_recurring_get_request_options.rb +1 -1
- data/lib/plaid/models/transactions_recurring_get_response.rb +1 -1
- data/lib/plaid/models/transactions_refresh_request.rb +1 -1
- data/lib/plaid/models/transactions_refresh_response.rb +1 -1
- data/lib/plaid/models/transactions_removed_webhook.rb +1 -1
- data/lib/plaid/models/transactions_rule_details.rb +1 -1
- data/lib/plaid/models/transactions_rule_field.rb +1 -1
- data/lib/plaid/models/transactions_rule_type.rb +1 -1
- data/lib/plaid/models/transactions_rules_create_request.rb +1 -1
- data/lib/plaid/models/transactions_rules_create_response.rb +1 -1
- data/lib/plaid/models/transactions_rules_list_request.rb +1 -1
- data/lib/plaid/models/transactions_rules_list_response.rb +1 -1
- data/lib/plaid/models/transactions_rules_remove_request.rb +1 -1
- data/lib/plaid/models/transactions_rules_remove_response.rb +1 -1
- data/lib/plaid/models/transactions_sync_request.rb +2 -2
- data/lib/plaid/models/transactions_sync_request_options.rb +1 -1
- data/lib/plaid/models/transactions_sync_response.rb +1 -1
- data/lib/plaid/models/transfer.rb +20 -25
- data/lib/plaid/models/transfer_authorization.rb +1 -1
- data/lib/plaid/models/transfer_authorization_create_request.rb +16 -6
- data/lib/plaid/models/transfer_authorization_create_response.rb +1 -1
- data/lib/plaid/models/transfer_authorization_decision.rb +1 -1
- data/lib/plaid/models/transfer_authorization_decision_rationale.rb +1 -1
- data/lib/plaid/models/transfer_authorization_decision_rationale_code.rb +1 -1
- data/lib/plaid/models/transfer_authorization_device.rb +3 -3
- data/lib/plaid/models/transfer_authorization_guarantee_decision.rb +1 -1
- data/lib/plaid/models/transfer_authorization_guarantee_decision_rationale.rb +1 -1
- data/lib/plaid/models/transfer_authorization_guarantee_decision_rationale_code.rb +1 -1
- data/lib/plaid/models/transfer_authorization_proposed_transfer.rb +18 -12
- data/lib/plaid/models/transfer_authorization_user_in_request.rb +1 -1
- data/lib/plaid/models/transfer_balance.rb +239 -0
- data/lib/plaid/models/transfer_balance_get_request.rb +244 -0
- data/lib/plaid/models/transfer_balance_get_response.rb +239 -0
- data/lib/plaid/models/transfer_balance_type.rb +39 -0
- data/lib/plaid/models/transfer_cancel_request.rb +1 -1
- data/lib/plaid/models/transfer_cancel_response.rb +1 -1
- data/lib/plaid/models/transfer_capabilities_get_request.rb +1 -1
- data/lib/plaid/models/transfer_capabilities_get_response.rb +1 -1
- data/lib/plaid/models/transfer_capabilities_get_rtp.rb +1 -1
- data/lib/plaid/models/transfer_configuration_get_request.rb +1 -1
- data/lib/plaid/models/transfer_configuration_get_response.rb +1 -1
- data/lib/plaid/models/transfer_create_request.rb +7 -7
- data/lib/plaid/models/transfer_create_response.rb +1 -1
- data/lib/plaid/models/transfer_credit_funds_source.rb +41 -0
- data/lib/plaid/models/transfer_credit_usage_configuration.rb +286 -0
- data/lib/plaid/models/transfer_debit_usage_configuration.rb +286 -0
- data/lib/plaid/models/transfer_device.rb +1 -1
- data/lib/plaid/models/transfer_diligence_status.rb +1 -1
- data/lib/plaid/models/transfer_diligence_submit_request.rb +259 -0
- data/lib/plaid/models/transfer_diligence_submit_response.rb +225 -0
- data/lib/plaid/models/transfer_event.rb +3 -7
- data/lib/plaid/models/transfer_event_list_request.rb +1 -1
- data/lib/plaid/models/transfer_event_list_response.rb +1 -1
- data/lib/plaid/models/transfer_event_list_transfer_type.rb +1 -1
- data/lib/plaid/models/transfer_event_sync_request.rb +1 -1
- data/lib/plaid/models/transfer_event_sync_response.rb +1 -1
- data/lib/plaid/models/transfer_event_type.rb +1 -1
- data/lib/plaid/models/transfer_events_update_webhook.rb +1 -1
- data/lib/plaid/models/transfer_expected_sweep_settlement_schedule_item.rb +240 -0
- data/lib/plaid/models/transfer_failure.rb +1 -1
- data/lib/plaid/models/transfer_get_request.rb +1 -1
- data/lib/plaid/models/transfer_get_response.rb +1 -1
- data/lib/plaid/models/transfer_intent_authorization_decision.rb +1 -1
- data/lib/plaid/models/transfer_intent_create.rb +1 -1
- data/lib/plaid/models/transfer_intent_create_mode.rb +1 -1
- data/lib/plaid/models/transfer_intent_create_network.rb +1 -1
- data/lib/plaid/models/transfer_intent_create_request.rb +1 -1
- data/lib/plaid/models/transfer_intent_create_response.rb +1 -1
- data/lib/plaid/models/transfer_intent_get.rb +1 -1
- data/lib/plaid/models/transfer_intent_get_failure_reason.rb +1 -1
- data/lib/plaid/models/transfer_intent_get_request.rb +1 -1
- data/lib/plaid/models/transfer_intent_get_response.rb +1 -1
- data/lib/plaid/models/transfer_intent_status.rb +1 -1
- data/lib/plaid/models/transfer_list_request.rb +1 -1
- data/lib/plaid/models/transfer_list_response.rb +1 -1
- data/lib/plaid/models/transfer_metrics_get_request.rb +1 -1
- data/lib/plaid/models/transfer_metrics_get_response.rb +1 -1
- data/lib/plaid/models/transfer_migrate_account_request.rb +1 -1
- data/lib/plaid/models/transfer_migrate_account_response.rb +1 -1
- data/lib/plaid/models/transfer_network.rb +1 -1
- data/lib/plaid/models/transfer_originator_address.rb +281 -0
- data/lib/plaid/models/transfer_originator_create_request.rb +1 -1
- data/lib/plaid/models/transfer_originator_create_response.rb +1 -1
- data/lib/plaid/models/transfer_originator_diligence.rb +304 -0
- data/lib/plaid/models/transfer_originator_get_request.rb +1 -1
- data/lib/plaid/models/transfer_originator_get_response.rb +1 -1
- data/lib/plaid/models/transfer_originator_list_request.rb +1 -1
- data/lib/plaid/models/transfer_originator_list_response.rb +1 -1
- data/lib/plaid/models/transfer_questionnaire_create_request.rb +1 -1
- data/lib/plaid/models/transfer_questionnaire_create_response.rb +1 -1
- data/lib/plaid/models/transfer_recurring_cancel_request.rb +1 -1
- data/lib/plaid/models/transfer_recurring_cancel_response.rb +1 -1
- data/lib/plaid/models/transfer_recurring_create_request.rb +1 -1
- data/lib/plaid/models/transfer_recurring_create_response.rb +1 -1
- data/lib/plaid/models/transfer_recurring_get_request.rb +1 -1
- data/lib/plaid/models/transfer_recurring_get_response.rb +1 -1
- data/lib/plaid/models/transfer_recurring_list_request.rb +1 -1
- data/lib/plaid/models/transfer_recurring_list_response.rb +1 -1
- data/lib/plaid/models/transfer_recurring_schedule.rb +1 -1
- data/lib/plaid/models/transfer_recurring_status.rb +1 -1
- data/lib/plaid/models/transfer_refund.rb +1 -1
- data/lib/plaid/models/transfer_refund_cancel_request.rb +1 -1
- data/lib/plaid/models/transfer_refund_cancel_response.rb +1 -1
- data/lib/plaid/models/transfer_refund_create_request.rb +1 -1
- data/lib/plaid/models/transfer_refund_create_response.rb +1 -1
- data/lib/plaid/models/transfer_refund_get_request.rb +1 -1
- data/lib/plaid/models/transfer_refund_get_response.rb +1 -1
- data/lib/plaid/models/transfer_refund_status.rb +1 -1
- data/lib/plaid/models/transfer_repayment.rb +1 -1
- data/lib/plaid/models/transfer_repayment_list_request.rb +1 -1
- data/lib/plaid/models/transfer_repayment_list_response.rb +1 -1
- data/lib/plaid/models/transfer_repayment_return.rb +1 -1
- data/lib/plaid/models/transfer_repayment_return_list_request.rb +1 -1
- data/lib/plaid/models/transfer_repayment_return_list_response.rb +1 -1
- data/lib/plaid/models/transfer_schedule_interval_unit.rb +1 -1
- data/lib/plaid/models/transfer_status.rb +1 -1
- data/lib/plaid/models/transfer_sweep.rb +1 -1
- data/lib/plaid/models/transfer_sweep_get_request.rb +1 -1
- data/lib/plaid/models/transfer_sweep_get_response.rb +1 -1
- data/lib/plaid/models/transfer_sweep_list_request.rb +1 -1
- data/lib/plaid/models/transfer_sweep_list_response.rb +1 -1
- data/lib/plaid/models/transfer_sweep_status.rb +1 -1
- data/lib/plaid/models/transfer_test_clock.rb +1 -1
- data/lib/plaid/models/transfer_type.rb +1 -1
- data/lib/plaid/models/transfer_user_address_in_request.rb +1 -1
- data/lib/plaid/models/transfer_user_address_in_response.rb +1 -1
- data/lib/plaid/models/transfer_user_in_request.rb +1 -1
- data/lib/plaid/models/transfer_user_in_request_deprecated.rb +1 -1
- data/lib/plaid/models/transfer_user_in_response.rb +1 -1
- data/lib/plaid/models/update_entity_screening_request_search_terms.rb +1 -1
- data/lib/plaid/models/update_individual_screening_request_search_terms.rb +1 -1
- data/lib/plaid/models/user_address.rb +1 -1
- data/lib/plaid/models/user_create_request.rb +1 -1
- data/lib/plaid/models/user_create_response.rb +1 -1
- data/lib/plaid/models/user_custom_password.rb +1 -1
- data/lib/plaid/models/user_id_number.rb +1 -1
- data/lib/plaid/models/user_permission_revoked_webhook.rb +1 -1
- data/lib/plaid/models/user_stated_income_source_category.rb +1 -1
- data/lib/plaid/models/user_stated_income_source_frequency.rb +1 -1
- data/lib/plaid/models/user_stated_income_source_pay_type.rb +1 -1
- data/lib/plaid/models/validation_source.rb +1 -1
- data/lib/plaid/models/validation_sources.rb +1 -1
- data/lib/plaid/models/verification_expired_webhook.rb +1 -1
- data/lib/plaid/models/verification_of_asset.rb +1 -1
- data/lib/plaid/models/verification_of_asset_response.rb +1 -1
- data/lib/plaid/models/verification_refresh_status.rb +1 -1
- data/lib/plaid/models/verification_status.rb +1 -1
- data/lib/plaid/models/w2.rb +1 -1
- data/lib/plaid/models/w2_box12.rb +1 -1
- data/lib/plaid/models/w2_state_and_local_wages.rb +1 -1
- data/lib/plaid/models/wallet.rb +1 -1
- data/lib/plaid/models/wallet_balance.rb +1 -1
- data/lib/plaid/models/wallet_create_request.rb +1 -1
- data/lib/plaid/models/wallet_create_response.rb +1 -1
- data/lib/plaid/models/wallet_get_request.rb +1 -1
- data/lib/plaid/models/wallet_get_response.rb +1 -1
- data/lib/plaid/models/wallet_iso_currency_code.rb +1 -1
- data/lib/plaid/models/wallet_list_request.rb +1 -1
- data/lib/plaid/models/wallet_list_response.rb +1 -1
- data/lib/plaid/models/wallet_numbers.rb +1 -1
- data/lib/plaid/models/wallet_status.rb +1 -1
- data/lib/plaid/models/wallet_transaction.rb +1 -1
- data/lib/plaid/models/wallet_transaction_amount.rb +1 -1
- data/lib/plaid/models/wallet_transaction_counterparty.rb +1 -1
- data/lib/plaid/models/wallet_transaction_counterparty_bacs.rb +1 -1
- data/lib/plaid/models/wallet_transaction_counterparty_international.rb +1 -1
- data/lib/plaid/models/wallet_transaction_counterparty_numbers.rb +1 -1
- data/lib/plaid/models/wallet_transaction_execute_request.rb +1 -1
- data/lib/plaid/models/wallet_transaction_execute_response.rb +1 -1
- data/lib/plaid/models/wallet_transaction_get_request.rb +1 -1
- data/lib/plaid/models/wallet_transaction_get_response.rb +1 -1
- data/lib/plaid/models/wallet_transaction_list_request.rb +1 -1
- data/lib/plaid/models/wallet_transaction_list_request_options.rb +1 -1
- data/lib/plaid/models/wallet_transaction_list_response.rb +1 -1
- data/lib/plaid/models/wallet_transaction_status.rb +1 -1
- data/lib/plaid/models/wallet_transaction_status_update_webhook.rb +1 -1
- data/lib/plaid/models/wallet_transactions_list_request.rb +1 -1
- data/lib/plaid/models/warning.rb +1 -1
- data/lib/plaid/models/watchlist_screening_audit_trail.rb +1 -1
- data/lib/plaid/models/watchlist_screening_document.rb +1 -1
- data/lib/plaid/models/watchlist_screening_document_type.rb +1 -1
- data/lib/plaid/models/watchlist_screening_entity_create_request.rb +2 -2
- data/lib/plaid/models/watchlist_screening_entity_create_response.rb +2 -2
- data/lib/plaid/models/watchlist_screening_entity_get_request.rb +1 -1
- data/lib/plaid/models/watchlist_screening_entity_get_response.rb +2 -2
- data/lib/plaid/models/watchlist_screening_entity_history_list_request.rb +1 -1
- data/lib/plaid/models/watchlist_screening_entity_history_list_response.rb +1 -1
- data/lib/plaid/models/watchlist_screening_entity_hit_list_request.rb +1 -1
- data/lib/plaid/models/watchlist_screening_entity_hit_list_response.rb +1 -1
- data/lib/plaid/models/watchlist_screening_entity_list_request.rb +2 -2
- data/lib/plaid/models/watchlist_screening_entity_list_response.rb +1 -1
- data/lib/plaid/models/watchlist_screening_entity_program_get_request.rb +1 -1
- data/lib/plaid/models/watchlist_screening_entity_program_get_response.rb +1 -1
- data/lib/plaid/models/watchlist_screening_entity_program_list_request.rb +1 -1
- data/lib/plaid/models/watchlist_screening_entity_program_list_response.rb +1 -1
- data/lib/plaid/models/watchlist_screening_entity_review_create_request.rb +1 -1
- data/lib/plaid/models/watchlist_screening_entity_review_create_response.rb +1 -1
- data/lib/plaid/models/watchlist_screening_entity_review_list_request.rb +1 -1
- data/lib/plaid/models/watchlist_screening_entity_review_list_response.rb +1 -1
- data/lib/plaid/models/watchlist_screening_entity_update_request.rb +2 -2
- data/lib/plaid/models/watchlist_screening_entity_update_request_resettable_field.rb +1 -1
- data/lib/plaid/models/watchlist_screening_entity_update_response.rb +2 -2
- data/lib/plaid/models/watchlist_screening_hit.rb +1 -1
- data/lib/plaid/models/watchlist_screening_hit_locations.rb +1 -1
- data/lib/plaid/models/watchlist_screening_hit_status.rb +1 -1
- data/lib/plaid/models/watchlist_screening_individual.rb +2 -2
- data/lib/plaid/models/watchlist_screening_individual_create_request.rb +2 -2
- data/lib/plaid/models/watchlist_screening_individual_create_response.rb +2 -2
- data/lib/plaid/models/watchlist_screening_individual_get_request.rb +1 -1
- data/lib/plaid/models/watchlist_screening_individual_get_response.rb +2 -2
- data/lib/plaid/models/watchlist_screening_individual_history_list_request.rb +1 -1
- data/lib/plaid/models/watchlist_screening_individual_history_list_response.rb +1 -1
- data/lib/plaid/models/watchlist_screening_individual_hit_list_request.rb +1 -1
- data/lib/plaid/models/watchlist_screening_individual_hit_list_response.rb +1 -1
- data/lib/plaid/models/watchlist_screening_individual_list_request.rb +2 -2
- data/lib/plaid/models/watchlist_screening_individual_list_response.rb +1 -1
- data/lib/plaid/models/watchlist_screening_individual_program_get_request.rb +1 -1
- data/lib/plaid/models/watchlist_screening_individual_program_get_response.rb +1 -1
- data/lib/plaid/models/watchlist_screening_individual_program_list_request.rb +1 -1
- data/lib/plaid/models/watchlist_screening_individual_program_list_response.rb +1 -1
- data/lib/plaid/models/watchlist_screening_individual_review_create_request.rb +1 -1
- data/lib/plaid/models/watchlist_screening_individual_review_create_response.rb +1 -1
- data/lib/plaid/models/watchlist_screening_individual_review_list_request.rb +1 -1
- data/lib/plaid/models/watchlist_screening_individual_review_list_response.rb +1 -1
- data/lib/plaid/models/watchlist_screening_individual_update_request.rb +2 -2
- data/lib/plaid/models/watchlist_screening_individual_update_request_resettable_field.rb +1 -1
- data/lib/plaid/models/watchlist_screening_individual_update_response.rb +2 -2
- data/lib/plaid/models/watchlist_screening_request_search_terms.rb +1 -1
- data/lib/plaid/models/watchlist_screening_review.rb +1 -1
- data/lib/plaid/models/watchlist_screening_search_terms.rb +2 -2
- data/lib/plaid/models/watchlist_screening_status.rb +1 -1
- data/lib/plaid/models/weak_alias_determination.rb +1 -1
- data/lib/plaid/models/webhook_environment_values.rb +1 -1
- data/lib/plaid/models/webhook_type.rb +2 -1
- data/lib/plaid/models/webhook_update_acknowledged_webhook.rb +1 -1
- data/lib/plaid/models/webhook_verification_key_get_request.rb +1 -1
- data/lib/plaid/models/webhook_verification_key_get_response.rb +1 -1
- data/lib/plaid/models/ytd_gross_income_summary_field_number.rb +1 -1
- data/lib/plaid/models/ytd_net_income_summary_field_number.rb +1 -1
- data/lib/plaid/version.rb +2 -2
- data/lib/plaid.rb +42 -2
- data/plaid.gemspec +1 -1
- metadata +43 -3
data/lib/plaid/api/plaid_api.rb
CHANGED
@@ -3,7 +3,7 @@
|
|
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.370.0
|
7
7
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
9
9
|
OpenAPI Generator version: 5.1.1
|
@@ -605,7 +605,7 @@ module Plaid
|
|
605
605
|
end
|
606
606
|
|
607
607
|
# Retrieve a PDF Asset Report
|
608
|
-
# The `/asset_report/pdf/get` endpoint retrieves the Asset Report in PDF format. Before calling `/asset_report/pdf/get`, you must first create the Asset Report using `/asset_report/create` (or filter an Asset Report using `/asset_report/filter`) and then wait for the [`PRODUCT_READY`](https://plaid.com/docs/api/products/assets/#product_ready) webhook to fire, indicating that the Report is ready to be retrieved. The response to `/asset_report/pdf/get` is the PDF binary data. The `request_id` is returned in the `Plaid-Request-ID` header. If report_type was set to `VERIFICATION_OF_EMPLOYMENT` when the Asset Report was created in asset_report/create
|
608
|
+
# The `/asset_report/pdf/get` endpoint retrieves the Asset Report in PDF format. Before calling `/asset_report/pdf/get`, you must first create the Asset Report using `/asset_report/create` (or filter an Asset Report using `/asset_report/filter`) and then wait for the [`PRODUCT_READY`](https://plaid.com/docs/api/products/assets/#product_ready) webhook to fire, indicating that the Report is ready to be retrieved. The response to `/asset_report/pdf/get` is the PDF binary data. The `request_id` is returned in the `Plaid-Request-ID` header. If `report_type` was set to `VERIFICATION_OF_EMPLOYMENT` when the Asset Report was created in `/asset_report/create`, debit transactions and transaction amounts won’t be included in the report. [View a sample PDF Asset Report](https://plaid.com/documents/sample-asset-report.pdf).
|
609
609
|
# @param asset_report_pdf_get_request [AssetReportPDFGetRequest]
|
610
610
|
# @param [Hash] opts the optional parameters
|
611
611
|
# @return [File]
|
@@ -615,7 +615,7 @@ module Plaid
|
|
615
615
|
end
|
616
616
|
|
617
617
|
# Retrieve a PDF Asset Report
|
618
|
-
# The `/asset_report/pdf/get` endpoint retrieves the Asset Report in PDF format. Before calling `/asset_report/pdf/get`, you must first create the Asset Report using `/asset_report/create` (or filter an Asset Report using `/asset_report/filter`) and then wait for the [`PRODUCT_READY`](https://plaid.com/docs/api/products/assets/#product_ready) webhook to fire, indicating that the Report is ready to be retrieved. The response to `/asset_report/pdf/get` is the PDF binary data. The `request_id` is returned in the `Plaid-Request-ID` header. If report_type was set to `VERIFICATION_OF_EMPLOYMENT` when the Asset Report was created in asset_report/create
|
618
|
+
# The `/asset_report/pdf/get` endpoint retrieves the Asset Report in PDF format. Before calling `/asset_report/pdf/get`, you must first create the Asset Report using `/asset_report/create` (or filter an Asset Report using `/asset_report/filter`) and then wait for the [`PRODUCT_READY`](https://plaid.com/docs/api/products/assets/#product_ready) webhook to fire, indicating that the Report is ready to be retrieved. The response to `/asset_report/pdf/get` is the PDF binary data. The `request_id` is returned in the `Plaid-Request-ID` header. If `report_type` was set to `VERIFICATION_OF_EMPLOYMENT` when the Asset Report was created in `/asset_report/create`, debit transactions and transaction amounts won’t be included in the report. [View a sample PDF Asset Report](https://plaid.com/documents/sample-asset-report.pdf).
|
619
619
|
# @param asset_report_pdf_get_request [AssetReportPDFGetRequest]
|
620
620
|
# @param [Hash] opts the optional parameters
|
621
621
|
# @return [Array<(File, Integer, Hash)>] File data, response status code and response headers
|
@@ -2036,26 +2036,26 @@ module Plaid
|
|
2036
2036
|
|
2037
2037
|
# Refresh a user's bank income information
|
2038
2038
|
# `/credit/bank_income/refresh` refreshes the bank income report data for a specific user.
|
2039
|
-
# @param
|
2039
|
+
# @param credit_bank_income_refresh_request [CreditBankIncomeRefreshRequest]
|
2040
2040
|
# @param [Hash] opts the optional parameters
|
2041
2041
|
# @return [CreditBankIncomeRefreshResponse]
|
2042
|
-
def credit_bank_income_refresh(
|
2043
|
-
data, _status_code, _headers = credit_bank_income_refresh_with_http_info(
|
2042
|
+
def credit_bank_income_refresh(credit_bank_income_refresh_request, opts = {})
|
2043
|
+
data, _status_code, _headers = credit_bank_income_refresh_with_http_info(credit_bank_income_refresh_request, opts)
|
2044
2044
|
data
|
2045
2045
|
end
|
2046
2046
|
|
2047
2047
|
# Refresh a user's bank income information
|
2048
2048
|
# `/credit/bank_income/refresh` refreshes the bank income report data for a specific user.
|
2049
|
-
# @param
|
2049
|
+
# @param credit_bank_income_refresh_request [CreditBankIncomeRefreshRequest]
|
2050
2050
|
# @param [Hash] opts the optional parameters
|
2051
2051
|
# @return [Array<(CreditBankIncomeRefreshResponse, Integer, Hash)>] CreditBankIncomeRefreshResponse data, response status code and response headers
|
2052
|
-
def credit_bank_income_refresh_with_http_info(
|
2052
|
+
def credit_bank_income_refresh_with_http_info(credit_bank_income_refresh_request, opts = {})
|
2053
2053
|
if @api_client.config.debugging
|
2054
2054
|
@api_client.config.logger.debug 'Calling API: PlaidApi.credit_bank_income_refresh ...'
|
2055
2055
|
end
|
2056
|
-
# verify the required parameter '
|
2057
|
-
if @api_client.config.client_side_validation &&
|
2058
|
-
fail ArgumentError, "Missing the required parameter '
|
2056
|
+
# verify the required parameter 'credit_bank_income_refresh_request' is set
|
2057
|
+
if @api_client.config.client_side_validation && credit_bank_income_refresh_request.nil?
|
2058
|
+
fail ArgumentError, "Missing the required parameter 'credit_bank_income_refresh_request' when calling PlaidApi.credit_bank_income_refresh"
|
2059
2059
|
end
|
2060
2060
|
# resource path
|
2061
2061
|
local_var_path = '/credit/bank_income/refresh'
|
@@ -2074,7 +2074,7 @@ module Plaid
|
|
2074
2074
|
form_params = opts[:form_params] || {}
|
2075
2075
|
|
2076
2076
|
# http body (model)
|
2077
|
-
post_body = opts[:debug_body] || @api_client.object_to_http_body(
|
2077
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(credit_bank_income_refresh_request)
|
2078
2078
|
|
2079
2079
|
# return_type
|
2080
2080
|
return_type = opts[:debug_return_type] || 'CreditBankIncomeRefreshResponse'
|
@@ -2166,26 +2166,26 @@ module Plaid
|
|
2166
2166
|
|
2167
2167
|
# Retrieve an Asset Report with Freddie Mac format (aka VOA - Verification Of Assets), and a Verification Of Employment (VOE) report if this one is available. Only Freddie Mac can use this endpoint.
|
2168
2168
|
# The `credit/asset_report/freddie_mac/get` endpoint retrieves the Verification of Assets and Verification of Employment reports.
|
2169
|
-
# @param
|
2169
|
+
# @param credit_freddie_mac_reports_get_request [CreditFreddieMacReportsGetRequest]
|
2170
2170
|
# @param [Hash] opts the optional parameters
|
2171
2171
|
# @return [CreditFreddieMacReportsGetResponse]
|
2172
|
-
def credit_freddie_mac_reports_get(
|
2173
|
-
data, _status_code, _headers = credit_freddie_mac_reports_get_with_http_info(
|
2172
|
+
def credit_freddie_mac_reports_get(credit_freddie_mac_reports_get_request, opts = {})
|
2173
|
+
data, _status_code, _headers = credit_freddie_mac_reports_get_with_http_info(credit_freddie_mac_reports_get_request, opts)
|
2174
2174
|
data
|
2175
2175
|
end
|
2176
2176
|
|
2177
2177
|
# Retrieve an Asset Report with Freddie Mac format (aka VOA - Verification Of Assets), and a Verification Of Employment (VOE) report if this one is available. Only Freddie Mac can use this endpoint.
|
2178
2178
|
# The `credit/asset_report/freddie_mac/get` endpoint retrieves the Verification of Assets and Verification of Employment reports.
|
2179
|
-
# @param
|
2179
|
+
# @param credit_freddie_mac_reports_get_request [CreditFreddieMacReportsGetRequest]
|
2180
2180
|
# @param [Hash] opts the optional parameters
|
2181
2181
|
# @return [Array<(CreditFreddieMacReportsGetResponse, Integer, Hash)>] CreditFreddieMacReportsGetResponse data, response status code and response headers
|
2182
|
-
def credit_freddie_mac_reports_get_with_http_info(
|
2182
|
+
def credit_freddie_mac_reports_get_with_http_info(credit_freddie_mac_reports_get_request, opts = {})
|
2183
2183
|
if @api_client.config.debugging
|
2184
2184
|
@api_client.config.logger.debug 'Calling API: PlaidApi.credit_freddie_mac_reports_get ...'
|
2185
2185
|
end
|
2186
|
-
# verify the required parameter '
|
2187
|
-
if @api_client.config.client_side_validation &&
|
2188
|
-
fail ArgumentError, "Missing the required parameter '
|
2186
|
+
# verify the required parameter 'credit_freddie_mac_reports_get_request' is set
|
2187
|
+
if @api_client.config.client_side_validation && credit_freddie_mac_reports_get_request.nil?
|
2188
|
+
fail ArgumentError, "Missing the required parameter 'credit_freddie_mac_reports_get_request' when calling PlaidApi.credit_freddie_mac_reports_get"
|
2189
2189
|
end
|
2190
2190
|
# resource path
|
2191
2191
|
local_var_path = '/credit/freddie_mac/reports/get'
|
@@ -2204,7 +2204,7 @@ module Plaid
|
|
2204
2204
|
form_params = opts[:form_params] || {}
|
2205
2205
|
|
2206
2206
|
# http body (model)
|
2207
|
-
post_body = opts[:debug_body] || @api_client.object_to_http_body(
|
2207
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(credit_freddie_mac_reports_get_request)
|
2208
2208
|
|
2209
2209
|
# return_type
|
2210
2210
|
return_type = opts[:debug_return_type] || 'CreditFreddieMacReportsGetResponse'
|
@@ -2424,6 +2424,71 @@ module Plaid
|
|
2424
2424
|
return data, status_code, headers
|
2425
2425
|
end
|
2426
2426
|
|
2427
|
+
# Retrieve fraud insights for a user's manually uploaded document(s).
|
2428
|
+
# `/credit/payroll_income/risk_signals/get` can be used as part of the Document Income flow to assess a user-uploaded document for signs of potential fraud or tampering. It returns a risk score for each uploaded document that indicates the likelihood of the document being fraudulent, in addition to details on the individual risk signals contributing to the score. `/credit/payroll_income/risk_signals/get` can be called at any time after the `INCOME_VERIFICATION` webhook has been fired. `/credit/payroll_income/risk_signals/get` is offered as an add-on to Document Income and is billed separately. To request access to this endpoint, submit a product access request or contact your Plaid account manager.
|
2429
|
+
# @param credit_payroll_income_risk_signals_get_request [CreditPayrollIncomeRiskSignalsGetRequest]
|
2430
|
+
# @param [Hash] opts the optional parameters
|
2431
|
+
# @return [CreditPayrollIncomeRiskSignalsGetResponse]
|
2432
|
+
def credit_payroll_income_risk_signals_get(credit_payroll_income_risk_signals_get_request, opts = {})
|
2433
|
+
data, _status_code, _headers = credit_payroll_income_risk_signals_get_with_http_info(credit_payroll_income_risk_signals_get_request, opts)
|
2434
|
+
data
|
2435
|
+
end
|
2436
|
+
|
2437
|
+
# Retrieve fraud insights for a user's manually uploaded document(s).
|
2438
|
+
# `/credit/payroll_income/risk_signals/get` can be used as part of the Document Income flow to assess a user-uploaded document for signs of potential fraud or tampering. It returns a risk score for each uploaded document that indicates the likelihood of the document being fraudulent, in addition to details on the individual risk signals contributing to the score. `/credit/payroll_income/risk_signals/get` can be called at any time after the `INCOME_VERIFICATION` webhook has been fired. `/credit/payroll_income/risk_signals/get` is offered as an add-on to Document Income and is billed separately. To request access to this endpoint, submit a product access request or contact your Plaid account manager.
|
2439
|
+
# @param credit_payroll_income_risk_signals_get_request [CreditPayrollIncomeRiskSignalsGetRequest]
|
2440
|
+
# @param [Hash] opts the optional parameters
|
2441
|
+
# @return [Array<(CreditPayrollIncomeRiskSignalsGetResponse, Integer, Hash)>] CreditPayrollIncomeRiskSignalsGetResponse data, response status code and response headers
|
2442
|
+
def credit_payroll_income_risk_signals_get_with_http_info(credit_payroll_income_risk_signals_get_request, opts = {})
|
2443
|
+
if @api_client.config.debugging
|
2444
|
+
@api_client.config.logger.debug 'Calling API: PlaidApi.credit_payroll_income_risk_signals_get ...'
|
2445
|
+
end
|
2446
|
+
# verify the required parameter 'credit_payroll_income_risk_signals_get_request' is set
|
2447
|
+
if @api_client.config.client_side_validation && credit_payroll_income_risk_signals_get_request.nil?
|
2448
|
+
fail ArgumentError, "Missing the required parameter 'credit_payroll_income_risk_signals_get_request' when calling PlaidApi.credit_payroll_income_risk_signals_get"
|
2449
|
+
end
|
2450
|
+
# resource path
|
2451
|
+
local_var_path = '/credit/payroll_income/risk_signals/get'
|
2452
|
+
|
2453
|
+
# query parameters
|
2454
|
+
query_params = opts[:query_params] || {}
|
2455
|
+
|
2456
|
+
# header parameters
|
2457
|
+
header_params = opts[:header_params] || {}
|
2458
|
+
# HTTP header 'Accept' (if needed)
|
2459
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
2460
|
+
# HTTP header 'Content-Type'
|
2461
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
2462
|
+
|
2463
|
+
# form parameters
|
2464
|
+
form_params = opts[:form_params] || {}
|
2465
|
+
|
2466
|
+
# http body (model)
|
2467
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(credit_payroll_income_risk_signals_get_request)
|
2468
|
+
|
2469
|
+
# return_type
|
2470
|
+
return_type = opts[:debug_return_type] || 'CreditPayrollIncomeRiskSignalsGetResponse'
|
2471
|
+
|
2472
|
+
# auth_names
|
2473
|
+
auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
|
2474
|
+
|
2475
|
+
new_options = opts.merge(
|
2476
|
+
:operation => :"PlaidApi.credit_payroll_income_risk_signals_get",
|
2477
|
+
:header_params => header_params,
|
2478
|
+
:query_params => query_params,
|
2479
|
+
:form_params => form_params,
|
2480
|
+
:body => post_body,
|
2481
|
+
:auth_names => auth_names,
|
2482
|
+
:return_type => return_type
|
2483
|
+
)
|
2484
|
+
|
2485
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
2486
|
+
if @api_client.config.debugging
|
2487
|
+
@api_client.config.logger.debug "API called: PlaidApi#credit_payroll_income_risk_signals_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
2488
|
+
end
|
2489
|
+
return data, status_code, headers
|
2490
|
+
end
|
2491
|
+
|
2427
2492
|
# Create a relay token to share an Asset Report with a partner client (beta)
|
2428
2493
|
# Plaid can share an Asset Report directly with a participating third party on your behalf. The shared Asset Report is the exact same Asset Report originally created in `/asset_report/create`. To grant a third party access to an Asset Report, use the `/credit/relay/create` endpoint to create a `relay_token` and then pass that token to your third party. Each third party has its own `secondary_client_id`; for example, `ce5bd328dcd34123456`. You'll need to create a separate `relay_token` for each third party that needs access to the report on your behalf.
|
2429
2494
|
# @param credit_relay_create_request [CreditRelayCreateRequest]
|
@@ -3530,7 +3595,7 @@ module Plaid
|
|
3530
3595
|
end
|
3531
3596
|
|
3532
3597
|
# Create a new identity verification
|
3533
|
-
# Create a new Identity Verification for the user specified by the `client_user_id` field. The requirements and behavior of the verification are determined by the `template_id` provided. If you don't know whether the associated user already has an active Identity Verification, you can specify `\"is_idempotent\": true` in the request body. With idempotency enabled, a new Identity Verification will only be created if one does not already exist for the associated `client_user_id` and `template_id`. If an Identity Verification is found, it will be returned unmodified with an `200 OK` HTTP status code.
|
3598
|
+
# Create a new Identity Verification for the user specified by the `client_user_id` field. The requirements and behavior of the verification are determined by the `template_id` provided. If you don't know whether the associated user already has an active Identity Verification, you can specify `\"is_idempotent\": true` in the request body. With idempotency enabled, a new Identity Verification will only be created if one does not already exist for the associated `client_user_id` and `template_id`. If an Identity Verification is found, it will be returned unmodified with an `200 OK` HTTP status code. You can also use this endpoint to supply information you already have collected about the user; if any of these fields are specified, the screens prompting the user to enter them will be skipped during the Link flow.
|
3534
3599
|
# @param identity_verification_create_request [IdentityVerificationCreateRequest]
|
3535
3600
|
# @param [Hash] opts the optional parameters
|
3536
3601
|
# @return [IdentityVerificationCreateResponse]
|
@@ -3540,7 +3605,7 @@ module Plaid
|
|
3540
3605
|
end
|
3541
3606
|
|
3542
3607
|
# Create a new identity verification
|
3543
|
-
# Create a new Identity Verification for the user specified by the `client_user_id` field. The requirements and behavior of the verification are determined by the `template_id` provided. If you don't know whether the associated user already has an active Identity Verification, you can specify `\"is_idempotent\": true` in the request body. With idempotency enabled, a new Identity Verification will only be created if one does not already exist for the associated `client_user_id` and `template_id`. If an Identity Verification is found, it will be returned unmodified with an `200 OK` HTTP status code.
|
3608
|
+
# Create a new Identity Verification for the user specified by the `client_user_id` field. The requirements and behavior of the verification are determined by the `template_id` provided. If you don't know whether the associated user already has an active Identity Verification, you can specify `\"is_idempotent\": true` in the request body. With idempotency enabled, a new Identity Verification will only be created if one does not already exist for the associated `client_user_id` and `template_id`. If an Identity Verification is found, it will be returned unmodified with an `200 OK` HTTP status code. You can also use this endpoint to supply information you already have collected about the user; if any of these fields are specified, the screens prompting the user to enter them will be skipped during the Link flow.
|
3544
3609
|
# @param identity_verification_create_request [IdentityVerificationCreateRequest]
|
3545
3610
|
# @param [Hash] opts the optional parameters
|
3546
3611
|
# @return [Array<(IdentityVerificationCreateResponse, Integer, Hash)>] IdentityVerificationCreateResponse data, response status code and response headers
|
@@ -4051,26 +4116,26 @@ module Plaid
|
|
4051
4116
|
|
4052
4117
|
# (Deprecated) Retrieve information from the tax documents used for income verification
|
4053
4118
|
# `/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.
|
4054
|
-
# @param
|
4119
|
+
# @param income_verification_taxforms_get_request [IncomeVerificationTaxformsGetRequest]
|
4055
4120
|
# @param [Hash] opts the optional parameters
|
4056
4121
|
# @return [IncomeVerificationTaxformsGetResponse]
|
4057
|
-
def income_verification_taxforms_get(
|
4058
|
-
data, _status_code, _headers = income_verification_taxforms_get_with_http_info(
|
4122
|
+
def income_verification_taxforms_get(income_verification_taxforms_get_request, opts = {})
|
4123
|
+
data, _status_code, _headers = income_verification_taxforms_get_with_http_info(income_verification_taxforms_get_request, opts)
|
4059
4124
|
data
|
4060
4125
|
end
|
4061
4126
|
|
4062
4127
|
# (Deprecated) Retrieve information from the tax documents used for income verification
|
4063
4128
|
# `/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.
|
4064
|
-
# @param
|
4129
|
+
# @param income_verification_taxforms_get_request [IncomeVerificationTaxformsGetRequest]
|
4065
4130
|
# @param [Hash] opts the optional parameters
|
4066
4131
|
# @return [Array<(IncomeVerificationTaxformsGetResponse, Integer, Hash)>] IncomeVerificationTaxformsGetResponse data, response status code and response headers
|
4067
|
-
def income_verification_taxforms_get_with_http_info(
|
4132
|
+
def income_verification_taxforms_get_with_http_info(income_verification_taxforms_get_request, opts = {})
|
4068
4133
|
if @api_client.config.debugging
|
4069
4134
|
@api_client.config.logger.debug 'Calling API: PlaidApi.income_verification_taxforms_get ...'
|
4070
4135
|
end
|
4071
|
-
# verify the required parameter '
|
4072
|
-
if @api_client.config.client_side_validation &&
|
4073
|
-
fail ArgumentError, "Missing the required parameter '
|
4136
|
+
# verify the required parameter 'income_verification_taxforms_get_request' is set
|
4137
|
+
if @api_client.config.client_side_validation && income_verification_taxforms_get_request.nil?
|
4138
|
+
fail ArgumentError, "Missing the required parameter 'income_verification_taxforms_get_request' when calling PlaidApi.income_verification_taxforms_get"
|
4074
4139
|
end
|
4075
4140
|
# resource path
|
4076
4141
|
local_var_path = '/income/verification/taxforms/get'
|
@@ -4089,7 +4154,7 @@ module Plaid
|
|
4089
4154
|
form_params = opts[:form_params] || {}
|
4090
4155
|
|
4091
4156
|
# http body (model)
|
4092
|
-
post_body = opts[:debug_body] || @api_client.object_to_http_body(
|
4157
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(income_verification_taxforms_get_request)
|
4093
4158
|
|
4094
4159
|
# return_type
|
4095
4160
|
return_type = opts[:debug_return_type] || 'IncomeVerificationTaxformsGetResponse'
|
@@ -4374,6 +4439,71 @@ module Plaid
|
|
4374
4439
|
return data, status_code, headers
|
4375
4440
|
end
|
4376
4441
|
|
4442
|
+
# Refresh investment data
|
4443
|
+
# `/investments/refresh` is an optional endpoint for users of the Investments product. It initiates an on-demand extraction to fetch the newest investments, holdings and investment transactions for an Item. This on-demand extraction takes place in addition to the periodic extractions that automatically occur multiple times a day for any Investments-enabled Item. If changes to investments are discovered after calling `/investments/refresh`, Plaid will fire webhooks: [`HOLDINGS: DEFAULT_UPDATE`](https://plaid.com/docs/api/products/investments/#holdings-default_update) if any new holdings are detected, and [INVESTMENTS_TRANSACTIONS: DEFAULT_UPDATE](https://plaid.com/docs/api/products/investments/#investments_transactions-default_update) if any new investment transactions are detected. Updated holdings and investment transactions can be fetched by calling `/investments/holdings/get` and `/investments/transactions/get`. \"Note that the `/investments/refresh` endpoint is not supported by all institutions. If called on an Item from an institution that does not support this functionality, it will return a `PRODUCT_NOT_SUPPORTED` error. `/investments/refresh` is offered as an add-on to Investments and has a separate [fee model](/docs/account/billing/#per-request-flat-fee). To request access to this endpoint, submit a [product access request](https://dashboard.plaid.com/team/products) or contact your Plaid account manager.
|
4444
|
+
# @param investments_refresh_request [InvestmentsRefreshRequest]
|
4445
|
+
# @param [Hash] opts the optional parameters
|
4446
|
+
# @return [InvestmentsRefreshResponse]
|
4447
|
+
def investments_refresh(investments_refresh_request, opts = {})
|
4448
|
+
data, _status_code, _headers = investments_refresh_with_http_info(investments_refresh_request, opts)
|
4449
|
+
data
|
4450
|
+
end
|
4451
|
+
|
4452
|
+
# Refresh investment data
|
4453
|
+
# `/investments/refresh` is an optional endpoint for users of the Investments product. It initiates an on-demand extraction to fetch the newest investments, holdings and investment transactions for an Item. This on-demand extraction takes place in addition to the periodic extractions that automatically occur multiple times a day for any Investments-enabled Item. If changes to investments are discovered after calling `/investments/refresh`, Plaid will fire webhooks: [`HOLDINGS: DEFAULT_UPDATE`](https://plaid.com/docs/api/products/investments/#holdings-default_update) if any new holdings are detected, and [INVESTMENTS_TRANSACTIONS: DEFAULT_UPDATE](https://plaid.com/docs/api/products/investments/#investments_transactions-default_update) if any new investment transactions are detected. Updated holdings and investment transactions can be fetched by calling `/investments/holdings/get` and `/investments/transactions/get`. \"Note that the `/investments/refresh` endpoint is not supported by all institutions. If called on an Item from an institution that does not support this functionality, it will return a `PRODUCT_NOT_SUPPORTED` error. `/investments/refresh` is offered as an add-on to Investments and has a separate [fee model](/docs/account/billing/#per-request-flat-fee). To request access to this endpoint, submit a [product access request](https://dashboard.plaid.com/team/products) or contact your Plaid account manager.
|
4454
|
+
# @param investments_refresh_request [InvestmentsRefreshRequest]
|
4455
|
+
# @param [Hash] opts the optional parameters
|
4456
|
+
# @return [Array<(InvestmentsRefreshResponse, Integer, Hash)>] InvestmentsRefreshResponse data, response status code and response headers
|
4457
|
+
def investments_refresh_with_http_info(investments_refresh_request, opts = {})
|
4458
|
+
if @api_client.config.debugging
|
4459
|
+
@api_client.config.logger.debug 'Calling API: PlaidApi.investments_refresh ...'
|
4460
|
+
end
|
4461
|
+
# verify the required parameter 'investments_refresh_request' is set
|
4462
|
+
if @api_client.config.client_side_validation && investments_refresh_request.nil?
|
4463
|
+
fail ArgumentError, "Missing the required parameter 'investments_refresh_request' when calling PlaidApi.investments_refresh"
|
4464
|
+
end
|
4465
|
+
# resource path
|
4466
|
+
local_var_path = '/investments/refresh'
|
4467
|
+
|
4468
|
+
# query parameters
|
4469
|
+
query_params = opts[:query_params] || {}
|
4470
|
+
|
4471
|
+
# header parameters
|
4472
|
+
header_params = opts[:header_params] || {}
|
4473
|
+
# HTTP header 'Accept' (if needed)
|
4474
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
4475
|
+
# HTTP header 'Content-Type'
|
4476
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
4477
|
+
|
4478
|
+
# form parameters
|
4479
|
+
form_params = opts[:form_params] || {}
|
4480
|
+
|
4481
|
+
# http body (model)
|
4482
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(investments_refresh_request)
|
4483
|
+
|
4484
|
+
# return_type
|
4485
|
+
return_type = opts[:debug_return_type] || 'InvestmentsRefreshResponse'
|
4486
|
+
|
4487
|
+
# auth_names
|
4488
|
+
auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
|
4489
|
+
|
4490
|
+
new_options = opts.merge(
|
4491
|
+
:operation => :"PlaidApi.investments_refresh",
|
4492
|
+
:header_params => header_params,
|
4493
|
+
:query_params => query_params,
|
4494
|
+
:form_params => form_params,
|
4495
|
+
:body => post_body,
|
4496
|
+
:auth_names => auth_names,
|
4497
|
+
:return_type => return_type
|
4498
|
+
)
|
4499
|
+
|
4500
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
4501
|
+
if @api_client.config.debugging
|
4502
|
+
@api_client.config.logger.debug "API called: PlaidApi#investments_refresh\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
4503
|
+
end
|
4504
|
+
return data, status_code, headers
|
4505
|
+
end
|
4506
|
+
|
4377
4507
|
# Get investment transactions
|
4378
4508
|
# The `/investments/transactions/get` endpoint allows developers to retrieve up to 24 months of user-authorized transaction data for investment accounts. Transactions are returned in reverse-chronological order, and the sequence of transaction ordering is stable and will not shift. Due to the potentially large number of investment transactions associated with an Item, results are paginated. Manipulate the count and offset parameters in conjunction with the `total_investment_transactions` response body field to fetch all available investment transactions. Note that Investments does not have a webhook to indicate when initial transaction data has loaded. Instead, if transactions data is not ready when `/investments/transactions/get` is first called, Plaid will wait for the data. For this reason, calling `/investments/transactions/get` immediately after Link may take up to one to two minutes to return.
|
4379
4509
|
# @param investments_transactions_get_request [InvestmentsTransactionsGetRequest]
|
@@ -7039,6 +7169,71 @@ module Plaid
|
|
7039
7169
|
return data, status_code, headers
|
7040
7170
|
end
|
7041
7171
|
|
7172
|
+
# Retrieve identity match score
|
7173
|
+
# The `/processor/identity/match` endpoint generates a match score, which indicates how well the provided identity data matches the identity information on file with the account holder's financial institution. This request may take some time to complete if Identity was not specified as an initial product when creating the Item. This is because Plaid must communicate directly with the institution to retrieve the data.
|
7174
|
+
# @param processor_identity_match_request [ProcessorIdentityMatchRequest]
|
7175
|
+
# @param [Hash] opts the optional parameters
|
7176
|
+
# @return [ProcessorIdentityMatchResponse]
|
7177
|
+
def processor_identity_match(processor_identity_match_request, opts = {})
|
7178
|
+
data, _status_code, _headers = processor_identity_match_with_http_info(processor_identity_match_request, opts)
|
7179
|
+
data
|
7180
|
+
end
|
7181
|
+
|
7182
|
+
# Retrieve identity match score
|
7183
|
+
# The `/processor/identity/match` endpoint generates a match score, which indicates how well the provided identity data matches the identity information on file with the account holder's financial institution. This request may take some time to complete if Identity was not specified as an initial product when creating the Item. This is because Plaid must communicate directly with the institution to retrieve the data.
|
7184
|
+
# @param processor_identity_match_request [ProcessorIdentityMatchRequest]
|
7185
|
+
# @param [Hash] opts the optional parameters
|
7186
|
+
# @return [Array<(ProcessorIdentityMatchResponse, Integer, Hash)>] ProcessorIdentityMatchResponse data, response status code and response headers
|
7187
|
+
def processor_identity_match_with_http_info(processor_identity_match_request, opts = {})
|
7188
|
+
if @api_client.config.debugging
|
7189
|
+
@api_client.config.logger.debug 'Calling API: PlaidApi.processor_identity_match ...'
|
7190
|
+
end
|
7191
|
+
# verify the required parameter 'processor_identity_match_request' is set
|
7192
|
+
if @api_client.config.client_side_validation && processor_identity_match_request.nil?
|
7193
|
+
fail ArgumentError, "Missing the required parameter 'processor_identity_match_request' when calling PlaidApi.processor_identity_match"
|
7194
|
+
end
|
7195
|
+
# resource path
|
7196
|
+
local_var_path = '/processor/identity/match'
|
7197
|
+
|
7198
|
+
# query parameters
|
7199
|
+
query_params = opts[:query_params] || {}
|
7200
|
+
|
7201
|
+
# header parameters
|
7202
|
+
header_params = opts[:header_params] || {}
|
7203
|
+
# HTTP header 'Accept' (if needed)
|
7204
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
7205
|
+
# HTTP header 'Content-Type'
|
7206
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
7207
|
+
|
7208
|
+
# form parameters
|
7209
|
+
form_params = opts[:form_params] || {}
|
7210
|
+
|
7211
|
+
# http body (model)
|
7212
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(processor_identity_match_request)
|
7213
|
+
|
7214
|
+
# return_type
|
7215
|
+
return_type = opts[:debug_return_type] || 'ProcessorIdentityMatchResponse'
|
7216
|
+
|
7217
|
+
# auth_names
|
7218
|
+
auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
|
7219
|
+
|
7220
|
+
new_options = opts.merge(
|
7221
|
+
:operation => :"PlaidApi.processor_identity_match",
|
7222
|
+
:header_params => header_params,
|
7223
|
+
:query_params => query_params,
|
7224
|
+
:form_params => form_params,
|
7225
|
+
:body => post_body,
|
7226
|
+
:auth_names => auth_names,
|
7227
|
+
:return_type => return_type
|
7228
|
+
)
|
7229
|
+
|
7230
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
7231
|
+
if @api_client.config.debugging
|
7232
|
+
@api_client.config.logger.debug "API called: PlaidApi#processor_identity_match\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
7233
|
+
end
|
7234
|
+
return data, status_code, headers
|
7235
|
+
end
|
7236
|
+
|
7042
7237
|
# Report whether you initiated an ACH transaction
|
7043
7238
|
# After calling `/processor/signal/evaluate`, call `/processor/signal/decision/report` to report whether the transaction was initiated. This endpoint will return an [`INVALID_FIELD`](/docs/errors/invalid-request/#invalid_field) error if called a second time with a different value for `initiated`.
|
7044
7239
|
# @param processor_signal_decision_report_request [ProcessorSignalDecisionReportRequest]
|
@@ -7364,31 +7559,31 @@ module Plaid
|
|
7364
7559
|
return data, status_code, headers
|
7365
7560
|
end
|
7366
7561
|
|
7367
|
-
#
|
7368
|
-
#
|
7369
|
-
# @param
|
7562
|
+
# Get a processor token's product permissions
|
7563
|
+
# Used to get a processor token's product permissions. The `products` field will be an empty list if the processor can access all available products.
|
7564
|
+
# @param processor_token_permissions_get_request [ProcessorTokenPermissionsGetRequest]
|
7370
7565
|
# @param [Hash] opts the optional parameters
|
7371
|
-
# @return [
|
7372
|
-
def
|
7373
|
-
data, _status_code, _headers =
|
7566
|
+
# @return [ProcessorTokenPermissionsGetResponse]
|
7567
|
+
def processor_token_permissions_get(processor_token_permissions_get_request, opts = {})
|
7568
|
+
data, _status_code, _headers = processor_token_permissions_get_with_http_info(processor_token_permissions_get_request, opts)
|
7374
7569
|
data
|
7375
7570
|
end
|
7376
7571
|
|
7377
|
-
#
|
7378
|
-
#
|
7379
|
-
# @param
|
7572
|
+
# Get a processor token's product permissions
|
7573
|
+
# Used to get a processor token's product permissions. The `products` field will be an empty list if the processor can access all available products.
|
7574
|
+
# @param processor_token_permissions_get_request [ProcessorTokenPermissionsGetRequest]
|
7380
7575
|
# @param [Hash] opts the optional parameters
|
7381
|
-
# @return [Array<(
|
7382
|
-
def
|
7576
|
+
# @return [Array<(ProcessorTokenPermissionsGetResponse, Integer, Hash)>] ProcessorTokenPermissionsGetResponse data, response status code and response headers
|
7577
|
+
def processor_token_permissions_get_with_http_info(processor_token_permissions_get_request, opts = {})
|
7383
7578
|
if @api_client.config.debugging
|
7384
|
-
@api_client.config.logger.debug 'Calling API: PlaidApi.
|
7579
|
+
@api_client.config.logger.debug 'Calling API: PlaidApi.processor_token_permissions_get ...'
|
7385
7580
|
end
|
7386
|
-
# verify the required parameter '
|
7387
|
-
if @api_client.config.client_side_validation &&
|
7388
|
-
fail ArgumentError, "Missing the required parameter '
|
7581
|
+
# verify the required parameter 'processor_token_permissions_get_request' is set
|
7582
|
+
if @api_client.config.client_side_validation && processor_token_permissions_get_request.nil?
|
7583
|
+
fail ArgumentError, "Missing the required parameter 'processor_token_permissions_get_request' when calling PlaidApi.processor_token_permissions_get"
|
7389
7584
|
end
|
7390
7585
|
# resource path
|
7391
|
-
local_var_path = '/
|
7586
|
+
local_var_path = '/processor/token/permissions/get'
|
7392
7587
|
|
7393
7588
|
# query parameters
|
7394
7589
|
query_params = opts[:query_params] || {}
|
@@ -7404,16 +7599,16 @@ module Plaid
|
|
7404
7599
|
form_params = opts[:form_params] || {}
|
7405
7600
|
|
7406
7601
|
# http body (model)
|
7407
|
-
post_body = opts[:debug_body] || @api_client.object_to_http_body(
|
7602
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(processor_token_permissions_get_request)
|
7408
7603
|
|
7409
7604
|
# return_type
|
7410
|
-
return_type = opts[:debug_return_type] || '
|
7605
|
+
return_type = opts[:debug_return_type] || 'ProcessorTokenPermissionsGetResponse'
|
7411
7606
|
|
7412
7607
|
# auth_names
|
7413
7608
|
auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
|
7414
7609
|
|
7415
7610
|
new_options = opts.merge(
|
7416
|
-
:operation => :"PlaidApi.
|
7611
|
+
:operation => :"PlaidApi.processor_token_permissions_get",
|
7417
7612
|
:header_params => header_params,
|
7418
7613
|
:query_params => query_params,
|
7419
7614
|
:form_params => form_params,
|
@@ -7424,36 +7619,36 @@ module Plaid
|
|
7424
7619
|
|
7425
7620
|
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
7426
7621
|
if @api_client.config.debugging
|
7427
|
-
@api_client.config.logger.debug "API called: PlaidApi#
|
7622
|
+
@api_client.config.logger.debug "API called: PlaidApi#processor_token_permissions_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
7428
7623
|
end
|
7429
7624
|
return data, status_code, headers
|
7430
7625
|
end
|
7431
7626
|
|
7432
|
-
#
|
7433
|
-
#
|
7434
|
-
# @param
|
7627
|
+
# Control a processor's access to products
|
7628
|
+
# Used to control a processor's access to products on the given processor token. By default, a processor will have access to all available products on the corresponding item. To restrict access to a particular set of products, call this endpoint with the desired products. To restore access to all available products, call this endpoint with an empty list. This endpoint can be called multiple times as your needs and your processor's needs change.
|
7629
|
+
# @param processor_token_permissions_set_request [ProcessorTokenPermissionsSetRequest]
|
7435
7630
|
# @param [Hash] opts the optional parameters
|
7436
|
-
# @return [
|
7437
|
-
def
|
7438
|
-
data, _status_code, _headers =
|
7631
|
+
# @return [ProcessorTokenPermissionsSetResponse]
|
7632
|
+
def processor_token_permissions_set(processor_token_permissions_set_request, opts = {})
|
7633
|
+
data, _status_code, _headers = processor_token_permissions_set_with_http_info(processor_token_permissions_set_request, opts)
|
7439
7634
|
data
|
7440
7635
|
end
|
7441
7636
|
|
7442
|
-
#
|
7443
|
-
#
|
7444
|
-
# @param
|
7637
|
+
# Control a processor's access to products
|
7638
|
+
# Used to control a processor's access to products on the given processor token. By default, a processor will have access to all available products on the corresponding item. To restrict access to a particular set of products, call this endpoint with the desired products. To restore access to all available products, call this endpoint with an empty list. This endpoint can be called multiple times as your needs and your processor's needs change.
|
7639
|
+
# @param processor_token_permissions_set_request [ProcessorTokenPermissionsSetRequest]
|
7445
7640
|
# @param [Hash] opts the optional parameters
|
7446
|
-
# @return [Array<(
|
7447
|
-
def
|
7641
|
+
# @return [Array<(ProcessorTokenPermissionsSetResponse, Integer, Hash)>] ProcessorTokenPermissionsSetResponse data, response status code and response headers
|
7642
|
+
def processor_token_permissions_set_with_http_info(processor_token_permissions_set_request, opts = {})
|
7448
7643
|
if @api_client.config.debugging
|
7449
|
-
@api_client.config.logger.debug 'Calling API: PlaidApi.
|
7644
|
+
@api_client.config.logger.debug 'Calling API: PlaidApi.processor_token_permissions_set ...'
|
7450
7645
|
end
|
7451
|
-
# verify the required parameter '
|
7452
|
-
if @api_client.config.client_side_validation &&
|
7453
|
-
fail ArgumentError, "Missing the required parameter '
|
7646
|
+
# verify the required parameter 'processor_token_permissions_set_request' is set
|
7647
|
+
if @api_client.config.client_side_validation && processor_token_permissions_set_request.nil?
|
7648
|
+
fail ArgumentError, "Missing the required parameter 'processor_token_permissions_set_request' when calling PlaidApi.processor_token_permissions_set"
|
7454
7649
|
end
|
7455
7650
|
# resource path
|
7456
|
-
local_var_path = '/
|
7651
|
+
local_var_path = '/processor/token/permissions/set'
|
7457
7652
|
|
7458
7653
|
# query parameters
|
7459
7654
|
query_params = opts[:query_params] || {}
|
@@ -7469,16 +7664,16 @@ module Plaid
|
|
7469
7664
|
form_params = opts[:form_params] || {}
|
7470
7665
|
|
7471
7666
|
# http body (model)
|
7472
|
-
post_body = opts[:debug_body] || @api_client.object_to_http_body(
|
7667
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(processor_token_permissions_set_request)
|
7473
7668
|
|
7474
7669
|
# return_type
|
7475
|
-
return_type = opts[:debug_return_type] || '
|
7670
|
+
return_type = opts[:debug_return_type] || 'ProcessorTokenPermissionsSetResponse'
|
7476
7671
|
|
7477
7672
|
# auth_names
|
7478
7673
|
auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
|
7479
7674
|
|
7480
7675
|
new_options = opts.merge(
|
7481
|
-
:operation => :"PlaidApi.
|
7676
|
+
:operation => :"PlaidApi.processor_token_permissions_set",
|
7482
7677
|
:header_params => header_params,
|
7483
7678
|
:query_params => query_params,
|
7484
7679
|
:form_params => form_params,
|
@@ -7489,36 +7684,36 @@ module Plaid
|
|
7489
7684
|
|
7490
7685
|
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
7491
7686
|
if @api_client.config.debugging
|
7492
|
-
@api_client.config.logger.debug "API called: PlaidApi#
|
7687
|
+
@api_client.config.logger.debug "API called: PlaidApi#processor_token_permissions_set\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
7493
7688
|
end
|
7494
7689
|
return data, status_code, headers
|
7495
7690
|
end
|
7496
7691
|
|
7497
|
-
#
|
7498
|
-
#
|
7499
|
-
# @param
|
7692
|
+
# Get transaction data
|
7693
|
+
# The `/processor/transactions/get` endpoint allows developers to receive user-authorized transaction data for credit, depository, and some loan-type accounts (only those with account subtype `student`; coverage may be limited). Transaction data is standardized across financial institutions, and in many cases transactions are linked to a clean name, entity type, location, and category. Similarly, account data is standardized and returned with a clean name, number, balance, and other meta information where available. Transactions are returned in reverse-chronological order, and the sequence of transaction ordering is stable and will not shift. Transactions are not immutable and can also be removed altogether by the institution; a removed transaction will no longer appear in `/processor/transactions/get`. For more details, see [Pending and posted transactions](https://plaid.com/docs/transactions/transactions-data/#pending-and-posted-transactions). Due to the potentially large number of transactions associated with an Item, results are paginated. Manipulate the `count` and `offset` parameters in conjunction with the `total_transactions` response body field to fetch all available transactions. Data returned by `/processor/transactions/get` will be the data available for the Item as of the most recent successful check for new transactions. Plaid typically checks for new data multiple times a day, but these checks may occur less frequently, such as once a day, depending on the institution. An Item's `status.transactions.last_successful_update` field will show the timestamp of the most recent successful update. To force Plaid to check for new transactions, you can use the `/processor/transactions/refresh` endpoint. Note that data may not be immediately available to `/processor/transactions/get`. Plaid will begin to prepare transactions data upon Item link, if Link was initialized with `transactions`, or upon the first call to `/processor/transactions/get`, if it wasn't. If no transaction history is ready when `/processor/transactions/get` is called, it will return a `PRODUCT_NOT_READY` error.
|
7694
|
+
# @param processor_transactions_get_request [ProcessorTransactionsGetRequest]
|
7500
7695
|
# @param [Hash] opts the optional parameters
|
7501
|
-
# @return [
|
7502
|
-
def
|
7503
|
-
data, _status_code, _headers =
|
7696
|
+
# @return [ProcessorTransactionsGetResponse]
|
7697
|
+
def processor_transactions_get(processor_transactions_get_request, opts = {})
|
7698
|
+
data, _status_code, _headers = processor_transactions_get_with_http_info(processor_transactions_get_request, opts)
|
7504
7699
|
data
|
7505
7700
|
end
|
7506
7701
|
|
7507
|
-
#
|
7508
|
-
#
|
7509
|
-
# @param
|
7702
|
+
# Get transaction data
|
7703
|
+
# The `/processor/transactions/get` endpoint allows developers to receive user-authorized transaction data for credit, depository, and some loan-type accounts (only those with account subtype `student`; coverage may be limited). Transaction data is standardized across financial institutions, and in many cases transactions are linked to a clean name, entity type, location, and category. Similarly, account data is standardized and returned with a clean name, number, balance, and other meta information where available. Transactions are returned in reverse-chronological order, and the sequence of transaction ordering is stable and will not shift. Transactions are not immutable and can also be removed altogether by the institution; a removed transaction will no longer appear in `/processor/transactions/get`. For more details, see [Pending and posted transactions](https://plaid.com/docs/transactions/transactions-data/#pending-and-posted-transactions). Due to the potentially large number of transactions associated with an Item, results are paginated. Manipulate the `count` and `offset` parameters in conjunction with the `total_transactions` response body field to fetch all available transactions. Data returned by `/processor/transactions/get` will be the data available for the Item as of the most recent successful check for new transactions. Plaid typically checks for new data multiple times a day, but these checks may occur less frequently, such as once a day, depending on the institution. An Item's `status.transactions.last_successful_update` field will show the timestamp of the most recent successful update. To force Plaid to check for new transactions, you can use the `/processor/transactions/refresh` endpoint. Note that data may not be immediately available to `/processor/transactions/get`. Plaid will begin to prepare transactions data upon Item link, if Link was initialized with `transactions`, or upon the first call to `/processor/transactions/get`, if it wasn't. If no transaction history is ready when `/processor/transactions/get` is called, it will return a `PRODUCT_NOT_READY` error.
|
7704
|
+
# @param processor_transactions_get_request [ProcessorTransactionsGetRequest]
|
7510
7705
|
# @param [Hash] opts the optional parameters
|
7511
|
-
# @return [Array<(
|
7512
|
-
def
|
7706
|
+
# @return [Array<(ProcessorTransactionsGetResponse, Integer, Hash)>] ProcessorTransactionsGetResponse data, response status code and response headers
|
7707
|
+
def processor_transactions_get_with_http_info(processor_transactions_get_request, opts = {})
|
7513
7708
|
if @api_client.config.debugging
|
7514
|
-
@api_client.config.logger.debug 'Calling API: PlaidApi.
|
7709
|
+
@api_client.config.logger.debug 'Calling API: PlaidApi.processor_transactions_get ...'
|
7515
7710
|
end
|
7516
|
-
# verify the required parameter '
|
7517
|
-
if @api_client.config.client_side_validation &&
|
7518
|
-
fail ArgumentError, "Missing the required parameter '
|
7711
|
+
# verify the required parameter 'processor_transactions_get_request' is set
|
7712
|
+
if @api_client.config.client_side_validation && processor_transactions_get_request.nil?
|
7713
|
+
fail ArgumentError, "Missing the required parameter 'processor_transactions_get_request' when calling PlaidApi.processor_transactions_get"
|
7519
7714
|
end
|
7520
7715
|
# resource path
|
7521
|
-
local_var_path = '/
|
7716
|
+
local_var_path = '/processor/transactions/get'
|
7522
7717
|
|
7523
7718
|
# query parameters
|
7524
7719
|
query_params = opts[:query_params] || {}
|
@@ -7534,16 +7729,16 @@ module Plaid
|
|
7534
7729
|
form_params = opts[:form_params] || {}
|
7535
7730
|
|
7536
7731
|
# http body (model)
|
7537
|
-
post_body = opts[:debug_body] || @api_client.object_to_http_body(
|
7732
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(processor_transactions_get_request)
|
7538
7733
|
|
7539
7734
|
# return_type
|
7540
|
-
return_type = opts[:debug_return_type] || '
|
7735
|
+
return_type = opts[:debug_return_type] || 'ProcessorTransactionsGetResponse'
|
7541
7736
|
|
7542
7737
|
# auth_names
|
7543
7738
|
auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
|
7544
7739
|
|
7545
7740
|
new_options = opts.merge(
|
7546
|
-
:operation => :"PlaidApi.
|
7741
|
+
:operation => :"PlaidApi.processor_transactions_get",
|
7547
7742
|
:header_params => header_params,
|
7548
7743
|
:query_params => query_params,
|
7549
7744
|
:form_params => form_params,
|
@@ -7554,36 +7749,36 @@ module Plaid
|
|
7554
7749
|
|
7555
7750
|
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
7556
7751
|
if @api_client.config.debugging
|
7557
|
-
@api_client.config.logger.debug "API called: PlaidApi#
|
7752
|
+
@api_client.config.logger.debug "API called: PlaidApi#processor_transactions_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
7558
7753
|
end
|
7559
7754
|
return data, status_code, headers
|
7560
7755
|
end
|
7561
7756
|
|
7562
|
-
#
|
7563
|
-
# The `/
|
7564
|
-
# @param
|
7757
|
+
# Fetch recurring transaction streams
|
7758
|
+
# The `/processor/transactions/recurring/get` endpoint allows developers to receive a summary of the recurring outflow and inflow streams (expenses and deposits) from a user’s checking, savings or credit card accounts. Additionally, Plaid provides key insights about each recurring stream including the category, merchant, last amount, and more. Developers can use these insights to build tools and experiences that help their users better manage cash flow, monitor subscriptions, reduce spend, and stay on track with bill payments. This endpoint is offered as an add-on to Transactions. To request access to this endpoint, submit a [product access request](https://dashboard.plaid.com/team/products) or contact your Plaid account manager. This endpoint can only be called on an Item that has already been initialized with Transactions (either during Link, by specifying it in `/link/token/create`; or after Link, by calling `/processor/transactions/get` or `/processor/transactions/sync`). Once all historical transactions have been fetched, call `/processor/transactions/recurring/get` to receive the Recurring Transactions streams and subscribe to the [`RECURRING_TRANSACTIONS_UPDATE`](https://plaid.com/docs/api/products/transactions/#recurring_transactions_update) webhook. To know when historical transactions have been fetched, if you are using `/transactions/sync` listen for the [`SYNC_UPDATES_AVAILABLE`](https://plaid.com/docs/api/products/transactions/#SyncUpdatesAvailableWebhook-historical-update-complete) webhook and check that the `historical_update_complete` field in the payload is `true`. If using `/transactions/get`, listen for the [`HISTORICAL_UPDATE`](https://plaid.com/docs/api/products/transactions/#historical_update) webhook. After the initial call, you can call `/processor/transactions/recurring/get` endpoint at any point in the future to retrieve the latest summary of recurring streams. Listen to the [`RECURRING_TRANSACTIONS_UPDATE`](https://plaid.com/docs/api/products/transactions/#recurring_transactions_update) webhook to be notified when new updates are available.
|
7759
|
+
# @param processor_transactions_recurring_get_request [ProcessorTransactionsRecurringGetRequest]
|
7565
7760
|
# @param [Hash] opts the optional parameters
|
7566
|
-
# @return [
|
7567
|
-
def
|
7568
|
-
data, _status_code, _headers =
|
7761
|
+
# @return [ProcessorTransactionsRecurringGetResponse]
|
7762
|
+
def processor_transactions_recurring_get(processor_transactions_recurring_get_request, opts = {})
|
7763
|
+
data, _status_code, _headers = processor_transactions_recurring_get_with_http_info(processor_transactions_recurring_get_request, opts)
|
7569
7764
|
data
|
7570
7765
|
end
|
7571
7766
|
|
7572
|
-
#
|
7573
|
-
# The `/
|
7574
|
-
# @param
|
7767
|
+
# Fetch recurring transaction streams
|
7768
|
+
# The `/processor/transactions/recurring/get` endpoint allows developers to receive a summary of the recurring outflow and inflow streams (expenses and deposits) from a user’s checking, savings or credit card accounts. Additionally, Plaid provides key insights about each recurring stream including the category, merchant, last amount, and more. Developers can use these insights to build tools and experiences that help their users better manage cash flow, monitor subscriptions, reduce spend, and stay on track with bill payments. This endpoint is offered as an add-on to Transactions. To request access to this endpoint, submit a [product access request](https://dashboard.plaid.com/team/products) or contact your Plaid account manager. This endpoint can only be called on an Item that has already been initialized with Transactions (either during Link, by specifying it in `/link/token/create`; or after Link, by calling `/processor/transactions/get` or `/processor/transactions/sync`). Once all historical transactions have been fetched, call `/processor/transactions/recurring/get` to receive the Recurring Transactions streams and subscribe to the [`RECURRING_TRANSACTIONS_UPDATE`](https://plaid.com/docs/api/products/transactions/#recurring_transactions_update) webhook. To know when historical transactions have been fetched, if you are using `/transactions/sync` listen for the [`SYNC_UPDATES_AVAILABLE`](https://plaid.com/docs/api/products/transactions/#SyncUpdatesAvailableWebhook-historical-update-complete) webhook and check that the `historical_update_complete` field in the payload is `true`. If using `/transactions/get`, listen for the [`HISTORICAL_UPDATE`](https://plaid.com/docs/api/products/transactions/#historical_update) webhook. After the initial call, you can call `/processor/transactions/recurring/get` endpoint at any point in the future to retrieve the latest summary of recurring streams. Listen to the [`RECURRING_TRANSACTIONS_UPDATE`](https://plaid.com/docs/api/products/transactions/#recurring_transactions_update) webhook to be notified when new updates are available.
|
7769
|
+
# @param processor_transactions_recurring_get_request [ProcessorTransactionsRecurringGetRequest]
|
7575
7770
|
# @param [Hash] opts the optional parameters
|
7576
|
-
# @return [Array<(
|
7577
|
-
def
|
7771
|
+
# @return [Array<(ProcessorTransactionsRecurringGetResponse, Integer, Hash)>] ProcessorTransactionsRecurringGetResponse data, response status code and response headers
|
7772
|
+
def processor_transactions_recurring_get_with_http_info(processor_transactions_recurring_get_request, opts = {})
|
7578
7773
|
if @api_client.config.debugging
|
7579
|
-
@api_client.config.logger.debug 'Calling API: PlaidApi.
|
7774
|
+
@api_client.config.logger.debug 'Calling API: PlaidApi.processor_transactions_recurring_get ...'
|
7580
7775
|
end
|
7581
|
-
# verify the required parameter '
|
7582
|
-
if @api_client.config.client_side_validation &&
|
7583
|
-
fail ArgumentError, "Missing the required parameter '
|
7776
|
+
# verify the required parameter 'processor_transactions_recurring_get_request' is set
|
7777
|
+
if @api_client.config.client_side_validation && processor_transactions_recurring_get_request.nil?
|
7778
|
+
fail ArgumentError, "Missing the required parameter 'processor_transactions_recurring_get_request' when calling PlaidApi.processor_transactions_recurring_get"
|
7584
7779
|
end
|
7585
7780
|
# resource path
|
7586
|
-
local_var_path = '/
|
7781
|
+
local_var_path = '/processor/transactions/recurring/get'
|
7587
7782
|
|
7588
7783
|
# query parameters
|
7589
7784
|
query_params = opts[:query_params] || {}
|
@@ -7599,16 +7794,16 @@ module Plaid
|
|
7599
7794
|
form_params = opts[:form_params] || {}
|
7600
7795
|
|
7601
7796
|
# http body (model)
|
7602
|
-
post_body = opts[:debug_body] || @api_client.object_to_http_body(
|
7797
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(processor_transactions_recurring_get_request)
|
7603
7798
|
|
7604
7799
|
# return_type
|
7605
|
-
return_type = opts[:debug_return_type] || '
|
7800
|
+
return_type = opts[:debug_return_type] || 'ProcessorTransactionsRecurringGetResponse'
|
7606
7801
|
|
7607
7802
|
# auth_names
|
7608
7803
|
auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
|
7609
7804
|
|
7610
7805
|
new_options = opts.merge(
|
7611
|
-
:operation => :"PlaidApi.
|
7806
|
+
:operation => :"PlaidApi.processor_transactions_recurring_get",
|
7612
7807
|
:header_params => header_params,
|
7613
7808
|
:query_params => query_params,
|
7614
7809
|
:form_params => form_params,
|
@@ -7619,36 +7814,36 @@ module Plaid
|
|
7619
7814
|
|
7620
7815
|
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
7621
7816
|
if @api_client.config.debugging
|
7622
|
-
@api_client.config.logger.debug "API called: PlaidApi#
|
7817
|
+
@api_client.config.logger.debug "API called: PlaidApi#processor_transactions_recurring_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
7623
7818
|
end
|
7624
7819
|
return data, status_code, headers
|
7625
7820
|
end
|
7626
7821
|
|
7627
|
-
#
|
7628
|
-
# `/
|
7629
|
-
# @param
|
7822
|
+
# Refresh transaction data
|
7823
|
+
# `/processor/transactions/refresh` is an optional endpoint for users of the Transactions product. It initiates an on-demand extraction to fetch the newest transactions for an Item. This on-demand extraction takes place in addition to the periodic extractions that automatically occur multiple times a day for any Transactions-enabled Item. If changes to transactions are discovered after calling `/processor/transactions/refresh`, Plaid will fire a webhook: for `/transactions/sync` users, [`SYNC_UPDATES_AVAILABLE`](https://plaid.com/docs/api/products/transactions/#sync_updates_available) will be fired if there are any transactions updated, added, or removed. For users of both `/processor/transactions/sync` and `/processor/transactions/get`, [`TRANSACTIONS_REMOVED`](https://plaid.com/docs/api/products/transactions/#transactions_removed) will be fired if any removed transactions are detected, and [`DEFAULT_UPDATE`](https://plaid.com/docs/api/products/transactions/#default_update) will be fired if any new transactions are detected. New transactions can be fetched by calling `/processor/transactions/get` or `/processor/transactions/sync`. Note that the `/processor/transactions/refresh` endpoint is not supported for Capital One (`ins_128026`) and will result in a `PRODUCT_NOT_SUPPORTED` error if called on an Item from that institution. `/processor/transactions/refresh` is offered as an add-on to Transactions and has a separate [fee model](/docs/account/billing/#per-request-flat-fee). To request access to this endpoint, submit a [product access request](https://dashboard.plaid.com/team/products) or contact your Plaid account manager.
|
7824
|
+
# @param processor_transactions_refresh_request [ProcessorTransactionsRefreshRequest]
|
7630
7825
|
# @param [Hash] opts the optional parameters
|
7631
|
-
# @return [
|
7632
|
-
def
|
7633
|
-
data, _status_code, _headers =
|
7826
|
+
# @return [ProcessorTransactionsRefreshResponse]
|
7827
|
+
def processor_transactions_refresh(processor_transactions_refresh_request, opts = {})
|
7828
|
+
data, _status_code, _headers = processor_transactions_refresh_with_http_info(processor_transactions_refresh_request, opts)
|
7634
7829
|
data
|
7635
7830
|
end
|
7636
7831
|
|
7637
|
-
#
|
7638
|
-
# `/
|
7639
|
-
# @param
|
7832
|
+
# Refresh transaction data
|
7833
|
+
# `/processor/transactions/refresh` is an optional endpoint for users of the Transactions product. It initiates an on-demand extraction to fetch the newest transactions for an Item. This on-demand extraction takes place in addition to the periodic extractions that automatically occur multiple times a day for any Transactions-enabled Item. If changes to transactions are discovered after calling `/processor/transactions/refresh`, Plaid will fire a webhook: for `/transactions/sync` users, [`SYNC_UPDATES_AVAILABLE`](https://plaid.com/docs/api/products/transactions/#sync_updates_available) will be fired if there are any transactions updated, added, or removed. For users of both `/processor/transactions/sync` and `/processor/transactions/get`, [`TRANSACTIONS_REMOVED`](https://plaid.com/docs/api/products/transactions/#transactions_removed) will be fired if any removed transactions are detected, and [`DEFAULT_UPDATE`](https://plaid.com/docs/api/products/transactions/#default_update) will be fired if any new transactions are detected. New transactions can be fetched by calling `/processor/transactions/get` or `/processor/transactions/sync`. Note that the `/processor/transactions/refresh` endpoint is not supported for Capital One (`ins_128026`) and will result in a `PRODUCT_NOT_SUPPORTED` error if called on an Item from that institution. `/processor/transactions/refresh` is offered as an add-on to Transactions and has a separate [fee model](/docs/account/billing/#per-request-flat-fee). To request access to this endpoint, submit a [product access request](https://dashboard.plaid.com/team/products) or contact your Plaid account manager.
|
7834
|
+
# @param processor_transactions_refresh_request [ProcessorTransactionsRefreshRequest]
|
7640
7835
|
# @param [Hash] opts the optional parameters
|
7641
|
-
# @return [Array<(
|
7642
|
-
def
|
7836
|
+
# @return [Array<(ProcessorTransactionsRefreshResponse, Integer, Hash)>] ProcessorTransactionsRefreshResponse data, response status code and response headers
|
7837
|
+
def processor_transactions_refresh_with_http_info(processor_transactions_refresh_request, opts = {})
|
7643
7838
|
if @api_client.config.debugging
|
7644
|
-
@api_client.config.logger.debug 'Calling API: PlaidApi.
|
7839
|
+
@api_client.config.logger.debug 'Calling API: PlaidApi.processor_transactions_refresh ...'
|
7645
7840
|
end
|
7646
|
-
# verify the required parameter '
|
7647
|
-
if @api_client.config.client_side_validation &&
|
7648
|
-
fail ArgumentError, "Missing the required parameter '
|
7841
|
+
# verify the required parameter 'processor_transactions_refresh_request' is set
|
7842
|
+
if @api_client.config.client_side_validation && processor_transactions_refresh_request.nil?
|
7843
|
+
fail ArgumentError, "Missing the required parameter 'processor_transactions_refresh_request' when calling PlaidApi.processor_transactions_refresh"
|
7649
7844
|
end
|
7650
7845
|
# resource path
|
7651
|
-
local_var_path = '/
|
7846
|
+
local_var_path = '/processor/transactions/refresh'
|
7652
7847
|
|
7653
7848
|
# query parameters
|
7654
7849
|
query_params = opts[:query_params] || {}
|
@@ -7664,16 +7859,16 @@ module Plaid
|
|
7664
7859
|
form_params = opts[:form_params] || {}
|
7665
7860
|
|
7666
7861
|
# http body (model)
|
7667
|
-
post_body = opts[:debug_body] || @api_client.object_to_http_body(
|
7862
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(processor_transactions_refresh_request)
|
7668
7863
|
|
7669
7864
|
# return_type
|
7670
|
-
return_type = opts[:debug_return_type] || '
|
7865
|
+
return_type = opts[:debug_return_type] || 'ProcessorTransactionsRefreshResponse'
|
7671
7866
|
|
7672
7867
|
# auth_names
|
7673
7868
|
auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
|
7674
7869
|
|
7675
7870
|
new_options = opts.merge(
|
7676
|
-
:operation => :"PlaidApi.
|
7871
|
+
:operation => :"PlaidApi.processor_transactions_refresh",
|
7677
7872
|
:header_params => header_params,
|
7678
7873
|
:query_params => query_params,
|
7679
7874
|
:form_params => form_params,
|
@@ -7684,7 +7879,397 @@ module Plaid
|
|
7684
7879
|
|
7685
7880
|
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
7686
7881
|
if @api_client.config.debugging
|
7687
|
-
@api_client.config.logger.debug "API called: PlaidApi#
|
7882
|
+
@api_client.config.logger.debug "API called: PlaidApi#processor_transactions_refresh\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
7883
|
+
end
|
7884
|
+
return data, status_code, headers
|
7885
|
+
end
|
7886
|
+
|
7887
|
+
# Get incremental transaction updates on an Item
|
7888
|
+
# This endpoint replaces `/processor/transactions/get` and its associated webhooks for most common use-cases. The `/processor/transactions/sync` endpoint allows developers to subscribe to all transactions associated with an Item and get updates synchronously in a stream-like manner, using a cursor to track which updates have already been seen. `/processor/transactions/sync` provides the same functionality as `/processor/transactions/get` and can be used instead of `/processor/transactions/get` to simplify the process of tracking transactions updates. This endpoint provides user-authorized transaction data for `credit`, `depository`, and some loan-type accounts (only those with account subtype `student`; coverage may be limited). For transaction history from `investments` accounts, use `/investments/transactions/get` instead. Returned transactions data is grouped into three types of update, indicating whether the transaction was added, removed, or modified since the last call to the API. In the first call to `/processor/transactions/sync` for an Item, the endpoint will return all historical transactions data associated with that Item up until the time of the API call (as \"adds\"), which then generates a `next_cursor` for that Item. In subsequent calls, send the `next_cursor` to receive only the changes that have occurred since the previous call. Due to the potentially large number of transactions associated with an Item, results are paginated. The `has_more` field specifies if additional calls are necessary to fetch all available transaction updates. Call `/processor/transactions/sync` with the new cursor, pulling all updates, until `has_more` is `false`. When retrieving paginated updates, track both the `next_cursor` from the latest response and the original cursor from the first call in which `has_more` was `true`; if a call to `/processor/transactions/sync` fails when retrieving a paginated update, which can occur as a result of the [`TRANSACTIONS_SYNC_MUTATION_DURING_PAGINATION`](https://plaid.com/docs/errors/transactions/#transactions_sync_mutation_during_pagination) error, the entire pagination request loop must be restarted beginning with the cursor for the first page of the update, rather than retrying only the single request that failed. Whenever new or updated transaction data becomes available, `/processor/transactions/sync` will provide these updates. Plaid typically checks for new data multiple times a day, but these checks may occur less frequently, such as once a day, depending on the institution. An Item's `status.transactions.last_successful_update` field will show the timestamp of the most recent successful update. To force Plaid to check for new transactions, use the `/processor/transactions/refresh` endpoint. Note that for newly created Items, data may not be immediately available to `/processor/transactions/sync`. Plaid begins preparing transactions data when the Item is created, but the process can take anywhere from a few seconds to several minutes to complete, depending on the number of transactions available.
|
7889
|
+
# @param processor_transactions_sync_request [ProcessorTransactionsSyncRequest]
|
7890
|
+
# @param [Hash] opts the optional parameters
|
7891
|
+
# @return [ProcessorTransactionsSyncResponse]
|
7892
|
+
def processor_transactions_sync(processor_transactions_sync_request, opts = {})
|
7893
|
+
data, _status_code, _headers = processor_transactions_sync_with_http_info(processor_transactions_sync_request, opts)
|
7894
|
+
data
|
7895
|
+
end
|
7896
|
+
|
7897
|
+
# Get incremental transaction updates on an Item
|
7898
|
+
# This endpoint replaces `/processor/transactions/get` and its associated webhooks for most common use-cases. The `/processor/transactions/sync` endpoint allows developers to subscribe to all transactions associated with an Item and get updates synchronously in a stream-like manner, using a cursor to track which updates have already been seen. `/processor/transactions/sync` provides the same functionality as `/processor/transactions/get` and can be used instead of `/processor/transactions/get` to simplify the process of tracking transactions updates. This endpoint provides user-authorized transaction data for `credit`, `depository`, and some loan-type accounts (only those with account subtype `student`; coverage may be limited). For transaction history from `investments` accounts, use `/investments/transactions/get` instead. Returned transactions data is grouped into three types of update, indicating whether the transaction was added, removed, or modified since the last call to the API. In the first call to `/processor/transactions/sync` for an Item, the endpoint will return all historical transactions data associated with that Item up until the time of the API call (as \"adds\"), which then generates a `next_cursor` for that Item. In subsequent calls, send the `next_cursor` to receive only the changes that have occurred since the previous call. Due to the potentially large number of transactions associated with an Item, results are paginated. The `has_more` field specifies if additional calls are necessary to fetch all available transaction updates. Call `/processor/transactions/sync` with the new cursor, pulling all updates, until `has_more` is `false`. When retrieving paginated updates, track both the `next_cursor` from the latest response and the original cursor from the first call in which `has_more` was `true`; if a call to `/processor/transactions/sync` fails when retrieving a paginated update, which can occur as a result of the [`TRANSACTIONS_SYNC_MUTATION_DURING_PAGINATION`](https://plaid.com/docs/errors/transactions/#transactions_sync_mutation_during_pagination) error, the entire pagination request loop must be restarted beginning with the cursor for the first page of the update, rather than retrying only the single request that failed. Whenever new or updated transaction data becomes available, `/processor/transactions/sync` will provide these updates. Plaid typically checks for new data multiple times a day, but these checks may occur less frequently, such as once a day, depending on the institution. An Item's `status.transactions.last_successful_update` field will show the timestamp of the most recent successful update. To force Plaid to check for new transactions, use the `/processor/transactions/refresh` endpoint. Note that for newly created Items, data may not be immediately available to `/processor/transactions/sync`. Plaid begins preparing transactions data when the Item is created, but the process can take anywhere from a few seconds to several minutes to complete, depending on the number of transactions available.
|
7899
|
+
# @param processor_transactions_sync_request [ProcessorTransactionsSyncRequest]
|
7900
|
+
# @param [Hash] opts the optional parameters
|
7901
|
+
# @return [Array<(ProcessorTransactionsSyncResponse, Integer, Hash)>] ProcessorTransactionsSyncResponse data, response status code and response headers
|
7902
|
+
def processor_transactions_sync_with_http_info(processor_transactions_sync_request, opts = {})
|
7903
|
+
if @api_client.config.debugging
|
7904
|
+
@api_client.config.logger.debug 'Calling API: PlaidApi.processor_transactions_sync ...'
|
7905
|
+
end
|
7906
|
+
# verify the required parameter 'processor_transactions_sync_request' is set
|
7907
|
+
if @api_client.config.client_side_validation && processor_transactions_sync_request.nil?
|
7908
|
+
fail ArgumentError, "Missing the required parameter 'processor_transactions_sync_request' when calling PlaidApi.processor_transactions_sync"
|
7909
|
+
end
|
7910
|
+
# resource path
|
7911
|
+
local_var_path = '/processor/transactions/sync'
|
7912
|
+
|
7913
|
+
# query parameters
|
7914
|
+
query_params = opts[:query_params] || {}
|
7915
|
+
|
7916
|
+
# header parameters
|
7917
|
+
header_params = opts[:header_params] || {}
|
7918
|
+
# HTTP header 'Accept' (if needed)
|
7919
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
7920
|
+
# HTTP header 'Content-Type'
|
7921
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
7922
|
+
|
7923
|
+
# form parameters
|
7924
|
+
form_params = opts[:form_params] || {}
|
7925
|
+
|
7926
|
+
# http body (model)
|
7927
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(processor_transactions_sync_request)
|
7928
|
+
|
7929
|
+
# return_type
|
7930
|
+
return_type = opts[:debug_return_type] || 'ProcessorTransactionsSyncResponse'
|
7931
|
+
|
7932
|
+
# auth_names
|
7933
|
+
auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
|
7934
|
+
|
7935
|
+
new_options = opts.merge(
|
7936
|
+
:operation => :"PlaidApi.processor_transactions_sync",
|
7937
|
+
:header_params => header_params,
|
7938
|
+
:query_params => query_params,
|
7939
|
+
:form_params => form_params,
|
7940
|
+
:body => post_body,
|
7941
|
+
:auth_names => auth_names,
|
7942
|
+
:return_type => return_type
|
7943
|
+
)
|
7944
|
+
|
7945
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
7946
|
+
if @api_client.config.debugging
|
7947
|
+
@api_client.config.logger.debug "API called: PlaidApi#processor_transactions_sync\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
7948
|
+
end
|
7949
|
+
return data, status_code, headers
|
7950
|
+
end
|
7951
|
+
|
7952
|
+
# Manually fire a Bank Transfer webhook
|
7953
|
+
# Use the `/sandbox/bank_transfer/fire_webhook` endpoint to manually trigger a Bank Transfers webhook in the Sandbox environment.
|
7954
|
+
# @param sandbox_bank_transfer_fire_webhook_request [SandboxBankTransferFireWebhookRequest]
|
7955
|
+
# @param [Hash] opts the optional parameters
|
7956
|
+
# @return [SandboxBankTransferFireWebhookResponse]
|
7957
|
+
def sandbox_bank_transfer_fire_webhook(sandbox_bank_transfer_fire_webhook_request, opts = {})
|
7958
|
+
data, _status_code, _headers = sandbox_bank_transfer_fire_webhook_with_http_info(sandbox_bank_transfer_fire_webhook_request, opts)
|
7959
|
+
data
|
7960
|
+
end
|
7961
|
+
|
7962
|
+
# Manually fire a Bank Transfer webhook
|
7963
|
+
# Use the `/sandbox/bank_transfer/fire_webhook` endpoint to manually trigger a Bank Transfers webhook in the Sandbox environment.
|
7964
|
+
# @param sandbox_bank_transfer_fire_webhook_request [SandboxBankTransferFireWebhookRequest]
|
7965
|
+
# @param [Hash] opts the optional parameters
|
7966
|
+
# @return [Array<(SandboxBankTransferFireWebhookResponse, Integer, Hash)>] SandboxBankTransferFireWebhookResponse data, response status code and response headers
|
7967
|
+
def sandbox_bank_transfer_fire_webhook_with_http_info(sandbox_bank_transfer_fire_webhook_request, opts = {})
|
7968
|
+
if @api_client.config.debugging
|
7969
|
+
@api_client.config.logger.debug 'Calling API: PlaidApi.sandbox_bank_transfer_fire_webhook ...'
|
7970
|
+
end
|
7971
|
+
# verify the required parameter 'sandbox_bank_transfer_fire_webhook_request' is set
|
7972
|
+
if @api_client.config.client_side_validation && sandbox_bank_transfer_fire_webhook_request.nil?
|
7973
|
+
fail ArgumentError, "Missing the required parameter 'sandbox_bank_transfer_fire_webhook_request' when calling PlaidApi.sandbox_bank_transfer_fire_webhook"
|
7974
|
+
end
|
7975
|
+
# resource path
|
7976
|
+
local_var_path = '/sandbox/bank_transfer/fire_webhook'
|
7977
|
+
|
7978
|
+
# query parameters
|
7979
|
+
query_params = opts[:query_params] || {}
|
7980
|
+
|
7981
|
+
# header parameters
|
7982
|
+
header_params = opts[:header_params] || {}
|
7983
|
+
# HTTP header 'Accept' (if needed)
|
7984
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
7985
|
+
# HTTP header 'Content-Type'
|
7986
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
7987
|
+
|
7988
|
+
# form parameters
|
7989
|
+
form_params = opts[:form_params] || {}
|
7990
|
+
|
7991
|
+
# http body (model)
|
7992
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(sandbox_bank_transfer_fire_webhook_request)
|
7993
|
+
|
7994
|
+
# return_type
|
7995
|
+
return_type = opts[:debug_return_type] || 'SandboxBankTransferFireWebhookResponse'
|
7996
|
+
|
7997
|
+
# auth_names
|
7998
|
+
auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
|
7999
|
+
|
8000
|
+
new_options = opts.merge(
|
8001
|
+
:operation => :"PlaidApi.sandbox_bank_transfer_fire_webhook",
|
8002
|
+
:header_params => header_params,
|
8003
|
+
:query_params => query_params,
|
8004
|
+
:form_params => form_params,
|
8005
|
+
:body => post_body,
|
8006
|
+
:auth_names => auth_names,
|
8007
|
+
:return_type => return_type
|
8008
|
+
)
|
8009
|
+
|
8010
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
8011
|
+
if @api_client.config.debugging
|
8012
|
+
@api_client.config.logger.debug "API called: PlaidApi#sandbox_bank_transfer_fire_webhook\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
8013
|
+
end
|
8014
|
+
return data, status_code, headers
|
8015
|
+
end
|
8016
|
+
|
8017
|
+
# Simulate a bank transfer event in Sandbox
|
8018
|
+
# Use the `/sandbox/bank_transfer/simulate` endpoint to simulate a bank transfer event in the Sandbox environment. Note that while an event will be simulated and will appear when using endpoints such as `/bank_transfer/event/sync` or `/bank_transfer/event/list`, no transactions will actually take place and funds will not move between accounts, even within the Sandbox.
|
8019
|
+
# @param sandbox_bank_transfer_simulate_request [SandboxBankTransferSimulateRequest]
|
8020
|
+
# @param [Hash] opts the optional parameters
|
8021
|
+
# @return [SandboxBankTransferSimulateResponse]
|
8022
|
+
def sandbox_bank_transfer_simulate(sandbox_bank_transfer_simulate_request, opts = {})
|
8023
|
+
data, _status_code, _headers = sandbox_bank_transfer_simulate_with_http_info(sandbox_bank_transfer_simulate_request, opts)
|
8024
|
+
data
|
8025
|
+
end
|
8026
|
+
|
8027
|
+
# Simulate a bank transfer event in Sandbox
|
8028
|
+
# Use the `/sandbox/bank_transfer/simulate` endpoint to simulate a bank transfer event in the Sandbox environment. Note that while an event will be simulated and will appear when using endpoints such as `/bank_transfer/event/sync` or `/bank_transfer/event/list`, no transactions will actually take place and funds will not move between accounts, even within the Sandbox.
|
8029
|
+
# @param sandbox_bank_transfer_simulate_request [SandboxBankTransferSimulateRequest]
|
8030
|
+
# @param [Hash] opts the optional parameters
|
8031
|
+
# @return [Array<(SandboxBankTransferSimulateResponse, Integer, Hash)>] SandboxBankTransferSimulateResponse data, response status code and response headers
|
8032
|
+
def sandbox_bank_transfer_simulate_with_http_info(sandbox_bank_transfer_simulate_request, opts = {})
|
8033
|
+
if @api_client.config.debugging
|
8034
|
+
@api_client.config.logger.debug 'Calling API: PlaidApi.sandbox_bank_transfer_simulate ...'
|
8035
|
+
end
|
8036
|
+
# verify the required parameter 'sandbox_bank_transfer_simulate_request' is set
|
8037
|
+
if @api_client.config.client_side_validation && sandbox_bank_transfer_simulate_request.nil?
|
8038
|
+
fail ArgumentError, "Missing the required parameter 'sandbox_bank_transfer_simulate_request' when calling PlaidApi.sandbox_bank_transfer_simulate"
|
8039
|
+
end
|
8040
|
+
# resource path
|
8041
|
+
local_var_path = '/sandbox/bank_transfer/simulate'
|
8042
|
+
|
8043
|
+
# query parameters
|
8044
|
+
query_params = opts[:query_params] || {}
|
8045
|
+
|
8046
|
+
# header parameters
|
8047
|
+
header_params = opts[:header_params] || {}
|
8048
|
+
# HTTP header 'Accept' (if needed)
|
8049
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
8050
|
+
# HTTP header 'Content-Type'
|
8051
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
8052
|
+
|
8053
|
+
# form parameters
|
8054
|
+
form_params = opts[:form_params] || {}
|
8055
|
+
|
8056
|
+
# http body (model)
|
8057
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(sandbox_bank_transfer_simulate_request)
|
8058
|
+
|
8059
|
+
# return_type
|
8060
|
+
return_type = opts[:debug_return_type] || 'SandboxBankTransferSimulateResponse'
|
8061
|
+
|
8062
|
+
# auth_names
|
8063
|
+
auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
|
8064
|
+
|
8065
|
+
new_options = opts.merge(
|
8066
|
+
:operation => :"PlaidApi.sandbox_bank_transfer_simulate",
|
8067
|
+
:header_params => header_params,
|
8068
|
+
:query_params => query_params,
|
8069
|
+
:form_params => form_params,
|
8070
|
+
:body => post_body,
|
8071
|
+
:auth_names => auth_names,
|
8072
|
+
:return_type => return_type
|
8073
|
+
)
|
8074
|
+
|
8075
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
8076
|
+
if @api_client.config.debugging
|
8077
|
+
@api_client.config.logger.debug "API called: PlaidApi#sandbox_bank_transfer_simulate\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
8078
|
+
end
|
8079
|
+
return data, status_code, headers
|
8080
|
+
end
|
8081
|
+
|
8082
|
+
# Manually fire an Income webhook
|
8083
|
+
# Use the `/sandbox/income/fire_webhook` endpoint to manually trigger an Income webhook in the Sandbox environment.
|
8084
|
+
# @param sandbox_income_fire_webhook_request [SandboxIncomeFireWebhookRequest]
|
8085
|
+
# @param [Hash] opts the optional parameters
|
8086
|
+
# @return [SandboxIncomeFireWebhookResponse]
|
8087
|
+
def sandbox_income_fire_webhook(sandbox_income_fire_webhook_request, opts = {})
|
8088
|
+
data, _status_code, _headers = sandbox_income_fire_webhook_with_http_info(sandbox_income_fire_webhook_request, opts)
|
8089
|
+
data
|
8090
|
+
end
|
8091
|
+
|
8092
|
+
# Manually fire an Income webhook
|
8093
|
+
# Use the `/sandbox/income/fire_webhook` endpoint to manually trigger an Income webhook in the Sandbox environment.
|
8094
|
+
# @param sandbox_income_fire_webhook_request [SandboxIncomeFireWebhookRequest]
|
8095
|
+
# @param [Hash] opts the optional parameters
|
8096
|
+
# @return [Array<(SandboxIncomeFireWebhookResponse, Integer, Hash)>] SandboxIncomeFireWebhookResponse data, response status code and response headers
|
8097
|
+
def sandbox_income_fire_webhook_with_http_info(sandbox_income_fire_webhook_request, opts = {})
|
8098
|
+
if @api_client.config.debugging
|
8099
|
+
@api_client.config.logger.debug 'Calling API: PlaidApi.sandbox_income_fire_webhook ...'
|
8100
|
+
end
|
8101
|
+
# verify the required parameter 'sandbox_income_fire_webhook_request' is set
|
8102
|
+
if @api_client.config.client_side_validation && sandbox_income_fire_webhook_request.nil?
|
8103
|
+
fail ArgumentError, "Missing the required parameter 'sandbox_income_fire_webhook_request' when calling PlaidApi.sandbox_income_fire_webhook"
|
8104
|
+
end
|
8105
|
+
# resource path
|
8106
|
+
local_var_path = '/sandbox/income/fire_webhook'
|
8107
|
+
|
8108
|
+
# query parameters
|
8109
|
+
query_params = opts[:query_params] || {}
|
8110
|
+
|
8111
|
+
# header parameters
|
8112
|
+
header_params = opts[:header_params] || {}
|
8113
|
+
# HTTP header 'Accept' (if needed)
|
8114
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
8115
|
+
# HTTP header 'Content-Type'
|
8116
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
8117
|
+
|
8118
|
+
# form parameters
|
8119
|
+
form_params = opts[:form_params] || {}
|
8120
|
+
|
8121
|
+
# http body (model)
|
8122
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(sandbox_income_fire_webhook_request)
|
8123
|
+
|
8124
|
+
# return_type
|
8125
|
+
return_type = opts[:debug_return_type] || 'SandboxIncomeFireWebhookResponse'
|
8126
|
+
|
8127
|
+
# auth_names
|
8128
|
+
auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
|
8129
|
+
|
8130
|
+
new_options = opts.merge(
|
8131
|
+
:operation => :"PlaidApi.sandbox_income_fire_webhook",
|
8132
|
+
:header_params => header_params,
|
8133
|
+
:query_params => query_params,
|
8134
|
+
:form_params => form_params,
|
8135
|
+
:body => post_body,
|
8136
|
+
:auth_names => auth_names,
|
8137
|
+
:return_type => return_type
|
8138
|
+
)
|
8139
|
+
|
8140
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
8141
|
+
if @api_client.config.debugging
|
8142
|
+
@api_client.config.logger.debug "API called: PlaidApi#sandbox_income_fire_webhook\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
8143
|
+
end
|
8144
|
+
return data, status_code, headers
|
8145
|
+
end
|
8146
|
+
|
8147
|
+
# Fire a test webhook
|
8148
|
+
# 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. `RECURRING_TRANSACTIONS_UPDATE`: Recurring Transactions webhook to be fired for a given Sandbox Item. If the Item does not support Recurring Transactions, a `SANDBOX_PRODUCT_NOT_ENABLED` error will result. `SYNC_UPDATES_AVAILABLE`: Transactions webhook to be fired for a given Sandbox Item. If the Item does not support Transactions, a `SANDBOX_PRODUCT_NOT_ENABLED` error will result. `PRODUCT_READY`: Assets webhook to be fired when a given asset report has been successfully generated. If the Item does not support Assets, a `SANDBOX_PRODUCT_NOT_ENABLED` error will result. `ERROR`: Assets webhook to be fired when asset report generation has failed. If the Item does not support Assets, a `SANDBOX_PRODUCT_NOT_ENABLED` error will result. 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.
|
8149
|
+
# @param sandbox_item_fire_webhook_request [SandboxItemFireWebhookRequest]
|
8150
|
+
# @param [Hash] opts the optional parameters
|
8151
|
+
# @return [SandboxItemFireWebhookResponse]
|
8152
|
+
def sandbox_item_fire_webhook(sandbox_item_fire_webhook_request, opts = {})
|
8153
|
+
data, _status_code, _headers = sandbox_item_fire_webhook_with_http_info(sandbox_item_fire_webhook_request, opts)
|
8154
|
+
data
|
8155
|
+
end
|
8156
|
+
|
8157
|
+
# Fire a test webhook
|
8158
|
+
# 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. `RECURRING_TRANSACTIONS_UPDATE`: Recurring Transactions webhook to be fired for a given Sandbox Item. If the Item does not support Recurring Transactions, a `SANDBOX_PRODUCT_NOT_ENABLED` error will result. `SYNC_UPDATES_AVAILABLE`: Transactions webhook to be fired for a given Sandbox Item. If the Item does not support Transactions, a `SANDBOX_PRODUCT_NOT_ENABLED` error will result. `PRODUCT_READY`: Assets webhook to be fired when a given asset report has been successfully generated. If the Item does not support Assets, a `SANDBOX_PRODUCT_NOT_ENABLED` error will result. `ERROR`: Assets webhook to be fired when asset report generation has failed. If the Item does not support Assets, a `SANDBOX_PRODUCT_NOT_ENABLED` error will result. 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.
|
8159
|
+
# @param sandbox_item_fire_webhook_request [SandboxItemFireWebhookRequest]
|
8160
|
+
# @param [Hash] opts the optional parameters
|
8161
|
+
# @return [Array<(SandboxItemFireWebhookResponse, Integer, Hash)>] SandboxItemFireWebhookResponse data, response status code and response headers
|
8162
|
+
def sandbox_item_fire_webhook_with_http_info(sandbox_item_fire_webhook_request, opts = {})
|
8163
|
+
if @api_client.config.debugging
|
8164
|
+
@api_client.config.logger.debug 'Calling API: PlaidApi.sandbox_item_fire_webhook ...'
|
8165
|
+
end
|
8166
|
+
# verify the required parameter 'sandbox_item_fire_webhook_request' is set
|
8167
|
+
if @api_client.config.client_side_validation && sandbox_item_fire_webhook_request.nil?
|
8168
|
+
fail ArgumentError, "Missing the required parameter 'sandbox_item_fire_webhook_request' when calling PlaidApi.sandbox_item_fire_webhook"
|
8169
|
+
end
|
8170
|
+
# resource path
|
8171
|
+
local_var_path = '/sandbox/item/fire_webhook'
|
8172
|
+
|
8173
|
+
# query parameters
|
8174
|
+
query_params = opts[:query_params] || {}
|
8175
|
+
|
8176
|
+
# header parameters
|
8177
|
+
header_params = opts[:header_params] || {}
|
8178
|
+
# HTTP header 'Accept' (if needed)
|
8179
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
8180
|
+
# HTTP header 'Content-Type'
|
8181
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
8182
|
+
|
8183
|
+
# form parameters
|
8184
|
+
form_params = opts[:form_params] || {}
|
8185
|
+
|
8186
|
+
# http body (model)
|
8187
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(sandbox_item_fire_webhook_request)
|
8188
|
+
|
8189
|
+
# return_type
|
8190
|
+
return_type = opts[:debug_return_type] || 'SandboxItemFireWebhookResponse'
|
8191
|
+
|
8192
|
+
# auth_names
|
8193
|
+
auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
|
8194
|
+
|
8195
|
+
new_options = opts.merge(
|
8196
|
+
:operation => :"PlaidApi.sandbox_item_fire_webhook",
|
8197
|
+
:header_params => header_params,
|
8198
|
+
:query_params => query_params,
|
8199
|
+
:form_params => form_params,
|
8200
|
+
:body => post_body,
|
8201
|
+
:auth_names => auth_names,
|
8202
|
+
:return_type => return_type
|
8203
|
+
)
|
8204
|
+
|
8205
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
8206
|
+
if @api_client.config.debugging
|
8207
|
+
@api_client.config.logger.debug "API called: PlaidApi#sandbox_item_fire_webhook\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
8208
|
+
end
|
8209
|
+
return data, status_code, headers
|
8210
|
+
end
|
8211
|
+
|
8212
|
+
# Force a Sandbox Item into an error state
|
8213
|
+
# `/sandbox/item/reset_login/` forces an Item into an `ITEM_LOGIN_REQUIRED` state in order to simulate an Item whose login is no longer valid. This makes it easy to test Link's [update mode](https://plaid.com/docs/link/update-mode) flow in the Sandbox environment. After calling `/sandbox/item/reset_login`, You can then use Plaid Link update mode to restore the Item to a good state. An `ITEM_LOGIN_REQUIRED` webhook will also be fired after a call to this endpoint, if one is associated with the Item. In the Sandbox, Items will transition to an `ITEM_LOGIN_REQUIRED` error state automatically after 30 days, even if this endpoint is not called.
|
8214
|
+
# @param sandbox_item_reset_login_request [SandboxItemResetLoginRequest]
|
8215
|
+
# @param [Hash] opts the optional parameters
|
8216
|
+
# @return [SandboxItemResetLoginResponse]
|
8217
|
+
def sandbox_item_reset_login(sandbox_item_reset_login_request, opts = {})
|
8218
|
+
data, _status_code, _headers = sandbox_item_reset_login_with_http_info(sandbox_item_reset_login_request, opts)
|
8219
|
+
data
|
8220
|
+
end
|
8221
|
+
|
8222
|
+
# Force a Sandbox Item into an error state
|
8223
|
+
# `/sandbox/item/reset_login/` forces an Item into an `ITEM_LOGIN_REQUIRED` state in order to simulate an Item whose login is no longer valid. This makes it easy to test Link's [update mode](https://plaid.com/docs/link/update-mode) flow in the Sandbox environment. After calling `/sandbox/item/reset_login`, You can then use Plaid Link update mode to restore the Item to a good state. An `ITEM_LOGIN_REQUIRED` webhook will also be fired after a call to this endpoint, if one is associated with the Item. In the Sandbox, Items will transition to an `ITEM_LOGIN_REQUIRED` error state automatically after 30 days, even if this endpoint is not called.
|
8224
|
+
# @param sandbox_item_reset_login_request [SandboxItemResetLoginRequest]
|
8225
|
+
# @param [Hash] opts the optional parameters
|
8226
|
+
# @return [Array<(SandboxItemResetLoginResponse, Integer, Hash)>] SandboxItemResetLoginResponse data, response status code and response headers
|
8227
|
+
def sandbox_item_reset_login_with_http_info(sandbox_item_reset_login_request, opts = {})
|
8228
|
+
if @api_client.config.debugging
|
8229
|
+
@api_client.config.logger.debug 'Calling API: PlaidApi.sandbox_item_reset_login ...'
|
8230
|
+
end
|
8231
|
+
# verify the required parameter 'sandbox_item_reset_login_request' is set
|
8232
|
+
if @api_client.config.client_side_validation && sandbox_item_reset_login_request.nil?
|
8233
|
+
fail ArgumentError, "Missing the required parameter 'sandbox_item_reset_login_request' when calling PlaidApi.sandbox_item_reset_login"
|
8234
|
+
end
|
8235
|
+
# resource path
|
8236
|
+
local_var_path = '/sandbox/item/reset_login'
|
8237
|
+
|
8238
|
+
# query parameters
|
8239
|
+
query_params = opts[:query_params] || {}
|
8240
|
+
|
8241
|
+
# header parameters
|
8242
|
+
header_params = opts[:header_params] || {}
|
8243
|
+
# HTTP header 'Accept' (if needed)
|
8244
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
8245
|
+
# HTTP header 'Content-Type'
|
8246
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
8247
|
+
|
8248
|
+
# form parameters
|
8249
|
+
form_params = opts[:form_params] || {}
|
8250
|
+
|
8251
|
+
# http body (model)
|
8252
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(sandbox_item_reset_login_request)
|
8253
|
+
|
8254
|
+
# return_type
|
8255
|
+
return_type = opts[:debug_return_type] || 'SandboxItemResetLoginResponse'
|
8256
|
+
|
8257
|
+
# auth_names
|
8258
|
+
auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
|
8259
|
+
|
8260
|
+
new_options = opts.merge(
|
8261
|
+
:operation => :"PlaidApi.sandbox_item_reset_login",
|
8262
|
+
:header_params => header_params,
|
8263
|
+
:query_params => query_params,
|
8264
|
+
:form_params => form_params,
|
8265
|
+
:body => post_body,
|
8266
|
+
:auth_names => auth_names,
|
8267
|
+
:return_type => return_type
|
8268
|
+
)
|
8269
|
+
|
8270
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
8271
|
+
if @api_client.config.debugging
|
8272
|
+
@api_client.config.logger.debug "API called: PlaidApi#sandbox_item_reset_login\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
7688
8273
|
end
|
7689
8274
|
return data, status_code, headers
|
7690
8275
|
end
|
@@ -8860,7 +9445,7 @@ module Plaid
|
|
8860
9445
|
end
|
8861
9446
|
|
8862
9447
|
# Enrich locally-held transaction data
|
8863
|
-
# The `/transactions/enrich` endpoint enriches raw transaction data generated by your own banking products or retrieved from other non-Plaid sources.
|
9448
|
+
# The `/transactions/enrich` endpoint enriches raw transaction data generated by your own banking products or retrieved from other non-Plaid sources.
|
8864
9449
|
# @param transactions_enrich_get_request [TransactionsEnrichGetRequest]
|
8865
9450
|
# @param [Hash] opts the optional parameters
|
8866
9451
|
# @return [TransactionsEnrichGetResponse]
|
@@ -8870,7 +9455,7 @@ module Plaid
|
|
8870
9455
|
end
|
8871
9456
|
|
8872
9457
|
# Enrich locally-held transaction data
|
8873
|
-
# The `/transactions/enrich` endpoint enriches raw transaction data generated by your own banking products or retrieved from other non-Plaid sources.
|
9458
|
+
# The `/transactions/enrich` endpoint enriches raw transaction data generated by your own banking products or retrieved from other non-Plaid sources.
|
8874
9459
|
# @param transactions_enrich_get_request [TransactionsEnrichGetRequest]
|
8875
9460
|
# @param [Hash] opts the optional parameters
|
8876
9461
|
# @return [Array<(TransactionsEnrichGetResponse, Integer, Hash)>] TransactionsEnrichGetResponse data, response status code and response headers
|
@@ -9315,7 +9900,7 @@ module Plaid
|
|
9315
9900
|
end
|
9316
9901
|
|
9317
9902
|
# Get incremental transaction updates on an Item
|
9318
|
-
# This endpoint replaces `/transactions/get` and its associated webhooks for most common use-cases. The `/transactions/sync` endpoint allows developers to subscribe to all transactions associated with an Item and get updates synchronously in a stream-like manner, using a cursor to track which updates have already been seen. `/transactions/sync` provides the same functionality as `/transactions/get` and can be used instead of `/transactions/get` to simplify the process of tracking transactions updates. This endpoint provides user-authorized transaction data for `credit`, `depository`, and some loan-type accounts (only those with account subtype `student`; coverage may be limited). For transaction history from `investments` accounts, use `/investments/transactions/get` instead. Returned transactions data is grouped into three types of update, indicating whether the transaction was added, removed, or modified since the last call to the API. In the first call to `/transactions/sync` for an Item, the endpoint will return all historical transactions data associated with that Item up until the time of the API call (as \"adds\"), which then generates a `next_cursor` for that Item. In subsequent calls, send the `next_cursor` to receive only the changes that have occurred since the previous call. Due to the potentially large number of transactions associated with an Item, results are paginated. The `has_more` field specifies if additional calls are necessary to fetch all available transaction updates. Call `/transactions/sync` with the new cursor, pulling all updates, until `has_more` is `false`. When retrieving paginated updates, track both the `next_cursor` from the latest response and the original cursor from the first call in which `has_more` was `true`; if a call to `/transactions/sync` fails
|
9903
|
+
# This endpoint replaces `/transactions/get` and its associated webhooks for most common use-cases. The `/transactions/sync` endpoint allows developers to subscribe to all transactions associated with an Item and get updates synchronously in a stream-like manner, using a cursor to track which updates have already been seen. `/transactions/sync` provides the same functionality as `/transactions/get` and can be used instead of `/transactions/get` to simplify the process of tracking transactions updates. This endpoint provides user-authorized transaction data for `credit`, `depository`, and some loan-type accounts (only those with account subtype `student`; coverage may be limited). For transaction history from `investments` accounts, use `/investments/transactions/get` instead. Returned transactions data is grouped into three types of update, indicating whether the transaction was added, removed, or modified since the last call to the API. In the first call to `/transactions/sync` for an Item, the endpoint will return all historical transactions data associated with that Item up until the time of the API call (as \"adds\"), which then generates a `next_cursor` for that Item. In subsequent calls, send the `next_cursor` to receive only the changes that have occurred since the previous call. Due to the potentially large number of transactions associated with an Item, results are paginated. The `has_more` field specifies if additional calls are necessary to fetch all available transaction updates. Call `/transactions/sync` with the new cursor, pulling all updates, until `has_more` is `false`. When retrieving paginated updates, track both the `next_cursor` from the latest response and the original cursor from the first call in which `has_more` was `true`; if a call to `/transactions/sync` fails due to the [`TRANSACTIONS_SYNC_MUTATION_DURING_PAGINATION`](https://plaid.com/docs/errors/transactions/#transactions_sync_mutation_during_pagination) error, the entire pagination request loop must be restarted beginning with the cursor for the first page of the update, rather than retrying only the single request that failed. Whenever new or updated transaction data becomes available, `/transactions/sync` will provide these updates. Plaid typically checks for new data multiple times a day, but these checks may occur less frequently, such as once a day, depending on the institution. An Item's `status.transactions.last_successful_update` field will show the timestamp of the most recent successful update. To force Plaid to check for new transactions, use the `/transactions/refresh` endpoint. Note that for newly created Items, data may not be immediately available to `/transactions/sync`. Plaid begins preparing transactions data when the Item is created, but the process can take anywhere from a few seconds to several minutes to complete, depending on the number of transactions available. To be alerted when new data is available, listen for the [`SYNC_UPDATES_AVAILABLE`](https://plaid.com/docs/api/products/transactions/#sync_updates_available) webhook.
|
9319
9904
|
# @param transactions_sync_request [TransactionsSyncRequest]
|
9320
9905
|
# @param [Hash] opts the optional parameters
|
9321
9906
|
# @return [TransactionsSyncResponse]
|
@@ -9325,7 +9910,7 @@ module Plaid
|
|
9325
9910
|
end
|
9326
9911
|
|
9327
9912
|
# Get incremental transaction updates on an Item
|
9328
|
-
# This endpoint replaces `/transactions/get` and its associated webhooks for most common use-cases. The `/transactions/sync` endpoint allows developers to subscribe to all transactions associated with an Item and get updates synchronously in a stream-like manner, using a cursor to track which updates have already been seen. `/transactions/sync` provides the same functionality as `/transactions/get` and can be used instead of `/transactions/get` to simplify the process of tracking transactions updates. This endpoint provides user-authorized transaction data for `credit`, `depository`, and some loan-type accounts (only those with account subtype `student`; coverage may be limited). For transaction history from `investments` accounts, use `/investments/transactions/get` instead. Returned transactions data is grouped into three types of update, indicating whether the transaction was added, removed, or modified since the last call to the API. In the first call to `/transactions/sync` for an Item, the endpoint will return all historical transactions data associated with that Item up until the time of the API call (as \"adds\"), which then generates a `next_cursor` for that Item. In subsequent calls, send the `next_cursor` to receive only the changes that have occurred since the previous call. Due to the potentially large number of transactions associated with an Item, results are paginated. The `has_more` field specifies if additional calls are necessary to fetch all available transaction updates. Call `/transactions/sync` with the new cursor, pulling all updates, until `has_more` is `false`. When retrieving paginated updates, track both the `next_cursor` from the latest response and the original cursor from the first call in which `has_more` was `true`; if a call to `/transactions/sync` fails
|
9913
|
+
# This endpoint replaces `/transactions/get` and its associated webhooks for most common use-cases. The `/transactions/sync` endpoint allows developers to subscribe to all transactions associated with an Item and get updates synchronously in a stream-like manner, using a cursor to track which updates have already been seen. `/transactions/sync` provides the same functionality as `/transactions/get` and can be used instead of `/transactions/get` to simplify the process of tracking transactions updates. This endpoint provides user-authorized transaction data for `credit`, `depository`, and some loan-type accounts (only those with account subtype `student`; coverage may be limited). For transaction history from `investments` accounts, use `/investments/transactions/get` instead. Returned transactions data is grouped into three types of update, indicating whether the transaction was added, removed, or modified since the last call to the API. In the first call to `/transactions/sync` for an Item, the endpoint will return all historical transactions data associated with that Item up until the time of the API call (as \"adds\"), which then generates a `next_cursor` for that Item. In subsequent calls, send the `next_cursor` to receive only the changes that have occurred since the previous call. Due to the potentially large number of transactions associated with an Item, results are paginated. The `has_more` field specifies if additional calls are necessary to fetch all available transaction updates. Call `/transactions/sync` with the new cursor, pulling all updates, until `has_more` is `false`. When retrieving paginated updates, track both the `next_cursor` from the latest response and the original cursor from the first call in which `has_more` was `true`; if a call to `/transactions/sync` fails due to the [`TRANSACTIONS_SYNC_MUTATION_DURING_PAGINATION`](https://plaid.com/docs/errors/transactions/#transactions_sync_mutation_during_pagination) error, the entire pagination request loop must be restarted beginning with the cursor for the first page of the update, rather than retrying only the single request that failed. Whenever new or updated transaction data becomes available, `/transactions/sync` will provide these updates. Plaid typically checks for new data multiple times a day, but these checks may occur less frequently, such as once a day, depending on the institution. An Item's `status.transactions.last_successful_update` field will show the timestamp of the most recent successful update. To force Plaid to check for new transactions, use the `/transactions/refresh` endpoint. Note that for newly created Items, data may not be immediately available to `/transactions/sync`. Plaid begins preparing transactions data when the Item is created, but the process can take anywhere from a few seconds to several minutes to complete, depending on the number of transactions available. To be alerted when new data is available, listen for the [`SYNC_UPDATES_AVAILABLE`](https://plaid.com/docs/api/products/transactions/#sync_updates_available) webhook.
|
9329
9914
|
# @param transactions_sync_request [TransactionsSyncRequest]
|
9330
9915
|
# @param [Hash] opts the optional parameters
|
9331
9916
|
# @return [Array<(TransactionsSyncResponse, Integer, Hash)>] TransactionsSyncResponse data, response status code and response headers
|
@@ -9380,7 +9965,7 @@ module Plaid
|
|
9380
9965
|
end
|
9381
9966
|
|
9382
9967
|
# Create a transfer authorization
|
9383
|
-
# 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 `ITEM_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. `device.ip_address
|
9968
|
+
# 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 `ITEM_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. The fields `device.ip_address` and `device.user_agent` are required for all sessions where the end-user is present. For example, when a user is authorizing a one-time payment from their device. For [Guarantee](https://www.plaid.com/docs//transfer/guarantee/), the following fields are required : `idempotency_key`, `user.phone_number` (optional if `email_address` provided), `user.email_address` (optional if `phone_number` provided), `device.ip_address`, `device.user_agent`, and `user_present`.
|
9384
9969
|
# @param transfer_authorization_create_request [TransferAuthorizationCreateRequest]
|
9385
9970
|
# @param [Hash] opts the optional parameters
|
9386
9971
|
# @return [TransferAuthorizationCreateResponse]
|
@@ -9390,7 +9975,7 @@ module Plaid
|
|
9390
9975
|
end
|
9391
9976
|
|
9392
9977
|
# Create a transfer authorization
|
9393
|
-
# 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 `ITEM_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. `device.ip_address`
|
9978
|
+
# 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 `ITEM_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. The fields `device.ip_address` and `device.user_agent` are required for all sessions where the end-user is present. For example, when a user is authorizing a one-time payment from their device. For [Guarantee](https://www.plaid.com/docs//transfer/guarantee/), the following fields are required : `idempotency_key`, `user.phone_number` (optional if `email_address` provided), `user.email_address` (optional if `phone_number` provided), `device.ip_address`, `device.user_agent`, and `user_present`.
|
9394
9979
|
# @param transfer_authorization_create_request [TransferAuthorizationCreateRequest]
|
9395
9980
|
# @param [Hash] opts the optional parameters
|
9396
9981
|
# @return [Array<(TransferAuthorizationCreateResponse, Integer, Hash)>] TransferAuthorizationCreateResponse data, response status code and response headers
|
@@ -9444,6 +10029,71 @@ module Plaid
|
|
9444
10029
|
return data, status_code, headers
|
9445
10030
|
end
|
9446
10031
|
|
10032
|
+
# Retrieve a balance held with Plaid
|
10033
|
+
# Use the `/transfer/balance/get` endpoint to view a balance held with Plaid.
|
10034
|
+
# @param transfer_balance_get_request [TransferBalanceGetRequest]
|
10035
|
+
# @param [Hash] opts the optional parameters
|
10036
|
+
# @return [TransferBalanceGetResponse]
|
10037
|
+
def transfer_balance_get(transfer_balance_get_request, opts = {})
|
10038
|
+
data, _status_code, _headers = transfer_balance_get_with_http_info(transfer_balance_get_request, opts)
|
10039
|
+
data
|
10040
|
+
end
|
10041
|
+
|
10042
|
+
# Retrieve a balance held with Plaid
|
10043
|
+
# Use the `/transfer/balance/get` endpoint to view a balance held with Plaid.
|
10044
|
+
# @param transfer_balance_get_request [TransferBalanceGetRequest]
|
10045
|
+
# @param [Hash] opts the optional parameters
|
10046
|
+
# @return [Array<(TransferBalanceGetResponse, Integer, Hash)>] TransferBalanceGetResponse data, response status code and response headers
|
10047
|
+
def transfer_balance_get_with_http_info(transfer_balance_get_request, opts = {})
|
10048
|
+
if @api_client.config.debugging
|
10049
|
+
@api_client.config.logger.debug 'Calling API: PlaidApi.transfer_balance_get ...'
|
10050
|
+
end
|
10051
|
+
# verify the required parameter 'transfer_balance_get_request' is set
|
10052
|
+
if @api_client.config.client_side_validation && transfer_balance_get_request.nil?
|
10053
|
+
fail ArgumentError, "Missing the required parameter 'transfer_balance_get_request' when calling PlaidApi.transfer_balance_get"
|
10054
|
+
end
|
10055
|
+
# resource path
|
10056
|
+
local_var_path = '/transfer/balance/get'
|
10057
|
+
|
10058
|
+
# query parameters
|
10059
|
+
query_params = opts[:query_params] || {}
|
10060
|
+
|
10061
|
+
# header parameters
|
10062
|
+
header_params = opts[:header_params] || {}
|
10063
|
+
# HTTP header 'Accept' (if needed)
|
10064
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
10065
|
+
# HTTP header 'Content-Type'
|
10066
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
10067
|
+
|
10068
|
+
# form parameters
|
10069
|
+
form_params = opts[:form_params] || {}
|
10070
|
+
|
10071
|
+
# http body (model)
|
10072
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(transfer_balance_get_request)
|
10073
|
+
|
10074
|
+
# return_type
|
10075
|
+
return_type = opts[:debug_return_type] || 'TransferBalanceGetResponse'
|
10076
|
+
|
10077
|
+
# auth_names
|
10078
|
+
auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
|
10079
|
+
|
10080
|
+
new_options = opts.merge(
|
10081
|
+
:operation => :"PlaidApi.transfer_balance_get",
|
10082
|
+
:header_params => header_params,
|
10083
|
+
:query_params => query_params,
|
10084
|
+
:form_params => form_params,
|
10085
|
+
:body => post_body,
|
10086
|
+
:auth_names => auth_names,
|
10087
|
+
:return_type => return_type
|
10088
|
+
)
|
10089
|
+
|
10090
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
10091
|
+
if @api_client.config.debugging
|
10092
|
+
@api_client.config.logger.debug "API called: PlaidApi#transfer_balance_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
10093
|
+
end
|
10094
|
+
return data, status_code, headers
|
10095
|
+
end
|
10096
|
+
|
9447
10097
|
# Cancel a transfer
|
9448
10098
|
# Use the `/transfer/cancel` endpoint to cancel a transfer. A transfer is eligible for cancellation if the `cancellable` property returned by `/transfer/get` is `true`.
|
9449
10099
|
# @param transfer_cancel_request [TransferCancelRequest]
|
@@ -9704,6 +10354,71 @@ module Plaid
|
|
9704
10354
|
return data, status_code, headers
|
9705
10355
|
end
|
9706
10356
|
|
10357
|
+
# Submit transfer diligence on behalf of the end customer (i.e. the originator).
|
10358
|
+
# Use the `/transfer/diligence/submit` endpoint to submit transfer diligence on behalf of the originator.
|
10359
|
+
# @param transfer_diligence_submit_request [TransferDiligenceSubmitRequest]
|
10360
|
+
# @param [Hash] opts the optional parameters
|
10361
|
+
# @return [TransferDiligenceSubmitResponse]
|
10362
|
+
def transfer_diligence_submit(transfer_diligence_submit_request, opts = {})
|
10363
|
+
data, _status_code, _headers = transfer_diligence_submit_with_http_info(transfer_diligence_submit_request, opts)
|
10364
|
+
data
|
10365
|
+
end
|
10366
|
+
|
10367
|
+
# Submit transfer diligence on behalf of the end customer (i.e. the originator).
|
10368
|
+
# Use the `/transfer/diligence/submit` endpoint to submit transfer diligence on behalf of the originator.
|
10369
|
+
# @param transfer_diligence_submit_request [TransferDiligenceSubmitRequest]
|
10370
|
+
# @param [Hash] opts the optional parameters
|
10371
|
+
# @return [Array<(TransferDiligenceSubmitResponse, Integer, Hash)>] TransferDiligenceSubmitResponse data, response status code and response headers
|
10372
|
+
def transfer_diligence_submit_with_http_info(transfer_diligence_submit_request, opts = {})
|
10373
|
+
if @api_client.config.debugging
|
10374
|
+
@api_client.config.logger.debug 'Calling API: PlaidApi.transfer_diligence_submit ...'
|
10375
|
+
end
|
10376
|
+
# verify the required parameter 'transfer_diligence_submit_request' is set
|
10377
|
+
if @api_client.config.client_side_validation && transfer_diligence_submit_request.nil?
|
10378
|
+
fail ArgumentError, "Missing the required parameter 'transfer_diligence_submit_request' when calling PlaidApi.transfer_diligence_submit"
|
10379
|
+
end
|
10380
|
+
# resource path
|
10381
|
+
local_var_path = '/transfer/diligence/submit'
|
10382
|
+
|
10383
|
+
# query parameters
|
10384
|
+
query_params = opts[:query_params] || {}
|
10385
|
+
|
10386
|
+
# header parameters
|
10387
|
+
header_params = opts[:header_params] || {}
|
10388
|
+
# HTTP header 'Accept' (if needed)
|
10389
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
10390
|
+
# HTTP header 'Content-Type'
|
10391
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
10392
|
+
|
10393
|
+
# form parameters
|
10394
|
+
form_params = opts[:form_params] || {}
|
10395
|
+
|
10396
|
+
# http body (model)
|
10397
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(transfer_diligence_submit_request)
|
10398
|
+
|
10399
|
+
# return_type
|
10400
|
+
return_type = opts[:debug_return_type] || 'TransferDiligenceSubmitResponse'
|
10401
|
+
|
10402
|
+
# auth_names
|
10403
|
+
auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
|
10404
|
+
|
10405
|
+
new_options = opts.merge(
|
10406
|
+
:operation => :"PlaidApi.transfer_diligence_submit",
|
10407
|
+
:header_params => header_params,
|
10408
|
+
:query_params => query_params,
|
10409
|
+
:form_params => form_params,
|
10410
|
+
:body => post_body,
|
10411
|
+
:auth_names => auth_names,
|
10412
|
+
:return_type => return_type
|
10413
|
+
)
|
10414
|
+
|
10415
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
10416
|
+
if @api_client.config.debugging
|
10417
|
+
@api_client.config.logger.debug "API called: PlaidApi#transfer_diligence_submit\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
10418
|
+
end
|
10419
|
+
return data, status_code, headers
|
10420
|
+
end
|
10421
|
+
|
9707
10422
|
# List transfer events
|
9708
10423
|
# Use the `/transfer/event/list` endpoint to get a list of transfer events based on specified filter criteria.
|
9709
10424
|
# @param transfer_event_list_request [TransferEventListRequest]
|