plaid 46.1.0 → 47.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +161 -0
- data/Gemfile.lock +1 -1
- data/Makefile +1 -1
- data/lib/plaid/api/plaid_api.rb +500 -300
- 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/aamva_analysis.rb +1 -1
- data/lib/plaid/models/aamva_detailed_match_result.rb +1 -1
- data/lib/plaid/models/aamva_match_result.rb +1 -1
- data/lib/plaid/models/account_access.rb +2 -2
- data/lib/plaid/models/account_assets.rb +3 -3
- data/lib/plaid/models/account_balance.rb +3 -3
- data/lib/plaid/models/account_base.rb +5 -5
- data/lib/plaid/models/account_base_nullable.rb +5 -5
- data/lib/plaid/models/account_filter.rb +1 -1
- data/lib/plaid/models/account_filters_response.rb +1 -1
- data/lib/plaid/models/account_holder_category.rb +1 -1
- data/lib/plaid/models/account_identity.rb +4 -8
- data/lib/plaid/models/account_identity_all_of.rb +40 -2
- data/lib/plaid/models/account_identity_document_upload.rb +5 -5
- data/lib/plaid/models/account_identity_document_upload_all_of.rb +1 -1
- data/lib/plaid/models/account_identity_match_score.rb +4 -8
- data/lib/plaid/models/account_identity_match_score_all_of.rb +40 -2
- data/lib/plaid/models/account_insights.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/account_verification_insights.rb +1 -1
- data/lib/plaid/models/account_verification_insights_account_number_format.rb +1 -1
- data/lib/plaid/models/account_verification_insights_network_status.rb +1 -1
- data/lib/plaid/models/account_verification_insights_previous_returns.rb +1 -1
- data/lib/plaid/models/accounts_balance_get_request.rb +2 -2
- data/lib/plaid/models/accounts_balance_get_request_options.rb +1 -1
- data/lib/plaid/models/accounts_get_request.rb +2 -2
- 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/affordability_insights.rb +2 -2
- data/lib/plaid/models/amount_with_currency.rb +1 -1
- data/lib/plaid/models/amount_with_currency_with_monthly_average.rb +1 -1
- data/lib/plaid/models/application.rb +8 -8
- 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 +3 -3
- data/lib/plaid/models/asset_holder.rb +1 -1
- data/lib/plaid/models/asset_holder_name.rb +1 -1
- data/lib/plaid/models/asset_holding.rb +1 -1
- data/lib/plaid/models/asset_holdings.rb +1 -1
- data/lib/plaid/models/asset_investment_transaction_type.rb +1 -1
- data/lib/plaid/models/asset_owner.rb +1 -1
- data/lib/plaid/models/asset_owners.rb +2 -2
- data/lib/plaid/models/asset_report.rb +1 -1
- data/lib/plaid/models/asset_report_account_balance.rb +3 -3
- 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_pdf_get_request.rb +1 -1
- data/lib/plaid/models/asset_report_audit_copy_remove_request.rb +1 -1
- data/lib/plaid/models/asset_report_audit_copy_remove_response.rb +1 -1
- data/lib/plaid/models/asset_report_create_request.rb +1 -1
- data/lib/plaid/models/asset_report_create_request_options.rb +2 -2
- 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 +2 -2
- data/lib/plaid/models/asset_report_freddie_get_response.rb +2 -2
- 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 +2 -2
- data/lib/plaid/models/asset_report_investment_transaction.rb +3 -3
- data/lib/plaid/models/asset_report_investments.rb +1 -1
- data/lib/plaid/models/asset_report_item.rb +2 -2
- 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_type.rb +1 -1
- data/lib/plaid/models/asset_report_user.rb +2 -2
- data/lib/plaid/models/asset_transaction.rb +2 -2
- data/lib/plaid/models/asset_transaction_category_type.rb +1 -1
- data/lib/plaid/models/asset_transaction_description.rb +2 -2
- data/lib/plaid/models/asset_transaction_detail.rb +1 -1
- data/lib/plaid/models/asset_transaction_type.rb +1 -1
- data/lib/plaid/models/asset_transactions.rb +1 -1
- data/lib/plaid/models/asset_type.rb +1 -1
- data/lib/plaid/models/assets.rb +1 -1
- data/lib/plaid/models/assets_error_webhook.rb +1 -1
- data/lib/plaid/models/assets_product_ready_webhook.rb +2 -2
- data/lib/plaid/models/auth_default_update_webhook.rb +1 -1
- data/lib/plaid/models/auth_get_numbers.rb +3 -3
- data/lib/plaid/models/auth_get_request.rb +2 -2
- 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 +3 -3
- data/lib/plaid/models/auth_update_types.rb +1 -1
- data/lib/plaid/models/auth_verify_numbers_ach.rb +1 -1
- data/lib/plaid/models/auth_verify_request.rb +1 -1
- data/lib/plaid/models/auth_verify_request_numbers.rb +1 -1
- data/lib/plaid/models/auth_verify_response.rb +2 -2
- data/lib/plaid/models/authorization_guarantee_details.rb +264 -0
- data/lib/plaid/models/authorization_guarantee_schedule_item.rb +241 -0
- data/lib/plaid/models/automatically_verified_webhook.rb +1 -1
- 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_penalties_indicators.rb +1 -1
- data/lib/plaid/models/bank_transfer.rb +3 -3
- 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 +2 -2
- data/lib/plaid/models/bank_transfer_cancel_response.rb +1 -1
- data/lib/plaid/models/bank_transfer_create_request.rb +3 -3
- 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 +3 -3
- 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 +2 -2
- 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 +2 -2
- 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 +3 -3
- data/lib/plaid/models/bank_transfers_events_update_webhook.rb +1 -1
- data/lib/plaid/models/bank_transfers_events_update_webhook_for_auth.rb +2 -2
- data/lib/plaid/models/base_report.rb +2 -2
- data/lib/plaid/models/base_report_account.rb +2 -2
- data/lib/plaid/models/base_report_account_balances.rb +3 -3
- data/lib/plaid/models/base_report_account_insights.rb +2 -2
- data/lib/plaid/models/base_report_account_metadata.rb +1 -1
- data/lib/plaid/models/base_report_attributes.rb +1 -1
- data/lib/plaid/models/base_report_average_flow_insights.rb +1 -1
- data/lib/plaid/models/base_report_average_monthly_balances.rb +1 -1
- data/lib/plaid/models/base_report_historical_balance.rb +1 -1
- data/lib/plaid/models/base_report_investment_holding.rb +1 -1
- data/lib/plaid/models/base_report_investment_security.rb +2 -2
- data/lib/plaid/models/base_report_investment_transaction.rb +3 -3
- data/lib/plaid/models/base_report_investments.rb +1 -1
- data/lib/plaid/models/base_report_item.rb +2 -2
- data/lib/plaid/models/base_report_longest_gap_insights.rb +1 -1
- data/lib/plaid/models/base_report_number_flow_insights.rb +1 -1
- data/lib/plaid/models/base_report_transaction.rb +1 -1
- data/lib/plaid/models/base_report_transaction_personal_finance_category.rb +2 -2
- data/lib/plaid/models/base_report_transaction_type.rb +1 -1
- data/lib/plaid/models/base_report_user_attributes.rb +1 -1
- data/lib/plaid/models/base_report_warning.rb +1 -1
- data/lib/plaid/models/base_report_warning_code.rb +1 -1
- data/lib/plaid/models/base_reports_error_webhook.rb +1 -1
- data/lib/plaid/models/beacon_account_risk_attributes.rb +3 -3
- data/lib/plaid/models/beacon_account_risk_evaluate_account.rb +1 -1
- data/lib/plaid/models/beacon_account_risk_evaluate_account_attributes.rb +2 -2
- data/lib/plaid/models/beacon_account_risk_evaluate_evaluation_reason.rb +1 -1
- data/lib/plaid/models/beacon_account_risk_evaluate_request.rb +4 -4
- data/lib/plaid/models/beacon_account_risk_evaluate_request_options.rb +1 -1
- data/lib/plaid/models/beacon_account_risk_evaluate_response.rb +1 -1
- data/lib/plaid/models/beacon_audit_trail.rb +2 -2
- data/lib/plaid/models/beacon_audit_trail_source.rb +1 -1
- data/lib/plaid/models/beacon_bank_account_insights.rb +2 -2
- data/lib/plaid/models/beacon_bank_accounts.rb +1 -1
- data/lib/plaid/models/beacon_duplicate_detected_webhook.rb +1 -1
- data/lib/plaid/models/beacon_duplicate_get_request.rb +1 -1
- data/lib/plaid/models/beacon_duplicate_get_response.rb +1 -1
- data/lib/plaid/models/beacon_match_summary_analysis.rb +1 -1
- data/lib/plaid/models/beacon_match_summary_code.rb +1 -1
- data/lib/plaid/models/beacon_report.rb +1 -1
- data/lib/plaid/models/beacon_report_create_request.rb +1 -1
- data/lib/plaid/models/beacon_report_create_response.rb +1 -1
- data/lib/plaid/models/beacon_report_create_type.rb +1 -1
- data/lib/plaid/models/beacon_report_created_webhook.rb +1 -1
- data/lib/plaid/models/beacon_report_get_request.rb +1 -1
- data/lib/plaid/models/beacon_report_get_response.rb +1 -1
- data/lib/plaid/models/beacon_report_list_request.rb +1 -1
- data/lib/plaid/models/beacon_report_list_response.rb +1 -1
- data/lib/plaid/models/beacon_report_syndication.rb +1 -1
- data/lib/plaid/models/beacon_report_syndication_analysis.rb +1 -1
- data/lib/plaid/models/beacon_report_syndication_created_webhook.rb +1 -1
- data/lib/plaid/models/beacon_report_syndication_get_request.rb +1 -1
- data/lib/plaid/models/beacon_report_syndication_get_response.rb +1 -1
- data/lib/plaid/models/beacon_report_syndication_list_request.rb +1 -1
- data/lib/plaid/models/beacon_report_syndication_list_response.rb +1 -1
- data/lib/plaid/models/beacon_report_syndication_original_report.rb +1 -1
- data/lib/plaid/models/beacon_report_type.rb +1 -1
- data/lib/plaid/models/beacon_report_updated_webhook.rb +1 -1
- data/lib/plaid/models/beacon_syndicated_report_depository_account_match_analysis.rb +2 -2
- data/lib/plaid/models/beacon_user.rb +1 -1
- data/lib/plaid/models/beacon_user_account_insights_get_request.rb +2 -2
- data/lib/plaid/models/beacon_user_account_insights_get_response.rb +2 -2
- data/lib/plaid/models/beacon_user_address.rb +1 -1
- data/lib/plaid/models/beacon_user_create_request.rb +1 -1
- data/lib/plaid/models/beacon_user_create_response.rb +1 -1
- data/lib/plaid/models/beacon_user_data.rb +2 -2
- data/lib/plaid/models/beacon_user_depository_account.rb +2 -2
- 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_history_list_request.rb +1 -1
- data/lib/plaid/models/beacon_user_history_list_response.rb +1 -1
- data/lib/plaid/models/beacon_user_id_number.rb +2 -2
- data/lib/plaid/models/beacon_user_name.rb +1 -1
- data/lib/plaid/models/beacon_user_name_nullable.rb +1 -1
- data/lib/plaid/models/beacon_user_request_address.rb +1 -1
- data/lib/plaid/models/beacon_user_request_address_nullable.rb +1 -1
- data/lib/plaid/models/beacon_user_request_data.rb +2 -2
- data/lib/plaid/models/beacon_user_request_depository_account.rb +1 -1
- data/lib/plaid/models/beacon_user_review_request.rb +1 -1
- data/lib/plaid/models/beacon_user_revision.rb +1 -1
- data/lib/plaid/models/beacon_user_status.rb +1 -1
- data/lib/plaid/models/beacon_user_status_updated_webhook.rb +1 -1
- data/lib/plaid/models/beacon_user_update_request.rb +1 -1
- data/lib/plaid/models/beacon_user_update_request_data.rb +2 -2
- data/lib/plaid/models/beacon_user_update_response.rb +1 -1
- data/lib/plaid/models/beta_ewa_report_v1_get_request.rb +2 -2
- data/lib/plaid/models/beta_ewa_report_v1_get_response.rb +1 -1
- data/lib/plaid/models/beta_partner_customer_v1_create_request.rb +2 -2
- data/lib/plaid/models/beta_partner_customer_v1_create_response.rb +1 -1
- data/lib/plaid/models/beta_partner_customer_v1_enable_request.rb +1 -1
- data/lib/plaid/models/beta_partner_customer_v1_enable_response.rb +1 -1
- data/lib/plaid/models/beta_partner_customer_v1_get_request.rb +1 -1
- data/lib/plaid/models/beta_partner_customer_v1_get_response.rb +1 -1
- data/lib/plaid/models/beta_partner_customer_v1_update_request.rb +1 -1
- data/lib/plaid/models/beta_partner_customer_v1_update_response.rb +1 -1
- data/lib/plaid/models/beta_partner_end_customer.rb +1 -1
- data/lib/plaid/models/beta_partner_end_customer_with_secrets.rb +1 -1
- data/lib/plaid/models/business_account.rb +4 -8
- data/lib/plaid/models/business_account_all_of.rb +40 -2
- data/lib/plaid/models/business_check_boolean_status.rb +1 -1
- data/lib/plaid/models/business_digital_presence_check.rb +1 -1
- data/lib/plaid/models/business_email_address.rb +1 -1
- data/lib/plaid/models/business_entity_type.rb +1 -1
- data/lib/plaid/models/business_field_match_summary.rb +1 -1
- data/lib/plaid/models/business_finance_category.rb +2 -2
- data/lib/plaid/models/business_industry_prediction.rb +1 -1
- data/lib/plaid/models/business_industry_prediction_nullable.rb +1 -1
- data/lib/plaid/models/business_kyb_check.rb +1 -1
- data/lib/plaid/models/business_kyb_match_details.rb +1 -1
- data/lib/plaid/models/business_phone_number.rb +1 -1
- data/lib/plaid/models/business_risk_check.rb +1 -1
- data/lib/plaid/models/business_search_terms.rb +1 -1
- data/lib/plaid/models/business_verification_create_request.rb +1 -1
- data/lib/plaid/models/business_verification_create_request_business.rb +1 -1
- data/lib/plaid/models/business_verification_create_response.rb +1 -1
- data/lib/plaid/models/business_verification_get_request.rb +1 -1
- data/lib/plaid/models/business_verification_get_response.rb +1 -1
- data/lib/plaid/models/business_verification_status_kyb_check.rb +1 -1
- data/lib/plaid/models/business_verification_status_overall.rb +1 -1
- data/lib/plaid/models/business_verification_status_risk_check.rb +1 -1
- data/lib/plaid/models/business_verification_status_web_presence_check.rb +1 -1
- data/lib/plaid/models/business_website.rb +1 -1
- data/lib/plaid/models/business_website_analysis.rb +1 -1
- data/lib/plaid/models/business_website_build_status.rb +1 -1
- data/lib/plaid/models/business_website_ssl.rb +1 -1
- data/lib/plaid/models/business_whois_record.rb +1 -1
- data/lib/plaid/models/cash_flow_insight.rb +1 -1
- data/lib/plaid/models/cash_flow_updates_event_webhook_codes.rb +1 -1
- data/lib/plaid/models/cash_flow_updates_expected_deposit_missed_webhook.rb +2 -2
- data/lib/plaid/models/cash_flow_updates_insights_v2_webhook.rb +2 -2
- data/lib/plaid/models/cash_flow_updates_insights_webhook.rb +1 -1
- data/lib/plaid/models/cash_flow_updates_large_deposit_webhook.rb +2 -2
- data/lib/plaid/models/cash_flow_updates_low_balance_webhook.rb +2 -2
- data/lib/plaid/models/cash_flow_updates_new_income_stream_webhook.rb +2 -2
- data/lib/plaid/models/cash_flow_updates_new_loan_payment_webhook.rb +2 -2
- data/lib/plaid/models/cash_flow_updates_nsf_webhook.rb +2 -2
- data/lib/plaid/models/cashflow_attributes_version.rb +1 -1
- data/lib/plaid/models/cashflow_report_account_insights.rb +1 -1
- data/lib/plaid/models/cashflow_report_get_request.rb +2 -2
- data/lib/plaid/models/cashflow_report_get_request_options.rb +1 -1
- data/lib/plaid/models/cashflow_report_get_response.rb +1 -1
- data/lib/plaid/models/cashflow_report_historical_balance.rb +1 -1
- data/lib/plaid/models/cashflow_report_insights_get_request.rb +2 -2
- data/lib/plaid/models/cashflow_report_insights_get_response.rb +2 -2
- data/lib/plaid/models/cashflow_report_monthly_summary.rb +1 -1
- data/lib/plaid/models/cashflow_report_monthly_summary_average_daily_ending_balance.rb +1 -1
- data/lib/plaid/models/cashflow_report_monthly_summary_average_daily_inflow_amount.rb +1 -1
- data/lib/plaid/models/cashflow_report_monthly_summary_average_daily_net_cashflow_amount.rb +1 -1
- data/lib/plaid/models/cashflow_report_monthly_summary_average_daily_outflow_amount.rb +1 -1
- data/lib/plaid/models/cashflow_report_monthly_summary_ending_balance.rb +1 -1
- data/lib/plaid/models/cashflow_report_monthly_summary_starting_balance.rb +1 -1
- data/lib/plaid/models/cashflow_report_monthly_summary_total_loan_payment.rb +1 -1
- data/lib/plaid/models/cashflow_report_monthly_summary_total_payroll.rb +1 -1
- data/lib/plaid/models/cashflow_report_monthly_summary_total_revenue.rb +1 -1
- data/lib/plaid/models/cashflow_report_monthly_summary_total_variable_expense.rb +1 -1
- data/lib/plaid/models/cashflow_report_payment_meta.rb +1 -1
- data/lib/plaid/models/cashflow_report_refresh_request.rb +2 -2
- data/lib/plaid/models/cashflow_report_refresh_response.rb +2 -2
- data/lib/plaid/models/cashflow_report_transaction.rb +1 -1
- data/lib/plaid/models/cashflow_report_transactions_get_request.rb +2 -2
- data/lib/plaid/models/cashflow_report_transactions_get_request_options.rb +1 -1
- data/lib/plaid/models/cashflow_report_transactions_get_response.rb +1 -1
- data/lib/plaid/models/categories_get_response.rb +1 -1
- data/lib/plaid/models/category.rb +1 -1
- data/lib/plaid/models/category_expenses.rb +1 -1
- data/lib/plaid/models/category_insight_details.rb +1 -1
- data/lib/plaid/models/category_insights.rb +1 -1
- data/lib/plaid/models/cause.rb +2 -2
- data/lib/plaid/models/cause_all_of.rb +1 -1
- data/lib/plaid/models/check_report_warning.rb +1 -1
- data/lib/plaid/models/check_report_warning_code.rb +1 -1
- data/lib/plaid/models/client_customization.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/client_user_identity.rb +1 -1
- data/lib/plaid/models/client_user_identity_address.rb +1 -1
- data/lib/plaid/models/client_user_identity_email.rb +1 -1
- data/lib/plaid/models/client_user_identity_name.rb +1 -1
- data/lib/plaid/models/client_user_identity_phone_number.rb +1 -1
- data/lib/plaid/models/connected_application.rb +2 -2
- data/lib/plaid/models/consent_event.rb +3 -3
- data/lib/plaid/models/consent_event_code.rb +1 -1
- data/lib/plaid/models/consent_event_initiator.rb +1 -1
- data/lib/plaid/models/consent_event_type.rb +1 -1
- data/lib/plaid/models/consent_events_get_request.rb +2 -2
- data/lib/plaid/models/consent_events_get_response.rb +1 -1
- data/lib/plaid/models/consented_account.rb +2 -2
- data/lib/plaid/models/consumer_dispute.rb +1 -1
- data/lib/plaid/models/consumer_dispute_category.rb +1 -1
- data/lib/plaid/models/consumer_report_pdf_get_request.rb +2 -2
- data/lib/plaid/models/consumer_report_permissible_purpose.rb +1 -1
- data/lib/plaid/models/consumer_report_user_identity.rb +4 -4
- data/lib/plaid/models/counterparty.rb +3 -3
- data/lib/plaid/models/counterparty_insights.rb +3 -3
- data/lib/plaid/models/counterparty_numbers.rb +1 -1
- data/lib/plaid/models/counterparty_numbers_bacs.rb +4 -4
- data/lib/plaid/models/counterparty_numbers_international.rb +2 -2
- data/lib/plaid/models/counterparty_type.rb +1 -1
- data/lib/plaid/models/country_code.rb +1 -1
- data/lib/plaid/models/cra_annual_income_values.rb +1 -1
- data/lib/plaid/models/cra_bank_income_account.rb +2 -2
- data/lib/plaid/models/cra_bank_income_account_metadata.rb +1 -1
- data/lib/plaid/models/cra_bank_income_bonus_type.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 +2 -2
- data/lib/plaid/models/cra_bank_income_employer.rb +1 -1
- data/lib/plaid/models/cra_bank_income_error_webhook.rb +1 -1
- data/lib/plaid/models/cra_bank_income_historical_summary.rb +1 -1
- data/lib/plaid/models/cra_bank_income_income_provider.rb +1 -1
- data/lib/plaid/models/cra_bank_income_item.rb +1 -1
- data/lib/plaid/models/cra_bank_income_source.rb +4 -4
- data/lib/plaid/models/cra_bank_income_status.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/cra_cashflow_insights_report.rb +1 -1
- data/lib/plaid/models/cra_check_report_base_report_get_request.rb +4 -4
- data/lib/plaid/models/cra_check_report_base_report_get_response.rb +1 -1
- data/lib/plaid/models/cra_check_report_cashflow_insights_get_options.rb +1 -1
- data/lib/plaid/models/cra_check_report_cashflow_insights_get_request.rb +3 -3
- data/lib/plaid/models/cra_check_report_cashflow_insights_get_response.rb +1 -1
- data/lib/plaid/models/cra_check_report_create_base_report_options.rb +1 -1
- data/lib/plaid/models/cra_check_report_create_partner_insights_options.rb +1 -1
- data/lib/plaid/models/cra_check_report_create_request.rb +3 -3
- data/lib/plaid/models/cra_check_report_create_response.rb +1 -1
- data/lib/plaid/models/cra_check_report_failed_webhook.rb +1 -1
- data/lib/plaid/models/cra_check_report_freddie_mac_get_request.rb +1 -1
- data/lib/plaid/models/cra_check_report_freddie_mac_get_response.rb +1 -1
- data/lib/plaid/models/cra_check_report_freddie_mac_verification_of_assets_deal.rb +1 -1
- data/lib/plaid/models/cra_check_report_gse_options.rb +1 -1
- data/lib/plaid/models/cra_check_report_home_lending_report_options.rb +1 -1
- data/lib/plaid/models/cra_check_report_income_insights_get_options.rb +1 -1
- data/lib/plaid/models/cra_check_report_income_insights_get_request.rb +3 -3
- data/lib/plaid/models/cra_check_report_income_insights_get_response.rb +1 -1
- data/lib/plaid/models/cra_check_report_lend_score_get_options.rb +1 -1
- data/lib/plaid/models/cra_check_report_lend_score_get_request.rb +3 -3
- data/lib/plaid/models/cra_check_report_lend_score_get_response.rb +1 -1
- data/lib/plaid/models/cra_check_report_network_insights_get_options.rb +1 -1
- data/lib/plaid/models/cra_check_report_network_insights_get_request.rb +3 -3
- data/lib/plaid/models/cra_check_report_network_insights_get_response.rb +2 -2
- data/lib/plaid/models/cra_check_report_partner_insights_get_options.rb +1 -1
- data/lib/plaid/models/cra_check_report_partner_insights_get_partner_insights.rb +2 -2
- data/lib/plaid/models/cra_check_report_partner_insights_get_request.rb +4 -4
- data/lib/plaid/models/cra_check_report_partner_insights_get_response.rb +2 -2
- data/lib/plaid/models/cra_check_report_pdf_get_request.rb +3 -3
- data/lib/plaid/models/cra_check_report_ready_webhook.rb +2 -2
- data/lib/plaid/models/cra_check_report_verification_get_employment_refresh_options.rb +1 -1
- data/lib/plaid/models/cra_check_report_verification_get_report_type.rb +2 -1
- data/lib/plaid/models/cra_check_report_verification_get_request.rb +3 -3
- data/lib/plaid/models/cra_check_report_verification_get_response.rb +1 -1
- data/lib/plaid/models/cra_check_report_verification_pdf_get_request.rb +31 -29
- data/lib/plaid/models/cra_check_report_verification_pdf_report_type.rb +2 -1
- data/lib/plaid/models/cra_credit_profile_inquiry_type.rb +39 -0
- data/lib/plaid/models/cra_credit_profile_lend_score.rb +265 -0
- data/lib/plaid/models/cra_credit_profile_report.rb +330 -0
- data/lib/plaid/models/{item_handle_fraud_report_request.rb → cra_credit_profile_report_get_request.rb} +50 -91
- data/lib/plaid/models/cra_credit_profile_report_get_response.rb +267 -0
- data/lib/plaid/models/cra_credit_profile_report_metadata.rb +378 -0
- data/lib/plaid/models/cra_credit_profile_report_type.rb +38 -0
- data/lib/plaid/models/cra_credit_profile_report_version.rb +38 -0
- data/lib/plaid/models/cra_current_modeled_income.rb +1 -1
- data/lib/plaid/models/cra_employment_refresh_report.rb +1 -1
- data/lib/plaid/models/cra_employment_refresh_report_account.rb +2 -2
- data/lib/plaid/models/cra_employment_refresh_report_item.rb +2 -2
- data/lib/plaid/models/cra_employment_refresh_report_transaction.rb +1 -1
- data/lib/plaid/models/cra_income_category.rb +1 -1
- data/lib/plaid/models/cra_income_insights.rb +6 -1
- data/lib/plaid/models/cra_income_insights_user_summary.rb +1 -1
- data/lib/plaid/models/cra_income_metrics.rb +1 -1
- data/lib/plaid/models/cra_income_next_payment.rb +1 -1
- data/lib/plaid/models/cra_income_stream.rb +1 -1
- data/lib/plaid/models/cra_income_stream_insights.rb +1 -1
- data/lib/plaid/models/cra_income_transaction.rb +1 -1
- data/lib/plaid/models/cra_income_transaction_outlier.rb +1 -1
- data/lib/plaid/models/cra_lend_score_report.rb +1 -1
- data/lib/plaid/models/cra_loan_application.rb +1 -1
- data/lib/plaid/models/cra_loan_application_decision.rb +1 -1
- data/lib/plaid/models/cra_loan_closed_status.rb +1 -1
- data/lib/plaid/models/cra_loan_opened_status.rb +1 -1
- data/lib/plaid/models/cra_loan_payment_history.rb +2 -2
- data/lib/plaid/models/cra_loan_payment_schedule.rb +1 -1
- data/lib/plaid/models/cra_loan_register.rb +1 -1
- data/lib/plaid/models/cra_loan_register_application.rb +1 -1
- data/lib/plaid/models/cra_loan_status.rb +1 -1
- data/lib/plaid/models/cra_loan_status_history_update.rb +1 -1
- data/lib/plaid/models/cra_loan_type.rb +1 -1
- data/lib/plaid/models/cra_loan_unregister.rb +1 -1
- data/lib/plaid/models/cra_loan_unregister_response.rb +1 -1
- data/lib/plaid/models/cra_loan_update.rb +1 -1
- data/lib/plaid/models/cra_loans_applications_register_request.rb +1 -1
- data/lib/plaid/models/cra_loans_applications_register_response.rb +1 -1
- data/lib/plaid/models/cra_loans_register_request.rb +1 -1
- data/lib/plaid/models/cra_loans_register_response.rb +1 -1
- data/lib/plaid/models/cra_loans_unregister_request.rb +1 -1
- data/lib/plaid/models/cra_loans_update_request.rb +1 -1
- data/lib/plaid/models/cra_loans_update_response.rb +1 -1
- data/lib/plaid/models/cra_monitoring_insights_get_request.rb +3 -3
- data/lib/plaid/models/cra_monitoring_insights_get_response.rb +1 -1
- data/lib/plaid/models/cra_monitoring_insights_item.rb +1 -1
- data/lib/plaid/models/cra_monitoring_insights_subscribe_request.rb +4 -4
- data/lib/plaid/models/cra_monitoring_insights_subscribe_response.rb +1 -1
- data/lib/plaid/models/cra_monitoring_insights_unsubscribe_request.rb +1 -1
- data/lib/plaid/models/cra_monitoring_insights_unsubscribe_response.rb +1 -1
- data/lib/plaid/models/cra_monthly_income_values.rb +1 -1
- data/lib/plaid/models/cra_network_insights_item.rb +1 -1
- data/lib/plaid/models/cra_network_insights_report.rb +1 -1
- data/lib/plaid/models/cra_partner_insights.rb +1 -1
- data/lib/plaid/models/cra_partner_insights_base_fico_score.rb +29 -8
- data/lib/plaid/models/cra_partner_insights_base_fico_score_version.rb +1 -1
- data/lib/plaid/models/cra_partner_insights_bureau.rb +1 -1
- data/lib/plaid/models/cra_partner_insights_complete_webhook.rb +1 -1
- data/lib/plaid/models/cra_partner_insights_error_webhook.rb +1 -1
- data/lib/plaid/models/cra_partner_insights_fico_input.rb +5 -5
- data/lib/plaid/models/cra_partner_insights_fico_report_characteristics.rb +2 -2
- data/lib/plaid/models/cra_partner_insights_fico_results.rb +3 -3
- data/lib/plaid/models/cra_partner_insights_get_request.rb +2 -2
- data/lib/plaid/models/cra_partner_insights_get_response.rb +1 -1
- data/lib/plaid/models/cra_partner_insights_item.rb +3 -3
- data/lib/plaid/models/cra_partner_insights_item_account.rb +2 -2
- data/lib/plaid/models/cra_partner_insights_item_account_metadata.rb +1 -1
- data/lib/plaid/models/cra_partner_insights_prism.rb +1 -1
- data/lib/plaid/models/cra_partner_insights_ultra_fico_score.rb +54 -12
- data/lib/plaid/models/cra_partner_insights_ultra_fico_score_request.rb +4 -4
- data/lib/plaid/models/cra_partner_insights_ultra_fico_score_result.rb +4 -4
- data/lib/plaid/models/cra_partner_insights_ultra_fico_score_version.rb +1 -1
- data/lib/plaid/models/cra_pdf_add_ons.rb +1 -1
- data/lib/plaid/models/cra_prediction_interval.rb +1 -1
- data/lib/plaid/models/cra_projected_modeled_income.rb +1 -1
- data/lib/plaid/models/cra_upgrade_failed_webhook.rb +1 -1
- data/lib/plaid/models/cra_user_check_report_failed_webhook.rb +3 -3
- data/lib/plaid/models/cra_user_check_report_ready_webhook.rb +3 -3
- data/lib/plaid/models/cra_user_tier.rb +1 -1
- data/lib/plaid/models/cra_verification_income_account.rb +323 -0
- data/lib/plaid/models/cra_verification_income_category.rb +241 -0
- data/lib/plaid/models/{network_insights_item.rb → cra_verification_income_item.rb} +58 -26
- data/lib/plaid/models/cra_verification_income_metrics.rb +243 -0
- data/lib/plaid/models/cra_verification_income_next_payment.rb +226 -0
- data/lib/plaid/models/cra_verification_income_pay_frequency.rb +43 -0
- data/lib/plaid/models/{item_handle_fraud_report_response.rb → cra_verification_income_provider.rb} +26 -26
- data/lib/plaid/models/{network_insights_report.rb → cra_verification_income_report.rb} +46 -34
- data/lib/plaid/models/cra_verification_income_status.rb +40 -0
- data/lib/plaid/models/cra_verification_income_stream.rb +316 -0
- data/lib/plaid/models/cra_verification_income_stream_insights.rb +295 -0
- data/lib/plaid/models/cra_verification_income_transaction.rb +337 -0
- data/lib/plaid/models/cra_verification_income_transaction_outlier.rb +237 -0
- data/lib/plaid/models/cra_verification_income_user_summary.rb +228 -0
- data/lib/plaid/models/{link_session_protect_result.rb → cra_verification_income_values.rb} +28 -36
- data/lib/plaid/models/cra_verification_modeled_income.rb +239 -0
- data/lib/plaid/models/cra_verification_report.rb +16 -6
- data/lib/plaid/models/cra_voa_report.rb +1 -1
- data/lib/plaid/models/cra_voa_report_account.rb +2 -2
- data/lib/plaid/models/cra_voa_report_account_balances.rb +3 -3
- data/lib/plaid/models/cra_voa_report_account_historical_balance.rb +1 -1
- data/lib/plaid/models/cra_voa_report_attributes.rb +1 -1
- data/lib/plaid/models/cra_voa_report_item.rb +2 -2
- data/lib/plaid/models/cra_voa_report_transactions_insights.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 +3 -3
- 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 +2 -2
- 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 +2 -2
- 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 +2 -2
- 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 +2 -2
- data/lib/plaid/models/credit_bank_income_refresh_request.rb +2 -2
- 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 +3 -3
- 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 +2 -2
- 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 +2 -2
- data/lib/plaid/models/credit_bank_statements_uploads_get_request_options.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 +2 -2
- 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.rb +1 -1
- data/lib/plaid/models/credit_freddie_mac_asset_transaction.rb +1 -1
- data/lib/plaid/models/credit_freddie_mac_asset_transactions.rb +1 -1
- data/lib/plaid/models/credit_freddie_mac_assets.rb +1 -1
- data/lib/plaid/models/credit_freddie_mac_individual_name.rb +1 -1
- data/lib/plaid/models/credit_freddie_mac_loan.rb +2 -2
- data/lib/plaid/models/credit_freddie_mac_loan_identifiers.rb +1 -1
- data/lib/plaid/models/credit_freddie_mac_loans.rb +1 -1
- data/lib/plaid/models/credit_freddie_mac_parties.rb +1 -1
- data/lib/plaid/models/credit_freddie_mac_party.rb +1 -1
- data/lib/plaid/models/credit_freddie_mac_party_individual.rb +1 -1
- data/lib/plaid/models/credit_freddie_mac_reporting_information.rb +3 -3
- data/lib/plaid/models/credit_freddie_mac_reports_get_request.rb +2 -2
- data/lib/plaid/models/credit_freddie_mac_reports_get_response.rb +1 -1
- data/lib/plaid/models/credit_freddie_mac_service.rb +1 -1
- data/lib/plaid/models/credit_freddie_mac_services.rb +1 -1
- data/lib/plaid/models/credit_freddie_mac_verification_of_asset.rb +1 -1
- data/lib/plaid/models/credit_freddie_mac_verification_of_asset_response.rb +1 -1
- data/lib/plaid/models/credit_freddie_mac_verification_of_assets_deal.rb +1 -1
- data/lib/plaid/models/credit_pay_stub.rb +1 -1
- data/lib/plaid/models/credit_pay_stub_address.rb +1 -1
- data/lib/plaid/models/credit_pay_stub_deductions.rb +1 -1
- data/lib/plaid/models/credit_pay_stub_earnings.rb +1 -1
- data/lib/plaid/models/credit_pay_stub_employee.rb +1 -1
- data/lib/plaid/models/credit_pay_stub_employer.rb +1 -1
- data/lib/plaid/models/credit_pay_stub_net_pay.rb +1 -1
- data/lib/plaid/models/credit_pay_stub_pay_basis_type.rb +1 -1
- data/lib/plaid/models/credit_payroll_income_get_request.rb +2 -2
- data/lib/plaid/models/credit_payroll_income_get_request_options.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 +3 -3
- data/lib/plaid/models/credit_payroll_income_parsing_config_update_response.rb +2 -2
- data/lib/plaid/models/credit_payroll_income_precheck_request.rb +2 -2
- data/lib/plaid/models/credit_payroll_income_precheck_response.rb +1 -1
- data/lib/plaid/models/credit_payroll_income_refresh_request.rb +2 -2
- data/lib/plaid/models/credit_payroll_income_refresh_request_options.rb +1 -1
- data/lib/plaid/models/credit_payroll_income_refresh_response.rb +1 -1
- data/lib/plaid/models/credit_payroll_income_risk_signals_get_request.rb +2 -2
- data/lib/plaid/models/credit_payroll_income_risk_signals_get_response.rb +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 +3 -1
- data/lib/plaid/models/credit_session_bank_income_result.rb +1 -1
- data/lib/plaid/models/credit_session_bank_income_status.rb +3 -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 +2 -2
- data/lib/plaid/models/credit_sessions_get_response.rb +1 -1
- data/lib/plaid/models/credit_w2.rb +4 -4
- data/lib/plaid/models/custom_sandbox_transaction.rb +1 -1
- data/lib/plaid/models/customer_initiated_return_risk.rb +1 -1
- data/lib/plaid/models/dashboard_user.rb +2 -2
- data/lib/plaid/models/dashboard_user_get_request.rb +2 -2
- data/lib/plaid/models/dashboard_user_get_response.rb +2 -2
- 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/data_sources.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/depository_account_subtype.rb +1 -1
- data/lib/plaid/models/depository_filter.rb +2 -2
- data/lib/plaid/models/detailed_originator.rb +2 -2
- data/lib/plaid/models/detected_account.rb +1 -1
- data/lib/plaid/models/device_id.rb +1 -1
- data/lib/plaid/models/distribution_breakdown.rb +1 -1
- data/lib/plaid/models/doc_type.rb +1 -1
- data/lib/plaid/models/document_analysis.rb +1 -1
- data/lib/plaid/models/document_authenticity_match_code.rb +1 -1
- data/lib/plaid/models/document_date_of_birth_match_code.rb +1 -1
- data/lib/plaid/models/document_metadata.rb +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 +2 -2
- 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 +2 -2
- data/lib/plaid/models/entity_document.rb +1 -1
- data/lib/plaid/models/entity_document_type.rb +1 -1
- data/lib/plaid/models/entity_screening_hit_analysis.rb +2 -2
- data/lib/plaid/models/entity_screening_hit_data.rb +1 -1
- data/lib/plaid/models/entity_screening_hit_documents_items.rb +1 -1
- data/lib/plaid/models/entity_screening_hit_emails.rb +1 -1
- data/lib/plaid/models/entity_screening_hit_emails_items.rb +1 -1
- data/lib/plaid/models/entity_screening_hit_names.rb +1 -1
- data/lib/plaid/models/entity_screening_hit_names_items.rb +1 -1
- data/lib/plaid/models/entity_screening_hit_phone_numbers.rb +1 -1
- data/lib/plaid/models/entity_screening_hit_urls.rb +1 -1
- data/lib/plaid/models/entity_screening_hit_urls_items.rb +1 -1
- data/lib/plaid/models/entity_screening_hits_phone_number_items.rb +1 -1
- data/lib/plaid/models/entity_screening_status_updated_webhook.rb +1 -1
- data/lib/plaid/models/entity_watchlist_code.rb +1 -1
- data/lib/plaid/models/entity_watchlist_program.rb +1 -1
- data/lib/plaid/models/entity_watchlist_screening.rb +2 -2
- data/lib/plaid/models/entity_watchlist_screening_hit.rb +19 -2
- data/lib/plaid/models/entity_watchlist_screening_review.rb +2 -2
- 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/ewa_score.rb +1 -1
- data/lib/plaid/models/expenditure_insights.rb +1 -1
- data/lib/plaid/models/expenditure_insights_cash_flow.rb +1 -1
- data/lib/plaid/models/expenditure_summary.rb +2 -2
- data/lib/plaid/models/expiration_date.rb +1 -1
- data/lib/plaid/models/extended_recipient_metadata.rb +1 -1
- data/lib/plaid/models/extended_recipient_metadata_all_of.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_consent_grant.rb +331 -0
- data/lib/plaid/models/fdx_consent_grant_resource.rb +279 -0
- data/lib/plaid/models/fdx_consent_grant_status.rb +40 -0
- data/lib/plaid/models/fdx_consent_resource_type.rb +40 -0
- data/lib/plaid/models/fdx_consent_revocation.rb +281 -0
- data/lib/plaid/models/fdx_consent_revocation_record.rb +290 -0
- data/lib/plaid/models/fdx_consent_revocations.rb +228 -0
- data/lib/plaid/models/fdx_content_types.rb +1 -1
- data/lib/plaid/models/fdx_data_cluster.rb +53 -0
- data/lib/plaid/models/fdx_event_status.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_lifecycle_event.rb +1 -1
- data/lib/plaid/models/fdx_notification.rb +2 -2
- 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/fdx_recipient_metadata.rb +2 -2
- data/lib/plaid/models/fdx_update_reason.rb +1 -1
- data/lib/plaid/models/fdxfi_attribute.rb +1 -1
- data/lib/plaid/models/financial_institution_insights.rb +1 -1
- data/lib/plaid/models/fixed_income.rb +1 -1
- data/lib/plaid/models/forecasted_monthly_income.rb +1 -1
- data/lib/plaid/models/form1099_type.rb +1 -1
- data/lib/plaid/models/forwarded_json_response.rb +1 -1
- data/lib/plaid/models/fraud_amount.rb +1 -1
- data/lib/plaid/models/fraud_analysis_details.rb +8 -23
- data/lib/plaid/models/fraud_check_outcome.rb +1 -1
- data/lib/plaid/models/fraud_check_outcome_with_no_data.rb +1 -1
- data/lib/plaid/models/gambling_indicators.rb +1 -1
- data/lib/plaid/models/generic_screening_hit_location_items.rb +1 -1
- data/lib/plaid/models/get_recipient_response.rb +1 -1
- data/lib/plaid/models/get_recipients_response.rb +1 -1
- data/lib/plaid/models/gse_report_type.rb +1 -1
- data/lib/plaid/models/health_incident.rb +1 -1
- data/lib/plaid/models/hidden_match_summary_code.rb +1 -1
- data/lib/plaid/models/historical_annual_income.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 +18 -6
- data/lib/plaid/models/holding_tax_lot.rb +309 -0
- data/lib/plaid/models/holding_tax_lot_position_type.rb +39 -0
- 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/hosted_mmd_verification_webhook.rb +3 -3
- data/lib/plaid/models/human_review.rb +1 -1
- data/lib/plaid/models/human_review_status.rb +1 -1
- data/lib/plaid/models/id_number_type.rb +2 -1
- data/lib/plaid/models/identity_default_update_webhook.rb +1 -1
- data/lib/plaid/models/identity_document_metadata.rb +1 -1
- data/lib/plaid/models/identity_document_upload.rb +1 -1
- data/lib/plaid/models/identity_document_upload_metadata.rb +1 -1
- data/lib/plaid/models/identity_document_upload_risk_insights.rb +1 -1
- data/lib/plaid/models/identity_document_upload_risk_signal.rb +1 -1
- data/lib/plaid/models/identity_document_upload_risk_summary.rb +1 -1
- data/lib/plaid/models/identity_documents_uploads_get_request.rb +2 -2
- data/lib/plaid/models/identity_documents_uploads_get_request_options.rb +1 -1
- data/lib/plaid/models/identity_documents_uploads_get_response.rb +1 -1
- data/lib/plaid/models/identity_get_request.rb +2 -2
- data/lib/plaid/models/identity_get_request_options.rb +1 -1
- data/lib/plaid/models/identity_get_response.rb +1 -1
- data/lib/plaid/models/identity_match_request.rb +2 -2
- data/lib/plaid/models/identity_match_request_options.rb +2 -2
- 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 +2 -2
- 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 +2 -2
- data/lib/plaid/models/identity_verification_autofill_address.rb +1 -1
- data/lib/plaid/models/identity_verification_autofill_create_request.rb +1 -1
- data/lib/plaid/models/identity_verification_autofill_create_response.rb +1 -1
- data/lib/plaid/models/identity_verification_autofill_status.rb +1 -1
- data/lib/plaid/models/identity_verification_autofill_user_data.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 +2 -2
- data/lib/plaid/models/identity_verification_document_address_response.rb +1 -1
- data/lib/plaid/models/identity_verification_document_name_response.rb +1 -1
- data/lib/plaid/models/identity_verification_get_request.rb +1 -1
- data/lib/plaid/models/identity_verification_get_response.rb +2 -2
- 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 +2 -2
- 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 +2 -2
- 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 +2 -2
- 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 +2 -2
- data/lib/plaid/models/idv_protect_event.rb +2 -2
- data/lib/plaid/models/image_quality.rb +1 -1
- data/lib/plaid/models/image_quality_details.rb +4 -23
- data/lib/plaid/models/image_quality_outcome.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_insights.rb +1 -1
- data/lib/plaid/models/income_insights_filter.rb +1 -1
- data/lib/plaid/models/income_insights_income_excluding_transfers.rb +1 -1
- data/lib/plaid/models/income_insights_total_income.rb +1 -1
- data/lib/plaid/models/income_insights_transfers_in.rb +1 -1
- data/lib/plaid/models/income_insights_version.rb +1 -1
- data/lib/plaid/models/income_override.rb +1 -1
- data/lib/plaid/models/income_sources_counts.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 +2 -2
- data/lib/plaid/models/income_verification_payroll_flow_type.rb +1 -1
- data/lib/plaid/models/income_verification_paystubs_get_request.rb +2 -2
- 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 +1 -1
- data/lib/plaid/models/income_verification_risk_signals_status_webhook.rb +6 -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 +2 -2
- 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 +2 -2
- 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 +1 -1
- data/lib/plaid/models/institution_supported_networks.rb +1 -1
- data/lib/plaid/models/institutions_get_by_id_request.rb +1 -1
- data/lib/plaid/models/institutions_get_by_id_request_options.rb +1 -1
- data/lib/plaid/models/institutions_get_by_id_response.rb +1 -1
- data/lib/plaid/models/institutions_get_request.rb +1 -1
- data/lib/plaid/models/institutions_get_request_options.rb +1 -1
- data/lib/plaid/models/institutions_get_response.rb +1 -1
- data/lib/plaid/models/institutions_search_account_filter.rb +1 -1
- data/lib/plaid/models/institutions_search_payment_initiation_options.rb +1 -1
- data/lib/plaid/models/institutions_search_request.rb +1 -1
- data/lib/plaid/models/institutions_search_request_options.rb +1 -1
- data/lib/plaid/models/institutions_search_response.rb +1 -1
- data/lib/plaid/models/investment_account.rb +4 -8
- data/lib/plaid/models/investment_account_all_of.rb +40 -2
- data/lib/plaid/models/investment_account_balance.rb +3 -3
- data/lib/plaid/models/investment_account_balance_all_of.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 +3 -3
- 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_auth401k_contribution_details.rb +1 -1
- data/lib/plaid/models/investments_auth401k_fee_details.rb +1 -1
- data/lib/plaid/models/investments_auth_account_details401k.rb +1 -1
- data/lib/plaid/models/investments_auth_data_sources.rb +1 -1
- data/lib/plaid/models/investments_auth_get_numbers.rb +1 -1
- data/lib/plaid/models/investments_auth_get_request.rb +2 -2
- 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 +2 -2
- data/lib/plaid/models/investments_historical_update_webhook.rb +2 -2
- data/lib/plaid/models/investments_holdings_get_request.rb +2 -2
- data/lib/plaid/models/investments_holdings_get_response.rb +1 -1
- data/lib/plaid/models/investments_refresh_request.rb +2 -2
- data/lib/plaid/models/investments_refresh_response.rb +1 -1
- data/lib/plaid/models/investments_transactions_get_request.rb +2 -2
- data/lib/plaid/models/investments_transactions_get_request_options.rb +1 -1
- data/lib/plaid/models/investments_transactions_get_response.rb +1 -1
- data/lib/plaid/models/investments_transactions_override.rb +1 -1
- data/lib/plaid/models/iso_currency_code.rb +1 -1
- data/lib/plaid/models/issue.rb +1 -1
- data/lib/plaid/models/issue_resolved_webhook.rb +1 -1
- data/lib/plaid/models/issues_get_request.rb +1 -1
- data/lib/plaid/models/issues_get_response.rb +1 -1
- data/lib/plaid/models/issues_search_request.rb +1 -1
- data/lib/plaid/models/issues_search_response.rb +1 -1
- data/lib/plaid/models/issues_status.rb +1 -1
- data/lib/plaid/models/issues_subscribe_request.rb +1 -1
- data/lib/plaid/models/issues_subscribe_response.rb +1 -1
- data/lib/plaid/models/issuing_country.rb +1 -1
- data/lib/plaid/models/item.rb +3 -3
- data/lib/plaid/models/item_access_token_invalidate_request.rb +2 -2
- data/lib/plaid/models/item_access_token_invalidate_response.rb +2 -2
- data/lib/plaid/models/item_activity_list_request.rb +2 -2
- data/lib/plaid/models/item_activity_list_response.rb +1 -1
- data/lib/plaid/models/item_add_result_webhook.rb +3 -3
- data/lib/plaid/models/item_application_list_request.rb +2 -2
- data/lib/plaid/models/item_application_list_response.rb +1 -1
- data/lib/plaid/models/item_application_list_user_auth.rb +2 -2
- data/lib/plaid/models/item_application_scopes_update_request.rb +3 -3
- data/lib/plaid/models/item_application_scopes_update_response.rb +1 -1
- data/lib/plaid/models/item_application_unlink_request.rb +3 -3
- data/lib/plaid/models/item_application_unlink_response.rb +1 -1
- data/lib/plaid/models/item_auth_method.rb +1 -1
- data/lib/plaid/models/item_consented_data_scope.rb +1 -1
- data/lib/plaid/models/item_create_authentication.rb +1 -1
- data/lib/plaid/models/item_error_webhook.rb +2 -2
- data/lib/plaid/models/item_get_request.rb +2 -2
- data/lib/plaid/models/item_get_response.rb +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 +3 -3
- data/lib/plaid/models/item_import_response.rb +2 -2
- 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_products_terminate_reason_code.rb +195 -15
- data/lib/plaid/models/item_products_terminate_request.rb +2 -24
- data/lib/plaid/models/item_products_terminate_response.rb +1 -1
- data/lib/plaid/models/item_public_token_create_request.rb +2 -2
- data/lib/plaid/models/item_public_token_create_response.rb +1 -1
- data/lib/plaid/models/item_public_token_exchange_request.rb +2 -2
- data/lib/plaid/models/item_public_token_exchange_response.rb +2 -2
- data/lib/plaid/models/item_remove_reason_code.rb +1 -1
- data/lib/plaid/models/item_remove_request.rb +3 -3
- 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 +2 -2
- data/lib/plaid/models/item_webhook_update_request.rb +2 -2
- data/lib/plaid/models/item_webhook_update_response.rb +1 -1
- data/lib/plaid/models/item_with_consent_fields.rb +3 -3
- data/lib/plaid/models/item_with_consent_fields_all_of.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_details_international_address.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/latest_scored_event.rb +2 -2
- data/lib/plaid/models/layer_authentication_passed_webhook.rb +1 -1
- data/lib/plaid/models/ledger_event_source_type.rb +1 -1
- data/lib/plaid/models/lend_score.rb +2 -2
- data/lib/plaid/models/liabilities_default_update_webhook.rb +1 -1
- data/lib/plaid/models/liabilities_get_request.rb +2 -2
- 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/limited_purpose_type.rb +1 -1
- data/lib/plaid/models/link_callback_metadata.rb +2 -2
- data/lib/plaid/models/link_delivery_account.rb +1 -1
- data/lib/plaid/models/link_delivery_callback_webhook.rb +2 -2
- data/lib/plaid/models/link_delivery_communication_method.rb +1 -1
- data/lib/plaid/models/link_delivery_create_request.rb +1 -1
- data/lib/plaid/models/link_delivery_create_response.rb +1 -1
- data/lib/plaid/models/link_delivery_delivery_method.rb +1 -1
- data/lib/plaid/models/link_delivery_get_request.rb +1 -1
- data/lib/plaid/models/link_delivery_get_response.rb +1 -1
- data/lib/plaid/models/link_delivery_institution.rb +1 -1
- data/lib/plaid/models/link_delivery_metadata.rb +1 -1
- data/lib/plaid/models/link_delivery_options.rb +1 -1
- data/lib/plaid/models/link_delivery_recipient.rb +1 -1
- data/lib/plaid/models/link_delivery_session_status.rb +1 -1
- data/lib/plaid/models/link_delivery_verification_status.rb +1 -1
- data/lib/plaid/models/link_delivery_webhook_callback_type.rb +1 -1
- data/lib/plaid/models/link_delivery_webhook_communication_method.rb +1 -1
- data/lib/plaid/models/link_delivery_webhook_delivery_status.rb +1 -1
- data/lib/plaid/models/link_event.rb +1 -1
- data/lib/plaid/models/link_event_metadata.rb +2 -2
- data/lib/plaid/models/link_event_name.rb +1 -1
- data/lib/plaid/models/link_events_webhook.rb +2 -2
- 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_bank_employment_result.rb +1 -1
- data/lib/plaid/models/link_session_bank_income_result.rb +1 -1
- data/lib/plaid/models/link_session_cra_document_upload_result.rb +1 -1
- data/lib/plaid/models/link_session_cra_item_add_result.rb +1 -1
- data/lib/plaid/models/link_session_cra_update_result.rb +2 -2
- data/lib/plaid/models/link_session_exit.rb +2 -2
- data/lib/plaid/models/link_session_exit_deprecated.rb +2 -2
- data/lib/plaid/models/link_session_exit_metadata.rb +2 -2
- data/lib/plaid/models/link_session_exit_metadata_institution.rb +1 -1
- data/lib/plaid/models/link_session_finished_webhook.rb +3 -3
- data/lib/plaid/models/link_session_item_add_result.rb +1 -1
- data/lib/plaid/models/link_session_payroll_income_result.rb +1 -1
- data/lib/plaid/models/link_session_results.rb +7 -17
- data/lib/plaid/models/link_session_success.rb +2 -2
- data/lib/plaid/models/link_session_success_metadata.rb +1 -1
- data/lib/plaid/models/link_session_success_metadata_account.rb +1 -1
- 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 +1 -1
- data/lib/plaid/models/link_token_cashflow_report.rb +1 -1
- data/lib/plaid/models/link_token_create_card_switch.rb +1 -1
- data/lib/plaid/models/link_token_create_credit_filter.rb +1 -1
- data/lib/plaid/models/link_token_create_depository_filter.rb +2 -2
- data/lib/plaid/models/link_token_create_hosted_link.rb +2 -2
- data/lib/plaid/models/link_token_create_identity.rb +1 -1
- data/lib/plaid/models/link_token_create_institution_data.rb +1 -1
- data/lib/plaid/models/link_token_create_investment_filter.rb +1 -1
- data/lib/plaid/models/link_token_create_loan_filter.rb +1 -1
- data/lib/plaid/models/link_token_create_request.rb +4 -4
- data/lib/plaid/models/link_token_create_request_account_subtypes.rb +1 -1
- data/lib/plaid/models/link_token_create_request_appearance_mode.rb +1 -1
- data/lib/plaid/models/link_token_create_request_auth.rb +3 -3
- data/lib/plaid/models/link_token_create_request_base_report.rb +1 -1
- data/lib/plaid/models/link_token_create_request_cra_options.rb +1 -1
- data/lib/plaid/models/link_token_create_request_cra_options_base_report.rb +1 -1
- data/lib/plaid/models/link_token_create_request_cra_options_base_report_gse_options.rb +1 -1
- data/lib/plaid/models/link_token_create_request_cra_options_cashflow_insights.rb +1 -1
- data/lib/plaid/models/link_token_create_request_cra_options_income_insights.rb +1 -1
- data/lib/plaid/models/link_token_create_request_cra_options_lend_score.rb +1 -1
- data/lib/plaid/models/link_token_create_request_cra_options_network_insights.rb +1 -1
- data/lib/plaid/models/link_token_create_request_cra_options_partner_insights.rb +1 -1
- data/lib/plaid/models/link_token_create_request_credit_partner_insights.rb +1 -1
- data/lib/plaid/models/link_token_create_request_deposit_switch.rb +1 -1
- data/lib/plaid/models/link_token_create_request_employment.rb +1 -1
- data/lib/plaid/models/link_token_create_request_employment_bank_income.rb +1 -1
- data/lib/plaid/models/link_token_create_request_identity_verification.rb +1 -1
- data/lib/plaid/models/link_token_create_request_income_verification.rb +1 -1
- data/lib/plaid/models/link_token_create_request_income_verification_bank_income.rb +1 -1
- data/lib/plaid/models/link_token_create_request_income_verification_payroll_income.rb +1 -1
- data/lib/plaid/models/link_token_create_request_payment_configuration.rb +1 -1
- 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 +2 -2
- data/lib/plaid/models/link_token_create_request_user.rb +3 -3
- 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 +2 -2
- 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 +2 -2
- 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 +2 -2
- data/lib/plaid/models/link_token_get_sessions_response.rb +1 -1
- data/lib/plaid/models/link_token_investments.rb +1 -1
- data/lib/plaid/models/link_token_investments_auth.rb +1 -1
- data/lib/plaid/models/link_token_transactions.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_disbursements_indicators.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/loan_payments_counts.rb +1 -1
- data/lib/plaid/models/loan_payments_indicators.rb +2 -2
- data/lib/plaid/models/loan_payments_merchant_counts.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 +2 -2
- data/lib/plaid/models/meta.rb +1 -1
- data/lib/plaid/models/mfa.rb +1 -1
- data/lib/plaid/models/monitoring_consumer_report_permissible_purpose.rb +1 -1
- data/lib/plaid/models/monitoring_income_insights.rb +1 -1
- data/lib/plaid/models/monitoring_income_source.rb +1 -1
- data/lib/plaid/models/monitoring_insights.rb +1 -1
- data/lib/plaid/models/monitoring_insights_item_status.rb +1 -1
- data/lib/plaid/models/monitoring_insights_status.rb +1 -1
- data/lib/plaid/models/monitoring_item_status_code.rb +1 -1
- data/lib/plaid/models/monitoring_loan_insights.rb +1 -1
- data/lib/plaid/models/monthly_average.rb +1 -1
- data/lib/plaid/models/monthly_summary.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/negative_balance_insights.rb +1 -1
- data/lib/plaid/models/negative_balance_occurrence.rb +1 -1
- data/lib/plaid/models/net_pay.rb +1 -1
- data/lib/plaid/models/network_insights_version.rb +1 -1
- data/lib/plaid/models/network_status_get_request.rb +1 -1
- data/lib/plaid/models/network_status_get_response.rb +1 -1
- data/lib/plaid/models/network_status_get_response_layer.rb +1 -1
- data/lib/plaid/models/network_status_get_response_network_status.rb +1 -1
- data/lib/plaid/models/network_status_get_user.rb +1 -1
- data/lib/plaid/models/new_accounts_available_webhook.rb +1 -1
- data/lib/plaid/models/numbers.rb +4 -4
- 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 +4 -4
- data/lib/plaid/models/numbers_bacs_nullable.rb +4 -4
- 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 +2 -2
- data/lib/plaid/models/numbers_international_iban.rb +1 -1
- data/lib/plaid/models/numbers_international_nullable.rb +2 -2
- data/lib/plaid/models/numbers_retirement401k.rb +1 -1
- data/lib/plaid/models/o_auth_error_code.rb +1 -1
- data/lib/plaid/models/o_auth_error_response.rb +1 -1
- data/lib/plaid/models/o_auth_grant_type.rb +1 -1
- data/lib/plaid/models/o_auth_introspect_request.rb +1 -1
- data/lib/plaid/models/o_auth_introspect_response.rb +1 -1
- data/lib/plaid/models/o_auth_revoke_request.rb +1 -1
- data/lib/plaid/models/o_auth_revoke_response.rb +1 -1
- data/lib/plaid/models/o_auth_subject_token_type.rb +1 -1
- data/lib/plaid/models/o_auth_token_request.rb +2 -2
- data/lib/plaid/models/o_auth_token_response.rb +2 -2
- data/lib/plaid/models/omittable_transfer_type.rb +1 -1
- data/lib/plaid/models/option_contract.rb +1 -1
- data/lib/plaid/models/originating_fund_source.rb +1 -1
- data/lib/plaid/models/originator.rb +2 -2
- data/lib/plaid/models/originator_expected_transfer_frequency.rb +1 -1
- data/lib/plaid/models/other_account_subtype.rb +1 -1
- data/lib/plaid/models/other_filter.rb +1 -1
- data/lib/plaid/models/outlier_transactions_insights.rb +1 -1
- 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 +2 -2
- data/lib/plaid/models/partner_customer_create_response.rb +1 -1
- data/lib/plaid/models/partner_customer_enable_request.rb +1 -1
- data/lib/plaid/models/partner_customer_enable_response.rb +1 -1
- data/lib/plaid/models/partner_customer_get_request.rb +1 -1
- data/lib/plaid/models/partner_customer_get_response.rb +1 -1
- data/lib/plaid/models/partner_customer_o_auth_institutions_get_request.rb +1 -1
- data/lib/plaid/models/partner_customer_o_auth_institutions_get_response.rb +1 -1
- data/lib/plaid/models/partner_customer_remove_request.rb +1 -1
- data/lib/plaid/models/partner_customer_remove_response.rb +1 -1
- data/lib/plaid/models/partner_end_customer.rb +1 -1
- data/lib/plaid/models/partner_end_customer_address.rb +1 -1
- data/lib/plaid/models/partner_end_customer_assets_under_management.rb +1 -1
- data/lib/plaid/models/partner_end_customer_bank_addendum_acceptance.rb +1 -1
- data/lib/plaid/models/partner_end_customer_billing_contact.rb +1 -1
- data/lib/plaid/models/partner_end_customer_cra_purposes.rb +1 -1
- data/lib/plaid/models/partner_end_customer_cra_questionnaire.rb +1 -1
- data/lib/plaid/models/partner_end_customer_cra_use_case.rb +1 -1
- data/lib/plaid/models/partner_end_customer_cra_use_cases.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_questionnaires.rb +1 -1
- data/lib/plaid/models/partner_end_customer_requirement_due.rb +1 -1
- data/lib/plaid/models/partner_end_customer_secrets.rb +1 -1
- data/lib/plaid/models/partner_end_customer_status.rb +1 -1
- data/lib/plaid/models/partner_end_customer_technical_contact.rb +1 -1
- data/lib/plaid/models/partner_end_customer_with_secrets.rb +1 -1
- data/lib/plaid/models/partner_end_customer_with_secrets_all_of.rb +1 -1
- data/lib/plaid/models/party.rb +1 -1
- data/lib/plaid/models/party_individual.rb +1 -1
- data/lib/plaid/models/party_role_type.rb +1 -1
- data/lib/plaid/models/pay.rb +1 -1
- data/lib/plaid/models/pay_frequency.rb +1 -1
- data/lib/plaid/models/pay_frequency_value.rb +1 -1
- data/lib/plaid/models/pay_period_details.rb +1 -1
- data/lib/plaid/models/pay_period_details_pay_frequency.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 +2 -2
- data/lib/plaid/models/payment_initiation_consent_payer_details.rb +1 -1
- data/lib/plaid/models/payment_initiation_consent_payer_numbers.rb +2 -2
- 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_processing_mode.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 +2 -2
- 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_consent_status_update_webhook.rb +1 -1
- data/lib/plaid/models/payment_initiation_consent_type.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 +2 -2
- 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 +2 -2
- 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 +2 -2
- data/lib/plaid/models/payment_initiation_recipient_create_response.rb +2 -2
- 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_deductions.rb +1 -1
- data/lib/plaid/models/paystub_override_deductions_breakdown.rb +1 -1
- data/lib/plaid/models/paystub_override_deductions_total.rb +1 -1
- data/lib/plaid/models/paystub_override_distribution_breakdown.rb +1 -1
- data/lib/plaid/models/paystub_override_earnings.rb +1 -1
- data/lib/plaid/models/paystub_override_earnings_breakdown.rb +1 -1
- data/lib/plaid/models/paystub_override_earnings_total.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_override_employer_address.rb +1 -1
- data/lib/plaid/models/paystub_override_net_pay.rb +1 -1
- data/lib/plaid/models/paystub_override_pay_period_details.rb +1 -1
- data/lib/plaid/models/paystub_override_taxpayer_id.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_disconnect_webhook.rb +2 -2
- data/lib/plaid/models/pending_disconnect_webhook_reason.rb +1 -1
- data/lib/plaid/models/pending_expiration_webhook.rb +2 -2
- data/lib/plaid/models/personal_finance_category.rb +2 -2
- data/lib/plaid/models/personal_finance_category_version.rb +1 -1
- data/lib/plaid/models/phone_number.rb +1 -1
- data/lib/plaid/models/phone_number_match_score.rb +1 -1
- data/lib/plaid/models/phone_type.rb +1 -1
- data/lib/plaid/models/physical_document_category.rb +1 -1
- data/lib/plaid/models/physical_document_extracted_data.rb +1 -1
- data/lib/plaid/models/physical_document_extracted_data_analysis.rb +1 -1
- data/lib/plaid/models/physical_document_images.rb +1 -1
- data/lib/plaid/models/plaid_error.rb +2 -2
- data/lib/plaid/models/plaid_error_type.rb +3 -1
- data/lib/plaid/models/plaid_lend_score_version.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/prism_cash_score.rb +1 -1
- data/lib/plaid/models/prism_cash_score_metadata.rb +1 -1
- data/lib/plaid/models/prism_cash_score_version.rb +1 -1
- data/lib/plaid/models/prism_detect.rb +1 -1
- data/lib/plaid/models/prism_detect_version.rb +1 -1
- data/lib/plaid/models/prism_extend.rb +1 -1
- data/lib/plaid/models/prism_extend_version.rb +1 -1
- data/lib/plaid/models/prism_first_detect.rb +1 -1
- data/lib/plaid/models/prism_first_detect_version.rb +1 -1
- data/lib/plaid/models/prism_insights.rb +13 -3
- data/lib/plaid/models/prism_insights_version.rb +1 -1
- data/lib/plaid/models/prism_versions.rb +1 -1
- data/lib/plaid/models/prism_versions_deprecated.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 +2 -2
- 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 +3 -3
- 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_investments_auth_get_request.rb +1 -1
- data/lib/plaid/models/processor_investments_auth_get_response.rb +1 -1
- data/lib/plaid/models/processor_investments_holdings_get_request.rb +1 -1
- data/lib/plaid/models/processor_investments_holdings_get_response.rb +2 -2
- data/lib/plaid/models/processor_investments_transactions_get_request.rb +1 -1
- data/lib/plaid/models/processor_investments_transactions_get_response.rb +1 -1
- data/lib/plaid/models/processor_liabilities_get_request.rb +1 -1
- data/lib/plaid/models/processor_liabilities_get_response.rb +1 -1
- data/lib/plaid/models/processor_number.rb +2 -2
- 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 +3 -3
- data/lib/plaid/models/processor_signal_evaluate_response.rb +1 -1
- data/lib/plaid/models/processor_signal_prepare_request.rb +1 -1
- data/lib/plaid/models/processor_signal_prepare_response.rb +1 -1
- 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 +3 -3
- data/lib/plaid/models/processor_stripe_bank_account_token_create_response.rb +2 -2
- data/lib/plaid/models/processor_sync_updates_available_webhook.rb +1 -1
- data/lib/plaid/models/processor_token_create_request.rb +4 -4
- 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 +1 -1
- data/lib/plaid/models/processor_transactions_get_request_options.rb +1 -1
- data/lib/plaid/models/processor_transactions_get_response.rb +1 -1
- data/lib/plaid/models/processor_transactions_recurring_get_request.rb +1 -1
- 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 +2 -2
- data/lib/plaid/models/processor_transactions_sync_response.rb +2 -2
- 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 +2 -1
- data/lib/plaid/models/products_terminate_reason_code.rb +50 -0
- data/lib/plaid/models/profile_network_status_get_request.rb +1 -1
- data/lib/plaid/models/profile_network_status_get_response.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/protect_bank_account.rb +1 -1
- data/lib/plaid/models/protect_compute_request.rb +2 -2
- data/lib/plaid/models/protect_compute_response.rb +14 -4
- data/lib/plaid/models/protect_compute_subscores.rb +288 -0
- data/lib/plaid/models/protect_event.rb +1 -1
- data/lib/plaid/models/protect_event_get_request.rb +1 -1
- data/lib/plaid/models/protect_event_get_response.rb +2 -2
- data/lib/plaid/models/protect_event_send_request.rb +1 -1
- data/lib/plaid/models/protect_event_send_response.rb +2 -2
- data/lib/plaid/models/protect_incident_amount.rb +1 -1
- data/lib/plaid/models/protect_incident_event.rb +17 -6
- data/lib/plaid/models/protect_incident_event_response.rb +1 -1
- data/lib/plaid/models/protect_link_model_inputs.rb +1 -1
- data/lib/plaid/models/protect_model_inputs.rb +2 -2
- data/lib/plaid/models/protect_report.rb +1 -1
- data/lib/plaid/models/protect_report_confidence.rb +1 -1
- data/lib/plaid/models/protect_report_create_request.rb +2 -19
- data/lib/plaid/models/protect_report_create_response.rb +1 -1
- data/lib/plaid/models/protect_report_source.rb +1 -1
- data/lib/plaid/models/protect_report_type.rb +1 -1
- data/lib/plaid/models/protect_sdk_model_inputs.rb +1 -1
- data/lib/plaid/models/protect_user.rb +3 -3
- data/lib/plaid/models/protect_user_event_webhook.rb +2 -2
- data/lib/plaid/models/protect_user_insights_get_request.rb +1 -1
- data/lib/plaid/models/protect_user_insights_get_response.rb +1 -1
- data/lib/plaid/models/provider_business_address.rb +1 -1
- data/lib/plaid/models/provider_business_name.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/reason_code.rb +1 -1
- data/lib/plaid/models/recaptcha_required_error.rb +5 -24
- data/lib/plaid/models/recipient_bacs.rb +2 -2
- data/lib/plaid/models/recipient_bacs_nullable.rb +2 -2
- data/lib/plaid/models/recommendation_string.rb +1 -1
- data/lib/plaid/models/recurring_cancelled_webhook.rb +2 -2
- data/lib/plaid/models/recurring_insights_stream.rb +1 -1
- data/lib/plaid/models/recurring_new_transfer_webhook.rb +3 -3
- data/lib/plaid/models/recurring_transaction_frequency.rb +1 -1
- data/lib/plaid/models/recurring_transactions.rb +1 -1
- data/lib/plaid/models/recurring_transactions_update_webhook.rb +1 -1
- data/lib/plaid/models/recurring_transfer.rb +4 -4
- data/lib/plaid/models/recurring_transfer_nullable.rb +4 -4
- data/lib/plaid/models/recurring_transfer_skipped_webhook.rb +2 -2
- data/lib/plaid/models/refresh_result.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 +2 -2
- data/lib/plaid/models/request_business_address.rb +1 -1
- data/lib/plaid/models/response_business_address.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 +44 -2
- 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_includes_date_of_birth.rb +40 -0
- data/lib/plaid/models/risk_check_email_is_deliverable_status.rb +1 -1
- data/lib/plaid/models/risk_check_email_is_edu.rb +40 -0
- data/lib/plaid/models/risk_check_email_name.rb +43 -0
- data/lib/plaid/models/risk_check_email_top_level_domain_is_suspicious.rb +1 -1
- data/lib/plaid/models/risk_check_facial_duplicate.rb +2 -2
- 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_network.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_indicators.rb +1 -1
- data/lib/plaid/models/risk_level.rb +1 -1
- data/lib/plaid/models/risk_level_with_no_data.rb +1 -1
- data/lib/plaid/models/risk_profile.rb +2 -2
- data/lib/plaid/models/risk_reason.rb +2 -2
- 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/risk_signal_document_type.rb +1 -1
- data/lib/plaid/models/risk_signal_file_type.rb +1 -1
- data/lib/plaid/models/role.rb +2 -2
- data/lib/plaid/models/role_detail.rb +1 -1
- data/lib/plaid/models/roles.rb +1 -1
- data/lib/plaid/models/rule_details.rb +2 -2
- data/lib/plaid/models/rule_result.rb +1 -1
- data/lib/plaid/models/ruleset.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 +2 -2
- data/lib/plaid/models/sandbox_bank_transfer_simulate_response.rb +1 -1
- data/lib/plaid/models/sandbox_cra_cashflow_updates_update_request.rb +4 -4
- data/lib/plaid/models/sandbox_cra_cashflow_updates_update_response.rb +1 -1
- data/lib/plaid/models/sandbox_income_fire_webhook_request.rb +1 -1
- data/lib/plaid/models/sandbox_income_fire_webhook_response.rb +1 -1
- data/lib/plaid/models/sandbox_income_webhook_fire_request_webhook_code.rb +1 -1
- data/lib/plaid/models/{network_insights_report_get_request.rb → sandbox_item_application_seed_request.rb} +31 -18
- data/lib/plaid/models/{network_insights_report_get_response.rb → sandbox_item_application_seed_response.rb} +16 -15
- data/lib/plaid/models/sandbox_item_fire_webhook_request.rb +2 -2
- data/lib/plaid/models/sandbox_item_fire_webhook_response.rb +1 -1
- data/lib/plaid/models/sandbox_item_reset_login_request.rb +2 -2
- data/lib/plaid/models/sandbox_item_reset_login_response.rb +1 -1
- data/lib/plaid/models/sandbox_item_set_verification_status_request.rb +2 -2
- 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_payment_simulate_request.rb +1 -1
- data/lib/plaid/models/sandbox_payment_simulate_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 +3 -3
- 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_statements.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_transactions_create_request.rb +2 -2
- data/lib/plaid/models/sandbox_transactions_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 +2 -2
- data/lib/plaid/models/sandbox_transfer_ledger_deposit_simulate_response.rb +1 -1
- data/lib/plaid/models/sandbox_transfer_ledger_simulate_available_request.rb +2 -2
- data/lib/plaid/models/sandbox_transfer_ledger_simulate_available_response.rb +1 -1
- data/lib/plaid/models/sandbox_transfer_ledger_withdraw_simulate_request.rb +2 -2
- data/lib/plaid/models/sandbox_transfer_ledger_withdraw_simulate_response.rb +1 -1
- data/lib/plaid/models/sandbox_transfer_refund_simulate_request.rb +3 -3
- data/lib/plaid/models/sandbox_transfer_refund_simulate_response.rb +1 -1
- data/lib/plaid/models/sandbox_transfer_repayment_simulate_request.rb +1 -1
- data/lib/plaid/models/sandbox_transfer_repayment_simulate_response.rb +1 -1
- data/lib/plaid/models/sandbox_transfer_rfp_simulate_action.rb +1 -1
- data/lib/plaid/models/sandbox_transfer_rfp_simulate_request.rb +2 -2
- data/lib/plaid/models/sandbox_transfer_rfp_simulate_response.rb +1 -1
- data/lib/plaid/models/sandbox_transfer_simulate_request.rb +3 -3
- data/lib/plaid/models/sandbox_transfer_simulate_response.rb +1 -1
- data/lib/plaid/models/sandbox_transfer_sweep_simulate_request.rb +2 -2
- data/lib/plaid/models/sandbox_transfer_sweep_simulate_response.rb +1 -1
- data/lib/plaid/models/sandbox_transfer_test_clock_advance_request.rb +2 -2
- 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 +2 -2
- 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/sandbox_user_reset_login_request.rb +3 -3
- data/lib/plaid/models/sandbox_user_reset_login_response.rb +1 -1
- data/lib/plaid/models/scopes.rb +1 -1
- data/lib/plaid/models/scopes_context.rb +1 -1
- data/lib/plaid/models/scopes_nullable.rb +1 -1
- data/lib/plaid/models/screening_hit_analysis.rb +2 -2
- data/lib/plaid/models/screening_hit_data.rb +1 -1
- data/lib/plaid/models/screening_hit_date_of_birth_item.rb +1 -1
- data/lib/plaid/models/screening_hit_documents_items.rb +1 -1
- data/lib/plaid/models/screening_hit_names_items.rb +1 -1
- data/lib/plaid/models/screening_status_updated_webhook.rb +1 -1
- data/lib/plaid/models/security.rb +2 -2
- data/lib/plaid/models/security_override.rb +2 -2
- data/lib/plaid/models/selfie_age_check.rb +288 -0
- data/lib/plaid/models/selfie_age_check_status.rb +41 -0
- data/lib/plaid/models/selfie_analysis.rb +12 -2
- data/lib/plaid/models/selfie_analysis_document_comparison.rb +1 -1
- data/lib/plaid/models/selfie_analysis_facial_analysis.rb +1 -1
- data/lib/plaid/models/selfie_analysis_facial_analysis_outcome.rb +1 -1
- data/lib/plaid/models/selfie_analysis_liveness_check.rb +1 -1
- data/lib/plaid/models/selfie_capture.rb +4 -4
- 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 +2 -2
- data/lib/plaid/models/service.rb +1 -1
- data/lib/plaid/models/service_product_fulfillment.rb +1 -1
- data/lib/plaid/models/service_product_fulfillment_detail.rb +1 -1
- data/lib/plaid/models/service_product_fulfillment_identifier.rb +1 -1
- data/lib/plaid/models/servicer_address_data.rb +1 -1
- data/lib/plaid/models/services.rb +1 -1
- data/lib/plaid/models/session_token_create_request.rb +2 -2
- data/lib/plaid/models/session_token_create_request_user.rb +1 -1
- data/lib/plaid/models/session_token_create_response.rb +1 -1
- data/lib/plaid/models/session_token_create_response_link.rb +2 -2
- 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 +3 -3
- data/lib/plaid/models/signal_evaluate_request.rb +2 -2
- 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 +2 -2
- 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_schedule_default_payment_method.rb +1 -1
- data/lib/plaid/models/signal_schedule_recommendation.rb +1 -1
- data/lib/plaid/models/signal_schedule_request.rb +2 -2
- data/lib/plaid/models/signal_schedule_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 +2 -2
- data/lib/plaid/models/simulated_transfer_sweep.rb +2 -2
- data/lib/plaid/models/single_document_risk_signal.rb +1 -1
- data/lib/plaid/models/sms_verification.rb +1 -1
- data/lib/plaid/models/sms_verification_status.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 +2 -2
- data/lib/plaid/models/statements_list_request.rb +2 -2
- data/lib/plaid/models/statements_list_response.rb +1 -1
- data/lib/plaid/models/statements_refresh_complete_result.rb +1 -1
- data/lib/plaid/models/statements_refresh_complete_webhook.rb +1 -1
- data/lib/plaid/models/statements_refresh_request.rb +2 -2
- data/lib/plaid/models/statements_refresh_response.rb +1 -1
- data/lib/plaid/models/statements_statement.rb +2 -2
- data/lib/plaid/models/status.rb +2 -2
- data/lib/plaid/models/statuses.rb +1 -1
- data/lib/plaid/models/strategy.rb +1 -1
- data/lib/plaid/models/student_loan.rb +2 -2
- 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_failure.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/synthetic_fraud.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/total_inflow_amount.rb +1 -1
- data/lib/plaid/models/total_inflow_amount30d.rb +1 -1
- data/lib/plaid/models/total_inflow_amount60d.rb +1 -1
- data/lib/plaid/models/total_inflow_amount90d.rb +1 -1
- data/lib/plaid/models/total_monthly_income_insights.rb +2 -2
- data/lib/plaid/models/total_outflow_amount.rb +1 -1
- data/lib/plaid/models/total_outflow_amount30d.rb +1 -1
- data/lib/plaid/models/total_outflow_amount60d.rb +1 -1
- data/lib/plaid/models/total_outflow_amount90d.rb +1 -1
- data/lib/plaid/models/total_report_inflow_amount.rb +1 -1
- data/lib/plaid/models/total_report_inflow_amount30d.rb +1 -1
- data/lib/plaid/models/total_report_inflow_amount60d.rb +1 -1
- data/lib/plaid/models/total_report_inflow_amount90d.rb +2 -2
- data/lib/plaid/models/total_report_outflow_amount.rb +1 -1
- data/lib/plaid/models/total_report_outflow_amount30d.rb +1 -1
- data/lib/plaid/models/total_report_outflow_amount60d.rb +1 -1
- data/lib/plaid/models/total_report_outflow_amount90d.rb +1 -1
- data/lib/plaid/models/transaction.rb +1 -1
- data/lib/plaid/models/transaction_all_of.rb +1 -1
- data/lib/plaid/models/transaction_base.rb +1 -1
- data/lib/plaid/models/transaction_code.rb +3 -1
- data/lib/plaid/models/transaction_counterparty.rb +2 -2
- data/lib/plaid/models/transaction_data.rb +1 -1
- data/lib/plaid/models/transaction_override.rb +1 -1
- data/lib/plaid/models/transaction_stream.rb +1 -1
- data/lib/plaid/models/transaction_stream_amount.rb +1 -1
- data/lib/plaid/models/transaction_stream_status.rb +1 -1
- data/lib/plaid/models/transactions_category_rule.rb +1 -1
- data/lib/plaid/models/transactions_enhance_get_request.rb +2 -2
- data/lib/plaid/models/transactions_enhance_get_response.rb +1 -1
- data/lib/plaid/models/transactions_enrich_request.rb +1 -1
- data/lib/plaid/models/transactions_enrich_request_options.rb +1 -1
- data/lib/plaid/models/transactions_enrich_response.rb +1 -1
- data/lib/plaid/models/transactions_get_request.rb +2 -2
- data/lib/plaid/models/transactions_get_request_options.rb +2 -2
- data/lib/plaid/models/transactions_get_response.rb +1 -1
- data/lib/plaid/models/transactions_recurring_create_input.rb +1 -1
- data/lib/plaid/models/transactions_recurring_create_request.rb +2 -2
- data/lib/plaid/models/transactions_recurring_create_response.rb +1 -1
- data/lib/plaid/models/transactions_recurring_get_request.rb +2 -2
- data/lib/plaid/models/transactions_recurring_get_request_options.rb +1 -1
- data/lib/plaid/models/transactions_recurring_get_response.rb +1 -1
- data/lib/plaid/models/transactions_recurring_merge_input.rb +1 -1
- data/lib/plaid/models/transactions_recurring_merge_request.rb +2 -2
- data/lib/plaid/models/transactions_recurring_merge_response.rb +1 -1
- data/lib/plaid/models/transactions_recurring_update_input.rb +1 -1
- data/lib/plaid/models/transactions_recurring_update_request.rb +2 -2
- data/lib/plaid/models/transactions_recurring_update_response.rb +1 -1
- data/lib/plaid/models/transactions_refresh_request.rb +2 -2
- data/lib/plaid/models/transactions_refresh_response.rb +1 -1
- data/lib/plaid/models/transactions_removed_webhook.rb +1 -1
- data/lib/plaid/models/transactions_rule_details.rb +1 -1
- data/lib/plaid/models/transactions_rule_field.rb +1 -1
- data/lib/plaid/models/transactions_rule_type.rb +1 -1
- data/lib/plaid/models/transactions_rules_create_request.rb +1 -1
- data/lib/plaid/models/transactions_rules_create_response.rb +1 -1
- data/lib/plaid/models/transactions_rules_list_request.rb +1 -1
- data/lib/plaid/models/transactions_rules_list_response.rb +1 -1
- data/lib/plaid/models/transactions_rules_remove_request.rb +1 -1
- data/lib/plaid/models/transactions_rules_remove_response.rb +1 -1
- data/lib/plaid/models/transactions_sync_request.rb +2 -2
- data/lib/plaid/models/transactions_sync_request_options.rb +2 -2
- data/lib/plaid/models/transactions_sync_response.rb +2 -2
- data/lib/plaid/models/transactions_update_status.rb +1 -1
- data/lib/plaid/models/transactions_user_insights_get_request.rb +1 -1
- data/lib/plaid/models/transactions_user_insights_get_response.rb +1 -1
- data/lib/plaid/models/transfer.rb +22 -8
- data/lib/plaid/models/transfer_ach_network.rb +1 -1
- data/lib/plaid/models/transfer_authorization.rb +18 -4
- data/lib/plaid/models/transfer_authorization_cancel_request.rb +2 -2
- data/lib/plaid/models/transfer_authorization_cancel_response.rb +1 -1
- data/lib/plaid/models/transfer_authorization_create_request.rb +30 -8
- 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 +2 -2
- data/lib/plaid/models/transfer_authorization_proposed_transfer.rb +18 -3
- data/lib/plaid/models/transfer_authorization_risk_level.rb +1 -1
- 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 +2 -2
- data/lib/plaid/models/transfer_cancel_response.rb +1 -1
- data/lib/plaid/models/transfer_capabilities_get_request.rb +1 -1
- data/lib/plaid/models/transfer_capabilities_get_response.rb +1 -1
- data/lib/plaid/models/transfer_capabilities_get_rf_p.rb +1 -1
- data/lib/plaid/models/transfer_capabilities_get_rtp.rb +1 -1
- data/lib/plaid/models/transfer_configuration_get_request.rb +1 -1
- data/lib/plaid/models/transfer_configuration_get_response.rb +1 -1
- data/lib/plaid/models/transfer_create_request.rb +5 -5
- 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 +5 -5
- data/lib/plaid/models/transfer_debit_usage_configuration.rb +5 -5
- data/lib/plaid/models/transfer_device.rb +1 -1
- data/lib/plaid/models/transfer_diligence_document_upload_request.rb +1 -1
- 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 +6 -6
- data/lib/plaid/models/transfer_event_list_request.rb +3 -3
- 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_funding_account_with_display_name.rb +2 -2
- data/lib/plaid/models/transfer_funding_account_with_display_name_all_of.rb +1 -1
- data/lib/plaid/models/transfer_get_request.rb +3 -3
- data/lib/plaid/models/transfer_get_response.rb +1 -1
- data/lib/plaid/models/transfer_guarantee_details.rb +243 -0
- data/lib/plaid/models/transfer_guarantee_outcome.rb +41 -0
- data/lib/plaid/models/transfer_guarantee_schedule_item.rb +260 -0
- data/lib/plaid/models/transfer_guarantee_schedule_item_all_of.rb +221 -0
- 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 +2 -2
- 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 +2 -2
- data/lib/plaid/models/transfer_ledger_deposit_response.rb +1 -1
- data/lib/plaid/models/transfer_ledger_distribute_request.rb +1 -1
- data/lib/plaid/models/transfer_ledger_distribute_response.rb +1 -1
- data/lib/plaid/models/transfer_ledger_event.rb +1 -1
- data/lib/plaid/models/transfer_ledger_event_list_request.rb +1 -1
- data/lib/plaid/models/transfer_ledger_event_list_response.rb +1 -1
- 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 +2 -2
- 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_authorization_usage.rb +1 -1
- data/lib/plaid/models/transfer_metrics_get_request.rb +1 -1
- data/lib/plaid/models/transfer_metrics_get_response.rb +1 -1
- data/lib/plaid/models/transfer_metrics_get_return_rates.rb +1 -1
- data/lib/plaid/models/transfer_metrics_get_return_rates_over_interval.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 +1 -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_create_request.rb +1 -1
- data/lib/plaid/models/transfer_originator_funding_account_create_response.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_platform_onboarding_update_webhook.rb +1 -1
- data/lib/plaid/models/transfer_platform_originator_create_request.rb +1 -1
- data/lib/plaid/models/transfer_platform_originator_create_response.rb +1 -1
- data/lib/plaid/models/transfer_platform_person_address.rb +1 -1
- data/lib/plaid/models/transfer_platform_person_create_request.rb +1 -1
- data/lib/plaid/models/transfer_platform_person_create_response.rb +1 -1
- data/lib/plaid/models/transfer_platform_person_id_number.rb +1 -1
- data/lib/plaid/models/transfer_platform_person_name.rb +1 -1
- data/lib/plaid/models/transfer_platform_requirement.rb +1 -1
- data/lib/plaid/models/transfer_platform_requirement_submission.rb +1 -1
- data/lib/plaid/models/transfer_platform_requirement_submit_request.rb +1 -1
- data/lib/plaid/models/transfer_platform_requirement_submit_response.rb +1 -1
- data/lib/plaid/models/transfer_platform_tos_acceptance_metadata.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 +2 -2
- data/lib/plaid/models/transfer_recurring_cancel_response.rb +1 -1
- data/lib/plaid/models/transfer_recurring_create_request.rb +2 -2
- data/lib/plaid/models/transfer_recurring_create_response.rb +1 -1
- data/lib/plaid/models/transfer_recurring_get_request.rb +2 -2
- 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_network.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 +3 -3
- data/lib/plaid/models/transfer_refund_cancel_request.rb +2 -2
- 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 +2 -2
- 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 +2 -2
- 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 +2 -2
- 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 +2 -2
- 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 +2 -2
- 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/transfer_wire_details.rb +1 -1
- data/lib/plaid/models/trust_index.rb +1 -1
- data/lib/plaid/models/trust_index_subscore.rb +1 -1
- data/lib/plaid/models/trust_index_subscores.rb +1 -1
- data/lib/plaid/models/trusted_device_data.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_account_identity.rb +3 -3
- data/lib/plaid/models/user_account_identity_address.rb +1 -1
- data/lib/plaid/models/user_account_identity_edit_counts.rb +1 -1
- data/lib/plaid/models/user_account_identity_edit_history.rb +1 -1
- data/lib/plaid/models/user_account_identity_name.rb +1 -1
- data/lib/plaid/models/user_account_identity_official_document.rb +1 -1
- data/lib/plaid/models/user_account_item.rb +2 -2
- data/lib/plaid/models/user_account_revoked_webhook.rb +1 -1
- data/lib/plaid/models/user_account_session_event.rb +1 -1
- data/lib/plaid/models/user_account_session_event_send_request.rb +1 -1
- data/lib/plaid/models/user_account_session_event_send_response.rb +1 -1
- data/lib/plaid/models/user_account_session_get_request.rb +1 -1
- data/lib/plaid/models/user_account_session_get_response.rb +1 -1
- data/lib/plaid/models/user_address.rb +1 -1
- data/lib/plaid/models/user_based_products.rb +1 -1
- data/lib/plaid/models/user_create_request.rb +2 -2
- data/lib/plaid/models/user_create_response.rb +3 -3
- data/lib/plaid/models/user_custom_password.rb +1 -1
- data/lib/plaid/models/user_data_overview.rb +1 -1
- data/lib/plaid/models/user_financial_data_refresh_request.rb +1 -1
- data/lib/plaid/models/user_financial_data_refresh_response.rb +1 -1
- data/lib/plaid/models/user_get_request.rb +2 -2
- data/lib/plaid/models/user_get_response.rb +2 -2
- data/lib/plaid/models/user_id_number.rb +2 -2
- data/lib/plaid/models/user_identity_remove_request.rb +2 -2
- data/lib/plaid/models/user_identity_remove_response.rb +1 -1
- data/lib/plaid/models/user_items_associate_request.rb +2 -2
- data/lib/plaid/models/user_items_associate_response.rb +1 -1
- data/lib/plaid/models/user_items_get_request.rb +3 -3
- data/lib/plaid/models/user_items_get_response.rb +1 -1
- data/lib/plaid/models/user_items_remove_request.rb +3 -3
- data/lib/plaid/models/user_items_remove_response.rb +1 -1
- data/lib/plaid/models/user_permission_revoked_webhook.rb +2 -2
- data/lib/plaid/models/user_products_terminate_reason_code.rb +218 -0
- data/lib/plaid/models/user_products_terminate_request.rb +42 -12
- data/lib/plaid/models/user_products_terminate_response.rb +1 -1
- data/lib/plaid/models/user_remove_request.rb +3 -3
- data/lib/plaid/models/user_remove_response.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_third_party_token_create_request.rb +3 -3
- data/lib/plaid/models/user_third_party_token_create_response.rb +1 -1
- data/lib/plaid/models/user_third_party_token_remove_request.rb +1 -1
- data/lib/plaid/models/user_third_party_token_remove_response.rb +1 -1
- data/lib/plaid/models/user_transactions_refresh_request.rb +1 -1
- data/lib/plaid/models/user_transactions_refresh_response.rb +1 -1
- data/lib/plaid/models/user_update_request.rb +3 -3
- 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 +1 -1
- data/lib/plaid/models/verification_of_asset.rb +1 -1
- data/lib/plaid/models/verification_of_asset_response.rb +1 -1
- data/lib/plaid/models/verification_refresh_status.rb +1 -1
- data/lib/plaid/models/verification_status.rb +1 -1
- data/lib/plaid/models/verify_sms_details.rb +1 -1
- data/lib/plaid/models/verify_sms_details_status.rb +1 -1
- data/lib/plaid/models/w2.rb +4 -4
- data/lib/plaid/models/w2_box12.rb +1 -1
- data/lib/plaid/models/w2_box12_override.rb +1 -1
- data/lib/plaid/models/w2_override.rb +4 -4
- data/lib/plaid/models/w2_state_and_local_wages.rb +1 -1
- data/lib/plaid/models/w2_state_and_local_wages_override.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 +2 -2
- 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 +3 -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_payee_verification_status.rb +1 -1
- data/lib/plaid/models/wallet_transaction_relation.rb +1 -1
- data/lib/plaid/models/wallet_transaction_status.rb +1 -1
- data/lib/plaid/models/wallet_transaction_status_update_webhook.rb +12 -2
- 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 +2 -2
- 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 +2 -2
- data/lib/plaid/models/watchlist_screening_entity_get_request.rb +1 -1
- data/lib/plaid/models/watchlist_screening_entity_get_response.rb +2 -2
- data/lib/plaid/models/watchlist_screening_entity_history_list_request.rb +1 -1
- data/lib/plaid/models/watchlist_screening_entity_history_list_response.rb +1 -1
- data/lib/plaid/models/watchlist_screening_entity_hit_list_request.rb +1 -1
- data/lib/plaid/models/watchlist_screening_entity_hit_list_response.rb +1 -1
- data/lib/plaid/models/watchlist_screening_entity_list_request.rb +2 -2
- data/lib/plaid/models/watchlist_screening_entity_list_response.rb +1 -1
- data/lib/plaid/models/watchlist_screening_entity_program_get_request.rb +1 -1
- data/lib/plaid/models/watchlist_screening_entity_program_get_response.rb +1 -1
- data/lib/plaid/models/watchlist_screening_entity_program_list_request.rb +1 -1
- data/lib/plaid/models/watchlist_screening_entity_program_list_response.rb +1 -1
- data/lib/plaid/models/watchlist_screening_entity_review_create_request.rb +2 -2
- data/lib/plaid/models/watchlist_screening_entity_review_create_response.rb +2 -2
- data/lib/plaid/models/watchlist_screening_entity_review_list_request.rb +1 -1
- data/lib/plaid/models/watchlist_screening_entity_review_list_response.rb +1 -1
- data/lib/plaid/models/watchlist_screening_entity_update_request.rb +2 -2
- data/lib/plaid/models/watchlist_screening_entity_update_request_resettable_field.rb +1 -1
- data/lib/plaid/models/watchlist_screening_entity_update_response.rb +2 -2
- data/lib/plaid/models/watchlist_screening_hit.rb +19 -2
- data/lib/plaid/models/watchlist_screening_hit_locations.rb +1 -1
- data/lib/plaid/models/watchlist_screening_hit_status.rb +1 -1
- data/lib/plaid/models/watchlist_screening_individual.rb +2 -2
- data/lib/plaid/models/watchlist_screening_individual_create_request.rb +1 -1
- data/lib/plaid/models/watchlist_screening_individual_create_response.rb +2 -2
- data/lib/plaid/models/watchlist_screening_individual_get_request.rb +1 -1
- data/lib/plaid/models/watchlist_screening_individual_get_response.rb +2 -2
- data/lib/plaid/models/watchlist_screening_individual_history_list_request.rb +1 -1
- data/lib/plaid/models/watchlist_screening_individual_history_list_response.rb +1 -1
- data/lib/plaid/models/watchlist_screening_individual_hit_list_request.rb +1 -1
- data/lib/plaid/models/watchlist_screening_individual_hit_list_response.rb +1 -1
- data/lib/plaid/models/watchlist_screening_individual_list_request.rb +3 -3
- 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 +2 -2
- data/lib/plaid/models/watchlist_screening_individual_review_create_response.rb +2 -2
- data/lib/plaid/models/watchlist_screening_individual_review_list_request.rb +1 -1
- data/lib/plaid/models/watchlist_screening_individual_review_list_response.rb +1 -1
- data/lib/plaid/models/watchlist_screening_individual_update_request.rb +2 -2
- data/lib/plaid/models/watchlist_screening_individual_update_request_resettable_field.rb +1 -1
- data/lib/plaid/models/watchlist_screening_individual_update_response.rb +2 -2
- data/lib/plaid/models/watchlist_screening_request_search_terms.rb +1 -1
- data/lib/plaid/models/watchlist_screening_review.rb +2 -2
- 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/yield_rate.rb +1 -1
- data/lib/plaid/models/yield_rate_type.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 +51 -8
- data/plaid.gemspec +1 -1
- metadata +52 -9
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.698.7
|
|
7
7
|
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
|
9
9
|
OpenAPI Generator version: 6.3.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, such as `/accounts/get`, return a balance object, `/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
|
|
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, `/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. Note: If you are getting real-time balance for the purpose of assessing the return risk of a proposed ACH transaction, it is recommended to use `/signal/evaluate` instead of `/accounts/balance/get`. `/signal/evaluate` returns the same real-time balance information and also provides access to Signal Rules, which provides no-code transaction business logic configuration, backtesting and recommendations for tuning your transaction acceptance logic, and the ability to easily switch between Balance and Signal Transaction Scores as needed for ultra-low-latency, ML-powered risk assessments. For more details, see the [Balance documentation](https://plaid.com/docs/balance/#balance-integration-options).
|
|
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, such as `/accounts/get`, return a balance object, `/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
|
|
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, `/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. Note: If you are getting real-time balance for the purpose of assessing the return risk of a proposed ACH transaction, it is recommended to use `/signal/evaluate` instead of `/accounts/balance/get`. `/signal/evaluate` returns the same real-time balance information and also provides access to Signal Rules, which provides no-code transaction business logic configuration, backtesting and recommendations for tuning your transaction acceptance logic, and the ability to easily switch between Balance and Signal Transaction Scores as needed for ultra-low-latency, ML-powered risk assessments. For more details, see the [Balance documentation](https://plaid.com/docs/balance/#balance-integration-options).
|
|
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
|
|
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. To return new accounts that were created after the user linked their Item, you can listen for 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 real-time balance information, use the paid endpoints `/accounts/balance/get` or `/signal/evaluate` 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
|
|
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. To return new accounts that were created after the user linked their Item, you can listen for 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 real-time balance information, use the paid endpoints `/accounts/balance/get` or `/signal/evaluate` 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
|
|
@@ -224,7 +224,7 @@ module Plaid
|
|
|
224
224
|
end
|
|
225
225
|
|
|
226
226
|
# Create Asset Report Audit Copy
|
|
227
|
-
# Plaid can provide an Audit Copy of any Asset Report directly to a participating third party on your behalf. For example, Plaid can supply an Audit Copy directly to the GSEs on your behalf if you participate in Fannie Mae's Day 1 Certainty™ program or utilize Freddie Mac
|
|
227
|
+
# Plaid can provide an Audit Copy of any Asset Report directly to a participating third party on your behalf. For example, Plaid can supply an Audit Copy directly to the GSEs on your behalf if you participate in Fannie Mae's Day 1 Certainty™ program or utilize Freddie Mac's Loan Product Advisor® (LPA®) Asset and Income Modeler (AIM). An Audit Copy contains the same underlying data as the Asset Report. To grant access to an Audit Copy, use the `/asset_report/audit_copy/create` endpoint to create an `audit_copy_token` and then pass that token to the third party who needs access. Each third party has its own `auditor_id`, for example `fannie_mae`. You'll need to create a separate Audit Copy for each third party to whom you want to grant access to the Report.
|
|
228
228
|
# @param asset_report_audit_copy_create_request [AssetReportAuditCopyCreateRequest]
|
|
229
229
|
# @param [Hash] opts the optional parameters
|
|
230
230
|
# @return [AssetReportAuditCopyCreateResponse]
|
|
@@ -234,7 +234,7 @@ module Plaid
|
|
|
234
234
|
end
|
|
235
235
|
|
|
236
236
|
# Create Asset Report Audit Copy
|
|
237
|
-
# Plaid can provide an Audit Copy of any Asset Report directly to a participating third party on your behalf. For example, Plaid can supply an Audit Copy directly to the GSEs on your behalf if you participate in Fannie Mae's Day 1 Certainty™ program or utilize Freddie Mac
|
|
237
|
+
# Plaid can provide an Audit Copy of any Asset Report directly to a participating third party on your behalf. For example, Plaid can supply an Audit Copy directly to the GSEs on your behalf if you participate in Fannie Mae's Day 1 Certainty™ program or utilize Freddie Mac's Loan Product Advisor® (LPA®) Asset and Income Modeler (AIM). An Audit Copy contains the same underlying data as the Asset Report. To grant access to an Audit Copy, use the `/asset_report/audit_copy/create` endpoint to create an `audit_copy_token` and then pass that token to the third party who needs access. Each third party has its own `auditor_id`, for example `fannie_mae`. You'll need to create a separate Audit Copy for each third party to whom you want to grant access to the Report.
|
|
238
238
|
# @param asset_report_audit_copy_create_request [AssetReportAuditCopyCreateRequest]
|
|
239
239
|
# @param [Hash] opts the optional parameters
|
|
240
240
|
# @return [Array<(AssetReportAuditCopyCreateResponse, Integer, Hash)>] AssetReportAuditCopyCreateResponse data, response status code and response headers
|
|
@@ -972,7 +972,7 @@ module Plaid
|
|
|
972
972
|
end
|
|
973
973
|
|
|
974
974
|
# Verify auth data
|
|
975
|
-
# The `/auth/verify` endpoint verifies bank account and routing numbers and (optionally) account owner names against Plaid's database via [Database Auth](https://plaid.com/docs/auth/coverage/database-auth/). It can be used to verify account numbers that were not collected via the Plaid Link flow. This endpoint is currently in Early Availability; contact
|
|
975
|
+
# The `/auth/verify` endpoint verifies bank account and routing numbers and (optionally) account owner names against Plaid's database via [Database Auth](https://plaid.com/docs/auth/coverage/database-auth/). It can be used to verify account numbers that were not collected via the Plaid Link flow. This endpoint is currently in Early Availability; contact sales or your Plaid account manager to request access.
|
|
976
976
|
# @param auth_verify_request [AuthVerifyRequest]
|
|
977
977
|
# @param [Hash] opts the optional parameters
|
|
978
978
|
# @return [AuthVerifyResponse]
|
|
@@ -982,7 +982,7 @@ module Plaid
|
|
|
982
982
|
end
|
|
983
983
|
|
|
984
984
|
# Verify auth data
|
|
985
|
-
# The `/auth/verify` endpoint verifies bank account and routing numbers and (optionally) account owner names against Plaid's database via [Database Auth](https://plaid.com/docs/auth/coverage/database-auth/). It can be used to verify account numbers that were not collected via the Plaid Link flow. This endpoint is currently in Early Availability; contact
|
|
985
|
+
# The `/auth/verify` endpoint verifies bank account and routing numbers and (optionally) account owner names against Plaid's database via [Database Auth](https://plaid.com/docs/auth/coverage/database-auth/). It can be used to verify account numbers that were not collected via the Plaid Link flow. This endpoint is currently in Early Availability; contact sales or your Plaid account manager to request access.
|
|
986
986
|
# @param auth_verify_request [AuthVerifyRequest]
|
|
987
987
|
# @param [Hash] opts the optional parameters
|
|
988
988
|
# @return [Array<(AuthVerifyResponse, Integer, Hash)>] AuthVerifyResponse data, response status code and response headers
|
|
@@ -1516,7 +1516,7 @@ module Plaid
|
|
|
1516
1516
|
end
|
|
1517
1517
|
|
|
1518
1518
|
# Migrate account into Bank Transfers
|
|
1519
|
-
# As an alternative to adding Items via Link, you can also use the `/bank_transfer/migrate_account` endpoint to migrate known account and routing numbers to Plaid Items. Note that Items created in this way are not compatible with endpoints for other products, such as `/accounts/balance/get`, and can only be used with Bank Transfer endpoints. If you require access to other endpoints, create the Item through Link instead. Access to `/bank_transfer/migrate_account` is not enabled by default; to obtain access, contact your Plaid
|
|
1519
|
+
# As an alternative to adding Items via Link, you can also use the `/bank_transfer/migrate_account` endpoint to migrate known account and routing numbers to Plaid Items. Note that Items created in this way are not compatible with endpoints for other products, such as `/accounts/balance/get`, and can only be used with Bank Transfer endpoints. If you require access to other endpoints, create the Item through Link instead. Access to `/bank_transfer/migrate_account` is not enabled by default; to obtain access, contact your Plaid account manager.
|
|
1520
1520
|
# @param bank_transfer_migrate_account_request [BankTransferMigrateAccountRequest]
|
|
1521
1521
|
# @param [Hash] opts the optional parameters
|
|
1522
1522
|
# @return [BankTransferMigrateAccountResponse]
|
|
@@ -1526,7 +1526,7 @@ module Plaid
|
|
|
1526
1526
|
end
|
|
1527
1527
|
|
|
1528
1528
|
# Migrate account into Bank Transfers
|
|
1529
|
-
# As an alternative to adding Items via Link, you can also use the `/bank_transfer/migrate_account` endpoint to migrate known account and routing numbers to Plaid Items. Note that Items created in this way are not compatible with endpoints for other products, such as `/accounts/balance/get`, and can only be used with Bank Transfer endpoints. If you require access to other endpoints, create the Item through Link instead. Access to `/bank_transfer/migrate_account` is not enabled by default; to obtain access, contact your Plaid
|
|
1529
|
+
# As an alternative to adding Items via Link, you can also use the `/bank_transfer/migrate_account` endpoint to migrate known account and routing numbers to Plaid Items. Note that Items created in this way are not compatible with endpoints for other products, such as `/accounts/balance/get`, and can only be used with Bank Transfer endpoints. If you require access to other endpoints, create the Item through Link instead. Access to `/bank_transfer/migrate_account` is not enabled by default; to obtain access, contact your Plaid account manager.
|
|
1530
1530
|
# @param bank_transfer_migrate_account_request [BankTransferMigrateAccountRequest]
|
|
1531
1531
|
# @param [Hash] opts the optional parameters
|
|
1532
1532
|
# @return [Array<(BankTransferMigrateAccountResponse, Integer, Hash)>] BankTransferMigrateAccountResponse data, response status code and response headers
|
|
@@ -1924,7 +1924,7 @@ module Plaid
|
|
|
1924
1924
|
end
|
|
1925
1925
|
|
|
1926
1926
|
# Get a Beacon Report
|
|
1927
|
-
# Returns a Beacon
|
|
1927
|
+
# Returns a Beacon Report for a given Beacon Report ID.
|
|
1928
1928
|
# @param beacon_report_get_request [BeaconReportGetRequest]
|
|
1929
1929
|
# @param [Hash] opts the optional parameters
|
|
1930
1930
|
# @return [BeaconReportGetResponse]
|
|
@@ -1934,7 +1934,7 @@ module Plaid
|
|
|
1934
1934
|
end
|
|
1935
1935
|
|
|
1936
1936
|
# Get a Beacon Report
|
|
1937
|
-
# Returns a Beacon
|
|
1937
|
+
# Returns a Beacon Report for a given Beacon Report ID.
|
|
1938
1938
|
# @param beacon_report_get_request [BeaconReportGetRequest]
|
|
1939
1939
|
# @param [Hash] opts the optional parameters
|
|
1940
1940
|
# @return [Array<(BeaconReportGetResponse, Integer, Hash)>] BeaconReportGetResponse data, response status code and response headers
|
|
@@ -2604,7 +2604,7 @@ module Plaid
|
|
|
2604
2604
|
end
|
|
2605
2605
|
|
|
2606
2606
|
# Get EWA Score Report
|
|
2607
|
-
# The `/beta/ewa_report/v1/get` endpoint provides an Earned Wage Access (EWA) score that quantifies the delinquency risk associated with a given item. The score is derived from a combination of cashflow patterns and network-based behavioral features. The response returns a list of EWA scores, where each score corresponds to a potential advance amount range. These scores estimate the likelihood of repayment for advances within that range. Score range: 1
|
|
2607
|
+
# The `/beta/ewa_report/v1/get` endpoint provides an Earned Wage Access (EWA) score that quantifies the delinquency risk associated with a given item. The score is derived from a combination of cashflow patterns and network-based behavioral features. The response returns a list of EWA scores, where each score corresponds to a potential advance amount range. These scores estimate the likelihood of repayment for advances within that range. Score range: 1-99 Interpretation: Higher scores indicate a greater likelihood of repayment. This endpoint enables clients to assess repayment risk and make data-driven decisions when determining eligibility or limits for earned wage advances.
|
|
2608
2608
|
# @param beta_ewa_report_v1_get_request [BetaEwaReportV1GetRequest]
|
|
2609
2609
|
# @param [Hash] opts the optional parameters
|
|
2610
2610
|
# @return [BetaEwaReportV1GetResponse]
|
|
@@ -2614,7 +2614,7 @@ module Plaid
|
|
|
2614
2614
|
end
|
|
2615
2615
|
|
|
2616
2616
|
# Get EWA Score Report
|
|
2617
|
-
# The `/beta/ewa_report/v1/get` endpoint provides an Earned Wage Access (EWA) score that quantifies the delinquency risk associated with a given item. The score is derived from a combination of cashflow patterns and network-based behavioral features. The response returns a list of EWA scores, where each score corresponds to a potential advance amount range. These scores estimate the likelihood of repayment for advances within that range. Score range: 1
|
|
2617
|
+
# The `/beta/ewa_report/v1/get` endpoint provides an Earned Wage Access (EWA) score that quantifies the delinquency risk associated with a given item. The score is derived from a combination of cashflow patterns and network-based behavioral features. The response returns a list of EWA scores, where each score corresponds to a potential advance amount range. These scores estimate the likelihood of repayment for advances within that range. Score range: 1-99 Interpretation: Higher scores indicate a greater likelihood of repayment. This endpoint enables clients to assess repayment risk and make data-driven decisions when determining eligibility or limits for earned wage advances.
|
|
2618
2618
|
# @param beta_ewa_report_v1_get_request [BetaEwaReportV1GetRequest]
|
|
2619
2619
|
# @param [Hash] opts the optional parameters
|
|
2620
2620
|
# @return [Array<(BetaEwaReportV1GetResponse, Integer, Hash)>] BetaEwaReportV1GetResponse data, response status code and response headers
|
|
@@ -2943,7 +2943,7 @@ module Plaid
|
|
|
2943
2943
|
return data, status_code, headers
|
|
2944
2944
|
end
|
|
2945
2945
|
|
|
2946
|
-
# Create a
|
|
2946
|
+
# Create a Business Verification
|
|
2947
2947
|
# Create a new business verification to check a business's identity and risk profile.
|
|
2948
2948
|
# @param business_verification_create_request [BusinessVerificationCreateRequest]
|
|
2949
2949
|
# @param [Hash] opts the optional parameters
|
|
@@ -2953,7 +2953,7 @@ module Plaid
|
|
|
2953
2953
|
data
|
|
2954
2954
|
end
|
|
2955
2955
|
|
|
2956
|
-
# Create a
|
|
2956
|
+
# Create a Business Verification
|
|
2957
2957
|
# Create a new business verification to check a business's identity and risk profile.
|
|
2958
2958
|
# @param business_verification_create_request [BusinessVerificationCreateRequest]
|
|
2959
2959
|
# @param [Hash] opts the optional parameters
|
|
@@ -3011,7 +3011,7 @@ module Plaid
|
|
|
3011
3011
|
return data, status_code, headers
|
|
3012
3012
|
end
|
|
3013
3013
|
|
|
3014
|
-
# Get a
|
|
3014
|
+
# Get a Business Verification
|
|
3015
3015
|
# Retrieve the current state of a specific business verification.
|
|
3016
3016
|
# @param business_verification_get_request [BusinessVerificationGetRequest]
|
|
3017
3017
|
# @param [Hash] opts the optional parameters
|
|
@@ -3021,7 +3021,7 @@ module Plaid
|
|
|
3021
3021
|
data
|
|
3022
3022
|
end
|
|
3023
3023
|
|
|
3024
|
-
# Get a
|
|
3024
|
+
# Get a Business Verification
|
|
3025
3025
|
# Retrieve the current state of a specific business verification.
|
|
3026
3026
|
# @param business_verification_get_request [BusinessVerificationGetRequest]
|
|
3027
3027
|
# @param [Hash] opts the optional parameters
|
|
@@ -3080,7 +3080,7 @@ module Plaid
|
|
|
3080
3080
|
end
|
|
3081
3081
|
|
|
3082
3082
|
# Gets transaction data in `cashflow_report`
|
|
3083
|
-
# The `/cashflow_report/get` endpoint retrieves transactions data associated with an
|
|
3083
|
+
# The `/cashflow_report/get` endpoint retrieves transactions data associated with an Item. Transactions data is standardized across financial institutions. Transactions are returned in reverse-chronological order, and the sequence of transaction ordering is stable and will not shift. Transactions are not immutable and can also be removed altogether by the institution; a removed transaction will no longer appear in `/transactions/get`. For more details, see [Pending and posted transactions](https://plaid.com/docs/transactions/transactions-data/#pending-and-posted-transactions). Due to the potentially large number of transactions associated with an Item, results are paginated. Manipulate the `count` and `cursor` parameters in conjunction with the `has_more` response body field to fetch all available transactions. Note that data isn't likely to be immediately available to `/cashflow_report/get`. Plaid will begin to prepare transactions data upon Item link, if Link was initialized with `cashflow_report`, or if it wasn't, upon the first call to `/cashflow_report/refresh`. To be alerted when transaction data is ready to be fetched, listen for the `CASHFLOW_REPORT_READY` webhook.
|
|
3084
3084
|
# @param cashflow_report_get_request [CashflowReportGetRequest]
|
|
3085
3085
|
# @param [Hash] opts the optional parameters
|
|
3086
3086
|
# @return [CashflowReportGetResponse]
|
|
@@ -3090,7 +3090,7 @@ module Plaid
|
|
|
3090
3090
|
end
|
|
3091
3091
|
|
|
3092
3092
|
# Gets transaction data in `cashflow_report`
|
|
3093
|
-
# The `/cashflow_report/get` endpoint retrieves transactions data associated with an
|
|
3093
|
+
# The `/cashflow_report/get` endpoint retrieves transactions data associated with an Item. Transactions data is standardized across financial institutions. Transactions are returned in reverse-chronological order, and the sequence of transaction ordering is stable and will not shift. Transactions are not immutable and can also be removed altogether by the institution; a removed transaction will no longer appear in `/transactions/get`. For more details, see [Pending and posted transactions](https://plaid.com/docs/transactions/transactions-data/#pending-and-posted-transactions). Due to the potentially large number of transactions associated with an Item, results are paginated. Manipulate the `count` and `cursor` parameters in conjunction with the `has_more` response body field to fetch all available transactions. Note that data isn't likely to be immediately available to `/cashflow_report/get`. Plaid will begin to prepare transactions data upon Item link, if Link was initialized with `cashflow_report`, or if it wasn't, upon the first call to `/cashflow_report/refresh`. To be alerted when transaction data is ready to be fetched, listen for the `CASHFLOW_REPORT_READY` webhook.
|
|
3094
3094
|
# @param cashflow_report_get_request [CashflowReportGetRequest]
|
|
3095
3095
|
# @param [Hash] opts the optional parameters
|
|
3096
3096
|
# @return [Array<(CashflowReportGetResponse, Integer, Hash)>] CashflowReportGetResponse data, response status code and response headers
|
|
@@ -3148,7 +3148,7 @@ module Plaid
|
|
|
3148
3148
|
end
|
|
3149
3149
|
|
|
3150
3150
|
# Gets insights data in Cashflow Report
|
|
3151
|
-
# The `/cashflow_report/insights/get` endpoint retrieves insights data associated with an
|
|
3151
|
+
# The `/cashflow_report/insights/get` endpoint retrieves insights data associated with an Item. Insights are only calculated on credit and depository accounts.
|
|
3152
3152
|
# @param cashflow_report_insights_get_request [CashflowReportInsightsGetRequest]
|
|
3153
3153
|
# @param [Hash] opts the optional parameters
|
|
3154
3154
|
# @return [CashflowReportInsightsGetResponse]
|
|
@@ -3158,7 +3158,7 @@ module Plaid
|
|
|
3158
3158
|
end
|
|
3159
3159
|
|
|
3160
3160
|
# Gets insights data in Cashflow Report
|
|
3161
|
-
# The `/cashflow_report/insights/get` endpoint retrieves insights data associated with an
|
|
3161
|
+
# The `/cashflow_report/insights/get` endpoint retrieves insights data associated with an Item. Insights are only calculated on credit and depository accounts.
|
|
3162
3162
|
# @param cashflow_report_insights_get_request [CashflowReportInsightsGetRequest]
|
|
3163
3163
|
# @param [Hash] opts the optional parameters
|
|
3164
3164
|
# @return [Array<(CashflowReportInsightsGetResponse, Integer, Hash)>] CashflowReportInsightsGetResponse data, response status code and response headers
|
|
@@ -3216,7 +3216,7 @@ module Plaid
|
|
|
3216
3216
|
end
|
|
3217
3217
|
|
|
3218
3218
|
# Refresh transaction data in `cashflow_report`
|
|
3219
|
-
# `/cashflow_report/refresh` is an endpoint that initiates an on-demand extraction to fetch the newest transactions for an
|
|
3219
|
+
# `/cashflow_report/refresh` is an endpoint that initiates an on-demand extraction to fetch the newest transactions for an Item (given an `item_id`). The Item must already have Cashflow Report added as a product in order to call `/cashflow_report/refresh`. After calling `/cashflow_report/refresh`, Plaid will fire a webhook `CASHFLOW_REPORT_READY` alerting clients that new transactions data can then be ingested via `/cashflow_report/get` or the webhook will contain an error code informing there was an error in refreshing transactions data. Note that the `/cashflow_report/refresh` endpoint is not supported for Capital One (`ins_128026`) non-depository accounts and will result in a `PRODUCTS_NOT_SUPPORTED` error if called on an Item that contains only non-depository accounts from that institution. 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 up to 30 seconds or more). If you encounter errors, you may find it necessary to adjust your timeout period for requests.
|
|
3220
3220
|
# @param cashflow_report_refresh_request [CashflowReportRefreshRequest]
|
|
3221
3221
|
# @param [Hash] opts the optional parameters
|
|
3222
3222
|
# @return [CashflowReportRefreshResponse]
|
|
@@ -3226,7 +3226,7 @@ module Plaid
|
|
|
3226
3226
|
end
|
|
3227
3227
|
|
|
3228
3228
|
# Refresh transaction data in `cashflow_report`
|
|
3229
|
-
# `/cashflow_report/refresh` is an endpoint that initiates an on-demand extraction to fetch the newest transactions for an
|
|
3229
|
+
# `/cashflow_report/refresh` is an endpoint that initiates an on-demand extraction to fetch the newest transactions for an Item (given an `item_id`). The Item must already have Cashflow Report added as a product in order to call `/cashflow_report/refresh`. After calling `/cashflow_report/refresh`, Plaid will fire a webhook `CASHFLOW_REPORT_READY` alerting clients that new transactions data can then be ingested via `/cashflow_report/get` or the webhook will contain an error code informing there was an error in refreshing transactions data. Note that the `/cashflow_report/refresh` endpoint is not supported for Capital One (`ins_128026`) non-depository accounts and will result in a `PRODUCTS_NOT_SUPPORTED` error if called on an Item that contains only non-depository accounts from that institution. 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 up to 30 seconds or more). If you encounter errors, you may find it necessary to adjust your timeout period for requests.
|
|
3230
3230
|
# @param cashflow_report_refresh_request [CashflowReportRefreshRequest]
|
|
3231
3231
|
# @param [Hash] opts the optional parameters
|
|
3232
3232
|
# @return [Array<(CashflowReportRefreshResponse, Integer, Hash)>] CashflowReportRefreshResponse data, response status code and response headers
|
|
@@ -3283,8 +3283,8 @@ module Plaid
|
|
|
3283
3283
|
return data, status_code, headers
|
|
3284
3284
|
end
|
|
3285
3285
|
|
|
3286
|
-
# Gets transaction data in cashflow_report
|
|
3287
|
-
# The `/cashflow_report/transactions/get` endpoint retrieves transactions data associated with an
|
|
3286
|
+
# Gets transaction data in `cashflow_report`
|
|
3287
|
+
# The `/cashflow_report/transactions/get` endpoint retrieves transactions data associated with an Item. Transactions data is standardized across financial institutions. Transactions are returned in reverse-chronological order, and the sequence of transaction ordering is stable and will not shift. Transactions are not immutable and can also be removed altogether by the institution; a removed transaction will no longer appear in `/transactions/get`. For more details, see [Pending and posted transactions](https://plaid.com/docs/transactions/transactions-data/#pending-and-posted-transactions). Due to the potentially large number of transactions associated with an Item, results are paginated. Manipulate the `count` and `cursor` parameters in conjunction with the `has_more` response body field to fetch all available transactions. Note that data isn't likely to be immediately available to `/cashflow_report/transactions/get`. Plaid will begin to prepare transactions data upon Item link, if Link was initialized with `cashflow_report`, or if it wasn't, upon the first call to `/cashflow_report/refresh`. To be alerted when transaction data is ready to be fetched, listen for the `CASHFLOW_REPORT_READY` webhook.
|
|
3288
3288
|
# @param cashflow_report_transactions_get_request [CashflowReportTransactionsGetRequest]
|
|
3289
3289
|
# @param [Hash] opts the optional parameters
|
|
3290
3290
|
# @return [CashflowReportTransactionsGetResponse]
|
|
@@ -3293,8 +3293,8 @@ module Plaid
|
|
|
3293
3293
|
data
|
|
3294
3294
|
end
|
|
3295
3295
|
|
|
3296
|
-
# Gets transaction data in cashflow_report
|
|
3297
|
-
# The `/cashflow_report/transactions/get` endpoint retrieves transactions data associated with an
|
|
3296
|
+
# Gets transaction data in `cashflow_report`
|
|
3297
|
+
# The `/cashflow_report/transactions/get` endpoint retrieves transactions data associated with an Item. Transactions data is standardized across financial institutions. Transactions are returned in reverse-chronological order, and the sequence of transaction ordering is stable and will not shift. Transactions are not immutable and can also be removed altogether by the institution; a removed transaction will no longer appear in `/transactions/get`. For more details, see [Pending and posted transactions](https://plaid.com/docs/transactions/transactions-data/#pending-and-posted-transactions). Due to the potentially large number of transactions associated with an Item, results are paginated. Manipulate the `count` and `cursor` parameters in conjunction with the `has_more` response body field to fetch all available transactions. Note that data isn't likely to be immediately available to `/cashflow_report/transactions/get`. Plaid will begin to prepare transactions data upon Item link, if Link was initialized with `cashflow_report`, or if it wasn't, upon the first call to `/cashflow_report/refresh`. To be alerted when transaction data is ready to be fetched, listen for the `CASHFLOW_REPORT_READY` webhook.
|
|
3298
3298
|
# @param cashflow_report_transactions_get_request [CashflowReportTransactionsGetRequest]
|
|
3299
3299
|
# @param [Hash] opts the optional parameters
|
|
3300
3300
|
# @return [Array<(CashflowReportTransactionsGetResponse, Integer, Hash)>] CashflowReportTransactionsGetResponse data, response status code and response headers
|
|
@@ -3487,7 +3487,7 @@ module Plaid
|
|
|
3487
3487
|
return data, status_code, headers
|
|
3488
3488
|
end
|
|
3489
3489
|
|
|
3490
|
-
# Retrieve
|
|
3490
|
+
# Retrieve PDF Reports
|
|
3491
3491
|
# Retrieves all existing CRB Bank Income and Base reports for the consumer in PDF format. Response is PDF binary data. The `request_id` is returned in the `Plaid-Request-ID` header.
|
|
3492
3492
|
# @param consumer_report_pdf_get_request [ConsumerReportPDFGetRequest]
|
|
3493
3493
|
# @param [Hash] opts the optional parameters
|
|
@@ -3497,7 +3497,7 @@ module Plaid
|
|
|
3497
3497
|
data
|
|
3498
3498
|
end
|
|
3499
3499
|
|
|
3500
|
-
# Retrieve
|
|
3500
|
+
# Retrieve PDF Reports
|
|
3501
3501
|
# Retrieves all existing CRB Bank Income and Base reports for the consumer in PDF format. Response is PDF binary data. The `request_id` is returned in the `Plaid-Request-ID` header.
|
|
3502
3502
|
# @param consumer_report_pdf_get_request [ConsumerReportPDFGetRequest]
|
|
3503
3503
|
# @param [Hash] opts the optional parameters
|
|
@@ -3624,7 +3624,7 @@ module Plaid
|
|
|
3624
3624
|
end
|
|
3625
3625
|
|
|
3626
3626
|
# Retrieve cash flow insights from your user's banking data
|
|
3627
|
-
# This endpoint allows you to retrieve the Cashflow Insights report for your user. You should call this endpoint after you've received a `CHECK_REPORT_READY` or a `USER_CHECK_REPORT_READY` webhook, either after the Link session for the user or after calling `/cra/check_report/create`. If the most recent consumer report for the user doesn
|
|
3627
|
+
# This endpoint allows you to retrieve the Cashflow Insights report for your user. You should call this endpoint after you've received a `CHECK_REPORT_READY` or a `USER_CHECK_REPORT_READY` webhook, either after the Link session for the user or after calling `/cra/check_report/create`. If the most recent consumer report for the user doesn't have sufficient data to generate the insights, or the consumer report has expired, you will receive an error indicating that you should create a new consumer report by calling `/cra/check_report/create`. If you did not initialize Link with the `cra_cashflow_insights` product or have generated a report using `/cra/check_report/create`, we will generate the insights when you call this endpoint. In this case, you may optionally provide parameters under `options` to configure which insights you want to receive.
|
|
3628
3628
|
# @param cra_check_report_cashflow_insights_get_request [CraCheckReportCashflowInsightsGetRequest]
|
|
3629
3629
|
# @param [Hash] opts the optional parameters
|
|
3630
3630
|
# @return [CraCheckReportCashflowInsightsGetResponse]
|
|
@@ -3634,7 +3634,7 @@ module Plaid
|
|
|
3634
3634
|
end
|
|
3635
3635
|
|
|
3636
3636
|
# Retrieve cash flow insights from your user's banking data
|
|
3637
|
-
# This endpoint allows you to retrieve the Cashflow Insights report for your user. You should call this endpoint after you've received a `CHECK_REPORT_READY` or a `USER_CHECK_REPORT_READY` webhook, either after the Link session for the user or after calling `/cra/check_report/create`. If the most recent consumer report for the user doesn
|
|
3637
|
+
# This endpoint allows you to retrieve the Cashflow Insights report for your user. You should call this endpoint after you've received a `CHECK_REPORT_READY` or a `USER_CHECK_REPORT_READY` webhook, either after the Link session for the user or after calling `/cra/check_report/create`. If the most recent consumer report for the user doesn't have sufficient data to generate the insights, or the consumer report has expired, you will receive an error indicating that you should create a new consumer report by calling `/cra/check_report/create`. If you did not initialize Link with the `cra_cashflow_insights` product or have generated a report using `/cra/check_report/create`, we will generate the insights when you call this endpoint. In this case, you may optionally provide parameters under `options` to configure which insights you want to receive.
|
|
3638
3638
|
# @param cra_check_report_cashflow_insights_get_request [CraCheckReportCashflowInsightsGetRequest]
|
|
3639
3639
|
# @param [Hash] opts the optional parameters
|
|
3640
3640
|
# @return [Array<(CraCheckReportCashflowInsightsGetResponse, Integer, Hash)>] CraCheckReportCashflowInsightsGetResponse data, response status code and response headers
|
|
@@ -3760,7 +3760,7 @@ module Plaid
|
|
|
3760
3760
|
end
|
|
3761
3761
|
|
|
3762
3762
|
# Retrieve cash flow information from your user's banks
|
|
3763
|
-
# This endpoint allows you to retrieve the Income Insights report for your user. You should call this endpoint after you
|
|
3763
|
+
# This endpoint allows you to retrieve the Income Insights report for your user. You should call this endpoint after you've received a `CHECK_REPORT_READY` or a `USER_CHECK_REPORT_READY` webhook, either after the Link session for the user or after calling `/cra/check_report/create`. If the most recent consumer report for the user doesn't have sufficient data to generate the base report, or the consumer report has expired, you will receive an error indicating that you should create a new consumer report by calling `/cra/check_report/create`. NOTE: The following schema was updated in April 2026 to reflect the response when the provided version is \"II2\". Please see [this document](https://docs.google.com/document/d/1kQkQ7FOgFaC4n-sUGUk74hoXZNY_L_nJeCuMe7Keip4/edit?tab=t.0#heading=h.rudamzinus2i) for guidance on migrating to II2 if you are currently using the II1 version, and [this section](https://docs.google.com/document/d/1kQkQ7FOgFaC4n-sUGUk74hoXZNY_L_nJeCuMe7Keip4/edit?tab=t.0#bookmark=id.tdcc2wpk0h60) for an example II1 response along with its [documentation](https://docs.google.com/document/d/1kQkQ7FOgFaC4n-sUGUk74hoXZNY_L_nJeCuMe7Keip4/edit?tab=t.36c85n2ircqk#heading=h.79dwr5c1iszl).
|
|
3764
3764
|
# @param cra_check_report_income_insights_get_request [CraCheckReportIncomeInsightsGetRequest]
|
|
3765
3765
|
# @param [Hash] opts the optional parameters
|
|
3766
3766
|
# @return [CraCheckReportIncomeInsightsGetResponse]
|
|
@@ -3770,7 +3770,7 @@ module Plaid
|
|
|
3770
3770
|
end
|
|
3771
3771
|
|
|
3772
3772
|
# Retrieve cash flow information from your user's banks
|
|
3773
|
-
# This endpoint allows you to retrieve the Income Insights report for your user. You should call this endpoint after you
|
|
3773
|
+
# This endpoint allows you to retrieve the Income Insights report for your user. You should call this endpoint after you've received a `CHECK_REPORT_READY` or a `USER_CHECK_REPORT_READY` webhook, either after the Link session for the user or after calling `/cra/check_report/create`. If the most recent consumer report for the user doesn't have sufficient data to generate the base report, or the consumer report has expired, you will receive an error indicating that you should create a new consumer report by calling `/cra/check_report/create`. NOTE: The following schema was updated in April 2026 to reflect the response when the provided version is \"II2\". Please see [this document](https://docs.google.com/document/d/1kQkQ7FOgFaC4n-sUGUk74hoXZNY_L_nJeCuMe7Keip4/edit?tab=t.0#heading=h.rudamzinus2i) for guidance on migrating to II2 if you are currently using the II1 version, and [this section](https://docs.google.com/document/d/1kQkQ7FOgFaC4n-sUGUk74hoXZNY_L_nJeCuMe7Keip4/edit?tab=t.0#bookmark=id.tdcc2wpk0h60) for an example II1 response along with its [documentation](https://docs.google.com/document/d/1kQkQ7FOgFaC4n-sUGUk74hoXZNY_L_nJeCuMe7Keip4/edit?tab=t.36c85n2ircqk#heading=h.79dwr5c1iszl).
|
|
3774
3774
|
# @param cra_check_report_income_insights_get_request [CraCheckReportIncomeInsightsGetRequest]
|
|
3775
3775
|
# @param [Hash] opts the optional parameters
|
|
3776
3776
|
# @return [Array<(CraCheckReportIncomeInsightsGetResponse, Integer, Hash)>] CraCheckReportIncomeInsightsGetResponse data, response status code and response headers
|
|
@@ -3828,7 +3828,7 @@ module Plaid
|
|
|
3828
3828
|
end
|
|
3829
3829
|
|
|
3830
3830
|
# Retrieve the LendScore from your user's banking data
|
|
3831
|
-
# This endpoint allows you to retrieve the LendScore report for your user. You should call this endpoint after you've received a `CHECK_REPORT_READY` or a `USER_CHECK_REPORT_READY` webhook, either after the Link session for the user or after calling `/cra/check_report/create`. If the most recent consumer report for the user doesn
|
|
3831
|
+
# This endpoint allows you to retrieve the LendScore report for your user. You should call this endpoint after you've received a `CHECK_REPORT_READY` or a `USER_CHECK_REPORT_READY` webhook, either after the Link session for the user or after calling `/cra/check_report/create`. If the most recent consumer report for the user doesn't have sufficient data to generate the insights, or the consumer report has expired, you will receive an error indicating that you should create a new consumer report by calling `/cra/check_report/create`. If you did not initialize Link with the `cra_lend_score` product or call `/cra/check_report/create` with the `cra_lend_score` product, Plaid will generate the insights when you call this endpoint. In this case, you may optionally provide parameters under `options` to configure which insights you want to receive.
|
|
3832
3832
|
# @param cra_check_report_lend_score_get_request [CraCheckReportLendScoreGetRequest]
|
|
3833
3833
|
# @param [Hash] opts the optional parameters
|
|
3834
3834
|
# @return [CraCheckReportLendScoreGetResponse]
|
|
@@ -3838,7 +3838,7 @@ module Plaid
|
|
|
3838
3838
|
end
|
|
3839
3839
|
|
|
3840
3840
|
# Retrieve the LendScore from your user's banking data
|
|
3841
|
-
# This endpoint allows you to retrieve the LendScore report for your user. You should call this endpoint after you've received a `CHECK_REPORT_READY` or a `USER_CHECK_REPORT_READY` webhook, either after the Link session for the user or after calling `/cra/check_report/create`. If the most recent consumer report for the user doesn
|
|
3841
|
+
# This endpoint allows you to retrieve the LendScore report for your user. You should call this endpoint after you've received a `CHECK_REPORT_READY` or a `USER_CHECK_REPORT_READY` webhook, either after the Link session for the user or after calling `/cra/check_report/create`. If the most recent consumer report for the user doesn't have sufficient data to generate the insights, or the consumer report has expired, you will receive an error indicating that you should create a new consumer report by calling `/cra/check_report/create`. If you did not initialize Link with the `cra_lend_score` product or call `/cra/check_report/create` with the `cra_lend_score` product, Plaid will generate the insights when you call this endpoint. In this case, you may optionally provide parameters under `options` to configure which insights you want to receive.
|
|
3842
3842
|
# @param cra_check_report_lend_score_get_request [CraCheckReportLendScoreGetRequest]
|
|
3843
3843
|
# @param [Hash] opts the optional parameters
|
|
3844
3844
|
# @return [Array<(CraCheckReportLendScoreGetResponse, Integer, Hash)>] CraCheckReportLendScoreGetResponse data, response status code and response headers
|
|
@@ -3896,7 +3896,7 @@ module Plaid
|
|
|
3896
3896
|
end
|
|
3897
3897
|
|
|
3898
3898
|
# Retrieve network attributes for the user
|
|
3899
|
-
# This endpoint allows you to retrieve the Network Insights product for your user. You should call this endpoint after you've received a `CHECK_REPORT_READY` or a `USER_CHECK_REPORT_READY` webhook, either after the Link session for the user or after calling `/cra/check_report/create`. If the most recent consumer report for the user doesn
|
|
3899
|
+
# This endpoint allows you to retrieve the Network Insights product for your user. You should call this endpoint after you've received a `CHECK_REPORT_READY` or a `USER_CHECK_REPORT_READY` webhook, either after the Link session for the user or after calling `/cra/check_report/create`. If the most recent consumer report for the user doesn't have sufficient data to generate the report, or the consumer report has expired, you will receive an error indicating that you should create a new consumer report by calling `/cra/check_report/create`. If you did not initialize Link with the `cra_network_insights` product or have generated a report using `/cra/check_report/create`, Plaid will generate the attributes when you call this endpoint.
|
|
3900
3900
|
# @param cra_check_report_network_insights_get_request [CraCheckReportNetworkInsightsGetRequest]
|
|
3901
3901
|
# @param [Hash] opts the optional parameters
|
|
3902
3902
|
# @return [CraCheckReportNetworkInsightsGetResponse]
|
|
@@ -3906,7 +3906,7 @@ module Plaid
|
|
|
3906
3906
|
end
|
|
3907
3907
|
|
|
3908
3908
|
# Retrieve network attributes for the user
|
|
3909
|
-
# This endpoint allows you to retrieve the Network Insights product for your user. You should call this endpoint after you've received a `CHECK_REPORT_READY` or a `USER_CHECK_REPORT_READY` webhook, either after the Link session for the user or after calling `/cra/check_report/create`. If the most recent consumer report for the user doesn
|
|
3909
|
+
# This endpoint allows you to retrieve the Network Insights product for your user. You should call this endpoint after you've received a `CHECK_REPORT_READY` or a `USER_CHECK_REPORT_READY` webhook, either after the Link session for the user or after calling `/cra/check_report/create`. If the most recent consumer report for the user doesn't have sufficient data to generate the report, or the consumer report has expired, you will receive an error indicating that you should create a new consumer report by calling `/cra/check_report/create`. If you did not initialize Link with the `cra_network_insights` product or have generated a report using `/cra/check_report/create`, Plaid will generate the attributes when you call this endpoint.
|
|
3910
3910
|
# @param cra_check_report_network_insights_get_request [CraCheckReportNetworkInsightsGetRequest]
|
|
3911
3911
|
# @param [Hash] opts the optional parameters
|
|
3912
3912
|
# @return [Array<(CraCheckReportNetworkInsightsGetResponse, Integer, Hash)>] CraCheckReportNetworkInsightsGetResponse data, response status code and response headers
|
|
@@ -3964,7 +3964,7 @@ module Plaid
|
|
|
3964
3964
|
end
|
|
3965
3965
|
|
|
3966
3966
|
# Retrieve cash flow insights from partners
|
|
3967
|
-
# This endpoint allows you to retrieve the Partner Insights report for your user. You should call this endpoint after you've received a `CHECK_REPORT_READY` or a `USER_CHECK_REPORT_READY` webhook, either after the Link session for the user or after calling `/cra/check_report/create`. If the most recent consumer report for the user doesn
|
|
3967
|
+
# This endpoint allows you to retrieve the Partner Insights report for your user. You should call this endpoint after you've received a `CHECK_REPORT_READY` or a `USER_CHECK_REPORT_READY` webhook, either after the Link session for the user or after calling `/cra/check_report/create`. If the most recent consumer report for the user doesn't have sufficient data to generate the base report, or the consumer report has expired, you will receive an error indicating that you should create a new consumer report by calling `/cra/check_report/create`. If you did not initialize Link with the `credit_partner_insights` product or have generated a report using `/cra/check_report/create`, we will call our partners to generate the insights when you call this endpoint. In this case, you may optionally provide parameters under `options` to configure which insights you want to receive.
|
|
3968
3968
|
# @param cra_check_report_partner_insights_get_request [CraCheckReportPartnerInsightsGetRequest]
|
|
3969
3969
|
# @param [Hash] opts the optional parameters
|
|
3970
3970
|
# @return [CraCheckReportPartnerInsightsGetResponse]
|
|
@@ -3974,7 +3974,7 @@ module Plaid
|
|
|
3974
3974
|
end
|
|
3975
3975
|
|
|
3976
3976
|
# Retrieve cash flow insights from partners
|
|
3977
|
-
# This endpoint allows you to retrieve the Partner Insights report for your user. You should call this endpoint after you've received a `CHECK_REPORT_READY` or a `USER_CHECK_REPORT_READY` webhook, either after the Link session for the user or after calling `/cra/check_report/create`. If the most recent consumer report for the user doesn
|
|
3977
|
+
# This endpoint allows you to retrieve the Partner Insights report for your user. You should call this endpoint after you've received a `CHECK_REPORT_READY` or a `USER_CHECK_REPORT_READY` webhook, either after the Link session for the user or after calling `/cra/check_report/create`. If the most recent consumer report for the user doesn't have sufficient data to generate the base report, or the consumer report has expired, you will receive an error indicating that you should create a new consumer report by calling `/cra/check_report/create`. If you did not initialize Link with the `credit_partner_insights` product or have generated a report using `/cra/check_report/create`, we will call our partners to generate the insights when you call this endpoint. In this case, you may optionally provide parameters under `options` to configure which insights you want to receive.
|
|
3978
3978
|
# @param cra_check_report_partner_insights_get_request [CraCheckReportPartnerInsightsGetRequest]
|
|
3979
3979
|
# @param [Hash] opts the optional parameters
|
|
3980
3980
|
# @return [Array<(CraCheckReportPartnerInsightsGetResponse, Integer, Hash)>] CraCheckReportPartnerInsightsGetResponse data, response status code and response headers
|
|
@@ -4031,7 +4031,7 @@ module Plaid
|
|
|
4031
4031
|
return data, status_code, headers
|
|
4032
4032
|
end
|
|
4033
4033
|
|
|
4034
|
-
# Retrieve Consumer
|
|
4034
|
+
# Retrieve a Consumer Report as a PDF
|
|
4035
4035
|
# `/cra/check_report/pdf/get` retrieves the most recent Consumer Report in PDF format. By default, the most recent Base Report (if it exists) for the user will be returned. To request that the most recent Partner Insights or Income Insights report be included in the PDF as well, use the `add-ons` field.
|
|
4036
4036
|
# @param cra_check_report_pdf_get_request [CraCheckReportPDFGetRequest]
|
|
4037
4037
|
# @param [Hash] opts the optional parameters
|
|
@@ -4041,7 +4041,7 @@ module Plaid
|
|
|
4041
4041
|
data
|
|
4042
4042
|
end
|
|
4043
4043
|
|
|
4044
|
-
# Retrieve Consumer
|
|
4044
|
+
# Retrieve a Consumer Report as a PDF
|
|
4045
4045
|
# `/cra/check_report/pdf/get` retrieves the most recent Consumer Report in PDF format. By default, the most recent Base Report (if it exists) for the user will be returned. To request that the most recent Partner Insights or Income Insights report be included in the PDF as well, use the `add-ons` field.
|
|
4046
4046
|
# @param cra_check_report_pdf_get_request [CraCheckReportPDFGetRequest]
|
|
4047
4047
|
# @param [Hash] opts the optional parameters
|
|
@@ -4099,8 +4099,8 @@ module Plaid
|
|
|
4099
4099
|
return data, status_code, headers
|
|
4100
4100
|
end
|
|
4101
4101
|
|
|
4102
|
-
# Retrieve various home lending reports for a user
|
|
4103
|
-
# This endpoint allows you to retrieve home lending reports for a user. To obtain a VoA or Employment Refresh report, you need to make sure that `cra_base_report` is included in the `products` parameter when calling `/link/token/create` or `/cra/check_report/create`. You should call this endpoint after you've received a `CHECK_REPORT_READY` or a `USER_CHECK_REPORT_READY` webhook, either after the Link session for the user or after calling `/cra/check_report/create`. If the most recent consumer report for the user doesn
|
|
4102
|
+
# Retrieve various home lending reports for a user
|
|
4103
|
+
# This endpoint allows you to retrieve home lending reports for a user. To obtain a VoA or Employment Refresh report, you need to make sure that `cra_base_report` is included in the `products` parameter when calling `/link/token/create` or `/cra/check_report/create`. You should call this endpoint after you've received a `CHECK_REPORT_READY` or a `USER_CHECK_REPORT_READY` webhook, either after the Link session for the user or after calling `/cra/check_report/create`. If the most recent consumer report for the user doesn't have sufficient data to generate the report, or the consumer report has expired, you will receive an error indicating that you should create a new consumer report by calling `/cra/check_report/create`.
|
|
4104
4104
|
# @param cra_check_report_verification_get_request [CraCheckReportVerificationGetRequest]
|
|
4105
4105
|
# @param [Hash] opts the optional parameters
|
|
4106
4106
|
# @return [CraCheckReportVerificationGetResponse]
|
|
@@ -4109,8 +4109,8 @@ module Plaid
|
|
|
4109
4109
|
data
|
|
4110
4110
|
end
|
|
4111
4111
|
|
|
4112
|
-
# Retrieve various home lending reports for a user
|
|
4113
|
-
# This endpoint allows you to retrieve home lending reports for a user. To obtain a VoA or Employment Refresh report, you need to make sure that `cra_base_report` is included in the `products` parameter when calling `/link/token/create` or `/cra/check_report/create`. You should call this endpoint after you've received a `CHECK_REPORT_READY` or a `USER_CHECK_REPORT_READY` webhook, either after the Link session for the user or after calling `/cra/check_report/create`. If the most recent consumer report for the user doesn
|
|
4112
|
+
# Retrieve various home lending reports for a user
|
|
4113
|
+
# This endpoint allows you to retrieve home lending reports for a user. To obtain a VoA or Employment Refresh report, you need to make sure that `cra_base_report` is included in the `products` parameter when calling `/link/token/create` or `/cra/check_report/create`. You should call this endpoint after you've received a `CHECK_REPORT_READY` or a `USER_CHECK_REPORT_READY` webhook, either after the Link session for the user or after calling `/cra/check_report/create`. If the most recent consumer report for the user doesn't have sufficient data to generate the report, or the consumer report has expired, you will receive an error indicating that you should create a new consumer report by calling `/cra/check_report/create`.
|
|
4114
4114
|
# @param cra_check_report_verification_get_request [CraCheckReportVerificationGetRequest]
|
|
4115
4115
|
# @param [Hash] opts the optional parameters
|
|
4116
4116
|
# @return [Array<(CraCheckReportVerificationGetResponse, Integer, Hash)>] CraCheckReportVerificationGetResponse data, response status code and response headers
|
|
@@ -4167,7 +4167,7 @@ module Plaid
|
|
|
4167
4167
|
return data, status_code, headers
|
|
4168
4168
|
end
|
|
4169
4169
|
|
|
4170
|
-
# Retrieve Consumer
|
|
4170
|
+
# Retrieve a Consumer Report as a Verification PDF
|
|
4171
4171
|
# The `/cra/check_report/verification/pdf/get` endpoint retrieves the most recent Consumer Report in PDF format, specifically formatted for Home Lending verification use cases. Before calling this endpoint, ensure that you've created a VOA report through Link or the `/cra/check_report/create` endpoint, and have received a `CHECK_REPORT_READY` or a `USER_CHECK_REPORT_READY` webhook. The response to `/cra/check_report/verification/pdf/get` is the PDF binary data. The `request_id` is returned in the `Plaid-Request-ID` header.
|
|
4172
4172
|
# @param cra_check_report_verification_pdf_get_request [CraCheckReportVerificationPdfGetRequest]
|
|
4173
4173
|
# @param [Hash] opts the optional parameters
|
|
@@ -4177,7 +4177,7 @@ module Plaid
|
|
|
4177
4177
|
data
|
|
4178
4178
|
end
|
|
4179
4179
|
|
|
4180
|
-
# Retrieve Consumer
|
|
4180
|
+
# Retrieve a Consumer Report as a Verification PDF
|
|
4181
4181
|
# The `/cra/check_report/verification/pdf/get` endpoint retrieves the most recent Consumer Report in PDF format, specifically formatted for Home Lending verification use cases. Before calling this endpoint, ensure that you've created a VOA report through Link or the `/cra/check_report/create` endpoint, and have received a `CHECK_REPORT_READY` or a `USER_CHECK_REPORT_READY` webhook. The response to `/cra/check_report/verification/pdf/get` is the PDF binary data. The `request_id` is returned in the `Plaid-Request-ID` header.
|
|
4182
4182
|
# @param cra_check_report_verification_pdf_get_request [CraCheckReportVerificationPdfGetRequest]
|
|
4183
4183
|
# @param [Hash] opts the optional parameters
|
|
@@ -4235,7 +4235,75 @@ module Plaid
|
|
|
4235
4235
|
return data, status_code, headers
|
|
4236
4236
|
end
|
|
4237
4237
|
|
|
4238
|
-
#
|
|
4238
|
+
# Retrieve the credit profile report for a user
|
|
4239
|
+
# `/cra/credit_profile/report/get` retrieves a credit profile report for a user.
|
|
4240
|
+
# @param cra_credit_profile_report_get_request [CraCreditProfileReportGetRequest]
|
|
4241
|
+
# @param [Hash] opts the optional parameters
|
|
4242
|
+
# @return [CraCreditProfileReportGetResponse]
|
|
4243
|
+
def cra_credit_profile_report_get(cra_credit_profile_report_get_request, opts = {})
|
|
4244
|
+
data, _status_code, _headers = cra_credit_profile_report_get_with_http_info(cra_credit_profile_report_get_request, opts)
|
|
4245
|
+
data
|
|
4246
|
+
end
|
|
4247
|
+
|
|
4248
|
+
# Retrieve the credit profile report for a user
|
|
4249
|
+
# `/cra/credit_profile/report/get` retrieves a credit profile report for a user.
|
|
4250
|
+
# @param cra_credit_profile_report_get_request [CraCreditProfileReportGetRequest]
|
|
4251
|
+
# @param [Hash] opts the optional parameters
|
|
4252
|
+
# @return [Array<(CraCreditProfileReportGetResponse, Integer, Hash)>] CraCreditProfileReportGetResponse data, response status code and response headers
|
|
4253
|
+
def cra_credit_profile_report_get_with_http_info(cra_credit_profile_report_get_request, opts = {})
|
|
4254
|
+
if @api_client.config.debugging
|
|
4255
|
+
@api_client.config.logger.debug 'Calling API: PlaidApi.cra_credit_profile_report_get ...'
|
|
4256
|
+
end
|
|
4257
|
+
# verify the required parameter 'cra_credit_profile_report_get_request' is set
|
|
4258
|
+
if @api_client.config.client_side_validation && cra_credit_profile_report_get_request.nil?
|
|
4259
|
+
fail ArgumentError, "Missing the required parameter 'cra_credit_profile_report_get_request' when calling PlaidApi.cra_credit_profile_report_get"
|
|
4260
|
+
end
|
|
4261
|
+
# resource path
|
|
4262
|
+
local_var_path = '/cra/credit_profile/report/get'
|
|
4263
|
+
|
|
4264
|
+
# query parameters
|
|
4265
|
+
query_params = opts[:query_params] || {}
|
|
4266
|
+
|
|
4267
|
+
# header parameters
|
|
4268
|
+
header_params = opts[:header_params] || {}
|
|
4269
|
+
# HTTP header 'Accept' (if needed)
|
|
4270
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
4271
|
+
# HTTP header 'Content-Type'
|
|
4272
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
|
4273
|
+
if !content_type.nil?
|
|
4274
|
+
header_params['Content-Type'] = content_type
|
|
4275
|
+
end
|
|
4276
|
+
|
|
4277
|
+
# form parameters
|
|
4278
|
+
form_params = opts[:form_params] || {}
|
|
4279
|
+
|
|
4280
|
+
# http body (model)
|
|
4281
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(cra_credit_profile_report_get_request)
|
|
4282
|
+
|
|
4283
|
+
# return_type
|
|
4284
|
+
return_type = opts[:debug_return_type] || 'CraCreditProfileReportGetResponse'
|
|
4285
|
+
|
|
4286
|
+
# auth_names
|
|
4287
|
+
auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
|
|
4288
|
+
|
|
4289
|
+
new_options = opts.merge(
|
|
4290
|
+
:operation => :"PlaidApi.cra_credit_profile_report_get",
|
|
4291
|
+
:header_params => header_params,
|
|
4292
|
+
:query_params => query_params,
|
|
4293
|
+
:form_params => form_params,
|
|
4294
|
+
:body => post_body,
|
|
4295
|
+
:auth_names => auth_names,
|
|
4296
|
+
:return_type => return_type
|
|
4297
|
+
)
|
|
4298
|
+
|
|
4299
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
|
4300
|
+
if @api_client.config.debugging
|
|
4301
|
+
@api_client.config.logger.debug "API called: PlaidApi#cra_credit_profile_report_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
4302
|
+
end
|
|
4303
|
+
return data, status_code, headers
|
|
4304
|
+
end
|
|
4305
|
+
|
|
4306
|
+
# Register loan applications and decisions
|
|
4239
4307
|
# `/cra/loans/applications/register` registers loan applications and decisions.
|
|
4240
4308
|
# @param cra_loans_applications_register_request [CraLoansApplicationsRegisterRequest]
|
|
4241
4309
|
# @param [Hash] opts the optional parameters
|
|
@@ -4245,7 +4313,7 @@ module Plaid
|
|
|
4245
4313
|
data
|
|
4246
4314
|
end
|
|
4247
4315
|
|
|
4248
|
-
# Register loan applications and decisions
|
|
4316
|
+
# Register loan applications and decisions
|
|
4249
4317
|
# `/cra/loans/applications/register` registers loan applications and decisions.
|
|
4250
4318
|
# @param cra_loans_applications_register_request [CraLoansApplicationsRegisterRequest]
|
|
4251
4319
|
# @param [Hash] opts the optional parameters
|
|
@@ -4303,7 +4371,7 @@ module Plaid
|
|
|
4303
4371
|
return data, status_code, headers
|
|
4304
4372
|
end
|
|
4305
4373
|
|
|
4306
|
-
# Register a list of loans to their applicants
|
|
4374
|
+
# Register a list of loans to their applicants
|
|
4307
4375
|
# `/cra/loans/register` registers a list of loans to their applicants.
|
|
4308
4376
|
# @param cra_loans_register_request [CRALoansRegisterRequest]
|
|
4309
4377
|
# @param [Hash] opts the optional parameters
|
|
@@ -4313,7 +4381,7 @@ module Plaid
|
|
|
4313
4381
|
data
|
|
4314
4382
|
end
|
|
4315
4383
|
|
|
4316
|
-
# Register a list of loans to their applicants
|
|
4384
|
+
# Register a list of loans to their applicants
|
|
4317
4385
|
# `/cra/loans/register` registers a list of loans to their applicants.
|
|
4318
4386
|
# @param cra_loans_register_request [CRALoansRegisterRequest]
|
|
4319
4387
|
# @param [Hash] opts the optional parameters
|
|
@@ -4371,7 +4439,7 @@ module Plaid
|
|
|
4371
4439
|
return data, status_code, headers
|
|
4372
4440
|
end
|
|
4373
4441
|
|
|
4374
|
-
# Unregister a list of loans
|
|
4442
|
+
# Unregister a list of loans
|
|
4375
4443
|
# `/cra/loans/unregister` indicates the loans have reached a final status and no further updates are expected.
|
|
4376
4444
|
# @param cra_loans_unregister_request [CraLoansUnregisterRequest]
|
|
4377
4445
|
# @param [Hash] opts the optional parameters
|
|
@@ -4381,7 +4449,7 @@ module Plaid
|
|
|
4381
4449
|
data
|
|
4382
4450
|
end
|
|
4383
4451
|
|
|
4384
|
-
# Unregister a list of loans
|
|
4452
|
+
# Unregister a list of loans
|
|
4385
4453
|
# `/cra/loans/unregister` indicates the loans have reached a final status and no further updates are expected.
|
|
4386
4454
|
# @param cra_loans_unregister_request [CraLoansUnregisterRequest]
|
|
4387
4455
|
# @param [Hash] opts the optional parameters
|
|
@@ -4439,7 +4507,7 @@ module Plaid
|
|
|
4439
4507
|
return data, status_code, headers
|
|
4440
4508
|
end
|
|
4441
4509
|
|
|
4442
|
-
#
|
|
4510
|
+
# Update loan data
|
|
4443
4511
|
# `/cra/loans/update` updates loan information such as the status and payment history.
|
|
4444
4512
|
# @param cra_loans_update_request [CraLoansUpdateRequest]
|
|
4445
4513
|
# @param [Hash] opts the optional parameters
|
|
@@ -4449,7 +4517,7 @@ module Plaid
|
|
|
4449
4517
|
data
|
|
4450
4518
|
end
|
|
4451
4519
|
|
|
4452
|
-
#
|
|
4520
|
+
# Update loan data
|
|
4453
4521
|
# `/cra/loans/update` updates loan information such as the status and payment history.
|
|
4454
4522
|
# @param cra_loans_update_request [CraLoansUpdateRequest]
|
|
4455
4523
|
# @param [Hash] opts the optional parameters
|
|
@@ -4848,7 +4916,7 @@ module Plaid
|
|
|
4848
4916
|
end
|
|
4849
4917
|
|
|
4850
4918
|
# Retrieve an Asset Report with Freddie Mac format. Only Freddie Mac can use this endpoint.
|
|
4851
|
-
# The
|
|
4919
|
+
# The `/credit/asset_report/freddie_mac/get` endpoint retrieves the Asset Report in Freddie Mac's JSON format.
|
|
4852
4920
|
# @param request_body [Hash<String, Object>]
|
|
4853
4921
|
# @param [Hash] opts the optional parameters
|
|
4854
4922
|
# @return [AssetReportFreddieGetResponse]
|
|
@@ -4858,7 +4926,7 @@ module Plaid
|
|
|
4858
4926
|
end
|
|
4859
4927
|
|
|
4860
4928
|
# Retrieve an Asset Report with Freddie Mac format. Only Freddie Mac can use this endpoint.
|
|
4861
|
-
# The `
|
|
4929
|
+
# The `/credit/asset_report/freddie_mac/get` endpoint retrieves the Asset Report in Freddie Mac's JSON format.
|
|
4862
4930
|
# @param request_body [Hash<String, Object>]
|
|
4863
4931
|
# @param [Hash] opts the optional parameters
|
|
4864
4932
|
# @return [Array<(AssetReportFreddieGetResponse, Integer, Hash)>] AssetReportFreddieGetResponse data, response status code and response headers
|
|
@@ -4916,7 +4984,7 @@ module Plaid
|
|
|
4916
4984
|
end
|
|
4917
4985
|
|
|
4918
4986
|
# Create Asset or Income Report Audit Copy Token
|
|
4919
|
-
# Plaid can create an Audit Copy token of an Asset Report and/or Income Report to share with a participating Government
|
|
4987
|
+
# Plaid can create an Audit Copy token of an Asset Report and/or Income Report to share with a participating Government-Sponsored Enterprise (GSE) if you participate in Fannie Mae's Day 1 Certainty™ program or utilize Freddie Mac's Loan Product Advisor® (LPA®) Asset and Income Modeler (AIM). An Audit Copy token contains the same underlying data as the Asset Report and/or Income Report (result of `/credit/payroll_income/get`). Use the `/credit/audit_copy_token/create` endpoint to create an `audit_copy_token` and then pass that token to the GSE who needs access.
|
|
4920
4988
|
# @param credit_audit_copy_token_create_request [CreditAuditCopyTokenCreateRequest]
|
|
4921
4989
|
# @param [Hash] opts the optional parameters
|
|
4922
4990
|
# @return [CreditAuditCopyTokenCreateResponse]
|
|
@@ -4926,7 +4994,7 @@ module Plaid
|
|
|
4926
4994
|
end
|
|
4927
4995
|
|
|
4928
4996
|
# Create Asset or Income Report Audit Copy Token
|
|
4929
|
-
# Plaid can create an Audit Copy token of an Asset Report and/or Income Report to share with a participating Government
|
|
4997
|
+
# Plaid can create an Audit Copy token of an Asset Report and/or Income Report to share with a participating Government-Sponsored Enterprise (GSE) if you participate in Fannie Mae's Day 1 Certainty™ program or utilize Freddie Mac's Loan Product Advisor® (LPA®) Asset and Income Modeler (AIM). An Audit Copy token contains the same underlying data as the Asset Report and/or Income Report (result of `/credit/payroll_income/get`). Use the `/credit/audit_copy_token/create` endpoint to create an `audit_copy_token` and then pass that token to the GSE who needs access.
|
|
4930
4998
|
# @param credit_audit_copy_token_create_request [CreditAuditCopyTokenCreateRequest]
|
|
4931
4999
|
# @param [Hash] opts the optional parameters
|
|
4932
5000
|
# @return [Array<(CreditAuditCopyTokenCreateResponse, Integer, Hash)>] CreditAuditCopyTokenCreateResponse data, response status code and response headers
|
|
@@ -4984,7 +5052,7 @@ module Plaid
|
|
|
4984
5052
|
end
|
|
4985
5053
|
|
|
4986
5054
|
# Update an Audit Copy Token
|
|
4987
|
-
# The `/credit/audit_copy_token/update` endpoint updates an existing
|
|
5055
|
+
# The `/credit/audit_copy_token/update` endpoint updates an existing Audit Copy Token by adding the report tokens in the `report_tokens` field to the `audit_copy_token`. If the Audit Copy Token already contains a report of a certain type, it will be replaced with the token provided in the `report_tokens` field.
|
|
4988
5056
|
# @param credit_audit_copy_token_update_request [CreditAuditCopyTokenUpdateRequest]
|
|
4989
5057
|
# @param [Hash] opts the optional parameters
|
|
4990
5058
|
# @return [CreditAuditCopyTokenUpdateResponse]
|
|
@@ -4994,7 +5062,7 @@ module Plaid
|
|
|
4994
5062
|
end
|
|
4995
5063
|
|
|
4996
5064
|
# Update an Audit Copy Token
|
|
4997
|
-
# The `/credit/audit_copy_token/update` endpoint updates an existing
|
|
5065
|
+
# The `/credit/audit_copy_token/update` endpoint updates an existing Audit Copy Token by adding the report tokens in the `report_tokens` field to the `audit_copy_token`. If the Audit Copy Token already contains a report of a certain type, it will be replaced with the token provided in the `report_tokens` field.
|
|
4998
5066
|
# @param credit_audit_copy_token_update_request [CreditAuditCopyTokenUpdateRequest]
|
|
4999
5067
|
# @param [Hash] opts the optional parameters
|
|
5000
5068
|
# @return [Array<(CreditAuditCopyTokenUpdateResponse, Integer, Hash)>] CreditAuditCopyTokenUpdateResponse data, response status code and response headers
|
|
@@ -5052,7 +5120,7 @@ module Plaid
|
|
|
5052
5120
|
end
|
|
5053
5121
|
|
|
5054
5122
|
# Retrieve information from the bank accounts used for employment verification
|
|
5055
|
-
# `/credit/bank_employment/get` returns the employment report(s) derived from bank transaction data for a specified user.
|
|
5123
|
+
# `/beta/credit/v1/bank_employment/get` returns the employment report(s) derived from bank transaction data for a specified user.
|
|
5056
5124
|
# @param credit_bank_employment_get_request [CreditBankEmploymentGetRequest]
|
|
5057
5125
|
# @param [Hash] opts the optional parameters
|
|
5058
5126
|
# @return [CreditBankEmploymentGetResponse]
|
|
@@ -5062,7 +5130,7 @@ module Plaid
|
|
|
5062
5130
|
end
|
|
5063
5131
|
|
|
5064
5132
|
# Retrieve information from the bank accounts used for employment verification
|
|
5065
|
-
# `/credit/bank_employment/get` returns the employment report(s) derived from bank transaction data for a specified user.
|
|
5133
|
+
# `/beta/credit/v1/bank_employment/get` returns the employment report(s) derived from bank transaction data for a specified user.
|
|
5066
5134
|
# @param credit_bank_employment_get_request [CreditBankEmploymentGetRequest]
|
|
5067
5135
|
# @param [Hash] opts the optional parameters
|
|
5068
5136
|
# @return [Array<(CreditBankEmploymentGetResponse, Integer, Hash)>] CreditBankEmploymentGetResponse data, response status code and response headers
|
|
@@ -5256,7 +5324,7 @@ module Plaid
|
|
|
5256
5324
|
end
|
|
5257
5325
|
|
|
5258
5326
|
# Refresh a user's bank income information
|
|
5259
|
-
# `/credit/bank_income/refresh`
|
|
5327
|
+
# `/credit/bank_income/refresh` is deprecated. The backend implementation was removed (returns an `Unimplemented` error at runtime), and the endpoint is no longer part of the documented API surface. To refresh Bank Income data for an existing user, send the user through Link's update mode so they can confirm their income sources. For a fully backend refresh, migrate to CRA Income Insights and call `/cra/check_report/create`.
|
|
5260
5328
|
# @param credit_bank_income_refresh_request [CreditBankIncomeRefreshRequest]
|
|
5261
5329
|
# @param [Hash] opts the optional parameters
|
|
5262
5330
|
# @return [CreditBankIncomeRefreshResponse]
|
|
@@ -5266,7 +5334,7 @@ module Plaid
|
|
|
5266
5334
|
end
|
|
5267
5335
|
|
|
5268
5336
|
# Refresh a user's bank income information
|
|
5269
|
-
# `/credit/bank_income/refresh`
|
|
5337
|
+
# `/credit/bank_income/refresh` is deprecated. The backend implementation was removed (returns an `Unimplemented` error at runtime), and the endpoint is no longer part of the documented API surface. To refresh Bank Income data for an existing user, send the user through Link's update mode so they can confirm their income sources. For a fully backend refresh, migrate to CRA Income Insights and call `/cra/check_report/create`.
|
|
5270
5338
|
# @param credit_bank_income_refresh_request [CreditBankIncomeRefreshRequest]
|
|
5271
5339
|
# @param [Hash] opts the optional parameters
|
|
5272
5340
|
# @return [Array<(CreditBankIncomeRefreshResponse, Integer, Hash)>] CreditBankIncomeRefreshResponse data, response status code and response headers
|
|
@@ -5528,7 +5596,7 @@ module Plaid
|
|
|
5528
5596
|
end
|
|
5529
5597
|
|
|
5530
5598
|
# Retrieve an Asset Report with Freddie Mac format (aka VOA - Verification Of Assets), and a Verification Of Employment (VOE) report if this one is available. Only Freddie Mac can use this endpoint.
|
|
5531
|
-
# The
|
|
5599
|
+
# The `/credit/freddie_mac/reports/get` endpoint retrieves the Verification of Assets and Verification of Employment reports.
|
|
5532
5600
|
# @param credit_freddie_mac_reports_get_request [CreditFreddieMacReportsGetRequest]
|
|
5533
5601
|
# @param [Hash] opts the optional parameters
|
|
5534
5602
|
# @return [CreditFreddieMacReportsGetResponse]
|
|
@@ -5538,7 +5606,7 @@ module Plaid
|
|
|
5538
5606
|
end
|
|
5539
5607
|
|
|
5540
5608
|
# Retrieve an Asset Report with Freddie Mac format (aka VOA - Verification Of Assets), and a Verification Of Employment (VOE) report if this one is available. Only Freddie Mac can use this endpoint.
|
|
5541
|
-
# The `
|
|
5609
|
+
# The `/credit/freddie_mac/reports/get` endpoint retrieves the Verification of Assets and Verification of Employment reports.
|
|
5542
5610
|
# @param credit_freddie_mac_reports_get_request [CreditFreddieMacReportsGetRequest]
|
|
5543
5611
|
# @param [Hash] opts the optional parameters
|
|
5544
5612
|
# @return [Array<(CreditFreddieMacReportsGetResponse, Integer, Hash)>] CreditFreddieMacReportsGetResponse data, response status code and response headers
|
|
@@ -6411,7 +6479,7 @@ module Plaid
|
|
|
6411
6479
|
return data, status_code, headers
|
|
6412
6480
|
end
|
|
6413
6481
|
|
|
6414
|
-
# Retrieve a
|
|
6482
|
+
# Retrieve a Dashboard user
|
|
6415
6483
|
# The `/dashboard_user/get` endpoint provides details (such as email address) about a specific Dashboard user based on the `dashboard_user_id` field, which is returned in the `audit_trail` object of certain Monitor and Beacon endpoints. This can be used to identify the specific reviewer who performed a Dashboard action.
|
|
6416
6484
|
# @param dashboard_user_get_request [DashboardUserGetRequest]
|
|
6417
6485
|
# @param [Hash] opts the optional parameters
|
|
@@ -6421,7 +6489,7 @@ module Plaid
|
|
|
6421
6489
|
data
|
|
6422
6490
|
end
|
|
6423
6491
|
|
|
6424
|
-
# Retrieve a
|
|
6492
|
+
# Retrieve a Dashboard user
|
|
6425
6493
|
# The `/dashboard_user/get` endpoint provides details (such as email address) about a specific Dashboard user based on the `dashboard_user_id` field, which is returned in the `audit_trail` object of certain Monitor and Beacon endpoints. This can be used to identify the specific reviewer who performed a Dashboard action.
|
|
6426
6494
|
# @param dashboard_user_get_request [DashboardUserGetRequest]
|
|
6427
6495
|
# @param [Hash] opts the optional parameters
|
|
@@ -6479,8 +6547,8 @@ module Plaid
|
|
|
6479
6547
|
return data, status_code, headers
|
|
6480
6548
|
end
|
|
6481
6549
|
|
|
6482
|
-
# List
|
|
6483
|
-
# The `/dashboard_user/list` endpoint provides details (such as email address) all Dashboard users associated with your account. This can
|
|
6550
|
+
# List Dashboard users
|
|
6551
|
+
# The `/dashboard_user/list` endpoint provides details (such as email address) about all Dashboard users associated with your account. This can be used to audit or track the list of reviewers for Monitor, Beacon, and Identity Verification products.
|
|
6484
6552
|
# @param dashboard_user_list_request [DashboardUserListRequest]
|
|
6485
6553
|
# @param [Hash] opts the optional parameters
|
|
6486
6554
|
# @return [DashboardUserListResponse]
|
|
@@ -6489,8 +6557,8 @@ module Plaid
|
|
|
6489
6557
|
data
|
|
6490
6558
|
end
|
|
6491
6559
|
|
|
6492
|
-
# List
|
|
6493
|
-
# The `/dashboard_user/list` endpoint provides details (such as email address) all Dashboard users associated with your account. This can
|
|
6560
|
+
# List Dashboard users
|
|
6561
|
+
# The `/dashboard_user/list` endpoint provides details (such as email address) about all Dashboard users associated with your account. This can be used to audit or track the list of reviewers for Monitor, Beacon, and Identity Verification products.
|
|
6494
6562
|
# @param dashboard_user_list_request [DashboardUserListRequest]
|
|
6495
6563
|
# @param [Hash] opts the optional parameters
|
|
6496
6564
|
# @return [Array<(DashboardUserListResponse, Integer, Hash)>] DashboardUserListResponse data, response status code and response headers
|
|
@@ -6548,7 +6616,7 @@ module Plaid
|
|
|
6548
6616
|
end
|
|
6549
6617
|
|
|
6550
6618
|
# Search employer database
|
|
6551
|
-
# `/employers/search` allows you the ability to search Plaid
|
|
6619
|
+
# `/employers/search` allows you the ability to search Plaid's database of known employers, for use with Deposit Switch. You can use this endpoint to look up a user's employer in order to confirm that they are supported. Users with non-supported employers can then be routed out of the Deposit Switch flow. The data in the employer database is currently limited. As the Deposit Switch and Income products progress through their respective beta periods, more employers are being regularly added. Because the employer database is frequently updated, we recommend that you do not cache or store data from this endpoint for more than a day.
|
|
6552
6620
|
# @param employers_search_request [EmployersSearchRequest]
|
|
6553
6621
|
# @param [Hash] opts the optional parameters
|
|
6554
6622
|
# @return [EmployersSearchResponse]
|
|
@@ -6558,7 +6626,7 @@ module Plaid
|
|
|
6558
6626
|
end
|
|
6559
6627
|
|
|
6560
6628
|
# Search employer database
|
|
6561
|
-
# `/employers/search` allows you the ability to search Plaid
|
|
6629
|
+
# `/employers/search` allows you the ability to search Plaid's database of known employers, for use with Deposit Switch. You can use this endpoint to look up a user's employer in order to confirm that they are supported. Users with non-supported employers can then be routed out of the Deposit Switch flow. The data in the employer database is currently limited. As the Deposit Switch and Income products progress through their respective beta periods, more employers are being regularly added. Because the employer database is frequently updated, we recommend that you do not cache or store data from this endpoint for more than a day.
|
|
6562
6630
|
# @param employers_search_request [EmployersSearchRequest]
|
|
6563
6631
|
# @param [Hash] opts the optional parameters
|
|
6564
6632
|
# @return [Array<(EmployersSearchResponse, Integer, Hash)>] EmployersSearchResponse data, response status code and response headers
|
|
@@ -6683,6 +6751,206 @@ module Plaid
|
|
|
6683
6751
|
return data, status_code, headers
|
|
6684
6752
|
end
|
|
6685
6753
|
|
|
6754
|
+
# Get FDX Consent Grant
|
|
6755
|
+
# Returns a consent grant by its identifier
|
|
6756
|
+
# @param consent_id [String] Consent Grant Identifier. Uniquely identifies the consent grant
|
|
6757
|
+
# @param [Hash] opts the optional parameters
|
|
6758
|
+
# @return [FDXConsentGrant]
|
|
6759
|
+
def fdx_consents_get(consent_id, opts = {})
|
|
6760
|
+
data, _status_code, _headers = fdx_consents_get_with_http_info(consent_id, opts)
|
|
6761
|
+
data
|
|
6762
|
+
end
|
|
6763
|
+
|
|
6764
|
+
# Get FDX Consent Grant
|
|
6765
|
+
# Returns a consent grant by its identifier
|
|
6766
|
+
# @param consent_id [String] Consent Grant Identifier. Uniquely identifies the consent grant
|
|
6767
|
+
# @param [Hash] opts the optional parameters
|
|
6768
|
+
# @return [Array<(FDXConsentGrant, Integer, Hash)>] FDXConsentGrant data, response status code and response headers
|
|
6769
|
+
def fdx_consents_get_with_http_info(consent_id, opts = {})
|
|
6770
|
+
if @api_client.config.debugging
|
|
6771
|
+
@api_client.config.logger.debug 'Calling API: PlaidApi.fdx_consents_get ...'
|
|
6772
|
+
end
|
|
6773
|
+
# verify the required parameter 'consent_id' is set
|
|
6774
|
+
if @api_client.config.client_side_validation && consent_id.nil?
|
|
6775
|
+
fail ArgumentError, "Missing the required parameter 'consent_id' when calling PlaidApi.fdx_consents_get"
|
|
6776
|
+
end
|
|
6777
|
+
# resource path
|
|
6778
|
+
local_var_path = '/fdx/consents/{consentId}'.sub('{' + 'consentId' + '}', CGI.escape(consent_id.to_s))
|
|
6779
|
+
|
|
6780
|
+
# query parameters
|
|
6781
|
+
query_params = opts[:query_params] || {}
|
|
6782
|
+
|
|
6783
|
+
# header parameters
|
|
6784
|
+
header_params = opts[:header_params] || {}
|
|
6785
|
+
# HTTP header 'Accept' (if needed)
|
|
6786
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
6787
|
+
|
|
6788
|
+
# form parameters
|
|
6789
|
+
form_params = opts[:form_params] || {}
|
|
6790
|
+
|
|
6791
|
+
# http body (model)
|
|
6792
|
+
post_body = opts[:debug_body]
|
|
6793
|
+
|
|
6794
|
+
# return_type
|
|
6795
|
+
return_type = opts[:debug_return_type] || 'FDXConsentGrant'
|
|
6796
|
+
|
|
6797
|
+
# auth_names
|
|
6798
|
+
auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
|
|
6799
|
+
|
|
6800
|
+
new_options = opts.merge(
|
|
6801
|
+
:operation => :"PlaidApi.fdx_consents_get",
|
|
6802
|
+
:header_params => header_params,
|
|
6803
|
+
:query_params => query_params,
|
|
6804
|
+
:form_params => form_params,
|
|
6805
|
+
:body => post_body,
|
|
6806
|
+
:auth_names => auth_names,
|
|
6807
|
+
:return_type => return_type
|
|
6808
|
+
)
|
|
6809
|
+
|
|
6810
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
6811
|
+
if @api_client.config.debugging
|
|
6812
|
+
@api_client.config.logger.debug "API called: PlaidApi#fdx_consents_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
6813
|
+
end
|
|
6814
|
+
return data, status_code, headers
|
|
6815
|
+
end
|
|
6816
|
+
|
|
6817
|
+
# Retrieve FDX Consent Grant revocation records
|
|
6818
|
+
# Returns the revocation history of a consent grant
|
|
6819
|
+
# @param consent_id [String] Consent Grant Identifier. Uniquely identifies the consent grant
|
|
6820
|
+
# @param [Hash] opts the optional parameters
|
|
6821
|
+
# @return [FDXConsentRevocations]
|
|
6822
|
+
def fdx_consents_revocation_get(consent_id, opts = {})
|
|
6823
|
+
data, _status_code, _headers = fdx_consents_revocation_get_with_http_info(consent_id, opts)
|
|
6824
|
+
data
|
|
6825
|
+
end
|
|
6826
|
+
|
|
6827
|
+
# Retrieve FDX Consent Grant revocation records
|
|
6828
|
+
# Returns the revocation history of a consent grant
|
|
6829
|
+
# @param consent_id [String] Consent Grant Identifier. Uniquely identifies the consent grant
|
|
6830
|
+
# @param [Hash] opts the optional parameters
|
|
6831
|
+
# @return [Array<(FDXConsentRevocations, Integer, Hash)>] FDXConsentRevocations data, response status code and response headers
|
|
6832
|
+
def fdx_consents_revocation_get_with_http_info(consent_id, opts = {})
|
|
6833
|
+
if @api_client.config.debugging
|
|
6834
|
+
@api_client.config.logger.debug 'Calling API: PlaidApi.fdx_consents_revocation_get ...'
|
|
6835
|
+
end
|
|
6836
|
+
# verify the required parameter 'consent_id' is set
|
|
6837
|
+
if @api_client.config.client_side_validation && consent_id.nil?
|
|
6838
|
+
fail ArgumentError, "Missing the required parameter 'consent_id' when calling PlaidApi.fdx_consents_revocation_get"
|
|
6839
|
+
end
|
|
6840
|
+
# resource path
|
|
6841
|
+
local_var_path = '/fdx/consents/{consentId}/revocation'.sub('{' + 'consentId' + '}', CGI.escape(consent_id.to_s))
|
|
6842
|
+
|
|
6843
|
+
# query parameters
|
|
6844
|
+
query_params = opts[:query_params] || {}
|
|
6845
|
+
|
|
6846
|
+
# header parameters
|
|
6847
|
+
header_params = opts[:header_params] || {}
|
|
6848
|
+
# HTTP header 'Accept' (if needed)
|
|
6849
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
6850
|
+
|
|
6851
|
+
# form parameters
|
|
6852
|
+
form_params = opts[:form_params] || {}
|
|
6853
|
+
|
|
6854
|
+
# http body (model)
|
|
6855
|
+
post_body = opts[:debug_body]
|
|
6856
|
+
|
|
6857
|
+
# return_type
|
|
6858
|
+
return_type = opts[:debug_return_type] || 'FDXConsentRevocations'
|
|
6859
|
+
|
|
6860
|
+
# auth_names
|
|
6861
|
+
auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
|
|
6862
|
+
|
|
6863
|
+
new_options = opts.merge(
|
|
6864
|
+
:operation => :"PlaidApi.fdx_consents_revocation_get",
|
|
6865
|
+
:header_params => header_params,
|
|
6866
|
+
:query_params => query_params,
|
|
6867
|
+
:form_params => form_params,
|
|
6868
|
+
:body => post_body,
|
|
6869
|
+
:auth_names => auth_names,
|
|
6870
|
+
:return_type => return_type
|
|
6871
|
+
)
|
|
6872
|
+
|
|
6873
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
6874
|
+
if @api_client.config.debugging
|
|
6875
|
+
@api_client.config.logger.debug "API called: PlaidApi#fdx_consents_revocation_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
6876
|
+
end
|
|
6877
|
+
return data, status_code, headers
|
|
6878
|
+
end
|
|
6879
|
+
|
|
6880
|
+
# Revoke FDX Consent Grant
|
|
6881
|
+
# Appends a REVOKED status record to the named consent grant
|
|
6882
|
+
# @param consent_id [String] Consent Grant Identifier. Uniquely identifies the consent grant
|
|
6883
|
+
# @param request_body [Hash<String, Object>]
|
|
6884
|
+
# @param [Hash] opts the optional parameters
|
|
6885
|
+
# @return [nil]
|
|
6886
|
+
def fdx_consents_revoke(consent_id, request_body, opts = {})
|
|
6887
|
+
fdx_consents_revoke_with_http_info(consent_id, request_body, opts)
|
|
6888
|
+
nil
|
|
6889
|
+
end
|
|
6890
|
+
|
|
6891
|
+
# Revoke FDX Consent Grant
|
|
6892
|
+
# Appends a REVOKED status record to the named consent grant
|
|
6893
|
+
# @param consent_id [String] Consent Grant Identifier. Uniquely identifies the consent grant
|
|
6894
|
+
# @param request_body [Hash<String, Object>]
|
|
6895
|
+
# @param [Hash] opts the optional parameters
|
|
6896
|
+
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
|
6897
|
+
def fdx_consents_revoke_with_http_info(consent_id, request_body, opts = {})
|
|
6898
|
+
if @api_client.config.debugging
|
|
6899
|
+
@api_client.config.logger.debug 'Calling API: PlaidApi.fdx_consents_revoke ...'
|
|
6900
|
+
end
|
|
6901
|
+
# verify the required parameter 'consent_id' is set
|
|
6902
|
+
if @api_client.config.client_side_validation && consent_id.nil?
|
|
6903
|
+
fail ArgumentError, "Missing the required parameter 'consent_id' when calling PlaidApi.fdx_consents_revoke"
|
|
6904
|
+
end
|
|
6905
|
+
# verify the required parameter 'request_body' is set
|
|
6906
|
+
if @api_client.config.client_side_validation && request_body.nil?
|
|
6907
|
+
fail ArgumentError, "Missing the required parameter 'request_body' when calling PlaidApi.fdx_consents_revoke"
|
|
6908
|
+
end
|
|
6909
|
+
# resource path
|
|
6910
|
+
local_var_path = '/fdx/consents/{consentId}/revocation'.sub('{' + 'consentId' + '}', CGI.escape(consent_id.to_s))
|
|
6911
|
+
|
|
6912
|
+
# query parameters
|
|
6913
|
+
query_params = opts[:query_params] || {}
|
|
6914
|
+
|
|
6915
|
+
# header parameters
|
|
6916
|
+
header_params = opts[:header_params] || {}
|
|
6917
|
+
# HTTP header 'Accept' (if needed)
|
|
6918
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
6919
|
+
# HTTP header 'Content-Type'
|
|
6920
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
|
6921
|
+
if !content_type.nil?
|
|
6922
|
+
header_params['Content-Type'] = content_type
|
|
6923
|
+
end
|
|
6924
|
+
|
|
6925
|
+
# form parameters
|
|
6926
|
+
form_params = opts[:form_params] || {}
|
|
6927
|
+
|
|
6928
|
+
# http body (model)
|
|
6929
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(request_body)
|
|
6930
|
+
|
|
6931
|
+
# return_type
|
|
6932
|
+
return_type = opts[:debug_return_type]
|
|
6933
|
+
|
|
6934
|
+
# auth_names
|
|
6935
|
+
auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
|
|
6936
|
+
|
|
6937
|
+
new_options = opts.merge(
|
|
6938
|
+
:operation => :"PlaidApi.fdx_consents_revoke",
|
|
6939
|
+
:header_params => header_params,
|
|
6940
|
+
:query_params => query_params,
|
|
6941
|
+
:form_params => form_params,
|
|
6942
|
+
:body => post_body,
|
|
6943
|
+
:auth_names => auth_names,
|
|
6944
|
+
:return_type => return_type
|
|
6945
|
+
)
|
|
6946
|
+
|
|
6947
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
|
|
6948
|
+
if @api_client.config.debugging
|
|
6949
|
+
@api_client.config.logger.debug "API called: PlaidApi#fdx_consents_revoke\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
6950
|
+
end
|
|
6951
|
+
return data, status_code, headers
|
|
6952
|
+
end
|
|
6953
|
+
|
|
6686
6954
|
# Webhook receiver for fdx notifications
|
|
6687
6955
|
# A generic webhook receiver endpoint for FDX Event Notifications
|
|
6688
6956
|
# @param fdx_notification [FDXNotification]
|
|
@@ -7147,7 +7415,7 @@ module Plaid
|
|
|
7147
7415
|
end
|
|
7148
7416
|
|
|
7149
7417
|
# Create autofill for an Identity Verification
|
|
7150
|
-
# Try to autofill an Identity Verification based
|
|
7418
|
+
# Try to autofill an Identity Verification based on the provided phone number, date of birth and country of residence.
|
|
7151
7419
|
# @param identity_verification_autofill_create_request [IdentityVerificationAutofillCreateRequest]
|
|
7152
7420
|
# @param [Hash] opts the optional parameters
|
|
7153
7421
|
# @return [IdentityVerificationAutofillCreateResponse]
|
|
@@ -7157,7 +7425,7 @@ module Plaid
|
|
|
7157
7425
|
end
|
|
7158
7426
|
|
|
7159
7427
|
# Create autofill for an Identity Verification
|
|
7160
|
-
# Try to autofill an Identity Verification based
|
|
7428
|
+
# Try to autofill an Identity Verification based on the provided phone number, date of birth and country of residence.
|
|
7161
7429
|
# @param identity_verification_autofill_create_request [IdentityVerificationAutofillCreateRequest]
|
|
7162
7430
|
# @param [Hash] opts the optional parameters
|
|
7163
7431
|
# @return [Array<(IdentityVerificationAutofillCreateResponse, Integer, Hash)>] IdentityVerificationAutofillCreateResponse data, response status code and response headers
|
|
@@ -7827,7 +8095,7 @@ module Plaid
|
|
|
7827
8095
|
end
|
|
7828
8096
|
|
|
7829
8097
|
# Get details of all supported institutions
|
|
7830
|
-
# Returns a JSON response containing details on all financial institutions currently supported by Plaid. Because Plaid supports thousands of institutions, results are paginated. If there is no overlap between an institution
|
|
8098
|
+
# Returns a JSON response containing details on all financial institutions currently supported by Plaid. Because Plaid supports thousands of institutions, results are paginated. If there is no overlap between an institution's enabled products and a client's enabled products, then the institution will be filtered out from the response. As a result, the number of institutions returned may not match the count specified in the call.
|
|
7831
8099
|
# @param institutions_get_request [InstitutionsGetRequest]
|
|
7832
8100
|
# @param [Hash] opts the optional parameters
|
|
7833
8101
|
# @return [InstitutionsGetResponse]
|
|
@@ -7837,7 +8105,7 @@ module Plaid
|
|
|
7837
8105
|
end
|
|
7838
8106
|
|
|
7839
8107
|
# Get details of all supported institutions
|
|
7840
|
-
# Returns a JSON response containing details on all financial institutions currently supported by Plaid. Because Plaid supports thousands of institutions, results are paginated. If there is no overlap between an institution
|
|
8108
|
+
# Returns a JSON response containing details on all financial institutions currently supported by Plaid. Because Plaid supports thousands of institutions, results are paginated. If there is no overlap between an institution's enabled products and a client's enabled products, then the institution will be filtered out from the response. As a result, the number of institutions returned may not match the count specified in the call.
|
|
7841
8109
|
# @param institutions_get_request [InstitutionsGetRequest]
|
|
7842
8110
|
# @param [Hash] opts the optional parameters
|
|
7843
8111
|
# @return [Array<(InstitutionsGetResponse, Integer, Hash)>] InstitutionsGetResponse data, response status code and response headers
|
|
@@ -8642,8 +8910,8 @@ module Plaid
|
|
|
8642
8910
|
return data, status_code, headers
|
|
8643
8911
|
end
|
|
8644
8912
|
|
|
8645
|
-
# List a user
|
|
8646
|
-
# List a user
|
|
8913
|
+
# List a user's connected applications
|
|
8914
|
+
# List a user's connected applications
|
|
8647
8915
|
# @param item_application_list_request [ItemApplicationListRequest]
|
|
8648
8916
|
# @param [Hash] opts the optional parameters
|
|
8649
8917
|
# @return [ItemApplicationListResponse]
|
|
@@ -8652,8 +8920,8 @@ module Plaid
|
|
|
8652
8920
|
data
|
|
8653
8921
|
end
|
|
8654
8922
|
|
|
8655
|
-
# List a user
|
|
8656
|
-
# List a user
|
|
8923
|
+
# List a user's connected applications
|
|
8924
|
+
# List a user's connected applications
|
|
8657
8925
|
# @param item_application_list_request [ItemApplicationListRequest]
|
|
8658
8926
|
# @param [Hash] opts the optional parameters
|
|
8659
8927
|
# @return [Array<(ItemApplicationListResponse, Integer, Hash)>] ItemApplicationListResponse data, response status code and response headers
|
|
@@ -8778,8 +9046,8 @@ module Plaid
|
|
|
8778
9046
|
return data, status_code, headers
|
|
8779
9047
|
end
|
|
8780
9048
|
|
|
8781
|
-
# Unlink a user
|
|
8782
|
-
# Unlink a user
|
|
9049
|
+
# Unlink a user's connected application
|
|
9050
|
+
# 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.
|
|
8783
9051
|
# @param item_application_unlink_request [ItemApplicationUnlinkRequest]
|
|
8784
9052
|
# @param [Hash] opts the optional parameters
|
|
8785
9053
|
# @return [ItemApplicationUnlinkResponse]
|
|
@@ -8788,8 +9056,8 @@ module Plaid
|
|
|
8788
9056
|
data
|
|
8789
9057
|
end
|
|
8790
9058
|
|
|
8791
|
-
# Unlink a user
|
|
8792
|
-
# Unlink a user
|
|
9059
|
+
# Unlink a user's connected application
|
|
9060
|
+
# 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.
|
|
8793
9061
|
# @param item_application_unlink_request [ItemApplicationUnlinkRequest]
|
|
8794
9062
|
# @param [Hash] opts the optional parameters
|
|
8795
9063
|
# @return [Array<(ItemApplicationUnlinkResponse, Integer, Hash)>] ItemApplicationUnlinkResponse data, response status code and response headers
|
|
@@ -8982,74 +9250,6 @@ module Plaid
|
|
|
8982
9250
|
return data, status_code, headers
|
|
8983
9251
|
end
|
|
8984
9252
|
|
|
8985
|
-
# Report fraud for an Item
|
|
8986
|
-
# Use this endpoint to create a fraud report and terminate the associated Item. The `access_token` associated with the Item will be deactivated and billing for the Item's products will be ended. This endpoint allows you to report various types of fraud incidents including account takeovers, identity fraud, unauthorized transactions, and other security events. The reported data helps improve fraud detection models and provides valuable feedback to enhance the overall security of the Plaid network. Reports can be created for confirmed incidents that have been fully investigated, or for suspected incidents that require further review. You can associate reports with specific users, sessions, or transactions to provide comprehensive context about the incident.
|
|
8987
|
-
# @param item_handle_fraud_report_request [ItemHandleFraudReportRequest]
|
|
8988
|
-
# @param [Hash] opts the optional parameters
|
|
8989
|
-
# @return [ItemHandleFraudReportResponse]
|
|
8990
|
-
def item_handle_fraud_report(item_handle_fraud_report_request, opts = {})
|
|
8991
|
-
data, _status_code, _headers = item_handle_fraud_report_with_http_info(item_handle_fraud_report_request, opts)
|
|
8992
|
-
data
|
|
8993
|
-
end
|
|
8994
|
-
|
|
8995
|
-
# Report fraud for an Item
|
|
8996
|
-
# Use this endpoint to create a fraud report and terminate the associated Item. The `access_token` associated with the Item will be deactivated and billing for the Item's products will be ended. This endpoint allows you to report various types of fraud incidents including account takeovers, identity fraud, unauthorized transactions, and other security events. The reported data helps improve fraud detection models and provides valuable feedback to enhance the overall security of the Plaid network. Reports can be created for confirmed incidents that have been fully investigated, or for suspected incidents that require further review. You can associate reports with specific users, sessions, or transactions to provide comprehensive context about the incident.
|
|
8997
|
-
# @param item_handle_fraud_report_request [ItemHandleFraudReportRequest]
|
|
8998
|
-
# @param [Hash] opts the optional parameters
|
|
8999
|
-
# @return [Array<(ItemHandleFraudReportResponse, Integer, Hash)>] ItemHandleFraudReportResponse data, response status code and response headers
|
|
9000
|
-
def item_handle_fraud_report_with_http_info(item_handle_fraud_report_request, opts = {})
|
|
9001
|
-
if @api_client.config.debugging
|
|
9002
|
-
@api_client.config.logger.debug 'Calling API: PlaidApi.item_handle_fraud_report ...'
|
|
9003
|
-
end
|
|
9004
|
-
# verify the required parameter 'item_handle_fraud_report_request' is set
|
|
9005
|
-
if @api_client.config.client_side_validation && item_handle_fraud_report_request.nil?
|
|
9006
|
-
fail ArgumentError, "Missing the required parameter 'item_handle_fraud_report_request' when calling PlaidApi.item_handle_fraud_report"
|
|
9007
|
-
end
|
|
9008
|
-
# resource path
|
|
9009
|
-
local_var_path = '/item/handle_fraud_report'
|
|
9010
|
-
|
|
9011
|
-
# query parameters
|
|
9012
|
-
query_params = opts[:query_params] || {}
|
|
9013
|
-
|
|
9014
|
-
# header parameters
|
|
9015
|
-
header_params = opts[:header_params] || {}
|
|
9016
|
-
# HTTP header 'Accept' (if needed)
|
|
9017
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
9018
|
-
# HTTP header 'Content-Type'
|
|
9019
|
-
content_type = @api_client.select_header_content_type(['application/json'])
|
|
9020
|
-
if !content_type.nil?
|
|
9021
|
-
header_params['Content-Type'] = content_type
|
|
9022
|
-
end
|
|
9023
|
-
|
|
9024
|
-
# form parameters
|
|
9025
|
-
form_params = opts[:form_params] || {}
|
|
9026
|
-
|
|
9027
|
-
# http body (model)
|
|
9028
|
-
post_body = opts[:debug_body] || @api_client.object_to_http_body(item_handle_fraud_report_request)
|
|
9029
|
-
|
|
9030
|
-
# return_type
|
|
9031
|
-
return_type = opts[:debug_return_type] || 'ItemHandleFraudReportResponse'
|
|
9032
|
-
|
|
9033
|
-
# auth_names
|
|
9034
|
-
auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
|
|
9035
|
-
|
|
9036
|
-
new_options = opts.merge(
|
|
9037
|
-
:operation => :"PlaidApi.item_handle_fraud_report",
|
|
9038
|
-
:header_params => header_params,
|
|
9039
|
-
:query_params => query_params,
|
|
9040
|
-
:form_params => form_params,
|
|
9041
|
-
:body => post_body,
|
|
9042
|
-
:auth_names => auth_names,
|
|
9043
|
-
:return_type => return_type
|
|
9044
|
-
)
|
|
9045
|
-
|
|
9046
|
-
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
|
9047
|
-
if @api_client.config.debugging
|
|
9048
|
-
@api_client.config.logger.debug "API called: PlaidApi#item_handle_fraud_report\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
9049
|
-
end
|
|
9050
|
-
return data, status_code, headers
|
|
9051
|
-
end
|
|
9052
|
-
|
|
9053
9253
|
# Import Item
|
|
9054
9254
|
# `/item/import` creates an Item via your Plaid Exchange Integration and returns an `access_token`. As part of an `/item/import` request, you will include a User ID (`user_auth.user_id`) and Authentication Token (`user_auth.auth_token`) that enable data aggregation through your Plaid Exchange API endpoints. These authentication principals are to be chosen by you. Upon creating an Item via `/item/import`, Plaid will automatically begin an extraction of that Item through the Plaid Exchange infrastructure you have already integrated.
|
|
9055
9255
|
# @param item_import_request [ItemImportRequest]
|
|
@@ -9594,7 +9794,7 @@ module Plaid
|
|
|
9594
9794
|
return data, status_code, headers
|
|
9595
9795
|
end
|
|
9596
9796
|
|
|
9597
|
-
# Exchange the Link Correlation
|
|
9797
|
+
# Exchange the Link Correlation ID for a Link Token
|
|
9598
9798
|
# Exchange an OAuth `link_correlation_id` for the corresponding `link_token`. The `link_correlation_id` is only available for `payment_initiation` products and is provided to the client via the OAuth `redirect_uri` as a query parameter. The `link_correlation_id` is ephemeral and expires in a brief period, after which it can no longer be exchanged for the `link_token`.
|
|
9599
9799
|
# @param link_o_auth_correlation_id_exchange_request [LinkOAuthCorrelationIdExchangeRequest]
|
|
9600
9800
|
# @param [Hash] opts the optional parameters
|
|
@@ -9604,7 +9804,7 @@ module Plaid
|
|
|
9604
9804
|
data
|
|
9605
9805
|
end
|
|
9606
9806
|
|
|
9607
|
-
# Exchange the Link Correlation
|
|
9807
|
+
# Exchange the Link Correlation ID for a Link Token
|
|
9608
9808
|
# Exchange an OAuth `link_correlation_id` for the corresponding `link_token`. The `link_correlation_id` is only available for `payment_initiation` products and is provided to the client via the OAuth `redirect_uri` as a query parameter. The `link_correlation_id` is ephemeral and expires in a brief period, after which it can no longer be exchanged for the `link_token`.
|
|
9609
9809
|
# @param link_o_auth_correlation_id_exchange_request [LinkOAuthCorrelationIdExchangeRequest]
|
|
9610
9810
|
# @param [Hash] opts the optional parameters
|
|
@@ -9798,76 +9998,8 @@ module Plaid
|
|
|
9798
9998
|
return data, status_code, headers
|
|
9799
9999
|
end
|
|
9800
10000
|
|
|
9801
|
-
# Retrieve network insights for the provided `access_tokens`
|
|
9802
|
-
# This endpoint allows you to retrieve the Network Insights from a list of `access_tokens`.
|
|
9803
|
-
# @param network_insights_report_get_request [NetworkInsightsReportGetRequest]
|
|
9804
|
-
# @param [Hash] opts the optional parameters
|
|
9805
|
-
# @return [NetworkInsightsReportGetResponse]
|
|
9806
|
-
def network_insights_report_get(network_insights_report_get_request, opts = {})
|
|
9807
|
-
data, _status_code, _headers = network_insights_report_get_with_http_info(network_insights_report_get_request, opts)
|
|
9808
|
-
data
|
|
9809
|
-
end
|
|
9810
|
-
|
|
9811
|
-
# Retrieve network insights for the provided `access_tokens`
|
|
9812
|
-
# This endpoint allows you to retrieve the Network Insights from a list of `access_tokens`.
|
|
9813
|
-
# @param network_insights_report_get_request [NetworkInsightsReportGetRequest]
|
|
9814
|
-
# @param [Hash] opts the optional parameters
|
|
9815
|
-
# @return [Array<(NetworkInsightsReportGetResponse, Integer, Hash)>] NetworkInsightsReportGetResponse data, response status code and response headers
|
|
9816
|
-
def network_insights_report_get_with_http_info(network_insights_report_get_request, opts = {})
|
|
9817
|
-
if @api_client.config.debugging
|
|
9818
|
-
@api_client.config.logger.debug 'Calling API: PlaidApi.network_insights_report_get ...'
|
|
9819
|
-
end
|
|
9820
|
-
# verify the required parameter 'network_insights_report_get_request' is set
|
|
9821
|
-
if @api_client.config.client_side_validation && network_insights_report_get_request.nil?
|
|
9822
|
-
fail ArgumentError, "Missing the required parameter 'network_insights_report_get_request' when calling PlaidApi.network_insights_report_get"
|
|
9823
|
-
end
|
|
9824
|
-
# resource path
|
|
9825
|
-
local_var_path = '/network_insights/report/get'
|
|
9826
|
-
|
|
9827
|
-
# query parameters
|
|
9828
|
-
query_params = opts[:query_params] || {}
|
|
9829
|
-
|
|
9830
|
-
# header parameters
|
|
9831
|
-
header_params = opts[:header_params] || {}
|
|
9832
|
-
# HTTP header 'Accept' (if needed)
|
|
9833
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
9834
|
-
# HTTP header 'Content-Type'
|
|
9835
|
-
content_type = @api_client.select_header_content_type(['application/json'])
|
|
9836
|
-
if !content_type.nil?
|
|
9837
|
-
header_params['Content-Type'] = content_type
|
|
9838
|
-
end
|
|
9839
|
-
|
|
9840
|
-
# form parameters
|
|
9841
|
-
form_params = opts[:form_params] || {}
|
|
9842
|
-
|
|
9843
|
-
# http body (model)
|
|
9844
|
-
post_body = opts[:debug_body] || @api_client.object_to_http_body(network_insights_report_get_request)
|
|
9845
|
-
|
|
9846
|
-
# return_type
|
|
9847
|
-
return_type = opts[:debug_return_type] || 'NetworkInsightsReportGetResponse'
|
|
9848
|
-
|
|
9849
|
-
# auth_names
|
|
9850
|
-
auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
|
|
9851
|
-
|
|
9852
|
-
new_options = opts.merge(
|
|
9853
|
-
:operation => :"PlaidApi.network_insights_report_get",
|
|
9854
|
-
:header_params => header_params,
|
|
9855
|
-
:query_params => query_params,
|
|
9856
|
-
:form_params => form_params,
|
|
9857
|
-
:body => post_body,
|
|
9858
|
-
:auth_names => auth_names,
|
|
9859
|
-
:return_type => return_type
|
|
9860
|
-
)
|
|
9861
|
-
|
|
9862
|
-
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
|
9863
|
-
if @api_client.config.debugging
|
|
9864
|
-
@api_client.config.logger.debug "API called: PlaidApi#network_insights_report_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
9865
|
-
end
|
|
9866
|
-
return data, status_code, headers
|
|
9867
|
-
end
|
|
9868
|
-
|
|
9869
10001
|
# Check a user's Plaid Network status
|
|
9870
|
-
# The `/network/status/get` endpoint can be used to check whether Plaid has a matching profile for the user. This is useful for determining if a user is eligible for a streamlined experience, such as Layer. To access this endpoint, contact your Plaid
|
|
10002
|
+
# The `/network/status/get` endpoint can be used to check whether Plaid has a matching profile for the user. This is useful for determining if a user is eligible for a streamlined experience, such as Layer. To access this endpoint, contact your Plaid account manager. Note: it is strongly recommended to check for Layer eligibility in the frontend. `/network/status/get` should only be used for checking Layer eligibility if a frontend check is not possible for your use case. For instructions on performing a frontend eligibility check, see the [Layer documentation](https://plaid.com/docs/layer/#integration-overview).
|
|
9871
10003
|
# @param network_status_get_request [NetworkStatusGetRequest]
|
|
9872
10004
|
# @param [Hash] opts the optional parameters
|
|
9873
10005
|
# @return [NetworkStatusGetResponse]
|
|
@@ -9877,7 +10009,7 @@ module Plaid
|
|
|
9877
10009
|
end
|
|
9878
10010
|
|
|
9879
10011
|
# Check a user's Plaid Network status
|
|
9880
|
-
# The `/network/status/get` endpoint can be used to check whether Plaid has a matching profile for the user. This is useful for determining if a user is eligible for a streamlined experience, such as Layer. To access this endpoint, contact your Plaid
|
|
10012
|
+
# The `/network/status/get` endpoint can be used to check whether Plaid has a matching profile for the user. This is useful for determining if a user is eligible for a streamlined experience, such as Layer. To access this endpoint, contact your Plaid account manager. Note: it is strongly recommended to check for Layer eligibility in the frontend. `/network/status/get` should only be used for checking Layer eligibility if a frontend check is not possible for your use case. For instructions on performing a frontend eligibility check, see the [Layer documentation](https://plaid.com/docs/layer/#integration-overview).
|
|
9881
10013
|
# @param network_status_get_request [NetworkStatusGetRequest]
|
|
9882
10014
|
# @param [Hash] opts the optional parameters
|
|
9883
10015
|
# @return [Array<(NetworkStatusGetResponse, Integer, Hash)>] NetworkStatusGetResponse data, response status code and response headers
|
|
@@ -10751,7 +10883,7 @@ module Plaid
|
|
|
10751
10883
|
end
|
|
10752
10884
|
|
|
10753
10885
|
# Create a payment
|
|
10754
|
-
# After creating a payment recipient, you can use the `/payment_initiation/payment/create` endpoint to create a payment to that recipient. Payments can be one-time or standing order (recurring) and can be denominated in either EUR, GBP or other chosen [currency](https://plaid.com/docs/api/products/payment-initiation/#payment_initiation-payment-create-request-amount-currency). If making domestic GBP-denominated payments, your recipient must have been created with
|
|
10886
|
+
# After creating a payment recipient, you can use the `/payment_initiation/payment/create` endpoint to create a payment to that recipient. Payments can be one-time or standing order (recurring) and can be denominated in either EUR, GBP or other chosen [currency](https://plaid.com/docs/api/products/payment-initiation/#payment_initiation-payment-create-request-amount-currency). If making domestic GBP-denominated payments, your recipient must have been created with Bacs numbers. In general, EUR-denominated payments will be sent via SEPA Credit Transfer, GBP-denominated payments will be sent via the Faster Payments network and for non-Eurozone markets typically via the local payment scheme, but the payment network used will be determined by the institution. Payments sent via Faster Payments will typically arrive immediately, while payments sent via SEPA Credit Transfer or other local payment schemes will typically arrive in one business day. Standing orders (recurring payments) must be denominated in GBP and can only be sent to recipients in the UK. Once created, standing order payments cannot be modified or canceled via the API. An end user can cancel or modify a standing order directly on their banking application or website, or by contacting the bank. Standing orders will follow the payment rules of the underlying rails (Faster Payments in UK). Payments can be sent Monday to Friday, excluding bank holidays. If the pre-arranged date falls on a weekend or bank holiday, the payment is made on the next working day. It is not possible to guarantee the exact time the payment will reach the recipient's account, although at least 90% of standing order payments are sent by 6am.
|
|
10755
10887
|
# @param payment_initiation_payment_create_request [PaymentInitiationPaymentCreateRequest]
|
|
10756
10888
|
# @param [Hash] opts the optional parameters
|
|
10757
10889
|
# @return [PaymentInitiationPaymentCreateResponse]
|
|
@@ -10761,7 +10893,7 @@ module Plaid
|
|
|
10761
10893
|
end
|
|
10762
10894
|
|
|
10763
10895
|
# Create a payment
|
|
10764
|
-
# After creating a payment recipient, you can use the `/payment_initiation/payment/create` endpoint to create a payment to that recipient. Payments can be one-time or standing order (recurring) and can be denominated in either EUR, GBP or other chosen [currency](https://plaid.com/docs/api/products/payment-initiation/#payment_initiation-payment-create-request-amount-currency). If making domestic GBP-denominated payments, your recipient must have been created with
|
|
10896
|
+
# After creating a payment recipient, you can use the `/payment_initiation/payment/create` endpoint to create a payment to that recipient. Payments can be one-time or standing order (recurring) and can be denominated in either EUR, GBP or other chosen [currency](https://plaid.com/docs/api/products/payment-initiation/#payment_initiation-payment-create-request-amount-currency). If making domestic GBP-denominated payments, your recipient must have been created with Bacs numbers. In general, EUR-denominated payments will be sent via SEPA Credit Transfer, GBP-denominated payments will be sent via the Faster Payments network and for non-Eurozone markets typically via the local payment scheme, but the payment network used will be determined by the institution. Payments sent via Faster Payments will typically arrive immediately, while payments sent via SEPA Credit Transfer or other local payment schemes will typically arrive in one business day. Standing orders (recurring payments) must be denominated in GBP and can only be sent to recipients in the UK. Once created, standing order payments cannot be modified or canceled via the API. An end user can cancel or modify a standing order directly on their banking application or website, or by contacting the bank. Standing orders will follow the payment rules of the underlying rails (Faster Payments in UK). Payments can be sent Monday to Friday, excluding bank holidays. If the pre-arranged date falls on a weekend or bank holiday, the payment is made on the next working day. It is not possible to guarantee the exact time the payment will reach the recipient's account, although at least 90% of standing order payments are sent by 6am.
|
|
10765
10897
|
# @param payment_initiation_payment_create_request [PaymentInitiationPaymentCreateRequest]
|
|
10766
10898
|
# @param [Hash] opts the optional parameters
|
|
10767
10899
|
# @return [Array<(PaymentInitiationPaymentCreateResponse, Integer, Hash)>] PaymentInitiationPaymentCreateResponse data, response status code and response headers
|
|
@@ -11023,7 +11155,7 @@ module Plaid
|
|
|
11023
11155
|
end
|
|
11024
11156
|
|
|
11025
11157
|
# Create payment recipient
|
|
11026
|
-
# Create a payment recipient for payment initiation. The recipient must be in Europe, within a country that is a member of the Single Euro
|
|
11158
|
+
# Create a payment recipient for payment initiation. The recipient must be in Europe, within a country that is a member of the Single Euro Payments Area (SEPA) or a non-Eurozone country [supported](https://support.plaid.com/hc/en-us/articles/27895826947735-What-Plaid-products-are-supported-in-each-country-and-region) by Plaid. For a standing order (recurring) payment, the recipient must be in the UK. It is recommended to use `bacs` in the UK and `iban` in EU. The endpoint is idempotent: if a developer has already made a request with the same payment details, Plaid will return the same `recipient_id`.
|
|
11027
11159
|
# @param payment_initiation_recipient_create_request [PaymentInitiationRecipientCreateRequest]
|
|
11028
11160
|
# @param [Hash] opts the optional parameters
|
|
11029
11161
|
# @return [PaymentInitiationRecipientCreateResponse]
|
|
@@ -11033,7 +11165,7 @@ module Plaid
|
|
|
11033
11165
|
end
|
|
11034
11166
|
|
|
11035
11167
|
# Create payment recipient
|
|
11036
|
-
# Create a payment recipient for payment initiation. The recipient must be in Europe, within a country that is a member of the Single Euro
|
|
11168
|
+
# Create a payment recipient for payment initiation. The recipient must be in Europe, within a country that is a member of the Single Euro Payments Area (SEPA) or a non-Eurozone country [supported](https://support.plaid.com/hc/en-us/articles/27895826947735-What-Plaid-products-are-supported-in-each-country-and-region) by Plaid. For a standing order (recurring) payment, the recipient must be in the UK. It is recommended to use `bacs` in the UK and `iban` in EU. The endpoint is idempotent: if a developer has already made a request with the same payment details, Plaid will return the same `recipient_id`.
|
|
11037
11169
|
# @param payment_initiation_recipient_create_request [PaymentInitiationRecipientCreateRequest]
|
|
11038
11170
|
# @param [Hash] opts the optional parameters
|
|
11039
11171
|
# @return [Array<(PaymentInitiationRecipientCreateResponse, Integer, Hash)>] PaymentInitiationRecipientCreateResponse data, response status code and response headers
|
|
@@ -11363,7 +11495,7 @@ module Plaid
|
|
|
11363
11495
|
end
|
|
11364
11496
|
|
|
11365
11497
|
# Remove payment profile
|
|
11366
|
-
# Use the `/payment_profile/remove` endpoint to remove a given Payment Profile. Once it
|
|
11498
|
+
# Use the `/payment_profile/remove` endpoint to remove a given Payment Profile. Once it's removed, it can no longer be used to create transfers.
|
|
11367
11499
|
# @param payment_profile_remove_request [PaymentProfileRemoveRequest]
|
|
11368
11500
|
# @param [Hash] opts the optional parameters
|
|
11369
11501
|
# @return [PaymentProfileRemoveResponse]
|
|
@@ -11373,7 +11505,7 @@ module Plaid
|
|
|
11373
11505
|
end
|
|
11374
11506
|
|
|
11375
11507
|
# Remove payment profile
|
|
11376
|
-
# Use the `/payment_profile/remove` endpoint to remove a given Payment Profile. Once it
|
|
11508
|
+
# Use the `/payment_profile/remove` endpoint to remove a given Payment Profile. Once it's removed, it can no longer be used to create transfers.
|
|
11377
11509
|
# @param payment_profile_remove_request [PaymentProfileRemoveRequest]
|
|
11378
11510
|
# @param [Hash] opts the optional parameters
|
|
11379
11511
|
# @return [Array<(PaymentProfileRemoveResponse, Integer, Hash)>] PaymentProfileRemoveResponse data, response status code and response headers
|
|
@@ -11431,7 +11563,7 @@ module Plaid
|
|
|
11431
11563
|
end
|
|
11432
11564
|
|
|
11433
11565
|
# Retrieve the account associated with a processor token
|
|
11434
|
-
# This endpoint returns the account associated with a given processor token. This endpoint retrieves cached information, rather than extracting fresh information from the institution. As a result, the account balance returned may not be up-to-date; for
|
|
11566
|
+
# This endpoint returns the account associated with a given processor token. This endpoint retrieves cached information, rather than extracting fresh information from the institution. As a result, the account balance returned may not be up-to-date; for real-time balance information, use `/processor/balance/get` instead. Note that some information is nullable.
|
|
11435
11567
|
# @param processor_account_get_request [ProcessorAccountGetRequest]
|
|
11436
11568
|
# @param [Hash] opts the optional parameters
|
|
11437
11569
|
# @return [ProcessorAccountGetResponse]
|
|
@@ -11441,7 +11573,7 @@ module Plaid
|
|
|
11441
11573
|
end
|
|
11442
11574
|
|
|
11443
11575
|
# Retrieve the account associated with a processor token
|
|
11444
|
-
# This endpoint returns the account associated with a given processor token. This endpoint retrieves cached information, rather than extracting fresh information from the institution. As a result, the account balance returned may not be up-to-date; for
|
|
11576
|
+
# This endpoint returns the account associated with a given processor token. This endpoint retrieves cached information, rather than extracting fresh information from the institution. As a result, the account balance returned may not be up-to-date; for real-time balance information, use `/processor/balance/get` instead. Note that some information is nullable.
|
|
11445
11577
|
# @param processor_account_get_request [ProcessorAccountGetRequest]
|
|
11446
11578
|
# @param [Hash] opts the optional parameters
|
|
11447
11579
|
# @return [Array<(ProcessorAccountGetResponse, Integer, Hash)>] ProcessorAccountGetResponse data, response status code and response headers
|
|
@@ -12859,7 +12991,7 @@ module Plaid
|
|
|
12859
12991
|
end
|
|
12860
12992
|
|
|
12861
12993
|
# Fetch recurring transaction streams
|
|
12862
|
-
# The `/processor/transactions/recurring/get` endpoint allows developers to receive a summary of the recurring outflow and inflow streams (expenses and deposits) from a user
|
|
12994
|
+
# The `/processor/transactions/recurring/get` endpoint allows developers to receive a summary of the recurring outflow and inflow streams (expenses and deposits) from a user's checking, savings or credit card accounts. Additionally, Plaid provides key insights about each recurring stream including the category, merchant, last amount, and more. Developers can use these insights to build tools and experiences that help their users better manage cash flow, monitor subscriptions, reduce spend, and stay on track with bill payments. This endpoint is offered as an add-on to Transactions. To request access to this endpoint, submit a [product access request](https://dashboard.plaid.com/team/products) or contact your Plaid account manager. This endpoint can only be called on a processor token that has already been initialized with Transactions (either during Link, by specifying it in `/link/token/create`; or after Link, by calling `/processor/transactions/get` or `/processor/transactions/sync`). Once all historical transactions have been fetched, call `/processor/transactions/recurring/get` to receive the Recurring Transactions streams and subscribe to the [`RECURRING_TRANSACTIONS_UPDATE`](https://plaid.com/docs/api/products/transactions/#recurring_transactions_update) webhook. To know when historical transactions have been fetched, if you are using `/processor/transactions/sync` listen for the [`SYNC_UPDATES_AVAILABLE`](https://plaid.com/docs/api/products/transactions/#SyncUpdatesAvailableWebhook-historical-update-complete) webhook and check that the `historical_update_complete` field in the payload is `true`. If using `/processor/transactions/get`, listen for the [`HISTORICAL_UPDATE`](https://plaid.com/docs/api/products/transactions/#historical_update) webhook. After the initial call, you can call `/processor/transactions/recurring/get` endpoint at any point in the future to retrieve the latest summary of recurring streams. Listen to the [`RECURRING_TRANSACTIONS_UPDATE`](https://plaid.com/docs/api/products/transactions/#recurring_transactions_update) webhook to be notified when new updates are available. To receive Transactions webhooks for a processor token, set its webhook URL via the [`/processor/token/webhook/update`](https://plaid.com/docs/api/processor-partners/#processortokenwebhookupdate) endpoint.
|
|
12863
12995
|
# @param processor_transactions_recurring_get_request [ProcessorTransactionsRecurringGetRequest]
|
|
12864
12996
|
# @param [Hash] opts the optional parameters
|
|
12865
12997
|
# @return [ProcessorTransactionsRecurringGetResponse]
|
|
@@ -12869,7 +13001,7 @@ module Plaid
|
|
|
12869
13001
|
end
|
|
12870
13002
|
|
|
12871
13003
|
# Fetch recurring transaction streams
|
|
12872
|
-
# The `/processor/transactions/recurring/get` endpoint allows developers to receive a summary of the recurring outflow and inflow streams (expenses and deposits) from a user
|
|
13004
|
+
# The `/processor/transactions/recurring/get` endpoint allows developers to receive a summary of the recurring outflow and inflow streams (expenses and deposits) from a user's checking, savings or credit card accounts. Additionally, Plaid provides key insights about each recurring stream including the category, merchant, last amount, and more. Developers can use these insights to build tools and experiences that help their users better manage cash flow, monitor subscriptions, reduce spend, and stay on track with bill payments. This endpoint is offered as an add-on to Transactions. To request access to this endpoint, submit a [product access request](https://dashboard.plaid.com/team/products) or contact your Plaid account manager. This endpoint can only be called on a processor token that has already been initialized with Transactions (either during Link, by specifying it in `/link/token/create`; or after Link, by calling `/processor/transactions/get` or `/processor/transactions/sync`). Once all historical transactions have been fetched, call `/processor/transactions/recurring/get` to receive the Recurring Transactions streams and subscribe to the [`RECURRING_TRANSACTIONS_UPDATE`](https://plaid.com/docs/api/products/transactions/#recurring_transactions_update) webhook. To know when historical transactions have been fetched, if you are using `/processor/transactions/sync` listen for the [`SYNC_UPDATES_AVAILABLE`](https://plaid.com/docs/api/products/transactions/#SyncUpdatesAvailableWebhook-historical-update-complete) webhook and check that the `historical_update_complete` field in the payload is `true`. If using `/processor/transactions/get`, listen for the [`HISTORICAL_UPDATE`](https://plaid.com/docs/api/products/transactions/#historical_update) webhook. After the initial call, you can call `/processor/transactions/recurring/get` endpoint at any point in the future to retrieve the latest summary of recurring streams. Listen to the [`RECURRING_TRANSACTIONS_UPDATE`](https://plaid.com/docs/api/products/transactions/#recurring_transactions_update) webhook to be notified when new updates are available. To receive Transactions webhooks for a processor token, set its webhook URL via the [`/processor/token/webhook/update`](https://plaid.com/docs/api/processor-partners/#processortokenwebhookupdate) endpoint.
|
|
12873
13005
|
# @param processor_transactions_recurring_get_request [ProcessorTransactionsRecurringGetRequest]
|
|
12874
13006
|
# @param [Hash] opts the optional parameters
|
|
12875
13007
|
# @return [Array<(ProcessorTransactionsRecurringGetResponse, Integer, Hash)>] ProcessorTransactionsRecurringGetResponse data, response status code and response headers
|
|
@@ -12995,7 +13127,7 @@ module Plaid
|
|
|
12995
13127
|
end
|
|
12996
13128
|
|
|
12997
13129
|
# Get incremental transaction updates on a processor token
|
|
12998
|
-
# The `/processor/transactions/sync` endpoint retrieves transactions associated with an Item and can fetch updates using a cursor to track which updates have already been seen. For important instructions on integrating with `/processor/transactions/sync`, see the [Transactions integration overview](https://plaid.com/docs/transactions/#integration-overview). If you are migrating from an existing integration using `/processor/transactions/get`, see the [Transactions Sync migration guide](https://plaid.com/docs/transactions/sync-migration/). This endpoint supports `credit`, `depository`, and some `loan`-type accounts (only those with account subtype `student`). For `investments` accounts, use `/investments/transactions/get` instead. When retrieving paginated updates, track both the `next_cursor` from the latest response and the original cursor from the first call in which `has_more` was `true`; if a call to `/processor/transactions/sync` fails when retrieving a paginated update (e.g 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. If transactions data is not yet available for the Item, which can happen if the Item was not initialized with transactions during the `/link/token/create` call or if `/processor/transactions/sync` was called within a few seconds of Item creation, `/processor/transactions/sync` will return empty transactions arrays. Plaid typically checks for new transactions data between one and four times per day, depending on the institution. To find out when transactions were last updated for an Item, use the [Item Debugger](https://plaid.com/docs/account/activity/#troubleshooting-with-item-debugger) or call `/item/get`; the `item.status.transactions.last_successful_update` field will show the timestamp of the most recent successful update. To force Plaid to check for new transactions, use the `/processor/transactions/refresh` endpoint. To be alerted when new transactions are available, listen for the [`SYNC_UPDATES_AVAILABLE`](https://plaid.com/docs/api/products/transactions/#sync_updates_available) webhook. To receive Transactions webhooks for a processor token, set its webhook URL via the [`/processor/token/webhook/update`](https://plaid.com/docs/api/processor-partners/#processortokenwebhookupdate) endpoint.
|
|
13130
|
+
# The `/processor/transactions/sync` endpoint retrieves transactions associated with an Item and can fetch updates using a cursor to track which updates have already been seen. For important instructions on integrating with `/processor/transactions/sync`, see the [Transactions integration overview](https://plaid.com/docs/transactions/#integration-overview). If you are migrating from an existing integration using `/processor/transactions/get`, see the [Transactions Sync migration guide](https://plaid.com/docs/transactions/sync-migration/). This endpoint supports `credit`, `depository`, and some `loan`-type accounts (only those with account subtype `student`). For `investments` accounts, use `/investments/transactions/get` instead. When retrieving paginated updates, track both the `next_cursor` from the latest response and the original cursor from the first call in which `has_more` was `true`; if a call to `/processor/transactions/sync` fails when retrieving a paginated update (e.g. 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. If transactions data is not yet available for the Item, which can happen if the Item was not initialized with transactions during the `/link/token/create` call or if `/processor/transactions/sync` was called within a few seconds of Item creation, `/processor/transactions/sync` will return empty transactions arrays. Plaid typically checks for new transactions data between one and four times per day, depending on the institution. To find out when transactions were last updated for an Item, use the [Item Debugger](https://plaid.com/docs/account/activity/#troubleshooting-with-item-debugger) or call `/item/get`; the `item.status.transactions.last_successful_update` field will show the timestamp of the most recent successful update. To force Plaid to check for new transactions, use the `/processor/transactions/refresh` endpoint. To be alerted when new transactions are available, listen for the [`SYNC_UPDATES_AVAILABLE`](https://plaid.com/docs/api/products/transactions/#sync_updates_available) webhook. To receive Transactions webhooks for a processor token, set its webhook URL via the [`/processor/token/webhook/update`](https://plaid.com/docs/api/processor-partners/#processortokenwebhookupdate) endpoint.
|
|
12999
13131
|
# @param processor_transactions_sync_request [ProcessorTransactionsSyncRequest]
|
|
13000
13132
|
# @param [Hash] opts the optional parameters
|
|
13001
13133
|
# @return [ProcessorTransactionsSyncResponse]
|
|
@@ -13005,7 +13137,7 @@ module Plaid
|
|
|
13005
13137
|
end
|
|
13006
13138
|
|
|
13007
13139
|
# Get incremental transaction updates on a processor token
|
|
13008
|
-
# The `/processor/transactions/sync` endpoint retrieves transactions associated with an Item and can fetch updates using a cursor to track which updates have already been seen. For important instructions on integrating with `/processor/transactions/sync`, see the [Transactions integration overview](https://plaid.com/docs/transactions/#integration-overview). If you are migrating from an existing integration using `/processor/transactions/get`, see the [Transactions Sync migration guide](https://plaid.com/docs/transactions/sync-migration/). This endpoint supports `credit`, `depository`, and some `loan`-type accounts (only those with account subtype `student`). For `investments` accounts, use `/investments/transactions/get` instead. When retrieving paginated updates, track both the `next_cursor` from the latest response and the original cursor from the first call in which `has_more` was `true`; if a call to `/processor/transactions/sync` fails when retrieving a paginated update (e.g 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. If transactions data is not yet available for the Item, which can happen if the Item was not initialized with transactions during the `/link/token/create` call or if `/processor/transactions/sync` was called within a few seconds of Item creation, `/processor/transactions/sync` will return empty transactions arrays. Plaid typically checks for new transactions data between one and four times per day, depending on the institution. To find out when transactions were last updated for an Item, use the [Item Debugger](https://plaid.com/docs/account/activity/#troubleshooting-with-item-debugger) or call `/item/get`; the `item.status.transactions.last_successful_update` field will show the timestamp of the most recent successful update. To force Plaid to check for new transactions, use the `/processor/transactions/refresh` endpoint. To be alerted when new transactions are available, listen for the [`SYNC_UPDATES_AVAILABLE`](https://plaid.com/docs/api/products/transactions/#sync_updates_available) webhook. To receive Transactions webhooks for a processor token, set its webhook URL via the [`/processor/token/webhook/update`](https://plaid.com/docs/api/processor-partners/#processortokenwebhookupdate) endpoint.
|
|
13140
|
+
# The `/processor/transactions/sync` endpoint retrieves transactions associated with an Item and can fetch updates using a cursor to track which updates have already been seen. For important instructions on integrating with `/processor/transactions/sync`, see the [Transactions integration overview](https://plaid.com/docs/transactions/#integration-overview). If you are migrating from an existing integration using `/processor/transactions/get`, see the [Transactions Sync migration guide](https://plaid.com/docs/transactions/sync-migration/). This endpoint supports `credit`, `depository`, and some `loan`-type accounts (only those with account subtype `student`). For `investments` accounts, use `/investments/transactions/get` instead. When retrieving paginated updates, track both the `next_cursor` from the latest response and the original cursor from the first call in which `has_more` was `true`; if a call to `/processor/transactions/sync` fails when retrieving a paginated update (e.g. 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. If transactions data is not yet available for the Item, which can happen if the Item was not initialized with transactions during the `/link/token/create` call or if `/processor/transactions/sync` was called within a few seconds of Item creation, `/processor/transactions/sync` will return empty transactions arrays. Plaid typically checks for new transactions data between one and four times per day, depending on the institution. To find out when transactions were last updated for an Item, use the [Item Debugger](https://plaid.com/docs/account/activity/#troubleshooting-with-item-debugger) or call `/item/get`; the `item.status.transactions.last_successful_update` field will show the timestamp of the most recent successful update. To force Plaid to check for new transactions, use the `/processor/transactions/refresh` endpoint. To be alerted when new transactions are available, listen for the [`SYNC_UPDATES_AVAILABLE`](https://plaid.com/docs/api/products/transactions/#sync_updates_available) webhook. To receive Transactions webhooks for a processor token, set its webhook URL via the [`/processor/token/webhook/update`](https://plaid.com/docs/api/processor-partners/#processortokenwebhookupdate) endpoint.
|
|
13009
13141
|
# @param processor_transactions_sync_request [ProcessorTransactionsSyncRequest]
|
|
13010
13142
|
# @param [Hash] opts the optional parameters
|
|
13011
13143
|
# @return [Array<(ProcessorTransactionsSyncResponse, Integer, Hash)>] ProcessorTransactionsSyncResponse data, response status code and response headers
|
|
@@ -13130,8 +13262,8 @@ module Plaid
|
|
|
13130
13262
|
return data, status_code, headers
|
|
13131
13263
|
end
|
|
13132
13264
|
|
|
13133
|
-
# Compute Protect Trust Index
|
|
13134
|
-
#
|
|
13265
|
+
# Compute Protect Trust Index scores and subscores
|
|
13266
|
+
# Compute a Protect Trust Index score for a user. The model selected determines what is scored and what additional fields the response contains. For example, `ti-link-session-2.0` scores a completed Link session for fraud risk; `cash-advance-onboarding-1.0` scores repayment risk for a first-time cash advance and additionally populates per-amount-bucket subscores. Cash-advance models require that the user have a Plaid Item with Transactions enabled, or an Assets Report, before scoring. The endpoint returns HTTP 400 with `error_type` = `INVALID_REQUEST` and `error_code` = `FAILED_PRECONDITION` when a required precondition is not met: for link-session models, when the Link session has not completed; for cash-advance models, when the user has not successfully linked any Item.
|
|
13135
13267
|
# @param protect_compute_request [ProtectComputeRequest]
|
|
13136
13268
|
# @param [Hash] opts the optional parameters
|
|
13137
13269
|
# @return [ProtectComputeResponse]
|
|
@@ -13140,8 +13272,8 @@ module Plaid
|
|
|
13140
13272
|
data
|
|
13141
13273
|
end
|
|
13142
13274
|
|
|
13143
|
-
# Compute Protect Trust Index
|
|
13144
|
-
#
|
|
13275
|
+
# Compute Protect Trust Index scores and subscores
|
|
13276
|
+
# Compute a Protect Trust Index score for a user. The model selected determines what is scored and what additional fields the response contains. For example, `ti-link-session-2.0` scores a completed Link session for fraud risk; `cash-advance-onboarding-1.0` scores repayment risk for a first-time cash advance and additionally populates per-amount-bucket subscores. Cash-advance models require that the user have a Plaid Item with Transactions enabled, or an Assets Report, before scoring. The endpoint returns HTTP 400 with `error_type` = `INVALID_REQUEST` and `error_code` = `FAILED_PRECONDITION` when a required precondition is not met: for link-session models, when the Link session has not completed; for cash-advance models, when the user has not successfully linked any Item.
|
|
13145
13277
|
# @param protect_compute_request [ProtectComputeRequest]
|
|
13146
13278
|
# @param [Hash] opts the optional parameters
|
|
13147
13279
|
# @return [Array<(ProtectComputeResponse, Integer, Hash)>] ProtectComputeResponse data, response status code and response headers
|
|
@@ -13335,7 +13467,7 @@ module Plaid
|
|
|
13335
13467
|
end
|
|
13336
13468
|
|
|
13337
13469
|
# Create a Protect report
|
|
13338
|
-
# Use this endpoint to create a Protect report to document fraud incidents, investigation outcomes, or other risk events. This endpoint allows you to report various types of incidents including account takeovers, identity fraud, unauthorized transactions, and other security events. The reported data helps improve fraud detection models and provides valuable feedback to enhance the overall security of the Plaid network. Reports can be created for confirmed incidents that have been fully investigated, or for suspected incidents that require further review. You can associate reports with specific users, sessions, or transactions to provide comprehensive context about the incident.
|
|
13470
|
+
# Use this endpoint to create a Protect report to document fraud incidents, investigation outcomes, or other risk events. This endpoint allows you to report various types of incidents including account takeovers, identity fraud, unauthorized transactions, and other security events. The reported data helps improve fraud detection models and provides valuable feedback to enhance the overall security of the Plaid network. Reports can be created for confirmed incidents that have been fully investigated, or for suspected incidents that require further review. You can associate reports with specific users, sessions, or transactions to provide comprehensive context about the incident. Each report must include `user_id`, or an `incident_event` with at least one supported identifier: `link_session_id`, `idv_session_id`, `protect_event_id`, `signal_client_transaction_id`, or `access_token`. Context fields such as `internal_reference`, `time`, `amount`, and `bank_account` do not satisfy this identifier requirement.
|
|
13339
13471
|
# @param protect_report_create_request [ProtectReportCreateRequest]
|
|
13340
13472
|
# @param [Hash] opts the optional parameters
|
|
13341
13473
|
# @return [ProtectReportCreateResponse]
|
|
@@ -13345,7 +13477,7 @@ module Plaid
|
|
|
13345
13477
|
end
|
|
13346
13478
|
|
|
13347
13479
|
# Create a Protect report
|
|
13348
|
-
# Use this endpoint to create a Protect report to document fraud incidents, investigation outcomes, or other risk events. This endpoint allows you to report various types of incidents including account takeovers, identity fraud, unauthorized transactions, and other security events. The reported data helps improve fraud detection models and provides valuable feedback to enhance the overall security of the Plaid network. Reports can be created for confirmed incidents that have been fully investigated, or for suspected incidents that require further review. You can associate reports with specific users, sessions, or transactions to provide comprehensive context about the incident.
|
|
13480
|
+
# Use this endpoint to create a Protect report to document fraud incidents, investigation outcomes, or other risk events. This endpoint allows you to report various types of incidents including account takeovers, identity fraud, unauthorized transactions, and other security events. The reported data helps improve fraud detection models and provides valuable feedback to enhance the overall security of the Plaid network. Reports can be created for confirmed incidents that have been fully investigated, or for suspected incidents that require further review. You can associate reports with specific users, sessions, or transactions to provide comprehensive context about the incident. Each report must include `user_id`, or an `incident_event` with at least one supported identifier: `link_session_id`, `idv_session_id`, `protect_event_id`, `signal_client_transaction_id`, or `access_token`. Context fields such as `internal_reference`, `time`, `amount`, and `bank_account` do not satisfy this identifier requirement.
|
|
13349
13481
|
# @param protect_report_create_request [ProtectReportCreateRequest]
|
|
13350
13482
|
# @param [Hash] opts the optional parameters
|
|
13351
13483
|
# @return [Array<(ProtectReportCreateResponse, Integer, Hash)>] ProtectReportCreateResponse data, response status code and response headers
|
|
@@ -13470,7 +13602,7 @@ module Plaid
|
|
|
13470
13602
|
return data, status_code, headers
|
|
13471
13603
|
end
|
|
13472
13604
|
|
|
13473
|
-
# Manually fire a
|
|
13605
|
+
# Manually fire a Bank Income webhook in Sandbox
|
|
13474
13606
|
# Use the `/sandbox/bank_income/fire_webhook` endpoint to manually trigger a Bank Income webhook in the Sandbox environment.
|
|
13475
13607
|
# @param sandbox_bank_income_fire_webhook_request [SandboxBankIncomeFireWebhookRequest]
|
|
13476
13608
|
# @param [Hash] opts the optional parameters
|
|
@@ -13480,7 +13612,7 @@ module Plaid
|
|
|
13480
13612
|
data
|
|
13481
13613
|
end
|
|
13482
13614
|
|
|
13483
|
-
# Manually fire a
|
|
13615
|
+
# Manually fire a Bank Income webhook in Sandbox
|
|
13484
13616
|
# Use the `/sandbox/bank_income/fire_webhook` endpoint to manually trigger a Bank Income webhook in the Sandbox environment.
|
|
13485
13617
|
# @param sandbox_bank_income_fire_webhook_request [SandboxBankIncomeFireWebhookRequest]
|
|
13486
13618
|
# @param [Hash] opts the optional parameters
|
|
@@ -13810,8 +13942,76 @@ module Plaid
|
|
|
13810
13942
|
return data, status_code, headers
|
|
13811
13943
|
end
|
|
13812
13944
|
|
|
13945
|
+
# Seed a connected application for a Permissions Manager sandbox item
|
|
13946
|
+
# `/sandbox/item/application/seed` creates a test connected application on an existing Permissions Manager Item's login. The seeded application will appear in subsequent calls to `/item/application/list`. The `access_token` must belong to a Permissions Manager Item created via `/item/import` in Sandbox. The `application_id` identifies the application to seed as a connected app. To disconnect a seeded application, use `/item/application/unlink`.
|
|
13947
|
+
# @param sandbox_item_application_seed_request [SandboxItemApplicationSeedRequest]
|
|
13948
|
+
# @param [Hash] opts the optional parameters
|
|
13949
|
+
# @return [SandboxItemApplicationSeedResponse]
|
|
13950
|
+
def sandbox_item_application_seed(sandbox_item_application_seed_request, opts = {})
|
|
13951
|
+
data, _status_code, _headers = sandbox_item_application_seed_with_http_info(sandbox_item_application_seed_request, opts)
|
|
13952
|
+
data
|
|
13953
|
+
end
|
|
13954
|
+
|
|
13955
|
+
# Seed a connected application for a Permissions Manager sandbox item
|
|
13956
|
+
# `/sandbox/item/application/seed` creates a test connected application on an existing Permissions Manager Item's login. The seeded application will appear in subsequent calls to `/item/application/list`. The `access_token` must belong to a Permissions Manager Item created via `/item/import` in Sandbox. The `application_id` identifies the application to seed as a connected app. To disconnect a seeded application, use `/item/application/unlink`.
|
|
13957
|
+
# @param sandbox_item_application_seed_request [SandboxItemApplicationSeedRequest]
|
|
13958
|
+
# @param [Hash] opts the optional parameters
|
|
13959
|
+
# @return [Array<(SandboxItemApplicationSeedResponse, Integer, Hash)>] SandboxItemApplicationSeedResponse data, response status code and response headers
|
|
13960
|
+
def sandbox_item_application_seed_with_http_info(sandbox_item_application_seed_request, opts = {})
|
|
13961
|
+
if @api_client.config.debugging
|
|
13962
|
+
@api_client.config.logger.debug 'Calling API: PlaidApi.sandbox_item_application_seed ...'
|
|
13963
|
+
end
|
|
13964
|
+
# verify the required parameter 'sandbox_item_application_seed_request' is set
|
|
13965
|
+
if @api_client.config.client_side_validation && sandbox_item_application_seed_request.nil?
|
|
13966
|
+
fail ArgumentError, "Missing the required parameter 'sandbox_item_application_seed_request' when calling PlaidApi.sandbox_item_application_seed"
|
|
13967
|
+
end
|
|
13968
|
+
# resource path
|
|
13969
|
+
local_var_path = '/sandbox/item/application/seed'
|
|
13970
|
+
|
|
13971
|
+
# query parameters
|
|
13972
|
+
query_params = opts[:query_params] || {}
|
|
13973
|
+
|
|
13974
|
+
# header parameters
|
|
13975
|
+
header_params = opts[:header_params] || {}
|
|
13976
|
+
# HTTP header 'Accept' (if needed)
|
|
13977
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
13978
|
+
# HTTP header 'Content-Type'
|
|
13979
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
|
13980
|
+
if !content_type.nil?
|
|
13981
|
+
header_params['Content-Type'] = content_type
|
|
13982
|
+
end
|
|
13983
|
+
|
|
13984
|
+
# form parameters
|
|
13985
|
+
form_params = opts[:form_params] || {}
|
|
13986
|
+
|
|
13987
|
+
# http body (model)
|
|
13988
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(sandbox_item_application_seed_request)
|
|
13989
|
+
|
|
13990
|
+
# return_type
|
|
13991
|
+
return_type = opts[:debug_return_type] || 'SandboxItemApplicationSeedResponse'
|
|
13992
|
+
|
|
13993
|
+
# auth_names
|
|
13994
|
+
auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
|
|
13995
|
+
|
|
13996
|
+
new_options = opts.merge(
|
|
13997
|
+
:operation => :"PlaidApi.sandbox_item_application_seed",
|
|
13998
|
+
:header_params => header_params,
|
|
13999
|
+
:query_params => query_params,
|
|
14000
|
+
:form_params => form_params,
|
|
14001
|
+
:body => post_body,
|
|
14002
|
+
:auth_names => auth_names,
|
|
14003
|
+
:return_type => return_type
|
|
14004
|
+
)
|
|
14005
|
+
|
|
14006
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
|
14007
|
+
if @api_client.config.debugging
|
|
14008
|
+
@api_client.config.logger.debug "API called: PlaidApi#sandbox_item_application_seed\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
14009
|
+
end
|
|
14010
|
+
return data, status_code, headers
|
|
14011
|
+
end
|
|
14012
|
+
|
|
13813
14013
|
# Fire a test webhook
|
|
13814
|
-
# The `/sandbox/item/fire_webhook` endpoint is used to test that code correctly handles webhooks. This endpoint can trigger the following webhooks: `DEFAULT_UPDATE`: Webhook to be fired for a given Sandbox Item simulating a default update event for the respective product as specified with the `webhook_type` in the request body. Valid Sandbox `DEFAULT_UPDATE` webhook types include: `AUTH`, `IDENTITY`, `TRANSACTIONS`, `INVESTMENTS_TRANSACTIONS`, `LIABILITIES`, `HOLDINGS`. If the Item does not support the product, a `SANDBOX_PRODUCT_NOT_ENABLED` error will result. `NEW_ACCOUNTS_AVAILABLE`: Fired to indicate that a new account is available on the Item and you can launch update mode to request access to it. `SMS_MICRODEPOSITS_VERIFICATION`: Fired when a given
|
|
14014
|
+
# The `/sandbox/item/fire_webhook` endpoint is used to test that code correctly handles webhooks. This endpoint can trigger the following webhooks: `DEFAULT_UPDATE`: Webhook to be fired for a given Sandbox Item simulating a default update event for the respective product as specified with the `webhook_type` in the request body. Valid Sandbox `DEFAULT_UPDATE` webhook types include: `AUTH`, `IDENTITY`, `TRANSACTIONS`, `INVESTMENTS_TRANSACTIONS`, `LIABILITIES`, `HOLDINGS`. If the Item does not support the product, a `SANDBOX_PRODUCT_NOT_ENABLED` error will result. `NEW_ACCOUNTS_AVAILABLE`: Fired to indicate that a new account is available on the Item and you can launch update mode to request access to it. `SMS_MICRODEPOSITS_VERIFICATION`: Fired when a given Same-Day Micro-deposit Item is verified via SMS verification. `LOGIN_REPAIRED`: Fired when an Item recovers from the `ITEM_LOGIN_REQUIRED` without the user going through update mode in your app. `PENDING_DISCONNECT`: Fired when an Item will stop working in the near future (e.g. due to a planned bank migration) and must be sent through update mode to continue working. `RECURRING_TRANSACTIONS_UPDATE`: Recurring Transactions webhook to be fired for a given Sandbox Item. If the Item does not support Recurring Transactions, a `SANDBOX_PRODUCT_NOT_ENABLED` error will result. `SYNC_UPDATES_AVAILABLE`: Transactions webhook to be fired for a given Sandbox Item. If the Item does not support Transactions, a `SANDBOX_PRODUCT_NOT_ENABLED` error will result. `PRODUCT_READY`: Assets webhook to be fired when a given asset report has been successfully generated. If the Item does not support Assets, a `SANDBOX_PRODUCT_NOT_ENABLED` error will result. `ERROR`: Assets webhook to be fired when asset report generation has failed. If the Item does not support Assets, a `SANDBOX_PRODUCT_NOT_ENABLED` error will result. `USER_PERMISSION_REVOKED`: Indicates an end user has revoked the permission that they previously granted to access an Item. May not always fire upon revocation, as some institutions' consent portals do not trigger this webhook. Upon receiving this webhook, it is recommended to delete any stored data from Plaid associated with the account or Item. `USER_ACCOUNT_REVOKED`: Fired when an end user has revoked access to their account on the Data Provider's portal. This webhook is currently sent only for PNC Items, but may be sent in the future for other financial institutions. Upon receiving this webhook, it is recommended to delete any stored data from Plaid associated with the account or Item. Note that this endpoint is provided for developer ease-of-use and is not required for testing webhooks; webhooks will also fire in Sandbox under the same conditions that they would in Production (except for webhooks of type `TRANSFER`).
|
|
13815
14015
|
# @param sandbox_item_fire_webhook_request [SandboxItemFireWebhookRequest]
|
|
13816
14016
|
# @param [Hash] opts the optional parameters
|
|
13817
14017
|
# @return [SandboxItemFireWebhookResponse]
|
|
@@ -13821,7 +14021,7 @@ module Plaid
|
|
|
13821
14021
|
end
|
|
13822
14022
|
|
|
13823
14023
|
# Fire a test webhook
|
|
13824
|
-
# The `/sandbox/item/fire_webhook` endpoint is used to test that code correctly handles webhooks. This endpoint can trigger the following webhooks: `DEFAULT_UPDATE`: Webhook to be fired for a given Sandbox Item simulating a default update event for the respective product as specified with the `webhook_type` in the request body. Valid Sandbox `DEFAULT_UPDATE` webhook types include: `AUTH`, `IDENTITY`, `TRANSACTIONS`, `INVESTMENTS_TRANSACTIONS`, `LIABILITIES`, `HOLDINGS`. If the Item does not support the product, a `SANDBOX_PRODUCT_NOT_ENABLED` error will result. `NEW_ACCOUNTS_AVAILABLE`: Fired to indicate that a new account is available on the Item and you can launch update mode to request access to it. `SMS_MICRODEPOSITS_VERIFICATION`: Fired when a given
|
|
14024
|
+
# The `/sandbox/item/fire_webhook` endpoint is used to test that code correctly handles webhooks. This endpoint can trigger the following webhooks: `DEFAULT_UPDATE`: Webhook to be fired for a given Sandbox Item simulating a default update event for the respective product as specified with the `webhook_type` in the request body. Valid Sandbox `DEFAULT_UPDATE` webhook types include: `AUTH`, `IDENTITY`, `TRANSACTIONS`, `INVESTMENTS_TRANSACTIONS`, `LIABILITIES`, `HOLDINGS`. If the Item does not support the product, a `SANDBOX_PRODUCT_NOT_ENABLED` error will result. `NEW_ACCOUNTS_AVAILABLE`: Fired to indicate that a new account is available on the Item and you can launch update mode to request access to it. `SMS_MICRODEPOSITS_VERIFICATION`: Fired when a given Same-Day Micro-deposit Item is verified via SMS verification. `LOGIN_REPAIRED`: Fired when an Item recovers from the `ITEM_LOGIN_REQUIRED` without the user going through update mode in your app. `PENDING_DISCONNECT`: Fired when an Item will stop working in the near future (e.g. due to a planned bank migration) and must be sent through update mode to continue working. `RECURRING_TRANSACTIONS_UPDATE`: Recurring Transactions webhook to be fired for a given Sandbox Item. If the Item does not support Recurring Transactions, a `SANDBOX_PRODUCT_NOT_ENABLED` error will result. `SYNC_UPDATES_AVAILABLE`: Transactions webhook to be fired for a given Sandbox Item. If the Item does not support Transactions, a `SANDBOX_PRODUCT_NOT_ENABLED` error will result. `PRODUCT_READY`: Assets webhook to be fired when a given asset report has been successfully generated. If the Item does not support Assets, a `SANDBOX_PRODUCT_NOT_ENABLED` error will result. `ERROR`: Assets webhook to be fired when asset report generation has failed. If the Item does not support Assets, a `SANDBOX_PRODUCT_NOT_ENABLED` error will result. `USER_PERMISSION_REVOKED`: Indicates an end user has revoked the permission that they previously granted to access an Item. May not always fire upon revocation, as some institutions' consent portals do not trigger this webhook. Upon receiving this webhook, it is recommended to delete any stored data from Plaid associated with the account or Item. `USER_ACCOUNT_REVOKED`: Fired when an end user has revoked access to their account on the Data Provider's portal. This webhook is currently sent only for PNC Items, but may be sent in the future for other financial institutions. Upon receiving this webhook, it is recommended to delete any stored data from Plaid associated with the account or Item. Note that this endpoint is provided for developer ease-of-use and is not required for testing webhooks; webhooks will also fire in Sandbox under the same conditions that they would in Production (except for webhooks of type `TRANSFER`).
|
|
13825
14025
|
# @param sandbox_item_fire_webhook_request [SandboxItemFireWebhookRequest]
|
|
13826
14026
|
# @param [Hash] opts the optional parameters
|
|
13827
14027
|
# @return [Array<(SandboxItemFireWebhookResponse, Integer, Hash)>] SandboxItemFireWebhookResponse data, response status code and response headers
|
|
@@ -13879,7 +14079,7 @@ module Plaid
|
|
|
13879
14079
|
end
|
|
13880
14080
|
|
|
13881
14081
|
# Force a Sandbox Item into an error state
|
|
13882
|
-
# `/sandbox/item/reset_login/` forces an Item into an `ITEM_LOGIN_REQUIRED` state in order to simulate an Item whose login is no longer valid. This makes it easy to test Link's [update mode](https://plaid.com/docs/link/update-mode) flow in the Sandbox environment. After calling `/sandbox/item/reset_login`,
|
|
14082
|
+
# `/sandbox/item/reset_login/` forces an Item into an `ITEM_LOGIN_REQUIRED` state in order to simulate an Item whose login is no longer valid. This makes it easy to test Link's [update mode](https://plaid.com/docs/link/update-mode) flow in the Sandbox environment. After calling `/sandbox/item/reset_login`, you can then use Plaid Link update mode to restore the Item to a good state. An `ITEM_LOGIN_REQUIRED` webhook will also be fired after a call to this endpoint, if one is associated with the Item. In the Sandbox, Items will transition to an `ITEM_LOGIN_REQUIRED` error state automatically after 30 days, even if this endpoint is not called.
|
|
13883
14083
|
# @param sandbox_item_reset_login_request [SandboxItemResetLoginRequest]
|
|
13884
14084
|
# @param [Hash] opts the optional parameters
|
|
13885
14085
|
# @return [SandboxItemResetLoginResponse]
|
|
@@ -13889,7 +14089,7 @@ module Plaid
|
|
|
13889
14089
|
end
|
|
13890
14090
|
|
|
13891
14091
|
# Force a Sandbox Item into an error state
|
|
13892
|
-
# `/sandbox/item/reset_login/` forces an Item into an `ITEM_LOGIN_REQUIRED` state in order to simulate an Item whose login is no longer valid. This makes it easy to test Link's [update mode](https://plaid.com/docs/link/update-mode) flow in the Sandbox environment. After calling `/sandbox/item/reset_login`,
|
|
14092
|
+
# `/sandbox/item/reset_login/` forces an Item into an `ITEM_LOGIN_REQUIRED` state in order to simulate an Item whose login is no longer valid. This makes it easy to test Link's [update mode](https://plaid.com/docs/link/update-mode) flow in the Sandbox environment. After calling `/sandbox/item/reset_login`, you can then use Plaid Link update mode to restore the Item to a good state. An `ITEM_LOGIN_REQUIRED` webhook will also be fired after a call to this endpoint, if one is associated with the Item. In the Sandbox, Items will transition to an `ITEM_LOGIN_REQUIRED` error state automatically after 30 days, even if this endpoint is not called.
|
|
13893
14093
|
# @param sandbox_item_reset_login_request [SandboxItemResetLoginRequest]
|
|
13894
14094
|
# @param [Hash] opts the optional parameters
|
|
13895
14095
|
# @return [Array<(SandboxItemResetLoginResponse, Integer, Hash)>] SandboxItemResetLoginResponse data, response status code and response headers
|
|
@@ -13947,7 +14147,7 @@ module Plaid
|
|
|
13947
14147
|
end
|
|
13948
14148
|
|
|
13949
14149
|
# Set verification status for Sandbox account
|
|
13950
|
-
# The `/sandbox/item/set_verification_status` endpoint can be used to change the verification status of an Item in
|
|
14150
|
+
# The `/sandbox/item/set_verification_status` endpoint can be used to change the verification status of an Item in the Sandbox in order to simulate the Automated Micro-deposit flow. For more information on testing Automated Micro-deposits in Sandbox, see [Auth full coverage testing](https://plaid.com/docs/auth/coverage/testing#).
|
|
13951
14151
|
# @param sandbox_item_set_verification_status_request [SandboxItemSetVerificationStatusRequest]
|
|
13952
14152
|
# @param [Hash] opts the optional parameters
|
|
13953
14153
|
# @return [SandboxItemSetVerificationStatusResponse]
|
|
@@ -13957,7 +14157,7 @@ module Plaid
|
|
|
13957
14157
|
end
|
|
13958
14158
|
|
|
13959
14159
|
# Set verification status for Sandbox account
|
|
13960
|
-
# The `/sandbox/item/set_verification_status` endpoint can be used to change the verification status of an Item in
|
|
14160
|
+
# The `/sandbox/item/set_verification_status` endpoint can be used to change the verification status of an Item in the Sandbox in order to simulate the Automated Micro-deposit flow. For more information on testing Automated Micro-deposits in Sandbox, see [Auth full coverage testing](https://plaid.com/docs/auth/coverage/testing#).
|
|
13961
14161
|
# @param sandbox_item_set_verification_status_request [SandboxItemSetVerificationStatusRequest]
|
|
13962
14162
|
# @param [Hash] opts the optional parameters
|
|
13963
14163
|
# @return [Array<(SandboxItemSetVerificationStatusResponse, Integer, Hash)>] SandboxItemSetVerificationStatusResponse data, response status code and response headers
|
|
@@ -14014,8 +14214,8 @@ module Plaid
|
|
|
14014
14214
|
return data, status_code, headers
|
|
14015
14215
|
end
|
|
14016
14216
|
|
|
14017
|
-
# Save the selected accounts when connecting to the Platypus
|
|
14018
|
-
# Save the selected accounts when connecting to the Platypus
|
|
14217
|
+
# Save the selected accounts when connecting to the Platypus OAuth institution
|
|
14218
|
+
# Save the selected accounts when connecting to the Platypus OAuth institution
|
|
14019
14219
|
# @param sandbox_oauth_select_accounts_request [SandboxOauthSelectAccountsRequest]
|
|
14020
14220
|
# @param [Hash] opts the optional parameters
|
|
14021
14221
|
# @return [Hash<String, Object>]
|
|
@@ -14024,8 +14224,8 @@ module Plaid
|
|
|
14024
14224
|
data
|
|
14025
14225
|
end
|
|
14026
14226
|
|
|
14027
|
-
# Save the selected accounts when connecting to the Platypus
|
|
14028
|
-
# Save the selected accounts when connecting to the Platypus
|
|
14227
|
+
# Save the selected accounts when connecting to the Platypus OAuth institution
|
|
14228
|
+
# Save the selected accounts when connecting to the Platypus OAuth institution
|
|
14029
14229
|
# @param sandbox_oauth_select_accounts_request [SandboxOauthSelectAccountsRequest]
|
|
14030
14230
|
# @param [Hash] opts the optional parameters
|
|
14031
14231
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
|
@@ -14355,7 +14555,7 @@ module Plaid
|
|
|
14355
14555
|
end
|
|
14356
14556
|
|
|
14357
14557
|
# Create sandbox transactions
|
|
14358
|
-
# Use the `/sandbox/transactions/create` endpoint to create new transactions for an existing Item. This endpoint can be used to add up to 10 transactions to any Item at a time. This endpoint can only be used with Items that were created in the Sandbox environment using the `user_transactions_dynamic` test user. You can use this to add transactions to test the `/transactions/get` and `/transactions/sync` endpoints.
|
|
14558
|
+
# Use the `/sandbox/transactions/create` endpoint to create new transactions for an existing Item. This endpoint can be used to add up to 10 transactions to any Item at a time. This endpoint can only be used with Items that were created in the Sandbox environment using the `user_transactions_dynamic` test user. You can use this to add transactions to test the `/transactions/get` and `/transactions/sync` endpoints. Custom transactions are only applied to the depository account. Support for per-account targeting may be added in the future.
|
|
14359
14559
|
# @param sandbox_transactions_create_request [SandboxTransactionsCreateRequest]
|
|
14360
14560
|
# @param [Hash] opts the optional parameters
|
|
14361
14561
|
# @return [SandboxTransactionsCreateResponse]
|
|
@@ -14365,7 +14565,7 @@ module Plaid
|
|
|
14365
14565
|
end
|
|
14366
14566
|
|
|
14367
14567
|
# Create sandbox transactions
|
|
14368
|
-
# Use the `/sandbox/transactions/create` endpoint to create new transactions for an existing Item. This endpoint can be used to add up to 10 transactions to any Item at a time. This endpoint can only be used with Items that were created in the Sandbox environment using the `user_transactions_dynamic` test user. You can use this to add transactions to test the `/transactions/get` and `/transactions/sync` endpoints.
|
|
14568
|
+
# Use the `/sandbox/transactions/create` endpoint to create new transactions for an existing Item. This endpoint can be used to add up to 10 transactions to any Item at a time. This endpoint can only be used with Items that were created in the Sandbox environment using the `user_transactions_dynamic` test user. You can use this to add transactions to test the `/transactions/get` and `/transactions/sync` endpoints. Custom transactions are only applied to the depository account. Support for per-account targeting may be added in the future.
|
|
14369
14569
|
# @param sandbox_transactions_create_request [SandboxTransactionsCreateRequest]
|
|
14370
14570
|
# @param [Hash] opts the optional parameters
|
|
14371
14571
|
# @return [Array<(SandboxTransactionsCreateResponse, Integer, Hash)>] SandboxTransactionsCreateResponse data, response status code and response headers
|
|
@@ -15239,7 +15439,7 @@ module Plaid
|
|
|
15239
15439
|
end
|
|
15240
15440
|
|
|
15241
15441
|
# Force item(s) for a Sandbox User into an error state
|
|
15242
|
-
# `/sandbox/user/reset_login/` functions the same as `/sandbox/item/reset_login`, but will modify Items related to a User. This endpoint forces each Item into an `ITEM_LOGIN_REQUIRED` state in order to simulate an Item whose login is no longer valid. This makes it easy to test Link's [update mode](https://plaid.com/docs/link/update-mode) flow in the Sandbox environment. After calling `/sandbox/user/reset_login`,
|
|
15442
|
+
# `/sandbox/user/reset_login/` functions the same as `/sandbox/item/reset_login`, but will modify Items related to a User. This endpoint forces each Item into an `ITEM_LOGIN_REQUIRED` state in order to simulate an Item whose login is no longer valid. This makes it easy to test Link's [update mode](https://plaid.com/docs/link/update-mode) flow in the Sandbox environment. After calling `/sandbox/user/reset_login`, you can then use Plaid Link update mode to restore Items associated with the User to a good state. An `ITEM_LOGIN_REQUIRED` webhook will also be fired after a call to this endpoint, if one is associated with the Item. In the Sandbox, Items will transition to an `ITEM_LOGIN_REQUIRED` error state automatically after 30 days, even if this endpoint is not called.
|
|
15243
15443
|
# @param sandbox_user_reset_login_request [SandboxUserResetLoginRequest]
|
|
15244
15444
|
# @param [Hash] opts the optional parameters
|
|
15245
15445
|
# @return [SandboxUserResetLoginResponse]
|
|
@@ -15249,7 +15449,7 @@ module Plaid
|
|
|
15249
15449
|
end
|
|
15250
15450
|
|
|
15251
15451
|
# Force item(s) for a Sandbox User into an error state
|
|
15252
|
-
# `/sandbox/user/reset_login/` functions the same as `/sandbox/item/reset_login`, but will modify Items related to a User. This endpoint forces each Item into an `ITEM_LOGIN_REQUIRED` state in order to simulate an Item whose login is no longer valid. This makes it easy to test Link's [update mode](https://plaid.com/docs/link/update-mode) flow in the Sandbox environment. After calling `/sandbox/user/reset_login`,
|
|
15452
|
+
# `/sandbox/user/reset_login/` functions the same as `/sandbox/item/reset_login`, but will modify Items related to a User. This endpoint forces each Item into an `ITEM_LOGIN_REQUIRED` state in order to simulate an Item whose login is no longer valid. This makes it easy to test Link's [update mode](https://plaid.com/docs/link/update-mode) flow in the Sandbox environment. After calling `/sandbox/user/reset_login`, you can then use Plaid Link update mode to restore Items associated with the User to a good state. An `ITEM_LOGIN_REQUIRED` webhook will also be fired after a call to this endpoint, if one is associated with the Item. In the Sandbox, Items will transition to an `ITEM_LOGIN_REQUIRED` error state automatically after 30 days, even if this endpoint is not called.
|
|
15253
15453
|
# @param sandbox_user_reset_login_request [SandboxUserResetLoginRequest]
|
|
15254
15454
|
# @param [Hash] opts the optional parameters
|
|
15255
15455
|
# @return [Array<(SandboxUserResetLoginResponse, Integer, Hash)>] SandboxUserResetLoginResponse data, response status code and response headers
|
|
@@ -15307,7 +15507,7 @@ module Plaid
|
|
|
15307
15507
|
end
|
|
15308
15508
|
|
|
15309
15509
|
# Create a Link token for Layer
|
|
15310
|
-
# `/session/token/create` is used to create a Link token for Layer. The returned Link token is used as
|
|
15510
|
+
# `/session/token/create` is used to create a Link token for Layer. The returned Link token is used as a parameter when initializing the Link SDK. For more details, see the [Link flow overview](https://plaid.com/docs/link/#link-flow-overview).
|
|
15311
15511
|
# @param session_token_create_request [SessionTokenCreateRequest]
|
|
15312
15512
|
# @param [Hash] opts the optional parameters
|
|
15313
15513
|
# @return [SessionTokenCreateResponse]
|
|
@@ -15317,7 +15517,7 @@ module Plaid
|
|
|
15317
15517
|
end
|
|
15318
15518
|
|
|
15319
15519
|
# Create a Link token for Layer
|
|
15320
|
-
# `/session/token/create` is used to create a Link token for Layer. The returned Link token is used as
|
|
15520
|
+
# `/session/token/create` is used to create a Link token for Layer. The returned Link token is used as a parameter when initializing the Link SDK. For more details, see the [Link flow overview](https://plaid.com/docs/link/#link-flow-overview).
|
|
15321
15521
|
# @param session_token_create_request [SessionTokenCreateRequest]
|
|
15322
15522
|
# @param [Hash] opts the optional parameters
|
|
15323
15523
|
# @return [Array<(SessionTokenCreateResponse, Integer, Hash)>] SessionTokenCreateResponse data, response status code and response headers
|
|
@@ -15746,7 +15946,7 @@ module Plaid
|
|
|
15746
15946
|
# header parameters
|
|
15747
15947
|
header_params = opts[:header_params] || {}
|
|
15748
15948
|
# HTTP header 'Accept' (if needed)
|
|
15749
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
15949
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/pdf', 'application/json'])
|
|
15750
15950
|
# HTTP header 'Content-Type'
|
|
15751
15951
|
content_type = @api_client.select_header_content_type(['application/json'])
|
|
15752
15952
|
if !content_type.nil?
|
|
@@ -15782,8 +15982,8 @@ module Plaid
|
|
|
15782
15982
|
return data, status_code, headers
|
|
15783
15983
|
end
|
|
15784
15984
|
|
|
15785
|
-
# Retrieve a list of all statements associated with an
|
|
15786
|
-
# The `/statements/list` endpoint retrieves a list of all statements associated with an
|
|
15985
|
+
# Retrieve a list of all statements associated with an Item.
|
|
15986
|
+
# The `/statements/list` endpoint retrieves a list of all statements associated with an Item.
|
|
15787
15987
|
# @param statements_list_request [StatementsListRequest]
|
|
15788
15988
|
# @param [Hash] opts the optional parameters
|
|
15789
15989
|
# @return [StatementsListResponse]
|
|
@@ -15792,8 +15992,8 @@ module Plaid
|
|
|
15792
15992
|
data
|
|
15793
15993
|
end
|
|
15794
15994
|
|
|
15795
|
-
# Retrieve a list of all statements associated with an
|
|
15796
|
-
# The `/statements/list` endpoint retrieves a list of all statements associated with an
|
|
15995
|
+
# Retrieve a list of all statements associated with an Item.
|
|
15996
|
+
# The `/statements/list` endpoint retrieves a list of all statements associated with an Item.
|
|
15797
15997
|
# @param statements_list_request [StatementsListRequest]
|
|
15798
15998
|
# @param [Hash] opts the optional parameters
|
|
15799
15999
|
# @return [Array<(StatementsListResponse, Integer, Hash)>] StatementsListResponse data, response status code and response headers
|
|
@@ -15918,7 +16118,7 @@ module Plaid
|
|
|
15918
16118
|
return data, status_code, headers
|
|
15919
16119
|
end
|
|
15920
16120
|
|
|
15921
|
-
#
|
|
16121
|
+
# Enhance locally-held transaction data
|
|
15922
16122
|
# The `/beta/transactions/v1/enhance` endpoint enriches raw transaction data provided directly by clients. The product is currently in beta.
|
|
15923
16123
|
# @param transactions_enhance_get_request [TransactionsEnhanceGetRequest]
|
|
15924
16124
|
# @param [Hash] opts the optional parameters
|
|
@@ -15928,7 +16128,7 @@ module Plaid
|
|
|
15928
16128
|
data
|
|
15929
16129
|
end
|
|
15930
16130
|
|
|
15931
|
-
#
|
|
16131
|
+
# Enhance locally-held transaction data
|
|
15932
16132
|
# The `/beta/transactions/v1/enhance` endpoint enriches raw transaction data provided directly by clients. The product is currently in beta.
|
|
15933
16133
|
# @param transactions_enhance_get_request [TransactionsEnhanceGetRequest]
|
|
15934
16134
|
# @param [Hash] opts the optional parameters
|
|
@@ -16123,7 +16323,7 @@ module Plaid
|
|
|
16123
16323
|
end
|
|
16124
16324
|
|
|
16125
16325
|
# Fetch recurring transaction streams
|
|
16126
|
-
# The `/transactions/recurring/get` endpoint allows developers to receive a summary of the recurring outflow and inflow streams (expenses and deposits) from a user
|
|
16326
|
+
# The `/transactions/recurring/get` endpoint allows developers to receive a summary of the recurring outflow and inflow streams (expenses and deposits) from a user's checking, savings or credit card accounts. Additionally, Plaid provides key insights about each recurring stream including the category, merchant, last amount, and more. Developers can use these insights to build tools and experiences that help their users better manage cash flow, monitor subscriptions, reduce spend, and stay on track with bill payments. This endpoint is offered as an add-on to Transactions. To request access to this endpoint, submit a [product access request](https://dashboard.plaid.com/team/products) or contact your Plaid account manager. This endpoint can only be called on an Item that has already been initialized with Transactions (either during Link, by specifying it in `/link/token/create`; or after Link, by calling `/transactions/get` or `/transactions/sync`). When using Recurring Transactions, for best results, make sure to use the [`days_requested`](https://plaid.com/docs/api/link/#link-token-create-request-transactions-days-requested) parameter to request at least 180 days of history when initializing Items with Transactions. Once all historical transactions have been fetched, call `/transactions/recurring/get` to receive the Recurring Transactions streams and subscribe to the [`RECURRING_TRANSACTIONS_UPDATE`](https://plaid.com/docs/api/products/transactions/#recurring_transactions_update) webhook. To know when historical transactions have been fetched, if you are using `/transactions/sync` listen for the [`SYNC_UPDATES_AVAILABLE`](https://plaid.com/docs/api/products/transactions/#SyncUpdatesAvailableWebhook-historical-update-complete) webhook and check that the `historical_update_complete` field in the payload is `true`. If using `/transactions/get`, listen for the [`HISTORICAL_UPDATE`](https://plaid.com/docs/api/products/transactions/#historical_update) webhook. After the initial call, you can call `/transactions/recurring/get` endpoint at any point in the future to retrieve the latest summary of recurring streams. Listen to the [`RECURRING_TRANSACTIONS_UPDATE`](https://plaid.com/docs/api/products/transactions/#recurring_transactions_update) webhook to be notified when new updates are available.
|
|
16127
16327
|
# @param transactions_recurring_get_request [TransactionsRecurringGetRequest]
|
|
16128
16328
|
# @param [Hash] opts the optional parameters
|
|
16129
16329
|
# @return [TransactionsRecurringGetResponse]
|
|
@@ -16133,7 +16333,7 @@ module Plaid
|
|
|
16133
16333
|
end
|
|
16134
16334
|
|
|
16135
16335
|
# Fetch recurring transaction streams
|
|
16136
|
-
# The `/transactions/recurring/get` endpoint allows developers to receive a summary of the recurring outflow and inflow streams (expenses and deposits) from a user
|
|
16336
|
+
# The `/transactions/recurring/get` endpoint allows developers to receive a summary of the recurring outflow and inflow streams (expenses and deposits) from a user's checking, savings or credit card accounts. Additionally, Plaid provides key insights about each recurring stream including the category, merchant, last amount, and more. Developers can use these insights to build tools and experiences that help their users better manage cash flow, monitor subscriptions, reduce spend, and stay on track with bill payments. This endpoint is offered as an add-on to Transactions. To request access to this endpoint, submit a [product access request](https://dashboard.plaid.com/team/products) or contact your Plaid account manager. This endpoint can only be called on an Item that has already been initialized with Transactions (either during Link, by specifying it in `/link/token/create`; or after Link, by calling `/transactions/get` or `/transactions/sync`). When using Recurring Transactions, for best results, make sure to use the [`days_requested`](https://plaid.com/docs/api/link/#link-token-create-request-transactions-days-requested) parameter to request at least 180 days of history when initializing Items with Transactions. Once all historical transactions have been fetched, call `/transactions/recurring/get` to receive the Recurring Transactions streams and subscribe to the [`RECURRING_TRANSACTIONS_UPDATE`](https://plaid.com/docs/api/products/transactions/#recurring_transactions_update) webhook. To know when historical transactions have been fetched, if you are using `/transactions/sync` listen for the [`SYNC_UPDATES_AVAILABLE`](https://plaid.com/docs/api/products/transactions/#SyncUpdatesAvailableWebhook-historical-update-complete) webhook and check that the `historical_update_complete` field in the payload is `true`. If using `/transactions/get`, listen for the [`HISTORICAL_UPDATE`](https://plaid.com/docs/api/products/transactions/#historical_update) webhook. After the initial call, you can call `/transactions/recurring/get` endpoint at any point in the future to retrieve the latest summary of recurring streams. Listen to the [`RECURRING_TRANSACTIONS_UPDATE`](https://plaid.com/docs/api/products/transactions/#recurring_transactions_update) webhook to be notified when new updates are available.
|
|
16137
16337
|
# @param transactions_recurring_get_request [TransactionsRecurringGetRequest]
|
|
16138
16338
|
# @param [Hash] opts the optional parameters
|
|
16139
16339
|
# @return [Array<(TransactionsRecurringGetResponse, Integer, Hash)>] TransactionsRecurringGetResponse data, response status code and response headers
|
|
@@ -16259,7 +16459,7 @@ module Plaid
|
|
|
16259
16459
|
end
|
|
16260
16460
|
|
|
16261
16461
|
# Create transaction category rule
|
|
16262
|
-
# The `/transactions/rules/v1/create` endpoint creates transaction categorization rules. Rules will be applied on the Item's transactions returned in `/transactions/get` response. The product is currently in beta. To request access, contact transactions-feedback@plaid.com.
|
|
16462
|
+
# The `/beta/transactions/rules/v1/create` endpoint creates transaction categorization rules. Rules will be applied on the Item's transactions returned in `/transactions/get` response. The product is currently in beta. To request access, contact transactions-feedback@plaid.com.
|
|
16263
16463
|
# @param transactions_rules_create_request [TransactionsRulesCreateRequest]
|
|
16264
16464
|
# @param [Hash] opts the optional parameters
|
|
16265
16465
|
# @return [TransactionsRulesCreateResponse]
|
|
@@ -16269,7 +16469,7 @@ module Plaid
|
|
|
16269
16469
|
end
|
|
16270
16470
|
|
|
16271
16471
|
# Create transaction category rule
|
|
16272
|
-
# The `/transactions/rules/v1/create` endpoint creates transaction categorization rules. Rules will be applied on the Item's transactions returned in `/transactions/get` response. The product is currently in beta. To request access, contact transactions-feedback@plaid.com.
|
|
16472
|
+
# The `/beta/transactions/rules/v1/create` endpoint creates transaction categorization rules. Rules will be applied on the Item's transactions returned in `/transactions/get` response. The product is currently in beta. To request access, contact transactions-feedback@plaid.com.
|
|
16273
16473
|
# @param transactions_rules_create_request [TransactionsRulesCreateRequest]
|
|
16274
16474
|
# @param [Hash] opts the optional parameters
|
|
16275
16475
|
# @return [Array<(TransactionsRulesCreateResponse, Integer, Hash)>] TransactionsRulesCreateResponse data, response status code and response headers
|
|
@@ -16327,7 +16527,7 @@ module Plaid
|
|
|
16327
16527
|
end
|
|
16328
16528
|
|
|
16329
16529
|
# Return a list of rules created for the Item associated with the access token.
|
|
16330
|
-
# The `/transactions/rules/v1/list` returns a list of transaction rules created for the Item associated with the access token.
|
|
16530
|
+
# The `/beta/transactions/rules/v1/list` returns a list of transaction rules created for the Item associated with the access token.
|
|
16331
16531
|
# @param transactions_rules_list_request [TransactionsRulesListRequest]
|
|
16332
16532
|
# @param [Hash] opts the optional parameters
|
|
16333
16533
|
# @return [TransactionsRulesListResponse]
|
|
@@ -16337,7 +16537,7 @@ module Plaid
|
|
|
16337
16537
|
end
|
|
16338
16538
|
|
|
16339
16539
|
# Return a list of rules created for the Item associated with the access token.
|
|
16340
|
-
# The `/transactions/rules/v1/list` returns a list of transaction rules created for the Item associated with the access token.
|
|
16540
|
+
# The `/beta/transactions/rules/v1/list` returns a list of transaction rules created for the Item associated with the access token.
|
|
16341
16541
|
# @param transactions_rules_list_request [TransactionsRulesListRequest]
|
|
16342
16542
|
# @param [Hash] opts the optional parameters
|
|
16343
16543
|
# @return [Array<(TransactionsRulesListResponse, Integer, Hash)>] TransactionsRulesListResponse data, response status code and response headers
|
|
@@ -16395,7 +16595,7 @@ module Plaid
|
|
|
16395
16595
|
end
|
|
16396
16596
|
|
|
16397
16597
|
# Remove transaction rule
|
|
16398
|
-
# The `/transactions/rules/v1/remove` endpoint is used to remove a transaction rule.
|
|
16598
|
+
# The `/beta/transactions/rules/v1/remove` endpoint is used to remove a transaction rule.
|
|
16399
16599
|
# @param transactions_rules_remove_request [TransactionsRulesRemoveRequest]
|
|
16400
16600
|
# @param [Hash] opts the optional parameters
|
|
16401
16601
|
# @return [TransactionsRulesRemoveResponse]
|
|
@@ -16405,7 +16605,7 @@ module Plaid
|
|
|
16405
16605
|
end
|
|
16406
16606
|
|
|
16407
16607
|
# Remove transaction rule
|
|
16408
|
-
# The `/transactions/rules/v1/remove` endpoint is used to remove a transaction rule.
|
|
16608
|
+
# The `/beta/transactions/rules/v1/remove` endpoint is used to remove a transaction rule.
|
|
16409
16609
|
# @param transactions_rules_remove_request [TransactionsRulesRemoveRequest]
|
|
16410
16610
|
# @param [Hash] opts the optional parameters
|
|
16411
16611
|
# @return [Array<(TransactionsRulesRemoveResponse, Integer, Hash)>] TransactionsRulesRemoveResponse data, response status code and response headers
|
|
@@ -16463,7 +16663,7 @@ module Plaid
|
|
|
16463
16663
|
end
|
|
16464
16664
|
|
|
16465
16665
|
# Get incremental transaction updates on an Item
|
|
16466
|
-
# The `/transactions/sync` endpoint retrieves transactions associated with an Item and can fetch updates using a cursor to track which updates have already been seen. For important instructions on integrating with `/transactions/sync`, see the [Transactions integration overview](https://plaid.com/docs/transactions/#integration-overview). If you are migrating from an existing integration using `/transactions/get`, see the [Transactions Sync migration guide](https://plaid.com/docs/transactions/sync-migration/). This endpoint supports `credit`, `depository`, and some `loan`-type accounts (only those with account subtype `student`). For `investments` accounts, use `/investments/transactions/get` instead. 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 when retrieving a paginated update (e.g 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. If transactions data is not yet available for the Item, which can happen if the Item was not initialized with transactions during the `/link/token/create` call or if `/transactions/sync` was called within a few seconds of Item creation, `/transactions/sync` will return empty transactions arrays. Plaid typically checks for new transactions data between one and four times per day, depending on the institution. To find out when transactions were last updated for an Item, use the [Item Debugger](https://plaid.com/docs/account/activity/#troubleshooting-with-item-debugger) or call `/item/get`; the `item.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. To be alerted when new transactions are available, listen for the [`SYNC_UPDATES_AVAILABLE`](https://plaid.com/docs/api/products/transactions/#sync_updates_available) webhook.
|
|
16666
|
+
# The `/transactions/sync` endpoint retrieves transactions associated with an Item and can fetch updates using a cursor to track which updates have already been seen. For important instructions on integrating with `/transactions/sync`, see the [Transactions integration overview](https://plaid.com/docs/transactions/#integration-overview). If you are migrating from an existing integration using `/transactions/get`, see the [Transactions Sync migration guide](https://plaid.com/docs/transactions/sync-migration/). This endpoint supports `credit`, `depository`, and some `loan`-type accounts (only those with account subtype `student`). For `investments` accounts, use `/investments/transactions/get` instead. 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 when retrieving a paginated update (e.g. 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. If transactions data is not yet available for the Item, which can happen if the Item was not initialized with transactions during the `/link/token/create` call or if `/transactions/sync` was called within a few seconds of Item creation, `/transactions/sync` will return empty transactions arrays. Plaid typically checks for new transactions data between one and four times per day, depending on the institution. To find out when transactions were last updated for an Item, use the [Item Debugger](https://plaid.com/docs/account/activity/#troubleshooting-with-item-debugger) or call `/item/get`; the `item.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. To be alerted when new transactions are available, listen for the [`SYNC_UPDATES_AVAILABLE`](https://plaid.com/docs/api/products/transactions/#sync_updates_available) webhook.
|
|
16467
16667
|
# @param transactions_sync_request [TransactionsSyncRequest]
|
|
16468
16668
|
# @param [Hash] opts the optional parameters
|
|
16469
16669
|
# @return [TransactionsSyncResponse]
|
|
@@ -16473,7 +16673,7 @@ module Plaid
|
|
|
16473
16673
|
end
|
|
16474
16674
|
|
|
16475
16675
|
# Get incremental transaction updates on an Item
|
|
16476
|
-
# The `/transactions/sync` endpoint retrieves transactions associated with an Item and can fetch updates using a cursor to track which updates have already been seen. For important instructions on integrating with `/transactions/sync`, see the [Transactions integration overview](https://plaid.com/docs/transactions/#integration-overview). If you are migrating from an existing integration using `/transactions/get`, see the [Transactions Sync migration guide](https://plaid.com/docs/transactions/sync-migration/). This endpoint supports `credit`, `depository`, and some `loan`-type accounts (only those with account subtype `student`). For `investments` accounts, use `/investments/transactions/get` instead. 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 when retrieving a paginated update (e.g 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. If transactions data is not yet available for the Item, which can happen if the Item was not initialized with transactions during the `/link/token/create` call or if `/transactions/sync` was called within a few seconds of Item creation, `/transactions/sync` will return empty transactions arrays. Plaid typically checks for new transactions data between one and four times per day, depending on the institution. To find out when transactions were last updated for an Item, use the [Item Debugger](https://plaid.com/docs/account/activity/#troubleshooting-with-item-debugger) or call `/item/get`; the `item.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. To be alerted when new transactions are available, listen for the [`SYNC_UPDATES_AVAILABLE`](https://plaid.com/docs/api/products/transactions/#sync_updates_available) webhook.
|
|
16676
|
+
# The `/transactions/sync` endpoint retrieves transactions associated with an Item and can fetch updates using a cursor to track which updates have already been seen. For important instructions on integrating with `/transactions/sync`, see the [Transactions integration overview](https://plaid.com/docs/transactions/#integration-overview). If you are migrating from an existing integration using `/transactions/get`, see the [Transactions Sync migration guide](https://plaid.com/docs/transactions/sync-migration/). This endpoint supports `credit`, `depository`, and some `loan`-type accounts (only those with account subtype `student`). For `investments` accounts, use `/investments/transactions/get` instead. 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 when retrieving a paginated update (e.g. 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. If transactions data is not yet available for the Item, which can happen if the Item was not initialized with transactions during the `/link/token/create` call or if `/transactions/sync` was called within a few seconds of Item creation, `/transactions/sync` will return empty transactions arrays. Plaid typically checks for new transactions data between one and four times per day, depending on the institution. To find out when transactions were last updated for an Item, use the [Item Debugger](https://plaid.com/docs/account/activity/#troubleshooting-with-item-debugger) or call `/item/get`; the `item.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. To be alerted when new transactions are available, listen for the [`SYNC_UPDATES_AVAILABLE`](https://plaid.com/docs/api/products/transactions/#sync_updates_available) webhook.
|
|
16477
16677
|
# @param transactions_sync_request [TransactionsSyncRequest]
|
|
16478
16678
|
# @param [Hash] opts the optional parameters
|
|
16479
16679
|
# @return [Array<(TransactionsSyncResponse, Integer, Hash)>] TransactionsSyncResponse data, response status code and response headers
|
|
@@ -16667,7 +16867,7 @@ module Plaid
|
|
|
16667
16867
|
end
|
|
16668
16868
|
|
|
16669
16869
|
# Create a transfer authorization
|
|
16670
|
-
# Use the `/transfer/authorization/create` endpoint to authorize a transfer. This endpoint must be called prior to calling `/transfer/create`. The transfer authorization will expire if not used after one hour. (You can contact your account manager to change the default authorization lifetime.) There are four 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 `user_action_required`, additional user input is needed, usually to fix a broken bank connection, before Plaid can properly assess the risk. You need to launch Link in update mode to complete the required user action. When calling `/link/token/create` to get a new Link token, instead of providing `access_token` in the request, you should set [`transfer.authorization_id`](https://plaid.com/docs/api/link/#link-token-create-request-transfer-authorization-id) as the `authorization.id`. After the Link flow is completed, you may re-attempt the authorization. - If the `authorization.decision` is `approved`, and the `authorization.
|
|
16870
|
+
# Use the `/transfer/authorization/create` endpoint to authorize a transfer. This endpoint must be called prior to calling `/transfer/create`. The transfer authorization will expire if not used after one hour. (You can contact your account manager to change the default authorization lifetime.) There are four 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 `user_action_required`, additional user input is needed, usually to fix a broken bank connection, before Plaid can properly assess the risk. You need to launch Link in update mode to complete the required user action. When calling `/link/token/create` to get a new Link token, instead of providing `access_token` in the request, you should set [`transfer.authorization_id`](https://plaid.com/docs/api/link/#link-token-create-request-transfer-authorization-id) as the `authorization.id`. After the Link flow is completed, you may re-attempt the authorization. - If the `authorization.decision` is `approved`, and the `authorization.decision_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.decision_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 get an authorization decision of `user_action_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.
|
|
16671
16871
|
# @param transfer_authorization_create_request [TransferAuthorizationCreateRequest]
|
|
16672
16872
|
# @param [Hash] opts the optional parameters
|
|
16673
16873
|
# @return [TransferAuthorizationCreateResponse]
|
|
@@ -16677,7 +16877,7 @@ module Plaid
|
|
|
16677
16877
|
end
|
|
16678
16878
|
|
|
16679
16879
|
# Create a transfer authorization
|
|
16680
|
-
# Use the `/transfer/authorization/create` endpoint to authorize a transfer. This endpoint must be called prior to calling `/transfer/create`. The transfer authorization will expire if not used after one hour. (You can contact your account manager to change the default authorization lifetime.) There are four 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 `user_action_required`, additional user input is needed, usually to fix a broken bank connection, before Plaid can properly assess the risk. You need to launch Link in update mode to complete the required user action. When calling `/link/token/create` to get a new Link token, instead of providing `access_token` in the request, you should set [`transfer.authorization_id`](https://plaid.com/docs/api/link/#link-token-create-request-transfer-authorization-id) as the `authorization.id`. After the Link flow is completed, you may re-attempt the authorization. - If the `authorization.decision` is `approved`, and the `authorization.
|
|
16880
|
+
# Use the `/transfer/authorization/create` endpoint to authorize a transfer. This endpoint must be called prior to calling `/transfer/create`. The transfer authorization will expire if not used after one hour. (You can contact your account manager to change the default authorization lifetime.) There are four 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 `user_action_required`, additional user input is needed, usually to fix a broken bank connection, before Plaid can properly assess the risk. You need to launch Link in update mode to complete the required user action. When calling `/link/token/create` to get a new Link token, instead of providing `access_token` in the request, you should set [`transfer.authorization_id`](https://plaid.com/docs/api/link/#link-token-create-request-transfer-authorization-id) as the `authorization.id`. After the Link flow is completed, you may re-attempt the authorization. - If the `authorization.decision` is `approved`, and the `authorization.decision_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.decision_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 get an authorization decision of `user_action_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.
|
|
16681
16881
|
# @param transfer_authorization_create_request [TransferAuthorizationCreateRequest]
|
|
16682
16882
|
# @param [Hash] opts the optional parameters
|
|
16683
16883
|
# @return [Array<(TransferAuthorizationCreateResponse, Integer, Hash)>] TransferAuthorizationCreateResponse data, response status code and response headers
|
|
@@ -17075,7 +17275,7 @@ module Plaid
|
|
|
17075
17275
|
end
|
|
17076
17276
|
|
|
17077
17277
|
# Upload transfer diligence document on behalf of the originator
|
|
17078
|
-
# 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
|
|
17278
|
+
# 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.
|
|
17079
17279
|
# @param transfer_diligence_document_upload_request [TransferDiligenceDocumentUploadRequest]
|
|
17080
17280
|
# @param [Hash] opts the optional parameters
|
|
17081
17281
|
# @return [TransferDiligenceDocumentUploadResponse]
|
|
@@ -17085,7 +17285,7 @@ module Plaid
|
|
|
17085
17285
|
end
|
|
17086
17286
|
|
|
17087
17287
|
# Upload transfer diligence document on behalf of the originator
|
|
17088
|
-
# 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
|
|
17288
|
+
# 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.
|
|
17089
17289
|
# @param transfer_diligence_document_upload_request [TransferDiligenceDocumentUploadRequest]
|
|
17090
17290
|
# @param [Hash] opts the optional parameters
|
|
17091
17291
|
# @return [Array<(TransferDiligenceDocumentUploadResponse, Integer, Hash)>] TransferDiligenceDocumentUploadResponse data, response status code and response headers
|
|
@@ -17619,7 +17819,7 @@ module Plaid
|
|
|
17619
17819
|
end
|
|
17620
17820
|
|
|
17621
17821
|
# Move available balance between ledgers
|
|
17622
|
-
# Use the `/transfer/ledger/distribute` endpoint to move available balance between ledgers, if you have multiple. If you
|
|
17822
|
+
# Use the `/transfer/ledger/distribute` endpoint to move available balance between ledgers, if you have multiple. If you're a platform, you can move funds between one of your ledgers and one of your customer's ledger.
|
|
17623
17823
|
# @param transfer_ledger_distribute_request [TransferLedgerDistributeRequest]
|
|
17624
17824
|
# @param [Hash] opts the optional parameters
|
|
17625
17825
|
# @return [TransferLedgerDistributeResponse]
|
|
@@ -17629,7 +17829,7 @@ module Plaid
|
|
|
17629
17829
|
end
|
|
17630
17830
|
|
|
17631
17831
|
# Move available balance between ledgers
|
|
17632
|
-
# Use the `/transfer/ledger/distribute` endpoint to move available balance between ledgers, if you have multiple. If you
|
|
17832
|
+
# Use the `/transfer/ledger/distribute` endpoint to move available balance between ledgers, if you have multiple. If you're a platform, you can move funds between one of your ledgers and one of your customer's ledger.
|
|
17633
17833
|
# @param transfer_ledger_distribute_request [TransferLedgerDistributeRequest]
|
|
17634
17834
|
# @param [Hash] opts the optional parameters
|
|
17635
17835
|
# @return [Array<(TransferLedgerDistributeResponse, Integer, Hash)>] TransferLedgerDistributeResponse data, response status code and response headers
|
|
@@ -17959,7 +18159,7 @@ module Plaid
|
|
|
17959
18159
|
end
|
|
17960
18160
|
|
|
17961
18161
|
# Get transfer product usage metrics
|
|
17962
|
-
# Use the `/transfer/metrics/get` endpoint to view your transfer product usage metrics.
|
|
18162
|
+
# Use the `/transfer/metrics/get` endpoint to view your transfer product usage metrics. In the Sandbox environment, this endpoint returns static placeholder values rather than metrics computed from your Sandbox transfer activity.
|
|
17963
18163
|
# @param transfer_metrics_get_request [TransferMetricsGetRequest]
|
|
17964
18164
|
# @param [Hash] opts the optional parameters
|
|
17965
18165
|
# @return [TransferMetricsGetResponse]
|
|
@@ -17969,7 +18169,7 @@ module Plaid
|
|
|
17969
18169
|
end
|
|
17970
18170
|
|
|
17971
18171
|
# Get transfer product usage metrics
|
|
17972
|
-
# Use the `/transfer/metrics/get` endpoint to view your transfer product usage metrics.
|
|
18172
|
+
# Use the `/transfer/metrics/get` endpoint to view your transfer product usage metrics. In the Sandbox environment, this endpoint returns static placeholder values rather than metrics computed from your Sandbox transfer activity.
|
|
17973
18173
|
# @param transfer_metrics_get_request [TransferMetricsGetRequest]
|
|
17974
18174
|
# @param [Hash] opts the optional parameters
|
|
17975
18175
|
# @return [Array<(TransferMetricsGetResponse, Integer, Hash)>] TransferMetricsGetResponse data, response status code and response headers
|
|
@@ -18027,7 +18227,7 @@ module Plaid
|
|
|
18027
18227
|
end
|
|
18028
18228
|
|
|
18029
18229
|
# Migrate account into Transfers
|
|
18030
|
-
# As an alternative to adding Items via Link, you can also use the `/transfer/migrate_account` endpoint to migrate previously-verified account and routing numbers to Plaid Items. This endpoint is also required when adding an Item for use with wire transfers; if you intend to create wire transfers on this account, you must provide `wire_routing_number`. Note that Items created in this way are not compatible with endpoints for other products, such as `/accounts/balance/get`, and can only be used with Transfer endpoints. If you require access to other endpoints, create the Item through Link instead. Access to `/transfer/migrate_account` is not enabled by default; to obtain access, contact your Plaid
|
|
18230
|
+
# As an alternative to adding Items via Link, you can also use the `/transfer/migrate_account` endpoint to migrate previously-verified account and routing numbers to Plaid Items. This endpoint is also required when adding an Item for use with wire transfers; if you intend to create wire transfers on this account, you must provide `wire_routing_number`. Note that Items created in this way are not compatible with endpoints for other products, such as `/accounts/balance/get`, and can only be used with Transfer endpoints. If you require access to other endpoints, create the Item through Link instead. Access to `/transfer/migrate_account` is not enabled by default; to obtain access, contact your Plaid account manager or [support](https://dashboard.plaid.com/support).
|
|
18031
18231
|
# @param transfer_migrate_account_request [TransferMigrateAccountRequest]
|
|
18032
18232
|
# @param [Hash] opts the optional parameters
|
|
18033
18233
|
# @return [TransferMigrateAccountResponse]
|
|
@@ -18037,7 +18237,7 @@ module Plaid
|
|
|
18037
18237
|
end
|
|
18038
18238
|
|
|
18039
18239
|
# Migrate account into Transfers
|
|
18040
|
-
# As an alternative to adding Items via Link, you can also use the `/transfer/migrate_account` endpoint to migrate previously-verified account and routing numbers to Plaid Items. This endpoint is also required when adding an Item for use with wire transfers; if you intend to create wire transfers on this account, you must provide `wire_routing_number`. Note that Items created in this way are not compatible with endpoints for other products, such as `/accounts/balance/get`, and can only be used with Transfer endpoints. If you require access to other endpoints, create the Item through Link instead. Access to `/transfer/migrate_account` is not enabled by default; to obtain access, contact your Plaid
|
|
18240
|
+
# As an alternative to adding Items via Link, you can also use the `/transfer/migrate_account` endpoint to migrate previously-verified account and routing numbers to Plaid Items. This endpoint is also required when adding an Item for use with wire transfers; if you intend to create wire transfers on this account, you must provide `wire_routing_number`. Note that Items created in this way are not compatible with endpoints for other products, such as `/accounts/balance/get`, and can only be used with Transfer endpoints. If you require access to other endpoints, create the Item through Link instead. Access to `/transfer/migrate_account` is not enabled by default; to obtain access, contact your Plaid account manager or [support](https://dashboard.plaid.com/support).
|
|
18041
18241
|
# @param transfer_migrate_account_request [TransferMigrateAccountRequest]
|
|
18042
18242
|
# @param [Hash] opts the optional parameters
|
|
18043
18243
|
# @return [Array<(TransferMigrateAccountResponse, Integer, Hash)>] TransferMigrateAccountResponse data, response status code and response headers
|
|
@@ -18639,7 +18839,7 @@ module Plaid
|
|
|
18639
18839
|
end
|
|
18640
18840
|
|
|
18641
18841
|
# Generate a Plaid-hosted onboarding UI URL.
|
|
18642
|
-
# The `/transfer/questionnaire/create` endpoint generates a Plaid-hosted onboarding UI URL. Redirect the originator to this URL to provide their due diligence information and agree to Plaid
|
|
18842
|
+
# The `/transfer/questionnaire/create` endpoint generates a Plaid-hosted onboarding UI URL. Redirect the originator to this URL to provide their due diligence information and agree to Plaid's terms for ACH money movement.
|
|
18643
18843
|
# @param transfer_questionnaire_create_request [TransferQuestionnaireCreateRequest]
|
|
18644
18844
|
# @param [Hash] opts the optional parameters
|
|
18645
18845
|
# @return [TransferQuestionnaireCreateResponse]
|
|
@@ -18649,7 +18849,7 @@ module Plaid
|
|
|
18649
18849
|
end
|
|
18650
18850
|
|
|
18651
18851
|
# Generate a Plaid-hosted onboarding UI URL.
|
|
18652
|
-
# The `/transfer/questionnaire/create` endpoint generates a Plaid-hosted onboarding UI URL. Redirect the originator to this URL to provide their due diligence information and agree to Plaid
|
|
18852
|
+
# The `/transfer/questionnaire/create` endpoint generates a Plaid-hosted onboarding UI URL. Redirect the originator to this URL to provide their due diligence information and agree to Plaid's terms for ACH money movement.
|
|
18653
18853
|
# @param transfer_questionnaire_create_request [TransferQuestionnaireCreateRequest]
|
|
18654
18854
|
# @param [Hash] opts the optional parameters
|
|
18655
18855
|
# @return [Array<(TransferQuestionnaireCreateResponse, Integer, Hash)>] TransferQuestionnaireCreateResponse data, response status code and response headers
|
|
@@ -20008,7 +20208,7 @@ module Plaid
|
|
|
20008
20208
|
end
|
|
20009
20209
|
|
|
20010
20210
|
# Remove Items from a User
|
|
20011
|
-
# Removes specific Items associated with a user. It is equivalent to calling `/item/remove` on each Item individually, but supports use cases (such as Plaid Check) where access tokens are not available. All specified Items must belong to the user or the entire operation fails. Similar to `/item/remove`, this deletes Item product data
|
|
20211
|
+
# Removes specific Items associated with a user. It is equivalent to calling `/item/remove` on each Item individually, but supports use cases (such as Plaid Check) where access tokens are not available. All specified Items must belong to the user or the entire operation fails. Similar to `/item/remove`, this deletes Item product data and terminates billing on the Item's products. Once removed, Items cannot be reconnected without going through Link again. This endpoint is not intended to remove all data for a user, as it will only remove Items and no other data for the user. If the user has any user-based recurring subscription products (Financial Management, Plaid Protect, or CRA Cash Flow Updates) and is deleting their account with your product, also call `/user/products/terminate` to end those subscriptions; per-Item billing is already terminated by this endpoint. For a user initiated data deletion request, see the [Consumer Service Center](https://plaid.com/check/consumer-service-center/) to revoke access to data.
|
|
20012
20212
|
# @param user_items_remove_request [UserItemsRemoveRequest]
|
|
20013
20213
|
# @param [Hash] opts the optional parameters
|
|
20014
20214
|
# @return [UserItemsRemoveResponse]
|
|
@@ -20018,7 +20218,7 @@ module Plaid
|
|
|
20018
20218
|
end
|
|
20019
20219
|
|
|
20020
20220
|
# Remove Items from a User
|
|
20021
|
-
# Removes specific Items associated with a user. It is equivalent to calling `/item/remove` on each Item individually, but supports use cases (such as Plaid Check) where access tokens are not available. All specified Items must belong to the user or the entire operation fails. Similar to `/item/remove`, this deletes Item product data
|
|
20221
|
+
# Removes specific Items associated with a user. It is equivalent to calling `/item/remove` on each Item individually, but supports use cases (such as Plaid Check) where access tokens are not available. All specified Items must belong to the user or the entire operation fails. Similar to `/item/remove`, this deletes Item product data and terminates billing on the Item's products. Once removed, Items cannot be reconnected without going through Link again. This endpoint is not intended to remove all data for a user, as it will only remove Items and no other data for the user. If the user has any user-based recurring subscription products (Financial Management, Plaid Protect, or CRA Cash Flow Updates) and is deleting their account with your product, also call `/user/products/terminate` to end those subscriptions; per-Item billing is already terminated by this endpoint. For a user initiated data deletion request, see the [Consumer Service Center](https://plaid.com/check/consumer-service-center/) to revoke access to data.
|
|
20022
20222
|
# @param user_items_remove_request [UserItemsRemoveRequest]
|
|
20023
20223
|
# @param [Hash] opts the optional parameters
|
|
20024
20224
|
# @return [Array<(UserItemsRemoveResponse, Integer, Hash)>] UserItemsRemoveResponse data, response status code and response headers
|
|
@@ -20076,7 +20276,7 @@ module Plaid
|
|
|
20076
20276
|
end
|
|
20077
20277
|
|
|
20078
20278
|
# Terminate user-based products
|
|
20079
|
-
#
|
|
20279
|
+
# Terminates user-based recurring subscription bundles or products (Financial Management, Plaid Protect, and CRA Cash Flow Updates) associated with a `user_id`. After you call this endpoint, the user will no longer be billed for these products. For CRA Monitoring, the subscription is canceled but historical data remains available for future report requests.
|
|
20080
20280
|
# @param user_products_terminate_request [UserProductsTerminateRequest]
|
|
20081
20281
|
# @param [Hash] opts the optional parameters
|
|
20082
20282
|
# @return [UserProductsTerminateResponse]
|
|
@@ -20086,7 +20286,7 @@ module Plaid
|
|
|
20086
20286
|
end
|
|
20087
20287
|
|
|
20088
20288
|
# Terminate user-based products
|
|
20089
|
-
#
|
|
20289
|
+
# Terminates user-based recurring subscription bundles or products (Financial Management, Plaid Protect, and CRA Cash Flow Updates) associated with a `user_id`. After you call this endpoint, the user will no longer be billed for these products. For CRA Monitoring, the subscription is canceled but historical data remains available for future report requests.
|
|
20090
20290
|
# @param user_products_terminate_request [UserProductsTerminateRequest]
|
|
20091
20291
|
# @param [Hash] opts the optional parameters
|
|
20092
20292
|
# @return [Array<(UserProductsTerminateResponse, Integer, Hash)>] UserProductsTerminateResponse data, response status code and response headers
|
|
@@ -20144,7 +20344,7 @@ module Plaid
|
|
|
20144
20344
|
end
|
|
20145
20345
|
|
|
20146
20346
|
# Remove user
|
|
20147
|
-
# `/user/remove` deletes a `user_id` or `user_token` and
|
|
20347
|
+
# `/user/remove` deletes a `user_id` or `user_token` and associated information, including any Items associated with the user.
|
|
20148
20348
|
# @param user_remove_request [UserRemoveRequest]
|
|
20149
20349
|
# @param [Hash] opts the optional parameters
|
|
20150
20350
|
# @option opts [Boolean] :plaid_new_user_api_enabled The HTTP header used in API requests to determine which set of User APIs to invoke: the legacy CRA version or the new User API version. (default to false)
|
|
@@ -20155,7 +20355,7 @@ module Plaid
|
|
|
20155
20355
|
end
|
|
20156
20356
|
|
|
20157
20357
|
# Remove user
|
|
20158
|
-
# `/user/remove` deletes a `user_id` or `user_token` and
|
|
20358
|
+
# `/user/remove` deletes a `user_id` or `user_token` and associated information, including any Items associated with the user.
|
|
20159
20359
|
# @param user_remove_request [UserRemoveRequest]
|
|
20160
20360
|
# @param [Hash] opts the optional parameters
|
|
20161
20361
|
# @option opts [Boolean] :plaid_new_user_api_enabled The HTTP header used in API requests to determine which set of User APIs to invoke: the legacy CRA version or the new User API version. (default to false)
|