plaid 44.0.0 → 45.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 +163 -0
- data/Dockerfile +2 -2
- data/Gemfile.lock +11 -17
- data/Makefile +1 -1
- data/lib/plaid/api/plaid_api.rb +783 -103
- 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 +1 -1
- data/lib/plaid/models/account_assets.rb +15 -5
- data/lib/plaid/models/account_balance.rb +4 -4
- data/lib/plaid/models/account_base.rb +2 -2
- data/lib/plaid/models/account_base_nullable.rb +2 -2
- 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 +2 -2
- data/lib/plaid/models/account_identity_all_of.rb +1 -1
- data/lib/plaid/models/account_identity_document_upload.rb +2 -2
- data/lib/plaid/models/account_identity_document_upload_all_of.rb +1 -1
- data/lib/plaid/models/account_identity_match_score.rb +2 -2
- data/lib/plaid/models/account_identity_match_score_all_of.rb +1 -1
- data/lib/plaid/models/account_insights.rb +231 -0
- 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 +1 -1
- data/lib/plaid/models/accounts_balance_get_request_options.rb +1 -1
- data/lib/plaid/models/accounts_get_request.rb +1 -1
- data/lib/plaid/models/accounts_get_request_options.rb +1 -1
- data/lib/plaid/models/accounts_get_response.rb +1 -1
- data/lib/plaid/models/ach_class.rb +1 -1
- data/lib/plaid/models/action_state.rb +1 -1
- data/lib/plaid/models/activity.rb +1 -1
- 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 +231 -0
- data/lib/plaid/models/amount_with_currency.rb +244 -0
- data/lib/plaid/models/amount_with_currency_with_monthly_average.rb +252 -0
- data/lib/plaid/models/application.rb +1 -1
- data/lib/plaid/models/application_get_request.rb +1 -1
- data/lib/plaid/models/application_get_response.rb +1 -1
- data/lib/plaid/models/apr.rb +1 -1
- data/lib/plaid/models/asset.rb +1 -1
- data/lib/plaid/models/asset_detail.rb +1 -1
- data/lib/plaid/models/asset_holder.rb +1 -1
- data/lib/plaid/models/asset_holder_name.rb +1 -1
- data/lib/plaid/models/asset_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 +1 -1
- data/lib/plaid/models/asset_report.rb +12 -2
- data/lib/plaid/models/asset_report_account_balance.rb +1 -1
- data/lib/plaid/models/asset_report_add_ons.rb +1 -1
- data/lib/plaid/models/asset_report_audit_copy_create_request.rb +1 -1
- data/lib/plaid/models/asset_report_audit_copy_create_response.rb +1 -1
- data/lib/plaid/models/asset_report_audit_copy_get_request.rb +1 -1
- data/lib/plaid/models/asset_report_audit_copy_pdf_get_request.rb +255 -0
- data/lib/plaid/models/asset_report_audit_copy_remove_request.rb +1 -1
- data/lib/plaid/models/asset_report_audit_copy_remove_response.rb +1 -1
- data/lib/plaid/models/asset_report_create_request.rb +1 -1
- data/lib/plaid/models/asset_report_create_request_options.rb +1 -1
- data/lib/plaid/models/asset_report_create_response.rb +1 -1
- data/lib/plaid/models/asset_report_filter_request.rb +1 -1
- data/lib/plaid/models/asset_report_filter_response.rb +1 -1
- data/lib/plaid/models/asset_report_freddie.rb +1 -1
- data/lib/plaid/models/asset_report_freddie_get_request.rb +1 -1
- data/lib/plaid/models/asset_report_freddie_get_response.rb +1 -1
- data/lib/plaid/models/asset_report_get_request.rb +1 -1
- data/lib/plaid/models/asset_report_get_request_options.rb +1 -1
- data/lib/plaid/models/asset_report_get_response.rb +1 -1
- data/lib/plaid/models/asset_report_investment_holding.rb +1 -1
- data/lib/plaid/models/asset_report_investment_security.rb +1 -1
- data/lib/plaid/models/asset_report_investment_transaction.rb +1 -1
- data/lib/plaid/models/asset_report_investments.rb +1 -1
- data/lib/plaid/models/asset_report_item.rb +1 -1
- data/lib/plaid/models/asset_report_pdf_get_request.rb +1 -1
- data/lib/plaid/models/asset_report_pdf_get_request_options.rb +1 -1
- data/lib/plaid/models/asset_report_refresh_request.rb +1 -1
- data/lib/plaid/models/asset_report_refresh_request_options.rb +1 -1
- data/lib/plaid/models/asset_report_refresh_response.rb +1 -1
- data/lib/plaid/models/asset_report_remove_request.rb +1 -1
- data/lib/plaid/models/asset_report_remove_response.rb +1 -1
- data/lib/plaid/models/asset_report_transaction.rb +1 -1
- data/lib/plaid/models/asset_report_transaction_type.rb +1 -1
- data/lib/plaid/models/asset_report_type.rb +1 -1
- data/lib/plaid/models/asset_report_user.rb +2 -2
- data/lib/plaid/models/asset_transaction.rb +1 -1
- data/lib/plaid/models/asset_transaction_category_type.rb +1 -1
- data/lib/plaid/models/asset_transaction_description.rb +1 -1
- data/lib/plaid/models/asset_transaction_detail.rb +1 -1
- data/lib/plaid/models/asset_transaction_type.rb +1 -1
- data/lib/plaid/models/asset_transactions.rb +1 -1
- data/lib/plaid/models/asset_type.rb +1 -1
- data/lib/plaid/models/assets.rb +1 -1
- data/lib/plaid/models/assets_error_webhook.rb +1 -1
- data/lib/plaid/models/assets_product_ready_webhook.rb +1 -1
- data/lib/plaid/models/auth_default_update_webhook.rb +1 -1
- data/lib/plaid/models/auth_get_numbers.rb +1 -1
- data/lib/plaid/models/auth_get_request.rb +1 -1
- data/lib/plaid/models/auth_get_request_options.rb +1 -1
- data/lib/plaid/models/auth_get_response.rb +1 -1
- data/lib/plaid/models/auth_metadata.rb +1 -1
- data/lib/plaid/models/auth_supported_methods.rb +1 -1
- data/lib/plaid/models/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 +1 -1
- 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 +1 -1
- data/lib/plaid/models/bank_income_refresh_update_webhook.rb +1 -1
- data/lib/plaid/models/bank_initiated_return_risk.rb +1 -1
- data/lib/plaid/models/bank_penalties_indicators.rb +311 -0
- data/lib/plaid/models/bank_transfer.rb +1 -1
- data/lib/plaid/models/bank_transfer_balance.rb +1 -1
- data/lib/plaid/models/bank_transfer_balance_get_request.rb +1 -1
- data/lib/plaid/models/bank_transfer_balance_get_response.rb +1 -1
- data/lib/plaid/models/bank_transfer_cancel_request.rb +1 -1
- data/lib/plaid/models/bank_transfer_cancel_response.rb +1 -1
- data/lib/plaid/models/bank_transfer_create_request.rb +1 -1
- data/lib/plaid/models/bank_transfer_create_response.rb +1 -1
- data/lib/plaid/models/bank_transfer_direction.rb +1 -1
- data/lib/plaid/models/bank_transfer_event.rb +1 -1
- data/lib/plaid/models/bank_transfer_event_list_bank_transfer_type.rb +1 -1
- data/lib/plaid/models/bank_transfer_event_list_direction.rb +1 -1
- data/lib/plaid/models/bank_transfer_event_list_request.rb +1 -1
- data/lib/plaid/models/bank_transfer_event_list_response.rb +1 -1
- data/lib/plaid/models/bank_transfer_event_sync_request.rb +1 -1
- data/lib/plaid/models/bank_transfer_event_sync_response.rb +1 -1
- data/lib/plaid/models/bank_transfer_event_type.rb +1 -1
- data/lib/plaid/models/bank_transfer_failure.rb +1 -1
- data/lib/plaid/models/bank_transfer_get_request.rb +1 -1
- data/lib/plaid/models/bank_transfer_get_response.rb +1 -1
- data/lib/plaid/models/bank_transfer_list_request.rb +1 -1
- data/lib/plaid/models/bank_transfer_list_response.rb +1 -1
- data/lib/plaid/models/bank_transfer_migrate_account_request.rb +1 -1
- data/lib/plaid/models/bank_transfer_migrate_account_response.rb +1 -1
- data/lib/plaid/models/bank_transfer_network.rb +1 -1
- data/lib/plaid/models/bank_transfer_status.rb +1 -1
- data/lib/plaid/models/bank_transfer_sweep.rb +1 -1
- data/lib/plaid/models/bank_transfer_sweep_get_request.rb +1 -1
- data/lib/plaid/models/bank_transfer_sweep_get_response.rb +1 -1
- data/lib/plaid/models/bank_transfer_sweep_list_request.rb +1 -1
- data/lib/plaid/models/bank_transfer_sweep_list_response.rb +1 -1
- data/lib/plaid/models/bank_transfer_type.rb +1 -1
- data/lib/plaid/models/bank_transfer_user.rb +1 -1
- data/lib/plaid/models/bank_transfers_events_update_webhook.rb +1 -1
- data/lib/plaid/models/bank_transfers_events_update_webhook_for_auth.rb +1 -1
- data/lib/plaid/models/base_report.rb +1 -1
- data/lib/plaid/models/base_report_account.rb +1 -1
- data/lib/plaid/models/base_report_account_balances.rb +1 -1
- data/lib/plaid/models/base_report_account_insights.rb +1 -1
- data/lib/plaid/models/base_report_account_metadata.rb +1 -1
- data/lib/plaid/models/base_report_attributes.rb +5 -5
- 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 +330 -0
- data/lib/plaid/models/base_report_investment_security.rb +303 -0
- data/lib/plaid/models/base_report_investment_transaction.rb +410 -0
- data/lib/plaid/models/base_report_investments.rb +262 -0
- data/lib/plaid/models/base_report_item.rb +1 -1
- 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_type.rb +1 -1
- data/lib/plaid/models/base_report_user_attributes.rb +5 -5
- 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 +1 -1
- data/lib/plaid/models/beacon_account_risk_evaluate_account.rb +1 -1
- data/lib/plaid/models/beacon_account_risk_evaluate_account_attributes.rb +1 -1
- data/lib/plaid/models/beacon_account_risk_evaluate_evaluation_reason.rb +1 -1
- data/lib/plaid/models/beacon_account_risk_evaluate_request.rb +1 -1
- 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 +1 -1
- data/lib/plaid/models/beacon_audit_trail_source.rb +1 -1
- data/lib/plaid/models/beacon_bank_account_insights.rb +1 -1
- 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 +1 -1
- data/lib/plaid/models/beacon_user.rb +1 -1
- data/lib/plaid/models/beacon_user_account_insights_get_request.rb +1 -1
- data/lib/plaid/models/beacon_user_account_insights_get_response.rb +1 -1
- data/lib/plaid/models/beacon_user_address.rb +3 -3
- 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 +1 -1
- data/lib/plaid/models/beacon_user_depository_account.rb +1 -1
- data/lib/plaid/models/beacon_user_get_request.rb +1 -1
- data/lib/plaid/models/beacon_user_get_response.rb +1 -1
- data/lib/plaid/models/beacon_user_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 +3 -3
- data/lib/plaid/models/beacon_user_request_address_nullable.rb +3 -3
- data/lib/plaid/models/beacon_user_request_data.rb +1 -1
- 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 +1 -1
- data/lib/plaid/models/beacon_user_update_response.rb +1 -1
- data/lib/plaid/models/beta_ewa_report_v1_get_request.rb +246 -0
- data/lib/plaid/models/beta_ewa_report_v1_get_response.rb +253 -0
- data/lib/plaid/models/beta_partner_customer_v1_create_request.rb +404 -0
- data/lib/plaid/models/beta_partner_customer_v1_create_response.rb +230 -0
- data/lib/plaid/models/beta_partner_customer_v1_enable_request.rb +256 -0
- data/lib/plaid/models/beta_partner_customer_v1_enable_response.rb +282 -0
- data/lib/plaid/models/beta_partner_customer_v1_get_request.rb +245 -0
- data/lib/plaid/models/beta_partner_customer_v1_get_response.rb +230 -0
- data/lib/plaid/models/beta_partner_customer_v1_update_request.rb +283 -0
- data/lib/plaid/models/beta_partner_customer_v1_update_response.rb +230 -0
- data/lib/plaid/models/beta_partner_end_customer.rb +286 -0
- data/lib/plaid/models/beta_partner_end_customer_with_secrets.rb +303 -0
- data/lib/plaid/models/business_account.rb +2 -2
- data/lib/plaid/models/business_account_all_of.rb +1 -1
- data/lib/plaid/models/business_email_address.rb +222 -0
- data/lib/plaid/models/business_entity_type.rb +57 -0
- data/lib/plaid/models/business_field_match_summary.rb +247 -0
- data/lib/plaid/models/business_finance_category.rb +1 -1
- data/lib/plaid/models/business_kyb_check.rb +314 -0
- data/lib/plaid/models/business_kyb_match_details.rb +333 -0
- data/lib/plaid/models/business_phone_number.rb +222 -0
- data/lib/plaid/models/{identity_creation_result.rb → business_risk_check.rb} +27 -44
- data/lib/plaid/models/business_search_terms.rb +269 -0
- data/lib/plaid/models/business_verification_create_request.rb +260 -0
- data/lib/plaid/models/business_verification_create_request_business.rb +270 -0
- data/lib/plaid/models/business_verification_create_response.rb +363 -0
- data/lib/plaid/models/business_verification_get_request.rb +246 -0
- data/lib/plaid/models/business_verification_get_response.rb +363 -0
- data/lib/plaid/models/{identity_creation_result_type.rb → business_verification_status_kyb_check.rb} +5 -5
- data/lib/plaid/models/business_verification_status_overall.rb +40 -0
- data/lib/plaid/models/business_verification_status_risk_check.rb +40 -0
- data/lib/plaid/models/business_website.rb +222 -0
- data/lib/plaid/models/cash_flow_insight.rb +41 -0
- 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 +1 -1
- data/lib/plaid/models/cash_flow_updates_insights_v2_webhook.rb +323 -0
- data/lib/plaid/models/cash_flow_updates_insights_webhook.rb +2 -2
- data/lib/plaid/models/cash_flow_updates_large_deposit_webhook.rb +1 -1
- data/lib/plaid/models/cash_flow_updates_low_balance_webhook.rb +1 -1
- data/lib/plaid/models/cash_flow_updates_new_income_stream_webhook.rb +1 -1
- data/lib/plaid/models/cash_flow_updates_new_loan_payment_webhook.rb +1 -1
- data/lib/plaid/models/cash_flow_updates_nsf_webhook.rb +1 -1
- data/lib/plaid/models/cashflow_attributes_version.rb +2 -1
- data/lib/plaid/models/cashflow_report_account_insights.rb +1 -1
- data/lib/plaid/models/cashflow_report_get_request.rb +1 -1
- 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 +1 -1
- data/lib/plaid/models/cashflow_report_insights_get_response.rb +1 -1
- 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 +1 -1
- data/lib/plaid/models/cashflow_report_refresh_response.rb +1 -1
- data/lib/plaid/models/cashflow_report_transaction.rb +1 -1
- data/lib/plaid/models/cashflow_report_transactions_get_request.rb +1 -1
- 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 +275 -0
- 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 +26 -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 +2 -1
- data/lib/plaid/models/client_user_identity_address.rb +5 -21
- 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 +1 -1
- data/lib/plaid/models/consent_event.rb +1 -1
- 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 +1 -1
- data/lib/plaid/models/consent_events_get_response.rb +1 -1
- data/lib/plaid/models/consented_account.rb +1 -1
- 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 -2
- data/lib/plaid/models/consumer_report_user_identity.rb +2 -2
- data/lib/plaid/models/counterparty.rb +1 -1
- data/lib/plaid/models/counterparty_insights.rb +1 -1
- data/lib/plaid/models/counterparty_numbers.rb +1 -1
- data/lib/plaid/models/counterparty_numbers_bacs.rb +1 -1
- data/lib/plaid/models/counterparty_numbers_international.rb +1 -1
- data/lib/plaid/models/counterparty_type.rb +1 -1
- data/lib/plaid/models/country_code.rb +1 -1
- data/lib/plaid/models/cra_bank_income_account.rb +1 -1
- 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 +1 -1
- 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 +241 -0
- data/lib/plaid/models/cra_bank_income_item.rb +1 -1
- data/lib/plaid/models/cra_bank_income_source.rb +21 -2
- data/lib/plaid/models/cra_bank_income_status.rb +40 -0
- 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 +4 -4
- data/lib/plaid/models/cra_check_report_base_report_get_request.rb +23 -22
- data/lib/plaid/models/cra_check_report_base_report_get_response.rb +2 -2
- 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 +13 -12
- 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 +23 -17
- 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_income_insights_get_request.rb +16 -15
- 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 +3 -3
- data/lib/plaid/models/cra_check_report_lend_score_get_request.rb +19 -9
- data/lib/plaid/models/cra_check_report_lend_score_get_response.rb +2 -2
- data/lib/plaid/models/cra_check_report_network_insights_get_options.rb +243 -0
- data/lib/plaid/models/cra_check_report_network_insights_get_request.rb +27 -16
- data/lib/plaid/models/cra_check_report_network_insights_get_response.rb +1 -1
- 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 +1 -1
- data/lib/plaid/models/cra_check_report_partner_insights_get_request.rb +13 -12
- data/lib/plaid/models/cra_check_report_partner_insights_get_response.rb +1 -1
- data/lib/plaid/models/cra_check_report_pdf_get_request.rb +22 -21
- data/lib/plaid/models/cra_check_report_ready_webhook.rb +1 -1
- 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 +1 -1
- data/lib/plaid/models/cra_check_report_verification_get_request.rb +16 -15
- 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 +297 -0
- data/lib/plaid/models/cra_check_report_verification_pdf_report_type.rb +39 -0
- data/lib/plaid/models/cra_employment_refresh_report.rb +1 -1
- data/lib/plaid/models/cra_employment_refresh_report_account.rb +1 -1
- data/lib/plaid/models/cra_employment_refresh_report_item.rb +1 -1
- data/lib/plaid/models/cra_employment_refresh_report_transaction.rb +1 -1
- data/lib/plaid/models/cra_income_insights.rb +1 -1
- data/lib/plaid/models/cra_lend_score_report.rb +4 -4
- 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 +1 -1
- 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 +16 -20
- 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 +23 -27
- 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_network_insights_item.rb +1 -1
- data/lib/plaid/models/cra_network_insights_report.rb +4 -4
- data/lib/plaid/models/cra_partner_insights.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_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 +1 -1
- data/lib/plaid/models/cra_partner_insights_item_account.rb +1 -1
- 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_pdf_add_ons.rb +3 -2
- data/lib/plaid/models/cra_prediction_interval.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 +292 -0
- data/lib/plaid/models/cra_user_check_report_ready_webhook.rb +328 -0
- data/lib/plaid/models/cra_verification_report.rb +1 -1
- data/lib/plaid/models/cra_voa_report.rb +1 -1
- data/lib/plaid/models/cra_voa_report_account.rb +16 -6
- data/lib/plaid/models/cra_voa_report_account_balances.rb +2 -2
- 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 +1 -1
- 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 +1 -1
- data/lib/plaid/models/credit_account_subtype.rb +1 -1
- data/lib/plaid/models/credit_ach_class.rb +1 -1
- data/lib/plaid/models/credit_amount_with_currency.rb +1 -1
- data/lib/plaid/models/credit_audit_copy_token_create_request.rb +1 -1
- data/lib/plaid/models/credit_audit_copy_token_create_response.rb +1 -1
- data/lib/plaid/models/credit_audit_copy_token_remove_request.rb +1 -1
- data/lib/plaid/models/credit_audit_copy_token_remove_response.rb +1 -1
- data/lib/plaid/models/credit_audit_copy_token_update_request.rb +1 -1
- data/lib/plaid/models/credit_audit_copy_token_update_response.rb +1 -1
- data/lib/plaid/models/credit_bank_employer.rb +1 -1
- data/lib/plaid/models/credit_bank_employment.rb +1 -1
- data/lib/plaid/models/credit_bank_employment_get_request.rb +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 +1 -1
- data/lib/plaid/models/credit_bank_income_summary.rb +1 -1
- data/lib/plaid/models/credit_bank_income_transaction.rb +1 -1
- data/lib/plaid/models/credit_bank_income_warning.rb +1 -1
- data/lib/plaid/models/credit_bank_income_warning_code.rb +1 -1
- data/lib/plaid/models/credit_bank_income_warning_type.rb +1 -1
- data/lib/plaid/models/credit_bank_income_webhook_update_request.rb +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 +1 -1
- 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 +1 -1
- 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 +1 -1
- data/lib/plaid/models/credit_freddie_mac_reports_get_request.rb +1 -1
- data/lib/plaid/models/credit_freddie_mac_reports_get_response.rb +1 -1
- data/lib/plaid/models/credit_freddie_mac_service.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 +2 -2
- data/lib/plaid/models/credit_payroll_income_parsing_config_update_response.rb +1 -1
- 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 +1 -1
- data/lib/plaid/models/credit_session_bank_income_result.rb +1 -1
- data/lib/plaid/models/credit_session_bank_income_status.rb +1 -1
- data/lib/plaid/models/credit_session_document_income_result.rb +1 -1
- data/lib/plaid/models/credit_session_error.rb +1 -1
- data/lib/plaid/models/credit_session_item_add_result.rb +1 -1
- data/lib/plaid/models/credit_session_payroll_income_result.rb +1 -1
- data/lib/plaid/models/credit_session_results.rb +1 -1
- data/lib/plaid/models/credit_sessions_get_request.rb +2 -2
- data/lib/plaid/models/credit_sessions_get_response.rb +1 -1
- data/lib/plaid/models/credit_w2.rb +1 -1
- 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 +1 -1
- data/lib/plaid/models/dashboard_user_get_request.rb +1 -1
- data/lib/plaid/models/dashboard_user_get_response.rb +1 -1
- data/lib/plaid/models/dashboard_user_list_request.rb +1 -1
- data/lib/plaid/models/dashboard_user_list_response.rb +1 -1
- data/lib/plaid/models/dashboard_user_status.rb +1 -1
- data/lib/plaid/models/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 +1 -1
- 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 +1 -1
- data/lib/plaid/models/employment_verification_get_response.rb +1 -1
- data/lib/plaid/models/employment_verification_status.rb +1 -1
- data/lib/plaid/models/enhancements.rb +1 -1
- data/lib/plaid/models/enrich_transaction_direction.rb +1 -1
- data/lib/plaid/models/enrichments.rb +1 -1
- data/lib/plaid/models/entity_document.rb +1 -1
- data/lib/plaid/models/entity_document_type.rb +1 -1
- data/lib/plaid/models/entity_screening_hit_analysis.rb +1 -1
- data/lib/plaid/models/entity_screening_hit_data.rb +1 -1
- data/lib/plaid/models/entity_screening_hit_documents_items.rb +1 -1
- data/lib/plaid/models/entity_screening_hit_emails.rb +1 -1
- data/lib/plaid/models/entity_screening_hit_emails_items.rb +1 -1
- data/lib/plaid/models/entity_screening_hit_names.rb +1 -1
- data/lib/plaid/models/entity_screening_hit_names_items.rb +1 -1
- data/lib/plaid/models/entity_screening_hit_phone_numbers.rb +1 -1
- data/lib/plaid/models/entity_screening_hit_urls.rb +1 -1
- data/lib/plaid/models/entity_screening_hit_urls_items.rb +1 -1
- data/lib/plaid/models/entity_screening_hits_phone_number_items.rb +1 -1
- data/lib/plaid/models/entity_screening_status_updated_webhook.rb +1 -1
- data/lib/plaid/models/entity_watchlist_code.rb +1 -1
- data/lib/plaid/models/entity_watchlist_program.rb +1 -1
- data/lib/plaid/models/entity_watchlist_screening.rb +1 -1
- data/lib/plaid/models/entity_watchlist_screening_hit.rb +1 -1
- data/lib/plaid/models/entity_watchlist_screening_review.rb +1 -1
- data/lib/plaid/models/entity_watchlist_screening_search_terms.rb +1 -1
- data/lib/plaid/models/entity_watchlist_search_terms.rb +1 -1
- data/lib/plaid/models/ewa_score.rb +241 -0
- data/lib/plaid/models/expenditure_insights.rb +280 -0
- data/lib/plaid/models/expenditure_insights_cash_flow.rb +251 -0
- data/lib/plaid/models/expenditure_summary.rb +288 -0
- 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_content_types.rb +1 -1
- data/lib/plaid/models/fdx_event_status.rb +41 -0
- 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 +280 -0
- data/lib/plaid/models/fdx_notification.rb +1 -1
- data/lib/plaid/models/fdx_notification_category.rb +2 -1
- data/lib/plaid/models/fdx_notification_payload.rb +11 -2
- 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 +2 -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 +1 -1
- data/lib/plaid/models/fdx_update_reason.rb +41 -0
- 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 +1 -1
- 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 +311 -0
- 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 +1 -1
- data/lib/plaid/models/holdings_default_update_webhook.rb +1 -1
- data/lib/plaid/models/holdings_override.rb +1 -1
- data/lib/plaid/models/hosted_link_delivery_method.rb +1 -1
- data/lib/plaid/models/hosted_mmd_verification_webhook.rb +1 -1
- 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 +1 -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 +1 -1
- 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 +1 -1
- data/lib/plaid/models/identity_get_request_options.rb +1 -1
- data/lib/plaid/models/identity_get_response.rb +1 -1
- data/lib/plaid/models/identity_match_request.rb +1 -1
- data/lib/plaid/models/identity_match_request_options.rb +1 -1
- data/lib/plaid/models/identity_match_response.rb +1 -1
- data/lib/plaid/models/identity_match_user.rb +1 -1
- data/lib/plaid/models/identity_refresh_request.rb +1 -1
- data/lib/plaid/models/identity_refresh_response.rb +1 -1
- data/lib/plaid/models/identity_update_types.rb +1 -1
- data/lib/plaid/models/identity_verification.rb +17 -7
- data/lib/plaid/models/identity_verification_autofill_address.rb +3 -3
- 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 +2 -2
- data/lib/plaid/models/identity_verification_create_request_user.rb +1 -1
- data/lib/plaid/models/identity_verification_create_response.rb +13 -3
- data/lib/plaid/models/identity_verification_document_address_response.rb +2 -2
- 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 +13 -3
- data/lib/plaid/models/identity_verification_list_request.rb +2 -1
- data/lib/plaid/models/identity_verification_list_response.rb +1 -1
- data/lib/plaid/models/identity_verification_request_user.rb +1 -1
- data/lib/plaid/models/identity_verification_request_user_name.rb +1 -1
- data/lib/plaid/models/identity_verification_response_user_name.rb +1 -1
- data/lib/plaid/models/identity_verification_retried_webhook.rb +1 -1
- data/lib/plaid/models/identity_verification_retry_request.rb +1 -1
- data/lib/plaid/models/identity_verification_retry_request_steps_object.rb +2 -2
- data/lib/plaid/models/identity_verification_retry_response.rb +13 -3
- data/lib/plaid/models/identity_verification_status.rb +1 -1
- data/lib/plaid/models/identity_verification_status_updated_webhook.rb +1 -1
- data/lib/plaid/models/identity_verification_step_status.rb +1 -1
- data/lib/plaid/models/identity_verification_step_summary.rb +1 -1
- data/lib/plaid/models/identity_verification_step_updated_webhook.rb +1 -1
- data/lib/plaid/models/identity_verification_template_reference.rb +1 -1
- data/lib/plaid/models/identity_verification_user_address.rb +3 -3
- data/lib/plaid/models/identity_verification_user_data.rb +1 -1
- data/lib/plaid/models/idv_protect_event.rb +264 -0
- data/lib/plaid/models/image_quality.rb +1 -1
- data/lib/plaid/models/image_quality_details.rb +1 -1
- 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 +238 -0
- data/lib/plaid/models/income_insights_income_excluding_transfers.rb +251 -0
- data/lib/plaid/models/income_insights_total_income.rb +251 -0
- data/lib/plaid/models/income_insights_transfers_in.rb +251 -0
- 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 +1 -1
- data/lib/plaid/models/income_verification_payroll_flow_type.rb +1 -1
- data/lib/plaid/models/income_verification_paystubs_get_request.rb +1 -1
- data/lib/plaid/models/income_verification_paystubs_get_response.rb +1 -1
- data/lib/plaid/models/income_verification_precheck_confidence.rb +1 -1
- data/lib/plaid/models/income_verification_precheck_employer.rb +1 -1
- data/lib/plaid/models/income_verification_precheck_employer_address.rb +1 -1
- data/lib/plaid/models/income_verification_precheck_employer_address_data.rb +1 -1
- data/lib/plaid/models/income_verification_precheck_military_info.rb +1 -1
- data/lib/plaid/models/income_verification_precheck_payroll_institution.rb +1 -1
- data/lib/plaid/models/income_verification_precheck_request.rb +1 -1
- data/lib/plaid/models/income_verification_precheck_response.rb +1 -1
- data/lib/plaid/models/income_verification_precheck_user.rb +1 -1
- data/lib/plaid/models/income_verification_refresh_reconnect_needed_webhook.rb +1 -1
- data/lib/plaid/models/income_verification_risk_signals_status_webhook.rb +1 -1
- data/lib/plaid/models/income_verification_source_type.rb +1 -1
- data/lib/plaid/models/income_verification_status_webhook.rb +1 -1
- data/lib/plaid/models/income_verification_taxforms_get_request.rb +1 -1
- data/lib/plaid/models/income_verification_taxforms_get_response.rb +1 -1
- data/lib/plaid/models/income_verification_webhook_status.rb +1 -1
- data/lib/plaid/models/individual_name.rb +1 -1
- data/lib/plaid/models/individual_screening_hit_names.rb +1 -1
- data/lib/plaid/models/individual_watchlist_code.rb +1 -1
- data/lib/plaid/models/individual_watchlist_program.rb +1 -1
- data/lib/plaid/models/inflow_model.rb +1 -1
- data/lib/plaid/models/initial_update_webhook.rb +1 -1
- data/lib/plaid/models/institution.rb +2 -2
- 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 +2 -2
- 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 +2 -2
- data/lib/plaid/models/institutions_search_request_options.rb +1 -1
- data/lib/plaid/models/institutions_search_response.rb +1 -1
- data/lib/plaid/models/investment_account_subtype.rb +1 -1
- data/lib/plaid/models/investment_filter.rb +1 -1
- data/lib/plaid/models/investment_holdings_get_request_options.rb +1 -1
- data/lib/plaid/models/investment_transaction.rb +14 -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 +1 -1
- data/lib/plaid/models/investments_auth_get_request_options.rb +1 -1
- data/lib/plaid/models/investments_auth_get_response.rb +1 -1
- data/lib/plaid/models/investments_auth_owner.rb +1 -1
- data/lib/plaid/models/investments_default_update_webhook.rb +1 -1
- data/lib/plaid/models/investments_historical_update_webhook.rb +1 -1
- data/lib/plaid/models/investments_holdings_get_request.rb +1 -1
- data/lib/plaid/models/investments_holdings_get_response.rb +1 -1
- data/lib/plaid/models/investments_refresh_request.rb +1 -1
- data/lib/plaid/models/investments_refresh_response.rb +1 -1
- data/lib/plaid/models/investments_transactions_get_request.rb +1 -1
- data/lib/plaid/models/investments_transactions_get_request_options.rb +1 -1
- data/lib/plaid/models/investments_transactions_get_response.rb +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 +2 -2
- data/lib/plaid/models/issues_search_request.rb +1 -1
- data/lib/plaid/models/issues_search_response.rb +2 -2
- 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 +2 -2
- data/lib/plaid/models/issuing_country.rb +1 -1
- data/lib/plaid/models/item.rb +1 -1
- data/lib/plaid/models/item_access_token_invalidate_request.rb +1 -1
- data/lib/plaid/models/item_access_token_invalidate_response.rb +1 -1
- data/lib/plaid/models/item_activity_list_request.rb +1 -1
- data/lib/plaid/models/item_activity_list_response.rb +1 -1
- data/lib/plaid/models/item_add_result_webhook.rb +1 -1
- data/lib/plaid/models/item_application_list_request.rb +1 -1
- data/lib/plaid/models/item_application_list_response.rb +1 -1
- data/lib/plaid/models/item_application_list_user_auth.rb +1 -1
- data/lib/plaid/models/item_application_scopes_update_request.rb +1 -1
- data/lib/plaid/models/item_application_scopes_update_response.rb +1 -1
- data/lib/plaid/models/item_application_unlink_request.rb +1 -1
- 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 +1 -1
- data/lib/plaid/models/item_get_request.rb +1 -1
- data/lib/plaid/models/item_get_response.rb +1 -1
- data/lib/plaid/models/item_import_request.rb +1 -1
- data/lib/plaid/models/item_import_request_options.rb +1 -1
- data/lib/plaid/models/item_import_request_user_auth.rb +1 -1
- data/lib/plaid/models/item_import_response.rb +1 -1
- data/lib/plaid/models/item_login_repaired_webhook.rb +1 -1
- data/lib/plaid/models/item_product_ready_webhook.rb +1 -1
- data/lib/plaid/models/item_public_token_create_request.rb +1 -1
- data/lib/plaid/models/item_public_token_create_response.rb +1 -1
- data/lib/plaid/models/item_public_token_exchange_request.rb +1 -1
- data/lib/plaid/models/item_public_token_exchange_response.rb +1 -1
- data/lib/plaid/models/item_remove_reason_code.rb +1 -1
- data/lib/plaid/models/item_remove_request.rb +1 -1
- data/lib/plaid/models/item_remove_response.rb +1 -1
- data/lib/plaid/models/item_status.rb +1 -1
- data/lib/plaid/models/item_status_investments.rb +1 -1
- data/lib/plaid/models/item_status_last_webhook.rb +1 -1
- data/lib/plaid/models/item_status_nullable.rb +1 -1
- data/lib/plaid/models/item_status_transactions.rb +1 -1
- data/lib/plaid/models/item_webhook_update_request.rb +1 -1
- data/lib/plaid/models/item_webhook_update_response.rb +1 -1
- data/lib/plaid/models/item_with_consent_fields.rb +1 -1
- 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 +1 -1
- data/lib/plaid/models/layer_authentication_passed_webhook.rb +2 -2
- data/lib/plaid/models/ledger_event_source_type.rb +1 -1
- data/lib/plaid/models/lend_score.rb +5 -5
- data/lib/plaid/models/liabilities_default_update_webhook.rb +1 -1
- data/lib/plaid/models/liabilities_get_request.rb +1 -1
- data/lib/plaid/models/liabilities_get_request_options.rb +1 -1
- data/lib/plaid/models/liabilities_get_response.rb +1 -1
- data/lib/plaid/models/liabilities_object.rb +1 -1
- data/lib/plaid/models/liability_override.rb +1 -1
- data/lib/plaid/models/link_callback_metadata.rb +1 -1
- data/lib/plaid/models/link_delivery_account.rb +1 -1
- data/lib/plaid/models/link_delivery_callback_webhook.rb +1 -1
- data/lib/plaid/models/link_delivery_communication_method.rb +1 -1
- data/lib/plaid/models/link_delivery_create_request.rb +1 -1
- data/lib/plaid/models/link_delivery_create_response.rb +1 -1
- data/lib/plaid/models/link_delivery_delivery_method.rb +1 -1
- data/lib/plaid/models/link_delivery_get_request.rb +1 -1
- data/lib/plaid/models/link_delivery_get_response.rb +1 -1
- data/lib/plaid/models/link_delivery_institution.rb +1 -1
- data/lib/plaid/models/link_delivery_metadata.rb +1 -1
- data/lib/plaid/models/link_delivery_options.rb +1 -1
- data/lib/plaid/models/link_delivery_recipient.rb +1 -1
- data/lib/plaid/models/link_delivery_session_status.rb +1 -1
- data/lib/plaid/models/link_delivery_verification_status.rb +1 -1
- data/lib/plaid/models/link_delivery_webhook_callback_type.rb +1 -1
- data/lib/plaid/models/link_delivery_webhook_communication_method.rb +1 -1
- data/lib/plaid/models/link_delivery_webhook_delivery_status.rb +1 -1
- data/lib/plaid/models/link_event.rb +1 -1
- data/lib/plaid/models/link_event_metadata.rb +1 -1
- data/lib/plaid/models/link_event_name.rb +1 -1
- data/lib/plaid/models/link_events_webhook.rb +1 -1
- data/lib/plaid/models/link_o_auth_correlation_id_exchange_request.rb +1 -1
- data/lib/plaid/models/link_o_auth_correlation_id_exchange_response.rb +1 -1
- data/lib/plaid/models/link_session_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 +1 -1
- 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 +1 -1
- data/lib/plaid/models/link_session_exit_metadata_institution.rb +1 -1
- data/lib/plaid/models/link_session_finished_webhook.rb +2 -2
- 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_protect_result.rb +1 -1
- data/lib/plaid/models/link_session_results.rb +2 -2
- 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 +2 -2
- data/lib/plaid/models/link_session_success_metadata_institution.rb +1 -1
- data/lib/plaid/models/link_session_success_metadata_transfer_status.rb +1 -1
- data/lib/plaid/models/link_token_account_filters.rb +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 +1 -1
- data/lib/plaid/models/link_token_create_hosted_link.rb +1 -1
- 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 +21 -20
- 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 +1 -1
- data/lib/plaid/models/link_token_create_request_base_report.rb +1 -1
- data/lib/plaid/models/link_token_create_request_cra_options.rb +11 -2
- 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_lend_score.rb +3 -3
- data/lib/plaid/models/link_token_create_request_cra_options_network_insights.rb +243 -0
- 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 +1 -1
- data/lib/plaid/models/link_token_create_request_user.rb +1 -1
- data/lib/plaid/models/link_token_create_request_user_address.rb +3 -3
- 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 +12 -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 +323 -0
- 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 +323 -0
- 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 +2 -2
- 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 +1 -1
- 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 +244 -0
- data/lib/plaid/models/monthly_summary.rb +243 -0
- 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 +255 -0
- data/lib/plaid/models/negative_balance_occurrence.rb +243 -0
- data/lib/plaid/models/net_pay.rb +1 -1
- data/lib/plaid/models/network_insights_item.rb +1 -1
- data/lib/plaid/models/network_insights_report.rb +2 -2
- data/lib/plaid/models/network_insights_report_get_request.rb +1 -1
- data/lib/plaid/models/network_insights_report_get_response.rb +1 -1
- data/lib/plaid/models/network_insights_version.rb +38 -0
- 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 +1 -1
- data/lib/plaid/models/numbers_acats.rb +1 -1
- data/lib/plaid/models/numbers_ach.rb +1 -1
- data/lib/plaid/models/numbers_ach_nullable.rb +1 -1
- data/lib/plaid/models/numbers_aton.rb +1 -1
- data/lib/plaid/models/numbers_bacs.rb +1 -1
- data/lib/plaid/models/numbers_bacs_nullable.rb +1 -1
- data/lib/plaid/models/numbers_eft.rb +1 -1
- data/lib/plaid/models/numbers_eft_nullable.rb +1 -1
- data/lib/plaid/models/numbers_iban_nullable.rb +1 -1
- data/lib/plaid/models/numbers_international.rb +1 -1
- data/lib/plaid/models/numbers_international_iban.rb +1 -1
- data/lib/plaid/models/numbers_international_nullable.rb +1 -1
- data/lib/plaid/models/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 +1 -1
- data/lib/plaid/models/o_auth_token_response.rb +1 -1
- 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 +1 -1
- 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 +244 -0
- data/lib/plaid/models/override_account_type.rb +1 -1
- data/lib/plaid/models/override_accounts.rb +1 -1
- data/lib/plaid/models/owner.rb +1 -1
- data/lib/plaid/models/owner_override.rb +1 -1
- data/lib/plaid/models/ownership_type.rb +1 -1
- data/lib/plaid/models/parties.rb +1 -1
- data/lib/plaid/models/partner_customer_create_request.rb +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 +241 -0
- data/lib/plaid/models/partner_end_customer_billing_contact.rb +1 -1
- data/lib/plaid/models/partner_end_customer_cra_purposes.rb +283 -0
- data/lib/plaid/models/partner_end_customer_cra_questionnaire.rb +240 -0
- data/lib/plaid/models/partner_end_customer_cra_use_case.rb +44 -0
- data/lib/plaid/models/partner_end_customer_cra_use_cases.rb +223 -0
- 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 +220 -0
- data/lib/plaid/models/partner_end_customer_requirement_due.rb +46 -0
- data/lib/plaid/models/partner_end_customer_secrets.rb +1 -1
- data/lib/plaid/models/partner_end_customer_status.rb +2 -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 +1 -1
- data/lib/plaid/models/payment_initiation_consent_payer_details.rb +1 -1
- data/lib/plaid/models/payment_initiation_consent_payer_numbers.rb +1 -1
- data/lib/plaid/models/payment_initiation_consent_payment_execute_request.rb +1 -1
- data/lib/plaid/models/payment_initiation_consent_payment_execute_response.rb +1 -1
- data/lib/plaid/models/payment_initiation_consent_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 +1 -1
- data/lib/plaid/models/payment_initiation_consent_scope.rb +1 -1
- data/lib/plaid/models/payment_initiation_consent_status.rb +1 -1
- data/lib/plaid/models/payment_initiation_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 +1 -1
- data/lib/plaid/models/payment_initiation_payment_list_request.rb +1 -1
- data/lib/plaid/models/payment_initiation_payment_list_response.rb +1 -1
- data/lib/plaid/models/payment_initiation_payment_reverse_request.rb +1 -1
- data/lib/plaid/models/payment_initiation_payment_reverse_response.rb +1 -1
- data/lib/plaid/models/payment_initiation_payment_status.rb +1 -1
- data/lib/plaid/models/payment_initiation_payment_token_create_request.rb +1 -1
- data/lib/plaid/models/payment_initiation_payment_token_create_response.rb +1 -1
- data/lib/plaid/models/payment_initiation_recipient.rb +1 -1
- data/lib/plaid/models/payment_initiation_recipient_create_request.rb +1 -1
- data/lib/plaid/models/payment_initiation_recipient_create_response.rb +1 -1
- data/lib/plaid/models/payment_initiation_recipient_get_request.rb +1 -1
- data/lib/plaid/models/payment_initiation_recipient_get_response.rb +1 -1
- data/lib/plaid/models/payment_initiation_recipient_get_response_all_of.rb +1 -1
- data/lib/plaid/models/payment_initiation_recipient_list_request.rb +1 -1
- data/lib/plaid/models/payment_initiation_recipient_list_response.rb +1 -1
- data/lib/plaid/models/payment_initiation_standing_order_metadata.rb +1 -1
- data/lib/plaid/models/payment_meta.rb +1 -1
- data/lib/plaid/models/payment_profile_create_request.rb +1 -1
- data/lib/plaid/models/payment_profile_create_response.rb +1 -1
- data/lib/plaid/models/payment_profile_get_request.rb +1 -1
- data/lib/plaid/models/payment_profile_get_response.rb +1 -1
- data/lib/plaid/models/payment_profile_remove_request.rb +1 -1
- data/lib/plaid/models/payment_profile_remove_response.rb +1 -1
- data/lib/plaid/models/payment_profile_status.rb +1 -1
- data/lib/plaid/models/payment_schedule_interval.rb +1 -1
- data/lib/plaid/models/payment_scheme.rb +1 -1
- data/lib/plaid/models/payment_status_update_webhook.rb +1 -1
- data/lib/plaid/models/payroll_income_account_data.rb +1 -1
- data/lib/plaid/models/payroll_income_object.rb +1 -1
- data/lib/plaid/models/payroll_income_rate_of_pay.rb +1 -1
- data/lib/plaid/models/payroll_item.rb +1 -1
- data/lib/plaid/models/payroll_item_status.rb +1 -1
- data/lib/plaid/models/payroll_risk_signals_item.rb +1 -1
- data/lib/plaid/models/paystub.rb +1 -1
- data/lib/plaid/models/paystub_address.rb +1 -1
- data/lib/plaid/models/paystub_deduction.rb +1 -1
- data/lib/plaid/models/paystub_details.rb +1 -1
- data/lib/plaid/models/paystub_employer.rb +1 -1
- data/lib/plaid/models/paystub_override.rb +1 -1
- data/lib/plaid/models/paystub_override_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 +1 -1
- data/lib/plaid/models/pending_disconnect_webhook_reason.rb +1 -1
- data/lib/plaid/models/pending_expiration_webhook.rb +1 -1
- data/lib/plaid/models/personal_finance_category.rb +25 -4
- data/lib/plaid/models/personal_finance_category_version.rb +39 -0
- 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 +15 -4
- 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_check_score.rb +3 -3
- data/lib/plaid/models/plaid_check_score_version.rb +1 -1
- data/lib/plaid/models/plaid_error.rb +30 -6
- data/lib/plaid/models/plaid_error_type.rb +3 -1
- data/lib/plaid/models/plaid_lend_score_version.rb +40 -0
- 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 +2 -2
- data/lib/plaid/models/prism_insights_version.rb +1 -1
- data/lib/plaid/models/prism_product.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 +1 -1
- data/lib/plaid/models/processor_auth_get_request.rb +1 -1
- data/lib/plaid/models/processor_auth_get_response.rb +1 -1
- data/lib/plaid/models/processor_balance_get_request.rb +1 -1
- data/lib/plaid/models/processor_balance_get_request_options.rb +1 -1
- data/lib/plaid/models/processor_balance_get_response.rb +1 -1
- data/lib/plaid/models/processor_bank_transfer_create_request.rb +1 -1
- data/lib/plaid/models/processor_bank_transfer_create_response.rb +1 -1
- data/lib/plaid/models/processor_default_update_webhook.rb +1 -1
- data/lib/plaid/models/processor_historical_update_webhook.rb +1 -1
- data/lib/plaid/models/processor_identity_get_request.rb +1 -1
- data/lib/plaid/models/processor_identity_get_response.rb +1 -1
- data/lib/plaid/models/processor_identity_match_request.rb +1 -1
- data/lib/plaid/models/processor_identity_match_response.rb +1 -1
- data/lib/plaid/models/processor_initial_update_webhook.rb +1 -1
- data/lib/plaid/models/processor_investments_holdings_get_request.rb +1 -1
- data/lib/plaid/models/processor_investments_holdings_get_response.rb +1 -1
- 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 +1 -1
- data/lib/plaid/models/processor_recurring_transactions_update_webhook.rb +1 -1
- data/lib/plaid/models/processor_signal_decision_report_request.rb +1 -1
- data/lib/plaid/models/processor_signal_decision_report_response.rb +1 -1
- data/lib/plaid/models/processor_signal_evaluate_request.rb +3 -3
- data/lib/plaid/models/processor_signal_evaluate_response.rb +2 -2
- 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 +1 -1
- data/lib/plaid/models/processor_stripe_bank_account_token_create_response.rb +1 -1
- data/lib/plaid/models/processor_sync_updates_available_webhook.rb +1 -1
- data/lib/plaid/models/processor_token_create_request.rb +3 -3
- data/lib/plaid/models/processor_token_create_response.rb +1 -1
- data/lib/plaid/models/processor_token_permissions_get_request.rb +1 -1
- data/lib/plaid/models/processor_token_permissions_get_response.rb +1 -1
- data/lib/plaid/models/processor_token_permissions_set_request.rb +1 -1
- data/lib/plaid/models/processor_token_permissions_set_response.rb +1 -1
- data/lib/plaid/models/processor_token_webhook_update.rb +1 -1
- data/lib/plaid/models/processor_token_webhook_update_request.rb +1 -1
- data/lib/plaid/models/processor_token_webhook_update_response.rb +1 -1
- data/lib/plaid/models/processor_transactions_get_request.rb +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 +24 -3
- data/lib/plaid/models/processor_transactions_refresh_request.rb +1 -1
- data/lib/plaid/models/processor_transactions_refresh_response.rb +1 -1
- data/lib/plaid/models/processor_transactions_removed_webhook.rb +1 -1
- data/lib/plaid/models/processor_transactions_sync_request.rb +1 -1
- data/lib/plaid/models/processor_transactions_sync_response.rb +1 -1
- data/lib/plaid/models/product_access.rb +1 -1
- data/lib/plaid/models/product_permissions_required_auth_webhook.rb +1 -1
- data/lib/plaid/models/product_permissions_required_identity_webhook.rb +1 -1
- data/lib/plaid/models/product_status.rb +1 -1
- data/lib/plaid/models/product_status_breakdown.rb +1 -1
- data/lib/plaid/models/products.rb +1 -2
- 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_event.rb +1 -1
- data/lib/plaid/models/protect_event_get_request.rb +1 -1
- data/lib/plaid/models/protect_event_get_response.rb +1 -1
- data/lib/plaid/models/protect_event_send_request.rb +1 -1
- data/lib/plaid/models/protect_event_send_response.rb +1 -1
- data/lib/plaid/models/protect_incident_amount.rb +1 -1
- data/lib/plaid/models/protect_incident_event.rb +16 -6
- data/lib/plaid/models/protect_incident_event_response.rb +298 -0
- data/lib/plaid/models/protect_report.rb +347 -0
- data/lib/plaid/models/protect_report_confidence.rb +1 -1
- data/lib/plaid/models/protect_report_create_request.rb +364 -0
- data/lib/plaid/models/{user_items_list_response.rb → protect_report_create_response.rb} +19 -32
- 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_user_event_webhook.rb +1 -1
- data/lib/plaid/models/protect_user_insights_get_request.rb +1 -1
- data/lib/plaid/models/protect_user_insights_get_response.rb +14 -2
- data/lib/plaid/models/provider_business_address.rb +296 -0
- 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 +1 -1
- data/lib/plaid/models/recipient_bacs.rb +1 -1
- data/lib/plaid/models/recipient_bacs_nullable.rb +1 -1
- data/lib/plaid/models/recommendation_string.rb +1 -1
- data/lib/plaid/models/recurrence.rb +2 -2
- data/lib/plaid/models/recurring_cancelled_webhook.rb +1 -1
- data/lib/plaid/models/recurring_frequency.rb +1 -1
- data/lib/plaid/models/recurring_insights_stream.rb +1 -1
- data/lib/plaid/models/recurring_new_transfer_webhook.rb +1 -1
- data/lib/plaid/models/recurring_transaction_frequency.rb +1 -1
- data/lib/plaid/models/recurring_transactions.rb +1 -1
- data/lib/plaid/models/recurring_transactions_update_webhook.rb +1 -1
- data/lib/plaid/models/recurring_transfer.rb +1 -1
- data/lib/plaid/models/recurring_transfer_nullable.rb +1 -1
- data/lib/plaid/models/recurring_transfer_skipped_webhook.rb +1 -1
- data/lib/plaid/models/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 +1 -1
- data/lib/plaid/models/request_business_address.rb +289 -0
- data/lib/plaid/models/response_business_address.rb +281 -0
- 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 +23 -6
- data/lib/plaid/models/risk_check_device.rb +1 -1
- data/lib/plaid/models/risk_check_email.rb +1 -1
- data/lib/plaid/models/risk_check_email_domain_is_custom.rb +1 -1
- data/lib/plaid/models/risk_check_email_domain_is_disposable.rb +1 -1
- data/lib/plaid/models/risk_check_email_domain_is_free_provider.rb +1 -1
- data/lib/plaid/models/risk_check_email_is_deliverable_status.rb +1 -1
- data/lib/plaid/models/risk_check_email_top_level_domain_is_suspicious.rb +1 -1
- data/lib/plaid/models/risk_check_facial_duplicate.rb +256 -0
- 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 +261 -0
- 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 +1 -1
- data/lib/plaid/models/risk_reason.rb +1 -1
- data/lib/plaid/models/risk_signal_document_reference.rb +1 -1
- data/lib/plaid/models/risk_signal_document_status.rb +1 -1
- data/lib/plaid/models/risk_signal_document_type.rb +1 -1
- data/lib/plaid/models/risk_signal_file_type.rb +1 -1
- data/lib/plaid/models/role.rb +1 -1
- data/lib/plaid/models/role_detail.rb +1 -1
- data/lib/plaid/models/roles.rb +1 -1
- data/lib/plaid/models/rule_details.rb +1 -1
- data/lib/plaid/models/rule_result.rb +1 -1
- data/lib/plaid/models/ruleset.rb +2 -2
- data/lib/plaid/models/sandbox_bank_income_fire_webhook_request.rb +1 -1
- data/lib/plaid/models/sandbox_bank_income_fire_webhook_response.rb +1 -1
- data/lib/plaid/models/sandbox_bank_income_webhook_fire_request_webhook_code.rb +1 -1
- data/lib/plaid/models/sandbox_bank_income_webhook_fire_request_webhook_fields.rb +1 -1
- data/lib/plaid/models/sandbox_bank_transfer_fire_webhook_request.rb +1 -1
- data/lib/plaid/models/sandbox_bank_transfer_fire_webhook_response.rb +1 -1
- data/lib/plaid/models/sandbox_bank_transfer_simulate_request.rb +1 -1
- data/lib/plaid/models/sandbox_bank_transfer_simulate_response.rb +1 -1
- data/lib/plaid/models/sandbox_cra_cashflow_updates_update_request.rb +17 -21
- 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/sandbox_item_fire_webhook_request.rb +1 -1
- data/lib/plaid/models/sandbox_item_fire_webhook_response.rb +1 -1
- data/lib/plaid/models/sandbox_item_reset_login_request.rb +1 -1
- data/lib/plaid/models/sandbox_item_reset_login_response.rb +1 -1
- data/lib/plaid/models/sandbox_item_set_verification_status_request.rb +1 -1
- data/lib/plaid/models/sandbox_item_set_verification_status_response.rb +1 -1
- data/lib/plaid/models/sandbox_oauth_select_accounts_request.rb +1 -1
- data/lib/plaid/models/sandbox_payment_profile_reset_login_request.rb +1 -1
- data/lib/plaid/models/sandbox_payment_profile_reset_login_response.rb +1 -1
- data/lib/plaid/models/sandbox_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 +17 -7
- 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 +2 -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 +1 -1
- 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 +1 -1
- data/lib/plaid/models/sandbox_transfer_ledger_deposit_simulate_response.rb +1 -1
- data/lib/plaid/models/sandbox_transfer_ledger_simulate_available_request.rb +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 +1 -1
- data/lib/plaid/models/sandbox_transfer_ledger_withdraw_simulate_response.rb +1 -1
- data/lib/plaid/models/sandbox_transfer_refund_simulate_request.rb +1 -1
- 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_simulate_request.rb +1 -1
- data/lib/plaid/models/sandbox_transfer_simulate_response.rb +1 -1
- data/lib/plaid/models/sandbox_transfer_sweep_simulate_request.rb +1 -1
- data/lib/plaid/models/sandbox_transfer_sweep_simulate_response.rb +1 -1
- data/lib/plaid/models/sandbox_transfer_test_clock_advance_request.rb +1 -1
- data/lib/plaid/models/sandbox_transfer_test_clock_advance_response.rb +1 -1
- data/lib/plaid/models/sandbox_transfer_test_clock_create_request.rb +1 -1
- data/lib/plaid/models/sandbox_transfer_test_clock_create_response.rb +1 -1
- data/lib/plaid/models/sandbox_transfer_test_clock_get_request.rb +1 -1
- data/lib/plaid/models/sandbox_transfer_test_clock_get_response.rb +1 -1
- data/lib/plaid/models/sandbox_transfer_test_clock_list_request.rb +1 -1
- data/lib/plaid/models/sandbox_transfer_test_clock_list_response.rb +1 -1
- data/lib/plaid/models/sandbox_user_reset_login_request.rb +17 -12
- 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 +1 -1
- data/lib/plaid/models/screening_hit_data.rb +1 -1
- data/lib/plaid/models/screening_hit_date_of_birth_item.rb +1 -1
- data/lib/plaid/models/screening_hit_documents_items.rb +1 -1
- data/lib/plaid/models/screening_hit_names_items.rb +1 -1
- data/lib/plaid/models/screening_status_updated_webhook.rb +1 -1
- data/lib/plaid/models/security.rb +1 -1
- data/lib/plaid/models/security_override.rb +1 -1
- data/lib/plaid/models/selfie_analysis.rb +1 -1
- data/lib/plaid/models/selfie_analysis_document_comparison.rb +1 -1
- data/lib/plaid/models/selfie_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 +1 -1
- data/lib/plaid/models/selfie_check.rb +1 -1
- data/lib/plaid/models/selfie_check_selfie.rb +1 -1
- data/lib/plaid/models/selfie_check_status.rb +1 -1
- data/lib/plaid/models/selfie_status.rb +1 -1
- data/lib/plaid/models/sender_bacs_nullable.rb +1 -1
- data/lib/plaid/models/service.rb +1 -1
- data/lib/plaid/models/service_product_fulfillment.rb +1 -1
- data/lib/plaid/models/service_product_fulfillment_detail.rb +1 -1
- data/lib/plaid/models/service_product_fulfillment_identifier.rb +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 +15 -14
- data/lib/plaid/models/session_token_create_request_user.rb +2 -3
- 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 +2 -2
- data/lib/plaid/models/signal_evaluate_core_attributes.rb +2 -2
- data/lib/plaid/models/signal_evaluate_request.rb +5 -5
- data/lib/plaid/models/signal_evaluate_response.rb +2 -2
- data/lib/plaid/models/signal_payment_method.rb +1 -1
- data/lib/plaid/models/signal_person_name.rb +1 -1
- data/lib/plaid/models/signal_prepare_request.rb +1 -1
- data/lib/plaid/models/signal_prepare_response.rb +1 -1
- data/lib/plaid/models/signal_return_report_request.rb +1 -1
- data/lib/plaid/models/signal_return_report_response.rb +1 -1
- data/lib/plaid/models/signal_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 +1 -1
- data/lib/plaid/models/signal_schedule_response.rb +2 -2
- data/lib/plaid/models/signal_scores.rb +2 -2
- data/lib/plaid/models/signal_user.rb +2 -2
- data/lib/plaid/models/signal_warning.rb +2 -2
- data/lib/plaid/models/simulated_transfer_sweep.rb +1 -1
- data/lib/plaid/models/single_document_risk_signal.rb +1 -1
- data/lib/plaid/models/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 +1 -1
- data/lib/plaid/models/statements_list_request.rb +1 -1
- data/lib/plaid/models/statements_list_response.rb +1 -1
- data/lib/plaid/models/statements_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 +1 -1
- data/lib/plaid/models/statements_refresh_response.rb +1 -1
- data/lib/plaid/models/statements_statement.rb +1 -1
- data/lib/plaid/models/status.rb +1 -1
- data/lib/plaid/models/statuses.rb +1 -1
- data/lib/plaid/models/strategy.rb +1 -1
- data/lib/plaid/models/student_loan.rb +1 -1
- data/lib/plaid/models/student_loan_repayment_model.rb +1 -1
- data/lib/plaid/models/student_loan_status.rb +1 -1
- data/lib/plaid/models/student_repayment_plan.rb +1 -1
- data/lib/plaid/models/sweep_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 +1 -1
- 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 +1 -1
- 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 +1 -1
- data/lib/plaid/models/transaction_counterparty.rb +1 -1
- data/lib/plaid/models/transaction_data.rb +1 -1
- data/lib/plaid/models/transaction_override.rb +1 -1
- data/lib/plaid/models/transaction_stream.rb +1 -1
- data/lib/plaid/models/transaction_stream_amount.rb +1 -1
- data/lib/plaid/models/transaction_stream_status.rb +1 -1
- data/lib/plaid/models/transactions_category_rule.rb +1 -1
- data/lib/plaid/models/transactions_enhance_get_request.rb +1 -1
- data/lib/plaid/models/transactions_enhance_get_response.rb +1 -1
- data/lib/plaid/models/transactions_enrich_request.rb +1 -1
- data/lib/plaid/models/transactions_enrich_request_options.rb +24 -3
- data/lib/plaid/models/transactions_enrich_response.rb +1 -1
- data/lib/plaid/models/transactions_get_request.rb +1 -1
- data/lib/plaid/models/transactions_get_request_options.rb +24 -3
- 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 +1 -1
- data/lib/plaid/models/transactions_recurring_create_response.rb +1 -1
- data/lib/plaid/models/transactions_recurring_get_request.rb +1 -1
- data/lib/plaid/models/transactions_recurring_get_request_options.rb +24 -3
- data/lib/plaid/models/transactions_recurring_get_response.rb +24 -3
- data/lib/plaid/models/transactions_recurring_merge_input.rb +1 -1
- data/lib/plaid/models/transactions_recurring_merge_request.rb +1 -1
- 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 +1 -1
- data/lib/plaid/models/transactions_recurring_update_response.rb +1 -1
- data/lib/plaid/models/transactions_refresh_request.rb +1 -1
- data/lib/plaid/models/transactions_refresh_response.rb +1 -1
- data/lib/plaid/models/transactions_removed_webhook.rb +1 -1
- data/lib/plaid/models/transactions_rule_details.rb +1 -1
- data/lib/plaid/models/transactions_rule_field.rb +1 -1
- data/lib/plaid/models/transactions_rule_type.rb +1 -1
- data/lib/plaid/models/transactions_rules_create_request.rb +2 -2
- data/lib/plaid/models/transactions_rules_create_response.rb +1 -1
- data/lib/plaid/models/transactions_rules_list_request.rb +1 -1
- data/lib/plaid/models/transactions_rules_list_response.rb +1 -1
- data/lib/plaid/models/transactions_rules_remove_request.rb +1 -1
- data/lib/plaid/models/transactions_rules_remove_response.rb +1 -1
- data/lib/plaid/models/transactions_sync_request.rb +1 -1
- data/lib/plaid/models/transactions_sync_request_options.rb +24 -3
- data/lib/plaid/models/transactions_sync_response.rb +1 -1
- 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 +1 -1
- data/lib/plaid/models/transfer_ach_network.rb +1 -1
- data/lib/plaid/models/transfer_authorization.rb +1 -1
- data/lib/plaid/models/transfer_authorization_cancel_request.rb +1 -1
- data/lib/plaid/models/transfer_authorization_cancel_response.rb +1 -1
- data/lib/plaid/models/transfer_authorization_create_request.rb +14 -3
- 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 +1 -1
- 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 +1 -1
- data/lib/plaid/models/transfer_cancel_response.rb +1 -1
- data/lib/plaid/models/transfer_capabilities_get_request.rb +1 -1
- data/lib/plaid/models/transfer_capabilities_get_response.rb +1 -1
- data/lib/plaid/models/transfer_capabilities_get_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 +1 -1
- data/lib/plaid/models/transfer_create_response.rb +1 -1
- data/lib/plaid/models/transfer_credit_funds_source.rb +1 -1
- data/lib/plaid/models/transfer_credit_usage_configuration.rb +2 -2
- data/lib/plaid/models/transfer_debit_usage_configuration.rb +1 -1
- data/lib/plaid/models/transfer_device.rb +1 -1
- data/lib/plaid/models/transfer_diligence_document_upload_request.rb +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 +1 -1
- data/lib/plaid/models/transfer_event_list_request.rb +1 -1
- data/lib/plaid/models/transfer_event_list_response.rb +1 -1
- data/lib/plaid/models/transfer_event_list_transfer_type.rb +1 -1
- data/lib/plaid/models/transfer_event_sync_request.rb +1 -1
- data/lib/plaid/models/transfer_event_sync_response.rb +1 -1
- data/lib/plaid/models/transfer_event_type.rb +1 -1
- data/lib/plaid/models/transfer_events_update_webhook.rb +1 -1
- data/lib/plaid/models/transfer_expected_sweep_settlement_schedule_item.rb +1 -1
- data/lib/plaid/models/transfer_failure.rb +1 -1
- data/lib/plaid/models/transfer_funding_account.rb +1 -1
- data/lib/plaid/models/transfer_funding_account_with_display_name.rb +1 -1
- data/lib/plaid/models/transfer_funding_account_with_display_name_all_of.rb +1 -1
- data/lib/plaid/models/transfer_get_request.rb +1 -1
- data/lib/plaid/models/transfer_get_response.rb +1 -1
- data/lib/plaid/models/transfer_intent_authorization_decision.rb +1 -1
- data/lib/plaid/models/transfer_intent_create.rb +1 -1
- data/lib/plaid/models/transfer_intent_create_mode.rb +1 -1
- data/lib/plaid/models/transfer_intent_create_network.rb +1 -1
- data/lib/plaid/models/transfer_intent_create_request.rb +1 -1
- data/lib/plaid/models/transfer_intent_create_response.rb +1 -1
- data/lib/plaid/models/transfer_intent_get.rb +1 -1
- data/lib/plaid/models/transfer_intent_get_failure_reason.rb +1 -1
- data/lib/plaid/models/transfer_intent_get_request.rb +1 -1
- data/lib/plaid/models/transfer_intent_get_response.rb +1 -1
- data/lib/plaid/models/transfer_intent_status.rb +1 -1
- data/lib/plaid/models/transfer_ledger_balance.rb +1 -1
- data/lib/plaid/models/transfer_ledger_deposit_request.rb +1 -1
- 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 +1 -1
- 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 +2 -2
- data/lib/plaid/models/transfer_platform_requirement_submission.rb +3 -3
- data/lib/plaid/models/transfer_platform_requirement_submit_request.rb +2 -2
- 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 +1 -1
- data/lib/plaid/models/transfer_recurring_cancel_response.rb +1 -1
- data/lib/plaid/models/transfer_recurring_create_request.rb +1 -1
- data/lib/plaid/models/transfer_recurring_create_response.rb +1 -1
- data/lib/plaid/models/transfer_recurring_get_request.rb +1 -1
- data/lib/plaid/models/transfer_recurring_get_response.rb +1 -1
- data/lib/plaid/models/transfer_recurring_list_request.rb +1 -1
- data/lib/plaid/models/transfer_recurring_list_response.rb +1 -1
- data/lib/plaid/models/transfer_recurring_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 +1 -1
- data/lib/plaid/models/transfer_refund_cancel_request.rb +1 -1
- data/lib/plaid/models/transfer_refund_cancel_response.rb +1 -1
- data/lib/plaid/models/transfer_refund_create_request.rb +1 -1
- data/lib/plaid/models/transfer_refund_create_response.rb +1 -1
- data/lib/plaid/models/transfer_refund_failure.rb +1 -1
- data/lib/plaid/models/transfer_refund_get_request.rb +1 -1
- data/lib/plaid/models/transfer_refund_get_response.rb +1 -1
- data/lib/plaid/models/transfer_refund_status.rb +1 -1
- data/lib/plaid/models/transfer_repayment.rb +1 -1
- data/lib/plaid/models/transfer_repayment_list_request.rb +1 -1
- data/lib/plaid/models/transfer_repayment_list_response.rb +1 -1
- data/lib/plaid/models/transfer_repayment_return.rb +1 -1
- data/lib/plaid/models/transfer_repayment_return_list_request.rb +1 -1
- data/lib/plaid/models/transfer_repayment_return_list_response.rb +1 -1
- data/lib/plaid/models/transfer_schedule_interval_unit.rb +1 -1
- data/lib/plaid/models/transfer_status.rb +1 -1
- data/lib/plaid/models/transfer_sweep.rb +1 -1
- data/lib/plaid/models/transfer_sweep_get_request.rb +1 -1
- data/lib/plaid/models/transfer_sweep_get_response.rb +1 -1
- data/lib/plaid/models/transfer_sweep_list_request.rb +1 -1
- data/lib/plaid/models/transfer_sweep_list_response.rb +1 -1
- data/lib/plaid/models/transfer_sweep_status.rb +1 -1
- data/lib/plaid/models/transfer_test_clock.rb +1 -1
- data/lib/plaid/models/transfer_type.rb +1 -1
- data/lib/plaid/models/transfer_user_address_in_request.rb +1 -1
- data/lib/plaid/models/transfer_user_address_in_response.rb +1 -1
- data/lib/plaid/models/transfer_user_in_request.rb +1 -1
- data/lib/plaid/models/transfer_user_in_request_deprecated.rb +1 -1
- data/lib/plaid/models/transfer_user_in_response.rb +1 -1
- data/lib/plaid/models/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 +1 -1
- data/lib/plaid/models/user_account_identity_address.rb +1 -1
- data/lib/plaid/models/user_account_identity_name.rb +1 -1
- data/lib/plaid/models/user_account_item.rb +1 -1
- data/lib/plaid/models/user_account_revoked_webhook.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 +3 -3
- data/lib/plaid/models/user_based_products.rb +48 -0
- data/lib/plaid/models/user_create_request.rb +19 -9
- data/lib/plaid/models/user_create_response.rb +7 -16
- 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_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 +16 -11
- data/lib/plaid/models/user_items_get_response.rb +1 -1
- data/lib/plaid/models/user_permission_revoked_webhook.rb +2 -2
- data/lib/plaid/models/{user_items_list_request.rb → user_products_terminate_request.rb} +16 -43
- data/lib/plaid/models/user_products_terminate_response.rb +226 -0
- data/lib/plaid/models/user_remove_request.rb +16 -16
- 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 +17 -12
- 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 +27 -27
- data/lib/plaid/models/user_update_response.rb +5 -14
- 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 +1 -1
- 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 +1 -1
- 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 +1 -1
- data/lib/plaid/models/wallet_transaction_amount.rb +1 -1
- data/lib/plaid/models/wallet_transaction_counterparty.rb +1 -1
- data/lib/plaid/models/wallet_transaction_counterparty_bacs.rb +1 -1
- data/lib/plaid/models/wallet_transaction_counterparty_international.rb +1 -1
- data/lib/plaid/models/wallet_transaction_counterparty_numbers.rb +1 -1
- data/lib/plaid/models/wallet_transaction_execute_request.rb +1 -1
- data/lib/plaid/models/wallet_transaction_execute_response.rb +1 -1
- data/lib/plaid/models/wallet_transaction_failure_reason.rb +1 -1
- data/lib/plaid/models/wallet_transaction_get_request.rb +1 -1
- data/lib/plaid/models/wallet_transaction_get_response.rb +1 -1
- data/lib/plaid/models/wallet_transaction_list_request.rb +1 -1
- data/lib/plaid/models/wallet_transaction_list_request_options.rb +1 -1
- data/lib/plaid/models/wallet_transaction_list_response.rb +1 -1
- data/lib/plaid/models/wallet_transaction_relation.rb +1 -1
- data/lib/plaid/models/wallet_transaction_status.rb +1 -1
- data/lib/plaid/models/wallet_transaction_status_update_webhook.rb +1 -1
- data/lib/plaid/models/wallet_transactions_list_request.rb +1 -1
- data/lib/plaid/models/warning.rb +1 -1
- data/lib/plaid/models/watchlist_screening_audit_trail.rb +1 -1
- data/lib/plaid/models/watchlist_screening_document.rb +1 -1
- data/lib/plaid/models/watchlist_screening_document_type.rb +1 -1
- data/lib/plaid/models/watchlist_screening_entity_create_request.rb +1 -1
- data/lib/plaid/models/watchlist_screening_entity_create_response.rb +1 -1
- data/lib/plaid/models/watchlist_screening_entity_get_request.rb +1 -1
- data/lib/plaid/models/watchlist_screening_entity_get_response.rb +1 -1
- data/lib/plaid/models/watchlist_screening_entity_history_list_request.rb +1 -1
- data/lib/plaid/models/watchlist_screening_entity_history_list_response.rb +1 -1
- data/lib/plaid/models/watchlist_screening_entity_hit_list_request.rb +1 -1
- data/lib/plaid/models/watchlist_screening_entity_hit_list_response.rb +1 -1
- data/lib/plaid/models/watchlist_screening_entity_list_request.rb +1 -1
- data/lib/plaid/models/watchlist_screening_entity_list_response.rb +1 -1
- data/lib/plaid/models/watchlist_screening_entity_program_get_request.rb +1 -1
- data/lib/plaid/models/watchlist_screening_entity_program_get_response.rb +1 -1
- data/lib/plaid/models/watchlist_screening_entity_program_list_request.rb +1 -1
- data/lib/plaid/models/watchlist_screening_entity_program_list_response.rb +1 -1
- data/lib/plaid/models/watchlist_screening_entity_review_create_request.rb +1 -1
- data/lib/plaid/models/watchlist_screening_entity_review_create_response.rb +1 -1
- data/lib/plaid/models/watchlist_screening_entity_review_list_request.rb +1 -1
- data/lib/plaid/models/watchlist_screening_entity_review_list_response.rb +1 -1
- data/lib/plaid/models/watchlist_screening_entity_update_request.rb +1 -1
- data/lib/plaid/models/watchlist_screening_entity_update_request_resettable_field.rb +1 -1
- data/lib/plaid/models/watchlist_screening_entity_update_response.rb +1 -1
- data/lib/plaid/models/watchlist_screening_hit.rb +1 -1
- data/lib/plaid/models/watchlist_screening_hit_locations.rb +1 -1
- data/lib/plaid/models/watchlist_screening_hit_status.rb +1 -1
- data/lib/plaid/models/watchlist_screening_individual.rb +1 -1
- data/lib/plaid/models/watchlist_screening_individual_create_request.rb +1 -1
- data/lib/plaid/models/watchlist_screening_individual_create_response.rb +1 -1
- data/lib/plaid/models/watchlist_screening_individual_get_request.rb +1 -1
- data/lib/plaid/models/watchlist_screening_individual_get_response.rb +1 -1
- data/lib/plaid/models/watchlist_screening_individual_history_list_request.rb +1 -1
- data/lib/plaid/models/watchlist_screening_individual_history_list_response.rb +1 -1
- data/lib/plaid/models/watchlist_screening_individual_hit_list_request.rb +1 -1
- data/lib/plaid/models/watchlist_screening_individual_hit_list_response.rb +1 -1
- data/lib/plaid/models/watchlist_screening_individual_list_request.rb +1 -1
- data/lib/plaid/models/watchlist_screening_individual_list_response.rb +1 -1
- data/lib/plaid/models/watchlist_screening_individual_program_get_request.rb +1 -1
- data/lib/plaid/models/watchlist_screening_individual_program_get_response.rb +1 -1
- data/lib/plaid/models/watchlist_screening_individual_program_list_request.rb +1 -1
- data/lib/plaid/models/watchlist_screening_individual_program_list_response.rb +1 -1
- data/lib/plaid/models/watchlist_screening_individual_review_create_request.rb +1 -1
- data/lib/plaid/models/watchlist_screening_individual_review_create_response.rb +1 -1
- data/lib/plaid/models/watchlist_screening_individual_review_list_request.rb +1 -1
- data/lib/plaid/models/watchlist_screening_individual_review_list_response.rb +1 -1
- data/lib/plaid/models/watchlist_screening_individual_update_request.rb +1 -1
- data/lib/plaid/models/watchlist_screening_individual_update_request_resettable_field.rb +1 -1
- data/lib/plaid/models/watchlist_screening_individual_update_response.rb +1 -1
- data/lib/plaid/models/watchlist_screening_request_search_terms.rb +1 -1
- data/lib/plaid/models/watchlist_screening_review.rb +1 -1
- data/lib/plaid/models/watchlist_screening_search_terms.rb +1 -1
- data/lib/plaid/models/watchlist_screening_status.rb +1 -1
- data/lib/plaid/models/weak_alias_determination.rb +1 -1
- data/lib/plaid/models/webhook_environment_values.rb +1 -1
- data/lib/plaid/models/webhook_type.rb +1 -1
- data/lib/plaid/models/webhook_update_acknowledged_webhook.rb +1 -1
- data/lib/plaid/models/webhook_verification_key_get_request.rb +1 -1
- data/lib/plaid/models/webhook_verification_key_get_response.rb +1 -1
- data/lib/plaid/models/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 +93 -5
- data/plaid.gemspec +2 -2
- data/templates/ruby/Gemfile.mustache +9 -0
- data/templates/ruby/README.mustache +152 -0
- data/templates/ruby/Rakefile.mustache +10 -0
- data/templates/ruby/api.mustache +255 -0
- data/templates/ruby/api_client_spec.mustache +220 -0
- data/templates/ruby/api_client_typhoeus_partial.mustache +155 -0
- data/templates/ruby/api_doc.mustache +132 -0
- data/templates/ruby/api_info.mustache +12 -0
- data/templates/ruby/api_test.mustache +47 -0
- data/templates/ruby/base_object.mustache +121 -0
- data/templates/ruby/configuration_faraday_partial.mustache +40 -0
- data/templates/ruby/configuration_spec.mustache +34 -0
- data/templates/ruby/configuration_typhoeus_partial.mustache +41 -0
- data/templates/ruby/gem.mustache +64 -0
- data/templates/ruby/gemspec.mustache +1 -1
- data/templates/ruby/git_push.sh.mustache +57 -0
- data/templates/ruby/gitignore.mustache +39 -0
- data/templates/ruby/gitlab-ci.mustache +26 -0
- data/templates/ruby/model.mustache +26 -0
- data/templates/ruby/model_doc.mustache +12 -0
- data/templates/ruby/model_test.mustache +77 -0
- data/templates/ruby/partial_model_generic_doc.mustache +28 -0
- data/templates/ruby/partial_oneof_module.mustache +137 -0
- data/templates/ruby/partial_oneof_module_doc.mustache +93 -0
- data/templates/ruby/rspec.mustache +2 -0
- data/templates/ruby/rubocop.mustache +148 -0
- data/templates/ruby/spec_helper.mustache +103 -0
- data/templates/ruby/travis.mustache +11 -0
- data/templates/ruby/version.mustache +7 -0
- metadata +124 -8
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.680.0
|
|
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,
|
|
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](/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,
|
|
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](/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 — 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 realtime balance information, use the paid
|
|
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 realtime 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 — 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 realtime balance information, use the paid
|
|
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 realtime 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
|
|
@@ -359,6 +359,74 @@ module Plaid
|
|
|
359
359
|
return data, status_code, headers
|
|
360
360
|
end
|
|
361
361
|
|
|
362
|
+
# Retrieve a PDF Asset Report Audit Copy
|
|
363
|
+
# The `/asset_report/audit_copy/pdf/get` endpoint retrieves an Asset Report Audit Copy in PDF format. The caller must provide the `audit_copy_token` that was shared via the `/asset_report/audit_copy/create` endpoint. The response to `/asset_report/audit_copy/pdf/get` is the PDF binary data. The `request_id` is returned in the `Plaid-Request-ID` header. [View a sample PDF Asset Report](https://plaid.com/documents/sample-asset-report.pdf).
|
|
364
|
+
# @param asset_report_audit_copy_pdf_get_request [AssetReportAuditCopyPdfGetRequest]
|
|
365
|
+
# @param [Hash] opts the optional parameters
|
|
366
|
+
# @return [File]
|
|
367
|
+
def asset_report_audit_copy_pdf_get(asset_report_audit_copy_pdf_get_request, opts = {})
|
|
368
|
+
data, _status_code, _headers = asset_report_audit_copy_pdf_get_with_http_info(asset_report_audit_copy_pdf_get_request, opts)
|
|
369
|
+
data
|
|
370
|
+
end
|
|
371
|
+
|
|
372
|
+
# Retrieve a PDF Asset Report Audit Copy
|
|
373
|
+
# The `/asset_report/audit_copy/pdf/get` endpoint retrieves an Asset Report Audit Copy in PDF format. The caller must provide the `audit_copy_token` that was shared via the `/asset_report/audit_copy/create` endpoint. The response to `/asset_report/audit_copy/pdf/get` is the PDF binary data. The `request_id` is returned in the `Plaid-Request-ID` header. [View a sample PDF Asset Report](https://plaid.com/documents/sample-asset-report.pdf).
|
|
374
|
+
# @param asset_report_audit_copy_pdf_get_request [AssetReportAuditCopyPdfGetRequest]
|
|
375
|
+
# @param [Hash] opts the optional parameters
|
|
376
|
+
# @return [Array<(File, Integer, Hash)>] File data, response status code and response headers
|
|
377
|
+
def asset_report_audit_copy_pdf_get_with_http_info(asset_report_audit_copy_pdf_get_request, opts = {})
|
|
378
|
+
if @api_client.config.debugging
|
|
379
|
+
@api_client.config.logger.debug 'Calling API: PlaidApi.asset_report_audit_copy_pdf_get ...'
|
|
380
|
+
end
|
|
381
|
+
# verify the required parameter 'asset_report_audit_copy_pdf_get_request' is set
|
|
382
|
+
if @api_client.config.client_side_validation && asset_report_audit_copy_pdf_get_request.nil?
|
|
383
|
+
fail ArgumentError, "Missing the required parameter 'asset_report_audit_copy_pdf_get_request' when calling PlaidApi.asset_report_audit_copy_pdf_get"
|
|
384
|
+
end
|
|
385
|
+
# resource path
|
|
386
|
+
local_var_path = '/asset_report/audit_copy/pdf/get'
|
|
387
|
+
|
|
388
|
+
# query parameters
|
|
389
|
+
query_params = opts[:query_params] || {}
|
|
390
|
+
|
|
391
|
+
# header parameters
|
|
392
|
+
header_params = opts[:header_params] || {}
|
|
393
|
+
# HTTP header 'Accept' (if needed)
|
|
394
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/pdf', 'application/json'])
|
|
395
|
+
# HTTP header 'Content-Type'
|
|
396
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
|
397
|
+
if !content_type.nil?
|
|
398
|
+
header_params['Content-Type'] = content_type
|
|
399
|
+
end
|
|
400
|
+
|
|
401
|
+
# form parameters
|
|
402
|
+
form_params = opts[:form_params] || {}
|
|
403
|
+
|
|
404
|
+
# http body (model)
|
|
405
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(asset_report_audit_copy_pdf_get_request)
|
|
406
|
+
|
|
407
|
+
# return_type
|
|
408
|
+
return_type = opts[:debug_return_type] || 'File'
|
|
409
|
+
|
|
410
|
+
# auth_names
|
|
411
|
+
auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
|
|
412
|
+
|
|
413
|
+
new_options = opts.merge(
|
|
414
|
+
:operation => :"PlaidApi.asset_report_audit_copy_pdf_get",
|
|
415
|
+
:header_params => header_params,
|
|
416
|
+
:query_params => query_params,
|
|
417
|
+
:form_params => form_params,
|
|
418
|
+
:body => post_body,
|
|
419
|
+
:auth_names => auth_names,
|
|
420
|
+
:return_type => return_type
|
|
421
|
+
)
|
|
422
|
+
|
|
423
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
|
424
|
+
if @api_client.config.debugging
|
|
425
|
+
@api_client.config.logger.debug "API called: PlaidApi#asset_report_audit_copy_pdf_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
426
|
+
end
|
|
427
|
+
return data, status_code, headers
|
|
428
|
+
end
|
|
429
|
+
|
|
362
430
|
# Remove Asset Report Audit Copy
|
|
363
431
|
# The `/asset_report/audit_copy/remove` endpoint allows you to remove an Audit Copy. Removing an Audit Copy invalidates the `audit_copy_token` associated with it, meaning both you and any third parties holding the token will no longer be able to use it to access Report data. Items associated with the Asset Report, the Asset Report itself and other Audit Copies of it are not affected and will remain accessible after removing the given Audit Copy.
|
|
364
432
|
# @param asset_report_audit_copy_remove_request [AssetReportAuditCopyRemoveRequest]
|
|
@@ -663,7 +731,7 @@ module Plaid
|
|
|
663
731
|
# header parameters
|
|
664
732
|
header_params = opts[:header_params] || {}
|
|
665
733
|
# HTTP header 'Accept' (if needed)
|
|
666
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/pdf'])
|
|
734
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/pdf', 'application/json'])
|
|
667
735
|
# HTTP header 'Content-Type'
|
|
668
736
|
content_type = @api_client.select_header_content_type(['application/json'])
|
|
669
737
|
if !content_type.nil?
|
|
@@ -2535,6 +2603,482 @@ module Plaid
|
|
|
2535
2603
|
return data, status_code, headers
|
|
2536
2604
|
end
|
|
2537
2605
|
|
|
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–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
|
+
# @param beta_ewa_report_v1_get_request [BetaEwaReportV1GetRequest]
|
|
2609
|
+
# @param [Hash] opts the optional parameters
|
|
2610
|
+
# @return [BetaEwaReportV1GetResponse]
|
|
2611
|
+
def beta_ewa_report_v1_get(beta_ewa_report_v1_get_request, opts = {})
|
|
2612
|
+
data, _status_code, _headers = beta_ewa_report_v1_get_with_http_info(beta_ewa_report_v1_get_request, opts)
|
|
2613
|
+
data
|
|
2614
|
+
end
|
|
2615
|
+
|
|
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–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
|
+
# @param beta_ewa_report_v1_get_request [BetaEwaReportV1GetRequest]
|
|
2619
|
+
# @param [Hash] opts the optional parameters
|
|
2620
|
+
# @return [Array<(BetaEwaReportV1GetResponse, Integer, Hash)>] BetaEwaReportV1GetResponse data, response status code and response headers
|
|
2621
|
+
def beta_ewa_report_v1_get_with_http_info(beta_ewa_report_v1_get_request, opts = {})
|
|
2622
|
+
if @api_client.config.debugging
|
|
2623
|
+
@api_client.config.logger.debug 'Calling API: PlaidApi.beta_ewa_report_v1_get ...'
|
|
2624
|
+
end
|
|
2625
|
+
# verify the required parameter 'beta_ewa_report_v1_get_request' is set
|
|
2626
|
+
if @api_client.config.client_side_validation && beta_ewa_report_v1_get_request.nil?
|
|
2627
|
+
fail ArgumentError, "Missing the required parameter 'beta_ewa_report_v1_get_request' when calling PlaidApi.beta_ewa_report_v1_get"
|
|
2628
|
+
end
|
|
2629
|
+
# resource path
|
|
2630
|
+
local_var_path = '/beta/ewa_report/v1/get'
|
|
2631
|
+
|
|
2632
|
+
# query parameters
|
|
2633
|
+
query_params = opts[:query_params] || {}
|
|
2634
|
+
|
|
2635
|
+
# header parameters
|
|
2636
|
+
header_params = opts[:header_params] || {}
|
|
2637
|
+
# HTTP header 'Accept' (if needed)
|
|
2638
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
2639
|
+
# HTTP header 'Content-Type'
|
|
2640
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
|
2641
|
+
if !content_type.nil?
|
|
2642
|
+
header_params['Content-Type'] = content_type
|
|
2643
|
+
end
|
|
2644
|
+
|
|
2645
|
+
# form parameters
|
|
2646
|
+
form_params = opts[:form_params] || {}
|
|
2647
|
+
|
|
2648
|
+
# http body (model)
|
|
2649
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(beta_ewa_report_v1_get_request)
|
|
2650
|
+
|
|
2651
|
+
# return_type
|
|
2652
|
+
return_type = opts[:debug_return_type] || 'BetaEwaReportV1GetResponse'
|
|
2653
|
+
|
|
2654
|
+
# auth_names
|
|
2655
|
+
auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
|
|
2656
|
+
|
|
2657
|
+
new_options = opts.merge(
|
|
2658
|
+
:operation => :"PlaidApi.beta_ewa_report_v1_get",
|
|
2659
|
+
:header_params => header_params,
|
|
2660
|
+
:query_params => query_params,
|
|
2661
|
+
:form_params => form_params,
|
|
2662
|
+
:body => post_body,
|
|
2663
|
+
:auth_names => auth_names,
|
|
2664
|
+
:return_type => return_type
|
|
2665
|
+
)
|
|
2666
|
+
|
|
2667
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
|
2668
|
+
if @api_client.config.debugging
|
|
2669
|
+
@api_client.config.logger.debug "API called: PlaidApi#beta_ewa_report_v1_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
2670
|
+
end
|
|
2671
|
+
return data, status_code, headers
|
|
2672
|
+
end
|
|
2673
|
+
|
|
2674
|
+
# Creates a new end customer for a Plaid reseller.
|
|
2675
|
+
# The `/beta/partner/customer/v1/create` endpoint creates a new end customer record. You can provide as much information as you have available. If any required information is missing for the products you intend to use, it will be listed in the `requirements_due` field of the response.
|
|
2676
|
+
# @param beta_partner_customer_v1_create_request [BetaPartnerCustomerV1CreateRequest]
|
|
2677
|
+
# @param [Hash] opts the optional parameters
|
|
2678
|
+
# @return [BetaPartnerCustomerV1CreateResponse]
|
|
2679
|
+
def beta_partner_customer_v1_create(beta_partner_customer_v1_create_request, opts = {})
|
|
2680
|
+
data, _status_code, _headers = beta_partner_customer_v1_create_with_http_info(beta_partner_customer_v1_create_request, opts)
|
|
2681
|
+
data
|
|
2682
|
+
end
|
|
2683
|
+
|
|
2684
|
+
# Creates a new end customer for a Plaid reseller.
|
|
2685
|
+
# The `/beta/partner/customer/v1/create` endpoint creates a new end customer record. You can provide as much information as you have available. If any required information is missing for the products you intend to use, it will be listed in the `requirements_due` field of the response.
|
|
2686
|
+
# @param beta_partner_customer_v1_create_request [BetaPartnerCustomerV1CreateRequest]
|
|
2687
|
+
# @param [Hash] opts the optional parameters
|
|
2688
|
+
# @return [Array<(BetaPartnerCustomerV1CreateResponse, Integer, Hash)>] BetaPartnerCustomerV1CreateResponse data, response status code and response headers
|
|
2689
|
+
def beta_partner_customer_v1_create_with_http_info(beta_partner_customer_v1_create_request, opts = {})
|
|
2690
|
+
if @api_client.config.debugging
|
|
2691
|
+
@api_client.config.logger.debug 'Calling API: PlaidApi.beta_partner_customer_v1_create ...'
|
|
2692
|
+
end
|
|
2693
|
+
# verify the required parameter 'beta_partner_customer_v1_create_request' is set
|
|
2694
|
+
if @api_client.config.client_side_validation && beta_partner_customer_v1_create_request.nil?
|
|
2695
|
+
fail ArgumentError, "Missing the required parameter 'beta_partner_customer_v1_create_request' when calling PlaidApi.beta_partner_customer_v1_create"
|
|
2696
|
+
end
|
|
2697
|
+
# resource path
|
|
2698
|
+
local_var_path = '/beta/partner/customer/v1/create'
|
|
2699
|
+
|
|
2700
|
+
# query parameters
|
|
2701
|
+
query_params = opts[:query_params] || {}
|
|
2702
|
+
|
|
2703
|
+
# header parameters
|
|
2704
|
+
header_params = opts[:header_params] || {}
|
|
2705
|
+
# HTTP header 'Accept' (if needed)
|
|
2706
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
2707
|
+
# HTTP header 'Content-Type'
|
|
2708
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
|
2709
|
+
if !content_type.nil?
|
|
2710
|
+
header_params['Content-Type'] = content_type
|
|
2711
|
+
end
|
|
2712
|
+
|
|
2713
|
+
# form parameters
|
|
2714
|
+
form_params = opts[:form_params] || {}
|
|
2715
|
+
|
|
2716
|
+
# http body (model)
|
|
2717
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(beta_partner_customer_v1_create_request)
|
|
2718
|
+
|
|
2719
|
+
# return_type
|
|
2720
|
+
return_type = opts[:debug_return_type] || 'BetaPartnerCustomerV1CreateResponse'
|
|
2721
|
+
|
|
2722
|
+
# auth_names
|
|
2723
|
+
auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
|
|
2724
|
+
|
|
2725
|
+
new_options = opts.merge(
|
|
2726
|
+
:operation => :"PlaidApi.beta_partner_customer_v1_create",
|
|
2727
|
+
:header_params => header_params,
|
|
2728
|
+
:query_params => query_params,
|
|
2729
|
+
:form_params => form_params,
|
|
2730
|
+
:body => post_body,
|
|
2731
|
+
:auth_names => auth_names,
|
|
2732
|
+
:return_type => return_type
|
|
2733
|
+
)
|
|
2734
|
+
|
|
2735
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
|
2736
|
+
if @api_client.config.debugging
|
|
2737
|
+
@api_client.config.logger.debug "API called: PlaidApi#beta_partner_customer_v1_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
2738
|
+
end
|
|
2739
|
+
return data, status_code, headers
|
|
2740
|
+
end
|
|
2741
|
+
|
|
2742
|
+
# Enables a Plaid reseller's end customer in the Production environment.
|
|
2743
|
+
# The `/beta/partner/customer/v1/enable` endpoint is used by reseller partners to enable an end customer in the full Production environment.
|
|
2744
|
+
# @param request_body [Hash<String, Object>]
|
|
2745
|
+
# @param [Hash] opts the optional parameters
|
|
2746
|
+
# @return [BetaPartnerCustomerV1EnableResponse]
|
|
2747
|
+
def beta_partner_customer_v1_enable(request_body, opts = {})
|
|
2748
|
+
data, _status_code, _headers = beta_partner_customer_v1_enable_with_http_info(request_body, opts)
|
|
2749
|
+
data
|
|
2750
|
+
end
|
|
2751
|
+
|
|
2752
|
+
# Enables a Plaid reseller's end customer in the Production environment.
|
|
2753
|
+
# The `/beta/partner/customer/v1/enable` endpoint is used by reseller partners to enable an end customer in the full Production environment.
|
|
2754
|
+
# @param request_body [Hash<String, Object>]
|
|
2755
|
+
# @param [Hash] opts the optional parameters
|
|
2756
|
+
# @return [Array<(BetaPartnerCustomerV1EnableResponse, Integer, Hash)>] BetaPartnerCustomerV1EnableResponse data, response status code and response headers
|
|
2757
|
+
def beta_partner_customer_v1_enable_with_http_info(request_body, opts = {})
|
|
2758
|
+
if @api_client.config.debugging
|
|
2759
|
+
@api_client.config.logger.debug 'Calling API: PlaidApi.beta_partner_customer_v1_enable ...'
|
|
2760
|
+
end
|
|
2761
|
+
# verify the required parameter 'request_body' is set
|
|
2762
|
+
if @api_client.config.client_side_validation && request_body.nil?
|
|
2763
|
+
fail ArgumentError, "Missing the required parameter 'request_body' when calling PlaidApi.beta_partner_customer_v1_enable"
|
|
2764
|
+
end
|
|
2765
|
+
# resource path
|
|
2766
|
+
local_var_path = '/beta/partner/customer/v1/enable'
|
|
2767
|
+
|
|
2768
|
+
# query parameters
|
|
2769
|
+
query_params = opts[:query_params] || {}
|
|
2770
|
+
|
|
2771
|
+
# header parameters
|
|
2772
|
+
header_params = opts[:header_params] || {}
|
|
2773
|
+
# HTTP header 'Accept' (if needed)
|
|
2774
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
2775
|
+
# HTTP header 'Content-Type'
|
|
2776
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
|
2777
|
+
if !content_type.nil?
|
|
2778
|
+
header_params['Content-Type'] = content_type
|
|
2779
|
+
end
|
|
2780
|
+
|
|
2781
|
+
# form parameters
|
|
2782
|
+
form_params = opts[:form_params] || {}
|
|
2783
|
+
|
|
2784
|
+
# http body (model)
|
|
2785
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(request_body)
|
|
2786
|
+
|
|
2787
|
+
# return_type
|
|
2788
|
+
return_type = opts[:debug_return_type] || 'BetaPartnerCustomerV1EnableResponse'
|
|
2789
|
+
|
|
2790
|
+
# auth_names
|
|
2791
|
+
auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
|
|
2792
|
+
|
|
2793
|
+
new_options = opts.merge(
|
|
2794
|
+
:operation => :"PlaidApi.beta_partner_customer_v1_enable",
|
|
2795
|
+
:header_params => header_params,
|
|
2796
|
+
:query_params => query_params,
|
|
2797
|
+
:form_params => form_params,
|
|
2798
|
+
:body => post_body,
|
|
2799
|
+
:auth_names => auth_names,
|
|
2800
|
+
:return_type => return_type
|
|
2801
|
+
)
|
|
2802
|
+
|
|
2803
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
|
2804
|
+
if @api_client.config.debugging
|
|
2805
|
+
@api_client.config.logger.debug "API called: PlaidApi#beta_partner_customer_v1_enable\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
2806
|
+
end
|
|
2807
|
+
return data, status_code, headers
|
|
2808
|
+
end
|
|
2809
|
+
|
|
2810
|
+
# Retrieves the details of a Plaid reseller's end customer.
|
|
2811
|
+
# The `/beta/partner/customer/v1/get` endpoint is used by reseller partners to retrieve data about a single end customer.
|
|
2812
|
+
# @param beta_partner_customer_v1_get_request [BetaPartnerCustomerV1GetRequest]
|
|
2813
|
+
# @param [Hash] opts the optional parameters
|
|
2814
|
+
# @return [BetaPartnerCustomerV1GetResponse]
|
|
2815
|
+
def beta_partner_customer_v1_get(beta_partner_customer_v1_get_request, opts = {})
|
|
2816
|
+
data, _status_code, _headers = beta_partner_customer_v1_get_with_http_info(beta_partner_customer_v1_get_request, opts)
|
|
2817
|
+
data
|
|
2818
|
+
end
|
|
2819
|
+
|
|
2820
|
+
# Retrieves the details of a Plaid reseller's end customer.
|
|
2821
|
+
# The `/beta/partner/customer/v1/get` endpoint is used by reseller partners to retrieve data about a single end customer.
|
|
2822
|
+
# @param beta_partner_customer_v1_get_request [BetaPartnerCustomerV1GetRequest]
|
|
2823
|
+
# @param [Hash] opts the optional parameters
|
|
2824
|
+
# @return [Array<(BetaPartnerCustomerV1GetResponse, Integer, Hash)>] BetaPartnerCustomerV1GetResponse data, response status code and response headers
|
|
2825
|
+
def beta_partner_customer_v1_get_with_http_info(beta_partner_customer_v1_get_request, opts = {})
|
|
2826
|
+
if @api_client.config.debugging
|
|
2827
|
+
@api_client.config.logger.debug 'Calling API: PlaidApi.beta_partner_customer_v1_get ...'
|
|
2828
|
+
end
|
|
2829
|
+
# verify the required parameter 'beta_partner_customer_v1_get_request' is set
|
|
2830
|
+
if @api_client.config.client_side_validation && beta_partner_customer_v1_get_request.nil?
|
|
2831
|
+
fail ArgumentError, "Missing the required parameter 'beta_partner_customer_v1_get_request' when calling PlaidApi.beta_partner_customer_v1_get"
|
|
2832
|
+
end
|
|
2833
|
+
# resource path
|
|
2834
|
+
local_var_path = '/beta/partner/customer/v1/get'
|
|
2835
|
+
|
|
2836
|
+
# query parameters
|
|
2837
|
+
query_params = opts[:query_params] || {}
|
|
2838
|
+
|
|
2839
|
+
# header parameters
|
|
2840
|
+
header_params = opts[:header_params] || {}
|
|
2841
|
+
# HTTP header 'Accept' (if needed)
|
|
2842
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
2843
|
+
# HTTP header 'Content-Type'
|
|
2844
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
|
2845
|
+
if !content_type.nil?
|
|
2846
|
+
header_params['Content-Type'] = content_type
|
|
2847
|
+
end
|
|
2848
|
+
|
|
2849
|
+
# form parameters
|
|
2850
|
+
form_params = opts[:form_params] || {}
|
|
2851
|
+
|
|
2852
|
+
# http body (model)
|
|
2853
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(beta_partner_customer_v1_get_request)
|
|
2854
|
+
|
|
2855
|
+
# return_type
|
|
2856
|
+
return_type = opts[:debug_return_type] || 'BetaPartnerCustomerV1GetResponse'
|
|
2857
|
+
|
|
2858
|
+
# auth_names
|
|
2859
|
+
auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
|
|
2860
|
+
|
|
2861
|
+
new_options = opts.merge(
|
|
2862
|
+
:operation => :"PlaidApi.beta_partner_customer_v1_get",
|
|
2863
|
+
:header_params => header_params,
|
|
2864
|
+
:query_params => query_params,
|
|
2865
|
+
:form_params => form_params,
|
|
2866
|
+
:body => post_body,
|
|
2867
|
+
:auth_names => auth_names,
|
|
2868
|
+
:return_type => return_type
|
|
2869
|
+
)
|
|
2870
|
+
|
|
2871
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
|
2872
|
+
if @api_client.config.debugging
|
|
2873
|
+
@api_client.config.logger.debug "API called: PlaidApi#beta_partner_customer_v1_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
2874
|
+
end
|
|
2875
|
+
return data, status_code, headers
|
|
2876
|
+
end
|
|
2877
|
+
|
|
2878
|
+
# Updates an existing end customer.
|
|
2879
|
+
# The `/beta/partner/customer/v1/update` endpoint updates an existing end customer record.
|
|
2880
|
+
# @param request_body [Hash<String, Object>]
|
|
2881
|
+
# @param [Hash] opts the optional parameters
|
|
2882
|
+
# @return [BetaPartnerCustomerV1UpdateResponse]
|
|
2883
|
+
def beta_partner_customer_v1_update(request_body, opts = {})
|
|
2884
|
+
data, _status_code, _headers = beta_partner_customer_v1_update_with_http_info(request_body, opts)
|
|
2885
|
+
data
|
|
2886
|
+
end
|
|
2887
|
+
|
|
2888
|
+
# Updates an existing end customer.
|
|
2889
|
+
# The `/beta/partner/customer/v1/update` endpoint updates an existing end customer record.
|
|
2890
|
+
# @param request_body [Hash<String, Object>]
|
|
2891
|
+
# @param [Hash] opts the optional parameters
|
|
2892
|
+
# @return [Array<(BetaPartnerCustomerV1UpdateResponse, Integer, Hash)>] BetaPartnerCustomerV1UpdateResponse data, response status code and response headers
|
|
2893
|
+
def beta_partner_customer_v1_update_with_http_info(request_body, opts = {})
|
|
2894
|
+
if @api_client.config.debugging
|
|
2895
|
+
@api_client.config.logger.debug 'Calling API: PlaidApi.beta_partner_customer_v1_update ...'
|
|
2896
|
+
end
|
|
2897
|
+
# verify the required parameter 'request_body' is set
|
|
2898
|
+
if @api_client.config.client_side_validation && request_body.nil?
|
|
2899
|
+
fail ArgumentError, "Missing the required parameter 'request_body' when calling PlaidApi.beta_partner_customer_v1_update"
|
|
2900
|
+
end
|
|
2901
|
+
# resource path
|
|
2902
|
+
local_var_path = '/beta/partner/customer/v1/update'
|
|
2903
|
+
|
|
2904
|
+
# query parameters
|
|
2905
|
+
query_params = opts[:query_params] || {}
|
|
2906
|
+
|
|
2907
|
+
# header parameters
|
|
2908
|
+
header_params = opts[:header_params] || {}
|
|
2909
|
+
# HTTP header 'Accept' (if needed)
|
|
2910
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
2911
|
+
# HTTP header 'Content-Type'
|
|
2912
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
|
2913
|
+
if !content_type.nil?
|
|
2914
|
+
header_params['Content-Type'] = content_type
|
|
2915
|
+
end
|
|
2916
|
+
|
|
2917
|
+
# form parameters
|
|
2918
|
+
form_params = opts[:form_params] || {}
|
|
2919
|
+
|
|
2920
|
+
# http body (model)
|
|
2921
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(request_body)
|
|
2922
|
+
|
|
2923
|
+
# return_type
|
|
2924
|
+
return_type = opts[:debug_return_type] || 'BetaPartnerCustomerV1UpdateResponse'
|
|
2925
|
+
|
|
2926
|
+
# auth_names
|
|
2927
|
+
auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
|
|
2928
|
+
|
|
2929
|
+
new_options = opts.merge(
|
|
2930
|
+
:operation => :"PlaidApi.beta_partner_customer_v1_update",
|
|
2931
|
+
:header_params => header_params,
|
|
2932
|
+
:query_params => query_params,
|
|
2933
|
+
:form_params => form_params,
|
|
2934
|
+
:body => post_body,
|
|
2935
|
+
:auth_names => auth_names,
|
|
2936
|
+
:return_type => return_type
|
|
2937
|
+
)
|
|
2938
|
+
|
|
2939
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
|
2940
|
+
if @api_client.config.debugging
|
|
2941
|
+
@api_client.config.logger.debug "API called: PlaidApi#beta_partner_customer_v1_update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
2942
|
+
end
|
|
2943
|
+
return data, status_code, headers
|
|
2944
|
+
end
|
|
2945
|
+
|
|
2946
|
+
# Create a business verification
|
|
2947
|
+
# Create a new business verification to check a business's identity and risk profile.
|
|
2948
|
+
# @param business_verification_create_request [BusinessVerificationCreateRequest]
|
|
2949
|
+
# @param [Hash] opts the optional parameters
|
|
2950
|
+
# @return [BusinessVerificationCreateResponse]
|
|
2951
|
+
def business_verification_create(business_verification_create_request, opts = {})
|
|
2952
|
+
data, _status_code, _headers = business_verification_create_with_http_info(business_verification_create_request, opts)
|
|
2953
|
+
data
|
|
2954
|
+
end
|
|
2955
|
+
|
|
2956
|
+
# Create a business verification
|
|
2957
|
+
# Create a new business verification to check a business's identity and risk profile.
|
|
2958
|
+
# @param business_verification_create_request [BusinessVerificationCreateRequest]
|
|
2959
|
+
# @param [Hash] opts the optional parameters
|
|
2960
|
+
# @return [Array<(BusinessVerificationCreateResponse, Integer, Hash)>] BusinessVerificationCreateResponse data, response status code and response headers
|
|
2961
|
+
def business_verification_create_with_http_info(business_verification_create_request, opts = {})
|
|
2962
|
+
if @api_client.config.debugging
|
|
2963
|
+
@api_client.config.logger.debug 'Calling API: PlaidApi.business_verification_create ...'
|
|
2964
|
+
end
|
|
2965
|
+
# verify the required parameter 'business_verification_create_request' is set
|
|
2966
|
+
if @api_client.config.client_side_validation && business_verification_create_request.nil?
|
|
2967
|
+
fail ArgumentError, "Missing the required parameter 'business_verification_create_request' when calling PlaidApi.business_verification_create"
|
|
2968
|
+
end
|
|
2969
|
+
# resource path
|
|
2970
|
+
local_var_path = '/business_verification/create'
|
|
2971
|
+
|
|
2972
|
+
# query parameters
|
|
2973
|
+
query_params = opts[:query_params] || {}
|
|
2974
|
+
|
|
2975
|
+
# header parameters
|
|
2976
|
+
header_params = opts[:header_params] || {}
|
|
2977
|
+
# HTTP header 'Accept' (if needed)
|
|
2978
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
2979
|
+
# HTTP header 'Content-Type'
|
|
2980
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
|
2981
|
+
if !content_type.nil?
|
|
2982
|
+
header_params['Content-Type'] = content_type
|
|
2983
|
+
end
|
|
2984
|
+
|
|
2985
|
+
# form parameters
|
|
2986
|
+
form_params = opts[:form_params] || {}
|
|
2987
|
+
|
|
2988
|
+
# http body (model)
|
|
2989
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(business_verification_create_request)
|
|
2990
|
+
|
|
2991
|
+
# return_type
|
|
2992
|
+
return_type = opts[:debug_return_type] || 'BusinessVerificationCreateResponse'
|
|
2993
|
+
|
|
2994
|
+
# auth_names
|
|
2995
|
+
auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
|
|
2996
|
+
|
|
2997
|
+
new_options = opts.merge(
|
|
2998
|
+
:operation => :"PlaidApi.business_verification_create",
|
|
2999
|
+
:header_params => header_params,
|
|
3000
|
+
:query_params => query_params,
|
|
3001
|
+
:form_params => form_params,
|
|
3002
|
+
:body => post_body,
|
|
3003
|
+
:auth_names => auth_names,
|
|
3004
|
+
:return_type => return_type
|
|
3005
|
+
)
|
|
3006
|
+
|
|
3007
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
|
3008
|
+
if @api_client.config.debugging
|
|
3009
|
+
@api_client.config.logger.debug "API called: PlaidApi#business_verification_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
3010
|
+
end
|
|
3011
|
+
return data, status_code, headers
|
|
3012
|
+
end
|
|
3013
|
+
|
|
3014
|
+
# Get a business verification
|
|
3015
|
+
# Retrieve the current state of a specific business verification.
|
|
3016
|
+
# @param business_verification_get_request [BusinessVerificationGetRequest]
|
|
3017
|
+
# @param [Hash] opts the optional parameters
|
|
3018
|
+
# @return [BusinessVerificationGetResponse]
|
|
3019
|
+
def business_verification_get(business_verification_get_request, opts = {})
|
|
3020
|
+
data, _status_code, _headers = business_verification_get_with_http_info(business_verification_get_request, opts)
|
|
3021
|
+
data
|
|
3022
|
+
end
|
|
3023
|
+
|
|
3024
|
+
# Get a business verification
|
|
3025
|
+
# Retrieve the current state of a specific business verification.
|
|
3026
|
+
# @param business_verification_get_request [BusinessVerificationGetRequest]
|
|
3027
|
+
# @param [Hash] opts the optional parameters
|
|
3028
|
+
# @return [Array<(BusinessVerificationGetResponse, Integer, Hash)>] BusinessVerificationGetResponse data, response status code and response headers
|
|
3029
|
+
def business_verification_get_with_http_info(business_verification_get_request, opts = {})
|
|
3030
|
+
if @api_client.config.debugging
|
|
3031
|
+
@api_client.config.logger.debug 'Calling API: PlaidApi.business_verification_get ...'
|
|
3032
|
+
end
|
|
3033
|
+
# verify the required parameter 'business_verification_get_request' is set
|
|
3034
|
+
if @api_client.config.client_side_validation && business_verification_get_request.nil?
|
|
3035
|
+
fail ArgumentError, "Missing the required parameter 'business_verification_get_request' when calling PlaidApi.business_verification_get"
|
|
3036
|
+
end
|
|
3037
|
+
# resource path
|
|
3038
|
+
local_var_path = '/business_verification/get'
|
|
3039
|
+
|
|
3040
|
+
# query parameters
|
|
3041
|
+
query_params = opts[:query_params] || {}
|
|
3042
|
+
|
|
3043
|
+
# header parameters
|
|
3044
|
+
header_params = opts[:header_params] || {}
|
|
3045
|
+
# HTTP header 'Accept' (if needed)
|
|
3046
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
3047
|
+
# HTTP header 'Content-Type'
|
|
3048
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
|
3049
|
+
if !content_type.nil?
|
|
3050
|
+
header_params['Content-Type'] = content_type
|
|
3051
|
+
end
|
|
3052
|
+
|
|
3053
|
+
# form parameters
|
|
3054
|
+
form_params = opts[:form_params] || {}
|
|
3055
|
+
|
|
3056
|
+
# http body (model)
|
|
3057
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(business_verification_get_request)
|
|
3058
|
+
|
|
3059
|
+
# return_type
|
|
3060
|
+
return_type = opts[:debug_return_type] || 'BusinessVerificationGetResponse'
|
|
3061
|
+
|
|
3062
|
+
# auth_names
|
|
3063
|
+
auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
|
|
3064
|
+
|
|
3065
|
+
new_options = opts.merge(
|
|
3066
|
+
:operation => :"PlaidApi.business_verification_get",
|
|
3067
|
+
:header_params => header_params,
|
|
3068
|
+
:query_params => query_params,
|
|
3069
|
+
:form_params => form_params,
|
|
3070
|
+
:body => post_body,
|
|
3071
|
+
:auth_names => auth_names,
|
|
3072
|
+
:return_type => return_type
|
|
3073
|
+
)
|
|
3074
|
+
|
|
3075
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
|
3076
|
+
if @api_client.config.debugging
|
|
3077
|
+
@api_client.config.logger.debug "API called: PlaidApi#business_verification_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
3078
|
+
end
|
|
3079
|
+
return data, status_code, headers
|
|
3080
|
+
end
|
|
3081
|
+
|
|
2538
3082
|
# Gets transaction data in `cashflow_report`
|
|
2539
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.
|
|
2540
3084
|
# @param cashflow_report_get_request [CashflowReportGetRequest]
|
|
@@ -2808,7 +3352,7 @@ module Plaid
|
|
|
2808
3352
|
end
|
|
2809
3353
|
|
|
2810
3354
|
# (Deprecated) Get legacy categories
|
|
2811
|
-
# Send a request to the `/categories/get` endpoint to get detailed information on legacy categories returned by Plaid. This endpoint does not require authentication. All implementations are recommended to [use the newer `personal_finance_category` taxonomy](https://plaid.com/docs/transactions/pfc-migration/) instead of the legacy `category` taxonomy supported by this endpoint.
|
|
3355
|
+
# Send a request to the `/categories/get` endpoint to get detailed information on legacy categories returned by Plaid. This endpoint does not require authentication. All implementations are recommended to [use the newer `personal_finance_category` taxonomy](https://plaid.com/docs/transactions/pfc-migration/) instead of the legacy `category` taxonomy supported by this endpoint.
|
|
2812
3356
|
# @param body [Object]
|
|
2813
3357
|
# @param [Hash] opts the optional parameters
|
|
2814
3358
|
# @return [CategoriesGetResponse]
|
|
@@ -2818,7 +3362,7 @@ module Plaid
|
|
|
2818
3362
|
end
|
|
2819
3363
|
|
|
2820
3364
|
# (Deprecated) Get legacy categories
|
|
2821
|
-
# Send a request to the `/categories/get` endpoint to get detailed information on legacy categories returned by Plaid. This endpoint does not require authentication. All implementations are recommended to [use the newer `personal_finance_category` taxonomy](https://plaid.com/docs/transactions/pfc-migration/) instead of the legacy `category` taxonomy supported by this endpoint.
|
|
3365
|
+
# Send a request to the `/categories/get` endpoint to get detailed information on legacy categories returned by Plaid. This endpoint does not require authentication. All implementations are recommended to [use the newer `personal_finance_category` taxonomy](https://plaid.com/docs/transactions/pfc-migration/) instead of the legacy `category` taxonomy supported by this endpoint.
|
|
2822
3366
|
# @param body [Object]
|
|
2823
3367
|
# @param [Hash] opts the optional parameters
|
|
2824
3368
|
# @return [Array<(CategoriesGetResponse, Integer, Hash)>] CategoriesGetResponse data, response status code and response headers
|
|
@@ -2975,7 +3519,7 @@ module Plaid
|
|
|
2975
3519
|
# header parameters
|
|
2976
3520
|
header_params = opts[:header_params] || {}
|
|
2977
3521
|
# HTTP header 'Accept' (if needed)
|
|
2978
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/pdf'])
|
|
3522
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/pdf', 'application/json'])
|
|
2979
3523
|
# HTTP header 'Content-Type'
|
|
2980
3524
|
content_type = @api_client.select_header_content_type(['application/json'])
|
|
2981
3525
|
if !content_type.nil?
|
|
@@ -3012,7 +3556,7 @@ module Plaid
|
|
|
3012
3556
|
end
|
|
3013
3557
|
|
|
3014
3558
|
# Retrieve a Base Report
|
|
3015
|
-
# This endpoint allows you to retrieve the Base Report for your user, allowing you to receive comprehensive bank account and cash flow data. You should call this endpoint after you've received a `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`.
|
|
3559
|
+
# This endpoint allows you to retrieve the Base Report for your user, allowing you to receive comprehensive bank account and cash flow data. 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`.
|
|
3016
3560
|
# @param cra_check_report_base_report_get_request [CraCheckReportBaseReportGetRequest]
|
|
3017
3561
|
# @param [Hash] opts the optional parameters
|
|
3018
3562
|
# @return [CraCheckReportBaseReportGetResponse]
|
|
@@ -3022,7 +3566,7 @@ module Plaid
|
|
|
3022
3566
|
end
|
|
3023
3567
|
|
|
3024
3568
|
# Retrieve a Base Report
|
|
3025
|
-
# This endpoint allows you to retrieve the Base Report for your user, allowing you to receive comprehensive bank account and cash flow data. You should call this endpoint after you've received a `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`.
|
|
3569
|
+
# This endpoint allows you to retrieve the Base Report for your user, allowing you to receive comprehensive bank account and cash flow data. 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`.
|
|
3026
3570
|
# @param cra_check_report_base_report_get_request [CraCheckReportBaseReportGetRequest]
|
|
3027
3571
|
# @param [Hash] opts the optional parameters
|
|
3028
3572
|
# @return [Array<(CraCheckReportBaseReportGetResponse, Integer, Hash)>] CraCheckReportBaseReportGetResponse data, response status code and response headers
|
|
@@ -3080,7 +3624,7 @@ module Plaid
|
|
|
3080
3624
|
end
|
|
3081
3625
|
|
|
3082
3626
|
# Retrieve cash flow insights from your user's banking data
|
|
3083
|
-
# This endpoint allows you to retrieve the Cashflow Insights report for your user. You should call this endpoint after you've received
|
|
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.
|
|
3084
3628
|
# @param cra_check_report_cashflow_insights_get_request [CraCheckReportCashflowInsightsGetRequest]
|
|
3085
3629
|
# @param [Hash] opts the optional parameters
|
|
3086
3630
|
# @return [CraCheckReportCashflowInsightsGetResponse]
|
|
@@ -3090,7 +3634,7 @@ module Plaid
|
|
|
3090
3634
|
end
|
|
3091
3635
|
|
|
3092
3636
|
# Retrieve cash flow insights from your user's banking data
|
|
3093
|
-
# This endpoint allows you to retrieve the Cashflow Insights report for your user. You should call this endpoint after you've received
|
|
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.
|
|
3094
3638
|
# @param cra_check_report_cashflow_insights_get_request [CraCheckReportCashflowInsightsGetRequest]
|
|
3095
3639
|
# @param [Hash] opts the optional parameters
|
|
3096
3640
|
# @return [Array<(CraCheckReportCashflowInsightsGetResponse, Integer, Hash)>] CraCheckReportCashflowInsightsGetResponse data, response status code and response headers
|
|
@@ -3147,8 +3691,8 @@ module Plaid
|
|
|
3147
3691
|
return data, status_code, headers
|
|
3148
3692
|
end
|
|
3149
3693
|
|
|
3150
|
-
#
|
|
3151
|
-
# `/cra/check_report/create`
|
|
3694
|
+
# Refresh or create a Consumer Report
|
|
3695
|
+
# The primary purpose of `/cra/check_report/create` is to refresh data in an existing report. A Consumer Report will last for 24 hours before expiring; you should call any `/get` endpoints on the report before it expires. If a report expires, you can call `/cra/check_report/create` again to re-generate it and refresh the data in the report. `/cra/check_report/create` can also be used to create a new report if `consumer_report_permissible_purpose` was omitted during Link token creation. However, using the endpoint in this way is not recommended. Instead, `consumer_report_permissible_purpose` should always be specified when calling `/link/token/create` for Plaid CRA products; this will reduce latency and simplify the integration process. If you provide a `consumer_report_permissible_purpose` during Link token creation, then Plaid Check will automatically begin creating a Consumer Report once the user completes the Link process, and it is not necessary to call `/cra/check_report/create` before retrieving the report.
|
|
3152
3696
|
# @param cra_check_report_create_request [CraCheckReportCreateRequest]
|
|
3153
3697
|
# @param [Hash] opts the optional parameters
|
|
3154
3698
|
# @return [CraCheckReportCreateResponse]
|
|
@@ -3157,8 +3701,8 @@ module Plaid
|
|
|
3157
3701
|
data
|
|
3158
3702
|
end
|
|
3159
3703
|
|
|
3160
|
-
#
|
|
3161
|
-
# `/cra/check_report/create`
|
|
3704
|
+
# Refresh or create a Consumer Report
|
|
3705
|
+
# The primary purpose of `/cra/check_report/create` is to refresh data in an existing report. A Consumer Report will last for 24 hours before expiring; you should call any `/get` endpoints on the report before it expires. If a report expires, you can call `/cra/check_report/create` again to re-generate it and refresh the data in the report. `/cra/check_report/create` can also be used to create a new report if `consumer_report_permissible_purpose` was omitted during Link token creation. However, using the endpoint in this way is not recommended. Instead, `consumer_report_permissible_purpose` should always be specified when calling `/link/token/create` for Plaid CRA products; this will reduce latency and simplify the integration process. If you provide a `consumer_report_permissible_purpose` during Link token creation, then Plaid Check will automatically begin creating a Consumer Report once the user completes the Link process, and it is not necessary to call `/cra/check_report/create` before retrieving the report.
|
|
3162
3706
|
# @param cra_check_report_create_request [CraCheckReportCreateRequest]
|
|
3163
3707
|
# @param [Hash] opts the optional parameters
|
|
3164
3708
|
# @return [Array<(CraCheckReportCreateResponse, Integer, Hash)>] CraCheckReportCreateResponse data, response status code and response headers
|
|
@@ -3216,7 +3760,7 @@ module Plaid
|
|
|
3216
3760
|
end
|
|
3217
3761
|
|
|
3218
3762
|
# Retrieve cash flow information from your user's banks
|
|
3219
|
-
# This endpoint allows you to retrieve the Income Insights report for your user.
|
|
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`.
|
|
3220
3764
|
# @param cra_check_report_income_insights_get_request [CraCheckReportIncomeInsightsGetRequest]
|
|
3221
3765
|
# @param [Hash] opts the optional parameters
|
|
3222
3766
|
# @return [CraCheckReportIncomeInsightsGetResponse]
|
|
@@ -3226,7 +3770,7 @@ module Plaid
|
|
|
3226
3770
|
end
|
|
3227
3771
|
|
|
3228
3772
|
# Retrieve cash flow information from your user's banks
|
|
3229
|
-
# This endpoint allows you to retrieve the Income Insights report for your user.
|
|
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`.
|
|
3230
3774
|
# @param cra_check_report_income_insights_get_request [CraCheckReportIncomeInsightsGetRequest]
|
|
3231
3775
|
# @param [Hash] opts the optional parameters
|
|
3232
3776
|
# @return [Array<(CraCheckReportIncomeInsightsGetResponse, Integer, Hash)>] CraCheckReportIncomeInsightsGetResponse data, response status code and response headers
|
|
@@ -3283,8 +3827,8 @@ module Plaid
|
|
|
3283
3827
|
return data, status_code, headers
|
|
3284
3828
|
end
|
|
3285
3829
|
|
|
3286
|
-
# Retrieve the
|
|
3287
|
-
# This endpoint allows you to retrieve the
|
|
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’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.
|
|
3288
3832
|
# @param cra_check_report_lend_score_get_request [CraCheckReportLendScoreGetRequest]
|
|
3289
3833
|
# @param [Hash] opts the optional parameters
|
|
3290
3834
|
# @return [CraCheckReportLendScoreGetResponse]
|
|
@@ -3293,8 +3837,8 @@ module Plaid
|
|
|
3293
3837
|
data
|
|
3294
3838
|
end
|
|
3295
3839
|
|
|
3296
|
-
# Retrieve the
|
|
3297
|
-
# This endpoint allows you to retrieve the
|
|
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’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.
|
|
3298
3842
|
# @param cra_check_report_lend_score_get_request [CraCheckReportLendScoreGetRequest]
|
|
3299
3843
|
# @param [Hash] opts the optional parameters
|
|
3300
3844
|
# @return [Array<(CraCheckReportLendScoreGetResponse, Integer, Hash)>] CraCheckReportLendScoreGetResponse data, response status code and response headers
|
|
@@ -3352,7 +3896,7 @@ module Plaid
|
|
|
3352
3896
|
end
|
|
3353
3897
|
|
|
3354
3898
|
# Retrieve network attributes for the user
|
|
3355
|
-
# This endpoint allows you to retrieve the Network Insights product for your user. You should call this endpoint after you've received
|
|
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_attributes` product or have generated a report using `/cra/check_report/create`, Plaid will generate the attributes when you call this endpoint.
|
|
3356
3900
|
# @param cra_check_report_network_insights_get_request [CraCheckReportNetworkInsightsGetRequest]
|
|
3357
3901
|
# @param [Hash] opts the optional parameters
|
|
3358
3902
|
# @return [CraCheckReportNetworkInsightsGetResponse]
|
|
@@ -3362,7 +3906,7 @@ module Plaid
|
|
|
3362
3906
|
end
|
|
3363
3907
|
|
|
3364
3908
|
# Retrieve network attributes for the user
|
|
3365
|
-
# This endpoint allows you to retrieve the Network Insights product for your user. You should call this endpoint after you've received
|
|
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_attributes` product or have generated a report using `/cra/check_report/create`, Plaid will generate the attributes when you call this endpoint.
|
|
3366
3910
|
# @param cra_check_report_network_insights_get_request [CraCheckReportNetworkInsightsGetRequest]
|
|
3367
3911
|
# @param [Hash] opts the optional parameters
|
|
3368
3912
|
# @return [Array<(CraCheckReportNetworkInsightsGetResponse, Integer, Hash)>] CraCheckReportNetworkInsightsGetResponse data, response status code and response headers
|
|
@@ -3420,7 +3964,7 @@ module Plaid
|
|
|
3420
3964
|
end
|
|
3421
3965
|
|
|
3422
3966
|
# Retrieve cash flow insights from partners
|
|
3423
|
-
# This endpoint allows you to retrieve the Partner Insights report for your user. You should call this endpoint after you've received
|
|
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.
|
|
3424
3968
|
# @param cra_check_report_partner_insights_get_request [CraCheckReportPartnerInsightsGetRequest]
|
|
3425
3969
|
# @param [Hash] opts the optional parameters
|
|
3426
3970
|
# @return [CraCheckReportPartnerInsightsGetResponse]
|
|
@@ -3430,7 +3974,7 @@ module Plaid
|
|
|
3430
3974
|
end
|
|
3431
3975
|
|
|
3432
3976
|
# Retrieve cash flow insights from partners
|
|
3433
|
-
# This endpoint allows you to retrieve the Partner Insights report for your user. You should call this endpoint after you've received
|
|
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.
|
|
3434
3978
|
# @param cra_check_report_partner_insights_get_request [CraCheckReportPartnerInsightsGetRequest]
|
|
3435
3979
|
# @param [Hash] opts the optional parameters
|
|
3436
3980
|
# @return [Array<(CraCheckReportPartnerInsightsGetResponse, Integer, Hash)>] CraCheckReportPartnerInsightsGetResponse data, response status code and response headers
|
|
@@ -3488,7 +4032,7 @@ module Plaid
|
|
|
3488
4032
|
end
|
|
3489
4033
|
|
|
3490
4034
|
# Retrieve Consumer Reports as a PDF
|
|
3491
|
-
# `/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 Income Insights report be included in the PDF as well, use the `add-ons` field.
|
|
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.
|
|
3492
4036
|
# @param cra_check_report_pdf_get_request [CraCheckReportPDFGetRequest]
|
|
3493
4037
|
# @param [Hash] opts the optional parameters
|
|
3494
4038
|
# @return [File]
|
|
@@ -3498,7 +4042,7 @@ module Plaid
|
|
|
3498
4042
|
end
|
|
3499
4043
|
|
|
3500
4044
|
# Retrieve Consumer Reports as a PDF
|
|
3501
|
-
# `/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 Income Insights report be included in the PDF as well, use the `add-ons` field.
|
|
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.
|
|
3502
4046
|
# @param cra_check_report_pdf_get_request [CraCheckReportPDFGetRequest]
|
|
3503
4047
|
# @param [Hash] opts the optional parameters
|
|
3504
4048
|
# @return [Array<(File, Integer, Hash)>] File data, response status code and response headers
|
|
@@ -3519,7 +4063,7 @@ module Plaid
|
|
|
3519
4063
|
# header parameters
|
|
3520
4064
|
header_params = opts[:header_params] || {}
|
|
3521
4065
|
# HTTP header 'Accept' (if needed)
|
|
3522
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/pdf'])
|
|
4066
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/pdf', 'application/json'])
|
|
3523
4067
|
# HTTP header 'Content-Type'
|
|
3524
4068
|
content_type = @api_client.select_header_content_type(['application/json'])
|
|
3525
4069
|
if !content_type.nil?
|
|
@@ -3556,7 +4100,7 @@ module Plaid
|
|
|
3556
4100
|
end
|
|
3557
4101
|
|
|
3558
4102
|
# Retrieve various verification reports for a user.
|
|
3559
|
-
# This endpoint allows you to retrieve verification 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` 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`.\"
|
|
4103
|
+
# This endpoint allows you to retrieve verification 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`.\"
|
|
3560
4104
|
# @param cra_check_report_verification_get_request [CraCheckReportVerificationGetRequest]
|
|
3561
4105
|
# @param [Hash] opts the optional parameters
|
|
3562
4106
|
# @return [CraCheckReportVerificationGetResponse]
|
|
@@ -3566,7 +4110,7 @@ module Plaid
|
|
|
3566
4110
|
end
|
|
3567
4111
|
|
|
3568
4112
|
# Retrieve various verification reports for a user.
|
|
3569
|
-
# This endpoint allows you to retrieve verification 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` 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`.\"
|
|
4113
|
+
# This endpoint allows you to retrieve verification 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`.\"
|
|
3570
4114
|
# @param cra_check_report_verification_get_request [CraCheckReportVerificationGetRequest]
|
|
3571
4115
|
# @param [Hash] opts the optional parameters
|
|
3572
4116
|
# @return [Array<(CraCheckReportVerificationGetResponse, Integer, Hash)>] CraCheckReportVerificationGetResponse data, response status code and response headers
|
|
@@ -3623,6 +4167,74 @@ module Plaid
|
|
|
3623
4167
|
return data, status_code, headers
|
|
3624
4168
|
end
|
|
3625
4169
|
|
|
4170
|
+
# Retrieve Consumer Reports as a Verification PDF
|
|
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
|
+
# @param cra_check_report_verification_pdf_get_request [CraCheckReportVerificationPdfGetRequest]
|
|
4173
|
+
# @param [Hash] opts the optional parameters
|
|
4174
|
+
# @return [File]
|
|
4175
|
+
def cra_check_report_verification_pdf_get(cra_check_report_verification_pdf_get_request, opts = {})
|
|
4176
|
+
data, _status_code, _headers = cra_check_report_verification_pdf_get_with_http_info(cra_check_report_verification_pdf_get_request, opts)
|
|
4177
|
+
data
|
|
4178
|
+
end
|
|
4179
|
+
|
|
4180
|
+
# Retrieve Consumer Reports as a Verification PDF
|
|
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
|
+
# @param cra_check_report_verification_pdf_get_request [CraCheckReportVerificationPdfGetRequest]
|
|
4183
|
+
# @param [Hash] opts the optional parameters
|
|
4184
|
+
# @return [Array<(File, Integer, Hash)>] File data, response status code and response headers
|
|
4185
|
+
def cra_check_report_verification_pdf_get_with_http_info(cra_check_report_verification_pdf_get_request, opts = {})
|
|
4186
|
+
if @api_client.config.debugging
|
|
4187
|
+
@api_client.config.logger.debug 'Calling API: PlaidApi.cra_check_report_verification_pdf_get ...'
|
|
4188
|
+
end
|
|
4189
|
+
# verify the required parameter 'cra_check_report_verification_pdf_get_request' is set
|
|
4190
|
+
if @api_client.config.client_side_validation && cra_check_report_verification_pdf_get_request.nil?
|
|
4191
|
+
fail ArgumentError, "Missing the required parameter 'cra_check_report_verification_pdf_get_request' when calling PlaidApi.cra_check_report_verification_pdf_get"
|
|
4192
|
+
end
|
|
4193
|
+
# resource path
|
|
4194
|
+
local_var_path = '/cra/check_report/verification/pdf/get'
|
|
4195
|
+
|
|
4196
|
+
# query parameters
|
|
4197
|
+
query_params = opts[:query_params] || {}
|
|
4198
|
+
|
|
4199
|
+
# header parameters
|
|
4200
|
+
header_params = opts[:header_params] || {}
|
|
4201
|
+
# HTTP header 'Accept' (if needed)
|
|
4202
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/pdf', 'application/json'])
|
|
4203
|
+
# HTTP header 'Content-Type'
|
|
4204
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
|
4205
|
+
if !content_type.nil?
|
|
4206
|
+
header_params['Content-Type'] = content_type
|
|
4207
|
+
end
|
|
4208
|
+
|
|
4209
|
+
# form parameters
|
|
4210
|
+
form_params = opts[:form_params] || {}
|
|
4211
|
+
|
|
4212
|
+
# http body (model)
|
|
4213
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(cra_check_report_verification_pdf_get_request)
|
|
4214
|
+
|
|
4215
|
+
# return_type
|
|
4216
|
+
return_type = opts[:debug_return_type] || 'File'
|
|
4217
|
+
|
|
4218
|
+
# auth_names
|
|
4219
|
+
auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
|
|
4220
|
+
|
|
4221
|
+
new_options = opts.merge(
|
|
4222
|
+
:operation => :"PlaidApi.cra_check_report_verification_pdf_get",
|
|
4223
|
+
:header_params => header_params,
|
|
4224
|
+
:query_params => query_params,
|
|
4225
|
+
:form_params => form_params,
|
|
4226
|
+
:body => post_body,
|
|
4227
|
+
:auth_names => auth_names,
|
|
4228
|
+
:return_type => return_type
|
|
4229
|
+
)
|
|
4230
|
+
|
|
4231
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
|
4232
|
+
if @api_client.config.debugging
|
|
4233
|
+
@api_client.config.logger.debug "API called: PlaidApi#cra_check_report_verification_pdf_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
4234
|
+
end
|
|
4235
|
+
return data, status_code, headers
|
|
4236
|
+
end
|
|
4237
|
+
|
|
3626
4238
|
# Register loan applications and decisions.
|
|
3627
4239
|
# `/cra/loans/applications/register` registers loan applications and decisions.
|
|
3628
4240
|
# @param cra_loans_applications_register_request [CraLoansApplicationsRegisterRequest]
|
|
@@ -3896,7 +4508,7 @@ module Plaid
|
|
|
3896
4508
|
end
|
|
3897
4509
|
|
|
3898
4510
|
# Retrieve a Monitoring Insights Report
|
|
3899
|
-
# This endpoint allows you to retrieve a Cash Flow Updates report by passing in the `
|
|
4511
|
+
# This endpoint allows you to retrieve a Cash Flow Updates report by passing in the `user_id` referred to in the webhook you received.
|
|
3900
4512
|
# @param cra_monitoring_insights_get_request [CraMonitoringInsightsGetRequest]
|
|
3901
4513
|
# @param [Hash] opts the optional parameters
|
|
3902
4514
|
# @return [CraMonitoringInsightsGetResponse]
|
|
@@ -3906,7 +4518,7 @@ module Plaid
|
|
|
3906
4518
|
end
|
|
3907
4519
|
|
|
3908
4520
|
# Retrieve a Monitoring Insights Report
|
|
3909
|
-
# This endpoint allows you to retrieve a Cash Flow Updates report by passing in the `
|
|
4521
|
+
# This endpoint allows you to retrieve a Cash Flow Updates report by passing in the `user_id` referred to in the webhook you received.
|
|
3910
4522
|
# @param cra_monitoring_insights_get_request [CraMonitoringInsightsGetRequest]
|
|
3911
4523
|
# @param [Hash] opts the optional parameters
|
|
3912
4524
|
# @return [Array<(CraMonitoringInsightsGetResponse, Integer, Hash)>] CraMonitoringInsightsGetResponse data, response status code and response headers
|
|
@@ -4607,7 +5219,7 @@ module Plaid
|
|
|
4607
5219
|
# header parameters
|
|
4608
5220
|
header_params = opts[:header_params] || {}
|
|
4609
5221
|
# HTTP header 'Accept' (if needed)
|
|
4610
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/pdf'])
|
|
5222
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/pdf', 'application/json'])
|
|
4611
5223
|
# HTTP header 'Content-Type'
|
|
4612
5224
|
content_type = @api_client.select_header_content_type(['application/json'])
|
|
4613
5225
|
if !content_type.nil?
|
|
@@ -5491,7 +6103,7 @@ module Plaid
|
|
|
5491
6103
|
# header parameters
|
|
5492
6104
|
header_params = opts[:header_params] || {}
|
|
5493
6105
|
# HTTP header 'Accept' (if needed)
|
|
5494
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/pdf'])
|
|
6106
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/pdf', 'application/json'])
|
|
5495
6107
|
# HTTP header 'Content-Type'
|
|
5496
6108
|
content_type = @api_client.select_header_content_type(['application/json'])
|
|
5497
6109
|
if !content_type.nil?
|
|
@@ -6399,7 +7011,7 @@ module Plaid
|
|
|
6399
7011
|
end
|
|
6400
7012
|
|
|
6401
7013
|
# Retrieve identity match score
|
|
6402
|
-
# The `/identity/match` endpoint generates a match score, which indicates how well the provided identity data matches the identity information on file with the account holder's financial institution. Fields within the `balances` object will always be null when retrieved by `/identity/match`. Instead, use the free `/accounts/get` endpoint to request balance cached data, or `/accounts/balance/get` for real-time data.
|
|
7014
|
+
# The `/identity/match` endpoint generates a match score, which indicates how well the provided identity data matches the identity information on file with the account holder's financial institution. Fields within the `balances` object will always be null when retrieved by `/identity/match`. Instead, use the free `/accounts/get` endpoint to request balance cached data, or `/accounts/balance/get` or `/signal/evaluate` for real-time data.
|
|
6403
7015
|
# @param identity_match_request [IdentityMatchRequest]
|
|
6404
7016
|
# @param [Hash] opts the optional parameters
|
|
6405
7017
|
# @return [IdentityMatchResponse]
|
|
@@ -6409,7 +7021,7 @@ module Plaid
|
|
|
6409
7021
|
end
|
|
6410
7022
|
|
|
6411
7023
|
# Retrieve identity match score
|
|
6412
|
-
# The `/identity/match` endpoint generates a match score, which indicates how well the provided identity data matches the identity information on file with the account holder's financial institution. Fields within the `balances` object will always be null when retrieved by `/identity/match`. Instead, use the free `/accounts/get` endpoint to request balance cached data, or `/accounts/balance/get` for real-time data.
|
|
7024
|
+
# The `/identity/match` endpoint generates a match score, which indicates how well the provided identity data matches the identity information on file with the account holder's financial institution. Fields within the `balances` object will always be null when retrieved by `/identity/match`. Instead, use the free `/accounts/get` endpoint to request balance cached data, or `/accounts/balance/get` or `/signal/evaluate` for real-time data.
|
|
6413
7025
|
# @param identity_match_request [IdentityMatchRequest]
|
|
6414
7026
|
# @param [Hash] opts the optional parameters
|
|
6415
7027
|
# @return [Array<(IdentityMatchResponse, Integer, Hash)>] IdentityMatchResponse data, response status code and response headers
|
|
@@ -6974,7 +7586,7 @@ module Plaid
|
|
|
6974
7586
|
# header parameters
|
|
6975
7587
|
header_params = opts[:header_params] || {}
|
|
6976
7588
|
# HTTP header 'Accept' (if needed)
|
|
6977
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/zip'])
|
|
7589
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/zip', 'application/json'])
|
|
6978
7590
|
# HTTP header 'Content-Type'
|
|
6979
7591
|
content_type = @api_client.select_header_content_type(['application/json'])
|
|
6980
7592
|
if !content_type.nil?
|
|
@@ -8983,7 +9595,7 @@ module Plaid
|
|
|
8983
9595
|
end
|
|
8984
9596
|
|
|
8985
9597
|
# Get Link Token
|
|
8986
|
-
# The `/link/token/get` endpoint gets information about a Link session, including all callbacks fired during the session along with their metadata, including the public token. This endpoint is used with Link flows that don't provide a public token via frontend callbacks, such as the [Hosted Link flow](https://plaid.com/docs/link/hosted-link/) and the [Multi-Item Link flow](https://plaid.com/docs/link/multi-item-link/). It also can be useful for debugging purposes. By default, this endpoint will only return complete event data for Hosted Link sessions. To use `/link/token/get` to retrieve event data for non-Hosted-Link sessions, contact your account manager to request that your account be enabled for Link events. If you do not have an account manager, you can submit this request via a support ticket. Enablement for Link events will also cause you to receive additional webhooks related to Link events, such as the `SESSION_FINISHED` and `EVENTS` webhook.
|
|
9598
|
+
# The `/link/token/get` endpoint gets information about a Link session, including all callbacks fired during the session along with their metadata, including the public token. This endpoint is used with Link flows that don't provide a public token via frontend callbacks, such as the [Hosted Link flow](https://plaid.com/docs/link/hosted-link/) and the [Multi-Item Link flow](https://plaid.com/docs/link/multi-item-link/). It also can be useful for debugging purposes. By default, this endpoint will only return complete event data for Hosted Link sessions. To use `/link/token/get` to retrieve event data for non-Hosted-Link sessions, contact your account manager to request that your account be enabled for Link events. If you do not have an account manager, you can submit this request via a support ticket. Enablement for Link events will also cause you to receive additional webhooks related to Link events, such as the `SESSION_FINISHED` and `EVENTS` webhook.
|
|
8987
9599
|
# @param link_token_get_request [LinkTokenGetRequest]
|
|
8988
9600
|
# @param [Hash] opts the optional parameters
|
|
8989
9601
|
# @return [LinkTokenGetResponse]
|
|
@@ -8993,7 +9605,7 @@ module Plaid
|
|
|
8993
9605
|
end
|
|
8994
9606
|
|
|
8995
9607
|
# Get Link Token
|
|
8996
|
-
# The `/link/token/get` endpoint gets information about a Link session, including all callbacks fired during the session along with their metadata, including the public token. This endpoint is used with Link flows that don't provide a public token via frontend callbacks, such as the [Hosted Link flow](https://plaid.com/docs/link/hosted-link/) and the [Multi-Item Link flow](https://plaid.com/docs/link/multi-item-link/). It also can be useful for debugging purposes. By default, this endpoint will only return complete event data for Hosted Link sessions. To use `/link/token/get` to retrieve event data for non-Hosted-Link sessions, contact your account manager to request that your account be enabled for Link events. If you do not have an account manager, you can submit this request via a support ticket. Enablement for Link events will also cause you to receive additional webhooks related to Link events, such as the `SESSION_FINISHED` and `EVENTS` webhook.
|
|
9608
|
+
# The `/link/token/get` endpoint gets information about a Link session, including all callbacks fired during the session along with their metadata, including the public token. This endpoint is used with Link flows that don't provide a public token via frontend callbacks, such as the [Hosted Link flow](https://plaid.com/docs/link/hosted-link/) and the [Multi-Item Link flow](https://plaid.com/docs/link/multi-item-link/). It also can be useful for debugging purposes. By default, this endpoint will only return complete event data for Hosted Link sessions. To use `/link/token/get` to retrieve event data for non-Hosted-Link sessions, contact your account manager to request that your account be enabled for Link events. If you do not have an account manager, you can submit this request via a support ticket. Enablement for Link events will also cause you to receive additional webhooks related to Link events, such as the `SESSION_FINISHED` and `EVENTS` webhook.
|
|
8997
9609
|
# @param link_token_get_request [LinkTokenGetRequest]
|
|
8998
9610
|
# @param [Hash] opts the optional parameters
|
|
8999
9611
|
# @return [Array<(LinkTokenGetResponse, Integer, Hash)>] LinkTokenGetResponse data, response status code and response headers
|
|
@@ -11363,7 +11975,7 @@ module Plaid
|
|
|
11363
11975
|
end
|
|
11364
11976
|
|
|
11365
11977
|
# Report whether you initiated an ACH transaction
|
|
11366
|
-
# After
|
|
11978
|
+
# After you call `/processor/signal/evaluate`, Plaid will normally infer the outcome from your Signal Rules. However, if you are not using Signal Rules, if the Signal Rules outcome was `REVIEW`, or if you take a different action than the one determined by the Signal Rules, you will need to call `/processor/signal/decision/report`. This helps improve Signal Transaction Score accuracy for your account and is necessary for proper functioning of the rule performance and rule tuning capabilities in the Dashboard. If your effective decision changes after calling `/processor/signal/decision/report` (for example, you indicated that you accepted a transaction, but later on, your payment processor rejected it, so it was never initiated), call `/processor/signal/decision/report` again for the transaction to correct Plaid's records. If you are using Plaid Transfer as your payment processor, you also do not need to call `/processor/signal/decision/report`, as Plaid can infer outcomes from your Transfer activity. If using a Balance-only ruleset, this endpoint will not impact scores (Balance does not use scores), but is necessary to view accurate transaction outcomes and tune rule logic in the Dashboard.
|
|
11367
11979
|
# @param processor_signal_decision_report_request [ProcessorSignalDecisionReportRequest]
|
|
11368
11980
|
# @param [Hash] opts the optional parameters
|
|
11369
11981
|
# @return [ProcessorSignalDecisionReportResponse]
|
|
@@ -11373,7 +11985,7 @@ module Plaid
|
|
|
11373
11985
|
end
|
|
11374
11986
|
|
|
11375
11987
|
# Report whether you initiated an ACH transaction
|
|
11376
|
-
# After
|
|
11988
|
+
# After you call `/processor/signal/evaluate`, Plaid will normally infer the outcome from your Signal Rules. However, if you are not using Signal Rules, if the Signal Rules outcome was `REVIEW`, or if you take a different action than the one determined by the Signal Rules, you will need to call `/processor/signal/decision/report`. This helps improve Signal Transaction Score accuracy for your account and is necessary for proper functioning of the rule performance and rule tuning capabilities in the Dashboard. If your effective decision changes after calling `/processor/signal/decision/report` (for example, you indicated that you accepted a transaction, but later on, your payment processor rejected it, so it was never initiated), call `/processor/signal/decision/report` again for the transaction to correct Plaid's records. If you are using Plaid Transfer as your payment processor, you also do not need to call `/processor/signal/decision/report`, as Plaid can infer outcomes from your Transfer activity. If using a Balance-only ruleset, this endpoint will not impact scores (Balance does not use scores), but is necessary to view accurate transaction outcomes and tune rule logic in the Dashboard.
|
|
11377
11989
|
# @param processor_signal_decision_report_request [ProcessorSignalDecisionReportRequest]
|
|
11378
11990
|
# @param [Hash] opts the optional parameters
|
|
11379
11991
|
# @return [Array<(ProcessorSignalDecisionReportResponse, Integer, Hash)>] ProcessorSignalDecisionReportResponse data, response status code and response headers
|
|
@@ -11431,7 +12043,7 @@ module Plaid
|
|
|
11431
12043
|
end
|
|
11432
12044
|
|
|
11433
12045
|
# Evaluate a planned ACH transaction
|
|
11434
|
-
# Use `/
|
|
12046
|
+
# Use `/signal/evaluate` to evaluate a planned ACH transaction to get a return risk assessment and additional risk signals. `/signal/evaluate` is used with Rulesets that are configured on the end customer Dashboard can can be used with either the Signal Transaction Scores product or the Balance product. Which product is used will be determined by the `ruleset_key` that you provide. For more details, see [Signal Rules](https://plaid.com/docs/signal/signal-rules/). Note: This request may have higher latency if Signal Transaction Scores is being added to an existing Item for the first time, or when using a Balance-only ruleset. This is because Plaid must communicate directly with the institution to request data.
|
|
11435
12047
|
# @param processor_signal_evaluate_request [ProcessorSignalEvaluateRequest]
|
|
11436
12048
|
# @param [Hash] opts the optional parameters
|
|
11437
12049
|
# @return [ProcessorSignalEvaluateResponse]
|
|
@@ -11441,7 +12053,7 @@ module Plaid
|
|
|
11441
12053
|
end
|
|
11442
12054
|
|
|
11443
12055
|
# Evaluate a planned ACH transaction
|
|
11444
|
-
# Use `/
|
|
12056
|
+
# Use `/signal/evaluate` to evaluate a planned ACH transaction to get a return risk assessment and additional risk signals. `/signal/evaluate` is used with Rulesets that are configured on the end customer Dashboard can can be used with either the Signal Transaction Scores product or the Balance product. Which product is used will be determined by the `ruleset_key` that you provide. For more details, see [Signal Rules](https://plaid.com/docs/signal/signal-rules/). Note: This request may have higher latency if Signal Transaction Scores is being added to an existing Item for the first time, or when using a Balance-only ruleset. This is because Plaid must communicate directly with the institution to request data.
|
|
11445
12057
|
# @param processor_signal_evaluate_request [ProcessorSignalEvaluateRequest]
|
|
11446
12058
|
# @param [Hash] opts the optional parameters
|
|
11447
12059
|
# @return [Array<(ProcessorSignalEvaluateResponse, Integer, Hash)>] ProcessorSignalEvaluateResponse data, response status code and response headers
|
|
@@ -11499,7 +12111,7 @@ module Plaid
|
|
|
11499
12111
|
end
|
|
11500
12112
|
|
|
11501
12113
|
# Opt-in a processor token to Signal
|
|
11502
|
-
# When a processor token is not initialized with
|
|
12114
|
+
# When a processor token is not initialized with `signal`, call `/processor/signal/prepare` to opt-in that processor token to the data collection process, which will improve the accuracy of the Signal Transaction Score. If this endpoint is called with a processor token that is already initialized with `signal`, it will return a 200 response and will not modify the processor token.
|
|
11503
12115
|
# @param processor_signal_prepare_request [ProcessorSignalPrepareRequest]
|
|
11504
12116
|
# @param [Hash] opts the optional parameters
|
|
11505
12117
|
# @return [ProcessorSignalPrepareResponse]
|
|
@@ -11509,7 +12121,7 @@ module Plaid
|
|
|
11509
12121
|
end
|
|
11510
12122
|
|
|
11511
12123
|
# Opt-in a processor token to Signal
|
|
11512
|
-
# When a processor token is not initialized with
|
|
12124
|
+
# When a processor token is not initialized with `signal`, call `/processor/signal/prepare` to opt-in that processor token to the data collection process, which will improve the accuracy of the Signal Transaction Score. If this endpoint is called with a processor token that is already initialized with `signal`, it will return a 200 response and will not modify the processor token.
|
|
11513
12125
|
# @param processor_signal_prepare_request [ProcessorSignalPrepareRequest]
|
|
11514
12126
|
# @param [Hash] opts the optional parameters
|
|
11515
12127
|
# @return [Array<(ProcessorSignalPrepareResponse, Integer, Hash)>] ProcessorSignalPrepareResponse data, response status code and response headers
|
|
@@ -12450,6 +13062,74 @@ module Plaid
|
|
|
12450
13062
|
return data, status_code, headers
|
|
12451
13063
|
end
|
|
12452
13064
|
|
|
13065
|
+
# Create a Protect report
|
|
13066
|
+
# 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.
|
|
13067
|
+
# @param protect_report_create_request [ProtectReportCreateRequest]
|
|
13068
|
+
# @param [Hash] opts the optional parameters
|
|
13069
|
+
# @return [ProtectReportCreateResponse]
|
|
13070
|
+
def protect_report_create(protect_report_create_request, opts = {})
|
|
13071
|
+
data, _status_code, _headers = protect_report_create_with_http_info(protect_report_create_request, opts)
|
|
13072
|
+
data
|
|
13073
|
+
end
|
|
13074
|
+
|
|
13075
|
+
# Create a Protect report
|
|
13076
|
+
# 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.
|
|
13077
|
+
# @param protect_report_create_request [ProtectReportCreateRequest]
|
|
13078
|
+
# @param [Hash] opts the optional parameters
|
|
13079
|
+
# @return [Array<(ProtectReportCreateResponse, Integer, Hash)>] ProtectReportCreateResponse data, response status code and response headers
|
|
13080
|
+
def protect_report_create_with_http_info(protect_report_create_request, opts = {})
|
|
13081
|
+
if @api_client.config.debugging
|
|
13082
|
+
@api_client.config.logger.debug 'Calling API: PlaidApi.protect_report_create ...'
|
|
13083
|
+
end
|
|
13084
|
+
# verify the required parameter 'protect_report_create_request' is set
|
|
13085
|
+
if @api_client.config.client_side_validation && protect_report_create_request.nil?
|
|
13086
|
+
fail ArgumentError, "Missing the required parameter 'protect_report_create_request' when calling PlaidApi.protect_report_create"
|
|
13087
|
+
end
|
|
13088
|
+
# resource path
|
|
13089
|
+
local_var_path = '/protect/report/create'
|
|
13090
|
+
|
|
13091
|
+
# query parameters
|
|
13092
|
+
query_params = opts[:query_params] || {}
|
|
13093
|
+
|
|
13094
|
+
# header parameters
|
|
13095
|
+
header_params = opts[:header_params] || {}
|
|
13096
|
+
# HTTP header 'Accept' (if needed)
|
|
13097
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
13098
|
+
# HTTP header 'Content-Type'
|
|
13099
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
|
13100
|
+
if !content_type.nil?
|
|
13101
|
+
header_params['Content-Type'] = content_type
|
|
13102
|
+
end
|
|
13103
|
+
|
|
13104
|
+
# form parameters
|
|
13105
|
+
form_params = opts[:form_params] || {}
|
|
13106
|
+
|
|
13107
|
+
# http body (model)
|
|
13108
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(protect_report_create_request)
|
|
13109
|
+
|
|
13110
|
+
# return_type
|
|
13111
|
+
return_type = opts[:debug_return_type] || 'ProtectReportCreateResponse'
|
|
13112
|
+
|
|
13113
|
+
# auth_names
|
|
13114
|
+
auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
|
|
13115
|
+
|
|
13116
|
+
new_options = opts.merge(
|
|
13117
|
+
:operation => :"PlaidApi.protect_report_create",
|
|
13118
|
+
:header_params => header_params,
|
|
13119
|
+
:query_params => query_params,
|
|
13120
|
+
:form_params => form_params,
|
|
13121
|
+
:body => post_body,
|
|
13122
|
+
:auth_names => auth_names,
|
|
13123
|
+
:return_type => return_type
|
|
13124
|
+
)
|
|
13125
|
+
|
|
13126
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
|
13127
|
+
if @api_client.config.debugging
|
|
13128
|
+
@api_client.config.logger.debug "API called: PlaidApi#protect_report_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
13129
|
+
end
|
|
13130
|
+
return data, status_code, headers
|
|
13131
|
+
end
|
|
13132
|
+
|
|
12453
13133
|
# Get Protect user insights
|
|
12454
13134
|
# Use this endpoint to get basic information about a user as it relates to their fraud profile with Protect.
|
|
12455
13135
|
# @param protect_user_insights_get_request [ProtectUserInsightsGetRequest]
|
|
@@ -14423,7 +15103,7 @@ module Plaid
|
|
|
14423
15103
|
end
|
|
14424
15104
|
|
|
14425
15105
|
# Report whether you initiated an ACH transaction
|
|
14426
|
-
# After
|
|
15106
|
+
# After you call `/signal/evaluate`, Plaid will normally infer the outcome from your Signal Rules. However, if you are not using Signal Rules, if the Signal Rules outcome was `REVIEW`, or if you take a different action than the one determined by the Signal Rules, you will need to call `/signal/decision/report`. This helps improve Signal Transaction Score accuracy for your account and is necessary for proper functioning of the rule performance and rule tuning capabilities in the Dashboard. If your effective decision changes after calling `/signal/decision/report` (for example, you indicated that you accepted a transaction, but later on, your payment processor rejected it, so it was never initiated), call `/signal/decision/report` again for the transaction to correct Plaid's records. If you are using Plaid Transfer as your payment processor, you also do not need to call `/signal/decision/report`, as Plaid can infer outcomes from your Transfer activity. If using a Balance-only ruleset, this endpoint will not impact scores (Balance does not use scores), but is necessary to view accurate transaction outcomes and tune rule logic in the Dashboard.
|
|
14427
15107
|
# @param signal_decision_report_request [SignalDecisionReportRequest]
|
|
14428
15108
|
# @param [Hash] opts the optional parameters
|
|
14429
15109
|
# @return [SignalDecisionReportResponse]
|
|
@@ -14433,7 +15113,7 @@ module Plaid
|
|
|
14433
15113
|
end
|
|
14434
15114
|
|
|
14435
15115
|
# Report whether you initiated an ACH transaction
|
|
14436
|
-
# After
|
|
15116
|
+
# After you call `/signal/evaluate`, Plaid will normally infer the outcome from your Signal Rules. However, if you are not using Signal Rules, if the Signal Rules outcome was `REVIEW`, or if you take a different action than the one determined by the Signal Rules, you will need to call `/signal/decision/report`. This helps improve Signal Transaction Score accuracy for your account and is necessary for proper functioning of the rule performance and rule tuning capabilities in the Dashboard. If your effective decision changes after calling `/signal/decision/report` (for example, you indicated that you accepted a transaction, but later on, your payment processor rejected it, so it was never initiated), call `/signal/decision/report` again for the transaction to correct Plaid's records. If you are using Plaid Transfer as your payment processor, you also do not need to call `/signal/decision/report`, as Plaid can infer outcomes from your Transfer activity. If using a Balance-only ruleset, this endpoint will not impact scores (Balance does not use scores), but is necessary to view accurate transaction outcomes and tune rule logic in the Dashboard.
|
|
14437
15117
|
# @param signal_decision_report_request [SignalDecisionReportRequest]
|
|
14438
15118
|
# @param [Hash] opts the optional parameters
|
|
14439
15119
|
# @return [Array<(SignalDecisionReportResponse, Integer, Hash)>] SignalDecisionReportResponse data, response status code and response headers
|
|
@@ -14491,7 +15171,7 @@ module Plaid
|
|
|
14491
15171
|
end
|
|
14492
15172
|
|
|
14493
15173
|
# Evaluate a planned ACH transaction
|
|
14494
|
-
# Use `/signal/evaluate` to evaluate a planned ACH transaction to get a return risk assessment
|
|
15174
|
+
# Use `/signal/evaluate` to evaluate a planned ACH transaction to get a return risk assessment and additional risk signals. Before using `/signal/evaluate`, you must first [create a ruleset](https://plaid.com/docs/signal/signal-rules/) in the Dashboard under [**Signal->Rules**](https://dashboard.plaid.com/signal/risk-profiles). `/signal/evaluate` can be used with either Signal Transaction Scores or the Balance product. Which product is used will be determined by the `ruleset_key` that you provide. For more details, see [Signal Rules](https://plaid.com/docs/signal/signal-rules/). Note: This request may have higher latency when using a Balance-only ruleset. This is because Plaid must communicate directly with the institution to request data. Balance-only rulesets may have latency of up to 30 seconds or more; if you encounter errors, you may find it necessary to adjust your timeout period when making requests.
|
|
14495
15175
|
# @param signal_evaluate_request [SignalEvaluateRequest]
|
|
14496
15176
|
# @param [Hash] opts the optional parameters
|
|
14497
15177
|
# @return [SignalEvaluateResponse]
|
|
@@ -14501,7 +15181,7 @@ module Plaid
|
|
|
14501
15181
|
end
|
|
14502
15182
|
|
|
14503
15183
|
# Evaluate a planned ACH transaction
|
|
14504
|
-
# Use `/signal/evaluate` to evaluate a planned ACH transaction to get a return risk assessment
|
|
15184
|
+
# Use `/signal/evaluate` to evaluate a planned ACH transaction to get a return risk assessment and additional risk signals. Before using `/signal/evaluate`, you must first [create a ruleset](https://plaid.com/docs/signal/signal-rules/) in the Dashboard under [**Signal->Rules**](https://dashboard.plaid.com/signal/risk-profiles). `/signal/evaluate` can be used with either Signal Transaction Scores or the Balance product. Which product is used will be determined by the `ruleset_key` that you provide. For more details, see [Signal Rules](https://plaid.com/docs/signal/signal-rules/). Note: This request may have higher latency when using a Balance-only ruleset. This is because Plaid must communicate directly with the institution to request data. Balance-only rulesets may have latency of up to 30 seconds or more; if you encounter errors, you may find it necessary to adjust your timeout period when making requests.
|
|
14505
15185
|
# @param signal_evaluate_request [SignalEvaluateRequest]
|
|
14506
15186
|
# @param [Hash] opts the optional parameters
|
|
14507
15187
|
# @return [Array<(SignalEvaluateResponse, Integer, Hash)>] SignalEvaluateResponse data, response status code and response headers
|
|
@@ -14558,8 +15238,8 @@ module Plaid
|
|
|
14558
15238
|
return data, status_code, headers
|
|
14559
15239
|
end
|
|
14560
15240
|
|
|
14561
|
-
# Opt-in an Item to Signal
|
|
14562
|
-
# When an Item is not initialized with
|
|
15241
|
+
# Opt-in an Item to Signal Transaction Scores
|
|
15242
|
+
# When an Item is not initialized with `signal`, call `/signal/prepare` to opt-in that Item to the data collection process used to develop a Signal Transaction Score. This should be done on Items where `signal` was added in the `additional_consented_products` array but not in the `products`, `optional_products`, or `required_if_supported_products` array. If `/signal/prepare` is skipped on an Item that is not initialized with `signal`, the initial call to `/signal/evaluate` on that Item will be less accurate, because Plaid will have access to less data for computing the Signal Transaction Score. If your integration is purely Balance-only, this endpoint will have no effect, as Balance-only rulesets do not calculate a Signal Transaction Score. If run on an Item that is already initialized with `signal`, this endpoint will return a 200 response and will not modify the Item.
|
|
14563
15243
|
# @param signal_prepare_request [SignalPrepareRequest]
|
|
14564
15244
|
# @param [Hash] opts the optional parameters
|
|
14565
15245
|
# @return [SignalPrepareResponse]
|
|
@@ -14568,8 +15248,8 @@ module Plaid
|
|
|
14568
15248
|
data
|
|
14569
15249
|
end
|
|
14570
15250
|
|
|
14571
|
-
# Opt-in an Item to Signal
|
|
14572
|
-
# When an Item is not initialized with
|
|
15251
|
+
# Opt-in an Item to Signal Transaction Scores
|
|
15252
|
+
# When an Item is not initialized with `signal`, call `/signal/prepare` to opt-in that Item to the data collection process used to develop a Signal Transaction Score. This should be done on Items where `signal` was added in the `additional_consented_products` array but not in the `products`, `optional_products`, or `required_if_supported_products` array. If `/signal/prepare` is skipped on an Item that is not initialized with `signal`, the initial call to `/signal/evaluate` on that Item will be less accurate, because Plaid will have access to less data for computing the Signal Transaction Score. If your integration is purely Balance-only, this endpoint will have no effect, as Balance-only rulesets do not calculate a Signal Transaction Score. If run on an Item that is already initialized with `signal`, this endpoint will return a 200 response and will not modify the Item.
|
|
14573
15253
|
# @param signal_prepare_request [SignalPrepareRequest]
|
|
14574
15254
|
# @param [Hash] opts the optional parameters
|
|
14575
15255
|
# @return [Array<(SignalPrepareResponse, Integer, Hash)>] SignalPrepareResponse data, response status code and response headers
|
|
@@ -14627,7 +15307,7 @@ module Plaid
|
|
|
14627
15307
|
end
|
|
14628
15308
|
|
|
14629
15309
|
# Report a return for an ACH transaction
|
|
14630
|
-
# Call the `/signal/return/report` endpoint to report a returned transaction that was previously sent to the `/signal/evaluate` endpoint. Your feedback will be used by the model to incorporate the latest risk
|
|
15310
|
+
# Call the `/signal/return/report` endpoint to report a returned transaction that was previously sent to the `/signal/evaluate` endpoint. Your feedback will be used by the model to incorporate the latest risk trends into your scores and tune rule logic. If using a Balance-only ruleset, this endpoint will not impact scores (as Balance does not use scores), but is necessary to view accurate transaction outcomes and tune rule logic in the Dashboard.
|
|
14631
15311
|
# @param signal_return_report_request [SignalReturnReportRequest]
|
|
14632
15312
|
# @param [Hash] opts the optional parameters
|
|
14633
15313
|
# @return [SignalReturnReportResponse]
|
|
@@ -14637,7 +15317,7 @@ module Plaid
|
|
|
14637
15317
|
end
|
|
14638
15318
|
|
|
14639
15319
|
# Report a return for an ACH transaction
|
|
14640
|
-
# Call the `/signal/return/report` endpoint to report a returned transaction that was previously sent to the `/signal/evaluate` endpoint. Your feedback will be used by the model to incorporate the latest risk
|
|
15320
|
+
# Call the `/signal/return/report` endpoint to report a returned transaction that was previously sent to the `/signal/evaluate` endpoint. Your feedback will be used by the model to incorporate the latest risk trends into your scores and tune rule logic. If using a Balance-only ruleset, this endpoint will not impact scores (as Balance does not use scores), but is necessary to view accurate transaction outcomes and tune rule logic in the Dashboard.
|
|
14641
15321
|
# @param signal_return_report_request [SignalReturnReportRequest]
|
|
14642
15322
|
# @param [Hash] opts the optional parameters
|
|
14643
15323
|
# @return [Array<(SignalReturnReportResponse, Integer, Hash)>] SignalReturnReportResponse data, response status code and response headers
|
|
@@ -17482,8 +18162,8 @@ module Plaid
|
|
|
17482
18162
|
return data, status_code, headers
|
|
17483
18163
|
end
|
|
17484
18164
|
|
|
17485
|
-
# Create an originator for
|
|
17486
|
-
#
|
|
18165
|
+
# Create an originator for Transfer for Platforms customers
|
|
18166
|
+
# Use the `/transfer/platform/originator/create` endpoint to submit information about the originator you are onboarding, including the originator's agreement to the required legal terms.
|
|
17487
18167
|
# @param transfer_platform_originator_create_request [TransferPlatformOriginatorCreateRequest]
|
|
17488
18168
|
# @param [Hash] opts the optional parameters
|
|
17489
18169
|
# @return [TransferPlatformOriginatorCreateResponse]
|
|
@@ -17492,8 +18172,8 @@ module Plaid
|
|
|
17492
18172
|
data
|
|
17493
18173
|
end
|
|
17494
18174
|
|
|
17495
|
-
# Create an originator for
|
|
17496
|
-
#
|
|
18175
|
+
# Create an originator for Transfer for Platforms customers
|
|
18176
|
+
# Use the `/transfer/platform/originator/create` endpoint to submit information about the originator you are onboarding, including the originator's agreement to the required legal terms.
|
|
17497
18177
|
# @param transfer_platform_originator_create_request [TransferPlatformOriginatorCreateRequest]
|
|
17498
18178
|
# @param [Hash] opts the optional parameters
|
|
17499
18179
|
# @return [Array<(TransferPlatformOriginatorCreateResponse, Integer, Hash)>] TransferPlatformOriginatorCreateResponse data, response status code and response headers
|
|
@@ -17551,7 +18231,7 @@ module Plaid
|
|
|
17551
18231
|
end
|
|
17552
18232
|
|
|
17553
18233
|
# Create a person associated with an originator
|
|
17554
|
-
# Use the `/transfer/platform/person/create` endpoint to create a person
|
|
18234
|
+
# Use the `/transfer/platform/person/create` endpoint to create a person associated with an originator (e.g. beneficial owner or control person) and optionally submit personal identification information for them.
|
|
17555
18235
|
# @param transfer_platform_person_create_request [TransferPlatformPersonCreateRequest]
|
|
17556
18236
|
# @param [Hash] opts the optional parameters
|
|
17557
18237
|
# @return [TransferPlatformPersonCreateResponse]
|
|
@@ -17561,7 +18241,7 @@ module Plaid
|
|
|
17561
18241
|
end
|
|
17562
18242
|
|
|
17563
18243
|
# Create a person associated with an originator
|
|
17564
|
-
# Use the `/transfer/platform/person/create` endpoint to create a person
|
|
18244
|
+
# Use the `/transfer/platform/person/create` endpoint to create a person associated with an originator (e.g. beneficial owner or control person) and optionally submit personal identification information for them.
|
|
17565
18245
|
# @param transfer_platform_person_create_request [TransferPlatformPersonCreateRequest]
|
|
17566
18246
|
# @param [Hash] opts the optional parameters
|
|
17567
18247
|
# @return [Array<(TransferPlatformPersonCreateResponse, Integer, Hash)>] TransferPlatformPersonCreateResponse data, response status code and response headers
|
|
@@ -17618,8 +18298,8 @@ module Plaid
|
|
|
17618
18298
|
return data, status_code, headers
|
|
17619
18299
|
end
|
|
17620
18300
|
|
|
17621
|
-
# Submit onboarding
|
|
17622
|
-
#
|
|
18301
|
+
# Submit additional onboarding information on behalf of an originator
|
|
18302
|
+
# Use the `/transfer/platform/requirement/submit` endpoint to submit additional onboarding information that is needed by Plaid to approve or decline the originator. See [Requirement type schema documentation](https://docs.google.com/document/d/1NEQkTD0sVK50iAQi6xHigrexDUxZ4QxXqSEfV_FFTiU/) for a list of requirement types and possible values.
|
|
17623
18303
|
# @param transfer_platform_requirement_submit_request [TransferPlatformRequirementSubmitRequest]
|
|
17624
18304
|
# @param [Hash] opts the optional parameters
|
|
17625
18305
|
# @return [TransferPlatformRequirementSubmitResponse]
|
|
@@ -17628,8 +18308,8 @@ module Plaid
|
|
|
17628
18308
|
data
|
|
17629
18309
|
end
|
|
17630
18310
|
|
|
17631
|
-
# Submit onboarding
|
|
17632
|
-
#
|
|
18311
|
+
# Submit additional onboarding information on behalf of an originator
|
|
18312
|
+
# Use the `/transfer/platform/requirement/submit` endpoint to submit additional onboarding information that is needed by Plaid to approve or decline the originator. See [Requirement type schema documentation](https://docs.google.com/document/d/1NEQkTD0sVK50iAQi6xHigrexDUxZ4QxXqSEfV_FFTiU/) for a list of requirement types and possible values.
|
|
17633
18313
|
# @param transfer_platform_requirement_submit_request [TransferPlatformRequirementSubmitRequest]
|
|
17634
18314
|
# @param [Hash] opts the optional parameters
|
|
17635
18315
|
# @return [Array<(TransferPlatformRequirementSubmitResponse, Integer, Hash)>] TransferPlatformRequirementSubmitResponse data, response status code and response headers
|
|
@@ -17823,7 +18503,7 @@ module Plaid
|
|
|
17823
18503
|
end
|
|
17824
18504
|
|
|
17825
18505
|
# Create a recurring transfer
|
|
17826
|
-
# Use the `/transfer/recurring/create` endpoint to initiate a new recurring transfer. This capability is not currently supported for Transfer UI or
|
|
18506
|
+
# Use the `/transfer/recurring/create` endpoint to initiate a new recurring transfer. This capability is not currently supported for Transfer UI or Transfer for Platforms (beta) customers.
|
|
17827
18507
|
# @param transfer_recurring_create_request [TransferRecurringCreateRequest]
|
|
17828
18508
|
# @param [Hash] opts the optional parameters
|
|
17829
18509
|
# @return [TransferRecurringCreateResponse]
|
|
@@ -17833,7 +18513,7 @@ module Plaid
|
|
|
17833
18513
|
end
|
|
17834
18514
|
|
|
17835
18515
|
# Create a recurring transfer
|
|
17836
|
-
# Use the `/transfer/recurring/create` endpoint to initiate a new recurring transfer. This capability is not currently supported for Transfer UI or
|
|
18516
|
+
# Use the `/transfer/recurring/create` endpoint to initiate a new recurring transfer. This capability is not currently supported for Transfer UI or Transfer for Platforms (beta) customers.
|
|
17837
18517
|
# @param transfer_recurring_create_request [TransferRecurringCreateRequest]
|
|
17838
18518
|
# @param [Hash] opts the optional parameters
|
|
17839
18519
|
# @return [Array<(TransferRecurringCreateResponse, Integer, Hash)>] TransferRecurringCreateResponse data, response status code and response headers
|
|
@@ -18095,7 +18775,7 @@ module Plaid
|
|
|
18095
18775
|
end
|
|
18096
18776
|
|
|
18097
18777
|
# Create a refund
|
|
18098
|
-
# Use the `/transfer/refund/create` endpoint to create a refund for a transfer. A transfer can be refunded if the transfer was initiated in the past 180 days. Refunds come out of the available balance of the ledger used for the original debit transfer. If there are not enough funds in the available balance to cover the refund amount, the refund will be rejected. You can create a refund at any time. Plaid does not impose any hold time on refunds. A refund can still be issued even if the Item's `access_token` is no longer valid (e.g. if the user revoked OAuth consent or the Item was deleted via `/item/remove`), as long as the account and routing number pair used to make the original transaction is still valid. A refund cannot be issued if the Item has an [invalidated TAN](https://plaid.com/docs/auth/#tokenized-account-numbers), which can occur at Chase or PNC.
|
|
18778
|
+
# Use the `/transfer/refund/create` endpoint to create a refund for a transfer. A transfer can be refunded if the transfer was initiated in the past 180 days. Refunds come out of the available balance of the ledger used for the original debit transfer. If there are not enough funds in the available balance to cover the refund amount, the refund will be rejected. You can create a refund at any time. Plaid does not impose any hold time on refunds. A refund can still be issued even if the Item's `access_token` is no longer valid (e.g. if the user revoked OAuth consent or the Item was deleted via `/item/remove`), as long as the account and routing number pair used to make the original transaction is still valid. A refund cannot be issued if the Item has an [invalidated TAN](https://plaid.com/docs/auth/#tokenized-account-numbers), which can occur at Chase or PNC.
|
|
18099
18779
|
# @param transfer_refund_create_request [TransferRefundCreateRequest]
|
|
18100
18780
|
# @param [Hash] opts the optional parameters
|
|
18101
18781
|
# @return [TransferRefundCreateResponse]
|
|
@@ -18105,7 +18785,7 @@ module Plaid
|
|
|
18105
18785
|
end
|
|
18106
18786
|
|
|
18107
18787
|
# Create a refund
|
|
18108
|
-
# Use the `/transfer/refund/create` endpoint to create a refund for a transfer. A transfer can be refunded if the transfer was initiated in the past 180 days. Refunds come out of the available balance of the ledger used for the original debit transfer. If there are not enough funds in the available balance to cover the refund amount, the refund will be rejected. You can create a refund at any time. Plaid does not impose any hold time on refunds. A refund can still be issued even if the Item's `access_token` is no longer valid (e.g. if the user revoked OAuth consent or the Item was deleted via `/item/remove`), as long as the account and routing number pair used to make the original transaction is still valid. A refund cannot be issued if the Item has an [invalidated TAN](https://plaid.com/docs/auth/#tokenized-account-numbers), which can occur at Chase or PNC.
|
|
18788
|
+
# Use the `/transfer/refund/create` endpoint to create a refund for a transfer. A transfer can be refunded if the transfer was initiated in the past 180 days. Refunds come out of the available balance of the ledger used for the original debit transfer. If there are not enough funds in the available balance to cover the refund amount, the refund will be rejected. You can create a refund at any time. Plaid does not impose any hold time on refunds. A refund can still be issued even if the Item's `access_token` is no longer valid (e.g. if the user revoked OAuth consent or the Item was deleted via `/item/remove`), as long as the account and routing number pair used to make the original transaction is still valid. A refund cannot be issued if the Item has an [invalidated TAN](https://plaid.com/docs/auth/#tokenized-account-numbers), which can occur at Chase or PNC.
|
|
18109
18789
|
# @param transfer_refund_create_request [TransferRefundCreateRequest]
|
|
18110
18790
|
# @param [Hash] opts the optional parameters
|
|
18111
18791
|
# @return [Array<(TransferRefundCreateResponse, Integer, Hash)>] TransferRefundCreateResponse data, response status code and response headers
|
|
@@ -18571,7 +19251,7 @@ module Plaid
|
|
|
18571
19251
|
end
|
|
18572
19252
|
|
|
18573
19253
|
# Create user
|
|
18574
|
-
#
|
|
19254
|
+
# For Plaid products and flows that use the user object, `/user/create` provides you a single token to access all data associated with the user. You must call this endpoint before calling `/link/token/create` if you are using any of the following: Plaid Check, Income Verification, Multi-Item Link, or Plaid Protect. For customers who began using this endpoint on or after December 10, 2025, this endpoint takes a `client_user_id` and an `identity` object and will return a `user_id`. For customers who began using it before that date, the endpoint takes a `client_user_id` and a `consumer_report_user_identity` object and will return a `user_token` and `user_id`. For more details, see [New User APIs](https://plaid.com/docs/api/users/user-apis). In order to create a Plaid Check Consumer Report for a user, the `identity` (new) or `consumer_report_user_identity` (legacy) object must be present. If it is not provided during the `/user/create` call, it can be added later by calling `/user/update`. In order to generate a Plaid Check Consumer Report, the following `identity` fields, at minimum, are required and must be non-empty: `name`, `date_of_birth`, `emails`, `phone_numbers`, and `addresses`, (with at least one email, phone number, and address designated as `primary`). Plaid Check Consumer Reports can only be created for US-based users; the user's address country must be `US`. If creating a report for sharing with a GSE such as Fannie or Freddie, the user's full SSN must be provided via the `id_numbers` field. Providing at least a partial SSN is also strongly recommended for all use cases, since it improves the accuracy of matching user records during compliance processes such as file disclosure, dispute, or security freeze requests. When using Plaid Protect, it is highly recommended that you provide an `identity` object to better identify and block fraud across your Link sessions. Plaid will normalize identity fields before storing them and utilize the same identity across different user-based products.
|
|
18575
19255
|
# @param user_create_request [UserCreateRequest]
|
|
18576
19256
|
# @param [Hash] opts the optional parameters
|
|
18577
19257
|
# @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)
|
|
@@ -18582,7 +19262,7 @@ module Plaid
|
|
|
18582
19262
|
end
|
|
18583
19263
|
|
|
18584
19264
|
# Create user
|
|
18585
|
-
#
|
|
19265
|
+
# For Plaid products and flows that use the user object, `/user/create` provides you a single token to access all data associated with the user. You must call this endpoint before calling `/link/token/create` if you are using any of the following: Plaid Check, Income Verification, Multi-Item Link, or Plaid Protect. For customers who began using this endpoint on or after December 10, 2025, this endpoint takes a `client_user_id` and an `identity` object and will return a `user_id`. For customers who began using it before that date, the endpoint takes a `client_user_id` and a `consumer_report_user_identity` object and will return a `user_token` and `user_id`. For more details, see [New User APIs](https://plaid.com/docs/api/users/user-apis). In order to create a Plaid Check Consumer Report for a user, the `identity` (new) or `consumer_report_user_identity` (legacy) object must be present. If it is not provided during the `/user/create` call, it can be added later by calling `/user/update`. In order to generate a Plaid Check Consumer Report, the following `identity` fields, at minimum, are required and must be non-empty: `name`, `date_of_birth`, `emails`, `phone_numbers`, and `addresses`, (with at least one email, phone number, and address designated as `primary`). Plaid Check Consumer Reports can only be created for US-based users; the user's address country must be `US`. If creating a report for sharing with a GSE such as Fannie or Freddie, the user's full SSN must be provided via the `id_numbers` field. Providing at least a partial SSN is also strongly recommended for all use cases, since it improves the accuracy of matching user records during compliance processes such as file disclosure, dispute, or security freeze requests. When using Plaid Protect, it is highly recommended that you provide an `identity` object to better identify and block fraud across your Link sessions. Plaid will normalize identity fields before storing them and utilize the same identity across different user-based products.
|
|
18586
19266
|
# @param user_create_request [UserCreateRequest]
|
|
18587
19267
|
# @param [Hash] opts the optional parameters
|
|
18588
19268
|
# @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)
|
|
@@ -18709,8 +19389,8 @@ module Plaid
|
|
|
18709
19389
|
return data, status_code, headers
|
|
18710
19390
|
end
|
|
18711
19391
|
|
|
18712
|
-
# Retrieve user identity and information
|
|
18713
|
-
#
|
|
19392
|
+
# Retrieve user identity and information
|
|
19393
|
+
# Get user details using a `user_id`. This endpoint only supports users that were created on the new user API flow, without a `user_token`. For more details, see [New User APIs](https://plaid.com/docs/api/users/user-apis).
|
|
18714
19394
|
# @param user_get_request [UserGetRequest]
|
|
18715
19395
|
# @param [Hash] opts the optional parameters
|
|
18716
19396
|
# @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)
|
|
@@ -18720,8 +19400,8 @@ module Plaid
|
|
|
18720
19400
|
data
|
|
18721
19401
|
end
|
|
18722
19402
|
|
|
18723
|
-
# Retrieve user identity and information
|
|
18724
|
-
#
|
|
19403
|
+
# Retrieve user identity and information
|
|
19404
|
+
# Get user details using a `user_id`. This endpoint only supports users that were created on the new user API flow, without a `user_token`. For more details, see [New User APIs](https://plaid.com/docs/api/users/user-apis).
|
|
18725
19405
|
# @param user_get_request [UserGetRequest]
|
|
18726
19406
|
# @param [Hash] opts the optional parameters
|
|
18727
19407
|
# @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)
|
|
@@ -18849,7 +19529,7 @@ module Plaid
|
|
|
18849
19529
|
end
|
|
18850
19530
|
|
|
18851
19531
|
# Get Items associated with a User
|
|
18852
|
-
# Returns Items associated with a
|
|
19532
|
+
# Returns Items associated with a `user_id`, along with their corresponding statuses. Plaid associates an Item with a User when it has been successfully connected within a Link session initialized with that `user_id`.
|
|
18853
19533
|
# @param user_items_get_request [UserItemsGetRequest]
|
|
18854
19534
|
# @param [Hash] opts the optional parameters
|
|
18855
19535
|
# @return [UserItemsGetResponse]
|
|
@@ -18859,7 +19539,7 @@ module Plaid
|
|
|
18859
19539
|
end
|
|
18860
19540
|
|
|
18861
19541
|
# Get Items associated with a User
|
|
18862
|
-
# Returns Items associated with a
|
|
19542
|
+
# Returns Items associated with a `user_id`, along with their corresponding statuses. Plaid associates an Item with a User when it has been successfully connected within a Link session initialized with that `user_id`.
|
|
18863
19543
|
# @param user_items_get_request [UserItemsGetRequest]
|
|
18864
19544
|
# @param [Hash] opts the optional parameters
|
|
18865
19545
|
# @return [Array<(UserItemsGetResponse, Integer, Hash)>] UserItemsGetResponse data, response status code and response headers
|
|
@@ -18916,31 +19596,31 @@ module Plaid
|
|
|
18916
19596
|
return data, status_code, headers
|
|
18917
19597
|
end
|
|
18918
19598
|
|
|
18919
|
-
#
|
|
18920
|
-
#
|
|
18921
|
-
# @param
|
|
19599
|
+
# Terminate user-based products
|
|
19600
|
+
# `/user/products/terminate` terminates user-based recurring subscriptions for a given client user. This will remove user-based products (Financial Management, Protect, and CRA products) from all items associated with the user.
|
|
19601
|
+
# @param user_products_terminate_request [UserProductsTerminateRequest]
|
|
18922
19602
|
# @param [Hash] opts the optional parameters
|
|
18923
|
-
# @return [
|
|
18924
|
-
def
|
|
18925
|
-
data, _status_code, _headers =
|
|
19603
|
+
# @return [UserProductsTerminateResponse]
|
|
19604
|
+
def user_products_terminate(user_products_terminate_request, opts = {})
|
|
19605
|
+
data, _status_code, _headers = user_products_terminate_with_http_info(user_products_terminate_request, opts)
|
|
18926
19606
|
data
|
|
18927
19607
|
end
|
|
18928
19608
|
|
|
18929
|
-
#
|
|
18930
|
-
#
|
|
18931
|
-
# @param
|
|
19609
|
+
# Terminate user-based products
|
|
19610
|
+
# `/user/products/terminate` terminates user-based recurring subscriptions for a given client user. This will remove user-based products (Financial Management, Protect, and CRA products) from all items associated with the user.
|
|
19611
|
+
# @param user_products_terminate_request [UserProductsTerminateRequest]
|
|
18932
19612
|
# @param [Hash] opts the optional parameters
|
|
18933
|
-
# @return [Array<(
|
|
18934
|
-
def
|
|
19613
|
+
# @return [Array<(UserProductsTerminateResponse, Integer, Hash)>] UserProductsTerminateResponse data, response status code and response headers
|
|
19614
|
+
def user_products_terminate_with_http_info(user_products_terminate_request, opts = {})
|
|
18935
19615
|
if @api_client.config.debugging
|
|
18936
|
-
@api_client.config.logger.debug 'Calling API: PlaidApi.
|
|
19616
|
+
@api_client.config.logger.debug 'Calling API: PlaidApi.user_products_terminate ...'
|
|
18937
19617
|
end
|
|
18938
|
-
# verify the required parameter '
|
|
18939
|
-
if @api_client.config.client_side_validation &&
|
|
18940
|
-
fail ArgumentError, "Missing the required parameter '
|
|
19618
|
+
# verify the required parameter 'user_products_terminate_request' is set
|
|
19619
|
+
if @api_client.config.client_side_validation && user_products_terminate_request.nil?
|
|
19620
|
+
fail ArgumentError, "Missing the required parameter 'user_products_terminate_request' when calling PlaidApi.user_products_terminate"
|
|
18941
19621
|
end
|
|
18942
19622
|
# resource path
|
|
18943
|
-
local_var_path = '/user/
|
|
19623
|
+
local_var_path = '/user/products/terminate'
|
|
18944
19624
|
|
|
18945
19625
|
# query parameters
|
|
18946
19626
|
query_params = opts[:query_params] || {}
|
|
@@ -18959,16 +19639,16 @@ module Plaid
|
|
|
18959
19639
|
form_params = opts[:form_params] || {}
|
|
18960
19640
|
|
|
18961
19641
|
# http body (model)
|
|
18962
|
-
post_body = opts[:debug_body] || @api_client.object_to_http_body(
|
|
19642
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(user_products_terminate_request)
|
|
18963
19643
|
|
|
18964
19644
|
# return_type
|
|
18965
|
-
return_type = opts[:debug_return_type] || '
|
|
19645
|
+
return_type = opts[:debug_return_type] || 'UserProductsTerminateResponse'
|
|
18966
19646
|
|
|
18967
19647
|
# auth_names
|
|
18968
19648
|
auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
|
|
18969
19649
|
|
|
18970
19650
|
new_options = opts.merge(
|
|
18971
|
-
:operation => :"PlaidApi.
|
|
19651
|
+
:operation => :"PlaidApi.user_products_terminate",
|
|
18972
19652
|
:header_params => header_params,
|
|
18973
19653
|
:query_params => query_params,
|
|
18974
19654
|
:form_params => form_params,
|
|
@@ -18979,13 +19659,13 @@ module Plaid
|
|
|
18979
19659
|
|
|
18980
19660
|
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
|
18981
19661
|
if @api_client.config.debugging
|
|
18982
|
-
@api_client.config.logger.debug "API called: PlaidApi#
|
|
19662
|
+
@api_client.config.logger.debug "API called: PlaidApi#user_products_terminate\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
18983
19663
|
end
|
|
18984
19664
|
return data, status_code, headers
|
|
18985
19665
|
end
|
|
18986
19666
|
|
|
18987
19667
|
# Remove user
|
|
18988
|
-
# `/user/remove` deletes a
|
|
19668
|
+
# `/user/remove` deletes a `user_id` or `user_token` and and associated information, including any Items associated with the user.
|
|
18989
19669
|
# @param user_remove_request [UserRemoveRequest]
|
|
18990
19670
|
# @param [Hash] opts the optional parameters
|
|
18991
19671
|
# @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)
|
|
@@ -18996,7 +19676,7 @@ module Plaid
|
|
|
18996
19676
|
end
|
|
18997
19677
|
|
|
18998
19678
|
# Remove user
|
|
18999
|
-
# `/user/remove` deletes a
|
|
19679
|
+
# `/user/remove` deletes a `user_id` or `user_token` and and associated information, including any Items associated with the user.
|
|
19000
19680
|
# @param user_remove_request [UserRemoveRequest]
|
|
19001
19681
|
# @param [Hash] opts the optional parameters
|
|
19002
19682
|
# @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)
|
|
@@ -19260,7 +19940,7 @@ module Plaid
|
|
|
19260
19940
|
end
|
|
19261
19941
|
|
|
19262
19942
|
# Update user information
|
|
19263
|
-
# This endpoint
|
|
19943
|
+
# This endpoint updates user information for an existing `user_id` or `user_token`. If an existing `user_id` or `user_token` is missing fields required for a given use case (e.g. creating a Consumer Report) use `/user/update` to add values for those fields. Identity updates use merge semantics: provided fields overwrite existing ones; omitted fields remain unchanged.
|
|
19264
19944
|
# @param user_update_request [UserUpdateRequest]
|
|
19265
19945
|
# @param [Hash] opts the optional parameters
|
|
19266
19946
|
# @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)
|
|
@@ -19271,7 +19951,7 @@ module Plaid
|
|
|
19271
19951
|
end
|
|
19272
19952
|
|
|
19273
19953
|
# Update user information
|
|
19274
|
-
# This endpoint
|
|
19954
|
+
# This endpoint updates user information for an existing `user_id` or `user_token`. If an existing `user_id` or `user_token` is missing fields required for a given use case (e.g. creating a Consumer Report) use `/user/update` to add values for those fields. Identity updates use merge semantics: provided fields overwrite existing ones; omitted fields remain unchanged.
|
|
19275
19955
|
# @param user_update_request [UserUpdateRequest]
|
|
19276
19956
|
# @param [Hash] opts the optional parameters
|
|
19277
19957
|
# @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)
|