From d233eb110f75d074d8240006f0582b35e151d2a4 Mon Sep 17 00:00:00 2001
From: fern-api <115122769+fern-api[bot]@users.noreply.github.com>
Date: Wed, 24 Jul 2024 11:46:04 +0000
Subject: [PATCH 1/2] SDK regeneration
---
poetry.lock | 203 +-
pyproject.toml | 3 +-
reference.md | 43086 ++++++++++++++++
src/merge/client.py | 8 +-
src/merge/core/__init__.py | 19 +-
src/merge/core/client_wrapper.py | 2 +-
src/merge/core/http_client.py | 56 +-
src/merge/core/jsonable_encoder.py | 58 +-
src/merge/core/pydantic_utilities.py | 157 +-
src/merge/core/query_encoder.py | 6 +-
src/merge/core/request_options.py | 4 +-
.../resources/account_details/client.py | 20 +-
.../resources/account_token/client.py | 24 +-
.../resources/accounting_periods/client.py | 42 +-
.../accounting/resources/accounts/client.py | 82 +-
.../accounting/resources/addresses/client.py | 24 +-
.../resources/async_passthrough/client.py | 52 +-
.../resources/attachments/client.py | 82 +-
.../resources/audit_trail/client.py | 20 +-
.../resources/available_actions/client.py | 20 +-
.../resources/balance_sheets/client.py | 42 +-
.../resources/cash_flow_statements/client.py | 42 +-
.../resources/company_info/client.py | 42 +-
.../accounting/resources/contacts/client.py | 82 +-
.../resources/credit_notes/client.py | 42 +-
.../resources/delete_account/client.py | 18 +-
.../accounting/resources/expenses/client.py | 82 +-
.../resources/field_mapping/client.py | 132 +-
.../resources/force_resync/client.py | 20 +-
.../resources/generate_key/client.py | 24 +-
.../resources/income_statements/client.py | 42 +-
.../accounting/resources/invoices/client.py | 128 +-
.../accounting/resources/issues/client.py | 42 +-
.../accounting/resources/items/client.py | 42 +-
.../resources/journal_entries/client.py | 82 +-
.../accounting/resources/link_token/client.py | 30 +-
.../resources/linked_accounts/client.py | 20 +-
.../resources/passthrough/client.py | 30 +-
.../accounting/resources/payments/client.py | 128 +-
.../resources/phone_numbers/client.py | 24 +-
.../resources/purchase_orders/client.py | 82 +-
.../resources/regenerate_key/client.py | 24 +-
.../accounting/resources/scopes/client.py | 100 +-
.../resources/sync_status/client.py | 20 +-
.../accounting/resources/tax_rates/client.py | 42 +-
.../resources/tracking_categories/client.py | 42 +-
.../resources/transactions/client.py | 42 +-
.../resources/vendor_credits/client.py | 42 +-
.../resources/webhook_receivers/client.py | 44 +-
.../resources/accounting/types/account.py | 58 +-
.../accounting/types/account_details.py | 33 +-
.../types/account_details_and_actions.py | 35 +-
...account_details_and_actions_integration.py | 31 +-
.../accounting/types/account_integration.py | 47 +-
.../accounting/types/account_request.py | 51 +-
.../accounting/types/account_response.py | 31 +-
.../accounting/types/account_token.py | 31 +-
.../accounting/types/accounting_attachment.py | 44 +-
.../types/accounting_attachment_request.py | 37 +-
.../types/accounting_attachment_response.py | 31 +-
.../accounting/types/accounting_period.py | 40 +-
.../types/accounting_phone_number.py | 38 +-
.../types/accounting_phone_number_request.py | 35 +-
.../resources/accounting/types/address.py | 48 +-
.../accounting/types/address_request.py | 45 +-
.../accounting/types/advanced_metadata.py | 31 +-
.../types/async_passthrough_reciept.py | 31 +-
.../accounting/types/audit_log_event.py | 38 +-
.../accounting/types/available_actions.py | 31 +-
.../accounting/types/balance_sheet.py | 50 +-
.../accounting/types/cash_flow_statement.py | 54 +-
.../types/common_model_scope_api.py | 33 +-
.../types/common_model_scopes_body_request.py | 31 +-
.../accounting/types/company_info.py | 54 +-
.../resources/accounting/types/contact.py | 60 +-
.../accounting/types/contact_request.py | 51 +-
.../accounting/types/contact_response.py | 31 +-
.../resources/accounting/types/credit_note.py | 66 +-
.../accounting/types/credit_note_line_item.py | 58 +-
.../types/data_passthrough_request.py | 43 +-
.../accounting/types/debug_mode_log.py | 31 +-
.../types/debug_model_log_summary.py | 31 +-
.../types/error_validation_problem.py | 31 +-
.../resources/accounting/types/expense.py | 62 +-
.../accounting/types/expense_line.py | 54 +-
.../accounting/types/expense_line_request.py | 49 +-
.../accounting/types/expense_request.py | 52 +-
.../accounting/types/expense_response.py | 31 +-
.../types/external_target_field_api.py | 31 +-
.../external_target_field_api_response.py | 73 +-
.../types/field_mapping_api_instance.py | 31 +-
...field_mapping_api_instance_remote_field.py | 35 +-
...tance_remote_field_remote_endpoint_info.py | 31 +-
.../field_mapping_api_instance_response.py | 73 +-
...field_mapping_api_instance_target_field.py | 31 +-
.../types/field_mapping_instance_response.py | 31 +-
.../types/field_permission_deserializer.py | 31 +-
.../field_permission_deserializer_request.py | 31 +-
.../accounting/types/income_statement.py | 54 +-
...ividual_common_model_scope_deserializer.py | 31 +-
...common_model_scope_deserializer_request.py | 31 +-
.../resources/accounting/types/invoice.py | 76 +-
.../accounting/types/invoice_line_item.py | 52 +-
.../types/invoice_line_item_request.py | 47 +-
.../accounting/types/invoice_request.py | 64 +-
.../accounting/types/invoice_response.py | 31 +-
src/merge/resources/accounting/types/issue.py | 32 +-
src/merge/resources/accounting/types/item.py | 54 +-
.../accounting/types/journal_entry.py | 62 +-
.../accounting/types/journal_entry_request.py | 46 +-
.../types/journal_entry_response.py | 31 +-
.../accounting/types/journal_line.py | 48 +-
.../accounting/types/journal_line_request.py | 43 +-
.../resources/accounting/types/link_token.py | 31 +-
.../accounting/types/linked_account_status.py | 31 +-
.../accounting/types/meta_response.py | 31 +-
.../accounting/types/model_operation.py | 31 +-
.../types/model_permission_deserializer.py | 31 +-
.../model_permission_deserializer_request.py | 31 +-
.../types/multipart_form_field_request.py | 41 +-
...inated_account_details_and_actions_list.py | 31 +-
.../types/paginated_account_list.py | 31 +-
.../paginated_accounting_attachment_list.py | 31 +-
.../types/paginated_accounting_period_list.py | 31 +-
.../types/paginated_audit_log_event_list.py | 31 +-
.../types/paginated_balance_sheet_list.py | 31 +-
.../paginated_cash_flow_statement_list.py | 31 +-
.../types/paginated_company_info_list.py | 31 +-
.../types/paginated_contact_list.py | 31 +-
.../types/paginated_credit_note_list.py | 31 +-
.../types/paginated_expense_list.py | 31 +-
.../types/paginated_income_statement_list.py | 31 +-
.../types/paginated_invoice_list.py | 31 +-
.../accounting/types/paginated_issue_list.py | 31 +-
.../accounting/types/paginated_item_list.py | 31 +-
.../types/paginated_journal_entry_list.py | 31 +-
.../types/paginated_payment_list.py | 31 +-
.../types/paginated_purchase_order_list.py | 31 +-
.../types/paginated_sync_status_list.py | 31 +-
.../types/paginated_tax_rate_list.py | 31 +-
.../types/paginated_tracking_category_list.py | 31 +-
.../types/paginated_transaction_list.py | 31 +-
.../types/paginated_vendor_credit_list.py | 31 +-
.../types/patched_payment_request.py | 50 +-
.../resources/accounting/types/payment.py | 60 +-
.../accounting/types/payment_line_item.py | 44 +-
.../types/payment_line_item_request.py | 40 +-
.../accounting/types/payment_request.py | 50 +-
.../accounting/types/payment_response.py | 31 +-
.../accounting/types/purchase_order.py | 68 +-
.../types/purchase_order_line_item.py | 60 +-
.../types/purchase_order_line_item_request.py | 55 +-
.../types/purchase_order_request.py | 52 +-
.../types/purchase_order_response.py | 31 +-
.../resources/accounting/types/remote_data.py | 31 +-
.../accounting/types/remote_endpoint_info.py | 31 +-
.../accounting/types/remote_field_api.py | 35 +-
.../types/remote_field_api_response.py | 73 +-
.../resources/accounting/types/remote_key.py | 31 +-
.../accounting/types/remote_response.py | 31 +-
.../resources/accounting/types/report_item.py | 42 +-
.../resources/accounting/types/sync_status.py | 30 +-
.../resources/accounting/types/tax_rate.py | 46 +-
.../accounting/types/tracking_category.py | 48 +-
.../resources/accounting/types/transaction.py | 58 +-
.../accounting/types/transaction_line_item.py | 58 +-
.../types/validation_problem_source.py | 31 +-
.../accounting/types/vendor_credit.py | 54 +-
.../accounting/types/vendor_credit_line.py | 52 +-
.../types/warning_validation_problem.py | 31 +-
.../accounting/types/webhook_receiver.py | 31 +-
.../ats/resources/account_details/client.py | 20 +-
.../ats/resources/account_token/client.py | 24 +-
.../ats/resources/activities/client.py | 84 +-
.../ats/resources/applications/client.py | 106 +-
.../ats/resources/async_passthrough/client.py | 52 +-
.../ats/resources/attachments/client.py | 84 +-
.../ats/resources/audit_trail/client.py | 20 +-
.../ats/resources/available_actions/client.py | 20 +-
.../ats/resources/candidates/client.py | 156 +-
.../ats/resources/delete_account/client.py | 18 +-
.../ats/resources/departments/client.py | 42 +-
.../resources/ats/resources/eeocs/client.py | 42 +-
.../ats/resources/field_mapping/client.py | 132 +-
.../ats/resources/force_resync/client.py | 20 +-
.../ats/resources/generate_key/client.py | 24 +-
.../ats/resources/interviews/client.py | 84 +-
.../resources/ats/resources/issues/client.py | 42 +-
.../resources/job_interview_stages/client.py | 42 +-
.../ats/resources/job_postings/client.py | 42 +-
.../resources/ats/resources/jobs/client.py | 64 +-
.../ats/resources/link_token/client.py | 30 +-
.../ats/resources/linked_accounts/client.py | 20 +-
.../resources/ats/resources/offers/client.py | 42 +-
.../resources/ats/resources/offices/client.py | 42 +-
.../ats/resources/passthrough/client.py | 30 +-
.../ats/resources/regenerate_key/client.py | 24 +-
.../ats/resources/reject_reasons/client.py | 42 +-
.../resources/ats/resources/scopes/client.py | 100 +-
.../ats/resources/scorecards/client.py | 42 +-
.../ats/resources/sync_status/client.py | 20 +-
.../resources/ats/resources/tags/client.py | 20 +-
.../resources/ats/resources/users/client.py | 42 +-
.../ats/resources/webhook_receivers/client.py | 44 +-
.../resources/ats/types/account_details.py | 33 +-
.../ats/types/account_details_and_actions.py | 35 +-
...account_details_and_actions_integration.py | 31 +-
.../ats/types/account_integration.py | 47 +-
.../resources/ats/types/account_token.py | 31 +-
src/merge/resources/ats/types/activity.py | 52 +-
.../resources/ats/types/activity_request.py | 43 +-
.../resources/ats/types/activity_response.py | 31 +-
.../resources/ats/types/advanced_metadata.py | 31 +-
src/merge/resources/ats/types/application.py | 54 +-
.../ats/types/application_request.py | 46 +-
.../ats/types/application_response.py | 31 +-
.../ats/types/async_passthrough_reciept.py | 31 +-
src/merge/resources/ats/types/attachment.py | 44 +-
.../resources/ats/types/attachment_request.py | 39 +-
.../ats/types/attachment_response.py | 31 +-
.../resources/ats/types/audit_log_event.py | 38 +-
.../resources/ats/types/available_actions.py | 31 +-
src/merge/resources/ats/types/candidate.py | 64 +-
.../resources/ats/types/candidate_request.py | 52 +-
.../resources/ats/types/candidate_response.py | 31 +-
.../ats/types/common_model_scope_api.py | 33 +-
.../types/common_model_scopes_body_request.py | 31 +-
.../ats/types/data_passthrough_request.py | 43 +-
.../resources/ats/types/debug_mode_log.py | 31 +-
.../ats/types/debug_model_log_summary.py | 31 +-
src/merge/resources/ats/types/department.py | 40 +-
src/merge/resources/ats/types/eeoc.py | 50 +-
.../resources/ats/types/email_address.py | 38 +-
.../ats/types/email_address_request.py | 35 +-
.../ats/types/error_validation_problem.py | 31 +-
.../ats/types/external_target_field_api.py | 31 +-
.../external_target_field_api_response.py | 69 +-
.../ats/types/field_mapping_api_instance.py | 31 +-
...field_mapping_api_instance_remote_field.py | 35 +-
...tance_remote_field_remote_endpoint_info.py | 31 +-
.../field_mapping_api_instance_response.py | 69 +-
...field_mapping_api_instance_target_field.py | 31 +-
.../types/field_mapping_instance_response.py | 31 +-
.../types/field_permission_deserializer.py | 31 +-
.../field_permission_deserializer_request.py | 31 +-
...ividual_common_model_scope_deserializer.py | 31 +-
...common_model_scope_deserializer_request.py | 31 +-
src/merge/resources/ats/types/issue.py | 32 +-
src/merge/resources/ats/types/job.py | 64 +-
.../ats/types/job_interview_stage.py | 44 +-
src/merge/resources/ats/types/job_posting.py | 54 +-
src/merge/resources/ats/types/link_token.py | 31 +-
.../ats/types/linked_account_status.py | 31 +-
.../resources/ats/types/meta_response.py | 31 +-
.../resources/ats/types/model_operation.py | 31 +-
.../types/model_permission_deserializer.py | 31 +-
.../model_permission_deserializer_request.py | 31 +-
.../ats/types/multipart_form_field_request.py | 41 +-
src/merge/resources/ats/types/offer.py | 54 +-
src/merge/resources/ats/types/office.py | 42 +-
...inated_account_details_and_actions_list.py | 31 +-
.../ats/types/paginated_activity_list.py | 31 +-
.../ats/types/paginated_application_list.py | 31 +-
.../ats/types/paginated_attachment_list.py | 31 +-
.../types/paginated_audit_log_event_list.py | 31 +-
.../ats/types/paginated_candidate_list.py | 31 +-
.../ats/types/paginated_department_list.py | 31 +-
.../ats/types/paginated_eeoc_list.py | 31 +-
.../ats/types/paginated_issue_list.py | 31 +-
.../paginated_job_interview_stage_list.py | 31 +-
.../resources/ats/types/paginated_job_list.py | 31 +-
.../ats/types/paginated_job_posting_list.py | 31 +-
.../ats/types/paginated_offer_list.py | 31 +-
.../ats/types/paginated_office_list.py | 31 +-
.../ats/types/paginated_reject_reason_list.py | 31 +-
.../ats/types/paginated_remote_user_list.py | 31 +-
.../paginated_scheduled_interview_list.py | 31 +-
.../ats/types/paginated_scorecard_list.py | 31 +-
.../paginated_screening_question_list.py | 31 +-
.../ats/types/paginated_sync_status_list.py | 31 +-
.../resources/ats/types/paginated_tag_list.py | 31 +-
.../ats/types/patched_candidate_request.py | 52 +-
src/merge/resources/ats/types/phone_number.py | 38 +-
.../ats/types/phone_number_request.py | 35 +-
.../resources/ats/types/reject_reason.py | 40 +-
src/merge/resources/ats/types/remote_data.py | 31 +-
.../ats/types/remote_endpoint_info.py | 31 +-
.../resources/ats/types/remote_field_api.py | 35 +-
.../ats/types/remote_field_api_response.py | 69 +-
src/merge/resources/ats/types/remote_key.py | 31 +-
.../resources/ats/types/remote_response.py | 31 +-
src/merge/resources/ats/types/remote_user.py | 50 +-
.../ats/types/scheduled_interview.py | 60 +-
.../ats/types/scheduled_interview_request.py | 46 +-
.../ats/types/scheduled_interview_response.py | 31 +-
src/merge/resources/ats/types/scorecard.py | 50 +-
.../resources/ats/types/screening_question.py | 46 +-
.../ats/types/screening_question_option.py | 38 +-
src/merge/resources/ats/types/sync_status.py | 30 +-
src/merge/resources/ats/types/tag.py | 40 +-
src/merge/resources/ats/types/url.py | 38 +-
src/merge/resources/ats/types/url_request.py | 35 +-
.../ats/types/validation_problem_source.py | 31 +-
.../ats/types/warning_validation_problem.py | 31 +-
.../resources/ats/types/webhook_receiver.py | 31 +-
.../crm/resources/account_details/client.py | 20 +-
.../crm/resources/account_token/client.py | 24 +-
.../crm/resources/accounts/client.py | 146 +-
.../crm/resources/association_types/client.py | 114 +-
.../crm/resources/associations/client.py | 56 +-
.../crm/resources/async_passthrough/client.py | 52 +-
.../crm/resources/audit_trail/client.py | 20 +-
.../crm/resources/available_actions/client.py | 20 +-
.../crm/resources/contacts/client.py | 174 +-
.../resources/custom_object_classes/client.py | 42 +-
.../crm/resources/custom_objects/client.py | 98 +-
.../crm/resources/delete_account/client.py | 18 +-
.../crm/resources/engagement_types/client.py | 60 +-
.../crm/resources/engagements/client.py | 146 +-
.../crm/resources/field_mapping/client.py | 132 +-
.../crm/resources/force_resync/client.py | 20 +-
.../crm/resources/generate_key/client.py | 24 +-
.../resources/crm/resources/issues/client.py | 42 +-
.../resources/crm/resources/leads/client.py | 100 +-
.../crm/resources/link_token/client.py | 30 +-
.../crm/resources/linked_accounts/client.py | 20 +-
.../resources/crm/resources/notes/client.py | 100 +-
.../crm/resources/opportunities/client.py | 146 +-
.../crm/resources/passthrough/client.py | 30 +-
.../crm/resources/regenerate_key/client.py | 24 +-
.../resources/crm/resources/scopes/client.py | 100 +-
.../resources/crm/resources/stages/client.py | 60 +-
.../crm/resources/sync_status/client.py | 20 +-
.../resources/crm/resources/tasks/client.py | 146 +-
.../resources/crm/resources/users/client.py | 88 +-
.../crm/resources/webhook_receivers/client.py | 44 +-
src/merge/resources/crm/types/account.py | 54 +-
.../resources/crm/types/account_details.py | 33 +-
.../crm/types/account_details_and_actions.py | 35 +-
...account_details_and_actions_integration.py | 31 +-
.../crm/types/account_integration.py | 47 +-
.../resources/crm/types/account_request.py | 44 +-
.../resources/crm/types/account_token.py | 31 +-
src/merge/resources/crm/types/address.py | 48 +-
.../resources/crm/types/address_request.py | 45 +-
.../resources/crm/types/advanced_metadata.py | 31 +-
src/merge/resources/crm/types/association.py | 36 +-
.../crm/types/association_sub_type.py | 34 +-
.../resources/crm/types/association_type.py | 38 +-
.../types/association_type_request_request.py | 31 +-
.../crm/types/async_passthrough_reciept.py | 31 +-
.../resources/crm/types/audit_log_event.py | 38 +-
.../resources/crm/types/available_actions.py | 31 +-
.../crm/types/common_model_scope_api.py | 33 +-
.../types/common_model_scopes_body_request.py | 31 +-
src/merge/resources/crm/types/contact.py | 48 +-
.../resources/crm/types/contact_request.py | 40 +-
.../crm/types/crm_account_response.py | 31 +-
.../types/crm_association_type_response.py | 31 +-
.../crm/types/crm_contact_response.py | 31 +-
.../crm/types/crm_custom_object_response.py | 31 +-
.../resources/crm/types/custom_object.py | 40 +-
.../crm/types/custom_object_class.py | 40 +-
.../crm/types/custom_object_request.py | 31 +-
.../crm/types/data_passthrough_request.py | 43 +-
.../resources/crm/types/debug_mode_log.py | 31 +-
.../crm/types/debug_model_log_summary.py | 31 +-
.../resources/crm/types/email_address.py | 38 +-
.../crm/types/email_address_request.py | 35 +-
src/merge/resources/crm/types/engagement.py | 54 +-
.../resources/crm/types/engagement_request.py | 46 +-
.../crm/types/engagement_response.py | 31 +-
.../resources/crm/types/engagement_type.py | 40 +-
.../crm/types/error_validation_problem.py | 31 +-
.../crm/types/external_target_field_api.py | 31 +-
.../external_target_field_api_response.py | 55 +-
.../crm/types/field_mapping_api_instance.py | 31 +-
...field_mapping_api_instance_remote_field.py | 35 +-
...tance_remote_field_remote_endpoint_info.py | 31 +-
.../field_mapping_api_instance_response.py | 55 +-
...field_mapping_api_instance_target_field.py | 31 +-
.../types/field_mapping_instance_response.py | 31 +-
.../types/field_permission_deserializer.py | 31 +-
.../field_permission_deserializer_request.py | 31 +-
.../crm/types/ignore_common_model_request.py | 31 +-
...ividual_common_model_scope_deserializer.py | 31 +-
...common_model_scope_deserializer_request.py | 31 +-
src/merge/resources/crm/types/issue.py | 32 +-
src/merge/resources/crm/types/item_schema.py | 31 +-
src/merge/resources/crm/types/lead.py | 58 +-
src/merge/resources/crm/types/lead_request.py | 48 +-
.../resources/crm/types/lead_response.py | 31 +-
src/merge/resources/crm/types/link_token.py | 31 +-
.../crm/types/linked_account_status.py | 31 +-
.../resources/crm/types/meta_response.py | 31 +-
.../resources/crm/types/model_operation.py | 31 +-
.../types/model_permission_deserializer.py | 31 +-
.../model_permission_deserializer_request.py | 31 +-
.../crm/types/multipart_form_field_request.py | 41 +-
src/merge/resources/crm/types/note.py | 50 +-
src/merge/resources/crm/types/note_request.py | 41 +-
.../resources/crm/types/note_response.py | 31 +-
.../types/object_class_description_request.py | 31 +-
src/merge/resources/crm/types/opportunity.py | 56 +-
.../crm/types/opportunity_request.py | 48 +-
.../crm/types/opportunity_response.py | 31 +-
...inated_account_details_and_actions_list.py | 31 +-
.../crm/types/paginated_account_list.py | 31 +-
.../crm/types/paginated_association_list.py | 31 +-
.../types/paginated_association_type_list.py | 31 +-
.../types/paginated_audit_log_event_list.py | 31 +-
.../crm/types/paginated_contact_list.py | 31 +-
.../paginated_custom_object_class_list.py | 31 +-
.../crm/types/paginated_custom_object_list.py | 31 +-
.../crm/types/paginated_engagement_list.py | 31 +-
.../types/paginated_engagement_type_list.py | 31 +-
.../crm/types/paginated_issue_list.py | 31 +-
.../crm/types/paginated_lead_list.py | 31 +-
.../crm/types/paginated_note_list.py | 31 +-
.../crm/types/paginated_opportunity_list.py | 31 +-
.../paginated_remote_field_class_list.py | 31 +-
.../crm/types/paginated_stage_list.py | 31 +-
.../crm/types/paginated_sync_status_list.py | 31 +-
.../crm/types/paginated_task_list.py | 31 +-
.../crm/types/paginated_user_list.py | 31 +-
.../crm/types/patched_account_request.py | 44 +-
.../crm/types/patched_contact_request.py | 40 +-
.../crm/types/patched_engagement_request.py | 46 +-
.../crm/types/patched_opportunity_request.py | 48 +-
.../crm/types/patched_task_request.py | 46 +-
src/merge/resources/crm/types/phone_number.py | 38 +-
.../crm/types/phone_number_request.py | 35 +-
src/merge/resources/crm/types/remote_data.py | 31 +-
.../crm/types/remote_endpoint_info.py | 31 +-
src/merge/resources/crm/types/remote_field.py | 31 +-
.../resources/crm/types/remote_field_api.py | 35 +-
.../crm/types/remote_field_api_response.py | 55 +-
.../resources/crm/types/remote_field_class.py | 31 +-
.../remote_field_class_field_choices_item.py | 31 +-
...ote_field_class_for_custom_object_class.py | 34 +-
..._custom_object_class_field_choices_item.py | 31 +-
...ass_for_custom_object_class_item_schema.py | 31 +-
.../crm/types/remote_field_request.py | 31 +-
src/merge/resources/crm/types/remote_key.py | 31 +-
.../resources/crm/types/remote_response.py | 31 +-
src/merge/resources/crm/types/stage.py | 40 +-
src/merge/resources/crm/types/sync_status.py | 30 +-
src/merge/resources/crm/types/task.py | 54 +-
src/merge/resources/crm/types/task_request.py | 46 +-
.../resources/crm/types/task_response.py | 31 +-
src/merge/resources/crm/types/user.py | 44 +-
.../crm/types/validation_problem_source.py | 31 +-
.../crm/types/warning_validation_problem.py | 31 +-
.../resources/crm/types/webhook_receiver.py | 31 +-
.../resources/account_details/client.py | 20 +-
.../resources/account_token/client.py | 24 +-
.../resources/async_passthrough/client.py | 52 +-
.../resources/audit_trail/client.py | 20 +-
.../resources/available_actions/client.py | 20 +-
.../resources/delete_account/client.py | 18 +-
.../filestorage/resources/drives/client.py | 42 +-
.../resources/field_mapping/client.py | 132 +-
.../filestorage/resources/files/client.py | 118 +-
.../filestorage/resources/folders/client.py | 82 +-
.../resources/force_resync/client.py | 20 +-
.../resources/generate_key/client.py | 24 +-
.../filestorage/resources/groups/client.py | 42 +-
.../filestorage/resources/issues/client.py | 42 +-
.../resources/link_token/client.py | 30 +-
.../resources/linked_accounts/client.py | 20 +-
.../resources/passthrough/client.py | 30 +-
.../resources/regenerate_key/client.py | 24 +-
.../filestorage/resources/scopes/client.py | 100 +-
.../resources/sync_status/client.py | 20 +-
.../filestorage/resources/users/client.py | 42 +-
.../resources/webhook_receivers/client.py | 44 +-
.../filestorage/types/account_details.py | 33 +-
.../types/account_details_and_actions.py | 35 +-
...account_details_and_actions_integration.py | 31 +-
.../filestorage/types/account_integration.py | 47 +-
.../filestorage/types/account_token.py | 31 +-
.../filestorage/types/advanced_metadata.py | 31 +-
.../types/async_passthrough_reciept.py | 31 +-
.../filestorage/types/audit_log_event.py | 38 +-
.../filestorage/types/available_actions.py | 31 +-
.../types/common_model_scope_api.py | 33 +-
.../types/common_model_scopes_body_request.py | 31 +-
.../types/data_passthrough_request.py | 43 +-
.../filestorage/types/debug_mode_log.py | 31 +-
.../types/debug_model_log_summary.py | 31 +-
.../resources/filestorage/types/drive.py | 44 +-
.../types/error_validation_problem.py | 31 +-
.../types/external_target_field_api.py | 31 +-
.../external_target_field_api_response.py | 43 +-
.../types/field_mapping_api_instance.py | 31 +-
...field_mapping_api_instance_remote_field.py | 35 +-
...tance_remote_field_remote_endpoint_info.py | 31 +-
.../field_mapping_api_instance_response.py | 43 +-
...field_mapping_api_instance_target_field.py | 31 +-
.../types/field_mapping_instance_response.py | 31 +-
.../types/field_permission_deserializer.py | 31 +-
.../field_permission_deserializer_request.py | 31 +-
src/merge/resources/filestorage/types/file.py | 60 +-
.../filestorage/types/file_request.py | 49 +-
.../types/file_storage_file_response.py | 31 +-
.../types/file_storage_folder_response.py | 31 +-
.../resources/filestorage/types/folder.py | 58 +-
.../filestorage/types/folder_request.py | 45 +-
.../resources/filestorage/types/group.py | 42 +-
...ividual_common_model_scope_deserializer.py | 31 +-
...common_model_scope_deserializer_request.py | 31 +-
.../resources/filestorage/types/issue.py | 32 +-
.../resources/filestorage/types/link_token.py | 31 +-
.../types/linked_account_status.py | 31 +-
.../filestorage/types/meta_response.py | 31 +-
.../filestorage/types/model_operation.py | 31 +-
.../types/model_permission_deserializer.py | 31 +-
.../model_permission_deserializer_request.py | 31 +-
.../types/multipart_form_field_request.py | 41 +-
...inated_account_details_and_actions_list.py | 31 +-
.../types/paginated_audit_log_event_list.py | 31 +-
.../filestorage/types/paginated_drive_list.py | 31 +-
.../filestorage/types/paginated_file_list.py | 31 +-
.../types/paginated_folder_list.py | 31 +-
.../filestorage/types/paginated_group_list.py | 31 +-
.../filestorage/types/paginated_issue_list.py | 31 +-
.../types/paginated_sync_status_list.py | 31 +-
.../filestorage/types/paginated_user_list.py | 31 +-
.../resources/filestorage/types/permission.py | 44 +-
.../filestorage/types/permission_request.py | 41 +-
.../filestorage/types/remote_endpoint_info.py | 31 +-
.../filestorage/types/remote_field_api.py | 35 +-
.../types/remote_field_api_response.py | 43 +-
.../resources/filestorage/types/remote_key.py | 31 +-
.../filestorage/types/remote_response.py | 31 +-
.../filestorage/types/sync_status.py | 30 +-
src/merge/resources/filestorage/types/user.py | 44 +-
.../types/validation_problem_source.py | 31 +-
.../types/warning_validation_problem.py | 31 +-
.../filestorage/types/webhook_receiver.py | 31 +-
.../hris/resources/account_details/client.py | 20 +-
.../hris/resources/account_token/client.py | 24 +-
.../resources/async_passthrough/client.py | 52 +-
.../hris/resources/audit_trail/client.py | 20 +-
.../resources/available_actions/client.py | 20 +-
.../hris/resources/bank_info/client.py | 42 +-
.../hris/resources/benefits/client.py | 42 +-
.../hris/resources/companies/client.py | 42 +-
.../hris/resources/delete_account/client.py | 18 +-
.../hris/resources/dependents/client.py | 42 +-
.../resources/employee_payroll_runs/client.py | 42 +-
.../hris/resources/employees/client.py | 106 +-
.../resources/employer_benefits/client.py | 42 +-
.../hris/resources/employments/client.py | 42 +-
.../hris/resources/field_mapping/client.py | 132 +-
.../hris/resources/force_resync/client.py | 20 +-
.../hris/resources/generate_key/client.py | 24 +-
.../resources/hris/resources/groups/client.py | 42 +-
.../resources/hris/resources/issues/client.py | 42 +-
.../hris/resources/link_token/client.py | 30 +-
.../hris/resources/linked_accounts/client.py | 20 +-
.../hris/resources/locations/client.py | 42 +-
.../hris/resources/passthrough/client.py | 30 +-
.../hris/resources/pay_groups/client.py | 42 +-
.../hris/resources/payroll_runs/client.py | 42 +-
.../hris/resources/regenerate_key/client.py | 24 +-
.../resources/hris/resources/scopes/client.py | 100 +-
.../hris/resources/sync_status/client.py | 20 +-
.../resources/hris/resources/teams/client.py | 42 +-
.../hris/resources/time_off/client.py | 82 +-
.../resources/time_off_balances/client.py | 42 +-
.../resources/timesheet_entries/client.py | 82 +-
.../resources/webhook_receivers/client.py | 44 +-
.../resources/hris/types/account_details.py | 33 +-
.../hris/types/account_details_and_actions.py | 35 +-
...account_details_and_actions_integration.py | 31 +-
.../hris/types/account_integration.py | 47 +-
.../resources/hris/types/account_token.py | 31 +-
.../resources/hris/types/advanced_metadata.py | 31 +-
.../hris/types/async_passthrough_reciept.py | 31 +-
.../resources/hris/types/audit_log_event.py | 38 +-
.../resources/hris/types/available_actions.py | 31 +-
src/merge/resources/hris/types/bank_info.py | 50 +-
src/merge/resources/hris/types/benefit.py | 54 +-
.../hris/types/common_model_scope_api.py | 33 +-
.../types/common_model_scopes_body_request.py | 31 +-
src/merge/resources/hris/types/company.py | 44 +-
.../hris/types/data_passthrough_request.py | 43 +-
.../resources/hris/types/debug_mode_log.py | 31 +-
.../hris/types/debug_model_log_summary.py | 31 +-
src/merge/resources/hris/types/deduction.py | 44 +-
src/merge/resources/hris/types/dependent.py | 60 +-
src/merge/resources/hris/types/earning.py | 42 +-
src/merge/resources/hris/types/employee.py | 94 +-
.../hris/types/employee_payroll_run.py | 52 +-
.../resources/hris/types/employee_request.py | 82 +-
.../resources/hris/types/employee_response.py | 31 +-
.../resources/hris/types/employer_benefit.py | 46 +-
src/merge/resources/hris/types/employment.py | 60 +-
.../hris/types/error_validation_problem.py | 31 +-
.../hris/types/external_target_field_api.py | 31 +-
.../external_target_field_api_response.py | 69 +-
.../hris/types/field_mapping_api_instance.py | 31 +-
...field_mapping_api_instance_remote_field.py | 35 +-
...tance_remote_field_remote_endpoint_info.py | 31 +-
.../field_mapping_api_instance_response.py | 69 +-
...field_mapping_api_instance_target_field.py | 31 +-
.../types/field_mapping_instance_response.py | 31 +-
.../types/field_permission_deserializer.py | 31 +-
.../field_permission_deserializer_request.py | 31 +-
src/merge/resources/hris/types/group.py | 46 +-
...ividual_common_model_scope_deserializer.py | 31 +-
...common_model_scope_deserializer_request.py | 31 +-
src/merge/resources/hris/types/issue.py | 32 +-
src/merge/resources/hris/types/link_token.py | 31 +-
.../hris/types/linked_account_status.py | 31 +-
src/merge/resources/hris/types/location.py | 56 +-
.../resources/hris/types/meta_response.py | 31 +-
.../resources/hris/types/model_operation.py | 31 +-
.../types/model_permission_deserializer.py | 31 +-
.../model_permission_deserializer_request.py | 31 +-
.../types/multipart_form_field_request.py | 41 +-
...inated_account_details_and_actions_list.py | 31 +-
.../types/paginated_audit_log_event_list.py | 31 +-
.../hris/types/paginated_bank_info_list.py | 31 +-
.../hris/types/paginated_benefit_list.py | 31 +-
.../hris/types/paginated_company_list.py | 31 +-
.../hris/types/paginated_dependent_list.py | 31 +-
.../hris/types/paginated_employee_list.py | 31 +-
.../paginated_employee_payroll_run_list.py | 31 +-
.../types/paginated_employer_benefit_list.py | 31 +-
.../hris/types/paginated_employment_list.py | 31 +-
.../hris/types/paginated_group_list.py | 31 +-
.../hris/types/paginated_issue_list.py | 31 +-
.../hris/types/paginated_location_list.py | 31 +-
.../hris/types/paginated_pay_group_list.py | 31 +-
.../hris/types/paginated_payroll_run_list.py | 31 +-
.../hris/types/paginated_sync_status_list.py | 31 +-
.../hris/types/paginated_team_list.py | 31 +-
.../types/paginated_time_off_balance_list.py | 31 +-
.../hris/types/paginated_time_off_list.py | 31 +-
.../types/paginated_timesheet_entry_list.py | 31 +-
src/merge/resources/hris/types/pay_group.py | 40 +-
src/merge/resources/hris/types/payroll_run.py | 48 +-
src/merge/resources/hris/types/remote_data.py | 31 +-
.../hris/types/remote_endpoint_info.py | 31 +-
.../resources/hris/types/remote_field_api.py | 35 +-
.../hris/types/remote_field_api_response.py | 69 +-
src/merge/resources/hris/types/remote_key.py | 31 +-
.../resources/hris/types/remote_response.py | 31 +-
src/merge/resources/hris/types/sync_status.py | 30 +-
src/merge/resources/hris/types/tax.py | 44 +-
src/merge/resources/hris/types/team.py | 44 +-
src/merge/resources/hris/types/time_off.py | 54 +-
.../resources/hris/types/time_off_balance.py | 46 +-
.../resources/hris/types/time_off_request.py | 48 +-
.../resources/hris/types/time_off_response.py | 31 +-
.../resources/hris/types/timesheet_entry.py | 46 +-
.../hris/types/timesheet_entry_request.py | 38 +-
.../hris/types/timesheet_entry_response.py | 31 +-
.../hris/types/validation_problem_source.py | 31 +-
.../hris/types/warning_validation_problem.py | 31 +-
.../resources/hris/types/webhook_receiver.py | 31 +-
.../resources/account_details/client.py | 20 +-
.../resources/account_token/client.py | 24 +-
.../ticketing/resources/accounts/client.py | 42 +-
.../resources/async_passthrough/client.py | 52 +-
.../ticketing/resources/attachments/client.py | 118 +-
.../ticketing/resources/audit_trail/client.py | 20 +-
.../resources/available_actions/client.py | 20 +-
.../ticketing/resources/collections/client.py | 64 +-
.../ticketing/resources/comments/client.py | 82 +-
.../ticketing/resources/contacts/client.py | 82 +-
.../resources/delete_account/client.py | 18 +-
.../resources/field_mapping/client.py | 132 +-
.../resources/force_resync/client.py | 20 +-
.../resources/generate_key/client.py | 24 +-
.../ticketing/resources/issues/client.py | 42 +-
.../ticketing/resources/link_token/client.py | 30 +-
.../resources/linked_accounts/client.py | 20 +-
.../ticketing/resources/passthrough/client.py | 30 +-
.../ticketing/resources/projects/client.py | 64 +-
.../resources/regenerate_key/client.py | 24 +-
.../ticketing/resources/roles/client.py | 42 +-
.../ticketing/resources/scopes/client.py | 100 +-
.../ticketing/resources/sync_status/client.py | 20 +-
.../ticketing/resources/tags/client.py | 42 +-
.../ticketing/resources/teams/client.py | 42 +-
.../ticketing/resources/tickets/client.py | 168 +-
.../ticketing/resources/users/client.py | 42 +-
.../resources/webhook_receivers/client.py | 44 +-
.../resources/ticketing/types/account.py | 42 +-
.../ticketing/types/account_details.py | 33 +-
.../types/account_details_and_actions.py | 35 +-
...account_details_and_actions_integration.py | 31 +-
.../ticketing/types/account_integration.py | 47 +-
.../ticketing/types/account_token.py | 31 +-
.../ticketing/types/advanced_metadata.py | 31 +-
.../types/async_passthrough_reciept.py | 31 +-
.../resources/ticketing/types/attachment.py | 50 +-
.../ticketing/types/attachment_request.py | 41 +-
.../ticketing/types/audit_log_event.py | 38 +-
.../ticketing/types/available_actions.py | 31 +-
.../resources/ticketing/types/collection.py | 50 +-
.../resources/ticketing/types/comment.py | 50 +-
.../ticketing/types/comment_request.py | 43 +-
.../ticketing/types/comment_response.py | 31 +-
.../ticketing/types/common_model_scope_api.py | 33 +-
.../types/common_model_scopes_body_request.py | 31 +-
.../resources/ticketing/types/contact.py | 48 +-
.../ticketing/types/contact_request.py | 41 +-
.../types/data_passthrough_request.py | 43 +-
.../ticketing/types/debug_mode_log.py | 31 +-
.../types/debug_model_log_summary.py | 31 +-
.../types/error_validation_problem.py | 31 +-
.../types/external_target_field_api.py | 31 +-
.../external_target_field_api_response.py | 59 +-
.../types/field_mapping_api_instance.py | 31 +-
...field_mapping_api_instance_remote_field.py | 35 +-
...tance_remote_field_remote_endpoint_info.py | 31 +-
.../field_mapping_api_instance_response.py | 59 +-
...field_mapping_api_instance_target_field.py | 31 +-
.../types/field_mapping_instance_response.py | 31 +-
.../types/field_permission_deserializer.py | 31 +-
.../field_permission_deserializer_request.py | 31 +-
...ividual_common_model_scope_deserializer.py | 31 +-
...common_model_scope_deserializer_request.py | 31 +-
src/merge/resources/ticketing/types/issue.py | 32 +-
.../resources/ticketing/types/item_schema.py | 31 +-
.../resources/ticketing/types/link_token.py | 31 +-
.../ticketing/types/linked_account_status.py | 31 +-
.../ticketing/types/meta_response.py | 31 +-
.../ticketing/types/model_operation.py | 31 +-
.../types/model_permission_deserializer.py | 31 +-
.../model_permission_deserializer_request.py | 31 +-
.../types/multipart_form_field_request.py | 41 +-
...inated_account_details_and_actions_list.py | 31 +-
.../ticketing/types/paginated_account_list.py | 31 +-
.../types/paginated_attachment_list.py | 31 +-
.../types/paginated_audit_log_event_list.py | 31 +-
.../types/paginated_collection_list.py | 31 +-
.../ticketing/types/paginated_comment_list.py | 31 +-
.../ticketing/types/paginated_contact_list.py | 31 +-
.../ticketing/types/paginated_issue_list.py | 31 +-
.../ticketing/types/paginated_project_list.py | 31 +-
.../paginated_remote_field_class_list.py | 31 +-
.../ticketing/types/paginated_role_list.py | 31 +-
.../types/paginated_sync_status_list.py | 31 +-
.../ticketing/types/paginated_tag_list.py | 31 +-
.../ticketing/types/paginated_team_list.py | 31 +-
.../ticketing/types/paginated_ticket_list.py | 31 +-
.../ticketing/types/paginated_user_list.py | 31 +-
.../ticketing/types/patched_ticket_request.py | 54 +-
.../resources/ticketing/types/project.py | 42 +-
.../resources/ticketing/types/remote_data.py | 31 +-
.../ticketing/types/remote_endpoint_info.py | 31 +-
.../resources/ticketing/types/remote_field.py | 31 +-
.../ticketing/types/remote_field_api.py | 35 +-
.../types/remote_field_api_response.py | 59 +-
.../ticketing/types/remote_field_class.py | 31 +-
.../remote_field_class_field_choices_item.py | 31 +-
.../ticketing/types/remote_field_request.py | 31 +-
.../resources/ticketing/types/remote_key.py | 31 +-
.../ticketing/types/remote_response.py | 31 +-
src/merge/resources/ticketing/types/role.py | 44 +-
.../resources/ticketing/types/sync_status.py | 30 +-
src/merge/resources/ticketing/types/tag.py | 40 +-
src/merge/resources/ticketing/types/team.py | 42 +-
src/merge/resources/ticketing/types/ticket.py | 66 +-
.../ticketing/types/ticket_request.py | 54 +-
.../ticketing/types/ticket_response.py | 31 +-
.../types/ticketing_attachment_response.py | 31 +-
.../types/ticketing_contact_response.py | 31 +-
src/merge/resources/ticketing/types/user.py | 46 +-
.../types/validation_problem_source.py | 31 +-
.../types/warning_validation_problem.py | 31 +-
.../ticketing/types/webhook_receiver.py | 31 +-
tests/utils/test_http_client.py | 47 +
tests/utils/test_query_encoding.py | 13 +
779 files changed, 58202 insertions(+), 16582 deletions(-)
create mode 100644 reference.md
create mode 100644 tests/utils/test_http_client.py
create mode 100644 tests/utils/test_query_encoding.py
diff --git a/poetry.lock b/poetry.lock
index a2577970..464f6035 100644
--- a/poetry.lock
+++ b/poetry.lock
@@ -38,13 +38,13 @@ trio = ["trio (>=0.23)"]
[[package]]
name = "certifi"
-version = "2024.6.2"
+version = "2024.7.4"
description = "Python package for providing Mozilla's CA Bundle."
optional = false
python-versions = ">=3.6"
files = [
- {file = "certifi-2024.6.2-py3-none-any.whl", hash = "sha256:ddc6c8ce995e6987e7faf5e3f1b02b302836a0e5d98ece18392cb1a36c72ad56"},
- {file = "certifi-2024.6.2.tar.gz", hash = "sha256:3cd43f1c6fa7dedc5899d69d3ad0398fd018ad1a17fba83ddaf78aa46c747516"},
+ {file = "certifi-2024.7.4-py3-none-any.whl", hash = "sha256:c198e21b1289c2ab85ee4e67bb4b4ef3ead0892059901a8d5b622f24a1101e90"},
+ {file = "certifi-2024.7.4.tar.gz", hash = "sha256:5a1e7645bc0ec61a09e26c36f6106dd4cf40c6db3a1fb6352b0244e7fb057c7b"},
]
[[package]]
@@ -60,13 +60,13 @@ files = [
[[package]]
name = "exceptiongroup"
-version = "1.2.1"
+version = "1.2.2"
description = "Backport of PEP 654 (exception groups)"
optional = false
python-versions = ">=3.7"
files = [
- {file = "exceptiongroup-1.2.1-py3-none-any.whl", hash = "sha256:5258b9ed329c5bbdd31a309f53cbfb0b155341807f6ff7606a1e801a891b29ad"},
- {file = "exceptiongroup-1.2.1.tar.gz", hash = "sha256:a4785e48b045528f5bfe627b6ad554ff32def154f42372786903b7abcfe1aa16"},
+ {file = "exceptiongroup-1.2.2-py3-none-any.whl", hash = "sha256:3111b9d131c238bec2f8f516e123e14ba243563fb135d3fe885990585aa7795b"},
+ {file = "exceptiongroup-1.2.2.tar.gz", hash = "sha256:47c2edf7c6738fafb49fd34290706d1a1a2f4d1c6df275526b62cbb4aa5393cc"},
]
[package.extras]
@@ -235,109 +235,122 @@ testing = ["pytest", "pytest-benchmark"]
[[package]]
name = "pydantic"
-version = "2.7.4"
+version = "2.8.2"
description = "Data validation using Python type hints"
optional = false
python-versions = ">=3.8"
files = [
- {file = "pydantic-2.7.4-py3-none-any.whl", hash = "sha256:ee8538d41ccb9c0a9ad3e0e5f07bf15ed8015b481ced539a1759d8cc89ae90d0"},
- {file = "pydantic-2.7.4.tar.gz", hash = "sha256:0c84efd9548d545f63ac0060c1e4d39bb9b14db8b3c0652338aecc07b5adec52"},
+ {file = "pydantic-2.8.2-py3-none-any.whl", hash = "sha256:73ee9fddd406dc318b885c7a2eab8a6472b68b8fb5ba8150949fc3db939f23c8"},
+ {file = "pydantic-2.8.2.tar.gz", hash = "sha256:6f62c13d067b0755ad1c21a34bdd06c0c12625a22b0fc09c6b149816604f7c2a"},
]
[package.dependencies]
annotated-types = ">=0.4.0"
-pydantic-core = "2.18.4"
-typing-extensions = ">=4.6.1"
+pydantic-core = "2.20.1"
+typing-extensions = [
+ {version = ">=4.12.2", markers = "python_version >= \"3.13\""},
+ {version = ">=4.6.1", markers = "python_version < \"3.13\""},
+]
[package.extras]
email = ["email-validator (>=2.0.0)"]
[[package]]
name = "pydantic-core"
-version = "2.18.4"
+version = "2.20.1"
description = "Core functionality for Pydantic validation and serialization"
optional = false
python-versions = ">=3.8"
files = [
- {file = "pydantic_core-2.18.4-cp310-cp310-macosx_10_12_x86_64.whl", hash = "sha256:f76d0ad001edd426b92233d45c746fd08f467d56100fd8f30e9ace4b005266e4"},
- {file = "pydantic_core-2.18.4-cp310-cp310-macosx_11_0_arm64.whl", hash = "sha256:59ff3e89f4eaf14050c8022011862df275b552caef8082e37b542b066ce1ff26"},
- {file = "pydantic_core-2.18.4-cp310-cp310-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:a55b5b16c839df1070bc113c1f7f94a0af4433fcfa1b41799ce7606e5c79ce0a"},
- {file = "pydantic_core-2.18.4-cp310-cp310-manylinux_2_17_armv7l.manylinux2014_armv7l.whl", hash = "sha256:4d0dcc59664fcb8974b356fe0a18a672d6d7cf9f54746c05f43275fc48636851"},
- {file = "pydantic_core-2.18.4-cp310-cp310-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:8951eee36c57cd128f779e641e21eb40bc5073eb28b2d23f33eb0ef14ffb3f5d"},
- {file = "pydantic_core-2.18.4-cp310-cp310-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:4701b19f7e3a06ea655513f7938de6f108123bf7c86bbebb1196eb9bd35cf724"},
- {file = "pydantic_core-2.18.4-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:e00a3f196329e08e43d99b79b286d60ce46bed10f2280d25a1718399457e06be"},
- {file = "pydantic_core-2.18.4-cp310-cp310-manylinux_2_5_i686.manylinux1_i686.whl", hash = "sha256:97736815b9cc893b2b7f663628e63f436018b75f44854c8027040e05230eeddb"},
- {file = "pydantic_core-2.18.4-cp310-cp310-musllinux_1_1_aarch64.whl", hash = "sha256:6891a2ae0e8692679c07728819b6e2b822fb30ca7445f67bbf6509b25a96332c"},
- {file = "pydantic_core-2.18.4-cp310-cp310-musllinux_1_1_x86_64.whl", hash = "sha256:bc4ff9805858bd54d1a20efff925ccd89c9d2e7cf4986144b30802bf78091c3e"},
- {file = "pydantic_core-2.18.4-cp310-none-win32.whl", hash = "sha256:1b4de2e51bbcb61fdebd0ab86ef28062704f62c82bbf4addc4e37fa4b00b7cbc"},
- {file = "pydantic_core-2.18.4-cp310-none-win_amd64.whl", hash = "sha256:6a750aec7bf431517a9fd78cb93c97b9b0c496090fee84a47a0d23668976b4b0"},
- {file = "pydantic_core-2.18.4-cp311-cp311-macosx_10_12_x86_64.whl", hash = "sha256:942ba11e7dfb66dc70f9ae66b33452f51ac7bb90676da39a7345e99ffb55402d"},
- {file = "pydantic_core-2.18.4-cp311-cp311-macosx_11_0_arm64.whl", hash = "sha256:b2ebef0e0b4454320274f5e83a41844c63438fdc874ea40a8b5b4ecb7693f1c4"},
- {file = "pydantic_core-2.18.4-cp311-cp311-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:a642295cd0c8df1b86fc3dced1d067874c353a188dc8e0f744626d49e9aa51c4"},
- {file = "pydantic_core-2.18.4-cp311-cp311-manylinux_2_17_armv7l.manylinux2014_armv7l.whl", hash = "sha256:5f09baa656c904807e832cf9cce799c6460c450c4ad80803517032da0cd062e2"},
- {file = "pydantic_core-2.18.4-cp311-cp311-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:98906207f29bc2c459ff64fa007afd10a8c8ac080f7e4d5beff4c97086a3dabd"},
- {file = "pydantic_core-2.18.4-cp311-cp311-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:19894b95aacfa98e7cb093cd7881a0c76f55731efad31073db4521e2b6ff5b7d"},
- {file = "pydantic_core-2.18.4-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:0fbbdc827fe5e42e4d196c746b890b3d72876bdbf160b0eafe9f0334525119c8"},
- {file = "pydantic_core-2.18.4-cp311-cp311-manylinux_2_5_i686.manylinux1_i686.whl", hash = "sha256:f85d05aa0918283cf29a30b547b4df2fbb56b45b135f9e35b6807cb28bc47951"},
- {file = "pydantic_core-2.18.4-cp311-cp311-musllinux_1_1_aarch64.whl", hash = "sha256:e85637bc8fe81ddb73fda9e56bab24560bdddfa98aa64f87aaa4e4b6730c23d2"},
- {file = "pydantic_core-2.18.4-cp311-cp311-musllinux_1_1_x86_64.whl", hash = "sha256:2f5966897e5461f818e136b8451d0551a2e77259eb0f73a837027b47dc95dab9"},
- {file = "pydantic_core-2.18.4-cp311-none-win32.whl", hash = "sha256:44c7486a4228413c317952e9d89598bcdfb06399735e49e0f8df643e1ccd0558"},
- {file = "pydantic_core-2.18.4-cp311-none-win_amd64.whl", hash = "sha256:8a7164fe2005d03c64fd3b85649891cd4953a8de53107940bf272500ba8a788b"},
- {file = "pydantic_core-2.18.4-cp311-none-win_arm64.whl", hash = "sha256:4e99bc050fe65c450344421017f98298a97cefc18c53bb2f7b3531eb39bc7805"},
- {file = "pydantic_core-2.18.4-cp312-cp312-macosx_10_12_x86_64.whl", hash = "sha256:6f5c4d41b2771c730ea1c34e458e781b18cc668d194958e0112455fff4e402b2"},
- {file = "pydantic_core-2.18.4-cp312-cp312-macosx_11_0_arm64.whl", hash = "sha256:2fdf2156aa3d017fddf8aea5adfba9f777db1d6022d392b682d2a8329e087cef"},
- {file = "pydantic_core-2.18.4-cp312-cp312-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:4748321b5078216070b151d5271ef3e7cc905ab170bbfd27d5c83ee3ec436695"},
- {file = "pydantic_core-2.18.4-cp312-cp312-manylinux_2_17_armv7l.manylinux2014_armv7l.whl", hash = "sha256:847a35c4d58721c5dc3dba599878ebbdfd96784f3fb8bb2c356e123bdcd73f34"},
- {file = "pydantic_core-2.18.4-cp312-cp312-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:3c40d4eaad41f78e3bbda31b89edc46a3f3dc6e171bf0ecf097ff7a0ffff7cb1"},
- {file = "pydantic_core-2.18.4-cp312-cp312-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:21a5e440dbe315ab9825fcd459b8814bb92b27c974cbc23c3e8baa2b76890077"},
- {file = "pydantic_core-2.18.4-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:01dd777215e2aa86dfd664daed5957704b769e726626393438f9c87690ce78c3"},
- {file = "pydantic_core-2.18.4-cp312-cp312-manylinux_2_5_i686.manylinux1_i686.whl", hash = "sha256:4b06beb3b3f1479d32befd1f3079cc47b34fa2da62457cdf6c963393340b56e9"},
- {file = "pydantic_core-2.18.4-cp312-cp312-musllinux_1_1_aarch64.whl", hash = "sha256:564d7922e4b13a16b98772441879fcdcbe82ff50daa622d681dd682175ea918c"},
- {file = "pydantic_core-2.18.4-cp312-cp312-musllinux_1_1_x86_64.whl", hash = "sha256:0eb2a4f660fcd8e2b1c90ad566db2b98d7f3f4717c64fe0a83e0adb39766d5b8"},
- {file = "pydantic_core-2.18.4-cp312-none-win32.whl", hash = "sha256:8b8bab4c97248095ae0c4455b5a1cd1cdd96e4e4769306ab19dda135ea4cdb07"},
- {file = "pydantic_core-2.18.4-cp312-none-win_amd64.whl", hash = "sha256:14601cdb733d741b8958224030e2bfe21a4a881fb3dd6fbb21f071cabd48fa0a"},
- {file = "pydantic_core-2.18.4-cp312-none-win_arm64.whl", hash = "sha256:c1322d7dd74713dcc157a2b7898a564ab091ca6c58302d5c7b4c07296e3fd00f"},
- {file = "pydantic_core-2.18.4-cp38-cp38-macosx_10_12_x86_64.whl", hash = "sha256:823be1deb01793da05ecb0484d6c9e20baebb39bd42b5d72636ae9cf8350dbd2"},
- {file = "pydantic_core-2.18.4-cp38-cp38-macosx_11_0_arm64.whl", hash = "sha256:ebef0dd9bf9b812bf75bda96743f2a6c5734a02092ae7f721c048d156d5fabae"},
- {file = "pydantic_core-2.18.4-cp38-cp38-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:ae1d6df168efb88d7d522664693607b80b4080be6750c913eefb77e34c12c71a"},
- {file = "pydantic_core-2.18.4-cp38-cp38-manylinux_2_17_armv7l.manylinux2014_armv7l.whl", hash = "sha256:f9899c94762343f2cc2fc64c13e7cae4c3cc65cdfc87dd810a31654c9b7358cc"},
- {file = "pydantic_core-2.18.4-cp38-cp38-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:99457f184ad90235cfe8461c4d70ab7dd2680e28821c29eca00252ba90308c78"},
- {file = "pydantic_core-2.18.4-cp38-cp38-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:18f469a3d2a2fdafe99296a87e8a4c37748b5080a26b806a707f25a902c040a8"},
- {file = "pydantic_core-2.18.4-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:b7cdf28938ac6b8b49ae5e92f2735056a7ba99c9b110a474473fd71185c1af5d"},
- {file = "pydantic_core-2.18.4-cp38-cp38-manylinux_2_5_i686.manylinux1_i686.whl", hash = "sha256:938cb21650855054dc54dfd9120a851c974f95450f00683399006aa6e8abb057"},
- {file = "pydantic_core-2.18.4-cp38-cp38-musllinux_1_1_aarch64.whl", hash = "sha256:44cd83ab6a51da80fb5adbd9560e26018e2ac7826f9626bc06ca3dc074cd198b"},
- {file = "pydantic_core-2.18.4-cp38-cp38-musllinux_1_1_x86_64.whl", hash = "sha256:972658f4a72d02b8abfa2581d92d59f59897d2e9f7e708fdabe922f9087773af"},
- {file = "pydantic_core-2.18.4-cp38-none-win32.whl", hash = "sha256:1d886dc848e60cb7666f771e406acae54ab279b9f1e4143babc9c2258213daa2"},
- {file = "pydantic_core-2.18.4-cp38-none-win_amd64.whl", hash = "sha256:bb4462bd43c2460774914b8525f79b00f8f407c945d50881568f294c1d9b4443"},
- {file = "pydantic_core-2.18.4-cp39-cp39-macosx_10_12_x86_64.whl", hash = "sha256:44a688331d4a4e2129140a8118479443bd6f1905231138971372fcde37e43528"},
- {file = "pydantic_core-2.18.4-cp39-cp39-macosx_11_0_arm64.whl", hash = "sha256:a2fdd81edd64342c85ac7cf2753ccae0b79bf2dfa063785503cb85a7d3593223"},
- {file = "pydantic_core-2.18.4-cp39-cp39-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:86110d7e1907ab36691f80b33eb2da87d780f4739ae773e5fc83fb272f88825f"},
- {file = "pydantic_core-2.18.4-cp39-cp39-manylinux_2_17_armv7l.manylinux2014_armv7l.whl", hash = "sha256:46387e38bd641b3ee5ce247563b60c5ca098da9c56c75c157a05eaa0933ed154"},
- {file = "pydantic_core-2.18.4-cp39-cp39-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:123c3cec203e3f5ac7b000bd82235f1a3eced8665b63d18be751f115588fea30"},
- {file = "pydantic_core-2.18.4-cp39-cp39-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:dc1803ac5c32ec324c5261c7209e8f8ce88e83254c4e1aebdc8b0a39f9ddb443"},
- {file = "pydantic_core-2.18.4-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:53db086f9f6ab2b4061958d9c276d1dbe3690e8dd727d6abf2321d6cce37fa94"},
- {file = "pydantic_core-2.18.4-cp39-cp39-manylinux_2_5_i686.manylinux1_i686.whl", hash = "sha256:abc267fa9837245cc28ea6929f19fa335f3dc330a35d2e45509b6566dc18be23"},
- {file = "pydantic_core-2.18.4-cp39-cp39-musllinux_1_1_aarch64.whl", hash = "sha256:a0d829524aaefdebccb869eed855e2d04c21d2d7479b6cada7ace5448416597b"},
- {file = "pydantic_core-2.18.4-cp39-cp39-musllinux_1_1_x86_64.whl", hash = "sha256:509daade3b8649f80d4e5ff21aa5673e4ebe58590b25fe42fac5f0f52c6f034a"},
- {file = "pydantic_core-2.18.4-cp39-none-win32.whl", hash = "sha256:ca26a1e73c48cfc54c4a76ff78df3727b9d9f4ccc8dbee4ae3f73306a591676d"},
- {file = "pydantic_core-2.18.4-cp39-none-win_amd64.whl", hash = "sha256:c67598100338d5d985db1b3d21f3619ef392e185e71b8d52bceacc4a7771ea7e"},
- {file = "pydantic_core-2.18.4-pp310-pypy310_pp73-macosx_10_12_x86_64.whl", hash = "sha256:574d92eac874f7f4db0ca653514d823a0d22e2354359d0759e3f6a406db5d55d"},
- {file = "pydantic_core-2.18.4-pp310-pypy310_pp73-macosx_11_0_arm64.whl", hash = "sha256:1f4d26ceb5eb9eed4af91bebeae4b06c3fb28966ca3a8fb765208cf6b51102ab"},
- {file = "pydantic_core-2.18.4-pp310-pypy310_pp73-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:77450e6d20016ec41f43ca4a6c63e9fdde03f0ae3fe90e7c27bdbeaece8b1ed4"},
- {file = "pydantic_core-2.18.4-pp310-pypy310_pp73-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:d323a01da91851a4f17bf592faf46149c9169d68430b3146dcba2bb5e5719abc"},
- {file = "pydantic_core-2.18.4-pp310-pypy310_pp73-manylinux_2_5_i686.manylinux1_i686.whl", hash = "sha256:43d447dd2ae072a0065389092a231283f62d960030ecd27565672bd40746c507"},
- {file = "pydantic_core-2.18.4-pp310-pypy310_pp73-musllinux_1_1_aarch64.whl", hash = "sha256:578e24f761f3b425834f297b9935e1ce2e30f51400964ce4801002435a1b41ef"},
- {file = "pydantic_core-2.18.4-pp310-pypy310_pp73-musllinux_1_1_x86_64.whl", hash = "sha256:81b5efb2f126454586d0f40c4d834010979cb80785173d1586df845a632e4e6d"},
- {file = "pydantic_core-2.18.4-pp310-pypy310_pp73-win_amd64.whl", hash = "sha256:ab86ce7c8f9bea87b9d12c7f0af71102acbf5ecbc66c17796cff45dae54ef9a5"},
- {file = "pydantic_core-2.18.4-pp39-pypy39_pp73-macosx_10_12_x86_64.whl", hash = "sha256:90afc12421df2b1b4dcc975f814e21bc1754640d502a2fbcc6d41e77af5ec312"},
- {file = "pydantic_core-2.18.4-pp39-pypy39_pp73-macosx_11_0_arm64.whl", hash = "sha256:51991a89639a912c17bef4b45c87bd83593aee0437d8102556af4885811d59f5"},
- {file = "pydantic_core-2.18.4-pp39-pypy39_pp73-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:293afe532740370aba8c060882f7d26cfd00c94cae32fd2e212a3a6e3b7bc15e"},
- {file = "pydantic_core-2.18.4-pp39-pypy39_pp73-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:b48ece5bde2e768197a2d0f6e925f9d7e3e826f0ad2271120f8144a9db18d5c8"},
- {file = "pydantic_core-2.18.4-pp39-pypy39_pp73-manylinux_2_5_i686.manylinux1_i686.whl", hash = "sha256:eae237477a873ab46e8dd748e515c72c0c804fb380fbe6c85533c7de51f23a8f"},
- {file = "pydantic_core-2.18.4-pp39-pypy39_pp73-musllinux_1_1_aarch64.whl", hash = "sha256:834b5230b5dfc0c1ec37b2fda433b271cbbc0e507560b5d1588e2cc1148cf1ce"},
- {file = "pydantic_core-2.18.4-pp39-pypy39_pp73-musllinux_1_1_x86_64.whl", hash = "sha256:e858ac0a25074ba4bce653f9b5d0a85b7456eaddadc0ce82d3878c22489fa4ee"},
- {file = "pydantic_core-2.18.4-pp39-pypy39_pp73-win_amd64.whl", hash = "sha256:2fd41f6eff4c20778d717af1cc50eca52f5afe7805ee530a4fbd0bae284f16e9"},
- {file = "pydantic_core-2.18.4.tar.gz", hash = "sha256:ec3beeada09ff865c344ff3bc2f427f5e6c26401cc6113d77e372c3fdac73864"},
+ {file = "pydantic_core-2.20.1-cp310-cp310-macosx_10_12_x86_64.whl", hash = "sha256:3acae97ffd19bf091c72df4d726d552c473f3576409b2a7ca36b2f535ffff4a3"},
+ {file = "pydantic_core-2.20.1-cp310-cp310-macosx_11_0_arm64.whl", hash = "sha256:41f4c96227a67a013e7de5ff8f20fb496ce573893b7f4f2707d065907bffdbd6"},
+ {file = "pydantic_core-2.20.1-cp310-cp310-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:5f239eb799a2081495ea659d8d4a43a8f42cd1fe9ff2e7e436295c38a10c286a"},
+ {file = "pydantic_core-2.20.1-cp310-cp310-manylinux_2_17_armv7l.manylinux2014_armv7l.whl", hash = "sha256:53e431da3fc53360db73eedf6f7124d1076e1b4ee4276b36fb25514544ceb4a3"},
+ {file = "pydantic_core-2.20.1-cp310-cp310-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:f1f62b2413c3a0e846c3b838b2ecd6c7a19ec6793b2a522745b0869e37ab5bc1"},
+ {file = "pydantic_core-2.20.1-cp310-cp310-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:5d41e6daee2813ecceea8eda38062d69e280b39df793f5a942fa515b8ed67953"},
+ {file = "pydantic_core-2.20.1-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:3d482efec8b7dc6bfaedc0f166b2ce349df0011f5d2f1f25537ced4cfc34fd98"},
+ {file = "pydantic_core-2.20.1-cp310-cp310-manylinux_2_5_i686.manylinux1_i686.whl", hash = "sha256:e93e1a4b4b33daed65d781a57a522ff153dcf748dee70b40c7258c5861e1768a"},
+ {file = "pydantic_core-2.20.1-cp310-cp310-musllinux_1_1_aarch64.whl", hash = "sha256:e7c4ea22b6739b162c9ecaaa41d718dfad48a244909fe7ef4b54c0b530effc5a"},
+ {file = "pydantic_core-2.20.1-cp310-cp310-musllinux_1_1_x86_64.whl", hash = "sha256:4f2790949cf385d985a31984907fecb3896999329103df4e4983a4a41e13e840"},
+ {file = "pydantic_core-2.20.1-cp310-none-win32.whl", hash = "sha256:5e999ba8dd90e93d57410c5e67ebb67ffcaadcea0ad973240fdfd3a135506250"},
+ {file = "pydantic_core-2.20.1-cp310-none-win_amd64.whl", hash = "sha256:512ecfbefef6dac7bc5eaaf46177b2de58cdf7acac8793fe033b24ece0b9566c"},
+ {file = "pydantic_core-2.20.1-cp311-cp311-macosx_10_12_x86_64.whl", hash = "sha256:d2a8fa9d6d6f891f3deec72f5cc668e6f66b188ab14bb1ab52422fe8e644f312"},
+ {file = "pydantic_core-2.20.1-cp311-cp311-macosx_11_0_arm64.whl", hash = "sha256:175873691124f3d0da55aeea1d90660a6ea7a3cfea137c38afa0a5ffabe37b88"},
+ {file = "pydantic_core-2.20.1-cp311-cp311-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:37eee5b638f0e0dcd18d21f59b679686bbd18917b87db0193ae36f9c23c355fc"},
+ {file = "pydantic_core-2.20.1-cp311-cp311-manylinux_2_17_armv7l.manylinux2014_armv7l.whl", hash = "sha256:25e9185e2d06c16ee438ed39bf62935ec436474a6ac4f9358524220f1b236e43"},
+ {file = "pydantic_core-2.20.1-cp311-cp311-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:150906b40ff188a3260cbee25380e7494ee85048584998c1e66df0c7a11c17a6"},
+ {file = "pydantic_core-2.20.1-cp311-cp311-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:8ad4aeb3e9a97286573c03df758fc7627aecdd02f1da04516a86dc159bf70121"},
+ {file = "pydantic_core-2.20.1-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:d3f3ed29cd9f978c604708511a1f9c2fdcb6c38b9aae36a51905b8811ee5cbf1"},
+ {file = "pydantic_core-2.20.1-cp311-cp311-manylinux_2_5_i686.manylinux1_i686.whl", hash = "sha256:b0dae11d8f5ded51699c74d9548dcc5938e0804cc8298ec0aa0da95c21fff57b"},
+ {file = "pydantic_core-2.20.1-cp311-cp311-musllinux_1_1_aarch64.whl", hash = "sha256:faa6b09ee09433b87992fb5a2859efd1c264ddc37280d2dd5db502126d0e7f27"},
+ {file = "pydantic_core-2.20.1-cp311-cp311-musllinux_1_1_x86_64.whl", hash = "sha256:9dc1b507c12eb0481d071f3c1808f0529ad41dc415d0ca11f7ebfc666e66a18b"},
+ {file = "pydantic_core-2.20.1-cp311-none-win32.whl", hash = "sha256:fa2fddcb7107e0d1808086ca306dcade7df60a13a6c347a7acf1ec139aa6789a"},
+ {file = "pydantic_core-2.20.1-cp311-none-win_amd64.whl", hash = "sha256:40a783fb7ee353c50bd3853e626f15677ea527ae556429453685ae32280c19c2"},
+ {file = "pydantic_core-2.20.1-cp312-cp312-macosx_10_12_x86_64.whl", hash = "sha256:595ba5be69b35777474fa07f80fc260ea71255656191adb22a8c53aba4479231"},
+ {file = "pydantic_core-2.20.1-cp312-cp312-macosx_11_0_arm64.whl", hash = "sha256:a4f55095ad087474999ee28d3398bae183a66be4823f753cd7d67dd0153427c9"},
+ {file = "pydantic_core-2.20.1-cp312-cp312-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:f9aa05d09ecf4c75157197f27cdc9cfaeb7c5f15021c6373932bf3e124af029f"},
+ {file = "pydantic_core-2.20.1-cp312-cp312-manylinux_2_17_armv7l.manylinux2014_armv7l.whl", hash = "sha256:e97fdf088d4b31ff4ba35db26d9cc472ac7ef4a2ff2badeabf8d727b3377fc52"},
+ {file = "pydantic_core-2.20.1-cp312-cp312-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:bc633a9fe1eb87e250b5c57d389cf28998e4292336926b0b6cdaee353f89a237"},
+ {file = "pydantic_core-2.20.1-cp312-cp312-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:d573faf8eb7e6b1cbbcb4f5b247c60ca8be39fe2c674495df0eb4318303137fe"},
+ {file = "pydantic_core-2.20.1-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:26dc97754b57d2fd00ac2b24dfa341abffc380b823211994c4efac7f13b9e90e"},
+ {file = "pydantic_core-2.20.1-cp312-cp312-manylinux_2_5_i686.manylinux1_i686.whl", hash = "sha256:33499e85e739a4b60c9dac710c20a08dc73cb3240c9a0e22325e671b27b70d24"},
+ {file = "pydantic_core-2.20.1-cp312-cp312-musllinux_1_1_aarch64.whl", hash = "sha256:bebb4d6715c814597f85297c332297c6ce81e29436125ca59d1159b07f423eb1"},
+ {file = "pydantic_core-2.20.1-cp312-cp312-musllinux_1_1_x86_64.whl", hash = "sha256:516d9227919612425c8ef1c9b869bbbee249bc91912c8aaffb66116c0b447ebd"},
+ {file = "pydantic_core-2.20.1-cp312-none-win32.whl", hash = "sha256:469f29f9093c9d834432034d33f5fe45699e664f12a13bf38c04967ce233d688"},
+ {file = "pydantic_core-2.20.1-cp312-none-win_amd64.whl", hash = "sha256:035ede2e16da7281041f0e626459bcae33ed998cca6a0a007a5ebb73414ac72d"},
+ {file = "pydantic_core-2.20.1-cp313-cp313-macosx_10_12_x86_64.whl", hash = "sha256:0827505a5c87e8aa285dc31e9ec7f4a17c81a813d45f70b1d9164e03a813a686"},
+ {file = "pydantic_core-2.20.1-cp313-cp313-macosx_11_0_arm64.whl", hash = "sha256:19c0fa39fa154e7e0b7f82f88ef85faa2a4c23cc65aae2f5aea625e3c13c735a"},
+ {file = "pydantic_core-2.20.1-cp313-cp313-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:4aa223cd1e36b642092c326d694d8bf59b71ddddc94cdb752bbbb1c5c91d833b"},
+ {file = "pydantic_core-2.20.1-cp313-cp313-manylinux_2_17_armv7l.manylinux2014_armv7l.whl", hash = "sha256:c336a6d235522a62fef872c6295a42ecb0c4e1d0f1a3e500fe949415761b8a19"},
+ {file = "pydantic_core-2.20.1-cp313-cp313-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:7eb6a0587eded33aeefea9f916899d42b1799b7b14b8f8ff2753c0ac1741edac"},
+ {file = "pydantic_core-2.20.1-cp313-cp313-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:70c8daf4faca8da5a6d655f9af86faf6ec2e1768f4b8b9d0226c02f3d6209703"},
+ {file = "pydantic_core-2.20.1-cp313-cp313-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:e9fa4c9bf273ca41f940bceb86922a7667cd5bf90e95dbb157cbb8441008482c"},
+ {file = "pydantic_core-2.20.1-cp313-cp313-manylinux_2_5_i686.manylinux1_i686.whl", hash = "sha256:11b71d67b4725e7e2a9f6e9c0ac1239bbc0c48cce3dc59f98635efc57d6dac83"},
+ {file = "pydantic_core-2.20.1-cp313-cp313-musllinux_1_1_aarch64.whl", hash = "sha256:270755f15174fb983890c49881e93f8f1b80f0b5e3a3cc1394a255706cabd203"},
+ {file = "pydantic_core-2.20.1-cp313-cp313-musllinux_1_1_x86_64.whl", hash = "sha256:c81131869240e3e568916ef4c307f8b99583efaa60a8112ef27a366eefba8ef0"},
+ {file = "pydantic_core-2.20.1-cp313-none-win32.whl", hash = "sha256:b91ced227c41aa29c672814f50dbb05ec93536abf8f43cd14ec9521ea09afe4e"},
+ {file = "pydantic_core-2.20.1-cp313-none-win_amd64.whl", hash = "sha256:65db0f2eefcaad1a3950f498aabb4875c8890438bc80b19362cf633b87a8ab20"},
+ {file = "pydantic_core-2.20.1-cp38-cp38-macosx_10_12_x86_64.whl", hash = "sha256:4745f4ac52cc6686390c40eaa01d48b18997cb130833154801a442323cc78f91"},
+ {file = "pydantic_core-2.20.1-cp38-cp38-macosx_11_0_arm64.whl", hash = "sha256:a8ad4c766d3f33ba8fd692f9aa297c9058970530a32c728a2c4bfd2616d3358b"},
+ {file = "pydantic_core-2.20.1-cp38-cp38-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:41e81317dd6a0127cabce83c0c9c3fbecceae981c8391e6f1dec88a77c8a569a"},
+ {file = "pydantic_core-2.20.1-cp38-cp38-manylinux_2_17_armv7l.manylinux2014_armv7l.whl", hash = "sha256:04024d270cf63f586ad41fff13fde4311c4fc13ea74676962c876d9577bcc78f"},
+ {file = "pydantic_core-2.20.1-cp38-cp38-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:eaad4ff2de1c3823fddf82f41121bdf453d922e9a238642b1dedb33c4e4f98ad"},
+ {file = "pydantic_core-2.20.1-cp38-cp38-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:26ab812fa0c845df815e506be30337e2df27e88399b985d0bb4e3ecfe72df31c"},
+ {file = "pydantic_core-2.20.1-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:3c5ebac750d9d5f2706654c638c041635c385596caf68f81342011ddfa1e5598"},
+ {file = "pydantic_core-2.20.1-cp38-cp38-manylinux_2_5_i686.manylinux1_i686.whl", hash = "sha256:2aafc5a503855ea5885559eae883978c9b6d8c8993d67766ee73d82e841300dd"},
+ {file = "pydantic_core-2.20.1-cp38-cp38-musllinux_1_1_aarch64.whl", hash = "sha256:4868f6bd7c9d98904b748a2653031fc9c2f85b6237009d475b1008bfaeb0a5aa"},
+ {file = "pydantic_core-2.20.1-cp38-cp38-musllinux_1_1_x86_64.whl", hash = "sha256:aa2f457b4af386254372dfa78a2eda2563680d982422641a85f271c859df1987"},
+ {file = "pydantic_core-2.20.1-cp38-none-win32.whl", hash = "sha256:225b67a1f6d602de0ce7f6c1c3ae89a4aa25d3de9be857999e9124f15dab486a"},
+ {file = "pydantic_core-2.20.1-cp38-none-win_amd64.whl", hash = "sha256:6b507132dcfc0dea440cce23ee2182c0ce7aba7054576efc65634f080dbe9434"},
+ {file = "pydantic_core-2.20.1-cp39-cp39-macosx_10_12_x86_64.whl", hash = "sha256:b03f7941783b4c4a26051846dea594628b38f6940a2fdc0df00b221aed39314c"},
+ {file = "pydantic_core-2.20.1-cp39-cp39-macosx_11_0_arm64.whl", hash = "sha256:1eedfeb6089ed3fad42e81a67755846ad4dcc14d73698c120a82e4ccf0f1f9f6"},
+ {file = "pydantic_core-2.20.1-cp39-cp39-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:635fee4e041ab9c479e31edda27fcf966ea9614fff1317e280d99eb3e5ab6fe2"},
+ {file = "pydantic_core-2.20.1-cp39-cp39-manylinux_2_17_armv7l.manylinux2014_armv7l.whl", hash = "sha256:77bf3ac639c1ff567ae3b47f8d4cc3dc20f9966a2a6dd2311dcc055d3d04fb8a"},
+ {file = "pydantic_core-2.20.1-cp39-cp39-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:7ed1b0132f24beeec5a78b67d9388656d03e6a7c837394f99257e2d55b461611"},
+ {file = "pydantic_core-2.20.1-cp39-cp39-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:c6514f963b023aeee506678a1cf821fe31159b925c4b76fe2afa94cc70b3222b"},
+ {file = "pydantic_core-2.20.1-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:10d4204d8ca33146e761c79f83cc861df20e7ae9f6487ca290a97702daf56006"},
+ {file = "pydantic_core-2.20.1-cp39-cp39-manylinux_2_5_i686.manylinux1_i686.whl", hash = "sha256:2d036c7187b9422ae5b262badb87a20a49eb6c5238b2004e96d4da1231badef1"},
+ {file = "pydantic_core-2.20.1-cp39-cp39-musllinux_1_1_aarch64.whl", hash = "sha256:9ebfef07dbe1d93efb94b4700f2d278494e9162565a54f124c404a5656d7ff09"},
+ {file = "pydantic_core-2.20.1-cp39-cp39-musllinux_1_1_x86_64.whl", hash = "sha256:6b9d9bb600328a1ce523ab4f454859e9d439150abb0906c5a1983c146580ebab"},
+ {file = "pydantic_core-2.20.1-cp39-none-win32.whl", hash = "sha256:784c1214cb6dd1e3b15dd8b91b9a53852aed16671cc3fbe4786f4f1db07089e2"},
+ {file = "pydantic_core-2.20.1-cp39-none-win_amd64.whl", hash = "sha256:d2fe69c5434391727efa54b47a1e7986bb0186e72a41b203df8f5b0a19a4f669"},
+ {file = "pydantic_core-2.20.1-pp310-pypy310_pp73-macosx_10_12_x86_64.whl", hash = "sha256:a45f84b09ac9c3d35dfcf6a27fd0634d30d183205230a0ebe8373a0e8cfa0906"},
+ {file = "pydantic_core-2.20.1-pp310-pypy310_pp73-macosx_11_0_arm64.whl", hash = "sha256:d02a72df14dfdbaf228424573a07af10637bd490f0901cee872c4f434a735b94"},
+ {file = "pydantic_core-2.20.1-pp310-pypy310_pp73-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:d2b27e6af28f07e2f195552b37d7d66b150adbaa39a6d327766ffd695799780f"},
+ {file = "pydantic_core-2.20.1-pp310-pypy310_pp73-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:084659fac3c83fd674596612aeff6041a18402f1e1bc19ca39e417d554468482"},
+ {file = "pydantic_core-2.20.1-pp310-pypy310_pp73-manylinux_2_5_i686.manylinux1_i686.whl", hash = "sha256:242b8feb3c493ab78be289c034a1f659e8826e2233786e36f2893a950a719bb6"},
+ {file = "pydantic_core-2.20.1-pp310-pypy310_pp73-musllinux_1_1_aarch64.whl", hash = "sha256:38cf1c40a921d05c5edc61a785c0ddb4bed67827069f535d794ce6bcded919fc"},
+ {file = "pydantic_core-2.20.1-pp310-pypy310_pp73-musllinux_1_1_x86_64.whl", hash = "sha256:e0bbdd76ce9aa5d4209d65f2b27fc6e5ef1312ae6c5333c26db3f5ade53a1e99"},
+ {file = "pydantic_core-2.20.1-pp310-pypy310_pp73-win_amd64.whl", hash = "sha256:254ec27fdb5b1ee60684f91683be95e5133c994cc54e86a0b0963afa25c8f8a6"},
+ {file = "pydantic_core-2.20.1-pp39-pypy39_pp73-macosx_10_12_x86_64.whl", hash = "sha256:407653af5617f0757261ae249d3fba09504d7a71ab36ac057c938572d1bc9331"},
+ {file = "pydantic_core-2.20.1-pp39-pypy39_pp73-macosx_11_0_arm64.whl", hash = "sha256:c693e916709c2465b02ca0ad7b387c4f8423d1db7b4649c551f27a529181c5ad"},
+ {file = "pydantic_core-2.20.1-pp39-pypy39_pp73-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:5b5ff4911aea936a47d9376fd3ab17e970cc543d1b68921886e7f64bd28308d1"},
+ {file = "pydantic_core-2.20.1-pp39-pypy39_pp73-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:177f55a886d74f1808763976ac4efd29b7ed15c69f4d838bbd74d9d09cf6fa86"},
+ {file = "pydantic_core-2.20.1-pp39-pypy39_pp73-manylinux_2_5_i686.manylinux1_i686.whl", hash = "sha256:964faa8a861d2664f0c7ab0c181af0bea66098b1919439815ca8803ef136fc4e"},
+ {file = "pydantic_core-2.20.1-pp39-pypy39_pp73-musllinux_1_1_aarch64.whl", hash = "sha256:4dd484681c15e6b9a977c785a345d3e378d72678fd5f1f3c0509608da24f2ac0"},
+ {file = "pydantic_core-2.20.1-pp39-pypy39_pp73-musllinux_1_1_x86_64.whl", hash = "sha256:f6d6cff3538391e8486a431569b77921adfcdef14eb18fbf19b7c0a5294d4e6a"},
+ {file = "pydantic_core-2.20.1-pp39-pypy39_pp73-win_amd64.whl", hash = "sha256:a6d511cc297ff0883bc3708b465ff82d7560193169a8b93260f74ecb0a5e08a7"},
+ {file = "pydantic_core-2.20.1.tar.gz", hash = "sha256:26ca695eeee5f9f1aeeb211ffc12f10bcb6f71e2989988fda61dabd65db878d4"},
]
[package.dependencies]
@@ -367,13 +380,13 @@ testing = ["argcomplete", "attrs (>=19.2.0)", "hypothesis (>=3.56)", "mock", "no
[[package]]
name = "pytest-asyncio"
-version = "0.23.7"
+version = "0.23.8"
description = "Pytest support for asyncio"
optional = false
python-versions = ">=3.8"
files = [
- {file = "pytest_asyncio-0.23.7-py3-none-any.whl", hash = "sha256:009b48127fbe44518a547bddd25611551b0e43ccdbf1e67d12479f569832c20b"},
- {file = "pytest_asyncio-0.23.7.tar.gz", hash = "sha256:5f5c72948f4c49e7db4f29f2521d4031f1c27f86e57b046126654083d4770268"},
+ {file = "pytest_asyncio-0.23.8-py3-none-any.whl", hash = "sha256:50265d892689a5faefb84df80819d1ecef566eb3549cf915dfb33569359d1ce2"},
+ {file = "pytest_asyncio-0.23.8.tar.gz", hash = "sha256:759b10b33a6dc61cce40a8bd5205e302978bbbcc00e279a8b61d9a6a3c82e4d3"},
]
[package.dependencies]
@@ -455,4 +468,4 @@ files = [
[metadata]
lock-version = "2.0"
python-versions = "^3.8"
-content-hash = "7fa2085bd251148908cf9a89f13b158fe85ccb037bb44614ae5f150ceecee53c"
+content-hash = "547951903d3bbcefb041f1f3a6ef8d5414ee7c6d96c5131d6197bfc91bc6229a"
diff --git a/pyproject.toml b/pyproject.toml
index 1b7203e3..43dd38c6 100644
--- a/pyproject.toml
+++ b/pyproject.toml
@@ -1,6 +1,6 @@
[tool.poetry]
name = "MergePythonClient"
-version = "1.0.12"
+version = "1.1.0rc0"
description = ""
readme = "README.md"
authors = []
@@ -34,6 +34,7 @@ Repository = 'https://github.com/merge-api/merge-python-client'
python = "^3.8"
httpx = ">=0.21.2"
pydantic = ">= 1.9.2"
+pydantic-core = "^2.18.2"
typing_extensions = ">= 4.0.0"
[tool.poetry.dev-dependencies]
diff --git a/reference.md b/reference.md
new file mode 100644
index 00000000..a9958fd8
--- /dev/null
+++ b/reference.md
@@ -0,0 +1,43086 @@
+# Reference
+## Filestorage AccountDetails
+client.filestorage.account_details.retrieve()
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Get details for a linked account.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.filestorage.account_details.retrieve()
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.filestorage.account_token.retrieve(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns the account token for the end user with the provided public token.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.filestorage.account_token.retrieve(
+ public_token="public_token",
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**public_token:** `str`
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.filestorage.async_passthrough.create(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Asynchronously pull data from an endpoint not currently supported by Merge.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+from merge.resources.filestorage import DataPassthroughRequest, MethodEnum
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.filestorage.async_passthrough.create(
+ request=DataPassthroughRequest(
+ method=MethodEnum.GET,
+ path="/scooters",
+ ),
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request:** `DataPassthroughRequest`
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.filestorage.async_passthrough.retrieve(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Retrieves data from earlier async-passthrough POST request
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.filestorage.async_passthrough.retrieve(
+ async_passthrough_receipt_id="async_passthrough_receipt_id",
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**async_passthrough_receipt_id:** `str`
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.filestorage.audit_trail.list(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Gets a list of audit trail events.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.filestorage.audit_trail.list()
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**cursor:** `typing.Optional[str]` — The pagination cursor value.
+
+
+
+
+
+-
+
+**end_date:** `typing.Optional[str]` — If included, will only include audit trail events that occurred before this time
+
+
+
+
+
+-
+
+**event_type:** `typing.Optional[str]` — If included, will only include events with the given event type. Possible values include: `CREATED_REMOTE_PRODUCTION_API_KEY`, `DELETED_REMOTE_PRODUCTION_API_KEY`, `CREATED_TEST_API_KEY`, `DELETED_TEST_API_KEY`, `REGENERATED_PRODUCTION_API_KEY`, `INVITED_USER`, `TWO_FACTOR_AUTH_ENABLED`, `TWO_FACTOR_AUTH_DISABLED`, `DELETED_LINKED_ACCOUNT`, `CREATED_DESTINATION`, `DELETED_DESTINATION`, `CHANGED_DESTINATION`, `CHANGED_SCOPES`, `CHANGED_PERSONAL_INFORMATION`, `CHANGED_ORGANIZATION_SETTINGS`, `ENABLED_INTEGRATION`, `DISABLED_INTEGRATION`, `ENABLED_CATEGORY`, `DISABLED_CATEGORY`, `CHANGED_PASSWORD`, `RESET_PASSWORD`, `ENABLED_REDACT_UNMAPPED_DATA_FOR_ORGANIZATION`, `ENABLED_REDACT_UNMAPPED_DATA_FOR_LINKED_ACCOUNT`, `DISABLED_REDACT_UNMAPPED_DATA_FOR_ORGANIZATION`, `DISABLED_REDACT_UNMAPPED_DATA_FOR_LINKED_ACCOUNT`, `CREATED_INTEGRATION_WIDE_FIELD_MAPPING`, `CREATED_LINKED_ACCOUNT_FIELD_MAPPING`, `CHANGED_INTEGRATION_WIDE_FIELD_MAPPING`, `CHANGED_LINKED_ACCOUNT_FIELD_MAPPING`, `DELETED_INTEGRATION_WIDE_FIELD_MAPPING`, `DELETED_LINKED_ACCOUNT_FIELD_MAPPING`, `FORCED_LINKED_ACCOUNT_RESYNC`, `MUTED_ISSUE`, `GENERATED_MAGIC_LINK`, `ENABLED_MERGE_WEBHOOK`, `DISABLED_MERGE_WEBHOOK`, `MERGE_WEBHOOK_TARGET_CHANGED`
+
+
+
+
+
+-
+
+**page_size:** `typing.Optional[int]` — Number of results to return per page.
+
+
+
+
+
+-
+
+**start_date:** `typing.Optional[str]` — If included, will only include audit trail events that occurred after this time
+
+
+
+
+
+-
+
+**user_email:** `typing.Optional[str]` — If provided, this will return events associated with the specified user email. Please note that the email address reflects the user's email at the time of the event, and may not be their current email.
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.filestorage.available_actions.retrieve()
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a list of models and actions available for an account.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.filestorage.available_actions.retrieve()
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.filestorage.scopes.default_scopes_retrieve()
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Get the default permissions for Merge Common Models and fields across all Linked Accounts of a given category. [Learn more](https://help.merge.dev/en/articles/8828211-common-model-and-field-scopes).
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.filestorage.scopes.default_scopes_retrieve()
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.filestorage.scopes.linked_account_scopes_retrieve()
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Get all available permissions for Merge Common Models and fields for a single Linked Account. [Learn more](https://help.merge.dev/en/articles/8828211-common-model-and-field-scopes).
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.filestorage.scopes.linked_account_scopes_retrieve()
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.filestorage.scopes.linked_account_scopes_create(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Update permissions for any Common Model or field for a single Linked Account. Any Scopes not set in this POST request will inherit the default Scopes. [Learn more](https://help.merge.dev/en/articles/8828211-common-model-and-field-scopes)
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+from merge.resources.filestorage import (
+ IndividualCommonModelScopeDeserializerRequest,
+ ModelPermissionDeserializerRequest,
+)
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.filestorage.scopes.linked_account_scopes_create(
+ common_models=[
+ IndividualCommonModelScopeDeserializerRequest(
+ model_name="Employee",
+ model_permissions={
+ "READ": ModelPermissionDeserializerRequest(
+ is_enabled=True,
+ ),
+ "WRITE": ModelPermissionDeserializerRequest(
+ is_enabled=False,
+ ),
+ },
+ ),
+ IndividualCommonModelScopeDeserializerRequest(
+ model_name="Benefit",
+ model_permissions={
+ "WRITE": ModelPermissionDeserializerRequest(
+ is_enabled=False,
+ )
+ },
+ ),
+ ],
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**common_models:** `typing.Sequence[IndividualCommonModelScopeDeserializerRequest]` — The common models you want to update the scopes for
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.filestorage.delete_account.delete()
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Delete a linked account.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.filestorage.delete_account.delete()
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.filestorage.drives.list(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a list of `Drive` objects.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.filestorage.drives.list()
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
+
+
+
+
+
+-
+
+**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
+
+
+
+
+
+-
+
+**cursor:** `typing.Optional[str]` — The pagination cursor value.
+
+
+
+
+
+-
+
+**include_deleted_data:** `typing.Optional[bool]` — Whether to include data that was marked as deleted by third party webhooks.
+
+
+
+
+
+-
+
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
+
+
+
+
+
+-
+
+**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
+
+
+
+
+
+-
+
+**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
+
+
+
+
+
+-
+
+**name:** `typing.Optional[str]` — If provided, will only return drives with this name. This performs an exact match.
+
+
+
+
+
+-
+
+**page_size:** `typing.Optional[int]` — Number of results to return per page.
+
+
+
+
+
+-
+
+**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.filestorage.drives.retrieve(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a `Drive` object with the given `id`.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.filestorage.drives.retrieve(
+ id="id",
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**id:** `str`
+
+
+
+
+
+-
+
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.filestorage.field_mapping.field_mappings_retrieve()
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Get all Field Mappings for this Linked Account. Field Mappings are mappings between third-party Remote Fields and user defined Merge fields. [Learn more](https://docs.merge.dev/supplemental-data/field-mappings/overview/).
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.filestorage.field_mapping.field_mappings_retrieve()
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.filestorage.field_mapping.field_mappings_create(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Create new Field Mappings that will be available after the next scheduled sync. This will cause the next sync for this Linked Account to sync **ALL** data from start.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.filestorage.field_mapping.field_mappings_create(
+ target_field_name="example_target_field_name",
+ target_field_description="this is a example description of the target field",
+ remote_field_traversal_path=["example_remote_field"],
+ remote_method="GET",
+ remote_url_path="/example-url-path",
+ common_model_name="ExampleCommonModel",
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**target_field_name:** `str` — The name of the target field you want this remote field to map to.
+
+
+
+
+
+-
+
+**target_field_description:** `str` — The description of the target field you want this remote field to map to.
+
+
+
+
+
+-
+
+**remote_field_traversal_path:** `typing.Sequence[typing.Any]` — The field traversal path of the remote field listed when you hit the GET /remote-fields endpoint.
+
+
+
+
+
+-
+
+**remote_method:** `str` — The method of the remote endpoint where the remote field is coming from.
+
+
+
+
+
+-
+
+**remote_url_path:** `str` — The path of the remote endpoint where the remote field is coming from.
+
+
+
+
+
+-
+
+**common_model_name:** `str` — The name of the Common Model that the remote field corresponds to in a given category.
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.filestorage.field_mapping.field_mappings_destroy(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Deletes Field Mappings for a Linked Account. All data related to this Field Mapping will be deleted and these changes will be reflected after the next scheduled sync. This will cause the next sync for this Linked Account to sync **ALL** data from start.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.filestorage.field_mapping.field_mappings_destroy(
+ field_mapping_id="field_mapping_id",
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**field_mapping_id:** `str`
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.filestorage.field_mapping.field_mappings_partial_update(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Create or update existing Field Mappings for a Linked Account. Changes will be reflected after the next scheduled sync. This will cause the next sync for this Linked Account to sync **ALL** data from start.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.filestorage.field_mapping.field_mappings_partial_update(
+ field_mapping_id="field_mapping_id",
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**field_mapping_id:** `str`
+
+
+
+
+
+-
+
+**remote_field_traversal_path:** `typing.Optional[typing.Sequence[typing.Any]]` — The field traversal path of the remote field listed when you hit the GET /remote-fields endpoint.
+
+
+
+
+
+-
+
+**remote_method:** `typing.Optional[str]` — The method of the remote endpoint where the remote field is coming from.
+
+
+
+
+
+-
+
+**remote_url_path:** `typing.Optional[str]` — The path of the remote endpoint where the remote field is coming from.
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.filestorage.field_mapping.remote_fields_retrieve(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Get all remote fields for a Linked Account. Remote fields are third-party fields that are accessible after initial sync if remote_data is enabled. You can use remote fields to override existing Merge fields or map a new Merge field. [Learn more](https://docs.merge.dev/supplemental-data/field-mappings/overview/).
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.filestorage.field_mapping.remote_fields_retrieve()
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**common_models:** `typing.Optional[str]` — A comma seperated list of Common Model names. If included, will only return Remote Fields for those Common Models.
+
+
+
+
+
+-
+
+**include_example_values:** `typing.Optional[str]` — If true, will include example values, where available, for remote fields in the 3rd party platform. These examples come from active data from your customers.
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.filestorage.field_mapping.target_fields_retrieve()
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Get all organization-wide Target Fields, this will not include any Linked Account specific Target Fields. Organization-wide Target Fields are additional fields appended to the Merge Common Model for all Linked Accounts in a category. [Learn more](https://docs.merge.dev/supplemental-data/field-mappings/target-fields/).
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.filestorage.field_mapping.target_fields_retrieve()
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.filestorage.files.list(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a list of `File` objects.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.filestorage.files.list()
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
+
+
+
+
+
+-
+
+**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
+
+
+
+
+
+-
+
+**cursor:** `typing.Optional[str]` — The pagination cursor value.
+
+
+
+
+
+-
+
+**drive_id:** `typing.Optional[str]` — Specifying a drive id returns only the files in that drive. Specifying null returns only the files outside the top-level drive.
+
+
+
+
+
+-
+
+**expand:** `typing.Optional[FilesListRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+
+
+
+
+
+-
+
+**folder_id:** `typing.Optional[str]` — Specifying a folder id returns only the files in that folder. Specifying null returns only the files in root directory.
+
+
+
+
+
+-
+
+**include_deleted_data:** `typing.Optional[bool]` — Whether to include data that was marked as deleted by third party webhooks.
+
+
+
+
+
+-
+
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
+
+
+
+
+
+-
+
+**mime_type:** `typing.Optional[str]` — If provided, will only return files with these mime_types. Multiple values can be separated by commas.
+
+
+
+
+
+-
+
+**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
+
+
+
+
+
+-
+
+**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
+
+
+
+
+
+-
+
+**name:** `typing.Optional[str]` — If provided, will only return files with this name. This performs an exact match.
+
+
+
+
+
+-
+
+**page_size:** `typing.Optional[int]` — Number of results to return per page.
+
+
+
+
+
+-
+
+**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.filestorage.files.create(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Creates a `File` object with the given values.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+from merge.resources.filestorage import FileRequest
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.filestorage.files.create(
+ model=FileRequest(),
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**model:** `FileRequest`
+
+
+
+
+
+-
+
+**is_debug_mode:** `typing.Optional[bool]` — Whether to include debug fields (such as log file links) in the response.
+
+
+
+
+
+-
+
+**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously.
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.filestorage.files.retrieve(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a `File` object with the given `id`.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.filestorage.files.retrieve(
+ id="id",
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**id:** `str`
+
+
+
+
+
+-
+
+**expand:** `typing.Optional[FilesRetrieveRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+
+
+
+
+
+-
+
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.filestorage.files.download_retrieve(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a `File` object with the given `id`.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.filestorage.files.download_retrieve(
+ id="string",
+ mime_type="string",
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**id:** `str`
+
+
+
+
+
+-
+
+**mime_type:** `typing.Optional[str]` — If provided, specifies the export format of the file to be downloaded. For information on supported export formats, please refer to our export format help center article.
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.filestorage.files.meta_post_retrieve()
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns metadata for `FileStorageFile` POSTs.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.filestorage.files.meta_post_retrieve()
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.filestorage.folders.list(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a list of `Folder` objects.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.filestorage.folders.list()
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
+
+
+
+
+
+-
+
+**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
+
+
+
+
+
+-
+
+**cursor:** `typing.Optional[str]` — The pagination cursor value.
+
+
+
+
+
+-
+
+**drive_id:** `typing.Optional[str]` — If provided, will only return folders in this drive.
+
+
+
+
+
+-
+
+**expand:** `typing.Optional[FoldersListRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+
+
+
+
+
+-
+
+**include_deleted_data:** `typing.Optional[bool]` — Whether to include data that was marked as deleted by third party webhooks.
+
+
+
+
+
+-
+
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
+
+
+
+
+
+-
+
+**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
+
+
+
+
+
+-
+
+**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
+
+
+
+
+
+-
+
+**name:** `typing.Optional[str]` — If provided, will only return folders with this name. This performs an exact match.
+
+
+
+
+
+-
+
+**page_size:** `typing.Optional[int]` — Number of results to return per page.
+
+
+
+
+
+-
+
+**parent_folder_id:** `typing.Optional[str]` — If provided, will only return folders in this parent folder. If null, will return folders in root directory.
+
+
+
+
+
+-
+
+**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.filestorage.folders.create(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Creates a `Folder` object with the given values.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+from merge.resources.filestorage import FolderRequest
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.filestorage.folders.create(
+ model=FolderRequest(),
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**model:** `FolderRequest`
+
+
+
+
+
+-
+
+**is_debug_mode:** `typing.Optional[bool]` — Whether to include debug fields (such as log file links) in the response.
+
+
+
+
+
+-
+
+**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously.
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.filestorage.folders.retrieve(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a `Folder` object with the given `id`.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.filestorage.folders.retrieve(
+ id="id",
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**id:** `str`
+
+
+
+
+
+-
+
+**expand:** `typing.Optional[FoldersRetrieveRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+
+
+
+
+
+-
+
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.filestorage.folders.meta_post_retrieve()
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns metadata for `FileStorageFolder` POSTs.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.filestorage.folders.meta_post_retrieve()
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.filestorage.generate_key.create(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Create a remote key.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.filestorage.generate_key.create(
+ name="Remote Deployment Key 1",
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**name:** `str` — The name of the remote key
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.filestorage.groups.list(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a list of `Group` objects.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.filestorage.groups.list()
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
+
+
+
+
+
+-
+
+**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
+
+
+
+
+
+-
+
+**cursor:** `typing.Optional[str]` — The pagination cursor value.
+
+
+
+
+
+-
+
+**include_deleted_data:** `typing.Optional[bool]` — Whether to include data that was marked as deleted by third party webhooks.
+
+
+
+
+
+-
+
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
+
+
+
+
+
+-
+
+**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
+
+
+
+
+
+-
+
+**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
+
+
+
+
+
+-
+
+**page_size:** `typing.Optional[int]` — Number of results to return per page.
+
+
+
+
+
+-
+
+**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.filestorage.groups.retrieve(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a `Group` object with the given `id`.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.filestorage.groups.retrieve(
+ id="id",
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**id:** `str`
+
+
+
+
+
+-
+
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.filestorage.issues.list(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Gets issues.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.filestorage.issues.list()
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**account_token:** `typing.Optional[str]`
+
+
+
+
+
+-
+
+**cursor:** `typing.Optional[str]` — The pagination cursor value.
+
+
+
+
+
+-
+
+**end_date:** `typing.Optional[str]` — If included, will only include issues whose most recent action occurred before this time
+
+
+
+
+
+-
+
+**end_user_organization_name:** `typing.Optional[str]`
+
+
+
+
+
+-
+
+**first_incident_time_after:** `typing.Optional[dt.datetime]` — If provided, will only return issues whose first incident time was after this datetime.
+
+
+
+
+
+-
+
+**first_incident_time_before:** `typing.Optional[dt.datetime]` — If provided, will only return issues whose first incident time was before this datetime.
+
+
+
+
+
+-
+
+**include_muted:** `typing.Optional[str]` — If true, will include muted issues
+
+
+
+
+
+-
+
+**integration_name:** `typing.Optional[str]`
+
+
+
+
+
+-
+
+**last_incident_time_after:** `typing.Optional[dt.datetime]` — If provided, will only return issues whose last incident time was after this datetime.
+
+
+
+
+
+-
+
+**last_incident_time_before:** `typing.Optional[dt.datetime]` — If provided, will only return issues whose last incident time was before this datetime.
+
+
+
+
+
+-
+
+**page_size:** `typing.Optional[int]` — Number of results to return per page.
+
+
+
+
+
+-
+
+**start_date:** `typing.Optional[str]` — If included, will only include issues whose most recent action occurred after this time
+
+
+
+
+
+-
+
+**status:** `typing.Optional[IssuesListRequestStatus]`
+
+Status of the issue. Options: ('ONGOING', 'RESOLVED')
+
+- `ONGOING` - ONGOING
+- `RESOLVED` - RESOLVED
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.filestorage.issues.retrieve(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Get a specific issue.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.filestorage.issues.retrieve(
+ id="id",
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**id:** `str`
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.filestorage.link_token.create(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Creates a link token to be used when linking a new end user.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+from merge.resources.filestorage import CategoriesEnum
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.filestorage.link_token.create(
+ end_user_email_address="example@gmail.com",
+ end_user_organization_name="Test Organization",
+ end_user_origin_id="12345",
+ categories=[CategoriesEnum.HRIS, CategoriesEnum.ATS],
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**end_user_email_address:** `str` — Your end user's email address. This is purely for identification purposes - setting this value will not cause any emails to be sent.
+
+
+
+
+
+-
+
+**end_user_organization_name:** `str` — Your end user's organization.
+
+
+
+
+
+-
+
+**end_user_origin_id:** `str` — This unique identifier typically represents the ID for your end user in your product's database. This value must be distinct from other Linked Accounts' unique identifiers.
+
+
+
+
+
+-
+
+**categories:** `typing.Sequence[CategoriesEnum]` — The integration categories to show in Merge Link.
+
+
+
+
+
+-
+
+**integration:** `typing.Optional[str]` — The slug of a specific pre-selected integration for this linking flow token. For examples of slugs, see https://docs.merge.dev/guides/merge-link/single-integration/.
+
+
+
+
+
+-
+
+**link_expiry_mins:** `typing.Optional[int]` — An integer number of minutes between [30, 720 or 10080 if for a Magic Link URL] for how long this token is valid. Defaults to 30.
+
+
+
+
+
+-
+
+**should_create_magic_link_url:** `typing.Optional[bool]` — Whether to generate a Magic Link URL. Defaults to false. For more information on Magic Link, see https://merge.dev/blog/integrations-fast-say-hello-to-magic-link.
+
+
+
+
+
+-
+
+**common_models:** `typing.Optional[typing.Sequence[CommonModelScopesBodyRequest]]` — An array of objects to specify the models and fields that will be disabled for a given Linked Account. Each object uses model_id, enabled_actions, and disabled_fields to specify the model, method, and fields that are scoped for a given Linked Account.
+
+
+
+
+
+-
+
+**category_common_model_scopes:** `typing.Optional[
+ typing.Dict[
+ str,
+ typing.Optional[
+ typing.Sequence[IndividualCommonModelScopeDeserializerRequest]
+ ],
+ ]
+]` — When creating a Link Token, you can set permissions for Common Models that will apply to the account that is going to be linked. Any model or field not specified in link token payload will default to existing settings.
+
+
+
+
+
+-
+
+**language:** `typing.Optional[str]` — The language code for the language to localize Merge Link to.
+
+
+
+
+
+-
+
+**integration_specific_config:** `typing.Optional[typing.Dict[str, typing.Any]]` — A JSON object containing integration-specific configuration options.
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.filestorage.linked_accounts.list(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+List linked accounts for your organization.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.filestorage.linked_accounts.list()
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**category:** `typing.Optional[LinkedAccountsListRequestCategory]`
+
+Options: ('hris', 'ats', 'accounting', 'ticketing', 'crm', 'mktg', 'filestorage')
+
+- `hris` - hris
+- `ats` - ats
+- `accounting` - accounting
+- `ticketing` - ticketing
+- `crm` - crm
+- `mktg` - mktg
+- `filestorage` - filestorage
+
+
+
+
+
+-
+
+**cursor:** `typing.Optional[str]` — The pagination cursor value.
+
+
+
+
+
+-
+
+**end_user_email_address:** `typing.Optional[str]` — If provided, will only return linked accounts associated with the given email address.
+
+
+
+
+
+-
+
+**end_user_organization_name:** `typing.Optional[str]` — If provided, will only return linked accounts associated with the given organization name.
+
+
+
+
+
+-
+
+**end_user_origin_id:** `typing.Optional[str]` — If provided, will only return linked accounts associated with the given origin ID.
+
+
+
+
+
+-
+
+**end_user_origin_ids:** `typing.Optional[str]` — Comma-separated list of EndUser origin IDs, making it possible to specify multiple EndUsers at once.
+
+
+
+
+
+-
+
+**id:** `typing.Optional[str]`
+
+
+
+
+
+-
+
+**ids:** `typing.Optional[str]` — Comma-separated list of LinkedAccount IDs, making it possible to specify multiple LinkedAccounts at once.
+
+
+
+
+
+-
+
+**include_duplicates:** `typing.Optional[bool]` — If `true`, will include complete production duplicates of the account specified by the `id` query parameter in the response. `id` must be for a complete production linked account.
+
+
+
+
+
+-
+
+**integration_name:** `typing.Optional[str]` — If provided, will only return linked accounts associated with the given integration name.
+
+
+
+
+
+-
+
+**is_test_account:** `typing.Optional[str]` — If included, will only include test linked accounts. If not included, will only include non-test linked accounts.
+
+
+
+
+
+-
+
+**page_size:** `typing.Optional[int]` — Number of results to return per page.
+
+
+
+
+
+-
+
+**status:** `typing.Optional[str]` — Filter by status. Options: `COMPLETE`, `INCOMPLETE`, `RELINK_NEEDED`
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.filestorage.passthrough.create(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Pull data from an endpoint not currently supported by Merge.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+from merge.resources.filestorage import DataPassthroughRequest, MethodEnum
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.filestorage.passthrough.create(
+ request=DataPassthroughRequest(
+ method=MethodEnum.GET,
+ path="/scooters",
+ ),
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request:** `DataPassthroughRequest`
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.filestorage.regenerate_key.create(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Exchange remote keys.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.filestorage.regenerate_key.create(
+ name="Remote Deployment Key 1",
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**name:** `str` — The name of the remote key
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.filestorage.sync_status.list(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Get syncing status. Possible values: `DISABLED`, `DONE`, `FAILED`, `PARTIALLY_SYNCED`, `PAUSED`, `SYNCING`. Learn more about sync status in our [Help Center](https://help.merge.dev/en/articles/8184193-merge-sync-statuses).
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.filestorage.sync_status.list()
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**cursor:** `typing.Optional[str]` — The pagination cursor value.
+
+
+
+
+
+-
+
+**page_size:** `typing.Optional[int]` — Number of results to return per page.
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.filestorage.force_resync.sync_status_resync_create()
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Force re-sync of all models. This is available for all organizations via the dashboard. Force re-sync is also available programmatically via API for monthly, quarterly, and highest sync frequency customers on the Launch, Professional, or Enterprise plans. Doing so will consume a sync credit for the relevant linked account.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.filestorage.force_resync.sync_status_resync_create()
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.filestorage.users.list(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a list of `User` objects.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.filestorage.users.list()
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
+
+
+
+
+
+-
+
+**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
+
+
+
+
+
+-
+
+**cursor:** `typing.Optional[str]` — The pagination cursor value.
+
+
+
+
+
+-
+
+**include_deleted_data:** `typing.Optional[bool]` — Whether to include data that was marked as deleted by third party webhooks.
+
+
+
+
+
+-
+
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
+
+
+
+
+
+-
+
+**is_me:** `typing.Optional[str]` — If provided, will only return the user object for requestor.
+
+
+
+
+
+-
+
+**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
+
+
+
+
+
+-
+
+**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
+
+
+
+
+
+-
+
+**page_size:** `typing.Optional[int]` — Number of results to return per page.
+
+
+
+
+
+-
+
+**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.filestorage.users.retrieve(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a `User` object with the given `id`.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.filestorage.users.retrieve(
+ id="id",
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**id:** `str`
+
+
+
+
+
+-
+
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.filestorage.webhook_receivers.list()
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a list of `WebhookReceiver` objects.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.filestorage.webhook_receivers.list()
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.filestorage.webhook_receivers.create(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Creates a `WebhookReceiver` object with the given values.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.filestorage.webhook_receivers.create(
+ event="event",
+ is_active=True,
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**event:** `str`
+
+
+
+
+
+-
+
+**is_active:** `bool`
+
+
+
+
+
+-
+
+**key:** `typing.Optional[str]`
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.ats.account_details.retrieve()
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Get details for a linked account.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.ats.account_details.retrieve()
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.ats.account_token.retrieve(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns the account token for the end user with the provided public token.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.ats.account_token.retrieve(
+ public_token="public_token",
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**public_token:** `str`
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.ats.activities.list(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a list of `Activity` objects.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.ats.activities.list()
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
+
+
+
+
+
+-
+
+**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
+
+
+
+
+
+-
+
+**cursor:** `typing.Optional[str]` — The pagination cursor value.
+
+
+
+
+
+-
+
+**expand:** `typing.Optional[typing.Literal["user"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+
+
+
+
+
+-
+
+**include_deleted_data:** `typing.Optional[bool]` — Whether to include data that was marked as deleted by third party webhooks.
+
+
+
+
+
+-
+
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
+
+
+
+
+
+-
+
+**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
+
+
+
+
+
+-
+
+**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
+
+
+
+
+
+-
+
+**page_size:** `typing.Optional[int]` — Number of results to return per page.
+
+
+
+
+
+-
+
+**remote_fields:** `typing.Optional[ActivitiesListRequestRemoteFields]` — Deprecated. Use show_enum_origins.
+
+
+
+
+
+-
+
+**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
+
+
+
+
+
+-
+
+**show_enum_origins:** `typing.Optional[ActivitiesListRequestShowEnumOrigins]` — A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter)
+
+
+
+
+
+-
+
+**user_id:** `typing.Optional[str]` — If provided, will only return activities done by this user.
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.ats.activities.create(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Creates an `Activity` object with the given values.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+from merge.resources.ats import ActivityRequest
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.ats.activities.create(
+ model=ActivityRequest(),
+ remote_user_id="remote_user_id",
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**model:** `ActivityRequest`
+
+
+
+
+
+-
+
+**remote_user_id:** `str`
+
+
+
+
+
+-
+
+**is_debug_mode:** `typing.Optional[bool]` — Whether to include debug fields (such as log file links) in the response.
+
+
+
+
+
+-
+
+**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously.
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.ats.activities.retrieve(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns an `Activity` object with the given `id`.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.ats.activities.retrieve(
+ id="id",
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**id:** `str`
+
+
+
+
+
+-
+
+**expand:** `typing.Optional[typing.Literal["user"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+
+
+
+
+
+-
+
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
+
+
+
+
+
+-
+
+**remote_fields:** `typing.Optional[ActivitiesRetrieveRequestRemoteFields]` — Deprecated. Use show_enum_origins.
+
+
+
+
+
+-
+
+**show_enum_origins:** `typing.Optional[ActivitiesRetrieveRequestShowEnumOrigins]` — A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter)
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.ats.activities.meta_post_retrieve()
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns metadata for `Activity` POSTs.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.ats.activities.meta_post_retrieve()
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.ats.applications.list(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a list of `Application` objects.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.ats.applications.list()
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**candidate_id:** `typing.Optional[str]` — If provided, will only return applications for this candidate.
+
+
+
+
+
+-
+
+**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
+
+
+
+
+
+-
+
+**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
+
+
+
+
+
+-
+
+**credited_to_id:** `typing.Optional[str]` — If provided, will only return applications credited to this user.
+
+
+
+
+
+-
+
+**current_stage_id:** `typing.Optional[str]` — If provided, will only return applications at this interview stage.
+
+
+
+
+
+-
+
+**cursor:** `typing.Optional[str]` — The pagination cursor value.
+
+
+
+
+
+-
+
+**expand:** `typing.Optional[ApplicationsListRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+
+
+
+
+
+-
+
+**include_deleted_data:** `typing.Optional[bool]` — Whether to include data that was marked as deleted by third party webhooks.
+
+
+
+
+
+-
+
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
+
+
+
+
+
+-
+
+**job_id:** `typing.Optional[str]` — If provided, will only return applications for this job.
+
+
+
+
+
+-
+
+**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
+
+
+
+
+
+-
+
+**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
+
+
+
+
+
+-
+
+**page_size:** `typing.Optional[int]` — Number of results to return per page.
+
+
+
+
+
+-
+
+**reject_reason_id:** `typing.Optional[str]` — If provided, will only return applications with this reject reason.
+
+
+
+
+
+-
+
+**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
+
+
+
+
+
+-
+
+**source:** `typing.Optional[str]` — If provided, will only return applications with this source.
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.ats.applications.create(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Creates an `Application` object with the given values.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+from merge.resources.ats import ApplicationRequest
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.ats.applications.create(
+ model=ApplicationRequest(),
+ remote_user_id="remote_user_id",
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**model:** `ApplicationRequest`
+
+
+
+
+
+-
+
+**remote_user_id:** `str`
+
+
+
+
+
+-
+
+**is_debug_mode:** `typing.Optional[bool]` — Whether to include debug fields (such as log file links) in the response.
+
+
+
+
+
+-
+
+**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously.
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.ats.applications.retrieve(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns an `Application` object with the given `id`.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.ats.applications.retrieve(
+ id="id",
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**id:** `str`
+
+
+
+
+
+-
+
+**expand:** `typing.Optional[ApplicationsRetrieveRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+
+
+
+
+
+-
+
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.ats.applications.change_stage_create(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Updates the `current_stage` field of an `Application` object
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.ats.applications.change_stage_create(
+ id="id",
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**id:** `str`
+
+
+
+
+
+-
+
+**is_debug_mode:** `typing.Optional[bool]` — Whether to include debug fields (such as log file links) in the response.
+
+
+
+
+
+-
+
+**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously.
+
+
+
+
+
+-
+
+**job_interview_stage:** `typing.Optional[str]` — The interview stage to move the application to.
+
+
+
+
+
+-
+
+**remote_user_id:** `typing.Optional[str]`
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.ats.applications.meta_post_retrieve(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns metadata for `Application` POSTs.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.ats.applications.meta_post_retrieve()
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**application_remote_template_id:** `typing.Optional[str]` — The template ID associated with the nested application in the request.
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.ats.async_passthrough.create(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Asynchronously pull data from an endpoint not currently supported by Merge.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+from merge.resources.ats import DataPassthroughRequest, MethodEnum
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.ats.async_passthrough.create(
+ request=DataPassthroughRequest(
+ method=MethodEnum.GET,
+ path="/scooters",
+ ),
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request:** `DataPassthroughRequest`
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.ats.async_passthrough.retrieve(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Retrieves data from earlier async-passthrough POST request
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.ats.async_passthrough.retrieve(
+ async_passthrough_receipt_id="async_passthrough_receipt_id",
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**async_passthrough_receipt_id:** `str`
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.ats.attachments.list(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a list of `Attachment` objects.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.ats.attachments.list()
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**candidate_id:** `typing.Optional[str]` — If provided, will only return attachments for this candidate.
+
+
+
+
+
+-
+
+**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
+
+
+
+
+
+-
+
+**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
+
+
+
+
+
+-
+
+**cursor:** `typing.Optional[str]` — The pagination cursor value.
+
+
+
+
+
+-
+
+**expand:** `typing.Optional[typing.Literal["candidate"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+
+
+
+
+
+-
+
+**include_deleted_data:** `typing.Optional[bool]` — Whether to include data that was marked as deleted by third party webhooks.
+
+
+
+
+
+-
+
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
+
+
+
+
+
+-
+
+**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
+
+
+
+
+
+-
+
+**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
+
+
+
+
+
+-
+
+**page_size:** `typing.Optional[int]` — Number of results to return per page.
+
+
+
+
+
+-
+
+**remote_fields:** `typing.Optional[typing.Literal["attachment_type"]]` — Deprecated. Use show_enum_origins.
+
+
+
+
+
+-
+
+**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
+
+
+
+
+
+-
+
+**show_enum_origins:** `typing.Optional[typing.Literal["attachment_type"]]` — A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter)
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.ats.attachments.create(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Creates an `Attachment` object with the given values.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+from merge.resources.ats import AttachmentRequest
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.ats.attachments.create(
+ model=AttachmentRequest(),
+ remote_user_id="remote_user_id",
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**model:** `AttachmentRequest`
+
+
+
+
+
+-
+
+**remote_user_id:** `str`
+
+
+
+
+
+-
+
+**is_debug_mode:** `typing.Optional[bool]` — Whether to include debug fields (such as log file links) in the response.
+
+
+
+
+
+-
+
+**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously.
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.ats.attachments.retrieve(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns an `Attachment` object with the given `id`.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.ats.attachments.retrieve(
+ id="id",
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**id:** `str`
+
+
+
+
+
+-
+
+**expand:** `typing.Optional[typing.Literal["candidate"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+
+
+
+
+
+-
+
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
+
+
+
+
+
+-
+
+**remote_fields:** `typing.Optional[typing.Literal["attachment_type"]]` — Deprecated. Use show_enum_origins.
+
+
+
+
+
+-
+
+**show_enum_origins:** `typing.Optional[typing.Literal["attachment_type"]]` — A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter)
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.ats.attachments.meta_post_retrieve()
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns metadata for `Attachment` POSTs.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.ats.attachments.meta_post_retrieve()
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.ats.audit_trail.list(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Gets a list of audit trail events.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.ats.audit_trail.list()
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**cursor:** `typing.Optional[str]` — The pagination cursor value.
+
+
+
+
+
+-
+
+**end_date:** `typing.Optional[str]` — If included, will only include audit trail events that occurred before this time
+
+
+
+
+
+-
+
+**event_type:** `typing.Optional[str]` — If included, will only include events with the given event type. Possible values include: `CREATED_REMOTE_PRODUCTION_API_KEY`, `DELETED_REMOTE_PRODUCTION_API_KEY`, `CREATED_TEST_API_KEY`, `DELETED_TEST_API_KEY`, `REGENERATED_PRODUCTION_API_KEY`, `INVITED_USER`, `TWO_FACTOR_AUTH_ENABLED`, `TWO_FACTOR_AUTH_DISABLED`, `DELETED_LINKED_ACCOUNT`, `CREATED_DESTINATION`, `DELETED_DESTINATION`, `CHANGED_DESTINATION`, `CHANGED_SCOPES`, `CHANGED_PERSONAL_INFORMATION`, `CHANGED_ORGANIZATION_SETTINGS`, `ENABLED_INTEGRATION`, `DISABLED_INTEGRATION`, `ENABLED_CATEGORY`, `DISABLED_CATEGORY`, `CHANGED_PASSWORD`, `RESET_PASSWORD`, `ENABLED_REDACT_UNMAPPED_DATA_FOR_ORGANIZATION`, `ENABLED_REDACT_UNMAPPED_DATA_FOR_LINKED_ACCOUNT`, `DISABLED_REDACT_UNMAPPED_DATA_FOR_ORGANIZATION`, `DISABLED_REDACT_UNMAPPED_DATA_FOR_LINKED_ACCOUNT`, `CREATED_INTEGRATION_WIDE_FIELD_MAPPING`, `CREATED_LINKED_ACCOUNT_FIELD_MAPPING`, `CHANGED_INTEGRATION_WIDE_FIELD_MAPPING`, `CHANGED_LINKED_ACCOUNT_FIELD_MAPPING`, `DELETED_INTEGRATION_WIDE_FIELD_MAPPING`, `DELETED_LINKED_ACCOUNT_FIELD_MAPPING`, `FORCED_LINKED_ACCOUNT_RESYNC`, `MUTED_ISSUE`, `GENERATED_MAGIC_LINK`, `ENABLED_MERGE_WEBHOOK`, `DISABLED_MERGE_WEBHOOK`, `MERGE_WEBHOOK_TARGET_CHANGED`
+
+
+
+
+
+-
+
+**page_size:** `typing.Optional[int]` — Number of results to return per page.
+
+
+
+
+
+-
+
+**start_date:** `typing.Optional[str]` — If included, will only include audit trail events that occurred after this time
+
+
+
+
+
+-
+
+**user_email:** `typing.Optional[str]` — If provided, this will return events associated with the specified user email. Please note that the email address reflects the user's email at the time of the event, and may not be their current email.
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.ats.available_actions.retrieve()
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a list of models and actions available for an account.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.ats.available_actions.retrieve()
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.ats.candidates.list(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a list of `Candidate` objects.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.ats.candidates.list()
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
+
+
+
+
+
+-
+
+**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
+
+
+
+
+
+-
+
+**cursor:** `typing.Optional[str]` — The pagination cursor value.
+
+
+
+
+
+-
+
+**email_addresses:** `typing.Optional[str]` — If provided, will only return candidates with these email addresses; multiple addresses can be separated by commas.
+
+
+
+
+
+-
+
+**expand:** `typing.Optional[CandidatesListRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+
+
+
+
+
+-
+
+**first_name:** `typing.Optional[str]` — If provided, will only return candidates with this first name.
+
+
+
+
+
+-
+
+**include_deleted_data:** `typing.Optional[bool]` — Whether to include data that was marked as deleted by third party webhooks.
+
+
+
+
+
+-
+
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
+
+
+
+
+
+-
+
+**last_name:** `typing.Optional[str]` — If provided, will only return candidates with this last name.
+
+
+
+
+
+-
+
+**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
+
+
+
+
+
+-
+
+**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
+
+
+
+
+
+-
+
+**page_size:** `typing.Optional[int]` — Number of results to return per page.
+
+
+
+
+
+-
+
+**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
+
+
+
+
+
+-
+
+**tags:** `typing.Optional[str]` — If provided, will only return candidates with these tags; multiple tags can be separated by commas.
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.ats.candidates.create(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Creates a `Candidate` object with the given values.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+from merge.resources.ats import CandidateRequest
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.ats.candidates.create(
+ model=CandidateRequest(),
+ remote_user_id="remote_user_id",
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**model:** `CandidateRequest`
+
+
+
+
+
+-
+
+**remote_user_id:** `str`
+
+
+
+
+
+-
+
+**is_debug_mode:** `typing.Optional[bool]` — Whether to include debug fields (such as log file links) in the response.
+
+
+
+
+
+-
+
+**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously.
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.ats.candidates.retrieve(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a `Candidate` object with the given `id`.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.ats.candidates.retrieve(
+ id="id",
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**id:** `str`
+
+
+
+
+
+-
+
+**expand:** `typing.Optional[CandidatesRetrieveRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+
+
+
+
+
+-
+
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.ats.candidates.partial_update(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Updates a `Candidate` object with the given `id`.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+from merge.resources.ats import PatchedCandidateRequest
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.ats.candidates.partial_update(
+ id="id",
+ model=PatchedCandidateRequest(),
+ remote_user_id="remote_user_id",
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**id:** `str`
+
+
+
+
+
+-
+
+**model:** `PatchedCandidateRequest`
+
+
+
+
+
+-
+
+**remote_user_id:** `str`
+
+
+
+
+
+-
+
+**is_debug_mode:** `typing.Optional[bool]` — Whether to include debug fields (such as log file links) in the response.
+
+
+
+
+
+-
+
+**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously.
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.ats.candidates.ignore_create(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Ignores a specific row based on the `model_id` in the url. These records will have their properties set to null, and will not be updated in future syncs. The "reason" and "message" fields in the request body will be stored for audit purposes.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+from merge.resources.ats import ReasonEnum
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.ats.candidates.ignore_create(
+ model_id="model_id",
+ reason=ReasonEnum.GENERAL_CUSTOMER_REQUEST,
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**model_id:** `str`
+
+
+
+
+
+-
+
+**reason:** `ReasonEnum`
+
+
+
+
+
+-
+
+**message:** `typing.Optional[str]`
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.ats.candidates.meta_patch_retrieve(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns metadata for `Candidate` PATCHs.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.ats.candidates.meta_patch_retrieve(
+ id="id",
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**id:** `str`
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.ats.candidates.meta_post_retrieve()
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns metadata for `Candidate` POSTs.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.ats.candidates.meta_post_retrieve()
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.ats.scopes.default_scopes_retrieve()
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Get the default permissions for Merge Common Models and fields across all Linked Accounts of a given category. [Learn more](https://help.merge.dev/en/articles/8828211-common-model-and-field-scopes).
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.ats.scopes.default_scopes_retrieve()
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.ats.scopes.linked_account_scopes_retrieve()
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Get all available permissions for Merge Common Models and fields for a single Linked Account. [Learn more](https://help.merge.dev/en/articles/8828211-common-model-and-field-scopes).
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.ats.scopes.linked_account_scopes_retrieve()
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.ats.scopes.linked_account_scopes_create(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Update permissions for any Common Model or field for a single Linked Account. Any Scopes not set in this POST request will inherit the default Scopes. [Learn more](https://help.merge.dev/en/articles/8828211-common-model-and-field-scopes)
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+from merge.resources.ats import (
+ IndividualCommonModelScopeDeserializerRequest,
+ ModelPermissionDeserializerRequest,
+)
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.ats.scopes.linked_account_scopes_create(
+ common_models=[
+ IndividualCommonModelScopeDeserializerRequest(
+ model_name="Employee",
+ model_permissions={
+ "READ": ModelPermissionDeserializerRequest(
+ is_enabled=True,
+ ),
+ "WRITE": ModelPermissionDeserializerRequest(
+ is_enabled=False,
+ ),
+ },
+ ),
+ IndividualCommonModelScopeDeserializerRequest(
+ model_name="Benefit",
+ model_permissions={
+ "WRITE": ModelPermissionDeserializerRequest(
+ is_enabled=False,
+ )
+ },
+ ),
+ ],
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**common_models:** `typing.Sequence[IndividualCommonModelScopeDeserializerRequest]` — The common models you want to update the scopes for
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.ats.delete_account.delete()
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Delete a linked account.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.ats.delete_account.delete()
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.ats.departments.list(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a list of `Department` objects.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.ats.departments.list()
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
+
+
+
+
+
+-
+
+**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
+
+
+
+
+
+-
+
+**cursor:** `typing.Optional[str]` — The pagination cursor value.
+
+
+
+
+
+-
+
+**include_deleted_data:** `typing.Optional[bool]` — Whether to include data that was marked as deleted by third party webhooks.
+
+
+
+
+
+-
+
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
+
+
+
+
+
+-
+
+**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
+
+
+
+
+
+-
+
+**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
+
+
+
+
+
+-
+
+**page_size:** `typing.Optional[int]` — Number of results to return per page.
+
+
+
+
+
+-
+
+**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.ats.departments.retrieve(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a `Department` object with the given `id`.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.ats.departments.retrieve(
+ id="id",
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**id:** `str`
+
+
+
+
+
+-
+
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.ats.eeocs.list(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a list of `EEOC` objects.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.ats.eeocs.list()
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**candidate_id:** `typing.Optional[str]` — If provided, will only return EEOC info for this candidate.
+
+
+
+
+
+-
+
+**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
+
+
+
+
+
+-
+
+**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
+
+
+
+
+
+-
+
+**cursor:** `typing.Optional[str]` — The pagination cursor value.
+
+
+
+
+
+-
+
+**expand:** `typing.Optional[typing.Literal["candidate"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+
+
+
+
+
+-
+
+**include_deleted_data:** `typing.Optional[bool]` — Whether to include data that was marked as deleted by third party webhooks.
+
+
+
+
+
+-
+
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
+
+
+
+
+
+-
+
+**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
+
+
+
+
+
+-
+
+**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
+
+
+
+
+
+-
+
+**page_size:** `typing.Optional[int]` — Number of results to return per page.
+
+
+
+
+
+-
+
+**remote_fields:** `typing.Optional[EeocsListRequestRemoteFields]` — Deprecated. Use show_enum_origins.
+
+
+
+
+
+-
+
+**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
+
+
+
+
+
+-
+
+**show_enum_origins:** `typing.Optional[EeocsListRequestShowEnumOrigins]` — A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter)
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.ats.eeocs.retrieve(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns an `EEOC` object with the given `id`.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.ats.eeocs.retrieve(
+ id="id",
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**id:** `str`
+
+
+
+
+
+-
+
+**expand:** `typing.Optional[typing.Literal["candidate"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+
+
+
+
+
+-
+
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
+
+
+
+
+
+-
+
+**remote_fields:** `typing.Optional[EeocsRetrieveRequestRemoteFields]` — Deprecated. Use show_enum_origins.
+
+
+
+
+
+-
+
+**show_enum_origins:** `typing.Optional[EeocsRetrieveRequestShowEnumOrigins]` — A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter)
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.ats.field_mapping.field_mappings_retrieve()
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Get all Field Mappings for this Linked Account. Field Mappings are mappings between third-party Remote Fields and user defined Merge fields. [Learn more](https://docs.merge.dev/supplemental-data/field-mappings/overview/).
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.ats.field_mapping.field_mappings_retrieve()
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.ats.field_mapping.field_mappings_create(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Create new Field Mappings that will be available after the next scheduled sync. This will cause the next sync for this Linked Account to sync **ALL** data from start.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.ats.field_mapping.field_mappings_create(
+ target_field_name="example_target_field_name",
+ target_field_description="this is a example description of the target field",
+ remote_field_traversal_path=["example_remote_field"],
+ remote_method="GET",
+ remote_url_path="/example-url-path",
+ common_model_name="ExampleCommonModel",
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**target_field_name:** `str` — The name of the target field you want this remote field to map to.
+
+
+
+
+
+-
+
+**target_field_description:** `str` — The description of the target field you want this remote field to map to.
+
+
+
+
+
+-
+
+**remote_field_traversal_path:** `typing.Sequence[typing.Any]` — The field traversal path of the remote field listed when you hit the GET /remote-fields endpoint.
+
+
+
+
+
+-
+
+**remote_method:** `str` — The method of the remote endpoint where the remote field is coming from.
+
+
+
+
+
+-
+
+**remote_url_path:** `str` — The path of the remote endpoint where the remote field is coming from.
+
+
+
+
+
+-
+
+**common_model_name:** `str` — The name of the Common Model that the remote field corresponds to in a given category.
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.ats.field_mapping.field_mappings_destroy(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Deletes Field Mappings for a Linked Account. All data related to this Field Mapping will be deleted and these changes will be reflected after the next scheduled sync. This will cause the next sync for this Linked Account to sync **ALL** data from start.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.ats.field_mapping.field_mappings_destroy(
+ field_mapping_id="field_mapping_id",
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**field_mapping_id:** `str`
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.ats.field_mapping.field_mappings_partial_update(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Create or update existing Field Mappings for a Linked Account. Changes will be reflected after the next scheduled sync. This will cause the next sync for this Linked Account to sync **ALL** data from start.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.ats.field_mapping.field_mappings_partial_update(
+ field_mapping_id="field_mapping_id",
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**field_mapping_id:** `str`
+
+
+
+
+
+-
+
+**remote_field_traversal_path:** `typing.Optional[typing.Sequence[typing.Any]]` — The field traversal path of the remote field listed when you hit the GET /remote-fields endpoint.
+
+
+
+
+
+-
+
+**remote_method:** `typing.Optional[str]` — The method of the remote endpoint where the remote field is coming from.
+
+
+
+
+
+-
+
+**remote_url_path:** `typing.Optional[str]` — The path of the remote endpoint where the remote field is coming from.
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.ats.field_mapping.remote_fields_retrieve(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Get all remote fields for a Linked Account. Remote fields are third-party fields that are accessible after initial sync if remote_data is enabled. You can use remote fields to override existing Merge fields or map a new Merge field. [Learn more](https://docs.merge.dev/supplemental-data/field-mappings/overview/).
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.ats.field_mapping.remote_fields_retrieve()
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**common_models:** `typing.Optional[str]` — A comma seperated list of Common Model names. If included, will only return Remote Fields for those Common Models.
+
+
+
+
+
+-
+
+**include_example_values:** `typing.Optional[str]` — If true, will include example values, where available, for remote fields in the 3rd party platform. These examples come from active data from your customers.
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.ats.field_mapping.target_fields_retrieve()
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Get all organization-wide Target Fields, this will not include any Linked Account specific Target Fields. Organization-wide Target Fields are additional fields appended to the Merge Common Model for all Linked Accounts in a category. [Learn more](https://docs.merge.dev/supplemental-data/field-mappings/target-fields/).
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.ats.field_mapping.target_fields_retrieve()
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.ats.generate_key.create(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Create a remote key.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.ats.generate_key.create(
+ name="Remote Deployment Key 1",
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**name:** `str` — The name of the remote key
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.ats.interviews.list(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a list of `ScheduledInterview` objects.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.ats.interviews.list()
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**application_id:** `typing.Optional[str]` — If provided, will only return interviews for this application.
+
+
+
+
+
+-
+
+**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
+
+
+
+
+
+-
+
+**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
+
+
+
+
+
+-
+
+**cursor:** `typing.Optional[str]` — The pagination cursor value.
+
+
+
+
+
+-
+
+**expand:** `typing.Optional[InterviewsListRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+
+
+
+
+
+-
+
+**include_deleted_data:** `typing.Optional[bool]` — Whether to include data that was marked as deleted by third party webhooks.
+
+
+
+
+
+-
+
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
+
+
+
+
+
+-
+
+**job_id:** `typing.Optional[str]` — If provided, wll only return interviews organized for this job.
+
+
+
+
+
+-
+
+**job_interview_stage_id:** `typing.Optional[str]` — If provided, will only return interviews at this stage.
+
+
+
+
+
+-
+
+**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
+
+
+
+
+
+-
+
+**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
+
+
+
+
+
+-
+
+**organizer_id:** `typing.Optional[str]` — If provided, will only return interviews organized by this user.
+
+
+
+
+
+-
+
+**page_size:** `typing.Optional[int]` — Number of results to return per page.
+
+
+
+
+
+-
+
+**remote_fields:** `typing.Optional[typing.Literal["status"]]` — Deprecated. Use show_enum_origins.
+
+
+
+
+
+-
+
+**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
+
+
+
+
+
+-
+
+**show_enum_origins:** `typing.Optional[typing.Literal["status"]]` — A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter)
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.ats.interviews.create(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Creates a `ScheduledInterview` object with the given values.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+from merge.resources.ats import ScheduledInterviewRequest
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.ats.interviews.create(
+ model=ScheduledInterviewRequest(),
+ remote_user_id="remote_user_id",
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**model:** `ScheduledInterviewRequest`
+
+
+
+
+
+-
+
+**remote_user_id:** `str`
+
+
+
+
+
+-
+
+**is_debug_mode:** `typing.Optional[bool]` — Whether to include debug fields (such as log file links) in the response.
+
+
+
+
+
+-
+
+**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously.
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.ats.interviews.retrieve(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a `ScheduledInterview` object with the given `id`.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.ats.interviews.retrieve(
+ id="id",
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**id:** `str`
+
+
+
+
+
+-
+
+**expand:** `typing.Optional[InterviewsRetrieveRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+
+
+
+
+
+-
+
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
+
+
+
+
+
+-
+
+**remote_fields:** `typing.Optional[typing.Literal["status"]]` — Deprecated. Use show_enum_origins.
+
+
+
+
+
+-
+
+**show_enum_origins:** `typing.Optional[typing.Literal["status"]]` — A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter)
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.ats.interviews.meta_post_retrieve()
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns metadata for `ScheduledInterview` POSTs.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.ats.interviews.meta_post_retrieve()
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.ats.issues.list(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Gets issues.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.ats.issues.list()
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**account_token:** `typing.Optional[str]`
+
+
+
+
+
+-
+
+**cursor:** `typing.Optional[str]` — The pagination cursor value.
+
+
+
+
+
+-
+
+**end_date:** `typing.Optional[str]` — If included, will only include issues whose most recent action occurred before this time
+
+
+
+
+
+-
+
+**end_user_organization_name:** `typing.Optional[str]`
+
+
+
+
+
+-
+
+**first_incident_time_after:** `typing.Optional[dt.datetime]` — If provided, will only return issues whose first incident time was after this datetime.
+
+
+
+
+
+-
+
+**first_incident_time_before:** `typing.Optional[dt.datetime]` — If provided, will only return issues whose first incident time was before this datetime.
+
+
+
+
+
+-
+
+**include_muted:** `typing.Optional[str]` — If true, will include muted issues
+
+
+
+
+
+-
+
+**integration_name:** `typing.Optional[str]`
+
+
+
+
+
+-
+
+**last_incident_time_after:** `typing.Optional[dt.datetime]` — If provided, will only return issues whose last incident time was after this datetime.
+
+
+
+
+
+-
+
+**last_incident_time_before:** `typing.Optional[dt.datetime]` — If provided, will only return issues whose last incident time was before this datetime.
+
+
+
+
+
+-
+
+**page_size:** `typing.Optional[int]` — Number of results to return per page.
+
+
+
+
+
+-
+
+**start_date:** `typing.Optional[str]` — If included, will only include issues whose most recent action occurred after this time
+
+
+
+
+
+-
+
+**status:** `typing.Optional[IssuesListRequestStatus]`
+
+Status of the issue. Options: ('ONGOING', 'RESOLVED')
+
+- `ONGOING` - ONGOING
+- `RESOLVED` - RESOLVED
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.ats.issues.retrieve(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Get a specific issue.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.ats.issues.retrieve(
+ id="id",
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**id:** `str`
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.ats.job_interview_stages.list(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a list of `JobInterviewStage` objects.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.ats.job_interview_stages.list()
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
+
+
+
+
+
+-
+
+**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
+
+
+
+
+
+-
+
+**cursor:** `typing.Optional[str]` — The pagination cursor value.
+
+
+
+
+
+-
+
+**expand:** `typing.Optional[typing.Literal["job"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+
+
+
+
+
+-
+
+**include_deleted_data:** `typing.Optional[bool]` — Whether to include data that was marked as deleted by third party webhooks.
+
+
+
+
+
+-
+
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
+
+
+
+
+
+-
+
+**job_id:** `typing.Optional[str]` — If provided, will only return interview stages for this job.
+
+
+
+
+
+-
+
+**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
+
+
+
+
+
+-
+
+**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
+
+
+
+
+
+-
+
+**page_size:** `typing.Optional[int]` — Number of results to return per page.
+
+
+
+
+
+-
+
+**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.ats.job_interview_stages.retrieve(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a `JobInterviewStage` object with the given `id`.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.ats.job_interview_stages.retrieve(
+ id="id",
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**id:** `str`
+
+
+
+
+
+-
+
+**expand:** `typing.Optional[typing.Literal["job"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+
+
+
+
+
+-
+
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.ats.job_postings.list(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a list of `JobPosting` objects.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.ats.job_postings.list()
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
+
+
+
+
+
+-
+
+**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
+
+
+
+
+
+-
+
+**cursor:** `typing.Optional[str]` — The pagination cursor value.
+
+
+
+
+
+-
+
+**expand:** `typing.Optional[typing.Literal["job"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+
+
+
+
+
+-
+
+**include_deleted_data:** `typing.Optional[bool]` — Whether to include data that was marked as deleted by third party webhooks.
+
+
+
+
+
+-
+
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
+
+
+
+
+
+-
+
+**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
+
+
+
+
+
+-
+
+**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
+
+
+
+
+
+-
+
+**page_size:** `typing.Optional[int]` — Number of results to return per page.
+
+
+
+
+
+-
+
+**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
+
+
+
+
+
+-
+
+**status:** `typing.Optional[JobPostingsListRequestStatus]`
+
+If provided, will only return Job Postings with this status. Options: ('PUBLISHED', 'CLOSED', 'DRAFT', 'INTERNAL', 'PENDING')
+
+- `PUBLISHED` - PUBLISHED
+- `CLOSED` - CLOSED
+- `DRAFT` - DRAFT
+- `INTERNAL` - INTERNAL
+- `PENDING` - PENDING
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.ats.job_postings.retrieve(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a `JobPosting` object with the given `id`.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.ats.job_postings.retrieve(
+ id="id",
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**id:** `str`
+
+
+
+
+
+-
+
+**expand:** `typing.Optional[typing.Literal["job"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+
+
+
+
+
+-
+
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.ats.jobs.list(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a list of `Job` objects.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.ats.jobs.list()
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**code:** `typing.Optional[str]` — If provided, will only return jobs with this code.
+
+
+
+
+
+-
+
+**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
+
+
+
+
+
+-
+
+**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
+
+
+
+
+
+-
+
+**cursor:** `typing.Optional[str]` — The pagination cursor value.
+
+
+
+
+
+-
+
+**expand:** `typing.Optional[JobsListRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+
+
+
+
+
+-
+
+**include_deleted_data:** `typing.Optional[bool]` — Whether to include data that was marked as deleted by third party webhooks.
+
+
+
+
+
+-
+
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
+
+
+
+
+
+-
+
+**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
+
+
+
+
+
+-
+
+**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
+
+
+
+
+
+-
+
+**offices:** `typing.Optional[str]` — If provided, will only return jobs for this office; multiple offices can be separated by commas.
+
+
+
+
+
+-
+
+**page_size:** `typing.Optional[int]` — Number of results to return per page.
+
+
+
+
+
+-
+
+**remote_fields:** `typing.Optional[typing.Literal["status"]]` — Deprecated. Use show_enum_origins.
+
+
+
+
+
+-
+
+**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
+
+
+
+
+
+-
+
+**show_enum_origins:** `typing.Optional[typing.Literal["status"]]` — A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter)
+
+
+
+
+
+-
+
+**status:** `typing.Optional[JobsListRequestStatus]`
+
+If provided, will only return jobs with this status. Options: ('OPEN', 'CLOSED', 'DRAFT', 'ARCHIVED', 'PENDING')
+
+- `OPEN` - OPEN
+- `CLOSED` - CLOSED
+- `DRAFT` - DRAFT
+- `ARCHIVED` - ARCHIVED
+- `PENDING` - PENDING
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.ats.jobs.retrieve(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a `Job` object with the given `id`.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.ats.jobs.retrieve(
+ id="id",
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**id:** `str`
+
+
+
+
+
+-
+
+**expand:** `typing.Optional[JobsRetrieveRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+
+
+
+
+
+-
+
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
+
+
+
+
+
+-
+
+**remote_fields:** `typing.Optional[typing.Literal["status"]]` — Deprecated. Use show_enum_origins.
+
+
+
+
+
+-
+
+**show_enum_origins:** `typing.Optional[typing.Literal["status"]]` — A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter)
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.ats.jobs.screening_questions_list(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a list of `ScreeningQuestion` objects.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.ats.jobs.screening_questions_list(
+ job_id="job_id",
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**job_id:** `str`
+
+
+
+
+
+-
+
+**cursor:** `typing.Optional[str]` — The pagination cursor value.
+
+
+
+
+
+-
+
+**expand:** `typing.Optional[JobsScreeningQuestionsListRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+
+
+
+
+
+-
+
+**include_deleted_data:** `typing.Optional[bool]` — Whether to include data that was marked as deleted by third party webhooks.
+
+
+
+
+
+-
+
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
+
+
+
+
+
+-
+
+**page_size:** `typing.Optional[int]` — Number of results to return per page.
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.ats.link_token.create(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Creates a link token to be used when linking a new end user.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+from merge.resources.ats import CategoriesEnum
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.ats.link_token.create(
+ end_user_email_address="example@gmail.com",
+ end_user_organization_name="Test Organization",
+ end_user_origin_id="12345",
+ categories=[CategoriesEnum.HRIS, CategoriesEnum.ATS],
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**end_user_email_address:** `str` — Your end user's email address. This is purely for identification purposes - setting this value will not cause any emails to be sent.
+
+
+
+
+
+-
+
+**end_user_organization_name:** `str` — Your end user's organization.
+
+
+
+
+
+-
+
+**end_user_origin_id:** `str` — This unique identifier typically represents the ID for your end user in your product's database. This value must be distinct from other Linked Accounts' unique identifiers.
+
+
+
+
+
+-
+
+**categories:** `typing.Sequence[CategoriesEnum]` — The integration categories to show in Merge Link.
+
+
+
+
+
+-
+
+**integration:** `typing.Optional[str]` — The slug of a specific pre-selected integration for this linking flow token. For examples of slugs, see https://docs.merge.dev/guides/merge-link/single-integration/.
+
+
+
+
+
+-
+
+**link_expiry_mins:** `typing.Optional[int]` — An integer number of minutes between [30, 720 or 10080 if for a Magic Link URL] for how long this token is valid. Defaults to 30.
+
+
+
+
+
+-
+
+**should_create_magic_link_url:** `typing.Optional[bool]` — Whether to generate a Magic Link URL. Defaults to false. For more information on Magic Link, see https://merge.dev/blog/integrations-fast-say-hello-to-magic-link.
+
+
+
+
+
+-
+
+**common_models:** `typing.Optional[typing.Sequence[CommonModelScopesBodyRequest]]` — An array of objects to specify the models and fields that will be disabled for a given Linked Account. Each object uses model_id, enabled_actions, and disabled_fields to specify the model, method, and fields that are scoped for a given Linked Account.
+
+
+
+
+
+-
+
+**category_common_model_scopes:** `typing.Optional[
+ typing.Dict[
+ str,
+ typing.Optional[
+ typing.Sequence[IndividualCommonModelScopeDeserializerRequest]
+ ],
+ ]
+]` — When creating a Link Token, you can set permissions for Common Models that will apply to the account that is going to be linked. Any model or field not specified in link token payload will default to existing settings.
+
+
+
+
+
+-
+
+**language:** `typing.Optional[str]` — The language code for the language to localize Merge Link to.
+
+
+
+
+
+-
+
+**integration_specific_config:** `typing.Optional[typing.Dict[str, typing.Any]]` — A JSON object containing integration-specific configuration options.
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.ats.linked_accounts.list(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+List linked accounts for your organization.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.ats.linked_accounts.list()
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**category:** `typing.Optional[LinkedAccountsListRequestCategory]`
+
+Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing`
+
+- `hris` - hris
+- `ats` - ats
+- `accounting` - accounting
+- `ticketing` - ticketing
+- `crm` - crm
+- `mktg` - mktg
+- `filestorage` - filestorage
+
+
+
+
+
+-
+
+**cursor:** `typing.Optional[str]` — The pagination cursor value.
+
+
+
+
+
+-
+
+**end_user_email_address:** `typing.Optional[str]` — If provided, will only return linked accounts associated with the given email address.
+
+
+
+
+
+-
+
+**end_user_organization_name:** `typing.Optional[str]` — If provided, will only return linked accounts associated with the given organization name.
+
+
+
+
+
+-
+
+**end_user_origin_id:** `typing.Optional[str]` — If provided, will only return linked accounts associated with the given origin ID.
+
+
+
+
+
+-
+
+**end_user_origin_ids:** `typing.Optional[str]` — Comma-separated list of EndUser origin IDs, making it possible to specify multiple EndUsers at once.
+
+
+
+
+
+-
+
+**id:** `typing.Optional[str]`
+
+
+
+
+
+-
+
+**ids:** `typing.Optional[str]` — Comma-separated list of LinkedAccount IDs, making it possible to specify multiple LinkedAccounts at once.
+
+
+
+
+
+-
+
+**include_duplicates:** `typing.Optional[bool]` — If `true`, will include complete production duplicates of the account specified by the `id` query parameter in the response. `id` must be for a complete production linked account.
+
+
+
+
+
+-
+
+**integration_name:** `typing.Optional[str]` — If provided, will only return linked accounts associated with the given integration name.
+
+
+
+
+
+-
+
+**is_test_account:** `typing.Optional[str]` — If included, will only include test linked accounts. If not included, will only include non-test linked accounts.
+
+
+
+
+
+-
+
+**page_size:** `typing.Optional[int]` — Number of results to return per page.
+
+
+
+
+
+-
+
+**status:** `typing.Optional[str]` — Filter by status. Options: `COMPLETE`, `INCOMPLETE`, `RELINK_NEEDED`
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.ats.offers.list(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a list of `Offer` objects.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.ats.offers.list()
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**application_id:** `typing.Optional[str]` — If provided, will only return offers for this application.
+
+
+
+
+
+-
+
+**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
+
+
+
+
+
+-
+
+**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
+
+
+
+
+
+-
+
+**creator_id:** `typing.Optional[str]` — If provided, will only return offers created by this user.
+
+
+
+
+
+-
+
+**cursor:** `typing.Optional[str]` — The pagination cursor value.
+
+
+
+
+
+-
+
+**expand:** `typing.Optional[OffersListRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+
+
+
+
+
+-
+
+**include_deleted_data:** `typing.Optional[bool]` — Whether to include data that was marked as deleted by third party webhooks.
+
+
+
+
+
+-
+
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
+
+
+
+
+
+-
+
+**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
+
+
+
+
+
+-
+
+**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
+
+
+
+
+
+-
+
+**page_size:** `typing.Optional[int]` — Number of results to return per page.
+
+
+
+
+
+-
+
+**remote_fields:** `typing.Optional[typing.Literal["status"]]` — Deprecated. Use show_enum_origins.
+
+
+
+
+
+-
+
+**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
+
+
+
+
+
+-
+
+**show_enum_origins:** `typing.Optional[typing.Literal["status"]]` — A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter)
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.ats.offers.retrieve(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns an `Offer` object with the given `id`.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.ats.offers.retrieve(
+ id="id",
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**id:** `str`
+
+
+
+
+
+-
+
+**expand:** `typing.Optional[OffersRetrieveRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+
+
+
+
+
+-
+
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
+
+
+
+
+
+-
+
+**remote_fields:** `typing.Optional[typing.Literal["status"]]` — Deprecated. Use show_enum_origins.
+
+
+
+
+
+-
+
+**show_enum_origins:** `typing.Optional[typing.Literal["status"]]` — A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter)
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.ats.offices.list(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a list of `Office` objects.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.ats.offices.list()
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
+
+
+
+
+
+-
+
+**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
+
+
+
+
+
+-
+
+**cursor:** `typing.Optional[str]` — The pagination cursor value.
+
+
+
+
+
+-
+
+**include_deleted_data:** `typing.Optional[bool]` — Whether to include data that was marked as deleted by third party webhooks.
+
+
+
+
+
+-
+
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
+
+
+
+
+
+-
+
+**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
+
+
+
+
+
+-
+
+**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
+
+
+
+
+
+-
+
+**page_size:** `typing.Optional[int]` — Number of results to return per page.
+
+
+
+
+
+-
+
+**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.ats.offices.retrieve(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns an `Office` object with the given `id`.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.ats.offices.retrieve(
+ id="id",
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**id:** `str`
+
+
+
+
+
+-
+
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.ats.passthrough.create(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Pull data from an endpoint not currently supported by Merge.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+from merge.resources.ats import DataPassthroughRequest, MethodEnum
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.ats.passthrough.create(
+ request=DataPassthroughRequest(
+ method=MethodEnum.GET,
+ path="/scooters",
+ ),
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request:** `DataPassthroughRequest`
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.ats.regenerate_key.create(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Exchange remote keys.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.ats.regenerate_key.create(
+ name="Remote Deployment Key 1",
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**name:** `str` — The name of the remote key
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.ats.reject_reasons.list(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a list of `RejectReason` objects.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.ats.reject_reasons.list()
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
+
+
+
+
+
+-
+
+**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
+
+
+
+
+
+-
+
+**cursor:** `typing.Optional[str]` — The pagination cursor value.
+
+
+
+
+
+-
+
+**include_deleted_data:** `typing.Optional[bool]` — Whether to include data that was marked as deleted by third party webhooks.
+
+
+
+
+
+-
+
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
+
+
+
+
+
+-
+
+**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
+
+
+
+
+
+-
+
+**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
+
+
+
+
+
+-
+
+**page_size:** `typing.Optional[int]` — Number of results to return per page.
+
+
+
+
+
+-
+
+**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.ats.reject_reasons.retrieve(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a `RejectReason` object with the given `id`.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.ats.reject_reasons.retrieve(
+ id="id",
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**id:** `str`
+
+
+
+
+
+-
+
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.ats.scorecards.list(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a list of `Scorecard` objects.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.ats.scorecards.list()
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**application_id:** `typing.Optional[str]` — If provided, will only return scorecards for this application.
+
+
+
+
+
+-
+
+**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
+
+
+
+
+
+-
+
+**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
+
+
+
+
+
+-
+
+**cursor:** `typing.Optional[str]` — The pagination cursor value.
+
+
+
+
+
+-
+
+**expand:** `typing.Optional[ScorecardsListRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+
+
+
+
+
+-
+
+**include_deleted_data:** `typing.Optional[bool]` — Whether to include data that was marked as deleted by third party webhooks.
+
+
+
+
+
+-
+
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
+
+
+
+
+
+-
+
+**interview_id:** `typing.Optional[str]` — If provided, will only return scorecards for this interview.
+
+
+
+
+
+-
+
+**interviewer_id:** `typing.Optional[str]` — If provided, will only return scorecards for this interviewer.
+
+
+
+
+
+-
+
+**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
+
+
+
+
+
+-
+
+**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
+
+
+
+
+
+-
+
+**page_size:** `typing.Optional[int]` — Number of results to return per page.
+
+
+
+
+
+-
+
+**remote_fields:** `typing.Optional[typing.Literal["overall_recommendation"]]` — Deprecated. Use show_enum_origins.
+
+
+
+
+
+-
+
+**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
+
+
+
+
+
+-
+
+**show_enum_origins:** `typing.Optional[typing.Literal["overall_recommendation"]]` — A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter)
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.ats.scorecards.retrieve(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a `Scorecard` object with the given `id`.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.ats.scorecards.retrieve(
+ id="id",
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**id:** `str`
+
+
+
+
+
+-
+
+**expand:** `typing.Optional[ScorecardsRetrieveRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+
+
+
+
+
+-
+
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
+
+
+
+
+
+-
+
+**remote_fields:** `typing.Optional[typing.Literal["overall_recommendation"]]` — Deprecated. Use show_enum_origins.
+
+
+
+
+
+-
+
+**show_enum_origins:** `typing.Optional[typing.Literal["overall_recommendation"]]` — A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter)
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.ats.sync_status.list(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Get syncing status. Possible values: `DISABLED`, `DONE`, `FAILED`, `PARTIALLY_SYNCED`, `PAUSED`, `SYNCING`. Learn more about sync status in our [Help Center](https://help.merge.dev/en/articles/8184193-merge-sync-statuses).
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.ats.sync_status.list()
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**cursor:** `typing.Optional[str]` — The pagination cursor value.
+
+
+
+
+
+-
+
+**page_size:** `typing.Optional[int]` — Number of results to return per page.
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.ats.force_resync.sync_status_resync_create()
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Force re-sync of all models. This is available for all organizations via the dashboard. Force re-sync is also available programmatically via API for monthly, quarterly, and highest sync frequency customers on the Launch, Professional, or Enterprise plans. Doing so will consume a sync credit for the relevant linked account.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.ats.force_resync.sync_status_resync_create()
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.ats.tags.list(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a list of `Tag` objects.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.ats.tags.list()
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
+
+
+
+
+
+-
+
+**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
+
+
+
+
+
+-
+
+**cursor:** `typing.Optional[str]` — The pagination cursor value.
+
+
+
+
+
+-
+
+**include_deleted_data:** `typing.Optional[bool]` — Whether to include data that was marked as deleted by third party webhooks.
+
+
+
+
+
+-
+
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
+
+
+
+
+
+-
+
+**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
+
+
+
+
+
+-
+
+**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
+
+
+
+
+
+-
+
+**page_size:** `typing.Optional[int]` — Number of results to return per page.
+
+
+
+
+
+-
+
+**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.ats.users.list(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a list of `RemoteUser` objects.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.ats.users.list()
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
+
+
+
+
+
+-
+
+**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
+
+
+
+
+
+-
+
+**cursor:** `typing.Optional[str]` — The pagination cursor value.
+
+
+
+
+
+-
+
+**email:** `typing.Optional[str]` — If provided, will only return remote users with the given email address
+
+
+
+
+
+-
+
+**include_deleted_data:** `typing.Optional[bool]` — Whether to include data that was marked as deleted by third party webhooks.
+
+
+
+
+
+-
+
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
+
+
+
+
+
+-
+
+**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
+
+
+
+
+
+-
+
+**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
+
+
+
+
+
+-
+
+**page_size:** `typing.Optional[int]` — Number of results to return per page.
+
+
+
+
+
+-
+
+**remote_fields:** `typing.Optional[typing.Literal["access_role"]]` — Deprecated. Use show_enum_origins.
+
+
+
+
+
+-
+
+**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
+
+
+
+
+
+-
+
+**show_enum_origins:** `typing.Optional[typing.Literal["access_role"]]` — A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter)
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.ats.users.retrieve(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a `RemoteUser` object with the given `id`.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.ats.users.retrieve(
+ id="id",
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**id:** `str`
+
+
+
+
+
+-
+
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
+
+
+
+
+
+-
+
+**remote_fields:** `typing.Optional[typing.Literal["access_role"]]` — Deprecated. Use show_enum_origins.
+
+
+
+
+
+-
+
+**show_enum_origins:** `typing.Optional[typing.Literal["access_role"]]` — A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter)
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.ats.webhook_receivers.list()
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a list of `WebhookReceiver` objects.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.ats.webhook_receivers.list()
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.ats.webhook_receivers.create(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Creates a `WebhookReceiver` object with the given values.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.ats.webhook_receivers.create(
+ event="event",
+ is_active=True,
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**event:** `str`
+
+
+
+
+
+-
+
+**is_active:** `bool`
+
+
+
+
+
+-
+
+**key:** `typing.Optional[str]`
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.hris.account_details.retrieve()
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Get details for a linked account.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.hris.account_details.retrieve()
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.hris.account_token.retrieve(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns the account token for the end user with the provided public token.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.hris.account_token.retrieve(
+ public_token="public_token",
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**public_token:** `str`
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.hris.async_passthrough.create(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Asynchronously pull data from an endpoint not currently supported by Merge.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+from merge.resources.hris import DataPassthroughRequest, MethodEnum
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.hris.async_passthrough.create(
+ request=DataPassthroughRequest(
+ method=MethodEnum.GET,
+ path="/scooters",
+ ),
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request:** `DataPassthroughRequest`
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.hris.async_passthrough.retrieve(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Retrieves data from earlier async-passthrough POST request
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.hris.async_passthrough.retrieve(
+ async_passthrough_receipt_id="async_passthrough_receipt_id",
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**async_passthrough_receipt_id:** `str`
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.hris.audit_trail.list(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Gets a list of audit trail events.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.hris.audit_trail.list()
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**cursor:** `typing.Optional[str]` — The pagination cursor value.
+
+
+
+
+
+-
+
+**end_date:** `typing.Optional[str]` — If included, will only include audit trail events that occurred before this time
+
+
+
+
+
+-
+
+**event_type:** `typing.Optional[str]` — If included, will only include events with the given event type. Possible values include: `CREATED_REMOTE_PRODUCTION_API_KEY`, `DELETED_REMOTE_PRODUCTION_API_KEY`, `CREATED_TEST_API_KEY`, `DELETED_TEST_API_KEY`, `REGENERATED_PRODUCTION_API_KEY`, `INVITED_USER`, `TWO_FACTOR_AUTH_ENABLED`, `TWO_FACTOR_AUTH_DISABLED`, `DELETED_LINKED_ACCOUNT`, `CREATED_DESTINATION`, `DELETED_DESTINATION`, `CHANGED_DESTINATION`, `CHANGED_SCOPES`, `CHANGED_PERSONAL_INFORMATION`, `CHANGED_ORGANIZATION_SETTINGS`, `ENABLED_INTEGRATION`, `DISABLED_INTEGRATION`, `ENABLED_CATEGORY`, `DISABLED_CATEGORY`, `CHANGED_PASSWORD`, `RESET_PASSWORD`, `ENABLED_REDACT_UNMAPPED_DATA_FOR_ORGANIZATION`, `ENABLED_REDACT_UNMAPPED_DATA_FOR_LINKED_ACCOUNT`, `DISABLED_REDACT_UNMAPPED_DATA_FOR_ORGANIZATION`, `DISABLED_REDACT_UNMAPPED_DATA_FOR_LINKED_ACCOUNT`, `CREATED_INTEGRATION_WIDE_FIELD_MAPPING`, `CREATED_LINKED_ACCOUNT_FIELD_MAPPING`, `CHANGED_INTEGRATION_WIDE_FIELD_MAPPING`, `CHANGED_LINKED_ACCOUNT_FIELD_MAPPING`, `DELETED_INTEGRATION_WIDE_FIELD_MAPPING`, `DELETED_LINKED_ACCOUNT_FIELD_MAPPING`, `FORCED_LINKED_ACCOUNT_RESYNC`, `MUTED_ISSUE`, `GENERATED_MAGIC_LINK`, `ENABLED_MERGE_WEBHOOK`, `DISABLED_MERGE_WEBHOOK`, `MERGE_WEBHOOK_TARGET_CHANGED`
+
+
+
+
+
+-
+
+**page_size:** `typing.Optional[int]` — Number of results to return per page.
+
+
+
+
+
+-
+
+**start_date:** `typing.Optional[str]` — If included, will only include audit trail events that occurred after this time
+
+
+
+
+
+-
+
+**user_email:** `typing.Optional[str]` — If provided, this will return events associated with the specified user email. Please note that the email address reflects the user's email at the time of the event, and may not be their current email.
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.hris.available_actions.retrieve()
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a list of models and actions available for an account.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.hris.available_actions.retrieve()
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.hris.bank_info.list(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a list of `BankInfo` objects.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.hris.bank_info.list()
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**account_type:** `typing.Optional[BankInfoListRequestAccountType]`
+
+If provided, will only return BankInfo's with this account type. Options: ('SAVINGS', 'CHECKING')
+
+- `SAVINGS` - SAVINGS
+- `CHECKING` - CHECKING
+
+
+
+
+
+-
+
+**bank_name:** `typing.Optional[str]` — If provided, will only return BankInfo's with this bank name.
+
+
+
+
+
+-
+
+**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
+
+
+
+
+
+-
+
+**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
+
+
+
+
+
+-
+
+**cursor:** `typing.Optional[str]` — The pagination cursor value.
+
+
+
+
+
+-
+
+**employee_id:** `typing.Optional[str]` — If provided, will only return bank accounts for this employee.
+
+
+
+
+
+-
+
+**expand:** `typing.Optional[typing.Literal["employee"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+
+
+
+
+
+-
+
+**include_deleted_data:** `typing.Optional[bool]` — Whether to include data that was marked as deleted by third party webhooks.
+
+
+
+
+
+-
+
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
+
+
+
+
+
+-
+
+**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
+
+
+
+
+
+-
+
+**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
+
+
+
+
+
+-
+
+**order_by:** `typing.Optional[BankInfoListRequestOrderBy]` — Overrides the default ordering for this endpoint.
+
+
+
+
+
+-
+
+**page_size:** `typing.Optional[int]` — Number of results to return per page.
+
+
+
+
+
+-
+
+**remote_fields:** `typing.Optional[typing.Literal["account_type"]]` — Deprecated. Use show_enum_origins.
+
+
+
+
+
+-
+
+**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
+
+
+
+
+
+-
+
+**show_enum_origins:** `typing.Optional[typing.Literal["account_type"]]` — A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter)
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.hris.bank_info.retrieve(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a `BankInfo` object with the given `id`.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.hris.bank_info.retrieve(
+ id="id",
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**id:** `str`
+
+
+
+
+
+-
+
+**expand:** `typing.Optional[typing.Literal["employee"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+
+
+
+
+
+-
+
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
+
+
+
+
+
+-
+
+**remote_fields:** `typing.Optional[typing.Literal["account_type"]]` — Deprecated. Use show_enum_origins.
+
+
+
+
+
+-
+
+**show_enum_origins:** `typing.Optional[typing.Literal["account_type"]]` — A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter)
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.hris.benefits.list(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a list of `Benefit` objects.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.hris.benefits.list()
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
+
+
+
+
+
+-
+
+**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
+
+
+
+
+
+-
+
+**cursor:** `typing.Optional[str]` — The pagination cursor value.
+
+
+
+
+
+-
+
+**employee_id:** `typing.Optional[str]` — If provided, will return the benefits associated with the employee.
+
+
+
+
+
+-
+
+**expand:** `typing.Optional[typing.Literal["employee"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+
+
+
+
+
+-
+
+**include_deleted_data:** `typing.Optional[bool]` — Whether to include data that was marked as deleted by third party webhooks.
+
+
+
+
+
+-
+
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
+
+
+
+
+
+-
+
+**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
+
+
+
+
+
+-
+
+**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
+
+
+
+
+
+-
+
+**page_size:** `typing.Optional[int]` — Number of results to return per page.
+
+
+
+
+
+-
+
+**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.hris.benefits.retrieve(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a `Benefit` object with the given `id`.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.hris.benefits.retrieve(
+ id="id",
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**id:** `str`
+
+
+
+
+
+-
+
+**expand:** `typing.Optional[typing.Literal["employee"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+
+
+
+
+
+-
+
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.hris.companies.list(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a list of `Company` objects.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.hris.companies.list()
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
+
+
+
+
+
+-
+
+**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
+
+
+
+
+
+-
+
+**cursor:** `typing.Optional[str]` — The pagination cursor value.
+
+
+
+
+
+-
+
+**include_deleted_data:** `typing.Optional[bool]` — Whether to include data that was marked as deleted by third party webhooks.
+
+
+
+
+
+-
+
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
+
+
+
+
+
+-
+
+**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
+
+
+
+
+
+-
+
+**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
+
+
+
+
+
+-
+
+**page_size:** `typing.Optional[int]` — Number of results to return per page.
+
+
+
+
+
+-
+
+**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.hris.companies.retrieve(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a `Company` object with the given `id`.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.hris.companies.retrieve(
+ id="id",
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**id:** `str`
+
+
+
+
+
+-
+
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.hris.scopes.default_scopes_retrieve()
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Get the default permissions for Merge Common Models and fields across all Linked Accounts of a given category. [Learn more](https://help.merge.dev/en/articles/8828211-common-model-and-field-scopes).
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.hris.scopes.default_scopes_retrieve()
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.hris.scopes.linked_account_scopes_retrieve()
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Get all available permissions for Merge Common Models and fields for a single Linked Account. [Learn more](https://help.merge.dev/en/articles/8828211-common-model-and-field-scopes).
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.hris.scopes.linked_account_scopes_retrieve()
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.hris.scopes.linked_account_scopes_create(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Update permissions for any Common Model or field for a single Linked Account. Any Scopes not set in this POST request will inherit the default Scopes. [Learn more](https://help.merge.dev/en/articles/8828211-common-model-and-field-scopes)
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+from merge.resources.hris import (
+ IndividualCommonModelScopeDeserializerRequest,
+ ModelPermissionDeserializerRequest,
+)
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.hris.scopes.linked_account_scopes_create(
+ common_models=[
+ IndividualCommonModelScopeDeserializerRequest(
+ model_name="Employee",
+ model_permissions={
+ "READ": ModelPermissionDeserializerRequest(
+ is_enabled=True,
+ ),
+ "WRITE": ModelPermissionDeserializerRequest(
+ is_enabled=False,
+ ),
+ },
+ ),
+ IndividualCommonModelScopeDeserializerRequest(
+ model_name="Benefit",
+ model_permissions={
+ "WRITE": ModelPermissionDeserializerRequest(
+ is_enabled=False,
+ )
+ },
+ ),
+ ],
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**common_models:** `typing.Sequence[IndividualCommonModelScopeDeserializerRequest]` — The common models you want to update the scopes for
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.hris.delete_account.delete()
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Delete a linked account.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.hris.delete_account.delete()
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.hris.dependents.list(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a list of `Dependent` objects.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.hris.dependents.list()
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
+
+
+
+
+
+-
+
+**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
+
+
+
+
+
+-
+
+**cursor:** `typing.Optional[str]` — The pagination cursor value.
+
+
+
+
+
+-
+
+**include_deleted_data:** `typing.Optional[bool]` — Whether to include data that was marked as deleted by third party webhooks.
+
+
+
+
+
+-
+
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
+
+
+
+
+
+-
+
+**include_sensitive_fields:** `typing.Optional[bool]` — Whether to include sensitive fields (such as social security numbers) in the response.
+
+
+
+
+
+-
+
+**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
+
+
+
+
+
+-
+
+**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
+
+
+
+
+
+-
+
+**page_size:** `typing.Optional[int]` — Number of results to return per page.
+
+
+
+
+
+-
+
+**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.hris.dependents.retrieve(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a `Dependent` object with the given `id`.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.hris.dependents.retrieve(
+ id="id",
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**id:** `str`
+
+
+
+
+
+-
+
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
+
+
+
+
+
+-
+
+**include_sensitive_fields:** `typing.Optional[bool]` — Whether to include sensitive fields (such as social security numbers) in the response.
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.hris.employee_payroll_runs.list(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a list of `EmployeePayrollRun` objects.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.hris.employee_payroll_runs.list()
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
+
+
+
+
+
+-
+
+**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
+
+
+
+
+
+-
+
+**cursor:** `typing.Optional[str]` — The pagination cursor value.
+
+
+
+
+
+-
+
+**employee_id:** `typing.Optional[str]` — If provided, will only return employee payroll runs for this employee.
+
+
+
+
+
+-
+
+**ended_after:** `typing.Optional[dt.datetime]` — If provided, will only return employee payroll runs ended after this datetime.
+
+
+
+
+
+-
+
+**ended_before:** `typing.Optional[dt.datetime]` — If provided, will only return employee payroll runs ended before this datetime.
+
+
+
+
+
+-
+
+**expand:** `typing.Optional[EmployeePayrollRunsListRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+
+
+
+
+
+-
+
+**include_deleted_data:** `typing.Optional[bool]` — Whether to include data that was marked as deleted by third party webhooks.
+
+
+
+
+
+-
+
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
+
+
+
+
+
+-
+
+**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
+
+
+
+
+
+-
+
+**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
+
+
+
+
+
+-
+
+**page_size:** `typing.Optional[int]` — Number of results to return per page.
+
+
+
+
+
+-
+
+**payroll_run_id:** `typing.Optional[str]` — If provided, will only return employee payroll runs for this employee.
+
+
+
+
+
+-
+
+**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
+
+
+
+
+
+-
+
+**started_after:** `typing.Optional[dt.datetime]` — If provided, will only return employee payroll runs started after this datetime.
+
+
+
+
+
+-
+
+**started_before:** `typing.Optional[dt.datetime]` — If provided, will only return employee payroll runs started before this datetime.
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.hris.employee_payroll_runs.retrieve(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns an `EmployeePayrollRun` object with the given `id`.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.hris.employee_payroll_runs.retrieve(
+ id="id",
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**id:** `str`
+
+
+
+
+
+-
+
+**expand:** `typing.Optional[EmployeePayrollRunsRetrieveRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+
+
+
+
+
+-
+
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.hris.employees.list(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a list of `Employee` objects.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.hris.employees.list()
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**company_id:** `typing.Optional[str]` — If provided, will only return employees for this company.
+
+
+
+
+
+-
+
+**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
+
+
+
+
+
+-
+
+**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
+
+
+
+
+
+-
+
+**cursor:** `typing.Optional[str]` — The pagination cursor value.
+
+
+
+
+
+-
+
+**display_full_name:** `typing.Optional[str]` — If provided, will only return employees with this display name.
+
+
+
+
+
+-
+
+**employment_status:** `typing.Optional[EmployeesListRequestEmploymentStatus]`
+
+If provided, will only return employees with this employment status.
+
+- `ACTIVE` - ACTIVE
+- `PENDING` - PENDING
+- `INACTIVE` - INACTIVE
+
+
+
+
+
+-
+
+**employment_type:** `typing.Optional[str]` — If provided, will only return employees that have an employment of the specified employment_type.
+
+
+
+
+
+-
+
+**expand:** `typing.Optional[EmployeesListRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+
+
+
+
+
+-
+
+**first_name:** `typing.Optional[str]` — If provided, will only return employees with this first name.
+
+
+
+
+
+-
+
+**groups:** `typing.Optional[str]` — If provided, will only return employees matching the group ids; multiple groups can be separated by commas.
+
+
+
+
+
+-
+
+**home_location_id:** `typing.Optional[str]` — If provided, will only return employees for this home location.
+
+
+
+
+
+-
+
+**include_deleted_data:** `typing.Optional[bool]` — Whether to include data that was marked as deleted by third party webhooks.
+
+
+
+
+
+-
+
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
+
+
+
+
+
+-
+
+**include_sensitive_fields:** `typing.Optional[bool]` — Whether to include sensitive fields (such as social security numbers) in the response.
+
+
+
+
+
+-
+
+**job_title:** `typing.Optional[str]` — If provided, will only return employees that have an employment of the specified job_title.
+
+
+
+
+
+-
+
+**last_name:** `typing.Optional[str]` — If provided, will only return employees with this last name.
+
+
+
+
+
+-
+
+**manager_id:** `typing.Optional[str]` — If provided, will only return employees for this manager.
+
+
+
+
+
+-
+
+**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
+
+
+
+
+
+-
+
+**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
+
+
+
+
+
+-
+
+**page_size:** `typing.Optional[int]` — Number of results to return per page.
+
+
+
+
+
+-
+
+**pay_group_id:** `typing.Optional[str]` — If provided, will only return employees for this pay group
+
+
+
+
+
+-
+
+**personal_email:** `typing.Optional[str]` — If provided, will only return Employees with this personal email
+
+
+
+
+
+-
+
+**remote_fields:** `typing.Optional[EmployeesListRequestRemoteFields]` — Deprecated. Use show_enum_origins.
+
+
+
+
+
+-
+
+**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
+
+
+
+
+
+-
+
+**show_enum_origins:** `typing.Optional[EmployeesListRequestShowEnumOrigins]` — A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter)
+
+
+
+
+
+-
+
+**started_after:** `typing.Optional[dt.datetime]` — If provided, will only return employees that started after this datetime.
+
+
+
+
+
+-
+
+**started_before:** `typing.Optional[dt.datetime]` — If provided, will only return employees that started before this datetime.
+
+
+
+
+
+-
+
+**team_id:** `typing.Optional[str]` — If provided, will only return employees for this team.
+
+
+
+
+
+-
+
+**terminated_after:** `typing.Optional[dt.datetime]` — If provided, will only return employees that were terminated after this datetime.
+
+
+
+
+
+-
+
+**terminated_before:** `typing.Optional[dt.datetime]` — If provided, will only return employees that were terminated before this datetime.
+
+
+
+
+
+-
+
+**work_email:** `typing.Optional[str]` — If provided, will only return Employees with this work email
+
+
+
+
+
+-
+
+**work_location_id:** `typing.Optional[str]` — If provided, will only return employees for this location.
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.hris.employees.create(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Creates an `Employee` object with the given values.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+from merge.resources.hris import EmployeeRequest
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.hris.employees.create(
+ model=EmployeeRequest(),
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**model:** `EmployeeRequest`
+
+
+
+
+
+-
+
+**is_debug_mode:** `typing.Optional[bool]` — Whether to include debug fields (such as log file links) in the response.
+
+
+
+
+
+-
+
+**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously.
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.hris.employees.retrieve(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns an `Employee` object with the given `id`.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.hris.employees.retrieve(
+ id="id",
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**id:** `str`
+
+
+
+
+
+-
+
+**expand:** `typing.Optional[EmployeesRetrieveRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+
+
+
+
+
+-
+
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
+
+
+
+
+
+-
+
+**include_sensitive_fields:** `typing.Optional[bool]` — Whether to include sensitive fields (such as social security numbers) in the response.
+
+
+
+
+
+-
+
+**remote_fields:** `typing.Optional[EmployeesRetrieveRequestRemoteFields]` — Deprecated. Use show_enum_origins.
+
+
+
+
+
+-
+
+**show_enum_origins:** `typing.Optional[EmployeesRetrieveRequestShowEnumOrigins]` — A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter)
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.hris.employees.ignore_create(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Ignores a specific row based on the `model_id` in the url. These records will have their properties set to null, and will not be updated in future syncs. The "reason" and "message" fields in the request body will be stored for audit purposes.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+from merge.resources.hris import ReasonEnum
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.hris.employees.ignore_create(
+ model_id="model_id",
+ reason=ReasonEnum.GENERAL_CUSTOMER_REQUEST,
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**model_id:** `str`
+
+
+
+
+
+-
+
+**reason:** `IgnoreCommonModelRequestReason`
+
+
+
+
+
+-
+
+**message:** `typing.Optional[str]`
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.hris.employees.meta_post_retrieve()
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns metadata for `Employee` POSTs.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.hris.employees.meta_post_retrieve()
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.hris.employer_benefits.list(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a list of `EmployerBenefit` objects.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.hris.employer_benefits.list()
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
+
+
+
+
+
+-
+
+**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
+
+
+
+
+
+-
+
+**cursor:** `typing.Optional[str]` — The pagination cursor value.
+
+
+
+
+
+-
+
+**include_deleted_data:** `typing.Optional[bool]` — Whether to include data that was marked as deleted by third party webhooks.
+
+
+
+
+
+-
+
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
+
+
+
+
+
+-
+
+**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
+
+
+
+
+
+-
+
+**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
+
+
+
+
+
+-
+
+**page_size:** `typing.Optional[int]` — Number of results to return per page.
+
+
+
+
+
+-
+
+**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.hris.employer_benefits.retrieve(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns an `EmployerBenefit` object with the given `id`.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.hris.employer_benefits.retrieve(
+ id="id",
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**id:** `str`
+
+
+
+
+
+-
+
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.hris.employments.list(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a list of `Employment` objects.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.hris.employments.list()
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
+
+
+
+
+
+-
+
+**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
+
+
+
+
+
+-
+
+**cursor:** `typing.Optional[str]` — The pagination cursor value.
+
+
+
+
+
+-
+
+**employee_id:** `typing.Optional[str]` — If provided, will only return employments for this employee.
+
+
+
+
+
+-
+
+**expand:** `typing.Optional[EmploymentsListRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+
+
+
+
+
+-
+
+**include_deleted_data:** `typing.Optional[bool]` — Whether to include data that was marked as deleted by third party webhooks.
+
+
+
+
+
+-
+
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
+
+
+
+
+
+-
+
+**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
+
+
+
+
+
+-
+
+**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
+
+
+
+
+
+-
+
+**order_by:** `typing.Optional[EmploymentsListRequestOrderBy]` — Overrides the default ordering for this endpoint.
+
+
+
+
+
+-
+
+**page_size:** `typing.Optional[int]` — Number of results to return per page.
+
+
+
+
+
+-
+
+**remote_fields:** `typing.Optional[EmploymentsListRequestRemoteFields]` — Deprecated. Use show_enum_origins.
+
+
+
+
+
+-
+
+**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
+
+
+
+
+
+-
+
+**show_enum_origins:** `typing.Optional[EmploymentsListRequestShowEnumOrigins]` — A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter)
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.hris.employments.retrieve(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns an `Employment` object with the given `id`.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.hris.employments.retrieve(
+ id="id",
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**id:** `str`
+
+
+
+
+
+-
+
+**expand:** `typing.Optional[EmploymentsRetrieveRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+
+
+
+
+
+-
+
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
+
+
+
+
+
+-
+
+**remote_fields:** `typing.Optional[EmploymentsRetrieveRequestRemoteFields]` — Deprecated. Use show_enum_origins.
+
+
+
+
+
+-
+
+**show_enum_origins:** `typing.Optional[EmploymentsRetrieveRequestShowEnumOrigins]` — A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter)
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.hris.field_mapping.field_mappings_retrieve()
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Get all Field Mappings for this Linked Account. Field Mappings are mappings between third-party Remote Fields and user defined Merge fields. [Learn more](https://docs.merge.dev/supplemental-data/field-mappings/overview/).
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.hris.field_mapping.field_mappings_retrieve()
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.hris.field_mapping.field_mappings_create(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Create new Field Mappings that will be available after the next scheduled sync. This will cause the next sync for this Linked Account to sync **ALL** data from start.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.hris.field_mapping.field_mappings_create(
+ target_field_name="example_target_field_name",
+ target_field_description="this is a example description of the target field",
+ remote_field_traversal_path=["example_remote_field"],
+ remote_method="GET",
+ remote_url_path="/example-url-path",
+ common_model_name="ExampleCommonModel",
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**target_field_name:** `str` — The name of the target field you want this remote field to map to.
+
+
+
+
+
+-
+
+**target_field_description:** `str` — The description of the target field you want this remote field to map to.
+
+
+
+
+
+-
+
+**remote_field_traversal_path:** `typing.Sequence[typing.Any]` — The field traversal path of the remote field listed when you hit the GET /remote-fields endpoint.
+
+
+
+
+
+-
+
+**remote_method:** `str` — The method of the remote endpoint where the remote field is coming from.
+
+
+
+
+
+-
+
+**remote_url_path:** `str` — The path of the remote endpoint where the remote field is coming from.
+
+
+
+
+
+-
+
+**common_model_name:** `str` — The name of the Common Model that the remote field corresponds to in a given category.
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.hris.field_mapping.field_mappings_destroy(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Deletes Field Mappings for a Linked Account. All data related to this Field Mapping will be deleted and these changes will be reflected after the next scheduled sync. This will cause the next sync for this Linked Account to sync **ALL** data from start.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.hris.field_mapping.field_mappings_destroy(
+ field_mapping_id="field_mapping_id",
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**field_mapping_id:** `str`
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.hris.field_mapping.field_mappings_partial_update(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Create or update existing Field Mappings for a Linked Account. Changes will be reflected after the next scheduled sync. This will cause the next sync for this Linked Account to sync **ALL** data from start.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.hris.field_mapping.field_mappings_partial_update(
+ field_mapping_id="field_mapping_id",
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**field_mapping_id:** `str`
+
+
+
+
+
+-
+
+**remote_field_traversal_path:** `typing.Optional[typing.Sequence[typing.Any]]` — The field traversal path of the remote field listed when you hit the GET /remote-fields endpoint.
+
+
+
+
+
+-
+
+**remote_method:** `typing.Optional[str]` — The method of the remote endpoint where the remote field is coming from.
+
+
+
+
+
+-
+
+**remote_url_path:** `typing.Optional[str]` — The path of the remote endpoint where the remote field is coming from.
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.hris.field_mapping.remote_fields_retrieve(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Get all remote fields for a Linked Account. Remote fields are third-party fields that are accessible after initial sync if remote_data is enabled. You can use remote fields to override existing Merge fields or map a new Merge field. [Learn more](https://docs.merge.dev/supplemental-data/field-mappings/overview/).
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.hris.field_mapping.remote_fields_retrieve()
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**common_models:** `typing.Optional[str]` — A comma seperated list of Common Model names. If included, will only return Remote Fields for those Common Models.
+
+
+
+
+
+-
+
+**include_example_values:** `typing.Optional[str]` — If true, will include example values, where available, for remote fields in the 3rd party platform. These examples come from active data from your customers.
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.hris.field_mapping.target_fields_retrieve()
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Get all organization-wide Target Fields, this will not include any Linked Account specific Target Fields. Organization-wide Target Fields are additional fields appended to the Merge Common Model for all Linked Accounts in a category. [Learn more](https://docs.merge.dev/supplemental-data/field-mappings/target-fields/).
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.hris.field_mapping.target_fields_retrieve()
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.hris.generate_key.create(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Create a remote key.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.hris.generate_key.create(
+ name="Remote Deployment Key 1",
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**name:** `str` — The name of the remote key
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.hris.groups.list(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a list of `Group` objects.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.hris.groups.list()
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
+
+
+
+
+
+-
+
+**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
+
+
+
+
+
+-
+
+**cursor:** `typing.Optional[str]` — The pagination cursor value.
+
+
+
+
+
+-
+
+**include_deleted_data:** `typing.Optional[bool]` — Whether to include data that was marked as deleted by third party webhooks.
+
+
+
+
+
+-
+
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
+
+
+
+
+
+-
+
+**is_commonly_used_as_team:** `typing.Optional[str]` — If provided, specifies whether to return only Group objects which refer to a team in the third party platform. Note that this is an opinionated view based on how a team may be represented in the third party platform.
+
+
+
+
+
+-
+
+**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
+
+
+
+
+
+-
+
+**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
+
+
+
+
+
+-
+
+**names:** `typing.Optional[str]` — If provided, will only return groups with these names. Multiple values can be separated by commas.
+
+
+
+
+
+-
+
+**page_size:** `typing.Optional[int]` — Number of results to return per page.
+
+
+
+
+
+-
+
+**remote_fields:** `typing.Optional[typing.Literal["type"]]` — Deprecated. Use show_enum_origins.
+
+
+
+
+
+-
+
+**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
+
+
+
+
+
+-
+
+**show_enum_origins:** `typing.Optional[typing.Literal["type"]]` — A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter)
+
+
+
+
+
+-
+
+**types:** `typing.Optional[str]` — If provided, will only return groups of these types. Multiple values can be separated by commas.
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.hris.groups.retrieve(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a `Group` object with the given `id`.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.hris.groups.retrieve(
+ id="id",
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**id:** `str`
+
+
+
+
+
+-
+
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
+
+
+
+
+
+-
+
+**remote_fields:** `typing.Optional[typing.Literal["type"]]` — Deprecated. Use show_enum_origins.
+
+
+
+
+
+-
+
+**show_enum_origins:** `typing.Optional[typing.Literal["type"]]` — A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter)
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.hris.issues.list(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Gets issues.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.hris.issues.list()
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**account_token:** `typing.Optional[str]`
+
+
+
+
+
+-
+
+**cursor:** `typing.Optional[str]` — The pagination cursor value.
+
+
+
+
+
+-
+
+**end_date:** `typing.Optional[str]` — If included, will only include issues whose most recent action occurred before this time
+
+
+
+
+
+-
+
+**end_user_organization_name:** `typing.Optional[str]`
+
+
+
+
+
+-
+
+**first_incident_time_after:** `typing.Optional[dt.datetime]` — If provided, will only return issues whose first incident time was after this datetime.
+
+
+
+
+
+-
+
+**first_incident_time_before:** `typing.Optional[dt.datetime]` — If provided, will only return issues whose first incident time was before this datetime.
+
+
+
+
+
+-
+
+**include_muted:** `typing.Optional[str]` — If true, will include muted issues
+
+
+
+
+
+-
+
+**integration_name:** `typing.Optional[str]`
+
+
+
+
+
+-
+
+**last_incident_time_after:** `typing.Optional[dt.datetime]` — If provided, will only return issues whose last incident time was after this datetime.
+
+
+
+
+
+-
+
+**last_incident_time_before:** `typing.Optional[dt.datetime]` — If provided, will only return issues whose last incident time was before this datetime.
+
+
+
+
+
+-
+
+**page_size:** `typing.Optional[int]` — Number of results to return per page.
+
+
+
+
+
+-
+
+**start_date:** `typing.Optional[str]` — If included, will only include issues whose most recent action occurred after this time
+
+
+
+
+
+-
+
+**status:** `typing.Optional[IssuesListRequestStatus]`
+
+Status of the issue. Options: ('ONGOING', 'RESOLVED')
+
+- `ONGOING` - ONGOING
+- `RESOLVED` - RESOLVED
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.hris.issues.retrieve(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Get a specific issue.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.hris.issues.retrieve(
+ id="id",
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**id:** `str`
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.hris.link_token.create(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Creates a link token to be used when linking a new end user.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+from merge.resources.hris import CategoriesEnum
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.hris.link_token.create(
+ end_user_email_address="example@gmail.com",
+ end_user_organization_name="Test Organization",
+ end_user_origin_id="12345",
+ categories=[CategoriesEnum.HRIS, CategoriesEnum.ATS],
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**end_user_email_address:** `str` — Your end user's email address. This is purely for identification purposes - setting this value will not cause any emails to be sent.
+
+
+
+
+
+-
+
+**end_user_organization_name:** `str` — Your end user's organization.
+
+
+
+
+
+-
+
+**end_user_origin_id:** `str` — This unique identifier typically represents the ID for your end user in your product's database. This value must be distinct from other Linked Accounts' unique identifiers.
+
+
+
+
+
+-
+
+**categories:** `typing.Sequence[CategoriesEnum]` — The integration categories to show in Merge Link.
+
+
+
+
+
+-
+
+**integration:** `typing.Optional[str]` — The slug of a specific pre-selected integration for this linking flow token. For examples of slugs, see https://docs.merge.dev/guides/merge-link/single-integration/.
+
+
+
+
+
+-
+
+**link_expiry_mins:** `typing.Optional[int]` — An integer number of minutes between [30, 720 or 10080 if for a Magic Link URL] for how long this token is valid. Defaults to 30.
+
+
+
+
+
+-
+
+**should_create_magic_link_url:** `typing.Optional[bool]` — Whether to generate a Magic Link URL. Defaults to false. For more information on Magic Link, see https://merge.dev/blog/integrations-fast-say-hello-to-magic-link.
+
+
+
+
+
+-
+
+**common_models:** `typing.Optional[typing.Sequence[CommonModelScopesBodyRequest]]` — An array of objects to specify the models and fields that will be disabled for a given Linked Account. Each object uses model_id, enabled_actions, and disabled_fields to specify the model, method, and fields that are scoped for a given Linked Account.
+
+
+
+
+
+-
+
+**category_common_model_scopes:** `typing.Optional[
+ typing.Dict[
+ str,
+ typing.Optional[
+ typing.Sequence[IndividualCommonModelScopeDeserializerRequest]
+ ],
+ ]
+]` — When creating a Link Token, you can set permissions for Common Models that will apply to the account that is going to be linked. Any model or field not specified in link token payload will default to existing settings.
+
+
+
+
+
+-
+
+**language:** `typing.Optional[str]` — The language code for the language to localize Merge Link to.
+
+
+
+
+
+-
+
+**integration_specific_config:** `typing.Optional[typing.Dict[str, typing.Any]]` — A JSON object containing integration-specific configuration options.
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.hris.linked_accounts.list(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+List linked accounts for your organization.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.hris.linked_accounts.list()
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**category:** `typing.Optional[LinkedAccountsListRequestCategory]`
+
+Options: ('hris', 'ats', 'accounting', 'ticketing', 'crm', 'mktg', 'filestorage')
+
+- `hris` - hris
+- `ats` - ats
+- `accounting` - accounting
+- `ticketing` - ticketing
+- `crm` - crm
+- `mktg` - mktg
+- `filestorage` - filestorage
+
+
+
+
+
+-
+
+**cursor:** `typing.Optional[str]` — The pagination cursor value.
+
+
+
+
+
+-
+
+**end_user_email_address:** `typing.Optional[str]` — If provided, will only return linked accounts associated with the given email address.
+
+
+
+
+
+-
+
+**end_user_organization_name:** `typing.Optional[str]` — If provided, will only return linked accounts associated with the given organization name.
+
+
+
+
+
+-
+
+**end_user_origin_id:** `typing.Optional[str]` — If provided, will only return linked accounts associated with the given origin ID.
+
+
+
+
+
+-
+
+**end_user_origin_ids:** `typing.Optional[str]` — Comma-separated list of EndUser origin IDs, making it possible to specify multiple EndUsers at once.
+
+
+
+
+
+-
+
+**id:** `typing.Optional[str]`
+
+
+
+
+
+-
+
+**ids:** `typing.Optional[str]` — Comma-separated list of LinkedAccount IDs, making it possible to specify multiple LinkedAccounts at once.
+
+
+
+
+
+-
+
+**include_duplicates:** `typing.Optional[bool]` — If `true`, will include complete production duplicates of the account specified by the `id` query parameter in the response. `id` must be for a complete production linked account.
+
+
+
+
+
+-
+
+**integration_name:** `typing.Optional[str]` — If provided, will only return linked accounts associated with the given integration name.
+
+
+
+
+
+-
+
+**is_test_account:** `typing.Optional[str]` — If included, will only include test linked accounts. If not included, will only include non-test linked accounts.
+
+
+
+
+
+-
+
+**page_size:** `typing.Optional[int]` — Number of results to return per page.
+
+
+
+
+
+-
+
+**status:** `typing.Optional[str]` — Filter by status. Options: `COMPLETE`, `INCOMPLETE`, `RELINK_NEEDED`
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.hris.locations.list(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a list of `Location` objects.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.hris.locations.list()
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
+
+
+
+
+
+-
+
+**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
+
+
+
+
+
+-
+
+**cursor:** `typing.Optional[str]` — The pagination cursor value.
+
+
+
+
+
+-
+
+**include_deleted_data:** `typing.Optional[bool]` — Whether to include data that was marked as deleted by third party webhooks.
+
+
+
+
+
+-
+
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
+
+
+
+
+
+-
+
+**location_type:** `typing.Optional[LocationsListRequestLocationType]`
+
+If provided, will only return locations with this location_type
+
+- `HOME` - HOME
+- `WORK` - WORK
+
+
+
+
+
+-
+
+**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
+
+
+
+
+
+-
+
+**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
+
+
+
+
+
+-
+
+**page_size:** `typing.Optional[int]` — Number of results to return per page.
+
+
+
+
+
+-
+
+**remote_fields:** `typing.Optional[typing.Literal["location_type"]]` — Deprecated. Use show_enum_origins.
+
+
+
+
+
+-
+
+**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
+
+
+
+
+
+-
+
+**show_enum_origins:** `typing.Optional[typing.Literal["location_type"]]` — A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter)
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.hris.locations.retrieve(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a `Location` object with the given `id`.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.hris.locations.retrieve(
+ id="id",
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**id:** `str`
+
+
+
+
+
+-
+
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
+
+
+
+
+
+-
+
+**remote_fields:** `typing.Optional[typing.Literal["location_type"]]` — Deprecated. Use show_enum_origins.
+
+
+
+
+
+-
+
+**show_enum_origins:** `typing.Optional[typing.Literal["location_type"]]` — A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter)
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.hris.passthrough.create(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Pull data from an endpoint not currently supported by Merge.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+from merge.resources.hris import DataPassthroughRequest, MethodEnum
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.hris.passthrough.create(
+ request=DataPassthroughRequest(
+ method=MethodEnum.GET,
+ path="/scooters",
+ ),
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request:** `DataPassthroughRequest`
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.hris.pay_groups.list(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a list of `PayGroup` objects.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.hris.pay_groups.list()
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
+
+
+
+
+
+-
+
+**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
+
+
+
+
+
+-
+
+**cursor:** `typing.Optional[str]` — The pagination cursor value.
+
+
+
+
+
+-
+
+**include_deleted_data:** `typing.Optional[bool]` — Whether to include data that was marked as deleted by third party webhooks.
+
+
+
+
+
+-
+
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
+
+
+
+
+
+-
+
+**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
+
+
+
+
+
+-
+
+**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
+
+
+
+
+
+-
+
+**page_size:** `typing.Optional[int]` — Number of results to return per page.
+
+
+
+
+
+-
+
+**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.hris.pay_groups.retrieve(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a `PayGroup` object with the given `id`.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.hris.pay_groups.retrieve(
+ id="id",
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**id:** `str`
+
+
+
+
+
+-
+
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.hris.payroll_runs.list(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a list of `PayrollRun` objects.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.hris.payroll_runs.list()
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
+
+
+
+
+
+-
+
+**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
+
+
+
+
+
+-
+
+**cursor:** `typing.Optional[str]` — The pagination cursor value.
+
+
+
+
+
+-
+
+**ended_after:** `typing.Optional[dt.datetime]` — If provided, will only return payroll runs ended after this datetime.
+
+
+
+
+
+-
+
+**ended_before:** `typing.Optional[dt.datetime]` — If provided, will only return payroll runs ended before this datetime.
+
+
+
+
+
+-
+
+**include_deleted_data:** `typing.Optional[bool]` — Whether to include data that was marked as deleted by third party webhooks.
+
+
+
+
+
+-
+
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
+
+
+
+
+
+-
+
+**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
+
+
+
+
+
+-
+
+**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
+
+
+
+
+
+-
+
+**page_size:** `typing.Optional[int]` — Number of results to return per page.
+
+
+
+
+
+-
+
+**remote_fields:** `typing.Optional[PayrollRunsListRequestRemoteFields]` — Deprecated. Use show_enum_origins.
+
+
+
+
+
+-
+
+**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
+
+
+
+
+
+-
+
+**run_type:** `typing.Optional[PayrollRunsListRequestRunType]`
+
+If provided, will only return PayrollRun's with this status. Options: ('REGULAR', 'OFF_CYCLE', 'CORRECTION', 'TERMINATION', 'SIGN_ON_BONUS')
+
+- `REGULAR` - REGULAR
+- `OFF_CYCLE` - OFF_CYCLE
+- `CORRECTION` - CORRECTION
+- `TERMINATION` - TERMINATION
+- `SIGN_ON_BONUS` - SIGN_ON_BONUS
+
+
+
+
+
+-
+
+**show_enum_origins:** `typing.Optional[PayrollRunsListRequestShowEnumOrigins]` — A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter)
+
+
+
+
+
+-
+
+**started_after:** `typing.Optional[dt.datetime]` — If provided, will only return payroll runs started after this datetime.
+
+
+
+
+
+-
+
+**started_before:** `typing.Optional[dt.datetime]` — If provided, will only return payroll runs started before this datetime.
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.hris.payroll_runs.retrieve(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a `PayrollRun` object with the given `id`.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.hris.payroll_runs.retrieve(
+ id="id",
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**id:** `str`
+
+
+
+
+
+-
+
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
+
+
+
+
+
+-
+
+**remote_fields:** `typing.Optional[PayrollRunsRetrieveRequestRemoteFields]` — Deprecated. Use show_enum_origins.
+
+
+
+
+
+-
+
+**show_enum_origins:** `typing.Optional[PayrollRunsRetrieveRequestShowEnumOrigins]` — A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter)
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.hris.regenerate_key.create(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Exchange remote keys.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.hris.regenerate_key.create(
+ name="Remote Deployment Key 1",
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**name:** `str` — The name of the remote key
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.hris.sync_status.list(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Get syncing status. Possible values: `DISABLED`, `DONE`, `FAILED`, `PARTIALLY_SYNCED`, `PAUSED`, `SYNCING`. Learn more about sync status in our [Help Center](https://help.merge.dev/en/articles/8184193-merge-sync-statuses).
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.hris.sync_status.list()
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**cursor:** `typing.Optional[str]` — The pagination cursor value.
+
+
+
+
+
+-
+
+**page_size:** `typing.Optional[int]` — Number of results to return per page.
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.hris.force_resync.sync_status_resync_create()
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Force re-sync of all models. This is available for all organizations via the dashboard. Force re-sync is also available programmatically via API for monthly, quarterly, and highest sync frequency customers on the Launch, Professional, or Enterprise plans. Doing so will consume a sync credit for the relevant linked account.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.hris.force_resync.sync_status_resync_create()
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.hris.teams.list(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a list of `Team` objects.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.hris.teams.list()
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
+
+
+
+
+
+-
+
+**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
+
+
+
+
+
+-
+
+**cursor:** `typing.Optional[str]` — The pagination cursor value.
+
+
+
+
+
+-
+
+**expand:** `typing.Optional[typing.Literal["parent_team"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+
+
+
+
+
+-
+
+**include_deleted_data:** `typing.Optional[bool]` — Whether to include data that was marked as deleted by third party webhooks.
+
+
+
+
+
+-
+
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
+
+
+
+
+
+-
+
+**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
+
+
+
+
+
+-
+
+**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
+
+
+
+
+
+-
+
+**page_size:** `typing.Optional[int]` — Number of results to return per page.
+
+
+
+
+
+-
+
+**parent_team_id:** `typing.Optional[str]` — If provided, will only return teams with this parent team.
+
+
+
+
+
+-
+
+**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.hris.teams.retrieve(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a `Team` object with the given `id`.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.hris.teams.retrieve(
+ id="id",
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**id:** `str`
+
+
+
+
+
+-
+
+**expand:** `typing.Optional[typing.Literal["parent_team"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+
+
+
+
+
+-
+
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.hris.time_off.list(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a list of `TimeOff` objects.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.hris.time_off.list()
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**approver_id:** `typing.Optional[str]` — If provided, will only return time off for this approver.
+
+
+
+
+
+-
+
+**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
+
+
+
+
+
+-
+
+**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
+
+
+
+
+
+-
+
+**cursor:** `typing.Optional[str]` — The pagination cursor value.
+
+
+
+
+
+-
+
+**employee_id:** `typing.Optional[str]` — If provided, will only return time off for this employee.
+
+
+
+
+
+-
+
+**ended_after:** `typing.Optional[dt.datetime]` — If provided, will only return employees that ended after this datetime.
+
+
+
+
+
+-
+
+**ended_before:** `typing.Optional[dt.datetime]` — If provided, will only return time-offs that ended before this datetime.
+
+
+
+
+
+-
+
+**expand:** `typing.Optional[TimeOffListRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+
+
+
+
+
+-
+
+**include_deleted_data:** `typing.Optional[bool]` — Whether to include data that was marked as deleted by third party webhooks.
+
+
+
+
+
+-
+
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
+
+
+
+
+
+-
+
+**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
+
+
+
+
+
+-
+
+**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
+
+
+
+
+
+-
+
+**page_size:** `typing.Optional[int]` — Number of results to return per page.
+
+
+
+
+
+-
+
+**remote_fields:** `typing.Optional[TimeOffListRequestRemoteFields]` — Deprecated. Use show_enum_origins.
+
+
+
+
+
+-
+
+**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
+
+
+
+
+
+-
+
+**request_type:** `typing.Optional[TimeOffListRequestRequestType]`
+
+If provided, will only return TimeOff with this request type. Options: ('VACATION', 'SICK', 'PERSONAL', 'JURY_DUTY', 'VOLUNTEER', 'BEREAVEMENT')
+
+- `VACATION` - VACATION
+- `SICK` - SICK
+- `PERSONAL` - PERSONAL
+- `JURY_DUTY` - JURY_DUTY
+- `VOLUNTEER` - VOLUNTEER
+- `BEREAVEMENT` - BEREAVEMENT
+
+
+
+
+
+-
+
+**show_enum_origins:** `typing.Optional[TimeOffListRequestShowEnumOrigins]` — A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter)
+
+
+
+
+
+-
+
+**started_after:** `typing.Optional[dt.datetime]` — If provided, will only return time-offs that started after this datetime.
+
+
+
+
+
+-
+
+**started_before:** `typing.Optional[dt.datetime]` — If provided, will only return time-offs that started before this datetime.
+
+
+
+
+
+-
+
+**status:** `typing.Optional[TimeOffListRequestStatus]`
+
+If provided, will only return TimeOff with this status. Options: ('REQUESTED', 'APPROVED', 'DECLINED', 'CANCELLED', 'DELETED')
+
+- `REQUESTED` - REQUESTED
+- `APPROVED` - APPROVED
+- `DECLINED` - DECLINED
+- `CANCELLED` - CANCELLED
+- `DELETED` - DELETED
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.hris.time_off.create(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Creates a `TimeOff` object with the given values.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+from merge.resources.hris import TimeOffRequest
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.hris.time_off.create(
+ model=TimeOffRequest(),
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**model:** `TimeOffRequest`
+
+
+
+
+
+-
+
+**is_debug_mode:** `typing.Optional[bool]` — Whether to include debug fields (such as log file links) in the response.
+
+
+
+
+
+-
+
+**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously.
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.hris.time_off.retrieve(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a `TimeOff` object with the given `id`.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.hris.time_off.retrieve(
+ id="id",
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**id:** `str`
+
+
+
+
+
+-
+
+**expand:** `typing.Optional[TimeOffRetrieveRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+
+
+
+
+
+-
+
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
+
+
+
+
+
+-
+
+**remote_fields:** `typing.Optional[TimeOffRetrieveRequestRemoteFields]` — Deprecated. Use show_enum_origins.
+
+
+
+
+
+-
+
+**show_enum_origins:** `typing.Optional[TimeOffRetrieveRequestShowEnumOrigins]` — A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter)
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.hris.time_off.meta_post_retrieve()
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns metadata for `TimeOff` POSTs.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.hris.time_off.meta_post_retrieve()
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.hris.time_off_balances.list(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a list of `TimeOffBalance` objects.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.hris.time_off_balances.list()
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
+
+
+
+
+
+-
+
+**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
+
+
+
+
+
+-
+
+**cursor:** `typing.Optional[str]` — The pagination cursor value.
+
+
+
+
+
+-
+
+**employee_id:** `typing.Optional[str]` — If provided, will only return time off balances for this employee.
+
+
+
+
+
+-
+
+**expand:** `typing.Optional[typing.Literal["employee"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+
+
+
+
+
+-
+
+**include_deleted_data:** `typing.Optional[bool]` — Whether to include data that was marked as deleted by third party webhooks.
+
+
+
+
+
+-
+
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
+
+
+
+
+
+-
+
+**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
+
+
+
+
+
+-
+
+**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
+
+
+
+
+
+-
+
+**page_size:** `typing.Optional[int]` — Number of results to return per page.
+
+
+
+
+
+-
+
+**policy_type:** `typing.Optional[TimeOffBalancesListRequestPolicyType]`
+
+If provided, will only return TimeOffBalance with this policy type. Options: ('VACATION', 'SICK', 'PERSONAL', 'JURY_DUTY', 'VOLUNTEER', 'BEREAVEMENT')
+
+- `VACATION` - VACATION
+- `SICK` - SICK
+- `PERSONAL` - PERSONAL
+- `JURY_DUTY` - JURY_DUTY
+- `VOLUNTEER` - VOLUNTEER
+- `BEREAVEMENT` - BEREAVEMENT
+
+
+
+
+
+-
+
+**remote_fields:** `typing.Optional[typing.Literal["policy_type"]]` — Deprecated. Use show_enum_origins.
+
+
+
+
+
+-
+
+**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
+
+
+
+
+
+-
+
+**show_enum_origins:** `typing.Optional[typing.Literal["policy_type"]]` — A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter)
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.hris.time_off_balances.retrieve(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a `TimeOffBalance` object with the given `id`.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.hris.time_off_balances.retrieve(
+ id="id",
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**id:** `str`
+
+
+
+
+
+-
+
+**expand:** `typing.Optional[typing.Literal["employee"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+
+
+
+
+
+-
+
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
+
+
+
+
+
+-
+
+**remote_fields:** `typing.Optional[typing.Literal["policy_type"]]` — Deprecated. Use show_enum_origins.
+
+
+
+
+
+-
+
+**show_enum_origins:** `typing.Optional[typing.Literal["policy_type"]]` — A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter)
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.hris.timesheet_entries.list(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a list of `TimesheetEntry` objects.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.hris.timesheet_entries.list()
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
+
+
+
+
+
+-
+
+**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
+
+
+
+
+
+-
+
+**cursor:** `typing.Optional[str]` — The pagination cursor value.
+
+
+
+
+
+-
+
+**employee_id:** `typing.Optional[str]` — If provided, will only return employee payroll runs for this employee.
+
+
+
+
+
+-
+
+**ended_after:** `typing.Optional[str]` — If provided, will only return employee payroll runs ended after this datetime.
+
+
+
+
+
+-
+
+**ended_before:** `typing.Optional[str]` — If provided, will only return employee payroll runs ended before this datetime.
+
+
+
+
+
+-
+
+**include_deleted_data:** `typing.Optional[bool]` — Whether to include data that was marked as deleted by third party webhooks.
+
+
+
+
+
+-
+
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
+
+
+
+
+
+-
+
+**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
+
+
+
+
+
+-
+
+**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
+
+
+
+
+
+-
+
+**order_by:** `typing.Optional[TimesheetEntriesListRequestOrderBy]` — Overrides the default ordering for this endpoint. Possible values include: start_time, -start_time.
+
+
+
+
+
+-
+
+**page_size:** `typing.Optional[int]` — Number of results to return per page.
+
+
+
+
+
+-
+
+**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
+
+
+
+
+
+-
+
+**started_after:** `typing.Optional[str]` — If provided, will only return employee payroll runs started after this datetime.
+
+
+
+
+
+-
+
+**started_before:** `typing.Optional[str]` — If provided, will only return employee payroll runs started before this datetime.
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.hris.timesheet_entries.create(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Creates a `TimesheetEntry` object with the given values.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+from merge.resources.hris import TimesheetEntryRequest
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.hris.timesheet_entries.create(
+ model=TimesheetEntryRequest(),
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**model:** `TimesheetEntryRequest`
+
+
+
+
+
+-
+
+**is_debug_mode:** `typing.Optional[bool]` — Whether to include debug fields (such as log file links) in the response.
+
+
+
+
+
+-
+
+**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously.
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.hris.timesheet_entries.retrieve(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a `TimesheetEntry` object with the given `id`.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.hris.timesheet_entries.retrieve(
+ id="id",
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**id:** `str`
+
+
+
+
+
+-
+
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.hris.timesheet_entries.meta_post_retrieve()
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns metadata for `TimesheetEntry` POSTs.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.hris.timesheet_entries.meta_post_retrieve()
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.hris.webhook_receivers.list()
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a list of `WebhookReceiver` objects.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.hris.webhook_receivers.list()
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.hris.webhook_receivers.create(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Creates a `WebhookReceiver` object with the given values.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.hris.webhook_receivers.create(
+ event="event",
+ is_active=True,
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**event:** `str`
+
+
+
+
+
+-
+
+**is_active:** `bool`
+
+
+
+
+
+-
+
+**key:** `typing.Optional[str]`
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.crm.account_details.retrieve()
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Get details for a linked account.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.crm.account_details.retrieve()
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.crm.account_token.retrieve(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns the account token for the end user with the provided public token.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.crm.account_token.retrieve(
+ public_token="public_token",
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**public_token:** `str`
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.crm.accounts.list(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a list of `Account` objects.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.crm.accounts.list()
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
+
+
+
+
+
+-
+
+**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
+
+
+
+
+
+-
+
+**cursor:** `typing.Optional[str]` — The pagination cursor value.
+
+
+
+
+
+-
+
+**expand:** `typing.Optional[typing.Literal["owner"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+
+
+
+
+
+-
+
+**include_deleted_data:** `typing.Optional[bool]` — Whether to include data that was marked as deleted by third party webhooks.
+
+
+
+
+
+-
+
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
+
+
+
+
+
+-
+
+**include_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.
+
+
+
+
+
+-
+
+**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
+
+
+
+
+
+-
+
+**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
+
+
+
+
+
+-
+
+**name:** `typing.Optional[str]` — If provided, will only return accounts with this name.
+
+
+
+
+
+-
+
+**owner_id:** `typing.Optional[str]` — If provided, will only return accounts with this owner.
+
+
+
+
+
+-
+
+**page_size:** `typing.Optional[int]` — Number of results to return per page.
+
+
+
+
+
+-
+
+**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.crm.accounts.create(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Creates an `Account` object with the given values.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+from merge.resources.crm import AccountRequest
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.crm.accounts.create(
+ model=AccountRequest(),
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**model:** `AccountRequest`
+
+
+
+
+
+-
+
+**is_debug_mode:** `typing.Optional[bool]` — Whether to include debug fields (such as log file links) in the response.
+
+
+
+
+
+-
+
+**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously.
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.crm.accounts.retrieve(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns an `Account` object with the given `id`.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.crm.accounts.retrieve(
+ id="id",
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**id:** `str`
+
+
+
+
+
+-
+
+**expand:** `typing.Optional[typing.Literal["owner"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+
+
+
+
+
+-
+
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
+
+
+
+
+
+-
+
+**include_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.crm.accounts.partial_update(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Updates an `Account` object with the given `id`.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+from merge.resources.crm import PatchedAccountRequest
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.crm.accounts.partial_update(
+ id="id",
+ model=PatchedAccountRequest(),
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**id:** `str`
+
+
+
+
+
+-
+
+**model:** `PatchedAccountRequest`
+
+
+
+
+
+-
+
+**is_debug_mode:** `typing.Optional[bool]` — Whether to include debug fields (such as log file links) in the response.
+
+
+
+
+
+-
+
+**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously.
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.crm.accounts.meta_patch_retrieve(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns metadata for `CRMAccount` PATCHs.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.crm.accounts.meta_patch_retrieve(
+ id="id",
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**id:** `str`
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.crm.accounts.meta_post_retrieve()
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns metadata for `CRMAccount` POSTs.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.crm.accounts.meta_post_retrieve()
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.crm.accounts.remote_field_classes_list(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a list of `RemoteFieldClass` objects.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.crm.accounts.remote_field_classes_list()
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**cursor:** `typing.Optional[str]` — The pagination cursor value.
+
+
+
+
+
+-
+
+**include_deleted_data:** `typing.Optional[bool]` — Whether to include data that was marked as deleted by third party webhooks.
+
+
+
+
+
+-
+
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
+
+
+
+
+
+-
+
+**include_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.
+
+
+
+
+
+-
+
+**page_size:** `typing.Optional[int]` — Number of results to return per page.
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.crm.async_passthrough.create(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Asynchronously pull data from an endpoint not currently supported by Merge.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+from merge.resources.crm import DataPassthroughRequest, MethodEnum
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.crm.async_passthrough.create(
+ request=DataPassthroughRequest(
+ method=MethodEnum.GET,
+ path="/scooters",
+ ),
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request:** `DataPassthroughRequest`
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.crm.async_passthrough.retrieve(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Retrieves data from earlier async-passthrough POST request
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.crm.async_passthrough.retrieve(
+ async_passthrough_receipt_id="async_passthrough_receipt_id",
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**async_passthrough_receipt_id:** `str`
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.crm.audit_trail.list(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Gets a list of audit trail events.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.crm.audit_trail.list()
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**cursor:** `typing.Optional[str]` — The pagination cursor value.
+
+
+
+
+
+-
+
+**end_date:** `typing.Optional[str]` — If included, will only include audit trail events that occurred before this time
+
+
+
+
+
+-
+
+**event_type:** `typing.Optional[str]` — If included, will only include events with the given event type. Possible values include: `CREATED_REMOTE_PRODUCTION_API_KEY`, `DELETED_REMOTE_PRODUCTION_API_KEY`, `CREATED_TEST_API_KEY`, `DELETED_TEST_API_KEY`, `REGENERATED_PRODUCTION_API_KEY`, `INVITED_USER`, `TWO_FACTOR_AUTH_ENABLED`, `TWO_FACTOR_AUTH_DISABLED`, `DELETED_LINKED_ACCOUNT`, `CREATED_DESTINATION`, `DELETED_DESTINATION`, `CHANGED_DESTINATION`, `CHANGED_SCOPES`, `CHANGED_PERSONAL_INFORMATION`, `CHANGED_ORGANIZATION_SETTINGS`, `ENABLED_INTEGRATION`, `DISABLED_INTEGRATION`, `ENABLED_CATEGORY`, `DISABLED_CATEGORY`, `CHANGED_PASSWORD`, `RESET_PASSWORD`, `ENABLED_REDACT_UNMAPPED_DATA_FOR_ORGANIZATION`, `ENABLED_REDACT_UNMAPPED_DATA_FOR_LINKED_ACCOUNT`, `DISABLED_REDACT_UNMAPPED_DATA_FOR_ORGANIZATION`, `DISABLED_REDACT_UNMAPPED_DATA_FOR_LINKED_ACCOUNT`, `CREATED_INTEGRATION_WIDE_FIELD_MAPPING`, `CREATED_LINKED_ACCOUNT_FIELD_MAPPING`, `CHANGED_INTEGRATION_WIDE_FIELD_MAPPING`, `CHANGED_LINKED_ACCOUNT_FIELD_MAPPING`, `DELETED_INTEGRATION_WIDE_FIELD_MAPPING`, `DELETED_LINKED_ACCOUNT_FIELD_MAPPING`, `FORCED_LINKED_ACCOUNT_RESYNC`, `MUTED_ISSUE`, `GENERATED_MAGIC_LINK`, `ENABLED_MERGE_WEBHOOK`, `DISABLED_MERGE_WEBHOOK`, `MERGE_WEBHOOK_TARGET_CHANGED`
+
+
+
+
+
+-
+
+**page_size:** `typing.Optional[int]` — Number of results to return per page.
+
+
+
+
+
+-
+
+**start_date:** `typing.Optional[str]` — If included, will only include audit trail events that occurred after this time
+
+
+
+
+
+-
+
+**user_email:** `typing.Optional[str]` — If provided, this will return events associated with the specified user email. Please note that the email address reflects the user's email at the time of the event, and may not be their current email.
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.crm.available_actions.retrieve()
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a list of models and actions available for an account.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.crm.available_actions.retrieve()
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.crm.contacts.list(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a list of `Contact` objects.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.crm.contacts.list()
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**account_id:** `typing.Optional[str]` — If provided, will only return contacts with this account.
+
+
+
+
+
+-
+
+**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
+
+
+
+
+
+-
+
+**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
+
+
+
+
+
+-
+
+**cursor:** `typing.Optional[str]` — The pagination cursor value.
+
+
+
+
+
+-
+
+**email_addresses:** `typing.Optional[str]` — If provided, will only return contacts matching the email addresses; multiple email_addresses can be separated by commas.
+
+
+
+
+
+-
+
+**expand:** `typing.Optional[ContactsListRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+
+
+
+
+
+-
+
+**include_deleted_data:** `typing.Optional[bool]` — Whether to include data that was marked as deleted by third party webhooks.
+
+
+
+
+
+-
+
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
+
+
+
+
+
+-
+
+**include_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.
+
+
+
+
+
+-
+
+**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
+
+
+
+
+
+-
+
+**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
+
+
+
+
+
+-
+
+**page_size:** `typing.Optional[int]` — Number of results to return per page.
+
+
+
+
+
+-
+
+**phone_numbers:** `typing.Optional[str]` — If provided, will only return contacts matching the phone numbers; multiple phone numbers can be separated by commas.
+
+
+
+
+
+-
+
+**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.crm.contacts.create(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Creates a `Contact` object with the given values.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+from merge.resources.crm import ContactRequest
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.crm.contacts.create(
+ model=ContactRequest(),
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**model:** `ContactRequest`
+
+
+
+
+
+-
+
+**is_debug_mode:** `typing.Optional[bool]` — Whether to include debug fields (such as log file links) in the response.
+
+
+
+
+
+-
+
+**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously.
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.crm.contacts.retrieve(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a `Contact` object with the given `id`.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.crm.contacts.retrieve(
+ id="id",
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**id:** `str`
+
+
+
+
+
+-
+
+**expand:** `typing.Optional[ContactsRetrieveRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+
+
+
+
+
+-
+
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
+
+
+
+
+
+-
+
+**include_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.crm.contacts.partial_update(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Updates a `Contact` object with the given `id`.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+from merge.resources.crm import PatchedContactRequest
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.crm.contacts.partial_update(
+ id="id",
+ model=PatchedContactRequest(),
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**id:** `str`
+
+
+
+
+
+-
+
+**model:** `PatchedContactRequest`
+
+
+
+
+
+-
+
+**is_debug_mode:** `typing.Optional[bool]` — Whether to include debug fields (such as log file links) in the response.
+
+
+
+
+
+-
+
+**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously.
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.crm.contacts.ignore_create(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Ignores a specific row based on the `model_id` in the url. These records will have their properties set to null, and will not be updated in future syncs. The "reason" and "message" fields in the request body will be stored for audit purposes.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+from merge.resources.crm import IgnoreCommonModelRequest, ReasonEnum
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.crm.contacts.ignore_create(
+ model_id="model_id",
+ request=IgnoreCommonModelRequest(
+ reason=ReasonEnum.GENERAL_CUSTOMER_REQUEST,
+ ),
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**model_id:** `str`
+
+
+
+
+
+-
+
+**request:** `IgnoreCommonModelRequest`
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.crm.contacts.meta_patch_retrieve(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns metadata for `CRMContact` PATCHs.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.crm.contacts.meta_patch_retrieve(
+ id="id",
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**id:** `str`
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.crm.contacts.meta_post_retrieve()
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns metadata for `CRMContact` POSTs.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.crm.contacts.meta_post_retrieve()
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.crm.contacts.remote_field_classes_list(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a list of `RemoteFieldClass` objects.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.crm.contacts.remote_field_classes_list()
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**cursor:** `typing.Optional[str]` — The pagination cursor value.
+
+
+
+
+
+-
+
+**include_deleted_data:** `typing.Optional[bool]` — Whether to include data that was marked as deleted by third party webhooks.
+
+
+
+
+
+-
+
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
+
+
+
+
+
+-
+
+**include_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.
+
+
+
+
+
+-
+
+**page_size:** `typing.Optional[int]` — Number of results to return per page.
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.crm.custom_object_classes.list(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a list of `CustomObjectClass` objects.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.crm.custom_object_classes.list()
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
+
+
+
+
+
+-
+
+**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
+
+
+
+
+
+-
+
+**cursor:** `typing.Optional[str]` — The pagination cursor value.
+
+
+
+
+
+-
+
+**expand:** `typing.Optional[typing.Literal["fields"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+
+
+
+
+
+-
+
+**include_deleted_data:** `typing.Optional[bool]` — Whether to include data that was marked as deleted by third party webhooks.
+
+
+
+
+
+-
+
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
+
+
+
+
+
+-
+
+**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
+
+
+
+
+
+-
+
+**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
+
+
+
+
+
+-
+
+**page_size:** `typing.Optional[int]` — Number of results to return per page.
+
+
+
+
+
+-
+
+**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.crm.custom_object_classes.retrieve(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a `CustomObjectClass` object with the given `id`.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.crm.custom_object_classes.retrieve(
+ id="id",
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**id:** `str`
+
+
+
+
+
+-
+
+**expand:** `typing.Optional[typing.Literal["fields"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+
+
+
+
+
+-
+
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.crm.association_types.custom_object_classes_association_types_list(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a list of `AssociationType` objects.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.crm.association_types.custom_object_classes_association_types_list(
+ custom_object_class_id="custom_object_class_id",
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**custom_object_class_id:** `str`
+
+
+
+
+
+-
+
+**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
+
+
+
+
+
+-
+
+**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
+
+
+
+
+
+-
+
+**cursor:** `typing.Optional[str]` — The pagination cursor value.
+
+
+
+
+
+-
+
+**expand:** `typing.Optional[typing.Literal["target_object_classes"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+
+
+
+
+
+-
+
+**include_deleted_data:** `typing.Optional[bool]` — Whether to include data that was marked as deleted by third party webhooks.
+
+
+
+
+
+-
+
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
+
+
+
+
+
+-
+
+**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
+
+
+
+
+
+-
+
+**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
+
+
+
+
+
+-
+
+**page_size:** `typing.Optional[int]` — Number of results to return per page.
+
+
+
+
+
+-
+
+**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.crm.association_types.custom_object_classes_association_types_create(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Creates an `AssociationType` object with the given values.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+from merge.resources.crm import (
+ AssociationTypeRequestRequest,
+ ObjectClassDescriptionRequest,
+ OriginTypeEnum,
+)
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.crm.association_types.custom_object_classes_association_types_create(
+ custom_object_class_id="custom_object_class_id",
+ model=AssociationTypeRequestRequest(
+ source_object_class=ObjectClassDescriptionRequest(
+ id="id",
+ origin_type=OriginTypeEnum.CUSTOM_OBJECT,
+ ),
+ target_object_classes=[
+ ObjectClassDescriptionRequest(
+ id="id",
+ origin_type=OriginTypeEnum.CUSTOM_OBJECT,
+ )
+ ],
+ remote_key_name="remote_key_name",
+ ),
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**custom_object_class_id:** `str`
+
+
+
+
+
+-
+
+**model:** `AssociationTypeRequestRequest`
+
+
+
+
+
+-
+
+**is_debug_mode:** `typing.Optional[bool]` — Whether to include debug fields (such as log file links) in the response.
+
+
+
+
+
+-
+
+**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously.
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.crm.association_types.custom_object_classes_association_types_retrieve(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns an `AssociationType` object with the given `id`.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.crm.association_types.custom_object_classes_association_types_retrieve(
+ custom_object_class_id="custom_object_class_id",
+ id="id",
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**custom_object_class_id:** `str`
+
+
+
+
+
+-
+
+**id:** `str`
+
+
+
+
+
+-
+
+**expand:** `typing.Optional[typing.Literal["target_object_classes"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+
+
+
+
+
+-
+
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.crm.association_types.custom_object_classes_association_types_meta_post_retrieve(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns metadata for `CRMAssociationType` POSTs.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.crm.association_types.custom_object_classes_association_types_meta_post_retrieve(
+ custom_object_class_id="custom_object_class_id",
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**custom_object_class_id:** `str`
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.crm.custom_objects.custom_object_classes_custom_objects_list(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a list of `CustomObject` objects.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.crm.custom_objects.custom_object_classes_custom_objects_list(
+ custom_object_class_id="custom_object_class_id",
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**custom_object_class_id:** `str`
+
+
+
+
+
+-
+
+**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
+
+
+
+
+
+-
+
+**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
+
+
+
+
+
+-
+
+**cursor:** `typing.Optional[str]` — The pagination cursor value.
+
+
+
+
+
+-
+
+**include_deleted_data:** `typing.Optional[bool]` — Whether to include data that was marked as deleted by third party webhooks.
+
+
+
+
+
+-
+
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
+
+
+
+
+
+-
+
+**include_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.
+
+
+
+
+
+-
+
+**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
+
+
+
+
+
+-
+
+**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
+
+
+
+
+
+-
+
+**page_size:** `typing.Optional[int]` — Number of results to return per page.
+
+
+
+
+
+-
+
+**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.crm.custom_objects.custom_object_classes_custom_objects_create(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Creates a `CustomObject` object with the given values.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+from merge.resources.crm import CustomObjectRequest
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.crm.custom_objects.custom_object_classes_custom_objects_create(
+ custom_object_class_id="custom_object_class_id",
+ model=CustomObjectRequest(
+ fields={"test_field": "hello"},
+ ),
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**custom_object_class_id:** `str`
+
+
+
+
+
+-
+
+**model:** `CustomObjectRequest`
+
+
+
+
+
+-
+
+**is_debug_mode:** `typing.Optional[bool]` — Whether to include debug fields (such as log file links) in the response.
+
+
+
+
+
+-
+
+**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously.
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.crm.custom_objects.custom_object_classes_custom_objects_retrieve(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a `CustomObject` object with the given `id`.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.crm.custom_objects.custom_object_classes_custom_objects_retrieve(
+ custom_object_class_id="custom_object_class_id",
+ id="id",
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**custom_object_class_id:** `str`
+
+
+
+
+
+-
+
+**id:** `str`
+
+
+
+
+
+-
+
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
+
+
+
+
+
+-
+
+**include_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.crm.custom_objects.custom_object_classes_custom_objects_meta_post_retrieve(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns metadata for `CRMCustomObject` POSTs.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.crm.custom_objects.custom_object_classes_custom_objects_meta_post_retrieve(
+ custom_object_class_id="custom_object_class_id",
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**custom_object_class_id:** `str`
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.crm.associations.custom_object_classes_custom_objects_associations_list(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a list of `Association` objects.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.crm.associations.custom_object_classes_custom_objects_associations_list(
+ custom_object_class_id="custom_object_class_id",
+ object_id="object_id",
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**custom_object_class_id:** `str`
+
+
+
+
+
+-
+
+**object_id:** `str`
+
+
+
+
+
+-
+
+**association_type_id:** `typing.Optional[str]` — If provided, will only return opportunities with this association_type.
+
+
+
+
+
+-
+
+**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
+
+
+
+
+
+-
+
+**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
+
+
+
+
+
+-
+
+**cursor:** `typing.Optional[str]` — The pagination cursor value.
+
+
+
+
+
+-
+
+**expand:** `typing.Optional[typing.Literal["association_type"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+
+
+
+
+
+-
+
+**include_deleted_data:** `typing.Optional[bool]` — Whether to include data that was marked as deleted by third party webhooks.
+
+
+
+
+
+-
+
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
+
+
+
+
+
+-
+
+**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
+
+
+
+
+
+-
+
+**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
+
+
+
+
+
+-
+
+**page_size:** `typing.Optional[int]` — Number of results to return per page.
+
+
+
+
+
+-
+
+**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.crm.associations.custom_object_classes_custom_objects_associations_update(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Creates an Association between `source_object_id` and `target_object_id` of type `association_type_id`.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.crm.associations.custom_object_classes_custom_objects_associations_update(
+ association_type_id="association_type_id",
+ source_class_id="source_class_id",
+ source_object_id="source_object_id",
+ target_class_id="target_class_id",
+ target_object_id="target_object_id",
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**association_type_id:** `str`
+
+
+
+
+
+-
+
+**source_class_id:** `str`
+
+
+
+
+
+-
+
+**source_object_id:** `str`
+
+
+
+
+
+-
+
+**target_class_id:** `str`
+
+
+
+
+
+-
+
+**target_object_id:** `str`
+
+
+
+
+
+-
+
+**is_debug_mode:** `typing.Optional[bool]` — Whether to include debug fields (such as log file links) in the response.
+
+
+
+
+
+-
+
+**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously.
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.crm.scopes.default_scopes_retrieve()
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Get the default permissions for Merge Common Models and fields across all Linked Accounts of a given category. [Learn more](https://help.merge.dev/en/articles/8828211-common-model-and-field-scopes).
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.crm.scopes.default_scopes_retrieve()
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.crm.scopes.linked_account_scopes_retrieve()
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Get all available permissions for Merge Common Models and fields for a single Linked Account. [Learn more](https://help.merge.dev/en/articles/8828211-common-model-and-field-scopes).
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.crm.scopes.linked_account_scopes_retrieve()
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.crm.scopes.linked_account_scopes_create(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Update permissions for any Common Model or field for a single Linked Account. Any Scopes not set in this POST request will inherit the default Scopes. [Learn more](https://help.merge.dev/en/articles/8828211-common-model-and-field-scopes)
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+from merge.resources.crm import (
+ IndividualCommonModelScopeDeserializerRequest,
+ ModelPermissionDeserializerRequest,
+)
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.crm.scopes.linked_account_scopes_create(
+ common_models=[
+ IndividualCommonModelScopeDeserializerRequest(
+ model_name="Employee",
+ model_permissions={
+ "READ": ModelPermissionDeserializerRequest(
+ is_enabled=True,
+ ),
+ "WRITE": ModelPermissionDeserializerRequest(
+ is_enabled=False,
+ ),
+ },
+ ),
+ IndividualCommonModelScopeDeserializerRequest(
+ model_name="Benefit",
+ model_permissions={
+ "WRITE": ModelPermissionDeserializerRequest(
+ is_enabled=False,
+ )
+ },
+ ),
+ ],
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**common_models:** `typing.Sequence[IndividualCommonModelScopeDeserializerRequest]` — The common models you want to update the scopes for
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.crm.delete_account.delete()
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Delete a linked account.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.crm.delete_account.delete()
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.crm.engagement_types.list(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a list of `EngagementType` objects.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.crm.engagement_types.list()
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
+
+
+
+
+
+-
+
+**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
+
+
+
+
+
+-
+
+**cursor:** `typing.Optional[str]` — The pagination cursor value.
+
+
+
+
+
+-
+
+**include_deleted_data:** `typing.Optional[bool]` — Whether to include data that was marked as deleted by third party webhooks.
+
+
+
+
+
+-
+
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
+
+
+
+
+
+-
+
+**include_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.
+
+
+
+
+
+-
+
+**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
+
+
+
+
+
+-
+
+**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
+
+
+
+
+
+-
+
+**page_size:** `typing.Optional[int]` — Number of results to return per page.
+
+
+
+
+
+-
+
+**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.crm.engagement_types.retrieve(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns an `EngagementType` object with the given `id`.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.crm.engagement_types.retrieve(
+ id="id",
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**id:** `str`
+
+
+
+
+
+-
+
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
+
+
+
+
+
+-
+
+**include_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.crm.engagement_types.remote_field_classes_list(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a list of `RemoteFieldClass` objects.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.crm.engagement_types.remote_field_classes_list()
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**cursor:** `typing.Optional[str]` — The pagination cursor value.
+
+
+
+
+
+-
+
+**include_deleted_data:** `typing.Optional[bool]` — Whether to include data that was marked as deleted by third party webhooks.
+
+
+
+
+
+-
+
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
+
+
+
+
+
+-
+
+**include_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.
+
+
+
+
+
+-
+
+**page_size:** `typing.Optional[int]` — Number of results to return per page.
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.crm.engagements.list(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a list of `Engagement` objects.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.crm.engagements.list()
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
+
+
+
+
+
+-
+
+**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
+
+
+
+
+
+-
+
+**cursor:** `typing.Optional[str]` — The pagination cursor value.
+
+
+
+
+
+-
+
+**expand:** `typing.Optional[EngagementsListRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+
+
+
+
+
+-
+
+**include_deleted_data:** `typing.Optional[bool]` — Whether to include data that was marked as deleted by third party webhooks.
+
+
+
+
+
+-
+
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
+
+
+
+
+
+-
+
+**include_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.
+
+
+
+
+
+-
+
+**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
+
+
+
+
+
+-
+
+**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
+
+
+
+
+
+-
+
+**page_size:** `typing.Optional[int]` — Number of results to return per page.
+
+
+
+
+
+-
+
+**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
+
+
+
+
+
+-
+
+**started_after:** `typing.Optional[dt.datetime]` — If provided, will only return engagements started after this datetime.
+
+
+
+
+
+-
+
+**started_before:** `typing.Optional[dt.datetime]` — If provided, will only return engagements started before this datetime.
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.crm.engagements.create(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Creates an `Engagement` object with the given values.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+from merge.resources.crm import EngagementRequest
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.crm.engagements.create(
+ model=EngagementRequest(),
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**model:** `EngagementRequest`
+
+
+
+
+
+-
+
+**is_debug_mode:** `typing.Optional[bool]` — Whether to include debug fields (such as log file links) in the response.
+
+
+
+
+
+-
+
+**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously.
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.crm.engagements.retrieve(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns an `Engagement` object with the given `id`.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.crm.engagements.retrieve(
+ id="id",
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**id:** `str`
+
+
+
+
+
+-
+
+**expand:** `typing.Optional[EngagementsRetrieveRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+
+
+
+
+
+-
+
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
+
+
+
+
+
+-
+
+**include_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.crm.engagements.partial_update(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Updates an `Engagement` object with the given `id`.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+from merge.resources.crm import PatchedEngagementRequest
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.crm.engagements.partial_update(
+ id="id",
+ model=PatchedEngagementRequest(),
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**id:** `str`
+
+
+
+
+
+-
+
+**model:** `PatchedEngagementRequest`
+
+
+
+
+
+-
+
+**is_debug_mode:** `typing.Optional[bool]` — Whether to include debug fields (such as log file links) in the response.
+
+
+
+
+
+-
+
+**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously.
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.crm.engagements.meta_patch_retrieve(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns metadata for `Engagement` PATCHs.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.crm.engagements.meta_patch_retrieve(
+ id="id",
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**id:** `str`
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.crm.engagements.meta_post_retrieve()
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns metadata for `Engagement` POSTs.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.crm.engagements.meta_post_retrieve()
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.crm.engagements.remote_field_classes_list(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a list of `RemoteFieldClass` objects.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.crm.engagements.remote_field_classes_list()
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**cursor:** `typing.Optional[str]` — The pagination cursor value.
+
+
+
+
+
+-
+
+**include_deleted_data:** `typing.Optional[bool]` — Whether to include data that was marked as deleted by third party webhooks.
+
+
+
+
+
+-
+
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
+
+
+
+
+
+-
+
+**include_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.
+
+
+
+
+
+-
+
+**page_size:** `typing.Optional[int]` — Number of results to return per page.
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.crm.field_mapping.field_mappings_retrieve()
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Get all Field Mappings for this Linked Account. Field Mappings are mappings between third-party Remote Fields and user defined Merge fields. [Learn more](https://docs.merge.dev/supplemental-data/field-mappings/overview/).
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.crm.field_mapping.field_mappings_retrieve()
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.crm.field_mapping.field_mappings_create(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Create new Field Mappings that will be available after the next scheduled sync. This will cause the next sync for this Linked Account to sync **ALL** data from start.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.crm.field_mapping.field_mappings_create(
+ target_field_name="example_target_field_name",
+ target_field_description="this is a example description of the target field",
+ remote_field_traversal_path=["example_remote_field"],
+ remote_method="GET",
+ remote_url_path="/example-url-path",
+ common_model_name="ExampleCommonModel",
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**target_field_name:** `str` — The name of the target field you want this remote field to map to.
+
+
+
+
+
+-
+
+**target_field_description:** `str` — The description of the target field you want this remote field to map to.
+
+
+
+
+
+-
+
+**remote_field_traversal_path:** `typing.Sequence[typing.Any]` — The field traversal path of the remote field listed when you hit the GET /remote-fields endpoint.
+
+
+
+
+
+-
+
+**remote_method:** `str` — The method of the remote endpoint where the remote field is coming from.
+
+
+
+
+
+-
+
+**remote_url_path:** `str` — The path of the remote endpoint where the remote field is coming from.
+
+
+
+
+
+-
+
+**common_model_name:** `str` — The name of the Common Model that the remote field corresponds to in a given category.
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.crm.field_mapping.field_mappings_destroy(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Deletes Field Mappings for a Linked Account. All data related to this Field Mapping will be deleted and these changes will be reflected after the next scheduled sync. This will cause the next sync for this Linked Account to sync **ALL** data from start.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.crm.field_mapping.field_mappings_destroy(
+ field_mapping_id="field_mapping_id",
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**field_mapping_id:** `str`
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.crm.field_mapping.field_mappings_partial_update(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Create or update existing Field Mappings for a Linked Account. Changes will be reflected after the next scheduled sync. This will cause the next sync for this Linked Account to sync **ALL** data from start.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.crm.field_mapping.field_mappings_partial_update(
+ field_mapping_id="field_mapping_id",
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**field_mapping_id:** `str`
+
+
+
+
+
+-
+
+**remote_field_traversal_path:** `typing.Optional[typing.Sequence[typing.Any]]` — The field traversal path of the remote field listed when you hit the GET /remote-fields endpoint.
+
+
+
+
+
+-
+
+**remote_method:** `typing.Optional[str]` — The method of the remote endpoint where the remote field is coming from.
+
+
+
+
+
+-
+
+**remote_url_path:** `typing.Optional[str]` — The path of the remote endpoint where the remote field is coming from.
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.crm.field_mapping.remote_fields_retrieve(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Get all remote fields for a Linked Account. Remote fields are third-party fields that are accessible after initial sync if remote_data is enabled. You can use remote fields to override existing Merge fields or map a new Merge field. [Learn more](https://docs.merge.dev/supplemental-data/field-mappings/overview/).
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.crm.field_mapping.remote_fields_retrieve()
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**common_models:** `typing.Optional[str]` — A comma seperated list of Common Model names. If included, will only return Remote Fields for those Common Models.
+
+
+
+
+
+-
+
+**include_example_values:** `typing.Optional[str]` — If true, will include example values, where available, for remote fields in the 3rd party platform. These examples come from active data from your customers.
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.crm.field_mapping.target_fields_retrieve()
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Get all organization-wide Target Fields, this will not include any Linked Account specific Target Fields. Organization-wide Target Fields are additional fields appended to the Merge Common Model for all Linked Accounts in a category. [Learn more](https://docs.merge.dev/supplemental-data/field-mappings/target-fields/).
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.crm.field_mapping.target_fields_retrieve()
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.crm.generate_key.create(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Create a remote key.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.crm.generate_key.create(
+ name="Remote Deployment Key 1",
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**name:** `str` — The name of the remote key
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.crm.issues.list(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Gets issues.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.crm.issues.list()
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**account_token:** `typing.Optional[str]`
+
+
+
+
+
+-
+
+**cursor:** `typing.Optional[str]` — The pagination cursor value.
+
+
+
+
+
+-
+
+**end_date:** `typing.Optional[str]` — If included, will only include issues whose most recent action occurred before this time
+
+
+
+
+
+-
+
+**end_user_organization_name:** `typing.Optional[str]`
+
+
+
+
+
+-
+
+**first_incident_time_after:** `typing.Optional[dt.datetime]` — If provided, will only return issues whose first incident time was after this datetime.
+
+
+
+
+
+-
+
+**first_incident_time_before:** `typing.Optional[dt.datetime]` — If provided, will only return issues whose first incident time was before this datetime.
+
+
+
+
+
+-
+
+**include_muted:** `typing.Optional[str]` — If true, will include muted issues
+
+
+
+
+
+-
+
+**integration_name:** `typing.Optional[str]`
+
+
+
+
+
+-
+
+**last_incident_time_after:** `typing.Optional[dt.datetime]` — If provided, will only return issues whose last incident time was after this datetime.
+
+
+
+
+
+-
+
+**last_incident_time_before:** `typing.Optional[dt.datetime]` — If provided, will only return issues whose last incident time was before this datetime.
+
+
+
+
+
+-
+
+**page_size:** `typing.Optional[int]` — Number of results to return per page.
+
+
+
+
+
+-
+
+**start_date:** `typing.Optional[str]` — If included, will only include issues whose most recent action occurred after this time
+
+
+
+
+
+-
+
+**status:** `typing.Optional[IssuesListRequestStatus]`
+
+Status of the issue. Options: ('ONGOING', 'RESOLVED')
+
+- `ONGOING` - ONGOING
+- `RESOLVED` - RESOLVED
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.crm.issues.retrieve(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Get a specific issue.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.crm.issues.retrieve(
+ id="id",
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**id:** `str`
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.crm.leads.list(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a list of `Lead` objects.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.crm.leads.list()
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**converted_account_id:** `typing.Optional[str]` — If provided, will only return leads with this account.
+
+
+
+
+
+-
+
+**converted_contact_id:** `typing.Optional[str]` — If provided, will only return leads with this contact.
+
+
+
+
+
+-
+
+**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
+
+
+
+
+
+-
+
+**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
+
+
+
+
+
+-
+
+**cursor:** `typing.Optional[str]` — The pagination cursor value.
+
+
+
+
+
+-
+
+**email_addresses:** `typing.Optional[str]` — If provided, will only return contacts matching the email addresses; multiple email_addresses can be separated by commas.
+
+
+
+
+
+-
+
+**expand:** `typing.Optional[LeadsListRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+
+
+
+
+
+-
+
+**include_deleted_data:** `typing.Optional[bool]` — Whether to include data that was marked as deleted by third party webhooks.
+
+
+
+
+
+-
+
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
+
+
+
+
+
+-
+
+**include_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.
+
+
+
+
+
+-
+
+**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
+
+
+
+
+
+-
+
+**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
+
+
+
+
+
+-
+
+**owner_id:** `typing.Optional[str]` — If provided, will only return leads with this owner.
+
+
+
+
+
+-
+
+**page_size:** `typing.Optional[int]` — Number of results to return per page.
+
+
+
+
+
+-
+
+**phone_numbers:** `typing.Optional[str]` — If provided, will only return contacts matching the phone numbers; multiple phone numbers can be separated by commas.
+
+
+
+
+
+-
+
+**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.crm.leads.create(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Creates a `Lead` object with the given values.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+from merge.resources.crm import LeadRequest
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.crm.leads.create(
+ model=LeadRequest(),
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**model:** `LeadRequest`
+
+
+
+
+
+-
+
+**is_debug_mode:** `typing.Optional[bool]` — Whether to include debug fields (such as log file links) in the response.
+
+
+
+
+
+-
+
+**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously.
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.crm.leads.retrieve(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a `Lead` object with the given `id`.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.crm.leads.retrieve(
+ id="id",
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**id:** `str`
+
+
+
+
+
+-
+
+**expand:** `typing.Optional[LeadsRetrieveRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+
+
+
+
+
+-
+
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
+
+
+
+
+
+-
+
+**include_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.crm.leads.meta_post_retrieve()
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns metadata for `Lead` POSTs.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.crm.leads.meta_post_retrieve()
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.crm.leads.remote_field_classes_list(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a list of `RemoteFieldClass` objects.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.crm.leads.remote_field_classes_list()
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**cursor:** `typing.Optional[str]` — The pagination cursor value.
+
+
+
+
+
+-
+
+**include_deleted_data:** `typing.Optional[bool]` — Whether to include data that was marked as deleted by third party webhooks.
+
+
+
+
+
+-
+
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
+
+
+
+
+
+-
+
+**include_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.
+
+
+
+
+
+-
+
+**page_size:** `typing.Optional[int]` — Number of results to return per page.
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.crm.link_token.create(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Creates a link token to be used when linking a new end user.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+from merge.resources.crm import CategoriesEnum
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.crm.link_token.create(
+ end_user_email_address="example@gmail.com",
+ end_user_organization_name="Test Organization",
+ end_user_origin_id="12345",
+ categories=[CategoriesEnum.HRIS, CategoriesEnum.ATS],
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**end_user_email_address:** `str` — Your end user's email address. This is purely for identification purposes - setting this value will not cause any emails to be sent.
+
+
+
+
+
+-
+
+**end_user_organization_name:** `str` — Your end user's organization.
+
+
+
+
+
+-
+
+**end_user_origin_id:** `str` — This unique identifier typically represents the ID for your end user in your product's database. This value must be distinct from other Linked Accounts' unique identifiers.
+
+
+
+
+
+-
+
+**categories:** `typing.Sequence[CategoriesEnum]` — The integration categories to show in Merge Link.
+
+
+
+
+
+-
+
+**integration:** `typing.Optional[str]` — The slug of a specific pre-selected integration for this linking flow token. For examples of slugs, see https://docs.merge.dev/guides/merge-link/single-integration/.
+
+
+
+
+
+-
+
+**link_expiry_mins:** `typing.Optional[int]` — An integer number of minutes between [30, 720 or 10080 if for a Magic Link URL] for how long this token is valid. Defaults to 30.
+
+
+
+
+
+-
+
+**should_create_magic_link_url:** `typing.Optional[bool]` — Whether to generate a Magic Link URL. Defaults to false. For more information on Magic Link, see https://merge.dev/blog/integrations-fast-say-hello-to-magic-link.
+
+
+
+
+
+-
+
+**common_models:** `typing.Optional[typing.Sequence[CommonModelScopesBodyRequest]]` — An array of objects to specify the models and fields that will be disabled for a given Linked Account. Each object uses model_id, enabled_actions, and disabled_fields to specify the model, method, and fields that are scoped for a given Linked Account.
+
+
+
+
+
+-
+
+**category_common_model_scopes:** `typing.Optional[
+ typing.Dict[
+ str,
+ typing.Optional[
+ typing.Sequence[IndividualCommonModelScopeDeserializerRequest]
+ ],
+ ]
+]` — When creating a Link Token, you can set permissions for Common Models that will apply to the account that is going to be linked. Any model or field not specified in link token payload will default to existing settings.
+
+
+
+
+
+-
+
+**language:** `typing.Optional[str]` — The language code for the language to localize Merge Link to.
+
+
+
+
+
+-
+
+**integration_specific_config:** `typing.Optional[typing.Dict[str, typing.Any]]` — A JSON object containing integration-specific configuration options.
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.crm.linked_accounts.list(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+List linked accounts for your organization.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.crm.linked_accounts.list()
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**category:** `typing.Optional[LinkedAccountsListRequestCategory]`
+
+Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing`
+
+- `hris` - hris
+- `ats` - ats
+- `accounting` - accounting
+- `ticketing` - ticketing
+- `crm` - crm
+- `mktg` - mktg
+- `filestorage` - filestorage
+
+
+
+
+
+-
+
+**cursor:** `typing.Optional[str]` — The pagination cursor value.
+
+
+
+
+
+-
+
+**end_user_email_address:** `typing.Optional[str]` — If provided, will only return linked accounts associated with the given email address.
+
+
+
+
+
+-
+
+**end_user_organization_name:** `typing.Optional[str]` — If provided, will only return linked accounts associated with the given organization name.
+
+
+
+
+
+-
+
+**end_user_origin_id:** `typing.Optional[str]` — If provided, will only return linked accounts associated with the given origin ID.
+
+
+
+
+
+-
+
+**end_user_origin_ids:** `typing.Optional[str]` — Comma-separated list of EndUser origin IDs, making it possible to specify multiple EndUsers at once.
+
+
+
+
+
+-
+
+**id:** `typing.Optional[str]`
+
+
+
+
+
+-
+
+**ids:** `typing.Optional[str]` — Comma-separated list of LinkedAccount IDs, making it possible to specify multiple LinkedAccounts at once.
+
+
+
+
+
+-
+
+**include_duplicates:** `typing.Optional[bool]` — If `true`, will include complete production duplicates of the account specified by the `id` query parameter in the response. `id` must be for a complete production linked account.
+
+
+
+
+
+-
+
+**integration_name:** `typing.Optional[str]` — If provided, will only return linked accounts associated with the given integration name.
+
+
+
+
+
+-
+
+**is_test_account:** `typing.Optional[str]` — If included, will only include test linked accounts. If not included, will only include non-test linked accounts.
+
+
+
+
+
+-
+
+**page_size:** `typing.Optional[int]` — Number of results to return per page.
+
+
+
+
+
+-
+
+**status:** `typing.Optional[str]` — Filter by status. Options: `COMPLETE`, `INCOMPLETE`, `RELINK_NEEDED`
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.crm.notes.list(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a list of `Note` objects.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.crm.notes.list()
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**account_id:** `typing.Optional[str]` — If provided, will only return notes with this account.
+
+
+
+
+
+-
+
+**contact_id:** `typing.Optional[str]` — If provided, will only return notes with this contact.
+
+
+
+
+
+-
+
+**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
+
+
+
+
+
+-
+
+**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
+
+
+
+
+
+-
+
+**cursor:** `typing.Optional[str]` — The pagination cursor value.
+
+
+
+
+
+-
+
+**expand:** `typing.Optional[NotesListRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+
+
+
+
+
+-
+
+**include_deleted_data:** `typing.Optional[bool]` — Whether to include data that was marked as deleted by third party webhooks.
+
+
+
+
+
+-
+
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
+
+
+
+
+
+-
+
+**include_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.
+
+
+
+
+
+-
+
+**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
+
+
+
+
+
+-
+
+**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
+
+
+
+
+
+-
+
+**opportunity_id:** `typing.Optional[str]` — If provided, will only return notes with this opportunity.
+
+
+
+
+
+-
+
+**owner_id:** `typing.Optional[str]` — If provided, will only return notes with this owner.
+
+
+
+
+
+-
+
+**page_size:** `typing.Optional[int]` — Number of results to return per page.
+
+
+
+
+
+-
+
+**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.crm.notes.create(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Creates a `Note` object with the given values.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+from merge.resources.crm import NoteRequest
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.crm.notes.create(
+ model=NoteRequest(),
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**model:** `NoteRequest`
+
+
+
+
+
+-
+
+**is_debug_mode:** `typing.Optional[bool]` — Whether to include debug fields (such as log file links) in the response.
+
+
+
+
+
+-
+
+**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously.
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.crm.notes.retrieve(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a `Note` object with the given `id`.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.crm.notes.retrieve(
+ id="id",
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**id:** `str`
+
+
+
+
+
+-
+
+**expand:** `typing.Optional[NotesRetrieveRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+
+
+
+
+
+-
+
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
+
+
+
+
+
+-
+
+**include_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.crm.notes.meta_post_retrieve()
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns metadata for `Note` POSTs.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.crm.notes.meta_post_retrieve()
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.crm.notes.remote_field_classes_list(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a list of `RemoteFieldClass` objects.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.crm.notes.remote_field_classes_list()
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**cursor:** `typing.Optional[str]` — The pagination cursor value.
+
+
+
+
+
+-
+
+**include_deleted_data:** `typing.Optional[bool]` — Whether to include data that was marked as deleted by third party webhooks.
+
+
+
+
+
+-
+
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
+
+
+
+
+
+-
+
+**include_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.
+
+
+
+
+
+-
+
+**page_size:** `typing.Optional[int]` — Number of results to return per page.
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.crm.opportunities.list(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a list of `Opportunity` objects.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.crm.opportunities.list()
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**account_id:** `typing.Optional[str]` — If provided, will only return opportunities with this account.
+
+
+
+
+
+-
+
+**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
+
+
+
+
+
+-
+
+**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
+
+
+
+
+
+-
+
+**cursor:** `typing.Optional[str]` — The pagination cursor value.
+
+
+
+
+
+-
+
+**expand:** `typing.Optional[OpportunitiesListRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+
+
+
+
+
+-
+
+**include_deleted_data:** `typing.Optional[bool]` — Whether to include data that was marked as deleted by third party webhooks.
+
+
+
+
+
+-
+
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
+
+
+
+
+
+-
+
+**include_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.
+
+
+
+
+
+-
+
+**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
+
+
+
+
+
+-
+
+**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
+
+
+
+
+
+-
+
+**owner_id:** `typing.Optional[str]` — If provided, will only return opportunities with this owner.
+
+
+
+
+
+-
+
+**page_size:** `typing.Optional[int]` — Number of results to return per page.
+
+
+
+
+
+-
+
+**remote_fields:** `typing.Optional[typing.Literal["status"]]` — Deprecated. Use show_enum_origins.
+
+
+
+
+
+-
+
+**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
+
+
+
+
+
+-
+
+**show_enum_origins:** `typing.Optional[typing.Literal["status"]]` — A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter)
+
+
+
+
+
+-
+
+**stage_id:** `typing.Optional[str]` — If provided, will only return opportunities with this stage.
+
+
+
+
+
+-
+
+**status:** `typing.Optional[OpportunitiesListRequestStatus]`
+
+If provided, will only return opportunities with this status. Options: ('OPEN', 'WON', 'LOST')
+
+- `OPEN` - OPEN
+- `WON` - WON
+- `LOST` - LOST
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.crm.opportunities.create(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Creates an `Opportunity` object with the given values.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+from merge.resources.crm import OpportunityRequest
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.crm.opportunities.create(
+ model=OpportunityRequest(),
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**model:** `OpportunityRequest`
+
+
+
+
+
+-
+
+**is_debug_mode:** `typing.Optional[bool]` — Whether to include debug fields (such as log file links) in the response.
+
+
+
+
+
+-
+
+**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously.
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.crm.opportunities.retrieve(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns an `Opportunity` object with the given `id`.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.crm.opportunities.retrieve(
+ id="id",
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**id:** `str`
+
+
+
+
+
+-
+
+**expand:** `typing.Optional[OpportunitiesRetrieveRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+
+
+
+
+
+-
+
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
+
+
+
+
+
+-
+
+**include_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.
+
+
+
+
+
+-
+
+**remote_fields:** `typing.Optional[typing.Literal["status"]]` — Deprecated. Use show_enum_origins.
+
+
+
+
+
+-
+
+**show_enum_origins:** `typing.Optional[typing.Literal["status"]]` — A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter)
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.crm.opportunities.partial_update(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Updates an `Opportunity` object with the given `id`.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+from merge.resources.crm import PatchedOpportunityRequest
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.crm.opportunities.partial_update(
+ id="id",
+ model=PatchedOpportunityRequest(),
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**id:** `str`
+
+
+
+
+
+-
+
+**model:** `PatchedOpportunityRequest`
+
+
+
+
+
+-
+
+**is_debug_mode:** `typing.Optional[bool]` — Whether to include debug fields (such as log file links) in the response.
+
+
+
+
+
+-
+
+**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously.
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.crm.opportunities.meta_patch_retrieve(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns metadata for `Opportunity` PATCHs.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.crm.opportunities.meta_patch_retrieve(
+ id="id",
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**id:** `str`
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.crm.opportunities.meta_post_retrieve()
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns metadata for `Opportunity` POSTs.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.crm.opportunities.meta_post_retrieve()
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.crm.opportunities.remote_field_classes_list(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a list of `RemoteFieldClass` objects.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.crm.opportunities.remote_field_classes_list()
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**cursor:** `typing.Optional[str]` — The pagination cursor value.
+
+
+
+
+
+-
+
+**include_deleted_data:** `typing.Optional[bool]` — Whether to include data that was marked as deleted by third party webhooks.
+
+
+
+
+
+-
+
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
+
+
+
+
+
+-
+
+**include_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.
+
+
+
+
+
+-
+
+**page_size:** `typing.Optional[int]` — Number of results to return per page.
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.crm.passthrough.create(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Pull data from an endpoint not currently supported by Merge.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+from merge.resources.crm import DataPassthroughRequest, MethodEnum
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.crm.passthrough.create(
+ request=DataPassthroughRequest(
+ method=MethodEnum.GET,
+ path="/scooters",
+ ),
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request:** `DataPassthroughRequest`
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.crm.regenerate_key.create(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Exchange remote keys.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.crm.regenerate_key.create(
+ name="Remote Deployment Key 1",
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**name:** `str` — The name of the remote key
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.crm.stages.list(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a list of `Stage` objects.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.crm.stages.list()
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
+
+
+
+
+
+-
+
+**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
+
+
+
+
+
+-
+
+**cursor:** `typing.Optional[str]` — The pagination cursor value.
+
+
+
+
+
+-
+
+**include_deleted_data:** `typing.Optional[bool]` — Whether to include data that was marked as deleted by third party webhooks.
+
+
+
+
+
+-
+
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
+
+
+
+
+
+-
+
+**include_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.
+
+
+
+
+
+-
+
+**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
+
+
+
+
+
+-
+
+**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
+
+
+
+
+
+-
+
+**page_size:** `typing.Optional[int]` — Number of results to return per page.
+
+
+
+
+
+-
+
+**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.crm.stages.retrieve(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a `Stage` object with the given `id`.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.crm.stages.retrieve(
+ id="id",
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**id:** `str`
+
+
+
+
+
+-
+
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
+
+
+
+
+
+-
+
+**include_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.crm.stages.remote_field_classes_list(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a list of `RemoteFieldClass` objects.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.crm.stages.remote_field_classes_list()
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**cursor:** `typing.Optional[str]` — The pagination cursor value.
+
+
+
+
+
+-
+
+**include_deleted_data:** `typing.Optional[bool]` — Whether to include data that was marked as deleted by third party webhooks.
+
+
+
+
+
+-
+
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
+
+
+
+
+
+-
+
+**include_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.
+
+
+
+
+
+-
+
+**page_size:** `typing.Optional[int]` — Number of results to return per page.
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.crm.sync_status.list(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Get syncing status. Possible values: `DISABLED`, `DONE`, `FAILED`, `PARTIALLY_SYNCED`, `PAUSED`, `SYNCING`. Learn more about sync status in our [Help Center](https://help.merge.dev/en/articles/8184193-merge-sync-statuses).
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.crm.sync_status.list()
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**cursor:** `typing.Optional[str]` — The pagination cursor value.
+
+
+
+
+
+-
+
+**page_size:** `typing.Optional[int]` — Number of results to return per page.
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.crm.force_resync.sync_status_resync_create()
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Force re-sync of all models. This is available for all organizations via the dashboard. Force re-sync is also available programmatically via API for monthly, quarterly, and highest sync frequency customers on the Launch, Professional, or Enterprise plans. Doing so will consume a sync credit for the relevant linked account.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.crm.force_resync.sync_status_resync_create()
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.crm.tasks.list(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a list of `Task` objects.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.crm.tasks.list()
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
+
+
+
+
+
+-
+
+**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
+
+
+
+
+
+-
+
+**cursor:** `typing.Optional[str]` — The pagination cursor value.
+
+
+
+
+
+-
+
+**expand:** `typing.Optional[TasksListRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+
+
+
+
+
+-
+
+**include_deleted_data:** `typing.Optional[bool]` — Whether to include data that was marked as deleted by third party webhooks.
+
+
+
+
+
+-
+
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
+
+
+
+
+
+-
+
+**include_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.
+
+
+
+
+
+-
+
+**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
+
+
+
+
+
+-
+
+**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
+
+
+
+
+
+-
+
+**page_size:** `typing.Optional[int]` — Number of results to return per page.
+
+
+
+
+
+-
+
+**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.crm.tasks.create(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Creates a `Task` object with the given values.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+from merge.resources.crm import TaskRequest
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.crm.tasks.create(
+ model=TaskRequest(),
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**model:** `TaskRequest`
+
+
+
+
+
+-
+
+**is_debug_mode:** `typing.Optional[bool]` — Whether to include debug fields (such as log file links) in the response.
+
+
+
+
+
+-
+
+**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously.
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.crm.tasks.retrieve(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a `Task` object with the given `id`.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.crm.tasks.retrieve(
+ id="id",
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**id:** `str`
+
+
+
+
+
+-
+
+**expand:** `typing.Optional[TasksRetrieveRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+
+
+
+
+
+-
+
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
+
+
+
+
+
+-
+
+**include_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.crm.tasks.partial_update(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Updates a `Task` object with the given `id`.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+from merge.resources.crm import PatchedTaskRequest
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.crm.tasks.partial_update(
+ id="id",
+ model=PatchedTaskRequest(),
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**id:** `str`
+
+
+
+
+
+-
+
+**model:** `PatchedTaskRequest`
+
+
+
+
+
+-
+
+**is_debug_mode:** `typing.Optional[bool]` — Whether to include debug fields (such as log file links) in the response.
+
+
+
+
+
+-
+
+**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously.
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.crm.tasks.meta_patch_retrieve(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns metadata for `Task` PATCHs.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.crm.tasks.meta_patch_retrieve(
+ id="id",
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**id:** `str`
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.crm.tasks.meta_post_retrieve()
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns metadata for `Task` POSTs.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.crm.tasks.meta_post_retrieve()
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.crm.tasks.remote_field_classes_list(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a list of `RemoteFieldClass` objects.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.crm.tasks.remote_field_classes_list()
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**cursor:** `typing.Optional[str]` — The pagination cursor value.
+
+
+
+
+
+-
+
+**include_deleted_data:** `typing.Optional[bool]` — Whether to include data that was marked as deleted by third party webhooks.
+
+
+
+
+
+-
+
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
+
+
+
+
+
+-
+
+**include_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.
+
+
+
+
+
+-
+
+**page_size:** `typing.Optional[int]` — Number of results to return per page.
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.crm.users.list(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a list of `User` objects.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.crm.users.list()
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
+
+
+
+
+
+-
+
+**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
+
+
+
+
+
+-
+
+**cursor:** `typing.Optional[str]` — The pagination cursor value.
+
+
+
+
+
+-
+
+**include_deleted_data:** `typing.Optional[bool]` — Whether to include data that was marked as deleted by third party webhooks.
+
+
+
+
+
+-
+
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
+
+
+
+
+
+-
+
+**include_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.
+
+
+
+
+
+-
+
+**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
+
+
+
+
+
+-
+
+**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
+
+
+
+
+
+-
+
+**page_size:** `typing.Optional[int]` — Number of results to return per page.
+
+
+
+
+
+-
+
+**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.crm.users.retrieve(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a `User` object with the given `id`.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.crm.users.retrieve(
+ id="id",
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**id:** `str`
+
+
+
+
+
+-
+
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
+
+
+
+
+
+-
+
+**include_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.crm.users.ignore_create(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Ignores a specific row based on the `model_id` in the url. These records will have their properties set to null, and will not be updated in future syncs. The "reason" and "message" fields in the request body will be stored for audit purposes.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+from merge.resources.crm import IgnoreCommonModelRequest, ReasonEnum
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.crm.users.ignore_create(
+ model_id="model_id",
+ request=IgnoreCommonModelRequest(
+ reason=ReasonEnum.GENERAL_CUSTOMER_REQUEST,
+ ),
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**model_id:** `str`
+
+
+
+
+
+-
+
+**request:** `IgnoreCommonModelRequest`
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.crm.users.remote_field_classes_list(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a list of `RemoteFieldClass` objects.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.crm.users.remote_field_classes_list()
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**cursor:** `typing.Optional[str]` — The pagination cursor value.
+
+
+
+
+
+-
+
+**include_deleted_data:** `typing.Optional[bool]` — Whether to include data that was marked as deleted by third party webhooks.
+
+
+
+
+
+-
+
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
+
+
+
+
+
+-
+
+**include_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.
+
+
+
+
+
+-
+
+**page_size:** `typing.Optional[int]` — Number of results to return per page.
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.crm.webhook_receivers.list()
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a list of `WebhookReceiver` objects.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.crm.webhook_receivers.list()
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.crm.webhook_receivers.create(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Creates a `WebhookReceiver` object with the given values.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.crm.webhook_receivers.create(
+ event="event",
+ is_active=True,
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**event:** `str`
+
+
+
+
+
+-
+
+**is_active:** `bool`
+
+
+
+
+
+-
+
+**key:** `typing.Optional[str]`
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.ticketing.account_details.retrieve()
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Get details for a linked account.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.ticketing.account_details.retrieve()
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.ticketing.account_token.retrieve(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns the account token for the end user with the provided public token.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.ticketing.account_token.retrieve(
+ public_token="public_token",
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**public_token:** `str`
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.ticketing.accounts.list(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a list of `Account` objects.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.ticketing.accounts.list()
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
+
+
+
+
+
+-
+
+**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
+
+
+
+
+
+-
+
+**cursor:** `typing.Optional[str]` — The pagination cursor value.
+
+
+
+
+
+-
+
+**include_deleted_data:** `typing.Optional[bool]` — Whether to include data that was marked as deleted by third party webhooks.
+
+
+
+
+
+-
+
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
+
+
+
+
+
+-
+
+**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
+
+
+
+
+
+-
+
+**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
+
+
+
+
+
+-
+
+**page_size:** `typing.Optional[int]` — Number of results to return per page.
+
+
+
+
+
+-
+
+**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.ticketing.accounts.retrieve(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns an `Account` object with the given `id`.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.ticketing.accounts.retrieve(
+ id="id",
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**id:** `str`
+
+
+
+
+
+-
+
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.ticketing.async_passthrough.create(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Asynchronously pull data from an endpoint not currently supported by Merge.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+from merge.resources.ticketing import DataPassthroughRequest, MethodEnum
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.ticketing.async_passthrough.create(
+ request=DataPassthroughRequest(
+ method=MethodEnum.GET,
+ path="/scooters",
+ ),
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request:** `DataPassthroughRequest`
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.ticketing.async_passthrough.retrieve(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Retrieves data from earlier async-passthrough POST request
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.ticketing.async_passthrough.retrieve(
+ async_passthrough_receipt_id="async_passthrough_receipt_id",
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**async_passthrough_receipt_id:** `str`
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.ticketing.attachments.list(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a list of `Attachment` objects.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.ticketing.attachments.list()
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
+
+
+
+
+
+-
+
+**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
+
+
+
+
+
+-
+
+**cursor:** `typing.Optional[str]` — The pagination cursor value.
+
+
+
+
+
+-
+
+**expand:** `typing.Optional[typing.Literal["ticket"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+
+
+
+
+
+-
+
+**include_deleted_data:** `typing.Optional[bool]` — Whether to include data that was marked as deleted by third party webhooks.
+
+
+
+
+
+-
+
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
+
+
+
+
+
+-
+
+**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
+
+
+
+
+
+-
+
+**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
+
+
+
+
+
+-
+
+**page_size:** `typing.Optional[int]` — Number of results to return per page.
+
+
+
+
+
+-
+
+**remote_created_after:** `typing.Optional[dt.datetime]` — If provided, will only return attachments created in the third party platform after this datetime.
+
+
+
+
+
+-
+
+**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
+
+
+
+
+
+-
+
+**ticket_id:** `typing.Optional[str]` — If provided, will only return comments for this ticket.
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.ticketing.attachments.create(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Creates an `Attachment` object with the given values.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+from merge.resources.ticketing import AttachmentRequest
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.ticketing.attachments.create(
+ model=AttachmentRequest(),
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**model:** `AttachmentRequest`
+
+
+
+
+
+-
+
+**is_debug_mode:** `typing.Optional[bool]` — Whether to include debug fields (such as log file links) in the response.
+
+
+
+
+
+-
+
+**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously.
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.ticketing.attachments.retrieve(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns an `Attachment` object with the given `id`.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.ticketing.attachments.retrieve(
+ id="id",
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**id:** `str`
+
+
+
+
+
+-
+
+**expand:** `typing.Optional[typing.Literal["ticket"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+
+
+
+
+
+-
+
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.ticketing.attachments.download_retrieve(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns an `Attachment` object with the given `id`.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.ticketing.attachments.download_retrieve(
+ id="string",
+ mime_type="string",
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**id:** `str`
+
+
+
+
+
+-
+
+**mime_type:** `typing.Optional[str]` — If provided, specifies the export format of the file to be downloaded. For information on supported export formats, please refer to our export format help center article.
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.ticketing.attachments.meta_post_retrieve()
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns metadata for `TicketingAttachment` POSTs.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.ticketing.attachments.meta_post_retrieve()
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.ticketing.audit_trail.list(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Gets a list of audit trail events.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.ticketing.audit_trail.list()
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**cursor:** `typing.Optional[str]` — The pagination cursor value.
+
+
+
+
+
+-
+
+**end_date:** `typing.Optional[str]` — If included, will only include audit trail events that occurred before this time
+
+
+
+
+
+-
+
+**event_type:** `typing.Optional[str]` — If included, will only include events with the given event type. Possible values include: `CREATED_REMOTE_PRODUCTION_API_KEY`, `DELETED_REMOTE_PRODUCTION_API_KEY`, `CREATED_TEST_API_KEY`, `DELETED_TEST_API_KEY`, `REGENERATED_PRODUCTION_API_KEY`, `INVITED_USER`, `TWO_FACTOR_AUTH_ENABLED`, `TWO_FACTOR_AUTH_DISABLED`, `DELETED_LINKED_ACCOUNT`, `CREATED_DESTINATION`, `DELETED_DESTINATION`, `CHANGED_DESTINATION`, `CHANGED_SCOPES`, `CHANGED_PERSONAL_INFORMATION`, `CHANGED_ORGANIZATION_SETTINGS`, `ENABLED_INTEGRATION`, `DISABLED_INTEGRATION`, `ENABLED_CATEGORY`, `DISABLED_CATEGORY`, `CHANGED_PASSWORD`, `RESET_PASSWORD`, `ENABLED_REDACT_UNMAPPED_DATA_FOR_ORGANIZATION`, `ENABLED_REDACT_UNMAPPED_DATA_FOR_LINKED_ACCOUNT`, `DISABLED_REDACT_UNMAPPED_DATA_FOR_ORGANIZATION`, `DISABLED_REDACT_UNMAPPED_DATA_FOR_LINKED_ACCOUNT`, `CREATED_INTEGRATION_WIDE_FIELD_MAPPING`, `CREATED_LINKED_ACCOUNT_FIELD_MAPPING`, `CHANGED_INTEGRATION_WIDE_FIELD_MAPPING`, `CHANGED_LINKED_ACCOUNT_FIELD_MAPPING`, `DELETED_INTEGRATION_WIDE_FIELD_MAPPING`, `DELETED_LINKED_ACCOUNT_FIELD_MAPPING`, `FORCED_LINKED_ACCOUNT_RESYNC`, `MUTED_ISSUE`, `GENERATED_MAGIC_LINK`, `ENABLED_MERGE_WEBHOOK`, `DISABLED_MERGE_WEBHOOK`, `MERGE_WEBHOOK_TARGET_CHANGED`
+
+
+
+
+
+-
+
+**page_size:** `typing.Optional[int]` — Number of results to return per page.
+
+
+
+
+
+-
+
+**start_date:** `typing.Optional[str]` — If included, will only include audit trail events that occurred after this time
+
+
+
+
+
+-
+
+**user_email:** `typing.Optional[str]` — If provided, this will return events associated with the specified user email. Please note that the email address reflects the user's email at the time of the event, and may not be their current email.
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.ticketing.available_actions.retrieve()
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a list of models and actions available for an account.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.ticketing.available_actions.retrieve()
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.ticketing.collections.list(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a list of `Collection` objects.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.ticketing.collections.list()
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**collection_type:** `typing.Optional[str]` — If provided, will only return collections of the given type.
+
+
+
+
+
+-
+
+**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
+
+
+
+
+
+-
+
+**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
+
+
+
+
+
+-
+
+**cursor:** `typing.Optional[str]` — The pagination cursor value.
+
+
+
+
+
+-
+
+**expand:** `typing.Optional[typing.Literal["parent_collection"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+
+
+
+
+
+-
+
+**include_deleted_data:** `typing.Optional[bool]` — Whether to include data that was marked as deleted by third party webhooks.
+
+
+
+
+
+-
+
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
+
+
+
+
+
+-
+
+**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
+
+
+
+
+
+-
+
+**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
+
+
+
+
+
+-
+
+**page_size:** `typing.Optional[int]` — Number of results to return per page.
+
+
+
+
+
+-
+
+**parent_collection_id:** `typing.Optional[str]` — If provided, will only return collections whose parent collection matches the given id.
+
+
+
+
+
+-
+
+**remote_fields:** `typing.Optional[typing.Literal["collection_type"]]` — Deprecated. Use show_enum_origins.
+
+
+
+
+
+-
+
+**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
+
+
+
+
+
+-
+
+**show_enum_origins:** `typing.Optional[typing.Literal["collection_type"]]` — A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter)
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.ticketing.collections.retrieve(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a `Collection` object with the given `id`.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.ticketing.collections.retrieve(
+ id="id",
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**id:** `str`
+
+
+
+
+
+-
+
+**expand:** `typing.Optional[typing.Literal["parent_collection"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+
+
+
+
+
+-
+
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
+
+
+
+
+
+-
+
+**remote_fields:** `typing.Optional[typing.Literal["collection_type"]]` — Deprecated. Use show_enum_origins.
+
+
+
+
+
+-
+
+**show_enum_origins:** `typing.Optional[typing.Literal["collection_type"]]` — A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter)
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.ticketing.collections.users_list(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a list of `User` objects.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.ticketing.collections.users_list(
+ parent_id="parent_id",
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**parent_id:** `str`
+
+
+
+
+
+-
+
+**cursor:** `typing.Optional[str]` — The pagination cursor value.
+
+
+
+
+
+-
+
+**expand:** `typing.Optional[CollectionsUsersListRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+
+
+
+
+
+-
+
+**include_deleted_data:** `typing.Optional[bool]` — Whether to include data that was marked as deleted by third party webhooks.
+
+
+
+
+
+-
+
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
+
+
+
+
+
+-
+
+**page_size:** `typing.Optional[int]` — Number of results to return per page.
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.ticketing.comments.list(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a list of `Comment` objects.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.ticketing.comments.list()
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
+
+
+
+
+
+-
+
+**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
+
+
+
+
+
+-
+
+**cursor:** `typing.Optional[str]` — The pagination cursor value.
+
+
+
+
+
+-
+
+**expand:** `typing.Optional[CommentsListRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+
+
+
+
+
+-
+
+**include_deleted_data:** `typing.Optional[bool]` — Whether to include data that was marked as deleted by third party webhooks.
+
+
+
+
+
+-
+
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
+
+
+
+
+
+-
+
+**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
+
+
+
+
+
+-
+
+**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
+
+
+
+
+
+-
+
+**page_size:** `typing.Optional[int]` — Number of results to return per page.
+
+
+
+
+
+-
+
+**remote_created_after:** `typing.Optional[dt.datetime]` — If provided, will only return Comments created in the third party platform after this datetime.
+
+
+
+
+
+-
+
+**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
+
+
+
+
+
+-
+
+**ticket_id:** `typing.Optional[str]` — If provided, will only return comments for this ticket.
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.ticketing.comments.create(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Creates a `Comment` object with the given values.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+from merge.resources.ticketing import CommentRequest
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.ticketing.comments.create(
+ model=CommentRequest(),
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**model:** `CommentRequest`
+
+
+
+
+
+-
+
+**is_debug_mode:** `typing.Optional[bool]` — Whether to include debug fields (such as log file links) in the response.
+
+
+
+
+
+-
+
+**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously.
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.ticketing.comments.retrieve(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a `Comment` object with the given `id`.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.ticketing.comments.retrieve(
+ id="id",
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**id:** `str`
+
+
+
+
+
+-
+
+**expand:** `typing.Optional[CommentsRetrieveRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+
+
+
+
+
+-
+
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.ticketing.comments.meta_post_retrieve()
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns metadata for `Comment` POSTs.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.ticketing.comments.meta_post_retrieve()
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.ticketing.contacts.list(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a list of `Contact` objects.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.ticketing.contacts.list()
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
+
+
+
+
+
+-
+
+**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
+
+
+
+
+
+-
+
+**cursor:** `typing.Optional[str]` — The pagination cursor value.
+
+
+
+
+
+-
+
+**expand:** `typing.Optional[typing.Literal["account"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+
+
+
+
+
+-
+
+**include_deleted_data:** `typing.Optional[bool]` — Whether to include data that was marked as deleted by third party webhooks.
+
+
+
+
+
+-
+
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
+
+
+
+
+
+-
+
+**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
+
+
+
+
+
+-
+
+**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
+
+
+
+
+
+-
+
+**page_size:** `typing.Optional[int]` — Number of results to return per page.
+
+
+
+
+
+-
+
+**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.ticketing.contacts.create(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Creates a `Contact` object with the given values.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+from merge.resources.ticketing import ContactRequest
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.ticketing.contacts.create(
+ model=ContactRequest(),
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**model:** `ContactRequest`
+
+
+
+
+
+-
+
+**is_debug_mode:** `typing.Optional[bool]` — Whether to include debug fields (such as log file links) in the response.
+
+
+
+
+
+-
+
+**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously.
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.ticketing.contacts.retrieve(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a `Contact` object with the given `id`.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.ticketing.contacts.retrieve(
+ id="id",
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**id:** `str`
+
+
+
+
+
+-
+
+**expand:** `typing.Optional[typing.Literal["account"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+
+
+
+
+
+-
+
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.ticketing.contacts.meta_post_retrieve()
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns metadata for `TicketingContact` POSTs.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.ticketing.contacts.meta_post_retrieve()
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.ticketing.scopes.default_scopes_retrieve()
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Get the default permissions for Merge Common Models and fields across all Linked Accounts of a given category. [Learn more](https://help.merge.dev/en/articles/8828211-common-model-and-field-scopes).
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.ticketing.scopes.default_scopes_retrieve()
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.ticketing.scopes.linked_account_scopes_retrieve()
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Get all available permissions for Merge Common Models and fields for a single Linked Account. [Learn more](https://help.merge.dev/en/articles/8828211-common-model-and-field-scopes).
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.ticketing.scopes.linked_account_scopes_retrieve()
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.ticketing.scopes.linked_account_scopes_create(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Update permissions for any Common Model or field for a single Linked Account. Any Scopes not set in this POST request will inherit the default Scopes. [Learn more](https://help.merge.dev/en/articles/8828211-common-model-and-field-scopes)
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+from merge.resources.ticketing import (
+ IndividualCommonModelScopeDeserializerRequest,
+ ModelPermissionDeserializerRequest,
+)
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.ticketing.scopes.linked_account_scopes_create(
+ common_models=[
+ IndividualCommonModelScopeDeserializerRequest(
+ model_name="Employee",
+ model_permissions={
+ "READ": ModelPermissionDeserializerRequest(
+ is_enabled=True,
+ ),
+ "WRITE": ModelPermissionDeserializerRequest(
+ is_enabled=False,
+ ),
+ },
+ ),
+ IndividualCommonModelScopeDeserializerRequest(
+ model_name="Benefit",
+ model_permissions={
+ "WRITE": ModelPermissionDeserializerRequest(
+ is_enabled=False,
+ )
+ },
+ ),
+ ],
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**common_models:** `typing.Sequence[IndividualCommonModelScopeDeserializerRequest]` — The common models you want to update the scopes for
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.ticketing.delete_account.delete()
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Delete a linked account.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.ticketing.delete_account.delete()
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.ticketing.field_mapping.field_mappings_retrieve()
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Get all Field Mappings for this Linked Account. Field Mappings are mappings between third-party Remote Fields and user defined Merge fields. [Learn more](https://docs.merge.dev/supplemental-data/field-mappings/overview/).
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.ticketing.field_mapping.field_mappings_retrieve()
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.ticketing.field_mapping.field_mappings_create(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Create new Field Mappings that will be available after the next scheduled sync. This will cause the next sync for this Linked Account to sync **ALL** data from start.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.ticketing.field_mapping.field_mappings_create(
+ target_field_name="example_target_field_name",
+ target_field_description="this is a example description of the target field",
+ remote_field_traversal_path=["example_remote_field"],
+ remote_method="GET",
+ remote_url_path="/example-url-path",
+ common_model_name="ExampleCommonModel",
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**target_field_name:** `str` — The name of the target field you want this remote field to map to.
+
+
+
+
+
+-
+
+**target_field_description:** `str` — The description of the target field you want this remote field to map to.
+
+
+
+
+
+-
+
+**remote_field_traversal_path:** `typing.Sequence[typing.Any]` — The field traversal path of the remote field listed when you hit the GET /remote-fields endpoint.
+
+
+
+
+
+-
+
+**remote_method:** `str` — The method of the remote endpoint where the remote field is coming from.
+
+
+
+
+
+-
+
+**remote_url_path:** `str` — The path of the remote endpoint where the remote field is coming from.
+
+
+
+
+
+-
+
+**common_model_name:** `str` — The name of the Common Model that the remote field corresponds to in a given category.
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.ticketing.field_mapping.field_mappings_destroy(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Deletes Field Mappings for a Linked Account. All data related to this Field Mapping will be deleted and these changes will be reflected after the next scheduled sync. This will cause the next sync for this Linked Account to sync **ALL** data from start.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.ticketing.field_mapping.field_mappings_destroy(
+ field_mapping_id="field_mapping_id",
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**field_mapping_id:** `str`
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.ticketing.field_mapping.field_mappings_partial_update(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Create or update existing Field Mappings for a Linked Account. Changes will be reflected after the next scheduled sync. This will cause the next sync for this Linked Account to sync **ALL** data from start.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.ticketing.field_mapping.field_mappings_partial_update(
+ field_mapping_id="field_mapping_id",
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**field_mapping_id:** `str`
+
+
+
+
+
+-
+
+**remote_field_traversal_path:** `typing.Optional[typing.Sequence[typing.Any]]` — The field traversal path of the remote field listed when you hit the GET /remote-fields endpoint.
+
+
+
+
+
+-
+
+**remote_method:** `typing.Optional[str]` — The method of the remote endpoint where the remote field is coming from.
+
+
+
+
+
+-
+
+**remote_url_path:** `typing.Optional[str]` — The path of the remote endpoint where the remote field is coming from.
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.ticketing.field_mapping.remote_fields_retrieve(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Get all remote fields for a Linked Account. Remote fields are third-party fields that are accessible after initial sync if remote_data is enabled. You can use remote fields to override existing Merge fields or map a new Merge field. [Learn more](https://docs.merge.dev/supplemental-data/field-mappings/overview/).
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.ticketing.field_mapping.remote_fields_retrieve()
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**common_models:** `typing.Optional[str]` — A comma seperated list of Common Model names. If included, will only return Remote Fields for those Common Models.
+
+
+
+
+
+-
+
+**include_example_values:** `typing.Optional[str]` — If true, will include example values, where available, for remote fields in the 3rd party platform. These examples come from active data from your customers.
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.ticketing.field_mapping.target_fields_retrieve()
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Get all organization-wide Target Fields, this will not include any Linked Account specific Target Fields. Organization-wide Target Fields are additional fields appended to the Merge Common Model for all Linked Accounts in a category. [Learn more](https://docs.merge.dev/supplemental-data/field-mappings/target-fields/).
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.ticketing.field_mapping.target_fields_retrieve()
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.ticketing.generate_key.create(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Create a remote key.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.ticketing.generate_key.create(
+ name="Remote Deployment Key 1",
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**name:** `str` — The name of the remote key
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.ticketing.issues.list(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Gets issues.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.ticketing.issues.list()
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**account_token:** `typing.Optional[str]`
+
+
+
+
+
+-
+
+**cursor:** `typing.Optional[str]` — The pagination cursor value.
+
+
+
+
+
+-
+
+**end_date:** `typing.Optional[str]` — If included, will only include issues whose most recent action occurred before this time
+
+
+
+
+
+-
+
+**end_user_organization_name:** `typing.Optional[str]`
+
+
+
+
+
+-
+
+**first_incident_time_after:** `typing.Optional[dt.datetime]` — If provided, will only return issues whose first incident time was after this datetime.
+
+
+
+
+
+-
+
+**first_incident_time_before:** `typing.Optional[dt.datetime]` — If provided, will only return issues whose first incident time was before this datetime.
+
+
+
+
+
+-
+
+**include_muted:** `typing.Optional[str]` — If true, will include muted issues
+
+
+
+
+
+-
+
+**integration_name:** `typing.Optional[str]`
+
+
+
+
+
+-
+
+**last_incident_time_after:** `typing.Optional[dt.datetime]` — If provided, will only return issues whose last incident time was after this datetime.
+
+
+
+
+
+-
+
+**last_incident_time_before:** `typing.Optional[dt.datetime]` — If provided, will only return issues whose last incident time was before this datetime.
+
+
+
+
+
+-
+
+**page_size:** `typing.Optional[int]` — Number of results to return per page.
+
+
+
+
+
+-
+
+**start_date:** `typing.Optional[str]` — If included, will only include issues whose most recent action occurred after this time
+
+
+
+
+
+-
+
+**status:** `typing.Optional[IssuesListRequestStatus]`
+
+Status of the issue. Options: ('ONGOING', 'RESOLVED')
+
+- `ONGOING` - ONGOING
+- `RESOLVED` - RESOLVED
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.ticketing.issues.retrieve(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Get a specific issue.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.ticketing.issues.retrieve(
+ id="id",
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**id:** `str`
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.ticketing.link_token.create(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Creates a link token to be used when linking a new end user.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+from merge.resources.ticketing import CategoriesEnum
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.ticketing.link_token.create(
+ end_user_email_address="example@gmail.com",
+ end_user_organization_name="Test Organization",
+ end_user_origin_id="12345",
+ categories=[CategoriesEnum.HRIS, CategoriesEnum.ATS],
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**end_user_email_address:** `str` — Your end user's email address. This is purely for identification purposes - setting this value will not cause any emails to be sent.
+
+
+
+
+
+-
+
+**end_user_organization_name:** `str` — Your end user's organization.
+
+
+
+
+
+-
+
+**end_user_origin_id:** `str` — This unique identifier typically represents the ID for your end user in your product's database. This value must be distinct from other Linked Accounts' unique identifiers.
+
+
+
+
+
+-
+
+**categories:** `typing.Sequence[CategoriesEnum]` — The integration categories to show in Merge Link.
+
+
+
+
+
+-
+
+**integration:** `typing.Optional[str]` — The slug of a specific pre-selected integration for this linking flow token. For examples of slugs, see https://docs.merge.dev/guides/merge-link/single-integration/.
+
+
+
+
+
+-
+
+**link_expiry_mins:** `typing.Optional[int]` — An integer number of minutes between [30, 720 or 10080 if for a Magic Link URL] for how long this token is valid. Defaults to 30.
+
+
+
+
+
+-
+
+**should_create_magic_link_url:** `typing.Optional[bool]` — Whether to generate a Magic Link URL. Defaults to false. For more information on Magic Link, see https://merge.dev/blog/integrations-fast-say-hello-to-magic-link.
+
+
+
+
+
+-
+
+**common_models:** `typing.Optional[typing.Sequence[CommonModelScopesBodyRequest]]` — An array of objects to specify the models and fields that will be disabled for a given Linked Account. Each object uses model_id, enabled_actions, and disabled_fields to specify the model, method, and fields that are scoped for a given Linked Account.
+
+
+
+
+
+-
+
+**category_common_model_scopes:** `typing.Optional[
+ typing.Dict[
+ str,
+ typing.Optional[
+ typing.Sequence[IndividualCommonModelScopeDeserializerRequest]
+ ],
+ ]
+]` — When creating a Link Token, you can set permissions for Common Models that will apply to the account that is going to be linked. Any model or field not specified in link token payload will default to existing settings.
+
+
+
+
+
+-
+
+**language:** `typing.Optional[str]` — The language code for the language to localize Merge Link to.
+
+
+
+
+
+-
+
+**integration_specific_config:** `typing.Optional[typing.Dict[str, typing.Any]]` — A JSON object containing integration-specific configuration options.
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.ticketing.linked_accounts.list(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+List linked accounts for your organization.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.ticketing.linked_accounts.list()
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**category:** `typing.Optional[LinkedAccountsListRequestCategory]`
+
+Options: ('hris', 'ats', 'accounting', 'ticketing', 'crm', 'mktg', 'filestorage')
+
+- `hris` - hris
+- `ats` - ats
+- `accounting` - accounting
+- `ticketing` - ticketing
+- `crm` - crm
+- `mktg` - mktg
+- `filestorage` - filestorage
+
+
+
+
+
+-
+
+**cursor:** `typing.Optional[str]` — The pagination cursor value.
+
+
+
+
+
+-
+
+**end_user_email_address:** `typing.Optional[str]` — If provided, will only return linked accounts associated with the given email address.
+
+
+
+
+
+-
+
+**end_user_organization_name:** `typing.Optional[str]` — If provided, will only return linked accounts associated with the given organization name.
+
+
+
+
+
+-
+
+**end_user_origin_id:** `typing.Optional[str]` — If provided, will only return linked accounts associated with the given origin ID.
+
+
+
+
+
+-
+
+**end_user_origin_ids:** `typing.Optional[str]` — Comma-separated list of EndUser origin IDs, making it possible to specify multiple EndUsers at once.
+
+
+
+
+
+-
+
+**id:** `typing.Optional[str]`
+
+
+
+
+
+-
+
+**ids:** `typing.Optional[str]` — Comma-separated list of LinkedAccount IDs, making it possible to specify multiple LinkedAccounts at once.
+
+
+
+
+
+-
+
+**include_duplicates:** `typing.Optional[bool]` — If `true`, will include complete production duplicates of the account specified by the `id` query parameter in the response. `id` must be for a complete production linked account.
+
+
+
+
+
+-
+
+**integration_name:** `typing.Optional[str]` — If provided, will only return linked accounts associated with the given integration name.
+
+
+
+
+
+-
+
+**is_test_account:** `typing.Optional[str]` — If included, will only include test linked accounts. If not included, will only include non-test linked accounts.
+
+
+
+
+
+-
+
+**page_size:** `typing.Optional[int]` — Number of results to return per page.
+
+
+
+
+
+-
+
+**status:** `typing.Optional[str]` — Filter by status. Options: `COMPLETE`, `INCOMPLETE`, `RELINK_NEEDED`
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.ticketing.passthrough.create(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Pull data from an endpoint not currently supported by Merge.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+from merge.resources.ticketing import DataPassthroughRequest, MethodEnum
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.ticketing.passthrough.create(
+ request=DataPassthroughRequest(
+ method=MethodEnum.GET,
+ path="/scooters",
+ ),
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request:** `DataPassthroughRequest`
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.ticketing.projects.list(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a list of `Project` objects.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.ticketing.projects.list()
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
+
+
+
+
+
+-
+
+**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
+
+
+
+
+
+-
+
+**cursor:** `typing.Optional[str]` — The pagination cursor value.
+
+
+
+
+
+-
+
+**include_deleted_data:** `typing.Optional[bool]` — Whether to include data that was marked as deleted by third party webhooks.
+
+
+
+
+
+-
+
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
+
+
+
+
+
+-
+
+**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
+
+
+
+
+
+-
+
+**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
+
+
+
+
+
+-
+
+**page_size:** `typing.Optional[int]` — Number of results to return per page.
+
+
+
+
+
+-
+
+**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.ticketing.projects.retrieve(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a `Project` object with the given `id`.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.ticketing.projects.retrieve(
+ id="id",
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**id:** `str`
+
+
+
+
+
+-
+
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.ticketing.projects.users_list(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a list of `User` objects.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.ticketing.projects.users_list(
+ parent_id="parent_id",
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**parent_id:** `str`
+
+
+
+
+
+-
+
+**cursor:** `typing.Optional[str]` — The pagination cursor value.
+
+
+
+
+
+-
+
+**expand:** `typing.Optional[ProjectsUsersListRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+
+
+
+
+
+-
+
+**include_deleted_data:** `typing.Optional[bool]` — Whether to include data that was marked as deleted by third party webhooks.
+
+
+
+
+
+-
+
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
+
+
+
+
+
+-
+
+**page_size:** `typing.Optional[int]` — Number of results to return per page.
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.ticketing.regenerate_key.create(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Exchange remote keys.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.ticketing.regenerate_key.create(
+ name="Remote Deployment Key 1",
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**name:** `str` — The name of the remote key
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.ticketing.roles.list(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a list of `Role` objects.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.ticketing.roles.list()
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
+
+
+
+
+
+-
+
+**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
+
+
+
+
+
+-
+
+**cursor:** `typing.Optional[str]` — The pagination cursor value.
+
+
+
+
+
+-
+
+**include_deleted_data:** `typing.Optional[bool]` — Whether to include data that was marked as deleted by third party webhooks.
+
+
+
+
+
+-
+
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
+
+
+
+
+
+-
+
+**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
+
+
+
+
+
+-
+
+**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
+
+
+
+
+
+-
+
+**page_size:** `typing.Optional[int]` — Number of results to return per page.
+
+
+
+
+
+-
+
+**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.ticketing.roles.retrieve(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a `Role` object with the given `id`.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.ticketing.roles.retrieve(
+ id="id",
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**id:** `str`
+
+
+
+
+
+-
+
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.ticketing.sync_status.list(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Get syncing status. Possible values: `DISABLED`, `DONE`, `FAILED`, `PARTIALLY_SYNCED`, `PAUSED`, `SYNCING`. Learn more about sync status in our [Help Center](https://help.merge.dev/en/articles/8184193-merge-sync-statuses).
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.ticketing.sync_status.list()
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**cursor:** `typing.Optional[str]` — The pagination cursor value.
+
+
+
+
+
+-
+
+**page_size:** `typing.Optional[int]` — Number of results to return per page.
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.ticketing.force_resync.sync_status_resync_create()
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Force re-sync of all models. This is available for all organizations via the dashboard. Force re-sync is also available programmatically via API for monthly, quarterly, and highest sync frequency customers on the Launch, Professional, or Enterprise plans. Doing so will consume a sync credit for the relevant linked account.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.ticketing.force_resync.sync_status_resync_create()
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.ticketing.tags.list(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a list of `Tag` objects.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.ticketing.tags.list()
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
+
+
+
+
+
+-
+
+**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
+
+
+
+
+
+-
+
+**cursor:** `typing.Optional[str]` — The pagination cursor value.
+
+
+
+
+
+-
+
+**include_deleted_data:** `typing.Optional[bool]` — Whether to include data that was marked as deleted by third party webhooks.
+
+
+
+
+
+-
+
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
+
+
+
+
+
+-
+
+**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
+
+
+
+
+
+-
+
+**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
+
+
+
+
+
+-
+
+**page_size:** `typing.Optional[int]` — Number of results to return per page.
+
+
+
+
+
+-
+
+**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.ticketing.tags.retrieve(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a `Tag` object with the given `id`.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.ticketing.tags.retrieve(
+ id="id",
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**id:** `str`
+
+
+
+
+
+-
+
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.ticketing.teams.list(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a list of `Team` objects.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.ticketing.teams.list()
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
+
+
+
+
+
+-
+
+**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
+
+
+
+
+
+-
+
+**cursor:** `typing.Optional[str]` — The pagination cursor value.
+
+
+
+
+
+-
+
+**include_deleted_data:** `typing.Optional[bool]` — Whether to include data that was marked as deleted by third party webhooks.
+
+
+
+
+
+-
+
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
+
+
+
+
+
+-
+
+**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
+
+
+
+
+
+-
+
+**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
+
+
+
+
+
+-
+
+**page_size:** `typing.Optional[int]` — Number of results to return per page.
+
+
+
+
+
+-
+
+**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.ticketing.teams.retrieve(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a `Team` object with the given `id`.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.ticketing.teams.retrieve(
+ id="id",
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**id:** `str`
+
+
+
+
+
+-
+
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.ticketing.tickets.list(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a list of `Ticket` objects.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.ticketing.tickets.list()
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**account_id:** `typing.Optional[str]` — If provided, will only return tickets for this account.
+
+
+
+
+
+-
+
+**assignee_ids:** `typing.Optional[str]` — If provided, will only return tickets assigned to the assignee_ids; multiple assignee_ids can be separated by commas.
+
+
+
+
+
+-
+
+**collection_ids:** `typing.Optional[str]` — If provided, will only return tickets assigned to the collection_ids; multiple collection_ids can be separated by commas.
+
+
+
+
+
+-
+
+**completed_after:** `typing.Optional[dt.datetime]` — If provided, will only return tickets completed after this datetime.
+
+
+
+
+
+-
+
+**completed_before:** `typing.Optional[dt.datetime]` — If provided, will only return tickets completed before this datetime.
+
+
+
+
+
+-
+
+**contact_id:** `typing.Optional[str]` — If provided, will only return tickets for this contact.
+
+
+
+
+
+-
+
+**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
+
+
+
+
+
+-
+
+**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
+
+
+
+
+
+-
+
+**cursor:** `typing.Optional[str]` — The pagination cursor value.
+
+
+
+
+
+-
+
+**due_after:** `typing.Optional[dt.datetime]` — If provided, will only return tickets due after this datetime.
+
+
+
+
+
+-
+
+**due_before:** `typing.Optional[dt.datetime]` — If provided, will only return tickets due before this datetime.
+
+
+
+
+
+-
+
+**expand:** `typing.Optional[TicketsListRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+
+
+
+
+
+-
+
+**include_deleted_data:** `typing.Optional[bool]` — Whether to include data that was marked as deleted by third party webhooks.
+
+
+
+
+
+-
+
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
+
+
+
+
+
+-
+
+**include_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.
+
+
+
+
+
+-
+
+**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
+
+
+
+
+
+-
+
+**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
+
+
+
+
+
+-
+
+**page_size:** `typing.Optional[int]` — Number of results to return per page.
+
+
+
+
+
+-
+
+**parent_ticket_id:** `typing.Optional[str]` — If provided, will only return sub tickets of the parent_ticket_id.
+
+
+
+
+
+-
+
+**priority:** `typing.Optional[TicketsListRequestPriority]`
+
+If provided, will only return tickets of this priority.
+
+- `URGENT` - URGENT
+- `HIGH` - HIGH
+- `NORMAL` - NORMAL
+- `LOW` - LOW
+
+
+
+
+
+-
+
+**remote_created_after:** `typing.Optional[dt.datetime]` — If provided, will only return tickets created in the third party platform after this datetime.
+
+
+
+
+
+-
+
+**remote_created_before:** `typing.Optional[dt.datetime]` — If provided, will only return tickets created in the third party platform before this datetime.
+
+
+
+
+
+-
+
+**remote_fields:** `typing.Optional[TicketsListRequestRemoteFields]` — Deprecated. Use show_enum_origins.
+
+
+
+
+
+-
+
+**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
+
+
+
+
+
+-
+
+**remote_updated_after:** `typing.Optional[dt.datetime]` — If provided, will only return tickets updated in the third party platform after this datetime.
+
+
+
+
+
+-
+
+**remote_updated_before:** `typing.Optional[dt.datetime]` — If provided, will only return tickets updated in the third party platform before this datetime.
+
+
+
+
+
+-
+
+**show_enum_origins:** `typing.Optional[TicketsListRequestShowEnumOrigins]` — A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter)
+
+
+
+
+
+-
+
+**status:** `typing.Optional[TicketsListRequestStatus]`
+
+If provided, will only return tickets of this status.
+
+- `OPEN` - OPEN
+- `CLOSED` - CLOSED
+- `IN_PROGRESS` - IN_PROGRESS
+- `ON_HOLD` - ON_HOLD
+
+
+
+
+
+-
+
+**tags:** `typing.Optional[str]` — If provided, will only return tickets matching the tags; multiple tags can be separated by commas.
+
+
+
+
+
+-
+
+**ticket_type:** `typing.Optional[str]` — If provided, will only return tickets of this type.
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.ticketing.tickets.create(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Creates a `Ticket` object with the given values.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+from merge.resources.ticketing import TicketRequest
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.ticketing.tickets.create(
+ model=TicketRequest(),
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**model:** `TicketRequest`
+
+
+
+
+
+-
+
+**is_debug_mode:** `typing.Optional[bool]` — Whether to include debug fields (such as log file links) in the response.
+
+
+
+
+
+-
+
+**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously.
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.ticketing.tickets.retrieve(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a `Ticket` object with the given `id`.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.ticketing.tickets.retrieve(
+ id="id",
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**id:** `str`
+
+
+
+
+
+-
+
+**expand:** `typing.Optional[TicketsRetrieveRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+
+
+
+
+
+-
+
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
+
+
+
+
+
+-
+
+**include_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.
+
+
+
+
+
+-
+
+**remote_fields:** `typing.Optional[TicketsRetrieveRequestRemoteFields]` — Deprecated. Use show_enum_origins.
+
+
+
+
+
+-
+
+**show_enum_origins:** `typing.Optional[TicketsRetrieveRequestShowEnumOrigins]` — A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter)
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.ticketing.tickets.partial_update(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Updates a `Ticket` object with the given `id`.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+from merge.resources.ticketing import PatchedTicketRequest
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.ticketing.tickets.partial_update(
+ id="id",
+ model=PatchedTicketRequest(),
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**id:** `str`
+
+
+
+
+
+-
+
+**model:** `PatchedTicketRequest`
+
+
+
+
+
+-
+
+**is_debug_mode:** `typing.Optional[bool]` — Whether to include debug fields (such as log file links) in the response.
+
+
+
+
+
+-
+
+**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously.
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.ticketing.tickets.collaborators_list(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a list of `User` objects.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.ticketing.tickets.collaborators_list(
+ parent_id="parent_id",
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**parent_id:** `str`
+
+
+
+
+
+-
+
+**cursor:** `typing.Optional[str]` — The pagination cursor value.
+
+
+
+
+
+-
+
+**expand:** `typing.Optional[TicketsCollaboratorsListRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+
+
+
+
+
+-
+
+**include_deleted_data:** `typing.Optional[bool]` — Whether to include data that was marked as deleted by third party webhooks.
+
+
+
+
+
+-
+
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
+
+
+
+
+
+-
+
+**page_size:** `typing.Optional[int]` — Number of results to return per page.
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.ticketing.tickets.meta_patch_retrieve(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns metadata for `Ticket` PATCHs.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.ticketing.tickets.meta_patch_retrieve(
+ id="id",
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**id:** `str`
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.ticketing.tickets.meta_post_retrieve()
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns metadata for `Ticket` POSTs.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.ticketing.tickets.meta_post_retrieve()
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.ticketing.tickets.remote_field_classes_list(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a list of `RemoteFieldClass` objects.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.ticketing.tickets.remote_field_classes_list()
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**cursor:** `typing.Optional[str]` — The pagination cursor value.
+
+
+
+
+
+-
+
+**include_deleted_data:** `typing.Optional[bool]` — Whether to include data that was marked as deleted by third party webhooks.
+
+
+
+
+
+-
+
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
+
+
+
+
+
+-
+
+**page_size:** `typing.Optional[int]` — Number of results to return per page.
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.ticketing.users.list(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a list of `User` objects.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.ticketing.users.list()
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
+
+
+
+
+
+-
+
+**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
+
+
+
+
+
+-
+
+**cursor:** `typing.Optional[str]` — The pagination cursor value.
+
+
+
+
+
+-
+
+**email_address:** `typing.Optional[str]` — If provided, will only return users with emails equal to this value (case insensitive).
+
+
+
+
+
+-
+
+**expand:** `typing.Optional[UsersListRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+
+
+
+
+
+-
+
+**include_deleted_data:** `typing.Optional[bool]` — Whether to include data that was marked as deleted by third party webhooks.
+
+
+
+
+
+-
+
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
+
+
+
+
+
+-
+
+**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
+
+
+
+
+
+-
+
+**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
+
+
+
+
+
+-
+
+**page_size:** `typing.Optional[int]` — Number of results to return per page.
+
+
+
+
+
+-
+
+**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.ticketing.users.retrieve(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a `User` object with the given `id`.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.ticketing.users.retrieve(
+ id="id",
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**id:** `str`
+
+
+
+
+
+-
+
+**expand:** `typing.Optional[UsersRetrieveRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+
+
+
+
+
+-
+
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.ticketing.webhook_receivers.list()
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a list of `WebhookReceiver` objects.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.ticketing.webhook_receivers.list()
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.ticketing.webhook_receivers.create(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Creates a `WebhookReceiver` object with the given values.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.ticketing.webhook_receivers.create(
+ event="event",
+ is_active=True,
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**event:** `str`
+
+
+
+
+
+-
+
+**is_active:** `bool`
+
+
+
+
+
+-
+
+**key:** `typing.Optional[str]`
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.accounting.account_details.retrieve()
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Get details for a linked account.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.accounting.account_details.retrieve()
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.accounting.account_token.retrieve(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns the account token for the end user with the provided public token.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.accounting.account_token.retrieve(
+ public_token="public_token",
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**public_token:** `str`
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.accounting.accounting_periods.list(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a list of `AccountingPeriod` objects.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.accounting.accounting_periods.list()
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**cursor:** `typing.Optional[str]` — The pagination cursor value.
+
+
+
+
+
+-
+
+**include_deleted_data:** `typing.Optional[bool]` — Whether to include data that was marked as deleted by third party webhooks.
+
+
+
+
+
+-
+
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
+
+
+
+
+
+-
+
+**page_size:** `typing.Optional[int]` — Number of results to return per page.
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.accounting.accounting_periods.retrieve(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns an `AccountingPeriod` object with the given `id`.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.accounting.accounting_periods.retrieve(
+ id="id",
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**id:** `str`
+
+
+
+
+
+-
+
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.accounting.accounts.list(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a list of `Account` objects.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.accounting.accounts.list()
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**company_id:** `typing.Optional[str]` — If provided, will only return accounts for this company.
+
+
+
+
+
+-
+
+**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
+
+
+
+
+
+-
+
+**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
+
+
+
+
+
+-
+
+**cursor:** `typing.Optional[str]` — The pagination cursor value.
+
+
+
+
+
+-
+
+**expand:** `typing.Optional[typing.Literal["company"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+
+
+
+
+
+-
+
+**include_deleted_data:** `typing.Optional[bool]` — Whether to include data that was marked as deleted by third party webhooks.
+
+
+
+
+
+-
+
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
+
+
+
+
+
+-
+
+**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
+
+
+
+
+
+-
+
+**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
+
+
+
+
+
+-
+
+**page_size:** `typing.Optional[int]` — Number of results to return per page.
+
+
+
+
+
+-
+
+**remote_fields:** `typing.Optional[AccountsListRequestRemoteFields]` — Deprecated. Use show_enum_origins.
+
+
+
+
+
+-
+
+**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
+
+
+
+
+
+-
+
+**show_enum_origins:** `typing.Optional[AccountsListRequestShowEnumOrigins]` — A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter)
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.accounting.accounts.create(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Creates an `Account` object with the given values.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+from merge.resources.accounting import AccountRequest
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.accounting.accounts.create(
+ model=AccountRequest(),
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**model:** `AccountRequest`
+
+
+
+
+
+-
+
+**is_debug_mode:** `typing.Optional[bool]` — Whether to include debug fields (such as log file links) in the response.
+
+
+
+
+
+-
+
+**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously.
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.accounting.accounts.retrieve(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns an `Account` object with the given `id`.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.accounting.accounts.retrieve(
+ id="id",
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**id:** `str`
+
+
+
+
+
+-
+
+**expand:** `typing.Optional[typing.Literal["company"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+
+
+
+
+
+-
+
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
+
+
+
+
+
+-
+
+**remote_fields:** `typing.Optional[AccountsRetrieveRequestRemoteFields]` — Deprecated. Use show_enum_origins.
+
+
+
+
+
+-
+
+**show_enum_origins:** `typing.Optional[AccountsRetrieveRequestShowEnumOrigins]` — A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter)
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.accounting.accounts.meta_post_retrieve()
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns metadata for `Account` POSTs.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.accounting.accounts.meta_post_retrieve()
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.accounting.addresses.retrieve(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns an `Address` object with the given `id`.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.accounting.addresses.retrieve(
+ id="id",
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**id:** `str`
+
+
+
+
+
+-
+
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
+
+
+
+
+
+-
+
+**remote_fields:** `typing.Optional[typing.Literal["type"]]` — Deprecated. Use show_enum_origins.
+
+
+
+
+
+-
+
+**show_enum_origins:** `typing.Optional[typing.Literal["type"]]` — A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter)
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.accounting.async_passthrough.create(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Asynchronously pull data from an endpoint not currently supported by Merge.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+from merge.resources.accounting import DataPassthroughRequest, MethodEnum
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.accounting.async_passthrough.create(
+ request=DataPassthroughRequest(
+ method=MethodEnum.GET,
+ path="/scooters",
+ ),
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request:** `DataPassthroughRequest`
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.accounting.async_passthrough.retrieve(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Retrieves data from earlier async-passthrough POST request
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.accounting.async_passthrough.retrieve(
+ async_passthrough_receipt_id="async_passthrough_receipt_id",
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**async_passthrough_receipt_id:** `str`
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.accounting.attachments.list(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a list of `AccountingAttachment` objects.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.accounting.attachments.list()
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**company_id:** `typing.Optional[str]` — If provided, will only return accounting attachments for this company.
+
+
+
+
+
+-
+
+**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
+
+
+
+
+
+-
+
+**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
+
+
+
+
+
+-
+
+**cursor:** `typing.Optional[str]` — The pagination cursor value.
+
+
+
+
+
+-
+
+**include_deleted_data:** `typing.Optional[bool]` — Whether to include data that was marked as deleted by third party webhooks.
+
+
+
+
+
+-
+
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
+
+
+
+
+
+-
+
+**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
+
+
+
+
+
+-
+
+**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
+
+
+
+
+
+-
+
+**page_size:** `typing.Optional[int]` — Number of results to return per page.
+
+
+
+
+
+-
+
+**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.accounting.attachments.create(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Creates an `AccountingAttachment` object with the given values.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+from merge.resources.accounting import AccountingAttachmentRequest
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.accounting.attachments.create(
+ model=AccountingAttachmentRequest(),
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**model:** `AccountingAttachmentRequest`
+
+
+
+
+
+-
+
+**is_debug_mode:** `typing.Optional[bool]` — Whether to include debug fields (such as log file links) in the response.
+
+
+
+
+
+-
+
+**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously.
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.accounting.attachments.retrieve(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns an `AccountingAttachment` object with the given `id`.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.accounting.attachments.retrieve(
+ id="id",
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**id:** `str`
+
+
+
+
+
+-
+
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.accounting.attachments.meta_post_retrieve()
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns metadata for `AccountingAttachment` POSTs.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.accounting.attachments.meta_post_retrieve()
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.accounting.audit_trail.list(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Gets a list of audit trail events.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.accounting.audit_trail.list()
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**cursor:** `typing.Optional[str]` — The pagination cursor value.
+
+
+
+
+
+-
+
+**end_date:** `typing.Optional[str]` — If included, will only include audit trail events that occurred before this time
+
+
+
+
+
+-
+
+**event_type:** `typing.Optional[str]` — If included, will only include events with the given event type. Possible values include: `CREATED_REMOTE_PRODUCTION_API_KEY`, `DELETED_REMOTE_PRODUCTION_API_KEY`, `CREATED_TEST_API_KEY`, `DELETED_TEST_API_KEY`, `REGENERATED_PRODUCTION_API_KEY`, `INVITED_USER`, `TWO_FACTOR_AUTH_ENABLED`, `TWO_FACTOR_AUTH_DISABLED`, `DELETED_LINKED_ACCOUNT`, `CREATED_DESTINATION`, `DELETED_DESTINATION`, `CHANGED_DESTINATION`, `CHANGED_SCOPES`, `CHANGED_PERSONAL_INFORMATION`, `CHANGED_ORGANIZATION_SETTINGS`, `ENABLED_INTEGRATION`, `DISABLED_INTEGRATION`, `ENABLED_CATEGORY`, `DISABLED_CATEGORY`, `CHANGED_PASSWORD`, `RESET_PASSWORD`, `ENABLED_REDACT_UNMAPPED_DATA_FOR_ORGANIZATION`, `ENABLED_REDACT_UNMAPPED_DATA_FOR_LINKED_ACCOUNT`, `DISABLED_REDACT_UNMAPPED_DATA_FOR_ORGANIZATION`, `DISABLED_REDACT_UNMAPPED_DATA_FOR_LINKED_ACCOUNT`, `CREATED_INTEGRATION_WIDE_FIELD_MAPPING`, `CREATED_LINKED_ACCOUNT_FIELD_MAPPING`, `CHANGED_INTEGRATION_WIDE_FIELD_MAPPING`, `CHANGED_LINKED_ACCOUNT_FIELD_MAPPING`, `DELETED_INTEGRATION_WIDE_FIELD_MAPPING`, `DELETED_LINKED_ACCOUNT_FIELD_MAPPING`, `FORCED_LINKED_ACCOUNT_RESYNC`, `MUTED_ISSUE`, `GENERATED_MAGIC_LINK`, `ENABLED_MERGE_WEBHOOK`, `DISABLED_MERGE_WEBHOOK`, `MERGE_WEBHOOK_TARGET_CHANGED`
+
+
+
+
+
+-
+
+**page_size:** `typing.Optional[int]` — Number of results to return per page.
+
+
+
+
+
+-
+
+**start_date:** `typing.Optional[str]` — If included, will only include audit trail events that occurred after this time
+
+
+
+
+
+-
+
+**user_email:** `typing.Optional[str]` — If provided, this will return events associated with the specified user email. Please note that the email address reflects the user's email at the time of the event, and may not be their current email.
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.accounting.available_actions.retrieve()
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a list of models and actions available for an account.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.accounting.available_actions.retrieve()
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.accounting.balance_sheets.list(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a list of `BalanceSheet` objects.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.accounting.balance_sheets.list()
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**company_id:** `typing.Optional[str]` — If provided, will only return balance sheets for this company.
+
+
+
+
+
+-
+
+**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
+
+
+
+
+
+-
+
+**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
+
+
+
+
+
+-
+
+**cursor:** `typing.Optional[str]` — The pagination cursor value.
+
+
+
+
+
+-
+
+**expand:** `typing.Optional[typing.Literal["company"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+
+
+
+
+
+-
+
+**include_deleted_data:** `typing.Optional[bool]` — Whether to include data that was marked as deleted by third party webhooks.
+
+
+
+
+
+-
+
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
+
+
+
+
+
+-
+
+**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
+
+
+
+
+
+-
+
+**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
+
+
+
+
+
+-
+
+**page_size:** `typing.Optional[int]` — Number of results to return per page.
+
+
+
+
+
+-
+
+**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.accounting.balance_sheets.retrieve(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a `BalanceSheet` object with the given `id`.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.accounting.balance_sheets.retrieve(
+ id="id",
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**id:** `str`
+
+
+
+
+
+-
+
+**expand:** `typing.Optional[typing.Literal["company"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+
+
+
+
+
+-
+
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.accounting.cash_flow_statements.list(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a list of `CashFlowStatement` objects.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.accounting.cash_flow_statements.list()
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**company_id:** `typing.Optional[str]` — If provided, will only return cash flow statements for this company.
+
+
+
+
+
+-
+
+**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
+
+
+
+
+
+-
+
+**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
+
+
+
+
+
+-
+
+**cursor:** `typing.Optional[str]` — The pagination cursor value.
+
+
+
+
+
+-
+
+**expand:** `typing.Optional[typing.Literal["company"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+
+
+
+
+
+-
+
+**include_deleted_data:** `typing.Optional[bool]` — Whether to include data that was marked as deleted by third party webhooks.
+
+
+
+
+
+-
+
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
+
+
+
+
+
+-
+
+**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
+
+
+
+
+
+-
+
+**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
+
+
+
+
+
+-
+
+**page_size:** `typing.Optional[int]` — Number of results to return per page.
+
+
+
+
+
+-
+
+**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.accounting.cash_flow_statements.retrieve(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a `CashFlowStatement` object with the given `id`.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.accounting.cash_flow_statements.retrieve(
+ id="id",
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**id:** `str`
+
+
+
+
+
+-
+
+**expand:** `typing.Optional[typing.Literal["company"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+
+
+
+
+
+-
+
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.accounting.company_info.list(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a list of `CompanyInfo` objects.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.accounting.company_info.list()
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
+
+
+
+
+
+-
+
+**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
+
+
+
+
+
+-
+
+**cursor:** `typing.Optional[str]` — The pagination cursor value.
+
+
+
+
+
+-
+
+**expand:** `typing.Optional[CompanyInfoListRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+
+
+
+
+
+-
+
+**include_deleted_data:** `typing.Optional[bool]` — Whether to include data that was marked as deleted by third party webhooks.
+
+
+
+
+
+-
+
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
+
+
+
+
+
+-
+
+**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
+
+
+
+
+
+-
+
+**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
+
+
+
+
+
+-
+
+**page_size:** `typing.Optional[int]` — Number of results to return per page.
+
+
+
+
+
+-
+
+**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.accounting.company_info.retrieve(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a `CompanyInfo` object with the given `id`.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.accounting.company_info.retrieve(
+ id="id",
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**id:** `str`
+
+
+
+
+
+-
+
+**expand:** `typing.Optional[CompanyInfoRetrieveRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+
+
+
+
+
+-
+
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.accounting.contacts.list(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a list of `Contact` objects.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.accounting.contacts.list()
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**company_id:** `typing.Optional[str]` — If provided, will only return contacts for this company.
+
+
+
+
+
+-
+
+**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
+
+
+
+
+
+-
+
+**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
+
+
+
+
+
+-
+
+**cursor:** `typing.Optional[str]` — The pagination cursor value.
+
+
+
+
+
+-
+
+**expand:** `typing.Optional[ContactsListRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+
+
+
+
+
+-
+
+**include_deleted_data:** `typing.Optional[bool]` — Whether to include data that was marked as deleted by third party webhooks.
+
+
+
+
+
+-
+
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
+
+
+
+
+
+-
+
+**is_customer:** `typing.Optional[str]` — If provided, will only return Contacts that are denoted as customers.
+
+
+
+
+
+-
+
+**is_supplier:** `typing.Optional[str]` — If provided, will only return Contacts that are denoted as suppliers.
+
+
+
+
+
+-
+
+**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
+
+
+
+
+
+-
+
+**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
+
+
+
+
+
+-
+
+**page_size:** `typing.Optional[int]` — Number of results to return per page.
+
+
+
+
+
+-
+
+**remote_fields:** `typing.Optional[typing.Literal["status"]]` — Deprecated. Use show_enum_origins.
+
+
+
+
+
+-
+
+**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
+
+
+
+
+
+-
+
+**show_enum_origins:** `typing.Optional[typing.Literal["status"]]` — A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter)
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.accounting.contacts.create(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Creates a `Contact` object with the given values.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+from merge.resources.accounting import ContactRequest
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.accounting.contacts.create(
+ model=ContactRequest(),
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**model:** `ContactRequest`
+
+
+
+
+
+-
+
+**is_debug_mode:** `typing.Optional[bool]` — Whether to include debug fields (such as log file links) in the response.
+
+
+
+
+
+-
+
+**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously.
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.accounting.contacts.retrieve(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a `Contact` object with the given `id`.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.accounting.contacts.retrieve(
+ id="id",
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**id:** `str`
+
+
+
+
+
+-
+
+**expand:** `typing.Optional[ContactsRetrieveRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+
+
+
+
+
+-
+
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
+
+
+
+
+
+-
+
+**remote_fields:** `typing.Optional[typing.Literal["status"]]` — Deprecated. Use show_enum_origins.
+
+
+
+
+
+-
+
+**show_enum_origins:** `typing.Optional[typing.Literal["status"]]` — A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter)
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.accounting.contacts.meta_post_retrieve()
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns metadata for `Contact` POSTs.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.accounting.contacts.meta_post_retrieve()
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.accounting.credit_notes.list(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a list of `CreditNote` objects.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.accounting.credit_notes.list()
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**company_id:** `typing.Optional[str]` — If provided, will only return credit notes for this company.
+
+
+
+
+
+-
+
+**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
+
+
+
+
+
+-
+
+**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
+
+
+
+
+
+-
+
+**cursor:** `typing.Optional[str]` — The pagination cursor value.
+
+
+
+
+
+-
+
+**expand:** `typing.Optional[CreditNotesListRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+
+
+
+
+
+-
+
+**include_deleted_data:** `typing.Optional[bool]` — Whether to include data that was marked as deleted by third party webhooks.
+
+
+
+
+
+-
+
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
+
+
+
+
+
+-
+
+**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
+
+
+
+
+
+-
+
+**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
+
+
+
+
+
+-
+
+**page_size:** `typing.Optional[int]` — Number of results to return per page.
+
+
+
+
+
+-
+
+**remote_fields:** `typing.Optional[CreditNotesListRequestRemoteFields]` — Deprecated. Use show_enum_origins.
+
+
+
+
+
+-
+
+**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
+
+
+
+
+
+-
+
+**show_enum_origins:** `typing.Optional[CreditNotesListRequestShowEnumOrigins]` — A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter)
+
+
+
+
+
+-
+
+**transaction_date_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
+
+
+
+
+
+-
+
+**transaction_date_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.accounting.credit_notes.retrieve(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a `CreditNote` object with the given `id`.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.accounting.credit_notes.retrieve(
+ id="id",
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**id:** `str`
+
+
+
+
+
+-
+
+**expand:** `typing.Optional[CreditNotesRetrieveRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+
+
+
+
+
+-
+
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
+
+
+
+
+
+-
+
+**remote_fields:** `typing.Optional[CreditNotesRetrieveRequestRemoteFields]` — Deprecated. Use show_enum_origins.
+
+
+
+
+
+-
+
+**show_enum_origins:** `typing.Optional[CreditNotesRetrieveRequestShowEnumOrigins]` — A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter)
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.accounting.scopes.default_scopes_retrieve()
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Get the default permissions for Merge Common Models and fields across all Linked Accounts of a given category. [Learn more](https://help.merge.dev/en/articles/8828211-common-model-and-field-scopes).
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.accounting.scopes.default_scopes_retrieve()
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.accounting.scopes.linked_account_scopes_retrieve()
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Get all available permissions for Merge Common Models and fields for a single Linked Account. [Learn more](https://help.merge.dev/en/articles/8828211-common-model-and-field-scopes).
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.accounting.scopes.linked_account_scopes_retrieve()
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.accounting.scopes.linked_account_scopes_create(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Update permissions for any Common Model or field for a single Linked Account. Any Scopes not set in this POST request will inherit the default Scopes. [Learn more](https://help.merge.dev/en/articles/8828211-common-model-and-field-scopes)
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+from merge.resources.accounting import (
+ IndividualCommonModelScopeDeserializerRequest,
+ ModelPermissionDeserializerRequest,
+)
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.accounting.scopes.linked_account_scopes_create(
+ common_models=[
+ IndividualCommonModelScopeDeserializerRequest(
+ model_name="Employee",
+ model_permissions={
+ "READ": ModelPermissionDeserializerRequest(
+ is_enabled=True,
+ ),
+ "WRITE": ModelPermissionDeserializerRequest(
+ is_enabled=False,
+ ),
+ },
+ ),
+ IndividualCommonModelScopeDeserializerRequest(
+ model_name="Benefit",
+ model_permissions={
+ "WRITE": ModelPermissionDeserializerRequest(
+ is_enabled=False,
+ )
+ },
+ ),
+ ],
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**common_models:** `typing.Sequence[IndividualCommonModelScopeDeserializerRequest]` — The common models you want to update the scopes for
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.accounting.delete_account.delete()
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Delete a linked account.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.accounting.delete_account.delete()
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.accounting.expenses.list(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a list of `Expense` objects.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.accounting.expenses.list()
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**company_id:** `typing.Optional[str]` — If provided, will only return expenses for this company.
+
+
+
+
+
+-
+
+**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
+
+
+
+
+
+-
+
+**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
+
+
+
+
+
+-
+
+**cursor:** `typing.Optional[str]` — The pagination cursor value.
+
+
+
+
+
+-
+
+**expand:** `typing.Optional[ExpensesListRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+
+
+
+
+
+-
+
+**include_deleted_data:** `typing.Optional[bool]` — Whether to include data that was marked as deleted by third party webhooks.
+
+
+
+
+
+-
+
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
+
+
+
+
+
+-
+
+**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
+
+
+
+
+
+-
+
+**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
+
+
+
+
+
+-
+
+**page_size:** `typing.Optional[int]` — Number of results to return per page.
+
+
+
+
+
+-
+
+**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
+
+
+
+
+
+-
+
+**transaction_date_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
+
+
+
+
+
+-
+
+**transaction_date_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.accounting.expenses.create(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Creates an `Expense` object with the given values.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+from merge.resources.accounting import ExpenseRequest
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.accounting.expenses.create(
+ model=ExpenseRequest(),
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**model:** `ExpenseRequest`
+
+
+
+
+
+-
+
+**is_debug_mode:** `typing.Optional[bool]` — Whether to include debug fields (such as log file links) in the response.
+
+
+
+
+
+-
+
+**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously.
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.accounting.expenses.retrieve(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns an `Expense` object with the given `id`.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.accounting.expenses.retrieve(
+ id="id",
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**id:** `str`
+
+
+
+
+
+-
+
+**expand:** `typing.Optional[ExpensesRetrieveRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+
+
+
+
+
+-
+
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.accounting.expenses.meta_post_retrieve()
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns metadata for `Expense` POSTs.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.accounting.expenses.meta_post_retrieve()
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.accounting.field_mapping.field_mappings_retrieve()
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Get all Field Mappings for this Linked Account. Field Mappings are mappings between third-party Remote Fields and user defined Merge fields. [Learn more](https://docs.merge.dev/supplemental-data/field-mappings/overview/).
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.accounting.field_mapping.field_mappings_retrieve()
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.accounting.field_mapping.field_mappings_create(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Create new Field Mappings that will be available after the next scheduled sync. This will cause the next sync for this Linked Account to sync **ALL** data from start.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.accounting.field_mapping.field_mappings_create(
+ target_field_name="example_target_field_name",
+ target_field_description="this is a example description of the target field",
+ remote_field_traversal_path=["example_remote_field"],
+ remote_method="GET",
+ remote_url_path="/example-url-path",
+ common_model_name="ExampleCommonModel",
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**target_field_name:** `str` — The name of the target field you want this remote field to map to.
+
+
+
+
+
+-
+
+**target_field_description:** `str` — The description of the target field you want this remote field to map to.
+
+
+
+
+
+-
+
+**remote_field_traversal_path:** `typing.Sequence[typing.Any]` — The field traversal path of the remote field listed when you hit the GET /remote-fields endpoint.
+
+
+
+
+
+-
+
+**remote_method:** `str` — The method of the remote endpoint where the remote field is coming from.
+
+
+
+
+
+-
+
+**remote_url_path:** `str` — The path of the remote endpoint where the remote field is coming from.
+
+
+
+
+
+-
+
+**common_model_name:** `str` — The name of the Common Model that the remote field corresponds to in a given category.
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.accounting.field_mapping.field_mappings_destroy(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Deletes Field Mappings for a Linked Account. All data related to this Field Mapping will be deleted and these changes will be reflected after the next scheduled sync. This will cause the next sync for this Linked Account to sync **ALL** data from start.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.accounting.field_mapping.field_mappings_destroy(
+ field_mapping_id="field_mapping_id",
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**field_mapping_id:** `str`
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.accounting.field_mapping.field_mappings_partial_update(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Create or update existing Field Mappings for a Linked Account. Changes will be reflected after the next scheduled sync. This will cause the next sync for this Linked Account to sync **ALL** data from start.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.accounting.field_mapping.field_mappings_partial_update(
+ field_mapping_id="field_mapping_id",
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**field_mapping_id:** `str`
+
+
+
+
+
+-
+
+**remote_field_traversal_path:** `typing.Optional[typing.Sequence[typing.Any]]` — The field traversal path of the remote field listed when you hit the GET /remote-fields endpoint.
+
+
+
+
+
+-
+
+**remote_method:** `typing.Optional[str]` — The method of the remote endpoint where the remote field is coming from.
+
+
+
+
+
+-
+
+**remote_url_path:** `typing.Optional[str]` — The path of the remote endpoint where the remote field is coming from.
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.accounting.field_mapping.remote_fields_retrieve(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Get all remote fields for a Linked Account. Remote fields are third-party fields that are accessible after initial sync if remote_data is enabled. You can use remote fields to override existing Merge fields or map a new Merge field. [Learn more](https://docs.merge.dev/supplemental-data/field-mappings/overview/).
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.accounting.field_mapping.remote_fields_retrieve()
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**common_models:** `typing.Optional[str]` — A comma seperated list of Common Model names. If included, will only return Remote Fields for those Common Models.
+
+
+
+
+
+-
+
+**include_example_values:** `typing.Optional[str]` — If true, will include example values, where available, for remote fields in the 3rd party platform. These examples come from active data from your customers.
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.accounting.field_mapping.target_fields_retrieve()
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Get all organization-wide Target Fields, this will not include any Linked Account specific Target Fields. Organization-wide Target Fields are additional fields appended to the Merge Common Model for all Linked Accounts in a category. [Learn more](https://docs.merge.dev/supplemental-data/field-mappings/target-fields/).
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.accounting.field_mapping.target_fields_retrieve()
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.accounting.generate_key.create(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Create a remote key.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.accounting.generate_key.create(
+ name="Remote Deployment Key 1",
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**name:** `str` — The name of the remote key
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.accounting.income_statements.list(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a list of `IncomeStatement` objects.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.accounting.income_statements.list()
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**company_id:** `typing.Optional[str]` — If provided, will only return income statements for this company.
+
+
+
+
+
+-
+
+**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
+
+
+
+
+
+-
+
+**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
+
+
+
+
+
+-
+
+**cursor:** `typing.Optional[str]` — The pagination cursor value.
+
+
+
+
+
+-
+
+**expand:** `typing.Optional[typing.Literal["company"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+
+
+
+
+
+-
+
+**include_deleted_data:** `typing.Optional[bool]` — Whether to include data that was marked as deleted by third party webhooks.
+
+
+
+
+
+-
+
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
+
+
+
+
+
+-
+
+**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
+
+
+
+
+
+-
+
+**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
+
+
+
+
+
+-
+
+**page_size:** `typing.Optional[int]` — Number of results to return per page.
+
+
+
+
+
+-
+
+**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.accounting.income_statements.retrieve(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns an `IncomeStatement` object with the given `id`.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.accounting.income_statements.retrieve(
+ id="id",
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**id:** `str`
+
+
+
+
+
+-
+
+**expand:** `typing.Optional[typing.Literal["company"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+
+
+
+
+
+-
+
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.accounting.invoices.list(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a list of `Invoice` objects.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.accounting.invoices.list()
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**company_id:** `typing.Optional[str]` — If provided, will only return invoices for this company.
+
+
+
+
+
+-
+
+**contact_id:** `typing.Optional[str]` — If provided, will only return invoices for this contact.
+
+
+
+
+
+-
+
+**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
+
+
+
+
+
+-
+
+**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
+
+
+
+
+
+-
+
+**cursor:** `typing.Optional[str]` — The pagination cursor value.
+
+
+
+
+
+-
+
+**expand:** `typing.Optional[InvoicesListRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+
+
+
+
+
+-
+
+**include_deleted_data:** `typing.Optional[bool]` — Whether to include data that was marked as deleted by third party webhooks.
+
+
+
+
+
+-
+
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
+
+
+
+
+
+-
+
+**issue_date_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
+
+
+
+
+
+-
+
+**issue_date_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
+
+
+
+
+
+-
+
+**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
+
+
+
+
+
+-
+
+**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
+
+
+
+
+
+-
+
+**page_size:** `typing.Optional[int]` — Number of results to return per page.
+
+
+
+
+
+-
+
+**remote_fields:** `typing.Optional[typing.Literal["type"]]` — Deprecated. Use show_enum_origins.
+
+
+
+
+
+-
+
+**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
+
+
+
+
+
+-
+
+**show_enum_origins:** `typing.Optional[typing.Literal["type"]]` — A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter)
+
+
+
+
+
+-
+
+**type:** `typing.Optional[InvoicesListRequestType]`
+
+If provided, will only return Invoices with this type
+
+- `ACCOUNTS_RECEIVABLE` - ACCOUNTS_RECEIVABLE
+- `ACCOUNTS_PAYABLE` - ACCOUNTS_PAYABLE
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.accounting.invoices.create(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Creates an `Invoice` object with the given values.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+from merge.resources.accounting import InvoiceRequest
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.accounting.invoices.create(
+ model=InvoiceRequest(),
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**model:** `InvoiceRequest`
+
+
+
+
+
+-
+
+**is_debug_mode:** `typing.Optional[bool]` — Whether to include debug fields (such as log file links) in the response.
+
+
+
+
+
+-
+
+**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously.
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.accounting.invoices.retrieve(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns an `Invoice` object with the given `id`.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.accounting.invoices.retrieve(
+ id="id",
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**id:** `str`
+
+
+
+
+
+-
+
+**expand:** `typing.Optional[InvoicesRetrieveRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+
+
+
+
+
+-
+
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
+
+
+
+
+
+-
+
+**remote_fields:** `typing.Optional[typing.Literal["type"]]` — Deprecated. Use show_enum_origins.
+
+
+
+
+
+-
+
+**show_enum_origins:** `typing.Optional[typing.Literal["type"]]` — A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter)
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.accounting.invoices.partial_update(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Updates an `Invoice` object with the given `id`.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+from merge.resources.accounting import InvoiceRequest
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.accounting.invoices.partial_update(
+ id="id",
+ model=InvoiceRequest(),
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**id:** `str`
+
+
+
+
+
+-
+
+**model:** `InvoiceRequest`
+
+
+
+
+
+-
+
+**is_debug_mode:** `typing.Optional[bool]` — Whether to include debug fields (such as log file links) in the response.
+
+
+
+
+
+-
+
+**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously.
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.accounting.invoices.meta_patch_retrieve(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns metadata for `Invoice` PATCHs.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.accounting.invoices.meta_patch_retrieve(
+ id="id",
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**id:** `str`
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.accounting.invoices.meta_post_retrieve()
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns metadata for `Invoice` POSTs.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.accounting.invoices.meta_post_retrieve()
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.accounting.issues.list(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Gets issues.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.accounting.issues.list()
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**account_token:** `typing.Optional[str]`
+
+
+
+
+
+-
+
+**cursor:** `typing.Optional[str]` — The pagination cursor value.
+
+
+
+
+
+-
+
+**end_date:** `typing.Optional[str]` — If included, will only include issues whose most recent action occurred before this time
+
+
+
+
+
+-
+
+**end_user_organization_name:** `typing.Optional[str]`
+
+
+
+
+
+-
+
+**first_incident_time_after:** `typing.Optional[dt.datetime]` — If provided, will only return issues whose first incident time was after this datetime.
+
+
+
+
+
+-
+
+**first_incident_time_before:** `typing.Optional[dt.datetime]` — If provided, will only return issues whose first incident time was before this datetime.
+
+
+
+
+
+-
+
+**include_muted:** `typing.Optional[str]` — If true, will include muted issues
+
+
+
+
+
+-
+
+**integration_name:** `typing.Optional[str]`
+
+
+
+
+
+-
+
+**last_incident_time_after:** `typing.Optional[dt.datetime]` — If provided, will only return issues whose last incident time was after this datetime.
+
+
+
+
+
+-
+
+**last_incident_time_before:** `typing.Optional[dt.datetime]` — If provided, will only return issues whose last incident time was before this datetime.
+
+
+
+
+
+-
+
+**page_size:** `typing.Optional[int]` — Number of results to return per page.
+
+
+
+
+
+-
+
+**start_date:** `typing.Optional[str]` — If included, will only include issues whose most recent action occurred after this time
+
+
+
+
+
+-
+
+**status:** `typing.Optional[IssuesListRequestStatus]`
+
+Status of the issue. Options: ('ONGOING', 'RESOLVED')
+
+- `ONGOING` - ONGOING
+- `RESOLVED` - RESOLVED
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.accounting.issues.retrieve(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Get a specific issue.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.accounting.issues.retrieve(
+ id="id",
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**id:** `str`
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.accounting.items.list(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a list of `Item` objects.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.accounting.items.list()
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**company_id:** `typing.Optional[str]` — If provided, will only return items for this company.
+
+
+
+
+
+-
+
+**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
+
+
+
+
+
+-
+
+**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
+
+
+
+
+
+-
+
+**cursor:** `typing.Optional[str]` — The pagination cursor value.
+
+
+
+
+
+-
+
+**expand:** `typing.Optional[ItemsListRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+
+
+
+
+
+-
+
+**include_deleted_data:** `typing.Optional[bool]` — Whether to include data that was marked as deleted by third party webhooks.
+
+
+
+
+
+-
+
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
+
+
+
+
+
+-
+
+**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
+
+
+
+
+
+-
+
+**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
+
+
+
+
+
+-
+
+**page_size:** `typing.Optional[int]` — Number of results to return per page.
+
+
+
+
+
+-
+
+**remote_fields:** `typing.Optional[typing.Literal["status"]]` — Deprecated. Use show_enum_origins.
+
+
+
+
+
+-
+
+**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
+
+
+
+
+
+-
+
+**show_enum_origins:** `typing.Optional[typing.Literal["status"]]` — A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter)
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.accounting.items.retrieve(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns an `Item` object with the given `id`.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.accounting.items.retrieve(
+ id="id",
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**id:** `str`
+
+
+
+
+
+-
+
+**expand:** `typing.Optional[ItemsRetrieveRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+
+
+
+
+
+-
+
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
+
+
+
+
+
+-
+
+**remote_fields:** `typing.Optional[typing.Literal["status"]]` — Deprecated. Use show_enum_origins.
+
+
+
+
+
+-
+
+**show_enum_origins:** `typing.Optional[typing.Literal["status"]]` — A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter)
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.accounting.journal_entries.list(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a list of `JournalEntry` objects.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.accounting.journal_entries.list()
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**company_id:** `typing.Optional[str]` — If provided, will only return journal entries for this company.
+
+
+
+
+
+-
+
+**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
+
+
+
+
+
+-
+
+**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
+
+
+
+
+
+-
+
+**cursor:** `typing.Optional[str]` — The pagination cursor value.
+
+
+
+
+
+-
+
+**expand:** `typing.Optional[JournalEntriesListRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+
+
+
+
+
+-
+
+**include_deleted_data:** `typing.Optional[bool]` — Whether to include data that was marked as deleted by third party webhooks.
+
+
+
+
+
+-
+
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
+
+
+
+
+
+-
+
+**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
+
+
+
+
+
+-
+
+**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
+
+
+
+
+
+-
+
+**page_size:** `typing.Optional[int]` — Number of results to return per page.
+
+
+
+
+
+-
+
+**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
+
+
+
+
+
+-
+
+**transaction_date_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
+
+
+
+
+
+-
+
+**transaction_date_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.accounting.journal_entries.create(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Creates a `JournalEntry` object with the given values.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+from merge.resources.accounting import JournalEntryRequest
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.accounting.journal_entries.create(
+ model=JournalEntryRequest(),
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**model:** `JournalEntryRequest`
+
+
+
+
+
+-
+
+**is_debug_mode:** `typing.Optional[bool]` — Whether to include debug fields (such as log file links) in the response.
+
+
+
+
+
+-
+
+**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously.
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.accounting.journal_entries.retrieve(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a `JournalEntry` object with the given `id`.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.accounting.journal_entries.retrieve(
+ id="id",
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**id:** `str`
+
+
+
+
+
+-
+
+**expand:** `typing.Optional[JournalEntriesRetrieveRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+
+
+
+
+
+-
+
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.accounting.journal_entries.meta_post_retrieve()
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns metadata for `JournalEntry` POSTs.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.accounting.journal_entries.meta_post_retrieve()
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.accounting.link_token.create(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Creates a link token to be used when linking a new end user.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+from merge.resources.accounting import CategoriesEnum
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.accounting.link_token.create(
+ end_user_email_address="example@gmail.com",
+ end_user_organization_name="Test Organization",
+ end_user_origin_id="12345",
+ categories=[CategoriesEnum.HRIS, CategoriesEnum.ATS],
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**end_user_email_address:** `str` — Your end user's email address. This is purely for identification purposes - setting this value will not cause any emails to be sent.
+
+
+
+
+
+-
+
+**end_user_organization_name:** `str` — Your end user's organization.
+
+
+
+
+
+-
+
+**end_user_origin_id:** `str` — This unique identifier typically represents the ID for your end user in your product's database. This value must be distinct from other Linked Accounts' unique identifiers.
+
+
+
+
+
+-
+
+**categories:** `typing.Sequence[CategoriesEnum]` — The integration categories to show in Merge Link.
+
+
+
+
+
+-
+
+**integration:** `typing.Optional[str]` — The slug of a specific pre-selected integration for this linking flow token. For examples of slugs, see https://docs.merge.dev/guides/merge-link/single-integration/.
+
+
+
+
+
+-
+
+**link_expiry_mins:** `typing.Optional[int]` — An integer number of minutes between [30, 720 or 10080 if for a Magic Link URL] for how long this token is valid. Defaults to 30.
+
+
+
+
+
+-
+
+**should_create_magic_link_url:** `typing.Optional[bool]` — Whether to generate a Magic Link URL. Defaults to false. For more information on Magic Link, see https://merge.dev/blog/integrations-fast-say-hello-to-magic-link.
+
+
+
+
+
+-
+
+**common_models:** `typing.Optional[typing.Sequence[CommonModelScopesBodyRequest]]` — An array of objects to specify the models and fields that will be disabled for a given Linked Account. Each object uses model_id, enabled_actions, and disabled_fields to specify the model, method, and fields that are scoped for a given Linked Account.
+
+
+
+
+
+-
+
+**category_common_model_scopes:** `typing.Optional[
+ typing.Dict[
+ str,
+ typing.Optional[
+ typing.Sequence[IndividualCommonModelScopeDeserializerRequest]
+ ],
+ ]
+]` — When creating a Link Token, you can set permissions for Common Models that will apply to the account that is going to be linked. Any model or field not specified in link token payload will default to existing settings.
+
+
+
+
+
+-
+
+**language:** `typing.Optional[str]` — The language code for the language to localize Merge Link to.
+
+
+
+
+
+-
+
+**integration_specific_config:** `typing.Optional[typing.Dict[str, typing.Any]]` — A JSON object containing integration-specific configuration options.
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.accounting.linked_accounts.list(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+List linked accounts for your organization.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.accounting.linked_accounts.list()
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**category:** `typing.Optional[LinkedAccountsListRequestCategory]`
+
+Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing`
+
+- `hris` - hris
+- `ats` - ats
+- `accounting` - accounting
+- `ticketing` - ticketing
+- `crm` - crm
+- `mktg` - mktg
+- `filestorage` - filestorage
+
+
+
+
+
+-
+
+**cursor:** `typing.Optional[str]` — The pagination cursor value.
+
+
+
+
+
+-
+
+**end_user_email_address:** `typing.Optional[str]` — If provided, will only return linked accounts associated with the given email address.
+
+
+
+
+
+-
+
+**end_user_organization_name:** `typing.Optional[str]` — If provided, will only return linked accounts associated with the given organization name.
+
+
+
+
+
+-
+
+**end_user_origin_id:** `typing.Optional[str]` — If provided, will only return linked accounts associated with the given origin ID.
+
+
+
+
+
+-
+
+**end_user_origin_ids:** `typing.Optional[str]` — Comma-separated list of EndUser origin IDs, making it possible to specify multiple EndUsers at once.
+
+
+
+
+
+-
+
+**id:** `typing.Optional[str]`
+
+
+
+
+
+-
+
+**ids:** `typing.Optional[str]` — Comma-separated list of LinkedAccount IDs, making it possible to specify multiple LinkedAccounts at once.
+
+
+
+
+
+-
+
+**include_duplicates:** `typing.Optional[bool]` — If `true`, will include complete production duplicates of the account specified by the `id` query parameter in the response. `id` must be for a complete production linked account.
+
+
+
+
+
+-
+
+**integration_name:** `typing.Optional[str]` — If provided, will only return linked accounts associated with the given integration name.
+
+
+
+
+
+-
+
+**is_test_account:** `typing.Optional[str]` — If included, will only include test linked accounts. If not included, will only include non-test linked accounts.
+
+
+
+
+
+-
+
+**page_size:** `typing.Optional[int]` — Number of results to return per page.
+
+
+
+
+
+-
+
+**status:** `typing.Optional[str]` — Filter by status. Options: `COMPLETE`, `INCOMPLETE`, `RELINK_NEEDED`
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.accounting.passthrough.create(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Pull data from an endpoint not currently supported by Merge.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+from merge.resources.accounting import DataPassthroughRequest, MethodEnum
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.accounting.passthrough.create(
+ request=DataPassthroughRequest(
+ method=MethodEnum.GET,
+ path="/scooters",
+ ),
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request:** `DataPassthroughRequest`
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.accounting.payments.list(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a list of `Payment` objects.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.accounting.payments.list()
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**account_id:** `typing.Optional[str]` — If provided, will only return payments for this account.
+
+
+
+
+
+-
+
+**company_id:** `typing.Optional[str]` — If provided, will only return payments for this company.
+
+
+
+
+
+-
+
+**contact_id:** `typing.Optional[str]` — If provided, will only return payments for this contact.
+
+
+
+
+
+-
+
+**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
+
+
+
+
+
+-
+
+**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
+
+
+
+
+
+-
+
+**cursor:** `typing.Optional[str]` — The pagination cursor value.
+
+
+
+
+
+-
+
+**expand:** `typing.Optional[PaymentsListRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+
+
+
+
+
+-
+
+**include_deleted_data:** `typing.Optional[bool]` — Whether to include data that was marked as deleted by third party webhooks.
+
+
+
+
+
+-
+
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
+
+
+
+
+
+-
+
+**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
+
+
+
+
+
+-
+
+**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
+
+
+
+
+
+-
+
+**page_size:** `typing.Optional[int]` — Number of results to return per page.
+
+
+
+
+
+-
+
+**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
+
+
+
+
+
+-
+
+**transaction_date_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
+
+
+
+
+
+-
+
+**transaction_date_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.accounting.payments.create(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Creates a `Payment` object with the given values.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+from merge.resources.accounting import PaymentRequest
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.accounting.payments.create(
+ model=PaymentRequest(),
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**model:** `PaymentRequest`
+
+
+
+
+
+-
+
+**is_debug_mode:** `typing.Optional[bool]` — Whether to include debug fields (such as log file links) in the response.
+
+
+
+
+
+-
+
+**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously.
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.accounting.payments.retrieve(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a `Payment` object with the given `id`.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.accounting.payments.retrieve(
+ id="id",
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**id:** `str`
+
+
+
+
+
+-
+
+**expand:** `typing.Optional[PaymentsRetrieveRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+
+
+
+
+
+-
+
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.accounting.payments.partial_update(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Updates a `Payment` object with the given `id`.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+from merge.resources.accounting import PatchedPaymentRequest
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.accounting.payments.partial_update(
+ id="id",
+ model=PatchedPaymentRequest(),
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**id:** `str`
+
+
+
+
+
+-
+
+**model:** `PatchedPaymentRequest`
+
+
+
+
+
+-
+
+**is_debug_mode:** `typing.Optional[bool]` — Whether to include debug fields (such as log file links) in the response.
+
+
+
+
+
+-
+
+**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously.
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.accounting.payments.meta_patch_retrieve(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns metadata for `Payment` PATCHs.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.accounting.payments.meta_patch_retrieve(
+ id="id",
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**id:** `str`
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.accounting.payments.meta_post_retrieve()
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns metadata for `Payment` POSTs.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.accounting.payments.meta_post_retrieve()
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.accounting.phone_numbers.retrieve(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns an `AccountingPhoneNumber` object with the given `id`.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.accounting.phone_numbers.retrieve(
+ id="id",
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**id:** `str`
+
+
+
+
+
+-
+
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.accounting.purchase_orders.list(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a list of `PurchaseOrder` objects.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.accounting.purchase_orders.list()
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**company_id:** `typing.Optional[str]` — If provided, will only return purchase orders for this company.
+
+
+
+
+
+-
+
+**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
+
+
+
+
+
+-
+
+**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
+
+
+
+
+
+-
+
+**cursor:** `typing.Optional[str]` — The pagination cursor value.
+
+
+
+
+
+-
+
+**expand:** `typing.Optional[PurchaseOrdersListRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+
+
+
+
+
+-
+
+**include_deleted_data:** `typing.Optional[bool]` — Whether to include data that was marked as deleted by third party webhooks.
+
+
+
+
+
+-
+
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
+
+
+
+
+
+-
+
+**issue_date_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
+
+
+
+
+
+-
+
+**issue_date_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
+
+
+
+
+
+-
+
+**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
+
+
+
+
+
+-
+
+**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
+
+
+
+
+
+-
+
+**page_size:** `typing.Optional[int]` — Number of results to return per page.
+
+
+
+
+
+-
+
+**remote_fields:** `typing.Optional[typing.Literal["status"]]` — Deprecated. Use show_enum_origins.
+
+
+
+
+
+-
+
+**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
+
+
+
+
+
+-
+
+**show_enum_origins:** `typing.Optional[typing.Literal["status"]]` — A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter)
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.accounting.purchase_orders.create(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Creates a `PurchaseOrder` object with the given values.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+from merge.resources.accounting import PurchaseOrderRequest
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.accounting.purchase_orders.create(
+ model=PurchaseOrderRequest(),
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**model:** `PurchaseOrderRequest`
+
+
+
+
+
+-
+
+**is_debug_mode:** `typing.Optional[bool]` — Whether to include debug fields (such as log file links) in the response.
+
+
+
+
+
+-
+
+**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously.
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.accounting.purchase_orders.retrieve(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a `PurchaseOrder` object with the given `id`.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.accounting.purchase_orders.retrieve(
+ id="id",
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**id:** `str`
+
+
+
+
+
+-
+
+**expand:** `typing.Optional[PurchaseOrdersRetrieveRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+
+
+
+
+
+-
+
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
+
+
+
+
+
+-
+
+**remote_fields:** `typing.Optional[typing.Literal["status"]]` — Deprecated. Use show_enum_origins.
+
+
+
+
+
+-
+
+**show_enum_origins:** `typing.Optional[typing.Literal["status"]]` — A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter)
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.accounting.purchase_orders.meta_post_retrieve()
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns metadata for `PurchaseOrder` POSTs.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.accounting.purchase_orders.meta_post_retrieve()
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.accounting.regenerate_key.create(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Exchange remote keys.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.accounting.regenerate_key.create(
+ name="Remote Deployment Key 1",
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**name:** `str` — The name of the remote key
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.accounting.sync_status.list(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Get syncing status. Possible values: `DISABLED`, `DONE`, `FAILED`, `PARTIALLY_SYNCED`, `PAUSED`, `SYNCING`. Learn more about sync status in our [Help Center](https://help.merge.dev/en/articles/8184193-merge-sync-statuses).
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.accounting.sync_status.list()
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**cursor:** `typing.Optional[str]` — The pagination cursor value.
+
+
+
+
+
+-
+
+**page_size:** `typing.Optional[int]` — Number of results to return per page.
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.accounting.force_resync.sync_status_resync_create()
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Force re-sync of all models. This is available for all organizations via the dashboard. Force re-sync is also available programmatically via API for monthly, quarterly, and highest sync frequency customers on the Launch, Professional, or Enterprise plans. Doing so will consume a sync credit for the relevant linked account.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.accounting.force_resync.sync_status_resync_create()
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.accounting.tax_rates.list(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a list of `TaxRate` objects.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.accounting.tax_rates.list()
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**company_id:** `typing.Optional[str]` — If provided, will only return tax rates for this company.
+
+
+
+
+
+-
+
+**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
+
+
+
+
+
+-
+
+**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
+
+
+
+
+
+-
+
+**cursor:** `typing.Optional[str]` — The pagination cursor value.
+
+
+
+
+
+-
+
+**expand:** `typing.Optional[typing.Literal["company"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+
+
+
+
+
+-
+
+**include_deleted_data:** `typing.Optional[bool]` — Whether to include data that was marked as deleted by third party webhooks.
+
+
+
+
+
+-
+
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
+
+
+
+
+
+-
+
+**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
+
+
+
+
+
+-
+
+**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
+
+
+
+
+
+-
+
+**page_size:** `typing.Optional[int]` — Number of results to return per page.
+
+
+
+
+
+-
+
+**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.accounting.tax_rates.retrieve(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a `TaxRate` object with the given `id`.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.accounting.tax_rates.retrieve(
+ id="id",
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**id:** `str`
+
+
+
+
+
+-
+
+**expand:** `typing.Optional[typing.Literal["company"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+
+
+
+
+
+-
+
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.accounting.tracking_categories.list(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a list of `TrackingCategory` objects.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.accounting.tracking_categories.list()
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**company_id:** `typing.Optional[str]` — If provided, will only return tracking categories for this company.
+
+
+
+
+
+-
+
+**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
+
+
+
+
+
+-
+
+**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
+
+
+
+
+
+-
+
+**cursor:** `typing.Optional[str]` — The pagination cursor value.
+
+
+
+
+
+-
+
+**expand:** `typing.Optional[typing.Literal["company"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+
+
+
+
+
+-
+
+**include_deleted_data:** `typing.Optional[bool]` — Whether to include data that was marked as deleted by third party webhooks.
+
+
+
+
+
+-
+
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
+
+
+
+
+
+-
+
+**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
+
+
+
+
+
+-
+
+**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
+
+
+
+
+
+-
+
+**page_size:** `typing.Optional[int]` — Number of results to return per page.
+
+
+
+
+
+-
+
+**remote_fields:** `typing.Optional[typing.Literal["status"]]` — Deprecated. Use show_enum_origins.
+
+
+
+
+
+-
+
+**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
+
+
+
+
+
+-
+
+**show_enum_origins:** `typing.Optional[typing.Literal["status"]]` — A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter)
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.accounting.tracking_categories.retrieve(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a `TrackingCategory` object with the given `id`.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.accounting.tracking_categories.retrieve(
+ id="id",
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**id:** `str`
+
+
+
+
+
+-
+
+**expand:** `typing.Optional[typing.Literal["company"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+
+
+
+
+
+-
+
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
+
+
+
+
+
+-
+
+**remote_fields:** `typing.Optional[typing.Literal["status"]]` — Deprecated. Use show_enum_origins.
+
+
+
+
+
+-
+
+**show_enum_origins:** `typing.Optional[typing.Literal["status"]]` — A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter)
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.accounting.transactions.list(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a list of `Transaction` objects.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.accounting.transactions.list()
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**company_id:** `typing.Optional[str]` — If provided, will only return accounting transactions for this company.
+
+
+
+
+
+-
+
+**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
+
+
+
+
+
+-
+
+**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
+
+
+
+
+
+-
+
+**cursor:** `typing.Optional[str]` — The pagination cursor value.
+
+
+
+
+
+-
+
+**expand:** `typing.Optional[TransactionsListRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+
+
+
+
+
+-
+
+**include_deleted_data:** `typing.Optional[bool]` — Whether to include data that was marked as deleted by third party webhooks.
+
+
+
+
+
+-
+
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
+
+
+
+
+
+-
+
+**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
+
+
+
+
+
+-
+
+**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
+
+
+
+
+
+-
+
+**page_size:** `typing.Optional[int]` — Number of results to return per page.
+
+
+
+
+
+-
+
+**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
+
+
+
+
+
+-
+
+**transaction_date_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
+
+
+
+
+
+-
+
+**transaction_date_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.accounting.transactions.retrieve(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a `Transaction` object with the given `id`.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.accounting.transactions.retrieve(
+ id="id",
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**id:** `str`
+
+
+
+
+
+-
+
+**expand:** `typing.Optional[TransactionsRetrieveRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+
+
+
+
+
+-
+
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.accounting.vendor_credits.list(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a list of `VendorCredit` objects.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.accounting.vendor_credits.list()
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**company_id:** `typing.Optional[str]` — If provided, will only return vendor credits for this company.
+
+
+
+
+
+-
+
+**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
+
+
+
+
+
+-
+
+**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
+
+
+
+
+
+-
+
+**cursor:** `typing.Optional[str]` — The pagination cursor value.
+
+
+
+
+
+-
+
+**expand:** `typing.Optional[VendorCreditsListRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+
+
+
+
+
+-
+
+**include_deleted_data:** `typing.Optional[bool]` — Whether to include data that was marked as deleted by third party webhooks.
+
+
+
+
+
+-
+
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
+
+
+
+
+
+-
+
+**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
+
+
+
+
+
+-
+
+**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
+
+
+
+
+
+-
+
+**page_size:** `typing.Optional[int]` — Number of results to return per page.
+
+
+
+
+
+-
+
+**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
+
+
+
+
+
+-
+
+**transaction_date_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
+
+
+
+
+
+-
+
+**transaction_date_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.accounting.vendor_credits.retrieve(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a `VendorCredit` object with the given `id`.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.accounting.vendor_credits.retrieve(
+ id="id",
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**id:** `str`
+
+
+
+
+
+-
+
+**expand:** `typing.Optional[VendorCreditsRetrieveRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+
+
+
+
+
+-
+
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.accounting.webhook_receivers.list()
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a list of `WebhookReceiver` objects.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.accounting.webhook_receivers.list()
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.accounting.webhook_receivers.create(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Creates a `WebhookReceiver` object with the given values.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge.client import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.accounting.webhook_receivers.create(
+ event="event",
+ is_active=True,
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**event:** `str`
+
+
+
+
+
+-
+
+**is_active:** `bool`
+
+
+
+
+
+-
+
+**key:** `typing.Optional[str]`
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+