mergepythonclient 0.0.1__py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- merge/__init__.py +77 -0
- merge/_base_client.py +1431 -0
- merge/_base_exceptions.py +117 -0
- merge/_client.py +344 -0
- merge/_exceptions.py +31 -0
- merge/_models.py +235 -0
- merge/_qs.py +148 -0
- merge/_resource.py +34 -0
- merge/_types.py +145 -0
- merge/_utils/__init__.py +25 -0
- merge/_utils/_transform.py +205 -0
- merge/_utils/_utils.py +325 -0
- merge/_version.py +4 -0
- merge/pagination.py +43 -0
- merge/py.typed +0 -0
- merge/resources/__init__.py +26 -0
- merge/resources/accounting/__init__.py +104 -0
- merge/resources/accounting/account_details.py +52 -0
- merge/resources/accounting/account_tokens.py +54 -0
- merge/resources/accounting/accounting.py +184 -0
- merge/resources/accounting/accounts/__init__.py +6 -0
- merge/resources/accounting/accounts/accounts.py +428 -0
- merge/resources/accounting/accounts/meta.py +52 -0
- merge/resources/accounting/addresses.py +122 -0
- merge/resources/accounting/attachments/__init__.py +6 -0
- merge/resources/accounting/attachments/attachments.py +371 -0
- merge/resources/accounting/attachments/meta.py +52 -0
- merge/resources/accounting/available_actions.py +52 -0
- merge/resources/accounting/balance_sheets.py +294 -0
- merge/resources/accounting/cash_flow_statements.py +294 -0
- merge/resources/accounting/common_model_scopes.py +185 -0
- merge/resources/accounting/company_info.py +286 -0
- merge/resources/accounting/contacts/__init__.py +6 -0
- merge/resources/accounting/contacts/contacts.py +428 -0
- merge/resources/accounting/contacts/meta.py +52 -0
- merge/resources/accounting/credit_notes.py +342 -0
- merge/resources/accounting/expenses/__init__.py +6 -0
- merge/resources/accounting/expenses/expenses.py +416 -0
- merge/resources/accounting/expenses/meta.py +52 -0
- merge/resources/accounting/income_statements.py +294 -0
- merge/resources/accounting/invoices/__init__.py +6 -0
- merge/resources/accounting/invoices/invoices.py +472 -0
- merge/resources/accounting/invoices/meta.py +52 -0
- merge/resources/accounting/issues.py +251 -0
- merge/resources/accounting/items.py +322 -0
- merge/resources/accounting/journal_entries/__init__.py +6 -0
- merge/resources/accounting/journal_entries/journal_entries.py +416 -0
- merge/resources/accounting/journal_entries/meta.py +52 -0
- merge/resources/accounting/link_tokens.py +173 -0
- merge/resources/accounting/linked_accounts.py +286 -0
- merge/resources/accounting/passthrough_requests.py +167 -0
- merge/resources/accounting/payments/__init__.py +6 -0
- merge/resources/accounting/payments/meta.py +52 -0
- merge/resources/accounting/payments/payments.py +430 -0
- merge/resources/accounting/phone_numbers.py +97 -0
- merge/resources/accounting/purchase_orders/__init__.py +6 -0
- merge/resources/accounting/purchase_orders/meta.py +52 -0
- merge/resources/accounting/purchase_orders/purchase_orders.py +452 -0
- merge/resources/accounting/remote_keys.py +144 -0
- merge/resources/accounting/selective_sync.py +234 -0
- merge/resources/accounting/sync_status.py +167 -0
- merge/resources/accounting/tax_rates.py +290 -0
- merge/resources/accounting/tracking_categories.py +326 -0
- merge/resources/accounting/transactions.py +310 -0
- merge/resources/accounting/vendor_credits.py +310 -0
- merge/resources/accounting/webhook_receivers.py +139 -0
- merge/resources/ats/__init__.py +89 -0
- merge/resources/ats/account_details.py +52 -0
- merge/resources/ats/account_tokens.py +54 -0
- merge/resources/ats/activities/__init__.py +6 -0
- merge/resources/ats/activities/activities.py +446 -0
- merge/resources/ats/activities/meta.py +52 -0
- merge/resources/ats/applications/__init__.py +6 -0
- merge/resources/ats/applications/applications.py +547 -0
- merge/resources/ats/applications/meta.py +96 -0
- merge/resources/ats/ats.py +159 -0
- merge/resources/ats/attachments/__init__.py +6 -0
- merge/resources/ats/attachments/attachments.py +442 -0
- merge/resources/ats/attachments/meta.py +52 -0
- merge/resources/ats/available_actions.py +52 -0
- merge/resources/ats/candidates/__init__.py +6 -0
- merge/resources/ats/candidates/candidates.py +543 -0
- merge/resources/ats/candidates/meta.py +52 -0
- merge/resources/ats/common_model_scopes.py +185 -0
- merge/resources/ats/departments.py +255 -0
- merge/resources/ats/eeocs.py +458 -0
- merge/resources/ats/interviews/__init__.py +6 -0
- merge/resources/ats/interviews/interviews.py +464 -0
- merge/resources/ats/interviews/meta.py +52 -0
- merge/resources/ats/issues.py +251 -0
- merge/resources/ats/job_interview_stages.py +294 -0
- merge/resources/ats/jobs.py +354 -0
- merge/resources/ats/link_tokens.py +173 -0
- merge/resources/ats/linked_accounts.py +286 -0
- merge/resources/ats/offers.py +330 -0
- merge/resources/ats/offices.py +255 -0
- merge/resources/ats/passthrough_requests.py +167 -0
- merge/resources/ats/reject_reasons.py +261 -0
- merge/resources/ats/remote_keys.py +144 -0
- merge/resources/ats/scorecards.py +338 -0
- merge/resources/ats/selective_sync.py +234 -0
- merge/resources/ats/sync_status.py +167 -0
- merge/resources/ats/tags.py +174 -0
- merge/resources/ats/users.py +303 -0
- merge/resources/ats/webhook_receivers.py +136 -0
- merge/resources/crm/__init__.py +80 -0
- merge/resources/crm/account_details.py +52 -0
- merge/resources/crm/account_tokens.py +54 -0
- merge/resources/crm/accounts/__init__.py +6 -0
- merge/resources/crm/accounts/accounts.py +626 -0
- merge/resources/crm/accounts/meta.py +92 -0
- merge/resources/crm/available_actions.py +52 -0
- merge/resources/crm/common_model_scopes.py +185 -0
- merge/resources/crm/contacts/__init__.py +6 -0
- merge/resources/crm/contacts/contacts.py +727 -0
- merge/resources/crm/contacts/meta.py +92 -0
- merge/resources/crm/crm.py +144 -0
- merge/resources/crm/custom_object_classes/__init__.py +6 -0
- merge/resources/crm/custom_object_classes/association_types/__init__.py +6 -0
- merge/resources/crm/custom_object_classes/association_types/association_types.py +374 -0
- merge/resources/crm/custom_object_classes/association_types/meta.py +54 -0
- merge/resources/crm/custom_object_classes/custom_object_classes.py +302 -0
- merge/resources/crm/custom_objects/__init__.py +17 -0
- merge/resources/crm/custom_objects/associations.py +250 -0
- merge/resources/crm/custom_objects/custom_objects.py +452 -0
- merge/resources/crm/custom_objects/generators.py +54 -0
- merge/resources/crm/custom_objects/meta.py +96 -0
- merge/resources/crm/engagement_types.py +409 -0
- merge/resources/crm/engagements/__init__.py +6 -0
- merge/resources/crm/engagements/engagements.py +623 -0
- merge/resources/crm/engagements/meta.py +92 -0
- merge/resources/crm/issues.py +251 -0
- merge/resources/crm/leads/__init__.py +6 -0
- merge/resources/crm/leads/leads.py +558 -0
- merge/resources/crm/leads/meta.py +52 -0
- merge/resources/crm/link_tokens.py +173 -0
- merge/resources/crm/linked_accounts.py +286 -0
- merge/resources/crm/notes/__init__.py +6 -0
- merge/resources/crm/notes/meta.py +52 -0
- merge/resources/crm/notes/notes.py +564 -0
- merge/resources/crm/opportunities/__init__.py +6 -0
- merge/resources/crm/opportunities/meta.py +92 -0
- merge/resources/crm/opportunities/opportunities.py +697 -0
- merge/resources/crm/passthrough_requests.py +167 -0
- merge/resources/crm/remote_keys.py +144 -0
- merge/resources/crm/selective_sync.py +234 -0
- merge/resources/crm/stages.py +409 -0
- merge/resources/crm/sync_status.py +167 -0
- merge/resources/crm/tasks/__init__.py +6 -0
- merge/resources/crm/tasks/meta.py +92 -0
- merge/resources/crm/tasks/tasks.py +619 -0
- merge/resources/crm/users.py +509 -0
- merge/resources/crm/webhook_receivers.py +136 -0
- merge/resources/file_storage/__init__.py +59 -0
- merge/resources/file_storage/account_details.py +52 -0
- merge/resources/file_storage/account_tokens.py +54 -0
- merge/resources/file_storage/available_actions.py +52 -0
- merge/resources/file_storage/common_model_scopes.py +185 -0
- merge/resources/file_storage/drives.py +265 -0
- merge/resources/file_storage/file_storage.py +109 -0
- merge/resources/file_storage/files/__init__.py +6 -0
- merge/resources/file_storage/files/files.py +452 -0
- merge/resources/file_storage/files/meta.py +52 -0
- merge/resources/file_storage/folders/__init__.py +6 -0
- merge/resources/file_storage/folders/folders.py +420 -0
- merge/resources/file_storage/folders/meta.py +52 -0
- merge/resources/file_storage/groups.py +255 -0
- merge/resources/file_storage/issues.py +251 -0
- merge/resources/file_storage/link_tokens.py +173 -0
- merge/resources/file_storage/linked_accounts.py +286 -0
- merge/resources/file_storage/passthrough_requests.py +167 -0
- merge/resources/file_storage/remote_keys.py +147 -0
- merge/resources/file_storage/selective_sync.py +234 -0
- merge/resources/file_storage/sync_status.py +167 -0
- merge/resources/file_storage/users.py +255 -0
- merge/resources/file_storage/webhook_receivers.py +139 -0
- merge/resources/hris/__init__.py +83 -0
- merge/resources/hris/account_details.py +52 -0
- merge/resources/hris/account_tokens.py +54 -0
- merge/resources/hris/available_actions.py +52 -0
- merge/resources/hris/banks.py +356 -0
- merge/resources/hris/benefits.py +290 -0
- merge/resources/hris/common_model_scopes.py +185 -0
- merge/resources/hris/companies.py +255 -0
- merge/resources/hris/employee_payroll_runs.py +336 -0
- merge/resources/hris/employees/__init__.py +6 -0
- merge/resources/hris/employees/employees.py +841 -0
- merge/resources/hris/employees/meta.py +52 -0
- merge/resources/hris/employments.py +466 -0
- merge/resources/hris/groups.py +304 -0
- merge/resources/hris/hris.py +149 -0
- merge/resources/hris/issues.py +251 -0
- merge/resources/hris/link_tokens.py +173 -0
- merge/resources/hris/linked_accounts.py +286 -0
- merge/resources/hris/locations.py +294 -0
- merge/resources/hris/passthrough_requests.py +167 -0
- merge/resources/hris/pay_groups.py +255 -0
- merge/resources/hris/payroll_runs.py +356 -0
- merge/resources/hris/remote_keys.py +144 -0
- merge/resources/hris/selective_sync.py +234 -0
- merge/resources/hris/sync_status.py +167 -0
- merge/resources/hris/teams.py +291 -0
- merge/resources/hris/time_off/__init__.py +6 -0
- merge/resources/hris/time_off/meta.py +52 -0
- merge/resources/hris/time_off/time_off.py +560 -0
- merge/resources/hris/time_off_balances.py +354 -0
- merge/resources/hris/webhook_receivers.py +136 -0
- merge/resources/marketing/__init__.py +74 -0
- merge/resources/marketing/account_details.py +52 -0
- merge/resources/marketing/account_tokens.py +54 -0
- merge/resources/marketing/actions/__init__.py +6 -0
- merge/resources/marketing/actions/actions.py +363 -0
- merge/resources/marketing/actions/meta.py +52 -0
- merge/resources/marketing/automations/__init__.py +6 -0
- merge/resources/marketing/automations/automations.py +481 -0
- merge/resources/marketing/automations/meta.py +52 -0
- merge/resources/marketing/available_actions.py +52 -0
- merge/resources/marketing/campaigns/__init__.py +6 -0
- merge/resources/marketing/campaigns/campaigns.py +481 -0
- merge/resources/marketing/campaigns/meta.py +52 -0
- merge/resources/marketing/common_model_scopes.py +185 -0
- merge/resources/marketing/contact_lists/__init__.py +6 -0
- merge/resources/marketing/contact_lists/contact_lists.py +477 -0
- merge/resources/marketing/contact_lists/meta.py +52 -0
- merge/resources/marketing/contacts/__init__.py +6 -0
- merge/resources/marketing/contacts/contacts.py +361 -0
- merge/resources/marketing/contacts/meta.py +52 -0
- merge/resources/marketing/emails.py +375 -0
- merge/resources/marketing/events.py +375 -0
- merge/resources/marketing/issues.py +251 -0
- merge/resources/marketing/link_tokens.py +173 -0
- merge/resources/marketing/linked_accounts.py +286 -0
- merge/resources/marketing/marketing.py +134 -0
- merge/resources/marketing/messages.py +375 -0
- merge/resources/marketing/passthrough_requests.py +167 -0
- merge/resources/marketing/remote_keys.py +144 -0
- merge/resources/marketing/selective_sync.py +234 -0
- merge/resources/marketing/sync_status.py +167 -0
- merge/resources/marketing/templates/__init__.py +6 -0
- merge/resources/marketing/templates/meta.py +52 -0
- merge/resources/marketing/templates/templates.py +365 -0
- merge/resources/marketing/users.py +255 -0
- merge/resources/marketing/webhook_receivers.py +139 -0
- merge/resources/ticketing/__init__.py +74 -0
- merge/resources/ticketing/account_details.py +52 -0
- merge/resources/ticketing/account_tokens.py +54 -0
- merge/resources/ticketing/accounts.py +256 -0
- merge/resources/ticketing/attachments/__init__.py +6 -0
- merge/resources/ticketing/attachments/attachments.py +396 -0
- merge/resources/ticketing/attachments/meta.py +52 -0
- merge/resources/ticketing/available_actions.py +52 -0
- merge/resources/ticketing/collections.py +468 -0
- merge/resources/ticketing/comments/__init__.py +6 -0
- merge/resources/ticketing/comments/comments.py +396 -0
- merge/resources/ticketing/comments/meta.py +52 -0
- merge/resources/ticketing/common_model_scopes.py +185 -0
- merge/resources/ticketing/contacts.py +283 -0
- merge/resources/ticketing/issues.py +251 -0
- merge/resources/ticketing/link_tokens.py +173 -0
- merge/resources/ticketing/linked_accounts.py +286 -0
- merge/resources/ticketing/passthrough_requests.py +167 -0
- merge/resources/ticketing/projects.py +386 -0
- merge/resources/ticketing/remote_keys.py +144 -0
- merge/resources/ticketing/selective_sync.py +234 -0
- merge/resources/ticketing/sync_status.py +167 -0
- merge/resources/ticketing/tags.py +256 -0
- merge/resources/ticketing/teams.py +256 -0
- merge/resources/ticketing/ticketing.py +134 -0
- merge/resources/ticketing/tickets/__init__.py +6 -0
- merge/resources/ticketing/tickets/meta.py +92 -0
- merge/resources/ticketing/tickets/tickets.py +1037 -0
- merge/resources/ticketing/users.py +292 -0
- merge/resources/ticketing/webhook_receivers.py +139 -0
- merge/types/__init__.py +33 -0
- merge/types/accounting/__init__.py +155 -0
- merge/types/accounting/account_create_params.py +706 -0
- merge/types/accounting/account_list_params.py +63 -0
- merge/types/accounting/account_response.py +28 -0
- merge/types/accounting/account_retrieve_params.py +28 -0
- merge/types/accounting/accounting_attachment.py +35 -0
- merge/types/accounting/accounting_attachment_response.py +30 -0
- merge/types/accounting/accounts/__init__.py +3 -0
- merge/types/accounting/address_retrieve_params.py +21 -0
- merge/types/accounting/attachment_create_params.py +38 -0
- merge/types/accounting/attachment_list_params.py +51 -0
- merge/types/accounting/attachment_retrieve_params.py +15 -0
- merge/types/accounting/attachments/__init__.py +3 -0
- merge/types/accounting/balance_sheet.py +728 -0
- merge/types/accounting/balance_sheet_list_params.py +57 -0
- merge/types/accounting/balance_sheet_retrieve_params.py +22 -0
- merge/types/accounting/cash_flow_statement.py +730 -0
- merge/types/accounting/cash_flow_statement_list_params.py +57 -0
- merge/types/accounting/cash_flow_statement_retrieve_params.py +22 -0
- merge/types/accounting/common_model_scope_retrieve_params.py +12 -0
- merge/types/accounting/common_model_scope_update_params.py +21 -0
- merge/types/accounting/company_info.py +672 -0
- merge/types/accounting/company_info_list_params.py +54 -0
- merge/types/accounting/company_info_retrieve_params.py +22 -0
- merge/types/accounting/contact_create_params.py +384 -0
- merge/types/accounting/contact_list_params.py +63 -0
- merge/types/accounting/contact_response.py +28 -0
- merge/types/accounting/contact_retrieve_params.py +28 -0
- merge/types/accounting/contacts/__init__.py +3 -0
- merge/types/accounting/credit_note.py +727 -0
- merge/types/accounting/credit_note_list_params.py +69 -0
- merge/types/accounting/credit_note_retrieve_params.py +28 -0
- merge/types/accounting/expense.py +707 -0
- merge/types/accounting/expense_create_params.py +709 -0
- merge/types/accounting/expense_list_params.py +63 -0
- merge/types/accounting/expense_response.py +31 -0
- merge/types/accounting/expense_retrieve_params.py +22 -0
- merge/types/accounting/expenses/__init__.py +3 -0
- merge/types/accounting/income_statement.py +751 -0
- merge/types/accounting/income_statement_list_params.py +57 -0
- merge/types/accounting/income_statement_retrieve_params.py +22 -0
- merge/types/accounting/invoice.py +1357 -0
- merge/types/accounting/invoice_create_params.py +1351 -0
- merge/types/accounting/invoice_list_params.py +79 -0
- merge/types/accounting/invoice_response.py +30 -0
- merge/types/accounting/invoice_retrieve_params.py +28 -0
- merge/types/accounting/invoices/__init__.py +3 -0
- merge/types/accounting/issue_list_params.py +72 -0
- merge/types/accounting/item.py +54 -0
- merge/types/accounting/item_list_params.py +63 -0
- merge/types/accounting/item_retrieve_params.py +28 -0
- merge/types/accounting/journal_entries/__init__.py +3 -0
- merge/types/accounting/journal_entry.py +701 -0
- merge/types/accounting/journal_entry_create_params.py +699 -0
- merge/types/accounting/journal_entry_list_params.py +63 -0
- merge/types/accounting/journal_entry_response.py +31 -0
- merge/types/accounting/journal_entry_retrieve_params.py +22 -0
- merge/types/accounting/link_token_create_params.py +66 -0
- merge/types/accounting/linked_account_list_params.py +89 -0
- merge/types/accounting/passthrough_request_send_params.py +76 -0
- merge/types/accounting/payment.py +669 -0
- merge/types/accounting/payment_create_params.py +669 -0
- merge/types/accounting/payment_list_params.py +69 -0
- merge/types/accounting/payment_response.py +30 -0
- merge/types/accounting/payment_retrieve_params.py +22 -0
- merge/types/accounting/payments/__init__.py +3 -0
- merge/types/accounting/phone_number.py +19 -0
- merge/types/accounting/phone_number_retrieve_params.py +15 -0
- merge/types/accounting/purchase_order.py +1351 -0
- merge/types/accounting/purchase_order_create_params.py +1346 -0
- merge/types/accounting/purchase_order_list_params.py +69 -0
- merge/types/accounting/purchase_order_response.py +31 -0
- merge/types/accounting/purchase_order_retrieve_params.py +28 -0
- merge/types/accounting/purchase_orders/__init__.py +3 -0
- merge/types/accounting/remote_key_generate_params.py +11 -0
- merge/types/accounting/remote_key_regenerate_params.py +11 -0
- merge/types/accounting/selective_sync_list_configurations_response.py +11 -0
- merge/types/accounting/selective_sync_list_metadata_params.py +17 -0
- merge/types/accounting/selective_sync_replace_configurations_params.py +29 -0
- merge/types/accounting/selective_sync_replace_configurations_response.py +11 -0
- merge/types/accounting/sync_status_list_params.py +15 -0
- merge/types/accounting/sync_status_resync_response.py +9 -0
- merge/types/accounting/tax_rate.py +38 -0
- merge/types/accounting/tax_rate_list_params.py +57 -0
- merge/types/accounting/tax_rate_retrieve_params.py +22 -0
- merge/types/accounting/tracking_category.py +48 -0
- merge/types/accounting/tracking_category_list_params.py +63 -0
- merge/types/accounting/tracking_category_retrieve_params.py +28 -0
- merge/types/accounting/transaction.py +1336 -0
- merge/types/accounting/transaction_list_params.py +63 -0
- merge/types/accounting/transaction_retrieve_params.py +22 -0
- merge/types/accounting/vendor_credit.py +697 -0
- merge/types/accounting/vendor_credit_list_params.py +63 -0
- merge/types/accounting/vendor_credit_retrieve_params.py +22 -0
- merge/types/accounting/webhook_receiver_create_params.py +15 -0
- merge/types/accounting/webhook_receiver_list_response.py +9 -0
- merge/types/ats/__init__.py +125 -0
- merge/types/ats/activities/__init__.py +3 -0
- merge/types/ats/activity.py +53 -0
- merge/types/ats/activity_create_params.py +55 -0
- merge/types/ats/activity_create_response.py +31 -0
- merge/types/ats/activity_list_params.py +63 -0
- merge/types/ats/activity_retrieve_params.py +28 -0
- merge/types/ats/application.py +49 -0
- merge/types/ats/application_change_stage_params.py +15 -0
- merge/types/ats/application_create_params.py +63 -0
- merge/types/ats/application_list_params.py +72 -0
- merge/types/ats/application_response.py +33 -0
- merge/types/ats/application_retrieve_params.py +22 -0
- merge/types/ats/applications/__init__.py +5 -0
- merge/types/ats/applications/meta_for_create_params.py +12 -0
- merge/types/ats/attachment_create_params.py +61 -0
- merge/types/ats/attachment_list_params.py +63 -0
- merge/types/ats/attachment_response.py +28 -0
- merge/types/ats/attachment_retrieve_params.py +28 -0
- merge/types/ats/attachments/__init__.py +3 -0
- merge/types/ats/candidate.py +128 -0
- merge/types/ats/candidate_create_params.py +137 -0
- merge/types/ats/candidate_ignore_row_params.py +18 -0
- merge/types/ats/candidate_list_params.py +72 -0
- merge/types/ats/candidate_response.py +32 -0
- merge/types/ats/candidate_retrieve_params.py +22 -0
- merge/types/ats/candidates/__init__.py +3 -0
- merge/types/ats/common_model_scope_retrieve_params.py +12 -0
- merge/types/ats/common_model_scope_update_params.py +21 -0
- merge/types/ats/department.py +29 -0
- merge/types/ats/department_list_params.py +48 -0
- merge/types/ats/department_retrieve_params.py +15 -0
- merge/types/ats/eeoc.py +94 -0
- merge/types/ats/eeoc_list_params.py +95 -0
- merge/types/ats/eeoc_retrieve_params.py +60 -0
- merge/types/ats/interview_create_params.py +64 -0
- merge/types/ats/interview_list_params.py +69 -0
- merge/types/ats/interview_retrieve_params.py +28 -0
- merge/types/ats/interviews/__init__.py +3 -0
- merge/types/ats/issue_list_params.py +72 -0
- merge/types/ats/job.py +91 -0
- merge/types/ats/job_interview_stage.py +35 -0
- merge/types/ats/job_interview_stage_list_params.py +57 -0
- merge/types/ats/job_interview_stage_retrieve_params.py +22 -0
- merge/types/ats/job_list_params.py +81 -0
- merge/types/ats/job_retrieve_params.py +28 -0
- merge/types/ats/link_token_create_params.py +66 -0
- merge/types/ats/linked_account_list_params.py +89 -0
- merge/types/ats/offer.py +62 -0
- merge/types/ats/offer_list_params.py +66 -0
- merge/types/ats/offer_retrieve_params.py +28 -0
- merge/types/ats/office.py +32 -0
- merge/types/ats/office_list_params.py +48 -0
- merge/types/ats/office_retrieve_params.py +15 -0
- merge/types/ats/passthrough_request_send_params.py +76 -0
- merge/types/ats/reject_reason.py +29 -0
- merge/types/ats/reject_reason_list_params.py +48 -0
- merge/types/ats/reject_reason_retrieve_params.py +15 -0
- merge/types/ats/remote_key_generate_params.py +11 -0
- merge/types/ats/remote_key_regenerate_params.py +11 -0
- merge/types/ats/scheduled_interview.py +61 -0
- merge/types/ats/scheduled_interview_response.py +32 -0
- merge/types/ats/scorecard.py +51 -0
- merge/types/ats/scorecard_list_params.py +69 -0
- merge/types/ats/scorecard_retrieve_params.py +28 -0
- merge/types/ats/selective_sync_list_configurations_response.py +11 -0
- merge/types/ats/selective_sync_list_metadata_params.py +17 -0
- merge/types/ats/selective_sync_replace_configurations_params.py +29 -0
- merge/types/ats/selective_sync_replace_configurations_response.py +11 -0
- merge/types/ats/sync_status_list_params.py +15 -0
- merge/types/ats/sync_status_resync_response.py +9 -0
- merge/types/ats/tag_list_params.py +48 -0
- merge/types/ats/user_list_params.py +57 -0
- merge/types/ats/user_retrieve_params.py +21 -0
- merge/types/ats/webhook_receiver_create_params.py +15 -0
- merge/types/ats/webhook_receiver_list_response.py +9 -0
- merge/types/crm/__init__.py +156 -0
- merge/types/crm/account_create_params.py +706 -0
- merge/types/crm/account_list_params.py +63 -0
- merge/types/crm/account_list_remote_field_classes_params.py +30 -0
- merge/types/crm/account_response.py +28 -0
- merge/types/crm/account_retrieve_params.py +28 -0
- merge/types/crm/account_update_params.py +55 -0
- merge/types/crm/accounts/__init__.py +3 -0
- merge/types/crm/common_model_scope_retrieve_params.py +12 -0
- merge/types/crm/common_model_scope_update_params.py +21 -0
- merge/types/crm/contact_create_params.py +384 -0
- merge/types/crm/contact_ignore_row_params.py +18 -0
- merge/types/crm/contact_list_params.py +63 -0
- merge/types/crm/contact_list_remote_field_classes_params.py +30 -0
- merge/types/crm/contact_response.py +28 -0
- merge/types/crm/contact_retrieve_params.py +28 -0
- merge/types/crm/contact_update_params.py +371 -0
- merge/types/crm/contacts/__init__.py +3 -0
- merge/types/crm/custom_object.py +31 -0
- merge/types/crm/custom_object_class.py +73 -0
- merge/types/crm/custom_object_class_list_params.py +54 -0
- merge/types/crm/custom_object_class_retrieve_params.py +22 -0
- merge/types/crm/custom_object_classes/__init__.py +17 -0
- merge/types/crm/custom_object_classes/association_type.py +46 -0
- merge/types/crm/custom_object_classes/association_type_create_params.py +54 -0
- merge/types/crm/custom_object_classes/association_type_list_params.py +54 -0
- merge/types/crm/custom_object_classes/association_type_response.py +29 -0
- merge/types/crm/custom_object_classes/association_type_retrieve_params.py +22 -0
- merge/types/crm/custom_object_classes/association_types/__init__.py +3 -0
- merge/types/crm/custom_object_create_params.py +15 -0
- merge/types/crm/custom_object_list_params.py +54 -0
- merge/types/crm/custom_object_response.py +29 -0
- merge/types/crm/custom_object_retrieve_params.py +21 -0
- merge/types/crm/custom_object_update_params.py +15 -0
- merge/types/crm/custom_objects/__init__.py +6 -0
- merge/types/crm/custom_objects/association.py +19 -0
- merge/types/crm/custom_objects/association_list_params.py +57 -0
- merge/types/crm/engagement.py +64 -0
- merge/types/crm/engagement_create_params.py +61 -0
- merge/types/crm/engagement_list_params.py +60 -0
- merge/types/crm/engagement_list_remote_field_classes_params.py +30 -0
- merge/types/crm/engagement_response.py +30 -0
- merge/types/crm/engagement_retrieve_params.py +28 -0
- merge/types/crm/engagement_type.py +38 -0
- merge/types/crm/engagement_type_list_params.py +54 -0
- merge/types/crm/engagement_type_list_remote_field_classes_params.py +30 -0
- merge/types/crm/engagement_type_retrieve_params.py +21 -0
- merge/types/crm/engagement_update_params.py +61 -0
- merge/types/crm/engagements/__init__.py +3 -0
- merge/types/crm/issue_list_params.py +72 -0
- merge/types/crm/lead.py +111 -0
- merge/types/crm/lead_create_params.py +386 -0
- merge/types/crm/lead_list_params.py +69 -0
- merge/types/crm/lead_list_remote_field_classes_params.py +30 -0
- merge/types/crm/lead_response.py +30 -0
- merge/types/crm/lead_retrieve_params.py +28 -0
- merge/types/crm/leads/__init__.py +3 -0
- merge/types/crm/link_token_create_params.py +66 -0
- merge/types/crm/linked_account_list_params.py +89 -0
- merge/types/crm/note.py +54 -0
- merge/types/crm/note_create_params.py +43 -0
- merge/types/crm/note_list_params.py +72 -0
- merge/types/crm/note_list_remote_field_classes_params.py +30 -0
- merge/types/crm/note_response.py +29 -0
- merge/types/crm/note_retrieve_params.py +28 -0
- merge/types/crm/notes/__init__.py +3 -0
- merge/types/crm/opportunities/__init__.py +3 -0
- merge/types/crm/opportunity.py +68 -0
- merge/types/crm/opportunity_create_params.py +63 -0
- merge/types/crm/opportunity_list_params.py +85 -0
- merge/types/crm/opportunity_list_remote_field_classes_params.py +30 -0
- merge/types/crm/opportunity_response.py +30 -0
- merge/types/crm/opportunity_retrieve_params.py +34 -0
- merge/types/crm/opportunity_update_params.py +63 -0
- merge/types/crm/passthrough_request_send_params.py +76 -0
- merge/types/crm/remote_key_generate_params.py +11 -0
- merge/types/crm/remote_key_regenerate_params.py +11 -0
- merge/types/crm/selective_sync_list_configurations_response.py +11 -0
- merge/types/crm/selective_sync_list_metadata_params.py +17 -0
- merge/types/crm/selective_sync_replace_configurations_params.py +29 -0
- merge/types/crm/selective_sync_replace_configurations_response.py +11 -0
- merge/types/crm/stage.py +37 -0
- merge/types/crm/stage_list_params.py +54 -0
- merge/types/crm/stage_list_remote_field_classes_params.py +30 -0
- merge/types/crm/stage_retrieve_params.py +21 -0
- merge/types/crm/sync_status_list_params.py +15 -0
- merge/types/crm/sync_status_resync_response.py +9 -0
- merge/types/crm/task.py +59 -0
- merge/types/crm/task_create_params.py +55 -0
- merge/types/crm/task_create_response.py +29 -0
- merge/types/crm/task_list_params.py +60 -0
- merge/types/crm/task_list_remote_field_classes_params.py +30 -0
- merge/types/crm/task_retrieve_params.py +28 -0
- merge/types/crm/task_update_params.py +55 -0
- merge/types/crm/tasks/__init__.py +3 -0
- merge/types/crm/user.py +43 -0
- merge/types/crm/user_ignore_row_params.py +18 -0
- merge/types/crm/user_list_params.py +54 -0
- merge/types/crm/user_list_remote_field_classes_params.py +30 -0
- merge/types/crm/user_retrieve_params.py +21 -0
- merge/types/crm/webhook_receiver_create_params.py +15 -0
- merge/types/crm/webhook_receiver_list_response.py +9 -0
- merge/types/file_storage/__init__.py +65 -0
- merge/types/file_storage/common_model_scope_retrieve_params.py +12 -0
- merge/types/file_storage/common_model_scope_update_params.py +21 -0
- merge/types/file_storage/drive.py +31 -0
- merge/types/file_storage/drive_list_params.py +54 -0
- merge/types/file_storage/drive_retrieve_params.py +15 -0
- merge/types/file_storage/file.py +59 -0
- merge/types/file_storage/file_create_params.py +60 -0
- merge/types/file_storage/file_list_params.py +66 -0
- merge/types/file_storage/file_response.py +30 -0
- merge/types/file_storage/file_retrieve_params.py +22 -0
- merge/types/file_storage/files/__init__.py +3 -0
- merge/types/file_storage/folder.py +53 -0
- merge/types/file_storage/folder_create_params.py +55 -0
- merge/types/file_storage/folder_list_params.py +69 -0
- merge/types/file_storage/folder_response.py +31 -0
- merge/types/file_storage/folder_retrieve_params.py +22 -0
- merge/types/file_storage/folders/__init__.py +3 -0
- merge/types/file_storage/group.py +32 -0
- merge/types/file_storage/group_list_params.py +48 -0
- merge/types/file_storage/group_retrieve_params.py +15 -0
- merge/types/file_storage/issue_list_params.py +72 -0
- merge/types/file_storage/link_token_create_params.py +66 -0
- merge/types/file_storage/linked_account_list_params.py +89 -0
- merge/types/file_storage/passthrough_request_send_params.py +76 -0
- merge/types/file_storage/remote_key_generate_params.py +11 -0
- merge/types/file_storage/remote_key_regenerate_params.py +11 -0
- merge/types/file_storage/selective_sync_list_configurations_response.py +11 -0
- merge/types/file_storage/selective_sync_list_metadata_params.py +17 -0
- merge/types/file_storage/selective_sync_replace_configurations_params.py +29 -0
- merge/types/file_storage/selective_sync_replace_configurations_response.py +11 -0
- merge/types/file_storage/sync_status_list_params.py +15 -0
- merge/types/file_storage/sync_status_resync_response.py +9 -0
- merge/types/file_storage/user.py +31 -0
- merge/types/file_storage/user_list_params.py +48 -0
- merge/types/file_storage/user_retrieve_params.py +15 -0
- merge/types/file_storage/webhook_receiver_create_params.py +15 -0
- merge/types/file_storage/webhook_receiver_list_response.py +9 -0
- merge/types/hris/__init__.py +103 -0
- merge/types/hris/bank_info.py +48 -0
- merge/types/hris/bank_list_params.py +78 -0
- merge/types/hris/bank_retrieve_params.py +28 -0
- merge/types/hris/benefit.py +41 -0
- merge/types/hris/benefit_list_params.py +57 -0
- merge/types/hris/benefit_retrieve_params.py +22 -0
- merge/types/hris/common_model_scope_retrieve_params.py +12 -0
- merge/types/hris/common_model_scope_update_params.py +21 -0
- merge/types/hris/company.py +35 -0
- merge/types/hris/company_list_params.py +48 -0
- merge/types/hris/company_retrieve_params.py +15 -0
- merge/types/hris/created_employee_response.py +31 -0
- merge/types/hris/employee.py +167 -0
- merge/types/hris/employee_create_params.py +164 -0
- merge/types/hris/employee_ignore_params.py +18 -0
- merge/types/hris/employee_list_params.py +162 -0
- merge/types/hris/employee_payroll_run.py +149 -0
- merge/types/hris/employee_payroll_run_list_params.py +77 -0
- merge/types/hris/employee_payroll_run_retrieve_params.py +22 -0
- merge/types/hris/employee_retrieve_params.py +68 -0
- merge/types/hris/employees/__init__.py +3 -0
- merge/types/hris/employment.py +718 -0
- merge/types/hris/employment_list_params.py +98 -0
- merge/types/hris/employment_retrieve_params.py +60 -0
- merge/types/hris/group.py +42 -0
- merge/types/hris/group_list_params.py +60 -0
- merge/types/hris/group_retrieve_params.py +21 -0
- merge/types/hris/issue_list_params.py +72 -0
- merge/types/hris/link_token_create_params.py +66 -0
- merge/types/hris/linked_account_list_params.py +89 -0
- merge/types/hris/location.py +309 -0
- merge/types/hris/location_list_params.py +54 -0
- merge/types/hris/location_retrieve_params.py +21 -0
- merge/types/hris/passthrough_request_send_params.py +76 -0
- merge/types/hris/pay_group.py +29 -0
- merge/types/hris/pay_group_list_params.py +48 -0
- merge/types/hris/pay_group_retrieve_params.py +15 -0
- merge/types/hris/payroll_run.py +54 -0
- merge/types/hris/payroll_run_list_params.py +78 -0
- merge/types/hris/payroll_run_retrieve_params.py +21 -0
- merge/types/hris/remote_key_generate_params.py +11 -0
- merge/types/hris/remote_key_regenerate_params.py +11 -0
- merge/types/hris/selective_sync_list_configurations_response.py +11 -0
- merge/types/hris/selective_sync_list_metadata_params.py +17 -0
- merge/types/hris/selective_sync_replace_configurations_params.py +29 -0
- merge/types/hris/selective_sync_replace_configurations_response.py +11 -0
- merge/types/hris/sync_status_list_params.py +15 -0
- merge/types/hris/sync_status_resync_response.py +9 -0
- merge/types/hris/team_list_params.py +57 -0
- merge/types/hris/team_retrieve_params.py +22 -0
- merge/types/hris/time_off/__init__.py +5 -0
- merge/types/hris/time_off/time_off.py +69 -0
- merge/types/hris/time_off_balance.py +46 -0
- merge/types/hris/time_off_balance_list_params.py +77 -0
- merge/types/hris/time_off_balance_retrieve_params.py +28 -0
- merge/types/hris/time_off_create_params.py +75 -0
- merge/types/hris/time_off_list_params.py +108 -0
- merge/types/hris/time_off_response.py +30 -0
- merge/types/hris/time_off_retrieve_params.py +44 -0
- merge/types/hris/webhook_receiver_create_params.py +15 -0
- merge/types/hris/webhook_receiver_list_response.py +9 -0
- merge/types/marketing/__init__.py +113 -0
- merge/types/marketing/action.py +41 -0
- merge/types/marketing/action_create_params.py +44 -0
- merge/types/marketing/action_list_params.py +48 -0
- merge/types/marketing/action_response.py +30 -0
- merge/types/marketing/action_retrieve_params.py +15 -0
- merge/types/marketing/actions/__init__.py +3 -0
- merge/types/marketing/automation.py +53 -0
- merge/types/marketing/automation_create_params.py +60 -0
- merge/types/marketing/automation_list_params.py +48 -0
- merge/types/marketing/automation_list_recipients_params.py +24 -0
- merge/types/marketing/automation_response.py +31 -0
- merge/types/marketing/automation_retrieve_params.py +15 -0
- merge/types/marketing/automations/__init__.py +3 -0
- merge/types/marketing/campaign.py +38 -0
- merge/types/marketing/campaign_create_params.py +39 -0
- merge/types/marketing/campaign_list_contacts_params.py +24 -0
- merge/types/marketing/campaign_list_params.py +48 -0
- merge/types/marketing/campaign_response.py +31 -0
- merge/types/marketing/campaign_retrieve_params.py +15 -0
- merge/types/marketing/campaigns/__init__.py +3 -0
- merge/types/marketing/common_model_scope_retrieve_params.py +12 -0
- merge/types/marketing/common_model_scope_update_params.py +21 -0
- merge/types/marketing/contact_create_params.py +384 -0
- merge/types/marketing/contact_list.py +38 -0
- merge/types/marketing/contact_list_create_params.py +34 -0
- merge/types/marketing/contact_list_create_response.py +29 -0
- merge/types/marketing/contact_list_list_params.py +48 -0
- merge/types/marketing/contact_list_list_subscribers_params.py +24 -0
- merge/types/marketing/contact_list_params.py +48 -0
- merge/types/marketing/contact_list_retrieve_params.py +15 -0
- merge/types/marketing/contact_lists/__init__.py +3 -0
- merge/types/marketing/contact_response.py +28 -0
- merge/types/marketing/contact_retrieve_params.py +15 -0
- merge/types/marketing/contacts/__init__.py +3 -0
- merge/types/marketing/email.py +73 -0
- merge/types/marketing/email_list_params.py +48 -0
- merge/types/marketing/email_list_recipients_params.py +24 -0
- merge/types/marketing/email_retrieve_params.py +15 -0
- merge/types/marketing/event.py +47 -0
- merge/types/marketing/event_list_contacts_params.py +24 -0
- merge/types/marketing/event_list_params.py +48 -0
- merge/types/marketing/event_retrieve_params.py +15 -0
- merge/types/marketing/issue_list_params.py +72 -0
- merge/types/marketing/link_token_create_params.py +66 -0
- merge/types/marketing/linked_account_list_params.py +89 -0
- merge/types/marketing/message.py +35 -0
- merge/types/marketing/message_list_params.py +48 -0
- merge/types/marketing/message_list_recipients_params.py +24 -0
- merge/types/marketing/message_retrieve_params.py +15 -0
- merge/types/marketing/passthrough_request_send_params.py +76 -0
- merge/types/marketing/remote_key_generate_params.py +11 -0
- merge/types/marketing/remote_key_regenerate_params.py +11 -0
- merge/types/marketing/selective_sync_list_configurations_response.py +11 -0
- merge/types/marketing/selective_sync_list_metadata_params.py +17 -0
- merge/types/marketing/selective_sync_replace_configurations_params.py +29 -0
- merge/types/marketing/selective_sync_replace_configurations_response.py +11 -0
- merge/types/marketing/sync_status_list_params.py +15 -0
- merge/types/marketing/sync_status_resync_response.py +9 -0
- merge/types/marketing/template.py +48 -0
- merge/types/marketing/template_create_params.py +45 -0
- merge/types/marketing/template_list_params.py +48 -0
- merge/types/marketing/template_response.py +31 -0
- merge/types/marketing/template_retrieve_params.py +15 -0
- merge/types/marketing/templates/__init__.py +3 -0
- merge/types/marketing/user.py +47 -0
- merge/types/marketing/user_list_params.py +48 -0
- merge/types/marketing/user_retrieve_params.py +15 -0
- merge/types/marketing/webhook_receiver_create_params.py +15 -0
- merge/types/marketing/webhook_receiver_list_response.py +9 -0
- merge/types/shared/__init__.py +33 -0
- merge/types/shared/account.py +745 -0
- merge/types/shared/account_detail.py +45 -0
- merge/types/shared/account_details_and_actions.py +78 -0
- merge/types/shared/account_token.py +56 -0
- merge/types/shared/address.py +303 -0
- merge/types/shared/attachment.py +60 -0
- merge/types/shared/available_action.py +68 -0
- merge/types/shared/common_model_scope.py +56 -0
- merge/types/shared/condition_schema.py +56 -0
- merge/types/shared/contact.py +397 -0
- merge/types/shared/country.py +257 -0
- merge/types/shared/debug_log.py +22 -0
- merge/types/shared/issue.py +31 -0
- merge/types/shared/link_token.py +15 -0
- merge/types/shared/linked_account_selective_sync_configuration.py +35 -0
- merge/types/shared/meta_response.py +25 -0
- merge/types/shared/remote_data.py +13 -0
- merge/types/shared/remote_field_class.py +54 -0
- merge/types/shared/remote_key.py +12 -0
- merge/types/shared/remote_response.py +28 -0
- merge/types/shared/remote_user.py +51 -0
- merge/types/shared/sync_status.py +36 -0
- merge/types/shared/tag.py +27 -0
- merge/types/shared/team.py +35 -0
- merge/types/shared/validation_error.py +21 -0
- merge/types/shared/validation_warning.py +21 -0
- merge/types/shared/webhook_receiver.py +15 -0
- merge/types/shared_params/__init__.py +33 -0
- merge/types/shared_params/account.py +700 -0
- merge/types/shared_params/account_detail.py +20 -0
- merge/types/shared_params/account_details_and_actions.py +78 -0
- merge/types/shared_params/account_token.py +54 -0
- merge/types/shared_params/address.py +295 -0
- merge/types/shared_params/attachment.py +50 -0
- merge/types/shared_params/available_action.py +66 -0
- merge/types/shared_params/common_model_scope.py +56 -0
- merge/types/shared_params/condition_schema.py +49 -0
- merge/types/shared_params/contact.py +374 -0
- merge/types/shared_params/country.py +259 -0
- merge/types/shared_params/debug_log.py +23 -0
- merge/types/shared_params/issue.py +25 -0
- merge/types/shared_params/link_token.py +15 -0
- merge/types/shared_params/linked_account_selective_sync_configuration.py +11 -0
- merge/types/shared_params/meta_response.py +25 -0
- merge/types/shared_params/remote_data.py +13 -0
- merge/types/shared_params/remote_field_class.py +54 -0
- merge/types/shared_params/remote_key.py +13 -0
- merge/types/shared_params/remote_response.py +27 -0
- merge/types/shared_params/remote_user.py +40 -0
- merge/types/shared_params/sync_status.py +38 -0
- merge/types/shared_params/tag.py +19 -0
- merge/types/shared_params/team.py +22 -0
- merge/types/shared_params/validation_error.py +21 -0
- merge/types/shared_params/validation_warning.py +21 -0
- merge/types/shared_params/webhook_receiver.py +15 -0
- merge/types/ticketing/__init__.py +94 -0
- merge/types/ticketing/account_list_params.py +48 -0
- merge/types/ticketing/account_retrieve_params.py +15 -0
- merge/types/ticketing/attachment_create_params.py +59 -0
- merge/types/ticketing/attachment_create_response.py +28 -0
- merge/types/ticketing/attachment_list_params.py +57 -0
- merge/types/ticketing/attachment_retrieve_params.py +22 -0
- merge/types/ticketing/attachments/__init__.py +3 -0
- merge/types/ticketing/collection.py +42 -0
- merge/types/ticketing/collection_list_params.py +73 -0
- merge/types/ticketing/collection_list_users_params.py +31 -0
- merge/types/ticketing/collection_retrieve_params.py +28 -0
- merge/types/ticketing/comment.py +46 -0
- merge/types/ticketing/comment_create_params.py +46 -0
- merge/types/ticketing/comment_list_params.py +57 -0
- merge/types/ticketing/comment_response.py +29 -0
- merge/types/ticketing/comment_retrieve_params.py +22 -0
- merge/types/ticketing/comments/__init__.py +3 -0
- merge/types/ticketing/common_model_scope_retrieve_params.py +12 -0
- merge/types/ticketing/common_model_scope_update_params.py +21 -0
- merge/types/ticketing/contact_list_params.py +54 -0
- merge/types/ticketing/contact_retrieve_params.py +22 -0
- merge/types/ticketing/issue_list_params.py +72 -0
- merge/types/ticketing/link_token_create_params.py +66 -0
- merge/types/ticketing/linked_account_list_params.py +89 -0
- merge/types/ticketing/passthrough_request_send_params.py +76 -0
- merge/types/ticketing/project.py +32 -0
- merge/types/ticketing/project_list_params.py +48 -0
- merge/types/ticketing/project_list_users_params.py +31 -0
- merge/types/ticketing/project_retrieve_params.py +15 -0
- merge/types/ticketing/remote_key_generate_params.py +11 -0
- merge/types/ticketing/remote_key_regenerate_params.py +11 -0
- merge/types/ticketing/selective_sync_list_configurations_response.py +11 -0
- merge/types/ticketing/selective_sync_list_metadata_params.py +17 -0
- merge/types/ticketing/selective_sync_replace_configurations_params.py +29 -0
- merge/types/ticketing/selective_sync_replace_configurations_response.py +11 -0
- merge/types/ticketing/sync_status_list_params.py +15 -0
- merge/types/ticketing/sync_status_resync_response.py +9 -0
- merge/types/ticketing/tag_list_params.py +48 -0
- merge/types/ticketing/tag_retrieve_params.py +15 -0
- merge/types/ticketing/team_list_params.py +48 -0
- merge/types/ticketing/team_retrieve_params.py +15 -0
- merge/types/ticketing/ticket.py +100 -0
- merge/types/ticketing/ticket_create_params.py +91 -0
- merge/types/ticketing/ticket_list_collaborators_params.py +31 -0
- merge/types/ticketing/ticket_list_params.py +171 -0
- merge/types/ticketing/ticket_list_remote_field_classes_params.py +24 -0
- merge/types/ticketing/ticket_response.py +29 -0
- merge/types/ticketing/ticket_retrieve_params.py +52 -0
- merge/types/ticketing/ticket_update_params.py +89 -0
- merge/types/ticketing/tickets/__init__.py +3 -0
- merge/types/ticketing/user.py +40 -0
- merge/types/ticketing/user_list_params.py +60 -0
- merge/types/ticketing/user_retrieve_params.py +22 -0
- merge/types/ticketing/webhook_receiver_create_params.py +15 -0
- merge/types/ticketing/webhook_receiver_list_response.py +9 -0
- mergepythonclient-0.0.1.dist-info/LICENSE.md +16 -0
- mergepythonclient-0.0.1.dist-info/METADATA +281 -0
- mergepythonclient-0.0.1.dist-info/RECORD +834 -0
- mergepythonclient-0.0.1.dist-info/WHEEL +4 -0
|
@@ -0,0 +1,727 @@
|
|
|
1
|
+
# File generated from our OpenAPI spec by Stainless.
|
|
2
|
+
|
|
3
|
+
from __future__ import annotations
|
|
4
|
+
|
|
5
|
+
from typing import TYPE_CHECKING, List, Union, Optional
|
|
6
|
+
from datetime import datetime
|
|
7
|
+
from typing_extensions import Literal
|
|
8
|
+
|
|
9
|
+
from .meta import Meta, AsyncMeta
|
|
10
|
+
from ....types import shared
|
|
11
|
+
from ...._types import NOT_GIVEN, Body, Query, Headers, NoneType, NotGiven
|
|
12
|
+
from ...._utils import maybe_transform
|
|
13
|
+
from ...._resource import SyncAPIResource, AsyncAPIResource
|
|
14
|
+
from ....types.crm import (
|
|
15
|
+
ContactResponse,
|
|
16
|
+
contact_list_params,
|
|
17
|
+
contact_create_params,
|
|
18
|
+
contact_update_params,
|
|
19
|
+
contact_retrieve_params,
|
|
20
|
+
contact_ignore_row_params,
|
|
21
|
+
contact_list_remote_field_classes_params,
|
|
22
|
+
)
|
|
23
|
+
from ....pagination import SyncPage, AsyncPage
|
|
24
|
+
from ...._base_client import AsyncPaginator, make_request_options
|
|
25
|
+
|
|
26
|
+
if TYPE_CHECKING:
|
|
27
|
+
from ...._client import Merge, AsyncMerge
|
|
28
|
+
|
|
29
|
+
__all__ = ["Contacts", "AsyncContacts"]
|
|
30
|
+
|
|
31
|
+
|
|
32
|
+
class Contacts(SyncAPIResource):
|
|
33
|
+
meta: Meta
|
|
34
|
+
|
|
35
|
+
def __init__(self, client: Merge) -> None:
|
|
36
|
+
super().__init__(client)
|
|
37
|
+
self.meta = Meta(client)
|
|
38
|
+
|
|
39
|
+
def create(
|
|
40
|
+
self,
|
|
41
|
+
*,
|
|
42
|
+
model: contact_create_params.Model,
|
|
43
|
+
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
|
|
44
|
+
# The extra values given here take precedence over values defined on the client or passed to this method.
|
|
45
|
+
extra_headers: Headers | None = None,
|
|
46
|
+
extra_query: Query | None = None,
|
|
47
|
+
extra_body: Body | None = None,
|
|
48
|
+
timeout: float | None | NotGiven = NOT_GIVEN,
|
|
49
|
+
) -> ContactResponse:
|
|
50
|
+
"""
|
|
51
|
+
Creates a `Contact` object with the given values.
|
|
52
|
+
|
|
53
|
+
Args:
|
|
54
|
+
model: # The Contact Object
|
|
55
|
+
|
|
56
|
+
### Description
|
|
57
|
+
|
|
58
|
+
The `Contact` object is used to represent a contact in the remote system.
|
|
59
|
+
|
|
60
|
+
### Usage Example
|
|
61
|
+
|
|
62
|
+
Fetch from the `GET /api/mktg/v1/contact` endpoint and view their phone numbers.
|
|
63
|
+
|
|
64
|
+
extra_headers: Send extra headers
|
|
65
|
+
|
|
66
|
+
extra_query: Add additional query parameters to the request
|
|
67
|
+
|
|
68
|
+
extra_body: Add additional JSON properties to the request
|
|
69
|
+
|
|
70
|
+
timeout: Override the client-level default timeout for this request, in seconds
|
|
71
|
+
"""
|
|
72
|
+
return self._post(
|
|
73
|
+
"/crm/v1/contacts",
|
|
74
|
+
body=maybe_transform({"model": model}, contact_create_params.ContactCreateParams),
|
|
75
|
+
options=make_request_options(
|
|
76
|
+
extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
|
|
77
|
+
),
|
|
78
|
+
cast_to=ContactResponse,
|
|
79
|
+
)
|
|
80
|
+
|
|
81
|
+
def retrieve(
|
|
82
|
+
self,
|
|
83
|
+
id: str,
|
|
84
|
+
*,
|
|
85
|
+
expand: List[Literal["account"]] | NotGiven = NOT_GIVEN,
|
|
86
|
+
include_remote_data: bool | NotGiven = NOT_GIVEN,
|
|
87
|
+
include_remote_fields: bool | NotGiven = NOT_GIVEN,
|
|
88
|
+
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
|
|
89
|
+
# The extra values given here take precedence over values defined on the client or passed to this method.
|
|
90
|
+
extra_headers: Headers | None = None,
|
|
91
|
+
extra_query: Query | None = None,
|
|
92
|
+
extra_body: Body | None = None,
|
|
93
|
+
timeout: float | None | NotGiven = NOT_GIVEN,
|
|
94
|
+
) -> shared.Contact:
|
|
95
|
+
"""
|
|
96
|
+
Returns a `Contact` object with the given `id`.
|
|
97
|
+
|
|
98
|
+
Args:
|
|
99
|
+
expand: Which relations should be returned in expanded form. Multiple relation names
|
|
100
|
+
should be comma separated without spaces.
|
|
101
|
+
|
|
102
|
+
include_remote_data: Whether to include the original data Merge fetched from the third-party to
|
|
103
|
+
produce these models.
|
|
104
|
+
|
|
105
|
+
include_remote_fields: Whether to include all remote fields, including fields that Merge did not map to
|
|
106
|
+
common models, in a normalized format.
|
|
107
|
+
|
|
108
|
+
extra_headers: Send extra headers
|
|
109
|
+
|
|
110
|
+
extra_query: Add additional query parameters to the request
|
|
111
|
+
|
|
112
|
+
extra_body: Add additional JSON properties to the request
|
|
113
|
+
|
|
114
|
+
timeout: Override the client-level default timeout for this request, in seconds
|
|
115
|
+
"""
|
|
116
|
+
return self._get(
|
|
117
|
+
f"/crm/v1/contacts/{id}",
|
|
118
|
+
options=make_request_options(
|
|
119
|
+
extra_headers=extra_headers,
|
|
120
|
+
extra_query=extra_query,
|
|
121
|
+
extra_body=extra_body,
|
|
122
|
+
timeout=timeout,
|
|
123
|
+
query=maybe_transform(
|
|
124
|
+
{
|
|
125
|
+
"expand": expand,
|
|
126
|
+
"include_remote_data": include_remote_data,
|
|
127
|
+
"include_remote_fields": include_remote_fields,
|
|
128
|
+
},
|
|
129
|
+
contact_retrieve_params.ContactRetrieveParams,
|
|
130
|
+
),
|
|
131
|
+
),
|
|
132
|
+
cast_to=shared.Contact,
|
|
133
|
+
)
|
|
134
|
+
|
|
135
|
+
def update(
|
|
136
|
+
self,
|
|
137
|
+
id: str,
|
|
138
|
+
*,
|
|
139
|
+
model: contact_update_params.Model,
|
|
140
|
+
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
|
|
141
|
+
# The extra values given here take precedence over values defined on the client or passed to this method.
|
|
142
|
+
extra_headers: Headers | None = None,
|
|
143
|
+
extra_query: Query | None = None,
|
|
144
|
+
extra_body: Body | None = None,
|
|
145
|
+
timeout: float | None | NotGiven = NOT_GIVEN,
|
|
146
|
+
) -> ContactResponse:
|
|
147
|
+
"""
|
|
148
|
+
Updates a `Contact` object with the given `id`.
|
|
149
|
+
|
|
150
|
+
Args:
|
|
151
|
+
model: # The Contact Object
|
|
152
|
+
|
|
153
|
+
### Description
|
|
154
|
+
|
|
155
|
+
The `Contact` object is used to represent an existing point of contact at a
|
|
156
|
+
company in a CRM system.
|
|
157
|
+
|
|
158
|
+
### Usage Example
|
|
159
|
+
|
|
160
|
+
TODO
|
|
161
|
+
|
|
162
|
+
extra_headers: Send extra headers
|
|
163
|
+
|
|
164
|
+
extra_query: Add additional query parameters to the request
|
|
165
|
+
|
|
166
|
+
extra_body: Add additional JSON properties to the request
|
|
167
|
+
|
|
168
|
+
timeout: Override the client-level default timeout for this request, in seconds
|
|
169
|
+
"""
|
|
170
|
+
return self._patch(
|
|
171
|
+
f"/crm/v1/contacts/{id}",
|
|
172
|
+
body=maybe_transform({"model": model}, contact_update_params.ContactUpdateParams),
|
|
173
|
+
options=make_request_options(
|
|
174
|
+
extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
|
|
175
|
+
),
|
|
176
|
+
cast_to=ContactResponse,
|
|
177
|
+
)
|
|
178
|
+
|
|
179
|
+
def list(
|
|
180
|
+
self,
|
|
181
|
+
*,
|
|
182
|
+
account_id: str | NotGiven = NOT_GIVEN,
|
|
183
|
+
created_after: Union[str, datetime] | NotGiven = NOT_GIVEN,
|
|
184
|
+
created_before: Union[str, datetime] | NotGiven = NOT_GIVEN,
|
|
185
|
+
cursor: str | NotGiven = NOT_GIVEN,
|
|
186
|
+
expand: List[Literal["account"]] | NotGiven = NOT_GIVEN,
|
|
187
|
+
include_deleted_data: bool | NotGiven = NOT_GIVEN,
|
|
188
|
+
include_remote_data: bool | NotGiven = NOT_GIVEN,
|
|
189
|
+
include_remote_fields: bool | NotGiven = NOT_GIVEN,
|
|
190
|
+
modified_after: Union[str, datetime] | NotGiven = NOT_GIVEN,
|
|
191
|
+
modified_before: Union[str, datetime] | NotGiven = NOT_GIVEN,
|
|
192
|
+
page_size: int | NotGiven = NOT_GIVEN,
|
|
193
|
+
remote_id: Optional[str] | NotGiven = NOT_GIVEN,
|
|
194
|
+
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
|
|
195
|
+
# The extra values given here take precedence over values defined on the client or passed to this method.
|
|
196
|
+
extra_headers: Headers | None = None,
|
|
197
|
+
extra_query: Query | None = None,
|
|
198
|
+
extra_body: Body | None = None,
|
|
199
|
+
timeout: float | None | NotGiven = NOT_GIVEN,
|
|
200
|
+
) -> SyncPage[shared.Contact]:
|
|
201
|
+
"""
|
|
202
|
+
Returns a list of `Contact` objects.
|
|
203
|
+
|
|
204
|
+
Args:
|
|
205
|
+
account_id: If provided, will only return contacts with this account.
|
|
206
|
+
|
|
207
|
+
created_after: If provided, will only return objects created after this datetime.
|
|
208
|
+
|
|
209
|
+
created_before: If provided, will only return objects created before this datetime.
|
|
210
|
+
|
|
211
|
+
cursor: The pagination cursor value.
|
|
212
|
+
|
|
213
|
+
expand: Which relations should be returned in expanded form. Multiple relation names
|
|
214
|
+
should be comma separated without spaces.
|
|
215
|
+
|
|
216
|
+
include_deleted_data: Whether to include data that was marked as deleted by third party webhooks.
|
|
217
|
+
|
|
218
|
+
include_remote_data: Whether to include the original data Merge fetched from the third-party to
|
|
219
|
+
produce these models.
|
|
220
|
+
|
|
221
|
+
include_remote_fields: Whether to include all remote fields, including fields that Merge did not map to
|
|
222
|
+
common models, in a normalized format.
|
|
223
|
+
|
|
224
|
+
modified_after: If provided, only objects synced by Merge after this date time will be returned.
|
|
225
|
+
|
|
226
|
+
modified_before: If provided, only objects synced by Merge before this date time will be
|
|
227
|
+
returned.
|
|
228
|
+
|
|
229
|
+
page_size: Number of results to return per page.
|
|
230
|
+
|
|
231
|
+
remote_id: The API provider's ID for the given object.
|
|
232
|
+
|
|
233
|
+
extra_headers: Send extra headers
|
|
234
|
+
|
|
235
|
+
extra_query: Add additional query parameters to the request
|
|
236
|
+
|
|
237
|
+
extra_body: Add additional JSON properties to the request
|
|
238
|
+
|
|
239
|
+
timeout: Override the client-level default timeout for this request, in seconds
|
|
240
|
+
"""
|
|
241
|
+
return self._get_api_list(
|
|
242
|
+
"/crm/v1/contacts",
|
|
243
|
+
page=SyncPage[shared.Contact],
|
|
244
|
+
options=make_request_options(
|
|
245
|
+
extra_headers=extra_headers,
|
|
246
|
+
extra_query=extra_query,
|
|
247
|
+
extra_body=extra_body,
|
|
248
|
+
timeout=timeout,
|
|
249
|
+
query=maybe_transform(
|
|
250
|
+
{
|
|
251
|
+
"account_id": account_id,
|
|
252
|
+
"created_after": created_after,
|
|
253
|
+
"created_before": created_before,
|
|
254
|
+
"cursor": cursor,
|
|
255
|
+
"expand": expand,
|
|
256
|
+
"include_deleted_data": include_deleted_data,
|
|
257
|
+
"include_remote_data": include_remote_data,
|
|
258
|
+
"include_remote_fields": include_remote_fields,
|
|
259
|
+
"modified_after": modified_after,
|
|
260
|
+
"modified_before": modified_before,
|
|
261
|
+
"page_size": page_size,
|
|
262
|
+
"remote_id": remote_id,
|
|
263
|
+
},
|
|
264
|
+
contact_list_params.ContactListParams,
|
|
265
|
+
),
|
|
266
|
+
),
|
|
267
|
+
model=shared.Contact,
|
|
268
|
+
)
|
|
269
|
+
|
|
270
|
+
def ignore_row(
|
|
271
|
+
self,
|
|
272
|
+
model_id: str,
|
|
273
|
+
*,
|
|
274
|
+
reason: Literal["GENERAL_CUSTOMER_REQUEST", "GDPR", "OTHER"],
|
|
275
|
+
message: str | NotGiven = NOT_GIVEN,
|
|
276
|
+
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
|
|
277
|
+
# The extra values given here take precedence over values defined on the client or passed to this method.
|
|
278
|
+
extra_headers: Headers | None = None,
|
|
279
|
+
extra_query: Query | None = None,
|
|
280
|
+
extra_body: Body | None = None,
|
|
281
|
+
timeout: float | None | NotGiven = NOT_GIVEN,
|
|
282
|
+
) -> None:
|
|
283
|
+
"""Ignores a specific row based on the `model_id` in the url.
|
|
284
|
+
|
|
285
|
+
These records will
|
|
286
|
+
have their properties set to null, and will not be updated in future syncs. The
|
|
287
|
+
"reason" and "message" fields in the request body will be stored for audit
|
|
288
|
+
purposes.
|
|
289
|
+
|
|
290
|
+
Args:
|
|
291
|
+
reason: - `GENERAL_CUSTOMER_REQUEST` - GENERAL_CUSTOMER_REQUEST
|
|
292
|
+
- `GDPR` - GDPR
|
|
293
|
+
- `OTHER` - OTHER
|
|
294
|
+
|
|
295
|
+
extra_headers: Send extra headers
|
|
296
|
+
|
|
297
|
+
extra_query: Add additional query parameters to the request
|
|
298
|
+
|
|
299
|
+
extra_body: Add additional JSON properties to the request
|
|
300
|
+
|
|
301
|
+
timeout: Override the client-level default timeout for this request, in seconds
|
|
302
|
+
"""
|
|
303
|
+
extra_headers = {"Accept": "*/*", **(extra_headers or {})}
|
|
304
|
+
return self._post(
|
|
305
|
+
f"/crm/v1/contacts/ignore/{model_id}",
|
|
306
|
+
body=maybe_transform(
|
|
307
|
+
{
|
|
308
|
+
"reason": reason,
|
|
309
|
+
"message": message,
|
|
310
|
+
},
|
|
311
|
+
contact_ignore_row_params.ContactIgnoreRowParams,
|
|
312
|
+
),
|
|
313
|
+
options=make_request_options(
|
|
314
|
+
extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
|
|
315
|
+
),
|
|
316
|
+
cast_to=NoneType,
|
|
317
|
+
)
|
|
318
|
+
|
|
319
|
+
def list_remote_field_classes(
|
|
320
|
+
self,
|
|
321
|
+
*,
|
|
322
|
+
cursor: str | NotGiven = NOT_GIVEN,
|
|
323
|
+
include_deleted_data: bool | NotGiven = NOT_GIVEN,
|
|
324
|
+
include_remote_data: bool | NotGiven = NOT_GIVEN,
|
|
325
|
+
include_remote_fields: bool | NotGiven = NOT_GIVEN,
|
|
326
|
+
page_size: int | NotGiven = NOT_GIVEN,
|
|
327
|
+
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
|
|
328
|
+
# The extra values given here take precedence over values defined on the client or passed to this method.
|
|
329
|
+
extra_headers: Headers | None = None,
|
|
330
|
+
extra_query: Query | None = None,
|
|
331
|
+
extra_body: Body | None = None,
|
|
332
|
+
timeout: float | None | NotGiven = NOT_GIVEN,
|
|
333
|
+
) -> SyncPage[shared.RemoteFieldClass]:
|
|
334
|
+
"""
|
|
335
|
+
Returns a list of `RemoteFieldClass` objects.
|
|
336
|
+
|
|
337
|
+
Args:
|
|
338
|
+
cursor: The pagination cursor value.
|
|
339
|
+
|
|
340
|
+
include_deleted_data: Whether to include data that was marked as deleted by third party webhooks.
|
|
341
|
+
|
|
342
|
+
include_remote_data: Whether to include the original data Merge fetched from the third-party to
|
|
343
|
+
produce these models.
|
|
344
|
+
|
|
345
|
+
include_remote_fields: Whether to include all remote fields, including fields that Merge did not map to
|
|
346
|
+
common models, in a normalized format.
|
|
347
|
+
|
|
348
|
+
page_size: Number of results to return per page.
|
|
349
|
+
|
|
350
|
+
extra_headers: Send extra headers
|
|
351
|
+
|
|
352
|
+
extra_query: Add additional query parameters to the request
|
|
353
|
+
|
|
354
|
+
extra_body: Add additional JSON properties to the request
|
|
355
|
+
|
|
356
|
+
timeout: Override the client-level default timeout for this request, in seconds
|
|
357
|
+
"""
|
|
358
|
+
return self._get_api_list(
|
|
359
|
+
"/crm/v1/contacts/remote-field-classes",
|
|
360
|
+
page=SyncPage[shared.RemoteFieldClass],
|
|
361
|
+
options=make_request_options(
|
|
362
|
+
extra_headers=extra_headers,
|
|
363
|
+
extra_query=extra_query,
|
|
364
|
+
extra_body=extra_body,
|
|
365
|
+
timeout=timeout,
|
|
366
|
+
query=maybe_transform(
|
|
367
|
+
{
|
|
368
|
+
"cursor": cursor,
|
|
369
|
+
"include_deleted_data": include_deleted_data,
|
|
370
|
+
"include_remote_data": include_remote_data,
|
|
371
|
+
"include_remote_fields": include_remote_fields,
|
|
372
|
+
"page_size": page_size,
|
|
373
|
+
},
|
|
374
|
+
contact_list_remote_field_classes_params.ContactListRemoteFieldClassesParams,
|
|
375
|
+
),
|
|
376
|
+
),
|
|
377
|
+
model=shared.RemoteFieldClass,
|
|
378
|
+
)
|
|
379
|
+
|
|
380
|
+
|
|
381
|
+
class AsyncContacts(AsyncAPIResource):
|
|
382
|
+
meta: AsyncMeta
|
|
383
|
+
|
|
384
|
+
def __init__(self, client: AsyncMerge) -> None:
|
|
385
|
+
super().__init__(client)
|
|
386
|
+
self.meta = AsyncMeta(client)
|
|
387
|
+
|
|
388
|
+
async def create(
|
|
389
|
+
self,
|
|
390
|
+
*,
|
|
391
|
+
model: contact_create_params.Model,
|
|
392
|
+
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
|
|
393
|
+
# The extra values given here take precedence over values defined on the client or passed to this method.
|
|
394
|
+
extra_headers: Headers | None = None,
|
|
395
|
+
extra_query: Query | None = None,
|
|
396
|
+
extra_body: Body | None = None,
|
|
397
|
+
timeout: float | None | NotGiven = NOT_GIVEN,
|
|
398
|
+
) -> ContactResponse:
|
|
399
|
+
"""
|
|
400
|
+
Creates a `Contact` object with the given values.
|
|
401
|
+
|
|
402
|
+
Args:
|
|
403
|
+
model: # The Contact Object
|
|
404
|
+
|
|
405
|
+
### Description
|
|
406
|
+
|
|
407
|
+
The `Contact` object is used to represent a contact in the remote system.
|
|
408
|
+
|
|
409
|
+
### Usage Example
|
|
410
|
+
|
|
411
|
+
Fetch from the `GET /api/mktg/v1/contact` endpoint and view their phone numbers.
|
|
412
|
+
|
|
413
|
+
extra_headers: Send extra headers
|
|
414
|
+
|
|
415
|
+
extra_query: Add additional query parameters to the request
|
|
416
|
+
|
|
417
|
+
extra_body: Add additional JSON properties to the request
|
|
418
|
+
|
|
419
|
+
timeout: Override the client-level default timeout for this request, in seconds
|
|
420
|
+
"""
|
|
421
|
+
return await self._post(
|
|
422
|
+
"/crm/v1/contacts",
|
|
423
|
+
body=maybe_transform({"model": model}, contact_create_params.ContactCreateParams),
|
|
424
|
+
options=make_request_options(
|
|
425
|
+
extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
|
|
426
|
+
),
|
|
427
|
+
cast_to=ContactResponse,
|
|
428
|
+
)
|
|
429
|
+
|
|
430
|
+
async def retrieve(
|
|
431
|
+
self,
|
|
432
|
+
id: str,
|
|
433
|
+
*,
|
|
434
|
+
expand: List[Literal["account"]] | NotGiven = NOT_GIVEN,
|
|
435
|
+
include_remote_data: bool | NotGiven = NOT_GIVEN,
|
|
436
|
+
include_remote_fields: bool | NotGiven = NOT_GIVEN,
|
|
437
|
+
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
|
|
438
|
+
# The extra values given here take precedence over values defined on the client or passed to this method.
|
|
439
|
+
extra_headers: Headers | None = None,
|
|
440
|
+
extra_query: Query | None = None,
|
|
441
|
+
extra_body: Body | None = None,
|
|
442
|
+
timeout: float | None | NotGiven = NOT_GIVEN,
|
|
443
|
+
) -> shared.Contact:
|
|
444
|
+
"""
|
|
445
|
+
Returns a `Contact` object with the given `id`.
|
|
446
|
+
|
|
447
|
+
Args:
|
|
448
|
+
expand: Which relations should be returned in expanded form. Multiple relation names
|
|
449
|
+
should be comma separated without spaces.
|
|
450
|
+
|
|
451
|
+
include_remote_data: Whether to include the original data Merge fetched from the third-party to
|
|
452
|
+
produce these models.
|
|
453
|
+
|
|
454
|
+
include_remote_fields: Whether to include all remote fields, including fields that Merge did not map to
|
|
455
|
+
common models, in a normalized format.
|
|
456
|
+
|
|
457
|
+
extra_headers: Send extra headers
|
|
458
|
+
|
|
459
|
+
extra_query: Add additional query parameters to the request
|
|
460
|
+
|
|
461
|
+
extra_body: Add additional JSON properties to the request
|
|
462
|
+
|
|
463
|
+
timeout: Override the client-level default timeout for this request, in seconds
|
|
464
|
+
"""
|
|
465
|
+
return await self._get(
|
|
466
|
+
f"/crm/v1/contacts/{id}",
|
|
467
|
+
options=make_request_options(
|
|
468
|
+
extra_headers=extra_headers,
|
|
469
|
+
extra_query=extra_query,
|
|
470
|
+
extra_body=extra_body,
|
|
471
|
+
timeout=timeout,
|
|
472
|
+
query=maybe_transform(
|
|
473
|
+
{
|
|
474
|
+
"expand": expand,
|
|
475
|
+
"include_remote_data": include_remote_data,
|
|
476
|
+
"include_remote_fields": include_remote_fields,
|
|
477
|
+
},
|
|
478
|
+
contact_retrieve_params.ContactRetrieveParams,
|
|
479
|
+
),
|
|
480
|
+
),
|
|
481
|
+
cast_to=shared.Contact,
|
|
482
|
+
)
|
|
483
|
+
|
|
484
|
+
async def update(
|
|
485
|
+
self,
|
|
486
|
+
id: str,
|
|
487
|
+
*,
|
|
488
|
+
model: contact_update_params.Model,
|
|
489
|
+
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
|
|
490
|
+
# The extra values given here take precedence over values defined on the client or passed to this method.
|
|
491
|
+
extra_headers: Headers | None = None,
|
|
492
|
+
extra_query: Query | None = None,
|
|
493
|
+
extra_body: Body | None = None,
|
|
494
|
+
timeout: float | None | NotGiven = NOT_GIVEN,
|
|
495
|
+
) -> ContactResponse:
|
|
496
|
+
"""
|
|
497
|
+
Updates a `Contact` object with the given `id`.
|
|
498
|
+
|
|
499
|
+
Args:
|
|
500
|
+
model: # The Contact Object
|
|
501
|
+
|
|
502
|
+
### Description
|
|
503
|
+
|
|
504
|
+
The `Contact` object is used to represent an existing point of contact at a
|
|
505
|
+
company in a CRM system.
|
|
506
|
+
|
|
507
|
+
### Usage Example
|
|
508
|
+
|
|
509
|
+
TODO
|
|
510
|
+
|
|
511
|
+
extra_headers: Send extra headers
|
|
512
|
+
|
|
513
|
+
extra_query: Add additional query parameters to the request
|
|
514
|
+
|
|
515
|
+
extra_body: Add additional JSON properties to the request
|
|
516
|
+
|
|
517
|
+
timeout: Override the client-level default timeout for this request, in seconds
|
|
518
|
+
"""
|
|
519
|
+
return await self._patch(
|
|
520
|
+
f"/crm/v1/contacts/{id}",
|
|
521
|
+
body=maybe_transform({"model": model}, contact_update_params.ContactUpdateParams),
|
|
522
|
+
options=make_request_options(
|
|
523
|
+
extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
|
|
524
|
+
),
|
|
525
|
+
cast_to=ContactResponse,
|
|
526
|
+
)
|
|
527
|
+
|
|
528
|
+
def list(
|
|
529
|
+
self,
|
|
530
|
+
*,
|
|
531
|
+
account_id: str | NotGiven = NOT_GIVEN,
|
|
532
|
+
created_after: Union[str, datetime] | NotGiven = NOT_GIVEN,
|
|
533
|
+
created_before: Union[str, datetime] | NotGiven = NOT_GIVEN,
|
|
534
|
+
cursor: str | NotGiven = NOT_GIVEN,
|
|
535
|
+
expand: List[Literal["account"]] | NotGiven = NOT_GIVEN,
|
|
536
|
+
include_deleted_data: bool | NotGiven = NOT_GIVEN,
|
|
537
|
+
include_remote_data: bool | NotGiven = NOT_GIVEN,
|
|
538
|
+
include_remote_fields: bool | NotGiven = NOT_GIVEN,
|
|
539
|
+
modified_after: Union[str, datetime] | NotGiven = NOT_GIVEN,
|
|
540
|
+
modified_before: Union[str, datetime] | NotGiven = NOT_GIVEN,
|
|
541
|
+
page_size: int | NotGiven = NOT_GIVEN,
|
|
542
|
+
remote_id: Optional[str] | NotGiven = NOT_GIVEN,
|
|
543
|
+
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
|
|
544
|
+
# The extra values given here take precedence over values defined on the client or passed to this method.
|
|
545
|
+
extra_headers: Headers | None = None,
|
|
546
|
+
extra_query: Query | None = None,
|
|
547
|
+
extra_body: Body | None = None,
|
|
548
|
+
timeout: float | None | NotGiven = NOT_GIVEN,
|
|
549
|
+
) -> AsyncPaginator[shared.Contact, AsyncPage[shared.Contact]]:
|
|
550
|
+
"""
|
|
551
|
+
Returns a list of `Contact` objects.
|
|
552
|
+
|
|
553
|
+
Args:
|
|
554
|
+
account_id: If provided, will only return contacts with this account.
|
|
555
|
+
|
|
556
|
+
created_after: If provided, will only return objects created after this datetime.
|
|
557
|
+
|
|
558
|
+
created_before: If provided, will only return objects created before this datetime.
|
|
559
|
+
|
|
560
|
+
cursor: The pagination cursor value.
|
|
561
|
+
|
|
562
|
+
expand: Which relations should be returned in expanded form. Multiple relation names
|
|
563
|
+
should be comma separated without spaces.
|
|
564
|
+
|
|
565
|
+
include_deleted_data: Whether to include data that was marked as deleted by third party webhooks.
|
|
566
|
+
|
|
567
|
+
include_remote_data: Whether to include the original data Merge fetched from the third-party to
|
|
568
|
+
produce these models.
|
|
569
|
+
|
|
570
|
+
include_remote_fields: Whether to include all remote fields, including fields that Merge did not map to
|
|
571
|
+
common models, in a normalized format.
|
|
572
|
+
|
|
573
|
+
modified_after: If provided, only objects synced by Merge after this date time will be returned.
|
|
574
|
+
|
|
575
|
+
modified_before: If provided, only objects synced by Merge before this date time will be
|
|
576
|
+
returned.
|
|
577
|
+
|
|
578
|
+
page_size: Number of results to return per page.
|
|
579
|
+
|
|
580
|
+
remote_id: The API provider's ID for the given object.
|
|
581
|
+
|
|
582
|
+
extra_headers: Send extra headers
|
|
583
|
+
|
|
584
|
+
extra_query: Add additional query parameters to the request
|
|
585
|
+
|
|
586
|
+
extra_body: Add additional JSON properties to the request
|
|
587
|
+
|
|
588
|
+
timeout: Override the client-level default timeout for this request, in seconds
|
|
589
|
+
"""
|
|
590
|
+
return self._get_api_list(
|
|
591
|
+
"/crm/v1/contacts",
|
|
592
|
+
page=AsyncPage[shared.Contact],
|
|
593
|
+
options=make_request_options(
|
|
594
|
+
extra_headers=extra_headers,
|
|
595
|
+
extra_query=extra_query,
|
|
596
|
+
extra_body=extra_body,
|
|
597
|
+
timeout=timeout,
|
|
598
|
+
query=maybe_transform(
|
|
599
|
+
{
|
|
600
|
+
"account_id": account_id,
|
|
601
|
+
"created_after": created_after,
|
|
602
|
+
"created_before": created_before,
|
|
603
|
+
"cursor": cursor,
|
|
604
|
+
"expand": expand,
|
|
605
|
+
"include_deleted_data": include_deleted_data,
|
|
606
|
+
"include_remote_data": include_remote_data,
|
|
607
|
+
"include_remote_fields": include_remote_fields,
|
|
608
|
+
"modified_after": modified_after,
|
|
609
|
+
"modified_before": modified_before,
|
|
610
|
+
"page_size": page_size,
|
|
611
|
+
"remote_id": remote_id,
|
|
612
|
+
},
|
|
613
|
+
contact_list_params.ContactListParams,
|
|
614
|
+
),
|
|
615
|
+
),
|
|
616
|
+
model=shared.Contact,
|
|
617
|
+
)
|
|
618
|
+
|
|
619
|
+
async def ignore_row(
|
|
620
|
+
self,
|
|
621
|
+
model_id: str,
|
|
622
|
+
*,
|
|
623
|
+
reason: Literal["GENERAL_CUSTOMER_REQUEST", "GDPR", "OTHER"],
|
|
624
|
+
message: str | NotGiven = NOT_GIVEN,
|
|
625
|
+
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
|
|
626
|
+
# The extra values given here take precedence over values defined on the client or passed to this method.
|
|
627
|
+
extra_headers: Headers | None = None,
|
|
628
|
+
extra_query: Query | None = None,
|
|
629
|
+
extra_body: Body | None = None,
|
|
630
|
+
timeout: float | None | NotGiven = NOT_GIVEN,
|
|
631
|
+
) -> None:
|
|
632
|
+
"""Ignores a specific row based on the `model_id` in the url.
|
|
633
|
+
|
|
634
|
+
These records will
|
|
635
|
+
have their properties set to null, and will not be updated in future syncs. The
|
|
636
|
+
"reason" and "message" fields in the request body will be stored for audit
|
|
637
|
+
purposes.
|
|
638
|
+
|
|
639
|
+
Args:
|
|
640
|
+
reason: - `GENERAL_CUSTOMER_REQUEST` - GENERAL_CUSTOMER_REQUEST
|
|
641
|
+
- `GDPR` - GDPR
|
|
642
|
+
- `OTHER` - OTHER
|
|
643
|
+
|
|
644
|
+
extra_headers: Send extra headers
|
|
645
|
+
|
|
646
|
+
extra_query: Add additional query parameters to the request
|
|
647
|
+
|
|
648
|
+
extra_body: Add additional JSON properties to the request
|
|
649
|
+
|
|
650
|
+
timeout: Override the client-level default timeout for this request, in seconds
|
|
651
|
+
"""
|
|
652
|
+
extra_headers = {"Accept": "*/*", **(extra_headers or {})}
|
|
653
|
+
return await self._post(
|
|
654
|
+
f"/crm/v1/contacts/ignore/{model_id}",
|
|
655
|
+
body=maybe_transform(
|
|
656
|
+
{
|
|
657
|
+
"reason": reason,
|
|
658
|
+
"message": message,
|
|
659
|
+
},
|
|
660
|
+
contact_ignore_row_params.ContactIgnoreRowParams,
|
|
661
|
+
),
|
|
662
|
+
options=make_request_options(
|
|
663
|
+
extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
|
|
664
|
+
),
|
|
665
|
+
cast_to=NoneType,
|
|
666
|
+
)
|
|
667
|
+
|
|
668
|
+
def list_remote_field_classes(
|
|
669
|
+
self,
|
|
670
|
+
*,
|
|
671
|
+
cursor: str | NotGiven = NOT_GIVEN,
|
|
672
|
+
include_deleted_data: bool | NotGiven = NOT_GIVEN,
|
|
673
|
+
include_remote_data: bool | NotGiven = NOT_GIVEN,
|
|
674
|
+
include_remote_fields: bool | NotGiven = NOT_GIVEN,
|
|
675
|
+
page_size: int | NotGiven = NOT_GIVEN,
|
|
676
|
+
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
|
|
677
|
+
# The extra values given here take precedence over values defined on the client or passed to this method.
|
|
678
|
+
extra_headers: Headers | None = None,
|
|
679
|
+
extra_query: Query | None = None,
|
|
680
|
+
extra_body: Body | None = None,
|
|
681
|
+
timeout: float | None | NotGiven = NOT_GIVEN,
|
|
682
|
+
) -> AsyncPaginator[shared.RemoteFieldClass, AsyncPage[shared.RemoteFieldClass]]:
|
|
683
|
+
"""
|
|
684
|
+
Returns a list of `RemoteFieldClass` objects.
|
|
685
|
+
|
|
686
|
+
Args:
|
|
687
|
+
cursor: The pagination cursor value.
|
|
688
|
+
|
|
689
|
+
include_deleted_data: Whether to include data that was marked as deleted by third party webhooks.
|
|
690
|
+
|
|
691
|
+
include_remote_data: Whether to include the original data Merge fetched from the third-party to
|
|
692
|
+
produce these models.
|
|
693
|
+
|
|
694
|
+
include_remote_fields: Whether to include all remote fields, including fields that Merge did not map to
|
|
695
|
+
common models, in a normalized format.
|
|
696
|
+
|
|
697
|
+
page_size: Number of results to return per page.
|
|
698
|
+
|
|
699
|
+
extra_headers: Send extra headers
|
|
700
|
+
|
|
701
|
+
extra_query: Add additional query parameters to the request
|
|
702
|
+
|
|
703
|
+
extra_body: Add additional JSON properties to the request
|
|
704
|
+
|
|
705
|
+
timeout: Override the client-level default timeout for this request, in seconds
|
|
706
|
+
"""
|
|
707
|
+
return self._get_api_list(
|
|
708
|
+
"/crm/v1/contacts/remote-field-classes",
|
|
709
|
+
page=AsyncPage[shared.RemoteFieldClass],
|
|
710
|
+
options=make_request_options(
|
|
711
|
+
extra_headers=extra_headers,
|
|
712
|
+
extra_query=extra_query,
|
|
713
|
+
extra_body=extra_body,
|
|
714
|
+
timeout=timeout,
|
|
715
|
+
query=maybe_transform(
|
|
716
|
+
{
|
|
717
|
+
"cursor": cursor,
|
|
718
|
+
"include_deleted_data": include_deleted_data,
|
|
719
|
+
"include_remote_data": include_remote_data,
|
|
720
|
+
"include_remote_fields": include_remote_fields,
|
|
721
|
+
"page_size": page_size,
|
|
722
|
+
},
|
|
723
|
+
contact_list_remote_field_classes_params.ContactListRemoteFieldClassesParams,
|
|
724
|
+
),
|
|
725
|
+
),
|
|
726
|
+
model=shared.RemoteFieldClass,
|
|
727
|
+
)
|