plaid 15.4.0 → 15.7.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 +184 -0
- data/Gemfile.lock +5 -5
- data/Makefile +1 -1
- data/README.md +36 -1
- data/lib/plaid/api/plaid_api.rb +2117 -169
- data/lib/plaid/api_client.rb +4 -4
- data/lib/plaid/api_error.rb +1 -1
- data/lib/plaid/configuration.rb +1 -1
- data/lib/plaid/models/account_access.rb +1 -1
- data/lib/plaid/models/account_assets.rb +1 -1
- data/lib/plaid/models/account_assets_all_of.rb +1 -1
- data/lib/plaid/models/account_balance.rb +1 -1
- data/lib/plaid/models/account_base.rb +1 -1
- data/lib/plaid/models/account_filter.rb +1 -1
- data/lib/plaid/models/account_filters_response.rb +1 -1
- data/lib/plaid/models/account_identity.rb +1 -1
- data/lib/plaid/models/account_identity_all_of.rb +1 -1
- data/lib/plaid/models/account_product_access.rb +1 -1
- data/lib/plaid/models/account_product_access_nullable.rb +1 -1
- data/lib/plaid/models/account_selection_cardinality.rb +1 -1
- data/lib/plaid/models/account_subtype.rb +1 -1
- data/lib/plaid/models/account_type.rb +1 -1
- data/lib/plaid/models/accounts_balance_get_request.rb +1 -1
- data/lib/plaid/models/accounts_balance_get_request_options.rb +1 -1
- data/lib/plaid/models/accounts_get_request.rb +1 -1
- data/lib/plaid/models/accounts_get_request_options.rb +1 -1
- data/lib/plaid/models/accounts_get_response.rb +1 -1
- data/lib/plaid/models/ach_class.rb +1 -12
- data/lib/plaid/models/address.rb +1 -1
- data/lib/plaid/models/address_data.rb +1 -1
- data/lib/plaid/models/address_data_nullable.rb +1 -1
- data/lib/plaid/models/address_nullable.rb +1 -1
- data/lib/plaid/models/address_purpose_label.rb +40 -0
- data/lib/plaid/models/application.rb +10 -9
- 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_report.rb +1 -1
- data/lib/plaid/models/asset_report_audit_copy_create_request.rb +1 -1
- data/lib/plaid/models/asset_report_audit_copy_create_response.rb +1 -1
- data/lib/plaid/models/asset_report_audit_copy_get_request.rb +1 -1
- data/lib/plaid/models/asset_report_audit_copy_remove_request.rb +1 -1
- data/lib/plaid/models/asset_report_audit_copy_remove_response.rb +1 -1
- data/lib/plaid/models/asset_report_create_request.rb +2 -2
- data/lib/plaid/models/asset_report_create_request_options.rb +13 -2
- data/lib/plaid/models/asset_report_create_response.rb +1 -1
- data/lib/plaid/models/asset_report_filter_request.rb +1 -1
- data/lib/plaid/models/asset_report_filter_response.rb +1 -1
- data/lib/plaid/models/asset_report_get_request.rb +17 -5
- data/lib/plaid/models/asset_report_get_response.rb +1 -1
- data/lib/plaid/models/asset_report_item.rb +1 -1
- data/lib/plaid/models/asset_report_pdf_get_request.rb +1 -1
- data/lib/plaid/models/asset_report_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_relay_create_request.rb +1 -1
- data/lib/plaid/models/asset_report_relay_create_response.rb +1 -1
- data/lib/plaid/models/asset_report_relay_get_request.rb +1 -1
- data/lib/plaid/models/asset_report_relay_refresh_request.rb +1 -1
- data/lib/plaid/models/asset_report_relay_refresh_response.rb +1 -1
- data/lib/plaid/models/asset_report_relay_remove_request.rb +1 -1
- data/lib/plaid/models/asset_report_relay_remove_response.rb +1 -1
- data/lib/plaid/models/asset_report_remove_request.rb +1 -1
- data/lib/plaid/models/asset_report_remove_response.rb +1 -1
- data/lib/plaid/models/asset_report_transaction.rb +1 -1
- data/lib/plaid/models/asset_report_transaction_all_of.rb +1 -1
- data/lib/plaid/models/asset_report_user.rb +1 -1
- data/lib/plaid/models/assets_error_webhook.rb +1 -1
- data/lib/plaid/models/assets_product_ready_webhook.rb +1 -1
- data/lib/plaid/models/assets_relay_webhook.rb +1 -1
- data/lib/plaid/models/auth_get_numbers.rb +1 -1
- data/lib/plaid/models/auth_get_request.rb +1 -1
- data/lib/plaid/models/auth_get_request_options.rb +1 -1
- data/lib/plaid/models/auth_get_response.rb +1 -1
- data/lib/plaid/models/auth_metadata.rb +1 -1
- data/lib/plaid/models/auth_supported_methods.rb +1 -1
- data/lib/plaid/models/automatically_verified_webhook.rb +1 -1
- data/lib/plaid/models/bank_initiated_return_risk.rb +1 -1
- data/lib/plaid/models/bank_transfer.rb +1 -1
- data/lib/plaid/models/bank_transfer_balance.rb +1 -1
- data/lib/plaid/models/bank_transfer_balance_get_request.rb +1 -1
- data/lib/plaid/models/bank_transfer_balance_get_response.rb +1 -1
- data/lib/plaid/models/bank_transfer_cancel_request.rb +1 -1
- data/lib/plaid/models/bank_transfer_cancel_response.rb +1 -1
- data/lib/plaid/models/bank_transfer_create_request.rb +1 -1
- data/lib/plaid/models/bank_transfer_create_response.rb +1 -1
- data/lib/plaid/models/bank_transfer_direction.rb +1 -1
- data/lib/plaid/models/bank_transfer_event.rb +1 -1
- data/lib/plaid/models/bank_transfer_event_list_bank_transfer_type.rb +1 -1
- data/lib/plaid/models/bank_transfer_event_list_direction.rb +1 -1
- data/lib/plaid/models/bank_transfer_event_list_request.rb +1 -1
- data/lib/plaid/models/bank_transfer_event_list_response.rb +1 -1
- data/lib/plaid/models/bank_transfer_event_sync_request.rb +1 -1
- data/lib/plaid/models/bank_transfer_event_sync_response.rb +1 -1
- data/lib/plaid/models/bank_transfer_event_type.rb +1 -1
- data/lib/plaid/models/bank_transfer_failure.rb +1 -1
- data/lib/plaid/models/bank_transfer_get_request.rb +1 -1
- data/lib/plaid/models/bank_transfer_get_response.rb +1 -1
- data/lib/plaid/models/bank_transfer_list_request.rb +1 -1
- data/lib/plaid/models/bank_transfer_list_response.rb +1 -1
- data/lib/plaid/models/bank_transfer_migrate_account_request.rb +1 -1
- data/lib/plaid/models/bank_transfer_migrate_account_response.rb +1 -1
- data/lib/plaid/models/bank_transfer_network.rb +1 -1
- data/lib/plaid/models/bank_transfer_status.rb +1 -1
- data/lib/plaid/models/bank_transfer_sweep.rb +1 -1
- data/lib/plaid/models/bank_transfer_sweep_get_request.rb +1 -1
- data/lib/plaid/models/bank_transfer_sweep_get_response.rb +1 -1
- data/lib/plaid/models/bank_transfer_sweep_list_request.rb +1 -1
- data/lib/plaid/models/bank_transfer_sweep_list_response.rb +1 -1
- data/lib/plaid/models/bank_transfer_type.rb +1 -1
- data/lib/plaid/models/bank_transfer_user.rb +1 -1
- data/lib/plaid/models/bank_transfers_events_update_webhook.rb +1 -1
- data/lib/plaid/models/categories_get_response.rb +1 -1
- data/lib/plaid/models/category.rb +1 -1
- data/lib/plaid/models/cause.rb +2 -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_raw_transaction.rb +1 -1
- data/lib/plaid/models/connected_application.rb +13 -2
- data/lib/plaid/models/country_code.rb +1 -1
- data/lib/plaid/models/{transactions_recurring_deactivate_request.rb → create_entity_screening_request.rb} +28 -29
- data/lib/plaid/models/create_entity_watchlist_screening_review_request.rb +307 -0
- data/lib/plaid/models/create_individual_watchlist_screening_review_request.rb +307 -0
- data/lib/plaid/models/credit_account_subtype.rb +1 -1
- data/lib/plaid/models/credit_audit_copy_token_create_request.rb +262 -0
- data/lib/plaid/models/credit_audit_copy_token_create_response.rb +240 -0
- 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 +8 -8
- data/lib/plaid/models/credit_bank_income_pay_frequency.rb +1 -1
- data/lib/plaid/models/credit_bank_income_refresh_request.rb +1 -1
- data/lib/plaid/models/credit_bank_income_refresh_request_options.rb +1 -1
- data/lib/plaid/models/credit_bank_income_refresh_response.rb +1 -1
- data/lib/plaid/models/credit_bank_income_source.rb +1 -1
- data/lib/plaid/models/credit_bank_income_summary.rb +1 -1
- data/lib/plaid/models/credit_bank_income_transaction.rb +1 -1
- data/lib/plaid/models/credit_bank_income_warning.rb +1 -1
- data/lib/plaid/models/credit_bank_income_warning_code.rb +1 -1
- data/lib/plaid/models/credit_bank_income_warning_type.rb +1 -1
- data/lib/plaid/models/credit_card_liability.rb +1 -1
- data/lib/plaid/models/credit_document_metadata.rb +1 -1
- data/lib/plaid/models/credit_employer_verification.rb +1 -1
- data/lib/plaid/models/credit_employment_get_request.rb +1 -1
- data/lib/plaid/models/credit_employment_get_response.rb +1 -1
- data/lib/plaid/models/credit_employment_item.rb +1 -1
- data/lib/plaid/models/credit_employment_verification.rb +27 -5
- data/lib/plaid/models/credit_filter.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_verification.rb +1 -1
- data/lib/plaid/models/credit_payroll_income_get_request.rb +1 -1
- data/lib/plaid/models/credit_payroll_income_get_response.rb +20 -5
- 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_response.rb +1 -1
- data/lib/plaid/models/credit_payroll_income_risk_signals_get_request.rb +240 -0
- data/lib/plaid/models/credit_payroll_income_risk_signals_get_response.rb +251 -0
- data/lib/plaid/models/credit_platform_ids.rb +1 -1
- data/lib/plaid/models/credit_relay_create_request.rb +273 -0
- data/lib/plaid/models/credit_relay_create_response.rb +240 -0
- 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 +269 -0
- data/lib/plaid/models/dashboard_user_response.rb +284 -0
- data/lib/plaid/models/dashboard_user_status.rb +40 -0
- data/lib/plaid/models/date_range.rb +240 -0
- 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/distribution_breakdown.rb +1 -1
- data/lib/plaid/models/doc_type.rb +1 -1
- data/lib/plaid/models/document_analysis.rb +248 -0
- data/lib/plaid/models/document_authenticity_match_code.rb +41 -0
- data/lib/plaid/models/document_date_of_birth_match_code.rb +40 -0
- data/lib/plaid/models/document_metadata.rb +1 -1
- data/lib/plaid/models/document_name_match_code.rb +40 -0
- data/lib/plaid/models/document_risk_signal.rb +274 -0
- data/lib/plaid/models/{transactions_recurring_deactivate_response.rb → document_risk_signal_institution_metadata.rb} +16 -16
- data/lib/plaid/models/document_risk_signals_object.rb +255 -0
- data/lib/plaid/models/document_status.rb +40 -0
- data/lib/plaid/models/{payment_initiation_refund.rb → documentary_verification.rb} +20 -46
- data/lib/plaid/models/documentary_verification_document.rb +277 -0
- 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/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_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 +24 -2
- data/lib/plaid/models/entity_document.rb +271 -0
- data/lib/plaid/models/entity_document_type.rb +43 -0
- data/lib/plaid/models/entity_screening_hit_analysis.rb +279 -0
- data/lib/plaid/models/entity_screening_hit_data.rb +282 -0
- data/lib/plaid/models/entity_screening_hit_documents_items.rb +228 -0
- data/lib/plaid/models/entity_screening_hit_emails.rb +225 -0
- data/lib/plaid/models/entity_screening_hit_emails_items.rb +228 -0
- data/lib/plaid/models/entity_screening_hit_names.rb +254 -0
- data/lib/plaid/models/entity_screening_hit_names_items.rb +228 -0
- data/lib/plaid/models/entity_screening_hit_phone_numbers.rb +262 -0
- data/lib/plaid/models/entity_screening_hit_urls.rb +225 -0
- data/lib/plaid/models/entity_screening_hit_urls_items.rb +228 -0
- data/lib/plaid/models/entity_screening_hits_phone_number_items.rb +228 -0
- data/lib/plaid/models/entity_screening_status_updated_webhook.rb +251 -0
- data/lib/plaid/models/entity_watchlist_code.rb +50 -0
- data/lib/plaid/models/entity_watchlist_program.rb +374 -0
- data/lib/plaid/models/entity_watchlist_program_response.rb +389 -0
- data/lib/plaid/models/entity_watchlist_screening.rb +287 -0
- data/lib/plaid/models/entity_watchlist_screening_hit.rb +351 -0
- data/lib/plaid/models/entity_watchlist_screening_response.rb +302 -0
- data/lib/plaid/models/entity_watchlist_screening_review.rb +301 -0
- data/lib/plaid/models/entity_watchlist_screening_review_response.rb +316 -0
- data/lib/plaid/models/entity_watchlist_screening_search_terms.rb +337 -0
- data/lib/plaid/models/entity_watchlist_search_terms.rb +322 -0
- data/lib/plaid/models/error.rb +2 -1
- data/lib/plaid/models/expiration_date.rb +40 -0
- data/lib/plaid/models/external_payment_initiation_consent_options.rb +53 -6
- 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/generic_screening_hit_location_items.rb +228 -0
- data/lib/plaid/models/get_dashboard_user_request.rb +245 -0
- data/lib/plaid/models/get_entity_watchlist_screening_request.rb +245 -0
- data/lib/plaid/models/get_identity_verification_request.rb +245 -0
- data/lib/plaid/models/get_individual_watchlist_screening_request.rb +245 -0
- data/lib/plaid/models/get_watchlist_screening_entity_program_request.rb +245 -0
- data/lib/plaid/models/get_watchlist_screening_individual_program_request.rb +245 -0
- 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 +2 -2
- data/lib/plaid/models/holdings_default_update_webhook.rb +1 -1
- data/lib/plaid/models/holdings_override.rb +1 -1
- data/lib/plaid/models/id_number_type.rb +72 -0
- data/lib/plaid/models/identity_default_update_webhook.rb +1 -1
- data/lib/plaid/models/identity_get_request.rb +1 -1
- data/lib/plaid/models/identity_get_request_options.rb +1 -1
- data/lib/plaid/models/identity_get_response.rb +1 -1
- data/lib/plaid/models/identity_update_types.rb +1 -1
- data/lib/plaid/models/identity_verification.rb +406 -0
- data/lib/plaid/models/identity_verification_create_request.rb +302 -0
- data/lib/plaid/models/identity_verification_request_user.rb +338 -0
- data/lib/plaid/models/identity_verification_response.rb +421 -0
- data/lib/plaid/models/identity_verification_retried_webhook.rb +251 -0
- data/lib/plaid/models/identity_verification_retry_request.rb +316 -0
- data/lib/plaid/models/identity_verification_retry_request_steps_object.rb +270 -0
- data/lib/plaid/models/identity_verification_status.rb +43 -0
- data/lib/plaid/models/identity_verification_status_updated_webhook.rb +251 -0
- data/lib/plaid/models/identity_verification_step_status.rb +48 -0
- data/lib/plaid/models/identity_verification_step_summary.rb +308 -0
- data/lib/plaid/models/identity_verification_step_updated_webhook.rb +251 -0
- data/lib/plaid/models/identity_verification_template_reference.rb +240 -0
- data/lib/plaid/models/identity_verification_user_address.rb +308 -0
- data/lib/plaid/models/identity_verification_user_data.rb +302 -0
- data/lib/plaid/models/image_quality.rb +40 -0
- data/lib/plaid/models/incident_update.rb +1 -1
- data/lib/plaid/models/income_breakdown.rb +1 -1
- data/lib/plaid/models/income_breakdown_type.rb +1 -1
- data/lib/plaid/models/income_override.rb +1 -1
- data/lib/plaid/models/income_summary.rb +1 -1
- data/lib/plaid/models/income_summary_field_number.rb +1 -1
- data/lib/plaid/models/income_summary_field_string.rb +1 -1
- data/lib/plaid/models/income_verification_create_request.rb +1 -1
- data/lib/plaid/models/income_verification_create_request_options.rb +1 -1
- data/lib/plaid/models/income_verification_create_response.rb +1 -1
- data/lib/plaid/models/income_verification_documents_download_request.rb +1 -1
- data/lib/plaid/models/income_verification_payroll_flow_type.rb +1 -1
- data/lib/plaid/models/income_verification_paystubs_get_request.rb +1 -1
- data/lib/plaid/models/income_verification_paystubs_get_response.rb +1 -1
- data/lib/plaid/models/income_verification_precheck_confidence.rb +1 -1
- data/lib/plaid/models/income_verification_precheck_employer.rb +1 -1
- data/lib/plaid/models/income_verification_precheck_employer_address.rb +1 -1
- data/lib/plaid/models/income_verification_precheck_employer_address_data.rb +1 -1
- data/lib/plaid/models/income_verification_precheck_military_info.rb +1 -1
- data/lib/plaid/models/income_verification_precheck_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_request.rb +1 -1
- data/lib/plaid/models/income_verification_refresh_response.rb +1 -1
- data/lib/plaid/models/income_verification_source_type.rb +1 -1
- data/lib/plaid/models/income_verification_status_webhook.rb +12 -2
- 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_screening_hit_names.rb +254 -0
- data/lib/plaid/models/individual_watchlist_code.rb +59 -0
- data/lib/plaid/models/individual_watchlist_program.rb +374 -0
- data/lib/plaid/models/individual_watchlist_program_response.rb +389 -0
- 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/institutions_get_by_id_request.rb +1 -1
- data/lib/plaid/models/institutions_get_by_id_request_options.rb +1 -1
- data/lib/plaid/models/institutions_get_by_id_response.rb +1 -1
- data/lib/plaid/models/institutions_get_request.rb +1 -1
- data/lib/plaid/models/institutions_get_request_options.rb +1 -1
- data/lib/plaid/models/institutions_get_response.rb +1 -1
- data/lib/plaid/models/institutions_search_account_filter.rb +1 -1
- data/lib/plaid/models/institutions_search_payment_initiation_options.rb +1 -1
- data/lib/plaid/models/institutions_search_request.rb +1 -1
- data/lib/plaid/models/institutions_search_request_options.rb +1 -1
- data/lib/plaid/models/institutions_search_response.rb +1 -1
- data/lib/plaid/models/investment_account_subtype.rb +1 -1
- data/lib/plaid/models/investment_filter.rb +1 -1
- data/lib/plaid/models/investment_holdings_get_request_options.rb +1 -1
- data/lib/plaid/models/investment_transaction.rb +1 -1
- data/lib/plaid/models/investment_transaction_subtype.rb +1 -1
- data/lib/plaid/models/investment_transaction_type.rb +1 -1
- data/lib/plaid/models/investments_default_update_webhook.rb +1 -1
- data/lib/plaid/models/investments_holdings_get_request.rb +1 -1
- data/lib/plaid/models/investments_holdings_get_response.rb +1 -1
- data/lib/plaid/models/investments_transactions_get_request.rb +1 -1
- data/lib/plaid/models/investments_transactions_get_request_options.rb +1 -1
- data/lib/plaid/models/investments_transactions_get_response.rb +1 -1
- data/lib/plaid/models/investments_transactions_override.rb +1 -1
- data/lib/plaid/models/issuing_country.rb +39 -0
- data/lib/plaid/models/item.rb +1 -1
- data/lib/plaid/models/item_access_token_invalidate_request.rb +1 -1
- data/lib/plaid/models/item_access_token_invalidate_response.rb +1 -1
- data/lib/plaid/models/item_application_list_request.rb +1 -1
- data/lib/plaid/models/item_application_list_response.rb +1 -1
- data/lib/plaid/models/item_application_list_user_auth.rb +1 -1
- data/lib/plaid/models/item_application_scopes_update_request.rb +1 -1
- data/lib/plaid/models/item_application_scopes_update_response.rb +1 -1
- data/lib/plaid/models/item_error_webhook.rb +1 -1
- data/lib/plaid/models/item_get_request.rb +1 -1
- data/lib/plaid/models/item_get_response.rb +1 -1
- data/lib/plaid/models/item_import_request.rb +1 -1
- data/lib/plaid/models/item_import_request_options.rb +1 -1
- data/lib/plaid/models/item_import_request_user_auth.rb +1 -1
- data/lib/plaid/models/item_import_response.rb +1 -1
- data/lib/plaid/models/item_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 +252 -0
- data/lib/plaid/models/kyc_check_date_of_birth_summary.rb +224 -0
- data/lib/plaid/models/kyc_check_details.rb +295 -0
- data/lib/plaid/models/kyc_check_id_number_summary.rb +224 -0
- data/lib/plaid/models/kyc_check_name_summary.rb +224 -0
- data/lib/plaid/models/kyc_check_phone_summary.rb +224 -0
- data/lib/plaid/models/liabilities_default_update_webhook.rb +1 -1
- data/lib/plaid/models/liabilities_get_request.rb +1 -1
- data/lib/plaid/models/liabilities_get_request_options.rb +1 -1
- data/lib/plaid/models/liabilities_get_response.rb +1 -1
- data/lib/plaid/models/liabilities_object.rb +1 -1
- data/lib/plaid/models/liability_override.rb +1 -1
- data/lib/plaid/models/link_token_account_filters.rb +1 -1
- data/lib/plaid/models/link_token_create_credit_filter.rb +1 -1
- data/lib/plaid/models/link_token_create_depository_filter.rb +1 -1
- data/lib/plaid/models/link_token_create_institution_data.rb +1 -1
- data/lib/plaid/models/link_token_create_investment_filter.rb +1 -1
- data/lib/plaid/models/link_token_create_loan_filter.rb +1 -1
- data/lib/plaid/models/link_token_create_request.rb +14 -2
- data/lib/plaid/models/link_token_create_request_account_subtypes.rb +1 -1
- data/lib/plaid/models/link_token_create_request_auth.rb +46 -9
- data/lib/plaid/models/link_token_create_request_deposit_switch.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 +18 -5
- data/lib/plaid/models/link_token_create_request_income_verification_payroll_income.rb +16 -6
- data/lib/plaid/models/link_token_create_request_payment_initiation.rb +32 -5
- data/lib/plaid/models/link_token_create_request_transfer.rb +1 -1
- data/lib/plaid/models/link_token_create_request_update.rb +1 -1
- data/lib/plaid/models/link_token_create_request_user.rb +1 -1
- data/lib/plaid/models/link_token_create_response.rb +1 -1
- data/lib/plaid/models/link_token_eu_config.rb +1 -1
- data/lib/plaid/models/link_token_get_metadata_response.rb +1 -1
- data/lib/plaid/models/link_token_get_request.rb +1 -1
- data/lib/plaid/models/link_token_get_response.rb +1 -1
- data/lib/plaid/models/list_dashboard_user_request.rb +241 -0
- data/lib/plaid/models/list_entity_watchlist_screening_request.rb +286 -0
- data/lib/plaid/models/list_identity_verification_request.rb +303 -0
- data/lib/plaid/models/list_individual_watchlist_screening_request.rb +286 -0
- data/lib/plaid/models/list_watchlist_screening_entity_history_request.rb +256 -0
- data/lib/plaid/models/list_watchlist_screening_entity_hit_request.rb +256 -0
- data/lib/plaid/models/list_watchlist_screening_entity_programs_request.rb +241 -0
- data/lib/plaid/models/list_watchlist_screening_entity_reviews_request.rb +256 -0
- data/lib/plaid/models/list_watchlist_screening_individual_history_request.rb +256 -0
- data/lib/plaid/models/list_watchlist_screening_individual_hit_request.rb +256 -0
- data/lib/plaid/models/list_watchlist_screening_individual_programs_request.rb +241 -0
- data/lib/plaid/models/list_watchlist_screening_individual_reviews_request.rb +256 -0
- data/lib/plaid/models/loan_account_subtype.rb +1 -1
- data/lib/plaid/models/loan_filter.rb +1 -1
- data/lib/plaid/models/location.rb +1 -1
- data/lib/plaid/models/match_summary.rb +224 -0
- data/lib/plaid/models/match_summary_code.rb +42 -0
- data/lib/plaid/models/meta.rb +1 -1
- data/lib/plaid/models/mfa.rb +1 -1
- data/lib/plaid/models/mortgage_interest_rate.rb +1 -1
- data/lib/plaid/models/mortgage_liability.rb +1 -1
- data/lib/plaid/models/mortgage_property_address.rb +1 -1
- data/lib/plaid/models/multi_document_risk_signal.rb +244 -0
- data/lib/plaid/models/net_pay.rb +1 -1
- data/lib/plaid/models/new_accounts_available_webhook.rb +1 -1
- data/lib/plaid/models/numbers.rb +1 -1
- data/lib/plaid/models/numbers_ach.rb +1 -1
- data/lib/plaid/models/numbers_ach_nullable.rb +1 -1
- data/lib/plaid/models/numbers_bacs.rb +1 -1
- data/lib/plaid/models/numbers_bacs_nullable.rb +1 -1
- data/lib/plaid/models/numbers_eft.rb +1 -1
- data/lib/plaid/models/numbers_eft_nullable.rb +1 -1
- data/lib/plaid/models/numbers_international.rb +1 -1
- data/lib/plaid/models/numbers_international_nullable.rb +1 -1
- data/lib/plaid/models/override_account_type.rb +1 -1
- data/lib/plaid/models/override_accounts.rb +1 -1
- data/lib/plaid/models/owner.rb +1 -1
- data/lib/plaid/models/owner_override.rb +1 -1
- data/lib/plaid/models/paginated_dashboard_user_list_response.rb +253 -0
- data/lib/plaid/models/paginated_entity_watchlist_program_list_response.rb +253 -0
- data/lib/plaid/models/paginated_entity_watchlist_screening_hit_list_response.rb +253 -0
- data/lib/plaid/models/paginated_entity_watchlist_screening_list_response.rb +253 -0
- data/lib/plaid/models/paginated_entity_watchlist_screening_review_list_response.rb +253 -0
- data/lib/plaid/models/paginated_identity_verification_list_response.rb +253 -0
- data/lib/plaid/models/paginated_individual_watchlist_program_list_response.rb +253 -0
- data/lib/plaid/models/paginated_individual_watchlist_screening_hit_list_response.rb +253 -0
- data/lib/plaid/models/paginated_individual_watchlist_screening_list_response.rb +253 -0
- data/lib/plaid/models/paginated_individual_watchlist_screening_review_list_response.rb +253 -0
- data/lib/plaid/models/pay.rb +1 -1
- data/lib/plaid/models/pay_frequency.rb +1 -1
- data/lib/plaid/models/pay_frequency_value.rb +1 -1
- data/lib/plaid/models/pay_period_details.rb +1 -1
- data/lib/plaid/models/pay_stub_deductions_breakdown.rb +1 -1
- data/lib/plaid/models/pay_stub_deductions_total.rb +1 -1
- data/lib/plaid/models/pay_stub_distribution_breakdown.rb +1 -1
- data/lib/plaid/models/pay_stub_earnings_breakdown.rb +1 -1
- data/lib/plaid/models/pay_stub_earnings_total.rb +1 -1
- data/lib/plaid/models/pay_stub_pay_period_details.rb +1 -1
- data/lib/plaid/models/pay_stub_taxpayer_id.rb +1 -1
- data/lib/plaid/models/pay_stub_verification_attribute.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_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 +6 -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 +32 -1
- data/lib/plaid/models/payment_initiation_consent_create_request.rb +1 -1
- data/lib/plaid/models/payment_initiation_consent_create_response.rb +1 -1
- data/lib/plaid/models/payment_initiation_consent_get_request.rb +1 -1
- data/lib/plaid/models/payment_initiation_consent_get_response.rb +1 -1
- data/lib/plaid/models/payment_initiation_consent_payment_execute_request.rb +1 -1
- data/lib/plaid/models/payment_initiation_consent_payment_execute_response.rb +1 -1
- data/lib/plaid/models/payment_initiation_consent_revoke_request.rb +1 -1
- data/lib/plaid/models/payment_initiation_consent_revoke_response.rb +1 -1
- data/lib/plaid/models/payment_initiation_consent_scope.rb +1 -1
- data/lib/plaid/models/payment_initiation_consent_status.rb +1 -1
- data/lib/plaid/models/payment_initiation_metadata.rb +17 -2
- data/lib/plaid/models/payment_initiation_optional_restriction_bacs.rb +1 -1
- data/lib/plaid/models/payment_initiation_payment.rb +11 -10
- 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 +11 -10
- data/lib/plaid/models/payment_initiation_payment_list_request.rb +34 -6
- data/lib/plaid/models/payment_initiation_payment_list_response.rb +1 -1
- data/lib/plaid/models/payment_initiation_payment_reverse_request.rb +95 -5
- 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 +6 -17
- 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 +2 -13
- 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_refund_status.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_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 +246 -0
- data/lib/plaid/models/payroll_income_object.rb +1 -1
- data/lib/plaid/models/payroll_income_rate_of_pay.rb +232 -0
- data/lib/plaid/models/payroll_item.rb +18 -2
- data/lib/plaid/models/payroll_item_status.rb +2 -2
- data/lib/plaid/models/payroll_risk_signals_item.rb +242 -0
- data/lib/plaid/models/paystub.rb +1 -1
- data/lib/plaid/models/paystub_address.rb +1 -1
- data/lib/plaid/models/paystub_deduction.rb +1 -1
- data/lib/plaid/models/paystub_details.rb +1 -1
- data/lib/plaid/models/paystub_employer.rb +1 -1
- data/lib/plaid/models/paystub_override.rb +1 -1
- data/lib/plaid/models/paystub_override_employee.rb +1 -1
- data/lib/plaid/models/paystub_override_employee_address.rb +1 -1
- data/lib/plaid/models/paystub_override_employer.rb +1 -1
- data/lib/plaid/models/paystub_pay_frequency.rb +1 -1
- data/lib/plaid/models/paystub_verification.rb +1 -1
- data/lib/plaid/models/paystub_verification_status.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_type.rb +39 -0
- data/lib/plaid/models/physical_document_category.rb +42 -0
- data/lib/plaid/models/physical_document_extracted_data.rb +311 -0
- data/lib/plaid/models/physical_document_extracted_data_analysis.rb +266 -0
- data/lib/plaid/models/physical_document_images.rb +269 -0
- data/lib/plaid/models/plaid_error.rb +2 -1
- data/lib/plaid/models/platform_ids.rb +1 -1
- data/lib/plaid/models/po_box_status.rb +40 -0
- data/lib/plaid/models/processor_apex_processor_token_create_request.rb +1 -1
- data/lib/plaid/models/processor_auth_get_request.rb +1 -1
- data/lib/plaid/models/processor_auth_get_response.rb +1 -1
- data/lib/plaid/models/processor_balance_get_request.rb +1 -1
- data/lib/plaid/models/processor_balance_get_request_options.rb +1 -1
- data/lib/plaid/models/processor_balance_get_response.rb +1 -1
- data/lib/plaid/models/processor_bank_transfer_create_request.rb +1 -1
- data/lib/plaid/models/processor_bank_transfer_create_response.rb +1 -1
- data/lib/plaid/models/processor_identity_get_request.rb +1 -1
- data/lib/plaid/models/processor_identity_get_response.rb +1 -1
- data/lib/plaid/models/processor_number.rb +1 -1
- data/lib/plaid/models/processor_stripe_bank_account_token_create_request.rb +1 -1
- data/lib/plaid/models/processor_stripe_bank_account_token_create_response.rb +1 -1
- data/lib/plaid/models/processor_token_create_request.rb +1 -1
- data/lib/plaid/models/processor_token_create_response.rb +1 -1
- data/lib/plaid/models/product_access.rb +1 -1
- data/lib/plaid/models/product_status.rb +1 -1
- data/lib/plaid/models/product_status_breakdown.rb +1 -1
- data/lib/plaid/models/products.rb +1 -1
- data/lib/plaid/models/program_name_sensitivity.rb +41 -0
- data/lib/plaid/models/projected_income_summary_field_number.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/recurring_transaction_frequency.rb +1 -1
- data/lib/plaid/models/relay_event.rb +1 -1
- data/lib/plaid/models/removed_transaction.rb +1 -1
- data/lib/plaid/models/report_token.rb +230 -0
- data/lib/plaid/models/risk_signal_document_reference.rb +231 -0
- 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 +12 -2
- data/lib/plaid/models/sandbox_income_fire_webhook_response.rb +1 -1
- data/lib/plaid/models/sandbox_item_fire_webhook_request.rb +2 -2
- data/lib/plaid/models/sandbox_item_fire_webhook_response.rb +1 -1
- data/lib/plaid/models/sandbox_item_reset_login_request.rb +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_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_options.rb +1 -1
- data/lib/plaid/models/sandbox_public_token_create_request_options_transactions.rb +1 -1
- data/lib/plaid/models/sandbox_public_token_create_response.rb +1 -1
- data/lib/plaid/models/sandbox_transfer_fire_webhook_request.rb +1 -1
- data/lib/plaid/models/sandbox_transfer_fire_webhook_response.rb +1 -1
- data/lib/plaid/models/sandbox_transfer_repayment_simulate_request.rb +1 -1
- data/lib/plaid/models/sandbox_transfer_repayment_simulate_response.rb +1 -1
- data/lib/plaid/models/sandbox_transfer_simulate_request.rb +2 -2
- 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/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 +261 -0
- data/lib/plaid/models/screening_hit_data.rb +258 -0
- data/lib/plaid/models/screening_hit_date_of_birth_item.rb +228 -0
- data/lib/plaid/models/screening_hit_documents_items.rb +228 -0
- data/lib/plaid/models/screening_hit_names_items.rb +228 -0
- data/lib/plaid/models/screening_status_updated_webhook.rb +251 -0
- data/lib/plaid/models/security.rb +1 -1
- data/lib/plaid/models/security_override.rb +1 -1
- data/lib/plaid/models/sender_bacs_nullable.rb +1 -1
- data/lib/plaid/models/servicer_address_data.rb +1 -1
- data/lib/plaid/models/signal_address_data.rb +1 -1
- data/lib/plaid/models/signal_decision_report_request.rb +1 -1
- data/lib/plaid/models/signal_decision_report_response.rb +1 -1
- data/lib/plaid/models/signal_device.rb +1 -1
- data/lib/plaid/models/signal_evaluate_core_attributes.rb +1 -1
- data/lib/plaid/models/signal_evaluate_request.rb +1 -1
- data/lib/plaid/models/signal_evaluate_response.rb +1 -1
- data/lib/plaid/models/signal_person_name.rb +1 -1
- data/lib/plaid/models/signal_prepare_request.rb +1 -1
- data/lib/plaid/models/signal_prepare_response.rb +1 -1
- data/lib/plaid/models/signal_return_report_request.rb +1 -1
- data/lib/plaid/models/signal_return_report_response.rb +1 -1
- data/lib/plaid/models/signal_scores.rb +1 -1
- data/lib/plaid/models/signal_user.rb +1 -1
- data/lib/plaid/models/simulated_transfer_sweep.rb +1 -1
- data/lib/plaid/models/single_document_risk_signal.rb +241 -0
- data/lib/plaid/models/source.rb +41 -0
- 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/strategy.rb +41 -0
- data/lib/plaid/models/student_loan.rb +1 -1
- data/lib/plaid/models/student_loan_repayment_model.rb +1 -1
- data/lib/plaid/models/student_loan_status.rb +1 -1
- data/lib/plaid/models/student_repayment_plan.rb +1 -1
- data/lib/plaid/models/sync_updates_available_webhook.rb +285 -0
- data/lib/plaid/models/taxform.rb +1 -1
- data/lib/plaid/models/taxpayer_id.rb +1 -1
- data/lib/plaid/models/total.rb +1 -1
- data/lib/plaid/models/total_canonical_description.rb +1 -1
- data/lib/plaid/models/transaction.rb +1 -1
- data/lib/plaid/models/transaction_all_of.rb +1 -1
- data/lib/plaid/models/transaction_base.rb +1 -1
- data/lib/plaid/models/transaction_code.rb +1 -1
- data/lib/plaid/models/transaction_data.rb +1 -1
- data/lib/plaid/models/transaction_override.rb +1 -1
- data/lib/plaid/models/transaction_stream.rb +2 -6
- data/lib/plaid/models/transaction_stream_amount.rb +1 -1
- data/lib/plaid/models/transaction_stream_status.rb +1 -1
- data/lib/plaid/models/transactions_category_rule.rb +1 -1
- data/lib/plaid/models/transactions_enhance_get_request.rb +1 -1
- data/lib/plaid/models/transactions_enhance_get_response.rb +1 -1
- data/lib/plaid/models/transactions_get_request.rb +1 -1
- data/lib/plaid/models/transactions_get_request_options.rb +1 -1
- data/lib/plaid/models/transactions_get_response.rb +1 -1
- data/lib/plaid/models/transactions_recurring_get_request.rb +1 -1
- data/lib/plaid/models/transactions_recurring_get_request_options.rb +1 -1
- data/lib/plaid/models/transactions_recurring_get_response.rb +1 -1
- data/lib/plaid/models/transactions_refresh_request.rb +1 -1
- data/lib/plaid/models/transactions_refresh_response.rb +1 -1
- data/lib/plaid/models/transactions_removed_webhook.rb +1 -1
- data/lib/plaid/models/transactions_rule_details.rb +1 -1
- data/lib/plaid/models/transactions_rule_field.rb +1 -1
- data/lib/plaid/models/transactions_rule_type.rb +1 -1
- data/lib/plaid/models/transactions_rules_create_request.rb +2 -2
- data/lib/plaid/models/transactions_rules_create_response.rb +2 -2
- data/lib/plaid/models/transactions_rules_list_request.rb +2 -2
- data/lib/plaid/models/transactions_rules_list_response.rb +2 -2
- data/lib/plaid/models/transactions_rules_remove_request.rb +2 -2
- data/lib/plaid/models/transactions_rules_remove_response.rb +2 -2
- 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/transfer.rb +1 -1
- data/lib/plaid/models/transfer_authorization.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 +1 -1
- data/lib/plaid/models/transfer_authorization_decision_rationale.rb +1 -1
- data/lib/plaid/models/transfer_authorization_decision_rationale_code.rb +1 -1
- data/lib/plaid/models/transfer_authorization_device.rb +1 -1
- data/lib/plaid/models/transfer_authorization_guarantee_decision.rb +1 -1
- data/lib/plaid/models/transfer_authorization_guarantee_decision_rationale.rb +1 -1
- data/lib/plaid/models/transfer_authorization_guarantee_decision_rationale_code.rb +1 -1
- data/lib/plaid/models/transfer_authorization_proposed_transfer.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_create_request.rb +2 -2
- data/lib/plaid/models/transfer_create_response.rb +1 -1
- data/lib/plaid/models/transfer_event.rb +2 -2
- 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 +3 -1
- data/lib/plaid/models/transfer_events_update_webhook.rb +1 -1
- data/lib/plaid/models/transfer_failure.rb +3 -3
- 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 +16 -5
- data/lib/plaid/models/transfer_intent_create_mode.rb +1 -1
- data/lib/plaid/models/transfer_intent_create_request.rb +18 -5
- data/lib/plaid/models/transfer_intent_create_response.rb +1 -1
- data/lib/plaid/models/transfer_intent_get.rb +36 -5
- data/lib/plaid/models/transfer_intent_get_failure_reason.rb +1 -1
- data/lib/plaid/models/transfer_intent_get_request.rb +1 -1
- data/lib/plaid/models/transfer_intent_get_response.rb +1 -1
- data/lib/plaid/models/transfer_intent_status.rb +1 -1
- data/lib/plaid/models/transfer_list_request.rb +1 -1
- data/lib/plaid/models/transfer_list_response.rb +1 -1
- data/lib/plaid/models/transfer_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_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 +2 -2
- 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_status.rb +2 -1
- data/lib/plaid/models/transfer_sweep.rb +2 -2
- data/lib/plaid/models/transfer_sweep_get_request.rb +1 -1
- data/lib/plaid/models/transfer_sweep_get_response.rb +1 -1
- data/lib/plaid/models/transfer_sweep_list_request.rb +1 -1
- data/lib/plaid/models/transfer_sweep_list_response.rb +1 -1
- data/lib/plaid/models/transfer_sweep_status.rb +2 -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_response.rb +1 -1
- data/lib/plaid/models/update_entity_screening_request.rb +298 -0
- data/lib/plaid/models/update_entity_screening_request_resettable_field.rb +38 -0
- data/lib/plaid/models/update_entity_screening_request_search_terms.rb +315 -0
- data/lib/plaid/models/update_individual_screening_request.rb +298 -0
- data/lib/plaid/models/update_individual_screening_request_resettable_field.rb +38 -0
- data/lib/plaid/models/update_individual_screening_request_search_terms.rb +260 -0
- data/lib/plaid/models/user_address.rb +328 -0
- data/lib/plaid/models/user_create_request.rb +1 -1
- data/lib/plaid/models/user_create_response.rb +2 -1
- data/lib/plaid/models/user_custom_password.rb +1 -1
- data/lib/plaid/models/user_id_number.rb +239 -0
- data/lib/plaid/models/user_name.rb +240 -0
- data/lib/plaid/models/user_permission_revoked_webhook.rb +1 -1
- data/lib/plaid/models/verification_attribute.rb +1 -1
- data/lib/plaid/models/verification_expired_webhook.rb +1 -1
- data/lib/plaid/models/verification_refresh_status.rb +1 -1
- data/lib/plaid/models/verification_status.rb +1 -1
- data/lib/plaid/models/w2.rb +1 -1
- data/lib/plaid/models/w2_box12.rb +1 -1
- data/lib/plaid/models/w2_state_and_local_wages.rb +1 -1
- data/lib/plaid/models/wallet.rb +253 -0
- data/lib/plaid/models/wallet_balance.rb +1 -1
- data/lib/plaid/models/wallet_create_request.rb +244 -0
- data/lib/plaid/models/wallet_create_response.rb +276 -0
- data/lib/plaid/models/wallet_get_request.rb +1 -1
- data/lib/plaid/models/wallet_get_response.rb +32 -15
- data/lib/plaid/models/wallet_iso_currency_code.rb +38 -0
- data/lib/plaid/models/wallet_list_request.rb +304 -0
- data/lib/plaid/models/wallet_list_response.rb +252 -0
- data/lib/plaid/models/wallet_numbers.rb +1 -1
- data/lib/plaid/models/wallet_transaction.rb +4 -4
- data/lib/plaid/models/wallet_transaction_amount.rb +2 -48
- 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_numbers.rb +1 -1
- data/lib/plaid/models/wallet_transaction_execute_request.rb +1 -1
- data/lib/plaid/models/wallet_transaction_execute_response.rb +1 -1
- data/lib/plaid/models/wallet_transaction_get_request.rb +266 -0
- data/lib/plaid/models/wallet_transaction_get_response.rb +369 -0
- data/lib/plaid/models/wallet_transaction_status.rb +1 -1
- data/lib/plaid/models/wallet_transactions_list_request.rb +1 -1
- data/lib/plaid/models/wallet_transactions_list_response.rb +1 -1
- data/lib/plaid/models/warning.rb +1 -1
- data/lib/plaid/models/watchlist_screening_audit_trail.rb +249 -0
- data/lib/plaid/models/watchlist_screening_create_request.rb +254 -0
- data/lib/plaid/models/watchlist_screening_document.rb +271 -0
- data/lib/plaid/models/watchlist_screening_document_type.rb +50 -0
- data/lib/plaid/models/watchlist_screening_hit.rb +351 -0
- data/lib/plaid/models/watchlist_screening_hit_locations.rb +272 -0
- data/lib/plaid/models/watchlist_screening_hit_status.rb +40 -0
- data/lib/plaid/models/watchlist_screening_individual.rb +287 -0
- data/lib/plaid/models/watchlist_screening_individual_response.rb +302 -0
- data/lib/plaid/models/watchlist_screening_request_search_terms.rb +302 -0
- data/lib/plaid/models/watchlist_screening_review.rb +301 -0
- data/lib/plaid/models/watchlist_screening_review_response.rb +316 -0
- data/lib/plaid/models/watchlist_screening_search_terms.rb +317 -0
- data/lib/plaid/models/watchlist_screening_status.rb +40 -0
- data/lib/plaid/models/weak_alias_determination.rb +40 -0
- 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 +164 -4
- data/plaid.gemspec +1 -1
- data/templates/ruby/api_client.mustache +2 -2
- metadata +166 -6
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.128.2
|
7
7
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
9
9
|
OpenAPI Generator version: 5.1.1
|
@@ -1904,6 +1904,71 @@ module Plaid
|
|
1904
1904
|
return data, status_code, headers
|
1905
1905
|
end
|
1906
1906
|
|
1907
|
+
# Create Asset or Income Report Audit Copy Token
|
1908
|
+
# Plaid can provide an Audit Copy token of an Asset Report and/or Income Report directly to a participating third party on your behalf. For example, Plaid can supply an Audit Copy token directly to Fannie Mae on your behalf if you participate in the Day 1 Certainty™ program. An Audit Copy token contains the same underlying data as the Asset Report and/or Income Report (result of /credit/payroll_income/get). To grant access to an Audit Copy token, use the `/credit/audit_copy_token/create` endpoint to create an `audit_copy_token` and then pass that token to the third party who needs access. Each third party has its own `auditor_id`, for example `fannie_mae`. You’ll need to create a separate Audit Copy for each third party to whom you want to grant access to the Report.
|
1909
|
+
# @param credit_audit_copy_token_create_request [CreditAuditCopyTokenCreateRequest]
|
1910
|
+
# @param [Hash] opts the optional parameters
|
1911
|
+
# @return [CreditAuditCopyTokenCreateResponse]
|
1912
|
+
def credit_audit_copy_token_create(credit_audit_copy_token_create_request, opts = {})
|
1913
|
+
data, _status_code, _headers = credit_audit_copy_token_create_with_http_info(credit_audit_copy_token_create_request, opts)
|
1914
|
+
data
|
1915
|
+
end
|
1916
|
+
|
1917
|
+
# Create Asset or Income Report Audit Copy Token
|
1918
|
+
# Plaid can provide an Audit Copy token of an Asset Report and/or Income Report directly to a participating third party on your behalf. For example, Plaid can supply an Audit Copy token directly to Fannie Mae on your behalf if you participate in the Day 1 Certainty™ program. An Audit Copy token contains the same underlying data as the Asset Report and/or Income Report (result of /credit/payroll_income/get). To grant access to an Audit Copy token, use the `/credit/audit_copy_token/create` endpoint to create an `audit_copy_token` and then pass that token to the third party who needs access. Each third party has its own `auditor_id`, for example `fannie_mae`. You’ll need to create a separate Audit Copy for each third party to whom you want to grant access to the Report.
|
1919
|
+
# @param credit_audit_copy_token_create_request [CreditAuditCopyTokenCreateRequest]
|
1920
|
+
# @param [Hash] opts the optional parameters
|
1921
|
+
# @return [Array<(CreditAuditCopyTokenCreateResponse, Integer, Hash)>] CreditAuditCopyTokenCreateResponse data, response status code and response headers
|
1922
|
+
def credit_audit_copy_token_create_with_http_info(credit_audit_copy_token_create_request, opts = {})
|
1923
|
+
if @api_client.config.debugging
|
1924
|
+
@api_client.config.logger.debug 'Calling API: PlaidApi.credit_audit_copy_token_create ...'
|
1925
|
+
end
|
1926
|
+
# verify the required parameter 'credit_audit_copy_token_create_request' is set
|
1927
|
+
if @api_client.config.client_side_validation && credit_audit_copy_token_create_request.nil?
|
1928
|
+
fail ArgumentError, "Missing the required parameter 'credit_audit_copy_token_create_request' when calling PlaidApi.credit_audit_copy_token_create"
|
1929
|
+
end
|
1930
|
+
# resource path
|
1931
|
+
local_var_path = '/credit/audit_copy_token/create'
|
1932
|
+
|
1933
|
+
# query parameters
|
1934
|
+
query_params = opts[:query_params] || {}
|
1935
|
+
|
1936
|
+
# header parameters
|
1937
|
+
header_params = opts[:header_params] || {}
|
1938
|
+
# HTTP header 'Accept' (if needed)
|
1939
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1940
|
+
# HTTP header 'Content-Type'
|
1941
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
1942
|
+
|
1943
|
+
# form parameters
|
1944
|
+
form_params = opts[:form_params] || {}
|
1945
|
+
|
1946
|
+
# http body (model)
|
1947
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(credit_audit_copy_token_create_request)
|
1948
|
+
|
1949
|
+
# return_type
|
1950
|
+
return_type = opts[:debug_return_type] || 'CreditAuditCopyTokenCreateResponse'
|
1951
|
+
|
1952
|
+
# auth_names
|
1953
|
+
auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
|
1954
|
+
|
1955
|
+
new_options = opts.merge(
|
1956
|
+
:operation => :"PlaidApi.credit_audit_copy_token_create",
|
1957
|
+
:header_params => header_params,
|
1958
|
+
:query_params => query_params,
|
1959
|
+
:form_params => form_params,
|
1960
|
+
:body => post_body,
|
1961
|
+
:auth_names => auth_names,
|
1962
|
+
:return_type => return_type
|
1963
|
+
)
|
1964
|
+
|
1965
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
1966
|
+
if @api_client.config.debugging
|
1967
|
+
@api_client.config.logger.debug "API called: PlaidApi#credit_audit_copy_token_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1968
|
+
end
|
1969
|
+
return data, status_code, headers
|
1970
|
+
end
|
1971
|
+
|
1907
1972
|
# Retrieve information from the bank accounts used for income verification
|
1908
1973
|
# `/credit/bank_income/get` returns the bank income report(s) for a specified user.
|
1909
1974
|
# @param credit_bank_income_get_request [CreditBankIncomeGetRequest]
|
@@ -2294,6 +2359,201 @@ module Plaid
|
|
2294
2359
|
return data, status_code, headers
|
2295
2360
|
end
|
2296
2361
|
|
2362
|
+
# Create a `relay_token` to share an Asset Report with a partner client
|
2363
|
+
# Plaid can share an Asset Report directly with a participating third party on your behalf. The shared Asset Report is the exact same Asset Report originally created in `/asset_report/create`. To grant access to an Asset Report to a third party, use the `/credit/relay/create` endpoint to create a `relay_token` and then pass that token to the third party who needs access. Each third party has its own `secondary_client_id`, for example `ce5bd328dcd34123456`. You'll need to create a separate `relay_token` for each third party to whom you want to grant access to the Report.
|
2364
|
+
# @param credit_relay_create_request [CreditRelayCreateRequest]
|
2365
|
+
# @param [Hash] opts the optional parameters
|
2366
|
+
# @return [CreditRelayCreateResponse]
|
2367
|
+
def credit_relay_create(credit_relay_create_request, opts = {})
|
2368
|
+
data, _status_code, _headers = credit_relay_create_with_http_info(credit_relay_create_request, opts)
|
2369
|
+
data
|
2370
|
+
end
|
2371
|
+
|
2372
|
+
# Create a `relay_token` to share an Asset Report with a partner client
|
2373
|
+
# Plaid can share an Asset Report directly with a participating third party on your behalf. The shared Asset Report is the exact same Asset Report originally created in `/asset_report/create`. To grant access to an Asset Report to a third party, use the `/credit/relay/create` endpoint to create a `relay_token` and then pass that token to the third party who needs access. Each third party has its own `secondary_client_id`, for example `ce5bd328dcd34123456`. You'll need to create a separate `relay_token` for each third party to whom you want to grant access to the Report.
|
2374
|
+
# @param credit_relay_create_request [CreditRelayCreateRequest]
|
2375
|
+
# @param [Hash] opts the optional parameters
|
2376
|
+
# @return [Array<(CreditRelayCreateResponse, Integer, Hash)>] CreditRelayCreateResponse data, response status code and response headers
|
2377
|
+
def credit_relay_create_with_http_info(credit_relay_create_request, opts = {})
|
2378
|
+
if @api_client.config.debugging
|
2379
|
+
@api_client.config.logger.debug 'Calling API: PlaidApi.credit_relay_create ...'
|
2380
|
+
end
|
2381
|
+
# verify the required parameter 'credit_relay_create_request' is set
|
2382
|
+
if @api_client.config.client_side_validation && credit_relay_create_request.nil?
|
2383
|
+
fail ArgumentError, "Missing the required parameter 'credit_relay_create_request' when calling PlaidApi.credit_relay_create"
|
2384
|
+
end
|
2385
|
+
# resource path
|
2386
|
+
local_var_path = '/credit/relay/create'
|
2387
|
+
|
2388
|
+
# query parameters
|
2389
|
+
query_params = opts[:query_params] || {}
|
2390
|
+
|
2391
|
+
# header parameters
|
2392
|
+
header_params = opts[:header_params] || {}
|
2393
|
+
# HTTP header 'Accept' (if needed)
|
2394
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
2395
|
+
# HTTP header 'Content-Type'
|
2396
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
2397
|
+
|
2398
|
+
# form parameters
|
2399
|
+
form_params = opts[:form_params] || {}
|
2400
|
+
|
2401
|
+
# http body (model)
|
2402
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(credit_relay_create_request)
|
2403
|
+
|
2404
|
+
# return_type
|
2405
|
+
return_type = opts[:debug_return_type] || 'CreditRelayCreateResponse'
|
2406
|
+
|
2407
|
+
# auth_names
|
2408
|
+
auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
|
2409
|
+
|
2410
|
+
new_options = opts.merge(
|
2411
|
+
:operation => :"PlaidApi.credit_relay_create",
|
2412
|
+
:header_params => header_params,
|
2413
|
+
:query_params => query_params,
|
2414
|
+
:form_params => form_params,
|
2415
|
+
:body => post_body,
|
2416
|
+
:auth_names => auth_names,
|
2417
|
+
:return_type => return_type
|
2418
|
+
)
|
2419
|
+
|
2420
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
2421
|
+
if @api_client.config.debugging
|
2422
|
+
@api_client.config.logger.debug "API called: PlaidApi#credit_relay_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
2423
|
+
end
|
2424
|
+
return data, status_code, headers
|
2425
|
+
end
|
2426
|
+
|
2427
|
+
# List dashboard users
|
2428
|
+
# List all dashboard users associated with your account.
|
2429
|
+
# @param list_dashboard_user_request [ListDashboardUserRequest]
|
2430
|
+
# @param [Hash] opts the optional parameters
|
2431
|
+
# @return [PaginatedDashboardUserListResponse]
|
2432
|
+
def dashboard_user_list(list_dashboard_user_request, opts = {})
|
2433
|
+
data, _status_code, _headers = dashboard_user_list_with_http_info(list_dashboard_user_request, opts)
|
2434
|
+
data
|
2435
|
+
end
|
2436
|
+
|
2437
|
+
# List dashboard users
|
2438
|
+
# List all dashboard users associated with your account.
|
2439
|
+
# @param list_dashboard_user_request [ListDashboardUserRequest]
|
2440
|
+
# @param [Hash] opts the optional parameters
|
2441
|
+
# @return [Array<(PaginatedDashboardUserListResponse, Integer, Hash)>] PaginatedDashboardUserListResponse data, response status code and response headers
|
2442
|
+
def dashboard_user_list_with_http_info(list_dashboard_user_request, opts = {})
|
2443
|
+
if @api_client.config.debugging
|
2444
|
+
@api_client.config.logger.debug 'Calling API: PlaidApi.dashboard_user_list ...'
|
2445
|
+
end
|
2446
|
+
# verify the required parameter 'list_dashboard_user_request' is set
|
2447
|
+
if @api_client.config.client_side_validation && list_dashboard_user_request.nil?
|
2448
|
+
fail ArgumentError, "Missing the required parameter 'list_dashboard_user_request' when calling PlaidApi.dashboard_user_list"
|
2449
|
+
end
|
2450
|
+
# resource path
|
2451
|
+
local_var_path = '/dashboard_user/list'
|
2452
|
+
|
2453
|
+
# query parameters
|
2454
|
+
query_params = opts[:query_params] || {}
|
2455
|
+
|
2456
|
+
# header parameters
|
2457
|
+
header_params = opts[:header_params] || {}
|
2458
|
+
# HTTP header 'Accept' (if needed)
|
2459
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
2460
|
+
# HTTP header 'Content-Type'
|
2461
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
2462
|
+
|
2463
|
+
# form parameters
|
2464
|
+
form_params = opts[:form_params] || {}
|
2465
|
+
|
2466
|
+
# http body (model)
|
2467
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(list_dashboard_user_request)
|
2468
|
+
|
2469
|
+
# return_type
|
2470
|
+
return_type = opts[:debug_return_type] || 'PaginatedDashboardUserListResponse'
|
2471
|
+
|
2472
|
+
# auth_names
|
2473
|
+
auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
|
2474
|
+
|
2475
|
+
new_options = opts.merge(
|
2476
|
+
:operation => :"PlaidApi.dashboard_user_list",
|
2477
|
+
:header_params => header_params,
|
2478
|
+
:query_params => query_params,
|
2479
|
+
:form_params => form_params,
|
2480
|
+
:body => post_body,
|
2481
|
+
:auth_names => auth_names,
|
2482
|
+
:return_type => return_type
|
2483
|
+
)
|
2484
|
+
|
2485
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
2486
|
+
if @api_client.config.debugging
|
2487
|
+
@api_client.config.logger.debug "API called: PlaidApi#dashboard_user_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
2488
|
+
end
|
2489
|
+
return data, status_code, headers
|
2490
|
+
end
|
2491
|
+
|
2492
|
+
# Retrieve a dashboard user
|
2493
|
+
# Retrieve information about a dashboard user.
|
2494
|
+
# @param get_dashboard_user_request [GetDashboardUserRequest]
|
2495
|
+
# @param [Hash] opts the optional parameters
|
2496
|
+
# @return [DashboardUserResponse]
|
2497
|
+
def dashobard_user_get(get_dashboard_user_request, opts = {})
|
2498
|
+
data, _status_code, _headers = dashobard_user_get_with_http_info(get_dashboard_user_request, opts)
|
2499
|
+
data
|
2500
|
+
end
|
2501
|
+
|
2502
|
+
# Retrieve a dashboard user
|
2503
|
+
# Retrieve information about a dashboard user.
|
2504
|
+
# @param get_dashboard_user_request [GetDashboardUserRequest]
|
2505
|
+
# @param [Hash] opts the optional parameters
|
2506
|
+
# @return [Array<(DashboardUserResponse, Integer, Hash)>] DashboardUserResponse data, response status code and response headers
|
2507
|
+
def dashobard_user_get_with_http_info(get_dashboard_user_request, opts = {})
|
2508
|
+
if @api_client.config.debugging
|
2509
|
+
@api_client.config.logger.debug 'Calling API: PlaidApi.dashobard_user_get ...'
|
2510
|
+
end
|
2511
|
+
# verify the required parameter 'get_dashboard_user_request' is set
|
2512
|
+
if @api_client.config.client_side_validation && get_dashboard_user_request.nil?
|
2513
|
+
fail ArgumentError, "Missing the required parameter 'get_dashboard_user_request' when calling PlaidApi.dashobard_user_get"
|
2514
|
+
end
|
2515
|
+
# resource path
|
2516
|
+
local_var_path = '/dashboard_user/get'
|
2517
|
+
|
2518
|
+
# query parameters
|
2519
|
+
query_params = opts[:query_params] || {}
|
2520
|
+
|
2521
|
+
# header parameters
|
2522
|
+
header_params = opts[:header_params] || {}
|
2523
|
+
# HTTP header 'Accept' (if needed)
|
2524
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
2525
|
+
# HTTP header 'Content-Type'
|
2526
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
2527
|
+
|
2528
|
+
# form parameters
|
2529
|
+
form_params = opts[:form_params] || {}
|
2530
|
+
|
2531
|
+
# http body (model)
|
2532
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(get_dashboard_user_request)
|
2533
|
+
|
2534
|
+
# return_type
|
2535
|
+
return_type = opts[:debug_return_type] || 'DashboardUserResponse'
|
2536
|
+
|
2537
|
+
# auth_names
|
2538
|
+
auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
|
2539
|
+
|
2540
|
+
new_options = opts.merge(
|
2541
|
+
:operation => :"PlaidApi.dashobard_user_get",
|
2542
|
+
:header_params => header_params,
|
2543
|
+
:query_params => query_params,
|
2544
|
+
:form_params => form_params,
|
2545
|
+
:body => post_body,
|
2546
|
+
:auth_names => auth_names,
|
2547
|
+
:return_type => return_type
|
2548
|
+
)
|
2549
|
+
|
2550
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
2551
|
+
if @api_client.config.debugging
|
2552
|
+
@api_client.config.logger.debug "API called: PlaidApi#dashobard_user_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
2553
|
+
end
|
2554
|
+
return data, status_code, headers
|
2555
|
+
end
|
2556
|
+
|
2297
2557
|
# Create a deposit switch without using Plaid Exchange
|
2298
2558
|
# This endpoint provides an alternative to `/deposit_switch/create` for customers who have not yet fully integrated with Plaid Exchange. Like `/deposit_switch/create`, it creates a deposit switch entity that will be persisted throughout the lifecycle of the switch.
|
2299
2559
|
# @param deposit_switch_alt_create_request [DepositSwitchAltCreateRequest]
|
@@ -2749,31 +3009,31 @@ module Plaid
|
|
2749
3009
|
return data, status_code, headers
|
2750
3010
|
end
|
2751
3011
|
|
2752
|
-
#
|
2753
|
-
#
|
2754
|
-
# @param
|
3012
|
+
# Create a new identity verification
|
3013
|
+
# Create a new Identity Verification for the user specified by the `client_user_id` field. The requirements and behavior of the verification are determined by the `template_id` provided. If you don't know whether the associated user already has an active Identity Verification, you can specify `\"is_idempotent\": true` in the request body. With idempotency enabled, a new Identity Verification will only be created if one does not already exist for the associated `client_user_id` and `template_id`. If an Identity Verification is found, it will be returned unmodified with an `200 OK` HTTP status code.
|
3014
|
+
# @param identity_verification_create_request [IdentityVerificationCreateRequest]
|
2755
3015
|
# @param [Hash] opts the optional parameters
|
2756
|
-
# @return [
|
2757
|
-
def
|
2758
|
-
data, _status_code, _headers =
|
3016
|
+
# @return [IdentityVerificationResponse]
|
3017
|
+
def identity_verification_create(identity_verification_create_request, opts = {})
|
3018
|
+
data, _status_code, _headers = identity_verification_create_with_http_info(identity_verification_create_request, opts)
|
2759
3019
|
data
|
2760
3020
|
end
|
2761
3021
|
|
2762
|
-
#
|
2763
|
-
#
|
2764
|
-
# @param
|
3022
|
+
# Create a new identity verification
|
3023
|
+
# Create a new Identity Verification for the user specified by the `client_user_id` field. The requirements and behavior of the verification are determined by the `template_id` provided. If you don't know whether the associated user already has an active Identity Verification, you can specify `\"is_idempotent\": true` in the request body. With idempotency enabled, a new Identity Verification will only be created if one does not already exist for the associated `client_user_id` and `template_id`. If an Identity Verification is found, it will be returned unmodified with an `200 OK` HTTP status code.
|
3024
|
+
# @param identity_verification_create_request [IdentityVerificationCreateRequest]
|
2765
3025
|
# @param [Hash] opts the optional parameters
|
2766
|
-
# @return [Array<(
|
2767
|
-
def
|
3026
|
+
# @return [Array<(IdentityVerificationResponse, Integer, Hash)>] IdentityVerificationResponse data, response status code and response headers
|
3027
|
+
def identity_verification_create_with_http_info(identity_verification_create_request, opts = {})
|
2768
3028
|
if @api_client.config.debugging
|
2769
|
-
@api_client.config.logger.debug 'Calling API: PlaidApi.
|
3029
|
+
@api_client.config.logger.debug 'Calling API: PlaidApi.identity_verification_create ...'
|
2770
3030
|
end
|
2771
|
-
# verify the required parameter '
|
2772
|
-
if @api_client.config.client_side_validation &&
|
2773
|
-
fail ArgumentError, "Missing the required parameter '
|
3031
|
+
# verify the required parameter 'identity_verification_create_request' is set
|
3032
|
+
if @api_client.config.client_side_validation && identity_verification_create_request.nil?
|
3033
|
+
fail ArgumentError, "Missing the required parameter 'identity_verification_create_request' when calling PlaidApi.identity_verification_create"
|
2774
3034
|
end
|
2775
3035
|
# resource path
|
2776
|
-
local_var_path = '/
|
3036
|
+
local_var_path = '/identity_verification/create'
|
2777
3037
|
|
2778
3038
|
# query parameters
|
2779
3039
|
query_params = opts[:query_params] || {}
|
@@ -2789,16 +3049,16 @@ module Plaid
|
|
2789
3049
|
form_params = opts[:form_params] || {}
|
2790
3050
|
|
2791
3051
|
# http body (model)
|
2792
|
-
post_body = opts[:debug_body] || @api_client.object_to_http_body(
|
3052
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(identity_verification_create_request)
|
2793
3053
|
|
2794
3054
|
# return_type
|
2795
|
-
return_type = opts[:debug_return_type] || '
|
3055
|
+
return_type = opts[:debug_return_type] || 'IdentityVerificationResponse'
|
2796
3056
|
|
2797
3057
|
# auth_names
|
2798
3058
|
auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
|
2799
3059
|
|
2800
3060
|
new_options = opts.merge(
|
2801
|
-
:operation => :"PlaidApi.
|
3061
|
+
:operation => :"PlaidApi.identity_verification_create",
|
2802
3062
|
:header_params => header_params,
|
2803
3063
|
:query_params => query_params,
|
2804
3064
|
:form_params => form_params,
|
@@ -2809,36 +3069,36 @@ module Plaid
|
|
2809
3069
|
|
2810
3070
|
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
2811
3071
|
if @api_client.config.debugging
|
2812
|
-
@api_client.config.logger.debug "API called: PlaidApi#
|
3072
|
+
@api_client.config.logger.debug "API called: PlaidApi#identity_verification_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
2813
3073
|
end
|
2814
3074
|
return data, status_code, headers
|
2815
3075
|
end
|
2816
3076
|
|
2817
|
-
#
|
2818
|
-
#
|
2819
|
-
# @param
|
3077
|
+
# Retrieve Identity Verification
|
3078
|
+
# Retrieve a previously created identity verification
|
3079
|
+
# @param get_identity_verification_request [GetIdentityVerificationRequest]
|
2820
3080
|
# @param [Hash] opts the optional parameters
|
2821
|
-
# @return [
|
2822
|
-
def
|
2823
|
-
data, _status_code, _headers =
|
3081
|
+
# @return [IdentityVerificationResponse]
|
3082
|
+
def identity_verification_get(get_identity_verification_request, opts = {})
|
3083
|
+
data, _status_code, _headers = identity_verification_get_with_http_info(get_identity_verification_request, opts)
|
2824
3084
|
data
|
2825
3085
|
end
|
2826
3086
|
|
2827
|
-
#
|
2828
|
-
#
|
2829
|
-
# @param
|
3087
|
+
# Retrieve Identity Verification
|
3088
|
+
# Retrieve a previously created identity verification
|
3089
|
+
# @param get_identity_verification_request [GetIdentityVerificationRequest]
|
2830
3090
|
# @param [Hash] opts the optional parameters
|
2831
|
-
# @return [Array<(
|
2832
|
-
def
|
3091
|
+
# @return [Array<(IdentityVerificationResponse, Integer, Hash)>] IdentityVerificationResponse data, response status code and response headers
|
3092
|
+
def identity_verification_get_with_http_info(get_identity_verification_request, opts = {})
|
2833
3093
|
if @api_client.config.debugging
|
2834
|
-
@api_client.config.logger.debug 'Calling API: PlaidApi.
|
3094
|
+
@api_client.config.logger.debug 'Calling API: PlaidApi.identity_verification_get ...'
|
2835
3095
|
end
|
2836
|
-
# verify the required parameter '
|
2837
|
-
if @api_client.config.client_side_validation &&
|
2838
|
-
fail ArgumentError, "Missing the required parameter '
|
3096
|
+
# verify the required parameter 'get_identity_verification_request' is set
|
3097
|
+
if @api_client.config.client_side_validation && get_identity_verification_request.nil?
|
3098
|
+
fail ArgumentError, "Missing the required parameter 'get_identity_verification_request' when calling PlaidApi.identity_verification_get"
|
2839
3099
|
end
|
2840
3100
|
# resource path
|
2841
|
-
local_var_path = '/
|
3101
|
+
local_var_path = '/identity_verification/get'
|
2842
3102
|
|
2843
3103
|
# query parameters
|
2844
3104
|
query_params = opts[:query_params] || {}
|
@@ -2846,7 +3106,7 @@ module Plaid
|
|
2846
3106
|
# header parameters
|
2847
3107
|
header_params = opts[:header_params] || {}
|
2848
3108
|
# HTTP header 'Accept' (if needed)
|
2849
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/
|
3109
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
2850
3110
|
# HTTP header 'Content-Type'
|
2851
3111
|
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
2852
3112
|
|
@@ -2854,16 +3114,16 @@ module Plaid
|
|
2854
3114
|
form_params = opts[:form_params] || {}
|
2855
3115
|
|
2856
3116
|
# http body (model)
|
2857
|
-
post_body = opts[:debug_body] || @api_client.object_to_http_body(
|
3117
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(get_identity_verification_request)
|
2858
3118
|
|
2859
3119
|
# return_type
|
2860
|
-
return_type = opts[:debug_return_type] || '
|
3120
|
+
return_type = opts[:debug_return_type] || 'IdentityVerificationResponse'
|
2861
3121
|
|
2862
3122
|
# auth_names
|
2863
3123
|
auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
|
2864
3124
|
|
2865
3125
|
new_options = opts.merge(
|
2866
|
-
:operation => :"PlaidApi.
|
3126
|
+
:operation => :"PlaidApi.identity_verification_get",
|
2867
3127
|
:header_params => header_params,
|
2868
3128
|
:query_params => query_params,
|
2869
3129
|
:form_params => form_params,
|
@@ -2874,36 +3134,36 @@ module Plaid
|
|
2874
3134
|
|
2875
3135
|
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
2876
3136
|
if @api_client.config.debugging
|
2877
|
-
@api_client.config.logger.debug "API called: PlaidApi#
|
3137
|
+
@api_client.config.logger.debug "API called: PlaidApi#identity_verification_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
2878
3138
|
end
|
2879
3139
|
return data, status_code, headers
|
2880
3140
|
end
|
2881
3141
|
|
2882
|
-
#
|
2883
|
-
#
|
2884
|
-
# @param
|
3142
|
+
# List Identity Verifications
|
3143
|
+
# Filter and list Identity Verifications created by your account
|
3144
|
+
# @param list_identity_verification_request [ListIdentityVerificationRequest]
|
2885
3145
|
# @param [Hash] opts the optional parameters
|
2886
|
-
# @return [
|
2887
|
-
def
|
2888
|
-
data, _status_code, _headers =
|
3146
|
+
# @return [PaginatedIdentityVerificationListResponse]
|
3147
|
+
def identity_verification_list(list_identity_verification_request, opts = {})
|
3148
|
+
data, _status_code, _headers = identity_verification_list_with_http_info(list_identity_verification_request, opts)
|
2889
3149
|
data
|
2890
3150
|
end
|
2891
3151
|
|
2892
|
-
#
|
2893
|
-
#
|
2894
|
-
# @param
|
3152
|
+
# List Identity Verifications
|
3153
|
+
# Filter and list Identity Verifications created by your account
|
3154
|
+
# @param list_identity_verification_request [ListIdentityVerificationRequest]
|
2895
3155
|
# @param [Hash] opts the optional parameters
|
2896
|
-
# @return [Array<(
|
2897
|
-
def
|
3156
|
+
# @return [Array<(PaginatedIdentityVerificationListResponse, Integer, Hash)>] PaginatedIdentityVerificationListResponse data, response status code and response headers
|
3157
|
+
def identity_verification_list_with_http_info(list_identity_verification_request, opts = {})
|
2898
3158
|
if @api_client.config.debugging
|
2899
|
-
@api_client.config.logger.debug 'Calling API: PlaidApi.
|
3159
|
+
@api_client.config.logger.debug 'Calling API: PlaidApi.identity_verification_list ...'
|
2900
3160
|
end
|
2901
|
-
# verify the required parameter '
|
2902
|
-
if @api_client.config.client_side_validation &&
|
2903
|
-
fail ArgumentError, "Missing the required parameter '
|
3161
|
+
# verify the required parameter 'list_identity_verification_request' is set
|
3162
|
+
if @api_client.config.client_side_validation && list_identity_verification_request.nil?
|
3163
|
+
fail ArgumentError, "Missing the required parameter 'list_identity_verification_request' when calling PlaidApi.identity_verification_list"
|
2904
3164
|
end
|
2905
3165
|
# resource path
|
2906
|
-
local_var_path = '/
|
3166
|
+
local_var_path = '/identity_verification/list'
|
2907
3167
|
|
2908
3168
|
# query parameters
|
2909
3169
|
query_params = opts[:query_params] || {}
|
@@ -2919,16 +3179,16 @@ module Plaid
|
|
2919
3179
|
form_params = opts[:form_params] || {}
|
2920
3180
|
|
2921
3181
|
# http body (model)
|
2922
|
-
post_body = opts[:debug_body] || @api_client.object_to_http_body(
|
3182
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(list_identity_verification_request)
|
2923
3183
|
|
2924
3184
|
# return_type
|
2925
|
-
return_type = opts[:debug_return_type] || '
|
3185
|
+
return_type = opts[:debug_return_type] || 'PaginatedIdentityVerificationListResponse'
|
2926
3186
|
|
2927
3187
|
# auth_names
|
2928
3188
|
auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
|
2929
3189
|
|
2930
3190
|
new_options = opts.merge(
|
2931
|
-
:operation => :"PlaidApi.
|
3191
|
+
:operation => :"PlaidApi.identity_verification_list",
|
2932
3192
|
:header_params => header_params,
|
2933
3193
|
:query_params => query_params,
|
2934
3194
|
:form_params => form_params,
|
@@ -2939,32 +3199,292 @@ module Plaid
|
|
2939
3199
|
|
2940
3200
|
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
2941
3201
|
if @api_client.config.debugging
|
2942
|
-
@api_client.config.logger.debug "API called: PlaidApi#
|
3202
|
+
@api_client.config.logger.debug "API called: PlaidApi#identity_verification_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
2943
3203
|
end
|
2944
3204
|
return data, status_code, headers
|
2945
3205
|
end
|
2946
3206
|
|
2947
|
-
#
|
2948
|
-
#
|
2949
|
-
# @param
|
3207
|
+
# Retry an Identity Verification
|
3208
|
+
# Allow a customer to retry their identity verification
|
3209
|
+
# @param identity_verification_retry_request [IdentityVerificationRetryRequest]
|
2950
3210
|
# @param [Hash] opts the optional parameters
|
2951
|
-
# @return [
|
2952
|
-
def
|
2953
|
-
data, _status_code, _headers =
|
3211
|
+
# @return [IdentityVerificationResponse]
|
3212
|
+
def identity_verification_retry(identity_verification_retry_request, opts = {})
|
3213
|
+
data, _status_code, _headers = identity_verification_retry_with_http_info(identity_verification_retry_request, opts)
|
2954
3214
|
data
|
2955
3215
|
end
|
2956
3216
|
|
2957
|
-
#
|
2958
|
-
#
|
2959
|
-
# @param
|
3217
|
+
# Retry an Identity Verification
|
3218
|
+
# Allow a customer to retry their identity verification
|
3219
|
+
# @param identity_verification_retry_request [IdentityVerificationRetryRequest]
|
2960
3220
|
# @param [Hash] opts the optional parameters
|
2961
|
-
# @return [Array<(
|
2962
|
-
def
|
3221
|
+
# @return [Array<(IdentityVerificationResponse, Integer, Hash)>] IdentityVerificationResponse data, response status code and response headers
|
3222
|
+
def identity_verification_retry_with_http_info(identity_verification_retry_request, opts = {})
|
2963
3223
|
if @api_client.config.debugging
|
2964
|
-
@api_client.config.logger.debug 'Calling API: PlaidApi.
|
3224
|
+
@api_client.config.logger.debug 'Calling API: PlaidApi.identity_verification_retry ...'
|
2965
3225
|
end
|
2966
|
-
# verify the required parameter '
|
2967
|
-
if @api_client.config.client_side_validation &&
|
3226
|
+
# verify the required parameter 'identity_verification_retry_request' is set
|
3227
|
+
if @api_client.config.client_side_validation && identity_verification_retry_request.nil?
|
3228
|
+
fail ArgumentError, "Missing the required parameter 'identity_verification_retry_request' when calling PlaidApi.identity_verification_retry"
|
3229
|
+
end
|
3230
|
+
# resource path
|
3231
|
+
local_var_path = '/identity_verification/retry'
|
3232
|
+
|
3233
|
+
# query parameters
|
3234
|
+
query_params = opts[:query_params] || {}
|
3235
|
+
|
3236
|
+
# header parameters
|
3237
|
+
header_params = opts[:header_params] || {}
|
3238
|
+
# HTTP header 'Accept' (if needed)
|
3239
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
3240
|
+
# HTTP header 'Content-Type'
|
3241
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
3242
|
+
|
3243
|
+
# form parameters
|
3244
|
+
form_params = opts[:form_params] || {}
|
3245
|
+
|
3246
|
+
# http body (model)
|
3247
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(identity_verification_retry_request)
|
3248
|
+
|
3249
|
+
# return_type
|
3250
|
+
return_type = opts[:debug_return_type] || 'IdentityVerificationResponse'
|
3251
|
+
|
3252
|
+
# auth_names
|
3253
|
+
auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
|
3254
|
+
|
3255
|
+
new_options = opts.merge(
|
3256
|
+
:operation => :"PlaidApi.identity_verification_retry",
|
3257
|
+
:header_params => header_params,
|
3258
|
+
:query_params => query_params,
|
3259
|
+
:form_params => form_params,
|
3260
|
+
:body => post_body,
|
3261
|
+
:auth_names => auth_names,
|
3262
|
+
:return_type => return_type
|
3263
|
+
)
|
3264
|
+
|
3265
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
3266
|
+
if @api_client.config.debugging
|
3267
|
+
@api_client.config.logger.debug "API called: PlaidApi#identity_verification_retry\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
3268
|
+
end
|
3269
|
+
return data, status_code, headers
|
3270
|
+
end
|
3271
|
+
|
3272
|
+
# (Deprecated) Create an income verification instance
|
3273
|
+
# `/income/verification/create` begins the income verification process by returning an `income_verification_id`. You can then provide the `income_verification_id` to `/link/token/create` under the `income_verification` parameter in order to create a Link instance that will prompt the user to go through the income verification flow. Plaid will fire an `INCOME` webhook once the user completes the Payroll Income flow, or when the uploaded documents in the Document Income flow have finished processing.
|
3274
|
+
# @param income_verification_create_request [IncomeVerificationCreateRequest]
|
3275
|
+
# @param [Hash] opts the optional parameters
|
3276
|
+
# @return [IncomeVerificationCreateResponse]
|
3277
|
+
def income_verification_create(income_verification_create_request, opts = {})
|
3278
|
+
data, _status_code, _headers = income_verification_create_with_http_info(income_verification_create_request, opts)
|
3279
|
+
data
|
3280
|
+
end
|
3281
|
+
|
3282
|
+
# (Deprecated) Create an income verification instance
|
3283
|
+
# `/income/verification/create` begins the income verification process by returning an `income_verification_id`. You can then provide the `income_verification_id` to `/link/token/create` under the `income_verification` parameter in order to create a Link instance that will prompt the user to go through the income verification flow. Plaid will fire an `INCOME` webhook once the user completes the Payroll Income flow, or when the uploaded documents in the Document Income flow have finished processing.
|
3284
|
+
# @param income_verification_create_request [IncomeVerificationCreateRequest]
|
3285
|
+
# @param [Hash] opts the optional parameters
|
3286
|
+
# @return [Array<(IncomeVerificationCreateResponse, Integer, Hash)>] IncomeVerificationCreateResponse data, response status code and response headers
|
3287
|
+
def income_verification_create_with_http_info(income_verification_create_request, opts = {})
|
3288
|
+
if @api_client.config.debugging
|
3289
|
+
@api_client.config.logger.debug 'Calling API: PlaidApi.income_verification_create ...'
|
3290
|
+
end
|
3291
|
+
# verify the required parameter 'income_verification_create_request' is set
|
3292
|
+
if @api_client.config.client_side_validation && income_verification_create_request.nil?
|
3293
|
+
fail ArgumentError, "Missing the required parameter 'income_verification_create_request' when calling PlaidApi.income_verification_create"
|
3294
|
+
end
|
3295
|
+
# resource path
|
3296
|
+
local_var_path = '/income/verification/create'
|
3297
|
+
|
3298
|
+
# query parameters
|
3299
|
+
query_params = opts[:query_params] || {}
|
3300
|
+
|
3301
|
+
# header parameters
|
3302
|
+
header_params = opts[:header_params] || {}
|
3303
|
+
# HTTP header 'Accept' (if needed)
|
3304
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
3305
|
+
# HTTP header 'Content-Type'
|
3306
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
3307
|
+
|
3308
|
+
# form parameters
|
3309
|
+
form_params = opts[:form_params] || {}
|
3310
|
+
|
3311
|
+
# http body (model)
|
3312
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(income_verification_create_request)
|
3313
|
+
|
3314
|
+
# return_type
|
3315
|
+
return_type = opts[:debug_return_type] || 'IncomeVerificationCreateResponse'
|
3316
|
+
|
3317
|
+
# auth_names
|
3318
|
+
auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
|
3319
|
+
|
3320
|
+
new_options = opts.merge(
|
3321
|
+
:operation => :"PlaidApi.income_verification_create",
|
3322
|
+
:header_params => header_params,
|
3323
|
+
:query_params => query_params,
|
3324
|
+
:form_params => form_params,
|
3325
|
+
:body => post_body,
|
3326
|
+
:auth_names => auth_names,
|
3327
|
+
:return_type => return_type
|
3328
|
+
)
|
3329
|
+
|
3330
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
3331
|
+
if @api_client.config.debugging
|
3332
|
+
@api_client.config.logger.debug "API called: PlaidApi#income_verification_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
3333
|
+
end
|
3334
|
+
return data, status_code, headers
|
3335
|
+
end
|
3336
|
+
|
3337
|
+
# (Deprecated) Download the original documents used for income verification
|
3338
|
+
# `/income/verification/documents/download` provides the ability to download the source documents associated with the verification. If Document Income was used, the documents will be those the user provided in Link. For Payroll Income, the most recent files available for download from the payroll provider will be available from this endpoint. The response to `/income/verification/documents/download` is a ZIP file in binary data. If a `document_id` is passed, a single document will be contained in this file. If not, the response will contain all documents associated with the verification. The `request_id` is returned in the `Plaid-Request-ID` header.
|
3339
|
+
# @param income_verification_documents_download_request [IncomeVerificationDocumentsDownloadRequest]
|
3340
|
+
# @param [Hash] opts the optional parameters
|
3341
|
+
# @return [File]
|
3342
|
+
def income_verification_documents_download(income_verification_documents_download_request, opts = {})
|
3343
|
+
data, _status_code, _headers = income_verification_documents_download_with_http_info(income_verification_documents_download_request, opts)
|
3344
|
+
data
|
3345
|
+
end
|
3346
|
+
|
3347
|
+
# (Deprecated) Download the original documents used for income verification
|
3348
|
+
# `/income/verification/documents/download` provides the ability to download the source documents associated with the verification. If Document Income was used, the documents will be those the user provided in Link. For Payroll Income, the most recent files available for download from the payroll provider will be available from this endpoint. The response to `/income/verification/documents/download` is a ZIP file in binary data. If a `document_id` is passed, a single document will be contained in this file. If not, the response will contain all documents associated with the verification. The `request_id` is returned in the `Plaid-Request-ID` header.
|
3349
|
+
# @param income_verification_documents_download_request [IncomeVerificationDocumentsDownloadRequest]
|
3350
|
+
# @param [Hash] opts the optional parameters
|
3351
|
+
# @return [Array<(File, Integer, Hash)>] File data, response status code and response headers
|
3352
|
+
def income_verification_documents_download_with_http_info(income_verification_documents_download_request, opts = {})
|
3353
|
+
if @api_client.config.debugging
|
3354
|
+
@api_client.config.logger.debug 'Calling API: PlaidApi.income_verification_documents_download ...'
|
3355
|
+
end
|
3356
|
+
# verify the required parameter 'income_verification_documents_download_request' is set
|
3357
|
+
if @api_client.config.client_side_validation && income_verification_documents_download_request.nil?
|
3358
|
+
fail ArgumentError, "Missing the required parameter 'income_verification_documents_download_request' when calling PlaidApi.income_verification_documents_download"
|
3359
|
+
end
|
3360
|
+
# resource path
|
3361
|
+
local_var_path = '/income/verification/documents/download'
|
3362
|
+
|
3363
|
+
# query parameters
|
3364
|
+
query_params = opts[:query_params] || {}
|
3365
|
+
|
3366
|
+
# header parameters
|
3367
|
+
header_params = opts[:header_params] || {}
|
3368
|
+
# HTTP header 'Accept' (if needed)
|
3369
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/zip'])
|
3370
|
+
# HTTP header 'Content-Type'
|
3371
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
3372
|
+
|
3373
|
+
# form parameters
|
3374
|
+
form_params = opts[:form_params] || {}
|
3375
|
+
|
3376
|
+
# http body (model)
|
3377
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(income_verification_documents_download_request)
|
3378
|
+
|
3379
|
+
# return_type
|
3380
|
+
return_type = opts[:debug_return_type] || 'File'
|
3381
|
+
|
3382
|
+
# auth_names
|
3383
|
+
auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
|
3384
|
+
|
3385
|
+
new_options = opts.merge(
|
3386
|
+
:operation => :"PlaidApi.income_verification_documents_download",
|
3387
|
+
:header_params => header_params,
|
3388
|
+
:query_params => query_params,
|
3389
|
+
:form_params => form_params,
|
3390
|
+
:body => post_body,
|
3391
|
+
:auth_names => auth_names,
|
3392
|
+
:return_type => return_type
|
3393
|
+
)
|
3394
|
+
|
3395
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
3396
|
+
if @api_client.config.debugging
|
3397
|
+
@api_client.config.logger.debug "API called: PlaidApi#income_verification_documents_download\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
3398
|
+
end
|
3399
|
+
return data, status_code, headers
|
3400
|
+
end
|
3401
|
+
|
3402
|
+
# (Deprecated) Retrieve information from the paystubs used for income verification
|
3403
|
+
# `/income/verification/paystubs/get` returns the information collected from the paystubs that were used to verify an end user''s income. It can be called once the status of the verification has been set to `VERIFICATION_STATUS_PROCESSING_COMPLETE`, as reported by the `INCOME: verification_status` webhook. Attempting to call the endpoint before verification has been completed will result in an error. This endpoint has been deprecated; new integrations should use `/credit/payroll_income/get` instead.
|
3404
|
+
# @param income_verification_paystubs_get_request [IncomeVerificationPaystubsGetRequest]
|
3405
|
+
# @param [Hash] opts the optional parameters
|
3406
|
+
# @return [IncomeVerificationPaystubsGetResponse]
|
3407
|
+
def income_verification_paystubs_get(income_verification_paystubs_get_request, opts = {})
|
3408
|
+
data, _status_code, _headers = income_verification_paystubs_get_with_http_info(income_verification_paystubs_get_request, opts)
|
3409
|
+
data
|
3410
|
+
end
|
3411
|
+
|
3412
|
+
# (Deprecated) Retrieve information from the paystubs used for income verification
|
3413
|
+
# `/income/verification/paystubs/get` returns the information collected from the paystubs that were used to verify an end user''s income. It can be called once the status of the verification has been set to `VERIFICATION_STATUS_PROCESSING_COMPLETE`, as reported by the `INCOME: verification_status` webhook. Attempting to call the endpoint before verification has been completed will result in an error. This endpoint has been deprecated; new integrations should use `/credit/payroll_income/get` instead.
|
3414
|
+
# @param income_verification_paystubs_get_request [IncomeVerificationPaystubsGetRequest]
|
3415
|
+
# @param [Hash] opts the optional parameters
|
3416
|
+
# @return [Array<(IncomeVerificationPaystubsGetResponse, Integer, Hash)>] IncomeVerificationPaystubsGetResponse data, response status code and response headers
|
3417
|
+
def income_verification_paystubs_get_with_http_info(income_verification_paystubs_get_request, opts = {})
|
3418
|
+
if @api_client.config.debugging
|
3419
|
+
@api_client.config.logger.debug 'Calling API: PlaidApi.income_verification_paystubs_get ...'
|
3420
|
+
end
|
3421
|
+
# verify the required parameter 'income_verification_paystubs_get_request' is set
|
3422
|
+
if @api_client.config.client_side_validation && income_verification_paystubs_get_request.nil?
|
3423
|
+
fail ArgumentError, "Missing the required parameter 'income_verification_paystubs_get_request' when calling PlaidApi.income_verification_paystubs_get"
|
3424
|
+
end
|
3425
|
+
# resource path
|
3426
|
+
local_var_path = '/income/verification/paystubs/get'
|
3427
|
+
|
3428
|
+
# query parameters
|
3429
|
+
query_params = opts[:query_params] || {}
|
3430
|
+
|
3431
|
+
# header parameters
|
3432
|
+
header_params = opts[:header_params] || {}
|
3433
|
+
# HTTP header 'Accept' (if needed)
|
3434
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
3435
|
+
# HTTP header 'Content-Type'
|
3436
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
3437
|
+
|
3438
|
+
# form parameters
|
3439
|
+
form_params = opts[:form_params] || {}
|
3440
|
+
|
3441
|
+
# http body (model)
|
3442
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(income_verification_paystubs_get_request)
|
3443
|
+
|
3444
|
+
# return_type
|
3445
|
+
return_type = opts[:debug_return_type] || 'IncomeVerificationPaystubsGetResponse'
|
3446
|
+
|
3447
|
+
# auth_names
|
3448
|
+
auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
|
3449
|
+
|
3450
|
+
new_options = opts.merge(
|
3451
|
+
:operation => :"PlaidApi.income_verification_paystubs_get",
|
3452
|
+
:header_params => header_params,
|
3453
|
+
:query_params => query_params,
|
3454
|
+
:form_params => form_params,
|
3455
|
+
:body => post_body,
|
3456
|
+
:auth_names => auth_names,
|
3457
|
+
:return_type => return_type
|
3458
|
+
)
|
3459
|
+
|
3460
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
3461
|
+
if @api_client.config.debugging
|
3462
|
+
@api_client.config.logger.debug "API called: PlaidApi#income_verification_paystubs_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
3463
|
+
end
|
3464
|
+
return data, status_code, headers
|
3465
|
+
end
|
3466
|
+
|
3467
|
+
# (Deprecated) Check digital income verification eligibility and optimize conversion
|
3468
|
+
# `/income/verification/precheck` is an optional endpoint that can be called before initializing a Link session for income verification. It evaluates whether a given user is supportable by digital income verification and returns a `precheck_id` that can be provided to `/link/token/create`. If the user is eligible for digital verification, providing the `precheck_id` in this way will generate a Link UI optimized for the end user and their specific employer. If the user cannot be confirmed as eligible, the `precheck_id` can still be provided to `/link/token/create` and the user can still use the income verification flow, but they may be required to manually upload a paystub to verify their income. While all request fields are optional, providing either `employer` or `transactions_access_tokens` data will increase the chance of receiving a useful result. This endpoint has been deprecated; new integrations should use `/credit/payroll_income/precheck` instead.
|
3469
|
+
# @param income_verification_precheck_request [IncomeVerificationPrecheckRequest]
|
3470
|
+
# @param [Hash] opts the optional parameters
|
3471
|
+
# @return [IncomeVerificationPrecheckResponse]
|
3472
|
+
def income_verification_precheck(income_verification_precheck_request, opts = {})
|
3473
|
+
data, _status_code, _headers = income_verification_precheck_with_http_info(income_verification_precheck_request, opts)
|
3474
|
+
data
|
3475
|
+
end
|
3476
|
+
|
3477
|
+
# (Deprecated) Check digital income verification eligibility and optimize conversion
|
3478
|
+
# `/income/verification/precheck` is an optional endpoint that can be called before initializing a Link session for income verification. It evaluates whether a given user is supportable by digital income verification and returns a `precheck_id` that can be provided to `/link/token/create`. If the user is eligible for digital verification, providing the `precheck_id` in this way will generate a Link UI optimized for the end user and their specific employer. If the user cannot be confirmed as eligible, the `precheck_id` can still be provided to `/link/token/create` and the user can still use the income verification flow, but they may be required to manually upload a paystub to verify their income. While all request fields are optional, providing either `employer` or `transactions_access_tokens` data will increase the chance of receiving a useful result. This endpoint has been deprecated; new integrations should use `/credit/payroll_income/precheck` instead.
|
3479
|
+
# @param income_verification_precheck_request [IncomeVerificationPrecheckRequest]
|
3480
|
+
# @param [Hash] opts the optional parameters
|
3481
|
+
# @return [Array<(IncomeVerificationPrecheckResponse, Integer, Hash)>] IncomeVerificationPrecheckResponse data, response status code and response headers
|
3482
|
+
def income_verification_precheck_with_http_info(income_verification_precheck_request, opts = {})
|
3483
|
+
if @api_client.config.debugging
|
3484
|
+
@api_client.config.logger.debug 'Calling API: PlaidApi.income_verification_precheck ...'
|
3485
|
+
end
|
3486
|
+
# verify the required parameter 'income_verification_precheck_request' is set
|
3487
|
+
if @api_client.config.client_side_validation && income_verification_precheck_request.nil?
|
2968
3488
|
fail ArgumentError, "Missing the required parameter 'income_verification_precheck_request' when calling PlaidApi.income_verification_precheck"
|
2969
3489
|
end
|
2970
3490
|
# resource path
|
@@ -3400,7 +3920,7 @@ module Plaid
|
|
3400
3920
|
end
|
3401
3921
|
|
3402
3922
|
# Get investment transactions
|
3403
|
-
# The `/investments/transactions/get` endpoint allows developers to retrieve user-authorized transaction data for investment accounts. Transactions are returned in reverse-chronological order, and the sequence of transaction ordering is stable and will not shift. Due to the potentially large number of investment transactions associated with an Item, results are paginated. Manipulate the count and offset parameters in conjunction with the `total_investment_transactions` response body field to fetch all available investment transactions.
|
3923
|
+
# The `/investments/transactions/get` endpoint allows developers to retrieve up to 24 months of user-authorized transaction data for investment accounts. Transactions are returned in reverse-chronological order, and the sequence of transaction ordering is stable and will not shift. Due to the potentially large number of investment transactions associated with an Item, results are paginated. Manipulate the count and offset parameters in conjunction with the `total_investment_transactions` response body field to fetch all available investment transactions.
|
3404
3924
|
# @param investments_transactions_get_request [InvestmentsTransactionsGetRequest]
|
3405
3925
|
# @param [Hash] opts the optional parameters
|
3406
3926
|
# @return [InvestmentsTransactionsGetResponse]
|
@@ -3410,7 +3930,7 @@ module Plaid
|
|
3410
3930
|
end
|
3411
3931
|
|
3412
3932
|
# Get investment transactions
|
3413
|
-
# The `/investments/transactions/get` endpoint allows developers to retrieve user-authorized transaction data for investment accounts. Transactions are returned in reverse-chronological order, and the sequence of transaction ordering is stable and will not shift. Due to the potentially large number of investment transactions associated with an Item, results are paginated. Manipulate the count and offset parameters in conjunction with the `total_investment_transactions` response body field to fetch all available investment transactions.
|
3933
|
+
# The `/investments/transactions/get` endpoint allows developers to retrieve up to 24 months of user-authorized transaction data for investment accounts. Transactions are returned in reverse-chronological order, and the sequence of transaction ordering is stable and will not shift. Due to the potentially large number of investment transactions associated with an Item, results are paginated. Manipulate the count and offset parameters in conjunction with the `total_investment_transactions` response body field to fetch all available investment transactions.
|
3414
3934
|
# @param investments_transactions_get_request [InvestmentsTransactionsGetRequest]
|
3415
3935
|
# @param [Hash] opts the optional parameters
|
3416
3936
|
# @return [Array<(InvestmentsTransactionsGetResponse, Integer, Hash)>] InvestmentsTransactionsGetResponse data, response status code and response headers
|
@@ -5610,7 +6130,7 @@ module Plaid
|
|
5610
6130
|
end
|
5611
6131
|
|
5612
6132
|
# Fire a test webhook
|
5613
|
-
# The `/sandbox/item/fire_webhook` endpoint is used to test that code correctly handles webhooks. This endpoint can trigger the following webhooks:
|
6133
|
+
# The `/sandbox/item/fire_webhook` endpoint is used to test that code correctly handles webhooks. This endpoint can trigger the following webhooks: `DEFAULT_UPDATE`: Transactions update webhook to be fired for a given Sandbox Item. If the Item does not support Transactions, a `SANDBOX_PRODUCT_NOT_ENABLED` error will result. `NEW_ACCOUNTS_AVAILABLE`: Webhook to be fired for a given Sandbox Item created with Account Select v2. `AUTH_DATA_UPDATE`: Webhook to be fired for a given Sandbox Item created with Auth as an enabled product. Note that this endpoint is provided for developer ease-of-use and is not required for testing webhooks; webhooks will also fire in Sandbox under the same conditions that they would in Production or Development'
|
5614
6134
|
# @param sandbox_item_fire_webhook_request [SandboxItemFireWebhookRequest]
|
5615
6135
|
# @param [Hash] opts the optional parameters
|
5616
6136
|
# @return [SandboxItemFireWebhookResponse]
|
@@ -5620,7 +6140,7 @@ module Plaid
|
|
5620
6140
|
end
|
5621
6141
|
|
5622
6142
|
# Fire a test webhook
|
5623
|
-
# The `/sandbox/item/fire_webhook` endpoint is used to test that code correctly handles webhooks. This endpoint can trigger the following webhooks:
|
6143
|
+
# The `/sandbox/item/fire_webhook` endpoint is used to test that code correctly handles webhooks. This endpoint can trigger the following webhooks: `DEFAULT_UPDATE`: Transactions update webhook to be fired for a given Sandbox Item. If the Item does not support Transactions, a `SANDBOX_PRODUCT_NOT_ENABLED` error will result. `NEW_ACCOUNTS_AVAILABLE`: Webhook to be fired for a given Sandbox Item created with Account Select v2. `AUTH_DATA_UPDATE`: Webhook to be fired for a given Sandbox Item created with Auth as an enabled product. Note that this endpoint is provided for developer ease-of-use and is not required for testing webhooks; webhooks will also fire in Sandbox under the same conditions that they would in Production or Development'
|
5624
6144
|
# @param sandbox_item_fire_webhook_request [SandboxItemFireWebhookRequest]
|
5625
6145
|
# @param [Hash] opts the optional parameters
|
5626
6146
|
# @return [Array<(SandboxItemFireWebhookResponse, Integer, Hash)>] SandboxItemFireWebhookResponse data, response status code and response headers
|
@@ -6195,7 +6715,7 @@ module Plaid
|
|
6195
6715
|
end
|
6196
6716
|
|
6197
6717
|
# Simulate creating a sweep
|
6198
|
-
# Use the `/sandbox/transfer/sweep/simulate` endpoint to create a sweep and associated events in the Sandbox environment. Upon calling this endpoint, all `posted` or `pending` transfers with a sweep status of `unswept` will become `swept`, and all `
|
6718
|
+
# Use the `/sandbox/transfer/sweep/simulate` endpoint to create a sweep and associated events in the Sandbox environment. Upon calling this endpoint, all `posted` or `pending` transfers with a sweep status of `unswept` will become `swept`, and all `returned` transfers with a sweep status of `swept` will become `return_swept`.
|
6199
6719
|
# @param sandbox_transfer_sweep_simulate_request [SandboxTransferSweepSimulateRequest]
|
6200
6720
|
# @param [Hash] opts the optional parameters
|
6201
6721
|
# @return [SandboxTransferSweepSimulateResponse]
|
@@ -6205,7 +6725,7 @@ module Plaid
|
|
6205
6725
|
end
|
6206
6726
|
|
6207
6727
|
# Simulate creating a sweep
|
6208
|
-
# Use the `/sandbox/transfer/sweep/simulate` endpoint to create a sweep and associated events in the Sandbox environment. Upon calling this endpoint, all `posted` or `pending` transfers with a sweep status of `unswept` will become `swept`, and all `
|
6728
|
+
# Use the `/sandbox/transfer/sweep/simulate` endpoint to create a sweep and associated events in the Sandbox environment. Upon calling this endpoint, all `posted` or `pending` transfers with a sweep status of `unswept` will become `swept`, and all `returned` transfers with a sweep status of `swept` will become `return_swept`.
|
6209
6729
|
# @param sandbox_transfer_sweep_simulate_request [SandboxTransferSweepSimulateRequest]
|
6210
6730
|
# @param [Hash] opts the optional parameters
|
6211
6731
|
# @return [Array<(SandboxTransferSweepSimulateResponse, Integer, Hash)>] SandboxTransferSweepSimulateResponse data, response status code and response headers
|
@@ -6649,74 +7169,9 @@ module Plaid
|
|
6649
7169
|
return data, status_code, headers
|
6650
7170
|
end
|
6651
7171
|
|
6652
|
-
#
|
6653
|
-
# The `/transactions/recurring/
|
6654
|
-
# @param
|
6655
|
-
# @param [Hash] opts the optional parameters
|
6656
|
-
# @return [TransactionsRecurringDeactivateResponse]
|
6657
|
-
def transactions_recurring_deactivate(transactions_recurring_deactivate_request, opts = {})
|
6658
|
-
data, _status_code, _headers = transactions_recurring_deactivate_with_http_info(transactions_recurring_deactivate_request, opts)
|
6659
|
-
data
|
6660
|
-
end
|
6661
|
-
|
6662
|
-
# Deactivate recurring transactions product for Item
|
6663
|
-
# The `/transactions/recurring/deactivate` endpoint returns returns a message indicating the success in removing the product from the Item or returns an error. The product is currently in beta. To request access, contact transactions-feedback@plaid.com.
|
6664
|
-
# @param transactions_recurring_deactivate_request [TransactionsRecurringDeactivateRequest]
|
6665
|
-
# @param [Hash] opts the optional parameters
|
6666
|
-
# @return [Array<(TransactionsRecurringDeactivateResponse, Integer, Hash)>] TransactionsRecurringDeactivateResponse data, response status code and response headers
|
6667
|
-
def transactions_recurring_deactivate_with_http_info(transactions_recurring_deactivate_request, opts = {})
|
6668
|
-
if @api_client.config.debugging
|
6669
|
-
@api_client.config.logger.debug 'Calling API: PlaidApi.transactions_recurring_deactivate ...'
|
6670
|
-
end
|
6671
|
-
# verify the required parameter 'transactions_recurring_deactivate_request' is set
|
6672
|
-
if @api_client.config.client_side_validation && transactions_recurring_deactivate_request.nil?
|
6673
|
-
fail ArgumentError, "Missing the required parameter 'transactions_recurring_deactivate_request' when calling PlaidApi.transactions_recurring_deactivate"
|
6674
|
-
end
|
6675
|
-
# resource path
|
6676
|
-
local_var_path = '/transactions/recurring/deactivate'
|
6677
|
-
|
6678
|
-
# query parameters
|
6679
|
-
query_params = opts[:query_params] || {}
|
6680
|
-
|
6681
|
-
# header parameters
|
6682
|
-
header_params = opts[:header_params] || {}
|
6683
|
-
# HTTP header 'Accept' (if needed)
|
6684
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
6685
|
-
# HTTP header 'Content-Type'
|
6686
|
-
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
6687
|
-
|
6688
|
-
# form parameters
|
6689
|
-
form_params = opts[:form_params] || {}
|
6690
|
-
|
6691
|
-
# http body (model)
|
6692
|
-
post_body = opts[:debug_body] || @api_client.object_to_http_body(transactions_recurring_deactivate_request)
|
6693
|
-
|
6694
|
-
# return_type
|
6695
|
-
return_type = opts[:debug_return_type] || 'TransactionsRecurringDeactivateResponse'
|
6696
|
-
|
6697
|
-
# auth_names
|
6698
|
-
auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
|
6699
|
-
|
6700
|
-
new_options = opts.merge(
|
6701
|
-
:operation => :"PlaidApi.transactions_recurring_deactivate",
|
6702
|
-
:header_params => header_params,
|
6703
|
-
:query_params => query_params,
|
6704
|
-
:form_params => form_params,
|
6705
|
-
:body => post_body,
|
6706
|
-
:auth_names => auth_names,
|
6707
|
-
:return_type => return_type
|
6708
|
-
)
|
6709
|
-
|
6710
|
-
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
6711
|
-
if @api_client.config.debugging
|
6712
|
-
@api_client.config.logger.debug "API called: PlaidApi#transactions_recurring_deactivate\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
6713
|
-
end
|
6714
|
-
return data, status_code, headers
|
6715
|
-
end
|
6716
|
-
|
6717
|
-
# Get streams of recurring transactions
|
6718
|
-
# The `/transactions/recurring/get` endpoint identifies and returns groups of transactions that occur on a regular basis for the inputted Item and accounts. The product is currently in beta. To request access, contact transactions-feedback@plaid.com.
|
6719
|
-
# @param transactions_recurring_get_request [TransactionsRecurringGetRequest]
|
7172
|
+
# Fetch recurring transaction streams
|
7173
|
+
# The `/transactions/recurring/get` endpoint allows developers to receive a summary of the recurring outflow and inflow streams (expenses and deposits) from a user’s checking, savings or credit card accounts. Additionally, Plaid provides key insights about each recurring stream including the category, merchant, last amount, and more. Developers can use these insights to build tools and experiences that help their users better manage cash flow, monitor subscriptions, reduce spend, and stay on track with bill payments. This endpoint is not included by default as part of Transactions. To request access to this endpoint and learn more about pricing, contact your Plaid account manager. Note that unlike `/transactions/get`, `/transactions/recurring/get` will not initialize an Item with Transactions. The Item must already have been initialized with Transactions (either during Link, by specifying it in `/link/token/create`, or after Link, by calling `/transactions/get`) before calling this endpoint. Data is available to `/transactions/recurring/get` approximately 5 seconds after the [`HISTORICAL_UPDATE`](https://plaid.com/docs/api/products/transactions/#historical_update) webhook has fired (about 1-2 minutes after initialization). After the initial call, you can call `/transactions/recurring/get` endpoint at any point in the future to retrieve the latest summary of recurring streams. Since recurring streams do not change often, it will typically not be necessary to call this endpoint more than once per day.
|
7174
|
+
# @param transactions_recurring_get_request [TransactionsRecurringGetRequest]
|
6720
7175
|
# @param [Hash] opts the optional parameters
|
6721
7176
|
# @return [TransactionsRecurringGetResponse]
|
6722
7177
|
def transactions_recurring_get(transactions_recurring_get_request, opts = {})
|
@@ -6724,8 +7179,8 @@ module Plaid
|
|
6724
7179
|
data
|
6725
7180
|
end
|
6726
7181
|
|
6727
|
-
#
|
6728
|
-
# The `/transactions/recurring/get` endpoint
|
7182
|
+
# Fetch recurring transaction streams
|
7183
|
+
# The `/transactions/recurring/get` endpoint allows developers to receive a summary of the recurring outflow and inflow streams (expenses and deposits) from a user’s checking, savings or credit card accounts. Additionally, Plaid provides key insights about each recurring stream including the category, merchant, last amount, and more. Developers can use these insights to build tools and experiences that help their users better manage cash flow, monitor subscriptions, reduce spend, and stay on track with bill payments. This endpoint is not included by default as part of Transactions. To request access to this endpoint and learn more about pricing, contact your Plaid account manager. Note that unlike `/transactions/get`, `/transactions/recurring/get` will not initialize an Item with Transactions. The Item must already have been initialized with Transactions (either during Link, by specifying it in `/link/token/create`, or after Link, by calling `/transactions/get`) before calling this endpoint. Data is available to `/transactions/recurring/get` approximately 5 seconds after the [`HISTORICAL_UPDATE`](https://plaid.com/docs/api/products/transactions/#historical_update) webhook has fired (about 1-2 minutes after initialization). After the initial call, you can call `/transactions/recurring/get` endpoint at any point in the future to retrieve the latest summary of recurring streams. Since recurring streams do not change often, it will typically not be necessary to call this endpoint more than once per day.
|
6729
7184
|
# @param transactions_recurring_get_request [TransactionsRecurringGetRequest]
|
6730
7185
|
# @param [Hash] opts the optional parameters
|
6731
7186
|
# @return [Array<(TransactionsRecurringGetResponse, Integer, Hash)>] TransactionsRecurringGetResponse data, response status code and response headers
|
@@ -6845,7 +7300,7 @@ module Plaid
|
|
6845
7300
|
end
|
6846
7301
|
|
6847
7302
|
# Create transaction category rule
|
6848
|
-
# The `/transactions/rules/create` endpoint creates transaction categorization rules. Rules will be applied on the Item's transactions returned in `/transactions/get` response. The product is currently in beta. To request access, contact transactions-feedback@plaid.com.
|
7303
|
+
# The `/transactions/rules/v1/create` endpoint creates transaction categorization rules. Rules will be applied on the Item's transactions returned in `/transactions/get` response. The product is currently in beta. To request access, contact transactions-feedback@plaid.com.
|
6849
7304
|
# @param transactions_rules_create_request [TransactionsRulesCreateRequest]
|
6850
7305
|
# @param [Hash] opts the optional parameters
|
6851
7306
|
# @return [TransactionsRulesCreateResponse]
|
@@ -6855,7 +7310,7 @@ module Plaid
|
|
6855
7310
|
end
|
6856
7311
|
|
6857
7312
|
# Create transaction category rule
|
6858
|
-
# The `/transactions/rules/create` endpoint creates transaction categorization rules. Rules will be applied on the Item's transactions returned in `/transactions/get` response. The product is currently in beta. To request access, contact transactions-feedback@plaid.com.
|
7313
|
+
# The `/transactions/rules/v1/create` endpoint creates transaction categorization rules. Rules will be applied on the Item's transactions returned in `/transactions/get` response. The product is currently in beta. To request access, contact transactions-feedback@plaid.com.
|
6859
7314
|
# @param transactions_rules_create_request [TransactionsRulesCreateRequest]
|
6860
7315
|
# @param [Hash] opts the optional parameters
|
6861
7316
|
# @return [Array<(TransactionsRulesCreateResponse, Integer, Hash)>] TransactionsRulesCreateResponse data, response status code and response headers
|
@@ -6868,7 +7323,7 @@ module Plaid
|
|
6868
7323
|
fail ArgumentError, "Missing the required parameter 'transactions_rules_create_request' when calling PlaidApi.transactions_rules_create"
|
6869
7324
|
end
|
6870
7325
|
# resource path
|
6871
|
-
local_var_path = '/beta/transactions/rules/create'
|
7326
|
+
local_var_path = '/beta/transactions/rules/v1/create'
|
6872
7327
|
|
6873
7328
|
# query parameters
|
6874
7329
|
query_params = opts[:query_params] || {}
|
@@ -6910,7 +7365,7 @@ module Plaid
|
|
6910
7365
|
end
|
6911
7366
|
|
6912
7367
|
# Return a list of rules created for the Item associated with the access token.
|
6913
|
-
# The `/transactions/rules/list` returns a list of transaction rules created for the Item associated with the access token.
|
7368
|
+
# The `/transactions/rules/v1/list` returns a list of transaction rules created for the Item associated with the access token.
|
6914
7369
|
# @param transactions_rules_list_request [TransactionsRulesListRequest]
|
6915
7370
|
# @param [Hash] opts the optional parameters
|
6916
7371
|
# @return [TransactionsRulesListResponse]
|
@@ -6920,7 +7375,7 @@ module Plaid
|
|
6920
7375
|
end
|
6921
7376
|
|
6922
7377
|
# Return a list of rules created for the Item associated with the access token.
|
6923
|
-
# The `/transactions/rules/list` returns a list of transaction rules created for the Item associated with the access token.
|
7378
|
+
# The `/transactions/rules/v1/list` returns a list of transaction rules created for the Item associated with the access token.
|
6924
7379
|
# @param transactions_rules_list_request [TransactionsRulesListRequest]
|
6925
7380
|
# @param [Hash] opts the optional parameters
|
6926
7381
|
# @return [Array<(TransactionsRulesListResponse, Integer, Hash)>] TransactionsRulesListResponse data, response status code and response headers
|
@@ -6933,7 +7388,7 @@ module Plaid
|
|
6933
7388
|
fail ArgumentError, "Missing the required parameter 'transactions_rules_list_request' when calling PlaidApi.transactions_rules_list"
|
6934
7389
|
end
|
6935
7390
|
# resource path
|
6936
|
-
local_var_path = '/beta/transactions/rules/list'
|
7391
|
+
local_var_path = '/beta/transactions/rules/v1/list'
|
6937
7392
|
|
6938
7393
|
# query parameters
|
6939
7394
|
query_params = opts[:query_params] || {}
|
@@ -6975,7 +7430,7 @@ module Plaid
|
|
6975
7430
|
end
|
6976
7431
|
|
6977
7432
|
# Remove transaction rule
|
6978
|
-
# The `/transactions/rules/remove` endpoint is used to remove a transaction rule.
|
7433
|
+
# The `/transactions/rules/v1/remove` endpoint is used to remove a transaction rule.
|
6979
7434
|
# @param transactions_rules_remove_request [TransactionsRulesRemoveRequest]
|
6980
7435
|
# @param [Hash] opts the optional parameters
|
6981
7436
|
# @return [TransactionsRulesRemoveResponse]
|
@@ -6985,7 +7440,7 @@ module Plaid
|
|
6985
7440
|
end
|
6986
7441
|
|
6987
7442
|
# Remove transaction rule
|
6988
|
-
# The `/transactions/rules/remove` endpoint is used to remove a transaction rule.
|
7443
|
+
# The `/transactions/rules/v1/remove` endpoint is used to remove a transaction rule.
|
6989
7444
|
# @param transactions_rules_remove_request [TransactionsRulesRemoveRequest]
|
6990
7445
|
# @param [Hash] opts the optional parameters
|
6991
7446
|
# @return [Array<(TransactionsRulesRemoveResponse, Integer, Hash)>] TransactionsRulesRemoveResponse data, response status code and response headers
|
@@ -6998,7 +7453,7 @@ module Plaid
|
|
6998
7453
|
fail ArgumentError, "Missing the required parameter 'transactions_rules_remove_request' when calling PlaidApi.transactions_rules_remove"
|
6999
7454
|
end
|
7000
7455
|
# resource path
|
7001
|
-
local_var_path = '/beta/transactions/rules/remove'
|
7456
|
+
local_var_path = '/beta/transactions/rules/v1/remove'
|
7002
7457
|
|
7003
7458
|
# query parameters
|
7004
7459
|
query_params = opts[:query_params] || {}
|
@@ -7040,7 +7495,7 @@ module Plaid
|
|
7040
7495
|
end
|
7041
7496
|
|
7042
7497
|
# Get incremental transaction updates on an Item
|
7043
|
-
# The `/transactions/sync` endpoint
|
7498
|
+
# This endpoint replaces `/transactions/get` and its associated webhooks for most common use-cases. The `/transactions/sync` endpoint allows developers to subscribe to all transactions associated with an Item and get updates synchronously in a stream-like manner, using a cursor to track which updates have already been seen. `/transactions/sync` provides the same functionality as `/transactions/get` and can be used instead of `/transactions/get` to simplify the process of tracking transactions updates. This endpoint provides user-authorized transaction data for `credit`, `depository`, and some loan-type accounts (only those with account subtype `student`; coverage may be limited). For transaction history from `investments` accounts, use `/investments/transactions/get` instead. Returned transactions data is grouped into three types of update, indicating whether the transaction was added, removed, or modified since the last call to the API. In the first call to `/transactions/sync` for an Item, the endpoint will return all historical transactions data associated with that Item up until the time of the API call (as \"adds\"), which then generates a `latest_cursor` for that Item. In subsequent calls, send the `latest_cursor` to receive only the changes that have occurred since the previous call. Due to the potentially large number of transactions associated with an Item, results are paginated. The `has_more` field specifies if additional calls are necessary to fetch all available transaction updates. Whenever new or updated transaction data becomes available, `/transactions/sync` will provide these updates. Plaid typically checks for new data multiple times a day, but these checks may occur less frequently, such as once a day, depending on the institution. An Item's `status.transactions.last_successful_update` field will show the timestamp of the most recent successful update. To force Plaid to check for new transactions, use the `/transactions/refresh` endpoint. Note that for newly created Items, data may not be immediately available to `/transactions/sync`. Plaid begins preparing transactions data when the Item is created, but the process can take anywhere from a few seconds to several minutes to complete, depending on the number of transactions available. To be alerted when new data is available, listen for the [`SYNC_UPDATES_AVAILABLE`](https://plaid.com/docs/api/products/transactions/#sync_updates_available) webhook.
|
7044
7499
|
# @param transactions_sync_request [TransactionsSyncRequest]
|
7045
7500
|
# @param [Hash] opts the optional parameters
|
7046
7501
|
# @return [TransactionsSyncResponse]
|
@@ -7050,7 +7505,7 @@ module Plaid
|
|
7050
7505
|
end
|
7051
7506
|
|
7052
7507
|
# Get incremental transaction updates on an Item
|
7053
|
-
# The `/transactions/sync` endpoint
|
7508
|
+
# This endpoint replaces `/transactions/get` and its associated webhooks for most common use-cases. The `/transactions/sync` endpoint allows developers to subscribe to all transactions associated with an Item and get updates synchronously in a stream-like manner, using a cursor to track which updates have already been seen. `/transactions/sync` provides the same functionality as `/transactions/get` and can be used instead of `/transactions/get` to simplify the process of tracking transactions updates. This endpoint provides user-authorized transaction data for `credit`, `depository`, and some loan-type accounts (only those with account subtype `student`; coverage may be limited). For transaction history from `investments` accounts, use `/investments/transactions/get` instead. Returned transactions data is grouped into three types of update, indicating whether the transaction was added, removed, or modified since the last call to the API. In the first call to `/transactions/sync` for an Item, the endpoint will return all historical transactions data associated with that Item up until the time of the API call (as \"adds\"), which then generates a `latest_cursor` for that Item. In subsequent calls, send the `latest_cursor` to receive only the changes that have occurred since the previous call. Due to the potentially large number of transactions associated with an Item, results are paginated. The `has_more` field specifies if additional calls are necessary to fetch all available transaction updates. Whenever new or updated transaction data becomes available, `/transactions/sync` will provide these updates. Plaid typically checks for new data multiple times a day, but these checks may occur less frequently, such as once a day, depending on the institution. An Item's `status.transactions.last_successful_update` field will show the timestamp of the most recent successful update. To force Plaid to check for new transactions, use the `/transactions/refresh` endpoint. Note that for newly created Items, data may not be immediately available to `/transactions/sync`. Plaid begins preparing transactions data when the Item is created, but the process can take anywhere from a few seconds to several minutes to complete, depending on the number of transactions available. To be alerted when new data is available, listen for the [`SYNC_UPDATES_AVAILABLE`](https://plaid.com/docs/api/products/transactions/#sync_updates_available) webhook.
|
7054
7509
|
# @param transactions_sync_request [TransactionsSyncRequest]
|
7055
7510
|
# @param [Hash] opts the optional parameters
|
7056
7511
|
# @return [Array<(TransactionsSyncResponse, Integer, Hash)>] TransactionsSyncResponse data, response status code and response headers
|
@@ -8079,8 +8534,73 @@ module Plaid
|
|
8079
8534
|
return data, status_code, headers
|
8080
8535
|
end
|
8081
8536
|
|
8537
|
+
# Create an e-wallet
|
8538
|
+
# Create an e-wallet. The response is the newly created e-wallet object.
|
8539
|
+
# @param wallet_create_request [WalletCreateRequest]
|
8540
|
+
# @param [Hash] opts the optional parameters
|
8541
|
+
# @return [WalletCreateResponse]
|
8542
|
+
def wallet_create(wallet_create_request, opts = {})
|
8543
|
+
data, _status_code, _headers = wallet_create_with_http_info(wallet_create_request, opts)
|
8544
|
+
data
|
8545
|
+
end
|
8546
|
+
|
8547
|
+
# Create an e-wallet
|
8548
|
+
# Create an e-wallet. The response is the newly created e-wallet object.
|
8549
|
+
# @param wallet_create_request [WalletCreateRequest]
|
8550
|
+
# @param [Hash] opts the optional parameters
|
8551
|
+
# @return [Array<(WalletCreateResponse, Integer, Hash)>] WalletCreateResponse data, response status code and response headers
|
8552
|
+
def wallet_create_with_http_info(wallet_create_request, opts = {})
|
8553
|
+
if @api_client.config.debugging
|
8554
|
+
@api_client.config.logger.debug 'Calling API: PlaidApi.wallet_create ...'
|
8555
|
+
end
|
8556
|
+
# verify the required parameter 'wallet_create_request' is set
|
8557
|
+
if @api_client.config.client_side_validation && wallet_create_request.nil?
|
8558
|
+
fail ArgumentError, "Missing the required parameter 'wallet_create_request' when calling PlaidApi.wallet_create"
|
8559
|
+
end
|
8560
|
+
# resource path
|
8561
|
+
local_var_path = '/wallet/create'
|
8562
|
+
|
8563
|
+
# query parameters
|
8564
|
+
query_params = opts[:query_params] || {}
|
8565
|
+
|
8566
|
+
# header parameters
|
8567
|
+
header_params = opts[:header_params] || {}
|
8568
|
+
# HTTP header 'Accept' (if needed)
|
8569
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
8570
|
+
# HTTP header 'Content-Type'
|
8571
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
8572
|
+
|
8573
|
+
# form parameters
|
8574
|
+
form_params = opts[:form_params] || {}
|
8575
|
+
|
8576
|
+
# http body (model)
|
8577
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(wallet_create_request)
|
8578
|
+
|
8579
|
+
# return_type
|
8580
|
+
return_type = opts[:debug_return_type] || 'WalletCreateResponse'
|
8581
|
+
|
8582
|
+
# auth_names
|
8583
|
+
auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
|
8584
|
+
|
8585
|
+
new_options = opts.merge(
|
8586
|
+
:operation => :"PlaidApi.wallet_create",
|
8587
|
+
:header_params => header_params,
|
8588
|
+
:query_params => query_params,
|
8589
|
+
:form_params => form_params,
|
8590
|
+
:body => post_body,
|
8591
|
+
:auth_names => auth_names,
|
8592
|
+
:return_type => return_type
|
8593
|
+
)
|
8594
|
+
|
8595
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
8596
|
+
if @api_client.config.debugging
|
8597
|
+
@api_client.config.logger.debug "API called: PlaidApi#wallet_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
8598
|
+
end
|
8599
|
+
return data, status_code, headers
|
8600
|
+
end
|
8601
|
+
|
8082
8602
|
# Fetch an e-wallet
|
8083
|
-
# Fetch an e-wallet. The response includes the current balance.
|
8603
|
+
# Fetch an e-wallet. The response includes the current balance.
|
8084
8604
|
# @param wallet_get_request [WalletGetRequest]
|
8085
8605
|
# @param [Hash] opts the optional parameters
|
8086
8606
|
# @return [WalletGetResponse]
|
@@ -8090,7 +8610,7 @@ module Plaid
|
|
8090
8610
|
end
|
8091
8611
|
|
8092
8612
|
# Fetch an e-wallet
|
8093
|
-
# Fetch an e-wallet. The response includes the current balance.
|
8613
|
+
# Fetch an e-wallet. The response includes the current balance.
|
8094
8614
|
# @param wallet_get_request [WalletGetRequest]
|
8095
8615
|
# @param [Hash] opts the optional parameters
|
8096
8616
|
# @return [Array<(WalletGetResponse, Integer, Hash)>] WalletGetResponse data, response status code and response headers
|
@@ -8144,8 +8664,73 @@ module Plaid
|
|
8144
8664
|
return data, status_code, headers
|
8145
8665
|
end
|
8146
8666
|
|
8667
|
+
# Fetch a list of e-wallets
|
8668
|
+
# This endpoint lists all e-wallets in descending order of creation.
|
8669
|
+
# @param wallet_list_request [WalletListRequest]
|
8670
|
+
# @param [Hash] opts the optional parameters
|
8671
|
+
# @return [WalletListResponse]
|
8672
|
+
def wallet_list(wallet_list_request, opts = {})
|
8673
|
+
data, _status_code, _headers = wallet_list_with_http_info(wallet_list_request, opts)
|
8674
|
+
data
|
8675
|
+
end
|
8676
|
+
|
8677
|
+
# Fetch a list of e-wallets
|
8678
|
+
# This endpoint lists all e-wallets in descending order of creation.
|
8679
|
+
# @param wallet_list_request [WalletListRequest]
|
8680
|
+
# @param [Hash] opts the optional parameters
|
8681
|
+
# @return [Array<(WalletListResponse, Integer, Hash)>] WalletListResponse data, response status code and response headers
|
8682
|
+
def wallet_list_with_http_info(wallet_list_request, opts = {})
|
8683
|
+
if @api_client.config.debugging
|
8684
|
+
@api_client.config.logger.debug 'Calling API: PlaidApi.wallet_list ...'
|
8685
|
+
end
|
8686
|
+
# verify the required parameter 'wallet_list_request' is set
|
8687
|
+
if @api_client.config.client_side_validation && wallet_list_request.nil?
|
8688
|
+
fail ArgumentError, "Missing the required parameter 'wallet_list_request' when calling PlaidApi.wallet_list"
|
8689
|
+
end
|
8690
|
+
# resource path
|
8691
|
+
local_var_path = '/wallet/list'
|
8692
|
+
|
8693
|
+
# query parameters
|
8694
|
+
query_params = opts[:query_params] || {}
|
8695
|
+
|
8696
|
+
# header parameters
|
8697
|
+
header_params = opts[:header_params] || {}
|
8698
|
+
# HTTP header 'Accept' (if needed)
|
8699
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
8700
|
+
# HTTP header 'Content-Type'
|
8701
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
8702
|
+
|
8703
|
+
# form parameters
|
8704
|
+
form_params = opts[:form_params] || {}
|
8705
|
+
|
8706
|
+
# http body (model)
|
8707
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(wallet_list_request)
|
8708
|
+
|
8709
|
+
# return_type
|
8710
|
+
return_type = opts[:debug_return_type] || 'WalletListResponse'
|
8711
|
+
|
8712
|
+
# auth_names
|
8713
|
+
auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
|
8714
|
+
|
8715
|
+
new_options = opts.merge(
|
8716
|
+
:operation => :"PlaidApi.wallet_list",
|
8717
|
+
:header_params => header_params,
|
8718
|
+
:query_params => query_params,
|
8719
|
+
:form_params => form_params,
|
8720
|
+
:body => post_body,
|
8721
|
+
:auth_names => auth_names,
|
8722
|
+
:return_type => return_type
|
8723
|
+
)
|
8724
|
+
|
8725
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
8726
|
+
if @api_client.config.debugging
|
8727
|
+
@api_client.config.logger.debug "API called: PlaidApi#wallet_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
8728
|
+
end
|
8729
|
+
return data, status_code, headers
|
8730
|
+
end
|
8731
|
+
|
8147
8732
|
# Execute a transaction using an e-wallet
|
8148
|
-
# Execute a transaction using the specified e-wallet. Specify the e-wallet to debit from, the counterparty to credit to, the idempotency key to prevent duplicate payouts, the amount and reference for the payout. The payouts are executed over the Faster Payment rails, where settlement usually only takes a few seconds.
|
8733
|
+
# Execute a transaction using the specified e-wallet. Specify the e-wallet to debit from, the counterparty to credit to, the idempotency key to prevent duplicate payouts, the amount and reference for the payout. The payouts are executed over the Faster Payment rails, where settlement usually only takes a few seconds.
|
8149
8734
|
# @param wallet_transaction_execute_request [WalletTransactionExecuteRequest]
|
8150
8735
|
# @param [Hash] opts the optional parameters
|
8151
8736
|
# @return [WalletTransactionExecuteResponse]
|
@@ -8155,7 +8740,7 @@ module Plaid
|
|
8155
8740
|
end
|
8156
8741
|
|
8157
8742
|
# Execute a transaction using an e-wallet
|
8158
|
-
# Execute a transaction using the specified e-wallet. Specify the e-wallet to debit from, the counterparty to credit to, the idempotency key to prevent duplicate payouts, the amount and reference for the payout. The payouts are executed over the Faster Payment rails, where settlement usually only takes a few seconds.
|
8743
|
+
# Execute a transaction using the specified e-wallet. Specify the e-wallet to debit from, the counterparty to credit to, the idempotency key to prevent duplicate payouts, the amount and reference for the payout. The payouts are executed over the Faster Payment rails, where settlement usually only takes a few seconds.
|
8159
8744
|
# @param wallet_transaction_execute_request [WalletTransactionExecuteRequest]
|
8160
8745
|
# @param [Hash] opts the optional parameters
|
8161
8746
|
# @return [Array<(WalletTransactionExecuteResponse, Integer, Hash)>] WalletTransactionExecuteResponse data, response status code and response headers
|
@@ -8209,8 +8794,71 @@ module Plaid
|
|
8209
8794
|
return data, status_code, headers
|
8210
8795
|
end
|
8211
8796
|
|
8797
|
+
# Fetch a specific e-wallet transaction
|
8798
|
+
# @param wallet_transaction_get_request [WalletTransactionGetRequest]
|
8799
|
+
# @param [Hash] opts the optional parameters
|
8800
|
+
# @return [WalletTransactionGetResponse]
|
8801
|
+
def wallet_transaction_get(wallet_transaction_get_request, opts = {})
|
8802
|
+
data, _status_code, _headers = wallet_transaction_get_with_http_info(wallet_transaction_get_request, opts)
|
8803
|
+
data
|
8804
|
+
end
|
8805
|
+
|
8806
|
+
# Fetch a specific e-wallet transaction
|
8807
|
+
# @param wallet_transaction_get_request [WalletTransactionGetRequest]
|
8808
|
+
# @param [Hash] opts the optional parameters
|
8809
|
+
# @return [Array<(WalletTransactionGetResponse, Integer, Hash)>] WalletTransactionGetResponse data, response status code and response headers
|
8810
|
+
def wallet_transaction_get_with_http_info(wallet_transaction_get_request, opts = {})
|
8811
|
+
if @api_client.config.debugging
|
8812
|
+
@api_client.config.logger.debug 'Calling API: PlaidApi.wallet_transaction_get ...'
|
8813
|
+
end
|
8814
|
+
# verify the required parameter 'wallet_transaction_get_request' is set
|
8815
|
+
if @api_client.config.client_side_validation && wallet_transaction_get_request.nil?
|
8816
|
+
fail ArgumentError, "Missing the required parameter 'wallet_transaction_get_request' when calling PlaidApi.wallet_transaction_get"
|
8817
|
+
end
|
8818
|
+
# resource path
|
8819
|
+
local_var_path = '/wallet/transaction/get'
|
8820
|
+
|
8821
|
+
# query parameters
|
8822
|
+
query_params = opts[:query_params] || {}
|
8823
|
+
|
8824
|
+
# header parameters
|
8825
|
+
header_params = opts[:header_params] || {}
|
8826
|
+
# HTTP header 'Accept' (if needed)
|
8827
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
8828
|
+
# HTTP header 'Content-Type'
|
8829
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
8830
|
+
|
8831
|
+
# form parameters
|
8832
|
+
form_params = opts[:form_params] || {}
|
8833
|
+
|
8834
|
+
# http body (model)
|
8835
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(wallet_transaction_get_request)
|
8836
|
+
|
8837
|
+
# return_type
|
8838
|
+
return_type = opts[:debug_return_type] || 'WalletTransactionGetResponse'
|
8839
|
+
|
8840
|
+
# auth_names
|
8841
|
+
auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
|
8842
|
+
|
8843
|
+
new_options = opts.merge(
|
8844
|
+
:operation => :"PlaidApi.wallet_transaction_get",
|
8845
|
+
:header_params => header_params,
|
8846
|
+
:query_params => query_params,
|
8847
|
+
:form_params => form_params,
|
8848
|
+
:body => post_body,
|
8849
|
+
:auth_names => auth_names,
|
8850
|
+
:return_type => return_type
|
8851
|
+
)
|
8852
|
+
|
8853
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
8854
|
+
if @api_client.config.debugging
|
8855
|
+
@api_client.config.logger.debug "API called: PlaidApi#wallet_transaction_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
8856
|
+
end
|
8857
|
+
return data, status_code, headers
|
8858
|
+
end
|
8859
|
+
|
8212
8860
|
# List e-wallet transactions
|
8213
|
-
# This endpoint lists the latest transactions of the specified e-wallet. Transactions are returned in descending order by the `created_at` time.
|
8861
|
+
# This endpoint lists the latest transactions of the specified e-wallet. Transactions are returned in descending order by the `created_at` time.
|
8214
8862
|
# @param wallet_transactions_list_request [WalletTransactionsListRequest]
|
8215
8863
|
# @param [Hash] opts the optional parameters
|
8216
8864
|
# @return [WalletTransactionsListResponse]
|
@@ -8220,7 +8868,7 @@ module Plaid
|
|
8220
8868
|
end
|
8221
8869
|
|
8222
8870
|
# List e-wallet transactions
|
8223
|
-
# This endpoint lists the latest transactions of the specified e-wallet. Transactions are returned in descending order by the `created_at` time.
|
8871
|
+
# This endpoint lists the latest transactions of the specified e-wallet. Transactions are returned in descending order by the `created_at` time.
|
8224
8872
|
# @param wallet_transactions_list_request [WalletTransactionsListRequest]
|
8225
8873
|
# @param [Hash] opts the optional parameters
|
8226
8874
|
# @return [Array<(WalletTransactionsListResponse, Integer, Hash)>] WalletTransactionsListResponse data, response status code and response headers
|
@@ -8274,6 +8922,1306 @@ module Plaid
|
|
8274
8922
|
return data, status_code, headers
|
8275
8923
|
end
|
8276
8924
|
|
8925
|
+
# Create a watchlist screening for an entity
|
8926
|
+
# Create a new entity watchlist screening to check your customer against watchlists defined in the associated entity watchlist program. If your associated program has ongoing screening enabled, this is the profile information that will be used to monitor your customer over time.
|
8927
|
+
# @param create_entity_screening_request [CreateEntityScreeningRequest]
|
8928
|
+
# @param [Hash] opts the optional parameters
|
8929
|
+
# @return [EntityWatchlistScreeningResponse]
|
8930
|
+
def watchlist_screening_entity_create(create_entity_screening_request, opts = {})
|
8931
|
+
data, _status_code, _headers = watchlist_screening_entity_create_with_http_info(create_entity_screening_request, opts)
|
8932
|
+
data
|
8933
|
+
end
|
8934
|
+
|
8935
|
+
# Create a watchlist screening for an entity
|
8936
|
+
# Create a new entity watchlist screening to check your customer against watchlists defined in the associated entity watchlist program. If your associated program has ongoing screening enabled, this is the profile information that will be used to monitor your customer over time.
|
8937
|
+
# @param create_entity_screening_request [CreateEntityScreeningRequest]
|
8938
|
+
# @param [Hash] opts the optional parameters
|
8939
|
+
# @return [Array<(EntityWatchlistScreeningResponse, Integer, Hash)>] EntityWatchlistScreeningResponse data, response status code and response headers
|
8940
|
+
def watchlist_screening_entity_create_with_http_info(create_entity_screening_request, opts = {})
|
8941
|
+
if @api_client.config.debugging
|
8942
|
+
@api_client.config.logger.debug 'Calling API: PlaidApi.watchlist_screening_entity_create ...'
|
8943
|
+
end
|
8944
|
+
# verify the required parameter 'create_entity_screening_request' is set
|
8945
|
+
if @api_client.config.client_side_validation && create_entity_screening_request.nil?
|
8946
|
+
fail ArgumentError, "Missing the required parameter 'create_entity_screening_request' when calling PlaidApi.watchlist_screening_entity_create"
|
8947
|
+
end
|
8948
|
+
# resource path
|
8949
|
+
local_var_path = '/watchlist_screening/entity/create'
|
8950
|
+
|
8951
|
+
# query parameters
|
8952
|
+
query_params = opts[:query_params] || {}
|
8953
|
+
|
8954
|
+
# header parameters
|
8955
|
+
header_params = opts[:header_params] || {}
|
8956
|
+
# HTTP header 'Accept' (if needed)
|
8957
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
8958
|
+
# HTTP header 'Content-Type'
|
8959
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
8960
|
+
|
8961
|
+
# form parameters
|
8962
|
+
form_params = opts[:form_params] || {}
|
8963
|
+
|
8964
|
+
# http body (model)
|
8965
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(create_entity_screening_request)
|
8966
|
+
|
8967
|
+
# return_type
|
8968
|
+
return_type = opts[:debug_return_type] || 'EntityWatchlistScreeningResponse'
|
8969
|
+
|
8970
|
+
# auth_names
|
8971
|
+
auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
|
8972
|
+
|
8973
|
+
new_options = opts.merge(
|
8974
|
+
:operation => :"PlaidApi.watchlist_screening_entity_create",
|
8975
|
+
:header_params => header_params,
|
8976
|
+
:query_params => query_params,
|
8977
|
+
:form_params => form_params,
|
8978
|
+
:body => post_body,
|
8979
|
+
:auth_names => auth_names,
|
8980
|
+
:return_type => return_type
|
8981
|
+
)
|
8982
|
+
|
8983
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
8984
|
+
if @api_client.config.debugging
|
8985
|
+
@api_client.config.logger.debug "API called: PlaidApi#watchlist_screening_entity_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
8986
|
+
end
|
8987
|
+
return data, status_code, headers
|
8988
|
+
end
|
8989
|
+
|
8990
|
+
# Get an entity screening
|
8991
|
+
# Retrieve an entity watchlist screening.
|
8992
|
+
# @param get_entity_watchlist_screening_request [GetEntityWatchlistScreeningRequest]
|
8993
|
+
# @param [Hash] opts the optional parameters
|
8994
|
+
# @return [EntityWatchlistScreeningResponse]
|
8995
|
+
def watchlist_screening_entity_get(get_entity_watchlist_screening_request, opts = {})
|
8996
|
+
data, _status_code, _headers = watchlist_screening_entity_get_with_http_info(get_entity_watchlist_screening_request, opts)
|
8997
|
+
data
|
8998
|
+
end
|
8999
|
+
|
9000
|
+
# Get an entity screening
|
9001
|
+
# Retrieve an entity watchlist screening.
|
9002
|
+
# @param get_entity_watchlist_screening_request [GetEntityWatchlistScreeningRequest]
|
9003
|
+
# @param [Hash] opts the optional parameters
|
9004
|
+
# @return [Array<(EntityWatchlistScreeningResponse, Integer, Hash)>] EntityWatchlistScreeningResponse data, response status code and response headers
|
9005
|
+
def watchlist_screening_entity_get_with_http_info(get_entity_watchlist_screening_request, opts = {})
|
9006
|
+
if @api_client.config.debugging
|
9007
|
+
@api_client.config.logger.debug 'Calling API: PlaidApi.watchlist_screening_entity_get ...'
|
9008
|
+
end
|
9009
|
+
# verify the required parameter 'get_entity_watchlist_screening_request' is set
|
9010
|
+
if @api_client.config.client_side_validation && get_entity_watchlist_screening_request.nil?
|
9011
|
+
fail ArgumentError, "Missing the required parameter 'get_entity_watchlist_screening_request' when calling PlaidApi.watchlist_screening_entity_get"
|
9012
|
+
end
|
9013
|
+
# resource path
|
9014
|
+
local_var_path = '/watchlist_screening/entity/get'
|
9015
|
+
|
9016
|
+
# query parameters
|
9017
|
+
query_params = opts[:query_params] || {}
|
9018
|
+
|
9019
|
+
# header parameters
|
9020
|
+
header_params = opts[:header_params] || {}
|
9021
|
+
# HTTP header 'Accept' (if needed)
|
9022
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
9023
|
+
# HTTP header 'Content-Type'
|
9024
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
9025
|
+
|
9026
|
+
# form parameters
|
9027
|
+
form_params = opts[:form_params] || {}
|
9028
|
+
|
9029
|
+
# http body (model)
|
9030
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(get_entity_watchlist_screening_request)
|
9031
|
+
|
9032
|
+
# return_type
|
9033
|
+
return_type = opts[:debug_return_type] || 'EntityWatchlistScreeningResponse'
|
9034
|
+
|
9035
|
+
# auth_names
|
9036
|
+
auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
|
9037
|
+
|
9038
|
+
new_options = opts.merge(
|
9039
|
+
:operation => :"PlaidApi.watchlist_screening_entity_get",
|
9040
|
+
:header_params => header_params,
|
9041
|
+
:query_params => query_params,
|
9042
|
+
:form_params => form_params,
|
9043
|
+
:body => post_body,
|
9044
|
+
:auth_names => auth_names,
|
9045
|
+
:return_type => return_type
|
9046
|
+
)
|
9047
|
+
|
9048
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
9049
|
+
if @api_client.config.debugging
|
9050
|
+
@api_client.config.logger.debug "API called: PlaidApi#watchlist_screening_entity_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
9051
|
+
end
|
9052
|
+
return data, status_code, headers
|
9053
|
+
end
|
9054
|
+
|
9055
|
+
# List history for entity watchlist screenings
|
9056
|
+
# List all changes to the entity watchlist screening in reverse-chronological order. If the watchlist screening has not been edited, no history will be returned.
|
9057
|
+
# @param list_watchlist_screening_entity_history_request [ListWatchlistScreeningEntityHistoryRequest]
|
9058
|
+
# @param [Hash] opts the optional parameters
|
9059
|
+
# @return [PaginatedEntityWatchlistScreeningListResponse]
|
9060
|
+
def watchlist_screening_entity_history_list(list_watchlist_screening_entity_history_request, opts = {})
|
9061
|
+
data, _status_code, _headers = watchlist_screening_entity_history_list_with_http_info(list_watchlist_screening_entity_history_request, opts)
|
9062
|
+
data
|
9063
|
+
end
|
9064
|
+
|
9065
|
+
# List history for entity watchlist screenings
|
9066
|
+
# List all changes to the entity watchlist screening in reverse-chronological order. If the watchlist screening has not been edited, no history will be returned.
|
9067
|
+
# @param list_watchlist_screening_entity_history_request [ListWatchlistScreeningEntityHistoryRequest]
|
9068
|
+
# @param [Hash] opts the optional parameters
|
9069
|
+
# @return [Array<(PaginatedEntityWatchlistScreeningListResponse, Integer, Hash)>] PaginatedEntityWatchlistScreeningListResponse data, response status code and response headers
|
9070
|
+
def watchlist_screening_entity_history_list_with_http_info(list_watchlist_screening_entity_history_request, opts = {})
|
9071
|
+
if @api_client.config.debugging
|
9072
|
+
@api_client.config.logger.debug 'Calling API: PlaidApi.watchlist_screening_entity_history_list ...'
|
9073
|
+
end
|
9074
|
+
# verify the required parameter 'list_watchlist_screening_entity_history_request' is set
|
9075
|
+
if @api_client.config.client_side_validation && list_watchlist_screening_entity_history_request.nil?
|
9076
|
+
fail ArgumentError, "Missing the required parameter 'list_watchlist_screening_entity_history_request' when calling PlaidApi.watchlist_screening_entity_history_list"
|
9077
|
+
end
|
9078
|
+
# resource path
|
9079
|
+
local_var_path = '/watchlist_screening/entity/history/list'
|
9080
|
+
|
9081
|
+
# query parameters
|
9082
|
+
query_params = opts[:query_params] || {}
|
9083
|
+
|
9084
|
+
# header parameters
|
9085
|
+
header_params = opts[:header_params] || {}
|
9086
|
+
# HTTP header 'Accept' (if needed)
|
9087
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
9088
|
+
# HTTP header 'Content-Type'
|
9089
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
9090
|
+
|
9091
|
+
# form parameters
|
9092
|
+
form_params = opts[:form_params] || {}
|
9093
|
+
|
9094
|
+
# http body (model)
|
9095
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(list_watchlist_screening_entity_history_request)
|
9096
|
+
|
9097
|
+
# return_type
|
9098
|
+
return_type = opts[:debug_return_type] || 'PaginatedEntityWatchlistScreeningListResponse'
|
9099
|
+
|
9100
|
+
# auth_names
|
9101
|
+
auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
|
9102
|
+
|
9103
|
+
new_options = opts.merge(
|
9104
|
+
:operation => :"PlaidApi.watchlist_screening_entity_history_list",
|
9105
|
+
:header_params => header_params,
|
9106
|
+
:query_params => query_params,
|
9107
|
+
:form_params => form_params,
|
9108
|
+
:body => post_body,
|
9109
|
+
:auth_names => auth_names,
|
9110
|
+
:return_type => return_type
|
9111
|
+
)
|
9112
|
+
|
9113
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
9114
|
+
if @api_client.config.debugging
|
9115
|
+
@api_client.config.logger.debug "API called: PlaidApi#watchlist_screening_entity_history_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
9116
|
+
end
|
9117
|
+
return data, status_code, headers
|
9118
|
+
end
|
9119
|
+
|
9120
|
+
# List hits for entity watchlist screenings
|
9121
|
+
# List all hits for the entity watchlist screening.
|
9122
|
+
# @param list_watchlist_screening_entity_hit_request [ListWatchlistScreeningEntityHitRequest]
|
9123
|
+
# @param [Hash] opts the optional parameters
|
9124
|
+
# @return [PaginatedEntityWatchlistScreeningHitListResponse]
|
9125
|
+
def watchlist_screening_entity_hits_list(list_watchlist_screening_entity_hit_request, opts = {})
|
9126
|
+
data, _status_code, _headers = watchlist_screening_entity_hits_list_with_http_info(list_watchlist_screening_entity_hit_request, opts)
|
9127
|
+
data
|
9128
|
+
end
|
9129
|
+
|
9130
|
+
# List hits for entity watchlist screenings
|
9131
|
+
# List all hits for the entity watchlist screening.
|
9132
|
+
# @param list_watchlist_screening_entity_hit_request [ListWatchlistScreeningEntityHitRequest]
|
9133
|
+
# @param [Hash] opts the optional parameters
|
9134
|
+
# @return [Array<(PaginatedEntityWatchlistScreeningHitListResponse, Integer, Hash)>] PaginatedEntityWatchlistScreeningHitListResponse data, response status code and response headers
|
9135
|
+
def watchlist_screening_entity_hits_list_with_http_info(list_watchlist_screening_entity_hit_request, opts = {})
|
9136
|
+
if @api_client.config.debugging
|
9137
|
+
@api_client.config.logger.debug 'Calling API: PlaidApi.watchlist_screening_entity_hits_list ...'
|
9138
|
+
end
|
9139
|
+
# verify the required parameter 'list_watchlist_screening_entity_hit_request' is set
|
9140
|
+
if @api_client.config.client_side_validation && list_watchlist_screening_entity_hit_request.nil?
|
9141
|
+
fail ArgumentError, "Missing the required parameter 'list_watchlist_screening_entity_hit_request' when calling PlaidApi.watchlist_screening_entity_hits_list"
|
9142
|
+
end
|
9143
|
+
# resource path
|
9144
|
+
local_var_path = '/watchlist_screening/entity/hit/list'
|
9145
|
+
|
9146
|
+
# query parameters
|
9147
|
+
query_params = opts[:query_params] || {}
|
9148
|
+
|
9149
|
+
# header parameters
|
9150
|
+
header_params = opts[:header_params] || {}
|
9151
|
+
# HTTP header 'Accept' (if needed)
|
9152
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
9153
|
+
# HTTP header 'Content-Type'
|
9154
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
9155
|
+
|
9156
|
+
# form parameters
|
9157
|
+
form_params = opts[:form_params] || {}
|
9158
|
+
|
9159
|
+
# http body (model)
|
9160
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(list_watchlist_screening_entity_hit_request)
|
9161
|
+
|
9162
|
+
# return_type
|
9163
|
+
return_type = opts[:debug_return_type] || 'PaginatedEntityWatchlistScreeningHitListResponse'
|
9164
|
+
|
9165
|
+
# auth_names
|
9166
|
+
auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
|
9167
|
+
|
9168
|
+
new_options = opts.merge(
|
9169
|
+
:operation => :"PlaidApi.watchlist_screening_entity_hits_list",
|
9170
|
+
:header_params => header_params,
|
9171
|
+
:query_params => query_params,
|
9172
|
+
:form_params => form_params,
|
9173
|
+
:body => post_body,
|
9174
|
+
:auth_names => auth_names,
|
9175
|
+
:return_type => return_type
|
9176
|
+
)
|
9177
|
+
|
9178
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
9179
|
+
if @api_client.config.debugging
|
9180
|
+
@api_client.config.logger.debug "API called: PlaidApi#watchlist_screening_entity_hits_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
9181
|
+
end
|
9182
|
+
return data, status_code, headers
|
9183
|
+
end
|
9184
|
+
|
9185
|
+
# List entity watchlist screenings
|
9186
|
+
# List all entity screenings.
|
9187
|
+
# @param list_entity_watchlist_screening_request [ListEntityWatchlistScreeningRequest]
|
9188
|
+
# @param [Hash] opts the optional parameters
|
9189
|
+
# @return [PaginatedEntityWatchlistScreeningListResponse]
|
9190
|
+
def watchlist_screening_entity_list(list_entity_watchlist_screening_request, opts = {})
|
9191
|
+
data, _status_code, _headers = watchlist_screening_entity_list_with_http_info(list_entity_watchlist_screening_request, opts)
|
9192
|
+
data
|
9193
|
+
end
|
9194
|
+
|
9195
|
+
# List entity watchlist screenings
|
9196
|
+
# List all entity screenings.
|
9197
|
+
# @param list_entity_watchlist_screening_request [ListEntityWatchlistScreeningRequest]
|
9198
|
+
# @param [Hash] opts the optional parameters
|
9199
|
+
# @return [Array<(PaginatedEntityWatchlistScreeningListResponse, Integer, Hash)>] PaginatedEntityWatchlistScreeningListResponse data, response status code and response headers
|
9200
|
+
def watchlist_screening_entity_list_with_http_info(list_entity_watchlist_screening_request, opts = {})
|
9201
|
+
if @api_client.config.debugging
|
9202
|
+
@api_client.config.logger.debug 'Calling API: PlaidApi.watchlist_screening_entity_list ...'
|
9203
|
+
end
|
9204
|
+
# verify the required parameter 'list_entity_watchlist_screening_request' is set
|
9205
|
+
if @api_client.config.client_side_validation && list_entity_watchlist_screening_request.nil?
|
9206
|
+
fail ArgumentError, "Missing the required parameter 'list_entity_watchlist_screening_request' when calling PlaidApi.watchlist_screening_entity_list"
|
9207
|
+
end
|
9208
|
+
# resource path
|
9209
|
+
local_var_path = '/watchlist_screening/entity/list'
|
9210
|
+
|
9211
|
+
# query parameters
|
9212
|
+
query_params = opts[:query_params] || {}
|
9213
|
+
|
9214
|
+
# header parameters
|
9215
|
+
header_params = opts[:header_params] || {}
|
9216
|
+
# HTTP header 'Accept' (if needed)
|
9217
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
9218
|
+
# HTTP header 'Content-Type'
|
9219
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
9220
|
+
|
9221
|
+
# form parameters
|
9222
|
+
form_params = opts[:form_params] || {}
|
9223
|
+
|
9224
|
+
# http body (model)
|
9225
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(list_entity_watchlist_screening_request)
|
9226
|
+
|
9227
|
+
# return_type
|
9228
|
+
return_type = opts[:debug_return_type] || 'PaginatedEntityWatchlistScreeningListResponse'
|
9229
|
+
|
9230
|
+
# auth_names
|
9231
|
+
auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
|
9232
|
+
|
9233
|
+
new_options = opts.merge(
|
9234
|
+
:operation => :"PlaidApi.watchlist_screening_entity_list",
|
9235
|
+
:header_params => header_params,
|
9236
|
+
:query_params => query_params,
|
9237
|
+
:form_params => form_params,
|
9238
|
+
:body => post_body,
|
9239
|
+
:auth_names => auth_names,
|
9240
|
+
:return_type => return_type
|
9241
|
+
)
|
9242
|
+
|
9243
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
9244
|
+
if @api_client.config.debugging
|
9245
|
+
@api_client.config.logger.debug "API called: PlaidApi#watchlist_screening_entity_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
9246
|
+
end
|
9247
|
+
return data, status_code, headers
|
9248
|
+
end
|
9249
|
+
|
9250
|
+
# Get entity watchlist screening program
|
9251
|
+
# Get an entity watchlist screening program
|
9252
|
+
# @param get_watchlist_screening_entity_program_request [GetWatchlistScreeningEntityProgramRequest]
|
9253
|
+
# @param [Hash] opts the optional parameters
|
9254
|
+
# @return [EntityWatchlistProgramResponse]
|
9255
|
+
def watchlist_screening_entity_program_get(get_watchlist_screening_entity_program_request, opts = {})
|
9256
|
+
data, _status_code, _headers = watchlist_screening_entity_program_get_with_http_info(get_watchlist_screening_entity_program_request, opts)
|
9257
|
+
data
|
9258
|
+
end
|
9259
|
+
|
9260
|
+
# Get entity watchlist screening program
|
9261
|
+
# Get an entity watchlist screening program
|
9262
|
+
# @param get_watchlist_screening_entity_program_request [GetWatchlistScreeningEntityProgramRequest]
|
9263
|
+
# @param [Hash] opts the optional parameters
|
9264
|
+
# @return [Array<(EntityWatchlistProgramResponse, Integer, Hash)>] EntityWatchlistProgramResponse data, response status code and response headers
|
9265
|
+
def watchlist_screening_entity_program_get_with_http_info(get_watchlist_screening_entity_program_request, opts = {})
|
9266
|
+
if @api_client.config.debugging
|
9267
|
+
@api_client.config.logger.debug 'Calling API: PlaidApi.watchlist_screening_entity_program_get ...'
|
9268
|
+
end
|
9269
|
+
# verify the required parameter 'get_watchlist_screening_entity_program_request' is set
|
9270
|
+
if @api_client.config.client_side_validation && get_watchlist_screening_entity_program_request.nil?
|
9271
|
+
fail ArgumentError, "Missing the required parameter 'get_watchlist_screening_entity_program_request' when calling PlaidApi.watchlist_screening_entity_program_get"
|
9272
|
+
end
|
9273
|
+
# resource path
|
9274
|
+
local_var_path = '/watchlist_screening/entity/program/get'
|
9275
|
+
|
9276
|
+
# query parameters
|
9277
|
+
query_params = opts[:query_params] || {}
|
9278
|
+
|
9279
|
+
# header parameters
|
9280
|
+
header_params = opts[:header_params] || {}
|
9281
|
+
# HTTP header 'Accept' (if needed)
|
9282
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
9283
|
+
# HTTP header 'Content-Type'
|
9284
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
9285
|
+
|
9286
|
+
# form parameters
|
9287
|
+
form_params = opts[:form_params] || {}
|
9288
|
+
|
9289
|
+
# http body (model)
|
9290
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(get_watchlist_screening_entity_program_request)
|
9291
|
+
|
9292
|
+
# return_type
|
9293
|
+
return_type = opts[:debug_return_type] || 'EntityWatchlistProgramResponse'
|
9294
|
+
|
9295
|
+
# auth_names
|
9296
|
+
auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
|
9297
|
+
|
9298
|
+
new_options = opts.merge(
|
9299
|
+
:operation => :"PlaidApi.watchlist_screening_entity_program_get",
|
9300
|
+
:header_params => header_params,
|
9301
|
+
:query_params => query_params,
|
9302
|
+
:form_params => form_params,
|
9303
|
+
:body => post_body,
|
9304
|
+
:auth_names => auth_names,
|
9305
|
+
:return_type => return_type
|
9306
|
+
)
|
9307
|
+
|
9308
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
9309
|
+
if @api_client.config.debugging
|
9310
|
+
@api_client.config.logger.debug "API called: PlaidApi#watchlist_screening_entity_program_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
9311
|
+
end
|
9312
|
+
return data, status_code, headers
|
9313
|
+
end
|
9314
|
+
|
9315
|
+
# List entity watchlist screening programs
|
9316
|
+
# List all entity watchlist screening programs
|
9317
|
+
# @param list_watchlist_screening_entity_programs_request [ListWatchlistScreeningEntityProgramsRequest]
|
9318
|
+
# @param [Hash] opts the optional parameters
|
9319
|
+
# @return [PaginatedEntityWatchlistProgramListResponse]
|
9320
|
+
def watchlist_screening_entity_program_list(list_watchlist_screening_entity_programs_request, opts = {})
|
9321
|
+
data, _status_code, _headers = watchlist_screening_entity_program_list_with_http_info(list_watchlist_screening_entity_programs_request, opts)
|
9322
|
+
data
|
9323
|
+
end
|
9324
|
+
|
9325
|
+
# List entity watchlist screening programs
|
9326
|
+
# List all entity watchlist screening programs
|
9327
|
+
# @param list_watchlist_screening_entity_programs_request [ListWatchlistScreeningEntityProgramsRequest]
|
9328
|
+
# @param [Hash] opts the optional parameters
|
9329
|
+
# @return [Array<(PaginatedEntityWatchlistProgramListResponse, Integer, Hash)>] PaginatedEntityWatchlistProgramListResponse data, response status code and response headers
|
9330
|
+
def watchlist_screening_entity_program_list_with_http_info(list_watchlist_screening_entity_programs_request, opts = {})
|
9331
|
+
if @api_client.config.debugging
|
9332
|
+
@api_client.config.logger.debug 'Calling API: PlaidApi.watchlist_screening_entity_program_list ...'
|
9333
|
+
end
|
9334
|
+
# verify the required parameter 'list_watchlist_screening_entity_programs_request' is set
|
9335
|
+
if @api_client.config.client_side_validation && list_watchlist_screening_entity_programs_request.nil?
|
9336
|
+
fail ArgumentError, "Missing the required parameter 'list_watchlist_screening_entity_programs_request' when calling PlaidApi.watchlist_screening_entity_program_list"
|
9337
|
+
end
|
9338
|
+
# resource path
|
9339
|
+
local_var_path = '/watchlist_screening/entity/program/list'
|
9340
|
+
|
9341
|
+
# query parameters
|
9342
|
+
query_params = opts[:query_params] || {}
|
9343
|
+
|
9344
|
+
# header parameters
|
9345
|
+
header_params = opts[:header_params] || {}
|
9346
|
+
# HTTP header 'Accept' (if needed)
|
9347
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
9348
|
+
# HTTP header 'Content-Type'
|
9349
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
9350
|
+
|
9351
|
+
# form parameters
|
9352
|
+
form_params = opts[:form_params] || {}
|
9353
|
+
|
9354
|
+
# http body (model)
|
9355
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(list_watchlist_screening_entity_programs_request)
|
9356
|
+
|
9357
|
+
# return_type
|
9358
|
+
return_type = opts[:debug_return_type] || 'PaginatedEntityWatchlistProgramListResponse'
|
9359
|
+
|
9360
|
+
# auth_names
|
9361
|
+
auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
|
9362
|
+
|
9363
|
+
new_options = opts.merge(
|
9364
|
+
:operation => :"PlaidApi.watchlist_screening_entity_program_list",
|
9365
|
+
:header_params => header_params,
|
9366
|
+
:query_params => query_params,
|
9367
|
+
:form_params => form_params,
|
9368
|
+
:body => post_body,
|
9369
|
+
:auth_names => auth_names,
|
9370
|
+
:return_type => return_type
|
9371
|
+
)
|
9372
|
+
|
9373
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
9374
|
+
if @api_client.config.debugging
|
9375
|
+
@api_client.config.logger.debug "API called: PlaidApi#watchlist_screening_entity_program_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
9376
|
+
end
|
9377
|
+
return data, status_code, headers
|
9378
|
+
end
|
9379
|
+
|
9380
|
+
# Create a review for an entity watchlist screening
|
9381
|
+
# Create a review for an entity watchlist screening. Reviews are compliance reports created by users in your organization regarding the relevance of potential hits found by Plaid.
|
9382
|
+
# @param create_entity_watchlist_screening_review_request [CreateEntityWatchlistScreeningReviewRequest]
|
9383
|
+
# @param [Hash] opts the optional parameters
|
9384
|
+
# @return [EntityWatchlistScreeningReviewResponse]
|
9385
|
+
def watchlist_screening_entity_review_create(create_entity_watchlist_screening_review_request, opts = {})
|
9386
|
+
data, _status_code, _headers = watchlist_screening_entity_review_create_with_http_info(create_entity_watchlist_screening_review_request, opts)
|
9387
|
+
data
|
9388
|
+
end
|
9389
|
+
|
9390
|
+
# Create a review for an entity watchlist screening
|
9391
|
+
# Create a review for an entity watchlist screening. Reviews are compliance reports created by users in your organization regarding the relevance of potential hits found by Plaid.
|
9392
|
+
# @param create_entity_watchlist_screening_review_request [CreateEntityWatchlistScreeningReviewRequest]
|
9393
|
+
# @param [Hash] opts the optional parameters
|
9394
|
+
# @return [Array<(EntityWatchlistScreeningReviewResponse, Integer, Hash)>] EntityWatchlistScreeningReviewResponse data, response status code and response headers
|
9395
|
+
def watchlist_screening_entity_review_create_with_http_info(create_entity_watchlist_screening_review_request, opts = {})
|
9396
|
+
if @api_client.config.debugging
|
9397
|
+
@api_client.config.logger.debug 'Calling API: PlaidApi.watchlist_screening_entity_review_create ...'
|
9398
|
+
end
|
9399
|
+
# verify the required parameter 'create_entity_watchlist_screening_review_request' is set
|
9400
|
+
if @api_client.config.client_side_validation && create_entity_watchlist_screening_review_request.nil?
|
9401
|
+
fail ArgumentError, "Missing the required parameter 'create_entity_watchlist_screening_review_request' when calling PlaidApi.watchlist_screening_entity_review_create"
|
9402
|
+
end
|
9403
|
+
# resource path
|
9404
|
+
local_var_path = '/watchlist_screening/entity/review/create'
|
9405
|
+
|
9406
|
+
# query parameters
|
9407
|
+
query_params = opts[:query_params] || {}
|
9408
|
+
|
9409
|
+
# header parameters
|
9410
|
+
header_params = opts[:header_params] || {}
|
9411
|
+
# HTTP header 'Accept' (if needed)
|
9412
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
9413
|
+
# HTTP header 'Content-Type'
|
9414
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
9415
|
+
|
9416
|
+
# form parameters
|
9417
|
+
form_params = opts[:form_params] || {}
|
9418
|
+
|
9419
|
+
# http body (model)
|
9420
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(create_entity_watchlist_screening_review_request)
|
9421
|
+
|
9422
|
+
# return_type
|
9423
|
+
return_type = opts[:debug_return_type] || 'EntityWatchlistScreeningReviewResponse'
|
9424
|
+
|
9425
|
+
# auth_names
|
9426
|
+
auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
|
9427
|
+
|
9428
|
+
new_options = opts.merge(
|
9429
|
+
:operation => :"PlaidApi.watchlist_screening_entity_review_create",
|
9430
|
+
:header_params => header_params,
|
9431
|
+
:query_params => query_params,
|
9432
|
+
:form_params => form_params,
|
9433
|
+
:body => post_body,
|
9434
|
+
:auth_names => auth_names,
|
9435
|
+
:return_type => return_type
|
9436
|
+
)
|
9437
|
+
|
9438
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
9439
|
+
if @api_client.config.debugging
|
9440
|
+
@api_client.config.logger.debug "API called: PlaidApi#watchlist_screening_entity_review_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
9441
|
+
end
|
9442
|
+
return data, status_code, headers
|
9443
|
+
end
|
9444
|
+
|
9445
|
+
# List reviews for entity watchlist screenings
|
9446
|
+
# List all reviews for a particular entity watchlist screening. Reviews are compliance reports created by users in your organization regarding the relevance of potential hits found by Plaid.
|
9447
|
+
# @param list_watchlist_screening_entity_reviews_request [ListWatchlistScreeningEntityReviewsRequest]
|
9448
|
+
# @param [Hash] opts the optional parameters
|
9449
|
+
# @return [PaginatedEntityWatchlistScreeningReviewListResponse]
|
9450
|
+
def watchlist_screening_entity_review_list(list_watchlist_screening_entity_reviews_request, opts = {})
|
9451
|
+
data, _status_code, _headers = watchlist_screening_entity_review_list_with_http_info(list_watchlist_screening_entity_reviews_request, opts)
|
9452
|
+
data
|
9453
|
+
end
|
9454
|
+
|
9455
|
+
# List reviews for entity watchlist screenings
|
9456
|
+
# List all reviews for a particular entity watchlist screening. Reviews are compliance reports created by users in your organization regarding the relevance of potential hits found by Plaid.
|
9457
|
+
# @param list_watchlist_screening_entity_reviews_request [ListWatchlistScreeningEntityReviewsRequest]
|
9458
|
+
# @param [Hash] opts the optional parameters
|
9459
|
+
# @return [Array<(PaginatedEntityWatchlistScreeningReviewListResponse, Integer, Hash)>] PaginatedEntityWatchlistScreeningReviewListResponse data, response status code and response headers
|
9460
|
+
def watchlist_screening_entity_review_list_with_http_info(list_watchlist_screening_entity_reviews_request, opts = {})
|
9461
|
+
if @api_client.config.debugging
|
9462
|
+
@api_client.config.logger.debug 'Calling API: PlaidApi.watchlist_screening_entity_review_list ...'
|
9463
|
+
end
|
9464
|
+
# verify the required parameter 'list_watchlist_screening_entity_reviews_request' is set
|
9465
|
+
if @api_client.config.client_side_validation && list_watchlist_screening_entity_reviews_request.nil?
|
9466
|
+
fail ArgumentError, "Missing the required parameter 'list_watchlist_screening_entity_reviews_request' when calling PlaidApi.watchlist_screening_entity_review_list"
|
9467
|
+
end
|
9468
|
+
# resource path
|
9469
|
+
local_var_path = '/watchlist_screening/entity/review/list'
|
9470
|
+
|
9471
|
+
# query parameters
|
9472
|
+
query_params = opts[:query_params] || {}
|
9473
|
+
|
9474
|
+
# header parameters
|
9475
|
+
header_params = opts[:header_params] || {}
|
9476
|
+
# HTTP header 'Accept' (if needed)
|
9477
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
9478
|
+
# HTTP header 'Content-Type'
|
9479
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
9480
|
+
|
9481
|
+
# form parameters
|
9482
|
+
form_params = opts[:form_params] || {}
|
9483
|
+
|
9484
|
+
# http body (model)
|
9485
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(list_watchlist_screening_entity_reviews_request)
|
9486
|
+
|
9487
|
+
# return_type
|
9488
|
+
return_type = opts[:debug_return_type] || 'PaginatedEntityWatchlistScreeningReviewListResponse'
|
9489
|
+
|
9490
|
+
# auth_names
|
9491
|
+
auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
|
9492
|
+
|
9493
|
+
new_options = opts.merge(
|
9494
|
+
:operation => :"PlaidApi.watchlist_screening_entity_review_list",
|
9495
|
+
:header_params => header_params,
|
9496
|
+
:query_params => query_params,
|
9497
|
+
:form_params => form_params,
|
9498
|
+
:body => post_body,
|
9499
|
+
:auth_names => auth_names,
|
9500
|
+
:return_type => return_type
|
9501
|
+
)
|
9502
|
+
|
9503
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
9504
|
+
if @api_client.config.debugging
|
9505
|
+
@api_client.config.logger.debug "API called: PlaidApi#watchlist_screening_entity_review_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
9506
|
+
end
|
9507
|
+
return data, status_code, headers
|
9508
|
+
end
|
9509
|
+
|
9510
|
+
# Update an entity screening
|
9511
|
+
# Update an entity watchlist screening.
|
9512
|
+
# @param update_entity_screening_request [UpdateEntityScreeningRequest] The entity screening was successfully updated.
|
9513
|
+
# @param [Hash] opts the optional parameters
|
9514
|
+
# @return [EntityWatchlistScreeningResponse]
|
9515
|
+
def watchlist_screening_entity_update(update_entity_screening_request, opts = {})
|
9516
|
+
data, _status_code, _headers = watchlist_screening_entity_update_with_http_info(update_entity_screening_request, opts)
|
9517
|
+
data
|
9518
|
+
end
|
9519
|
+
|
9520
|
+
# Update an entity screening
|
9521
|
+
# Update an entity watchlist screening.
|
9522
|
+
# @param update_entity_screening_request [UpdateEntityScreeningRequest] The entity screening was successfully updated.
|
9523
|
+
# @param [Hash] opts the optional parameters
|
9524
|
+
# @return [Array<(EntityWatchlistScreeningResponse, Integer, Hash)>] EntityWatchlistScreeningResponse data, response status code and response headers
|
9525
|
+
def watchlist_screening_entity_update_with_http_info(update_entity_screening_request, opts = {})
|
9526
|
+
if @api_client.config.debugging
|
9527
|
+
@api_client.config.logger.debug 'Calling API: PlaidApi.watchlist_screening_entity_update ...'
|
9528
|
+
end
|
9529
|
+
# verify the required parameter 'update_entity_screening_request' is set
|
9530
|
+
if @api_client.config.client_side_validation && update_entity_screening_request.nil?
|
9531
|
+
fail ArgumentError, "Missing the required parameter 'update_entity_screening_request' when calling PlaidApi.watchlist_screening_entity_update"
|
9532
|
+
end
|
9533
|
+
# resource path
|
9534
|
+
local_var_path = '/watchlist_screening/entity/update'
|
9535
|
+
|
9536
|
+
# query parameters
|
9537
|
+
query_params = opts[:query_params] || {}
|
9538
|
+
|
9539
|
+
# header parameters
|
9540
|
+
header_params = opts[:header_params] || {}
|
9541
|
+
# HTTP header 'Accept' (if needed)
|
9542
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
9543
|
+
# HTTP header 'Content-Type'
|
9544
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
9545
|
+
|
9546
|
+
# form parameters
|
9547
|
+
form_params = opts[:form_params] || {}
|
9548
|
+
|
9549
|
+
# http body (model)
|
9550
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(update_entity_screening_request)
|
9551
|
+
|
9552
|
+
# return_type
|
9553
|
+
return_type = opts[:debug_return_type] || 'EntityWatchlistScreeningResponse'
|
9554
|
+
|
9555
|
+
# auth_names
|
9556
|
+
auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
|
9557
|
+
|
9558
|
+
new_options = opts.merge(
|
9559
|
+
:operation => :"PlaidApi.watchlist_screening_entity_update",
|
9560
|
+
:header_params => header_params,
|
9561
|
+
:query_params => query_params,
|
9562
|
+
:form_params => form_params,
|
9563
|
+
:body => post_body,
|
9564
|
+
:auth_names => auth_names,
|
9565
|
+
:return_type => return_type
|
9566
|
+
)
|
9567
|
+
|
9568
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
9569
|
+
if @api_client.config.debugging
|
9570
|
+
@api_client.config.logger.debug "API called: PlaidApi#watchlist_screening_entity_update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
9571
|
+
end
|
9572
|
+
return data, status_code, headers
|
9573
|
+
end
|
9574
|
+
|
9575
|
+
# Create a watchlist screening for a person
|
9576
|
+
# Create a new Watchlist Screening to check your customer against watchlists defined in the associated Watchlist Program. If your associated program has ongoing screening enabled, this is the profile information that will be used to monitor your customer over time.
|
9577
|
+
# @param watchlist_screening_create_request [WatchlistScreeningCreateRequest]
|
9578
|
+
# @param [Hash] opts the optional parameters
|
9579
|
+
# @return [WatchlistScreeningIndividualResponse]
|
9580
|
+
def watchlist_screening_individual_create(watchlist_screening_create_request, opts = {})
|
9581
|
+
data, _status_code, _headers = watchlist_screening_individual_create_with_http_info(watchlist_screening_create_request, opts)
|
9582
|
+
data
|
9583
|
+
end
|
9584
|
+
|
9585
|
+
# Create a watchlist screening for a person
|
9586
|
+
# Create a new Watchlist Screening to check your customer against watchlists defined in the associated Watchlist Program. If your associated program has ongoing screening enabled, this is the profile information that will be used to monitor your customer over time.
|
9587
|
+
# @param watchlist_screening_create_request [WatchlistScreeningCreateRequest]
|
9588
|
+
# @param [Hash] opts the optional parameters
|
9589
|
+
# @return [Array<(WatchlistScreeningIndividualResponse, Integer, Hash)>] WatchlistScreeningIndividualResponse data, response status code and response headers
|
9590
|
+
def watchlist_screening_individual_create_with_http_info(watchlist_screening_create_request, opts = {})
|
9591
|
+
if @api_client.config.debugging
|
9592
|
+
@api_client.config.logger.debug 'Calling API: PlaidApi.watchlist_screening_individual_create ...'
|
9593
|
+
end
|
9594
|
+
# verify the required parameter 'watchlist_screening_create_request' is set
|
9595
|
+
if @api_client.config.client_side_validation && watchlist_screening_create_request.nil?
|
9596
|
+
fail ArgumentError, "Missing the required parameter 'watchlist_screening_create_request' when calling PlaidApi.watchlist_screening_individual_create"
|
9597
|
+
end
|
9598
|
+
# resource path
|
9599
|
+
local_var_path = '/watchlist_screening/individual/create'
|
9600
|
+
|
9601
|
+
# query parameters
|
9602
|
+
query_params = opts[:query_params] || {}
|
9603
|
+
|
9604
|
+
# header parameters
|
9605
|
+
header_params = opts[:header_params] || {}
|
9606
|
+
# HTTP header 'Accept' (if needed)
|
9607
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
9608
|
+
# HTTP header 'Content-Type'
|
9609
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
9610
|
+
|
9611
|
+
# form parameters
|
9612
|
+
form_params = opts[:form_params] || {}
|
9613
|
+
|
9614
|
+
# http body (model)
|
9615
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(watchlist_screening_create_request)
|
9616
|
+
|
9617
|
+
# return_type
|
9618
|
+
return_type = opts[:debug_return_type] || 'WatchlistScreeningIndividualResponse'
|
9619
|
+
|
9620
|
+
# auth_names
|
9621
|
+
auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
|
9622
|
+
|
9623
|
+
new_options = opts.merge(
|
9624
|
+
:operation => :"PlaidApi.watchlist_screening_individual_create",
|
9625
|
+
:header_params => header_params,
|
9626
|
+
:query_params => query_params,
|
9627
|
+
:form_params => form_params,
|
9628
|
+
:body => post_body,
|
9629
|
+
:auth_names => auth_names,
|
9630
|
+
:return_type => return_type
|
9631
|
+
)
|
9632
|
+
|
9633
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
9634
|
+
if @api_client.config.debugging
|
9635
|
+
@api_client.config.logger.debug "API called: PlaidApi#watchlist_screening_individual_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
9636
|
+
end
|
9637
|
+
return data, status_code, headers
|
9638
|
+
end
|
9639
|
+
|
9640
|
+
# Retrieve an individual watchlist screening
|
9641
|
+
# Retrieve a previously created individual watchlist screening
|
9642
|
+
# @param get_individual_watchlist_screening_request [GetIndividualWatchlistScreeningRequest]
|
9643
|
+
# @param [Hash] opts the optional parameters
|
9644
|
+
# @return [WatchlistScreeningIndividualResponse]
|
9645
|
+
def watchlist_screening_individual_get(get_individual_watchlist_screening_request, opts = {})
|
9646
|
+
data, _status_code, _headers = watchlist_screening_individual_get_with_http_info(get_individual_watchlist_screening_request, opts)
|
9647
|
+
data
|
9648
|
+
end
|
9649
|
+
|
9650
|
+
# Retrieve an individual watchlist screening
|
9651
|
+
# Retrieve a previously created individual watchlist screening
|
9652
|
+
# @param get_individual_watchlist_screening_request [GetIndividualWatchlistScreeningRequest]
|
9653
|
+
# @param [Hash] opts the optional parameters
|
9654
|
+
# @return [Array<(WatchlistScreeningIndividualResponse, Integer, Hash)>] WatchlistScreeningIndividualResponse data, response status code and response headers
|
9655
|
+
def watchlist_screening_individual_get_with_http_info(get_individual_watchlist_screening_request, opts = {})
|
9656
|
+
if @api_client.config.debugging
|
9657
|
+
@api_client.config.logger.debug 'Calling API: PlaidApi.watchlist_screening_individual_get ...'
|
9658
|
+
end
|
9659
|
+
# verify the required parameter 'get_individual_watchlist_screening_request' is set
|
9660
|
+
if @api_client.config.client_side_validation && get_individual_watchlist_screening_request.nil?
|
9661
|
+
fail ArgumentError, "Missing the required parameter 'get_individual_watchlist_screening_request' when calling PlaidApi.watchlist_screening_individual_get"
|
9662
|
+
end
|
9663
|
+
# resource path
|
9664
|
+
local_var_path = '/watchlist_screening/individual/get'
|
9665
|
+
|
9666
|
+
# query parameters
|
9667
|
+
query_params = opts[:query_params] || {}
|
9668
|
+
|
9669
|
+
# header parameters
|
9670
|
+
header_params = opts[:header_params] || {}
|
9671
|
+
# HTTP header 'Accept' (if needed)
|
9672
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
9673
|
+
# HTTP header 'Content-Type'
|
9674
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
9675
|
+
|
9676
|
+
# form parameters
|
9677
|
+
form_params = opts[:form_params] || {}
|
9678
|
+
|
9679
|
+
# http body (model)
|
9680
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(get_individual_watchlist_screening_request)
|
9681
|
+
|
9682
|
+
# return_type
|
9683
|
+
return_type = opts[:debug_return_type] || 'WatchlistScreeningIndividualResponse'
|
9684
|
+
|
9685
|
+
# auth_names
|
9686
|
+
auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
|
9687
|
+
|
9688
|
+
new_options = opts.merge(
|
9689
|
+
:operation => :"PlaidApi.watchlist_screening_individual_get",
|
9690
|
+
:header_params => header_params,
|
9691
|
+
:query_params => query_params,
|
9692
|
+
:form_params => form_params,
|
9693
|
+
:body => post_body,
|
9694
|
+
:auth_names => auth_names,
|
9695
|
+
:return_type => return_type
|
9696
|
+
)
|
9697
|
+
|
9698
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
9699
|
+
if @api_client.config.debugging
|
9700
|
+
@api_client.config.logger.debug "API called: PlaidApi#watchlist_screening_individual_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
9701
|
+
end
|
9702
|
+
return data, status_code, headers
|
9703
|
+
end
|
9704
|
+
|
9705
|
+
# List history for individual watchlist screenings
|
9706
|
+
# List all changes to the individual watchlist screening in reverse-chronological order. If the watchlist screening has not been edited, no history will be returned.
|
9707
|
+
# @param list_watchlist_screening_individual_history_request [ListWatchlistScreeningIndividualHistoryRequest]
|
9708
|
+
# @param [Hash] opts the optional parameters
|
9709
|
+
# @return [PaginatedIndividualWatchlistScreeningListResponse]
|
9710
|
+
def watchlist_screening_individual_history_list(list_watchlist_screening_individual_history_request, opts = {})
|
9711
|
+
data, _status_code, _headers = watchlist_screening_individual_history_list_with_http_info(list_watchlist_screening_individual_history_request, opts)
|
9712
|
+
data
|
9713
|
+
end
|
9714
|
+
|
9715
|
+
# List history for individual watchlist screenings
|
9716
|
+
# List all changes to the individual watchlist screening in reverse-chronological order. If the watchlist screening has not been edited, no history will be returned.
|
9717
|
+
# @param list_watchlist_screening_individual_history_request [ListWatchlistScreeningIndividualHistoryRequest]
|
9718
|
+
# @param [Hash] opts the optional parameters
|
9719
|
+
# @return [Array<(PaginatedIndividualWatchlistScreeningListResponse, Integer, Hash)>] PaginatedIndividualWatchlistScreeningListResponse data, response status code and response headers
|
9720
|
+
def watchlist_screening_individual_history_list_with_http_info(list_watchlist_screening_individual_history_request, opts = {})
|
9721
|
+
if @api_client.config.debugging
|
9722
|
+
@api_client.config.logger.debug 'Calling API: PlaidApi.watchlist_screening_individual_history_list ...'
|
9723
|
+
end
|
9724
|
+
# verify the required parameter 'list_watchlist_screening_individual_history_request' is set
|
9725
|
+
if @api_client.config.client_side_validation && list_watchlist_screening_individual_history_request.nil?
|
9726
|
+
fail ArgumentError, "Missing the required parameter 'list_watchlist_screening_individual_history_request' when calling PlaidApi.watchlist_screening_individual_history_list"
|
9727
|
+
end
|
9728
|
+
# resource path
|
9729
|
+
local_var_path = '/watchlist_screening/individual/history/list'
|
9730
|
+
|
9731
|
+
# query parameters
|
9732
|
+
query_params = opts[:query_params] || {}
|
9733
|
+
|
9734
|
+
# header parameters
|
9735
|
+
header_params = opts[:header_params] || {}
|
9736
|
+
# HTTP header 'Accept' (if needed)
|
9737
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
9738
|
+
# HTTP header 'Content-Type'
|
9739
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
9740
|
+
|
9741
|
+
# form parameters
|
9742
|
+
form_params = opts[:form_params] || {}
|
9743
|
+
|
9744
|
+
# http body (model)
|
9745
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(list_watchlist_screening_individual_history_request)
|
9746
|
+
|
9747
|
+
# return_type
|
9748
|
+
return_type = opts[:debug_return_type] || 'PaginatedIndividualWatchlistScreeningListResponse'
|
9749
|
+
|
9750
|
+
# auth_names
|
9751
|
+
auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
|
9752
|
+
|
9753
|
+
new_options = opts.merge(
|
9754
|
+
:operation => :"PlaidApi.watchlist_screening_individual_history_list",
|
9755
|
+
:header_params => header_params,
|
9756
|
+
:query_params => query_params,
|
9757
|
+
:form_params => form_params,
|
9758
|
+
:body => post_body,
|
9759
|
+
:auth_names => auth_names,
|
9760
|
+
:return_type => return_type
|
9761
|
+
)
|
9762
|
+
|
9763
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
9764
|
+
if @api_client.config.debugging
|
9765
|
+
@api_client.config.logger.debug "API called: PlaidApi#watchlist_screening_individual_history_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
9766
|
+
end
|
9767
|
+
return data, status_code, headers
|
9768
|
+
end
|
9769
|
+
|
9770
|
+
# List hits for individual watchlist screening
|
9771
|
+
# List all hits found by Plaid for a particular individual watchlist screening.
|
9772
|
+
# @param list_watchlist_screening_individual_hit_request [ListWatchlistScreeningIndividualHitRequest]
|
9773
|
+
# @param [Hash] opts the optional parameters
|
9774
|
+
# @return [PaginatedIndividualWatchlistScreeningHitListResponse]
|
9775
|
+
def watchlist_screening_individual_hit_list(list_watchlist_screening_individual_hit_request, opts = {})
|
9776
|
+
data, _status_code, _headers = watchlist_screening_individual_hit_list_with_http_info(list_watchlist_screening_individual_hit_request, opts)
|
9777
|
+
data
|
9778
|
+
end
|
9779
|
+
|
9780
|
+
# List hits for individual watchlist screening
|
9781
|
+
# List all hits found by Plaid for a particular individual watchlist screening.
|
9782
|
+
# @param list_watchlist_screening_individual_hit_request [ListWatchlistScreeningIndividualHitRequest]
|
9783
|
+
# @param [Hash] opts the optional parameters
|
9784
|
+
# @return [Array<(PaginatedIndividualWatchlistScreeningHitListResponse, Integer, Hash)>] PaginatedIndividualWatchlistScreeningHitListResponse data, response status code and response headers
|
9785
|
+
def watchlist_screening_individual_hit_list_with_http_info(list_watchlist_screening_individual_hit_request, opts = {})
|
9786
|
+
if @api_client.config.debugging
|
9787
|
+
@api_client.config.logger.debug 'Calling API: PlaidApi.watchlist_screening_individual_hit_list ...'
|
9788
|
+
end
|
9789
|
+
# verify the required parameter 'list_watchlist_screening_individual_hit_request' is set
|
9790
|
+
if @api_client.config.client_side_validation && list_watchlist_screening_individual_hit_request.nil?
|
9791
|
+
fail ArgumentError, "Missing the required parameter 'list_watchlist_screening_individual_hit_request' when calling PlaidApi.watchlist_screening_individual_hit_list"
|
9792
|
+
end
|
9793
|
+
# resource path
|
9794
|
+
local_var_path = '/watchlist_screening/individual/hit/list'
|
9795
|
+
|
9796
|
+
# query parameters
|
9797
|
+
query_params = opts[:query_params] || {}
|
9798
|
+
|
9799
|
+
# header parameters
|
9800
|
+
header_params = opts[:header_params] || {}
|
9801
|
+
# HTTP header 'Accept' (if needed)
|
9802
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
9803
|
+
# HTTP header 'Content-Type'
|
9804
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
9805
|
+
|
9806
|
+
# form parameters
|
9807
|
+
form_params = opts[:form_params] || {}
|
9808
|
+
|
9809
|
+
# http body (model)
|
9810
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(list_watchlist_screening_individual_hit_request)
|
9811
|
+
|
9812
|
+
# return_type
|
9813
|
+
return_type = opts[:debug_return_type] || 'PaginatedIndividualWatchlistScreeningHitListResponse'
|
9814
|
+
|
9815
|
+
# auth_names
|
9816
|
+
auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
|
9817
|
+
|
9818
|
+
new_options = opts.merge(
|
9819
|
+
:operation => :"PlaidApi.watchlist_screening_individual_hit_list",
|
9820
|
+
:header_params => header_params,
|
9821
|
+
:query_params => query_params,
|
9822
|
+
:form_params => form_params,
|
9823
|
+
:body => post_body,
|
9824
|
+
:auth_names => auth_names,
|
9825
|
+
:return_type => return_type
|
9826
|
+
)
|
9827
|
+
|
9828
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
9829
|
+
if @api_client.config.debugging
|
9830
|
+
@api_client.config.logger.debug "API called: PlaidApi#watchlist_screening_individual_hit_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
9831
|
+
end
|
9832
|
+
return data, status_code, headers
|
9833
|
+
end
|
9834
|
+
|
9835
|
+
# List Individual Watchlist Screenings
|
9836
|
+
# List previously created watchlist screenings for individuals
|
9837
|
+
# @param list_individual_watchlist_screening_request [ListIndividualWatchlistScreeningRequest]
|
9838
|
+
# @param [Hash] opts the optional parameters
|
9839
|
+
# @return [PaginatedIndividualWatchlistScreeningListResponse]
|
9840
|
+
def watchlist_screening_individual_list(list_individual_watchlist_screening_request, opts = {})
|
9841
|
+
data, _status_code, _headers = watchlist_screening_individual_list_with_http_info(list_individual_watchlist_screening_request, opts)
|
9842
|
+
data
|
9843
|
+
end
|
9844
|
+
|
9845
|
+
# List Individual Watchlist Screenings
|
9846
|
+
# List previously created watchlist screenings for individuals
|
9847
|
+
# @param list_individual_watchlist_screening_request [ListIndividualWatchlistScreeningRequest]
|
9848
|
+
# @param [Hash] opts the optional parameters
|
9849
|
+
# @return [Array<(PaginatedIndividualWatchlistScreeningListResponse, Integer, Hash)>] PaginatedIndividualWatchlistScreeningListResponse data, response status code and response headers
|
9850
|
+
def watchlist_screening_individual_list_with_http_info(list_individual_watchlist_screening_request, opts = {})
|
9851
|
+
if @api_client.config.debugging
|
9852
|
+
@api_client.config.logger.debug 'Calling API: PlaidApi.watchlist_screening_individual_list ...'
|
9853
|
+
end
|
9854
|
+
# verify the required parameter 'list_individual_watchlist_screening_request' is set
|
9855
|
+
if @api_client.config.client_side_validation && list_individual_watchlist_screening_request.nil?
|
9856
|
+
fail ArgumentError, "Missing the required parameter 'list_individual_watchlist_screening_request' when calling PlaidApi.watchlist_screening_individual_list"
|
9857
|
+
end
|
9858
|
+
# resource path
|
9859
|
+
local_var_path = '/watchlist_screening/individual/list'
|
9860
|
+
|
9861
|
+
# query parameters
|
9862
|
+
query_params = opts[:query_params] || {}
|
9863
|
+
|
9864
|
+
# header parameters
|
9865
|
+
header_params = opts[:header_params] || {}
|
9866
|
+
# HTTP header 'Accept' (if needed)
|
9867
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
9868
|
+
# HTTP header 'Content-Type'
|
9869
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
9870
|
+
|
9871
|
+
# form parameters
|
9872
|
+
form_params = opts[:form_params] || {}
|
9873
|
+
|
9874
|
+
# http body (model)
|
9875
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(list_individual_watchlist_screening_request)
|
9876
|
+
|
9877
|
+
# return_type
|
9878
|
+
return_type = opts[:debug_return_type] || 'PaginatedIndividualWatchlistScreeningListResponse'
|
9879
|
+
|
9880
|
+
# auth_names
|
9881
|
+
auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
|
9882
|
+
|
9883
|
+
new_options = opts.merge(
|
9884
|
+
:operation => :"PlaidApi.watchlist_screening_individual_list",
|
9885
|
+
:header_params => header_params,
|
9886
|
+
:query_params => query_params,
|
9887
|
+
:form_params => form_params,
|
9888
|
+
:body => post_body,
|
9889
|
+
:auth_names => auth_names,
|
9890
|
+
:return_type => return_type
|
9891
|
+
)
|
9892
|
+
|
9893
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
9894
|
+
if @api_client.config.debugging
|
9895
|
+
@api_client.config.logger.debug "API called: PlaidApi#watchlist_screening_individual_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
9896
|
+
end
|
9897
|
+
return data, status_code, headers
|
9898
|
+
end
|
9899
|
+
|
9900
|
+
# Get individual watchlist screening program
|
9901
|
+
# Get an individual watchlist screening program
|
9902
|
+
# @param get_watchlist_screening_individual_program_request [GetWatchlistScreeningIndividualProgramRequest]
|
9903
|
+
# @param [Hash] opts the optional parameters
|
9904
|
+
# @return [IndividualWatchlistProgramResponse]
|
9905
|
+
def watchlist_screening_individual_program_get(get_watchlist_screening_individual_program_request, opts = {})
|
9906
|
+
data, _status_code, _headers = watchlist_screening_individual_program_get_with_http_info(get_watchlist_screening_individual_program_request, opts)
|
9907
|
+
data
|
9908
|
+
end
|
9909
|
+
|
9910
|
+
# Get individual watchlist screening program
|
9911
|
+
# Get an individual watchlist screening program
|
9912
|
+
# @param get_watchlist_screening_individual_program_request [GetWatchlistScreeningIndividualProgramRequest]
|
9913
|
+
# @param [Hash] opts the optional parameters
|
9914
|
+
# @return [Array<(IndividualWatchlistProgramResponse, Integer, Hash)>] IndividualWatchlistProgramResponse data, response status code and response headers
|
9915
|
+
def watchlist_screening_individual_program_get_with_http_info(get_watchlist_screening_individual_program_request, opts = {})
|
9916
|
+
if @api_client.config.debugging
|
9917
|
+
@api_client.config.logger.debug 'Calling API: PlaidApi.watchlist_screening_individual_program_get ...'
|
9918
|
+
end
|
9919
|
+
# verify the required parameter 'get_watchlist_screening_individual_program_request' is set
|
9920
|
+
if @api_client.config.client_side_validation && get_watchlist_screening_individual_program_request.nil?
|
9921
|
+
fail ArgumentError, "Missing the required parameter 'get_watchlist_screening_individual_program_request' when calling PlaidApi.watchlist_screening_individual_program_get"
|
9922
|
+
end
|
9923
|
+
# resource path
|
9924
|
+
local_var_path = '/watchlist_screening/individual/program/get'
|
9925
|
+
|
9926
|
+
# query parameters
|
9927
|
+
query_params = opts[:query_params] || {}
|
9928
|
+
|
9929
|
+
# header parameters
|
9930
|
+
header_params = opts[:header_params] || {}
|
9931
|
+
# HTTP header 'Accept' (if needed)
|
9932
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
9933
|
+
# HTTP header 'Content-Type'
|
9934
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
9935
|
+
|
9936
|
+
# form parameters
|
9937
|
+
form_params = opts[:form_params] || {}
|
9938
|
+
|
9939
|
+
# http body (model)
|
9940
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(get_watchlist_screening_individual_program_request)
|
9941
|
+
|
9942
|
+
# return_type
|
9943
|
+
return_type = opts[:debug_return_type] || 'IndividualWatchlistProgramResponse'
|
9944
|
+
|
9945
|
+
# auth_names
|
9946
|
+
auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
|
9947
|
+
|
9948
|
+
new_options = opts.merge(
|
9949
|
+
:operation => :"PlaidApi.watchlist_screening_individual_program_get",
|
9950
|
+
:header_params => header_params,
|
9951
|
+
:query_params => query_params,
|
9952
|
+
:form_params => form_params,
|
9953
|
+
:body => post_body,
|
9954
|
+
:auth_names => auth_names,
|
9955
|
+
:return_type => return_type
|
9956
|
+
)
|
9957
|
+
|
9958
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
9959
|
+
if @api_client.config.debugging
|
9960
|
+
@api_client.config.logger.debug "API called: PlaidApi#watchlist_screening_individual_program_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
9961
|
+
end
|
9962
|
+
return data, status_code, headers
|
9963
|
+
end
|
9964
|
+
|
9965
|
+
# List individual watchlist screening programs
|
9966
|
+
# List all individual watchlist screening programs
|
9967
|
+
# @param list_watchlist_screening_individual_programs_request [ListWatchlistScreeningIndividualProgramsRequest]
|
9968
|
+
# @param [Hash] opts the optional parameters
|
9969
|
+
# @return [PaginatedIndividualWatchlistProgramListResponse]
|
9970
|
+
def watchlist_screening_individual_program_list(list_watchlist_screening_individual_programs_request, opts = {})
|
9971
|
+
data, _status_code, _headers = watchlist_screening_individual_program_list_with_http_info(list_watchlist_screening_individual_programs_request, opts)
|
9972
|
+
data
|
9973
|
+
end
|
9974
|
+
|
9975
|
+
# List individual watchlist screening programs
|
9976
|
+
# List all individual watchlist screening programs
|
9977
|
+
# @param list_watchlist_screening_individual_programs_request [ListWatchlistScreeningIndividualProgramsRequest]
|
9978
|
+
# @param [Hash] opts the optional parameters
|
9979
|
+
# @return [Array<(PaginatedIndividualWatchlistProgramListResponse, Integer, Hash)>] PaginatedIndividualWatchlistProgramListResponse data, response status code and response headers
|
9980
|
+
def watchlist_screening_individual_program_list_with_http_info(list_watchlist_screening_individual_programs_request, opts = {})
|
9981
|
+
if @api_client.config.debugging
|
9982
|
+
@api_client.config.logger.debug 'Calling API: PlaidApi.watchlist_screening_individual_program_list ...'
|
9983
|
+
end
|
9984
|
+
# verify the required parameter 'list_watchlist_screening_individual_programs_request' is set
|
9985
|
+
if @api_client.config.client_side_validation && list_watchlist_screening_individual_programs_request.nil?
|
9986
|
+
fail ArgumentError, "Missing the required parameter 'list_watchlist_screening_individual_programs_request' when calling PlaidApi.watchlist_screening_individual_program_list"
|
9987
|
+
end
|
9988
|
+
# resource path
|
9989
|
+
local_var_path = '/watchlist_screening/individual/program/list'
|
9990
|
+
|
9991
|
+
# query parameters
|
9992
|
+
query_params = opts[:query_params] || {}
|
9993
|
+
|
9994
|
+
# header parameters
|
9995
|
+
header_params = opts[:header_params] || {}
|
9996
|
+
# HTTP header 'Accept' (if needed)
|
9997
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
9998
|
+
# HTTP header 'Content-Type'
|
9999
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
10000
|
+
|
10001
|
+
# form parameters
|
10002
|
+
form_params = opts[:form_params] || {}
|
10003
|
+
|
10004
|
+
# http body (model)
|
10005
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(list_watchlist_screening_individual_programs_request)
|
10006
|
+
|
10007
|
+
# return_type
|
10008
|
+
return_type = opts[:debug_return_type] || 'PaginatedIndividualWatchlistProgramListResponse'
|
10009
|
+
|
10010
|
+
# auth_names
|
10011
|
+
auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
|
10012
|
+
|
10013
|
+
new_options = opts.merge(
|
10014
|
+
:operation => :"PlaidApi.watchlist_screening_individual_program_list",
|
10015
|
+
:header_params => header_params,
|
10016
|
+
:query_params => query_params,
|
10017
|
+
:form_params => form_params,
|
10018
|
+
:body => post_body,
|
10019
|
+
:auth_names => auth_names,
|
10020
|
+
:return_type => return_type
|
10021
|
+
)
|
10022
|
+
|
10023
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
10024
|
+
if @api_client.config.debugging
|
10025
|
+
@api_client.config.logger.debug "API called: PlaidApi#watchlist_screening_individual_program_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
10026
|
+
end
|
10027
|
+
return data, status_code, headers
|
10028
|
+
end
|
10029
|
+
|
10030
|
+
# Create a review for an individual watchlist screening
|
10031
|
+
# Create a review for the individual watchlist screening. Reviews are compliance reports created by users in your organization regarding the relevance of potential hits found by Plaid.
|
10032
|
+
# @param create_individual_watchlist_screening_review_request [CreateIndividualWatchlistScreeningReviewRequest]
|
10033
|
+
# @param [Hash] opts the optional parameters
|
10034
|
+
# @return [WatchlistScreeningReviewResponse]
|
10035
|
+
def watchlist_screening_individual_review_create(create_individual_watchlist_screening_review_request, opts = {})
|
10036
|
+
data, _status_code, _headers = watchlist_screening_individual_review_create_with_http_info(create_individual_watchlist_screening_review_request, opts)
|
10037
|
+
data
|
10038
|
+
end
|
10039
|
+
|
10040
|
+
# Create a review for an individual watchlist screening
|
10041
|
+
# Create a review for the individual watchlist screening. Reviews are compliance reports created by users in your organization regarding the relevance of potential hits found by Plaid.
|
10042
|
+
# @param create_individual_watchlist_screening_review_request [CreateIndividualWatchlistScreeningReviewRequest]
|
10043
|
+
# @param [Hash] opts the optional parameters
|
10044
|
+
# @return [Array<(WatchlistScreeningReviewResponse, Integer, Hash)>] WatchlistScreeningReviewResponse data, response status code and response headers
|
10045
|
+
def watchlist_screening_individual_review_create_with_http_info(create_individual_watchlist_screening_review_request, opts = {})
|
10046
|
+
if @api_client.config.debugging
|
10047
|
+
@api_client.config.logger.debug 'Calling API: PlaidApi.watchlist_screening_individual_review_create ...'
|
10048
|
+
end
|
10049
|
+
# verify the required parameter 'create_individual_watchlist_screening_review_request' is set
|
10050
|
+
if @api_client.config.client_side_validation && create_individual_watchlist_screening_review_request.nil?
|
10051
|
+
fail ArgumentError, "Missing the required parameter 'create_individual_watchlist_screening_review_request' when calling PlaidApi.watchlist_screening_individual_review_create"
|
10052
|
+
end
|
10053
|
+
# resource path
|
10054
|
+
local_var_path = '/watchlist_screening/individual/review/create'
|
10055
|
+
|
10056
|
+
# query parameters
|
10057
|
+
query_params = opts[:query_params] || {}
|
10058
|
+
|
10059
|
+
# header parameters
|
10060
|
+
header_params = opts[:header_params] || {}
|
10061
|
+
# HTTP header 'Accept' (if needed)
|
10062
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
10063
|
+
# HTTP header 'Content-Type'
|
10064
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
10065
|
+
|
10066
|
+
# form parameters
|
10067
|
+
form_params = opts[:form_params] || {}
|
10068
|
+
|
10069
|
+
# http body (model)
|
10070
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(create_individual_watchlist_screening_review_request)
|
10071
|
+
|
10072
|
+
# return_type
|
10073
|
+
return_type = opts[:debug_return_type] || 'WatchlistScreeningReviewResponse'
|
10074
|
+
|
10075
|
+
# auth_names
|
10076
|
+
auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
|
10077
|
+
|
10078
|
+
new_options = opts.merge(
|
10079
|
+
:operation => :"PlaidApi.watchlist_screening_individual_review_create",
|
10080
|
+
:header_params => header_params,
|
10081
|
+
:query_params => query_params,
|
10082
|
+
:form_params => form_params,
|
10083
|
+
:body => post_body,
|
10084
|
+
:auth_names => auth_names,
|
10085
|
+
:return_type => return_type
|
10086
|
+
)
|
10087
|
+
|
10088
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
10089
|
+
if @api_client.config.debugging
|
10090
|
+
@api_client.config.logger.debug "API called: PlaidApi#watchlist_screening_individual_review_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
10091
|
+
end
|
10092
|
+
return data, status_code, headers
|
10093
|
+
end
|
10094
|
+
|
10095
|
+
# List reviews for individual watchlist screenings
|
10096
|
+
# List all reviews for the individual watchlist screening.
|
10097
|
+
# @param list_watchlist_screening_individual_reviews_request [ListWatchlistScreeningIndividualReviewsRequest]
|
10098
|
+
# @param [Hash] opts the optional parameters
|
10099
|
+
# @return [PaginatedIndividualWatchlistScreeningReviewListResponse]
|
10100
|
+
def watchlist_screening_individual_reviews_list(list_watchlist_screening_individual_reviews_request, opts = {})
|
10101
|
+
data, _status_code, _headers = watchlist_screening_individual_reviews_list_with_http_info(list_watchlist_screening_individual_reviews_request, opts)
|
10102
|
+
data
|
10103
|
+
end
|
10104
|
+
|
10105
|
+
# List reviews for individual watchlist screenings
|
10106
|
+
# List all reviews for the individual watchlist screening.
|
10107
|
+
# @param list_watchlist_screening_individual_reviews_request [ListWatchlistScreeningIndividualReviewsRequest]
|
10108
|
+
# @param [Hash] opts the optional parameters
|
10109
|
+
# @return [Array<(PaginatedIndividualWatchlistScreeningReviewListResponse, Integer, Hash)>] PaginatedIndividualWatchlistScreeningReviewListResponse data, response status code and response headers
|
10110
|
+
def watchlist_screening_individual_reviews_list_with_http_info(list_watchlist_screening_individual_reviews_request, opts = {})
|
10111
|
+
if @api_client.config.debugging
|
10112
|
+
@api_client.config.logger.debug 'Calling API: PlaidApi.watchlist_screening_individual_reviews_list ...'
|
10113
|
+
end
|
10114
|
+
# verify the required parameter 'list_watchlist_screening_individual_reviews_request' is set
|
10115
|
+
if @api_client.config.client_side_validation && list_watchlist_screening_individual_reviews_request.nil?
|
10116
|
+
fail ArgumentError, "Missing the required parameter 'list_watchlist_screening_individual_reviews_request' when calling PlaidApi.watchlist_screening_individual_reviews_list"
|
10117
|
+
end
|
10118
|
+
# resource path
|
10119
|
+
local_var_path = '/watchlist_screening/individual/review/list'
|
10120
|
+
|
10121
|
+
# query parameters
|
10122
|
+
query_params = opts[:query_params] || {}
|
10123
|
+
|
10124
|
+
# header parameters
|
10125
|
+
header_params = opts[:header_params] || {}
|
10126
|
+
# HTTP header 'Accept' (if needed)
|
10127
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
10128
|
+
# HTTP header 'Content-Type'
|
10129
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
10130
|
+
|
10131
|
+
# form parameters
|
10132
|
+
form_params = opts[:form_params] || {}
|
10133
|
+
|
10134
|
+
# http body (model)
|
10135
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(list_watchlist_screening_individual_reviews_request)
|
10136
|
+
|
10137
|
+
# return_type
|
10138
|
+
return_type = opts[:debug_return_type] || 'PaginatedIndividualWatchlistScreeningReviewListResponse'
|
10139
|
+
|
10140
|
+
# auth_names
|
10141
|
+
auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
|
10142
|
+
|
10143
|
+
new_options = opts.merge(
|
10144
|
+
:operation => :"PlaidApi.watchlist_screening_individual_reviews_list",
|
10145
|
+
:header_params => header_params,
|
10146
|
+
:query_params => query_params,
|
10147
|
+
:form_params => form_params,
|
10148
|
+
:body => post_body,
|
10149
|
+
:auth_names => auth_names,
|
10150
|
+
:return_type => return_type
|
10151
|
+
)
|
10152
|
+
|
10153
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
10154
|
+
if @api_client.config.debugging
|
10155
|
+
@api_client.config.logger.debug "API called: PlaidApi#watchlist_screening_individual_reviews_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
10156
|
+
end
|
10157
|
+
return data, status_code, headers
|
10158
|
+
end
|
10159
|
+
|
10160
|
+
# Update individual watchlist screening
|
10161
|
+
# Update a specific individual watchlist screening. This endpoint can be used to add additional customer information, correct outdated information, add a reference id, assign the individual to a reviewer, and update which program it is associated with. Please note that you may not update `search_terms` and `status` at the same time since editing `search_terms` may trigger an automatic `status` change.
|
10162
|
+
# @param update_individual_screening_request [UpdateIndividualScreeningRequest]
|
10163
|
+
# @param [Hash] opts the optional parameters
|
10164
|
+
# @return [WatchlistScreeningIndividualResponse]
|
10165
|
+
def watchlist_screening_individual_update(update_individual_screening_request, opts = {})
|
10166
|
+
data, _status_code, _headers = watchlist_screening_individual_update_with_http_info(update_individual_screening_request, opts)
|
10167
|
+
data
|
10168
|
+
end
|
10169
|
+
|
10170
|
+
# Update individual watchlist screening
|
10171
|
+
# Update a specific individual watchlist screening. This endpoint can be used to add additional customer information, correct outdated information, add a reference id, assign the individual to a reviewer, and update which program it is associated with. Please note that you may not update `search_terms` and `status` at the same time since editing `search_terms` may trigger an automatic `status` change.
|
10172
|
+
# @param update_individual_screening_request [UpdateIndividualScreeningRequest]
|
10173
|
+
# @param [Hash] opts the optional parameters
|
10174
|
+
# @return [Array<(WatchlistScreeningIndividualResponse, Integer, Hash)>] WatchlistScreeningIndividualResponse data, response status code and response headers
|
10175
|
+
def watchlist_screening_individual_update_with_http_info(update_individual_screening_request, opts = {})
|
10176
|
+
if @api_client.config.debugging
|
10177
|
+
@api_client.config.logger.debug 'Calling API: PlaidApi.watchlist_screening_individual_update ...'
|
10178
|
+
end
|
10179
|
+
# verify the required parameter 'update_individual_screening_request' is set
|
10180
|
+
if @api_client.config.client_side_validation && update_individual_screening_request.nil?
|
10181
|
+
fail ArgumentError, "Missing the required parameter 'update_individual_screening_request' when calling PlaidApi.watchlist_screening_individual_update"
|
10182
|
+
end
|
10183
|
+
# resource path
|
10184
|
+
local_var_path = '/watchlist_screening/individual/update'
|
10185
|
+
|
10186
|
+
# query parameters
|
10187
|
+
query_params = opts[:query_params] || {}
|
10188
|
+
|
10189
|
+
# header parameters
|
10190
|
+
header_params = opts[:header_params] || {}
|
10191
|
+
# HTTP header 'Accept' (if needed)
|
10192
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
10193
|
+
# HTTP header 'Content-Type'
|
10194
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
10195
|
+
|
10196
|
+
# form parameters
|
10197
|
+
form_params = opts[:form_params] || {}
|
10198
|
+
|
10199
|
+
# http body (model)
|
10200
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(update_individual_screening_request)
|
10201
|
+
|
10202
|
+
# return_type
|
10203
|
+
return_type = opts[:debug_return_type] || 'WatchlistScreeningIndividualResponse'
|
10204
|
+
|
10205
|
+
# auth_names
|
10206
|
+
auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
|
10207
|
+
|
10208
|
+
new_options = opts.merge(
|
10209
|
+
:operation => :"PlaidApi.watchlist_screening_individual_update",
|
10210
|
+
:header_params => header_params,
|
10211
|
+
:query_params => query_params,
|
10212
|
+
:form_params => form_params,
|
10213
|
+
:body => post_body,
|
10214
|
+
:auth_names => auth_names,
|
10215
|
+
:return_type => return_type
|
10216
|
+
)
|
10217
|
+
|
10218
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
10219
|
+
if @api_client.config.debugging
|
10220
|
+
@api_client.config.logger.debug "API called: PlaidApi#watchlist_screening_individual_update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
10221
|
+
end
|
10222
|
+
return data, status_code, headers
|
10223
|
+
end
|
10224
|
+
|
8277
10225
|
# Get webhook verification key
|
8278
10226
|
# Plaid signs all outgoing webhooks and provides JSON Web Tokens (JWTs) so that you can verify the authenticity of any incoming webhooks to your application. A message signature is included in the `Plaid-Verification` header. The `/webhook_verification_key/get` endpoint provides a JSON Web Key (JWK) that can be used to verify a JWT.
|
8279
10227
|
# @param webhook_verification_key_get_request [WebhookVerificationKeyGetRequest]
|