plaid 22.0.0 → 24.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 +917 -105
- data/CONTRIBUTING.md +4 -1
- data/Gemfile.lock +3 -3
- data/Makefile +1 -1
- data/README.md +112 -57
- data/lib/plaid/api/plaid_api.rb +663 -51
- 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 +4 -4
- 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 +4 -4
- 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 +5 -5
- data/lib/plaid/models/account_identity_all_of.rb +2 -2
- data/lib/plaid/models/account_identity_match_score.rb +4 -4
- 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 +2 -2
- 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_not_required.rb +1 -1
- data/lib/plaid/models/address_data_nullable.rb +1 -1
- data/lib/plaid/models/address_data_nullable_no_required_fields.rb +1 -1
- data/lib/plaid/models/address_match_score.rb +1 -1
- 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 +2 -2
- data/lib/plaid/models/application_get_request.rb +2 -2
- 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 +2 -12
- 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_investment_holding.rb +1 -1
- data/lib/plaid/models/asset_report_investment_security.rb +1 -1
- data/lib/plaid/models/asset_report_investments.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_type.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 +12 -2
- data/lib/plaid/models/assets_product_ready_webhook.rb +12 -2
- 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 +20 -5
- data/lib/plaid/models/automatically_verified_webhook.rb +15 -5
- data/lib/plaid/models/bank_income_complete_result.rb +1 -1
- data/lib/plaid/models/bank_income_complete_webhook.rb +1 -1
- data/lib/plaid/models/bank_income_refresh_complete_result.rb +1 -1
- data/lib/plaid/models/bank_income_refresh_complete_webhook.rb +2 -2
- data/lib/plaid/models/bank_income_refresh_update_webhook.rb +2 -2
- 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/base_report.rb +1 -1
- data/lib/plaid/models/base_report_account.rb +2 -2
- data/lib/plaid/models/base_report_account_balances.rb +319 -0
- data/lib/plaid/models/{credit_freddie_mac_asset_transaction_voe25.rb → base_report_account_balances_all_of.rb} +32 -30
- data/lib/plaid/models/base_report_account_insights.rb +3 -3
- data/lib/plaid/models/base_report_average_flow_insights.rb +3 -3
- data/lib/plaid/models/{credit_freddie_mac_verification_of_assets_voa24.rb → base_report_average_monthly_balances.rb} +29 -29
- data/lib/plaid/models/base_report_get_request.rb +1 -1
- data/lib/plaid/models/base_report_get_response.rb +14 -2
- data/lib/plaid/models/base_report_item.rb +1 -1
- data/lib/plaid/models/base_report_longest_gap_insights.rb +3 -3
- data/lib/plaid/models/base_report_number_flow_insights.rb +3 -3
- data/lib/plaid/models/base_report_transaction.rb +1 -1
- data/lib/plaid/models/{fraud_amount_nullable.rb → base_report_warning.rb} +39 -25
- data/lib/plaid/models/base_report_warning_code.rb +39 -0
- data/lib/plaid/models/base_reports_error_webhook.rb +1 -1
- data/lib/plaid/models/base_reports_product_ready_webhook.rb +1 -1
- data/lib/plaid/models/beacon_audit_trail.rb +1 -1
- data/lib/plaid/models/beacon_audit_trail_source.rb +1 -1
- data/lib/plaid/models/beacon_match_summary_code.rb +41 -0
- data/lib/plaid/models/beacon_report.rb +309 -0
- data/lib/plaid/models/beacon_report_create_request.rb +2 -1
- data/lib/plaid/models/beacon_report_create_response.rb +2 -6
- data/lib/plaid/models/beacon_report_list_request.rb +257 -0
- data/lib/plaid/models/beacon_report_list_response.rb +253 -0
- data/lib/plaid/models/beacon_report_syndication.rb +254 -0
- data/lib/plaid/models/beacon_report_syndication_analysis.rb +309 -0
- data/lib/plaid/models/beacon_report_syndication_list_request.rb +257 -0
- data/lib/plaid/models/beacon_report_syndication_list_response.rb +253 -0
- data/lib/plaid/models/{beacon_user_create_embedded_report.rb → beacon_report_syndication_original_report.rb} +35 -19
- data/lib/plaid/models/beacon_report_type.rb +2 -2
- data/lib/plaid/models/beacon_user_address.rb +1 -1
- data/lib/plaid/models/beacon_user_create_request.rb +2 -12
- data/lib/plaid/models/beacon_user_create_response.rb +1 -1
- data/lib/plaid/models/beacon_user_data.rb +1 -1
- data/lib/plaid/models/beacon_user_get_request.rb +1 -1
- data/lib/plaid/models/beacon_user_get_response.rb +1 -1
- data/lib/plaid/models/beacon_user_id_number.rb +1 -1
- data/lib/plaid/models/beacon_user_name.rb +1 -1
- data/lib/plaid/models/beacon_user_request_address.rb +1 -1
- data/lib/plaid/models/beacon_user_request_data.rb +1 -1
- data/lib/plaid/models/beacon_user_review_request.rb +260 -0
- data/lib/plaid/models/beacon_user_status.rb +1 -1
- data/lib/plaid/models/{credit_freddie_mac_asset_voe25.rb → beacon_user_status_updated_webhook.rb} +45 -42
- data/lib/plaid/models/categories_get_response.rb +1 -1
- data/lib/plaid/models/category.rb +1 -1
- data/lib/plaid/models/category_insight_details.rb +283 -0
- data/lib/plaid/models/category_insights.rb +235 -0
- data/lib/plaid/models/cause.rb +1 -1
- 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 +3 -3
- data/lib/plaid/models/consumer_report_permissible_purpose.rb +1 -1
- data/lib/plaid/models/consumer_report_user_identity.rb +1 -1
- data/lib/plaid/models/counterparty.rb +1 -1
- data/lib/plaid/models/{signal_insights.rb → counterparty_insights.rb} +23 -20
- data/lib/plaid/models/counterparty_type.rb +1 -1
- data/lib/plaid/models/country_code.rb +2 -1
- data/lib/plaid/models/cra_bank_income.rb +1 -1
- data/lib/plaid/models/cra_bank_income_account.rb +1 -1
- data/lib/plaid/models/cra_bank_income_cause.rb +1 -1
- data/lib/plaid/models/cra_bank_income_complete_result.rb +1 -1
- data/lib/plaid/models/cra_bank_income_complete_webhook.rb +1 -1
- data/lib/plaid/models/cra_bank_income_employer.rb +1 -1
- data/lib/plaid/models/cra_bank_income_get_request.rb +1 -1
- data/lib/plaid/models/cra_bank_income_get_response.rb +1 -1
- data/lib/plaid/models/cra_bank_income_historical_summary.rb +1 -1
- data/lib/plaid/models/cra_bank_income_item.rb +1 -1
- data/lib/plaid/models/cra_bank_income_source.rb +1 -1
- data/lib/plaid/models/cra_bank_income_summary.rb +1 -1
- data/lib/plaid/models/cra_bank_income_transaction.rb +1 -1
- data/lib/plaid/models/cra_bank_income_warning.rb +1 -1
- data/lib/plaid/models/cra_bank_income_warning_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_ach_class.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 +1 -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_bank_income_webhook_update_request.rb +1 -1
- data/lib/plaid/models/credit_bank_income_webhook_update_response.rb +1 -1
- data/lib/plaid/models/credit_bank_statement_upload_account_owner.rb +1 -1
- data/lib/plaid/models/credit_bank_statement_upload_account_owner_address.rb +1 -1
- data/lib/plaid/models/credit_bank_statement_upload_bank_account.rb +1 -1
- data/lib/plaid/models/credit_bank_statement_upload_bank_account_period.rb +1 -1
- data/lib/plaid/models/credit_bank_statement_upload_item.rb +1 -1
- data/lib/plaid/models/credit_bank_statement_upload_object.rb +1 -1
- data/lib/plaid/models/credit_bank_statement_upload_transaction.rb +1 -1
- data/lib/plaid/models/credit_bank_statements_uploads_get_request.rb +1 -1
- data/lib/plaid/models/credit_bank_statements_uploads_get_response.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 +2 -2
- 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_voa24.rb → credit_freddie_mac_asset.rb} +5 -5
- data/lib/plaid/models/{credit_freddie_mac_asset_transaction_voa24.rb → credit_freddie_mac_asset_transaction.rb} +4 -4
- data/lib/plaid/models/{credit_freddie_mac_asset_transactions_voa24.rb → credit_freddie_mac_asset_transactions.rb} +5 -5
- data/lib/plaid/models/{credit_freddie_mac_assets_voe25.rb → credit_freddie_mac_assets.rb} +5 -5
- data/lib/plaid/models/{credit_freddie_mac_individual_name_voa24.rb → credit_freddie_mac_individual_name.rb} +4 -4
- data/lib/plaid/models/{credit_freddie_mac_loan_voa24.rb → credit_freddie_mac_loan.rb} +5 -5
- data/lib/plaid/models/{credit_freddie_mac_loan_identifiers_voa24.rb → credit_freddie_mac_loan_identifiers.rb} +4 -4
- data/lib/plaid/models/{credit_freddie_mac_loans_voa24.rb → credit_freddie_mac_loans.rb} +5 -5
- data/lib/plaid/models/{credit_freddie_mac_parties_voa24.rb → credit_freddie_mac_parties.rb} +5 -5
- data/lib/plaid/models/{credit_freddie_mac_party_voa24.rb → credit_freddie_mac_party.rb} +5 -5
- data/lib/plaid/models/{credit_freddie_mac_party_individual_voa24.rb → credit_freddie_mac_party_individual.rb} +5 -5
- data/lib/plaid/models/{credit_freddie_mac_reporting_information_voa24.rb → credit_freddie_mac_reporting_information.rb} +4 -4
- data/lib/plaid/models/credit_freddie_mac_reports_get_request.rb +1 -1
- data/lib/plaid/models/credit_freddie_mac_reports_get_response.rb +31 -22
- data/lib/plaid/models/{credit_freddie_mac_service_voa24.rb → credit_freddie_mac_service.rb} +5 -5
- data/lib/plaid/models/{credit_freddie_mac_services_voa24.rb → credit_freddie_mac_services.rb} +5 -5
- data/lib/plaid/models/{credit_freddie_mac_verification_of_asset_voa24.rb → credit_freddie_mac_verification_of_asset.rb} +6 -6
- data/lib/plaid/models/{credit_freddie_mac_verification_of_asset_response_voe25.rb → credit_freddie_mac_verification_of_asset_response.rb} +5 -5
- data/lib/plaid/models/{credit_freddie_mac_verification_of_assets_deal_voa24.rb → credit_freddie_mac_verification_of_assets_deal.rb} +7 -7
- 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_parsing_config_update_request.rb +273 -0
- data/lib/plaid/models/credit_payroll_income_parsing_config_update_response.rb +226 -0
- 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 +2 -2
- data/lib/plaid/models/credit_payroll_income_refresh_response.rb +1 -1
- data/lib/plaid/models/credit_payroll_income_risk_signals_get_request.rb +1 -1
- data/lib/plaid/models/credit_payroll_income_risk_signals_get_response.rb +1 -1
- 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_pdf_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 +2 -1
- data/lib/plaid/models/detected_account.rb +308 -0
- 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 +1 -1
- 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 +1 -1
- 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 +1 -1
- 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 +1 -1
- 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 +1 -1
- 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 +1 -1
- 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 +1 -1
- data/lib/plaid/models/fdx_notification.rb +1 -6
- data/lib/plaid/models/fdx_notification_category.rb +1 -1
- data/lib/plaid/models/fdx_notification_payload.rb +1 -1
- 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 +1 -1
- data/lib/plaid/models/financial_institution_insights.rb +265 -0
- data/lib/plaid/models/form1099_type.rb +1 -1
- data/lib/plaid/models/fraud_amount.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/hosted_link_delivery_method.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 +1 -1
- 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 +1 -1
- data/lib/plaid/models/identity_refresh_request.rb +1 -1
- data/lib/plaid/models/identity_refresh_response.rb +1 -1
- data/lib/plaid/models/identity_update_types.rb +1 -1
- data/lib/plaid/models/identity_verification.rb +1 -1
- data/lib/plaid/models/identity_verification_create_request.rb +1 -1
- data/lib/plaid/models/identity_verification_create_request_user.rb +1 -1
- data/lib/plaid/models/identity_verification_create_response.rb +1 -1
- data/lib/plaid/models/identity_verification_document_address_response.rb +1 -1
- data/lib/plaid/models/identity_verification_get_request.rb +1 -1
- data/lib/plaid/models/identity_verification_get_response.rb +1 -1
- data/lib/plaid/models/identity_verification_list_request.rb +1 -1
- data/lib/plaid/models/identity_verification_list_response.rb +1 -1
- data/lib/plaid/models/identity_verification_request_user.rb +1 -1
- 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 +1 -1
- data/lib/plaid/models/identity_verification_retry_request_steps_object.rb +1 -1
- data/lib/plaid/models/identity_verification_retry_response.rb +1 -1
- 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 +1 -1
- 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_doc_parsing_config.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_refresh_reconnect_needed_webhook.rb +270 -0
- data/lib/plaid/models/income_verification_risk_signals_status_webhook.rb +1 -1
- 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_status_alert_webhook.rb +285 -0
- 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_auth_get_numbers.rb +1 -1
- data/lib/plaid/models/investments_auth_get_request.rb +1 -1
- data/lib/plaid/models/investments_auth_get_request_options.rb +1 -1
- data/lib/plaid/models/investments_auth_get_response.rb +1 -1
- data/lib/plaid/models/investments_auth_owner.rb +1 -1
- data/lib/plaid/models/investments_default_update_webhook.rb +1 -1
- data/lib/plaid/models/investments_historical_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 +15 -5
- data/lib/plaid/models/investments_refresh_request.rb +1 -1
- data/lib/plaid/models/investments_refresh_response.rb +1 -1
- 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 +15 -5
- data/lib/plaid/models/investments_transactions_override.rb +1 -1
- data/lib/plaid/models/iso_currency_code.rb +1 -1
- data/lib/plaid/models/issuing_country.rb +1 -1
- data/lib/plaid/models/item.rb +2 -2
- 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 +2 -2
- data/lib/plaid/models/item_application_scopes_update_response.rb +1 -1
- data/lib/plaid/models/item_application_unlink_request.rb +261 -0
- data/lib/plaid/models/{credit_freddie_mac_services_voe25.rb → item_application_unlink_response.rb} +16 -15
- 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 +2 -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 +1 -1
- data/lib/plaid/models/link_event_metadata.rb +1 -1
- data/lib/plaid/models/link_event_name.rb +1 -1
- data/lib/plaid/models/link_events_webhook.rb +1 -1
- 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_session_exit.rb +1 -1
- data/lib/plaid/models/link_session_exit_metadata.rb +1 -1
- data/lib/plaid/models/link_session_exit_metadata_institution.rb +1 -1
- data/lib/plaid/models/link_session_finished_webhook.rb +1 -1
- data/lib/plaid/models/link_session_success.rb +1 -1
- data/lib/plaid/models/link_session_success_metadata.rb +1 -1
- data/lib/plaid/models/link_session_success_metadata_account.rb +2 -2
- data/lib/plaid/models/link_session_success_metadata_institution.rb +1 -1
- data/lib/plaid/models/link_session_success_metadata_transfer_status.rb +1 -1
- data/lib/plaid/models/link_token_account_filters.rb +15 -6
- 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_hosted_link.rb +25 -5
- 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 +106 -8
- data/lib/plaid/models/link_token_create_request_account_subtypes.rb +1 -1
- data/lib/plaid/models/link_token_create_request_auth.rb +22 -2
- data/lib/plaid/models/link_token_create_request_base_report.rb +36 -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 +3 -12
- 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 +2 -2
- data/lib/plaid/models/link_token_create_request_payment_initiation.rb +1 -1
- data/lib/plaid/models/link_token_create_request_statements.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 +22 -1
- data/lib/plaid/models/link_token_create_request_user_address.rb +1 -1
- data/lib/plaid/models/link_token_create_request_user_id_number.rb +1 -1
- data/lib/plaid/models/link_token_create_request_user_name.rb +1 -1
- 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_get_sessions_response.rb +1 -1
- data/lib/plaid/models/link_token_investments.rb +15 -5
- data/lib/plaid/models/link_token_investments_auth.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/merchant_insights.rb +315 -0
- 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 +1 -1
- 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_acats.rb +1 -1
- data/lib/plaid/models/numbers_ach.rb +2 -2
- data/lib/plaid/models/numbers_ach_nullable.rb +2 -2
- data/lib/plaid/models/numbers_aton.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/omittable_transfer_type.rb +1 -1
- data/lib/plaid/models/originator.rb +1 -1
- data/lib/plaid/models/originator_expected_transfer_frequency.rb +1 -1
- data/lib/plaid/models/other_account_subtype.rb +39 -0
- data/lib/plaid/models/other_filter.rb +228 -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 +3 -8
- 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 +2 -1
- data/lib/plaid/models/partner_customer_remove_response.rb +1 -1
- data/lib/plaid/models/partner_end_customer.rb +3 -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 +3 -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 +1 -1
- 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 +3 -3
- 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 +1 -1
- 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_account_get_request.rb +1 -1
- data/lib/plaid/models/processor_account_get_response.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_default_update_webhook.rb +1 -1
- data/lib/plaid/models/processor_historical_update_webhook.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 +1 -1
- data/lib/plaid/models/processor_identity_match_response.rb +1 -1
- data/lib/plaid/models/processor_initial_update_webhook.rb +1 -1
- data/lib/plaid/models/processor_number.rb +1 -1
- data/lib/plaid/models/processor_recurring_transactions_update_webhook.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 +1 -1
- data/lib/plaid/models/processor_signal_prepare_request.rb +246 -0
- data/lib/plaid/models/processor_signal_prepare_response.rb +226 -0
- 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_sync_updates_available_webhook.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 +1 -1
- data/lib/plaid/models/processor_token_permissions_get_response.rb +1 -1
- data/lib/plaid/models/processor_token_permissions_set_request.rb +1 -1
- data/lib/plaid/models/processor_token_permissions_set_response.rb +1 -1
- data/lib/plaid/models/processor_token_webhook_update.rb +1 -1
- data/lib/plaid/models/processor_token_webhook_update_request.rb +1 -1
- data/lib/plaid/models/processor_token_webhook_update_response.rb +1 -1
- data/lib/plaid/models/processor_transactions_get_request.rb +2 -2
- data/lib/plaid/models/{credit_freddie_mac_asset_detail_voe25.rb → processor_transactions_get_request_options.rb} +96 -87
- data/lib/plaid/models/processor_transactions_get_response.rb +11 -14
- data/lib/plaid/models/processor_transactions_recurring_get_request.rb +5 -22
- data/lib/plaid/models/processor_transactions_recurring_get_response.rb +1 -1
- data/lib/plaid/models/processor_transactions_refresh_request.rb +1 -1
- data/lib/plaid/models/processor_transactions_refresh_response.rb +1 -1
- data/lib/plaid/models/processor_transactions_removed_webhook.rb +1 -1
- data/lib/plaid/models/processor_transactions_sync_request.rb +1 -1
- data/lib/plaid/models/processor_transactions_sync_response.rb +1 -1
- data/lib/plaid/models/product_access.rb +1 -1
- data/lib/plaid/models/product_permissions_required_auth_webhook.rb +1 -1
- data/lib/plaid/models/product_permissions_required_identity_webhook.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 +1 -1
- 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_frequency.rb +1 -1
- data/lib/plaid/models/recurring_insights_stream.rb +379 -0
- 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.rb +245 -0
- data/lib/plaid/models/recurring_transactions_update_webhook.rb +1 -1
- data/lib/plaid/models/recurring_transfer.rb +2 -2
- data/lib/plaid/models/recurring_transfer_nullable.rb +2 -2
- 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 +1 -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_identity_abuse_signals.rb +1 -1
- data/lib/plaid/models/risk_check_linked_service.rb +1 -1
- data/lib/plaid/models/risk_check_phone.rb +1 -1
- data/lib/plaid/models/risk_check_stolen_identity.rb +1 -1
- data/lib/plaid/models/risk_check_synthetic_identity.rb +1 -1
- data/lib/plaid/models/risk_signal_document_reference.rb +1 -1
- data/lib/plaid/models/risk_signal_document_status.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_income_fire_webhook_request.rb +1 -1
- data/lib/plaid/models/sandbox_bank_income_fire_webhook_response.rb +1 -1
- data/lib/plaid/models/sandbox_bank_income_webhook_fire_request_webhook_code.rb +1 -1
- data/lib/plaid/models/sandbox_bank_income_webhook_fire_request_webhook_fields.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 +17 -8
- data/lib/plaid/models/sandbox_income_fire_webhook_response.rb +1 -1
- data/lib/plaid/models/sandbox_income_webhook_fire_request_webhook_code.rb +39 -0
- 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_ledger_deposit_simulate_request.rb +1 -1
- data/lib/plaid/models/sandbox_transfer_ledger_deposit_simulate_response.rb +1 -1
- data/lib/plaid/models/sandbox_transfer_ledger_simulate_available_request.rb +1 -1
- data/lib/plaid/models/sandbox_transfer_ledger_simulate_available_response.rb +1 -1
- data/lib/plaid/models/sandbox_transfer_ledger_withdraw_simulate_request.rb +1 -1
- data/lib/plaid/models/sandbox_transfer_ledger_withdraw_simulate_response.rb +1 -1
- data/lib/plaid/models/sandbox_transfer_refund_simulate_request.rb +282 -0
- data/lib/plaid/models/sandbox_transfer_refund_simulate_response.rb +226 -0
- 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 +1 -1
- 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 +3 -3
- data/lib/plaid/models/security_override.rb +3 -3
- data/lib/plaid/models/selfie_analysis.rb +1 -1
- data/lib/plaid/models/selfie_analysis_document_comparison.rb +1 -1
- data/lib/plaid/models/selfie_capture.rb +1 -1
- data/lib/plaid/models/selfie_check.rb +1 -1
- data/lib/plaid/models/selfie_check_selfie.rb +1 -1
- data/lib/plaid/models/selfie_check_status.rb +1 -1
- data/lib/plaid/models/selfie_status.rb +1 -1
- 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 +2 -2
- 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 +1 -1
- 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 +1 -1
- data/lib/plaid/models/simulated_transfer_sweep.rb +16 -5
- 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/statements_account.rb +1 -1
- data/lib/plaid/models/statements_download_request.rb +1 -1
- data/lib/plaid/models/statements_list_request.rb +1 -1
- data/lib/plaid/models/statements_list_response.rb +1 -1
- data/lib/plaid/models/statements_statement.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/sweep_status.rb +1 -1
- data/lib/plaid/models/sweep_trigger.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 +6 -6
- data/lib/plaid/models/transaction_all_of.rb +2 -2
- data/lib/plaid/models/transaction_base.rb +5 -5
- 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 +31 -6
- 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 → transactions_enrich_request.rb} +5 -5
- data/lib/plaid/models/transactions_enrich_request_options.rb +1 -1
- data/lib/plaid/models/{transactions_enrich_get_response.rb → transactions_enrich_response.rb} +5 -5
- data/lib/plaid/models/transactions_get_request.rb +1 -1
- data/lib/plaid/models/transactions_get_request_options.rb +5 -5
- data/lib/plaid/models/transactions_get_response.rb +1 -1
- data/lib/plaid/models/transactions_recurring_create_input.rb +223 -0
- data/lib/plaid/models/transactions_recurring_create_request.rb +263 -0
- data/lib/plaid/models/transactions_recurring_create_response.rb +252 -0
- data/lib/plaid/models/transactions_recurring_get_request.rb +1 -1
- data/lib/plaid/models/transactions_recurring_get_request_options.rb +2 -2
- data/lib/plaid/models/transactions_recurring_get_response.rb +1 -1
- data/lib/plaid/models/{credit_freddie_mac_asset_transactions_voe25.rb → transactions_recurring_merge_input.rb} +17 -16
- data/lib/plaid/models/transactions_recurring_merge_request.rb +263 -0
- data/lib/plaid/models/transactions_recurring_merge_response.rb +240 -0
- data/lib/plaid/models/{credit_freddie_mac_service_voe25.rb → transactions_recurring_update_input.rb} +28 -26
- data/lib/plaid/models/transactions_recurring_update_request.rb +263 -0
- data/lib/plaid/models/transactions_recurring_update_response.rb +240 -0
- 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 +1 -1
- data/lib/plaid/models/transactions_sync_request_options.rb +3 -3
- data/lib/plaid/models/transactions_sync_response.rb +1 -1
- data/lib/plaid/models/{credit_freddie_verification_of_employment_deal_voe25.rb → transactions_user_insights_get_request.rb} +30 -37
- data/lib/plaid/models/transactions_user_insights_get_response.rb +252 -0
- data/lib/plaid/models/transfer.rb +29 -8
- data/lib/plaid/models/transfer_ach_network.rb +1 -1
- data/lib/plaid/models/transfer_authorization.rb +12 -12
- data/lib/plaid/models/transfer_authorization_create_request.rb +4 -4
- 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 +1 -1
- 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_payment_risk.rb +312 -0
- data/lib/plaid/models/transfer_authorization_proposed_transfer.rb +3 -3
- data/lib/plaid/models/transfer_authorization_risk_level.rb +42 -0
- data/lib/plaid/models/transfer_authorization_user_in_request.rb +1 -1
- data/lib/plaid/models/transfer_balance.rb +1 -1
- data/lib/plaid/models/transfer_balance_get_request.rb +1 -1
- data/lib/plaid/models/transfer_balance_get_response.rb +1 -1
- data/lib/plaid/models/transfer_balance_type.rb +1 -1
- 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 +11 -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 +2 -2
- data/lib/plaid/models/transfer_configuration_get_response.rb +1 -1
- data/lib/plaid/models/transfer_create_request.rb +27 -7
- data/lib/plaid/models/transfer_create_response.rb +1 -1
- data/lib/plaid/models/transfer_credit_funds_source.rb +1 -1
- data/lib/plaid/models/transfer_credit_usage_configuration.rb +2 -2
- data/lib/plaid/models/transfer_debit_usage_configuration.rb +1 -1
- data/lib/plaid/models/transfer_device.rb +1 -1
- data/lib/plaid/models/transfer_diligence_document_upload_request.rb +2 -2
- data/lib/plaid/models/transfer_diligence_document_upload_response.rb +1 -1
- data/lib/plaid/models/transfer_diligence_status.rb +1 -1
- data/lib/plaid/models/transfer_diligence_submit_request.rb +1 -1
- data/lib/plaid/models/transfer_diligence_submit_response.rb +1 -1
- data/lib/plaid/models/transfer_document_purpose.rb +1 -1
- data/lib/plaid/models/transfer_event.rb +1 -1
- 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 +1 -1
- data/lib/plaid/models/transfer_failure.rb +1 -1
- data/lib/plaid/models/transfer_funding_account.rb +2 -2
- 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 +2 -2
- 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 +3 -3
- data/lib/plaid/models/transfer_intent_create_response.rb +1 -1
- data/lib/plaid/models/transfer_intent_get.rb +2 -2
- 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_ledger_balance.rb +1 -1
- data/lib/plaid/models/transfer_ledger_deposit_request.rb +3 -3
- data/lib/plaid/models/transfer_ledger_deposit_response.rb +1 -1
- data/lib/plaid/models/transfer_ledger_distribute_request.rb +322 -0
- data/lib/plaid/models/{credit_freddie_mac_assets_voa24.rb → transfer_ledger_distribute_response.rb} +16 -18
- data/lib/plaid/models/transfer_ledger_get_request.rb +1 -1
- data/lib/plaid/models/transfer_ledger_get_response.rb +1 -1
- data/lib/plaid/models/transfer_ledger_sweep_simulate_event_type.rb +1 -1
- data/lib/plaid/models/transfer_ledger_withdraw_request.rb +3 -3
- data/lib/plaid/models/transfer_ledger_withdraw_response.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 +2 -2
- 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 +5 -1
- 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 +1 -1
- data/lib/plaid/models/transfer_originator_funding_account_update_request.rb +1 -1
- data/lib/plaid/models/transfer_originator_funding_account_update_response.rb +1 -1
- 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 +3 -8
- 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 +16 -5
- 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_failure.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 +16 -5
- 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_data_overview.rb +291 -0
- 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/user_update_request.rb +1 -1
- data/lib/plaid/models/user_update_response.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 +15 -5
- 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_payment_scheme.rb +1 -1
- data/lib/plaid/models/wallet_status.rb +1 -1
- data/lib/plaid/models/wallet_transaction.rb +4 -4
- 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_failure_reason.rb +1 -1
- data/lib/plaid/models/wallet_transaction_get_request.rb +1 -1
- data/lib/plaid/models/wallet_transaction_get_response.rb +4 -4
- 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 +1 -1
- data/lib/plaid/models/watchlist_screening_entity_create_response.rb +1 -1
- data/lib/plaid/models/watchlist_screening_entity_get_request.rb +1 -1
- data/lib/plaid/models/watchlist_screening_entity_get_response.rb +1 -1
- 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 +1 -1
- 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 +1 -1
- data/lib/plaid/models/watchlist_screening_entity_update_request_resettable_field.rb +1 -1
- data/lib/plaid/models/watchlist_screening_entity_update_response.rb +1 -1
- 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 +1 -1
- data/lib/plaid/models/watchlist_screening_individual_create_request.rb +1 -1
- data/lib/plaid/models/watchlist_screening_individual_create_response.rb +1 -1
- data/lib/plaid/models/watchlist_screening_individual_get_request.rb +1 -1
- data/lib/plaid/models/watchlist_screening_individual_get_response.rb +1 -1
- 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 +1 -1
- 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 +1 -1
- data/lib/plaid/models/watchlist_screening_individual_update_request_resettable_field.rb +1 -1
- data/lib/plaid/models/watchlist_screening_individual_update_response.rb +1 -1
- 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 +1 -1
- 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 +1 -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 +1377 -1339
- data/plaid.gemspec +1 -1
- data/test/test_enrich.rb +2 -2
- metadata +75 -37
- data/lib/plaid/models/credit_freddie_mac_asset_transaction_detail_voe25.rb +0 -324
- data/lib/plaid/models/credit_freddie_mac_verification_of_asset_response_voa24.rb +0 -225
- data/lib/plaid/models/credit_freddie_mac_verification_of_asset_voe25.rb +0 -253
- data/lib/plaid/models/credit_freddie_verification_of_employment_voe25.rb +0 -240
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.470.1
|
7
7
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
9
9
|
OpenAPI Generator version: 6.1.0
|
@@ -20,7 +20,7 @@ module Plaid
|
|
20
20
|
@api_client = api_client
|
21
21
|
end
|
22
22
|
# Retrieve real-time balance data
|
23
|
-
# The `/accounts/balance/get` endpoint returns the real-time balance for each of an Item's accounts. While other endpoints
|
23
|
+
# The `/accounts/balance/get` endpoint returns the real-time balance for each of an Item's accounts. While other endpoints, such as `/accounts/get`, return a balance object, only `/accounts/balance/get` forces the available and current balance fields to be refreshed rather than cached. This endpoint can be used for existing Items that were added via any of Plaid’s other products. This endpoint can be used as long as Link has been initialized with any other product, `balance` itself is not a product that can be used to initialize Link. As this endpoint triggers a synchronous request for fresh data, latency may be higher than for other Plaid endpoints (typically less than 10 seconds, but occasionally up to 30 seconds or more); if you encounter errors, you may find it necessary to adjust your timeout period when making requests.
|
24
24
|
# @param accounts_balance_get_request [AccountsBalanceGetRequest]
|
25
25
|
# @param [Hash] opts the optional parameters
|
26
26
|
# @return [AccountsGetResponse]
|
@@ -30,7 +30,7 @@ module Plaid
|
|
30
30
|
end
|
31
31
|
|
32
32
|
# Retrieve real-time balance data
|
33
|
-
# The `/accounts/balance/get` endpoint returns the real-time balance for each of an Item's accounts. While other endpoints
|
33
|
+
# The `/accounts/balance/get` endpoint returns the real-time balance for each of an Item's accounts. While other endpoints, such as `/accounts/get`, return a balance object, only `/accounts/balance/get` forces the available and current balance fields to be refreshed rather than cached. This endpoint can be used for existing Items that were added via any of Plaid’s other products. This endpoint can be used as long as Link has been initialized with any other product, `balance` itself is not a product that can be used to initialize Link. As this endpoint triggers a synchronous request for fresh data, latency may be higher than for other Plaid endpoints (typically less than 10 seconds, but occasionally up to 30 seconds or more); if you encounter errors, you may find it necessary to adjust your timeout period when making requests.
|
34
34
|
# @param accounts_balance_get_request [AccountsBalanceGetRequest]
|
35
35
|
# @param [Hash] opts the optional parameters
|
36
36
|
# @return [Array<(AccountsGetResponse, Integer, Hash)>] AccountsGetResponse data, response status code and response headers
|
@@ -88,7 +88,7 @@ module Plaid
|
|
88
88
|
end
|
89
89
|
|
90
90
|
# Retrieve accounts
|
91
|
-
# The `/accounts/get` endpoint can be used to retrieve a list of accounts associated with any linked Item. Plaid will only return active bank accounts — that is, accounts that are not closed and are capable of carrying a balance. For items that went through the updated account selection pane, this endpoint only returns accounts that were permissioned by the user when they initially created the Item. If a user creates a new account after the initial link, you can capture this event through the [`NEW_ACCOUNTS_AVAILABLE`](https://plaid.com/docs/api/items/#new_accounts_available) webhook and then use Link's [update mode](https://plaid.com/docs/link/update-mode/) to request that the user share this new account with you.
|
91
|
+
# The `/accounts/get` endpoint can be used to retrieve a list of accounts associated with any linked Item. Plaid will only return active bank accounts — that is, accounts that are not closed and are capable of carrying a balance. For items that went through the updated account selection pane, this endpoint only returns accounts that were permissioned by the user when they initially created the Item. If a user creates a new account after the initial link, you can capture this event through the [`NEW_ACCOUNTS_AVAILABLE`](https://plaid.com/docs/api/items/#new_accounts_available) webhook and then use Link's [update mode](https://plaid.com/docs/link/update-mode/) to request that the user share this new account with you. `/accounts/get` is free to use and retrieves cached information, rather than extracting fresh information from the institution. The balance returned will reflect the balance at the time of the last successful Item update. If the Item is enabled for a regularly updating product, such as Transactions, Investments, or Liabilities, the balance will typically update about once a day, as long as the Item is healthy. If the Item is enabled only for products that do not frequently update, such as Auth or Identity, balance data may be much older. For realtime balance information, use the paid endpoint `/accounts/balance/get` instead.
|
92
92
|
# @param accounts_get_request [AccountsGetRequest]
|
93
93
|
# @param [Hash] opts the optional parameters
|
94
94
|
# @return [AccountsGetResponse]
|
@@ -98,7 +98,7 @@ module Plaid
|
|
98
98
|
end
|
99
99
|
|
100
100
|
# Retrieve accounts
|
101
|
-
# The `/accounts/get` endpoint can be used to retrieve a list of accounts associated with any linked Item. Plaid will only return active bank accounts — that is, accounts that are not closed and are capable of carrying a balance. For items that went through the updated account selection pane, this endpoint only returns accounts that were permissioned by the user when they initially created the Item. If a user creates a new account after the initial link, you can capture this event through the [`NEW_ACCOUNTS_AVAILABLE`](https://plaid.com/docs/api/items/#new_accounts_available) webhook and then use Link's [update mode](https://plaid.com/docs/link/update-mode/) to request that the user share this new account with you.
|
101
|
+
# The `/accounts/get` endpoint can be used to retrieve a list of accounts associated with any linked Item. Plaid will only return active bank accounts — that is, accounts that are not closed and are capable of carrying a balance. For items that went through the updated account selection pane, this endpoint only returns accounts that were permissioned by the user when they initially created the Item. If a user creates a new account after the initial link, you can capture this event through the [`NEW_ACCOUNTS_AVAILABLE`](https://plaid.com/docs/api/items/#new_accounts_available) webhook and then use Link's [update mode](https://plaid.com/docs/link/update-mode/) to request that the user share this new account with you. `/accounts/get` is free to use and retrieves cached information, rather than extracting fresh information from the institution. The balance returned will reflect the balance at the time of the last successful Item update. If the Item is enabled for a regularly updating product, such as Transactions, Investments, or Liabilities, the balance will typically update about once a day, as long as the Item is healthy. If the Item is enabled only for products that do not frequently update, such as Auth or Identity, balance data may be much older. For realtime balance information, use the paid endpoint `/accounts/balance/get` instead.
|
102
102
|
# @param accounts_get_request [AccountsGetRequest]
|
103
103
|
# @param [Hash] opts the optional parameters
|
104
104
|
# @return [Array<(AccountsGetResponse, Integer, Hash)>] AccountsGetResponse data, response status code and response headers
|
@@ -1719,6 +1719,142 @@ module Plaid
|
|
1719
1719
|
return data, status_code, headers
|
1720
1720
|
end
|
1721
1721
|
|
1722
|
+
# List Beacon Reports for a Beacon User
|
1723
|
+
# Use the `/beacon/report/list` endpoint to view all Beacon Reports you created for a specific Beacon User. The reports returned by this endpoint are exclusively reports you created for a specific user. A Beacon User can only have one active report at a time, but a new report can be created if a previous report has been deleted. The results from this endpoint are paginated; the `next_cursor` field will be populated if there is another page of results that can be retrieved. To fetch the next page, pass the `next_cursor` value as the `cursor` parameter in the next request.
|
1724
|
+
# @param beacon_report_list_request [BeaconReportListRequest]
|
1725
|
+
# @param [Hash] opts the optional parameters
|
1726
|
+
# @return [BeaconReportListResponse]
|
1727
|
+
def beacon_report_list(beacon_report_list_request, opts = {})
|
1728
|
+
data, _status_code, _headers = beacon_report_list_with_http_info(beacon_report_list_request, opts)
|
1729
|
+
data
|
1730
|
+
end
|
1731
|
+
|
1732
|
+
# List Beacon Reports for a Beacon User
|
1733
|
+
# Use the `/beacon/report/list` endpoint to view all Beacon Reports you created for a specific Beacon User. The reports returned by this endpoint are exclusively reports you created for a specific user. A Beacon User can only have one active report at a time, but a new report can be created if a previous report has been deleted. The results from this endpoint are paginated; the `next_cursor` field will be populated if there is another page of results that can be retrieved. To fetch the next page, pass the `next_cursor` value as the `cursor` parameter in the next request.
|
1734
|
+
# @param beacon_report_list_request [BeaconReportListRequest]
|
1735
|
+
# @param [Hash] opts the optional parameters
|
1736
|
+
# @return [Array<(BeaconReportListResponse, Integer, Hash)>] BeaconReportListResponse data, response status code and response headers
|
1737
|
+
def beacon_report_list_with_http_info(beacon_report_list_request, opts = {})
|
1738
|
+
if @api_client.config.debugging
|
1739
|
+
@api_client.config.logger.debug 'Calling API: PlaidApi.beacon_report_list ...'
|
1740
|
+
end
|
1741
|
+
# verify the required parameter 'beacon_report_list_request' is set
|
1742
|
+
if @api_client.config.client_side_validation && beacon_report_list_request.nil?
|
1743
|
+
fail ArgumentError, "Missing the required parameter 'beacon_report_list_request' when calling PlaidApi.beacon_report_list"
|
1744
|
+
end
|
1745
|
+
# resource path
|
1746
|
+
local_var_path = '/beacon/report/list'
|
1747
|
+
|
1748
|
+
# query parameters
|
1749
|
+
query_params = opts[:query_params] || {}
|
1750
|
+
|
1751
|
+
# header parameters
|
1752
|
+
header_params = opts[:header_params] || {}
|
1753
|
+
# HTTP header 'Accept' (if needed)
|
1754
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1755
|
+
# HTTP header 'Content-Type'
|
1756
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
1757
|
+
if !content_type.nil?
|
1758
|
+
header_params['Content-Type'] = content_type
|
1759
|
+
end
|
1760
|
+
|
1761
|
+
# form parameters
|
1762
|
+
form_params = opts[:form_params] || {}
|
1763
|
+
|
1764
|
+
# http body (model)
|
1765
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(beacon_report_list_request)
|
1766
|
+
|
1767
|
+
# return_type
|
1768
|
+
return_type = opts[:debug_return_type] || 'BeaconReportListResponse'
|
1769
|
+
|
1770
|
+
# auth_names
|
1771
|
+
auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
|
1772
|
+
|
1773
|
+
new_options = opts.merge(
|
1774
|
+
:operation => :"PlaidApi.beacon_report_list",
|
1775
|
+
:header_params => header_params,
|
1776
|
+
:query_params => query_params,
|
1777
|
+
:form_params => form_params,
|
1778
|
+
:body => post_body,
|
1779
|
+
:auth_names => auth_names,
|
1780
|
+
:return_type => return_type
|
1781
|
+
)
|
1782
|
+
|
1783
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
1784
|
+
if @api_client.config.debugging
|
1785
|
+
@api_client.config.logger.debug "API called: PlaidApi#beacon_report_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1786
|
+
end
|
1787
|
+
return data, status_code, headers
|
1788
|
+
end
|
1789
|
+
|
1790
|
+
# List Beacon Report Syndications for a Beacon User
|
1791
|
+
# Use the `/beacon/report_syndication/list` endpoint to view all Beacon Reports that have been syndicated to a specific Beacon User. This endpoint returns Beacon Report Syndications which are references to Beacon Reports created either by you, or another Beacon customer, that matched the specified Beacon User. A Beacon User can have multiple active Beacon Report Syndications at once. The results from this endpoint are paginated; the `next_cursor` field will be populated if there is another page of results that can be retrieved. To fetch the next page, pass the `next_cursor` value as the `cursor` parameter in the next request.
|
1792
|
+
# @param beacon_report_syndication_list_request [BeaconReportSyndicationListRequest]
|
1793
|
+
# @param [Hash] opts the optional parameters
|
1794
|
+
# @return [BeaconReportSyndicationListResponse]
|
1795
|
+
def beacon_report_syndication_list(beacon_report_syndication_list_request, opts = {})
|
1796
|
+
data, _status_code, _headers = beacon_report_syndication_list_with_http_info(beacon_report_syndication_list_request, opts)
|
1797
|
+
data
|
1798
|
+
end
|
1799
|
+
|
1800
|
+
# List Beacon Report Syndications for a Beacon User
|
1801
|
+
# Use the `/beacon/report_syndication/list` endpoint to view all Beacon Reports that have been syndicated to a specific Beacon User. This endpoint returns Beacon Report Syndications which are references to Beacon Reports created either by you, or another Beacon customer, that matched the specified Beacon User. A Beacon User can have multiple active Beacon Report Syndications at once. The results from this endpoint are paginated; the `next_cursor` field will be populated if there is another page of results that can be retrieved. To fetch the next page, pass the `next_cursor` value as the `cursor` parameter in the next request.
|
1802
|
+
# @param beacon_report_syndication_list_request [BeaconReportSyndicationListRequest]
|
1803
|
+
# @param [Hash] opts the optional parameters
|
1804
|
+
# @return [Array<(BeaconReportSyndicationListResponse, Integer, Hash)>] BeaconReportSyndicationListResponse data, response status code and response headers
|
1805
|
+
def beacon_report_syndication_list_with_http_info(beacon_report_syndication_list_request, opts = {})
|
1806
|
+
if @api_client.config.debugging
|
1807
|
+
@api_client.config.logger.debug 'Calling API: PlaidApi.beacon_report_syndication_list ...'
|
1808
|
+
end
|
1809
|
+
# verify the required parameter 'beacon_report_syndication_list_request' is set
|
1810
|
+
if @api_client.config.client_side_validation && beacon_report_syndication_list_request.nil?
|
1811
|
+
fail ArgumentError, "Missing the required parameter 'beacon_report_syndication_list_request' when calling PlaidApi.beacon_report_syndication_list"
|
1812
|
+
end
|
1813
|
+
# resource path
|
1814
|
+
local_var_path = '/beacon/report_syndication/list'
|
1815
|
+
|
1816
|
+
# query parameters
|
1817
|
+
query_params = opts[:query_params] || {}
|
1818
|
+
|
1819
|
+
# header parameters
|
1820
|
+
header_params = opts[:header_params] || {}
|
1821
|
+
# HTTP header 'Accept' (if needed)
|
1822
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1823
|
+
# HTTP header 'Content-Type'
|
1824
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
1825
|
+
if !content_type.nil?
|
1826
|
+
header_params['Content-Type'] = content_type
|
1827
|
+
end
|
1828
|
+
|
1829
|
+
# form parameters
|
1830
|
+
form_params = opts[:form_params] || {}
|
1831
|
+
|
1832
|
+
# http body (model)
|
1833
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(beacon_report_syndication_list_request)
|
1834
|
+
|
1835
|
+
# return_type
|
1836
|
+
return_type = opts[:debug_return_type] || 'BeaconReportSyndicationListResponse'
|
1837
|
+
|
1838
|
+
# auth_names
|
1839
|
+
auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
|
1840
|
+
|
1841
|
+
new_options = opts.merge(
|
1842
|
+
:operation => :"PlaidApi.beacon_report_syndication_list",
|
1843
|
+
:header_params => header_params,
|
1844
|
+
:query_params => query_params,
|
1845
|
+
:form_params => form_params,
|
1846
|
+
:body => post_body,
|
1847
|
+
:auth_names => auth_names,
|
1848
|
+
:return_type => return_type
|
1849
|
+
)
|
1850
|
+
|
1851
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
1852
|
+
if @api_client.config.debugging
|
1853
|
+
@api_client.config.logger.debug "API called: PlaidApi#beacon_report_syndication_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1854
|
+
end
|
1855
|
+
return data, status_code, headers
|
1856
|
+
end
|
1857
|
+
|
1722
1858
|
# Create a Beacon User
|
1723
1859
|
# Create and scan a Beacon User against your Beacon Program, according to your program's settings. When you submit a new user to `/beacon/user/create`, several checks are performed immediately: - The user's PII (provided within the `user` object) is searched against all other users within the Beacon Program you specified. If a match is found that violates your program's \"Duplicate Information Filtering\" settings, the user will be returned with a status of `pending_review`. - The user's PII is also searched against all fraud reports created by your organization across all of your Beacon Programs. If the user's data matches a fraud report that your team created, the user will be returned with a status of `rejected`. - Finally, the user's PII is searched against all fraud report shared with the Beacon Network by other companies. If a matching fraud report is found, the user will be returned with a `pending_review` status if your program has enabled automatic flagging based on network fraud.
|
1724
1860
|
# @param beacon_user_create_request [BeaconUserCreateRequest]
|
@@ -1855,6 +1991,74 @@ module Plaid
|
|
1855
1991
|
return data, status_code, headers
|
1856
1992
|
end
|
1857
1993
|
|
1994
|
+
# Review a Beacon User
|
1995
|
+
# Update the status of a Beacon User. When updating a Beacon User's status via this endpoint, Plaid validates that the status change is consistent with the related state for this Beacon User. Specifically, we will check: 1. Whether there are any associated Beacon Reports connected to the Beacon User, and 2. Whether there are any confirmed Beacon Report Syndications connected to the Beacon User. When updating a Beacon User's status to \"rejected\", we enforce that either a Beacon Report has been created for the Beacon User or a Beacon Report Syndication has been confirmed. When updating a Beacon User's status to \"cleared\", we enforce that there are no active Beacon Reports or confirmed Beacon Report Syndications associated with the user. If you previously created a Beacon Report for this user, you must delete it before updating the Beacon User's status to \"cleared\". There are no restrictions on updating a Beacon User's status to \"pending_review\". If these conditions are not met, the request will be rejected with an error explaining the issue.
|
1996
|
+
# @param beacon_user_review_request [BeaconUserReviewRequest]
|
1997
|
+
# @param [Hash] opts the optional parameters
|
1998
|
+
# @return [BeaconUserGetResponse]
|
1999
|
+
def beacon_user_review(beacon_user_review_request, opts = {})
|
2000
|
+
data, _status_code, _headers = beacon_user_review_with_http_info(beacon_user_review_request, opts)
|
2001
|
+
data
|
2002
|
+
end
|
2003
|
+
|
2004
|
+
# Review a Beacon User
|
2005
|
+
# Update the status of a Beacon User. When updating a Beacon User's status via this endpoint, Plaid validates that the status change is consistent with the related state for this Beacon User. Specifically, we will check: 1. Whether there are any associated Beacon Reports connected to the Beacon User, and 2. Whether there are any confirmed Beacon Report Syndications connected to the Beacon User. When updating a Beacon User's status to \"rejected\", we enforce that either a Beacon Report has been created for the Beacon User or a Beacon Report Syndication has been confirmed. When updating a Beacon User's status to \"cleared\", we enforce that there are no active Beacon Reports or confirmed Beacon Report Syndications associated with the user. If you previously created a Beacon Report for this user, you must delete it before updating the Beacon User's status to \"cleared\". There are no restrictions on updating a Beacon User's status to \"pending_review\". If these conditions are not met, the request will be rejected with an error explaining the issue.
|
2006
|
+
# @param beacon_user_review_request [BeaconUserReviewRequest]
|
2007
|
+
# @param [Hash] opts the optional parameters
|
2008
|
+
# @return [Array<(BeaconUserGetResponse, Integer, Hash)>] BeaconUserGetResponse data, response status code and response headers
|
2009
|
+
def beacon_user_review_with_http_info(beacon_user_review_request, opts = {})
|
2010
|
+
if @api_client.config.debugging
|
2011
|
+
@api_client.config.logger.debug 'Calling API: PlaidApi.beacon_user_review ...'
|
2012
|
+
end
|
2013
|
+
# verify the required parameter 'beacon_user_review_request' is set
|
2014
|
+
if @api_client.config.client_side_validation && beacon_user_review_request.nil?
|
2015
|
+
fail ArgumentError, "Missing the required parameter 'beacon_user_review_request' when calling PlaidApi.beacon_user_review"
|
2016
|
+
end
|
2017
|
+
# resource path
|
2018
|
+
local_var_path = '/beacon/user/review'
|
2019
|
+
|
2020
|
+
# query parameters
|
2021
|
+
query_params = opts[:query_params] || {}
|
2022
|
+
|
2023
|
+
# header parameters
|
2024
|
+
header_params = opts[:header_params] || {}
|
2025
|
+
# HTTP header 'Accept' (if needed)
|
2026
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
2027
|
+
# HTTP header 'Content-Type'
|
2028
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
2029
|
+
if !content_type.nil?
|
2030
|
+
header_params['Content-Type'] = content_type
|
2031
|
+
end
|
2032
|
+
|
2033
|
+
# form parameters
|
2034
|
+
form_params = opts[:form_params] || {}
|
2035
|
+
|
2036
|
+
# http body (model)
|
2037
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(beacon_user_review_request)
|
2038
|
+
|
2039
|
+
# return_type
|
2040
|
+
return_type = opts[:debug_return_type] || 'BeaconUserGetResponse'
|
2041
|
+
|
2042
|
+
# auth_names
|
2043
|
+
auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
|
2044
|
+
|
2045
|
+
new_options = opts.merge(
|
2046
|
+
:operation => :"PlaidApi.beacon_user_review",
|
2047
|
+
:header_params => header_params,
|
2048
|
+
:query_params => query_params,
|
2049
|
+
:form_params => form_params,
|
2050
|
+
:body => post_body,
|
2051
|
+
:auth_names => auth_names,
|
2052
|
+
:return_type => return_type
|
2053
|
+
)
|
2054
|
+
|
2055
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
2056
|
+
if @api_client.config.debugging
|
2057
|
+
@api_client.config.logger.debug "API called: PlaidApi#beacon_user_review\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
2058
|
+
end
|
2059
|
+
return data, status_code, headers
|
2060
|
+
end
|
2061
|
+
|
1858
2062
|
# Get categories
|
1859
2063
|
# Send a request to the `/categories/get` endpoint to get detailed information on categories returned by Plaid. This endpoint does not require authentication. All implementations are recommended to use the newer `personal_finance_category` taxonomy instead of the older `category` taxonomy supported by this endpoint. The [`personal_finance_category taxonomy` CSV file](https://plaid.com/documents/transactions-personal-finance-category-taxonomy.csv) is available for download and is not accessible via API.
|
1860
2064
|
# @param body [Object]
|
@@ -2536,7 +2740,7 @@ module Plaid
|
|
2536
2740
|
end
|
2537
2741
|
|
2538
2742
|
# Subscribe and unsubscribe to proactive notifications for a user's income profile
|
2539
|
-
# `/credit/bank_income/webhook/update` allows you to subscribe or unsubscribe a user for income webhook notifications. If a user is subscribed, on significant changes to the user's income profile, you will receive a `BANK_INCOME_REFRESH_UPDATE` webhook, prompting you to refresh bank income data for the user.
|
2743
|
+
# `/credit/bank_income/webhook/update` allows you to subscribe or unsubscribe a user for income webhook notifications. By default, all users start out unsubscribed. If a user is subscribed, on significant changes to the user's income profile, you will receive a `BANK_INCOME_REFRESH_UPDATE` webhook, prompting you to refresh bank income data for the user.
|
2540
2744
|
# @param credit_bank_income_webhook_update_request [CreditBankIncomeWebhookUpdateRequest]
|
2541
2745
|
# @param [Hash] opts the optional parameters
|
2542
2746
|
# @return [CreditBankIncomeWebhookUpdateResponse]
|
@@ -2546,7 +2750,7 @@ module Plaid
|
|
2546
2750
|
end
|
2547
2751
|
|
2548
2752
|
# Subscribe and unsubscribe to proactive notifications for a user's income profile
|
2549
|
-
# `/credit/bank_income/webhook/update` allows you to subscribe or unsubscribe a user for income webhook notifications. If a user is subscribed, on significant changes to the user's income profile, you will receive a `BANK_INCOME_REFRESH_UPDATE` webhook, prompting you to refresh bank income data for the user.
|
2753
|
+
# `/credit/bank_income/webhook/update` allows you to subscribe or unsubscribe a user for income webhook notifications. By default, all users start out unsubscribed. If a user is subscribed, on significant changes to the user's income profile, you will receive a `BANK_INCOME_REFRESH_UPDATE` webhook, prompting you to refresh bank income data for the user.
|
2550
2754
|
# @param credit_bank_income_webhook_update_request [CreditBankIncomeWebhookUpdateRequest]
|
2551
2755
|
# @param [Hash] opts the optional parameters
|
2552
2756
|
# @return [Array<(CreditBankIncomeWebhookUpdateResponse, Integer, Hash)>] CreditBankIncomeWebhookUpdateResponse data, response status code and response headers
|
@@ -2604,7 +2808,7 @@ module Plaid
|
|
2604
2808
|
end
|
2605
2809
|
|
2606
2810
|
# Retrieve data for a user's uploaded bank statements
|
2607
|
-
# `/credit/bank_statements/uploads/get` returns data from
|
2811
|
+
# `/credit/bank_statements/uploads/get` returns parsed data from bank statements uploaded by users as part of the Document Income flow. If your account is not enabled for Document Parsing, contact your account manager to request access.
|
2608
2812
|
# @param credit_bank_statements_uploads_get_request [CreditBankStatementsUploadsGetRequest]
|
2609
2813
|
# @param [Hash] opts the optional parameters
|
2610
2814
|
# @return [CreditBankStatementsUploadsGetResponse]
|
@@ -2614,7 +2818,7 @@ module Plaid
|
|
2614
2818
|
end
|
2615
2819
|
|
2616
2820
|
# Retrieve data for a user's uploaded bank statements
|
2617
|
-
# `/credit/bank_statements/uploads/get` returns data from
|
2821
|
+
# `/credit/bank_statements/uploads/get` returns parsed data from bank statements uploaded by users as part of the Document Income flow. If your account is not enabled for Document Parsing, contact your account manager to request access.
|
2618
2822
|
# @param credit_bank_statements_uploads_get_request [CreditBankStatementsUploadsGetRequest]
|
2619
2823
|
# @param [Hash] opts the optional parameters
|
2620
2824
|
# @return [Array<(CreditBankStatementsUploadsGetResponse, Integer, Hash)>] CreditBankStatementsUploadsGetResponse data, response status code and response headers
|
@@ -2875,6 +3079,74 @@ module Plaid
|
|
2875
3079
|
return data, status_code, headers
|
2876
3080
|
end
|
2877
3081
|
|
3082
|
+
# Update the parsing configuration for a document income verification
|
3083
|
+
# `/credit/payroll_income/parsing_config/update` updates the parsing configuration for a document income verification.
|
3084
|
+
# @param request_body [Hash<String, Object>]
|
3085
|
+
# @param [Hash] opts the optional parameters
|
3086
|
+
# @return [CreditPayrollIncomeParsingConfigUpdateResponse]
|
3087
|
+
def credit_payroll_income_parsing_config_update(request_body, opts = {})
|
3088
|
+
data, _status_code, _headers = credit_payroll_income_parsing_config_update_with_http_info(request_body, opts)
|
3089
|
+
data
|
3090
|
+
end
|
3091
|
+
|
3092
|
+
# Update the parsing configuration for a document income verification
|
3093
|
+
# `/credit/payroll_income/parsing_config/update` updates the parsing configuration for a document income verification.
|
3094
|
+
# @param request_body [Hash<String, Object>]
|
3095
|
+
# @param [Hash] opts the optional parameters
|
3096
|
+
# @return [Array<(CreditPayrollIncomeParsingConfigUpdateResponse, Integer, Hash)>] CreditPayrollIncomeParsingConfigUpdateResponse data, response status code and response headers
|
3097
|
+
def credit_payroll_income_parsing_config_update_with_http_info(request_body, opts = {})
|
3098
|
+
if @api_client.config.debugging
|
3099
|
+
@api_client.config.logger.debug 'Calling API: PlaidApi.credit_payroll_income_parsing_config_update ...'
|
3100
|
+
end
|
3101
|
+
# verify the required parameter 'request_body' is set
|
3102
|
+
if @api_client.config.client_side_validation && request_body.nil?
|
3103
|
+
fail ArgumentError, "Missing the required parameter 'request_body' when calling PlaidApi.credit_payroll_income_parsing_config_update"
|
3104
|
+
end
|
3105
|
+
# resource path
|
3106
|
+
local_var_path = '/credit/payroll_income/parsing_config/update'
|
3107
|
+
|
3108
|
+
# query parameters
|
3109
|
+
query_params = opts[:query_params] || {}
|
3110
|
+
|
3111
|
+
# header parameters
|
3112
|
+
header_params = opts[:header_params] || {}
|
3113
|
+
# HTTP header 'Accept' (if needed)
|
3114
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
3115
|
+
# HTTP header 'Content-Type'
|
3116
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
3117
|
+
if !content_type.nil?
|
3118
|
+
header_params['Content-Type'] = content_type
|
3119
|
+
end
|
3120
|
+
|
3121
|
+
# form parameters
|
3122
|
+
form_params = opts[:form_params] || {}
|
3123
|
+
|
3124
|
+
# http body (model)
|
3125
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(request_body)
|
3126
|
+
|
3127
|
+
# return_type
|
3128
|
+
return_type = opts[:debug_return_type] || 'CreditPayrollIncomeParsingConfigUpdateResponse'
|
3129
|
+
|
3130
|
+
# auth_names
|
3131
|
+
auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
|
3132
|
+
|
3133
|
+
new_options = opts.merge(
|
3134
|
+
:operation => :"PlaidApi.credit_payroll_income_parsing_config_update",
|
3135
|
+
:header_params => header_params,
|
3136
|
+
:query_params => query_params,
|
3137
|
+
:form_params => form_params,
|
3138
|
+
:body => post_body,
|
3139
|
+
:auth_names => auth_names,
|
3140
|
+
:return_type => return_type
|
3141
|
+
)
|
3142
|
+
|
3143
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
3144
|
+
if @api_client.config.debugging
|
3145
|
+
@api_client.config.logger.debug "API called: PlaidApi#credit_payroll_income_parsing_config_update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
3146
|
+
end
|
3147
|
+
return data, status_code, headers
|
3148
|
+
end
|
3149
|
+
|
2878
3150
|
# Check income verification eligibility and optimize conversion
|
2879
3151
|
# `/credit/payroll_income/precheck` is an optional endpoint that can be called before initializing a Link session for income verification. It evaluates whether a given user is supportable by digital income verification. If the user is eligible for digital verification, that information will be associated with the user token, and in this way will generate a Link UI optimized for the end user and their specific employer. If the user cannot be confirmed as eligible, the user can still use the income verification flow, but they may be required to manually upload a paystub to verify their income. While all request fields are optional, providing `employer` data will increase the chance of receiving a useful result. When testing in Sandbox, you can control the results by providing special test values in the `employer` and `access_tokens` fields. `employer_good` and `employer_bad` will result in `HIGH` and `LOW` confidence values, respectively. `employer_multi` will result in a `HIGH` confidence with multiple payroll options. Likewise, `access_good` and `access_bad` will result in `HIGH` and `LOW` confidence values, respectively. Any other value for `employer` and `access_tokens` in Sandbox will result in `UNKNOWN` confidence.
|
2880
3152
|
# @param credit_payroll_income_precheck_request [CreditPayrollIncomePrecheckRequest]
|
@@ -3012,7 +3284,7 @@ module Plaid
|
|
3012
3284
|
end
|
3013
3285
|
|
3014
3286
|
# Retrieve fraud insights for a user's manually uploaded document(s).
|
3015
|
-
# `/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_RISK_SIGNALS` 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.
|
3287
|
+
# `/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. To trigger risk signal generation for an Item, call `/link/token/create` with `parsing_config` set to include `fraud_risk`, or call `/credit/payroll_income/parsing_config/update`. Once risk signal generation has been triggered, `/credit/payroll_income/risk_signals/get` can be called at any time after the `INCOME_VERIFICATION_RISK_SIGNALS` 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.
|
3016
3288
|
# @param credit_payroll_income_risk_signals_get_request [CreditPayrollIncomeRiskSignalsGetRequest]
|
3017
3289
|
# @param [Hash] opts the optional parameters
|
3018
3290
|
# @return [CreditPayrollIncomeRiskSignalsGetResponse]
|
@@ -3022,7 +3294,7 @@ module Plaid
|
|
3022
3294
|
end
|
3023
3295
|
|
3024
3296
|
# Retrieve fraud insights for a user's manually uploaded document(s).
|
3025
|
-
# `/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_RISK_SIGNALS` 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.
|
3297
|
+
# `/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. To trigger risk signal generation for an Item, call `/link/token/create` with `parsing_config` set to include `fraud_risk`, or call `/credit/payroll_income/parsing_config/update`. Once risk signal generation has been triggered, `/credit/payroll_income/risk_signals/get` can be called at any time after the `INCOME_VERIFICATION_RISK_SIGNALS` 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.
|
3026
3298
|
# @param credit_payroll_income_risk_signals_get_request [CreditPayrollIncomeRiskSignalsGetRequest]
|
3027
3299
|
# @param [Hash] opts the optional parameters
|
3028
3300
|
# @return [Array<(CreditPayrollIncomeRiskSignalsGetResponse, Integer, Hash)>] CreditPayrollIncomeRiskSignalsGetResponse data, response status code and response headers
|
@@ -4236,7 +4508,7 @@ module Plaid
|
|
4236
4508
|
end
|
4237
4509
|
|
4238
4510
|
# Retrieve identity match score
|
4239
|
-
# The `/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.
|
4511
|
+
# The `/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. Fields within the `balances` object will always be null when retrieved by `/identity/match`. Instead, use the free `/accounts/get` endpoint to request balance cached data, or `/accounts/balance/get` for real-time data. 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.
|
4240
4512
|
# @param identity_match_request [IdentityMatchRequest]
|
4241
4513
|
# @param [Hash] opts the optional parameters
|
4242
4514
|
# @return [IdentityMatchResponse]
|
@@ -4246,7 +4518,7 @@ module Plaid
|
|
4246
4518
|
end
|
4247
4519
|
|
4248
4520
|
# Retrieve identity match score
|
4249
|
-
# The `/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.
|
4521
|
+
# The `/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. Fields within the `balances` object will always be null when retrieved by `/identity/match`. Instead, use the free `/accounts/get` endpoint to request balance cached data, or `/accounts/balance/get` for real-time data. 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.
|
4250
4522
|
# @param identity_match_request [IdentityMatchRequest]
|
4251
4523
|
# @param [Hash] opts the optional parameters
|
4252
4524
|
# @return [Array<(IdentityMatchResponse, Integer, Hash)>] IdentityMatchResponse data, response status code and response headers
|
@@ -5731,6 +6003,74 @@ module Plaid
|
|
5731
6003
|
return data, status_code, headers
|
5732
6004
|
end
|
5733
6005
|
|
6006
|
+
# Unlink a user’s connected application
|
6007
|
+
# Unlink a user’s connected application. On an unlink request, Plaid will immediately revoke the Application’s access to the User’s data. The User will have to redo the OAuth authentication process in order to restore functionality. This endpoint only removes ongoing data access permissions, therefore the User will need to reach out to the Application itself in order to disable and delete their account and delete any data that the Application already received (if the Application does not do so by default). This endpoint should be called in real time as the User is unlinking an Application, and should not be batched in order to ensure that the change is reflected as soon as possible.
|
6008
|
+
# @param item_application_unlink_request [ItemApplicationUnlinkRequest]
|
6009
|
+
# @param [Hash] opts the optional parameters
|
6010
|
+
# @return [ItemApplicationUnlinkResponse]
|
6011
|
+
def item_application_unlink(item_application_unlink_request, opts = {})
|
6012
|
+
data, _status_code, _headers = item_application_unlink_with_http_info(item_application_unlink_request, opts)
|
6013
|
+
data
|
6014
|
+
end
|
6015
|
+
|
6016
|
+
# Unlink a user’s connected application
|
6017
|
+
# Unlink a user’s connected application. On an unlink request, Plaid will immediately revoke the Application’s access to the User’s data. The User will have to redo the OAuth authentication process in order to restore functionality. This endpoint only removes ongoing data access permissions, therefore the User will need to reach out to the Application itself in order to disable and delete their account and delete any data that the Application already received (if the Application does not do so by default). This endpoint should be called in real time as the User is unlinking an Application, and should not be batched in order to ensure that the change is reflected as soon as possible.
|
6018
|
+
# @param item_application_unlink_request [ItemApplicationUnlinkRequest]
|
6019
|
+
# @param [Hash] opts the optional parameters
|
6020
|
+
# @return [Array<(ItemApplicationUnlinkResponse, Integer, Hash)>] ItemApplicationUnlinkResponse data, response status code and response headers
|
6021
|
+
def item_application_unlink_with_http_info(item_application_unlink_request, opts = {})
|
6022
|
+
if @api_client.config.debugging
|
6023
|
+
@api_client.config.logger.debug 'Calling API: PlaidApi.item_application_unlink ...'
|
6024
|
+
end
|
6025
|
+
# verify the required parameter 'item_application_unlink_request' is set
|
6026
|
+
if @api_client.config.client_side_validation && item_application_unlink_request.nil?
|
6027
|
+
fail ArgumentError, "Missing the required parameter 'item_application_unlink_request' when calling PlaidApi.item_application_unlink"
|
6028
|
+
end
|
6029
|
+
# resource path
|
6030
|
+
local_var_path = '/item/application/unlink'
|
6031
|
+
|
6032
|
+
# query parameters
|
6033
|
+
query_params = opts[:query_params] || {}
|
6034
|
+
|
6035
|
+
# header parameters
|
6036
|
+
header_params = opts[:header_params] || {}
|
6037
|
+
# HTTP header 'Accept' (if needed)
|
6038
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
6039
|
+
# HTTP header 'Content-Type'
|
6040
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
6041
|
+
if !content_type.nil?
|
6042
|
+
header_params['Content-Type'] = content_type
|
6043
|
+
end
|
6044
|
+
|
6045
|
+
# form parameters
|
6046
|
+
form_params = opts[:form_params] || {}
|
6047
|
+
|
6048
|
+
# http body (model)
|
6049
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(item_application_unlink_request)
|
6050
|
+
|
6051
|
+
# return_type
|
6052
|
+
return_type = opts[:debug_return_type] || 'ItemApplicationUnlinkResponse'
|
6053
|
+
|
6054
|
+
# auth_names
|
6055
|
+
auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
|
6056
|
+
|
6057
|
+
new_options = opts.merge(
|
6058
|
+
:operation => :"PlaidApi.item_application_unlink",
|
6059
|
+
:header_params => header_params,
|
6060
|
+
:query_params => query_params,
|
6061
|
+
:form_params => form_params,
|
6062
|
+
:body => post_body,
|
6063
|
+
:auth_names => auth_names,
|
6064
|
+
:return_type => return_type
|
6065
|
+
)
|
6066
|
+
|
6067
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
6068
|
+
if @api_client.config.debugging
|
6069
|
+
@api_client.config.logger.debug "API called: PlaidApi#item_application_unlink\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
6070
|
+
end
|
6071
|
+
return data, status_code, headers
|
6072
|
+
end
|
6073
|
+
|
5734
6074
|
# Create public token
|
5735
6075
|
# Note: As of July 2020, the `/item/public_token/create` endpoint is deprecated. Instead, use `/link/token/create` with an `access_token` to create a Link token for use with [update mode](https://plaid.com/docs/link/update-mode). If you need your user to take action to restore or resolve an error associated with an Item, generate a public token with the `/item/public_token/create` endpoint and then initialize Link with that `public_token`. A `public_token` is one-time use and expires after 30 minutes. You use a `public_token` to initialize Link in [update mode](https://plaid.com/docs/link/update-mode) for a particular Item. You can generate a `public_token` for an Item even if you did not use Link to create the Item originally. The `/item/public_token/create` endpoint is **not** used to create your initial `public_token`. If you have not already received an `access_token` for a specific Item, use Link to obtain your `public_token` instead. See the [Quickstart](https://plaid.com/docs/quickstart) for more information.
|
5736
6076
|
# @param item_public_token_create_request [ItemPublicTokenCreateRequest]
|
@@ -8248,7 +8588,7 @@ module Plaid
|
|
8248
8588
|
end
|
8249
8589
|
|
8250
8590
|
# Retrieve identity match score
|
8251
|
-
# 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.
|
8591
|
+
# 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. Fields within the `balances` object will always be null when retrieved by `/identity/match`. Instead, use the free `/accounts/get` endpoint to request balance cached data, or `/accounts/balance/get` for real-time data. 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.
|
8252
8592
|
# @param processor_identity_match_request [ProcessorIdentityMatchRequest]
|
8253
8593
|
# @param [Hash] opts the optional parameters
|
8254
8594
|
# @return [ProcessorIdentityMatchResponse]
|
@@ -8258,7 +8598,7 @@ module Plaid
|
|
8258
8598
|
end
|
8259
8599
|
|
8260
8600
|
# Retrieve identity match score
|
8261
|
-
# 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.
|
8601
|
+
# 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. Fields within the `balances` object will always be null when retrieved by `/identity/match`. Instead, use the free `/accounts/get` endpoint to request balance cached data, or `/accounts/balance/get` for real-time data. 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.
|
8262
8602
|
# @param processor_identity_match_request [ProcessorIdentityMatchRequest]
|
8263
8603
|
# @param [Hash] opts the optional parameters
|
8264
8604
|
# @return [Array<(ProcessorIdentityMatchResponse, Integer, Hash)>] ProcessorIdentityMatchResponse data, response status code and response headers
|
@@ -8451,6 +8791,74 @@ module Plaid
|
|
8451
8791
|
return data, status_code, headers
|
8452
8792
|
end
|
8453
8793
|
|
8794
|
+
# Opt-in a processor token to Signal
|
8795
|
+
# When a processor token is not initialized with Signal, call `/processor/signal/prepare` to opt-in that processor token to the Signal data collection process, which will improve the accuracy of the Signal score. If this endpoint is called with a processor token that is already initialized with Signal, it will return a 200 response and will not modify the processor token.
|
8796
|
+
# @param processor_signal_prepare_request [ProcessorSignalPrepareRequest]
|
8797
|
+
# @param [Hash] opts the optional parameters
|
8798
|
+
# @return [ProcessorSignalPrepareResponse]
|
8799
|
+
def processor_signal_prepare(processor_signal_prepare_request, opts = {})
|
8800
|
+
data, _status_code, _headers = processor_signal_prepare_with_http_info(processor_signal_prepare_request, opts)
|
8801
|
+
data
|
8802
|
+
end
|
8803
|
+
|
8804
|
+
# Opt-in a processor token to Signal
|
8805
|
+
# When a processor token is not initialized with Signal, call `/processor/signal/prepare` to opt-in that processor token to the Signal data collection process, which will improve the accuracy of the Signal score. If this endpoint is called with a processor token that is already initialized with Signal, it will return a 200 response and will not modify the processor token.
|
8806
|
+
# @param processor_signal_prepare_request [ProcessorSignalPrepareRequest]
|
8807
|
+
# @param [Hash] opts the optional parameters
|
8808
|
+
# @return [Array<(ProcessorSignalPrepareResponse, Integer, Hash)>] ProcessorSignalPrepareResponse data, response status code and response headers
|
8809
|
+
def processor_signal_prepare_with_http_info(processor_signal_prepare_request, opts = {})
|
8810
|
+
if @api_client.config.debugging
|
8811
|
+
@api_client.config.logger.debug 'Calling API: PlaidApi.processor_signal_prepare ...'
|
8812
|
+
end
|
8813
|
+
# verify the required parameter 'processor_signal_prepare_request' is set
|
8814
|
+
if @api_client.config.client_side_validation && processor_signal_prepare_request.nil?
|
8815
|
+
fail ArgumentError, "Missing the required parameter 'processor_signal_prepare_request' when calling PlaidApi.processor_signal_prepare"
|
8816
|
+
end
|
8817
|
+
# resource path
|
8818
|
+
local_var_path = '/processor/signal/prepare'
|
8819
|
+
|
8820
|
+
# query parameters
|
8821
|
+
query_params = opts[:query_params] || {}
|
8822
|
+
|
8823
|
+
# header parameters
|
8824
|
+
header_params = opts[:header_params] || {}
|
8825
|
+
# HTTP header 'Accept' (if needed)
|
8826
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
8827
|
+
# HTTP header 'Content-Type'
|
8828
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
8829
|
+
if !content_type.nil?
|
8830
|
+
header_params['Content-Type'] = content_type
|
8831
|
+
end
|
8832
|
+
|
8833
|
+
# form parameters
|
8834
|
+
form_params = opts[:form_params] || {}
|
8835
|
+
|
8836
|
+
# http body (model)
|
8837
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(processor_signal_prepare_request)
|
8838
|
+
|
8839
|
+
# return_type
|
8840
|
+
return_type = opts[:debug_return_type] || 'ProcessorSignalPrepareResponse'
|
8841
|
+
|
8842
|
+
# auth_names
|
8843
|
+
auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
|
8844
|
+
|
8845
|
+
new_options = opts.merge(
|
8846
|
+
:operation => :"PlaidApi.processor_signal_prepare",
|
8847
|
+
:header_params => header_params,
|
8848
|
+
:query_params => query_params,
|
8849
|
+
:form_params => form_params,
|
8850
|
+
:body => post_body,
|
8851
|
+
:auth_names => auth_names,
|
8852
|
+
:return_type => return_type
|
8853
|
+
)
|
8854
|
+
|
8855
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
8856
|
+
if @api_client.config.debugging
|
8857
|
+
@api_client.config.logger.debug "API called: PlaidApi#processor_signal_prepare\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
8858
|
+
end
|
8859
|
+
return data, status_code, headers
|
8860
|
+
end
|
8861
|
+
|
8454
8862
|
# Report a return for an ACH transaction
|
8455
8863
|
# Call the `/processor/signal/return/report` endpoint to report a returned transaction that was previously sent to the `/processor/signal/evaluate` endpoint. Your feedback will be used by the model to incorporate the latest risk trend in your portfolio.
|
8456
8864
|
# @param processor_signal_return_report_request [ProcessorSignalReturnReportRequest]
|
@@ -9336,7 +9744,7 @@ module Plaid
|
|
9336
9744
|
end
|
9337
9745
|
|
9338
9746
|
# Manually fire an Income webhook
|
9339
|
-
# Use the `/sandbox/income/fire_webhook` endpoint to manually trigger a Payroll Income webhook in the Sandbox environment.
|
9747
|
+
# Use the `/sandbox/income/fire_webhook` endpoint to manually trigger a Payroll or Document Income webhook in the Sandbox environment.
|
9340
9748
|
# @param sandbox_income_fire_webhook_request [SandboxIncomeFireWebhookRequest]
|
9341
9749
|
# @param [Hash] opts the optional parameters
|
9342
9750
|
# @return [SandboxIncomeFireWebhookResponse]
|
@@ -9346,7 +9754,7 @@ module Plaid
|
|
9346
9754
|
end
|
9347
9755
|
|
9348
9756
|
# Manually fire an Income webhook
|
9349
|
-
# Use the `/sandbox/income/fire_webhook` endpoint to manually trigger a Payroll Income webhook in the Sandbox environment.
|
9757
|
+
# Use the `/sandbox/income/fire_webhook` endpoint to manually trigger a Payroll or Document Income webhook in the Sandbox environment.
|
9350
9758
|
# @param sandbox_income_fire_webhook_request [SandboxIncomeFireWebhookRequest]
|
9351
9759
|
# @param [Hash] opts the optional parameters
|
9352
9760
|
# @return [Array<(SandboxIncomeFireWebhookResponse, Integer, Hash)>] SandboxIncomeFireWebhookResponse data, response status code and response headers
|
@@ -10151,6 +10559,74 @@ module Plaid
|
|
10151
10559
|
return data, status_code, headers
|
10152
10560
|
end
|
10153
10561
|
|
10562
|
+
# Simulate a refund event in Sandbox
|
10563
|
+
# Use the `/sandbox/transfer/refund/simulate` endpoint to simulate a refund event in the Sandbox environment. Note that while an event will be simulated and will appear when using endpoints such as `/transfer/event/sync` or `/transfer/event/list`, no transactions will actually take place and funds will not move between accounts, even within the Sandbox.
|
10564
|
+
# @param sandbox_transfer_refund_simulate_request [SandboxTransferRefundSimulateRequest]
|
10565
|
+
# @param [Hash] opts the optional parameters
|
10566
|
+
# @return [SandboxTransferRefundSimulateResponse]
|
10567
|
+
def sandbox_transfer_refund_simulate(sandbox_transfer_refund_simulate_request, opts = {})
|
10568
|
+
data, _status_code, _headers = sandbox_transfer_refund_simulate_with_http_info(sandbox_transfer_refund_simulate_request, opts)
|
10569
|
+
data
|
10570
|
+
end
|
10571
|
+
|
10572
|
+
# Simulate a refund event in Sandbox
|
10573
|
+
# Use the `/sandbox/transfer/refund/simulate` endpoint to simulate a refund event in the Sandbox environment. Note that while an event will be simulated and will appear when using endpoints such as `/transfer/event/sync` or `/transfer/event/list`, no transactions will actually take place and funds will not move between accounts, even within the Sandbox.
|
10574
|
+
# @param sandbox_transfer_refund_simulate_request [SandboxTransferRefundSimulateRequest]
|
10575
|
+
# @param [Hash] opts the optional parameters
|
10576
|
+
# @return [Array<(SandboxTransferRefundSimulateResponse, Integer, Hash)>] SandboxTransferRefundSimulateResponse data, response status code and response headers
|
10577
|
+
def sandbox_transfer_refund_simulate_with_http_info(sandbox_transfer_refund_simulate_request, opts = {})
|
10578
|
+
if @api_client.config.debugging
|
10579
|
+
@api_client.config.logger.debug 'Calling API: PlaidApi.sandbox_transfer_refund_simulate ...'
|
10580
|
+
end
|
10581
|
+
# verify the required parameter 'sandbox_transfer_refund_simulate_request' is set
|
10582
|
+
if @api_client.config.client_side_validation && sandbox_transfer_refund_simulate_request.nil?
|
10583
|
+
fail ArgumentError, "Missing the required parameter 'sandbox_transfer_refund_simulate_request' when calling PlaidApi.sandbox_transfer_refund_simulate"
|
10584
|
+
end
|
10585
|
+
# resource path
|
10586
|
+
local_var_path = '/sandbox/transfer/refund/simulate'
|
10587
|
+
|
10588
|
+
# query parameters
|
10589
|
+
query_params = opts[:query_params] || {}
|
10590
|
+
|
10591
|
+
# header parameters
|
10592
|
+
header_params = opts[:header_params] || {}
|
10593
|
+
# HTTP header 'Accept' (if needed)
|
10594
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
10595
|
+
# HTTP header 'Content-Type'
|
10596
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
10597
|
+
if !content_type.nil?
|
10598
|
+
header_params['Content-Type'] = content_type
|
10599
|
+
end
|
10600
|
+
|
10601
|
+
# form parameters
|
10602
|
+
form_params = opts[:form_params] || {}
|
10603
|
+
|
10604
|
+
# http body (model)
|
10605
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(sandbox_transfer_refund_simulate_request)
|
10606
|
+
|
10607
|
+
# return_type
|
10608
|
+
return_type = opts[:debug_return_type] || 'SandboxTransferRefundSimulateResponse'
|
10609
|
+
|
10610
|
+
# auth_names
|
10611
|
+
auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
|
10612
|
+
|
10613
|
+
new_options = opts.merge(
|
10614
|
+
:operation => :"PlaidApi.sandbox_transfer_refund_simulate",
|
10615
|
+
:header_params => header_params,
|
10616
|
+
:query_params => query_params,
|
10617
|
+
:form_params => form_params,
|
10618
|
+
:body => post_body,
|
10619
|
+
:auth_names => auth_names,
|
10620
|
+
:return_type => return_type
|
10621
|
+
)
|
10622
|
+
|
10623
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
10624
|
+
if @api_client.config.debugging
|
10625
|
+
@api_client.config.logger.debug "API called: PlaidApi#sandbox_transfer_refund_simulate\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
10626
|
+
end
|
10627
|
+
return data, status_code, headers
|
10628
|
+
end
|
10629
|
+
|
10154
10630
|
# Trigger the creation of a repayment
|
10155
10631
|
# Use the `/sandbox/transfer/repayment/simulate` endpoint to trigger the creation of a repayment. As a side effect of calling this route, a repayment is created that includes all unreimbursed returns of guaranteed transfers. If there are no such returns, an 400 error is returned.
|
10156
10632
|
# @param sandbox_transfer_repayment_simulate_request [SandboxTransferRepaymentSimulateRequest]
|
@@ -10288,7 +10764,7 @@ module Plaid
|
|
10288
10764
|
end
|
10289
10765
|
|
10290
10766
|
# Simulate creating a sweep
|
10291
|
-
# Use the `/sandbox/transfer/sweep/simulate` endpoint to create a sweep and associated events in the Sandbox environment. Upon calling this endpoint, all `posted` or `pending` transfers with a sweep status of `unswept` will become `swept`, and all `returned` transfers with a sweep status of `swept` will become `return_swept`.
|
10767
|
+
# Use the `/sandbox/transfer/sweep/simulate` endpoint to create a sweep and associated events in the Sandbox environment. Upon calling this endpoint, all transfers with a sweep status of `swept` will become `swept_settled`, all `posted` or `pending` transfers with a sweep status of `unswept` will become `swept`, and all `returned` transfers with a sweep status of `swept` will become `return_swept`.
|
10292
10768
|
# @param sandbox_transfer_sweep_simulate_request [SandboxTransferSweepSimulateRequest]
|
10293
10769
|
# @param [Hash] opts the optional parameters
|
10294
10770
|
# @return [SandboxTransferSweepSimulateResponse]
|
@@ -10298,7 +10774,7 @@ module Plaid
|
|
10298
10774
|
end
|
10299
10775
|
|
10300
10776
|
# Simulate creating a sweep
|
10301
|
-
# Use the `/sandbox/transfer/sweep/simulate` endpoint to create a sweep and associated events in the Sandbox environment. Upon calling this endpoint, all `posted` or `pending` transfers with a sweep status of `unswept` will become `swept`, and all `returned` transfers with a sweep status of `swept` will become `return_swept`.
|
10777
|
+
# Use the `/sandbox/transfer/sweep/simulate` endpoint to create a sweep and associated events in the Sandbox environment. Upon calling this endpoint, all transfers with a sweep status of `swept` will become `swept_settled`, all `posted` or `pending` transfers with a sweep status of `unswept` will become `swept`, and all `returned` transfers with a sweep status of `swept` will become `return_swept`.
|
10302
10778
|
# @param sandbox_transfer_sweep_simulate_request [SandboxTransferSweepSimulateRequest]
|
10303
10779
|
# @param [Hash] opts the optional parameters
|
10304
10780
|
# @return [Array<(SandboxTransferSweepSimulateResponse, Integer, Hash)>] SandboxTransferSweepSimulateResponse data, response status code and response headers
|
@@ -10764,7 +11240,7 @@ module Plaid
|
|
10764
11240
|
end
|
10765
11241
|
|
10766
11242
|
# Opt-in an Item to Signal
|
10767
|
-
# When Link is not initialized with Signal, call `/signal/prepare` to opt-in that Item to the Signal data collection process, developing a Signal score. If you are using other Plaid products after Link, e.g. Identity or Assets, call `/signal/prepare` after those product calls are complete. Example flow: Link is initialized with Auth, call `/auth/get` for the account and routing number, call `/identity/get` to retrieve bank ownership details, then call `/signal/prepare` to begin Signal data collection. Later, once you have obtained details about the proposed transaction from the user, call `/signal/evaluate` for a Signal score. For more information please see [Recommendations for initializing Link with specific product combinations](https://www.plaid.com/docs/link/initializing-products/#recommendations-for-initializing-link-with-specific-product-combinations). If run on an Item that is already initialized with Signal, this endpoint will return a 200 response and will not modify the Item.
|
11243
|
+
# When Link is not initialized with Signal, call `/signal/prepare` to opt-in that Item to the Signal data collection process, developing a Signal score. If you are using other Plaid products after Link, e.g. Identity or Assets, call `/signal/prepare` after those product calls are complete. Example flow: Link is initialized with Auth, call `/auth/get` for the account and routing number, call `/identity/get` to retrieve bank ownership details, then call `/signal/prepare` to begin Signal data collection. Later, once you have obtained details about the proposed transaction from the user, call `/signal/evaluate` for a Signal score. For more information please see [Recommendations for initializing Link with specific product combinations](https://www.plaid.com/docs/link/initializing-products/#recommendations-for-initializing-link-with-specific-product-combinations). If run on an Item that is already initialized with Signal, this endpoint will return a 200 response and will not modify the Item.
|
10768
11244
|
# @param signal_prepare_request [SignalPrepareRequest]
|
10769
11245
|
# @param [Hash] opts the optional parameters
|
10770
11246
|
# @return [SignalPrepareResponse]
|
@@ -10774,7 +11250,7 @@ module Plaid
|
|
10774
11250
|
end
|
10775
11251
|
|
10776
11252
|
# Opt-in an Item to Signal
|
10777
|
-
# When Link is not initialized with Signal, call `/signal/prepare` to opt-in that Item to the Signal data collection process, developing a Signal score. If you are using other Plaid products after Link, e.g. Identity or Assets, call `/signal/prepare` after those product calls are complete. Example flow: Link is initialized with Auth, call `/auth/get` for the account and routing number, call `/identity/get` to retrieve bank ownership details, then call `/signal/prepare` to begin Signal data collection. Later, once you have obtained details about the proposed transaction from the user, call `/signal/evaluate` for a Signal score. For more information please see [Recommendations for initializing Link with specific product combinations](https://www.plaid.com/docs/link/initializing-products/#recommendations-for-initializing-link-with-specific-product-combinations). If run on an Item that is already initialized with Signal, this endpoint will return a 200 response and will not modify the Item.
|
11253
|
+
# When Link is not initialized with Signal, call `/signal/prepare` to opt-in that Item to the Signal data collection process, developing a Signal score. If you are using other Plaid products after Link, e.g. Identity or Assets, call `/signal/prepare` after those product calls are complete. Example flow: Link is initialized with Auth, call `/auth/get` for the account and routing number, call `/identity/get` to retrieve bank ownership details, then call `/signal/prepare` to begin Signal data collection. Later, once you have obtained details about the proposed transaction from the user, call `/signal/evaluate` for a Signal score. For more information please see [Recommendations for initializing Link with specific product combinations](https://www.plaid.com/docs/link/initializing-products/#recommendations-for-initializing-link-with-specific-product-combinations). If run on an Item that is already initialized with Signal, this endpoint will return a 200 response and will not modify the Item.
|
10778
11254
|
# @param signal_prepare_request [SignalPrepareRequest]
|
10779
11255
|
# @param [Hash] opts the optional parameters
|
10780
11256
|
# @return [Array<(SignalPrepareResponse, Integer, Hash)>] SignalPrepareResponse data, response status code and response headers
|
@@ -11105,26 +11581,26 @@ module Plaid
|
|
11105
11581
|
|
11106
11582
|
# Enrich locally-held transaction data
|
11107
11583
|
# The `/transactions/enrich` endpoint enriches raw transaction data generated by your own banking products or retrieved from other non-Plaid sources.
|
11108
|
-
# @param
|
11584
|
+
# @param transactions_enrich_request [TransactionsEnrichRequest]
|
11109
11585
|
# @param [Hash] opts the optional parameters
|
11110
|
-
# @return [
|
11111
|
-
def transactions_enrich(
|
11112
|
-
data, _status_code, _headers = transactions_enrich_with_http_info(
|
11586
|
+
# @return [TransactionsEnrichResponse]
|
11587
|
+
def transactions_enrich(transactions_enrich_request, opts = {})
|
11588
|
+
data, _status_code, _headers = transactions_enrich_with_http_info(transactions_enrich_request, opts)
|
11113
11589
|
data
|
11114
11590
|
end
|
11115
11591
|
|
11116
11592
|
# Enrich locally-held transaction data
|
11117
11593
|
# The `/transactions/enrich` endpoint enriches raw transaction data generated by your own banking products or retrieved from other non-Plaid sources.
|
11118
|
-
# @param
|
11594
|
+
# @param transactions_enrich_request [TransactionsEnrichRequest]
|
11119
11595
|
# @param [Hash] opts the optional parameters
|
11120
|
-
# @return [Array<(
|
11121
|
-
def transactions_enrich_with_http_info(
|
11596
|
+
# @return [Array<(TransactionsEnrichResponse, Integer, Hash)>] TransactionsEnrichResponse data, response status code and response headers
|
11597
|
+
def transactions_enrich_with_http_info(transactions_enrich_request, opts = {})
|
11122
11598
|
if @api_client.config.debugging
|
11123
11599
|
@api_client.config.logger.debug 'Calling API: PlaidApi.transactions_enrich ...'
|
11124
11600
|
end
|
11125
|
-
# verify the required parameter '
|
11126
|
-
if @api_client.config.client_side_validation &&
|
11127
|
-
fail ArgumentError, "Missing the required parameter '
|
11601
|
+
# verify the required parameter 'transactions_enrich_request' is set
|
11602
|
+
if @api_client.config.client_side_validation && transactions_enrich_request.nil?
|
11603
|
+
fail ArgumentError, "Missing the required parameter 'transactions_enrich_request' when calling PlaidApi.transactions_enrich"
|
11128
11604
|
end
|
11129
11605
|
# resource path
|
11130
11606
|
local_var_path = '/transactions/enrich'
|
@@ -11146,10 +11622,10 @@ module Plaid
|
|
11146
11622
|
form_params = opts[:form_params] || {}
|
11147
11623
|
|
11148
11624
|
# http body (model)
|
11149
|
-
post_body = opts[:debug_body] || @api_client.object_to_http_body(
|
11625
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(transactions_enrich_request)
|
11150
11626
|
|
11151
11627
|
# return_type
|
11152
|
-
return_type = opts[:debug_return_type] || '
|
11628
|
+
return_type = opts[:debug_return_type] || 'TransactionsEnrichResponse'
|
11153
11629
|
|
11154
11630
|
# auth_names
|
11155
11631
|
auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
|
@@ -11580,7 +12056,7 @@ module Plaid
|
|
11580
12056
|
end
|
11581
12057
|
|
11582
12058
|
# Get incremental transaction updates on an Item
|
11583
|
-
#
|
12059
|
+
# 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. To learn more about migrating from `/transactions/get`, see the [Transactions Sync migration guide](https://plaid.com/docs/transactions/sync-migration/). 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. 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. `/transactions/sync` does not directly return balance data. To get the balance for an account, call `/accounts/get`, which is a free-to-use endpoint that will return the cached balance as of the last successful transactions update.
|
11584
12060
|
# @param transactions_sync_request [TransactionsSyncRequest]
|
11585
12061
|
# @param [Hash] opts the optional parameters
|
11586
12062
|
# @return [TransactionsSyncResponse]
|
@@ -11590,7 +12066,7 @@ module Plaid
|
|
11590
12066
|
end
|
11591
12067
|
|
11592
12068
|
# Get incremental transaction updates on an Item
|
11593
|
-
#
|
12069
|
+
# 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. To learn more about migrating from `/transactions/get`, see the [Transactions Sync migration guide](https://plaid.com/docs/transactions/sync-migration/). 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. 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. `/transactions/sync` does not directly return balance data. To get the balance for an account, call `/accounts/get`, which is a free-to-use endpoint that will return the cached balance as of the last successful transactions update.
|
11594
12070
|
# @param transactions_sync_request [TransactionsSyncRequest]
|
11595
12071
|
# @param [Hash] opts the optional parameters
|
11596
12072
|
# @return [Array<(TransactionsSyncResponse, Integer, Hash)>] TransactionsSyncResponse data, response status code and response headers
|
@@ -11647,8 +12123,76 @@ module Plaid
|
|
11647
12123
|
return data, status_code, headers
|
11648
12124
|
end
|
11649
12125
|
|
12126
|
+
# Obtain user insights based on transactions sent through /transactions/enrich
|
12127
|
+
# The `/beta/transactions/user_insights/v1/get` gets user insights for clients who have enriched data with `/transactions/enrich`. The product is currently in beta.
|
12128
|
+
# @param transactions_user_insights_get_request [TransactionsUserInsightsGetRequest]
|
12129
|
+
# @param [Hash] opts the optional parameters
|
12130
|
+
# @return [TransactionsUserInsightsGetResponse]
|
12131
|
+
def transactions_user_insights_get(transactions_user_insights_get_request, opts = {})
|
12132
|
+
data, _status_code, _headers = transactions_user_insights_get_with_http_info(transactions_user_insights_get_request, opts)
|
12133
|
+
data
|
12134
|
+
end
|
12135
|
+
|
12136
|
+
# Obtain user insights based on transactions sent through /transactions/enrich
|
12137
|
+
# The `/beta/transactions/user_insights/v1/get` gets user insights for clients who have enriched data with `/transactions/enrich`. The product is currently in beta.
|
12138
|
+
# @param transactions_user_insights_get_request [TransactionsUserInsightsGetRequest]
|
12139
|
+
# @param [Hash] opts the optional parameters
|
12140
|
+
# @return [Array<(TransactionsUserInsightsGetResponse, Integer, Hash)>] TransactionsUserInsightsGetResponse data, response status code and response headers
|
12141
|
+
def transactions_user_insights_get_with_http_info(transactions_user_insights_get_request, opts = {})
|
12142
|
+
if @api_client.config.debugging
|
12143
|
+
@api_client.config.logger.debug 'Calling API: PlaidApi.transactions_user_insights_get ...'
|
12144
|
+
end
|
12145
|
+
# verify the required parameter 'transactions_user_insights_get_request' is set
|
12146
|
+
if @api_client.config.client_side_validation && transactions_user_insights_get_request.nil?
|
12147
|
+
fail ArgumentError, "Missing the required parameter 'transactions_user_insights_get_request' when calling PlaidApi.transactions_user_insights_get"
|
12148
|
+
end
|
12149
|
+
# resource path
|
12150
|
+
local_var_path = '/beta/transactions/user_insights/v1/get'
|
12151
|
+
|
12152
|
+
# query parameters
|
12153
|
+
query_params = opts[:query_params] || {}
|
12154
|
+
|
12155
|
+
# header parameters
|
12156
|
+
header_params = opts[:header_params] || {}
|
12157
|
+
# HTTP header 'Accept' (if needed)
|
12158
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
12159
|
+
# HTTP header 'Content-Type'
|
12160
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
12161
|
+
if !content_type.nil?
|
12162
|
+
header_params['Content-Type'] = content_type
|
12163
|
+
end
|
12164
|
+
|
12165
|
+
# form parameters
|
12166
|
+
form_params = opts[:form_params] || {}
|
12167
|
+
|
12168
|
+
# http body (model)
|
12169
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(transactions_user_insights_get_request)
|
12170
|
+
|
12171
|
+
# return_type
|
12172
|
+
return_type = opts[:debug_return_type] || 'TransactionsUserInsightsGetResponse'
|
12173
|
+
|
12174
|
+
# auth_names
|
12175
|
+
auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
|
12176
|
+
|
12177
|
+
new_options = opts.merge(
|
12178
|
+
:operation => :"PlaidApi.transactions_user_insights_get",
|
12179
|
+
:header_params => header_params,
|
12180
|
+
:query_params => query_params,
|
12181
|
+
:form_params => form_params,
|
12182
|
+
:body => post_body,
|
12183
|
+
:auth_names => auth_names,
|
12184
|
+
:return_type => return_type
|
12185
|
+
)
|
12186
|
+
|
12187
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
12188
|
+
if @api_client.config.debugging
|
12189
|
+
@api_client.config.logger.debug "API called: PlaidApi#transactions_user_insights_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
12190
|
+
end
|
12191
|
+
return data, status_code, headers
|
12192
|
+
end
|
12193
|
+
|
11650
12194
|
# Create a transfer authorization
|
11651
|
-
# Use the `/transfer/authorization/create` endpoint to authorize a transfer. This endpoint must be called prior to calling `/transfer/create`.
|
12195
|
+
# Use the `/transfer/authorization/create` endpoint to authorize a transfer. This endpoint must be called prior to calling `/transfer/create`. There are three possible outcomes to calling this endpoint: If the `authorization.decision` in the response is `declined`, the proposed transfer has failed the risk check and you cannot proceed with the transfer. If the `authorization.decision` is `approved`, and the `authorization.rationale_code` is `null`, the transfer has passed the risk check and you can proceed to call `/transfer/create`. If the `authorization.decision` is `approved` and the `authorization.rationale_code` is non-`null`, the risk check could not be run: you may proceed with the transfer, but should perform your own risk evaluation. For more details, see the response schema. 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.
|
11652
12196
|
# @param transfer_authorization_create_request [TransferAuthorizationCreateRequest]
|
11653
12197
|
# @param [Hash] opts the optional parameters
|
11654
12198
|
# @return [TransferAuthorizationCreateResponse]
|
@@ -11658,7 +12202,7 @@ module Plaid
|
|
11658
12202
|
end
|
11659
12203
|
|
11660
12204
|
# Create a transfer authorization
|
11661
|
-
# Use the `/transfer/authorization/create` endpoint to authorize a transfer. This endpoint must be called prior to calling `/transfer/create`.
|
12205
|
+
# Use the `/transfer/authorization/create` endpoint to authorize a transfer. This endpoint must be called prior to calling `/transfer/create`. There are three possible outcomes to calling this endpoint: If the `authorization.decision` in the response is `declined`, the proposed transfer has failed the risk check and you cannot proceed with the transfer. If the `authorization.decision` is `approved`, and the `authorization.rationale_code` is `null`, the transfer has passed the risk check and you can proceed to call `/transfer/create`. If the `authorization.decision` is `approved` and the `authorization.rationale_code` is non-`null`, the risk check could not be run: you may proceed with the transfer, but should perform your own risk evaluation. For more details, see the response schema. 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.
|
11662
12206
|
# @param transfer_authorization_create_request [TransferAuthorizationCreateRequest]
|
11663
12207
|
# @param [Hash] opts the optional parameters
|
11664
12208
|
# @return [Array<(TransferAuthorizationCreateResponse, Integer, Hash)>] TransferAuthorizationCreateResponse data, response status code and response headers
|
@@ -11852,7 +12396,7 @@ module Plaid
|
|
11852
12396
|
end
|
11853
12397
|
|
11854
12398
|
# Get RTP eligibility information of a transfer
|
11855
|
-
# Use the `/transfer/capabilities/get` endpoint to determine the RTP eligibility information of a transfer.
|
12399
|
+
# Use the `/transfer/capabilities/get` endpoint to determine the RTP eligibility information of a transfer. To simulate RTP eligibility in Sandbox, log in using the username `user_good` and password `pass_good` and use the first two checking and savings accounts in the \"First Platypus Bank\" institution (ending in 0000 or 1111), which will return `true`. Any other account will return `false`.
|
11856
12400
|
# @param transfer_capabilities_get_request [TransferCapabilitiesGetRequest]
|
11857
12401
|
# @param [Hash] opts the optional parameters
|
11858
12402
|
# @return [TransferCapabilitiesGetResponse]
|
@@ -11862,7 +12406,7 @@ module Plaid
|
|
11862
12406
|
end
|
11863
12407
|
|
11864
12408
|
# Get RTP eligibility information of a transfer
|
11865
|
-
# Use the `/transfer/capabilities/get` endpoint to determine the RTP eligibility information of a transfer.
|
12409
|
+
# Use the `/transfer/capabilities/get` endpoint to determine the RTP eligibility information of a transfer. To simulate RTP eligibility in Sandbox, log in using the username `user_good` and password `pass_good` and use the first two checking and savings accounts in the \"First Platypus Bank\" institution (ending in 0000 or 1111), which will return `true`. Any other account will return `false`.
|
11866
12410
|
# @param transfer_capabilities_get_request [TransferCapabilitiesGetRequest]
|
11867
12411
|
# @param [Hash] opts the optional parameters
|
11868
12412
|
# @return [Array<(TransferCapabilitiesGetResponse, Integer, Hash)>] TransferCapabilitiesGetResponse data, response status code and response headers
|
@@ -12055,7 +12599,7 @@ module Plaid
|
|
12055
12599
|
return data, status_code, headers
|
12056
12600
|
end
|
12057
12601
|
|
12058
|
-
#
|
12602
|
+
# Upload transfer diligence document on behalf of the originator
|
12059
12603
|
# Third-party sender customers can use `/transfer/diligence/document/upload` endpoint to upload a document on behalf of its end customer (i.e. originator) to Plaid. You’ll need to send a request of type multipart/form-data. You must provide the `client_id` in the `PLAID-CLIENT-ID` header and `secret` in the `PLAID-SECRET` header.
|
12060
12604
|
# @param transfer_diligence_document_upload_request [TransferDiligenceDocumentUploadRequest]
|
12061
12605
|
# @param [Hash] opts the optional parameters
|
@@ -12065,7 +12609,7 @@ module Plaid
|
|
12065
12609
|
data
|
12066
12610
|
end
|
12067
12611
|
|
12068
|
-
#
|
12612
|
+
# Upload transfer diligence document on behalf of the originator
|
12069
12613
|
# Third-party sender customers can use `/transfer/diligence/document/upload` endpoint to upload a document on behalf of its end customer (i.e. originator) to Plaid. You’ll need to send a request of type multipart/form-data. You must provide the `client_id` in the `PLAID-CLIENT-ID` header and `secret` in the `PLAID-SECRET` header.
|
12070
12614
|
# @param transfer_diligence_document_upload_request [TransferDiligenceDocumentUploadRequest]
|
12071
12615
|
# @param [Hash] opts the optional parameters
|
@@ -12123,8 +12667,8 @@ module Plaid
|
|
12123
12667
|
return data, status_code, headers
|
12124
12668
|
end
|
12125
12669
|
|
12126
|
-
# Submit transfer diligence on behalf of the
|
12127
|
-
# Use the `/transfer/diligence/submit` endpoint to submit transfer diligence on behalf of the originator.
|
12670
|
+
# Submit transfer diligence on behalf of the originator
|
12671
|
+
# Use the `/transfer/diligence/submit` endpoint to submit transfer diligence on behalf of the originator (i.e., the end customer).
|
12128
12672
|
# @param transfer_diligence_submit_request [TransferDiligenceSubmitRequest]
|
12129
12673
|
# @param [Hash] opts the optional parameters
|
12130
12674
|
# @return [TransferDiligenceSubmitResponse]
|
@@ -12133,8 +12677,8 @@ module Plaid
|
|
12133
12677
|
data
|
12134
12678
|
end
|
12135
12679
|
|
12136
|
-
# Submit transfer diligence on behalf of the
|
12137
|
-
# Use the `/transfer/diligence/submit` endpoint to submit transfer diligence on behalf of the originator.
|
12680
|
+
# Submit transfer diligence on behalf of the originator
|
12681
|
+
# Use the `/transfer/diligence/submit` endpoint to submit transfer diligence on behalf of the originator (i.e., the end customer).
|
12138
12682
|
# @param transfer_diligence_submit_request [TransferDiligenceSubmitRequest]
|
12139
12683
|
# @param [Hash] opts the optional parameters
|
12140
12684
|
# @return [Array<(TransferDiligenceSubmitResponse, Integer, Hash)>] TransferDiligenceSubmitResponse data, response status code and response headers
|
@@ -12599,6 +13143,74 @@ module Plaid
|
|
12599
13143
|
return data, status_code, headers
|
12600
13144
|
end
|
12601
13145
|
|
13146
|
+
# Move available balance between the ledgers of the platform and one of its originators
|
13147
|
+
# Use the `/transfer/ledger/distribute` endpoint to move available balance between the ledgers of the platform and one of its originators.
|
13148
|
+
# @param transfer_ledger_distribute_request [TransferLedgerDistributeRequest]
|
13149
|
+
# @param [Hash] opts the optional parameters
|
13150
|
+
# @return [TransferLedgerDistributeResponse]
|
13151
|
+
def transfer_ledger_distribute(transfer_ledger_distribute_request, opts = {})
|
13152
|
+
data, _status_code, _headers = transfer_ledger_distribute_with_http_info(transfer_ledger_distribute_request, opts)
|
13153
|
+
data
|
13154
|
+
end
|
13155
|
+
|
13156
|
+
# Move available balance between the ledgers of the platform and one of its originators
|
13157
|
+
# Use the `/transfer/ledger/distribute` endpoint to move available balance between the ledgers of the platform and one of its originators.
|
13158
|
+
# @param transfer_ledger_distribute_request [TransferLedgerDistributeRequest]
|
13159
|
+
# @param [Hash] opts the optional parameters
|
13160
|
+
# @return [Array<(TransferLedgerDistributeResponse, Integer, Hash)>] TransferLedgerDistributeResponse data, response status code and response headers
|
13161
|
+
def transfer_ledger_distribute_with_http_info(transfer_ledger_distribute_request, opts = {})
|
13162
|
+
if @api_client.config.debugging
|
13163
|
+
@api_client.config.logger.debug 'Calling API: PlaidApi.transfer_ledger_distribute ...'
|
13164
|
+
end
|
13165
|
+
# verify the required parameter 'transfer_ledger_distribute_request' is set
|
13166
|
+
if @api_client.config.client_side_validation && transfer_ledger_distribute_request.nil?
|
13167
|
+
fail ArgumentError, "Missing the required parameter 'transfer_ledger_distribute_request' when calling PlaidApi.transfer_ledger_distribute"
|
13168
|
+
end
|
13169
|
+
# resource path
|
13170
|
+
local_var_path = '/transfer/ledger/distribute'
|
13171
|
+
|
13172
|
+
# query parameters
|
13173
|
+
query_params = opts[:query_params] || {}
|
13174
|
+
|
13175
|
+
# header parameters
|
13176
|
+
header_params = opts[:header_params] || {}
|
13177
|
+
# HTTP header 'Accept' (if needed)
|
13178
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
13179
|
+
# HTTP header 'Content-Type'
|
13180
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
13181
|
+
if !content_type.nil?
|
13182
|
+
header_params['Content-Type'] = content_type
|
13183
|
+
end
|
13184
|
+
|
13185
|
+
# form parameters
|
13186
|
+
form_params = opts[:form_params] || {}
|
13187
|
+
|
13188
|
+
# http body (model)
|
13189
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(transfer_ledger_distribute_request)
|
13190
|
+
|
13191
|
+
# return_type
|
13192
|
+
return_type = opts[:debug_return_type] || 'TransferLedgerDistributeResponse'
|
13193
|
+
|
13194
|
+
# auth_names
|
13195
|
+
auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
|
13196
|
+
|
13197
|
+
new_options = opts.merge(
|
13198
|
+
:operation => :"PlaidApi.transfer_ledger_distribute",
|
13199
|
+
:header_params => header_params,
|
13200
|
+
:query_params => query_params,
|
13201
|
+
:form_params => form_params,
|
13202
|
+
:body => post_body,
|
13203
|
+
:auth_names => auth_names,
|
13204
|
+
:return_type => return_type
|
13205
|
+
)
|
13206
|
+
|
13207
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
13208
|
+
if @api_client.config.debugging
|
13209
|
+
@api_client.config.logger.debug "API called: PlaidApi#transfer_ledger_distribute\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
13210
|
+
end
|
13211
|
+
return data, status_code, headers
|
13212
|
+
end
|
13213
|
+
|
12602
13214
|
# Retrieve Plaid Ledger balance
|
12603
13215
|
# Use the `/transfer/ledger/get` endpoint to view a balance on the ledger held with Plaid.
|
12604
13216
|
# @param transfer_ledger_get_request [TransferLedgerGetRequest]
|
@@ -13348,7 +13960,7 @@ module Plaid
|
|
13348
13960
|
end
|
13349
13961
|
|
13350
13962
|
# Create a recurring transfer
|
13351
|
-
# Use the `/transfer/recurring/create` endpoint to initiate a new recurring transfer.
|
13963
|
+
# Use the `/transfer/recurring/create` endpoint to initiate a new recurring transfer. This capability is not currently supported for Transfer UI or Platform Payments (beta) customers.
|
13352
13964
|
# @param transfer_recurring_create_request [TransferRecurringCreateRequest]
|
13353
13965
|
# @param [Hash] opts the optional parameters
|
13354
13966
|
# @return [TransferRecurringCreateResponse]
|
@@ -13358,7 +13970,7 @@ module Plaid
|
|
13358
13970
|
end
|
13359
13971
|
|
13360
13972
|
# Create a recurring transfer
|
13361
|
-
# Use the `/transfer/recurring/create` endpoint to initiate a new recurring transfer.
|
13973
|
+
# Use the `/transfer/recurring/create` endpoint to initiate a new recurring transfer. This capability is not currently supported for Transfer UI or Platform Payments (beta) customers.
|
13362
13974
|
# @param transfer_recurring_create_request [TransferRecurringCreateRequest]
|
13363
13975
|
# @param [Hash] opts the optional parameters
|
13364
13976
|
# @return [Array<(TransferRecurringCreateResponse, Integer, Hash)>] TransferRecurringCreateResponse data, response status code and response headers
|
@@ -13620,7 +14232,7 @@ module Plaid
|
|
13620
14232
|
end
|
13621
14233
|
|
13622
14234
|
# Create a refund
|
13623
|
-
# Use the `/transfer/refund/create` endpoint to create a refund for a transfer. A transfer can be refunded if the transfer was initiated in the past 180 days. Processing of the refund will not occur until at least
|
14235
|
+
# Use the `/transfer/refund/create` endpoint to create a refund for a transfer. A transfer can be refunded if the transfer was initiated in the past 180 days. Processing of the refund will not occur until at least 4 business days following the transfer's settlement date, plus any hold/settlement delays. This 3-day window helps better protect your business from regular ACH returns. Consumer initiated returns (unauthorized returns) could still happen for about 60 days from the settlement date. If the original transfer is canceled, returned or failed, all pending refunds will automatically be canceled. Processed refunds cannot be revoked.
|
13624
14236
|
# @param transfer_refund_create_request [TransferRefundCreateRequest]
|
13625
14237
|
# @param [Hash] opts the optional parameters
|
13626
14238
|
# @return [TransferRefundCreateResponse]
|
@@ -13630,7 +14242,7 @@ module Plaid
|
|
13630
14242
|
end
|
13631
14243
|
|
13632
14244
|
# Create a refund
|
13633
|
-
# Use the `/transfer/refund/create` endpoint to create a refund for a transfer. A transfer can be refunded if the transfer was initiated in the past 180 days. Processing of the refund will not occur until at least
|
14245
|
+
# Use the `/transfer/refund/create` endpoint to create a refund for a transfer. A transfer can be refunded if the transfer was initiated in the past 180 days. Processing of the refund will not occur until at least 4 business days following the transfer's settlement date, plus any hold/settlement delays. This 3-day window helps better protect your business from regular ACH returns. Consumer initiated returns (unauthorized returns) could still happen for about 60 days from the settlement date. If the original transfer is canceled, returned or failed, all pending refunds will automatically be canceled. Processed refunds cannot be revoked.
|
13634
14246
|
# @param transfer_refund_create_request [TransferRefundCreateRequest]
|
13635
14247
|
# @param [Hash] opts the optional parameters
|
13636
14248
|
# @return [Array<(TransferRefundCreateResponse, Integer, Hash)>] TransferRefundCreateResponse data, response status code and response headers
|
@@ -14096,7 +14708,7 @@ module Plaid
|
|
14096
14708
|
end
|
14097
14709
|
|
14098
14710
|
# Update user information
|
14099
|
-
# This endpoint is used to update user information associated with an existing `user_token`. The `user_token` should be in the response of `/user/create` call
|
14711
|
+
# This endpoint is used to update user information associated with an existing `user_token`. The `user_token` should be in the response of `/user/create` call If you call the endpoint with a non-exist `user_token`, the call will fail with an error message indicating that the user token is not found.
|
14100
14712
|
# @param user_update_request [UserUpdateRequest]
|
14101
14713
|
# @param [Hash] opts the optional parameters
|
14102
14714
|
# @return [UserUpdateResponse]
|
@@ -14106,7 +14718,7 @@ module Plaid
|
|
14106
14718
|
end
|
14107
14719
|
|
14108
14720
|
# Update user information
|
14109
|
-
# This endpoint is used to update user information associated with an existing `user_token`. The `user_token` should be in the response of `/user/create` call
|
14721
|
+
# This endpoint is used to update user information associated with an existing `user_token`. The `user_token` should be in the response of `/user/create` call If you call the endpoint with a non-exist `user_token`, the call will fail with an error message indicating that the user token is not found.
|
14110
14722
|
# @param user_update_request [UserUpdateRequest]
|
14111
14723
|
# @param [Hash] opts the optional parameters
|
14112
14724
|
# @return [Array<(UserUpdateResponse, Integer, Hash)>] UserUpdateResponse data, response status code and response headers
|