plaid 28.0.0 → 30.0.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +195 -0
- data/Gemfile.lock +2 -2
- data/Makefile +1 -1
- data/README.md +34 -30
- data/lib/plaid/api/plaid_api.rb +830 -82
- data/lib/plaid/api_client.rb +2 -2
- data/lib/plaid/api_error.rb +1 -1
- data/lib/plaid/configuration.rb +4 -7
- data/lib/plaid/models/account_access.rb +1 -1
- data/lib/plaid/models/account_assets.rb +12 -2
- data/lib/plaid/models/account_balance.rb +1 -1
- data/lib/plaid/models/account_base.rb +16 -6
- 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 +40 -0
- data/lib/plaid/models/account_identity.rb +16 -18
- data/lib/plaid/models/account_identity_all_of.rb +5 -17
- data/lib/plaid/models/account_identity_document_upload.rb +13 -3
- data/lib/plaid/models/account_identity_document_upload_all_of.rb +1 -1
- data/lib/plaid/models/account_identity_match_score.rb +13 -3
- data/lib/plaid/models/account_identity_match_score_all_of.rb +1 -1
- data/lib/plaid/models/account_product_access.rb +1 -1
- data/lib/plaid/models/account_product_access_nullable.rb +1 -1
- data/lib/plaid/models/account_selection_cardinality.rb +1 -1
- data/lib/plaid/models/account_subtype.rb +1 -1
- data/lib/plaid/models/account_type.rb +1 -1
- data/lib/plaid/models/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_balance_get_request_payment_details.rb +30 -18
- data/lib/plaid/models/accounts_balance_get_response_payment_risk_assessment.rb +47 -6
- 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/application.rb +1 -1
- data/lib/plaid/models/application_get_request.rb +1 -1
- data/lib/plaid/models/application_get_response.rb +1 -1
- data/lib/plaid/models/apr.rb +1 -1
- data/lib/plaid/models/asset.rb +1 -1
- data/lib/plaid/models/asset_detail.rb +1 -1
- data/lib/plaid/models/asset_holder.rb +1 -1
- data/lib/plaid/models/asset_holder_name.rb +1 -1
- data/lib/plaid/models/asset_owner.rb +1 -1
- data/lib/plaid/models/asset_owners.rb +1 -1
- data/lib/plaid/models/asset_report.rb +1 -1
- data/lib/plaid/models/asset_report_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_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_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 +39 -0
- data/lib/plaid/models/asset_report_user.rb +1 -1
- data/lib/plaid/models/asset_transaction.rb +1 -1
- data/lib/plaid/models/asset_transaction_category_type.rb +1 -1
- data/lib/plaid/models/asset_transaction_description.rb +1 -1
- data/lib/plaid/models/asset_transaction_detail.rb +1 -1
- data/lib/plaid/models/asset_transaction_type.rb +1 -1
- data/lib/plaid/models/asset_transactions.rb +1 -1
- data/lib/plaid/models/asset_type.rb +1 -1
- data/lib/plaid/models/assets.rb +1 -1
- data/lib/plaid/models/assets_error_webhook.rb +1 -1
- data/lib/plaid/models/assets_product_ready_webhook.rb +2 -3
- data/lib/plaid/models/auth_default_update_webhook.rb +336 -0
- 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 +39 -0
- data/lib/plaid/models/automatically_verified_webhook.rb +1 -1
- data/lib/plaid/models/balance_plus_attributes.rb +10 -10
- data/lib/plaid/models/balance_plus_risk_level.rb +42 -0
- 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_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 +17 -2
- data/lib/plaid/models/base_report_account_balances.rb +1 -1
- data/lib/plaid/models/base_report_account_balances_all_of.rb +1 -1
- data/lib/plaid/models/base_report_account_insights.rb +3 -1
- data/lib/plaid/models/base_report_average_flow_insights.rb +1 -1
- data/lib/plaid/models/base_report_average_monthly_balances.rb +1 -1
- data/lib/plaid/models/base_report_create_request.rb +1 -1
- data/lib/plaid/models/base_report_create_response.rb +1 -1
- data/lib/plaid/models/base_report_get_request.rb +1 -1
- data/lib/plaid/models/base_report_get_response.rb +1 -1
- data/lib/plaid/models/base_report_item.rb +17 -2
- data/lib/plaid/models/base_report_longest_gap_insights.rb +1 -1
- data/lib/plaid/models/base_report_number_flow_insights.rb +1 -1
- data/lib/plaid/models/base_report_transaction.rb +32 -2
- data/lib/plaid/models/base_report_transaction_type.rb +1 -1
- data/lib/plaid/models/base_report_warning.rb +2 -2
- 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/base_reports_product_ready_webhook.rb +1 -1
- data/lib/plaid/models/beacon_account_risk_attributes.rb +519 -0
- 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 +286 -0
- data/lib/plaid/models/beacon_bank_accounts.rb +242 -0
- 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_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_user.rb +25 -17
- data/lib/plaid/models/beacon_user_account_insights_get_request.rb +261 -0
- data/lib/plaid/models/beacon_user_account_insights_get_response.rb +285 -0
- data/lib/plaid/models/beacon_user_address.rb +1 -22
- data/lib/plaid/models/beacon_user_create_request.rb +15 -23
- data/lib/plaid/models/beacon_user_create_response.rb +25 -17
- data/lib/plaid/models/beacon_user_data.rb +1 -1
- data/lib/plaid/models/beacon_user_get_request.rb +1 -1
- data/lib/plaid/models/beacon_user_get_response.rb +25 -17
- 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 +1 -1
- data/lib/plaid/models/beacon_user_name.rb +1 -1
- data/lib/plaid/models/beacon_user_name_nullable.rb +1 -1
- data/lib/plaid/models/beacon_user_request_address.rb +1 -22
- data/lib/plaid/models/beacon_user_request_address_nullable.rb +1 -22
- data/lib/plaid/models/beacon_user_request_data.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 +16 -7
- data/lib/plaid/models/beacon_user_update_request_data.rb +2 -2
- data/lib/plaid/models/beacon_user_update_response.rb +25 -17
- data/lib/plaid/models/categories_get_response.rb +1 -1
- data/lib/plaid/models/category.rb +1 -1
- data/lib/plaid/models/category_insight_details.rb +1 -1
- data/lib/plaid/models/category_insights.rb +1 -1
- data/lib/plaid/models/cause.rb +1 -1
- data/lib/plaid/models/cause_all_of.rb +1 -1
- data/lib/plaid/models/client_provided_enhanced_transaction.rb +1 -1
- data/lib/plaid/models/client_provided_enriched_transaction.rb +1 -1
- data/lib/plaid/models/client_provided_raw_transaction.rb +1 -1
- data/lib/plaid/models/client_provided_transaction.rb +1 -1
- data/lib/plaid/models/client_provided_transaction_location.rb +1 -1
- data/lib/plaid/models/connected_application.rb +1 -1
- data/lib/plaid/models/consumer_report_pdf_get_request.rb +1 -1
- data/lib/plaid/models/consumer_report_permissible_purpose.rb +1 -1
- 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_type.rb +1 -1
- data/lib/plaid/models/country_code.rb +1 -1
- data/lib/plaid/models/cra_bank_income.rb +1 -1
- data/lib/plaid/models/cra_bank_income_account.rb +12 -2
- 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_create_request.rb +1 -1
- data/lib/plaid/models/cra_bank_income_create_response.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_get_request.rb +1 -1
- data/lib/plaid/models/cra_bank_income_get_response.rb +1 -1
- data/lib/plaid/models/cra_bank_income_historical_summary.rb +1 -1
- data/lib/plaid/models/cra_bank_income_item.rb +12 -2
- data/lib/plaid/models/cra_bank_income_source.rb +12 -2
- data/lib/plaid/models/cra_bank_income_summary.rb +1 -1
- data/lib/plaid/models/cra_bank_income_transaction.rb +13 -3
- 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_check_report_base_report_get_request.rb +259 -0
- data/lib/plaid/models/cra_check_report_base_report_get_response.rb +252 -0
- data/lib/plaid/models/cra_check_report_create_request.rb +345 -0
- data/lib/plaid/models/cra_check_report_create_response.rb +221 -0
- data/lib/plaid/models/cra_check_report_failed_webhook.rb +292 -0
- data/lib/plaid/models/cra_check_report_income_insights_get_request.rb +246 -0
- data/lib/plaid/models/cra_check_report_income_insights_get_response.rb +235 -0
- data/lib/plaid/models/cra_check_report_network_attributes_get_request.rb +246 -0
- data/lib/plaid/models/cra_check_report_network_attributes_get_response.rb +240 -0
- data/lib/plaid/models/cra_check_report_partner_insights_get_options.rb +223 -0
- data/lib/plaid/models/cra_check_report_partner_insights_get_request.rb +256 -0
- data/lib/plaid/models/cra_check_report_partner_insights_get_response.rb +235 -0
- data/lib/plaid/models/cra_check_report_pdf_get_request.rb +258 -0
- data/lib/plaid/models/cra_check_report_product.rb +41 -0
- data/lib/plaid/models/cra_check_report_ready_webhook.rb +305 -0
- data/lib/plaid/models/cra_income_insights.rb +274 -0
- 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_network_attributes_item.rb +256 -0
- data/lib/plaid/models/cra_network_attributes_report.rb +273 -0
- data/lib/plaid/models/cra_partner_insights.rb +3 -3
- 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 +6 -1
- 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 +12 -2
- data/lib/plaid/models/cra_partner_insights_prism.rb +3 -3
- data/lib/plaid/models/cra_pdf_add_ons.rb +38 -0
- data/lib/plaid/models/cra_prediction_interval.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 +2 -2
- data/lib/plaid/models/credit_bank_employer.rb +1 -1
- data/lib/plaid/models/credit_bank_employment.rb +1 -1
- data/lib/plaid/models/credit_bank_employment_get_request.rb +1 -1
- data/lib/plaid/models/credit_bank_employment_get_response.rb +1 -1
- data/lib/plaid/models/credit_bank_employment_item.rb +1 -1
- data/lib/plaid/models/credit_bank_employment_report.rb +1 -1
- data/lib/plaid/models/credit_bank_employment_warning.rb +1 -1
- data/lib/plaid/models/credit_bank_employment_warning_type.rb +1 -1
- data/lib/plaid/models/credit_bank_income.rb +1 -1
- data/lib/plaid/models/credit_bank_income_account.rb +1 -1
- data/lib/plaid/models/credit_bank_income_account_type.rb +1 -1
- data/lib/plaid/models/credit_bank_income_category.rb +1 -1
- data/lib/plaid/models/credit_bank_income_cause.rb +1 -1
- data/lib/plaid/models/credit_bank_income_error_type.rb +1 -1
- data/lib/plaid/models/credit_bank_income_get_request.rb +1 -1
- data/lib/plaid/models/credit_bank_income_get_request_options.rb +1 -1
- data/lib/plaid/models/credit_bank_income_get_response.rb +1 -1
- data/lib/plaid/models/credit_bank_income_historical_summary.rb +1 -1
- data/lib/plaid/models/credit_bank_income_item.rb +1 -1
- data/lib/plaid/models/credit_bank_income_pay_frequency.rb +1 -1
- data/lib/plaid/models/credit_bank_income_pdf_get_request.rb +1 -1
- data/lib/plaid/models/credit_bank_income_refresh_request.rb +1 -1
- data/lib/plaid/models/credit_bank_income_refresh_request_options.rb +1 -1
- data/lib/plaid/models/credit_bank_income_refresh_response.rb +1 -1
- data/lib/plaid/models/credit_bank_income_source.rb +1 -1
- data/lib/plaid/models/credit_bank_income_summary.rb +1 -1
- data/lib/plaid/models/credit_bank_income_transaction.rb +1 -1
- data/lib/plaid/models/credit_bank_income_warning.rb +1 -1
- data/lib/plaid/models/credit_bank_income_warning_code.rb +1 -1
- data/lib/plaid/models/credit_bank_income_warning_type.rb +1 -1
- data/lib/plaid/models/credit_bank_income_webhook_update_request.rb +1 -1
- data/lib/plaid/models/credit_bank_income_webhook_update_response.rb +1 -1
- data/lib/plaid/models/credit_bank_statement_upload_account_owner.rb +1 -1
- data/lib/plaid/models/credit_bank_statement_upload_account_owner_address.rb +1 -1
- data/lib/plaid/models/credit_bank_statement_upload_bank_account.rb +1 -1
- data/lib/plaid/models/credit_bank_statement_upload_bank_account_period.rb +1 -1
- data/lib/plaid/models/credit_bank_statement_upload_item.rb +1 -1
- data/lib/plaid/models/credit_bank_statement_upload_object.rb +1 -1
- data/lib/plaid/models/credit_bank_statement_upload_transaction.rb +1 -1
- data/lib/plaid/models/credit_bank_statements_uploads_get_request.rb +1 -1
- data/lib/plaid/models/credit_bank_statements_uploads_get_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 +18 -7
- data/lib/plaid/models/credit_employer_verification.rb +1 -1
- data/lib/plaid/models/credit_employment_get_request.rb +1 -1
- data/lib/plaid/models/credit_employment_get_response.rb +1 -1
- data/lib/plaid/models/credit_employment_item.rb +1 -1
- data/lib/plaid/models/credit_employment_verification.rb +1 -1
- data/lib/plaid/models/credit_filter.rb +1 -1
- data/lib/plaid/models/credit_freddie_mac_asset.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 +1 -1
- 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 +1 -1
- data/lib/plaid/models/credit_payroll_income_parsing_config_update_response.rb +1 -1
- data/lib/plaid/models/credit_payroll_income_precheck_request.rb +1 -1
- data/lib/plaid/models/credit_payroll_income_precheck_response.rb +1 -1
- data/lib/plaid/models/credit_payroll_income_refresh_request.rb +1 -1
- data/lib/plaid/models/credit_payroll_income_refresh_request_options.rb +1 -1
- data/lib/plaid/models/credit_payroll_income_refresh_response.rb +1 -1
- data/lib/plaid/models/credit_payroll_income_risk_signals_get_request.rb +1 -1
- data/lib/plaid/models/credit_payroll_income_risk_signals_get_response.rb +1 -1
- data/lib/plaid/models/credit_platform_ids.rb +1 -1
- data/lib/plaid/models/credit_relay_create_request.rb +1 -1
- data/lib/plaid/models/credit_relay_create_response.rb +1 -1
- data/lib/plaid/models/credit_relay_get_request.rb +1 -1
- data/lib/plaid/models/credit_relay_pdf_get_request.rb +1 -1
- data/lib/plaid/models/credit_relay_refresh_request.rb +1 -1
- data/lib/plaid/models/credit_relay_refresh_response.rb +1 -1
- data/lib/plaid/models/credit_relay_remove_request.rb +1 -1
- data/lib/plaid/models/credit_relay_remove_response.rb +1 -1
- data/lib/plaid/models/credit_session.rb +1 -1
- data/lib/plaid/models/credit_session_bank_employment_result.rb +1 -1
- data/lib/plaid/models/credit_session_bank_employment_status.rb +1 -1
- data/lib/plaid/models/credit_session_bank_income_result.rb +1 -1
- data/lib/plaid/models/credit_session_bank_income_status.rb +1 -1
- data/lib/plaid/models/credit_session_document_income_result.rb +1 -1
- data/lib/plaid/models/credit_session_error.rb +1 -1
- data/lib/plaid/models/credit_session_item_add_result.rb +1 -1
- data/lib/plaid/models/credit_session_payroll_income_result.rb +1 -1
- data/lib/plaid/models/credit_session_results.rb +1 -1
- data/lib/plaid/models/credit_sessions_get_request.rb +1 -1
- data/lib/plaid/models/credit_sessions_get_response.rb +1 -1
- data/lib/plaid/models/credit_w2.rb +1 -1
- data/lib/plaid/models/customer_initiated_return_risk.rb +1 -1
- data/lib/plaid/models/dashboard_user.rb +1 -1
- data/lib/plaid/models/dashboard_user_get_request.rb +1 -1
- data/lib/plaid/models/dashboard_user_get_response.rb +1 -1
- data/lib/plaid/models/dashboard_user_list_request.rb +1 -1
- data/lib/plaid/models/dashboard_user_list_response.rb +1 -1
- data/lib/plaid/models/dashboard_user_status.rb +1 -1
- data/lib/plaid/models/date_range.rb +1 -1
- data/lib/plaid/models/deductions.rb +1 -1
- data/lib/plaid/models/deductions_breakdown.rb +1 -1
- data/lib/plaid/models/deductions_total.rb +1 -1
- data/lib/plaid/models/default_update_webhook.rb +1 -1
- data/lib/plaid/models/deposit_switch_address_data.rb +1 -1
- data/lib/plaid/models/deposit_switch_alt_create_request.rb +1 -1
- data/lib/plaid/models/deposit_switch_alt_create_response.rb +1 -1
- data/lib/plaid/models/deposit_switch_create_request.rb +1 -1
- data/lib/plaid/models/deposit_switch_create_request_options.rb +1 -1
- data/lib/plaid/models/deposit_switch_create_response.rb +1 -1
- data/lib/plaid/models/deposit_switch_get_request.rb +1 -1
- data/lib/plaid/models/deposit_switch_get_response.rb +1 -1
- data/lib/plaid/models/deposit_switch_state_update_webhook.rb +1 -1
- data/lib/plaid/models/deposit_switch_target_account.rb +1 -1
- data/lib/plaid/models/deposit_switch_target_user.rb +1 -1
- data/lib/plaid/models/deposit_switch_token_create_request.rb +1 -1
- data/lib/plaid/models/deposit_switch_token_create_response.rb +1 -1
- data/lib/plaid/models/depository_account_subtype.rb +1 -1
- data/lib/plaid/models/depository_filter.rb +1 -1
- data/lib/plaid/models/detailed_originator.rb +1 -1
- data/lib/plaid/models/detected_account.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 -22
- 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 +12 -12
- data/lib/plaid/models/entity_watchlist_code.rb +1 -1
- data/lib/plaid/models/entity_watchlist_program.rb +1 -22
- data/lib/plaid/models/entity_watchlist_screening.rb +1 -18
- data/lib/plaid/models/entity_watchlist_screening_hit.rb +1 -18
- data/lib/plaid/models/entity_watchlist_screening_review.rb +1 -18
- data/lib/plaid/models/entity_watchlist_screening_search_terms.rb +1 -56
- data/lib/plaid/models/entity_watchlist_search_terms.rb +1 -56
- data/lib/plaid/models/expiration_date.rb +1 -1
- data/lib/plaid/models/external_payment_initiation_consent_options.rb +1 -1
- data/lib/plaid/models/external_payment_options.rb +1 -1
- data/lib/plaid/models/external_payment_refund_details.rb +1 -1
- data/lib/plaid/models/external_payment_schedule_base.rb +1 -1
- data/lib/plaid/models/external_payment_schedule_get.rb +1 -1
- data/lib/plaid/models/external_payment_schedule_request.rb +1 -1
- data/lib/plaid/models/fallback_auth_microdeposit_auto_verified_webhook.rb +1 -1
- data/lib/plaid/models/fallback_auth_microdeposit_verification_expired_webhook.rb +1 -1
- data/lib/plaid/models/fdx_content_types.rb +1 -1
- data/lib/plaid/models/fdx_hateoas_link.rb +1 -1
- data/lib/plaid/models/fdx_hateoas_link_action.rb +1 -1
- data/lib/plaid/models/fdx_initiator_fi_attribute.rb +1 -1
- data/lib/plaid/models/fdx_notification.rb +1 -1
- data/lib/plaid/models/fdx_notification_category.rb +1 -1
- data/lib/plaid/models/fdx_notification_payload.rb +1 -1
- data/lib/plaid/models/fdx_notification_payload_id_type.rb +1 -1
- data/lib/plaid/models/fdx_notification_priority.rb +1 -1
- data/lib/plaid/models/fdx_notification_severity.rb +1 -1
- data/lib/plaid/models/fdx_notification_type.rb +1 -1
- data/lib/plaid/models/fdx_party.rb +1 -1
- data/lib/plaid/models/fdx_party_registry.rb +1 -1
- data/lib/plaid/models/fdx_party_type.rb +1 -1
- data/lib/plaid/models/fdxfi_attribute.rb +1 -1
- data/lib/plaid/models/financial_institution_insights.rb +1 -1
- data/lib/plaid/models/form1099_type.rb +1 -1
- data/lib/plaid/models/fraud_amount.rb +1 -1
- data/lib/plaid/models/generic_screening_hit_location_items.rb +1 -1
- data/lib/plaid/models/health_incident.rb +1 -1
- data/lib/plaid/models/historical_balance.rb +1 -1
- data/lib/plaid/models/historical_update_webhook.rb +1 -1
- data/lib/plaid/models/holding.rb +1 -1
- data/lib/plaid/models/holdings_default_update_webhook.rb +1 -1
- data/lib/plaid/models/holdings_override.rb +1 -1
- data/lib/plaid/models/hosted_link_delivery_method.rb +1 -1
- data/lib/plaid/models/hosted_mmd_verification_webhook.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 +1 -22
- data/lib/plaid/models/identity_verification_autofill_address.rb +1 -22
- data/lib/plaid/models/identity_verification_autofill_create_request.rb +1 -1
- data/lib/plaid/models/identity_verification_autofill_create_response.rb +1 -1
- data/lib/plaid/models/identity_verification_autofill_status.rb +1 -1
- data/lib/plaid/models/identity_verification_autofill_user_data.rb +1 -1
- data/lib/plaid/models/identity_verification_create_request.rb +1 -18
- data/lib/plaid/models/identity_verification_create_request_user.rb +1 -18
- data/lib/plaid/models/identity_verification_create_response.rb +1 -22
- data/lib/plaid/models/identity_verification_document_address_response.rb +1 -22
- data/lib/plaid/models/identity_verification_get_request.rb +1 -1
- data/lib/plaid/models/identity_verification_get_response.rb +1 -22
- data/lib/plaid/models/identity_verification_list_request.rb +1 -22
- 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 -22
- data/lib/plaid/models/identity_verification_retry_request_steps_object.rb +1 -1
- data/lib/plaid/models/identity_verification_retry_response.rb +1 -22
- data/lib/plaid/models/identity_verification_status.rb +1 -1
- data/lib/plaid/models/identity_verification_status_updated_webhook.rb +1 -1
- data/lib/plaid/models/identity_verification_step_status.rb +1 -1
- data/lib/plaid/models/identity_verification_step_summary.rb +1 -1
- data/lib/plaid/models/identity_verification_step_updated_webhook.rb +1 -1
- data/lib/plaid/models/identity_verification_template_reference.rb +1 -1
- data/lib/plaid/models/identity_verification_user_address.rb +1 -22
- data/lib/plaid/models/identity_verification_user_data.rb +1 -1
- data/lib/plaid/models/image_quality.rb +1 -1
- data/lib/plaid/models/incident_update.rb +1 -1
- data/lib/plaid/models/income_breakdown.rb +1 -1
- data/lib/plaid/models/income_breakdown_type.rb +1 -1
- data/lib/plaid/models/income_override.rb +1 -1
- data/lib/plaid/models/income_summary.rb +1 -1
- data/lib/plaid/models/income_summary_field_number.rb +1 -1
- data/lib/plaid/models/income_summary_field_string.rb +1 -1
- data/lib/plaid/models/income_verification_create_request.rb +1 -1
- data/lib/plaid/models/income_verification_create_request_options.rb +1 -1
- data/lib/plaid/models/income_verification_create_response.rb +1 -1
- data/lib/plaid/models/income_verification_doc_parsing_config.rb +1 -1
- data/lib/plaid/models/income_verification_documents_download_request.rb +1 -1
- data/lib/plaid/models/income_verification_payroll_flow_type.rb +1 -1
- data/lib/plaid/models/income_verification_paystubs_get_request.rb +1 -1
- data/lib/plaid/models/income_verification_paystubs_get_response.rb +1 -1
- data/lib/plaid/models/income_verification_precheck_confidence.rb +1 -1
- data/lib/plaid/models/income_verification_precheck_employer.rb +1 -1
- data/lib/plaid/models/income_verification_precheck_employer_address.rb +1 -1
- data/lib/plaid/models/income_verification_precheck_employer_address_data.rb +1 -1
- data/lib/plaid/models/income_verification_precheck_military_info.rb +1 -1
- data/lib/plaid/models/income_verification_precheck_payroll_institution.rb +1 -1
- data/lib/plaid/models/income_verification_precheck_request.rb +1 -1
- data/lib/plaid/models/income_verification_precheck_response.rb +1 -1
- data/lib/plaid/models/income_verification_precheck_user.rb +1 -1
- data/lib/plaid/models/income_verification_refresh_reconnect_needed_webhook.rb +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 -22
- data/lib/plaid/models/inflow_model.rb +1 -1
- data/lib/plaid/models/initial_update_webhook.rb +1 -1
- data/lib/plaid/models/institution.rb +1 -1
- data/lib/plaid/models/institution_status.rb +1 -1
- data/lib/plaid/models/institution_status_alert_webhook.rb +1 -1
- data/lib/plaid/models/institution_supported_networks.rb +1 -1
- data/lib/plaid/models/institutions_get_by_id_request.rb +1 -1
- data/lib/plaid/models/institutions_get_by_id_request_options.rb +1 -1
- data/lib/plaid/models/institutions_get_by_id_response.rb +1 -1
- data/lib/plaid/models/institutions_get_request.rb +1 -1
- data/lib/plaid/models/institutions_get_request_options.rb +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 +1 -1
- data/lib/plaid/models/institutions_search_request_options.rb +1 -1
- data/lib/plaid/models/institutions_search_response.rb +1 -1
- data/lib/plaid/models/investment_account_subtype.rb +1 -1
- data/lib/plaid/models/investment_filter.rb +1 -1
- data/lib/plaid/models/investment_holdings_get_request_options.rb +1 -1
- data/lib/plaid/models/investment_transaction.rb +1 -1
- data/lib/plaid/models/investment_transaction_subtype.rb +1 -1
- data/lib/plaid/models/investment_transaction_type.rb +1 -1
- data/lib/plaid/models/investments_auth_get_numbers.rb +1 -1
- data/lib/plaid/models/investments_auth_get_request.rb +1 -1
- data/lib/plaid/models/investments_auth_get_request_options.rb +1 -1
- data/lib/plaid/models/investments_auth_get_response.rb +1 -1
- data/lib/plaid/models/investments_auth_owner.rb +1 -1
- data/lib/plaid/models/investments_default_update_webhook.rb +1 -1
- data/lib/plaid/models/investments_historical_update_webhook.rb +1 -1
- data/lib/plaid/models/investments_holdings_get_request.rb +1 -1
- data/lib/plaid/models/investments_holdings_get_response.rb +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/issuing_country.rb +1 -1
- data/lib/plaid/models/item.rb +2 -2
- data/lib/plaid/models/item_access_token_invalidate_request.rb +1 -1
- data/lib/plaid/models/item_access_token_invalidate_response.rb +1 -1
- data/lib/plaid/models/item_activity_list_request.rb +1 -1
- data/lib/plaid/models/item_activity_list_response.rb +1 -1
- data/lib/plaid/models/item_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_error_webhook.rb +1 -1
- data/lib/plaid/models/item_get_request.rb +1 -1
- data/lib/plaid/models/item_get_response.rb +1 -1
- data/lib/plaid/models/item_import_request.rb +1 -1
- data/lib/plaid/models/item_import_request_options.rb +1 -1
- data/lib/plaid/models/item_import_request_user_auth.rb +1 -1
- data/lib/plaid/models/item_import_response.rb +1 -1
- data/lib/plaid/models/item_login_repaired_webhook.rb +1 -1
- data/lib/plaid/models/item_product_ready_webhook.rb +1 -1
- data/lib/plaid/models/item_public_token_create_request.rb +1 -1
- data/lib/plaid/models/item_public_token_create_response.rb +1 -1
- data/lib/plaid/models/item_public_token_exchange_request.rb +1 -1
- data/lib/plaid/models/item_public_token_exchange_response.rb +1 -1
- data/lib/plaid/models/item_remove_request.rb +1 -1
- data/lib/plaid/models/item_remove_response.rb +1 -1
- data/lib/plaid/models/item_status.rb +1 -1
- data/lib/plaid/models/item_status_investments.rb +1 -1
- data/lib/plaid/models/item_status_last_webhook.rb +1 -1
- data/lib/plaid/models/item_status_nullable.rb +1 -1
- data/lib/plaid/models/item_status_transactions.rb +1 -1
- data/lib/plaid/models/item_webhook_update_request.rb +1 -1
- data/lib/plaid/models/item_webhook_update_response.rb +1 -1
- data/lib/plaid/models/jwk_public_key.rb +1 -1
- data/lib/plaid/models/jwt_header.rb +1 -1
- data/lib/plaid/models/kyc_check_address_summary.rb +1 -1
- data/lib/plaid/models/kyc_check_date_of_birth_summary.rb +1 -1
- data/lib/plaid/models/kyc_check_details.rb +1 -1
- data/lib/plaid/models/kyc_check_id_number_summary.rb +1 -1
- data/lib/plaid/models/kyc_check_name_summary.rb +1 -1
- data/lib/plaid/models/kyc_check_phone_summary.rb +1 -1
- data/lib/plaid/models/last_data_access_times.rb +1 -1
- data/lib/plaid/models/liabilities_default_update_webhook.rb +1 -1
- data/lib/plaid/models/liabilities_get_request.rb +1 -1
- data/lib/plaid/models/liabilities_get_request_options.rb +1 -1
- data/lib/plaid/models/liabilities_get_response.rb +1 -1
- data/lib/plaid/models/liabilities_object.rb +1 -1
- data/lib/plaid/models/liability_override.rb +2 -2
- 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 +2 -2
- data/lib/plaid/models/link_event_name.rb +1 -1
- data/lib/plaid/models/link_events_webhook.rb +5 -5
- 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_profile_eligibility_check_request.rb +1 -1
- data/lib/plaid/models/link_profile_eligibility_check_response.rb +1 -1
- data/lib/plaid/models/link_profile_eligibility_check_user.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_exit.rb +1 -1
- data/lib/plaid/models/link_session_exit_deprecated.rb +1 -1
- data/lib/plaid/models/link_session_exit_metadata.rb +1 -1
- data/lib/plaid/models/link_session_exit_metadata_institution.rb +1 -1
- data/lib/plaid/models/link_session_finished_webhook.rb +3 -3
- data/lib/plaid/models/link_session_item_add_result.rb +1 -1
- data/lib/plaid/models/link_session_payroll_income_result.rb +1 -1
- data/lib/plaid/models/link_session_results.rb +1 -1
- data/lib/plaid/models/link_session_success.rb +1 -1
- data/lib/plaid/models/link_session_success_metadata.rb +1 -1
- data/lib/plaid/models/link_session_success_metadata_account.rb +1 -1
- data/lib/plaid/models/link_session_success_metadata_institution.rb +1 -1
- data/lib/plaid/models/link_session_success_metadata_transfer_status.rb +1 -1
- data/lib/plaid/models/link_token_account_filters.rb +1 -1
- data/lib/plaid/models/link_token_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 +17 -5
- data/lib/plaid/models/link_token_create_institution_data.rb +1 -1
- data/lib/plaid/models/link_token_create_investment_filter.rb +1 -1
- data/lib/plaid/models/link_token_create_loan_filter.rb +1 -1
- data/lib/plaid/models/link_token_create_request.rb +15 -6
- data/lib/plaid/models/link_token_create_request_account_subtypes.rb +1 -1
- data/lib/plaid/models/link_token_create_request_auth.rb +1 -1
- data/lib/plaid/models/link_token_create_request_base_report.rb +1 -1
- data/lib/plaid/models/link_token_create_request_cra_options.rb +274 -0
- data/lib/plaid/models/link_token_create_request_cra_options_base_report.rb +222 -0
- data/lib/plaid/models/link_token_create_request_cra_options_partner_insights.rb +223 -0
- data/lib/plaid/models/link_token_create_request_credit_partner_insights.rb +2 -2
- data/lib/plaid/models/link_token_create_request_deposit_switch.rb +1 -1
- data/lib/plaid/models/link_token_create_request_employment.rb +1 -1
- data/lib/plaid/models/link_token_create_request_employment_bank_income.rb +1 -1
- data/lib/plaid/models/link_token_create_request_identity_verification.rb +1 -1
- data/lib/plaid/models/link_token_create_request_income_verification.rb +1 -1
- data/lib/plaid/models/link_token_create_request_income_verification_bank_income.rb +1 -1
- data/lib/plaid/models/link_token_create_request_income_verification_payroll_income.rb +1 -1
- data/lib/plaid/models/link_token_create_request_payment_initiation.rb +1 -1
- data/lib/plaid/models/link_token_create_request_statements.rb +1 -1
- data/lib/plaid/models/link_token_create_request_transfer.rb +12 -2
- data/lib/plaid/models/link_token_create_request_update.rb +18 -6
- data/lib/plaid/models/link_token_create_request_user.rb +2 -2
- data/lib/plaid/models/link_token_create_request_user_address.rb +1 -22
- data/lib/plaid/models/link_token_create_request_user_id_number.rb +1 -1
- data/lib/plaid/models/link_token_create_request_user_name.rb +1 -1
- data/lib/plaid/models/link_token_create_request_user_stated_income_source.rb +1 -1
- data/lib/plaid/models/link_token_create_response.rb +1 -1
- data/lib/plaid/models/link_token_eu_config.rb +1 -1
- data/lib/plaid/models/link_token_get_metadata_response.rb +1 -1
- data/lib/plaid/models/link_token_get_request.rb +1 -1
- data/lib/plaid/models/link_token_get_response.rb +2 -2
- data/lib/plaid/models/link_token_get_sessions_response.rb +1 -1
- data/lib/plaid/models/link_token_investments.rb +1 -1
- data/lib/plaid/models/link_token_investments_auth.rb +1 -1
- data/lib/plaid/models/link_token_transactions.rb +1 -1
- data/lib/plaid/models/link_user_delivery_status_webhook.rb +1 -1
- data/lib/plaid/models/loan.rb +1 -1
- data/lib/plaid/models/loan_account_subtype.rb +1 -1
- data/lib/plaid/models/loan_filter.rb +1 -1
- data/lib/plaid/models/loan_identifier.rb +1 -1
- data/lib/plaid/models/loan_identifier_type.rb +1 -1
- data/lib/plaid/models/loan_identifiers.rb +1 -1
- data/lib/plaid/models/loans.rb +1 -1
- data/lib/plaid/models/location.rb +1 -1
- data/lib/plaid/models/match_summary.rb +1 -1
- data/lib/plaid/models/match_summary_code.rb +1 -1
- data/lib/plaid/models/merchant_insights.rb +1 -1
- data/lib/plaid/models/meta.rb +1 -1
- data/lib/plaid/models/mfa.rb +1 -1
- data/lib/plaid/models/mortgage_interest_rate.rb +1 -1
- data/lib/plaid/models/mortgage_liability.rb +1 -1
- data/lib/plaid/models/mortgage_property_address.rb +1 -1
- data/lib/plaid/models/multi_document_risk_signal.rb +1 -1
- data/lib/plaid/models/name_match_score.rb +1 -1
- data/lib/plaid/models/net_pay.rb +1 -1
- data/lib/plaid/models/new_accounts_available_webhook.rb +2 -2
- data/lib/plaid/models/numbers.rb +2 -2
- 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/omittable_transfer_type.rb +1 -1
- data/lib/plaid/models/option_contract.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/override_account_type.rb +1 -1
- data/lib/plaid/models/override_accounts.rb +1 -1
- data/lib/plaid/models/owner.rb +5 -16
- 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_billing_contact.rb +1 -1
- data/lib/plaid/models/partner_end_customer_customer_support_info.rb +1 -1
- data/lib/plaid/models/partner_end_customer_flowdown_status.rb +1 -1
- data/lib/plaid/models/partner_end_customer_o_auth_institution.rb +1 -1
- data/lib/plaid/models/partner_end_customer_o_auth_institution_application_status.rb +1 -1
- data/lib/plaid/models/partner_end_customer_o_auth_institution_environments.rb +1 -1
- data/lib/plaid/models/partner_end_customer_o_auth_status_updated_values.rb +1 -1
- data/lib/plaid/models/partner_end_customer_o_auth_status_updated_webhook.rb +1 -1
- data/lib/plaid/models/partner_end_customer_questionnaire_status.rb +1 -1
- data/lib/plaid/models/partner_end_customer_secrets.rb +17 -7
- data/lib/plaid/models/partner_end_customer_status.rb +1 -1
- data/lib/plaid/models/partner_end_customer_technical_contact.rb +1 -1
- data/lib/plaid/models/partner_end_customer_with_secrets.rb +2 -2
- 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_payment_execute_request.rb +2 -2
- data/lib/plaid/models/payment_initiation_consent_payment_execute_response.rb +1 -1
- data/lib/plaid/models/payment_initiation_consent_revoke_request.rb +1 -1
- data/lib/plaid/models/payment_initiation_consent_revoke_response.rb +1 -1
- data/lib/plaid/models/payment_initiation_consent_scope.rb +1 -1
- data/lib/plaid/models/payment_initiation_consent_status.rb +1 -1
- data/lib/plaid/models/payment_initiation_metadata.rb +1 -1
- data/lib/plaid/models/payment_initiation_optional_restriction_bacs.rb +1 -1
- data/lib/plaid/models/payment_initiation_payment.rb +1 -1
- data/lib/plaid/models/payment_initiation_payment_create_request.rb +1 -1
- data/lib/plaid/models/payment_initiation_payment_create_response.rb +1 -1
- data/lib/plaid/models/payment_initiation_payment_create_status.rb +1 -1
- data/lib/plaid/models/payment_initiation_payment_get_request.rb +1 -1
- data/lib/plaid/models/payment_initiation_payment_get_response.rb +1 -1
- data/lib/plaid/models/payment_initiation_payment_list_request.rb +1 -1
- data/lib/plaid/models/payment_initiation_payment_list_response.rb +1 -1
- data/lib/plaid/models/payment_initiation_payment_reverse_request.rb +1 -1
- data/lib/plaid/models/payment_initiation_payment_reverse_response.rb +1 -1
- data/lib/plaid/models/payment_initiation_payment_status.rb +1 -1
- data/lib/plaid/models/payment_initiation_payment_token_create_request.rb +1 -1
- data/lib/plaid/models/payment_initiation_payment_token_create_response.rb +1 -1
- data/lib/plaid/models/payment_initiation_recipient.rb +1 -1
- data/lib/plaid/models/payment_initiation_recipient_create_request.rb +1 -1
- data/lib/plaid/models/payment_initiation_recipient_create_response.rb +1 -1
- data/lib/plaid/models/payment_initiation_recipient_get_request.rb +1 -1
- data/lib/plaid/models/payment_initiation_recipient_get_response.rb +1 -1
- data/lib/plaid/models/payment_initiation_recipient_get_response_all_of.rb +1 -1
- data/lib/plaid/models/payment_initiation_recipient_list_request.rb +1 -1
- data/lib/plaid/models/payment_initiation_recipient_list_response.rb +1 -1
- data/lib/plaid/models/payment_initiation_standing_order_metadata.rb +1 -1
- data/lib/plaid/models/payment_meta.rb +1 -1
- data/lib/plaid/models/payment_profile_create_request.rb +1 -1
- data/lib/plaid/models/payment_profile_create_response.rb +1 -1
- data/lib/plaid/models/payment_profile_get_request.rb +1 -1
- data/lib/plaid/models/payment_profile_get_response.rb +1 -1
- data/lib/plaid/models/payment_profile_remove_request.rb +1 -1
- data/lib/plaid/models/payment_profile_remove_response.rb +1 -1
- data/lib/plaid/models/payment_profile_status.rb +1 -1
- data/lib/plaid/models/payment_schedule_interval.rb +1 -1
- data/lib/plaid/models/payment_scheme.rb +1 -1
- data/lib/plaid/models/payment_status_update_webhook.rb +1 -1
- data/lib/plaid/models/payroll_income_account_data.rb +1 -1
- data/lib/plaid/models/payroll_income_object.rb +1 -1
- data/lib/plaid/models/payroll_income_rate_of_pay.rb +1 -1
- data/lib/plaid/models/payroll_item.rb +1 -1
- data/lib/plaid/models/payroll_item_status.rb +1 -1
- data/lib/plaid/models/payroll_risk_signals_item.rb +1 -1
- data/lib/plaid/models/paystub.rb +1 -1
- data/lib/plaid/models/paystub_address.rb +1 -1
- data/lib/plaid/models/paystub_deduction.rb +1 -1
- data/lib/plaid/models/paystub_details.rb +1 -1
- data/lib/plaid/models/paystub_employer.rb +1 -1
- data/lib/plaid/models/paystub_override.rb +1 -1
- data/lib/plaid/models/paystub_override_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_expiration_webhook.rb +1 -1
- data/lib/plaid/models/personal_finance_category.rb +1 -1
- data/lib/plaid/models/phone_number.rb +1 -1
- data/lib/plaid/models/phone_number_match_score.rb +1 -1
- data/lib/plaid/models/phone_type.rb +1 -1
- data/lib/plaid/models/physical_document_category.rb +1 -1
- data/lib/plaid/models/physical_document_extracted_data.rb +1 -22
- data/lib/plaid/models/physical_document_extracted_data_analysis.rb +1 -1
- data/lib/plaid/models/physical_document_images.rb +1 -1
- data/lib/plaid/models/plaid_error.rb +1 -1
- data/lib/plaid/models/plaid_error_type.rb +1 -1
- data/lib/plaid/models/platform_ids.rb +1 -1
- data/lib/plaid/models/po_box_status.rb +1 -1
- data/lib/plaid/models/prism_cash_score.rb +4 -4
- data/lib/plaid/models/prism_cash_score_metadata.rb +1 -1
- data/lib/plaid/models/prism_first_detect.rb +5 -5
- data/lib/plaid/models/prism_insights.rb +3 -3
- data/lib/plaid/models/prism_product.rb +2 -2
- 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_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 +1 -1
- data/lib/plaid/models/processor_signal_evaluate_response.rb +1 -1
- data/lib/plaid/models/processor_signal_prepare_request.rb +1 -1
- data/lib/plaid/models/processor_signal_prepare_response.rb +1 -1
- data/lib/plaid/models/processor_signal_return_report_request.rb +1 -1
- data/lib/plaid/models/processor_signal_return_report_response.rb +1 -1
- data/lib/plaid/models/processor_stripe_bank_account_token_create_request.rb +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 +1 -1
- data/lib/plaid/models/processor_transactions_refresh_request.rb +1 -1
- data/lib/plaid/models/processor_transactions_refresh_response.rb +1 -1
- data/lib/plaid/models/processor_transactions_removed_webhook.rb +1 -1
- data/lib/plaid/models/processor_transactions_sync_request.rb +1 -1
- data/lib/plaid/models/processor_transactions_sync_response.rb +1 -1
- data/lib/plaid/models/product_access.rb +1 -1
- data/lib/plaid/models/product_permissions_required_auth_webhook.rb +1 -1
- data/lib/plaid/models/product_permissions_required_identity_webhook.rb +1 -1
- data/lib/plaid/models/product_status.rb +1 -1
- data/lib/plaid/models/product_status_breakdown.rb +1 -1
- data/lib/plaid/models/products.rb +7 -1
- data/lib/plaid/models/profile_get_request.rb +1 -11
- data/lib/plaid/models/profile_get_response.rb +1 -1
- data/lib/plaid/models/profile_identity.rb +1 -1
- data/lib/plaid/models/profile_identity_address.rb +1 -1
- data/lib/plaid/models/profile_identity_name.rb +1 -1
- data/lib/plaid/models/profile_item.rb +1 -1
- data/lib/plaid/models/program_name_sensitivity.rb +1 -1
- data/lib/plaid/models/projected_income_summary_field_number.rb +1 -1
- data/lib/plaid/models/proxy_type.rb +1 -1
- data/lib/plaid/models/pslf_status.rb +1 -1
- data/lib/plaid/models/recaptcha_required_error.rb +1 -1
- data/lib/plaid/models/recipient_bacs.rb +1 -1
- data/lib/plaid/models/recipient_bacs_nullable.rb +1 -1
- data/lib/plaid/models/recurrence.rb +1 -1
- data/lib/plaid/models/recurring_cancelled_webhook.rb +1 -1
- data/lib/plaid/models/recurring_frequency.rb +1 -1
- data/lib/plaid/models/recurring_insights_stream.rb +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/removed_transaction.rb +1 -1
- data/lib/plaid/models/report_type.rb +1 -1
- data/lib/plaid/models/reporting_information.rb +1 -1
- data/lib/plaid/models/risk_check_behavior.rb +1 -1
- data/lib/plaid/models/risk_check_behavior_bot_detected_label.rb +1 -1
- data/lib/plaid/models/risk_check_behavior_fraud_ring_detected_label.rb +1 -1
- data/lib/plaid/models/risk_check_behavior_user_interactions_label.rb +1 -1
- data/lib/plaid/models/risk_check_details.rb +1 -1
- data/lib/plaid/models/risk_check_device.rb +1 -1
- data/lib/plaid/models/risk_check_email.rb +1 -1
- data/lib/plaid/models/risk_check_email_domain_is_custom.rb +1 -1
- data/lib/plaid/models/risk_check_email_domain_is_disposable.rb +1 -1
- data/lib/plaid/models/risk_check_email_domain_is_free_provider.rb +1 -1
- data/lib/plaid/models/risk_check_email_is_deliverable_status.rb +1 -1
- data/lib/plaid/models/risk_check_email_top_level_domain_is_suspicious.rb +1 -1
- data/lib/plaid/models/risk_check_identity_abuse_signals.rb +1 -1
- data/lib/plaid/models/risk_check_linked_service.rb +1 -1
- data/lib/plaid/models/risk_check_phone.rb +1 -1
- data/lib/plaid/models/risk_check_stolen_identity.rb +1 -1
- data/lib/plaid/models/risk_check_synthetic_identity.rb +1 -1
- data/lib/plaid/models/risk_profile.rb +2 -2
- data/lib/plaid/models/risk_reason.rb +13 -3
- data/lib/plaid/models/risk_signal_document_reference.rb +15 -5
- data/lib/plaid/models/risk_signal_document_status.rb +1 -1
- data/lib/plaid/models/risk_signal_document_type.rb +49 -0
- 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/ruleset.rb +231 -0
- data/lib/plaid/models/sandbox_bank_income_fire_webhook_request.rb +1 -1
- data/lib/plaid/models/sandbox_bank_income_fire_webhook_response.rb +1 -1
- data/lib/plaid/models/sandbox_bank_income_webhook_fire_request_webhook_code.rb +1 -1
- data/lib/plaid/models/sandbox_bank_income_webhook_fire_request_webhook_fields.rb +1 -1
- data/lib/plaid/models/sandbox_bank_transfer_fire_webhook_request.rb +1 -1
- data/lib/plaid/models/sandbox_bank_transfer_fire_webhook_response.rb +1 -1
- data/lib/plaid/models/sandbox_bank_transfer_simulate_request.rb +1 -1
- data/lib/plaid/models/sandbox_bank_transfer_simulate_response.rb +1 -1
- data/lib/plaid/models/sandbox_income_fire_webhook_request.rb +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 +3 -3
- data/lib/plaid/models/sandbox_item_fire_webhook_response.rb +1 -1
- data/lib/plaid/models/sandbox_item_reset_login_request.rb +1 -1
- data/lib/plaid/models/sandbox_item_reset_login_response.rb +1 -1
- data/lib/plaid/models/sandbox_item_set_verification_status_request.rb +1 -1
- data/lib/plaid/models/sandbox_item_set_verification_status_response.rb +1 -1
- data/lib/plaid/models/sandbox_oauth_select_accounts_request.rb +1 -1
- data/lib/plaid/models/sandbox_payment_profile_reset_login_request.rb +1 -1
- data/lib/plaid/models/sandbox_payment_profile_reset_login_response.rb +1 -1
- data/lib/plaid/models/sandbox_processor_token_create_request.rb +1 -1
- data/lib/plaid/models/sandbox_processor_token_create_request_options.rb +1 -1
- data/lib/plaid/models/sandbox_processor_token_create_response.rb +1 -1
- data/lib/plaid/models/sandbox_public_token_create_request.rb +1 -1
- data/lib/plaid/models/sandbox_public_token_create_request_income_verification_bank_income.rb +1 -1
- data/lib/plaid/models/sandbox_public_token_create_request_options.rb +1 -1
- data/lib/plaid/models/sandbox_public_token_create_request_options_income_verification.rb +1 -1
- data/lib/plaid/models/sandbox_public_token_create_request_options_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_transfer_fire_webhook_request.rb +1 -1
- data/lib/plaid/models/sandbox_transfer_fire_webhook_response.rb +1 -1
- data/lib/plaid/models/sandbox_transfer_ledger_deposit_simulate_request.rb +1 -1
- data/lib/plaid/models/sandbox_transfer_ledger_deposit_simulate_response.rb +1 -1
- data/lib/plaid/models/sandbox_transfer_ledger_simulate_available_request.rb +1 -1
- data/lib/plaid/models/sandbox_transfer_ledger_simulate_available_response.rb +1 -1
- data/lib/plaid/models/sandbox_transfer_ledger_withdraw_simulate_request.rb +1 -1
- data/lib/plaid/models/sandbox_transfer_ledger_withdraw_simulate_response.rb +1 -1
- data/lib/plaid/models/sandbox_transfer_refund_simulate_request.rb +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 +259 -0
- data/lib/plaid/models/sandbox_user_reset_login_response.rb +226 -0
- 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_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/signal_address_data.rb +1 -1
- data/lib/plaid/models/signal_decision_outcome.rb +1 -1
- data/lib/plaid/models/signal_decision_report_request.rb +1 -1
- data/lib/plaid/models/signal_decision_report_response.rb +1 -1
- data/lib/plaid/models/signal_device.rb +1 -1
- data/lib/plaid/models/signal_evaluate_core_attributes.rb +1 -1
- data/lib/plaid/models/signal_evaluate_request.rb +44 -7
- data/lib/plaid/models/signal_evaluate_response.rb +12 -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 +2 -2
- data/lib/plaid/models/signal_return_report_response.rb +1 -1
- data/lib/plaid/models/signal_scores.rb +1 -1
- data/lib/plaid/models/signal_user.rb +1 -1
- data/lib/plaid/models/signal_warning.rb +1 -1
- data/lib/plaid/models/simulated_transfer_sweep.rb +1 -1
- data/lib/plaid/models/single_document_risk_signal.rb +1 -1
- data/lib/plaid/models/source.rb +1 -1
- data/lib/plaid/models/standalone_account_type.rb +1 -1
- data/lib/plaid/models/standalone_currency_code_list.rb +1 -1
- data/lib/plaid/models/standalone_investment_transaction_type.rb +1 -1
- data/lib/plaid/models/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 +3 -3
- data/lib/plaid/models/sweep_status.rb +1 -1
- data/lib/plaid/models/sweep_trigger.rb +1 -1
- data/lib/plaid/models/sync_updates_available_webhook.rb +1 -1
- data/lib/plaid/models/taxform.rb +1 -1
- data/lib/plaid/models/taxpayer_id.rb +1 -1
- data/lib/plaid/models/taxpayer_identifier.rb +1 -1
- data/lib/plaid/models/taxpayer_identifier_type.rb +1 -1
- data/lib/plaid/models/taxpayer_identifiers.rb +1 -1
- data/lib/plaid/models/total.rb +1 -1
- data/lib/plaid/models/total_canonical_description.rb +1 -1
- data/lib/plaid/models/transaction.rb +2 -2
- data/lib/plaid/models/transaction_all_of.rb +1 -1
- data/lib/plaid/models/transaction_base.rb +2 -2
- 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 +1 -1
- 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 +1 -1
- 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 +1 -1
- data/lib/plaid/models/transactions_recurring_get_response.rb +1 -1
- data/lib/plaid/models/transactions_recurring_merge_input.rb +1 -1
- data/lib/plaid/models/transactions_recurring_merge_request.rb +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 +1 -1
- data/lib/plaid/models/transactions_rules_create_response.rb +1 -1
- data/lib/plaid/models/transactions_rules_list_request.rb +1 -1
- data/lib/plaid/models/transactions_rules_list_response.rb +1 -1
- data/lib/plaid/models/transactions_rules_remove_request.rb +1 -1
- data/lib/plaid/models/transactions_rules_remove_response.rb +1 -1
- data/lib/plaid/models/transactions_sync_request.rb +1 -1
- data/lib/plaid/models/transactions_sync_request_options.rb +1 -1
- 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 +1 -1
- data/lib/plaid/models/transfer_authorization_create_response.rb +1 -1
- data/lib/plaid/models/transfer_authorization_decision.rb +2 -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 +1 -1
- 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_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 +1 -1
- 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 +9 -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_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 +2 -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_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_request.rb +1 -1
- data/lib/plaid/models/transfer_metrics_get_response.rb +15 -5
- data/lib/plaid/models/transfer_metrics_get_return_rates.rb +221 -0
- data/lib/plaid/models/transfer_metrics_get_return_rates_over_interval.rb +241 -0
- 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_update_request.rb +1 -1
- data/lib/plaid/models/transfer_originator_funding_account_update_response.rb +1 -1
- data/lib/plaid/models/transfer_originator_get_request.rb +1 -1
- data/lib/plaid/models/transfer_originator_get_response.rb +1 -1
- data/lib/plaid/models/transfer_originator_list_request.rb +1 -1
- data/lib/plaid/models/transfer_originator_list_response.rb +1 -1
- data/lib/plaid/models/transfer_questionnaire_create_request.rb +1 -1
- data/lib/plaid/models/transfer_questionnaire_create_response.rb +1 -1
- data/lib/plaid/models/transfer_recurring_cancel_request.rb +1 -1
- data/lib/plaid/models/transfer_recurring_cancel_response.rb +1 -1
- data/lib/plaid/models/transfer_recurring_create_request.rb +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/update_entity_screening_request_search_terms.rb +1 -52
- data/lib/plaid/models/update_individual_screening_request_search_terms.rb +1 -52
- data/lib/plaid/models/user_account_identity.rb +285 -0
- data/lib/plaid/models/user_account_identity_address.rb +277 -0
- data/lib/plaid/models/{identity_document.rb → user_account_identity_name.rb} +18 -18
- data/lib/plaid/models/user_account_item.rb +231 -0
- data/lib/plaid/models/user_account_revoked_webhook.rb +2 -2
- data/lib/plaid/models/user_account_session_get_request.rb +246 -0
- data/lib/plaid/models/user_account_session_get_response.rb +252 -0
- data/lib/plaid/models/user_address.rb +1 -22
- data/lib/plaid/models/user_create_request.rb +1 -1
- data/lib/plaid/models/user_create_response.rb +1 -1
- data/lib/plaid/models/user_custom_password.rb +1 -1
- data/lib/plaid/models/user_data_overview.rb +1 -1
- data/lib/plaid/models/user_id_number.rb +1 -1
- data/lib/plaid/models/user_items_get_request.rb +246 -0
- data/lib/plaid/models/user_items_get_response.rb +242 -0
- data/lib/plaid/models/user_permission_revoked_webhook.rb +2 -2
- data/lib/plaid/models/user_remove_request.rb +246 -0
- data/lib/plaid/models/user_remove_response.rb +226 -0
- data/lib/plaid/models/user_stated_income_source_category.rb +1 -1
- data/lib/plaid/models/user_stated_income_source_frequency.rb +1 -1
- data/lib/plaid/models/user_stated_income_source_pay_type.rb +1 -1
- data/lib/plaid/models/user_update_request.rb +1 -1
- data/lib/plaid/models/user_update_response.rb +1 -1
- data/lib/plaid/models/validation_source.rb +1 -1
- data/lib/plaid/models/validation_sources.rb +1 -1
- data/lib/plaid/models/verification_expired_webhook.rb +1 -1
- data/lib/plaid/models/verification_of_asset.rb +1 -1
- data/lib/plaid/models/verification_of_asset_response.rb +1 -1
- data/lib/plaid/models/verification_refresh_status.rb +1 -1
- data/lib/plaid/models/verification_status.rb +1 -1
- data/lib/plaid/models/w2.rb +1 -1
- data/lib/plaid/models/w2_box12.rb +1 -1
- data/lib/plaid/models/w2_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 +4 -4
- data/lib/plaid/models/wallet_transaction_amount.rb +1 -1
- data/lib/plaid/models/wallet_transaction_counterparty.rb +1 -1
- data/lib/plaid/models/wallet_transaction_counterparty_bacs.rb +1 -1
- data/lib/plaid/models/wallet_transaction_counterparty_international.rb +1 -1
- data/lib/plaid/models/wallet_transaction_counterparty_numbers.rb +1 -1
- data/lib/plaid/models/wallet_transaction_execute_request.rb +1 -1
- data/lib/plaid/models/wallet_transaction_execute_response.rb +1 -1
- data/lib/plaid/models/wallet_transaction_failure_reason.rb +1 -1
- data/lib/plaid/models/wallet_transaction_get_request.rb +1 -1
- data/lib/plaid/models/wallet_transaction_get_response.rb +4 -4
- data/lib/plaid/models/wallet_transaction_list_request.rb +1 -1
- data/lib/plaid/models/wallet_transaction_list_request_options.rb +1 -1
- data/lib/plaid/models/wallet_transaction_list_response.rb +1 -1
- data/lib/plaid/models/wallet_transaction_status.rb +1 -1
- data/lib/plaid/models/wallet_transaction_status_update_webhook.rb +1 -1
- data/lib/plaid/models/wallet_transactions_list_request.rb +1 -1
- data/lib/plaid/models/warning.rb +1 -1
- data/lib/plaid/models/watchlist_screening_audit_trail.rb +1 -1
- data/lib/plaid/models/watchlist_screening_document.rb +1 -22
- data/lib/plaid/models/watchlist_screening_document_type.rb +1 -1
- data/lib/plaid/models/watchlist_screening_entity_create_request.rb +1 -18
- data/lib/plaid/models/watchlist_screening_entity_create_response.rb +1 -18
- data/lib/plaid/models/watchlist_screening_entity_get_request.rb +1 -1
- data/lib/plaid/models/watchlist_screening_entity_get_response.rb +1 -18
- 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 -18
- 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 -22
- 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 -18
- data/lib/plaid/models/watchlist_screening_entity_review_create_response.rb +1 -18
- 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 -18
- 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 -18
- data/lib/plaid/models/watchlist_screening_hit.rb +1 -18
- data/lib/plaid/models/watchlist_screening_hit_locations.rb +1 -22
- data/lib/plaid/models/watchlist_screening_hit_status.rb +1 -1
- data/lib/plaid/models/watchlist_screening_individual.rb +1 -18
- data/lib/plaid/models/watchlist_screening_individual_create_request.rb +1 -18
- data/lib/plaid/models/watchlist_screening_individual_create_response.rb +1 -18
- data/lib/plaid/models/watchlist_screening_individual_get_request.rb +1 -1
- data/lib/plaid/models/watchlist_screening_individual_get_response.rb +1 -18
- 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 -18
- 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 -22
- 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 -18
- data/lib/plaid/models/watchlist_screening_individual_review_create_response.rb +1 -18
- 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 -18
- 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 -18
- data/lib/plaid/models/watchlist_screening_request_search_terms.rb +1 -56
- data/lib/plaid/models/watchlist_screening_review.rb +1 -18
- data/lib/plaid/models/watchlist_screening_search_terms.rb +1 -56
- 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 -2
- data/lib/plaid/models/webhook_type.rb +1 -1
- data/lib/plaid/models/webhook_update_acknowledged_webhook.rb +1 -1
- data/lib/plaid/models/webhook_verification_key_get_request.rb +1 -1
- data/lib/plaid/models/webhook_verification_key_get_response.rb +1 -1
- data/lib/plaid/models/ytd_gross_income_summary_field_number.rb +1 -1
- data/lib/plaid/models/ytd_net_income_summary_field_number.rb +1 -1
- data/lib/plaid/version.rb +2 -2
- data/lib/plaid.rb +49 -2
- data/plaid.gemspec +1 -1
- data/templates/ruby/configuration.mustache +3 -2
- data/test/test_configuration.rb +7 -6
- metadata +50 -3
data/lib/plaid/api/plaid_api.rb
CHANGED
@@ -3,7 +3,7 @@
|
|
3
3
|
|
4
4
|
#The Plaid REST API. Please see https://plaid.com/docs/api for more details.
|
5
5
|
|
6
|
-
The version of the OpenAPI document: 2020-09-14_1.
|
6
|
+
The version of the OpenAPI document: 2020-09-14_1.534.3
|
7
7
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
9
9
|
OpenAPI Generator version: 6.3.0
|
@@ -2195,6 +2195,74 @@ module Plaid
|
|
2195
2195
|
return data, status_code, headers
|
2196
2196
|
end
|
2197
2197
|
|
2198
|
+
# Get Account Insights for a Beacon User
|
2199
|
+
# Get Account Insights for all Accounts linked to this Beacon User. The insights for each account are computed based on the information that was last retrieved from the financial institution.
|
2200
|
+
# @param beacon_user_account_insights_get_request [BeaconUserAccountInsightsGetRequest]
|
2201
|
+
# @param [Hash] opts the optional parameters
|
2202
|
+
# @return [BeaconUserAccountInsightsGetResponse]
|
2203
|
+
def beacon_user_account_insights_get(beacon_user_account_insights_get_request, opts = {})
|
2204
|
+
data, _status_code, _headers = beacon_user_account_insights_get_with_http_info(beacon_user_account_insights_get_request, opts)
|
2205
|
+
data
|
2206
|
+
end
|
2207
|
+
|
2208
|
+
# Get Account Insights for a Beacon User
|
2209
|
+
# Get Account Insights for all Accounts linked to this Beacon User. The insights for each account are computed based on the information that was last retrieved from the financial institution.
|
2210
|
+
# @param beacon_user_account_insights_get_request [BeaconUserAccountInsightsGetRequest]
|
2211
|
+
# @param [Hash] opts the optional parameters
|
2212
|
+
# @return [Array<(BeaconUserAccountInsightsGetResponse, Integer, Hash)>] BeaconUserAccountInsightsGetResponse data, response status code and response headers
|
2213
|
+
def beacon_user_account_insights_get_with_http_info(beacon_user_account_insights_get_request, opts = {})
|
2214
|
+
if @api_client.config.debugging
|
2215
|
+
@api_client.config.logger.debug 'Calling API: PlaidApi.beacon_user_account_insights_get ...'
|
2216
|
+
end
|
2217
|
+
# verify the required parameter 'beacon_user_account_insights_get_request' is set
|
2218
|
+
if @api_client.config.client_side_validation && beacon_user_account_insights_get_request.nil?
|
2219
|
+
fail ArgumentError, "Missing the required parameter 'beacon_user_account_insights_get_request' when calling PlaidApi.beacon_user_account_insights_get"
|
2220
|
+
end
|
2221
|
+
# resource path
|
2222
|
+
local_var_path = '/beacon/user/account_insights/get'
|
2223
|
+
|
2224
|
+
# query parameters
|
2225
|
+
query_params = opts[:query_params] || {}
|
2226
|
+
|
2227
|
+
# header parameters
|
2228
|
+
header_params = opts[:header_params] || {}
|
2229
|
+
# HTTP header 'Accept' (if needed)
|
2230
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
2231
|
+
# HTTP header 'Content-Type'
|
2232
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
2233
|
+
if !content_type.nil?
|
2234
|
+
header_params['Content-Type'] = content_type
|
2235
|
+
end
|
2236
|
+
|
2237
|
+
# form parameters
|
2238
|
+
form_params = opts[:form_params] || {}
|
2239
|
+
|
2240
|
+
# http body (model)
|
2241
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(beacon_user_account_insights_get_request)
|
2242
|
+
|
2243
|
+
# return_type
|
2244
|
+
return_type = opts[:debug_return_type] || 'BeaconUserAccountInsightsGetResponse'
|
2245
|
+
|
2246
|
+
# auth_names
|
2247
|
+
auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
|
2248
|
+
|
2249
|
+
new_options = opts.merge(
|
2250
|
+
:operation => :"PlaidApi.beacon_user_account_insights_get",
|
2251
|
+
:header_params => header_params,
|
2252
|
+
:query_params => query_params,
|
2253
|
+
:form_params => form_params,
|
2254
|
+
:body => post_body,
|
2255
|
+
:auth_names => auth_names,
|
2256
|
+
:return_type => return_type
|
2257
|
+
)
|
2258
|
+
|
2259
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
2260
|
+
if @api_client.config.debugging
|
2261
|
+
@api_client.config.logger.debug "API called: PlaidApi#beacon_user_account_insights_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
2262
|
+
end
|
2263
|
+
return data, status_code, headers
|
2264
|
+
end
|
2265
|
+
|
2198
2266
|
# Create a Beacon User
|
2199
2267
|
# Create and scan a Beacon User against your Beacon Program, according to your program's settings. When you submit a new user to `/beacon/user/create`, several checks are performed immediately: - The user's PII (provided within the `user` object) is searched against all other users within the Beacon Program you specified. If a match is found that violates your program's \"Duplicate Information Filtering\" settings, the user will be returned with a status of `pending_review`. - The user's PII is also searched against all fraud reports created by your organization across all of your Beacon Programs. If the user's data matches a fraud report that your team created, the user will be returned with a status of `rejected`. - Finally, the user's PII is searched against all fraud report shared with the Beacon Network by other companies. If a matching fraud report is found, the user will be returned with a `pending_review` status if your program has enabled automatic flagging based on network fraud.
|
2200
2268
|
# @param beacon_user_create_request [BeaconUserCreateRequest]
|
@@ -2468,7 +2536,7 @@ module Plaid
|
|
2468
2536
|
end
|
2469
2537
|
|
2470
2538
|
# Update the identity data of a Beacon User
|
2471
|
-
# Update the identity data for a Beacon User in your Beacon Program. Similar to `/beacon/user/create`, several checks are performed immediately when you submit
|
2539
|
+
# Update the identity data for a Beacon User in your Beacon Program or add new accounts to the Beacon User. Similar to `/beacon/user/create`, several checks are performed immediately when you submit an identity data change to `/beacon/user/update`: - The user's updated PII is searched against all other users within the Beacon Program you specified. If a match is found that violates your program's \"Duplicate Information Filtering\" settings, the user will be returned with a status of `pending_review`. - The user's updated PII is also searched against all fraud reports created by your organization across all of your Beacon Programs. If the user's data matches a fraud report that your team created, the user will be returned with a status of `rejected`. - Finally, the user's PII is searched against all fraud report shared with the Beacon Network by other companies. If a matching fraud report is found, the user will be returned with a `pending_review` status if your program has enabled automatic flagging based on network fraud. Plaid maintains a version history for each Beacon User, so the Beacon User's identity data before and after the update is retained as separate versions.
|
2472
2540
|
# @param beacon_user_update_request [BeaconUserUpdateRequest]
|
2473
2541
|
# @param [Hash] opts the optional parameters
|
2474
2542
|
# @return [BeaconUserUpdateResponse]
|
@@ -2478,7 +2546,7 @@ module Plaid
|
|
2478
2546
|
end
|
2479
2547
|
|
2480
2548
|
# Update the identity data of a Beacon User
|
2481
|
-
# Update the identity data for a Beacon User in your Beacon Program. Similar to `/beacon/user/create`, several checks are performed immediately when you submit
|
2549
|
+
# Update the identity data for a Beacon User in your Beacon Program or add new accounts to the Beacon User. Similar to `/beacon/user/create`, several checks are performed immediately when you submit an identity data change to `/beacon/user/update`: - The user's updated PII is searched against all other users within the Beacon Program you specified. If a match is found that violates your program's \"Duplicate Information Filtering\" settings, the user will be returned with a status of `pending_review`. - The user's updated PII is also searched against all fraud reports created by your organization across all of your Beacon Programs. If the user's data matches a fraud report that your team created, the user will be returned with a status of `rejected`. - Finally, the user's PII is searched against all fraud report shared with the Beacon Network by other companies. If a matching fraud report is found, the user will be returned with a `pending_review` status if your program has enabled automatic flagging based on network fraud. Plaid maintains a version history for each Beacon User, so the Beacon User's identity data before and after the update is retained as separate versions.
|
2482
2550
|
# @param beacon_user_update_request [BeaconUserUpdateRequest]
|
2483
2551
|
# @param [Hash] opts the optional parameters
|
2484
2552
|
# @return [Array<(BeaconUserUpdateResponse, Integer, Hash)>] BeaconUserUpdateResponse data, response status code and response headers
|
@@ -2607,27 +2675,435 @@ module Plaid
|
|
2607
2675
|
# Retrieves all existing CRB Bank Income and Base reports for the consumer in PDF format. Response is PDF binary data. The `request_id` is returned in the `Plaid-Request-ID` header.
|
2608
2676
|
# @param consumer_report_pdf_get_request [ConsumerReportPDFGetRequest]
|
2609
2677
|
# @param [Hash] opts the optional parameters
|
2610
|
-
# @return [File]
|
2611
|
-
def consumer_report_pdf_get(consumer_report_pdf_get_request, opts = {})
|
2612
|
-
data, _status_code, _headers = consumer_report_pdf_get_with_http_info(consumer_report_pdf_get_request, opts)
|
2678
|
+
# @return [File]
|
2679
|
+
def consumer_report_pdf_get(consumer_report_pdf_get_request, opts = {})
|
2680
|
+
data, _status_code, _headers = consumer_report_pdf_get_with_http_info(consumer_report_pdf_get_request, opts)
|
2681
|
+
data
|
2682
|
+
end
|
2683
|
+
|
2684
|
+
# Retrieve a PDF Reports
|
2685
|
+
# Retrieves all existing CRB Bank Income and Base reports for the consumer in PDF format. Response is PDF binary data. The `request_id` is returned in the `Plaid-Request-ID` header.
|
2686
|
+
# @param consumer_report_pdf_get_request [ConsumerReportPDFGetRequest]
|
2687
|
+
# @param [Hash] opts the optional parameters
|
2688
|
+
# @return [Array<(File, Integer, Hash)>] File data, response status code and response headers
|
2689
|
+
def consumer_report_pdf_get_with_http_info(consumer_report_pdf_get_request, opts = {})
|
2690
|
+
if @api_client.config.debugging
|
2691
|
+
@api_client.config.logger.debug 'Calling API: PlaidApi.consumer_report_pdf_get ...'
|
2692
|
+
end
|
2693
|
+
# verify the required parameter 'consumer_report_pdf_get_request' is set
|
2694
|
+
if @api_client.config.client_side_validation && consumer_report_pdf_get_request.nil?
|
2695
|
+
fail ArgumentError, "Missing the required parameter 'consumer_report_pdf_get_request' when calling PlaidApi.consumer_report_pdf_get"
|
2696
|
+
end
|
2697
|
+
# resource path
|
2698
|
+
local_var_path = '/consumer_report/pdf/get'
|
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/pdf'])
|
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(consumer_report_pdf_get_request)
|
2718
|
+
|
2719
|
+
# return_type
|
2720
|
+
return_type = opts[:debug_return_type] || 'File'
|
2721
|
+
|
2722
|
+
# auth_names
|
2723
|
+
auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
|
2724
|
+
|
2725
|
+
new_options = opts.merge(
|
2726
|
+
:operation => :"PlaidApi.consumer_report_pdf_get",
|
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#consumer_report_pdf_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
2738
|
+
end
|
2739
|
+
return data, status_code, headers
|
2740
|
+
end
|
2741
|
+
|
2742
|
+
# Create a CRA report for income verification
|
2743
|
+
# `/cra/bank_income/create` creates a CRA report for income verification
|
2744
|
+
# @param cra_bank_income_create_request [CraBankIncomeCreateRequest]
|
2745
|
+
# @param [Hash] opts the optional parameters
|
2746
|
+
# @return [CraBankIncomeCreateResponse]
|
2747
|
+
def cra_bank_income_create(cra_bank_income_create_request, opts = {})
|
2748
|
+
data, _status_code, _headers = cra_bank_income_create_with_http_info(cra_bank_income_create_request, opts)
|
2749
|
+
data
|
2750
|
+
end
|
2751
|
+
|
2752
|
+
# Create a CRA report for income verification
|
2753
|
+
# `/cra/bank_income/create` creates a CRA report for income verification
|
2754
|
+
# @param cra_bank_income_create_request [CraBankIncomeCreateRequest]
|
2755
|
+
# @param [Hash] opts the optional parameters
|
2756
|
+
# @return [Array<(CraBankIncomeCreateResponse, Integer, Hash)>] CraBankIncomeCreateResponse data, response status code and response headers
|
2757
|
+
def cra_bank_income_create_with_http_info(cra_bank_income_create_request, opts = {})
|
2758
|
+
if @api_client.config.debugging
|
2759
|
+
@api_client.config.logger.debug 'Calling API: PlaidApi.cra_bank_income_create ...'
|
2760
|
+
end
|
2761
|
+
# verify the required parameter 'cra_bank_income_create_request' is set
|
2762
|
+
if @api_client.config.client_side_validation && cra_bank_income_create_request.nil?
|
2763
|
+
fail ArgumentError, "Missing the required parameter 'cra_bank_income_create_request' when calling PlaidApi.cra_bank_income_create"
|
2764
|
+
end
|
2765
|
+
# resource path
|
2766
|
+
local_var_path = '/cra/bank_income/create'
|
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(cra_bank_income_create_request)
|
2786
|
+
|
2787
|
+
# return_type
|
2788
|
+
return_type = opts[:debug_return_type] || 'CraBankIncomeCreateResponse'
|
2789
|
+
|
2790
|
+
# auth_names
|
2791
|
+
auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
|
2792
|
+
|
2793
|
+
new_options = opts.merge(
|
2794
|
+
:operation => :"PlaidApi.cra_bank_income_create",
|
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#cra_bank_income_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
2806
|
+
end
|
2807
|
+
return data, status_code, headers
|
2808
|
+
end
|
2809
|
+
|
2810
|
+
# Retrieve information from the bank accounts used for income verification
|
2811
|
+
# `/cra/bank_income/get` returns the bank income report(s) for a specified user.
|
2812
|
+
# @param cra_bank_income_get_request [CraBankIncomeGetRequest]
|
2813
|
+
# @param [Hash] opts the optional parameters
|
2814
|
+
# @return [CraBankIncomeGetResponse]
|
2815
|
+
def cra_bank_income_get(cra_bank_income_get_request, opts = {})
|
2816
|
+
data, _status_code, _headers = cra_bank_income_get_with_http_info(cra_bank_income_get_request, opts)
|
2817
|
+
data
|
2818
|
+
end
|
2819
|
+
|
2820
|
+
# Retrieve information from the bank accounts used for income verification
|
2821
|
+
# `/cra/bank_income/get` returns the bank income report(s) for a specified user.
|
2822
|
+
# @param cra_bank_income_get_request [CraBankIncomeGetRequest]
|
2823
|
+
# @param [Hash] opts the optional parameters
|
2824
|
+
# @return [Array<(CraBankIncomeGetResponse, Integer, Hash)>] CraBankIncomeGetResponse data, response status code and response headers
|
2825
|
+
def cra_bank_income_get_with_http_info(cra_bank_income_get_request, opts = {})
|
2826
|
+
if @api_client.config.debugging
|
2827
|
+
@api_client.config.logger.debug 'Calling API: PlaidApi.cra_bank_income_get ...'
|
2828
|
+
end
|
2829
|
+
# verify the required parameter 'cra_bank_income_get_request' is set
|
2830
|
+
if @api_client.config.client_side_validation && cra_bank_income_get_request.nil?
|
2831
|
+
fail ArgumentError, "Missing the required parameter 'cra_bank_income_get_request' when calling PlaidApi.cra_bank_income_get"
|
2832
|
+
end
|
2833
|
+
# resource path
|
2834
|
+
local_var_path = '/cra/bank_income/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(cra_bank_income_get_request)
|
2854
|
+
|
2855
|
+
# return_type
|
2856
|
+
return_type = opts[:debug_return_type] || 'CraBankIncomeGetResponse'
|
2857
|
+
|
2858
|
+
# auth_names
|
2859
|
+
auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
|
2860
|
+
|
2861
|
+
new_options = opts.merge(
|
2862
|
+
:operation => :"PlaidApi.cra_bank_income_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#cra_bank_income_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
2874
|
+
end
|
2875
|
+
return data, status_code, headers
|
2876
|
+
end
|
2877
|
+
|
2878
|
+
# Retrieve a Base Report
|
2879
|
+
# 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`.
|
2880
|
+
# @param cra_check_report_base_report_get_request [CraCheckReportBaseReportGetRequest]
|
2881
|
+
# @param [Hash] opts the optional parameters
|
2882
|
+
# @return [CraCheckReportBaseReportGetResponse]
|
2883
|
+
def cra_check_report_base_report_get(cra_check_report_base_report_get_request, opts = {})
|
2884
|
+
data, _status_code, _headers = cra_check_report_base_report_get_with_http_info(cra_check_report_base_report_get_request, opts)
|
2885
|
+
data
|
2886
|
+
end
|
2887
|
+
|
2888
|
+
# Retrieve a Base Report
|
2889
|
+
# 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`.
|
2890
|
+
# @param cra_check_report_base_report_get_request [CraCheckReportBaseReportGetRequest]
|
2891
|
+
# @param [Hash] opts the optional parameters
|
2892
|
+
# @return [Array<(CraCheckReportBaseReportGetResponse, Integer, Hash)>] CraCheckReportBaseReportGetResponse data, response status code and response headers
|
2893
|
+
def cra_check_report_base_report_get_with_http_info(cra_check_report_base_report_get_request, opts = {})
|
2894
|
+
if @api_client.config.debugging
|
2895
|
+
@api_client.config.logger.debug 'Calling API: PlaidApi.cra_check_report_base_report_get ...'
|
2896
|
+
end
|
2897
|
+
# verify the required parameter 'cra_check_report_base_report_get_request' is set
|
2898
|
+
if @api_client.config.client_side_validation && cra_check_report_base_report_get_request.nil?
|
2899
|
+
fail ArgumentError, "Missing the required parameter 'cra_check_report_base_report_get_request' when calling PlaidApi.cra_check_report_base_report_get"
|
2900
|
+
end
|
2901
|
+
# resource path
|
2902
|
+
local_var_path = '/cra/check_report/base_report/get'
|
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(cra_check_report_base_report_get_request)
|
2922
|
+
|
2923
|
+
# return_type
|
2924
|
+
return_type = opts[:debug_return_type] || 'CraCheckReportBaseReportGetResponse'
|
2925
|
+
|
2926
|
+
# auth_names
|
2927
|
+
auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
|
2928
|
+
|
2929
|
+
new_options = opts.merge(
|
2930
|
+
:operation => :"PlaidApi.cra_check_report_base_report_get",
|
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#cra_check_report_base_report_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
2942
|
+
end
|
2943
|
+
return data, status_code, headers
|
2944
|
+
end
|
2945
|
+
|
2946
|
+
# Create a Consumer Report
|
2947
|
+
# `/cra/check_report/create` creates a Consumer Report powered by Plaid Check. Plaid Check automatically starts creating Consumer Report data after the user completes the Link process with a Plaid Check product, so you typically would only call this endpoint if you wish to generate an updated report, some time after the initial report was generated.
|
2948
|
+
# @param cra_check_report_create_request [CraCheckReportCreateRequest]
|
2949
|
+
# @param [Hash] opts the optional parameters
|
2950
|
+
# @return [CraCheckReportCreateResponse]
|
2951
|
+
def cra_check_report_create(cra_check_report_create_request, opts = {})
|
2952
|
+
data, _status_code, _headers = cra_check_report_create_with_http_info(cra_check_report_create_request, opts)
|
2953
|
+
data
|
2954
|
+
end
|
2955
|
+
|
2956
|
+
# Create a Consumer Report
|
2957
|
+
# `/cra/check_report/create` creates a Consumer Report powered by Plaid Check. Plaid Check automatically starts creating Consumer Report data after the user completes the Link process with a Plaid Check product, so you typically would only call this endpoint if you wish to generate an updated report, some time after the initial report was generated.
|
2958
|
+
# @param cra_check_report_create_request [CraCheckReportCreateRequest]
|
2959
|
+
# @param [Hash] opts the optional parameters
|
2960
|
+
# @return [Array<(CraCheckReportCreateResponse, Integer, Hash)>] CraCheckReportCreateResponse data, response status code and response headers
|
2961
|
+
def cra_check_report_create_with_http_info(cra_check_report_create_request, opts = {})
|
2962
|
+
if @api_client.config.debugging
|
2963
|
+
@api_client.config.logger.debug 'Calling API: PlaidApi.cra_check_report_create ...'
|
2964
|
+
end
|
2965
|
+
# verify the required parameter 'cra_check_report_create_request' is set
|
2966
|
+
if @api_client.config.client_side_validation && cra_check_report_create_request.nil?
|
2967
|
+
fail ArgumentError, "Missing the required parameter 'cra_check_report_create_request' when calling PlaidApi.cra_check_report_create"
|
2968
|
+
end
|
2969
|
+
# resource path
|
2970
|
+
local_var_path = '/cra/check_report/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(cra_check_report_create_request)
|
2990
|
+
|
2991
|
+
# return_type
|
2992
|
+
return_type = opts[:debug_return_type] || 'CraCheckReportCreateResponse'
|
2993
|
+
|
2994
|
+
# auth_names
|
2995
|
+
auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
|
2996
|
+
|
2997
|
+
new_options = opts.merge(
|
2998
|
+
:operation => :"PlaidApi.cra_check_report_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#cra_check_report_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
3010
|
+
end
|
3011
|
+
return data, status_code, headers
|
3012
|
+
end
|
3013
|
+
|
3014
|
+
# Retrieve cash flow information from your user's banks
|
3015
|
+
# 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` 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
|
+
# @param cra_check_report_income_insights_get_request [CraCheckReportIncomeInsightsGetRequest]
|
3017
|
+
# @param [Hash] opts the optional parameters
|
3018
|
+
# @return [CraCheckReportIncomeInsightsGetResponse]
|
3019
|
+
def cra_check_report_income_insights_get(cra_check_report_income_insights_get_request, opts = {})
|
3020
|
+
data, _status_code, _headers = cra_check_report_income_insights_get_with_http_info(cra_check_report_income_insights_get_request, opts)
|
3021
|
+
data
|
3022
|
+
end
|
3023
|
+
|
3024
|
+
# Retrieve cash flow information from your user's banks
|
3025
|
+
# 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` 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
|
+
# @param cra_check_report_income_insights_get_request [CraCheckReportIncomeInsightsGetRequest]
|
3027
|
+
# @param [Hash] opts the optional parameters
|
3028
|
+
# @return [Array<(CraCheckReportIncomeInsightsGetResponse, Integer, Hash)>] CraCheckReportIncomeInsightsGetResponse data, response status code and response headers
|
3029
|
+
def cra_check_report_income_insights_get_with_http_info(cra_check_report_income_insights_get_request, opts = {})
|
3030
|
+
if @api_client.config.debugging
|
3031
|
+
@api_client.config.logger.debug 'Calling API: PlaidApi.cra_check_report_income_insights_get ...'
|
3032
|
+
end
|
3033
|
+
# verify the required parameter 'cra_check_report_income_insights_get_request' is set
|
3034
|
+
if @api_client.config.client_side_validation && cra_check_report_income_insights_get_request.nil?
|
3035
|
+
fail ArgumentError, "Missing the required parameter 'cra_check_report_income_insights_get_request' when calling PlaidApi.cra_check_report_income_insights_get"
|
3036
|
+
end
|
3037
|
+
# resource path
|
3038
|
+
local_var_path = '/cra/check_report/income_insights/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(cra_check_report_income_insights_get_request)
|
3058
|
+
|
3059
|
+
# return_type
|
3060
|
+
return_type = opts[:debug_return_type] || 'CraCheckReportIncomeInsightsGetResponse'
|
3061
|
+
|
3062
|
+
# auth_names
|
3063
|
+
auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
|
3064
|
+
|
3065
|
+
new_options = opts.merge(
|
3066
|
+
:operation => :"PlaidApi.cra_check_report_income_insights_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#cra_check_report_income_insights_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
3078
|
+
end
|
3079
|
+
return data, status_code, headers
|
3080
|
+
end
|
3081
|
+
|
3082
|
+
# Retrieve network attributes for the user
|
3083
|
+
# This endpoint allows you to retrieve the Network Attributes product for your user. You should call this endpoint after you've received the `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`, we will generate the attributes when you call this endpoint.
|
3084
|
+
# @param cra_check_report_network_attributes_get_request [CraCheckReportNetworkAttributesGetRequest]
|
3085
|
+
# @param [Hash] opts the optional parameters
|
3086
|
+
# @return [CraCheckReportNetworkAttributesGetResponse]
|
3087
|
+
def cra_check_report_network_attributes_get(cra_check_report_network_attributes_get_request, opts = {})
|
3088
|
+
data, _status_code, _headers = cra_check_report_network_attributes_get_with_http_info(cra_check_report_network_attributes_get_request, opts)
|
2613
3089
|
data
|
2614
3090
|
end
|
2615
3091
|
|
2616
|
-
# Retrieve
|
2617
|
-
#
|
2618
|
-
# @param
|
3092
|
+
# Retrieve network attributes for the user
|
3093
|
+
# This endpoint allows you to retrieve the Network Attributes product for your user. You should call this endpoint after you've received the `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`, we will generate the attributes when you call this endpoint.
|
3094
|
+
# @param cra_check_report_network_attributes_get_request [CraCheckReportNetworkAttributesGetRequest]
|
2619
3095
|
# @param [Hash] opts the optional parameters
|
2620
|
-
# @return [Array<(
|
2621
|
-
def
|
3096
|
+
# @return [Array<(CraCheckReportNetworkAttributesGetResponse, Integer, Hash)>] CraCheckReportNetworkAttributesGetResponse data, response status code and response headers
|
3097
|
+
def cra_check_report_network_attributes_get_with_http_info(cra_check_report_network_attributes_get_request, opts = {})
|
2622
3098
|
if @api_client.config.debugging
|
2623
|
-
@api_client.config.logger.debug 'Calling API: PlaidApi.
|
3099
|
+
@api_client.config.logger.debug 'Calling API: PlaidApi.cra_check_report_network_attributes_get ...'
|
2624
3100
|
end
|
2625
|
-
# verify the required parameter '
|
2626
|
-
if @api_client.config.client_side_validation &&
|
2627
|
-
fail ArgumentError, "Missing the required parameter '
|
3101
|
+
# verify the required parameter 'cra_check_report_network_attributes_get_request' is set
|
3102
|
+
if @api_client.config.client_side_validation && cra_check_report_network_attributes_get_request.nil?
|
3103
|
+
fail ArgumentError, "Missing the required parameter 'cra_check_report_network_attributes_get_request' when calling PlaidApi.cra_check_report_network_attributes_get"
|
2628
3104
|
end
|
2629
3105
|
# resource path
|
2630
|
-
local_var_path = '/
|
3106
|
+
local_var_path = '/cra/check_report/network_insights/get'
|
2631
3107
|
|
2632
3108
|
# query parameters
|
2633
3109
|
query_params = opts[:query_params] || {}
|
@@ -2635,7 +3111,7 @@ module Plaid
|
|
2635
3111
|
# header parameters
|
2636
3112
|
header_params = opts[:header_params] || {}
|
2637
3113
|
# HTTP header 'Accept' (if needed)
|
2638
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/
|
3114
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
2639
3115
|
# HTTP header 'Content-Type'
|
2640
3116
|
content_type = @api_client.select_header_content_type(['application/json'])
|
2641
3117
|
if !content_type.nil?
|
@@ -2646,16 +3122,16 @@ module Plaid
|
|
2646
3122
|
form_params = opts[:form_params] || {}
|
2647
3123
|
|
2648
3124
|
# http body (model)
|
2649
|
-
post_body = opts[:debug_body] || @api_client.object_to_http_body(
|
3125
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(cra_check_report_network_attributes_get_request)
|
2650
3126
|
|
2651
3127
|
# return_type
|
2652
|
-
return_type = opts[:debug_return_type] || '
|
3128
|
+
return_type = opts[:debug_return_type] || 'CraCheckReportNetworkAttributesGetResponse'
|
2653
3129
|
|
2654
3130
|
# auth_names
|
2655
3131
|
auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
|
2656
3132
|
|
2657
3133
|
new_options = opts.merge(
|
2658
|
-
:operation => :"PlaidApi.
|
3134
|
+
:operation => :"PlaidApi.cra_check_report_network_attributes_get",
|
2659
3135
|
:header_params => header_params,
|
2660
3136
|
:query_params => query_params,
|
2661
3137
|
:form_params => form_params,
|
@@ -2666,36 +3142,36 @@ module Plaid
|
|
2666
3142
|
|
2667
3143
|
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
2668
3144
|
if @api_client.config.debugging
|
2669
|
-
@api_client.config.logger.debug "API called: PlaidApi#
|
3145
|
+
@api_client.config.logger.debug "API called: PlaidApi#cra_check_report_network_attributes_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
2670
3146
|
end
|
2671
3147
|
return data, status_code, headers
|
2672
3148
|
end
|
2673
3149
|
|
2674
|
-
#
|
2675
|
-
# `/cra/
|
2676
|
-
# @param
|
3150
|
+
# Retrieve cash flow insights from partners
|
3151
|
+
# This endpoint allows you to retrieve the Partner Insights product for your user. You should call this endpoint after you've received the `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.
|
3152
|
+
# @param cra_check_report_partner_insights_get_request [CraCheckReportPartnerInsightsGetRequest]
|
2677
3153
|
# @param [Hash] opts the optional parameters
|
2678
|
-
# @return [
|
2679
|
-
def
|
2680
|
-
data, _status_code, _headers =
|
3154
|
+
# @return [CraCheckReportPartnerInsightsGetResponse]
|
3155
|
+
def cra_check_report_partner_insights_get(cra_check_report_partner_insights_get_request, opts = {})
|
3156
|
+
data, _status_code, _headers = cra_check_report_partner_insights_get_with_http_info(cra_check_report_partner_insights_get_request, opts)
|
2681
3157
|
data
|
2682
3158
|
end
|
2683
3159
|
|
2684
|
-
#
|
2685
|
-
# `/cra/
|
2686
|
-
# @param
|
3160
|
+
# Retrieve cash flow insights from partners
|
3161
|
+
# This endpoint allows you to retrieve the Partner Insights product for your user. You should call this endpoint after you've received the `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.
|
3162
|
+
# @param cra_check_report_partner_insights_get_request [CraCheckReportPartnerInsightsGetRequest]
|
2687
3163
|
# @param [Hash] opts the optional parameters
|
2688
|
-
# @return [Array<(
|
2689
|
-
def
|
3164
|
+
# @return [Array<(CraCheckReportPartnerInsightsGetResponse, Integer, Hash)>] CraCheckReportPartnerInsightsGetResponse data, response status code and response headers
|
3165
|
+
def cra_check_report_partner_insights_get_with_http_info(cra_check_report_partner_insights_get_request, opts = {})
|
2690
3166
|
if @api_client.config.debugging
|
2691
|
-
@api_client.config.logger.debug 'Calling API: PlaidApi.
|
3167
|
+
@api_client.config.logger.debug 'Calling API: PlaidApi.cra_check_report_partner_insights_get ...'
|
2692
3168
|
end
|
2693
|
-
# verify the required parameter '
|
2694
|
-
if @api_client.config.client_side_validation &&
|
2695
|
-
fail ArgumentError, "Missing the required parameter '
|
3169
|
+
# verify the required parameter 'cra_check_report_partner_insights_get_request' is set
|
3170
|
+
if @api_client.config.client_side_validation && cra_check_report_partner_insights_get_request.nil?
|
3171
|
+
fail ArgumentError, "Missing the required parameter 'cra_check_report_partner_insights_get_request' when calling PlaidApi.cra_check_report_partner_insights_get"
|
2696
3172
|
end
|
2697
3173
|
# resource path
|
2698
|
-
local_var_path = '/cra/
|
3174
|
+
local_var_path = '/cra/check_report/partner_insights/get'
|
2699
3175
|
|
2700
3176
|
# query parameters
|
2701
3177
|
query_params = opts[:query_params] || {}
|
@@ -2714,16 +3190,16 @@ module Plaid
|
|
2714
3190
|
form_params = opts[:form_params] || {}
|
2715
3191
|
|
2716
3192
|
# http body (model)
|
2717
|
-
post_body = opts[:debug_body] || @api_client.object_to_http_body(
|
3193
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(cra_check_report_partner_insights_get_request)
|
2718
3194
|
|
2719
3195
|
# return_type
|
2720
|
-
return_type = opts[:debug_return_type] || '
|
3196
|
+
return_type = opts[:debug_return_type] || 'CraCheckReportPartnerInsightsGetResponse'
|
2721
3197
|
|
2722
3198
|
# auth_names
|
2723
3199
|
auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
|
2724
3200
|
|
2725
3201
|
new_options = opts.merge(
|
2726
|
-
:operation => :"PlaidApi.
|
3202
|
+
:operation => :"PlaidApi.cra_check_report_partner_insights_get",
|
2727
3203
|
:header_params => header_params,
|
2728
3204
|
:query_params => query_params,
|
2729
3205
|
:form_params => form_params,
|
@@ -2734,36 +3210,36 @@ module Plaid
|
|
2734
3210
|
|
2735
3211
|
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
2736
3212
|
if @api_client.config.debugging
|
2737
|
-
@api_client.config.logger.debug "API called: PlaidApi#
|
3213
|
+
@api_client.config.logger.debug "API called: PlaidApi#cra_check_report_partner_insights_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
2738
3214
|
end
|
2739
3215
|
return data, status_code, headers
|
2740
3216
|
end
|
2741
3217
|
|
2742
|
-
# Retrieve
|
2743
|
-
# `/cra/
|
2744
|
-
# @param
|
3218
|
+
# Retrieve the most recent Base Report in PDF format. You can also include other reports in the same PDF if you specify `add_ons`.
|
3219
|
+
# `/cra/check_report/pdf/get` retrieve the most recent Bank Income report (if it exists) followed by the most recent Base Report (if it exists) in PDF format
|
3220
|
+
# @param cra_check_report_pdf_get_request [CraCheckReportPDFGetRequest]
|
2745
3221
|
# @param [Hash] opts the optional parameters
|
2746
|
-
# @return [
|
2747
|
-
def
|
2748
|
-
data, _status_code, _headers =
|
3222
|
+
# @return [File]
|
3223
|
+
def cra_check_report_pdf_get(cra_check_report_pdf_get_request, opts = {})
|
3224
|
+
data, _status_code, _headers = cra_check_report_pdf_get_with_http_info(cra_check_report_pdf_get_request, opts)
|
2749
3225
|
data
|
2750
3226
|
end
|
2751
3227
|
|
2752
|
-
# Retrieve
|
2753
|
-
# `/cra/
|
2754
|
-
# @param
|
3228
|
+
# Retrieve the most recent Base Report in PDF format. You can also include other reports in the same PDF if you specify `add_ons`.
|
3229
|
+
# `/cra/check_report/pdf/get` retrieve the most recent Bank Income report (if it exists) followed by the most recent Base Report (if it exists) in PDF format
|
3230
|
+
# @param cra_check_report_pdf_get_request [CraCheckReportPDFGetRequest]
|
2755
3231
|
# @param [Hash] opts the optional parameters
|
2756
|
-
# @return [Array<(
|
2757
|
-
def
|
3232
|
+
# @return [Array<(File, Integer, Hash)>] File data, response status code and response headers
|
3233
|
+
def cra_check_report_pdf_get_with_http_info(cra_check_report_pdf_get_request, opts = {})
|
2758
3234
|
if @api_client.config.debugging
|
2759
|
-
@api_client.config.logger.debug 'Calling API: PlaidApi.
|
3235
|
+
@api_client.config.logger.debug 'Calling API: PlaidApi.cra_check_report_pdf_get ...'
|
2760
3236
|
end
|
2761
|
-
# verify the required parameter '
|
2762
|
-
if @api_client.config.client_side_validation &&
|
2763
|
-
fail ArgumentError, "Missing the required parameter '
|
3237
|
+
# verify the required parameter 'cra_check_report_pdf_get_request' is set
|
3238
|
+
if @api_client.config.client_side_validation && cra_check_report_pdf_get_request.nil?
|
3239
|
+
fail ArgumentError, "Missing the required parameter 'cra_check_report_pdf_get_request' when calling PlaidApi.cra_check_report_pdf_get"
|
2764
3240
|
end
|
2765
3241
|
# resource path
|
2766
|
-
local_var_path = '/cra/
|
3242
|
+
local_var_path = '/cra/check_report/pdf/get'
|
2767
3243
|
|
2768
3244
|
# query parameters
|
2769
3245
|
query_params = opts[:query_params] || {}
|
@@ -2771,7 +3247,7 @@ module Plaid
|
|
2771
3247
|
# header parameters
|
2772
3248
|
header_params = opts[:header_params] || {}
|
2773
3249
|
# HTTP header 'Accept' (if needed)
|
2774
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/
|
3250
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/pdf'])
|
2775
3251
|
# HTTP header 'Content-Type'
|
2776
3252
|
content_type = @api_client.select_header_content_type(['application/json'])
|
2777
3253
|
if !content_type.nil?
|
@@ -2782,16 +3258,16 @@ module Plaid
|
|
2782
3258
|
form_params = opts[:form_params] || {}
|
2783
3259
|
|
2784
3260
|
# http body (model)
|
2785
|
-
post_body = opts[:debug_body] || @api_client.object_to_http_body(
|
3261
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(cra_check_report_pdf_get_request)
|
2786
3262
|
|
2787
3263
|
# return_type
|
2788
|
-
return_type = opts[:debug_return_type] || '
|
3264
|
+
return_type = opts[:debug_return_type] || 'File'
|
2789
3265
|
|
2790
3266
|
# auth_names
|
2791
3267
|
auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
|
2792
3268
|
|
2793
3269
|
new_options = opts.merge(
|
2794
|
-
:operation => :"PlaidApi.
|
3270
|
+
:operation => :"PlaidApi.cra_check_report_pdf_get",
|
2795
3271
|
:header_params => header_params,
|
2796
3272
|
:query_params => query_params,
|
2797
3273
|
:form_params => form_params,
|
@@ -2802,7 +3278,7 @@ module Plaid
|
|
2802
3278
|
|
2803
3279
|
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
2804
3280
|
if @api_client.config.debugging
|
2805
|
-
@api_client.config.logger.debug "API called: PlaidApi#
|
3281
|
+
@api_client.config.logger.debug "API called: PlaidApi#cra_check_report_pdf_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
2806
3282
|
end
|
2807
3283
|
return data, status_code, headers
|
2808
3284
|
end
|
@@ -7432,7 +7908,7 @@ module Plaid
|
|
7432
7908
|
end
|
7433
7909
|
|
7434
7910
|
# Remove an Item
|
7435
|
-
# The `/item/remove` endpoint allows you to remove an Item. Once removed, the `access_token`, as well as any processor tokens or bank account tokens associated with the Item, is no longer valid and cannot be used to access any data that was associated with the Item.
|
7911
|
+
# The `/item/remove` endpoint allows you to remove an Item. Once removed, the `access_token`, as well as any processor tokens or bank account tokens associated with the Item, is no longer valid and cannot be used to access any data that was associated with the Item. Calling `/item/remove` is a recommended best practice when offboarding users or if a user chooses to disconnect an account linked via Plaid. For subscription products, such as Transactions, Liabilities, and Investments, calling `/item/remove` is required to end subscription billing for the Item. In Limited Production, calling `/item/remove` does not impact the number of remaining Limited Production Items you have available. Removing an Item does not affect any Asset Reports or Audit Copies you have already created, which will remain accessible until you remove access to them specifically using the `/asset_report/remove` endpoint. Also note that for certain OAuth-based institutions, an Item removed via `/item/remove` may still show as an active connection in the institution's OAuth permission manager. API versions 2019-05-29 and earlier return a `removed` boolean as part of the response.
|
7436
7912
|
# @param item_remove_request [ItemRemoveRequest]
|
7437
7913
|
# @param [Hash] opts the optional parameters
|
7438
7914
|
# @return [ItemRemoveResponse]
|
@@ -7442,7 +7918,7 @@ module Plaid
|
|
7442
7918
|
end
|
7443
7919
|
|
7444
7920
|
# Remove an Item
|
7445
|
-
# The `/item/remove` endpoint allows you to remove an Item. Once removed, the `access_token`, as well as any processor tokens or bank account tokens associated with the Item, is no longer valid and cannot be used to access any data that was associated with the Item.
|
7921
|
+
# The `/item/remove` endpoint allows you to remove an Item. Once removed, the `access_token`, as well as any processor tokens or bank account tokens associated with the Item, is no longer valid and cannot be used to access any data that was associated with the Item. Calling `/item/remove` is a recommended best practice when offboarding users or if a user chooses to disconnect an account linked via Plaid. For subscription products, such as Transactions, Liabilities, and Investments, calling `/item/remove` is required to end subscription billing for the Item. In Limited Production, calling `/item/remove` does not impact the number of remaining Limited Production Items you have available. Removing an Item does not affect any Asset Reports or Audit Copies you have already created, which will remain accessible until you remove access to them specifically using the `/asset_report/remove` endpoint. Also note that for certain OAuth-based institutions, an Item removed via `/item/remove` may still show as an active connection in the institution's OAuth permission manager. API versions 2019-05-29 and earlier return a `removed` boolean as part of the response.
|
7446
7922
|
# @param item_remove_request [ItemRemoveRequest]
|
7447
7923
|
# @param [Hash] opts the optional parameters
|
7448
7924
|
# @return [Array<(ItemRemoveResponse, Integer, Hash)>] ItemRemoveResponse data, response status code and response headers
|
@@ -7908,7 +8384,7 @@ module Plaid
|
|
7908
8384
|
end
|
7909
8385
|
|
7910
8386
|
# Create Link Token
|
7911
|
-
# The `/link/token/create` endpoint creates a `link_token`, which is required as a parameter when initializing Link. Once Link has been initialized, it returns a `public_token
|
8387
|
+
# The `/link/token/create` endpoint creates a `link_token`, which is required as a parameter when initializing Link. Once Link has been initialized, it returns a `public_token`. For most Plaid products, the `public_token` is saved and exchanged for an `access_token` via `/item/public_token/exchange` as part of the main Link flow. For more details, see the [Link flow overview](https://plaid.com/docs/link/#link-flow-overview). A `link_token` generated by `/link/token/create` is also used to initialize other Link flows, such as the [update mode](https://plaid.com/docs/link/update-mode) flow for tokens with expired credentials, or the Identity Verification flow.
|
7912
8388
|
# @param link_token_create_request [LinkTokenCreateRequest]
|
7913
8389
|
# @param [Hash] opts the optional parameters
|
7914
8390
|
# @return [LinkTokenCreateResponse]
|
@@ -7918,7 +8394,7 @@ module Plaid
|
|
7918
8394
|
end
|
7919
8395
|
|
7920
8396
|
# Create Link Token
|
7921
|
-
# The `/link/token/create` endpoint creates a `link_token`, which is required as a parameter when initializing Link. Once Link has been initialized, it returns a `public_token`
|
8397
|
+
# The `/link/token/create` endpoint creates a `link_token`, which is required as a parameter when initializing Link. Once Link has been initialized, it returns a `public_token`. For most Plaid products, the `public_token` is saved and exchanged for an `access_token` via `/item/public_token/exchange` as part of the main Link flow. For more details, see the [Link flow overview](https://plaid.com/docs/link/#link-flow-overview). A `link_token` generated by `/link/token/create` is also used to initialize other Link flows, such as the [update mode](https://plaid.com/docs/link/update-mode) flow for tokens with expired credentials, or the Identity Verification flow.
|
7922
8398
|
# @param link_token_create_request [LinkTokenCreateRequest]
|
7923
8399
|
# @param [Hash] opts the optional parameters
|
7924
8400
|
# @return [Array<(LinkTokenCreateResponse, Integer, Hash)>] LinkTokenCreateResponse data, response status code and response headers
|
@@ -8112,7 +8588,7 @@ module Plaid
|
|
8112
8588
|
end
|
8113
8589
|
|
8114
8590
|
# Enables a Plaid reseller's end customer in the Production environment.
|
8115
|
-
# The `/partner/customer/enable` endpoint is used by reseller partners to enable an end customer in the Production environment.
|
8591
|
+
# The `/partner/customer/enable` endpoint is used by reseller partners to enable an end customer in the full Production environment.
|
8116
8592
|
# @param partner_customer_enable_request [PartnerCustomerEnableRequest]
|
8117
8593
|
# @param [Hash] opts the optional parameters
|
8118
8594
|
# @return [PartnerCustomerEnableResponse]
|
@@ -8122,7 +8598,7 @@ module Plaid
|
|
8122
8598
|
end
|
8123
8599
|
|
8124
8600
|
# Enables a Plaid reseller's end customer in the Production environment.
|
8125
|
-
# The `/partner/customer/enable` endpoint is used by reseller partners to enable an end customer in the Production environment.
|
8601
|
+
# The `/partner/customer/enable` endpoint is used by reseller partners to enable an end customer in the full Production environment.
|
8126
8602
|
# @param partner_customer_enable_request [PartnerCustomerEnableRequest]
|
8127
8603
|
# @param [Hash] opts the optional parameters
|
8128
8604
|
# @return [Array<(PartnerCustomerEnableResponse, Integer, Hash)>] PartnerCustomerEnableResponse data, response status code and response headers
|
@@ -8316,7 +8792,7 @@ module Plaid
|
|
8316
8792
|
end
|
8317
8793
|
|
8318
8794
|
# Removes a Plaid reseller's end customer.
|
8319
|
-
# The `/partner/customer/remove` endpoint is used by reseller partners to remove an end customer. Removing an end customer will remove it from view in the Plaid Dashboard and deactivate its API keys. This endpoint can only be used to remove an end customer that has not yet been enabled in Production.
|
8795
|
+
# The `/partner/customer/remove` endpoint is used by reseller partners to remove an end customer. Removing an end customer will remove it from view in the Plaid Dashboard and deactivate its API keys. This endpoint can only be used to remove an end customer that has not yet been enabled in full Production.
|
8320
8796
|
# @param partner_customer_remove_request [PartnerCustomerRemoveRequest]
|
8321
8797
|
# @param [Hash] opts the optional parameters
|
8322
8798
|
# @return [PartnerCustomerRemoveResponse]
|
@@ -8326,7 +8802,7 @@ module Plaid
|
|
8326
8802
|
end
|
8327
8803
|
|
8328
8804
|
# Removes a Plaid reseller's end customer.
|
8329
|
-
# The `/partner/customer/remove` endpoint is used by reseller partners to remove an end customer. Removing an end customer will remove it from view in the Plaid Dashboard and deactivate its API keys. This endpoint can only be used to remove an end customer that has not yet been enabled in Production.
|
8805
|
+
# The `/partner/customer/remove` endpoint is used by reseller partners to remove an end customer. Removing an end customer will remove it from view in the Plaid Dashboard and deactivate its API keys. This endpoint can only be used to remove an end customer that has not yet been enabled in full Production.
|
8330
8806
|
# @param partner_customer_remove_request [PartnerCustomerRemoveRequest]
|
8331
8807
|
# @param [Hash] opts the optional parameters
|
8332
8808
|
# @return [Array<(PartnerCustomerRemoveResponse, Integer, Hash)>] PartnerCustomerRemoveResponse data, response status code and response headers
|
@@ -8656,7 +9132,7 @@ module Plaid
|
|
8656
9132
|
end
|
8657
9133
|
|
8658
9134
|
# Create a payment
|
8659
|
-
# After creating a payment recipient, you can use the `/payment_initiation/payment/create` endpoint to create a payment to that recipient. Payments can be one-time or standing order (recurring) and can be denominated in either EUR, GBP or other chosen [currency](https://plaid.com/docs/api/products/payment-initiation/#payment_initiation-payment-create-request-amount-currency). If making domestic GBP-denominated payments, your recipient must have been created with BACS numbers. In general, EUR-denominated payments will be sent via SEPA Credit Transfer, GBP-denominated payments will be sent via the Faster Payments network and for non-Eurozone markets typically via the local payment scheme, but the payment network used will be determined by the institution. Payments sent via Faster Payments will typically arrive immediately, while payments sent via SEPA Credit Transfer or other local payment schemes will typically arrive in one business day. Standing orders (recurring payments) must be denominated in GBP and can only be sent to recipients in the UK. Once created, standing order payments cannot be modified or canceled via the API. An end user can cancel or modify a standing order directly on their banking application or website, or by contacting the bank. Standing orders will follow the payment rules of the underlying rails (Faster Payments in UK). Payments can be sent Monday to Friday, excluding bank holidays. If the pre-arranged date falls on a weekend or bank holiday, the payment is made on the next working day. It is not possible to guarantee the exact time the payment will reach the recipient’s account, although at least 90% of standing order payments are sent by 6am. In
|
9135
|
+
# After creating a payment recipient, you can use the `/payment_initiation/payment/create` endpoint to create a payment to that recipient. Payments can be one-time or standing order (recurring) and can be denominated in either EUR, GBP or other chosen [currency](https://plaid.com/docs/api/products/payment-initiation/#payment_initiation-payment-create-request-amount-currency). If making domestic GBP-denominated payments, your recipient must have been created with BACS numbers. In general, EUR-denominated payments will be sent via SEPA Credit Transfer, GBP-denominated payments will be sent via the Faster Payments network and for non-Eurozone markets typically via the local payment scheme, but the payment network used will be determined by the institution. Payments sent via Faster Payments will typically arrive immediately, while payments sent via SEPA Credit Transfer or other local payment schemes will typically arrive in one business day. Standing orders (recurring payments) must be denominated in GBP and can only be sent to recipients in the UK. Once created, standing order payments cannot be modified or canceled via the API. An end user can cancel or modify a standing order directly on their banking application or website, or by contacting the bank. Standing orders will follow the payment rules of the underlying rails (Faster Payments in UK). Payments can be sent Monday to Friday, excluding bank holidays. If the pre-arranged date falls on a weekend or bank holiday, the payment is made on the next working day. It is not possible to guarantee the exact time the payment will reach the recipient’s account, although at least 90% of standing order payments are sent by 6am. In Limited Production, payments must be below 5 GBP or other chosen [currency](https://plaid.com/docs/api/products/payment-initiation/#payment_initiation-payment-create-request-amount-currency), and standing orders, variable recurring payments, and Virtual Accounts are not supported.
|
8660
9136
|
# @param payment_initiation_payment_create_request [PaymentInitiationPaymentCreateRequest]
|
8661
9137
|
# @param [Hash] opts the optional parameters
|
8662
9138
|
# @return [PaymentInitiationPaymentCreateResponse]
|
@@ -8666,7 +9142,7 @@ module Plaid
|
|
8666
9142
|
end
|
8667
9143
|
|
8668
9144
|
# Create a payment
|
8669
|
-
# After creating a payment recipient, you can use the `/payment_initiation/payment/create` endpoint to create a payment to that recipient. Payments can be one-time or standing order (recurring) and can be denominated in either EUR, GBP or other chosen [currency](https://plaid.com/docs/api/products/payment-initiation/#payment_initiation-payment-create-request-amount-currency). If making domestic GBP-denominated payments, your recipient must have been created with BACS numbers. In general, EUR-denominated payments will be sent via SEPA Credit Transfer, GBP-denominated payments will be sent via the Faster Payments network and for non-Eurozone markets typically via the local payment scheme, but the payment network used will be determined by the institution. Payments sent via Faster Payments will typically arrive immediately, while payments sent via SEPA Credit Transfer or other local payment schemes will typically arrive in one business day. Standing orders (recurring payments) must be denominated in GBP and can only be sent to recipients in the UK. Once created, standing order payments cannot be modified or canceled via the API. An end user can cancel or modify a standing order directly on their banking application or website, or by contacting the bank. Standing orders will follow the payment rules of the underlying rails (Faster Payments in UK). Payments can be sent Monday to Friday, excluding bank holidays. If the pre-arranged date falls on a weekend or bank holiday, the payment is made on the next working day. It is not possible to guarantee the exact time the payment will reach the recipient’s account, although at least 90% of standing order payments are sent by 6am. In
|
9145
|
+
# After creating a payment recipient, you can use the `/payment_initiation/payment/create` endpoint to create a payment to that recipient. Payments can be one-time or standing order (recurring) and can be denominated in either EUR, GBP or other chosen [currency](https://plaid.com/docs/api/products/payment-initiation/#payment_initiation-payment-create-request-amount-currency). If making domestic GBP-denominated payments, your recipient must have been created with BACS numbers. In general, EUR-denominated payments will be sent via SEPA Credit Transfer, GBP-denominated payments will be sent via the Faster Payments network and for non-Eurozone markets typically via the local payment scheme, but the payment network used will be determined by the institution. Payments sent via Faster Payments will typically arrive immediately, while payments sent via SEPA Credit Transfer or other local payment schemes will typically arrive in one business day. Standing orders (recurring payments) must be denominated in GBP and can only be sent to recipients in the UK. Once created, standing order payments cannot be modified or canceled via the API. An end user can cancel or modify a standing order directly on their banking application or website, or by contacting the bank. Standing orders will follow the payment rules of the underlying rails (Faster Payments in UK). Payments can be sent Monday to Friday, excluding bank holidays. If the pre-arranged date falls on a weekend or bank holiday, the payment is made on the next working day. It is not possible to guarantee the exact time the payment will reach the recipient’s account, although at least 90% of standing order payments are sent by 6am. In Limited Production, payments must be below 5 GBP or other chosen [currency](https://plaid.com/docs/api/products/payment-initiation/#payment_initiation-payment-create-request-amount-currency), and standing orders, variable recurring payments, and Virtual Accounts are not supported.
|
8670
9146
|
# @param payment_initiation_payment_create_request [PaymentInitiationPaymentCreateRequest]
|
8671
9147
|
# @param [Hash] opts the optional parameters
|
8672
9148
|
# @return [Array<(PaymentInitiationPaymentCreateResponse, Integer, Hash)>] PaymentInitiationPaymentCreateResponse data, response status code and response headers
|
@@ -10628,7 +11104,7 @@ module Plaid
|
|
10628
11104
|
end
|
10629
11105
|
|
10630
11106
|
# Refresh transaction data
|
10631
|
-
# `/processor/transactions/refresh` is an optional endpoint for users of the Transactions product. It initiates an on-demand extraction to fetch the newest transactions for a processor token. This on-demand extraction takes place in addition to the periodic extractions that automatically occur one or more times per day for any Transactions-enabled processor token. If changes to transactions are discovered after calling `/processor/transactions/refresh`, Plaid will fire a webhook: for `/transactions/sync` users, [`SYNC_UPDATES_AVAILABLE`](https://plaid.com/docs/api/products/transactions/#sync_updates_available) will be fired if there are any transactions updated, added, or removed. For users of both `/processor/transactions/sync` and `/processor/transactions/get`, [`TRANSACTIONS_REMOVED`](https://plaid.com/docs/api/products/transactions/#transactions_removed) will be fired if any removed transactions are detected, and [`DEFAULT_UPDATE`](https://plaid.com/docs/api/products/transactions/#default_update) will be fired if any new transactions are detected. New transactions can be fetched by calling `/processor/transactions/get` or `/processor/transactions/sync`. Note that the `/
|
11107
|
+
# `/processor/transactions/refresh` is an optional endpoint for users of the Transactions product. It initiates an on-demand extraction to fetch the newest transactions for a processor token. This on-demand extraction takes place in addition to the periodic extractions that automatically occur one or more times per day for any Transactions-enabled processor token. If changes to transactions are discovered after calling `/processor/transactions/refresh`, Plaid will fire a webhook: for `/transactions/sync` users, [`SYNC_UPDATES_AVAILABLE`](https://plaid.com/docs/api/products/transactions/#sync_updates_available) will be fired if there are any transactions updated, added, or removed. For users of both `/processor/transactions/sync` and `/processor/transactions/get`, [`TRANSACTIONS_REMOVED`](https://plaid.com/docs/api/products/transactions/#transactions_removed) will be fired if any removed transactions are detected, and [`DEFAULT_UPDATE`](https://plaid.com/docs/api/products/transactions/#default_update) will be fired if any new transactions are detected. New transactions can be fetched by calling `/processor/transactions/get` or `/processor/transactions/sync`. Note that the `/transactions/refresh` endpoint is not supported for Capital One (`ins_128026`) non-depository accounts and will result in a `PRODUCTS_NOT_SUPPORTED` error if called on an Item that contains only non-depository accounts from that institution. As this endpoint triggers a synchronous request for fresh data, latency may be higher than for other Plaid endpoints (typically less than 10 seconds, but occasionally up to 30 seconds or more); if you encounter errors, you may find it necessary to adjust your timeout period when making requests. `/processor/transactions/refresh` is offered as an add-on to Transactions and has a separate [fee model](/docs/account/billing/#per-request-flat-fee). To request access to this endpoint, submit a [product access request](https://dashboard.plaid.com/team/products) or contact your Plaid account manager.
|
10632
11108
|
# @param processor_transactions_refresh_request [ProcessorTransactionsRefreshRequest]
|
10633
11109
|
# @param [Hash] opts the optional parameters
|
10634
11110
|
# @return [ProcessorTransactionsRefreshResponse]
|
@@ -10638,7 +11114,7 @@ module Plaid
|
|
10638
11114
|
end
|
10639
11115
|
|
10640
11116
|
# Refresh transaction data
|
10641
|
-
# `/processor/transactions/refresh` is an optional endpoint for users of the Transactions product. It initiates an on-demand extraction to fetch the newest transactions for a processor token. This on-demand extraction takes place in addition to the periodic extractions that automatically occur one or more times per day for any Transactions-enabled processor token. If changes to transactions are discovered after calling `/processor/transactions/refresh`, Plaid will fire a webhook: for `/transactions/sync` users, [`SYNC_UPDATES_AVAILABLE`](https://plaid.com/docs/api/products/transactions/#sync_updates_available) will be fired if there are any transactions updated, added, or removed. For users of both `/processor/transactions/sync` and `/processor/transactions/get`, [`TRANSACTIONS_REMOVED`](https://plaid.com/docs/api/products/transactions/#transactions_removed) will be fired if any removed transactions are detected, and [`DEFAULT_UPDATE`](https://plaid.com/docs/api/products/transactions/#default_update) will be fired if any new transactions are detected. New transactions can be fetched by calling `/processor/transactions/get` or `/processor/transactions/sync`. Note that the `/
|
11117
|
+
# `/processor/transactions/refresh` is an optional endpoint for users of the Transactions product. It initiates an on-demand extraction to fetch the newest transactions for a processor token. This on-demand extraction takes place in addition to the periodic extractions that automatically occur one or more times per day for any Transactions-enabled processor token. If changes to transactions are discovered after calling `/processor/transactions/refresh`, Plaid will fire a webhook: for `/transactions/sync` users, [`SYNC_UPDATES_AVAILABLE`](https://plaid.com/docs/api/products/transactions/#sync_updates_available) will be fired if there are any transactions updated, added, or removed. For users of both `/processor/transactions/sync` and `/processor/transactions/get`, [`TRANSACTIONS_REMOVED`](https://plaid.com/docs/api/products/transactions/#transactions_removed) will be fired if any removed transactions are detected, and [`DEFAULT_UPDATE`](https://plaid.com/docs/api/products/transactions/#default_update) will be fired if any new transactions are detected. New transactions can be fetched by calling `/processor/transactions/get` or `/processor/transactions/sync`. Note that the `/transactions/refresh` endpoint is not supported for Capital One (`ins_128026`) non-depository accounts and will result in a `PRODUCTS_NOT_SUPPORTED` error if called on an Item that contains only non-depository accounts from that institution. As this endpoint triggers a synchronous request for fresh data, latency may be higher than for other Plaid endpoints (typically less than 10 seconds, but occasionally up to 30 seconds or more); if you encounter errors, you may find it necessary to adjust your timeout period when making requests. `/processor/transactions/refresh` is offered as an add-on to Transactions and has a separate [fee model](/docs/account/billing/#per-request-flat-fee). To request access to this endpoint, submit a [product access request](https://dashboard.plaid.com/team/products) or contact your Plaid account manager.
|
10642
11118
|
# @param processor_transactions_refresh_request [ProcessorTransactionsRefreshRequest]
|
10643
11119
|
# @param [Hash] opts the optional parameters
|
10644
11120
|
# @return [Array<(ProcessorTransactionsRefreshResponse, Integer, Hash)>] ProcessorTransactionsRefreshResponse data, response status code and response headers
|
@@ -11104,7 +11580,7 @@ module Plaid
|
|
11104
11580
|
end
|
11105
11581
|
|
11106
11582
|
# Fire a test webhook
|
11107
|
-
# The `/sandbox/item/fire_webhook` endpoint is used to test that code correctly handles webhooks. This endpoint can trigger the following webhooks: `DEFAULT_UPDATE`:
|
11583
|
+
# The `/sandbox/item/fire_webhook` endpoint is used to test that code correctly handles webhooks. This endpoint can trigger the following webhooks: `DEFAULT_UPDATE`: Webhook to be fired for a given Sandbox Item simulating a default update event for the respective product as specified with the `webhook_type` in the request body. Valid sandbox `DEFAULT_UPDATE` responses include: `AUTH`, `IDENTITY`, `TRANSACTIONS`, `INVESTMENTS_TRANSACTIONS`, `LIABILITIES`, `HOLDINGS`. If the Item does not support the product, a `SANDBOX_PRODUCT_NOT_ENABLED` error will result. `NEW_ACCOUNTS_AVAILABLE`: Webhook to be fired for a given Sandbox Item created with Account Select v2. `SMS_MICRODEPOSITS_VERIFICATION`: Fired when a given same day micro-deposit item is verified via SMS verification. `LOGIN_REPAIRED`: Fired when an Item recovers from the `ITEM_LOGIN_REQUIRED` without the user going through update mode in your app. `RECURRING_TRANSACTIONS_UPDATE`: Recurring Transactions webhook to be fired for a given Sandbox Item. If the Item does not support Recurring Transactions, a `SANDBOX_PRODUCT_NOT_ENABLED` error will result. `SYNC_UPDATES_AVAILABLE`: Transactions webhook to be fired for a given Sandbox Item. If the Item does not support Transactions, a `SANDBOX_PRODUCT_NOT_ENABLED` error will result. `PRODUCT_READY`: Assets webhook to be fired when a given asset report has been successfully generated. If the Item does not support Assets, a `SANDBOX_PRODUCT_NOT_ENABLED` error will result. `ERROR`: Assets webhook to be fired when asset report generation has failed. If the Item does not support Assets, a `SANDBOX_PRODUCT_NOT_ENABLED` error will result. Note that this endpoint is provided for developer ease-of-use and is not required for testing webhooks; webhooks will also fire in Sandbox under the same conditions that they would in Production (except for webhooks of type `TRANSFER`).
|
11108
11584
|
# @param sandbox_item_fire_webhook_request [SandboxItemFireWebhookRequest]
|
11109
11585
|
# @param [Hash] opts the optional parameters
|
11110
11586
|
# @return [SandboxItemFireWebhookResponse]
|
@@ -11114,7 +11590,7 @@ module Plaid
|
|
11114
11590
|
end
|
11115
11591
|
|
11116
11592
|
# Fire a test webhook
|
11117
|
-
# The `/sandbox/item/fire_webhook` endpoint is used to test that code correctly handles webhooks. This endpoint can trigger the following webhooks: `DEFAULT_UPDATE`:
|
11593
|
+
# The `/sandbox/item/fire_webhook` endpoint is used to test that code correctly handles webhooks. This endpoint can trigger the following webhooks: `DEFAULT_UPDATE`: Webhook to be fired for a given Sandbox Item simulating a default update event for the respective product as specified with the `webhook_type` in the request body. Valid sandbox `DEFAULT_UPDATE` responses include: `AUTH`, `IDENTITY`, `TRANSACTIONS`, `INVESTMENTS_TRANSACTIONS`, `LIABILITIES`, `HOLDINGS`. If the Item does not support the product, a `SANDBOX_PRODUCT_NOT_ENABLED` error will result. `NEW_ACCOUNTS_AVAILABLE`: Webhook to be fired for a given Sandbox Item created with Account Select v2. `SMS_MICRODEPOSITS_VERIFICATION`: Fired when a given same day micro-deposit item is verified via SMS verification. `LOGIN_REPAIRED`: Fired when an Item recovers from the `ITEM_LOGIN_REQUIRED` without the user going through update mode in your app. `RECURRING_TRANSACTIONS_UPDATE`: Recurring Transactions webhook to be fired for a given Sandbox Item. If the Item does not support Recurring Transactions, a `SANDBOX_PRODUCT_NOT_ENABLED` error will result. `SYNC_UPDATES_AVAILABLE`: Transactions webhook to be fired for a given Sandbox Item. If the Item does not support Transactions, a `SANDBOX_PRODUCT_NOT_ENABLED` error will result. `PRODUCT_READY`: Assets webhook to be fired when a given asset report has been successfully generated. If the Item does not support Assets, a `SANDBOX_PRODUCT_NOT_ENABLED` error will result. `ERROR`: Assets webhook to be fired when asset report generation has failed. If the Item does not support Assets, a `SANDBOX_PRODUCT_NOT_ENABLED` error will result. Note that this endpoint is provided for developer ease-of-use and is not required for testing webhooks; webhooks will also fire in Sandbox under the same conditions that they would in Production (except for webhooks of type `TRANSFER`).
|
11118
11594
|
# @param sandbox_item_fire_webhook_request [SandboxItemFireWebhookRequest]
|
11119
11595
|
# @param [Hash] opts the optional parameters
|
11120
11596
|
# @return [Array<(SandboxItemFireWebhookResponse, Integer, Hash)>] SandboxItemFireWebhookResponse data, response status code and response headers
|
@@ -12395,8 +12871,76 @@ module Plaid
|
|
12395
12871
|
return data, status_code, headers
|
12396
12872
|
end
|
12397
12873
|
|
12874
|
+
# Force item(s) for a Sandbox User into an error state
|
12875
|
+
# `/sandbox/user/reset_login/` functions the same as `/sandbox/item/reset_login`, but will modify Items related to a User. This endpoint forces each Item into an `ITEM_LOGIN_REQUIRED` state in order to simulate an Item whose login is no longer valid. This makes it easy to test Link's [update mode](https://plaid.com/docs/link/update-mode) flow in the Sandbox environment. After calling `/sandbox/user/reset_login`, You can then use Plaid Link update mode to restore Items associated with the User to a good state. An `ITEM_LOGIN_REQUIRED` webhook will also be fired after a call to this endpoint, if one is associated with the Item. In the Sandbox, Items will transition to an `ITEM_LOGIN_REQUIRED` error state automatically after 30 days, even if this endpoint is not called.
|
12876
|
+
# @param sandbox_user_reset_login_request [SandboxUserResetLoginRequest]
|
12877
|
+
# @param [Hash] opts the optional parameters
|
12878
|
+
# @return [SandboxUserResetLoginResponse]
|
12879
|
+
def sandbox_user_reset_login(sandbox_user_reset_login_request, opts = {})
|
12880
|
+
data, _status_code, _headers = sandbox_user_reset_login_with_http_info(sandbox_user_reset_login_request, opts)
|
12881
|
+
data
|
12882
|
+
end
|
12883
|
+
|
12884
|
+
# Force item(s) for a Sandbox User into an error state
|
12885
|
+
# `/sandbox/user/reset_login/` functions the same as `/sandbox/item/reset_login`, but will modify Items related to a User. This endpoint forces each Item into an `ITEM_LOGIN_REQUIRED` state in order to simulate an Item whose login is no longer valid. This makes it easy to test Link's [update mode](https://plaid.com/docs/link/update-mode) flow in the Sandbox environment. After calling `/sandbox/user/reset_login`, You can then use Plaid Link update mode to restore Items associated with the User to a good state. An `ITEM_LOGIN_REQUIRED` webhook will also be fired after a call to this endpoint, if one is associated with the Item. In the Sandbox, Items will transition to an `ITEM_LOGIN_REQUIRED` error state automatically after 30 days, even if this endpoint is not called.
|
12886
|
+
# @param sandbox_user_reset_login_request [SandboxUserResetLoginRequest]
|
12887
|
+
# @param [Hash] opts the optional parameters
|
12888
|
+
# @return [Array<(SandboxUserResetLoginResponse, Integer, Hash)>] SandboxUserResetLoginResponse data, response status code and response headers
|
12889
|
+
def sandbox_user_reset_login_with_http_info(sandbox_user_reset_login_request, opts = {})
|
12890
|
+
if @api_client.config.debugging
|
12891
|
+
@api_client.config.logger.debug 'Calling API: PlaidApi.sandbox_user_reset_login ...'
|
12892
|
+
end
|
12893
|
+
# verify the required parameter 'sandbox_user_reset_login_request' is set
|
12894
|
+
if @api_client.config.client_side_validation && sandbox_user_reset_login_request.nil?
|
12895
|
+
fail ArgumentError, "Missing the required parameter 'sandbox_user_reset_login_request' when calling PlaidApi.sandbox_user_reset_login"
|
12896
|
+
end
|
12897
|
+
# resource path
|
12898
|
+
local_var_path = '/sandbox/user/reset_login'
|
12899
|
+
|
12900
|
+
# query parameters
|
12901
|
+
query_params = opts[:query_params] || {}
|
12902
|
+
|
12903
|
+
# header parameters
|
12904
|
+
header_params = opts[:header_params] || {}
|
12905
|
+
# HTTP header 'Accept' (if needed)
|
12906
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
12907
|
+
# HTTP header 'Content-Type'
|
12908
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
12909
|
+
if !content_type.nil?
|
12910
|
+
header_params['Content-Type'] = content_type
|
12911
|
+
end
|
12912
|
+
|
12913
|
+
# form parameters
|
12914
|
+
form_params = opts[:form_params] || {}
|
12915
|
+
|
12916
|
+
# http body (model)
|
12917
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(sandbox_user_reset_login_request)
|
12918
|
+
|
12919
|
+
# return_type
|
12920
|
+
return_type = opts[:debug_return_type] || 'SandboxUserResetLoginResponse'
|
12921
|
+
|
12922
|
+
# auth_names
|
12923
|
+
auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
|
12924
|
+
|
12925
|
+
new_options = opts.merge(
|
12926
|
+
:operation => :"PlaidApi.sandbox_user_reset_login",
|
12927
|
+
:header_params => header_params,
|
12928
|
+
:query_params => query_params,
|
12929
|
+
:form_params => form_params,
|
12930
|
+
:body => post_body,
|
12931
|
+
:auth_names => auth_names,
|
12932
|
+
:return_type => return_type
|
12933
|
+
)
|
12934
|
+
|
12935
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
12936
|
+
if @api_client.config.debugging
|
12937
|
+
@api_client.config.logger.debug "API called: PlaidApi#sandbox_user_reset_login\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
12938
|
+
end
|
12939
|
+
return data, status_code, headers
|
12940
|
+
end
|
12941
|
+
|
12398
12942
|
# Report whether you initiated an ACH transaction
|
12399
|
-
# After calling `/signal/evaluate`, call `/signal/decision/report` to report whether the transaction was initiated.
|
12943
|
+
# After calling `/signal/evaluate` (or `/accounts/balance/get`, for participants in the [Balance Plus](http://plaid.com/docs/balance/balance-plus) beta), call `/signal/decision/report` to report whether the transaction was initiated.
|
12400
12944
|
# @param signal_decision_report_request [SignalDecisionReportRequest]
|
12401
12945
|
# @param [Hash] opts the optional parameters
|
12402
12946
|
# @return [SignalDecisionReportResponse]
|
@@ -12406,7 +12950,7 @@ module Plaid
|
|
12406
12950
|
end
|
12407
12951
|
|
12408
12952
|
# Report whether you initiated an ACH transaction
|
12409
|
-
# After calling `/signal/evaluate`, call `/signal/decision/report` to report whether the transaction was initiated.
|
12953
|
+
# After calling `/signal/evaluate` (or `/accounts/balance/get`, for participants in the [Balance Plus](http://plaid.com/docs/balance/balance-plus) beta), call `/signal/decision/report` to report whether the transaction was initiated.
|
12410
12954
|
# @param signal_decision_report_request [SignalDecisionReportRequest]
|
12411
12955
|
# @param [Hash] opts the optional parameters
|
12412
12956
|
# @return [Array<(SignalDecisionReportResponse, Integer, Hash)>] SignalDecisionReportResponse data, response status code and response headers
|
@@ -12600,7 +13144,7 @@ module Plaid
|
|
12600
13144
|
end
|
12601
13145
|
|
12602
13146
|
# Report a return for an ACH transaction
|
12603
|
-
# Call the `/signal/return/report` endpoint to report a returned transaction that was previously sent to the `/signal/evaluate` endpoint. Your feedback will be used by the model to incorporate the latest risk trend in your portfolio.
|
13147
|
+
# Call the `/signal/return/report` endpoint to report a returned transaction that was previously sent to the `/signal/evaluate` or (for participants in the [Balance Plus](http://plaid.com/docs/balance/balance-plus) beta) the `/accounts/balance/get` endpoint. Your feedback will be used by the model to incorporate the latest risk trend in your portfolio.
|
12604
13148
|
# @param signal_return_report_request [SignalReturnReportRequest]
|
12605
13149
|
# @param [Hash] opts the optional parameters
|
12606
13150
|
# @return [SignalReturnReportResponse]
|
@@ -12610,7 +13154,7 @@ module Plaid
|
|
12610
13154
|
end
|
12611
13155
|
|
12612
13156
|
# Report a return for an ACH transaction
|
12613
|
-
# Call the `/signal/return/report` endpoint to report a returned transaction that was previously sent to the `/signal/evaluate` endpoint. Your feedback will be used by the model to incorporate the latest risk trend in your portfolio.
|
13157
|
+
# Call the `/signal/return/report` endpoint to report a returned transaction that was previously sent to the `/signal/evaluate` or (for participants in the [Balance Plus](http://plaid.com/docs/balance/balance-plus) beta) the `/accounts/balance/get` endpoint. Your feedback will be used by the model to incorporate the latest risk trend in your portfolio.
|
12614
13158
|
# @param signal_return_report_request [SignalReturnReportRequest]
|
12615
13159
|
# @param [Hash] opts the optional parameters
|
12616
13160
|
# @return [Array<(SignalReturnReportResponse, Integer, Hash)>] SignalReturnReportResponse data, response status code and response headers
|
@@ -13144,7 +13688,7 @@ module Plaid
|
|
13144
13688
|
end
|
13145
13689
|
|
13146
13690
|
# Refresh transaction data
|
13147
|
-
# `/transactions/refresh` is an optional endpoint that initiates an on-demand extraction to fetch the newest transactions for an Item. The on-demand extraction takes place in addition to the periodic extractions that automatically occur one or more times per day for any Transactions-enabled Item. The Item must already have Transactions added as a product in order to call `/transactions/refresh`. If changes to transactions are discovered after calling `/transactions/refresh`, Plaid will fire a webhook: for `/transactions/sync` users, [`SYNC_UPDATES_AVAILABLE`](https://plaid.com/docs/api/products/transactions/#sync_updates_available) will be fired if there are any transactions updated, added, or removed. For users of both `/transactions/sync` and `/transactions/get`, [`TRANSACTIONS_REMOVED`](https://plaid.com/docs/api/products/transactions/#transactions_removed) will be fired if any removed transactions are detected, and [`DEFAULT_UPDATE`](https://plaid.com/docs/api/products/transactions/#default_update) will be fired if any new transactions are detected. New transactions can be fetched by calling `/transactions/get` or `/transactions/sync`. Note that the `/transactions/refresh` endpoint is not supported for Capital One (`ins_128026`) and will result in a `PRODUCTS_NOT_SUPPORTED` error if called on an Item from that institution. As this endpoint triggers a synchronous request for fresh data, latency may be higher than for other Plaid endpoints (typically less than 10 seconds, but occasionally up to 30 seconds or more); if you encounter errors, you may find it necessary to adjust your timeout period when making requests. `/transactions/refresh` is offered as an optional add-on to Transactions and has a separate [fee model](/docs/account/billing/#per-request-flat-fee). To request access to this endpoint, submit a [product access request](https://dashboard.plaid.com/team/products) or contact your Plaid account manager.
|
13691
|
+
# `/transactions/refresh` is an optional endpoint that initiates an on-demand extraction to fetch the newest transactions for an Item. The on-demand extraction takes place in addition to the periodic extractions that automatically occur one or more times per day for any Transactions-enabled Item. The Item must already have Transactions added as a product in order to call `/transactions/refresh`. If changes to transactions are discovered after calling `/transactions/refresh`, Plaid will fire a webhook: for `/transactions/sync` users, [`SYNC_UPDATES_AVAILABLE`](https://plaid.com/docs/api/products/transactions/#sync_updates_available) will be fired if there are any transactions updated, added, or removed. For users of both `/transactions/sync` and `/transactions/get`, [`TRANSACTIONS_REMOVED`](https://plaid.com/docs/api/products/transactions/#transactions_removed) will be fired if any removed transactions are detected, and [`DEFAULT_UPDATE`](https://plaid.com/docs/api/products/transactions/#default_update) will be fired if any new transactions are detected. New transactions can be fetched by calling `/transactions/get` or `/transactions/sync`. Note that the `/transactions/refresh` endpoint is not supported for Capital One (`ins_128026`) non-depository accounts and will result in a `PRODUCTS_NOT_SUPPORTED` error if called on an Item that contains only non-depository accounts from that institution. As this endpoint triggers a synchronous request for fresh data, latency may be higher than for other Plaid endpoints (typically less than 10 seconds, but occasionally up to 30 seconds or more); if you encounter errors, you may find it necessary to adjust your timeout period when making requests. `/transactions/refresh` is offered as an optional add-on to Transactions and has a separate [fee model](/docs/account/billing/#per-request-flat-fee). To request access to this endpoint, submit a [product access request](https://dashboard.plaid.com/team/products) or contact your Plaid account manager.
|
13148
13692
|
# @param transactions_refresh_request [TransactionsRefreshRequest]
|
13149
13693
|
# @param [Hash] opts the optional parameters
|
13150
13694
|
# @return [TransactionsRefreshResponse]
|
@@ -13154,7 +13698,7 @@ module Plaid
|
|
13154
13698
|
end
|
13155
13699
|
|
13156
13700
|
# Refresh transaction data
|
13157
|
-
# `/transactions/refresh` is an optional endpoint that initiates an on-demand extraction to fetch the newest transactions for an Item. The on-demand extraction takes place in addition to the periodic extractions that automatically occur one or more times per day for any Transactions-enabled Item. The Item must already have Transactions added as a product in order to call `/transactions/refresh`. If changes to transactions are discovered after calling `/transactions/refresh`, Plaid will fire a webhook: for `/transactions/sync` users, [`SYNC_UPDATES_AVAILABLE`](https://plaid.com/docs/api/products/transactions/#sync_updates_available) will be fired if there are any transactions updated, added, or removed. For users of both `/transactions/sync` and `/transactions/get`, [`TRANSACTIONS_REMOVED`](https://plaid.com/docs/api/products/transactions/#transactions_removed) will be fired if any removed transactions are detected, and [`DEFAULT_UPDATE`](https://plaid.com/docs/api/products/transactions/#default_update) will be fired if any new transactions are detected. New transactions can be fetched by calling `/transactions/get` or `/transactions/sync`. Note that the `/transactions/refresh` endpoint is not supported for Capital One (`ins_128026`) and will result in a `PRODUCTS_NOT_SUPPORTED` error if called on an Item from that institution. As this endpoint triggers a synchronous request for fresh data, latency may be higher than for other Plaid endpoints (typically less than 10 seconds, but occasionally up to 30 seconds or more); if you encounter errors, you may find it necessary to adjust your timeout period when making requests. `/transactions/refresh` is offered as an optional add-on to Transactions and has a separate [fee model](/docs/account/billing/#per-request-flat-fee). To request access to this endpoint, submit a [product access request](https://dashboard.plaid.com/team/products) or contact your Plaid account manager.
|
13701
|
+
# `/transactions/refresh` is an optional endpoint that initiates an on-demand extraction to fetch the newest transactions for an Item. The on-demand extraction takes place in addition to the periodic extractions that automatically occur one or more times per day for any Transactions-enabled Item. The Item must already have Transactions added as a product in order to call `/transactions/refresh`. If changes to transactions are discovered after calling `/transactions/refresh`, Plaid will fire a webhook: for `/transactions/sync` users, [`SYNC_UPDATES_AVAILABLE`](https://plaid.com/docs/api/products/transactions/#sync_updates_available) will be fired if there are any transactions updated, added, or removed. For users of both `/transactions/sync` and `/transactions/get`, [`TRANSACTIONS_REMOVED`](https://plaid.com/docs/api/products/transactions/#transactions_removed) will be fired if any removed transactions are detected, and [`DEFAULT_UPDATE`](https://plaid.com/docs/api/products/transactions/#default_update) will be fired if any new transactions are detected. New transactions can be fetched by calling `/transactions/get` or `/transactions/sync`. Note that the `/transactions/refresh` endpoint is not supported for Capital One (`ins_128026`) non-depository accounts and will result in a `PRODUCTS_NOT_SUPPORTED` error if called on an Item that contains only non-depository accounts from that institution. As this endpoint triggers a synchronous request for fresh data, latency may be higher than for other Plaid endpoints (typically less than 10 seconds, but occasionally up to 30 seconds or more); if you encounter errors, you may find it necessary to adjust your timeout period when making requests. `/transactions/refresh` is offered as an optional add-on to Transactions and has a separate [fee model](/docs/account/billing/#per-request-flat-fee). To request access to this endpoint, submit a [product access request](https://dashboard.plaid.com/team/products) or contact your Plaid account manager.
|
13158
13702
|
# @param transactions_refresh_request [TransactionsRefreshRequest]
|
13159
13703
|
# @param [Hash] opts the optional parameters
|
13160
13704
|
# @return [Array<(TransactionsRefreshResponse, Integer, Hash)>] TransactionsRefreshResponse data, response status code and response headers
|
@@ -16067,6 +16611,74 @@ module Plaid
|
|
16067
16611
|
return data, status_code, headers
|
16068
16612
|
end
|
16069
16613
|
|
16614
|
+
# Retrieve User Account
|
16615
|
+
# Returns user permissioned account data including identity and Item access tokens.
|
16616
|
+
# @param user_account_session_get_request [UserAccountSessionGetRequest]
|
16617
|
+
# @param [Hash] opts the optional parameters
|
16618
|
+
# @return [UserAccountSessionGetResponse]
|
16619
|
+
def user_account_session_get(user_account_session_get_request, opts = {})
|
16620
|
+
data, _status_code, _headers = user_account_session_get_with_http_info(user_account_session_get_request, opts)
|
16621
|
+
data
|
16622
|
+
end
|
16623
|
+
|
16624
|
+
# Retrieve User Account
|
16625
|
+
# Returns user permissioned account data including identity and Item access tokens.
|
16626
|
+
# @param user_account_session_get_request [UserAccountSessionGetRequest]
|
16627
|
+
# @param [Hash] opts the optional parameters
|
16628
|
+
# @return [Array<(UserAccountSessionGetResponse, Integer, Hash)>] UserAccountSessionGetResponse data, response status code and response headers
|
16629
|
+
def user_account_session_get_with_http_info(user_account_session_get_request, opts = {})
|
16630
|
+
if @api_client.config.debugging
|
16631
|
+
@api_client.config.logger.debug 'Calling API: PlaidApi.user_account_session_get ...'
|
16632
|
+
end
|
16633
|
+
# verify the required parameter 'user_account_session_get_request' is set
|
16634
|
+
if @api_client.config.client_side_validation && user_account_session_get_request.nil?
|
16635
|
+
fail ArgumentError, "Missing the required parameter 'user_account_session_get_request' when calling PlaidApi.user_account_session_get"
|
16636
|
+
end
|
16637
|
+
# resource path
|
16638
|
+
local_var_path = '/user_account/session/get'
|
16639
|
+
|
16640
|
+
# query parameters
|
16641
|
+
query_params = opts[:query_params] || {}
|
16642
|
+
|
16643
|
+
# header parameters
|
16644
|
+
header_params = opts[:header_params] || {}
|
16645
|
+
# HTTP header 'Accept' (if needed)
|
16646
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
16647
|
+
# HTTP header 'Content-Type'
|
16648
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
16649
|
+
if !content_type.nil?
|
16650
|
+
header_params['Content-Type'] = content_type
|
16651
|
+
end
|
16652
|
+
|
16653
|
+
# form parameters
|
16654
|
+
form_params = opts[:form_params] || {}
|
16655
|
+
|
16656
|
+
# http body (model)
|
16657
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(user_account_session_get_request)
|
16658
|
+
|
16659
|
+
# return_type
|
16660
|
+
return_type = opts[:debug_return_type] || 'UserAccountSessionGetResponse'
|
16661
|
+
|
16662
|
+
# auth_names
|
16663
|
+
auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
|
16664
|
+
|
16665
|
+
new_options = opts.merge(
|
16666
|
+
:operation => :"PlaidApi.user_account_session_get",
|
16667
|
+
:header_params => header_params,
|
16668
|
+
:query_params => query_params,
|
16669
|
+
:form_params => form_params,
|
16670
|
+
:body => post_body,
|
16671
|
+
:auth_names => auth_names,
|
16672
|
+
:return_type => return_type
|
16673
|
+
)
|
16674
|
+
|
16675
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
16676
|
+
if @api_client.config.debugging
|
16677
|
+
@api_client.config.logger.debug "API called: PlaidApi#user_account_session_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
16678
|
+
end
|
16679
|
+
return data, status_code, headers
|
16680
|
+
end
|
16681
|
+
|
16070
16682
|
# Create user
|
16071
16683
|
# This endpoint should be called for each of your end users before they begin a Plaid income flow. This provides you a single token to access all income data associated with the user. You should only create one per end user. If you call the endpoint multiple times with the same `client_user_id`, the first creation call will succeed and the rest will fail with an error message indicating that the user has been created for the given `client_user_id`. Ensure that you store the `user_token` along with your user's identifier in your database, as it is not possible to retrieve a previously created `user_token`.
|
16072
16684
|
# @param user_create_request [UserCreateRequest]
|
@@ -16135,6 +16747,142 @@ module Plaid
|
|
16135
16747
|
return data, status_code, headers
|
16136
16748
|
end
|
16137
16749
|
|
16750
|
+
# Get Items associated with a User
|
16751
|
+
# Returns Items associated with a User along with their corresponding statuses.
|
16752
|
+
# @param user_items_get_request [UserItemsGetRequest]
|
16753
|
+
# @param [Hash] opts the optional parameters
|
16754
|
+
# @return [UserItemsGetResponse]
|
16755
|
+
def user_items_get(user_items_get_request, opts = {})
|
16756
|
+
data, _status_code, _headers = user_items_get_with_http_info(user_items_get_request, opts)
|
16757
|
+
data
|
16758
|
+
end
|
16759
|
+
|
16760
|
+
# Get Items associated with a User
|
16761
|
+
# Returns Items associated with a User along with their corresponding statuses.
|
16762
|
+
# @param user_items_get_request [UserItemsGetRequest]
|
16763
|
+
# @param [Hash] opts the optional parameters
|
16764
|
+
# @return [Array<(UserItemsGetResponse, Integer, Hash)>] UserItemsGetResponse data, response status code and response headers
|
16765
|
+
def user_items_get_with_http_info(user_items_get_request, opts = {})
|
16766
|
+
if @api_client.config.debugging
|
16767
|
+
@api_client.config.logger.debug 'Calling API: PlaidApi.user_items_get ...'
|
16768
|
+
end
|
16769
|
+
# verify the required parameter 'user_items_get_request' is set
|
16770
|
+
if @api_client.config.client_side_validation && user_items_get_request.nil?
|
16771
|
+
fail ArgumentError, "Missing the required parameter 'user_items_get_request' when calling PlaidApi.user_items_get"
|
16772
|
+
end
|
16773
|
+
# resource path
|
16774
|
+
local_var_path = '/user/items/get'
|
16775
|
+
|
16776
|
+
# query parameters
|
16777
|
+
query_params = opts[:query_params] || {}
|
16778
|
+
|
16779
|
+
# header parameters
|
16780
|
+
header_params = opts[:header_params] || {}
|
16781
|
+
# HTTP header 'Accept' (if needed)
|
16782
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
16783
|
+
# HTTP header 'Content-Type'
|
16784
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
16785
|
+
if !content_type.nil?
|
16786
|
+
header_params['Content-Type'] = content_type
|
16787
|
+
end
|
16788
|
+
|
16789
|
+
# form parameters
|
16790
|
+
form_params = opts[:form_params] || {}
|
16791
|
+
|
16792
|
+
# http body (model)
|
16793
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(user_items_get_request)
|
16794
|
+
|
16795
|
+
# return_type
|
16796
|
+
return_type = opts[:debug_return_type] || 'UserItemsGetResponse'
|
16797
|
+
|
16798
|
+
# auth_names
|
16799
|
+
auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
|
16800
|
+
|
16801
|
+
new_options = opts.merge(
|
16802
|
+
:operation => :"PlaidApi.user_items_get",
|
16803
|
+
:header_params => header_params,
|
16804
|
+
:query_params => query_params,
|
16805
|
+
:form_params => form_params,
|
16806
|
+
:body => post_body,
|
16807
|
+
:auth_names => auth_names,
|
16808
|
+
:return_type => return_type
|
16809
|
+
)
|
16810
|
+
|
16811
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
16812
|
+
if @api_client.config.debugging
|
16813
|
+
@api_client.config.logger.debug "API called: PlaidApi#user_items_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
16814
|
+
end
|
16815
|
+
return data, status_code, headers
|
16816
|
+
end
|
16817
|
+
|
16818
|
+
# Remove user
|
16819
|
+
# This endpoint is used to remove a user and any relevant data related to the user based on the provided user token. Any subsequent calls to retrieve information using the same user token will result in an error stating the user does not exist.
|
16820
|
+
# @param user_remove_request [UserRemoveRequest]
|
16821
|
+
# @param [Hash] opts the optional parameters
|
16822
|
+
# @return [UserRemoveResponse]
|
16823
|
+
def user_remove(user_remove_request, opts = {})
|
16824
|
+
data, _status_code, _headers = user_remove_with_http_info(user_remove_request, opts)
|
16825
|
+
data
|
16826
|
+
end
|
16827
|
+
|
16828
|
+
# Remove user
|
16829
|
+
# This endpoint is used to remove a user and any relevant data related to the user based on the provided user token. Any subsequent calls to retrieve information using the same user token will result in an error stating the user does not exist.
|
16830
|
+
# @param user_remove_request [UserRemoveRequest]
|
16831
|
+
# @param [Hash] opts the optional parameters
|
16832
|
+
# @return [Array<(UserRemoveResponse, Integer, Hash)>] UserRemoveResponse data, response status code and response headers
|
16833
|
+
def user_remove_with_http_info(user_remove_request, opts = {})
|
16834
|
+
if @api_client.config.debugging
|
16835
|
+
@api_client.config.logger.debug 'Calling API: PlaidApi.user_remove ...'
|
16836
|
+
end
|
16837
|
+
# verify the required parameter 'user_remove_request' is set
|
16838
|
+
if @api_client.config.client_side_validation && user_remove_request.nil?
|
16839
|
+
fail ArgumentError, "Missing the required parameter 'user_remove_request' when calling PlaidApi.user_remove"
|
16840
|
+
end
|
16841
|
+
# resource path
|
16842
|
+
local_var_path = '/user/remove'
|
16843
|
+
|
16844
|
+
# query parameters
|
16845
|
+
query_params = opts[:query_params] || {}
|
16846
|
+
|
16847
|
+
# header parameters
|
16848
|
+
header_params = opts[:header_params] || {}
|
16849
|
+
# HTTP header 'Accept' (if needed)
|
16850
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
16851
|
+
# HTTP header 'Content-Type'
|
16852
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
16853
|
+
if !content_type.nil?
|
16854
|
+
header_params['Content-Type'] = content_type
|
16855
|
+
end
|
16856
|
+
|
16857
|
+
# form parameters
|
16858
|
+
form_params = opts[:form_params] || {}
|
16859
|
+
|
16860
|
+
# http body (model)
|
16861
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(user_remove_request)
|
16862
|
+
|
16863
|
+
# return_type
|
16864
|
+
return_type = opts[:debug_return_type] || 'UserRemoveResponse'
|
16865
|
+
|
16866
|
+
# auth_names
|
16867
|
+
auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
|
16868
|
+
|
16869
|
+
new_options = opts.merge(
|
16870
|
+
:operation => :"PlaidApi.user_remove",
|
16871
|
+
:header_params => header_params,
|
16872
|
+
:query_params => query_params,
|
16873
|
+
:form_params => form_params,
|
16874
|
+
:body => post_body,
|
16875
|
+
:auth_names => auth_names,
|
16876
|
+
:return_type => return_type
|
16877
|
+
)
|
16878
|
+
|
16879
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
16880
|
+
if @api_client.config.debugging
|
16881
|
+
@api_client.config.logger.debug "API called: PlaidApi#user_remove\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
16882
|
+
end
|
16883
|
+
return data, status_code, headers
|
16884
|
+
end
|
16885
|
+
|
16138
16886
|
# Update user information
|
16139
16887
|
# This endpoint is used to update user information associated with an existing `user_token`. The `user_token` should be in the response of `/user/create` call If you call the endpoint with a non-exist `user_token`, the call will fail with an error message indicating that the user token is not found.
|
16140
16888
|
# @param user_update_request [UserUpdateRequest]
|