diff --git a/.mock/definition/hris/dependents.yml b/.mock/definition/hris/dependents.yml index bab4360c..75cac5b7 100644 --- a/.mock/definition/hris/dependents.yml +++ b/.mock/definition/hris/dependents.yml @@ -25,6 +25,9 @@ service: cursor: type: optional docs: The pagination cursor value. + employee_id: + type: optional + docs: If provided, will only return dependents for this employee. include_deleted_data: type: optional docs: >- diff --git a/.mock/definition/hris/employees.yml b/.mock/definition/hris/employees.yml index df2cd00f..04d39059 100644 --- a/.mock/definition/hris/employees.yml +++ b/.mock/definition/hris/employees.yml @@ -1183,6 +1183,9 @@ service: display_full_name: type: optional docs: If provided, will only return employees with this display name. + employee_number: + type: optional + docs: If provided, will only return employees with this employee number. employment_status: type: optional docs: >- diff --git a/README.md b/README.md index ff213acf..e003f4a1 100644 --- a/README.md +++ b/README.md @@ -171,7 +171,7 @@ from merge import Merge client = Merge( ..., httpx_client=httpx.Client( - proxies="http://my.test.proxy.example.com", + proxy="http://my.test.proxy.example.com", transport=httpx.HTTPTransport(local_address="0.0.0.0"), ), ) @@ -233,3 +233,4 @@ while response.next is not None: + diff --git a/reference.md b/reference.md index 8c298141..dcbadc03 100644 --- a/reference.md +++ b/reference.md @@ -7934,8 +7934,8 @@ client.ats.webhook_receivers.create( -## Crm AccountDetails -
client.crm.account_details.retrieve() +## Filestorage AccountDetails +
client.filestorage.account_details.retrieve()
@@ -7968,7 +7968,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.account_details.retrieve() +client.filestorage.account_details.retrieve() ```
@@ -7996,8 +7996,8 @@ client.crm.account_details.retrieve()
-## Crm AccountToken -
client.crm.account_token.retrieve(...) +## Filestorage AccountToken +
client.filestorage.account_token.retrieve(...)
@@ -8030,7 +8030,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.account_token.retrieve( +client.filestorage.account_token.retrieve( public_token="public_token", ) @@ -8068,8 +8068,8 @@ client.crm.account_token.retrieve(
-## Crm Accounts -
client.crm.accounts.list(...) +## Filestorage AsyncPassthrough +
client.filestorage.async_passthrough.create(...)
@@ -8081,7 +8081,7 @@ client.crm.account_token.retrieve(
-Returns a list of `Account` objects. +Asynchronously pull data from an endpoint not currently supported by Merge.
@@ -8097,13 +8097,17 @@ Returns a list of `Account` objects. ```python from merge import Merge +from merge.resources.filestorage import DataPassthroughRequest, MethodEnum client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.accounts.list( - cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +client.filestorage.async_passthrough.create( + request=DataPassthroughRequest( + method=MethodEnum.GET, + path="/scooters", + ), ) ``` @@ -8120,111 +8124,7 @@ client.crm.accounts.list(
-**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]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/). - -
-
- -
-
- -**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. - -
-
- -
-
- -**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). - -
-
- -
-
- -**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:** `DataPassthroughRequest`
@@ -8244,7 +8144,7 @@ client.crm.accounts.list(
-
client.crm.accounts.create(...) +
client.filestorage.async_passthrough.retrieve(...)
@@ -8256,7 +8156,7 @@ client.crm.accounts.list(
-Creates an `Account` object with the given values. +Retrieves data from earlier async-passthrough POST request
@@ -8272,14 +8172,13 @@ Creates an `Account` object with the given values. ```python from merge 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(), +client.filestorage.async_passthrough.retrieve( + async_passthrough_receipt_id="async_passthrough_receipt_id", ) ``` @@ -8296,23 +8195,7 @@ client.crm.accounts.create(
-**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. +**async_passthrough_receipt_id:** `str`
@@ -8332,7 +8215,8 @@ client.crm.accounts.create(
-
client.crm.accounts.retrieve(...) +## Filestorage AuditTrail +
client.filestorage.audit_trail.list(...)
@@ -8344,7 +8228,7 @@ client.crm.accounts.create(
-Returns an `Account` object with the given `id`. +Gets a list of audit trail events.
@@ -8365,8 +8249,8 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.accounts.retrieve( - id="id", +client.filestorage.audit_trail.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", ) ``` @@ -8383,7 +8267,7 @@ client.crm.accounts.retrieve(
-**id:** `str` +**cursor:** `typing.Optional[str]` — The pagination cursor value.
@@ -8391,7 +8275,7 @@ client.crm.accounts.retrieve(
-**expand:** `typing.Optional[typing.Literal["owner"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. +**end_date:** `typing.Optional[str]` — If included, will only include audit trail events that occurred before this time
@@ -8399,7 +8283,7 @@ client.crm.accounts.retrieve(
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. +**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`, `REGENERATED_WEBHOOK_SIGNATURE`, `INVITED_USER`, `TWO_FACTOR_AUTH_ENABLED`, `TWO_FACTOR_AUTH_DISABLED`, `DELETED_LINKED_ACCOUNT`, `DELETED_ALL_COMMON_MODELS_FOR_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`, `CREATED_LINKED_ACCOUNT_COMMON_MODEL_OVERRIDE`, `CHANGED_LINKED_ACCOUNT_COMMON_MODEL_OVERRIDE`, `DELETED_LINKED_ACCOUNT_COMMON_MODEL_OVERRIDE`, `FORCED_LINKED_ACCOUNT_RESYNC`, `MUTED_ISSUE`, `GENERATED_MAGIC_LINK`, `ENABLED_MERGE_WEBHOOK`, `DISABLED_MERGE_WEBHOOK`, `MERGE_WEBHOOK_TARGET_CHANGED`, `END_USER_CREDENTIALS_ACCESSED`
@@ -8407,7 +8291,7 @@ client.crm.accounts.retrieve(
-**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.
@@ -8415,7 +8299,15 @@ client.crm.accounts.retrieve(
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). +**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.
@@ -8435,7 +8327,8 @@ client.crm.accounts.retrieve(
-
client.crm.accounts.partial_update(...) +## Filestorage AvailableActions +
client.filestorage.available_actions.retrieve()
@@ -8447,7 +8340,7 @@ client.crm.accounts.retrieve(
-Updates an `Account` object with the given `id`. +Returns a list of models and actions available for an account.
@@ -8463,16 +8356,12 @@ Updates an `Account` object with the given `id`. ```python from merge 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(), -) +client.filestorage.available_actions.retrieve() ``` @@ -8488,38 +8377,6 @@ client.crm.accounts.partial_update(
-**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.
@@ -8532,7 +8389,8 @@ client.crm.accounts.partial_update(
-
client.crm.accounts.meta_patch_retrieve(...) +## Filestorage Scopes +
client.filestorage.scopes.default_scopes_retrieve()
@@ -8544,7 +8402,7 @@ client.crm.accounts.partial_update(
-Returns metadata for `CRMAccount` PATCHs. +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/5950052-common-model-and-field-scopes).
@@ -8565,9 +8423,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.accounts.meta_patch_retrieve( - id="id", -) +client.filestorage.scopes.default_scopes_retrieve() ``` @@ -8583,14 +8439,6 @@ client.crm.accounts.meta_patch_retrieve(
-**id:** `str` - -
-
- -
-
- **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -8603,7 +8451,7 @@ client.crm.accounts.meta_patch_retrieve(
-
client.crm.accounts.meta_post_retrieve() +
client.filestorage.scopes.linked_account_scopes_retrieve()
@@ -8615,7 +8463,7 @@ client.crm.accounts.meta_patch_retrieve(
-Returns metadata for `CRMAccount` POSTs. +Get all available permissions for Merge Common Models and fields for a single Linked Account. [Learn more](https://help.merge.dev/en/articles/5950052-common-model-and-field-scopes).
@@ -8636,7 +8484,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.accounts.meta_post_retrieve() +client.filestorage.scopes.linked_account_scopes_retrieve() ``` @@ -8664,7 +8512,7 @@ client.crm.accounts.meta_post_retrieve()
-
client.crm.accounts.remote_field_classes_list(...) +
client.filestorage.scopes.linked_account_scopes_create(...)
@@ -8676,7 +8524,7 @@ client.crm.accounts.meta_post_retrieve()
-Returns a list of `RemoteFieldClass` objects. +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/5950052-common-model-and-field-scopes)
@@ -8692,13 +8540,42 @@ Returns a list of `RemoteFieldClass` objects. ```python from merge import Merge +from merge.resources.filestorage import ( + FieldPermissionDeserializerRequest, + IndividualCommonModelScopeDeserializerRequest, + ModelPermissionDeserializerRequest, +) client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.accounts.remote_field_classes_list( - cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +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, + ), + }, + field_permissions=FieldPermissionDeserializerRequest( + enabled_fields=["avatar", "home_location"], + disabled_fields=["work_location"], + ), + ), + IndividualCommonModelScopeDeserializerRequest( + model_name="Benefit", + model_permissions={ + "WRITE": ModelPermissionDeserializerRequest( + is_enabled=False, + ) + }, + ), + ], ) ``` @@ -8715,7 +8592,7 @@ client.crm.accounts.remote_field_classes_list(
-**cursor:** `typing.Optional[str]` — The pagination cursor value. +**common_models:** `typing.Sequence[IndividualCommonModelScopeDeserializerRequest]` — The common models you want to update the scopes for
@@ -8723,58 +8600,64 @@ client.crm.accounts.remote_field_classes_list(
-**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/). +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+ +
-
-
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. -
+
+## Filestorage DeleteAccount +
client.filestorage.delete_account.delete()
-**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. - -
-
+#### 📝 Description
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). - -
-
-
-**is_common_model_field:** `typing.Optional[bool]` — If provided, will only return remote field classes with this is_common_model_field value - +Delete a linked account. +
+
+#### 🔌 Usage +
-**is_custom:** `typing.Optional[bool]` — If provided, will only return remote fields classes with this is_custom value - -
-
-
-**page_size:** `typing.Optional[int]` — Number of results to return per page. - +```python +from merge import Merge + +client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.filestorage.delete_account.delete() + +```
+ + + +#### ⚙️ Parameters + +
+
@@ -8791,8 +8674,8 @@ client.crm.accounts.remote_field_classes_list(
-## Crm AsyncPassthrough -
client.crm.async_passthrough.create(...) +## Filestorage Drives +
client.filestorage.drives.list(...)
@@ -8804,7 +8687,7 @@ client.crm.accounts.remote_field_classes_list(
-Asynchronously pull data from an endpoint not currently supported by Merge. +Returns a list of `Drive` objects.
@@ -8820,17 +8703,13 @@ Asynchronously pull data from an endpoint not currently supported by Merge. ```python from merge 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", - ), +client.filestorage.drives.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", ) ``` @@ -8847,7 +8726,7 @@ client.crm.async_passthrough.create(
-**request:** `DataPassthroughRequest` +**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
@@ -8855,70 +8734,79 @@ client.crm.async_passthrough.create(
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. +**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
- -
+
+
+**cursor:** `typing.Optional[str]` — The pagination cursor value. +
-
-
client.crm.async_passthrough.retrieve(...)
-#### 📝 Description +**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/). + +
+
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. + +
+
+
-Retrieves data from earlier async-passthrough POST request -
-
+**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). + -#### 🔌 Usage -
+**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned. + +
+
+
-```python -from merge 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", -) - -``` +**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. +
-#### ⚙️ Parameters -
+**page_size:** `typing.Optional[int]` — Number of results to return per page. + +
+
+
-**async_passthrough_receipt_id:** `str` +**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
@@ -8938,8 +8826,7 @@ client.crm.async_passthrough.retrieve(
-## Crm AuditTrail -
client.crm.audit_trail.list(...) +
client.filestorage.drives.retrieve(...)
@@ -8951,7 +8838,7 @@ client.crm.async_passthrough.retrieve(
-Gets a list of audit trail events. +Returns a `Drive` object with the given `id`.
@@ -8972,8 +8859,8 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.audit_trail.list( - cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +client.filestorage.drives.retrieve( + id="id", ) ``` @@ -8990,31 +8877,7 @@ client.crm.audit_trail.list(
-**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`, `REGENERATED_WEBHOOK_SIGNATURE`, `INVITED_USER`, `TWO_FACTOR_AUTH_ENABLED`, `TWO_FACTOR_AUTH_DISABLED`, `DELETED_LINKED_ACCOUNT`, `DELETED_ALL_COMMON_MODELS_FOR_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`, `CREATED_LINKED_ACCOUNT_COMMON_MODEL_OVERRIDE`, `CHANGED_LINKED_ACCOUNT_COMMON_MODEL_OVERRIDE`, `DELETED_LINKED_ACCOUNT_COMMON_MODEL_OVERRIDE`, `FORCED_LINKED_ACCOUNT_RESYNC`, `MUTED_ISSUE`, `GENERATED_MAGIC_LINK`, `ENABLED_MERGE_WEBHOOK`, `DISABLED_MERGE_WEBHOOK`, `MERGE_WEBHOOK_TARGET_CHANGED`, `END_USER_CREDENTIALS_ACCESSED` - -
-
- -
-
- -**page_size:** `typing.Optional[int]` — Number of results to return per page. +**id:** `str`
@@ -9022,7 +8885,7 @@ client.crm.audit_trail.list(
-**start_date:** `typing.Optional[str]` — If included, will only include audit trail events that occurred after this time +**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -9030,7 +8893,7 @@ client.crm.audit_trail.list(
-**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. +**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -9050,8 +8913,8 @@ client.crm.audit_trail.list(
-## Crm AvailableActions -
client.crm.available_actions.retrieve() +## Filestorage FieldMapping +
client.filestorage.field_mapping.field_mappings_retrieve(...)
@@ -9063,7 +8926,7 @@ client.crm.audit_trail.list(
-Returns a list of models and actions available for an account. +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/).
@@ -9084,7 +8947,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.available_actions.retrieve() +client.filestorage.field_mapping.field_mappings_retrieve() ``` @@ -9100,6 +8963,14 @@ client.crm.available_actions.retrieve()
+**exclude_remote_field_metadata:** `typing.Optional[bool]` — If `true`, remote fields metadata is excluded from each field mapping instance (i.e. `remote_fields.remote_key_name` and `remote_fields.schema` will be null). This will increase the speed of the request since these fields require some calculations. + +
+
+ +
+
+ **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -9112,8 +8983,7 @@ client.crm.available_actions.retrieve()
-## Crm Contacts -
client.crm.contacts.list(...) +
client.filestorage.field_mapping.field_mappings_create(...)
@@ -9125,7 +8995,7 @@ client.crm.available_actions.retrieve()
-Returns a list of `Contact` objects. +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.
@@ -9146,8 +9016,13 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.contacts.list( - cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +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", ) ``` @@ -9164,7 +9039,7 @@ client.crm.contacts.list(
-**account_id:** `typing.Optional[str]` — If provided, will only return contacts with this account. +**target_field_name:** `str` — The name of the target field you want this remote field to map to.
@@ -9172,7 +9047,7 @@ client.crm.contacts.list(
-**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime. +**target_field_description:** `str` — The description of the target field you want this remote field to map to.
@@ -9180,7 +9055,7 @@ client.crm.contacts.list(
-**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime. +**remote_field_traversal_path:** `typing.Sequence[typing.Optional[typing.Any]]` — The field traversal path of the remote field listed when you hit the GET /remote-fields endpoint.
@@ -9188,7 +9063,7 @@ client.crm.contacts.list(
-**cursor:** `typing.Optional[str]` — The pagination cursor value. +**remote_method:** `str` — The method of the remote endpoint where the remote field is coming from.
@@ -9196,7 +9071,7 @@ client.crm.contacts.list(
-**email_addresses:** `typing.Optional[str]` — If provided, will only return contacts matching the email addresses; multiple email_addresses can be separated by commas. +**remote_url_path:** `str` — The path of the remote endpoint where the remote field is coming from.
@@ -9204,7 +9079,7 @@ client.crm.contacts.list(
-**expand:** `typing.Optional[ContactsListRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. +**common_model_name:** `str` — The name of the Common Model that the remote field corresponds to in a given category.
@@ -9212,7 +9087,7 @@ client.crm.contacts.list(
-**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/). +**exclude_remote_field_metadata:** `typing.Optional[bool]` — If `true`, remote fields metadata is excluded from each field mapping instance (i.e. `remote_fields.remote_key_name` and `remote_fields.schema` will be null). This will increase the speed of the request since these fields require some calculations.
@@ -9220,63 +9095,70 @@ client.crm.contacts.list(
-**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.
+ +
-
-
-**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. -
+
+
client.filestorage.field_mapping.field_mappings_destroy(...)
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). - -
-
+#### 📝 Description
-**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. - +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 +
-**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. - +```python +from merge 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 +
-**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object. +
+
+ +**field_mapping_id:** `str`
@@ -9296,7 +9178,7 @@ client.crm.contacts.list(
-
client.crm.contacts.create(...) +
client.filestorage.field_mapping.field_mappings_partial_update(...)
@@ -9308,7 +9190,7 @@ client.crm.contacts.list(
-Creates a `Contact` object with the given values. +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.
@@ -9324,14 +9206,13 @@ Creates a `Contact` object with the given values. ```python from merge 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(), +client.filestorage.field_mapping.field_mappings_partial_update( + field_mapping_id="field_mapping_id", ) ``` @@ -9348,7 +9229,7 @@ client.crm.contacts.create(
-**model:** `ContactRequest` +**field_mapping_id:** `str`
@@ -9356,7 +9237,7 @@ client.crm.contacts.create(
-**is_debug_mode:** `typing.Optional[bool]` — Whether to include debug fields (such as log file links) in the response. +**remote_field_traversal_path:** `typing.Optional[typing.Sequence[typing.Optional[typing.Any]]]` — The field traversal path of the remote field listed when you hit the GET /remote-fields endpoint.
@@ -9364,7 +9245,15 @@ client.crm.contacts.create(
-**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously. +**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.
@@ -9384,7 +9273,7 @@ client.crm.contacts.create(
-
client.crm.contacts.retrieve(...) +
client.filestorage.field_mapping.remote_fields_retrieve(...)
@@ -9396,7 +9285,7 @@ client.crm.contacts.create(
-Returns a `Contact` object with the given `id`. +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/).
@@ -9417,9 +9306,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.contacts.retrieve( - id="id", -) +client.filestorage.field_mapping.remote_fields_retrieve() ``` @@ -9435,7 +9322,7 @@ client.crm.contacts.retrieve(
-**id:** `str` +**common_models:** `typing.Optional[str]` — A comma seperated list of Common Model names. If included, will only return Remote Fields for those Common Models.
@@ -9443,7 +9330,7 @@ client.crm.contacts.retrieve(
-**expand:** `typing.Optional[ContactsRetrieveRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. +**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.
@@ -9451,27 +9338,64 @@ client.crm.contacts.retrieve(
-**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.target_fields_retrieve()
-**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. - +#### 📝 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 +
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). - +
+
+ +```python +from merge import Merge + +client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.filestorage.field_mapping.target_fields_retrieve() + +``` +
+
+#### ⚙️ Parameters + +
+
+
@@ -9487,7 +9411,8 @@ client.crm.contacts.retrieve(
-
client.crm.contacts.partial_update(...) +## Filestorage Files +
client.filestorage.files.list(...)
@@ -9499,7 +9424,7 @@ client.crm.contacts.retrieve(
-Updates a `Contact` object with the given `id`. +Returns a list of `File` objects.
@@ -9515,15 +9440,13 @@ Updates a `Contact` object with the given `id`. ```python from merge 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(), +client.filestorage.files.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", ) ``` @@ -9540,7 +9463,7 @@ client.crm.contacts.partial_update(
-**id:** `str` +**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
@@ -9548,7 +9471,7 @@ client.crm.contacts.partial_update(
-**model:** `PatchedContactRequest` +**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
@@ -9556,7 +9479,7 @@ client.crm.contacts.partial_update(
-**is_debug_mode:** `typing.Optional[bool]` — Whether to include debug fields (such as log file links) in the response. +**cursor:** `typing.Optional[str]` — The pagination cursor value.
@@ -9564,7 +9487,7 @@ client.crm.contacts.partial_update(
-**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously. +**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.
@@ -9572,74 +9495,103 @@ client.crm.contacts.partial_update(
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. +**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]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/). +
-
-
client.crm.contacts.ignore_create(...)
-#### 📝 Description +**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. + +
+
+**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). + +
+
+
-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. +**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. +
-#### 🔌 Usage -
+**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned. + +
+
+
-```python -from merge import Merge -from merge.resources.crm import IgnoreCommonModelRequest, ReasonEnum +**name:** `typing.Optional[str]` — If provided, will only return files with this name. This performs an exact match. + +
+
-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, - ), -) +
+
-``` +**order_by:** `typing.Optional[FilesListRequestOrderBy]` — Overrides the default ordering for this endpoint. Possible values include: created_at, -created_at, modified_at, -modified_at. +
+ +
+
+ +**page_size:** `typing.Optional[int]` — Number of results to return per page. +
-#### ⚙️ Parameters -
+**remote_created_after:** `typing.Optional[dt.datetime]` — If provided, will only return files created in the third party platform after this datetime. + +
+
+
-**model_id:** `str` +**remote_created_before:** `typing.Optional[dt.datetime]` — If provided, will only return files created in the third party platform before this datetime.
@@ -9647,7 +9599,7 @@ client.crm.contacts.ignore_create(
-**request:** `IgnoreCommonModelRequest` +**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
@@ -9667,7 +9619,7 @@ client.crm.contacts.ignore_create(
-
client.crm.contacts.meta_patch_retrieve(...) +
client.filestorage.files.create(...)
@@ -9679,7 +9631,7 @@ client.crm.contacts.ignore_create(
-Returns metadata for `CRMContact` PATCHs. +Creates a `File` object with the given values.
@@ -9695,13 +9647,14 @@ Returns metadata for `CRMContact` PATCHs. ```python from merge import Merge +from merge.resources.filestorage import FileRequest client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.contacts.meta_patch_retrieve( - id="id", +client.filestorage.files.create( + model=FileRequest(), ) ``` @@ -9718,7 +9671,23 @@ client.crm.contacts.meta_patch_retrieve(
-**id:** `str` +**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.
@@ -9738,7 +9707,7 @@ client.crm.contacts.meta_patch_retrieve(
-
client.crm.contacts.meta_post_retrieve() +
client.filestorage.files.retrieve(...)
@@ -9750,7 +9719,7 @@ client.crm.contacts.meta_patch_retrieve(
-Returns metadata for `CRMContact` POSTs. +Returns a `File` object with the given `id`.
@@ -9771,7 +9740,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.contacts.meta_post_retrieve() +client.filestorage.files.retrieve( + id="id", +) ``` @@ -9787,6 +9758,38 @@ client.crm.contacts.meta_post_retrieve()
+**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. + +
+
+ +
+
+ +**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). + +
+
+ +
+
+ **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -9799,7 +9802,7 @@ client.crm.contacts.meta_post_retrieve()
-
client.crm.contacts.remote_field_classes_list(...) +
client.filestorage.files.download_request_meta_retrieve(...)
@@ -9811,7 +9814,7 @@ client.crm.contacts.meta_post_retrieve()
-Returns a list of `RemoteFieldClass` objects. +Returns metadata to construct an authenticated file download request for a singular file, allowing you to download file directly from the third-party.
@@ -9832,8 +9835,8 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.contacts.remote_field_classes_list( - cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +client.filestorage.files.download_request_meta_retrieve( + id="id", ) ``` @@ -9850,55 +9853,7 @@ client.crm.contacts.remote_field_classes_list(
-**cursor:** `typing.Optional[str]` — The pagination cursor value. - -
-
- -
-
- -**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/). - -
-
- -
-
- -**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. - -
-
- -
-
- -**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). - -
-
- -
-
- -**is_common_model_field:** `typing.Optional[bool]` — If provided, will only return remote field classes with this is_common_model_field value - -
-
- -
-
- -**is_custom:** `typing.Optional[bool]` — If provided, will only return remote fields classes with this is_custom value +**id:** `str`
@@ -9906,7 +9861,7 @@ client.crm.contacts.remote_field_classes_list(
-**page_size:** `typing.Optional[int]` — Number of results to return per page. +**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.
@@ -9926,8 +9881,7 @@ client.crm.contacts.remote_field_classes_list(
-## Crm CustomObjectClasses -
client.crm.custom_object_classes.list(...) +
client.filestorage.files.download_request_meta_list(...)
@@ -9939,7 +9893,7 @@ client.crm.contacts.remote_field_classes_list(
-Returns a list of `CustomObjectClass` objects. +Returns metadata to construct authenticated file download requests, allowing you to download files directly from the third-party.
@@ -9960,7 +9914,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.custom_object_classes.list( +client.filestorage.files.download_request_meta_list( cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", ) @@ -9978,7 +9932,7 @@ client.crm.custom_object_classes.list(
-**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime. +**created_after:** `typing.Optional[str]` — If provided, will only return objects created after this datetime.
@@ -9986,7 +9940,7 @@ client.crm.custom_object_classes.list(
-**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime. +**created_before:** `typing.Optional[str]` — If provided, will only return objects created before this datetime.
@@ -10002,7 +9956,7 @@ client.crm.custom_object_classes.list(
-**expand:** `typing.Optional[typing.Literal["fields"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. +**ids:** `typing.Optional[typing.Union[str, typing.Sequence[str]]]` — If provided, will only return objects with the given IDs. Comma-separated list of strings.
@@ -10018,7 +9972,7 @@ client.crm.custom_object_classes.list(
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. +**mime_types:** `typing.Optional[str]` — A comma-separated list of preferred MIME types in order of priority. If supported by the third-party provider, the file(s) will be returned in the first supported MIME type from the list. The default MIME type is PDF. To see supported MIME types by file type, refer to our export format help center article.
@@ -10026,7 +9980,7 @@ client.crm.custom_object_classes.list(
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). +**modified_after:** `typing.Optional[str]` — If provided, will only return objects modified after this datetime.
@@ -10034,7 +9988,7 @@ client.crm.custom_object_classes.list(
-**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned. +**modified_before:** `typing.Optional[str]` — If provided, will only return objects modified before this datetime.
@@ -10042,7 +9996,7 @@ client.crm.custom_object_classes.list(
-**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned. +**order_by:** `typing.Optional[FilesDownloadRequestMetaListRequestOrderBy]` — Overrides the default ordering for this endpoint. Possible values include: created_at, -created_at, modified_at, -modified_at.
@@ -10058,14 +10012,6 @@ client.crm.custom_object_classes.list(
-**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object. - -
-
- -
-
- **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -10078,7 +10024,7 @@ client.crm.custom_object_classes.list(
-
client.crm.custom_object_classes.retrieve(...) +
client.filestorage.files.meta_post_retrieve()
@@ -10090,7 +10036,7 @@ client.crm.custom_object_classes.list(
-Returns a `CustomObjectClass` object with the given `id`. +Returns metadata for `FileStorageFile` POSTs.
@@ -10111,9 +10057,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.custom_object_classes.retrieve( - id="id", -) +client.filestorage.files.meta_post_retrieve() ``` @@ -10129,38 +10073,6 @@ client.crm.custom_object_classes.retrieve(
-**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. - -
-
- -
-
- -**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). - -
-
- -
-
- **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -10173,8 +10085,8 @@ client.crm.custom_object_classes.retrieve(
-## Crm AssociationTypes -
client.crm.association_types.custom_object_classes_association_types_list(...) +## Filestorage Folders +
client.filestorage.folders.list(...)
@@ -10186,7 +10098,7 @@ client.crm.custom_object_classes.retrieve(
-Returns a list of `AssociationType` objects. +Returns a list of `Folder` objects.
@@ -10207,8 +10119,7 @@ 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", +client.filestorage.folders.list( cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", ) @@ -10226,7 +10137,7 @@ client.crm.association_types.custom_object_classes_association_types_list(
-**custom_object_class_id:** `str` +**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
@@ -10234,7 +10145,7 @@ client.crm.association_types.custom_object_classes_association_types_list(
-**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.
@@ -10242,7 +10153,7 @@ client.crm.association_types.custom_object_classes_association_types_list(
-**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime. +**cursor:** `typing.Optional[str]` — The pagination cursor value.
@@ -10250,7 +10161,7 @@ client.crm.association_types.custom_object_classes_association_types_list(
-**cursor:** `typing.Optional[str]` — The pagination cursor value. +**drive_id:** `typing.Optional[str]` — If provided, will only return folders in this drive.
@@ -10258,7 +10169,7 @@ client.crm.association_types.custom_object_classes_association_types_list(
-**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. +**expand:** `typing.Optional[FoldersListRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -10306,6 +10217,14 @@ client.crm.association_types.custom_object_classes_association_types_list(
+**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.
@@ -10314,6 +10233,14 @@ client.crm.association_types.custom_object_classes_association_types_list(
+**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.
@@ -10334,7 +10261,7 @@ client.crm.association_types.custom_object_classes_association_types_list(
-
client.crm.association_types.custom_object_classes_association_types_create(...) +
client.filestorage.folders.create(...)
@@ -10346,7 +10273,7 @@ client.crm.association_types.custom_object_classes_association_types_list(
-Creates an `AssociationType` object with the given values. +Creates a `Folder` object with the given values.
@@ -10362,31 +10289,14 @@ Creates an `AssociationType` object with the given values. ```python from merge import Merge -from merge.resources.crm import ( - AssociationTypeRequestRequest, - ObjectClassDescriptionRequest, - OriginTypeEnum, -) +from merge.resources.filestorage import FolderRequest 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", - ), +client.filestorage.folders.create( + model=FolderRequest(), ) ``` @@ -10403,15 +10313,7 @@ client.crm.association_types.custom_object_classes_association_types_create(
-**custom_object_class_id:** `str` - -
-
- -
-
- -**model:** `AssociationTypeRequestRequest` +**model:** `FolderRequest`
@@ -10447,7 +10349,7 @@ client.crm.association_types.custom_object_classes_association_types_create(
-
client.crm.association_types.custom_object_classes_association_types_retrieve(...) +
client.filestorage.folders.retrieve(...)
@@ -10459,7 +10361,7 @@ client.crm.association_types.custom_object_classes_association_types_create(
-Returns an `AssociationType` object with the given `id`. +Returns a `Folder` object with the given `id`.
@@ -10480,8 +10382,7 @@ 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", +client.filestorage.folders.retrieve( id="id", ) @@ -10499,14 +10400,6 @@ client.crm.association_types.custom_object_classes_association_types_retrieve(
-**custom_object_class_id:** `str` - -
-
- -
-
- **id:** `str`
@@ -10515,7 +10408,7 @@ client.crm.association_types.custom_object_classes_association_types_retrieve(
-**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. +**expand:** `typing.Optional[FoldersRetrieveRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -10551,7 +10444,7 @@ client.crm.association_types.custom_object_classes_association_types_retrieve(
-
client.crm.association_types.custom_object_classes_association_types_meta_post_retrieve(...) +
client.filestorage.folders.meta_post_retrieve()
@@ -10563,7 +10456,7 @@ client.crm.association_types.custom_object_classes_association_types_retrieve(
-Returns metadata for `CRMAssociationType` POSTs. +Returns metadata for `FileStorageFolder` POSTs.
@@ -10584,8 +10477,70 @@ 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", +client.filestorage.folders.meta_post_retrieve() + +``` + +
+ + + +#### ⚙️ Parameters + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + + + +
+ +## Filestorage GenerateKey +
client.filestorage.generate_key.create(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Create a remote key. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from merge import Merge + +client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.filestorage.generate_key.create( + name="Remote Deployment Key 1", ) ``` @@ -10602,7 +10557,7 @@ client.crm.association_types.custom_object_classes_association_types_meta_post_r
-**custom_object_class_id:** `str` +**name:** `str` — The name of the remote key
@@ -10622,8 +10577,8 @@ client.crm.association_types.custom_object_classes_association_types_meta_post_r
-## Crm CustomObjects -
client.crm.custom_objects.custom_object_classes_custom_objects_list(...) +## Filestorage Groups +
client.filestorage.groups.list(...)
@@ -10635,7 +10590,7 @@ client.crm.association_types.custom_object_classes_association_types_meta_post_r
-Returns a list of `CustomObject` objects. +Returns a list of `Group` objects.
@@ -10656,8 +10611,7 @@ 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", +client.filestorage.groups.list( cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", ) @@ -10675,14 +10629,6 @@ client.crm.custom_objects.custom_object_classes_custom_objects_list(
-**custom_object_class_id:** `str` - -
-
- -
-
- **created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
@@ -10707,7 +10653,7 @@ client.crm.custom_objects.custom_object_classes_custom_objects_list(
-**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/). +**expand:** `typing.Optional[typing.Literal["child_groups"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -10715,7 +10661,7 @@ client.crm.custom_objects.custom_object_classes_custom_objects_list(
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. +**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
@@ -10723,7 +10669,7 @@ client.crm.custom_objects.custom_object_classes_custom_objects_list(
-**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. +**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -10783,7 +10729,7 @@ client.crm.custom_objects.custom_object_classes_custom_objects_list(
-
client.crm.custom_objects.custom_object_classes_custom_objects_create(...) +
client.filestorage.groups.retrieve(...)
@@ -10795,7 +10741,7 @@ client.crm.custom_objects.custom_object_classes_custom_objects_list(
-Creates a `CustomObject` object with the given values. +Returns a `Group` object with the given `id`.
@@ -10811,17 +10757,13 @@ Creates a `CustomObject` object with the given values. ```python from merge 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"}, - ), +client.filestorage.groups.retrieve( + id="id", ) ``` @@ -10838,7 +10780,7 @@ client.crm.custom_objects.custom_object_classes_custom_objects_create(
-**custom_object_class_id:** `str` +**id:** `str`
@@ -10846,7 +10788,7 @@ client.crm.custom_objects.custom_object_classes_custom_objects_create(
-**model:** `CustomObjectRequest` +**expand:** `typing.Optional[typing.Literal["child_groups"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -10854,7 +10796,7 @@ client.crm.custom_objects.custom_object_classes_custom_objects_create(
-**is_debug_mode:** `typing.Optional[bool]` — Whether to include debug fields (such as log file links) in the response. +**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -10862,7 +10804,7 @@ client.crm.custom_objects.custom_object_classes_custom_objects_create(
-**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously. +**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -10882,7 +10824,8 @@ client.crm.custom_objects.custom_object_classes_custom_objects_create(
-
client.crm.custom_objects.custom_object_classes_custom_objects_retrieve(...) +## Filestorage Issues +
client.filestorage.issues.list(...)
@@ -10894,7 +10837,7 @@ client.crm.custom_objects.custom_object_classes_custom_objects_create(
-Returns a `CustomObject` object with the given `id`. +Gets all issues for Organization.
@@ -10915,9 +10858,8 @@ 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", +client.filestorage.issues.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", ) ``` @@ -10934,7 +10876,7 @@ client.crm.custom_objects.custom_object_classes_custom_objects_retrieve(
-**custom_object_class_id:** `str` +**account_token:** `typing.Optional[str]`
@@ -10942,7 +10884,7 @@ client.crm.custom_objects.custom_object_classes_custom_objects_retrieve(
-**id:** `str` +**cursor:** `typing.Optional[str]` — The pagination cursor value.
@@ -10950,7 +10892,7 @@ client.crm.custom_objects.custom_object_classes_custom_objects_retrieve(
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. +**end_date:** `typing.Optional[str]` — If included, will only include issues whose most recent action occurred before this time
@@ -10958,7 +10900,7 @@ client.crm.custom_objects.custom_object_classes_custom_objects_retrieve(
-**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. +**end_user_organization_name:** `typing.Optional[str]`
@@ -10966,7 +10908,84 @@ client.crm.custom_objects.custom_object_classes_custom_objects_retrieve(
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). +**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. + +
+
+ +
+
+ +**linked_account_id:** `typing.Optional[str]` — If provided, will only include issues pertaining to the linked account passed in. + +
+
+ +
+
+ +**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
@@ -10986,7 +11005,7 @@ client.crm.custom_objects.custom_object_classes_custom_objects_retrieve(
-
client.crm.custom_objects.custom_object_classes_custom_objects_meta_post_retrieve(...) +
client.filestorage.issues.retrieve(...)
@@ -10998,7 +11017,7 @@ client.crm.custom_objects.custom_object_classes_custom_objects_retrieve(
-Returns metadata for `CRMCustomObject` POSTs. +Get a specific issue.
@@ -11019,8 +11038,8 @@ 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", +client.filestorage.issues.retrieve( + id="id", ) ``` @@ -11037,7 +11056,7 @@ client.crm.custom_objects.custom_object_classes_custom_objects_meta_post_retriev
-**custom_object_class_id:** `str` +**id:** `str`
@@ -11057,7 +11076,8 @@ client.crm.custom_objects.custom_object_classes_custom_objects_meta_post_retriev
-
client.crm.custom_objects.custom_object_classes_custom_objects_remote_field_classes_list(...) +## Filestorage LinkToken +
client.filestorage.link_token.create(...)
@@ -11069,7 +11089,7 @@ client.crm.custom_objects.custom_object_classes_custom_objects_meta_post_retriev
-Returns a list of `RemoteFieldClass` objects. +Creates a link token to be used when linking a new end user.
@@ -11085,13 +11105,17 @@ Returns a list of `RemoteFieldClass` objects. ```python from merge import Merge +from merge.resources.filestorage import CategoriesEnum client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.custom_objects.custom_object_classes_custom_objects_remote_field_classes_list( - cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +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], ) ``` @@ -11108,7 +11132,7 @@ client.crm.custom_objects.custom_object_classes_custom_objects_remote_field_clas
-**cursor:** `typing.Optional[str]` — The pagination cursor value. +**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.
@@ -11116,7 +11140,7 @@ client.crm.custom_objects.custom_object_classes_custom_objects_remote_field_clas
-**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/). +**end_user_organization_name:** `str` — Your end user's organization.
@@ -11124,7 +11148,7 @@ client.crm.custom_objects.custom_object_classes_custom_objects_remote_field_clas
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. +**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.
@@ -11132,7 +11156,7 @@ client.crm.custom_objects.custom_object_classes_custom_objects_remote_field_clas
-**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. +**categories:** `typing.Sequence[CategoriesEnum]` — The integration categories to show in Merge Link.
@@ -11140,7 +11164,7 @@ client.crm.custom_objects.custom_object_classes_custom_objects_remote_field_clas
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). +**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/.
@@ -11148,7 +11172,7 @@ client.crm.custom_objects.custom_object_classes_custom_objects_remote_field_clas
-**is_common_model_field:** `typing.Optional[bool]` — If provided, will only return remote field classes with this is_common_model_field value +**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.
@@ -11156,7 +11180,7 @@ client.crm.custom_objects.custom_object_classes_custom_objects_remote_field_clas
-**is_custom:** `typing.Optional[bool]` — If provided, will only return remote fields classes with this is_custom value +**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.
@@ -11164,7 +11188,7 @@ client.crm.custom_objects.custom_object_classes_custom_objects_remote_field_clas
-**page_size:** `typing.Optional[int]` — Number of results to return per page. +**hide_admin_magic_link:** `typing.Optional[bool]` — Whether to generate a Magic Link URL on the Admin Needed screen during the linking flow. Defaults to false. For more information on Magic Link, see https://merge.dev/blog/integrations-fast-say-hello-to-magic-link.
@@ -11172,20 +11196,72 @@ client.crm.custom_objects.custom_object_classes_custom_objects_remote_field_clas
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. +**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[LanguageEnum]` + +The following subset of IETF language tags can be used to configure localization. + +* `en` - en +* `de` - de + +
+
+ +
+
+ +**are_syncs_disabled:** `typing.Optional[bool]` — The boolean that indicates whether initial, periodic, and force syncs will be disabled. + +
+
+ +
+
+ +**integration_specific_config:** `typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]]` — A JSON object containing integration-specific configuration options. + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+ +
-## Crm Associations -
client.crm.associations.custom_object_classes_custom_objects_associations_list(...) +## Filestorage LinkedAccounts +
client.filestorage.linked_accounts.list(...)
@@ -11197,7 +11273,7 @@ client.crm.custom_objects.custom_object_classes_custom_objects_remote_field_clas
-Returns a list of `Association` objects. +List linked accounts for your organization.
@@ -11218,9 +11294,7 @@ 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", +client.filestorage.linked_accounts.list( cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", ) @@ -11238,15 +11312,17 @@ client.crm.associations.custom_object_classes_custom_objects_associations_list(
-**custom_object_class_id:** `str` - -
-
+**category:** `typing.Optional[LinkedAccountsListRequestCategory]` -
-
+Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing` -**object_id:** `str` +* `hris` - hris +* `ats` - ats +* `accounting` - accounting +* `ticketing` - ticketing +* `crm` - crm +* `mktg` - mktg +* `filestorage` - filestorage
@@ -11254,7 +11330,7 @@ client.crm.associations.custom_object_classes_custom_objects_associations_list(
-**association_type_id:** `typing.Optional[str]` — If provided, will only return opportunities with this association_type. +**cursor:** `typing.Optional[str]` — The pagination cursor value.
@@ -11262,7 +11338,7 @@ client.crm.associations.custom_object_classes_custom_objects_associations_list(
-**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime. +**end_user_email_address:** `typing.Optional[str]` — If provided, will only return linked accounts associated with the given email address.
@@ -11270,7 +11346,7 @@ client.crm.associations.custom_object_classes_custom_objects_associations_list(
-**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime. +**end_user_organization_name:** `typing.Optional[str]` — If provided, will only return linked accounts associated with the given organization name.
@@ -11278,7 +11354,7 @@ client.crm.associations.custom_object_classes_custom_objects_associations_list(
-**cursor:** `typing.Optional[str]` — The pagination cursor value. +**end_user_origin_id:** `typing.Optional[str]` — If provided, will only return linked accounts associated with the given origin ID.
@@ -11286,7 +11362,7 @@ client.crm.associations.custom_object_classes_custom_objects_associations_list(
-**expand:** `typing.Optional[typing.Literal["association_type"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. +**end_user_origin_ids:** `typing.Optional[str]` — Comma-separated list of EndUser origin IDs, making it possible to specify multiple EndUsers at once.
@@ -11294,7 +11370,7 @@ client.crm.associations.custom_object_classes_custom_objects_associations_list(
-**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/). +**id:** `typing.Optional[str]`
@@ -11302,7 +11378,7 @@ client.crm.associations.custom_object_classes_custom_objects_associations_list(
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. +**ids:** `typing.Optional[str]` — Comma-separated list of LinkedAccount IDs, making it possible to specify multiple LinkedAccounts at once.
@@ -11310,7 +11386,7 @@ client.crm.associations.custom_object_classes_custom_objects_associations_list(
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). +**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.
@@ -11318,7 +11394,7 @@ client.crm.associations.custom_object_classes_custom_objects_associations_list(
-**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned. +**integration_name:** `typing.Optional[str]` — If provided, will only return linked accounts associated with the given integration name.
@@ -11326,7 +11402,7 @@ client.crm.associations.custom_object_classes_custom_objects_associations_list(
-**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned. +**is_test_account:** `typing.Optional[str]` — If included, will only include test linked accounts. If not included, will only include non-test linked accounts.
@@ -11342,7 +11418,7 @@ client.crm.associations.custom_object_classes_custom_objects_associations_list(
-**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object. +**status:** `typing.Optional[str]` — Filter by status. Options: `COMPLETE`, `IDLE`, `INCOMPLETE`, `RELINK_NEEDED`
@@ -11362,7 +11438,8 @@ client.crm.associations.custom_object_classes_custom_objects_associations_list(
-
client.crm.associations.custom_object_classes_custom_objects_associations_update(...) +## Filestorage Passthrough +
client.filestorage.passthrough.create(...)
@@ -11374,7 +11451,7 @@ client.crm.associations.custom_object_classes_custom_objects_associations_list(
-Creates an Association between `source_object_id` and `target_object_id` of type `association_type_id`. +Pull data from an endpoint not currently supported by Merge.
@@ -11390,17 +11467,17 @@ Creates an Association between `source_object_id` and `target_object_id` of type ```python from merge import Merge +from merge.resources.filestorage import DataPassthroughRequest, MethodEnum 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", +client.filestorage.passthrough.create( + request=DataPassthroughRequest( + method=MethodEnum.GET, + path="/scooters", + ), ) ``` @@ -11417,7 +11494,7 @@ client.crm.associations.custom_object_classes_custom_objects_associations_update
-**association_type_id:** `str` +**request:** `DataPassthroughRequest`
@@ -11425,47 +11502,71 @@ client.crm.associations.custom_object_classes_custom_objects_associations_update
-**source_class_id:** `str` +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+ +
-
-
-**source_object_id:** `str` -
+
+## Filestorage RegenerateKey +
client.filestorage.regenerate_key.create(...)
-**target_class_id:** `str` - -
-
+#### 📝 Description
-**target_object_id:** `str` - +
+
+ +Exchange remote keys. +
+
+#### 🔌 Usage +
-**is_debug_mode:** `typing.Optional[bool]` — Whether to include debug fields (such as log file links) in the response. - +
+
+ +```python +from merge 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 +
-**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously. +
+
+ +**name:** `str` — The name of the remote key
@@ -11485,8 +11586,8 @@ client.crm.associations.custom_object_classes_custom_objects_associations_update
-## Crm Scopes -
client.crm.scopes.default_scopes_retrieve() +## Filestorage SyncStatus +
client.filestorage.sync_status.list(...)
@@ -11498,7 +11599,7 @@ client.crm.associations.custom_object_classes_custom_objects_associations_update
-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/5950052-common-model-and-field-scopes). +Get sync status for the current sync and the most recently finished sync. `last_sync_start` represents the most recent time any sync began. `last_sync_finished` represents the most recent time any sync completed. These timestamps may correspond to different sync instances which may result in a sync start time being later than a separate sync completed time. To ensure you are retrieving the latest available data reference the `last_sync_finished` timestamp where `last_sync_result` is `DONE`. Possible values for `status` and `last_sync_result` are `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).
@@ -11519,7 +11620,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.scopes.default_scopes_retrieve() +client.filestorage.sync_status.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -11535,6 +11638,22 @@ client.crm.scopes.default_scopes_retrieve()
+**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.
@@ -11547,7 +11666,8 @@ client.crm.scopes.default_scopes_retrieve()
-
client.crm.scopes.linked_account_scopes_retrieve() +## Filestorage ForceResync +
client.filestorage.force_resync.sync_status_resync_create()
@@ -11559,7 +11679,7 @@ client.crm.scopes.default_scopes_retrieve()
-Get all available permissions for Merge Common Models and fields for a single Linked Account. [Learn more](https://help.merge.dev/en/articles/5950052-common-model-and-field-scopes). +Force re-sync of all models. This endpoint is available for monthly, quarterly, and highest sync frequency customers on the Professional or Enterprise plans. Doing so will consume a sync credit for the relevant linked account. Force re-syncs can also be triggered manually in the Merge Dashboard and is available for all customers.
@@ -11580,7 +11700,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.scopes.linked_account_scopes_retrieve() +client.filestorage.force_resync.sync_status_resync_create() ``` @@ -11608,7 +11728,8 @@ client.crm.scopes.linked_account_scopes_retrieve()
-
client.crm.scopes.linked_account_scopes_create(...) +## Filestorage Users +
client.filestorage.users.list(...)
@@ -11620,7 +11741,7 @@ client.crm.scopes.linked_account_scopes_retrieve()
-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/5950052-common-model-and-field-scopes) +Returns a list of `User` objects.
@@ -11636,42 +11757,13 @@ Update permissions for any Common Model or field for a single Linked Account. An ```python from merge import Merge -from merge.resources.crm import ( - FieldPermissionDeserializerRequest, - 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, - ), - }, - field_permissions=FieldPermissionDeserializerRequest( - enabled_fields=["avatar", "home_location"], - disabled_fields=["work_location"], - ), - ), - IndividualCommonModelScopeDeserializerRequest( - model_name="Benefit", - model_permissions={ - "WRITE": ModelPermissionDeserializerRequest( - is_enabled=False, - ) - }, - ), - ], +client.filestorage.users.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", ) ``` @@ -11688,7 +11780,7 @@ client.crm.scopes.linked_account_scopes_create(
-**common_models:** `typing.Sequence[IndividualCommonModelScopeDeserializerRequest]` — The common models you want to update the scopes for +**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
@@ -11696,65 +11788,83 @@ client.crm.scopes.linked_account_scopes_create(
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. +**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
- -
+
+
+**cursor:** `typing.Optional[str]` — The pagination cursor value. +
-
-## Crm DeleteAccount -
client.crm.delete_account.delete()
-#### 📝 Description +**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/). + +
+
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. + +
+
+
-Delete a linked account. -
-
+**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). + -#### 🔌 Usage -
+**is_me:** `typing.Optional[str]` — If provided, will only return the user object for requestor. + +
+
+
-```python -from merge import Merge +**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned. + +
+
-client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.crm.delete_account.delete() +
+
-``` +**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. +
-#### ⚙️ Parameters -
+**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object. + +
+
+
@@ -11770,8 +11880,7 @@ client.crm.delete_account.delete()
-## Crm EngagementTypes -
client.crm.engagement_types.list(...) +
client.filestorage.users.retrieve(...)
@@ -11783,7 +11892,7 @@ client.crm.delete_account.delete()
-Returns a list of `EngagementType` objects. +Returns a `User` object with the given `id`.
@@ -11804,8 +11913,8 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.engagement_types.list( - cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +client.filestorage.users.retrieve( + id="id", ) ``` @@ -11822,7 +11931,7 @@ client.crm.engagement_types.list(
-**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime. +**id:** `str`
@@ -11830,7 +11939,7 @@ client.crm.engagement_types.list(
-**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime. +**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -11838,7 +11947,7 @@ client.crm.engagement_types.list(
-**cursor:** `typing.Optional[str]` — The pagination cursor value. +**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -11846,67 +11955,65 @@ client.crm.engagement_types.list(
-**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/). +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+ +
-
-
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. -
+
+## Filestorage WebhookReceivers +
client.filestorage.webhook_receivers.list()
-**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. - -
-
+#### 📝 Description
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). - -
-
-
-**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned. - +Returns a list of `WebhookReceiver` objects. +
+
+#### 🔌 Usage +
-**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. - +```python +from merge import Merge + +client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.filestorage.webhook_receivers.list() + +``` +
+
+#### ⚙️ Parameters +
-**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object. - -
-
-
@@ -11922,7 +12029,7 @@ client.crm.engagement_types.list(
-
client.crm.engagement_types.retrieve(...) +
client.filestorage.webhook_receivers.create(...)
@@ -11934,7 +12041,7 @@ client.crm.engagement_types.list(
-Returns an `EngagementType` object with the given `id`. +Creates a `WebhookReceiver` object with the given values.
@@ -11955,8 +12062,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.engagement_types.retrieve( - id="id", +client.filestorage.webhook_receivers.create( + event="event", + is_active=True, ) ``` @@ -11973,15 +12081,7 @@ client.crm.engagement_types.retrieve(
-**id:** `str` - -
-
- -
-
- -**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. +**event:** `str`
@@ -11989,7 +12089,7 @@ client.crm.engagement_types.retrieve(
-**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. +**is_active:** `bool`
@@ -11997,7 +12097,7 @@ client.crm.engagement_types.retrieve(
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). +**key:** `typing.Optional[str]`
@@ -12017,7 +12117,8 @@ client.crm.engagement_types.retrieve(
-
client.crm.engagement_types.remote_field_classes_list(...) +## Ticketing AccountDetails +
client.ticketing.account_details.retrieve()
@@ -12029,7 +12130,7 @@ client.crm.engagement_types.retrieve(
-Returns a list of `RemoteFieldClass` objects. +Get details for a linked account.
@@ -12050,9 +12151,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.engagement_types.remote_field_classes_list( - cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", -) +client.ticketing.account_details.retrieve() ``` @@ -12068,63 +12167,71 @@ client.crm.engagement_types.remote_field_classes_list(
-**cursor:** `typing.Optional[str]` — The pagination cursor value. +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+ +
-
-
-**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/). -
+
+## Ticketing AccountToken +
client.ticketing.account_token.retrieve(...)
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. - -
-
+#### 📝 Description
-**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. - -
-
-
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). - +Returns the account token for the end user with the provided public token. +
+
+#### 🔌 Usage +
-**is_common_model_field:** `typing.Optional[bool]` — If provided, will only return remote field classes with this is_common_model_field value - -
-
-
-**is_custom:** `typing.Optional[bool]` — If provided, will only return remote fields classes with this is_custom value - +```python +from merge import Merge + +client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.ticketing.account_token.retrieve( + public_token="public_token", +) + +``` +
+
+#### ⚙️ Parameters +
-**page_size:** `typing.Optional[int]` — Number of results to return per page. +
+
+ +**public_token:** `str`
@@ -12144,8 +12251,8 @@ client.crm.engagement_types.remote_field_classes_list(
-## Crm Engagements -
client.crm.engagements.list(...) +## Ticketing Accounts +
client.ticketing.accounts.list(...)
@@ -12157,7 +12264,7 @@ client.crm.engagement_types.remote_field_classes_list(
-Returns a list of `Engagement` objects. +Returns a list of `Account` objects.
@@ -12178,7 +12285,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.engagements.list( +client.ticketing.accounts.list( cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", ) @@ -12220,14 +12327,6 @@ client.crm.engagements.list(
-**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]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
@@ -12244,14 +12343,6 @@ client.crm.engagements.list(
-**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. - -
-
- -
-
- **include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -12292,22 +12383,6 @@ client.crm.engagements.list(
-**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.
@@ -12320,7 +12395,7 @@ client.crm.engagements.list(
-
client.crm.engagements.create(...) +
client.ticketing.accounts.retrieve(...)
@@ -12332,7 +12407,7 @@ client.crm.engagements.list(
-Creates an `Engagement` object with the given values. +Returns an `Account` object with the given `id`.
@@ -12348,14 +12423,13 @@ Creates an `Engagement` object with the given values. ```python from merge 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(), +client.ticketing.accounts.retrieve( + id="id", ) ``` @@ -12372,7 +12446,7 @@ client.crm.engagements.create(
-**model:** `EngagementRequest` +**id:** `str`
@@ -12380,7 +12454,7 @@ client.crm.engagements.create(
-**is_debug_mode:** `typing.Optional[bool]` — Whether to include debug fields (such as log file links) in the response. +**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -12388,7 +12462,7 @@ client.crm.engagements.create(
-**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously. +**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -12408,7 +12482,8 @@ client.crm.engagements.create(
-
client.crm.engagements.retrieve(...) +## Ticketing AsyncPassthrough +
client.ticketing.async_passthrough.create(...)
@@ -12420,7 +12495,7 @@ client.crm.engagements.create(
-Returns an `Engagement` object with the given `id`. +Asynchronously pull data from an endpoint not currently supported by Merge.
@@ -12436,13 +12511,17 @@ Returns an `Engagement` object with the given `id`. ```python from merge import Merge +from merge.resources.ticketing import DataPassthroughRequest, MethodEnum client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.engagements.retrieve( - id="id", +client.ticketing.async_passthrough.create( + request=DataPassthroughRequest( + method=MethodEnum.GET, + path="/scooters", + ), ) ``` @@ -12459,7 +12538,7 @@ client.crm.engagements.retrieve(
-**id:** `str` +**request:** `DataPassthroughRequest`
@@ -12467,31 +12546,70 @@ client.crm.engagements.retrieve(
-**expand:** `typing.Optional[EngagementsRetrieveRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+ +
+ + + + +
+
client.ticketing.async_passthrough.retrieve(...)
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. - +#### 📝 Description + +
+
+ +
+
+ +Retrieves data from earlier async-passthrough POST request +
+
+#### 🔌 Usage +
-**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. - +
+
+ +```python +from merge 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 +
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). +
+
+ +**async_passthrough_receipt_id:** `str`
@@ -12511,7 +12629,8 @@ client.crm.engagements.retrieve(
-
client.crm.engagements.partial_update(...) +## Ticketing Attachments +
client.ticketing.attachments.list(...)
@@ -12523,7 +12642,7 @@ client.crm.engagements.retrieve(
-Updates an `Engagement` object with the given `id`. +Returns a list of `Attachment` objects.
@@ -12539,15 +12658,13 @@ Updates an `Engagement` object with the given `id`. ```python from merge 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(), +client.ticketing.attachments.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", ) ``` @@ -12564,7 +12681,7 @@ client.crm.engagements.partial_update(
-**id:** `str` +**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
@@ -12572,7 +12689,7 @@ client.crm.engagements.partial_update(
-**model:** `PatchedEngagementRequest` +**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
@@ -12580,7 +12697,7 @@ client.crm.engagements.partial_update(
-**is_debug_mode:** `typing.Optional[bool]` — Whether to include debug fields (such as log file links) in the response. +**cursor:** `typing.Optional[str]` — The pagination cursor value.
@@ -12588,7 +12705,7 @@ client.crm.engagements.partial_update(
-**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously. +**expand:** `typing.Optional[typing.Literal["ticket"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -12596,70 +12713,71 @@ client.crm.engagements.partial_update(
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. +**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
- -
+
+
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. +
-
-
client.crm.engagements.meta_patch_retrieve(...)
-#### 📝 Description +**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). + +
+
+**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned. + +
+
+
-Returns metadata for `Engagement` PATCHs. -
-
+**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned. + -#### 🔌 Usage -
+**page_size:** `typing.Optional[int]` — Number of results to return per page. + +
+
+
-```python -from merge import Merge - -client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.crm.engagements.meta_patch_retrieve( - id="id", -) - -``` -
-
+**remote_created_after:** `typing.Optional[dt.datetime]` — If provided, will only return attachments created in the third party platform after this datetime. + -#### ⚙️ Parameters -
+**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object. + +
+
+
-**id:** `str` +**ticket_id:** `typing.Optional[str]` — If provided, will only return comments for this ticket.
@@ -12679,7 +12797,7 @@ client.crm.engagements.meta_patch_retrieve(
-
client.crm.engagements.meta_post_retrieve() +
client.ticketing.attachments.create(...)
@@ -12691,7 +12809,7 @@ client.crm.engagements.meta_patch_retrieve(
-Returns metadata for `Engagement` POSTs. +Creates an `Attachment` object with the given values.
@@ -12707,12 +12825,15 @@ Returns metadata for `Engagement` POSTs. ```python from merge import Merge +from merge.resources.ticketing import AttachmentRequest client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.engagements.meta_post_retrieve() +client.ticketing.attachments.create( + model=AttachmentRequest(), +) ``` @@ -12728,6 +12849,30 @@ client.crm.engagements.meta_post_retrieve()
+**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.
@@ -12740,7 +12885,7 @@ client.crm.engagements.meta_post_retrieve()
-
client.crm.engagements.remote_field_classes_list(...) +
client.ticketing.attachments.retrieve(...)
@@ -12752,7 +12897,7 @@ client.crm.engagements.meta_post_retrieve()
-Returns a list of `RemoteFieldClass` objects. +Returns an `Attachment` object with the given `id`.
@@ -12773,8 +12918,8 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.engagements.remote_field_classes_list( - cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +client.ticketing.attachments.retrieve( + id="id", ) ``` @@ -12791,7 +12936,7 @@ client.crm.engagements.remote_field_classes_list(
-**cursor:** `typing.Optional[str]` — The pagination cursor value. +**id:** `str`
@@ -12799,7 +12944,7 @@ client.crm.engagements.remote_field_classes_list(
-**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/). +**expand:** `typing.Optional[typing.Literal["ticket"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -12815,14 +12960,6 @@ client.crm.engagements.remote_field_classes_list(
-**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. - -
-
- -
-
- **include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -12831,30 +12968,6 @@ client.crm.engagements.remote_field_classes_list(
-**is_common_model_field:** `typing.Optional[bool]` — If provided, will only return remote field classes with this is_common_model_field value - -
-
- -
-
- -**is_custom:** `typing.Optional[bool]` — If provided, will only return remote fields classes with this is_custom value - -
-
- -
-
- -**page_size:** `typing.Optional[int]` — Number of results to return per page. - -
-
- -
-
- **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -12867,8 +12980,7 @@ client.crm.engagements.remote_field_classes_list(
-## Crm FieldMapping -
client.crm.field_mapping.field_mappings_retrieve(...) +
client.ticketing.attachments.meta_post_retrieve()
@@ -12880,7 +12992,7 @@ client.crm.engagements.remote_field_classes_list(
-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/). +Returns metadata for `TicketingAttachment` POSTs.
@@ -12901,7 +13013,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.field_mapping.field_mappings_retrieve() +client.ticketing.attachments.meta_post_retrieve() ``` @@ -12917,14 +13029,6 @@ client.crm.field_mapping.field_mappings_retrieve()
-**exclude_remote_field_metadata:** `typing.Optional[bool]` — If `true`, remote fields metadata is excluded from each field mapping instance (i.e. `remote_fields.remote_key_name` and `remote_fields.schema` will be null). This will increase the speed of the request since these fields require some calculations. - -
-
- -
-
- **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -12937,7 +13041,8 @@ client.crm.field_mapping.field_mappings_retrieve()
-
client.crm.field_mapping.field_mappings_create(...) +## Ticketing AuditTrail +
client.ticketing.audit_trail.list(...)
@@ -12949,7 +13054,7 @@ client.crm.field_mapping.field_mappings_retrieve()
-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. +Gets a list of audit trail events.
@@ -12970,13 +13075,8 @@ 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", +client.ticketing.audit_trail.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", ) ``` @@ -12993,7 +13093,7 @@ client.crm.field_mapping.field_mappings_create(
-**target_field_name:** `str` — The name of the target field you want this remote field to map to. +**cursor:** `typing.Optional[str]` — The pagination cursor value.
@@ -13001,15 +13101,7 @@ client.crm.field_mapping.field_mappings_create(
-**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.Optional[typing.Any]]` — The field traversal path of the remote field listed when you hit the GET /remote-fields endpoint. +**end_date:** `typing.Optional[str]` — If included, will only include audit trail events that occurred before this time
@@ -13017,7 +13109,7 @@ client.crm.field_mapping.field_mappings_create(
-**remote_method:** `str` — The method of the remote endpoint where the remote field is coming from. +**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`, `REGENERATED_WEBHOOK_SIGNATURE`, `INVITED_USER`, `TWO_FACTOR_AUTH_ENABLED`, `TWO_FACTOR_AUTH_DISABLED`, `DELETED_LINKED_ACCOUNT`, `DELETED_ALL_COMMON_MODELS_FOR_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`, `CREATED_LINKED_ACCOUNT_COMMON_MODEL_OVERRIDE`, `CHANGED_LINKED_ACCOUNT_COMMON_MODEL_OVERRIDE`, `DELETED_LINKED_ACCOUNT_COMMON_MODEL_OVERRIDE`, `FORCED_LINKED_ACCOUNT_RESYNC`, `MUTED_ISSUE`, `GENERATED_MAGIC_LINK`, `ENABLED_MERGE_WEBHOOK`, `DISABLED_MERGE_WEBHOOK`, `MERGE_WEBHOOK_TARGET_CHANGED`, `END_USER_CREDENTIALS_ACCESSED`
@@ -13025,7 +13117,7 @@ client.crm.field_mapping.field_mappings_create(
-**remote_url_path:** `str` — The path of the remote endpoint where the remote field is coming from. +**page_size:** `typing.Optional[int]` — Number of results to return per page.
@@ -13033,7 +13125,7 @@ client.crm.field_mapping.field_mappings_create(
-**common_model_name:** `str` — The name of the Common Model that the remote field corresponds to in a given category. +**start_date:** `typing.Optional[str]` — If included, will only include audit trail events that occurred after this time
@@ -13041,7 +13133,7 @@ client.crm.field_mapping.field_mappings_create(
-**exclude_remote_field_metadata:** `typing.Optional[bool]` — If `true`, remote fields metadata is excluded from each field mapping instance (i.e. `remote_fields.remote_key_name` and `remote_fields.schema` will be null). This will increase the speed of the request since these fields require some calculations. +**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.
@@ -13061,7 +13153,8 @@ client.crm.field_mapping.field_mappings_create(
-
client.crm.field_mapping.field_mappings_destroy(...) +## Ticketing AvailableActions +
client.ticketing.available_actions.retrieve()
@@ -13073,7 +13166,7 @@ client.crm.field_mapping.field_mappings_create(
-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. +Returns a list of models and actions available for an account.
@@ -13094,9 +13187,7 @@ 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", -) +client.ticketing.available_actions.retrieve() ``` @@ -13112,14 +13203,6 @@ client.crm.field_mapping.field_mappings_destroy(
-**field_mapping_id:** `str` - -
-
- -
-
- **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -13132,7 +13215,8 @@ client.crm.field_mapping.field_mappings_destroy(
-
client.crm.field_mapping.field_mappings_partial_update(...) +## Ticketing Collections +
client.ticketing.collections.list(...)
@@ -13144,7 +13228,7 @@ client.crm.field_mapping.field_mappings_destroy(
-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. +Returns a list of `Collection` objects.
@@ -13165,8 +13249,8 @@ 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", +client.ticketing.collections.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", ) ``` @@ -13183,7 +13267,7 @@ client.crm.field_mapping.field_mappings_partial_update(
-**field_mapping_id:** `str` +**collection_type:** `typing.Optional[str]` — If provided, will only return collections of the given type.
@@ -13191,7 +13275,7 @@ client.crm.field_mapping.field_mappings_partial_update(
-**remote_field_traversal_path:** `typing.Optional[typing.Sequence[typing.Optional[typing.Any]]]` — The field traversal path of the remote field listed when you hit the GET /remote-fields endpoint. +**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
@@ -13199,7 +13283,7 @@ client.crm.field_mapping.field_mappings_partial_update(
-**remote_method:** `typing.Optional[str]` — The method of the remote endpoint where the remote field is coming from. +**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
@@ -13207,7 +13291,7 @@ client.crm.field_mapping.field_mappings_partial_update(
-**remote_url_path:** `typing.Optional[str]` — The path of the remote endpoint where the remote field is coming from. +**cursor:** `typing.Optional[str]` — The pagination cursor value.
@@ -13215,68 +13299,79 @@ client.crm.field_mapping.field_mappings_partial_update(
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. +**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]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/). +
-
-
client.crm.field_mapping.remote_fields_retrieve(...)
-#### 📝 Description +**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. + +
+
+**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). + +
+
+
-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/). -
-
+**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned. + -#### 🔌 Usage -
+**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned. + +
+
+
-```python -from merge import Merge - -client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.crm.field_mapping.remote_fields_retrieve() - -``` +**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. +
-#### ⚙️ Parameters -
+**remote_fields:** `typing.Optional[typing.Literal["collection_type"]]` — Deprecated. Use show_enum_origins. + +
+
+
-**common_models:** `typing.Optional[str]` — A comma seperated list of Common Model names. If included, will only return Remote Fields for those Common Models. +**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
@@ -13284,7 +13379,7 @@ client.crm.field_mapping.remote_fields_retrieve()
-**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. +**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)
@@ -13304,7 +13399,7 @@ client.crm.field_mapping.remote_fields_retrieve()
-
client.crm.field_mapping.target_fields_retrieve() +
client.ticketing.collections.viewers_list(...)
@@ -13316,7 +13411,7 @@ client.crm.field_mapping.remote_fields_retrieve()
-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/). +Returns a list of `Viewer` objects that point to a User id or Team id that is either an assignee or viewer on a `Collection` with the given id. [Learn more.](https://help.merge.dev/en/articles/10333658-ticketing-access-control-list-acls)
@@ -13337,7 +13432,10 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.field_mapping.target_fields_retrieve() +client.ticketing.collections.viewers_list( + collection_id="collection_id", + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -13353,6 +13451,62 @@ client.crm.field_mapping.target_fields_retrieve()
+**collection_id:** `str` + +
+
+ +
+
+ +**cursor:** `typing.Optional[str]` — The pagination cursor value. + +
+
+ +
+
+ +**expand:** `typing.Optional[CollectionsViewersListRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. + +
+
+ +
+
+ +**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/). + +
+
+ +
+
+ +**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. + +
+
+ +
+
+ +**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). + +
+
+ +
+
+ +**page_size:** `typing.Optional[int]` — Number of results to return per page. + +
+
+ +
+
+ **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -13365,8 +13519,7 @@ client.crm.field_mapping.target_fields_retrieve()
-## Crm GenerateKey -
client.crm.generate_key.create(...) +
client.ticketing.collections.retrieve(...)
@@ -13378,7 +13531,7 @@ client.crm.field_mapping.target_fields_retrieve()
-Create a remote key. +Returns a `Collection` object with the given `id`.
@@ -13399,8 +13552,8 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.generate_key.create( - name="Remote Deployment Key 1", +client.ticketing.collections.retrieve( + id="id", ) ``` @@ -13417,7 +13570,47 @@ client.crm.generate_key.create(
-**name:** `str` — The name of the remote key +**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. + +
+
+ +
+
+ +**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). + +
+
+ +
+
+ +**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)
@@ -13437,8 +13630,8 @@ client.crm.generate_key.create(
-## Crm Issues -
client.crm.issues.list(...) +## Ticketing Comments +
client.ticketing.comments.list(...)
@@ -13450,7 +13643,7 @@ client.crm.generate_key.create(
-Gets all issues for Organization. +Returns a list of `Comment` objects.
@@ -13471,7 +13664,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.issues.list( +client.ticketing.comments.list( cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", ) @@ -13489,7 +13682,7 @@ client.crm.issues.list(
-**account_token:** `typing.Optional[str]` +**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
@@ -13497,7 +13690,7 @@ client.crm.issues.list(
-**cursor:** `typing.Optional[str]` — The pagination cursor value. +**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
@@ -13505,7 +13698,7 @@ client.crm.issues.list(
-**end_date:** `typing.Optional[str]` — If included, will only include issues whose most recent action occurred before this time +**cursor:** `typing.Optional[str]` — The pagination cursor value.
@@ -13513,7 +13706,7 @@ client.crm.issues.list(
-**end_user_organization_name:** `typing.Optional[str]` +**expand:** `typing.Optional[CommentsListRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -13521,7 +13714,7 @@ client.crm.issues.list(
-**first_incident_time_after:** `typing.Optional[dt.datetime]` — If provided, will only return issues whose first incident time was after this datetime. +**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
@@ -13529,7 +13722,7 @@ client.crm.issues.list(
-**first_incident_time_before:** `typing.Optional[dt.datetime]` — If provided, will only return issues whose first incident time was before this datetime. +**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -13537,7 +13730,7 @@ client.crm.issues.list(
-**include_muted:** `typing.Optional[str]` — If true, will include muted issues +**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -13545,7 +13738,7 @@ client.crm.issues.list(
-**integration_name:** `typing.Optional[str]` +**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
@@ -13553,7 +13746,7 @@ client.crm.issues.list(
-**last_incident_time_after:** `typing.Optional[dt.datetime]` — If provided, will only return issues whose last incident time was after this datetime. +**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
@@ -13561,15 +13754,7 @@ client.crm.issues.list(
-**last_incident_time_before:** `typing.Optional[dt.datetime]` — If provided, will only return issues whose last incident time was before this datetime. - -
-
- -
-
- -**linked_account_id:** `typing.Optional[str]` — If provided, will only include issues pertaining to the linked account passed in. +**page_size:** `typing.Optional[int]` — Number of results to return per page.
@@ -13577,7 +13762,7 @@ client.crm.issues.list(
-**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.
@@ -13585,7 +13770,7 @@ client.crm.issues.list(
-**start_date:** `typing.Optional[str]` — If included, will only include issues whose most recent action occurred after this time +**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
@@ -13593,12 +13778,7 @@ client.crm.issues.list(
-**status:** `typing.Optional[IssuesListRequestStatus]` - -Status of the issue. Options: ('ONGOING', 'RESOLVED') - -* `ONGOING` - ONGOING -* `RESOLVED` - RESOLVED +**ticket_id:** `typing.Optional[str]` — If provided, will only return comments for this ticket.
@@ -13618,7 +13798,7 @@ Status of the issue. Options: ('ONGOING', 'RESOLVED')
-
client.crm.issues.retrieve(...) +
client.ticketing.comments.create(...)
@@ -13630,7 +13810,7 @@ Status of the issue. Options: ('ONGOING', 'RESOLVED')
-Get a specific issue. +Creates a `Comment` object with the given values.
@@ -13646,13 +13826,14 @@ Get a specific issue. ```python from merge import Merge +from merge.resources.ticketing import CommentRequest client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.issues.retrieve( - id="id", +client.ticketing.comments.create( + model=CommentRequest(), ) ``` @@ -13669,7 +13850,23 @@ client.crm.issues.retrieve(
-**id:** `str` +**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.
@@ -13689,8 +13886,7 @@ client.crm.issues.retrieve(
-## Crm Leads -
client.crm.leads.list(...) +
client.ticketing.comments.retrieve(...)
@@ -13702,7 +13898,7 @@ client.crm.issues.retrieve(
-Returns a list of `Lead` objects. +Returns a `Comment` object with the given `id`.
@@ -13723,8 +13919,8 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.leads.list( - cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +client.ticketing.comments.retrieve( + id="id", ) ``` @@ -13741,7 +13937,7 @@ client.crm.leads.list(
-**converted_account_id:** `typing.Optional[str]` — If provided, will only return leads with this account. +**id:** `str`
@@ -13749,7 +13945,7 @@ client.crm.leads.list(
-**converted_contact_id:** `typing.Optional[str]` — If provided, will only return leads with this contact. +**expand:** `typing.Optional[CommentsRetrieveRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -13757,7 +13953,7 @@ client.crm.leads.list(
-**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime. +**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -13765,7 +13961,7 @@ client.crm.leads.list(
-**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime. +**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -13773,23 +13969,132 @@ client.crm.leads.list(
-**cursor:** `typing.Optional[str]` — The pagination cursor value. +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+ +
+ + + + +
+
client.ticketing.comments.meta_post_retrieve()
-**email_addresses:** `typing.Optional[str]` — If provided, will only return contacts matching the email addresses; multiple email_addresses can be separated by commas. +#### 📝 Description + +
+
+ +
+
+ +Returns metadata for `Comment` POSTs. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from merge 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.
+
+
+ + +
+
+
+ +## Ticketing Contacts +
client.ticketing.contacts.list(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Returns a list of `Contact` objects. +
+
+
+
+ +#### 🔌 Usage
-**expand:** `typing.Optional[LeadsListRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. +
+
+ +```python +from merge import Merge + +client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.ticketing.contacts.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
@@ -13797,7 +14102,7 @@ client.crm.leads.list(
-**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/). +**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
@@ -13805,7 +14110,7 @@ client.crm.leads.list(
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. +**cursor:** `typing.Optional[str]` — The pagination cursor value.
@@ -13813,7 +14118,7 @@ client.crm.leads.list(
-**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. +**expand:** `typing.Optional[typing.Literal["account"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -13821,7 +14126,7 @@ client.crm.leads.list(
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). +**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
@@ -13829,7 +14134,7 @@ client.crm.leads.list(
-**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned. +**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -13837,7 +14142,7 @@ client.crm.leads.list(
-**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned. +**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -13845,7 +14150,7 @@ client.crm.leads.list(
-**owner_id:** `typing.Optional[str]` — If provided, will only return leads with this owner. +**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
@@ -13853,7 +14158,7 @@ client.crm.leads.list(
-**page_size:** `typing.Optional[int]` — Number of results to return per page. +**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
@@ -13861,7 +14166,7 @@ client.crm.leads.list(
-**phone_numbers:** `typing.Optional[str]` — If provided, will only return contacts matching the phone numbers; multiple phone numbers can be separated by commas. +**page_size:** `typing.Optional[int]` — Number of results to return per page.
@@ -13889,7 +14194,7 @@ client.crm.leads.list(
-
client.crm.leads.create(...) +
client.ticketing.contacts.create(...)
@@ -13901,7 +14206,7 @@ client.crm.leads.list(
-Creates a `Lead` object with the given values. +Creates a `Contact` object with the given values.
@@ -13917,14 +14222,14 @@ Creates a `Lead` object with the given values. ```python from merge import Merge -from merge.resources.crm import LeadRequest +from merge.resources.ticketing import ContactRequest client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.leads.create( - model=LeadRequest(), +client.ticketing.contacts.create( + model=ContactRequest(), ) ``` @@ -13941,7 +14246,7 @@ client.crm.leads.create(
-**model:** `LeadRequest` +**model:** `ContactRequest`
@@ -13977,7 +14282,7 @@ client.crm.leads.create(
-
client.crm.leads.retrieve(...) +
client.ticketing.contacts.retrieve(...)
@@ -13989,7 +14294,7 @@ client.crm.leads.create(
-Returns a `Lead` object with the given `id`. +Returns a `Contact` object with the given `id`.
@@ -14010,7 +14315,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.leads.retrieve( +client.ticketing.contacts.retrieve( id="id", ) @@ -14036,7 +14341,7 @@ client.crm.leads.retrieve(
-**expand:** `typing.Optional[LeadsRetrieveRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. +**expand:** `typing.Optional[typing.Literal["account"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -14052,14 +14357,6 @@ client.crm.leads.retrieve(
-**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. - -
-
- -
-
- **include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -14080,7 +14377,7 @@ client.crm.leads.retrieve(
-
client.crm.leads.meta_post_retrieve() +
client.ticketing.contacts.meta_post_retrieve()
@@ -14092,7 +14389,7 @@ client.crm.leads.retrieve(
-Returns metadata for `Lead` POSTs. +Returns metadata for `TicketingContact` POSTs.
@@ -14113,7 +14410,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.leads.meta_post_retrieve() +client.ticketing.contacts.meta_post_retrieve() ``` @@ -14141,7 +14438,8 @@ client.crm.leads.meta_post_retrieve()
-
client.crm.leads.remote_field_classes_list(...) +## Ticketing Scopes +
client.ticketing.scopes.default_scopes_retrieve()
@@ -14153,7 +14451,7 @@ client.crm.leads.meta_post_retrieve()
-Returns a list of `RemoteFieldClass` objects. +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/5950052-common-model-and-field-scopes).
@@ -14174,9 +14472,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.leads.remote_field_classes_list( - cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", -) +client.ticketing.scopes.default_scopes_retrieve() ``` @@ -14192,96 +14488,31 @@ client.crm.leads.remote_field_classes_list(
-**cursor:** `typing.Optional[str]` — The pagination cursor value. +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+ +
-
-
-**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/). -
+
+
client.ticketing.scopes.linked_account_scopes_retrieve()
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. - -
-
+#### 📝 Description
-**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. - -
-
- -
-
- -**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). - -
-
- -
-
- -**is_common_model_field:** `typing.Optional[bool]` — If provided, will only return remote field classes with this is_common_model_field value - -
-
- -
-
- -**is_custom:** `typing.Optional[bool]` — If provided, will only return remote fields classes with this is_custom value - -
-
- -
-
- -**page_size:** `typing.Optional[int]` — Number of results to return per page. - -
-
- -
-
- -**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. - -
-
- - - - - - -
- -## Crm LinkToken -
client.crm.link_token.create(...) -
-
- -#### 📝 Description -
-
-
- -Creates a link token to be used when linking a new end user. +Get all available permissions for Merge Common Models and fields for a single Linked Account. [Learn more](https://help.merge.dev/en/articles/5950052-common-model-and-field-scopes).
@@ -14297,18 +14528,12 @@ Creates a link token to be used when linking a new end user. ```python from merge 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], -) +client.ticketing.scopes.linked_account_scopes_retrieve() ```
@@ -14324,115 +14549,99 @@ client.crm.link_token.create(
-**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. +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
- -
-
- -**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. -
+
+
client.ticketing.scopes.linked_account_scopes_create(...)
-**categories:** `typing.Sequence[CategoriesEnum]` — The integration categories to show in Merge Link. - -
-
+#### 📝 Description
-**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. - +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/5950052-common-model-and-field-scopes)
- -
-
- -**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. -
+#### 🔌 Usage +
-**hide_admin_magic_link:** `typing.Optional[bool]` — Whether to generate a Magic Link URL on the Admin Needed screen during the linking flow. 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. - -
-
+```python +from merge import Merge +from merge.resources.ticketing import ( + FieldPermissionDeserializerRequest, + 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, + ), + }, + field_permissions=FieldPermissionDeserializerRequest( + enabled_fields=["avatar", "home_location"], + disabled_fields=["work_location"], + ), + ), + IndividualCommonModelScopeDeserializerRequest( + model_name="Benefit", + model_permissions={ + "WRITE": ModelPermissionDeserializerRequest( + is_enabled=False, + ) + }, + ), + ], +) -**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[EndUserDetailsRequestLanguage]` - -The following subset of IETF language tags can be used to configure localization. - -* `en` - en -* `de` - de -
+#### ⚙️ Parameters +
-**are_syncs_disabled:** `typing.Optional[bool]` — The boolean that indicates whether initial, periodic, and force syncs will be disabled. - -
-
-
-**integration_specific_config:** `typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]]` — A JSON object containing integration-specific configuration options. +**common_models:** `typing.Sequence[IndividualCommonModelScopeDeserializerRequest]` — The common models you want to update the scopes for
@@ -14452,8 +14661,8 @@ The following subset of IETF language tags can be used to configure localization
-## Crm LinkedAccounts -
client.crm.linked_accounts.list(...) +## Ticketing DeleteAccount +
client.ticketing.delete_account.delete()
@@ -14465,7 +14674,7 @@ The following subset of IETF language tags can be used to configure localization
-List linked accounts for your organization. +Delete a linked account.
@@ -14486,9 +14695,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.linked_accounts.list( - cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", -) +client.ticketing.delete_account.delete() ``` @@ -14504,113 +14711,69 @@ client.crm.linked_accounts.list(
-**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 +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
- -
-
- -**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. -
+
+## Ticketing FieldMapping +
client.ticketing.field_mapping.field_mappings_retrieve(...)
-**end_user_organization_name:** `typing.Optional[str]` — If provided, will only return linked accounts associated with the given organization name. - -
-
+#### 📝 Description
-**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. - +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/).
- -
-
- -**id:** `typing.Optional[str]` -
+#### 🔌 Usage +
-**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. - -
-
+```python +from merge import Merge -
-
+client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.ticketing.field_mapping.field_mappings_retrieve() -**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. -
+#### ⚙️ Parameters +
-**page_size:** `typing.Optional[int]` — Number of results to return per page. - -
-
-
-**status:** `typing.Optional[str]` — Filter by status. Options: `COMPLETE`, `IDLE`, `INCOMPLETE`, `RELINK_NEEDED` +**exclude_remote_field_metadata:** `typing.Optional[bool]` — If `true`, remote fields metadata is excluded from each field mapping instance (i.e. `remote_fields.remote_key_name` and `remote_fields.schema` will be null). This will increase the speed of the request since these fields require some calculations.
@@ -14630,8 +14793,7 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing`
-## Crm Notes -
client.crm.notes.list(...) +
client.ticketing.field_mapping.field_mappings_create(...)
@@ -14643,7 +14805,7 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing`
-Returns a list of `Note` objects. +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.
@@ -14664,8 +14826,13 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.notes.list( - cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +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", ) ``` @@ -14682,79 +14849,7 @@ client.crm.notes.list(
-**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]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/). - -
-
- -
-
- -**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. - -
-
- -
-
- -**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). +**target_field_name:** `str` — The name of the target field you want this remote field to map to.
@@ -14762,7 +14857,7 @@ client.crm.notes.list(
-**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned. +**target_field_description:** `str` — The description of the target field you want this remote field to map to.
@@ -14770,7 +14865,7 @@ client.crm.notes.list(
-**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned. +**remote_field_traversal_path:** `typing.Sequence[typing.Optional[typing.Any]]` — The field traversal path of the remote field listed when you hit the GET /remote-fields endpoint.
@@ -14778,7 +14873,7 @@ client.crm.notes.list(
-**opportunity_id:** `typing.Optional[str]` — If provided, will only return notes with this opportunity. +**remote_method:** `str` — The method of the remote endpoint where the remote field is coming from.
@@ -14786,7 +14881,7 @@ client.crm.notes.list(
-**owner_id:** `typing.Optional[str]` — If provided, will only return notes with this owner. +**remote_url_path:** `str` — The path of the remote endpoint where the remote field is coming from.
@@ -14794,7 +14889,7 @@ client.crm.notes.list(
-**page_size:** `typing.Optional[int]` — Number of results to return per page. +**common_model_name:** `str` — The name of the Common Model that the remote field corresponds to in a given category.
@@ -14802,7 +14897,7 @@ client.crm.notes.list(
-**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object. +**exclude_remote_field_metadata:** `typing.Optional[bool]` — If `true`, remote fields metadata is excluded from each field mapping instance (i.e. `remote_fields.remote_key_name` and `remote_fields.schema` will be null). This will increase the speed of the request since these fields require some calculations.
@@ -14822,7 +14917,7 @@ client.crm.notes.list(
-
client.crm.notes.create(...) +
client.ticketing.field_mapping.field_mappings_destroy(...)
@@ -14834,7 +14929,7 @@ client.crm.notes.list(
-Creates a `Note` object with the given values. +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.
@@ -14850,14 +14945,13 @@ Creates a `Note` object with the given values. ```python from merge 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(), +client.ticketing.field_mapping.field_mappings_destroy( + field_mapping_id="field_mapping_id", ) ``` @@ -14874,23 +14968,7 @@ client.crm.notes.create(
-**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. +**field_mapping_id:** `str`
@@ -14910,7 +14988,7 @@ client.crm.notes.create(
-
client.crm.notes.retrieve(...) +
client.ticketing.field_mapping.field_mappings_partial_update(...)
@@ -14922,7 +15000,7 @@ client.crm.notes.create(
-Returns a `Note` object with the given `id`. +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.
@@ -14943,8 +15021,8 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.notes.retrieve( - id="id", +client.ticketing.field_mapping.field_mappings_partial_update( + field_mapping_id="field_mapping_id", ) ``` @@ -14961,15 +15039,7 @@ client.crm.notes.retrieve(
-**id:** `str` - -
-
- -
-
- -**expand:** `typing.Optional[NotesRetrieveRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. +**field_mapping_id:** `str`
@@ -14977,7 +15047,7 @@ client.crm.notes.retrieve(
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. +**remote_field_traversal_path:** `typing.Optional[typing.Sequence[typing.Optional[typing.Any]]]` — The field traversal path of the remote field listed when you hit the GET /remote-fields endpoint.
@@ -14985,7 +15055,7 @@ client.crm.notes.retrieve(
-**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_method:** `typing.Optional[str]` — The method of the remote endpoint where the remote field is coming from.
@@ -14993,7 +15063,7 @@ client.crm.notes.retrieve(
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). +**remote_url_path:** `typing.Optional[str]` — The path of the remote endpoint where the remote field is coming from.
@@ -15013,7 +15083,7 @@ client.crm.notes.retrieve(
-
client.crm.notes.meta_post_retrieve() +
client.ticketing.field_mapping.remote_fields_retrieve(...)
@@ -15025,7 +15095,7 @@ client.crm.notes.retrieve(
-Returns metadata for `Note` POSTs. +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/).
@@ -15046,7 +15116,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.notes.meta_post_retrieve() +client.ticketing.field_mapping.remote_fields_retrieve() ``` @@ -15062,6 +15132,22 @@ client.crm.notes.meta_post_retrieve()
+**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.
@@ -15074,7 +15160,7 @@ client.crm.notes.meta_post_retrieve()
-
client.crm.notes.remote_field_classes_list(...) +
client.ticketing.field_mapping.target_fields_retrieve()
@@ -15086,7 +15172,7 @@ client.crm.notes.meta_post_retrieve()
-Returns a list of `RemoteFieldClass` objects. +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/).
@@ -15107,9 +15193,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.notes.remote_field_classes_list( - cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", -) +client.ticketing.field_mapping.target_fields_retrieve() ``` @@ -15125,63 +15209,71 @@ client.crm.notes.remote_field_classes_list(
-**cursor:** `typing.Optional[str]` — The pagination cursor value. +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+ +
-
-
-**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/). -
+
+## Ticketing GenerateKey +
client.ticketing.generate_key.create(...)
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. - -
-
+#### 📝 Description
-**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. - -
-
-
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). - +Create a remote key.
+ + + +#### 🔌 Usage
-**is_common_model_field:** `typing.Optional[bool]` — If provided, will only return remote field classes with this is_common_model_field value - -
-
-
-**is_custom:** `typing.Optional[bool]` — If provided, will only return remote fields classes with this is_custom value - +```python +from merge 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 +
-**page_size:** `typing.Optional[int]` — Number of results to return per page. +
+
+ +**name:** `str` — The name of the remote key
@@ -15201,8 +15293,8 @@ client.crm.notes.remote_field_classes_list(
-## Crm Opportunities -
client.crm.opportunities.list(...) +## Ticketing Issues +
client.ticketing.issues.list(...)
@@ -15214,7 +15306,7 @@ client.crm.notes.remote_field_classes_list(
-Returns a list of `Opportunity` objects. +Gets all issues for Organization.
@@ -15235,7 +15327,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.opportunities.list( +client.ticketing.issues.list( cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", ) @@ -15253,7 +15345,7 @@ client.crm.opportunities.list(
-**account_id:** `typing.Optional[str]` — If provided, will only return opportunities with this account. +**account_token:** `typing.Optional[str]`
@@ -15261,7 +15353,7 @@ client.crm.opportunities.list(
-**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime. +**cursor:** `typing.Optional[str]` — The pagination cursor value.
@@ -15269,7 +15361,7 @@ client.crm.opportunities.list(
-**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime. +**end_date:** `typing.Optional[str]` — If included, will only include issues whose most recent action occurred before this time
@@ -15277,7 +15369,7 @@ client.crm.opportunities.list(
-**cursor:** `typing.Optional[str]` — The pagination cursor value. +**end_user_organization_name:** `typing.Optional[str]`
@@ -15285,7 +15377,7 @@ client.crm.opportunities.list(
-**expand:** `typing.Optional[OpportunitiesListRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. +**first_incident_time_after:** `typing.Optional[dt.datetime]` — If provided, will only return issues whose first incident time was after this datetime.
@@ -15293,7 +15385,7 @@ client.crm.opportunities.list(
-**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/). +**first_incident_time_before:** `typing.Optional[dt.datetime]` — If provided, will only return issues whose first incident time was before this datetime.
@@ -15301,7 +15393,7 @@ client.crm.opportunities.list(
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. +**include_muted:** `typing.Optional[str]` — If true, will include muted issues
@@ -15309,7 +15401,7 @@ client.crm.opportunities.list(
-**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. +**integration_name:** `typing.Optional[str]`
@@ -15317,7 +15409,7 @@ client.crm.opportunities.list(
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). +**last_incident_time_after:** `typing.Optional[dt.datetime]` — If provided, will only return issues whose last incident time was after this datetime.
@@ -15325,7 +15417,7 @@ client.crm.opportunities.list(
-**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned. +**last_incident_time_before:** `typing.Optional[dt.datetime]` — If provided, will only return issues whose last incident time was before this datetime.
@@ -15333,7 +15425,7 @@ client.crm.opportunities.list(
-**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned. +**linked_account_id:** `typing.Optional[str]` — If provided, will only include issues pertaining to the linked account passed in.
@@ -15341,7 +15433,7 @@ client.crm.opportunities.list(
-**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.
@@ -15349,7 +15441,7 @@ client.crm.opportunities.list(
-**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
@@ -15357,7 +15449,12 @@ client.crm.opportunities.list(
-**remote_created_after:** `typing.Optional[dt.datetime]` — If provided, will only return opportunities created in the third party platform after this datetime. +**status:** `typing.Optional[IssuesListRequestStatus]` + +Status of the issue. Options: ('ONGOING', 'RESOLVED') + +* `ONGOING` - ONGOING +* `RESOLVED` - RESOLVED
@@ -15365,45 +15462,70 @@ client.crm.opportunities.list(
-**remote_fields:** `typing.Optional[typing.Literal["status"]]` — Deprecated. Use show_enum_origins. +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+ +
-
-
-**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object. -
+
+
client.ticketing.issues.retrieve(...)
-**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) - +#### 📝 Description + +
+
+ +
+
+ +Get a specific issue. +
+
+#### 🔌 Usage +
-**stage_id:** `typing.Optional[str]` — If provided, will only return opportunities with this stage. - +
+
+ +```python +from merge import Merge + +client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.ticketing.issues.retrieve( + id="id", +) + +``` +
+
+#### ⚙️ Parameters +
-**status:** `typing.Optional[OpportunitiesListRequestStatus]` - -If provided, will only return opportunities with this status. Options: ('OPEN', 'WON', 'LOST') +
+
-* `OPEN` - OPEN -* `WON` - WON -* `LOST` - LOST +**id:** `str`
@@ -15423,7 +15545,8 @@ If provided, will only return opportunities with this status. Options: ('OPEN',
-
client.crm.opportunities.create(...) +## Ticketing LinkToken +
client.ticketing.link_token.create(...)
@@ -15435,7 +15558,7 @@ If provided, will only return opportunities with this status. Options: ('OPEN',
-Creates an `Opportunity` object with the given values. +Creates a link token to be used when linking a new end user.
@@ -15451,14 +15574,17 @@ Creates an `Opportunity` object with the given values. ```python from merge import Merge -from merge.resources.crm import OpportunityRequest +from merge.resources.ticketing import CategoriesEnum client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.opportunities.create( - model=OpportunityRequest(), +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], ) ``` @@ -15475,23 +15601,7 @@ client.crm.opportunities.create(
-**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. +**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.
@@ -15499,70 +15609,47 @@ client.crm.opportunities.create(
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. +**end_user_organization_name:** `str` — Your end user's organization. -
-
- -
- - - - -
- -
client.crm.opportunities.retrieve(...) -
-
- -#### 📝 Description - -
-
+
+
-Returns an `Opportunity` object with the given `id`. -
-
+**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. +
-#### 🔌 Usage -
+**categories:** `typing.Sequence[CategoriesEnum]` — The integration categories to show in Merge Link. + +
+
+
-```python -from merge import Merge - -client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.crm.opportunities.retrieve( - id="id", -) - -``` -
-
+**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/. + -#### ⚙️ Parameters -
+**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. + +
+
+
-**id:** `str` +**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.
@@ -15570,7 +15657,7 @@ client.crm.opportunities.retrieve(
-**expand:** `typing.Optional[OpportunitiesRetrieveRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. +**hide_admin_magic_link:** `typing.Optional[bool]` — Whether to generate a Magic Link URL on the Admin Needed screen during the linking flow. Defaults to false. For more information on Magic Link, see https://merge.dev/blog/integrations-fast-say-hello-to-magic-link.
@@ -15578,7 +15665,7 @@ client.crm.opportunities.retrieve(
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. +**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.
@@ -15586,7 +15673,14 @@ client.crm.opportunities.retrieve(
-**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. +**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.
@@ -15594,7 +15688,12 @@ client.crm.opportunities.retrieve(
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). +**language:** `typing.Optional[EndUserDetailsRequestLanguage]` + +The following subset of IETF language tags can be used to configure localization. + +* `en` - en +* `de` - de
@@ -15602,7 +15701,7 @@ client.crm.opportunities.retrieve(
-**remote_fields:** `typing.Optional[typing.Literal["status"]]` — Deprecated. Use show_enum_origins. +**are_syncs_disabled:** `typing.Optional[bool]` — The boolean that indicates whether initial, periodic, and force syncs will be disabled.
@@ -15610,7 +15709,7 @@ client.crm.opportunities.retrieve(
-**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) +**integration_specific_config:** `typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]]` — A JSON object containing integration-specific configuration options.
@@ -15630,7 +15729,8 @@ client.crm.opportunities.retrieve(
-
client.crm.opportunities.partial_update(...) +## Ticketing LinkedAccounts +
client.ticketing.linked_accounts.list(...)
@@ -15642,7 +15742,7 @@ client.crm.opportunities.retrieve(
-Updates an `Opportunity` object with the given `id`. +List linked accounts for your organization.
@@ -15658,15 +15758,13 @@ Updates an `Opportunity` object with the given `id`. ```python from merge 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(), +client.ticketing.linked_accounts.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", ) ``` @@ -15683,7 +15781,17 @@ client.crm.opportunities.partial_update(
-**id:** `str` +**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
@@ -15691,7 +15799,7 @@ client.crm.opportunities.partial_update(
-**model:** `PatchedOpportunityRequest` +**cursor:** `typing.Optional[str]` — The pagination cursor value.
@@ -15699,7 +15807,7 @@ client.crm.opportunities.partial_update(
-**is_debug_mode:** `typing.Optional[bool]` — Whether to include debug fields (such as log file links) in the response. +**end_user_email_address:** `typing.Optional[str]` — If provided, will only return linked accounts associated with the given email address.
@@ -15707,7 +15815,7 @@ client.crm.opportunities.partial_update(
-**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously. +**end_user_organization_name:** `typing.Optional[str]` — If provided, will only return linked accounts associated with the given organization name.
@@ -15715,70 +15823,71 @@ client.crm.opportunities.partial_update(
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. +**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. +
-
-
client.crm.opportunities.meta_patch_retrieve(...)
-#### 📝 Description +**id:** `typing.Optional[str]` + +
+
+**ids:** `typing.Optional[str]` — Comma-separated list of LinkedAccount IDs, making it possible to specify multiple LinkedAccounts at once. + +
+
+
-Returns metadata for `Opportunity` PATCHs. -
-
+**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. + -#### 🔌 Usage -
+**integration_name:** `typing.Optional[str]` — If provided, will only return linked accounts associated with the given integration name. + +
+
+
-```python -from merge import Merge - -client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.crm.opportunities.meta_patch_retrieve( - id="id", -) - -``` -
-
+**is_test_account:** `typing.Optional[str]` — If included, will only include test linked accounts. If not included, will only include non-test linked accounts. + -#### ⚙️ Parameters -
+**page_size:** `typing.Optional[int]` — Number of results to return per page. + +
+
+
-**id:** `str` +**status:** `typing.Optional[str]` — Filter by status. Options: `COMPLETE`, `IDLE`, `INCOMPLETE`, `RELINK_NEEDED`
@@ -15798,7 +15907,8 @@ client.crm.opportunities.meta_patch_retrieve(
-
client.crm.opportunities.meta_post_retrieve() +## Ticketing Passthrough +
client.ticketing.passthrough.create(...)
@@ -15810,7 +15920,7 @@ client.crm.opportunities.meta_patch_retrieve(
-Returns metadata for `Opportunity` POSTs. +Pull data from an endpoint not currently supported by Merge.
@@ -15826,12 +15936,18 @@ Returns metadata for `Opportunity` POSTs. ```python from merge import Merge +from merge.resources.ticketing import DataPassthroughRequest, MethodEnum client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.opportunities.meta_post_retrieve() +client.ticketing.passthrough.create( + request=DataPassthroughRequest( + method=MethodEnum.GET, + path="/scooters", + ), +) ``` @@ -15847,6 +15963,14 @@ client.crm.opportunities.meta_post_retrieve()
+**request:** `DataPassthroughRequest` + +
+
+ +
+
+ **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -15859,7 +15983,8 @@ client.crm.opportunities.meta_post_retrieve()
-
client.crm.opportunities.remote_field_classes_list(...) +## Ticketing Projects +
client.ticketing.projects.list(...)
@@ -15871,7 +15996,7 @@ client.crm.opportunities.meta_post_retrieve()
-Returns a list of `RemoteFieldClass` objects. +Returns a list of `Project` objects.
@@ -15892,7 +16017,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.opportunities.remote_field_classes_list( +client.ticketing.projects.list( cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", ) @@ -15910,15 +16035,7 @@ client.crm.opportunities.remote_field_classes_list(
-**cursor:** `typing.Optional[str]` — The pagination cursor value. - -
-
- -
-
- -**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/). +**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
@@ -15926,7 +16043,7 @@ client.crm.opportunities.remote_field_classes_list(
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. +**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
@@ -15934,7 +16051,7 @@ client.crm.opportunities.remote_field_classes_list(
-**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. +**cursor:** `typing.Optional[str]` — The pagination cursor value.
@@ -15942,7 +16059,7 @@ client.crm.opportunities.remote_field_classes_list(
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). +**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
@@ -15950,7 +16067,7 @@ client.crm.opportunities.remote_field_classes_list(
-**is_common_model_field:** `typing.Optional[bool]` — If provided, will only return remote field classes with this is_common_model_field value +**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -15958,7 +16075,7 @@ client.crm.opportunities.remote_field_classes_list(
-**is_custom:** `typing.Optional[bool]` — If provided, will only return remote fields classes with this is_custom value +**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -15966,7 +16083,7 @@ client.crm.opportunities.remote_field_classes_list(
-**page_size:** `typing.Optional[int]` — Number of results to return per page. +**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
@@ -15974,75 +16091,23 @@ client.crm.opportunities.remote_field_classes_list(
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. +**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned. -
-
- -
- - - - -
- -## Crm Passthrough -
client.crm.passthrough.create(...) -
-
- -#### 📝 Description - -
-
- -
-
- -Pull data from an endpoint not currently supported by Merge. -
-
-
-
- -#### 🔌 Usage - -
-
- -
-
- -```python -from merge 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 -
+**page_size:** `typing.Optional[int]` — Number of results to return per page. + +
+
+
-**request:** `DataPassthroughRequest` +**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
@@ -16062,8 +16127,7 @@ client.crm.passthrough.create(
-## Crm RegenerateKey -
client.crm.regenerate_key.create(...) +
client.ticketing.projects.retrieve(...)
@@ -16075,7 +16139,7 @@ client.crm.passthrough.create(
-Exchange remote keys. +Returns a `Project` object with the given `id`.
@@ -16096,8 +16160,8 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.regenerate_key.create( - name="Remote Deployment Key 1", +client.ticketing.projects.retrieve( + id="id", ) ``` @@ -16114,7 +16178,23 @@ client.crm.regenerate_key.create(
-**name:** `str` — The name of the remote key +**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_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -16134,8 +16214,7 @@ client.crm.regenerate_key.create(
-## Crm Stages -
client.crm.stages.list(...) +
client.ticketing.projects.users_list(...)
@@ -16147,7 +16226,7 @@ client.crm.regenerate_key.create(
-Returns a list of `Stage` objects. +Returns a list of `User` objects.
@@ -16168,7 +16247,8 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.stages.list( +client.ticketing.projects.users_list( + parent_id="parent_id", cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", ) @@ -16186,7 +16266,7 @@ client.crm.stages.list(
-**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime. +**parent_id:** `str`
@@ -16194,7 +16274,7 @@ client.crm.stages.list(
-**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime. +**cursor:** `typing.Optional[str]` — The pagination cursor value.
@@ -16202,7 +16282,7 @@ client.crm.stages.list(
-**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.
@@ -16226,7 +16306,7 @@ client.crm.stages.list(
-**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. +**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -16234,7 +16314,7 @@ client.crm.stages.list(
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). +**page_size:** `typing.Optional[int]` — Number of results to return per page.
@@ -16242,31 +16322,71 @@ client.crm.stages.list(
-**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned. +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+ +
+ + + + +
+ +## Ticketing RegenerateKey +
client.ticketing.regenerate_key.create(...) +
+
+ +#### 📝 Description
-**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned. - +
+
+ +Exchange remote keys.
+
+
+ +#### 🔌 Usage
-**page_size:** `typing.Optional[int]` — Number of results to return per page. - +
+
+ +```python +from merge 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 +
-**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object. +
+
+ +**name:** `str` — The name of the remote key
@@ -16286,7 +16406,8 @@ client.crm.stages.list(
-
client.crm.stages.retrieve(...) +## Ticketing Roles +
client.ticketing.roles.list(...)
@@ -16298,7 +16419,7 @@ client.crm.stages.list(
-Returns a `Stage` object with the given `id`. +Returns a list of `Role` objects.
@@ -16319,8 +16440,8 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.stages.retrieve( - id="id", +client.ticketing.roles.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", ) ``` @@ -16337,7 +16458,7 @@ client.crm.stages.retrieve(
-**id:** `str` +**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
@@ -16345,7 +16466,7 @@ client.crm.stages.retrieve(
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. +**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
@@ -16353,7 +16474,23 @@ client.crm.stages.retrieve(
-**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. +**cursor:** `typing.Optional[str]` — The pagination cursor value. + +
+
+ +
+
+ +**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/). + +
+
+ +
+
+ +**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -16369,6 +16506,38 @@ client.crm.stages.retrieve(
+**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.
@@ -16381,7 +16550,7 @@ client.crm.stages.retrieve(
-
client.crm.stages.remote_field_classes_list(...) +
client.ticketing.roles.retrieve(...)
@@ -16393,7 +16562,7 @@ client.crm.stages.retrieve(
-Returns a list of `RemoteFieldClass` objects. +Returns a `Role` object with the given `id`.
@@ -16414,8 +16583,8 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.stages.remote_field_classes_list( - cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +client.ticketing.roles.retrieve( + id="id", ) ``` @@ -16432,15 +16601,7 @@ client.crm.stages.remote_field_classes_list(
-**cursor:** `typing.Optional[str]` — The pagination cursor value. - -
-
- -
-
- -**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/). +**id:** `str`
@@ -16456,14 +16617,6 @@ client.crm.stages.remote_field_classes_list(
-**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. - -
-
- -
-
- **include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -16472,30 +16625,6 @@ client.crm.stages.remote_field_classes_list(
-**is_common_model_field:** `typing.Optional[bool]` — If provided, will only return remote field classes with this is_common_model_field value - -
-
- -
-
- -**is_custom:** `typing.Optional[bool]` — If provided, will only return remote fields classes with this is_custom value - -
-
- -
-
- -**page_size:** `typing.Optional[int]` — Number of results to return per page. - -
-
- -
-
- **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -16508,8 +16637,8 @@ client.crm.stages.remote_field_classes_list(
-## Crm SyncStatus -
client.crm.sync_status.list(...) +## Ticketing SyncStatus +
client.ticketing.sync_status.list(...)
@@ -16542,7 +16671,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.sync_status.list( +client.ticketing.sync_status.list( cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", ) @@ -16588,8 +16717,8 @@ client.crm.sync_status.list(
-## Crm ForceResync -
client.crm.force_resync.sync_status_resync_create() +## Ticketing ForceResync +
client.ticketing.force_resync.sync_status_resync_create()
@@ -16622,7 +16751,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.force_resync.sync_status_resync_create() +client.ticketing.force_resync.sync_status_resync_create() ```
@@ -16650,8 +16779,8 @@ client.crm.force_resync.sync_status_resync_create()
-## Crm Tasks -
client.crm.tasks.list(...) +## Ticketing Tags +
client.ticketing.tags.list(...)
@@ -16663,7 +16792,7 @@ client.crm.force_resync.sync_status_resync_create()
-Returns a list of `Task` objects. +Returns a list of `Tag` objects.
@@ -16684,7 +16813,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.tasks.list( +client.ticketing.tags.list( cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", ) @@ -16726,23 +16855,7 @@ client.crm.tasks.list(
-**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]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/). - -
-
- -
-
- -**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. +**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
@@ -16750,7 +16863,7 @@ client.crm.tasks.list(
-**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. +**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -16810,7 +16923,7 @@ client.crm.tasks.list(
-
client.crm.tasks.create(...) +
client.ticketing.tags.retrieve(...)
@@ -16822,7 +16935,7 @@ client.crm.tasks.list(
-Creates a `Task` object with the given values. +Returns a `Tag` object with the given `id`.
@@ -16838,14 +16951,13 @@ Creates a `Task` object with the given values. ```python from merge 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(), +client.ticketing.tags.retrieve( + id="id", ) ``` @@ -16862,7 +16974,7 @@ client.crm.tasks.create(
-**model:** `TaskRequest` +**id:** `str`
@@ -16870,7 +16982,7 @@ client.crm.tasks.create(
-**is_debug_mode:** `typing.Optional[bool]` — Whether to include debug fields (such as log file links) in the response. +**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -16878,7 +16990,7 @@ client.crm.tasks.create(
-**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously. +**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -16898,7 +17010,8 @@ client.crm.tasks.create(
-
client.crm.tasks.retrieve(...) +## Ticketing Teams +
client.ticketing.teams.list(...)
@@ -16910,7 +17023,7 @@ client.crm.tasks.create(
-Returns a `Task` object with the given `id`. +Returns a list of `Team` objects.
@@ -16931,8 +17044,8 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.tasks.retrieve( - id="id", +client.ticketing.teams.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", ) ``` @@ -16949,7 +17062,7 @@ client.crm.tasks.retrieve(
-**id:** `str` +**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
@@ -16957,7 +17070,7 @@ client.crm.tasks.retrieve(
-**expand:** `typing.Optional[TasksRetrieveRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. +**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
@@ -16965,7 +17078,7 @@ client.crm.tasks.retrieve(
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. +**cursor:** `typing.Optional[str]` — The pagination cursor value.
@@ -16973,7 +17086,15 @@ client.crm.tasks.retrieve(
-**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. +**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/). + +
+
+ +
+
+ +**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -16989,6 +17110,38 @@ client.crm.tasks.retrieve(
+**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.
@@ -17001,7 +17154,7 @@ client.crm.tasks.retrieve(
-
client.crm.tasks.partial_update(...) +
client.ticketing.teams.retrieve(...)
@@ -17013,7 +17166,7 @@ client.crm.tasks.retrieve(
-Updates a `Task` object with the given `id`. +Returns a `Team` object with the given `id`.
@@ -17029,15 +17182,13 @@ Updates a `Task` object with the given `id`. ```python from merge 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( +client.ticketing.teams.retrieve( id="id", - model=PatchedTaskRequest(), ) ``` @@ -17062,15 +17213,7 @@ client.crm.tasks.partial_update(
-**model:** `PatchedTaskRequest` - -
-
- -
-
- -**is_debug_mode:** `typing.Optional[bool]` — Whether to include debug fields (such as log file links) in the response. +**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -17078,7 +17221,7 @@ client.crm.tasks.partial_update(
-**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously. +**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -17098,7 +17241,8 @@ client.crm.tasks.partial_update(
-
client.crm.tasks.meta_patch_retrieve(...) +## Ticketing Tickets +
client.ticketing.tickets.list(...)
@@ -17110,7 +17254,7 @@ client.crm.tasks.partial_update(
-Returns metadata for `Task` PATCHs. +Returns a list of `Ticket` objects.
@@ -17131,8 +17275,8 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.tasks.meta_patch_retrieve( - id="id", +client.ticketing.tickets.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", ) ``` @@ -17149,7 +17293,7 @@ client.crm.tasks.meta_patch_retrieve(
-**id:** `str` +**account_id:** `typing.Optional[str]` — If provided, will only return tickets for this account.
@@ -17157,131 +17301,95 @@ client.crm.tasks.meta_patch_retrieve(
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. +**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. +
-
-
client.crm.tasks.meta_post_retrieve()
-#### 📝 Description - -
-
+**completed_after:** `typing.Optional[dt.datetime]` — If provided, will only return tickets completed after this datetime. + +
+
-Returns metadata for `Task` POSTs. -
-
+**completed_before:** `typing.Optional[dt.datetime]` — If provided, will only return tickets completed before this datetime. +
-#### 🔌 Usage - -
-
-
-```python -from merge import Merge - -client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.crm.tasks.meta_post_retrieve() - -``` -
-
+**contact_id:** `typing.Optional[str]` — If provided, will only return tickets for this contact. +
-#### ⚙️ Parameters - -
-
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. +**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. +
-
-
client.crm.tasks.remote_field_classes_list(...)
-#### 📝 Description - -
-
+**creator_id:** `typing.Optional[str]` — If provided, will only return tickets created by this creator_id. + +
+
-Returns a list of `RemoteFieldClass` objects. -
-
+**cursor:** `typing.Optional[str]` — The pagination cursor value. +
-#### 🔌 Usage - -
-
-
-```python -from merge import Merge - -client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.crm.tasks.remote_field_classes_list( - cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", -) - -``` -
-
+**due_after:** `typing.Optional[dt.datetime]` — If provided, will only return tickets due after this datetime. +
-#### ⚙️ Parameters -
+**due_before:** `typing.Optional[dt.datetime]` — If provided, will only return tickets due before this datetime. + +
+
+
-**cursor:** `typing.Optional[str]` — The pagination cursor value. +**expand:** `typing.Optional[TicketsListRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -17321,7 +17429,7 @@ client.crm.tasks.remote_field_classes_list(
-**is_common_model_field:** `typing.Optional[bool]` — If provided, will only return remote field classes with this is_common_model_field value +**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
@@ -17329,7 +17437,7 @@ client.crm.tasks.remote_field_classes_list(
-**is_custom:** `typing.Optional[bool]` — If provided, will only return remote fields classes with this is_custom value +**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
@@ -17345,71 +17453,62 @@ client.crm.tasks.remote_field_classes_list(
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. +**parent_ticket_id:** `typing.Optional[str]` — If provided, will only return sub tickets of the parent_ticket_id.
- - - - - - -
-## Crm Users -
client.crm.users.list(...)
-#### 📝 Description - -
-
+**priority:** `typing.Optional[TicketsListRequestPriority]` -
-
+If provided, will only return tickets of this priority. -Returns a list of `User` objects. -
-
+* `URGENT` - URGENT +* `HIGH` - HIGH +* `NORMAL` - NORMAL +* `LOW` - LOW +
-#### 🔌 Usage - -
-
-
-```python -from merge import Merge +**remote_created_after:** `typing.Optional[dt.datetime]` — If provided, will only return tickets created in the third party platform after this datetime. + +
+
-client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.crm.users.list( - cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", -) +
+
-``` +**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. +
-#### ⚙️ Parameters -
+**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object. + +
+
+
-**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime. +**remote_updated_after:** `typing.Optional[dt.datetime]` — If provided, will only return tickets updated in the third party platform after this datetime.
@@ -17417,7 +17516,7 @@ client.crm.users.list(
-**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime. +**remote_updated_before:** `typing.Optional[dt.datetime]` — If provided, will only return tickets updated in the third party platform before this datetime.
@@ -17425,7 +17524,7 @@ client.crm.users.list(
-**cursor:** `typing.Optional[str]` — The pagination cursor value. +**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)
@@ -17433,7 +17532,7 @@ client.crm.users.list(
-**email:** `typing.Optional[str]` — If provided, will only return users with this email. +**status:** `typing.Optional[str]` — If provided, will only return tickets of this status.
@@ -17441,7 +17540,7 @@ client.crm.users.list(
-**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/). +**tags:** `typing.Optional[str]` — If provided, will only return tickets matching the tags; multiple tags can be separated by commas.
@@ -17449,7 +17548,7 @@ client.crm.users.list(
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. +**ticket_type:** `typing.Optional[str]` — If provided, will only return tickets of this type.
@@ -17457,7 +17556,7 @@ client.crm.users.list(
-**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. +**ticket_url:** `typing.Optional[str]` — If provided, will only return tickets where the URL matches or contains the substring
@@ -17465,23 +17564,71 @@ client.crm.users.list(
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+ + +
+
+
+
client.ticketing.tickets.create(...)
-**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned. - +#### 📝 Description + +
+
+ +
+
+ +Creates a `Ticket` object with the given values.
+
+
+ +#### 🔌 Usage
-**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned. +
+
+ +```python +from merge 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`
@@ -17489,7 +17636,7 @@ client.crm.users.list(
-**page_size:** `typing.Optional[int]` — Number of results to return per page. +**is_debug_mode:** `typing.Optional[bool]` — Whether to include debug fields (such as log file links) in the response.
@@ -17497,7 +17644,7 @@ client.crm.users.list(
-**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object. +**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously.
@@ -17517,7 +17664,7 @@ client.crm.users.list(
-
client.crm.users.retrieve(...) +
client.ticketing.tickets.retrieve(...)
@@ -17529,7 +17676,7 @@ client.crm.users.list(
-Returns a `User` object with the given `id`. +Returns a `Ticket` object with the given `id`.
@@ -17550,7 +17697,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.users.retrieve( +client.ticketing.tickets.retrieve( id="id", ) @@ -17576,6 +17723,14 @@ client.crm.users.retrieve(
+**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.
@@ -17600,6 +17755,22 @@ client.crm.users.retrieve(
+**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.
@@ -17612,7 +17783,7 @@ client.crm.users.retrieve(
-
client.crm.users.ignore_create(...) +
client.ticketing.tickets.partial_update(...)
@@ -17624,7 +17795,7 @@ client.crm.users.retrieve(
-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. +Updates a `Ticket` object with the given `id`.
@@ -17640,17 +17811,15 @@ Ignores a specific row based on the `model_id` in the url. These records will ha ```python from merge import Merge -from merge.resources.crm import IgnoreCommonModelRequest, ReasonEnum +from merge.resources.ticketing import PatchedTicketRequest 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, - ), +client.ticketing.tickets.partial_update( + id="id", + model=PatchedTicketRequest(), ) ``` @@ -17667,7 +17836,7 @@ client.crm.users.ignore_create(
-**model_id:** `str` +**id:** `str`
@@ -17675,7 +17844,23 @@ client.crm.users.ignore_create(
-**request:** `IgnoreCommonModelRequest` +**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.
@@ -17695,7 +17880,7 @@ client.crm.users.ignore_create(
-
client.crm.users.remote_field_classes_list(...) +
client.ticketing.tickets.viewers_list(...)
@@ -17707,7 +17892,7 @@ client.crm.users.ignore_create(
-Returns a list of `RemoteFieldClass` objects. +Returns a list of `Viewer` objects that point to a User id or Team id that is either an assignee or viewer on a `Ticket` with the given id. [Learn more.](https://help.merge.dev/en/articles/10333658-ticketing-access-control-list-acls)
@@ -17728,7 +17913,8 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.users.remote_field_classes_list( +client.ticketing.tickets.viewers_list( + ticket_id="ticket_id", cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", ) @@ -17746,15 +17932,7 @@ client.crm.users.remote_field_classes_list(
-**cursor:** `typing.Optional[str]` — The pagination cursor value. - -
-
- -
-
- -**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/). +**ticket_id:** `str`
@@ -17762,7 +17940,7 @@ client.crm.users.remote_field_classes_list(
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. +**cursor:** `typing.Optional[str]` — The pagination cursor value.
@@ -17770,7 +17948,7 @@ client.crm.users.remote_field_classes_list(
-**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. +**expand:** `typing.Optional[TicketsViewersListRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -17778,7 +17956,7 @@ client.crm.users.remote_field_classes_list(
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). +**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
@@ -17786,7 +17964,7 @@ client.crm.users.remote_field_classes_list(
-**is_common_model_field:** `typing.Optional[bool]` — If provided, will only return remote field classes with this is_common_model_field value +**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -17794,7 +17972,7 @@ client.crm.users.remote_field_classes_list(
-**is_custom:** `typing.Optional[bool]` — If provided, will only return remote fields classes with this is_custom value +**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -17822,8 +18000,7 @@ client.crm.users.remote_field_classes_list(
-## Crm WebhookReceivers -
client.crm.webhook_receivers.list() +
client.ticketing.tickets.meta_patch_retrieve(...)
@@ -17835,7 +18012,7 @@ client.crm.users.remote_field_classes_list(
-Returns a list of `WebhookReceiver` objects. +Returns metadata for `Ticket` PATCHs.
@@ -17856,7 +18033,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.webhook_receivers.list() +client.ticketing.tickets.meta_patch_retrieve( + id="id", +) ``` @@ -17872,6 +18051,14 @@ client.crm.webhook_receivers.list()
+**id:** `str` + +
+
+ +
+
+ **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -17884,7 +18071,7 @@ client.crm.webhook_receivers.list()
-
client.crm.webhook_receivers.create(...) +
client.ticketing.tickets.meta_post_retrieve(...)
@@ -17896,7 +18083,7 @@ client.crm.webhook_receivers.list()
-Creates a `WebhookReceiver` object with the given values. +Returns metadata for `Ticket` POSTs.
@@ -17917,10 +18104,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.webhook_receivers.create( - event="event", - is_active=True, -) +client.ticketing.tickets.meta_post_retrieve() ``` @@ -17936,15 +18120,7 @@ client.crm.webhook_receivers.create(
-**event:** `str` - -
-
- -
-
- -**is_active:** `bool` +**collection_id:** `typing.Optional[str]` — If provided, will only return tickets for this collection.
@@ -17952,7 +18128,7 @@ client.crm.webhook_receivers.create(
-**key:** `typing.Optional[str]` +**ticket_type:** `typing.Optional[str]` — If provided, will only return tickets for this ticket type.
@@ -17972,8 +18148,7 @@ client.crm.webhook_receivers.create(
-## Filestorage AccountDetails -
client.filestorage.account_details.retrieve() +
client.ticketing.tickets.remote_field_classes_list(...)
@@ -17985,7 +18160,7 @@ client.crm.webhook_receivers.create(
-Get details for a linked account. +Returns a list of `RemoteFieldClass` objects.
@@ -18006,7 +18181,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.filestorage.account_details.retrieve() +client.ticketing.tickets.remote_field_classes_list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -18022,71 +18199,63 @@ client.filestorage.account_details.retrieve()
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. +**cursor:** `typing.Optional[str]` — The pagination cursor value.
- -
+
+
+**ids:** `typing.Optional[str]` — If provided, will only return remote field classes with the `ids` in this list +
-
-## Filestorage AccountToken -
client.filestorage.account_token.retrieve(...)
-#### 📝 Description - -
-
+**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/). + +
+
-Returns the account token for the end user with the provided public token. -
-
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. +
-
- -#### 🔌 Usage +
+**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). + +
+
+
-```python -from merge import Merge - -client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.filestorage.account_token.retrieve( - public_token="public_token", -) - -``` -
-
+**is_common_model_field:** `typing.Optional[bool]` — If provided, will only return remote field classes with this is_common_model_field value + -#### ⚙️ Parameters -
+**is_custom:** `typing.Optional[bool]` — If provided, will only return remote fields classes with this is_custom value + +
+
+
-**public_token:** `str` +**page_size:** `typing.Optional[int]` — Number of results to return per page.
@@ -18106,8 +18275,8 @@ client.filestorage.account_token.retrieve(
-## Filestorage AsyncPassthrough -
client.filestorage.async_passthrough.create(...) +## Ticketing Users +
client.ticketing.users.list(...)
@@ -18119,7 +18288,7 @@ client.filestorage.account_token.retrieve(
-Asynchronously pull data from an endpoint not currently supported by Merge. +Returns a list of `User` objects.
@@ -18135,17 +18304,13 @@ Asynchronously pull data from an endpoint not currently supported by Merge. ```python from merge 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", - ), +client.ticketing.users.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", ) ``` @@ -18162,7 +18327,7 @@ client.filestorage.async_passthrough.create(
-**request:** `DataPassthroughRequest` +**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
@@ -18170,70 +18335,95 @@ client.filestorage.async_passthrough.create(
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. +**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
- -
+
+
+**cursor:** `typing.Optional[str]` — The pagination cursor value. +
-
-
client.filestorage.async_passthrough.retrieve(...)
-#### 📝 Description +**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. + +
+
+
-Retrieves data from earlier async-passthrough POST request +**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/). +
+ +
+
+ +**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. +
-#### 🔌 Usage -
+**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). + +
+
+
-```python -from merge import Merge +**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned. + +
+
-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", -) +
+
-``` +**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. +
-#### ⚙️ Parameters -
+**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object. + +
+
+
-**async_passthrough_receipt_id:** `str` +**team:** `typing.Optional[str]` — If provided, will only return users matching in this team.
@@ -18253,8 +18443,7 @@ client.filestorage.async_passthrough.retrieve(
-## Filestorage AuditTrail -
client.filestorage.audit_trail.list(...) +
client.ticketing.users.retrieve(...)
@@ -18266,7 +18455,7 @@ client.filestorage.async_passthrough.retrieve(
-Gets a list of audit trail events. +Returns a `User` object with the given `id`.
@@ -18287,8 +18476,8 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.filestorage.audit_trail.list( - cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +client.ticketing.users.retrieve( + id="id", ) ``` @@ -18305,23 +18494,7 @@ client.filestorage.audit_trail.list(
-**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`, `REGENERATED_WEBHOOK_SIGNATURE`, `INVITED_USER`, `TWO_FACTOR_AUTH_ENABLED`, `TWO_FACTOR_AUTH_DISABLED`, `DELETED_LINKED_ACCOUNT`, `DELETED_ALL_COMMON_MODELS_FOR_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`, `CREATED_LINKED_ACCOUNT_COMMON_MODEL_OVERRIDE`, `CHANGED_LINKED_ACCOUNT_COMMON_MODEL_OVERRIDE`, `DELETED_LINKED_ACCOUNT_COMMON_MODEL_OVERRIDE`, `FORCED_LINKED_ACCOUNT_RESYNC`, `MUTED_ISSUE`, `GENERATED_MAGIC_LINK`, `ENABLED_MERGE_WEBHOOK`, `DISABLED_MERGE_WEBHOOK`, `MERGE_WEBHOOK_TARGET_CHANGED`, `END_USER_CREDENTIALS_ACCESSED` +**id:** `str`
@@ -18329,7 +18502,7 @@ client.filestorage.audit_trail.list(
-**page_size:** `typing.Optional[int]` — Number of results to return per page. +**expand:** `typing.Optional[UsersRetrieveRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -18337,7 +18510,7 @@ client.filestorage.audit_trail.list(
-**start_date:** `typing.Optional[str]` — If included, will only include audit trail events that occurred after this time +**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -18345,7 +18518,7 @@ client.filestorage.audit_trail.list(
-**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. +**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -18365,8 +18538,8 @@ client.filestorage.audit_trail.list(
-## Filestorage AvailableActions -
client.filestorage.available_actions.retrieve() +## Ticketing WebhookReceivers +
client.ticketing.webhook_receivers.list()
@@ -18378,7 +18551,7 @@ client.filestorage.audit_trail.list(
-Returns a list of models and actions available for an account. +Returns a list of `WebhookReceiver` objects.
@@ -18399,7 +18572,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.filestorage.available_actions.retrieve() +client.ticketing.webhook_receivers.list() ``` @@ -18427,8 +18600,7 @@ client.filestorage.available_actions.retrieve()
-## Filestorage Scopes -
client.filestorage.scopes.default_scopes_retrieve() +
client.ticketing.webhook_receivers.create(...)
@@ -18440,7 +18612,7 @@ client.filestorage.available_actions.retrieve()
-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/5950052-common-model-and-field-scopes). +Creates a `WebhookReceiver` object with the given values.
@@ -18461,7 +18633,10 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.filestorage.scopes.default_scopes_retrieve() +client.ticketing.webhook_receivers.create( + event="event", + is_active=True, +) ``` @@ -18477,64 +18652,27 @@ client.filestorage.scopes.default_scopes_retrieve()
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. +**event:** `str`
- -
- - - - -
- -
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/5950052-common-model-and-field-scopes). -
-
+**is_active:** `bool` +
-#### 🔌 Usage -
-
-
- -```python -from merge import Merge - -client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.filestorage.scopes.linked_account_scopes_retrieve() - -``` -
-
+**key:** `typing.Optional[str]` +
-#### ⚙️ Parameters - -
-
-
@@ -18550,7 +18688,8 @@ client.filestorage.scopes.linked_account_scopes_retrieve()
-
client.filestorage.scopes.linked_account_scopes_create(...) +## Crm AccountDetails +
client.crm.account_details.retrieve()
@@ -18562,7 +18701,7 @@ client.filestorage.scopes.linked_account_scopes_retrieve()
-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/5950052-common-model-and-field-scopes) +Get details for a linked account.
@@ -18578,43 +18717,12 @@ Update permissions for any Common Model or field for a single Linked Account. An ```python from merge import Merge -from merge.resources.filestorage import ( - FieldPermissionDeserializerRequest, - 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, - ), - }, - field_permissions=FieldPermissionDeserializerRequest( - enabled_fields=["avatar", "home_location"], - disabled_fields=["work_location"], - ), - ), - IndividualCommonModelScopeDeserializerRequest( - model_name="Benefit", - model_permissions={ - "WRITE": ModelPermissionDeserializerRequest( - is_enabled=False, - ) - }, - ), - ], -) +client.crm.account_details.retrieve() ``` @@ -18622,19 +18730,11 @@ client.filestorage.scopes.linked_account_scopes_create(
-#### ⚙️ Parameters - -
-
+#### ⚙️ Parameters
-**common_models:** `typing.Sequence[IndividualCommonModelScopeDeserializerRequest]` — The common models you want to update the scopes for - -
-
-
@@ -18650,8 +18750,8 @@ client.filestorage.scopes.linked_account_scopes_create(
-## Filestorage DeleteAccount -
client.filestorage.delete_account.delete() +## Crm AccountToken +
client.crm.account_token.retrieve(...)
@@ -18663,7 +18763,7 @@ client.filestorage.scopes.linked_account_scopes_create(
-Delete a linked account. +Returns the account token for the end user with the provided public token.
@@ -18684,7 +18784,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.filestorage.delete_account.delete() +client.crm.account_token.retrieve( + public_token="public_token", +) ``` @@ -18700,6 +18802,14 @@ client.filestorage.delete_account.delete()
+**public_token:** `str` + +
+
+ +
+
+ **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -18712,8 +18822,8 @@ client.filestorage.delete_account.delete()
-## Filestorage Drives -
client.filestorage.drives.list(...) +## Crm Accounts +
client.crm.accounts.list(...)
@@ -18725,7 +18835,7 @@ client.filestorage.delete_account.delete()
-Returns a list of `Drive` objects. +Returns a list of `Account` objects.
@@ -18746,7 +18856,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.filestorage.drives.list( +client.crm.accounts.list( cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", ) @@ -18788,6 +18898,14 @@ client.filestorage.drives.list(
+**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]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
@@ -18804,6 +18922,14 @@ client.filestorage.drives.list(
+**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. + +
+
+ +
+
+ **include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -18828,7 +18954,15 @@ client.filestorage.drives.list(
-**name:** `typing.Optional[str]` — If provided, will only return drives with this name. This performs an exact match. +**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.
@@ -18864,7 +18998,7 @@ client.filestorage.drives.list(
-
client.filestorage.drives.retrieve(...) +
client.crm.accounts.create(...)
@@ -18876,7 +19010,7 @@ client.filestorage.drives.list(
-Returns a `Drive` object with the given `id`. +Creates an `Account` object with the given values.
@@ -18892,13 +19026,14 @@ Returns a `Drive` object with the given `id`. ```python from merge import Merge +from merge.resources.crm import AccountRequest client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.filestorage.drives.retrieve( - id="id", +client.crm.accounts.create( + model=AccountRequest(), ) ``` @@ -18915,23 +19050,7 @@ client.filestorage.drives.retrieve(
-**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_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). +**model:** `AccountRequest`
@@ -18939,69 +19058,15 @@ client.filestorage.drives.retrieve(
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. +**is_debug_mode:** `typing.Optional[bool]` — Whether to include debug fields (such as log file links) in the response. -
-
- -
- - - - -
- -## Filestorage FieldMapping -
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 import Merge - -client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.filestorage.field_mapping.field_mappings_retrieve() - -``` -
-
-#### ⚙️ Parameters - -
-
-
-**exclude_remote_field_metadata:** `typing.Optional[bool]` — If `true`, remote fields metadata is excluded from each field mapping instance (i.e. `remote_fields.remote_key_name` and `remote_fields.schema` will be null). This will increase the speed of the request since these fields require some calculations. +**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously.
@@ -19021,7 +19086,7 @@ client.filestorage.field_mapping.field_mappings_retrieve()
-
client.filestorage.field_mapping.field_mappings_create(...) +
client.crm.accounts.retrieve(...)
@@ -19033,7 +19098,7 @@ client.filestorage.field_mapping.field_mappings_retrieve()
-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. +Returns an `Account` object with the given `id`.
@@ -19054,13 +19119,8 @@ 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", +client.crm.accounts.retrieve( + id="id", ) ``` @@ -19077,39 +19137,7 @@ client.filestorage.field_mapping.field_mappings_create(
-**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.Optional[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. +**id:** `str`
@@ -19117,7 +19145,7 @@ client.filestorage.field_mapping.field_mappings_create(
-**common_model_name:** `str` — The name of the Common Model that the remote field corresponds to in a given category. +**expand:** `typing.Optional[typing.Literal["owner"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -19125,7 +19153,7 @@ client.filestorage.field_mapping.field_mappings_create(
-**exclude_remote_field_metadata:** `typing.Optional[bool]` — If `true`, remote fields metadata is excluded from each field mapping instance (i.e. `remote_fields.remote_key_name` and `remote_fields.schema` will be null). This will increase the speed of the request since these fields require some calculations. +**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -19133,70 +19161,15 @@ client.filestorage.field_mapping.field_mappings_create(
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. +**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.
- -
- - - - -
- -
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 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` +**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -19216,7 +19189,7 @@ client.filestorage.field_mapping.field_mappings_destroy(
-
client.filestorage.field_mapping.field_mappings_partial_update(...) +
client.crm.accounts.partial_update(...)
@@ -19228,7 +19201,7 @@ client.filestorage.field_mapping.field_mappings_destroy(
-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. +Updates an `Account` object with the given `id`.
@@ -19244,13 +19217,15 @@ Create or update existing Field Mappings for a Linked Account. Changes will be r ```python from merge import Merge +from merge.resources.crm import PatchedAccountRequest 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", +client.crm.accounts.partial_update( + id="id", + model=PatchedAccountRequest(), ) ``` @@ -19267,7 +19242,7 @@ client.filestorage.field_mapping.field_mappings_partial_update(
-**field_mapping_id:** `str` +**id:** `str`
@@ -19275,7 +19250,7 @@ client.filestorage.field_mapping.field_mappings_partial_update(
-**remote_field_traversal_path:** `typing.Optional[typing.Sequence[typing.Optional[typing.Any]]]` — The field traversal path of the remote field listed when you hit the GET /remote-fields endpoint. +**model:** `PatchedAccountRequest`
@@ -19283,7 +19258,7 @@ client.filestorage.field_mapping.field_mappings_partial_update(
-**remote_method:** `typing.Optional[str]` — The method of the remote endpoint where the remote field is coming from. +**is_debug_mode:** `typing.Optional[bool]` — Whether to include debug fields (such as log file links) in the response.
@@ -19291,7 +19266,7 @@ client.filestorage.field_mapping.field_mappings_partial_update(
-**remote_url_path:** `typing.Optional[str]` — The path of the remote endpoint where the remote field is coming from. +**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously.
@@ -19311,7 +19286,7 @@ client.filestorage.field_mapping.field_mappings_partial_update(
-
client.filestorage.field_mapping.remote_fields_retrieve(...) +
client.crm.accounts.meta_patch_retrieve(...)
@@ -19323,7 +19298,7 @@ client.filestorage.field_mapping.field_mappings_partial_update(
-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/). +Returns metadata for `CRMAccount` PATCHs.
@@ -19344,7 +19319,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.filestorage.field_mapping.remote_fields_retrieve() +client.crm.accounts.meta_patch_retrieve( + id="id", +) ``` @@ -19360,15 +19337,7 @@ client.filestorage.field_mapping.remote_fields_retrieve()
-**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. +**id:** `str`
@@ -19388,7 +19357,7 @@ client.filestorage.field_mapping.remote_fields_retrieve()
-
client.filestorage.field_mapping.target_fields_retrieve() +
client.crm.accounts.meta_post_retrieve()
@@ -19400,7 +19369,7 @@ client.filestorage.field_mapping.remote_fields_retrieve()
-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/). +Returns metadata for `CRMAccount` POSTs.
@@ -19421,7 +19390,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.filestorage.field_mapping.target_fields_retrieve() +client.crm.accounts.meta_post_retrieve() ``` @@ -19449,8 +19418,7 @@ client.filestorage.field_mapping.target_fields_retrieve()
-## Filestorage Files -
client.filestorage.files.list(...) +
client.crm.accounts.remote_field_classes_list(...)
@@ -19462,7 +19430,7 @@ client.filestorage.field_mapping.target_fields_retrieve()
-Returns a list of `File` objects. +Returns a list of `RemoteFieldClass` objects.
@@ -19483,7 +19451,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.filestorage.files.list( +client.crm.accounts.remote_field_classes_list( cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", ) @@ -19501,7 +19469,7 @@ client.filestorage.files.list(
-**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime. +**cursor:** `typing.Optional[str]` — The pagination cursor value.
@@ -19509,7 +19477,7 @@ client.filestorage.files.list(
-**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime. +**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
@@ -19517,7 +19485,7 @@ client.filestorage.files.list(
-**cursor:** `typing.Optional[str]` — The pagination cursor value. +**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -19525,7 +19493,7 @@ client.filestorage.files.list(
-**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. +**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.
@@ -19533,7 +19501,7 @@ client.filestorage.files.list(
-**expand:** `typing.Optional[FilesListRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. +**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -19541,7 +19509,7 @@ client.filestorage.files.list(
-**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. +**is_common_model_field:** `typing.Optional[bool]` — If provided, will only return remote field classes with this is_common_model_field value
@@ -19549,7 +19517,7 @@ client.filestorage.files.list(
-**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/). +**is_custom:** `typing.Optional[bool]` — If provided, will only return remote fields classes with this is_custom value
@@ -19557,7 +19525,7 @@ client.filestorage.files.list(
-**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.
@@ -19565,79 +19533,75 @@ client.filestorage.files.list(
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
- -
-
- -**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. -
+
+## Crm AsyncPassthrough +
client.crm.async_passthrough.create(...)
-**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned. - -
-
+#### 📝 Description
-**name:** `typing.Optional[str]` — If provided, will only return files with this name. This performs an exact match. - -
-
-
-**order_by:** `typing.Optional[FilesListRequestOrderBy]` — Overrides the default ordering for this endpoint. Possible values include: created_at, -created_at, modified_at, -modified_at. - +Asynchronously pull data from an endpoint not currently supported by Merge. +
+
+#### 🔌 Usage +
-**page_size:** `typing.Optional[int]` — Number of results to return per page. - -
-
-
-**remote_created_after:** `typing.Optional[dt.datetime]` — If provided, will only return files created in the third party platform after this datetime. - +```python +from merge 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 +
-**remote_created_before:** `typing.Optional[dt.datetime]` — If provided, will only return files created in the third party platform before this datetime. - -
-
-
-**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object. +**request:** `DataPassthroughRequest`
@@ -19657,7 +19621,7 @@ client.filestorage.files.list(
-
client.filestorage.files.create(...) +
client.crm.async_passthrough.retrieve(...)
@@ -19669,7 +19633,7 @@ client.filestorage.files.list(
-Creates a `File` object with the given values. +Retrieves data from earlier async-passthrough POST request
@@ -19685,14 +19649,13 @@ Creates a `File` object with the given values. ```python from merge 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(), +client.crm.async_passthrough.retrieve( + async_passthrough_receipt_id="async_passthrough_receipt_id", ) ``` @@ -19709,23 +19672,7 @@ client.filestorage.files.create(
-**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. +**async_passthrough_receipt_id:** `str`
@@ -19745,7 +19692,8 @@ client.filestorage.files.create(
-
client.filestorage.files.retrieve(...) +## Crm AuditTrail +
client.crm.audit_trail.list(...)
@@ -19757,7 +19705,7 @@ client.filestorage.files.create(
-Returns a `File` object with the given `id`. +Gets a list of audit trail events.
@@ -19778,8 +19726,8 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.filestorage.files.retrieve( - id="id", +client.crm.audit_trail.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", ) ``` @@ -19796,7 +19744,7 @@ client.filestorage.files.retrieve(
-**id:** `str` +**cursor:** `typing.Optional[str]` — The pagination cursor value.
@@ -19804,7 +19752,7 @@ client.filestorage.files.retrieve(
-**expand:** `typing.Optional[FilesRetrieveRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. +**end_date:** `typing.Optional[str]` — If included, will only include audit trail events that occurred before this time
@@ -19812,7 +19760,7 @@ client.filestorage.files.retrieve(
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. +**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`, `REGENERATED_WEBHOOK_SIGNATURE`, `INVITED_USER`, `TWO_FACTOR_AUTH_ENABLED`, `TWO_FACTOR_AUTH_DISABLED`, `DELETED_LINKED_ACCOUNT`, `DELETED_ALL_COMMON_MODELS_FOR_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`, `CREATED_LINKED_ACCOUNT_COMMON_MODEL_OVERRIDE`, `CHANGED_LINKED_ACCOUNT_COMMON_MODEL_OVERRIDE`, `DELETED_LINKED_ACCOUNT_COMMON_MODEL_OVERRIDE`, `FORCED_LINKED_ACCOUNT_RESYNC`, `MUTED_ISSUE`, `GENERATED_MAGIC_LINK`, `ENABLED_MERGE_WEBHOOK`, `DISABLED_MERGE_WEBHOOK`, `MERGE_WEBHOOK_TARGET_CHANGED`, `END_USER_CREDENTIALS_ACCESSED`
@@ -19820,7 +19768,23 @@ client.filestorage.files.retrieve(
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). +**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.
@@ -19840,7 +19804,8 @@ client.filestorage.files.retrieve(
-
client.filestorage.files.download_request_meta_retrieve(...) +## Crm AvailableActions +
client.crm.available_actions.retrieve()
@@ -19852,7 +19817,7 @@ client.filestorage.files.retrieve(
-Returns metadata to construct an authenticated file download request for a singular file, allowing you to download file directly from the third-party. +Returns a list of models and actions available for an account.
@@ -19873,9 +19838,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.filestorage.files.download_request_meta_retrieve( - id="id", -) +client.crm.available_actions.retrieve() ``` @@ -19891,22 +19854,6 @@ client.filestorage.files.download_request_meta_retrieve(
-**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.
@@ -19919,7 +19866,8 @@ client.filestorage.files.download_request_meta_retrieve(
-
client.filestorage.files.download_request_meta_list(...) +## Crm Contacts +
client.crm.contacts.list(...)
@@ -19931,7 +19879,7 @@ client.filestorage.files.download_request_meta_retrieve(
-Returns metadata to construct authenticated file download requests, allowing you to download files directly from the third-party. +Returns a list of `Contact` objects.
@@ -19952,7 +19900,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.filestorage.files.download_request_meta_list( +client.crm.contacts.list( cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", ) @@ -19970,7 +19918,47 @@ client.filestorage.files.download_request_meta_list(
-**created_after:** `typing.Optional[str]` — If provided, will only return objects created after this datetime. +**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.
@@ -19978,7 +19966,7 @@ client.filestorage.files.download_request_meta_list(
-**created_before:** `typing.Optional[str]` — If provided, will only return objects created before this datetime. +**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
@@ -19986,7 +19974,7 @@ client.filestorage.files.download_request_meta_list(
-**cursor:** `typing.Optional[str]` — The pagination cursor value. +**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -19994,7 +19982,7 @@ client.filestorage.files.download_request_meta_list(
-**ids:** `typing.Optional[typing.Union[str, typing.Sequence[str]]]` — If provided, will only return objects with the given IDs. Comma-separated list of strings. +**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.
@@ -20002,7 +19990,7 @@ client.filestorage.files.download_request_meta_list(
-**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/). +**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -20010,7 +19998,7 @@ client.filestorage.files.download_request_meta_list(
-**mime_types:** `typing.Optional[str]` — A comma-separated list of preferred MIME types in order of priority. If supported by the third-party provider, the file(s) will be returned in the first supported MIME type from the list. The default MIME type is PDF. To see supported MIME types by file type, refer to our export format help center article. +**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
@@ -20018,7 +20006,7 @@ client.filestorage.files.download_request_meta_list(
-**modified_after:** `typing.Optional[str]` — If provided, will only return objects modified after this datetime. +**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
@@ -20026,7 +20014,7 @@ client.filestorage.files.download_request_meta_list(
-**modified_before:** `typing.Optional[str]` — If provided, will only return objects modified before this datetime. +**page_size:** `typing.Optional[int]` — Number of results to return per page.
@@ -20034,7 +20022,7 @@ client.filestorage.files.download_request_meta_list(
-**order_by:** `typing.Optional[FilesDownloadRequestMetaListRequestOrderBy]` — Overrides the default ordering for this endpoint. Possible values include: created_at, -created_at, modified_at, -modified_at. +**phone_numbers:** `typing.Optional[str]` — If provided, will only return contacts matching the phone numbers; multiple phone numbers can be separated by commas.
@@ -20042,7 +20030,7 @@ client.filestorage.files.download_request_meta_list(
-**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.
@@ -20062,7 +20050,7 @@ client.filestorage.files.download_request_meta_list(
-
client.filestorage.files.meta_post_retrieve() +
client.crm.contacts.create(...)
@@ -20074,7 +20062,7 @@ client.filestorage.files.download_request_meta_list(
-Returns metadata for `FileStorageFile` POSTs. +Creates a `Contact` object with the given values.
@@ -20090,12 +20078,15 @@ Returns metadata for `FileStorageFile` POSTs. ```python from merge import Merge +from merge.resources.crm import ContactRequest client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.filestorage.files.meta_post_retrieve() +client.crm.contacts.create( + model=ContactRequest(), +) ``` @@ -20111,6 +20102,30 @@ client.filestorage.files.meta_post_retrieve()
+**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.
@@ -20123,8 +20138,7 @@ client.filestorage.files.meta_post_retrieve()
-## Filestorage Folders -
client.filestorage.folders.list(...) +
client.crm.contacts.retrieve(...)
@@ -20136,7 +20150,7 @@ client.filestorage.files.meta_post_retrieve()
-Returns a list of `Folder` objects. +Returns a `Contact` object with the given `id`.
@@ -20157,8 +20171,8 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.filestorage.folders.list( - cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +client.crm.contacts.retrieve( + id="id", ) ``` @@ -20175,7 +20189,7 @@ client.filestorage.folders.list(
-**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime. +**id:** `str`
@@ -20183,7 +20197,7 @@ client.filestorage.folders.list(
-**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime. +**expand:** `typing.Optional[ContactsRetrieveRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -20191,7 +20205,7 @@ client.filestorage.folders.list(
-**cursor:** `typing.Optional[str]` — The pagination cursor value. +**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -20199,7 +20213,7 @@ client.filestorage.folders.list(
-**drive_id:** `typing.Optional[str]` — If provided, will only return folders in this drive. +**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.
@@ -20207,7 +20221,7 @@ client.filestorage.folders.list(
-**expand:** `typing.Optional[FoldersListRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. +**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -20215,47 +20229,72 @@ client.filestorage.folders.list(
-**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/). +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+ +
-
-
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. -
+
+
client.crm.contacts.partial_update(...)
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). - -
-
+#### 📝 Description
-**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned. - +
+
+ +Updates a `Contact` object with the given `id`. +
+
+#### 🔌 Usage +
-**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned. - +
+
+ +```python +from merge 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
-**name:** `typing.Optional[str]` — If provided, will only return folders with this name. This performs an exact match. +
+
+ +**id:** `str`
@@ -20263,7 +20302,7 @@ client.filestorage.folders.list(
-**page_size:** `typing.Optional[int]` — Number of results to return per page. +**model:** `PatchedContactRequest`
@@ -20271,7 +20310,7 @@ client.filestorage.folders.list(
-**parent_folder_id:** `typing.Optional[str]` — If provided, will only return folders in this parent folder. If null, will return folders in root directory. +**is_debug_mode:** `typing.Optional[bool]` — Whether to include debug fields (such as log file links) in the response.
@@ -20279,7 +20318,7 @@ client.filestorage.folders.list(
-**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object. +**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously.
@@ -20299,7 +20338,7 @@ client.filestorage.folders.list(
-
client.filestorage.folders.create(...) +
client.crm.contacts.ignore_create(...)
@@ -20311,7 +20350,7 @@ client.filestorage.folders.list(
-Creates a `Folder` object with the given values. +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.
@@ -20327,14 +20366,17 @@ Creates a `Folder` object with the given values. ```python from merge import Merge -from merge.resources.filestorage import FolderRequest +from merge.resources.crm import IgnoreCommonModelRequest, ReasonEnum client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.filestorage.folders.create( - model=FolderRequest(), +client.crm.contacts.ignore_create( + model_id="model_id", + request=IgnoreCommonModelRequest( + reason=ReasonEnum.GENERAL_CUSTOMER_REQUEST, + ), ) ``` @@ -20351,15 +20393,7 @@ client.filestorage.folders.create(
-**model:** `FolderRequest` - -
-
- -
-
- -**is_debug_mode:** `typing.Optional[bool]` — Whether to include debug fields (such as log file links) in the response. +**model_id:** `str`
@@ -20367,7 +20401,7 @@ client.filestorage.folders.create(
-**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously. +**request:** `IgnoreCommonModelRequest`
@@ -20387,7 +20421,7 @@ client.filestorage.folders.create(
-
client.filestorage.folders.retrieve(...) +
client.crm.contacts.meta_patch_retrieve(...)
@@ -20399,7 +20433,7 @@ client.filestorage.folders.create(
-Returns a `Folder` object with the given `id`. +Returns metadata for `CRMContact` PATCHs.
@@ -20420,7 +20454,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.filestorage.folders.retrieve( +client.crm.contacts.meta_patch_retrieve( id="id", ) @@ -20446,30 +20480,6 @@ client.filestorage.folders.retrieve(
-**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. - -
-
- -
-
- -**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). - -
-
- -
-
- **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -20482,7 +20492,7 @@ client.filestorage.folders.retrieve(
-
client.filestorage.folders.meta_post_retrieve() +
client.crm.contacts.meta_post_retrieve()
@@ -20494,7 +20504,7 @@ client.filestorage.folders.retrieve(
-Returns metadata for `FileStorageFolder` POSTs. +Returns metadata for `CRMContact` POSTs.
@@ -20515,7 +20525,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.filestorage.folders.meta_post_retrieve() +client.crm.contacts.meta_post_retrieve() ``` @@ -20543,8 +20553,7 @@ client.filestorage.folders.meta_post_retrieve()
-## Filestorage GenerateKey -
client.filestorage.generate_key.create(...) +
client.crm.contacts.remote_field_classes_list(...)
@@ -20556,7 +20565,7 @@ client.filestorage.folders.meta_post_retrieve()
-Create a remote key. +Returns a list of `RemoteFieldClass` objects.
@@ -20577,8 +20586,8 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.filestorage.generate_key.create( - name="Remote Deployment Key 1", +client.crm.contacts.remote_field_classes_list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", ) ``` @@ -20595,7 +20604,63 @@ client.filestorage.generate_key.create(
-**name:** `str` — The name of the remote key +**cursor:** `typing.Optional[str]` — The pagination cursor value. + +
+
+ +
+
+ +**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/). + +
+
+ +
+
+ +**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. + +
+
+ +
+
+ +**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). + +
+
+ +
+
+ +**is_common_model_field:** `typing.Optional[bool]` — If provided, will only return remote field classes with this is_common_model_field value + +
+
+ +
+
+ +**is_custom:** `typing.Optional[bool]` — If provided, will only return remote fields classes with this is_custom value + +
+
+ +
+
+ +**page_size:** `typing.Optional[int]` — Number of results to return per page.
@@ -20615,8 +20680,8 @@ client.filestorage.generate_key.create(
-## Filestorage Groups -
client.filestorage.groups.list(...) +## Crm CustomObjectClasses +
client.crm.custom_object_classes.list(...)
@@ -20628,7 +20693,7 @@ client.filestorage.generate_key.create(
-Returns a list of `Group` objects. +Returns a list of `CustomObjectClass` objects.
@@ -20649,7 +20714,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.filestorage.groups.list( +client.crm.custom_object_classes.list( cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", ) @@ -20691,7 +20756,7 @@ client.filestorage.groups.list(
-**expand:** `typing.Optional[typing.Literal["child_groups"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. +**expand:** `typing.Optional[typing.Literal["fields"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -20767,7 +20832,7 @@ client.filestorage.groups.list(
-
client.filestorage.groups.retrieve(...) +
client.crm.custom_object_classes.retrieve(...)
@@ -20779,7 +20844,7 @@ client.filestorage.groups.list(
-Returns a `Group` object with the given `id`. +Returns a `CustomObjectClass` object with the given `id`.
@@ -20800,7 +20865,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.filestorage.groups.retrieve( +client.crm.custom_object_classes.retrieve( id="id", ) @@ -20826,7 +20891,7 @@ client.filestorage.groups.retrieve(
-**expand:** `typing.Optional[typing.Literal["child_groups"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. +**expand:** `typing.Optional[typing.Literal["fields"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -20862,8 +20927,8 @@ client.filestorage.groups.retrieve(
-## Filestorage Issues -
client.filestorage.issues.list(...) +## Crm AssociationTypes +
client.crm.association_types.custom_object_classes_association_types_list(...)
@@ -20875,7 +20940,7 @@ client.filestorage.groups.retrieve(
-Gets all issues for Organization. +Returns a list of `AssociationType` objects.
@@ -20896,7 +20961,8 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.filestorage.issues.list( +client.crm.association_types.custom_object_classes_association_types_list( + custom_object_class_id="custom_object_class_id", cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", ) @@ -20914,15 +20980,7 @@ client.filestorage.issues.list(
-**account_token:** `typing.Optional[str]` - -
-
- -
-
- -**cursor:** `typing.Optional[str]` — The pagination cursor value. +**custom_object_class_id:** `str`
@@ -20930,7 +20988,7 @@ client.filestorage.issues.list(
-**end_date:** `typing.Optional[str]` — If included, will only include issues whose most recent action occurred before this time +**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
@@ -20938,7 +20996,7 @@ client.filestorage.issues.list(
-**end_user_organization_name:** `typing.Optional[str]` +**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
@@ -20946,7 +21004,7 @@ client.filestorage.issues.list(
-**first_incident_time_after:** `typing.Optional[dt.datetime]` — If provided, will only return issues whose first incident time was after this datetime. +**cursor:** `typing.Optional[str]` — The pagination cursor value.
@@ -20954,7 +21012,7 @@ client.filestorage.issues.list(
-**first_incident_time_before:** `typing.Optional[dt.datetime]` — If provided, will only return issues whose first incident time was before this datetime. +**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.
@@ -20962,7 +21020,7 @@ client.filestorage.issues.list(
-**include_muted:** `typing.Optional[str]` — If true, will include muted issues +**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
@@ -20970,7 +21028,7 @@ client.filestorage.issues.list(
-**integration_name:** `typing.Optional[str]` +**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -20978,7 +21036,7 @@ client.filestorage.issues.list(
-**last_incident_time_after:** `typing.Optional[dt.datetime]` — If provided, will only return issues whose last incident time was after this datetime. +**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -20986,7 +21044,7 @@ client.filestorage.issues.list(
-**last_incident_time_before:** `typing.Optional[dt.datetime]` — If provided, will only return issues whose last incident time was before this datetime. +**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
@@ -20994,7 +21052,7 @@ client.filestorage.issues.list(
-**linked_account_id:** `typing.Optional[str]` — If provided, will only include issues pertaining to the linked account passed in. +**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
@@ -21010,20 +21068,7 @@ client.filestorage.issues.list(
-**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 +**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
@@ -21043,7 +21088,7 @@ Status of the issue. Options: ('ONGOING', 'RESOLVED')
-
client.filestorage.issues.retrieve(...) +
client.crm.association_types.custom_object_classes_association_types_create(...)
@@ -21055,7 +21100,7 @@ Status of the issue. Options: ('ONGOING', 'RESOLVED')
-Get a specific issue. +Creates an `AssociationType` object with the given values.
@@ -21071,13 +21116,31 @@ Get a specific issue. ```python from merge import Merge +from merge.resources.crm import ( + AssociationTypeRequestRequest, + ObjectClassDescriptionRequest, + OriginTypeEnum, +) client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.filestorage.issues.retrieve( - id="id", +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", + ), ) ``` @@ -21094,7 +21157,31 @@ client.filestorage.issues.retrieve(
-**id:** `str` +**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.
@@ -21114,8 +21201,7 @@ client.filestorage.issues.retrieve(
-## Filestorage LinkToken -
client.filestorage.link_token.create(...) +
client.crm.association_types.custom_object_classes_association_types_retrieve(...)
@@ -21127,7 +21213,7 @@ client.filestorage.issues.retrieve(
-Creates a link token to be used when linking a new end user. +Returns an `AssociationType` object with the given `id`.
@@ -21143,17 +21229,14 @@ Creates a link token to be used when linking a new end user. ```python from merge 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], +client.crm.association_types.custom_object_classes_association_types_retrieve( + custom_object_class_id="custom_object_class_id", + id="id", ) ``` @@ -21170,7 +21253,7 @@ client.filestorage.link_token.create(
-**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. +**custom_object_class_id:** `str`
@@ -21178,7 +21261,7 @@ client.filestorage.link_token.create(
-**end_user_organization_name:** `str` — Your end user's organization. +**id:** `str`
@@ -21186,7 +21269,7 @@ client.filestorage.link_token.create(
-**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. +**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.
@@ -21194,7 +21277,7 @@ client.filestorage.link_token.create(
-**categories:** `typing.Sequence[CategoriesEnum]` — The integration categories to show in Merge Link. +**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -21202,7 +21285,7 @@ client.filestorage.link_token.create(
-**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/. +**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -21210,75 +21293,70 @@ client.filestorage.link_token.create(
-**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. +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+ +
-
-
-**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. -
+
+
client.crm.association_types.custom_object_classes_association_types_meta_post_retrieve(...)
-**hide_admin_magic_link:** `typing.Optional[bool]` — Whether to generate a Magic Link URL on the Admin Needed screen during the linking flow. Defaults to false. For more information on Magic Link, see https://merge.dev/blog/integrations-fast-say-hello-to-magic-link. - -
-
+#### 📝 Description
-**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. - +Returns metadata for `CRMAssociationType` POSTs. +
+
+#### 🔌 Usage +
-**language:** `typing.Optional[LanguageEnum]` +
+
-The following subset of IETF language tags can be used to configure localization. +```python +from merge import Merge -* `en` - en -* `de` - de - +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 +
-**are_syncs_disabled:** `typing.Optional[bool]` — The boolean that indicates whether initial, periodic, and force syncs will be disabled. - -
-
-
-**integration_specific_config:** `typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]]` — A JSON object containing integration-specific configuration options. +**custom_object_class_id:** `str`
@@ -21298,8 +21376,8 @@ The following subset of IETF language tags can be used to configure localization
-## Filestorage LinkedAccounts -
client.filestorage.linked_accounts.list(...) +## Crm CustomObjects +
client.crm.custom_objects.custom_object_classes_custom_objects_list(...)
@@ -21311,7 +21389,7 @@ The following subset of IETF language tags can be used to configure localization
-List linked accounts for your organization. +Returns a list of `CustomObject` objects.
@@ -21332,7 +21410,8 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.filestorage.linked_accounts.list( +client.crm.custom_objects.custom_object_classes_custom_objects_list( + custom_object_class_id="custom_object_class_id", cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", ) @@ -21350,25 +21429,7 @@ client.filestorage.linked_accounts.list(
-**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. +**custom_object_class_id:** `str`
@@ -21376,7 +21437,7 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing`
-**end_user_email_address:** `typing.Optional[str]` — If provided, will only return linked accounts associated with the given email address. +**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
@@ -21384,7 +21445,7 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing`
-**end_user_organization_name:** `typing.Optional[str]` — If provided, will only return linked accounts associated with the given organization name. +**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
@@ -21392,7 +21453,7 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing`
-**end_user_origin_id:** `typing.Optional[str]` — If provided, will only return linked accounts associated with the given origin ID. +**cursor:** `typing.Optional[str]` — The pagination cursor value.
@@ -21400,7 +21461,7 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing`
-**end_user_origin_ids:** `typing.Optional[str]` — Comma-separated list of EndUser origin IDs, making it possible to specify multiple EndUsers at once. +**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
@@ -21408,7 +21469,7 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing`
-**id:** `typing.Optional[str]` +**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -21416,7 +21477,7 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing`
-**ids:** `typing.Optional[str]` — Comma-separated list of LinkedAccount IDs, making it possible to specify multiple LinkedAccounts at once. +**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.
@@ -21424,7 +21485,7 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing`
-**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. +**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -21432,7 +21493,7 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing`
-**integration_name:** `typing.Optional[str]` — If provided, will only return linked accounts associated with the given integration name. +**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
@@ -21440,7 +21501,7 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing`
-**is_test_account:** `typing.Optional[str]` — If included, will only include test linked accounts. If not included, will only include non-test linked accounts. +**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
@@ -21456,7 +21517,7 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing`
-**status:** `typing.Optional[str]` — Filter by status. Options: `COMPLETE`, `IDLE`, `INCOMPLETE`, `RELINK_NEEDED` +**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
@@ -21476,8 +21537,7 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing`
-## Filestorage Passthrough -
client.filestorage.passthrough.create(...) +
client.crm.custom_objects.custom_object_classes_custom_objects_create(...)
@@ -21489,7 +21549,7 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing`
-Pull data from an endpoint not currently supported by Merge. +Creates a `CustomObject` object with the given values.
@@ -21505,16 +21565,16 @@ Pull data from an endpoint not currently supported by Merge. ```python from merge import Merge -from merge.resources.filestorage import DataPassthroughRequest, MethodEnum +from merge.resources.crm import CustomObjectRequest client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.filestorage.passthrough.create( - request=DataPassthroughRequest( - method=MethodEnum.GET, - path="/scooters", +client.crm.custom_objects.custom_object_classes_custom_objects_create( + custom_object_class_id="custom_object_class_id", + model=CustomObjectRequest( + fields={"test_field": "hello"}, ), ) @@ -21532,7 +21592,7 @@ client.filestorage.passthrough.create(
-**request:** `DataPassthroughRequest` +**custom_object_class_id:** `str`
@@ -21540,71 +21600,23 @@ client.filestorage.passthrough.create(
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. +**model:** `CustomObjectRequest`
- -
- - - - -
- -## Filestorage RegenerateKey -
client.filestorage.regenerate_key.create(...) -
-
- -#### 📝 Description - -
-
- -
-
- -Exchange remote keys. -
-
-
-
- -#### 🔌 Usage
-
-
- -```python -from merge import Merge - -client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.filestorage.regenerate_key.create( - name="Remote Deployment Key 1", -) - -``` -
-
+**is_debug_mode:** `typing.Optional[bool]` — Whether to include debug fields (such as log file links) in the response. +
-#### ⚙️ Parameters - -
-
-
-**name:** `str` — The name of the remote key +**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously.
@@ -21624,8 +21636,7 @@ client.filestorage.regenerate_key.create(
-## Filestorage SyncStatus -
client.filestorage.sync_status.list(...) +
client.crm.custom_objects.custom_object_classes_custom_objects_retrieve(...)
@@ -21637,7 +21648,7 @@ client.filestorage.regenerate_key.create(
-Get sync status for the current sync and the most recently finished sync. `last_sync_start` represents the most recent time any sync began. `last_sync_finished` represents the most recent time any sync completed. These timestamps may correspond to different sync instances which may result in a sync start time being later than a separate sync completed time. To ensure you are retrieving the latest available data reference the `last_sync_finished` timestamp where `last_sync_result` is `DONE`. Possible values for `status` and `last_sync_result` are `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). +Returns a `CustomObject` object with the given `id`.
@@ -21658,8 +21669,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.filestorage.sync_status.list( - cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +client.crm.custom_objects.custom_object_classes_custom_objects_retrieve( + custom_object_class_id="custom_object_class_id", + id="id", ) ``` @@ -21676,7 +21688,7 @@ client.filestorage.sync_status.list(
-**cursor:** `typing.Optional[str]` — The pagination cursor value. +**custom_object_class_id:** `str`
@@ -21684,7 +21696,31 @@ client.filestorage.sync_status.list(
-**page_size:** `typing.Optional[int]` — Number of results to return per page. +**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. + +
+
+ +
+
+ +**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -21704,8 +21740,7 @@ client.filestorage.sync_status.list(
-## Filestorage ForceResync -
client.filestorage.force_resync.sync_status_resync_create() +
client.crm.custom_objects.custom_object_classes_custom_objects_meta_post_retrieve(...)
@@ -21717,7 +21752,7 @@ client.filestorage.sync_status.list(
-Force re-sync of all models. This endpoint is available for monthly, quarterly, and highest sync frequency customers on the Professional or Enterprise plans. Doing so will consume a sync credit for the relevant linked account. Force re-syncs can also be triggered manually in the Merge Dashboard and is available for all customers. +Returns metadata for `CRMCustomObject` POSTs.
@@ -21738,7 +21773,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.filestorage.force_resync.sync_status_resync_create() +client.crm.custom_objects.custom_object_classes_custom_objects_meta_post_retrieve( + custom_object_class_id="custom_object_class_id", +) ``` @@ -21754,6 +21791,14 @@ client.filestorage.force_resync.sync_status_resync_create()
+**custom_object_class_id:** `str` + +
+
+ +
+
+ **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -21766,8 +21811,7 @@ client.filestorage.force_resync.sync_status_resync_create()
-## Filestorage Users -
client.filestorage.users.list(...) +
client.crm.custom_objects.custom_object_classes_custom_objects_remote_field_classes_list(...)
@@ -21779,7 +21823,7 @@ client.filestorage.force_resync.sync_status_resync_create()
-Returns a list of `User` objects. +Returns a list of `RemoteFieldClass` objects.
@@ -21800,7 +21844,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.filestorage.users.list( +client.crm.custom_objects.custom_object_classes_custom_objects_remote_field_classes_list( cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", ) @@ -21818,22 +21862,6 @@ client.filestorage.users.list(
-**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.
@@ -21858,7 +21886,7 @@ client.filestorage.users.list(
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). +**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.
@@ -21866,7 +21894,7 @@ client.filestorage.users.list(
-**is_me:** `typing.Optional[str]` — If provided, will only return the user object for requestor. +**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -21874,7 +21902,7 @@ client.filestorage.users.list(
-**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned. +**is_common_model_field:** `typing.Optional[bool]` — If provided, will only return remote field classes with this is_common_model_field value
@@ -21882,7 +21910,7 @@ client.filestorage.users.list(
-**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned. +**is_custom:** `typing.Optional[bool]` — If provided, will only return remote fields classes with this is_custom value
@@ -21898,14 +21926,6 @@ client.filestorage.users.list(
-**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object. - -
-
- -
-
- **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -21918,7 +21938,8 @@ client.filestorage.users.list(
-
client.filestorage.users.retrieve(...) +## Crm Associations +
client.crm.associations.custom_object_classes_custom_objects_associations_list(...)
@@ -21930,7 +21951,7 @@ client.filestorage.users.list(
-Returns a `User` object with the given `id`. +Returns a list of `Association` objects.
@@ -21951,8 +21972,10 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.filestorage.users.retrieve( - id="id", +client.crm.associations.custom_object_classes_custom_objects_associations_list( + custom_object_class_id="custom_object_class_id", + object_id="object_id", + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", ) ``` @@ -21969,15 +21992,7 @@ client.filestorage.users.retrieve(
-**id:** `str` - -
-
- -
-
- -**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. +**custom_object_class_id:** `str`
@@ -21985,7 +22000,7 @@ client.filestorage.users.retrieve(
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). +**object_id:** `str`
@@ -21993,133 +22008,79 @@ client.filestorage.users.retrieve(
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. +**association_type_id:** `typing.Optional[str]` — If provided, will only return opportunities with this association_type.
-
- -
- - - - -
- -## Filestorage WebhookReceivers -
client.filestorage.webhook_receivers.list() -
-
- -#### 📝 Description - -
-
- -
-
- -Returns a list of `WebhookReceiver` objects. -
-
-
-
- -#### 🔌 Usage - -
-
- -
-
- -```python -from merge 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. +**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. +
-
-
client.filestorage.webhook_receivers.create(...)
-#### 📝 Description +**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. + +
+
+
-Creates a `WebhookReceiver` object with the given values. -
-
+**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/). + -#### 🔌 Usage -
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. + +
+
+
-```python -from merge import Merge - -client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.filestorage.webhook_receivers.create( - event="event", - is_active=True, -) - -``` -
-
+**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). + -#### ⚙️ Parameters -
+**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned. + +
+
+
-**event:** `str` +**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
@@ -22127,7 +22088,7 @@ client.filestorage.webhook_receivers.create(
-**is_active:** `bool` +**page_size:** `typing.Optional[int]` — Number of results to return per page.
@@ -22135,7 +22096,7 @@ client.filestorage.webhook_receivers.create(
-**key:** `typing.Optional[str]` +**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
@@ -22155,8 +22116,7 @@ client.filestorage.webhook_receivers.create(
-## Hris AccountDetails -
client.hris.account_details.retrieve() +
client.crm.associations.custom_object_classes_custom_objects_associations_update(...)
@@ -22168,7 +22128,7 @@ client.filestorage.webhook_receivers.create(
-Get details for a linked account. +Creates an Association between `source_object_id` and `target_object_id` of type `association_type_id`.
@@ -22189,7 +22149,13 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.account_details.retrieve() +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", +) ``` @@ -22205,71 +22171,55 @@ client.hris.account_details.retrieve()
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. +**association_type_id:** `str`
- -
+
+
+**source_class_id:** `str` +
-
-## Hris AccountToken -
client.hris.account_token.retrieve(...)
-#### 📝 Description - -
-
+**source_object_id:** `str` + +
+
-Returns the account token for the end user with the provided public token. -
-
+**target_class_id:** `str` +
-#### 🔌 Usage - -
-
-
-```python -from merge import Merge - -client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.hris.account_token.retrieve( - public_token="public_token", -) - -``` -
-
+**target_object_id:** `str` +
-#### ⚙️ Parameters -
+**is_debug_mode:** `typing.Optional[bool]` — Whether to include debug fields (such as log file links) in the response. + +
+
+
-**public_token:** `str` +**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously.
@@ -22289,8 +22239,8 @@ client.hris.account_token.retrieve(
-## Hris AsyncPassthrough -
client.hris.async_passthrough.create(...) +## Crm Scopes +
client.crm.scopes.default_scopes_retrieve()
@@ -22302,7 +22252,7 @@ client.hris.account_token.retrieve(
-Asynchronously pull data from an endpoint not currently supported by Merge. +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/5950052-common-model-and-field-scopes).
@@ -22318,18 +22268,12 @@ Asynchronously pull data from an endpoint not currently supported by Merge. ```python from merge 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", - ), -) +client.crm.scopes.default_scopes_retrieve() ``` @@ -22345,14 +22289,6 @@ client.hris.async_passthrough.create(
-**request:** `DataPassthroughRequest` - -
-
- -
-
- **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -22365,7 +22301,7 @@ client.hris.async_passthrough.create(
-
client.hris.async_passthrough.retrieve(...) +
client.crm.scopes.linked_account_scopes_retrieve()
@@ -22377,7 +22313,7 @@ client.hris.async_passthrough.create(
-Retrieves data from earlier async-passthrough POST request +Get all available permissions for Merge Common Models and fields for a single Linked Account. [Learn more](https://help.merge.dev/en/articles/5950052-common-model-and-field-scopes).
@@ -22398,9 +22334,7 @@ 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", -) +client.crm.scopes.linked_account_scopes_retrieve() ``` @@ -22416,14 +22350,6 @@ client.hris.async_passthrough.retrieve(
-**async_passthrough_receipt_id:** `str` - -
-
- -
-
- **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -22436,8 +22362,7 @@ client.hris.async_passthrough.retrieve(
-## Hris AuditTrail -
client.hris.audit_trail.list(...) +
client.crm.scopes.linked_account_scopes_create(...)
@@ -22449,7 +22374,7 @@ client.hris.async_passthrough.retrieve(
-Gets a list of audit trail events. +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/5950052-common-model-and-field-scopes)
@@ -22465,13 +22390,42 @@ Gets a list of audit trail events. ```python from merge import Merge +from merge.resources.crm import ( + FieldPermissionDeserializerRequest, + IndividualCommonModelScopeDeserializerRequest, + ModelPermissionDeserializerRequest, +) client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.audit_trail.list( - cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +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, + ), + }, + field_permissions=FieldPermissionDeserializerRequest( + enabled_fields=["avatar", "home_location"], + disabled_fields=["work_location"], + ), + ), + IndividualCommonModelScopeDeserializerRequest( + model_name="Benefit", + model_permissions={ + "WRITE": ModelPermissionDeserializerRequest( + is_enabled=False, + ) + }, + ), + ], ) ``` @@ -22488,47 +22442,7 @@ client.hris.audit_trail.list(
-**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`, `REGENERATED_WEBHOOK_SIGNATURE`, `INVITED_USER`, `TWO_FACTOR_AUTH_ENABLED`, `TWO_FACTOR_AUTH_DISABLED`, `DELETED_LINKED_ACCOUNT`, `DELETED_ALL_COMMON_MODELS_FOR_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`, `CREATED_LINKED_ACCOUNT_COMMON_MODEL_OVERRIDE`, `CHANGED_LINKED_ACCOUNT_COMMON_MODEL_OVERRIDE`, `DELETED_LINKED_ACCOUNT_COMMON_MODEL_OVERRIDE`, `FORCED_LINKED_ACCOUNT_RESYNC`, `MUTED_ISSUE`, `GENERATED_MAGIC_LINK`, `ENABLED_MERGE_WEBHOOK`, `DISABLED_MERGE_WEBHOOK`, `MERGE_WEBHOOK_TARGET_CHANGED`, `END_USER_CREDENTIALS_ACCESSED` - -
-
- -
-
- -**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. +**common_models:** `typing.Sequence[IndividualCommonModelScopeDeserializerRequest]` — The common models you want to update the scopes for
@@ -22548,8 +22462,8 @@ client.hris.audit_trail.list(
-## Hris AvailableActions -
client.hris.available_actions.retrieve() +## Crm DeleteAccount +
client.crm.delete_account.delete()
@@ -22561,7 +22475,7 @@ client.hris.audit_trail.list(
-Returns a list of models and actions available for an account. +Delete a linked account.
@@ -22582,7 +22496,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.available_actions.retrieve() +client.crm.delete_account.delete() ``` @@ -22610,8 +22524,8 @@ client.hris.available_actions.retrieve()
-## Hris BankInfo -
client.hris.bank_info.list(...) +## Crm EngagementTypes +
client.crm.engagement_types.list(...)
@@ -22623,7 +22537,7 @@ client.hris.available_actions.retrieve()
-Returns a list of `BankInfo` objects. +Returns a list of `EngagementType` objects.
@@ -22644,7 +22558,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.bank_info.list( +client.crm.engagement_types.list( cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", ) @@ -22662,27 +22576,6 @@ client.hris.bank_info.list(
-**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.
@@ -22707,15 +22600,7 @@ If provided, will only return BankInfo's with this account type. Options: ('SAVI
-**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]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
@@ -22723,7 +22608,7 @@ If provided, will only return BankInfo's with this account type. Options: ('SAVI
-**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/). +**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -22731,7 +22616,7 @@ If provided, will only return BankInfo's with this account type. Options: ('SAVI
-**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.
@@ -22763,14 +22648,6 @@ If provided, will only return BankInfo's with this account type. Options: ('SAVI
-**order_by:** `typing.Optional[BankInfoListRequestOrderBy]` — Overrides the default ordering for this endpoint. Possible values include: remote_created_at, -remote_created_at. - -
-
- -
-
- **page_size:** `typing.Optional[int]` — Number of results to return per page.
@@ -22779,14 +22656,6 @@ If provided, will only return BankInfo's with this account type. Options: ('SAVI
-**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.
@@ -22795,14 +22664,6 @@ If provided, will only return BankInfo's with this account type. Options: ('SAVI
-**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.
@@ -22815,7 +22676,7 @@ If provided, will only return BankInfo's with this account type. Options: ('SAVI
-
client.hris.bank_info.retrieve(...) +
client.crm.engagement_types.retrieve(...)
@@ -22827,7 +22688,7 @@ If provided, will only return BankInfo's with this account type. Options: ('SAVI
-Returns a `BankInfo` object with the given `id`. +Returns an `EngagementType` object with the given `id`.
@@ -22848,7 +22709,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.bank_info.retrieve( +client.crm.engagement_types.retrieve( id="id", ) @@ -22874,14 +22735,6 @@ client.hris.bank_info.retrieve(
-**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.
@@ -22890,15 +22743,7 @@ client.hris.bank_info.retrieve(
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). - -
-
- -
-
- -**remote_fields:** `typing.Optional[typing.Literal["account_type"]]` — Deprecated. Use show_enum_origins. +**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.
@@ -22906,7 +22751,7 @@ client.hris.bank_info.retrieve(
-**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) +**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -22926,8 +22771,7 @@ client.hris.bank_info.retrieve(
-## Hris Benefits -
client.hris.benefits.list(...) +
client.crm.engagement_types.remote_field_classes_list(...)
@@ -22939,7 +22783,7 @@ client.hris.bank_info.retrieve(
-Returns a list of `Benefit` objects. +Returns a list of `RemoteFieldClass` objects.
@@ -22960,7 +22804,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.benefits.list( +client.crm.engagement_types.remote_field_classes_list( cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", ) @@ -22978,22 +22822,6 @@ client.hris.benefits.list(
-**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.
@@ -23002,22 +22830,6 @@ client.hris.benefits.list(
-**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]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
@@ -23034,7 +22846,7 @@ client.hris.benefits.list(
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). +**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.
@@ -23042,7 +22854,7 @@ client.hris.benefits.list(
-**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned. +**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -23050,7 +22862,7 @@ client.hris.benefits.list(
-**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned. +**is_common_model_field:** `typing.Optional[bool]` — If provided, will only return remote field classes with this is_common_model_field value
@@ -23058,7 +22870,7 @@ client.hris.benefits.list(
-**page_size:** `typing.Optional[int]` — Number of results to return per page. +**is_custom:** `typing.Optional[bool]` — If provided, will only return remote fields classes with this is_custom value
@@ -23066,7 +22878,7 @@ client.hris.benefits.list(
-**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object. +**page_size:** `typing.Optional[int]` — Number of results to return per page.
@@ -23086,7 +22898,8 @@ client.hris.benefits.list(
-
client.hris.benefits.retrieve(...) +## Crm Engagements +
client.crm.engagements.list(...)
@@ -23098,7 +22911,7 @@ client.hris.benefits.list(
-Returns a `Benefit` object with the given `id`. +Returns a list of `Engagement` objects.
@@ -23119,8 +22932,8 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.benefits.retrieve( - id="id", +client.crm.engagements.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", ) ``` @@ -23137,7 +22950,7 @@ client.hris.benefits.retrieve(
-**id:** `str` +**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
@@ -23145,7 +22958,7 @@ client.hris.benefits.retrieve(
-**expand:** `typing.Optional[typing.Literal["employee"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. +**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
@@ -23153,7 +22966,7 @@ client.hris.benefits.retrieve(
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. +**cursor:** `typing.Optional[str]` — The pagination cursor value.
@@ -23161,7 +22974,7 @@ client.hris.benefits.retrieve(
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). +**expand:** `typing.Optional[EngagementsListRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -23169,71 +22982,71 @@ client.hris.benefits.retrieve(
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. +**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
- -
+
+
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. +
-
-## Hris Companies -
client.hris.companies.list(...)
-#### 📝 Description +**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. + +
+
+**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). + +
+
+
-Returns a list of `Company` objects. -
-
+**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned. + -#### 🔌 Usage -
+**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned. + +
+
+
-```python -from merge import Merge - -client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.hris.companies.list( - cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", -) - -``` -
-
+**page_size:** `typing.Optional[int]` — Number of results to return per page. + -#### ⚙️ Parameters -
+**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object. + +
+
+
-**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime. +**started_after:** `typing.Optional[dt.datetime]` — If provided, will only return engagements started after this datetime.
@@ -23241,7 +23054,7 @@ client.hris.companies.list(
-**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime. +**started_before:** `typing.Optional[dt.datetime]` — If provided, will only return engagements started before this datetime.
@@ -23249,47 +23062,71 @@ client.hris.companies.list(
-**cursor:** `typing.Optional[str]` — The pagination cursor value. +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+ + + + + + +
+
client.crm.engagements.create(...)
-**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/). - +#### 📝 Description + +
+
+ +
+
+ +Creates an `Engagement` object with the given values.
+
+
+ +#### 🔌 Usage
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. - +
+
+ +```python +from merge 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(), +) + +```
- -
-
- -**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). -
+#### ⚙️ Parameters +
-**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. +**model:** `EngagementRequest`
@@ -23297,7 +23134,7 @@ client.hris.companies.list(
-**page_size:** `typing.Optional[int]` — Number of results to return per page. +**is_debug_mode:** `typing.Optional[bool]` — Whether to include debug fields (such as log file links) in the response.
@@ -23305,7 +23142,7 @@ client.hris.companies.list(
-**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object. +**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously.
@@ -23325,7 +23162,7 @@ client.hris.companies.list(
-
client.hris.companies.retrieve(...) +
client.crm.engagements.retrieve(...)
@@ -23337,7 +23174,7 @@ client.hris.companies.list(
-Returns a `Company` object with the given `id`. +Returns an `Engagement` object with the given `id`.
@@ -23358,7 +23195,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.companies.retrieve( +client.crm.engagements.retrieve( id="id", ) @@ -23384,6 +23221,14 @@ client.hris.companies.retrieve(
+**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.
@@ -23392,6 +23237,14 @@ client.hris.companies.retrieve(
+**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. + +
+
+ +
+
+ **include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -23412,8 +23265,7 @@ client.hris.companies.retrieve(
-## Hris Scopes -
client.hris.scopes.default_scopes_retrieve() +
client.crm.engagements.partial_update(...)
@@ -23425,7 +23277,7 @@ client.hris.companies.retrieve(
-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/5950052-common-model-and-field-scopes). +Updates an `Engagement` object with the given `id`.
@@ -23441,12 +23293,16 @@ Get the default permissions for Merge Common Models and fields across all Linked ```python from merge import Merge +from merge.resources.crm import PatchedEngagementRequest client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.scopes.default_scopes_retrieve() +client.crm.engagements.partial_update( + id="id", + model=PatchedEngagementRequest(), +) ``` @@ -23462,64 +23318,35 @@ client.hris.scopes.default_scopes_retrieve()
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. +**id:** `str`
- -
- - - - -
-
client.hris.scopes.linked_account_scopes_retrieve()
-#### 📝 Description - -
-
+**model:** `PatchedEngagementRequest` + +
+
-Get all available permissions for Merge Common Models and fields for a single Linked Account. [Learn more](https://help.merge.dev/en/articles/5950052-common-model-and-field-scopes). -
-
+**is_debug_mode:** `typing.Optional[bool]` — Whether to include debug fields (such as log file links) in the response. +
-#### 🔌 Usage - -
-
-
-```python -from merge import Merge - -client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.hris.scopes.linked_account_scopes_retrieve() - -``` -
-
+**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously. +
-#### ⚙️ Parameters - -
-
-
@@ -23535,7 +23362,7 @@ client.hris.scopes.linked_account_scopes_retrieve()
-
client.hris.scopes.linked_account_scopes_create(...) +
client.crm.engagements.meta_patch_retrieve(...)
@@ -23547,7 +23374,7 @@ client.hris.scopes.linked_account_scopes_retrieve()
-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/5950052-common-model-and-field-scopes) +Returns metadata for `Engagement` PATCHs.
@@ -23563,42 +23390,13 @@ Update permissions for any Common Model or field for a single Linked Account. An ```python from merge import Merge -from merge.resources.hris import ( - FieldPermissionDeserializerRequest, - 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, - ), - }, - field_permissions=FieldPermissionDeserializerRequest( - enabled_fields=["avatar", "home_location"], - disabled_fields=["work_location"], - ), - ), - IndividualCommonModelScopeDeserializerRequest( - model_name="Benefit", - model_permissions={ - "WRITE": ModelPermissionDeserializerRequest( - is_enabled=False, - ) - }, - ), - ], +client.crm.engagements.meta_patch_retrieve( + id="id", ) ``` @@ -23615,7 +23413,7 @@ client.hris.scopes.linked_account_scopes_create(
-**common_models:** `typing.Sequence[IndividualCommonModelScopeDeserializerRequest]` — The common models you want to update the scopes for +**id:** `str`
@@ -23635,8 +23433,7 @@ client.hris.scopes.linked_account_scopes_create(
-## Hris DeleteAccount -
client.hris.delete_account.delete() +
client.crm.engagements.meta_post_retrieve()
@@ -23648,7 +23445,7 @@ client.hris.scopes.linked_account_scopes_create(
-Delete a linked account. +Returns metadata for `Engagement` POSTs.
@@ -23669,7 +23466,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.delete_account.delete() +client.crm.engagements.meta_post_retrieve() ``` @@ -23697,8 +23494,7 @@ client.hris.delete_account.delete()
-## Hris Dependents -
client.hris.dependents.list(...) +
client.crm.engagements.remote_field_classes_list(...)
@@ -23710,7 +23506,7 @@ client.hris.delete_account.delete()
-Returns a list of `Dependent` objects. +Returns a list of `RemoteFieldClass` objects.
@@ -23731,7 +23527,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.dependents.list( +client.crm.engagements.remote_field_classes_list( cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", ) @@ -23749,7 +23545,7 @@ client.hris.dependents.list(
-**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime. +**cursor:** `typing.Optional[str]` — The pagination cursor value.
@@ -23757,7 +23553,7 @@ client.hris.dependents.list(
-**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime. +**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
@@ -23765,7 +23561,7 @@ client.hris.dependents.list(
-**cursor:** `typing.Optional[str]` — The pagination cursor value. +**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -23773,7 +23569,7 @@ client.hris.dependents.list(
-**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/). +**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.
@@ -23781,7 +23577,7 @@ client.hris.dependents.list(
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. +**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -23789,7 +23585,7 @@ client.hris.dependents.list(
-**include_sensitive_fields:** `typing.Optional[bool]` — Whether to include sensitive fields (such as social security numbers) in the response. +**is_common_model_field:** `typing.Optional[bool]` — If provided, will only return remote field classes with this is_common_model_field value
@@ -23797,7 +23593,7 @@ client.hris.dependents.list(
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). +**is_custom:** `typing.Optional[bool]` — If provided, will only return remote fields classes with this is_custom value
@@ -23805,7 +23601,7 @@ client.hris.dependents.list(
-**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned. +**page_size:** `typing.Optional[int]` — Number of results to return per page.
@@ -23813,23 +23609,69 @@ client.hris.dependents.list(
-**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned. +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+ +
+ + + + +
+ +## Crm FieldMapping +
client.crm.field_mapping.field_mappings_retrieve(...) +
+
+ +#### 📝 Description
-**page_size:** `typing.Optional[int]` — Number of results to return per page. - +
+
+ +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
-**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object. +
+
+ +```python +from merge import Merge + +client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.crm.field_mapping.field_mappings_retrieve() + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**exclude_remote_field_metadata:** `typing.Optional[bool]` — If `true`, remote fields metadata is excluded from each field mapping instance (i.e. `remote_fields.remote_key_name` and `remote_fields.schema` will be null). This will increase the speed of the request since these fields require some calculations.
@@ -23849,7 +23691,7 @@ client.hris.dependents.list(
-
client.hris.dependents.retrieve(...) +
client.crm.field_mapping.field_mappings_create(...)
@@ -23861,7 +23703,7 @@ client.hris.dependents.list(
-Returns a `Dependent` object with the given `id`. +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.
@@ -23882,8 +23724,13 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.dependents.retrieve( - id="id", +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", ) ``` @@ -23892,15 +23739,39 @@ client.hris.dependents.retrieve(
-#### ⚙️ Parameters - +#### ⚙️ 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.Optional[typing.Any]]` — The field traversal path of the remote field listed when you hit the GET /remote-fields endpoint. + +
+
+
-**id:** `str` +**remote_method:** `str` — The method of the remote endpoint where the remote field is coming from.
@@ -23908,7 +23779,7 @@ client.hris.dependents.retrieve(
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. +**remote_url_path:** `str` — The path of the remote endpoint where the remote field is coming from.
@@ -23916,7 +23787,7 @@ client.hris.dependents.retrieve(
-**include_sensitive_fields:** `typing.Optional[bool]` — Whether to include sensitive fields (such as social security numbers) in the response. +**common_model_name:** `str` — The name of the Common Model that the remote field corresponds to in a given category.
@@ -23924,7 +23795,7 @@ client.hris.dependents.retrieve(
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). +**exclude_remote_field_metadata:** `typing.Optional[bool]` — If `true`, remote fields metadata is excluded from each field mapping instance (i.e. `remote_fields.remote_key_name` and `remote_fields.schema` will be null). This will increase the speed of the request since these fields require some calculations.
@@ -23944,8 +23815,7 @@ client.hris.dependents.retrieve(
-## Hris EmployeePayrollRuns -
client.hris.employee_payroll_runs.list(...) +
client.crm.field_mapping.field_mappings_destroy(...)
@@ -23957,7 +23827,7 @@ client.hris.dependents.retrieve(
-Returns a list of `EmployeePayrollRun` objects. +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.
@@ -23978,8 +23848,8 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.employee_payroll_runs.list( - cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +client.crm.field_mapping.field_mappings_destroy( + field_mapping_id="field_mapping_id", ) ``` @@ -23996,7 +23866,7 @@ client.hris.employee_payroll_runs.list(
-**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime. +**field_mapping_id:** `str`
@@ -24004,103 +23874,70 @@ client.hris.employee_payroll_runs.list(
-**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime. +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
- -
-
- -**cursor:** `typing.Optional[str]` — The pagination cursor value. -
-
-
-**employee_id:** `typing.Optional[str]` — If provided, will only return employee payroll runs for this employee. -
+
+
client.crm.field_mapping.field_mappings_partial_update(...)
-**ended_after:** `typing.Optional[dt.datetime]` — If provided, will only return employee payroll runs ended after this datetime. - -
-
+#### 📝 Description
-**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. - +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.
- -
-
- -**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/). -
+#### 🔌 Usage +
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. - -
-
-
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). - -
-
+```python +from merge 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", +) -**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. -
+#### ⚙️ Parameters +
-**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. +**field_mapping_id:** `str`
@@ -24108,7 +23945,7 @@ client.hris.employee_payroll_runs.list(
-**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object. +**remote_field_traversal_path:** `typing.Optional[typing.Sequence[typing.Optional[typing.Any]]]` — The field traversal path of the remote field listed when you hit the GET /remote-fields endpoint.
@@ -24116,7 +23953,7 @@ client.hris.employee_payroll_runs.list(
-**started_after:** `typing.Optional[dt.datetime]` — If provided, will only return employee payroll runs started after this datetime. +**remote_method:** `typing.Optional[str]` — The method of the remote endpoint where the remote field is coming from.
@@ -24124,7 +23961,7 @@ client.hris.employee_payroll_runs.list(
-**started_before:** `typing.Optional[dt.datetime]` — If provided, will only return employee payroll runs started before this datetime. +**remote_url_path:** `typing.Optional[str]` — The path of the remote endpoint where the remote field is coming from.
@@ -24144,7 +23981,7 @@ client.hris.employee_payroll_runs.list(
-
client.hris.employee_payroll_runs.retrieve(...) +
client.crm.field_mapping.remote_fields_retrieve(...)
@@ -24156,7 +23993,7 @@ client.hris.employee_payroll_runs.list(
-Returns an `EmployeePayrollRun` object with the given `id`. +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/).
@@ -24177,9 +24014,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.employee_payroll_runs.retrieve( - id="id", -) +client.crm.field_mapping.remote_fields_retrieve() ``` @@ -24195,23 +24030,7 @@ client.hris.employee_payroll_runs.retrieve(
-**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. +**common_models:** `typing.Optional[str]` — A comma seperated list of Common Model names. If included, will only return Remote Fields for those Common Models.
@@ -24219,7 +24038,7 @@ client.hris.employee_payroll_runs.retrieve(
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). +**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.
@@ -24239,8 +24058,7 @@ client.hris.employee_payroll_runs.retrieve(
-## Hris Employees -
client.hris.employees.list(...) +
client.crm.field_mapping.target_fields_retrieve()
@@ -24252,7 +24070,7 @@ client.hris.employee_payroll_runs.retrieve(
-Returns a list of `Employee` objects. +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/).
@@ -24273,9 +24091,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.employees.list( - cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", -) +client.crm.field_mapping.target_fields_retrieve() ``` @@ -24291,77 +24107,71 @@ client.hris.employees.list(
-**company_id:** `typing.Optional[str]` — If provided, will only return employees for this company. +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+ +
-
-
-**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime. -
+
+## Crm GenerateKey +
client.crm.generate_key.create(...)
-**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime. - -
-
+#### 📝 Description
-**cursor:** `typing.Optional[str]` — The pagination cursor value. - -
-
-
-**display_full_name:** `typing.Optional[str]` — If provided, will only return employees with this display name. - +Create a remote key.
+ + + +#### 🔌 Usage
-**employment_status:** `typing.Optional[EmployeesListRequestEmploymentStatus]` +
+
-If provided, will only return employees with this employment status. +```python +from merge import Merge -* `ACTIVE` - ACTIVE -* `PENDING` - PENDING -* `INACTIVE` - INACTIVE - +client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.crm.generate_key.create( + name="Remote Deployment Key 1", +) + +```
- -
-
- -**employment_type:** `typing.Optional[str]` — If provided, will only return employees that have an employment of the specified employment_type. -
+#### ⚙️ Parameters +
-**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. +**name:** `str` — The name of the remote key
@@ -24369,79 +24179,71 @@ If provided, will only return employees with this employment status.
-**groups:** `typing.Optional[str]` — If provided, will only return employees matching the group ids; multiple groups can be separated by commas. +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
-
-
-**home_location_id:** `typing.Optional[str]` — If provided, will only return employees for this home location. -
+
+## Crm Issues +
client.crm.issues.list(...)
-**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/). - -
-
+#### 📝 Description
-**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. - +Gets all issues for Organization. +
+
+#### 🔌 Usage +
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). - -
-
-
-**job_title:** `typing.Optional[str]` — If provided, will only return employees that have an employment of the specified job_title. - +```python +from merge import Merge + +client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.crm.issues.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) + +```
- -
-
- -**last_name:** `typing.Optional[str]` — If provided, will only return employees with this last name. -
+#### ⚙️ Parameters +
-**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. +**account_token:** `typing.Optional[str]`
@@ -24449,7 +24251,7 @@ If provided, will only return employees with this employment status.
-**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned. +**cursor:** `typing.Optional[str]` — The pagination cursor value.
@@ -24457,7 +24259,7 @@ If provided, will only return employees with this employment status.
-**page_size:** `typing.Optional[int]` — Number of results to return per page. +**end_date:** `typing.Optional[str]` — If included, will only include issues whose most recent action occurred before this time
@@ -24465,7 +24267,7 @@ If provided, will only return employees with this employment status.
-**pay_group_id:** `typing.Optional[str]` — If provided, will only return employees for this pay group +**end_user_organization_name:** `typing.Optional[str]`
@@ -24473,7 +24275,7 @@ If provided, will only return employees with this employment status.
-**personal_email:** `typing.Optional[str]` — If provided, will only return Employees with this personal email +**first_incident_time_after:** `typing.Optional[dt.datetime]` — If provided, will only return issues whose first incident time was after this datetime.
@@ -24481,7 +24283,7 @@ If provided, will only return employees with this employment status.
-**remote_fields:** `typing.Optional[EmployeesListRequestRemoteFields]` — Deprecated. Use show_enum_origins. +**first_incident_time_before:** `typing.Optional[dt.datetime]` — If provided, will only return issues whose first incident time was before this datetime.
@@ -24489,7 +24291,7 @@ If provided, will only return employees with this employment status.
-**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object. +**include_muted:** `typing.Optional[str]` — If true, will include muted issues
@@ -24497,7 +24299,7 @@ If provided, will only return employees with this employment status.
-**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) +**integration_name:** `typing.Optional[str]`
@@ -24505,7 +24307,7 @@ If provided, will only return employees with this employment status.
-**started_after:** `typing.Optional[dt.datetime]` — If provided, will only return employees that started after this datetime. +**last_incident_time_after:** `typing.Optional[dt.datetime]` — If provided, will only return issues whose last incident time was after this datetime.
@@ -24513,7 +24315,7 @@ If provided, will only return employees with this employment status.
-**started_before:** `typing.Optional[dt.datetime]` — If provided, will only return employees that started before this datetime. +**last_incident_time_before:** `typing.Optional[dt.datetime]` — If provided, will only return issues whose last incident time was before this datetime.
@@ -24521,7 +24323,7 @@ If provided, will only return employees with this employment status.
-**team_id:** `typing.Optional[str]` — If provided, will only return employees for this team. +**linked_account_id:** `typing.Optional[str]` — If provided, will only include issues pertaining to the linked account passed in.
@@ -24529,7 +24331,7 @@ If provided, will only return employees with this employment status.
-**terminated_after:** `typing.Optional[dt.datetime]` — If provided, will only return employees that were terminated after this datetime. +**page_size:** `typing.Optional[int]` — Number of results to return per page.
@@ -24537,7 +24339,7 @@ If provided, will only return employees with this employment status.
-**terminated_before:** `typing.Optional[dt.datetime]` — If provided, will only return employees that were terminated before this datetime. +**start_date:** `typing.Optional[str]` — If included, will only include issues whose most recent action occurred after this time
@@ -24545,15 +24347,12 @@ If provided, will only return employees with this employment status.
-**work_email:** `typing.Optional[str]` — If provided, will only return Employees with this work email - -
-
+**status:** `typing.Optional[IssuesListRequestStatus]` -
-
+Status of the issue. Options: ('ONGOING', 'RESOLVED') -**work_location_id:** `typing.Optional[str]` — If provided, will only return employees for this location. +* `ONGOING` - ONGOING +* `RESOLVED` - RESOLVED
@@ -24573,7 +24372,7 @@ If provided, will only return employees with this employment status.
-
client.hris.employees.create(...) +
client.crm.issues.retrieve(...)
@@ -24585,7 +24384,7 @@ If provided, will only return employees with this employment status.
-Creates an `Employee` object with the given values. +Get a specific issue.
@@ -24601,14 +24400,13 @@ Creates an `Employee` object with the given values. ```python from merge 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(), +client.crm.issues.retrieve( + id="id", ) ``` @@ -24625,23 +24423,7 @@ client.hris.employees.create(
-**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. +**id:** `str`
@@ -24661,7 +24443,8 @@ client.hris.employees.create(
-
client.hris.employees.retrieve(...) +## Crm Leads +
client.crm.leads.list(...)
@@ -24673,7 +24456,7 @@ client.hris.employees.create(
-Returns an `Employee` object with the given `id`. +Returns a list of `Lead` objects.
@@ -24694,8 +24477,8 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.employees.retrieve( - id="id", +client.crm.leads.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", ) ``` @@ -24712,7 +24495,7 @@ client.hris.employees.retrieve(
-**id:** `str` +**converted_account_id:** `typing.Optional[str]` — If provided, will only return leads with this account.
@@ -24720,7 +24503,7 @@ client.hris.employees.retrieve(
-**expand:** `typing.Optional[EmployeesRetrieveRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. +**converted_contact_id:** `typing.Optional[str]` — If provided, will only return leads with this contact.
@@ -24728,7 +24511,7 @@ client.hris.employees.retrieve(
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. +**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
@@ -24736,7 +24519,7 @@ client.hris.employees.retrieve(
-**include_sensitive_fields:** `typing.Optional[bool]` — Whether to include sensitive fields (such as social security numbers) in the response. +**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
@@ -24744,7 +24527,7 @@ client.hris.employees.retrieve(
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). +**cursor:** `typing.Optional[str]` — The pagination cursor value.
@@ -24752,7 +24535,7 @@ client.hris.employees.retrieve(
-**remote_fields:** `typing.Optional[EmployeesRetrieveRequestRemoteFields]` — Deprecated. Use show_enum_origins. +**email_addresses:** `typing.Optional[str]` — If provided, will only return contacts matching the email addresses; multiple email_addresses can be separated by commas.
@@ -24760,7 +24543,7 @@ client.hris.employees.retrieve(
-**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) +**expand:** `typing.Optional[LeadsListRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -24768,72 +24551,63 @@ client.hris.employees.retrieve(
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. +**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
- -
+
+
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. +
-
-
client.hris.employees.ignore_create(...)
-#### 📝 Description - -
-
+**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. + +
+
-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. -
-
+**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). +
-#### 🔌 Usage -
+**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned. + +
+
+
-```python -from merge 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, -) - -``` -
-
+**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned. + -#### ⚙️ Parameters -
+**owner_id:** `typing.Optional[str]` — If provided, will only return leads with this owner. + +
+
+
-**model_id:** `str` +**page_size:** `typing.Optional[int]` — Number of results to return per page.
@@ -24841,7 +24615,7 @@ client.hris.employees.ignore_create(
-**reason:** `IgnoreCommonModelRequestReason` +**phone_numbers:** `typing.Optional[str]` — If provided, will only return contacts matching the phone numbers; multiple phone numbers can be separated by commas.
@@ -24849,7 +24623,7 @@ client.hris.employees.ignore_create(
-**message:** `typing.Optional[str]` +**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
@@ -24869,7 +24643,7 @@ client.hris.employees.ignore_create(
-
client.hris.employees.meta_post_retrieve() +
client.crm.leads.create(...)
@@ -24881,7 +24655,7 @@ client.hris.employees.ignore_create(
-Returns metadata for `Employee` POSTs. +Creates a `Lead` object with the given values.
@@ -24897,12 +24671,15 @@ Returns metadata for `Employee` POSTs. ```python from merge import Merge +from merge.resources.crm import LeadRequest client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.employees.meta_post_retrieve() +client.crm.leads.create( + model=LeadRequest(), +) ``` @@ -24918,6 +24695,30 @@ client.hris.employees.meta_post_retrieve()
+**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.
@@ -24930,8 +24731,7 @@ client.hris.employees.meta_post_retrieve()
-## Hris EmployerBenefits -
client.hris.employer_benefits.list(...) +
client.crm.leads.retrieve(...)
@@ -24943,7 +24743,7 @@ client.hris.employees.meta_post_retrieve()
-Returns a list of `EmployerBenefit` objects. +Returns a `Lead` object with the given `id`.
@@ -24964,8 +24764,8 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.employer_benefits.list( - cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +client.crm.leads.retrieve( + id="id", ) ``` @@ -24982,7 +24782,7 @@ client.hris.employer_benefits.list(
-**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime. +**id:** `str`
@@ -24990,7 +24790,7 @@ client.hris.employer_benefits.list(
-**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime. +**expand:** `typing.Optional[LeadsRetrieveRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -24998,7 +24798,7 @@ client.hris.employer_benefits.list(
-**cursor:** `typing.Optional[str]` — The pagination cursor value. +**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -25006,7 +24806,7 @@ client.hris.employer_benefits.list(
-**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/). +**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.
@@ -25014,7 +24814,7 @@ client.hris.employer_benefits.list(
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. +**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -25022,43 +24822,64 @@ client.hris.employer_benefits.list(
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+ +
-
-
-**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned. -
+
+ +
client.crm.leads.meta_post_retrieve() +
+
+ +#### 📝 Description
-**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned. - +
+
+ +Returns metadata for `Lead` POSTs. +
+
+#### 🔌 Usage +
-**page_size:** `typing.Optional[int]` — Number of results to return per page. - +
+
+ +```python +from merge import Merge + +client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.crm.leads.meta_post_retrieve() + +``` +
+
+#### ⚙️ Parameters +
-**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object. - -
-
-
@@ -25074,7 +24895,7 @@ client.hris.employer_benefits.list(
-
client.hris.employer_benefits.retrieve(...) +
client.crm.leads.remote_field_classes_list(...)
@@ -25086,7 +24907,7 @@ client.hris.employer_benefits.list(
-Returns an `EmployerBenefit` object with the given `id`. +Returns a list of `RemoteFieldClass` objects.
@@ -25107,8 +24928,8 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.employer_benefits.retrieve( - id="id", +client.crm.leads.remote_field_classes_list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", ) ``` @@ -25125,7 +24946,15 @@ client.hris.employer_benefits.retrieve(
-**id:** `str` +**cursor:** `typing.Optional[str]` — The pagination cursor value. + +
+
+ +
+
+ +**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
@@ -25141,6 +24970,14 @@ client.hris.employer_benefits.retrieve(
+**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. + +
+
+ +
+
+ **include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -25149,6 +24986,30 @@ client.hris.employer_benefits.retrieve(
+**is_common_model_field:** `typing.Optional[bool]` — If provided, will only return remote field classes with this is_common_model_field value + +
+
+ +
+
+ +**is_custom:** `typing.Optional[bool]` — If provided, will only return remote fields classes with this is_custom value + +
+
+ +
+
+ +**page_size:** `typing.Optional[int]` — Number of results to return per page. + +
+
+ +
+
+ **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -25161,8 +25022,8 @@ client.hris.employer_benefits.retrieve(
-## Hris Employments -
client.hris.employments.list(...) +## Crm LinkToken +
client.crm.link_token.create(...)
@@ -25174,7 +25035,7 @@ client.hris.employer_benefits.retrieve(
-Returns a list of `Employment` objects. +Creates a link token to be used when linking a new end user.
@@ -25190,13 +25051,17 @@ Returns a list of `Employment` objects. ```python from merge import Merge +from merge.resources.crm import CategoriesEnum client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.employments.list( - cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +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], ) ``` @@ -25213,15 +25078,7 @@ client.hris.employments.list(
-**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. +**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.
@@ -25229,7 +25086,7 @@ client.hris.employments.list(
-**cursor:** `typing.Optional[str]` — The pagination cursor value. +**end_user_organization_name:** `str` — Your end user's organization.
@@ -25237,7 +25094,7 @@ client.hris.employments.list(
-**employee_id:** `typing.Optional[str]` — If provided, will only return employments for this employee. +**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.
@@ -25245,7 +25102,7 @@ client.hris.employments.list(
-**expand:** `typing.Optional[EmploymentsListRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. +**categories:** `typing.Sequence[CategoriesEnum]` — The integration categories to show in Merge Link.
@@ -25253,7 +25110,7 @@ client.hris.employments.list(
-**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/). +**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/.
@@ -25261,7 +25118,7 @@ client.hris.employments.list(
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. +**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.
@@ -25269,7 +25126,7 @@ client.hris.employments.list(
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). +**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.
@@ -25277,7 +25134,7 @@ client.hris.employments.list(
-**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned. +**hide_admin_magic_link:** `typing.Optional[bool]` — Whether to generate a Magic Link URL on the Admin Needed screen during the linking flow. Defaults to false. For more information on Magic Link, see https://merge.dev/blog/integrations-fast-say-hello-to-magic-link.
@@ -25285,7 +25142,7 @@ client.hris.employments.list(
-**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned. +**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.
@@ -25293,7 +25150,14 @@ client.hris.employments.list(
-**order_by:** `typing.Optional[EmploymentsListRequestOrderBy]` — Overrides the default ordering for this endpoint. Possible values include: effective_date, -effective_date. +**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.
@@ -25301,15 +25165,12 @@ client.hris.employments.list(
-**page_size:** `typing.Optional[int]` — Number of results to return per page. - -
-
+**language:** `typing.Optional[EndUserDetailsRequestLanguage]` -
-
+The following subset of IETF language tags can be used to configure localization. -**remote_fields:** `typing.Optional[EmploymentsListRequestRemoteFields]` — Deprecated. Use show_enum_origins. +* `en` - en +* `de` - de
@@ -25317,7 +25178,7 @@ client.hris.employments.list(
-**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object. +**are_syncs_disabled:** `typing.Optional[bool]` — The boolean that indicates whether initial, periodic, and force syncs will be disabled.
@@ -25325,7 +25186,7 @@ client.hris.employments.list(
-**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) +**integration_specific_config:** `typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]]` — A JSON object containing integration-specific configuration options.
@@ -25345,7 +25206,8 @@ client.hris.employments.list(
-
client.hris.employments.retrieve(...) +## Crm LinkedAccounts +
client.crm.linked_accounts.list(...)
@@ -25357,7 +25219,7 @@ client.hris.employments.list(
-Returns an `Employment` object with the given `id`. +List linked accounts for your organization.
@@ -25378,8 +25240,8 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.employments.retrieve( - id="id", +client.crm.linked_accounts.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", ) ``` @@ -25396,7 +25258,17 @@ client.hris.employments.retrieve(
-**id:** `str` +**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
@@ -25404,7 +25276,7 @@ client.hris.employments.retrieve(
-**expand:** `typing.Optional[EmploymentsRetrieveRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. +**cursor:** `typing.Optional[str]` — The pagination cursor value.
@@ -25412,7 +25284,7 @@ client.hris.employments.retrieve(
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. +**end_user_email_address:** `typing.Optional[str]` — If provided, will only return linked accounts associated with the given email address.
@@ -25420,7 +25292,7 @@ client.hris.employments.retrieve(
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). +**end_user_organization_name:** `typing.Optional[str]` — If provided, will only return linked accounts associated with the given organization name.
@@ -25428,7 +25300,7 @@ client.hris.employments.retrieve(
-**remote_fields:** `typing.Optional[EmploymentsRetrieveRequestRemoteFields]` — Deprecated. Use show_enum_origins. +**end_user_origin_id:** `typing.Optional[str]` — If provided, will only return linked accounts associated with the given origin ID.
@@ -25436,7 +25308,7 @@ client.hris.employments.retrieve(
-**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) +**end_user_origin_ids:** `typing.Optional[str]` — Comma-separated list of EndUser origin IDs, making it possible to specify multiple EndUsers at once.
@@ -25444,69 +25316,55 @@ client.hris.employments.retrieve(
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. +**id:** `typing.Optional[str]`
- -
+
+
+**ids:** `typing.Optional[str]` — Comma-separated list of LinkedAccount IDs, making it possible to specify multiple LinkedAccounts at once. +
-
-## Hris FieldMapping -
client.hris.field_mapping.field_mappings_retrieve(...)
-#### 📝 Description - -
-
+**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. + +
+
-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/). -
-
+**integration_name:** `typing.Optional[str]` — If provided, will only return linked accounts associated with the given integration name. +
-#### 🔌 Usage - -
-
-
-```python -from merge import Merge - -client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.hris.field_mapping.field_mappings_retrieve() - -``` -
-
+**is_test_account:** `typing.Optional[str]` — If included, will only include test linked accounts. If not included, will only include non-test linked accounts. +
-#### ⚙️ Parameters -
+**page_size:** `typing.Optional[int]` — Number of results to return per page. + +
+
+
-**exclude_remote_field_metadata:** `typing.Optional[bool]` — If `true`, remote fields metadata is excluded from each field mapping instance (i.e. `remote_fields.remote_key_name` and `remote_fields.schema` will be null). This will increase the speed of the request since these fields require some calculations. +**status:** `typing.Optional[str]` — Filter by status. Options: `COMPLETE`, `IDLE`, `INCOMPLETE`, `RELINK_NEEDED`
@@ -25526,7 +25384,8 @@ client.hris.field_mapping.field_mappings_retrieve()
-
client.hris.field_mapping.field_mappings_create(...) +## Crm Notes +
client.crm.notes.list(...)
@@ -25538,7 +25397,7 @@ client.hris.field_mapping.field_mappings_retrieve()
-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. +Returns a list of `Note` objects.
@@ -25559,13 +25418,8 @@ 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", +client.crm.notes.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", ) ``` @@ -25582,7 +25436,7 @@ client.hris.field_mapping.field_mappings_create(
-**target_field_name:** `str` — The name of the target field you want this remote field to map to. +**account_id:** `typing.Optional[str]` — If provided, will only return notes with this account.
@@ -25590,7 +25444,7 @@ client.hris.field_mapping.field_mappings_create(
-**target_field_description:** `str` — The description of the target field you want this remote field to map to. +**contact_id:** `typing.Optional[str]` — If provided, will only return notes with this contact.
@@ -25598,7 +25452,7 @@ client.hris.field_mapping.field_mappings_create(
-**remote_field_traversal_path:** `typing.Sequence[typing.Optional[typing.Any]]` — The field traversal path of the remote field listed when you hit the GET /remote-fields endpoint. +**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
@@ -25606,7 +25460,7 @@ client.hris.field_mapping.field_mappings_create(
-**remote_method:** `str` — The method of the remote endpoint where the remote field is coming from. +**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
@@ -25614,7 +25468,7 @@ client.hris.field_mapping.field_mappings_create(
-**remote_url_path:** `str` — The path of the remote endpoint where the remote field is coming from. +**cursor:** `typing.Optional[str]` — The pagination cursor value.
@@ -25622,7 +25476,7 @@ client.hris.field_mapping.field_mappings_create(
-**common_model_name:** `str` — The name of the Common Model that the remote field corresponds to in a given category. +**expand:** `typing.Optional[NotesListRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -25630,7 +25484,7 @@ client.hris.field_mapping.field_mappings_create(
-**exclude_remote_field_metadata:** `typing.Optional[bool]` — If `true`, remote fields metadata is excluded from each field mapping instance (i.e. `remote_fields.remote_key_name` and `remote_fields.schema` will be null). This will increase the speed of the request since these fields require some calculations. +**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
@@ -25638,70 +25492,71 @@ client.hris.field_mapping.field_mappings_create(
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. +**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. +
-
-
client.hris.field_mapping.field_mappings_destroy(...)
-#### 📝 Description +**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). + +
+
+**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned. + +
+
+
-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. -
-
+**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned. + -#### 🔌 Usage -
+**opportunity_id:** `typing.Optional[str]` — If provided, will only return notes with this opportunity. + +
+
+
-```python -from merge 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", -) - -``` -
-
+**owner_id:** `typing.Optional[str]` — If provided, will only return notes with this owner. + -#### ⚙️ Parameters -
+**page_size:** `typing.Optional[int]` — Number of results to return per page. + +
+
+
-**field_mapping_id:** `str` +**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
@@ -25721,7 +25576,7 @@ client.hris.field_mapping.field_mappings_destroy(
-
client.hris.field_mapping.field_mappings_partial_update(...) +
client.crm.notes.create(...)
@@ -25733,7 +25588,7 @@ client.hris.field_mapping.field_mappings_destroy(
-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. +Creates a `Note` object with the given values.
@@ -25749,13 +25604,14 @@ Create or update existing Field Mappings for a Linked Account. Changes will be r ```python from merge import Merge +from merge.resources.crm import NoteRequest 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", +client.crm.notes.create( + model=NoteRequest(), ) ``` @@ -25772,15 +25628,7 @@ client.hris.field_mapping.field_mappings_partial_update(
-**field_mapping_id:** `str` - -
-
- -
-
- -**remote_field_traversal_path:** `typing.Optional[typing.Sequence[typing.Optional[typing.Any]]]` — The field traversal path of the remote field listed when you hit the GET /remote-fields endpoint. +**model:** `NoteRequest`
@@ -25788,7 +25636,7 @@ client.hris.field_mapping.field_mappings_partial_update(
-**remote_method:** `typing.Optional[str]` — The method of the remote endpoint where the remote field is coming from. +**is_debug_mode:** `typing.Optional[bool]` — Whether to include debug fields (such as log file links) in the response.
@@ -25796,7 +25644,7 @@ client.hris.field_mapping.field_mappings_partial_update(
-**remote_url_path:** `typing.Optional[str]` — The path of the remote endpoint where the remote field is coming from. +**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously.
@@ -25816,7 +25664,7 @@ client.hris.field_mapping.field_mappings_partial_update(
-
client.hris.field_mapping.remote_fields_retrieve(...) +
client.crm.notes.retrieve(...)
@@ -25828,7 +25676,7 @@ client.hris.field_mapping.field_mappings_partial_update(
-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/). +Returns a `Note` object with the given `id`.
@@ -25849,7 +25697,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.field_mapping.remote_fields_retrieve() +client.crm.notes.retrieve( + id="id", +) ``` @@ -25865,7 +25715,7 @@ client.hris.field_mapping.remote_fields_retrieve()
-**common_models:** `typing.Optional[str]` — A comma seperated list of Common Model names. If included, will only return Remote Fields for those Common Models. +**id:** `str`
@@ -25873,7 +25723,7 @@ client.hris.field_mapping.remote_fields_retrieve()
-**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. +**expand:** `typing.Optional[NotesRetrieveRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -25881,64 +25731,27 @@ client.hris.field_mapping.remote_fields_retrieve()
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. +**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
- -
- - - - -
- -
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/). -
-
+**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. +
-#### 🔌 Usage - -
-
-
-```python -from merge import Merge - -client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.hris.field_mapping.target_fields_retrieve() - -``` -
-
+**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). +
-#### ⚙️ Parameters - -
-
-
@@ -25954,8 +25767,7 @@ client.hris.field_mapping.target_fields_retrieve()
-## Hris GenerateKey -
client.hris.generate_key.create(...) +
client.crm.notes.meta_post_retrieve()
@@ -25967,7 +25779,7 @@ client.hris.field_mapping.target_fields_retrieve()
-Create a remote key. +Returns metadata for `Note` POSTs.
@@ -25988,9 +25800,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.generate_key.create( - name="Remote Deployment Key 1", -) +client.crm.notes.meta_post_retrieve() ``` @@ -26006,14 +25816,6 @@ client.hris.generate_key.create(
-**name:** `str` — The name of the remote key - -
-
- -
-
- **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -26026,8 +25828,7 @@ client.hris.generate_key.create(
-## Hris Groups -
client.hris.groups.list(...) +
client.crm.notes.remote_field_classes_list(...)
@@ -26039,7 +25840,7 @@ client.hris.generate_key.create(
-Returns a list of `Group` objects. +Returns a list of `RemoteFieldClass` objects.
@@ -26060,7 +25861,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.groups.list( +client.crm.notes.remote_field_classes_list( cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", ) @@ -26078,7 +25879,7 @@ client.hris.groups.list(
-**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime. +**cursor:** `typing.Optional[str]` — The pagination cursor value.
@@ -26086,7 +25887,7 @@ client.hris.groups.list(
-**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime. +**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
@@ -26094,7 +25895,7 @@ client.hris.groups.list(
-**cursor:** `typing.Optional[str]` — The pagination cursor value. +**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -26102,7 +25903,7 @@ client.hris.groups.list(
-**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/). +**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.
@@ -26110,7 +25911,7 @@ client.hris.groups.list(
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. +**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -26118,7 +25919,7 @@ client.hris.groups.list(
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). +**is_common_model_field:** `typing.Optional[bool]` — If provided, will only return remote field classes with this is_common_model_field value
@@ -26126,7 +25927,7 @@ client.hris.groups.list(
-**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. +**is_custom:** `typing.Optional[bool]` — If provided, will only return remote fields classes with this is_custom value
@@ -26134,7 +25935,7 @@ client.hris.groups.list(
-**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned. +**page_size:** `typing.Optional[int]` — Number of results to return per page.
@@ -26142,39 +25943,71 @@ client.hris.groups.list(
-**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned. +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+ +
-
-
-**names:** `typing.Optional[str]` — If provided, will only return groups with these names. Multiple values can be separated by commas. -
+
+## Crm Opportunities +
client.crm.opportunities.list(...)
-**page_size:** `typing.Optional[int]` — Number of results to return per page. - +#### 📝 Description + +
+
+ +
+
+ +Returns a list of `Opportunity` objects. +
+
+#### 🔌 Usage +
-**remote_fields:** `typing.Optional[typing.Literal["type"]]` — Deprecated. Use show_enum_origins. - +
+
+ +```python +from merge import Merge + +client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.crm.opportunities.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) + +``` +
+
+#### ⚙️ Parameters +
-**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object. +
+
+ +**account_id:** `typing.Optional[str]` — If provided, will only return opportunities with this account.
@@ -26182,7 +26015,7 @@ client.hris.groups.list(
-**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) +**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
@@ -26190,7 +26023,7 @@ client.hris.groups.list(
-**types:** `typing.Optional[str]` — If provided, will only return groups of these types. Multiple values can be separated by commas. +**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
@@ -26198,70 +26031,95 @@ client.hris.groups.list(
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. +**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. +
-
-
client.hris.groups.retrieve(...)
-#### 📝 Description +**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/). + +
+
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. + +
+
+
-Returns a `Group` object with the given `id`. -
-
+**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. + -#### 🔌 Usage -
+**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). + +
+
+
-```python -from merge import Merge - -client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.hris.groups.retrieve( - id="id", -) +**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. +
-#### ⚙️ Parameters +
+
+ +**page_size:** `typing.Optional[int]` — Number of results to return per page. + +
+
+**remote_created_after:** `typing.Optional[dt.datetime]` — If provided, will only return opportunities created in the third party platform after this datetime. + +
+
+
-**id:** `str` +**remote_fields:** `typing.Optional[typing.Literal["status"]]` — Deprecated. Use show_enum_origins.
@@ -26269,7 +26127,7 @@ client.hris.groups.retrieve(
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. +**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
@@ -26277,7 +26135,7 @@ client.hris.groups.retrieve(
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). +**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)
@@ -26285,7 +26143,7 @@ client.hris.groups.retrieve(
-**remote_fields:** `typing.Optional[typing.Literal["type"]]` — Deprecated. Use show_enum_origins. +**stage_id:** `typing.Optional[str]` — If provided, will only return opportunities with this stage.
@@ -26293,7 +26151,13 @@ client.hris.groups.retrieve(
-**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) +**status:** `typing.Optional[OpportunitiesListRequestStatus]` + +If provided, will only return opportunities with this status. Options: ('OPEN', 'WON', 'LOST') + +* `OPEN` - OPEN +* `WON` - WON +* `LOST` - LOST
@@ -26313,8 +26177,7 @@ client.hris.groups.retrieve(
-## Hris Issues -
client.hris.issues.list(...) +
client.crm.opportunities.create(...)
@@ -26326,7 +26189,7 @@ client.hris.groups.retrieve(
-Gets all issues for Organization. +Creates an `Opportunity` object with the given values.
@@ -26342,13 +26205,14 @@ Gets all issues for Organization. ```python from merge import Merge +from merge.resources.crm import OpportunityRequest client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.issues.list( - cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +client.crm.opportunities.create( + model=OpportunityRequest(), ) ``` @@ -26365,7 +26229,7 @@ client.hris.issues.list(
-**account_token:** `typing.Optional[str]` +**model:** `OpportunityRequest`
@@ -26373,7 +26237,7 @@ client.hris.issues.list(
-**cursor:** `typing.Optional[str]` — The pagination cursor value. +**is_debug_mode:** `typing.Optional[bool]` — Whether to include debug fields (such as log file links) in the response.
@@ -26381,7 +26245,7 @@ client.hris.issues.list(
-**end_date:** `typing.Optional[str]` — If included, will only include issues whose most recent action occurred before this time +**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously.
@@ -26389,71 +26253,70 @@ client.hris.issues.list(
-**end_user_organization_name:** `typing.Optional[str]` +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+ +
-
-
-**first_incident_time_after:** `typing.Optional[dt.datetime]` — If provided, will only return issues whose first incident time was after this datetime. -
+
+
client.crm.opportunities.retrieve(...)
-**first_incident_time_before:** `typing.Optional[dt.datetime]` — If provided, will only return issues whose first incident time was before this datetime. - -
-
+#### 📝 Description
-**include_muted:** `typing.Optional[str]` — If true, will include muted issues - -
-
-
-**integration_name:** `typing.Optional[str]` - +Returns an `Opportunity` object with the given `id`. +
+
+#### 🔌 Usage +
-**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. - +```python +from merge import Merge + +client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.crm.opportunities.retrieve( + id="id", +) + +```
+ + + +#### ⚙️ Parameters
-**linked_account_id:** `typing.Optional[str]` — If provided, will only include issues pertaining to the linked account passed in. - -
-
-
-**page_size:** `typing.Optional[int]` — Number of results to return per page. +**id:** `str`
@@ -26461,7 +26324,7 @@ client.hris.issues.list(
-**start_date:** `typing.Optional[str]` — If included, will only include issues whose most recent action occurred after this time +**expand:** `typing.Optional[OpportunitiesRetrieveRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -26469,12 +26332,7 @@ client.hris.issues.list(
-**status:** `typing.Optional[IssuesListRequestStatus]` - -Status of the issue. Options: ('ONGOING', 'RESOLVED') - -* `ONGOING` - ONGOING -* `RESOLVED` - RESOLVED +**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -26482,70 +26340,31 @@ Status of the issue. Options: ('ONGOING', 'RESOLVED')
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. +**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.
- - - - - - -
- -
client.hris.issues.retrieve(...) -
-
- -#### 📝 Description - -
-
-Get a specific issue. -
-
+**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). +
-#### 🔌 Usage - -
-
-
-```python -from merge import Merge - -client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.hris.issues.retrieve( - id="id", -) - -``` -
-
+**remote_fields:** `typing.Optional[typing.Literal["status"]]` — Deprecated. Use show_enum_origins. +
-#### ⚙️ Parameters - -
-
-
-**id:** `str` +**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)
@@ -26565,8 +26384,7 @@ client.hris.issues.retrieve(
-## Hris LinkToken -
client.hris.link_token.create(...) +
client.crm.opportunities.partial_update(...)
@@ -26578,7 +26396,7 @@ client.hris.issues.retrieve(
-Creates a link token to be used when linking a new end user. +Updates an `Opportunity` object with the given `id`.
@@ -26594,17 +26412,15 @@ Creates a link token to be used when linking a new end user. ```python from merge import Merge -from merge.resources.hris import CategoriesEnum +from merge.resources.crm import PatchedOpportunityRequest 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], +client.crm.opportunities.partial_update( + id="id", + model=PatchedOpportunityRequest(), ) ``` @@ -26621,7 +26437,7 @@ client.hris.link_token.create(
-**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. +**id:** `str`
@@ -26629,7 +26445,7 @@ client.hris.link_token.create(
-**end_user_organization_name:** `str` — Your end user's organization. +**model:** `PatchedOpportunityRequest`
@@ -26637,7 +26453,7 @@ client.hris.link_token.create(
-**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. +**is_debug_mode:** `typing.Optional[bool]` — Whether to include debug fields (such as log file links) in the response.
@@ -26645,7 +26461,7 @@ client.hris.link_token.create(
-**categories:** `typing.Sequence[CategoriesEnum]` — The integration categories to show in Merge Link. +**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously.
@@ -26653,83 +26469,70 @@ client.hris.link_token.create(
-**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/. +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+ +
-
-
-**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. -
+
+
client.crm.opportunities.meta_patch_retrieve(...)
-**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. - -
-
+#### 📝 Description
-**hide_admin_magic_link:** `typing.Optional[bool]` — Whether to generate a Magic Link URL on the Admin Needed screen during the linking flow. 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. - +Returns metadata for `Opportunity` PATCHs. +
+
+#### 🔌 Usage +
-**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[EndUserDetailsRequestLanguage]` +```python +from merge import Merge -The following subset of IETF language tags can be used to configure localization. +client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.crm.opportunities.meta_patch_retrieve( + id="id", +) -* `en` - en -* `de` - de - +```
+ + + +#### ⚙️ Parameters
-**are_syncs_disabled:** `typing.Optional[bool]` — The boolean that indicates whether initial, periodic, and force syncs will be disabled. - -
-
-
-**integration_specific_config:** `typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]]` — A JSON object containing integration-specific configuration options. +**id:** `str`
@@ -26749,8 +26552,7 @@ The following subset of IETF language tags can be used to configure localization
-## Hris LinkedAccounts -
client.hris.linked_accounts.list(...) +
client.crm.opportunities.meta_post_retrieve()
@@ -26762,7 +26564,7 @@ The following subset of IETF language tags can be used to configure localization
-List linked accounts for your organization. +Returns metadata for `Opportunity` POSTs.
@@ -26783,9 +26585,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.linked_accounts.list( - cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", -) +client.crm.opportunities.meta_post_retrieve() ``` @@ -26801,57 +26601,70 @@ client.hris.linked_accounts.list(
-**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 +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+ +
-
-
-**cursor:** `typing.Optional[str]` — The pagination cursor value. -
+
+
client.crm.opportunities.remote_field_classes_list(...)
-**end_user_email_address:** `typing.Optional[str]` — If provided, will only return linked accounts associated with the given email address. - -
-
+#### 📝 Description
-**end_user_organization_name:** `typing.Optional[str]` — If provided, will only return linked accounts associated with the given organization name. - +
+
+ +Returns a list of `RemoteFieldClass` objects. +
+
+#### 🔌 Usage +
-**end_user_origin_id:** `typing.Optional[str]` — If provided, will only return linked accounts associated with the given origin ID. - +
+
+ +```python +from merge import Merge + +client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.crm.opportunities.remote_field_classes_list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) + +```
+
+
+ +#### ⚙️ Parameters
-**end_user_origin_ids:** `typing.Optional[str]` — Comma-separated list of EndUser origin IDs, making it possible to specify multiple EndUsers at once. +
+
+ +**cursor:** `typing.Optional[str]` — The pagination cursor value.
@@ -26859,7 +26672,7 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing`
-**id:** `typing.Optional[str]` +**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
@@ -26867,7 +26680,7 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing`
-**ids:** `typing.Optional[str]` — Comma-separated list of LinkedAccount IDs, making it possible to specify multiple LinkedAccounts at once. +**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -26875,7 +26688,7 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing`
-**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. +**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.
@@ -26883,7 +26696,7 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing`
-**integration_name:** `typing.Optional[str]` — If provided, will only return linked accounts associated with the given integration name. +**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -26891,7 +26704,7 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing`
-**is_test_account:** `typing.Optional[str]` — If included, will only include test linked accounts. If not included, will only include non-test linked accounts. +**is_common_model_field:** `typing.Optional[bool]` — If provided, will only return remote field classes with this is_common_model_field value
@@ -26899,7 +26712,7 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing`
-**page_size:** `typing.Optional[int]` — Number of results to return per page. +**is_custom:** `typing.Optional[bool]` — If provided, will only return remote fields classes with this is_custom value
@@ -26907,7 +26720,7 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing`
-**status:** `typing.Optional[str]` — Filter by status. Options: `COMPLETE`, `IDLE`, `INCOMPLETE`, `RELINK_NEEDED` +**page_size:** `typing.Optional[int]` — Number of results to return per page.
@@ -26927,8 +26740,8 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing`
-## Hris Locations -
client.hris.locations.list(...) +## Crm Passthrough +
client.crm.passthrough.create(...)
@@ -26940,7 +26753,7 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing`
-Returns a list of `Location` objects. +Pull data from an endpoint not currently supported by Merge.
@@ -26956,13 +26769,17 @@ Returns a list of `Location` objects. ```python from merge import Merge +from merge.resources.crm import DataPassthroughRequest, MethodEnum client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.locations.list( - cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +client.crm.passthrough.create( + request=DataPassthroughRequest( + method=MethodEnum.GET, + path="/scooters", + ), ) ``` @@ -26979,7 +26796,7 @@ client.hris.locations.list(
-**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime. +**request:** `DataPassthroughRequest`
@@ -26987,100 +26804,71 @@ client.hris.locations.list(
-**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime. +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
- -
-
- -**cursor:** `typing.Optional[str]` — The pagination cursor value. -
-
-
-**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/). -
+
+## Crm RegenerateKey +
client.crm.regenerate_key.create(...)
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. - -
-
+#### 📝 Description
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). - -
-
-
-**location_type:** `typing.Optional[LocationsListRequestLocationType]` - -If provided, will only return locations with this location_type - -* `HOME` - HOME -* `WORK` - WORK - +Exchange remote keys.
- -
-
- -**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned. -
+#### 🔌 Usage +
-**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. - -
-
+```python +from merge import Merge -
-
+client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.crm.regenerate_key.create( + name="Remote Deployment Key 1", +) -**remote_fields:** `typing.Optional[LocationsListRequestRemoteFields]` — Deprecated. Use show_enum_origins. - +``` +
+
+#### ⚙️ Parameters +
-**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object. - -
-
-
-**show_enum_origins:** `typing.Optional[LocationsListRequestShowEnumOrigins]` — 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) +**name:** `str` — The name of the remote key
@@ -27100,7 +26888,8 @@ If provided, will only return locations with this location_type
-
client.hris.locations.retrieve(...) +## Crm Stages +
client.crm.stages.list(...)
@@ -27112,7 +26901,7 @@ If provided, will only return locations with this location_type
-Returns a `Location` object with the given `id`. +Returns a list of `Stage` objects.
@@ -27133,8 +26922,8 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.locations.retrieve( - id="id", +client.crm.stages.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", ) ``` @@ -27151,7 +26940,31 @@ client.hris.locations.retrieve(
-**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]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
@@ -27167,6 +26980,14 @@ client.hris.locations.retrieve(
+**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. + +
+
+ +
+
+ **include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -27175,7 +26996,7 @@ client.hris.locations.retrieve(
-**remote_fields:** `typing.Optional[LocationsRetrieveRequestRemoteFields]` — Deprecated. Use show_enum_origins. +**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
@@ -27183,7 +27004,23 @@ client.hris.locations.retrieve(
-**show_enum_origins:** `typing.Optional[LocationsRetrieveRequestShowEnumOrigins]` — 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) +**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.
@@ -27203,8 +27040,7 @@ client.hris.locations.retrieve(
-## Hris Passthrough -
client.hris.passthrough.create(...) +
client.crm.stages.retrieve(...)
@@ -27216,7 +27052,7 @@ client.hris.locations.retrieve(
-Pull data from an endpoint not currently supported by Merge. +Returns a `Stage` object with the given `id`.
@@ -27232,17 +27068,13 @@ Pull data from an endpoint not currently supported by Merge. ```python from merge 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", - ), +client.crm.stages.retrieve( + id="id", ) ``` @@ -27259,7 +27091,31 @@ client.hris.passthrough.create(
-**request:** `DataPassthroughRequest` +**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. + +
+
+ +
+
+ +**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -27279,8 +27135,7 @@ client.hris.passthrough.create(
-## Hris PayGroups -
client.hris.pay_groups.list(...) +
client.crm.stages.remote_field_classes_list(...)
@@ -27292,7 +27147,7 @@ client.hris.passthrough.create(
-Returns a list of `PayGroup` objects. +Returns a list of `RemoteFieldClass` objects.
@@ -27313,7 +27168,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.pay_groups.list( +client.crm.stages.remote_field_classes_list( cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", ) @@ -27331,22 +27186,6 @@ client.hris.pay_groups.list(
-**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.
@@ -27371,7 +27210,7 @@ client.hris.pay_groups.list(
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). +**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.
@@ -27379,7 +27218,7 @@ client.hris.pay_groups.list(
-**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned. +**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -27387,7 +27226,7 @@ client.hris.pay_groups.list(
-**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned. +**is_common_model_field:** `typing.Optional[bool]` — If provided, will only return remote field classes with this is_common_model_field value
@@ -27395,7 +27234,7 @@ client.hris.pay_groups.list(
-**page_size:** `typing.Optional[int]` — Number of results to return per page. +**is_custom:** `typing.Optional[bool]` — If provided, will only return remote fields classes with this is_custom value
@@ -27403,7 +27242,7 @@ client.hris.pay_groups.list(
-**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object. +**page_size:** `typing.Optional[int]` — Number of results to return per page.
@@ -27423,7 +27262,8 @@ client.hris.pay_groups.list(
-
client.hris.pay_groups.retrieve(...) +## Crm SyncStatus +
client.crm.sync_status.list(...)
@@ -27435,7 +27275,7 @@ client.hris.pay_groups.list(
-Returns a `PayGroup` object with the given `id`. +Get sync status for the current sync and the most recently finished sync. `last_sync_start` represents the most recent time any sync began. `last_sync_finished` represents the most recent time any sync completed. These timestamps may correspond to different sync instances which may result in a sync start time being later than a separate sync completed time. To ensure you are retrieving the latest available data reference the `last_sync_finished` timestamp where `last_sync_result` is `DONE`. Possible values for `status` and `last_sync_result` are `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).
@@ -27456,8 +27296,8 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.pay_groups.retrieve( - id="id", +client.crm.sync_status.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", ) ``` @@ -27474,7 +27314,7 @@ client.hris.pay_groups.retrieve(
-**id:** `str` +**cursor:** `typing.Optional[str]` — The pagination cursor value.
@@ -27482,7 +27322,7 @@ client.hris.pay_groups.retrieve(
-**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.
@@ -27490,10 +27330,64 @@ client.hris.pay_groups.retrieve(
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+ +
+ + + + +
+ +## Crm ForceResync +
client.crm.force_resync.sync_status_resync_create() +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Force re-sync of all models. This endpoint is available for monthly, quarterly, and highest sync frequency customers on the Professional or Enterprise plans. Doing so will consume a sync credit for the relevant linked account. Force re-syncs can also be triggered manually in the Merge Dashboard and is available for all customers. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from merge import Merge + +client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.crm.force_resync.sync_status_resync_create() + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
@@ -27510,8 +27404,8 @@ client.hris.pay_groups.retrieve(
-## Hris PayrollRuns -
client.hris.payroll_runs.list(...) +## Crm Tasks +
client.crm.tasks.list(...)
@@ -27523,7 +27417,7 @@ client.hris.pay_groups.retrieve(
-Returns a list of `PayrollRun` objects. +Returns a list of `Task` objects.
@@ -27544,7 +27438,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.payroll_runs.list( +client.crm.tasks.list( cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", ) @@ -27586,7 +27480,7 @@ client.hris.payroll_runs.list(
-**ended_after:** `typing.Optional[dt.datetime]` — If provided, will only return payroll runs ended after this datetime. +**expand:** `typing.Optional[TasksListRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -27594,7 +27488,7 @@ client.hris.payroll_runs.list(
-**ended_before:** `typing.Optional[dt.datetime]` — If provided, will only return payroll runs ended before this datetime. +**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
@@ -27602,7 +27496,7 @@ client.hris.payroll_runs.list(
-**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/). +**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -27610,7 +27504,7 @@ client.hris.payroll_runs.list(
-**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.
@@ -27650,7 +27544,7 @@ client.hris.payroll_runs.list(
-**remote_fields:** `typing.Optional[PayrollRunsListRequestRemoteFields]` — Deprecated. Use show_enum_origins. +**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
@@ -27658,31 +27552,71 @@ client.hris.payroll_runs.list(
-**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(...)
-**run_type:** `typing.Optional[PayrollRunsListRequestRunType]` +#### 📝 Description -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 - +
+
+ +Creates a `Task` object with the given values. +
+
+#### 🔌 Usage +
-**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) +
+
+ +```python +from merge 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`
@@ -27690,7 +27624,7 @@ If provided, will only return PayrollRun's with this status. Options: ('REGULAR'
-**started_after:** `typing.Optional[dt.datetime]` — If provided, will only return payroll runs started after this datetime. +**is_debug_mode:** `typing.Optional[bool]` — Whether to include debug fields (such as log file links) in the response.
@@ -27698,7 +27632,7 @@ If provided, will only return PayrollRun's with this status. Options: ('REGULAR'
-**started_before:** `typing.Optional[dt.datetime]` — If provided, will only return payroll runs started before this datetime. +**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously.
@@ -27718,7 +27652,7 @@ If provided, will only return PayrollRun's with this status. Options: ('REGULAR'
-
client.hris.payroll_runs.retrieve(...) +
client.crm.tasks.retrieve(...)
@@ -27730,7 +27664,7 @@ If provided, will only return PayrollRun's with this status. Options: ('REGULAR'
-Returns a `PayrollRun` object with the given `id`. +Returns a `Task` object with the given `id`.
@@ -27751,7 +27685,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.payroll_runs.retrieve( +client.crm.tasks.retrieve( id="id", ) @@ -27777,7 +27711,7 @@ client.hris.payroll_runs.retrieve(
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. +**expand:** `typing.Optional[TasksRetrieveRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -27785,7 +27719,7 @@ client.hris.payroll_runs.retrieve(
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). +**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -27793,7 +27727,7 @@ client.hris.payroll_runs.retrieve(
-**remote_fields:** `typing.Optional[PayrollRunsRetrieveRequestRemoteFields]` — Deprecated. Use show_enum_origins. +**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.
@@ -27801,7 +27735,7 @@ client.hris.payroll_runs.retrieve(
-**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) +**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -27821,8 +27755,7 @@ client.hris.payroll_runs.retrieve(
-## Hris RegenerateKey -
client.hris.regenerate_key.create(...) +
client.crm.tasks.partial_update(...)
@@ -27834,7 +27767,7 @@ client.hris.payroll_runs.retrieve(
-Exchange remote keys. +Updates a `Task` object with the given `id`.
@@ -27850,13 +27783,15 @@ Exchange remote keys. ```python from merge import Merge +from merge.resources.crm import PatchedTaskRequest client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.regenerate_key.create( - name="Remote Deployment Key 1", +client.crm.tasks.partial_update( + id="id", + model=PatchedTaskRequest(), ) ``` @@ -27873,7 +27808,31 @@ client.hris.regenerate_key.create(
-**name:** `str` — The name of the remote key +**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.
@@ -27893,8 +27852,7 @@ client.hris.regenerate_key.create(
-## Hris SyncStatus -
client.hris.sync_status.list(...) +
client.crm.tasks.meta_patch_retrieve(...)
@@ -27906,7 +27864,7 @@ client.hris.regenerate_key.create(
-Get sync status for the current sync and the most recently finished sync. `last_sync_start` represents the most recent time any sync began. `last_sync_finished` represents the most recent time any sync completed. These timestamps may correspond to different sync instances which may result in a sync start time being later than a separate sync completed time. To ensure you are retrieving the latest available data reference the `last_sync_finished` timestamp where `last_sync_result` is `DONE`. Possible values for `status` and `last_sync_result` are `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). +Returns metadata for `Task` PATCHs.
@@ -27927,8 +27885,8 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.sync_status.list( - cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +client.crm.tasks.meta_patch_retrieve( + id="id", ) ``` @@ -27945,15 +27903,7 @@ client.hris.sync_status.list(
-**cursor:** `typing.Optional[str]` — The pagination cursor value. - -
-
- -
-
- -**page_size:** `typing.Optional[int]` — Number of results to return per page. +**id:** `str`
@@ -27973,8 +27923,7 @@ client.hris.sync_status.list(
-## Hris ForceResync -
client.hris.force_resync.sync_status_resync_create() +
client.crm.tasks.meta_post_retrieve()
@@ -27986,7 +27935,7 @@ client.hris.sync_status.list(
-Force re-sync of all models. This endpoint is available for monthly, quarterly, and highest sync frequency customers on the Professional or Enterprise plans. Doing so will consume a sync credit for the relevant linked account. Force re-syncs can also be triggered manually in the Merge Dashboard and is available for all customers. +Returns metadata for `Task` POSTs.
@@ -28007,7 +27956,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.force_resync.sync_status_resync_create() +client.crm.tasks.meta_post_retrieve() ``` @@ -28035,8 +27984,7 @@ client.hris.force_resync.sync_status_resync_create()
-## Hris Teams -
client.hris.teams.list(...) +
client.crm.tasks.remote_field_classes_list(...)
@@ -28048,7 +27996,7 @@ client.hris.force_resync.sync_status_resync_create()
-Returns a list of `Team` objects. +Returns a list of `RemoteFieldClass` objects.
@@ -28069,7 +28017,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.teams.list( +client.crm.tasks.remote_field_classes_list( cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", ) @@ -28087,22 +28035,6 @@ client.hris.teams.list(
-**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.
@@ -28111,14 +28043,6 @@ client.hris.teams.list(
-**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]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
@@ -28135,15 +28059,7 @@ client.hris.teams.list(
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). - -
-
- -
-
- -**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned. +**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.
@@ -28151,7 +28067,7 @@ client.hris.teams.list(
-**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned. +**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -28159,7 +28075,7 @@ client.hris.teams.list(
-**page_size:** `typing.Optional[int]` — Number of results to return per page. +**is_common_model_field:** `typing.Optional[bool]` — If provided, will only return remote field classes with this is_common_model_field value
@@ -28167,7 +28083,7 @@ client.hris.teams.list(
-**parent_team_id:** `typing.Optional[str]` — If provided, will only return teams with this parent team. +**is_custom:** `typing.Optional[bool]` — If provided, will only return remote fields classes with this is_custom value
@@ -28175,7 +28091,7 @@ client.hris.teams.list(
-**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object. +**page_size:** `typing.Optional[int]` — Number of results to return per page.
@@ -28195,7 +28111,8 @@ client.hris.teams.list(
-
client.hris.teams.retrieve(...) +## Crm Users +
client.crm.users.list(...)
@@ -28207,7 +28124,7 @@ client.hris.teams.list(
-Returns a `Team` object with the given `id`. +Returns a list of `User` objects.
@@ -28228,8 +28145,8 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.teams.retrieve( - id="id", +client.crm.users.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", ) ``` @@ -28246,7 +28163,7 @@ client.hris.teams.retrieve(
-**id:** `str` +**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
@@ -28254,7 +28171,7 @@ client.hris.teams.retrieve(
-**expand:** `typing.Optional[typing.Literal["parent_team"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. +**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
@@ -28262,7 +28179,7 @@ client.hris.teams.retrieve(
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. +**cursor:** `typing.Optional[str]` — The pagination cursor value.
@@ -28270,7 +28187,7 @@ client.hris.teams.retrieve(
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). +**email:** `typing.Optional[str]` — If provided, will only return users with this email.
@@ -28278,71 +28195,31 @@ client.hris.teams.retrieve(
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. +**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
- -
- - - - -
- -## Hris TimeOff -
client.hris.time_off.list(...) -
-
- -#### 📝 Description - -
-
-Returns a list of `TimeOff` objects. -
-
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. +
-#### 🔌 Usage - -
-
-
-```python -from merge import Merge - -client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.hris.time_off.list( - cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", -) - -``` -
-
+**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. +
-#### ⚙️ Parameters - -
-
-
-**approver_id:** `typing.Optional[str]` — If provided, will only return time off for this approver. +**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -28350,7 +28227,7 @@ client.hris.time_off.list(
-**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime. +**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
@@ -28358,7 +28235,7 @@ client.hris.time_off.list(
-**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime. +**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
@@ -28366,7 +28243,7 @@ client.hris.time_off.list(
-**cursor:** `typing.Optional[str]` — The pagination cursor value. +**page_size:** `typing.Optional[int]` — Number of results to return per page.
@@ -28374,7 +28251,7 @@ client.hris.time_off.list(
-**employee_id:** `typing.Optional[str]` — If provided, will only return time off for this employee. +**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
@@ -28382,112 +28259,70 @@ client.hris.time_off.list(
-**ended_after:** `typing.Optional[dt.datetime]` — If provided, will only return employees that ended after this datetime. +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
- -
-
- -**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. -
+
+
client.crm.users.retrieve(...)
-**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/). - -
-
+#### 📝 Description
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. - -
-
-
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). - +Returns a `User` object with the given `id`.
- -
-
- -**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned. -
+#### 🔌 Usage +
-**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. - -
-
+```python +from merge import Merge -
-
+client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.crm.users.retrieve( + id="id", +) -**remote_fields:** `typing.Optional[TimeOffListRequestRemoteFields]` — Deprecated. Use show_enum_origins. - +```
- -
-
- -**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object. -
+#### ⚙️ Parameters +
-**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) +**id:** `str`
@@ -28495,7 +28330,7 @@ If provided, will only return TimeOff with this request type. Options: ('VACATIO
-**started_after:** `typing.Optional[dt.datetime]` — If provided, will only return time-offs that started after this datetime. +**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -28503,23 +28338,15 @@ If provided, will only return TimeOff with this request type. Options: ('VACATIO
-**started_before:** `typing.Optional[dt.datetime]` — If provided, will only return time-offs that started before this datetime. +**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.
-
- -**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 +
+ +**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -28539,7 +28366,7 @@ If provided, will only return TimeOff with this status. Options: ('REQUESTED', '
-
client.hris.time_off.create(...) +
client.crm.users.ignore_create(...)
@@ -28551,7 +28378,7 @@ If provided, will only return TimeOff with this status. Options: ('REQUESTED', '
-Creates a `TimeOff` object with the given values. +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.
@@ -28567,14 +28394,17 @@ Creates a `TimeOff` object with the given values. ```python from merge import Merge -from merge.resources.hris import TimeOffRequest +from merge.resources.crm import IgnoreCommonModelRequest, ReasonEnum client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.time_off.create( - model=TimeOffRequest(), +client.crm.users.ignore_create( + model_id="model_id", + request=IgnoreCommonModelRequest( + reason=ReasonEnum.GENERAL_CUSTOMER_REQUEST, + ), ) ``` @@ -28591,15 +28421,7 @@ client.hris.time_off.create(
-**model:** `TimeOffRequest` - -
-
- -
-
- -**is_debug_mode:** `typing.Optional[bool]` — Whether to include debug fields (such as log file links) in the response. +**model_id:** `str`
@@ -28607,7 +28429,7 @@ client.hris.time_off.create(
-**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously. +**request:** `IgnoreCommonModelRequest`
@@ -28627,7 +28449,7 @@ client.hris.time_off.create(
-
client.hris.time_off.retrieve(...) +
client.crm.users.remote_field_classes_list(...)
@@ -28639,7 +28461,7 @@ client.hris.time_off.create(
-Returns a `TimeOff` object with the given `id`. +Returns a list of `RemoteFieldClass` objects.
@@ -28660,8 +28482,8 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.time_off.retrieve( - id="id", +client.crm.users.remote_field_classes_list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", ) ``` @@ -28678,7 +28500,7 @@ client.hris.time_off.retrieve(
-**id:** `str` +**cursor:** `typing.Optional[str]` — The pagination cursor value.
@@ -28686,7 +28508,7 @@ client.hris.time_off.retrieve(
-**expand:** `typing.Optional[TimeOffRetrieveRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. +**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
@@ -28702,6 +28524,14 @@ client.hris.time_off.retrieve(
+**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. + +
+
+ +
+
+ **include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -28710,7 +28540,7 @@ client.hris.time_off.retrieve(
-**remote_fields:** `typing.Optional[TimeOffRetrieveRequestRemoteFields]` — Deprecated. Use show_enum_origins. +**is_common_model_field:** `typing.Optional[bool]` — If provided, will only return remote field classes with this is_common_model_field value
@@ -28718,7 +28548,15 @@ client.hris.time_off.retrieve(
-**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) +**is_custom:** `typing.Optional[bool]` — If provided, will only return remote fields classes with this is_custom value + +
+
+ +
+
+ +**page_size:** `typing.Optional[int]` — Number of results to return per page.
@@ -28738,7 +28576,8 @@ client.hris.time_off.retrieve(
-
client.hris.time_off.meta_post_retrieve() +## Crm WebhookReceivers +
client.crm.webhook_receivers.list()
@@ -28750,7 +28589,7 @@ client.hris.time_off.retrieve(
-Returns metadata for `TimeOff` POSTs. +Returns a list of `WebhookReceiver` objects.
@@ -28771,7 +28610,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.time_off.meta_post_retrieve() +client.crm.webhook_receivers.list() ``` @@ -28799,8 +28638,7 @@ client.hris.time_off.meta_post_retrieve()
-## Hris TimeOffBalances -
client.hris.time_off_balances.list(...) +
client.crm.webhook_receivers.create(...)
@@ -28812,7 +28650,7 @@ client.hris.time_off.meta_post_retrieve()
-Returns a list of `TimeOffBalance` objects. +Creates a `WebhookReceiver` object with the given values.
@@ -28833,8 +28671,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.time_off_balances.list( - cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +client.crm.webhook_receivers.create( + event="event", + is_active=True, ) ``` @@ -28851,7 +28690,7 @@ client.hris.time_off_balances.list(
-**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime. +**event:** `str`
@@ -28859,7 +28698,7 @@ client.hris.time_off_balances.list(
-**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime. +**is_active:** `bool`
@@ -28867,7 +28706,7 @@ client.hris.time_off_balances.list(
-**cursor:** `typing.Optional[str]` — The pagination cursor value. +**key:** `typing.Optional[str]`
@@ -28875,104 +28714,133 @@ client.hris.time_off_balances.list(
-**employee_id:** `typing.Optional[str]` — If provided, will only return time off balances for this employee. +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+ +
-
-
-**expand:** `typing.Optional[typing.Literal["employee"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. -
+
+## Hris AccountDetails +
client.hris.account_details.retrieve()
-**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/). - -
-
+#### 📝 Description
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. - -
-
-
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). - +Get details for a linked account. +
+
+#### 🔌 Usage +
-**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned. - +
+
+ +```python +from merge import Merge + +client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.hris.account_details.retrieve() + +``` +
+
+#### ⚙️ Parameters +
-**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned. +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
-
-
-**page_size:** `typing.Optional[int]` — Number of results to return per page. -
+
+## Hris AccountToken +
client.hris.account_token.retrieve(...)
-**policy_type:** `typing.Optional[TimeOffBalancesListRequestPolicyType]` - -If provided, will only return TimeOffBalance with this policy type. Options: ('VACATION', 'SICK', 'PERSONAL', 'JURY_DUTY', 'VOLUNTEER', 'BEREAVEMENT') +#### 📝 Description -* `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. - +Returns the account token for the end user with the provided public token. +
+
+#### 🔌 Usage +
-**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object. - +
+
+ +```python +from merge import Merge + +client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.hris.account_token.retrieve( + public_token="public_token", +) + +``` +
+
+#### ⚙️ Parameters +
-**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) +
+
+ +**public_token:** `str`
@@ -28992,7 +28860,8 @@ If provided, will only return TimeOffBalance with this policy type. Options: ('V
-
client.hris.time_off_balances.retrieve(...) +## Hris AsyncPassthrough +
client.hris.async_passthrough.create(...)
@@ -29004,7 +28873,7 @@ If provided, will only return TimeOffBalance with this policy type. Options: ('V
-Returns a `TimeOffBalance` object with the given `id`. +Asynchronously pull data from an endpoint not currently supported by Merge.
@@ -29020,13 +28889,17 @@ Returns a `TimeOffBalance` object with the given `id`. ```python from merge import Merge +from merge.resources.hris import DataPassthroughRequest, MethodEnum client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.time_off_balances.retrieve( - id="id", +client.hris.async_passthrough.create( + request=DataPassthroughRequest( + method=MethodEnum.GET, + path="/scooters", + ), ) ``` @@ -29043,47 +28916,78 @@ client.hris.time_off_balances.retrieve(
-**id:** `str` +**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 + +
+
+
-**expand:** `typing.Optional[typing.Literal["employee"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. - +```python +from merge 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", +) + +```
- -
-
- -**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. -
-
-
- -**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). - -
-
+#### ⚙️ Parameters
-**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) +**async_passthrough_receipt_id:** `str`
@@ -29103,8 +29007,8 @@ client.hris.time_off_balances.retrieve(
-## Hris TimesheetEntries -
client.hris.timesheet_entries.list(...) +## Hris AuditTrail +
client.hris.audit_trail.list(...)
@@ -29116,7 +29020,7 @@ client.hris.time_off_balances.retrieve(
-Returns a list of `TimesheetEntry` objects. +Gets a list of audit trail events.
@@ -29137,7 +29041,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.timesheet_entries.list( +client.hris.audit_trail.list( cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", ) @@ -29155,7 +29059,7 @@ client.hris.timesheet_entries.list(
-**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime. +**cursor:** `typing.Optional[str]` — The pagination cursor value.
@@ -29163,7 +29067,7 @@ client.hris.timesheet_entries.list(
-**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime. +**end_date:** `typing.Optional[str]` — If included, will only include audit trail events that occurred before this time
@@ -29171,7 +29075,7 @@ client.hris.timesheet_entries.list(
-**cursor:** `typing.Optional[str]` — The pagination cursor value. +**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`, `REGENERATED_WEBHOOK_SIGNATURE`, `INVITED_USER`, `TWO_FACTOR_AUTH_ENABLED`, `TWO_FACTOR_AUTH_DISABLED`, `DELETED_LINKED_ACCOUNT`, `DELETED_ALL_COMMON_MODELS_FOR_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`, `CREATED_LINKED_ACCOUNT_COMMON_MODEL_OVERRIDE`, `CHANGED_LINKED_ACCOUNT_COMMON_MODEL_OVERRIDE`, `DELETED_LINKED_ACCOUNT_COMMON_MODEL_OVERRIDE`, `FORCED_LINKED_ACCOUNT_RESYNC`, `MUTED_ISSUE`, `GENERATED_MAGIC_LINK`, `ENABLED_MERGE_WEBHOOK`, `DISABLED_MERGE_WEBHOOK`, `MERGE_WEBHOOK_TARGET_CHANGED`, `END_USER_CREDENTIALS_ACCESSED`
@@ -29179,7 +29083,7 @@ client.hris.timesheet_entries.list(
-**employee_id:** `typing.Optional[str]` — If provided, will only return timesheet entries for this employee. +**page_size:** `typing.Optional[int]` — Number of results to return per page.
@@ -29187,7 +29091,7 @@ client.hris.timesheet_entries.list(
-**ended_after:** `typing.Optional[dt.datetime]` — If provided, will only return timesheet entries ended after this datetime. +**start_date:** `typing.Optional[str]` — If included, will only include audit trail events that occurred after this time
@@ -29195,7 +29099,7 @@ client.hris.timesheet_entries.list(
-**ended_before:** `typing.Optional[dt.datetime]` — If provided, will only return timesheet entries ended before this datetime. +**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.
@@ -29203,91 +29107,65 @@ client.hris.timesheet_entries.list(
-**expand:** `typing.Optional[typing.Literal["employee"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
- -
-
- -**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/). -
-
-
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. -
+
+## Hris AvailableActions +
client.hris.available_actions.retrieve()
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). - -
-
+#### 📝 Description
-**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. - +Returns a list of models and actions available for an account.
- -
-
- -**order_by:** `typing.Optional[TimesheetEntriesListRequestOrderBy]` — Overrides the default ordering for this endpoint. Possible values include: start_time, -start_time. -
+#### 🔌 Usage +
-**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. - -
-
+```python +from merge import Merge -
-
+client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.hris.available_actions.retrieve() -**started_after:** `typing.Optional[dt.datetime]` — If provided, will only return timesheet entries started after this datetime. - +``` +
+
+#### ⚙️ Parameters +
-**started_before:** `typing.Optional[dt.datetime]` — If provided, will only return timesheet entries started before this datetime. - -
-
-
@@ -29303,7 +29181,8 @@ client.hris.timesheet_entries.list(
-
client.hris.timesheet_entries.create(...) +## Hris BankInfo +
client.hris.bank_info.list(...)
@@ -29315,7 +29194,7 @@ client.hris.timesheet_entries.list(
-Creates a `TimesheetEntry` object with the given values. +Returns a list of `BankInfo` objects.
@@ -29331,14 +29210,13 @@ Creates a `TimesheetEntry` object with the given values. ```python from merge 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(), +client.hris.bank_info.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", ) ``` @@ -29355,7 +29233,12 @@ client.hris.timesheet_entries.create(
-**model:** `TimesheetEntryRequest` +**account_type:** `typing.Optional[BankInfoListRequestAccountType]` + +If provided, will only return BankInfo's with this account type. Options: ('SAVINGS', 'CHECKING') + +* `SAVINGS` - SAVINGS +* `CHECKING` - CHECKING
@@ -29363,7 +29246,7 @@ client.hris.timesheet_entries.create(
-**is_debug_mode:** `typing.Optional[bool]` — Whether to include debug fields (such as log file links) in the response. +**bank_name:** `typing.Optional[str]` — If provided, will only return BankInfo's with this bank name.
@@ -29371,7 +29254,7 @@ client.hris.timesheet_entries.create(
-**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously. +**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
@@ -29379,70 +29262,87 @@ client.hris.timesheet_entries.create(
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. +**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
- -
+
+
+**cursor:** `typing.Optional[str]` — The pagination cursor value. +
-
-
client.hris.timesheet_entries.retrieve(...)
-#### 📝 Description +**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. + +
+
+
-Returns a `TimesheetEntry` object with the given `id`. -
-
+**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/). + -#### 🔌 Usage -
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. + +
+
+
-```python -from merge import Merge +**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). + +
+
-client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.hris.timesheet_entries.retrieve( - id="id", -) +
+
-``` +**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. +
-#### ⚙️ Parameters -
+**order_by:** `typing.Optional[BankInfoListRequestOrderBy]` — Overrides the default ordering for this endpoint. Possible values include: remote_created_at, -remote_created_at. + +
+
+
-**id:** `str` +**page_size:** `typing.Optional[int]` — Number of results to return per page.
@@ -29450,7 +29350,7 @@ client.hris.timesheet_entries.retrieve(
-**expand:** `typing.Optional[typing.Literal["employee"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. +**remote_fields:** `typing.Optional[typing.Literal["account_type"]]` — Deprecated. Use show_enum_origins.
@@ -29458,7 +29358,7 @@ client.hris.timesheet_entries.retrieve(
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. +**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
@@ -29466,7 +29366,7 @@ client.hris.timesheet_entries.retrieve(
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). +**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)
@@ -29486,7 +29386,7 @@ client.hris.timesheet_entries.retrieve(
-
client.hris.timesheet_entries.meta_post_retrieve() +
client.hris.bank_info.retrieve(...)
@@ -29498,7 +29398,7 @@ client.hris.timesheet_entries.retrieve(
-Returns metadata for `TimesheetEntry` POSTs. +Returns a `BankInfo` object with the given `id`.
@@ -29519,7 +29419,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.timesheet_entries.meta_post_retrieve() +client.hris.bank_info.retrieve( + id="id", +) ``` @@ -29535,65 +29437,51 @@ client.hris.timesheet_entries.meta_post_retrieve()
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. +**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. +
-
-## Hris WebhookReceivers -
client.hris.webhook_receivers.list()
-#### 📝 Description - -
-
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. + +
+
-Returns a list of `WebhookReceiver` objects. -
-
+**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). +
-#### 🔌 Usage -
-
-
- -```python -from merge import Merge - -client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.hris.webhook_receivers.list() - -``` -
-
+**remote_fields:** `typing.Optional[typing.Literal["account_type"]]` — Deprecated. Use show_enum_origins. +
-
- -#### ⚙️ Parameters +
+**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) + +
+
+
@@ -29609,7 +29497,8 @@ client.hris.webhook_receivers.list()
-
client.hris.webhook_receivers.create(...) +## Hris Benefits +
client.hris.benefits.list(...)
@@ -29621,7 +29510,7 @@ client.hris.webhook_receivers.list()
-Creates a `WebhookReceiver` object with the given values. +Returns a list of `Benefit` objects.
@@ -29642,9 +29531,8 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.webhook_receivers.create( - event="event", - is_active=True, +client.hris.benefits.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", ) ``` @@ -29661,7 +29549,7 @@ client.hris.webhook_receivers.create(
-**event:** `str` +**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
@@ -29669,7 +29557,7 @@ client.hris.webhook_receivers.create(
-**is_active:** `bool` +**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
@@ -29677,7 +29565,7 @@ client.hris.webhook_receivers.create(
-**key:** `typing.Optional[str]` +**cursor:** `typing.Optional[str]` — The pagination cursor value.
@@ -29685,65 +29573,75 @@ client.hris.webhook_receivers.create(
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. +**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. +
-
-## Ticketing AccountDetails -
client.ticketing.account_details.retrieve()
-#### 📝 Description +**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/). + +
+
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. + +
+
+
-Get details for a linked account. -
-
+**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). + -#### 🔌 Usage -
+**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned. + +
+
+
-```python -from merge import Merge - -client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.ticketing.account_details.retrieve() - -``` +**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. +
-#### ⚙️ Parameters -
+**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object. + +
+
+
@@ -29759,8 +29657,7 @@ client.ticketing.account_details.retrieve()
-## Ticketing AccountToken -
client.ticketing.account_token.retrieve(...) +
client.hris.benefits.retrieve(...)
@@ -29772,7 +29669,7 @@ client.ticketing.account_details.retrieve()
-Returns the account token for the end user with the provided public token. +Returns a `Benefit` object with the given `id`.
@@ -29793,8 +29690,8 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.account_token.retrieve( - public_token="public_token", +client.hris.benefits.retrieve( + id="id", ) ``` @@ -29811,7 +29708,31 @@ client.ticketing.account_token.retrieve(
-**public_token:** `str` +**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. + +
+
+ +
+
+ +**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -29831,8 +29752,8 @@ client.ticketing.account_token.retrieve(
-## Ticketing Accounts -
client.ticketing.accounts.list(...) +## Hris Companies +
client.hris.companies.list(...)
@@ -29844,7 +29765,7 @@ client.ticketing.account_token.retrieve(
-Returns a list of `Account` objects. +Returns a list of `Company` objects.
@@ -29865,7 +29786,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.accounts.list( +client.hris.companies.list( cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", ) @@ -29975,7 +29896,7 @@ client.ticketing.accounts.list(
-
client.ticketing.accounts.retrieve(...) +
client.hris.companies.retrieve(...)
@@ -29987,7 +29908,7 @@ client.ticketing.accounts.list(
-Returns an `Account` object with the given `id`. +Returns a `Company` object with the given `id`.
@@ -30008,7 +29929,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.accounts.retrieve( +client.hris.companies.retrieve( id="id", ) @@ -30062,8 +29983,8 @@ client.ticketing.accounts.retrieve(
-## Ticketing AsyncPassthrough -
client.ticketing.async_passthrough.create(...) +## Hris Scopes +
client.hris.scopes.default_scopes_retrieve()
@@ -30075,7 +29996,129 @@ client.ticketing.accounts.retrieve(
-Asynchronously pull data from an endpoint not currently supported by Merge. +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/5950052-common-model-and-field-scopes). +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from merge 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/5950052-common-model-and-field-scopes). +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from merge 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/5950052-common-model-and-field-scopes)
@@ -30091,17 +30134,42 @@ Asynchronously pull data from an endpoint not currently supported by Merge. ```python from merge import Merge -from merge.resources.ticketing import DataPassthroughRequest, MethodEnum +from merge.resources.hris import ( + FieldPermissionDeserializerRequest, + IndividualCommonModelScopeDeserializerRequest, + ModelPermissionDeserializerRequest, +) client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.async_passthrough.create( - request=DataPassthroughRequest( - method=MethodEnum.GET, - path="/scooters", - ), +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, + ), + }, + field_permissions=FieldPermissionDeserializerRequest( + enabled_fields=["avatar", "home_location"], + disabled_fields=["work_location"], + ), + ), + IndividualCommonModelScopeDeserializerRequest( + model_name="Benefit", + model_permissions={ + "WRITE": ModelPermissionDeserializerRequest( + is_enabled=False, + ) + }, + ), + ], ) ``` @@ -30118,7 +30186,7 @@ client.ticketing.async_passthrough.create(
-**request:** `DataPassthroughRequest` +**common_models:** `typing.Sequence[IndividualCommonModelScopeDeserializerRequest]` — The common models you want to update the scopes for
@@ -30138,7 +30206,8 @@ client.ticketing.async_passthrough.create(
-
client.ticketing.async_passthrough.retrieve(...) +## Hris DeleteAccount +
client.hris.delete_account.delete()
@@ -30150,7 +30219,7 @@ client.ticketing.async_passthrough.create(
-Retrieves data from earlier async-passthrough POST request +Delete a linked account.
@@ -30171,9 +30240,7 @@ 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", -) +client.hris.delete_account.delete() ``` @@ -30189,14 +30256,6 @@ client.ticketing.async_passthrough.retrieve(
-**async_passthrough_receipt_id:** `str` - -
-
- -
-
- **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -30209,8 +30268,8 @@ client.ticketing.async_passthrough.retrieve(
-## Ticketing Attachments -
client.ticketing.attachments.list(...) +## Hris Dependents +
client.hris.dependents.list(...)
@@ -30222,7 +30281,7 @@ client.ticketing.async_passthrough.retrieve(
-Returns a list of `Attachment` objects. +Returns a list of `Dependent` objects.
@@ -30243,7 +30302,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.attachments.list( +client.hris.dependents.list( cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", ) @@ -30285,7 +30344,7 @@ client.ticketing.attachments.list(
-**expand:** `typing.Optional[typing.Literal["ticket"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. +**employee_id:** `typing.Optional[str]` — If provided, will only return dependents for this employee.
@@ -30309,7 +30368,7 @@ client.ticketing.attachments.list(
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). +**include_sensitive_fields:** `typing.Optional[bool]` — Whether to include sensitive fields (such as social security numbers) in the response.
@@ -30317,7 +30376,7 @@ client.ticketing.attachments.list(
-**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned. +**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -30325,7 +30384,7 @@ client.ticketing.attachments.list(
-**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned. +**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
@@ -30333,7 +30392,7 @@ client.ticketing.attachments.list(
-**page_size:** `typing.Optional[int]` — Number of results to return per page. +**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
@@ -30341,7 +30400,7 @@ client.ticketing.attachments.list(
-**remote_created_after:** `typing.Optional[dt.datetime]` — If provided, will only return attachments created in the third party platform after this datetime. +**page_size:** `typing.Optional[int]` — Number of results to return per page.
@@ -30357,14 +30416,6 @@ client.ticketing.attachments.list(
-**ticket_id:** `typing.Optional[str]` — If provided, will only return comments for this ticket. - -
-
- -
-
- **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -30377,7 +30428,7 @@ client.ticketing.attachments.list(
-
client.ticketing.attachments.create(...) +
client.hris.dependents.retrieve(...)
@@ -30389,7 +30440,7 @@ client.ticketing.attachments.list(
-Creates an `Attachment` object with the given values. +Returns a `Dependent` object with the given `id`.
@@ -30405,14 +30456,13 @@ Creates an `Attachment` object with the given values. ```python from merge 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(), +client.hris.dependents.retrieve( + id="id", ) ``` @@ -30429,7 +30479,7 @@ client.ticketing.attachments.create(
-**model:** `AttachmentRequest` +**id:** `str`
@@ -30437,7 +30487,7 @@ client.ticketing.attachments.create(
-**is_debug_mode:** `typing.Optional[bool]` — Whether to include debug fields (such as log file links) in the response. +**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -30445,7 +30495,15 @@ client.ticketing.attachments.create(
-**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously. +**include_sensitive_fields:** `typing.Optional[bool]` — Whether to include sensitive fields (such as social security numbers) in the response. + +
+
+ +
+
+ +**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -30465,7 +30523,8 @@ client.ticketing.attachments.create(
-
client.ticketing.attachments.retrieve(...) +## Hris EmployeePayrollRuns +
client.hris.employee_payroll_runs.list(...)
@@ -30477,7 +30536,7 @@ client.ticketing.attachments.create(
-Returns an `Attachment` object with the given `id`. +Returns a list of `EmployeePayrollRun` objects.
@@ -30498,8 +30557,8 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.attachments.retrieve( - id="id", +client.hris.employee_payroll_runs.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", ) ``` @@ -30516,7 +30575,7 @@ client.ticketing.attachments.retrieve(
-**id:** `str` +**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
@@ -30524,7 +30583,7 @@ client.ticketing.attachments.retrieve(
-**expand:** `typing.Optional[typing.Literal["ticket"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. +**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
@@ -30532,7 +30591,7 @@ client.ticketing.attachments.retrieve(
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. +**cursor:** `typing.Optional[str]` — The pagination cursor value.
@@ -30540,7 +30599,7 @@ client.ticketing.attachments.retrieve(
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). +**employee_id:** `typing.Optional[str]` — If provided, will only return employee payroll runs for this employee.
@@ -30548,132 +30607,63 @@ client.ticketing.attachments.retrieve(
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. +**ended_after:** `typing.Optional[dt.datetime]` — If provided, will only return employee payroll runs ended after this datetime.
- -
- - - - -
- -
client.ticketing.attachments.meta_post_retrieve() -
-
- -#### 📝 Description - -
-
-Returns metadata for `TicketingAttachment` POSTs. -
-
+**ended_before:** `typing.Optional[dt.datetime]` — If provided, will only return employee payroll runs ended before this datetime. +
-#### 🔌 Usage - -
-
-
-```python -from merge import Merge - -client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.ticketing.attachments.meta_post_retrieve() - -``` -
-
+**expand:** `typing.Optional[EmployeePayrollRunsListRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. +
-#### ⚙️ Parameters -
-
-
- -**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. +**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
-
-
- - -
-
-
-## Ticketing AuditTrail -
client.ticketing.audit_trail.list(...)
-#### 📝 Description - -
-
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. + +
+
-Gets a list of audit trail events. -
-
+**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). +
-#### 🔌 Usage - -
-
-
-```python -from merge import Merge - -client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.ticketing.audit_trail.list( - cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", -) - -``` -
-
+**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned. +
-#### ⚙️ Parameters - -
-
-
-**cursor:** `typing.Optional[str]` — The pagination cursor value. +**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
@@ -30681,7 +30671,7 @@ client.ticketing.audit_trail.list(
-**end_date:** `typing.Optional[str]` — If included, will only include audit trail events that occurred before this time +**page_size:** `typing.Optional[int]` — Number of results to return per page.
@@ -30689,7 +30679,7 @@ client.ticketing.audit_trail.list(
-**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`, `REGENERATED_WEBHOOK_SIGNATURE`, `INVITED_USER`, `TWO_FACTOR_AUTH_ENABLED`, `TWO_FACTOR_AUTH_DISABLED`, `DELETED_LINKED_ACCOUNT`, `DELETED_ALL_COMMON_MODELS_FOR_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`, `CREATED_LINKED_ACCOUNT_COMMON_MODEL_OVERRIDE`, `CHANGED_LINKED_ACCOUNT_COMMON_MODEL_OVERRIDE`, `DELETED_LINKED_ACCOUNT_COMMON_MODEL_OVERRIDE`, `FORCED_LINKED_ACCOUNT_RESYNC`, `MUTED_ISSUE`, `GENERATED_MAGIC_LINK`, `ENABLED_MERGE_WEBHOOK`, `DISABLED_MERGE_WEBHOOK`, `MERGE_WEBHOOK_TARGET_CHANGED`, `END_USER_CREDENTIALS_ACCESSED` +**payroll_run_id:** `typing.Optional[str]` — If provided, will only return employee payroll runs for this employee.
@@ -30697,7 +30687,7 @@ client.ticketing.audit_trail.list(
-**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.
@@ -30705,7 +30695,7 @@ client.ticketing.audit_trail.list(
-**start_date:** `typing.Optional[str]` — If included, will only include audit trail events that occurred after this time +**started_after:** `typing.Optional[dt.datetime]` — If provided, will only return employee payroll runs started after this datetime.
@@ -30713,7 +30703,7 @@ client.ticketing.audit_trail.list(
-**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. +**started_before:** `typing.Optional[dt.datetime]` — If provided, will only return employee payroll runs started before this datetime.
@@ -30733,8 +30723,7 @@ client.ticketing.audit_trail.list(
-## Ticketing AvailableActions -
client.ticketing.available_actions.retrieve() +
client.hris.employee_payroll_runs.retrieve(...)
@@ -30746,7 +30735,7 @@ client.ticketing.audit_trail.list(
-Returns a list of models and actions available for an account. +Returns an `EmployeePayrollRun` object with the given `id`.
@@ -30767,19 +30756,53 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.available_actions.retrieve() +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. +
-#### ⚙️ Parameters +
+
+ +**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. + +
+
+**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). + +
+
+
@@ -30795,8 +30818,8 @@ client.ticketing.available_actions.retrieve()
-## Ticketing Collections -
client.ticketing.collections.list(...) +## Hris Employees +
client.hris.employees.list(...)
@@ -30808,7 +30831,7 @@ client.ticketing.available_actions.retrieve()
-Returns a list of `Collection` objects. +Returns a list of `Employee` objects.
@@ -30829,7 +30852,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.collections.list( +client.hris.employees.list( cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", ) @@ -30847,7 +30870,7 @@ client.ticketing.collections.list(
-**collection_type:** `typing.Optional[str]` — If provided, will only return collections of the given type. +**company_id:** `typing.Optional[str]` — If provided, will only return employees for this company.
@@ -30879,7 +30902,7 @@ client.ticketing.collections.list(
-**expand:** `typing.Optional[typing.Literal["parent_collection"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. +**display_full_name:** `typing.Optional[str]` — If provided, will only return employees with this display name.
@@ -30887,7 +30910,7 @@ client.ticketing.collections.list(
-**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/). +**employee_number:** `typing.Optional[str]` — If provided, will only return employees with this employee number.
@@ -30895,7 +30918,13 @@ client.ticketing.collections.list(
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. +**employment_status:** `typing.Optional[EmployeesListRequestEmploymentStatus]` + +If provided, will only return employees with this employment status. + +* `ACTIVE` - ACTIVE +* `PENDING` - PENDING +* `INACTIVE` - INACTIVE
@@ -30903,7 +30932,7 @@ client.ticketing.collections.list(
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). +**employment_type:** `typing.Optional[str]` — If provided, will only return employees that have an employment of the specified employment_type.
@@ -30911,7 +30940,7 @@ client.ticketing.collections.list(
-**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned. +**expand:** `typing.Optional[EmployeesListRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -30919,7 +30948,7 @@ client.ticketing.collections.list(
-**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned. +**first_name:** `typing.Optional[str]` — If provided, will only return employees with this first name.
@@ -30927,7 +30956,7 @@ client.ticketing.collections.list(
-**page_size:** `typing.Optional[int]` — Number of results to return per page. +**groups:** `typing.Optional[str]` — If provided, will only return employees matching the group ids; multiple groups can be separated by commas.
@@ -30935,7 +30964,7 @@ client.ticketing.collections.list(
-**parent_collection_id:** `typing.Optional[str]` — If provided, will only return collections whose parent collection matches the given id. +**home_location_id:** `typing.Optional[str]` — If provided, will only return employees for this home location.
@@ -30943,7 +30972,7 @@ client.ticketing.collections.list(
-**remote_fields:** `typing.Optional[typing.Literal["collection_type"]]` — Deprecated. Use show_enum_origins. +**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
@@ -30951,7 +30980,7 @@ client.ticketing.collections.list(
-**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object. +**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -30959,7 +30988,7 @@ client.ticketing.collections.list(
-**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) +**include_sensitive_fields:** `typing.Optional[bool]` — Whether to include sensitive fields (such as social security numbers) in the response.
@@ -30967,71 +30996,103 @@ client.ticketing.collections.list(
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. +**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
+ +
+
+ +**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. +
-
-
client.ticketing.collections.viewers_list(...)
-#### 📝 Description +**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. + +
+
+
-Returns a list of `Viewer` objects that point to a User id or Team id that is either an assignee or viewer on a `Collection` with the given id. [Learn more.](https://help.merge.dev/en/articles/10333658-ticketing-access-control-list-acls) +**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. +
-#### 🔌 Usage -
+**pay_group_id:** `typing.Optional[str]` — If provided, will only return employees for this pay group + +
+
+
-```python -from merge import Merge +**personal_email:** `typing.Optional[str]` — If provided, will only return Employees with this personal email + +
+
-client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.ticketing.collections.viewers_list( - collection_id="collection_id", - cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", -) +
+
-``` +**remote_fields:** `typing.Optional[EmployeesListRequestRemoteFields]` — Deprecated. Use show_enum_origins. +
+ +
+
+ +**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object. +
-#### ⚙️ Parameters -
+**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) + +
+
+
-**collection_id:** `str` +**started_after:** `typing.Optional[dt.datetime]` — If provided, will only return employees that started after this datetime.
@@ -31039,7 +31100,7 @@ client.ticketing.collections.viewers_list(
-**cursor:** `typing.Optional[str]` — The pagination cursor value. +**started_before:** `typing.Optional[dt.datetime]` — If provided, will only return employees that started before this datetime.
@@ -31047,7 +31108,7 @@ client.ticketing.collections.viewers_list(
-**expand:** `typing.Optional[CollectionsViewersListRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. +**team_id:** `typing.Optional[str]` — If provided, will only return employees for this team.
@@ -31055,7 +31116,7 @@ client.ticketing.collections.viewers_list(
-**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/). +**terminated_after:** `typing.Optional[dt.datetime]` — If provided, will only return employees that were terminated after this datetime.
@@ -31063,7 +31124,7 @@ client.ticketing.collections.viewers_list(
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. +**terminated_before:** `typing.Optional[dt.datetime]` — If provided, will only return employees that were terminated before this datetime.
@@ -31071,7 +31132,7 @@ client.ticketing.collections.viewers_list(
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). +**work_email:** `typing.Optional[str]` — If provided, will only return Employees with this work email
@@ -31079,7 +31140,7 @@ client.ticketing.collections.viewers_list(
-**page_size:** `typing.Optional[int]` — Number of results to return per page. +**work_location_id:** `typing.Optional[str]` — If provided, will only return employees for this location.
@@ -31099,7 +31160,7 @@ client.ticketing.collections.viewers_list(
-
client.ticketing.collections.retrieve(...) +
client.hris.employees.create(...)
@@ -31111,7 +31172,7 @@ client.ticketing.collections.viewers_list(
-Returns a `Collection` object with the given `id`. +Creates an `Employee` object with the given values.
@@ -31127,13 +31188,14 @@ Returns a `Collection` object with the given `id`. ```python from merge import Merge +from merge.resources.hris import EmployeeRequest client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.collections.retrieve( - id="id", +client.hris.employees.create( + model=EmployeeRequest(), ) ``` @@ -31150,31 +31212,7 @@ client.ticketing.collections.retrieve(
-**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. - -
-
- -
-
- -**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). +**model:** `EmployeeRequest`
@@ -31182,7 +31220,7 @@ client.ticketing.collections.retrieve(
-**remote_fields:** `typing.Optional[typing.Literal["collection_type"]]` — Deprecated. Use show_enum_origins. +**is_debug_mode:** `typing.Optional[bool]` — Whether to include debug fields (such as log file links) in the response.
@@ -31190,7 +31228,7 @@ client.ticketing.collections.retrieve(
-**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) +**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously.
@@ -31210,8 +31248,7 @@ client.ticketing.collections.retrieve(
-## Ticketing Comments -
client.ticketing.comments.list(...) +
client.hris.employees.retrieve(...)
@@ -31223,7 +31260,7 @@ client.ticketing.collections.retrieve(
-Returns a list of `Comment` objects. +Returns an `Employee` object with the given `id`.
@@ -31244,8 +31281,8 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.comments.list( - cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +client.hris.employees.retrieve( + id="id", ) ``` @@ -31262,7 +31299,7 @@ client.ticketing.comments.list(
-**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime. +**id:** `str`
@@ -31270,7 +31307,7 @@ client.ticketing.comments.list(
-**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime. +**expand:** `typing.Optional[EmployeesRetrieveRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -31278,7 +31315,7 @@ client.ticketing.comments.list(
-**cursor:** `typing.Optional[str]` — The pagination cursor value. +**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -31286,7 +31323,7 @@ client.ticketing.comments.list(
-**expand:** `typing.Optional[CommentsListRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. +**include_sensitive_fields:** `typing.Optional[bool]` — Whether to include sensitive fields (such as social security numbers) in the response.
@@ -31294,7 +31331,7 @@ client.ticketing.comments.list(
-**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/). +**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -31302,7 +31339,7 @@ client.ticketing.comments.list(
-**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[EmployeesRetrieveRequestRemoteFields]` — Deprecated. Use show_enum_origins.
@@ -31310,39 +31347,80 @@ client.ticketing.comments.list(
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). +**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 + +
+
+
-**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned. - +```python +from merge 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, +) + +```
- -
-
- -**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned. -
+#### ⚙️ Parameters +
-**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. +**model_id:** `str`
@@ -31350,7 +31428,7 @@ client.ticketing.comments.list(
-**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object. +**reason:** `IgnoreCommonModelRequestReason`
@@ -31358,7 +31436,7 @@ client.ticketing.comments.list(
-**ticket_id:** `typing.Optional[str]` — If provided, will only return comments for this ticket. +**message:** `typing.Optional[str]`
@@ -31378,7 +31456,7 @@ client.ticketing.comments.list(
-
client.ticketing.comments.create(...) +
client.hris.employees.meta_post_retrieve()
@@ -31390,7 +31468,7 @@ client.ticketing.comments.list(
-Creates a `Comment` object with the given values. +Returns metadata for `Employee` POSTs.
@@ -31406,15 +31484,12 @@ Creates a `Comment` object with the given values. ```python from merge 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(), -) +client.hris.employees.meta_post_retrieve() ``` @@ -31430,30 +31505,6 @@ client.ticketing.comments.create(
-**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.
@@ -31466,7 +31517,8 @@ client.ticketing.comments.create(
-
client.ticketing.comments.retrieve(...) +## Hris EmployerBenefits +
client.hris.employer_benefits.list(...)
@@ -31478,7 +31530,7 @@ client.ticketing.comments.create(
-Returns a `Comment` object with the given `id`. +Returns a list of `EmployerBenefit` objects.
@@ -31499,8 +31551,8 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.comments.retrieve( - id="id", +client.hris.employer_benefits.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", ) ``` @@ -31517,7 +31569,7 @@ client.ticketing.comments.retrieve(
-**id:** `str` +**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
@@ -31525,7 +31577,23 @@ client.ticketing.comments.retrieve(
-**expand:** `typing.Optional[CommentsRetrieveRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. +**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]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
@@ -31549,6 +31617,38 @@ client.ticketing.comments.retrieve(
+**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.
@@ -31561,7 +31661,7 @@ client.ticketing.comments.retrieve(
-
client.ticketing.comments.meta_post_retrieve() +
client.hris.employer_benefits.retrieve(...)
@@ -31573,7 +31673,7 @@ client.ticketing.comments.retrieve(
-Returns metadata for `Comment` POSTs. +Returns an `EmployerBenefit` object with the given `id`.
@@ -31594,7 +31694,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.comments.meta_post_retrieve() +client.hris.employer_benefits.retrieve( + id="id", +) ``` @@ -31610,6 +31712,30 @@ client.ticketing.comments.meta_post_retrieve()
+**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_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). + +
+
+ +
+
+ **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -31622,8 +31748,8 @@ client.ticketing.comments.meta_post_retrieve()
-## Ticketing Contacts -
client.ticketing.contacts.list(...) +## Hris Employments +
client.hris.employments.list(...)
@@ -31635,7 +31761,7 @@ client.ticketing.comments.meta_post_retrieve()
-Returns a list of `Contact` objects. +Returns a list of `Employment` objects.
@@ -31656,7 +31782,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.contacts.list( +client.hris.employments.list( cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", ) @@ -31698,7 +31824,7 @@ client.ticketing.contacts.list(
-**expand:** `typing.Optional[typing.Literal["account"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. +**employee_id:** `typing.Optional[str]` — If provided, will only return employments for this employee.
@@ -31706,7 +31832,7 @@ client.ticketing.contacts.list(
-**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/). +**expand:** `typing.Optional[EmploymentsListRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -31714,7 +31840,7 @@ client.ticketing.contacts.list(
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. +**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
@@ -31722,7 +31848,7 @@ client.ticketing.contacts.list(
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). +**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -31730,7 +31856,7 @@ client.ticketing.contacts.list(
-**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned. +**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -31738,7 +31864,7 @@ client.ticketing.contacts.list(
-**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned. +**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
@@ -31746,7 +31872,7 @@ client.ticketing.contacts.list(
-**page_size:** `typing.Optional[int]` — Number of results to return per page. +**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
@@ -31754,7 +31880,7 @@ client.ticketing.contacts.list(
-**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object. +**order_by:** `typing.Optional[EmploymentsListRequestOrderBy]` — Overrides the default ordering for this endpoint. Possible values include: effective_date, -effective_date.
@@ -31762,71 +31888,15 @@ client.ticketing.contacts.list(
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. +**page_size:** `typing.Optional[int]` — Number of results to return per page.
- -
- - - - -
- -
client.ticketing.contacts.create(...) -
-
- -#### 📝 Description - -
-
- -
-
- -Creates a `Contact` object with the given values. -
-
-
-
- -#### 🔌 Usage - -
-
- -
-
- -```python -from merge 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` +**remote_fields:** `typing.Optional[EmploymentsListRequestRemoteFields]` — Deprecated. Use show_enum_origins.
@@ -31834,7 +31904,7 @@ client.ticketing.contacts.create(
-**is_debug_mode:** `typing.Optional[bool]` — Whether to include debug fields (such as log file links) in the response. +**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
@@ -31842,7 +31912,7 @@ client.ticketing.contacts.create(
-**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously. +**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)
@@ -31862,7 +31932,7 @@ client.ticketing.contacts.create(
-
client.ticketing.contacts.retrieve(...) +
client.hris.employments.retrieve(...)
@@ -31874,7 +31944,7 @@ client.ticketing.contacts.create(
-Returns a `Contact` object with the given `id`. +Returns an `Employment` object with the given `id`.
@@ -31895,7 +31965,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.contacts.retrieve( +client.hris.employments.retrieve( id="id", ) @@ -31905,15 +31975,31 @@ client.ticketing.contacts.retrieve(
-#### ⚙️ Parameters - +#### ⚙️ Parameters + +
+
+ +
+
+ +**id:** `str` + +
+
+
+**expand:** `typing.Optional[EmploymentsRetrieveRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. + +
+
+
-**id:** `str` +**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -31921,7 +32007,7 @@ client.ticketing.contacts.retrieve(
-**expand:** `typing.Optional[typing.Literal["account"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. +**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -31929,7 +32015,7 @@ client.ticketing.contacts.retrieve(
-**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.
@@ -31937,7 +32023,7 @@ client.ticketing.contacts.retrieve(
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). +**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)
@@ -31957,7 +32043,8 @@ client.ticketing.contacts.retrieve(
-
client.ticketing.contacts.meta_post_retrieve() +## Hris FieldMapping +
client.hris.field_mapping.field_mappings_retrieve(...)
@@ -31969,7 +32056,7 @@ client.ticketing.contacts.retrieve(
-Returns metadata for `TicketingContact` POSTs. +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/).
@@ -31990,7 +32077,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.contacts.meta_post_retrieve() +client.hris.field_mapping.field_mappings_retrieve() ``` @@ -32006,6 +32093,14 @@ client.ticketing.contacts.meta_post_retrieve()
+**exclude_remote_field_metadata:** `typing.Optional[bool]` — If `true`, remote fields metadata is excluded from each field mapping instance (i.e. `remote_fields.remote_key_name` and `remote_fields.schema` will be null). This will increase the speed of the request since these fields require some calculations. + +
+
+ +
+
+ **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -32018,8 +32113,7 @@ client.ticketing.contacts.meta_post_retrieve()
-## Ticketing Scopes -
client.ticketing.scopes.default_scopes_retrieve() +
client.hris.field_mapping.field_mappings_create(...)
@@ -32031,7 +32125,7 @@ client.ticketing.contacts.meta_post_retrieve()
-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/5950052-common-model-and-field-scopes). +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.
@@ -32052,7 +32146,14 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.scopes.default_scopes_retrieve() +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", +) ``` @@ -32068,64 +32169,59 @@ client.ticketing.scopes.default_scopes_retrieve()
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. +**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. +
-
-
client.ticketing.scopes.linked_account_scopes_retrieve()
-#### 📝 Description - -
-
+**remote_field_traversal_path:** `typing.Sequence[typing.Optional[typing.Any]]` — The field traversal path of the remote field listed when you hit the GET /remote-fields endpoint. + +
+
-Get all available permissions for Merge Common Models and fields for a single Linked Account. [Learn more](https://help.merge.dev/en/articles/5950052-common-model-and-field-scopes). -
-
+**remote_method:** `str` — The method of the remote endpoint where the remote field is coming from. +
-#### 🔌 Usage -
+**remote_url_path:** `str` — The path of the remote endpoint where the remote field is coming from. + +
+
+
-```python -from merge import Merge - -client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.ticketing.scopes.linked_account_scopes_retrieve() - -``` -
-
+**common_model_name:** `str` — The name of the Common Model that the remote field corresponds to in a given category. + -#### ⚙️ Parameters -
+**exclude_remote_field_metadata:** `typing.Optional[bool]` — If `true`, remote fields metadata is excluded from each field mapping instance (i.e. `remote_fields.remote_key_name` and `remote_fields.schema` will be null). This will increase the speed of the request since these fields require some calculations. + +
+
+
@@ -32141,7 +32237,7 @@ client.ticketing.scopes.linked_account_scopes_retrieve()
-
client.ticketing.scopes.linked_account_scopes_create(...) +
client.hris.field_mapping.field_mappings_destroy(...)
@@ -32153,7 +32249,7 @@ client.ticketing.scopes.linked_account_scopes_retrieve()
-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/5950052-common-model-and-field-scopes) +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.
@@ -32169,42 +32265,13 @@ Update permissions for any Common Model or field for a single Linked Account. An ```python from merge import Merge -from merge.resources.ticketing import ( - FieldPermissionDeserializerRequest, - 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, - ), - }, - field_permissions=FieldPermissionDeserializerRequest( - enabled_fields=["avatar", "home_location"], - disabled_fields=["work_location"], - ), - ), - IndividualCommonModelScopeDeserializerRequest( - model_name="Benefit", - model_permissions={ - "WRITE": ModelPermissionDeserializerRequest( - is_enabled=False, - ) - }, - ), - ], +client.hris.field_mapping.field_mappings_destroy( + field_mapping_id="field_mapping_id", ) ``` @@ -32221,7 +32288,7 @@ client.ticketing.scopes.linked_account_scopes_create(
-**common_models:** `typing.Sequence[IndividualCommonModelScopeDeserializerRequest]` — The common models you want to update the scopes for +**field_mapping_id:** `str`
@@ -32241,8 +32308,7 @@ client.ticketing.scopes.linked_account_scopes_create(
-## Ticketing DeleteAccount -
client.ticketing.delete_account.delete() +
client.hris.field_mapping.field_mappings_partial_update(...)
@@ -32254,7 +32320,7 @@ client.ticketing.scopes.linked_account_scopes_create(
-Delete a linked account. +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.
@@ -32275,7 +32341,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.delete_account.delete() +client.hris.field_mapping.field_mappings_partial_update( + field_mapping_id="field_mapping_id", +) ``` @@ -32291,69 +32359,31 @@ client.ticketing.delete_account.delete()
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. +**field_mapping_id:** `str`
- -
- - - - -
- -## Ticketing FieldMapping -
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/). -
-
+**remote_field_traversal_path:** `typing.Optional[typing.Sequence[typing.Optional[typing.Any]]]` — The field traversal path of the remote field listed when you hit the GET /remote-fields endpoint. +
-#### 🔌 Usage - -
-
-
-```python -from merge import Merge - -client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.ticketing.field_mapping.field_mappings_retrieve() - -``` -
-
+**remote_method:** `typing.Optional[str]` — The method of the remote endpoint where the remote field is coming from. +
-#### ⚙️ Parameters - -
-
-
-**exclude_remote_field_metadata:** `typing.Optional[bool]` — If `true`, remote fields metadata is excluded from each field mapping instance (i.e. `remote_fields.remote_key_name` and `remote_fields.schema` will be null). This will increase the speed of the request since these fields require some calculations. +**remote_url_path:** `typing.Optional[str]` — The path of the remote endpoint where the remote field is coming from.
@@ -32373,7 +32403,7 @@ client.ticketing.field_mapping.field_mappings_retrieve()
-
client.ticketing.field_mapping.field_mappings_create(...) +
client.hris.field_mapping.remote_fields_retrieve(...)
@@ -32385,7 +32415,7 @@ client.ticketing.field_mapping.field_mappings_retrieve()
-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. +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/).
@@ -32406,14 +32436,7 @@ 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", -) +client.hris.field_mapping.remote_fields_retrieve() ``` @@ -32429,7 +32452,7 @@ client.ticketing.field_mapping.field_mappings_create(
-**target_field_name:** `str` — The name of the target field you want this remote field to map to. +**common_models:** `typing.Optional[str]` — A comma seperated list of Common Model names. If included, will only return Remote Fields for those Common Models.
@@ -32437,7 +32460,7 @@ client.ticketing.field_mapping.field_mappings_create(
-**target_field_description:** `str` — The description of the target field you want this remote field to map to. +**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.
@@ -32445,43 +32468,64 @@ client.ticketing.field_mapping.field_mappings_create(
-**remote_field_traversal_path:** `typing.Sequence[typing.Optional[typing.Any]]` — The field traversal path of the remote field listed when you hit the GET /remote-fields endpoint. +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+ +
-
-
-**remote_method:** `str` — The method of the remote endpoint where the remote field is coming from. -
+
+
client.hris.field_mapping.target_fields_retrieve()
-**remote_url_path:** `str` — The path of the remote endpoint where the remote field is coming from. - -
-
+#### 📝 Description
-**common_model_name:** `str` — The name of the Common Model that the remote field corresponds to in a given category. - +
+
+ +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
-**exclude_remote_field_metadata:** `typing.Optional[bool]` — If `true`, remote fields metadata is excluded from each field mapping instance (i.e. `remote_fields.remote_key_name` and `remote_fields.schema` will be null). This will increase the speed of the request since these fields require some calculations. - +
+
+ +```python +from merge import Merge + +client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.hris.field_mapping.target_fields_retrieve() + +``` +
+
+#### ⚙️ Parameters + +
+
+
@@ -32497,7 +32541,8 @@ client.ticketing.field_mapping.field_mappings_create(
-
client.ticketing.field_mapping.field_mappings_destroy(...) +## Hris GenerateKey +
client.hris.generate_key.create(...)
@@ -32509,7 +32554,7 @@ client.ticketing.field_mapping.field_mappings_create(
-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. +Create a remote key.
@@ -32530,8 +32575,8 @@ 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", +client.hris.generate_key.create( + name="Remote Deployment Key 1", ) ``` @@ -32548,7 +32593,7 @@ client.ticketing.field_mapping.field_mappings_destroy(
-**field_mapping_id:** `str` +**name:** `str` — The name of the remote key
@@ -32568,7 +32613,8 @@ client.ticketing.field_mapping.field_mappings_destroy(
-
client.ticketing.field_mapping.field_mappings_partial_update(...) +## Hris Groups +
client.hris.groups.list(...)
@@ -32580,7 +32626,7 @@ client.ticketing.field_mapping.field_mappings_destroy(
-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. +Returns a list of `Group` objects.
@@ -32601,8 +32647,8 @@ 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", +client.hris.groups.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", ) ``` @@ -32619,7 +32665,7 @@ client.ticketing.field_mapping.field_mappings_partial_update(
-**field_mapping_id:** `str` +**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
@@ -32627,7 +32673,7 @@ client.ticketing.field_mapping.field_mappings_partial_update(
-**remote_field_traversal_path:** `typing.Optional[typing.Sequence[typing.Optional[typing.Any]]]` — The field traversal path of the remote field listed when you hit the GET /remote-fields endpoint. +**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
@@ -32635,7 +32681,7 @@ client.ticketing.field_mapping.field_mappings_partial_update(
-**remote_method:** `typing.Optional[str]` — The method of the remote endpoint where the remote field is coming from. +**cursor:** `typing.Optional[str]` — The pagination cursor value.
@@ -32643,7 +32689,7 @@ client.ticketing.field_mapping.field_mappings_partial_update(
-**remote_url_path:** `typing.Optional[str]` — The path of the remote endpoint where the remote field is coming from. +**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
@@ -32651,68 +32697,79 @@ client.ticketing.field_mapping.field_mappings_partial_update(
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. +**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
- -
+
+
+**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). +
-
-
client.ticketing.field_mapping.remote_fields_retrieve(...)
-#### 📝 Description +**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. + +
+
+
-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/). -
-
+**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned. + -#### 🔌 Usage -
+**names:** `typing.Optional[str]` — If provided, will only return groups with these names. Multiple values can be separated by commas. + +
+
+
-```python -from merge import Merge - -client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.ticketing.field_mapping.remote_fields_retrieve() - -``` +**page_size:** `typing.Optional[int]` — Number of results to return per page. +
+ +
+
+ +**remote_fields:** `typing.Optional[typing.Literal["type"]]` — Deprecated. Use show_enum_origins. +
-#### ⚙️ Parameters -
+**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object. + +
+
+
-**common_models:** `typing.Optional[str]` — A comma seperated list of Common Model names. If included, will only return Remote Fields for those Common Models. +**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)
@@ -32720,7 +32777,7 @@ client.ticketing.field_mapping.remote_fields_retrieve()
-**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. +**types:** `typing.Optional[str]` — If provided, will only return groups of these types. Multiple values can be separated by commas.
@@ -32740,7 +32797,7 @@ client.ticketing.field_mapping.remote_fields_retrieve()
-
client.ticketing.field_mapping.target_fields_retrieve() +
client.hris.groups.retrieve(...)
@@ -32752,7 +32809,7 @@ client.ticketing.field_mapping.remote_fields_retrieve()
-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/). +Returns a `Group` object with the given `id`.
@@ -32773,7 +32830,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.field_mapping.target_fields_retrieve() +client.hris.groups.retrieve( + id="id", +) ``` @@ -32789,71 +32848,39 @@ client.ticketing.field_mapping.target_fields_retrieve()
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. +**id:** `str`
- -
- - - - -
-## Ticketing GenerateKey -
client.ticketing.generate_key.create(...)
-#### 📝 Description - -
-
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. + +
+
-Create a remote key. -
-
+**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). +
-#### 🔌 Usage - -
-
-
-```python -from merge import Merge - -client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.ticketing.generate_key.create( - name="Remote Deployment Key 1", -) - -``` -
-
+**remote_fields:** `typing.Optional[typing.Literal["type"]]` — Deprecated. Use show_enum_origins. +
-#### ⚙️ Parameters - -
-
-
-**name:** `str` — The name of the remote key +**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)
@@ -32873,8 +32900,8 @@ client.ticketing.generate_key.create(
-## Ticketing Issues -
client.ticketing.issues.list(...) +## Hris Issues +
client.hris.issues.list(...)
@@ -32907,7 +32934,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.issues.list( +client.hris.issues.list( cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", ) @@ -33054,7 +33081,7 @@ Status of the issue. Options: ('ONGOING', 'RESOLVED')
-
client.ticketing.issues.retrieve(...) +
client.hris.issues.retrieve(...)
@@ -33087,7 +33114,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.issues.retrieve( +client.hris.issues.retrieve( id="id", ) @@ -33125,8 +33152,8 @@ client.ticketing.issues.retrieve(
-## Ticketing LinkToken -
client.ticketing.link_token.create(...) +## Hris LinkToken +
client.hris.link_token.create(...)
@@ -33154,13 +33181,13 @@ Creates a link token to be used when linking a new end user. ```python from merge import Merge -from merge.resources.ticketing import CategoriesEnum +from merge.resources.hris import CategoriesEnum client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.link_token.create( +client.hris.link_token.create( end_user_email_address="example@gmail.com", end_user_organization_name="Test Organization", end_user_origin_id="12345", @@ -33309,8 +33336,8 @@ The following subset of IETF language tags can be used to configure localization
-## Ticketing LinkedAccounts -
client.ticketing.linked_accounts.list(...) +## Hris LinkedAccounts +
client.hris.linked_accounts.list(...)
@@ -33343,7 +33370,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.linked_accounts.list( +client.hris.linked_accounts.list( cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", ) @@ -33487,84 +33514,8 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing`
-## Ticketing Passthrough -
client.ticketing.passthrough.create(...) -
-
- -#### 📝 Description - -
-
- -
-
- -Pull data from an endpoint not currently supported by Merge. -
-
-
-
- -#### 🔌 Usage - -
-
- -
-
- -```python -from merge 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. - -
-
-
-
- - -
-
-
- -## Ticketing Projects -
client.ticketing.projects.list(...) +## Hris Locations +
client.hris.locations.list(...)
@@ -33576,7 +33527,7 @@ client.ticketing.passthrough.create(
-Returns a list of `Project` objects. +Returns a list of `Location` objects.
@@ -33597,7 +33548,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.projects.list( +client.hris.locations.list( cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", ) @@ -33663,15 +33614,12 @@ client.ticketing.projects.list(
-**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned. - -
-
+**location_type:** `typing.Optional[LocationsListRequestLocationType]` -
-
+If provided, will only return locations with this location_type -**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned. +* `HOME` - HOME +* `WORK` - WORK
@@ -33679,7 +33627,7 @@ client.ticketing.projects.list(
-**page_size:** `typing.Optional[int]` — Number of results to return per page. +**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
@@ -33687,7 +33635,7 @@ client.ticketing.projects.list(
-**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object. +**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
@@ -33695,70 +33643,15 @@ client.ticketing.projects.list(
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. +**page_size:** `typing.Optional[int]` — Number of results to return per page.
- -
- - - - -
- -
client.ticketing.projects.retrieve(...) -
-
- -#### 📝 Description - -
-
- -
-
- -Returns a `Project` object with the given `id`. -
-
-
-
- -#### 🔌 Usage - -
-
- -
-
- -```python -from merge import Merge - -client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.ticketing.projects.retrieve( - id="id", -) - -``` -
-
-
-
- -#### ⚙️ Parameters
-
-
- -**id:** `str` +**remote_fields:** `typing.Optional[LocationsListRequestRemoteFields]` — Deprecated. Use show_enum_origins.
@@ -33766,7 +33659,7 @@ client.ticketing.projects.retrieve(
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. +**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
@@ -33774,7 +33667,7 @@ client.ticketing.projects.retrieve(
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). +**show_enum_origins:** `typing.Optional[LocationsListRequestShowEnumOrigins]` — 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)
@@ -33794,7 +33687,7 @@ client.ticketing.projects.retrieve(
-
client.ticketing.projects.users_list(...) +
client.hris.locations.retrieve(...)
@@ -33806,7 +33699,7 @@ client.ticketing.projects.retrieve(
-Returns a list of `User` objects. +Returns a `Location` object with the given `id`.
@@ -33827,9 +33720,8 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.projects.users_list( - parent_id="parent_id", - cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +client.hris.locations.retrieve( + id="id", ) ``` @@ -33846,23 +33738,7 @@ client.ticketing.projects.users_list(
-**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. +**id:** `str`
@@ -33870,7 +33746,7 @@ client.ticketing.projects.users_list(
-**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/). +**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -33878,7 +33754,7 @@ client.ticketing.projects.users_list(
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. +**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -33886,7 +33762,7 @@ client.ticketing.projects.users_list(
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). +**remote_fields:** `typing.Optional[LocationsRetrieveRequestRemoteFields]` — Deprecated. Use show_enum_origins.
@@ -33894,7 +33770,7 @@ client.ticketing.projects.users_list(
-**page_size:** `typing.Optional[int]` — Number of results to return per page. +**show_enum_origins:** `typing.Optional[LocationsRetrieveRequestShowEnumOrigins]` — 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)
@@ -33914,8 +33790,8 @@ client.ticketing.projects.users_list(
-## Ticketing RegenerateKey -
client.ticketing.regenerate_key.create(...) +## Hris Passthrough +
client.hris.passthrough.create(...)
@@ -33927,7 +33803,7 @@ client.ticketing.projects.users_list(
-Exchange remote keys. +Pull data from an endpoint not currently supported by Merge.
@@ -33943,13 +33819,17 @@ Exchange remote keys. ```python from merge import Merge +from merge.resources.hris import DataPassthroughRequest, MethodEnum client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.regenerate_key.create( - name="Remote Deployment Key 1", +client.hris.passthrough.create( + request=DataPassthroughRequest( + method=MethodEnum.GET, + path="/scooters", + ), ) ``` @@ -33966,7 +33846,7 @@ client.ticketing.regenerate_key.create(
-**name:** `str` — The name of the remote key +**request:** `DataPassthroughRequest`
@@ -33986,8 +33866,8 @@ client.ticketing.regenerate_key.create(
-## Ticketing Roles -
client.ticketing.roles.list(...) +## Hris PayGroups +
client.hris.pay_groups.list(...)
@@ -33999,7 +33879,7 @@ client.ticketing.regenerate_key.create(
-Returns a list of `Role` objects. +Returns a list of `PayGroup` objects.
@@ -34020,7 +33900,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.roles.list( +client.hris.pay_groups.list( cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", ) @@ -34130,7 +34010,7 @@ client.ticketing.roles.list(
-
client.ticketing.roles.retrieve(...) +
client.hris.pay_groups.retrieve(...)
@@ -34142,7 +34022,7 @@ client.ticketing.roles.list(
-Returns a `Role` object with the given `id`. +Returns a `PayGroup` object with the given `id`.
@@ -34163,7 +34043,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.roles.retrieve( +client.hris.pay_groups.retrieve( id="id", ) @@ -34217,8 +34097,8 @@ client.ticketing.roles.retrieve(
-## Ticketing SyncStatus -
client.ticketing.sync_status.list(...) +## Hris PayrollRuns +
client.hris.payroll_runs.list(...)
@@ -34230,7 +34110,7 @@ client.ticketing.roles.retrieve(
-Get sync status for the current sync and the most recently finished sync. `last_sync_start` represents the most recent time any sync began. `last_sync_finished` represents the most recent time any sync completed. These timestamps may correspond to different sync instances which may result in a sync start time being later than a separate sync completed time. To ensure you are retrieving the latest available data reference the `last_sync_finished` timestamp where `last_sync_result` is `DONE`. Possible values for `status` and `last_sync_result` are `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). +Returns a list of `PayrollRun` objects.
@@ -34251,7 +34131,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.sync_status.list( +client.hris.payroll_runs.list( cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", ) @@ -34269,6 +34149,22 @@ client.ticketing.sync_status.list(
+**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.
@@ -34277,7 +34173,7 @@ client.ticketing.sync_status.list(
-**page_size:** `typing.Optional[int]` — Number of results to return per page. +**ended_after:** `typing.Optional[dt.datetime]` — If provided, will only return payroll runs ended after this datetime.
@@ -34285,65 +34181,115 @@ client.ticketing.sync_status.list(
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. +**ended_before:** `typing.Optional[dt.datetime]` — If provided, will only return payroll runs ended before this datetime.
+ +
+
+ +**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/). +
+
+
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. +
-
-## Ticketing ForceResync -
client.ticketing.force_resync.sync_status_resync_create()
-#### 📝 Description +**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). + +
+
+**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned. + +
+
+
-Force re-sync of all models. This endpoint is available for monthly, quarterly, and highest sync frequency customers on the Professional or Enterprise plans. Doing so will consume a sync credit for the relevant linked account. Force re-syncs can also be triggered manually in the Merge Dashboard and is available for all customers. +**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. +
-#### 🔌 Usage +
+
+ +**remote_fields:** `typing.Optional[PayrollRunsListRequestRemoteFields]` — Deprecated. Use show_enum_origins. + +
+
+**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object. + +
+
+
-```python -from merge import Merge +**run_type:** `typing.Optional[PayrollRunsListRequestRunType]` -client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.ticketing.force_resync.sync_status_resync_create() +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) +
-#### ⚙️ Parameters +
+
+ +**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. + +
+
+
@@ -34359,8 +34305,7 @@ client.ticketing.force_resync.sync_status_resync_create()
-## Ticketing Tags -
client.ticketing.tags.list(...) +
client.hris.payroll_runs.retrieve(...)
@@ -34372,7 +34317,7 @@ client.ticketing.force_resync.sync_status_resync_create()
-Returns a list of `Tag` objects. +Returns a `PayrollRun` object with the given `id`.
@@ -34393,8 +34338,8 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.tags.list( - cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +client.hris.payroll_runs.retrieve( + id="id", ) ``` @@ -34411,7 +34356,7 @@ client.ticketing.tags.list(
-**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime. +**id:** `str`
@@ -34419,7 +34364,7 @@ client.ticketing.tags.list(
-**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime. +**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -34427,7 +34372,7 @@ client.ticketing.tags.list(
-**cursor:** `typing.Optional[str]` — The pagination cursor value. +**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -34435,7 +34380,7 @@ client.ticketing.tags.list(
-**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/). +**remote_fields:** `typing.Optional[PayrollRunsRetrieveRequestRemoteFields]` — Deprecated. Use show_enum_origins.
@@ -34443,7 +34388,7 @@ client.ticketing.tags.list(
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. +**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)
@@ -34451,39 +34396,71 @@ client.ticketing.tags.list(
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+ +
-
-
-**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned. -
+
+## Hris RegenerateKey +
client.hris.regenerate_key.create(...)
-**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned. - +#### 📝 Description + +
+
+ +
+
+ +Exchange remote keys. +
+
+#### 🔌 Usage +
-**page_size:** `typing.Optional[int]` — Number of results to return per page. - +
+
+ +```python +from merge 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
-**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object. +
+
+ +**name:** `str` — The name of the remote key
@@ -34503,7 +34480,8 @@ client.ticketing.tags.list(
-
client.ticketing.tags.retrieve(...) +## Hris SyncStatus +
client.hris.sync_status.list(...)
@@ -34515,7 +34493,7 @@ client.ticketing.tags.list(
-Returns a `Tag` object with the given `id`. +Get sync status for the current sync and the most recently finished sync. `last_sync_start` represents the most recent time any sync began. `last_sync_finished` represents the most recent time any sync completed. These timestamps may correspond to different sync instances which may result in a sync start time being later than a separate sync completed time. To ensure you are retrieving the latest available data reference the `last_sync_finished` timestamp where `last_sync_result` is `DONE`. Possible values for `status` and `last_sync_result` are `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).
@@ -34536,8 +34514,8 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.tags.retrieve( - id="id", +client.hris.sync_status.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", ) ``` @@ -34554,15 +34532,7 @@ client.ticketing.tags.retrieve(
-**id:** `str` - -
-
- -
-
- -**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. +**cursor:** `typing.Optional[str]` — The pagination cursor value.
@@ -34570,7 +34540,7 @@ client.ticketing.tags.retrieve(
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). +**page_size:** `typing.Optional[int]` — Number of results to return per page.
@@ -34590,8 +34560,8 @@ client.ticketing.tags.retrieve(
-## Ticketing Teams -
client.ticketing.teams.list(...) +## Hris ForceResync +
client.hris.force_resync.sync_status_resync_create()
@@ -34603,7 +34573,7 @@ client.ticketing.tags.retrieve(
-Returns a list of `Team` objects. +Force re-sync of all models. This endpoint is available for monthly, quarterly, and highest sync frequency customers on the Professional or Enterprise plans. Doing so will consume a sync credit for the relevant linked account. Force re-syncs can also be triggered manually in the Merge Dashboard and is available for all customers.
@@ -34624,9 +34594,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.teams.list( - cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", -) +client.hris.force_resync.sync_status_resync_create() ``` @@ -34642,55 +34610,71 @@ client.ticketing.teams.list(
-**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime. +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+ +
-
-
-**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime. -
+
+## Hris Teams +
client.hris.teams.list(...)
-**cursor:** `typing.Optional[str]` — The pagination cursor value. - -
-
+#### 📝 Description
-**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/). - -
-
-
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. - +Returns a list of `Team` objects.
+ + + +#### 🔌 Usage
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). - +
+
+ +```python +from merge import Merge + +client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.hris.teams.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) + +``` +
+
+#### ⚙️ Parameters +
-**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned. +
+
+ +**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
@@ -34698,7 +34682,7 @@ client.ticketing.teams.list(
-**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned. +**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
@@ -34706,7 +34690,7 @@ client.ticketing.teams.list(
-**page_size:** `typing.Optional[int]` — Number of results to return per page. +**cursor:** `typing.Optional[str]` — The pagination cursor value.
@@ -34714,7 +34698,7 @@ client.ticketing.teams.list(
-**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object. +**expand:** `typing.Optional[typing.Literal["parent_team"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -34722,70 +34706,47 @@ client.ticketing.teams.list(
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. +**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
-
-
+
+
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. +
-
-
client.ticketing.teams.retrieve(...)
-#### 📝 Description - -
-
+**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). + +
+
-Returns a `Team` object with the given `id`. -
-
+**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned. +
-#### 🔌 Usage - -
-
-
-```python -from merge import Merge - -client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.ticketing.teams.retrieve( - id="id", -) - -``` -
-
+**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned. +
-#### ⚙️ Parameters - -
-
-
-**id:** `str` +**page_size:** `typing.Optional[int]` — Number of results to return per page.
@@ -34793,7 +34754,7 @@ client.ticketing.teams.retrieve(
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. +**parent_team_id:** `typing.Optional[str]` — If provided, will only return teams with this parent team.
@@ -34801,7 +34762,7 @@ client.ticketing.teams.retrieve(
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). +**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
@@ -34821,8 +34782,7 @@ client.ticketing.teams.retrieve(
-## Ticketing Tickets -
client.ticketing.tickets.list(...) +
client.hris.teams.retrieve(...)
@@ -34834,7 +34794,7 @@ client.ticketing.teams.retrieve(
-Returns a list of `Ticket` objects. +Returns a `Team` object with the given `id`.
@@ -34855,8 +34815,8 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.tickets.list( - cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +client.hris.teams.retrieve( + id="id", ) ``` @@ -34873,7 +34833,7 @@ client.ticketing.tickets.list(
-**account_id:** `typing.Optional[str]` — If provided, will only return tickets for this account. +**id:** `str`
@@ -34881,7 +34841,7 @@ client.ticketing.tickets.list(
-**assignee_ids:** `typing.Optional[str]` — If provided, will only return tickets assigned to the assignee_ids; multiple assignee_ids can be separated by commas. +**expand:** `typing.Optional[typing.Literal["parent_team"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -34889,7 +34849,7 @@ client.ticketing.tickets.list(
-**collection_ids:** `typing.Optional[str]` — If provided, will only return tickets assigned to the collection_ids; multiple collection_ids can be separated by commas. +**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -34897,7 +34857,7 @@ client.ticketing.tickets.list(
-**completed_after:** `typing.Optional[dt.datetime]` — If provided, will only return tickets completed after this datetime. +**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -34905,71 +34865,71 @@ client.ticketing.tickets.list(
-**completed_before:** `typing.Optional[dt.datetime]` — If provided, will only return tickets completed before this datetime. +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+ +
-
-
-**contact_id:** `typing.Optional[str]` — If provided, will only return tickets for this contact. -
+
+## Hris TimeOff +
client.hris.time_off.list(...)
-**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime. - -
-
+#### 📝 Description
-**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 tickets created by this creator_id. - +Returns a list of `TimeOff` objects.
+ + + +#### 🔌 Usage
-**cursor:** `typing.Optional[str]` — The pagination cursor value. - -
-
-
-**due_after:** `typing.Optional[dt.datetime]` — If provided, will only return tickets due after this datetime. - +```python +from merge import Merge + +client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.hris.time_off.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) + +``` +
+
+#### ⚙️ Parameters +
-**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. +**approver_id:** `typing.Optional[str]` — If provided, will only return time off for this approver.
@@ -34977,7 +34937,7 @@ client.ticketing.tickets.list(
-**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/). +**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
@@ -34985,7 +34945,7 @@ client.ticketing.tickets.list(
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. +**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
@@ -34993,7 +34953,7 @@ client.ticketing.tickets.list(
-**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. +**cursor:** `typing.Optional[str]` — The pagination cursor value.
@@ -35001,7 +34961,7 @@ client.ticketing.tickets.list(
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). +**employee_id:** `typing.Optional[str]` — If provided, will only return time off for this employee.
@@ -35009,7 +34969,7 @@ client.ticketing.tickets.list(
-**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned. +**ended_after:** `typing.Optional[dt.datetime]` — If provided, will only return employees that ended after this datetime.
@@ -35017,7 +34977,7 @@ client.ticketing.tickets.list(
-**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned. +**ended_before:** `typing.Optional[dt.datetime]` — If provided, will only return time-offs that ended before this datetime.
@@ -35025,7 +34985,7 @@ client.ticketing.tickets.list(
-**page_size:** `typing.Optional[int]` — Number of results to return per page. +**expand:** `typing.Optional[TimeOffListRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -35033,7 +34993,7 @@ client.ticketing.tickets.list(
-**parent_ticket_id:** `typing.Optional[str]` — If provided, will only return sub tickets of the parent_ticket_id. +**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
@@ -35041,14 +35001,7 @@ client.ticketing.tickets.list(
-**priority:** `typing.Optional[TicketsListRequestPriority]` - -If provided, will only return tickets of this priority. - -* `URGENT` - URGENT -* `HIGH` - HIGH -* `NORMAL` - NORMAL -* `LOW` - LOW +**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -35056,7 +35009,7 @@ If provided, will only return tickets of this priority.
-**remote_created_after:** `typing.Optional[dt.datetime]` — If provided, will only return tickets created in the third party platform after this datetime. +**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -35064,7 +35017,7 @@ If provided, will only return tickets of this priority.
-**remote_created_before:** `typing.Optional[dt.datetime]` — If provided, will only return tickets created in the third party platform before this datetime. +**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
@@ -35072,7 +35025,7 @@ If provided, will only return tickets of this priority.
-**remote_fields:** `typing.Optional[TicketsListRequestRemoteFields]` — Deprecated. Use show_enum_origins. +**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
@@ -35080,7 +35033,7 @@ If provided, will only return tickets of this priority.
-**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object. +**page_size:** `typing.Optional[int]` — Number of results to return per page.
@@ -35088,7 +35041,7 @@ If provided, will only return tickets of this priority.
-**remote_updated_after:** `typing.Optional[dt.datetime]` — If provided, will only return tickets updated in the third party platform after this datetime. +**remote_fields:** `typing.Optional[TimeOffListRequestRemoteFields]` — Deprecated. Use show_enum_origins.
@@ -35096,7 +35049,7 @@ If provided, will only return tickets of this priority.
-**remote_updated_before:** `typing.Optional[dt.datetime]` — If provided, will only return tickets updated in the third party platform before this datetime. +**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
@@ -35104,7 +35057,16 @@ If provided, will only return tickets of this priority.
-**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) +**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
@@ -35112,7 +35074,7 @@ If provided, will only return tickets of this priority.
-**status:** `typing.Optional[str]` — If provided, will only return tickets of this status. +**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)
@@ -35120,7 +35082,7 @@ If provided, will only return tickets of this priority.
-**tags:** `typing.Optional[str]` — If provided, will only return tickets matching the tags; multiple tags can be separated by commas. +**started_after:** `typing.Optional[dt.datetime]` — If provided, will only return time-offs that started after this datetime.
@@ -35128,7 +35090,7 @@ If provided, will only return tickets of this priority.
-**ticket_type:** `typing.Optional[str]` — If provided, will only return tickets of this type. +**started_before:** `typing.Optional[dt.datetime]` — If provided, will only return time-offs that started before this datetime.
@@ -35136,7 +35098,15 @@ If provided, will only return tickets of this priority.
-**ticket_url:** `typing.Optional[str]` — If provided, will only return tickets where the URL matches or contains the substring +**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
@@ -35156,7 +35126,7 @@ If provided, will only return tickets of this priority.
-
client.ticketing.tickets.create(...) +
client.hris.time_off.create(...)
@@ -35168,7 +35138,7 @@ If provided, will only return tickets of this priority.
-Creates a `Ticket` object with the given values. +Creates a `TimeOff` object with the given values.
@@ -35184,14 +35154,14 @@ Creates a `Ticket` object with the given values. ```python from merge import Merge -from merge.resources.ticketing import TicketRequest +from merge.resources.hris import TimeOffRequest client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.tickets.create( - model=TicketRequest(), +client.hris.time_off.create( + model=TimeOffRequest(), ) ``` @@ -35208,7 +35178,7 @@ client.ticketing.tickets.create(
-**model:** `TicketRequest` +**model:** `TimeOffRequest`
@@ -35244,7 +35214,7 @@ client.ticketing.tickets.create(
-
client.ticketing.tickets.retrieve(...) +
client.hris.time_off.retrieve(...)
@@ -35256,7 +35226,7 @@ client.ticketing.tickets.create(
-Returns a `Ticket` object with the given `id`. +Returns a `TimeOff` object with the given `id`.
@@ -35277,7 +35247,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.tickets.retrieve( +client.hris.time_off.retrieve( id="id", ) @@ -35303,7 +35273,7 @@ client.ticketing.tickets.retrieve(
-**expand:** `typing.Optional[TicketsRetrieveRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. +**expand:** `typing.Optional[TimeOffRetrieveRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -35319,14 +35289,6 @@ client.ticketing.tickets.retrieve(
-**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. - -
-
- -
-
- **include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -35335,7 +35297,7 @@ client.ticketing.tickets.retrieve(
-**remote_fields:** `typing.Optional[TicketsRetrieveRequestRemoteFields]` — Deprecated. Use show_enum_origins. +**remote_fields:** `typing.Optional[TimeOffRetrieveRequestRemoteFields]` — Deprecated. Use show_enum_origins.
@@ -35343,7 +35305,7 @@ client.ticketing.tickets.retrieve(
-**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) +**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)
@@ -35363,7 +35325,7 @@ client.ticketing.tickets.retrieve(
-
client.ticketing.tickets.partial_update(...) +
client.hris.time_off.meta_post_retrieve()
@@ -35375,7 +35337,7 @@ client.ticketing.tickets.retrieve(
-Updates a `Ticket` object with the given `id`. +Returns metadata for `TimeOff` POSTs.
@@ -35391,16 +35353,12 @@ Updates a `Ticket` object with the given `id`. ```python from merge 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(), -) +client.hris.time_off.meta_post_retrieve() ``` @@ -35416,38 +35374,6 @@ client.ticketing.tickets.partial_update(
-**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.
@@ -35460,7 +35386,8 @@ client.ticketing.tickets.partial_update(
-
client.ticketing.tickets.viewers_list(...) +## Hris TimeOffBalances +
client.hris.time_off_balances.list(...)
@@ -35472,7 +35399,7 @@ client.ticketing.tickets.partial_update(
-Returns a list of `Viewer` objects that point to a User id or Team id that is either an assignee or viewer on a `Ticket` with the given id. [Learn more.](https://help.merge.dev/en/articles/10333658-ticketing-access-control-list-acls) +Returns a list of `TimeOffBalance` objects.
@@ -35493,8 +35420,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.tickets.viewers_list( - ticket_id="ticket_id", +client.hris.time_off_balances.list( cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", ) @@ -35512,7 +35438,15 @@ client.ticketing.tickets.viewers_list(
-**ticket_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.
@@ -35528,7 +35462,15 @@ client.ticketing.tickets.viewers_list(
-**expand:** `typing.Optional[TicketsViewersListRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. +**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.
@@ -35560,7 +35502,64 @@ client.ticketing.tickets.viewers_list(
-**page_size:** `typing.Optional[int]` — Number of results to return per page. +**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)
@@ -35580,7 +35579,7 @@ client.ticketing.tickets.viewers_list(
-
client.ticketing.tickets.meta_patch_retrieve(...) +
client.hris.time_off_balances.retrieve(...)
@@ -35592,7 +35591,7 @@ client.ticketing.tickets.viewers_list(
-Returns metadata for `Ticket` PATCHs. +Returns a `TimeOffBalance` object with the given `id`.
@@ -35613,7 +35612,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.tickets.meta_patch_retrieve( +client.hris.time_off_balances.retrieve( id="id", ) @@ -35639,6 +35638,46 @@ client.ticketing.tickets.meta_patch_retrieve(
+**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. + +
+
+ +
+
+ +**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). + +
+
+ +
+
+ +**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.
@@ -35651,7 +35690,8 @@ client.ticketing.tickets.meta_patch_retrieve(
-
client.ticketing.tickets.meta_post_retrieve(...) +## Hris TimesheetEntries +
client.hris.timesheet_entries.list(...)
@@ -35663,7 +35703,7 @@ client.ticketing.tickets.meta_patch_retrieve(
-Returns metadata for `Ticket` POSTs. +Returns a list of `TimesheetEntry` objects.
@@ -35684,7 +35724,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.tickets.meta_post_retrieve() +client.hris.timesheet_entries.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -35700,7 +35742,7 @@ client.ticketing.tickets.meta_post_retrieve()
-**collection_id:** `typing.Optional[str]` — If provided, will only return tickets for this collection. +**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
@@ -35708,7 +35750,7 @@ client.ticketing.tickets.meta_post_retrieve()
-**ticket_type:** `typing.Optional[str]` — If provided, will only return tickets for this ticket type. +**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
@@ -35716,70 +35758,63 @@ client.ticketing.tickets.meta_post_retrieve()
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. +**cursor:** `typing.Optional[str]` — The pagination cursor value.
- -
+
+
+**employee_id:** `typing.Optional[str]` — If provided, will only return timesheet entries for this employee. +
-
-
client.ticketing.tickets.remote_field_classes_list(...)
-#### 📝 Description - -
-
+**ended_after:** `typing.Optional[dt.datetime]` — If provided, will only return timesheet entries ended after this datetime. + +
+
-Returns a list of `RemoteFieldClass` objects. -
-
+**ended_before:** `typing.Optional[dt.datetime]` — If provided, will only return timesheet entries ended before this datetime. +
-#### 🔌 Usage -
+**expand:** `typing.Optional[typing.Literal["employee"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. + +
+
+
-```python -from merge import Merge - -client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.ticketing.tickets.remote_field_classes_list( - cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", -) - -``` -
-
+**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/). + -#### ⚙️ Parameters -
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. + +
+
+
-**cursor:** `typing.Optional[str]` — The pagination cursor value. +**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -35787,7 +35822,7 @@ client.ticketing.tickets.remote_field_classes_list(
-**ids:** `typing.Optional[str]` — If provided, will only return remote field classes with the `ids` in this list +**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
@@ -35795,7 +35830,7 @@ client.ticketing.tickets.remote_field_classes_list(
-**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/). +**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
@@ -35803,7 +35838,7 @@ client.ticketing.tickets.remote_field_classes_list(
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. +**order_by:** `typing.Optional[TimesheetEntriesListRequestOrderBy]` — Overrides the default ordering for this endpoint. Possible values include: start_time, -start_time.
@@ -35811,7 +35846,7 @@ client.ticketing.tickets.remote_field_classes_list(
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). +**page_size:** `typing.Optional[int]` — Number of results to return per page.
@@ -35819,7 +35854,7 @@ client.ticketing.tickets.remote_field_classes_list(
-**is_common_model_field:** `typing.Optional[bool]` — If provided, will only return remote field classes with this is_common_model_field value +**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
@@ -35827,7 +35862,7 @@ client.ticketing.tickets.remote_field_classes_list(
-**is_custom:** `typing.Optional[bool]` — If provided, will only return remote fields classes with this is_custom value +**started_after:** `typing.Optional[dt.datetime]` — If provided, will only return timesheet entries started after this datetime.
@@ -35835,7 +35870,7 @@ client.ticketing.tickets.remote_field_classes_list(
-**page_size:** `typing.Optional[int]` — Number of results to return per page. +**started_before:** `typing.Optional[dt.datetime]` — If provided, will only return timesheet entries started before this datetime.
@@ -35855,8 +35890,7 @@ client.ticketing.tickets.remote_field_classes_list(
-## Ticketing Users -
client.ticketing.users.list(...) +
client.hris.timesheet_entries.create(...)
@@ -35868,7 +35902,7 @@ client.ticketing.tickets.remote_field_classes_list(
-Returns a list of `User` objects. +Creates a `TimesheetEntry` object with the given values.
@@ -35884,13 +35918,14 @@ Returns a list of `User` objects. ```python from merge import Merge +from merge.resources.hris import TimesheetEntryRequest client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.users.list( - cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +client.hris.timesheet_entries.create( + model=TimesheetEntryRequest(), ) ``` @@ -35907,7 +35942,7 @@ client.ticketing.users.list(
-**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime. +**model:** `TimesheetEntryRequest`
@@ -35915,7 +35950,7 @@ client.ticketing.users.list(
-**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime. +**is_debug_mode:** `typing.Optional[bool]` — Whether to include debug fields (such as log file links) in the response.
@@ -35923,7 +35958,7 @@ client.ticketing.users.list(
-**cursor:** `typing.Optional[str]` — The pagination cursor value. +**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously.
@@ -35931,55 +35966,70 @@ client.ticketing.users.list(
-**email_address:** `typing.Optional[str]` — If provided, will only return users with emails equal to this value (case insensitive). +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+ +
-
-
-**expand:** `typing.Optional[UsersListRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. -
+
+
client.hris.timesheet_entries.retrieve(...)
-**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/). - -
-
+#### 📝 Description
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. - -
-
-
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). - +Returns a `TimesheetEntry` object with the given `id`. +
+
+#### 🔌 Usage +
-**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned. - +
+
+ +```python +from merge import Merge + +client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.hris.timesheet_entries.retrieve( + id="id", +) + +``` +
+
+#### ⚙️ Parameters +
-**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned. +
+
+ +**id:** `str`
@@ -35987,7 +36037,7 @@ client.ticketing.users.list(
-**page_size:** `typing.Optional[int]` — Number of results to return per page. +**expand:** `typing.Optional[typing.Literal["employee"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -35995,7 +36045,7 @@ client.ticketing.users.list(
-**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object. +**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -36003,7 +36053,7 @@ client.ticketing.users.list(
-**team:** `typing.Optional[str]` — If provided, will only return users matching in this team. +**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -36023,7 +36073,7 @@ client.ticketing.users.list(
-
client.ticketing.users.retrieve(...) +
client.hris.timesheet_entries.meta_post_retrieve()
@@ -36035,7 +36085,7 @@ client.ticketing.users.list(
-Returns a `User` object with the given `id`. +Returns metadata for `TimesheetEntry` POSTs.
@@ -36056,9 +36106,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.users.retrieve( - id="id", -) +client.hris.timesheet_entries.meta_post_retrieve() ``` @@ -36074,38 +36122,6 @@ client.ticketing.users.retrieve(
-**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. - -
-
- -
-
- -**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). - -
-
- -
-
- **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -36118,8 +36134,8 @@ client.ticketing.users.retrieve(
-## Ticketing WebhookReceivers -
client.ticketing.webhook_receivers.list() +## Hris WebhookReceivers +
client.hris.webhook_receivers.list()
@@ -36152,7 +36168,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.webhook_receivers.list() +client.hris.webhook_receivers.list() ```
@@ -36180,7 +36196,7 @@ client.ticketing.webhook_receivers.list()
-
client.ticketing.webhook_receivers.create(...) +
client.hris.webhook_receivers.create(...)
@@ -36213,7 +36229,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.webhook_receivers.create( +client.hris.webhook_receivers.create( event="event", is_active=True, ) diff --git a/src/merge/client.py b/src/merge/client.py index f421282c..34bfbffb 100644 --- a/src/merge/client.py +++ b/src/merge/client.py @@ -87,10 +87,10 @@ def __init__( timeout=_defaulted_timeout, ) self._ats: typing.Optional[AtsClient] = None - self._crm: typing.Optional[CrmClient] = None self._filestorage: typing.Optional[FilestorageClient] = None - self._hris: typing.Optional[HrisClient] = None self._ticketing: typing.Optional[TicketingClient] = None + self._crm: typing.Optional[CrmClient] = None + self._hris: typing.Optional[HrisClient] = None self._accounting: typing.Optional[AccountingClient] = None @property @@ -101,14 +101,6 @@ def ats(self): self._ats = AtsClient(client_wrapper=self._client_wrapper) return self._ats - @property - def crm(self): - if self._crm is None: - from .resources.crm.client import CrmClient # noqa: E402 - - self._crm = CrmClient(client_wrapper=self._client_wrapper) - return self._crm - @property def filestorage(self): if self._filestorage is None: @@ -117,14 +109,6 @@ def filestorage(self): self._filestorage = FilestorageClient(client_wrapper=self._client_wrapper) return self._filestorage - @property - def hris(self): - if self._hris is None: - from .resources.hris.client import HrisClient # noqa: E402 - - self._hris = HrisClient(client_wrapper=self._client_wrapper) - return self._hris - @property def ticketing(self): if self._ticketing is None: @@ -133,6 +117,22 @@ def ticketing(self): self._ticketing = TicketingClient(client_wrapper=self._client_wrapper) return self._ticketing + @property + def crm(self): + if self._crm is None: + from .resources.crm.client import CrmClient # noqa: E402 + + self._crm = CrmClient(client_wrapper=self._client_wrapper) + return self._crm + + @property + def hris(self): + if self._hris is None: + from .resources.hris.client import HrisClient # noqa: E402 + + self._hris = HrisClient(client_wrapper=self._client_wrapper) + return self._hris + @property def accounting(self): if self._accounting is None: @@ -212,10 +212,10 @@ def __init__( timeout=_defaulted_timeout, ) self._ats: typing.Optional[AsyncAtsClient] = None - self._crm: typing.Optional[AsyncCrmClient] = None self._filestorage: typing.Optional[AsyncFilestorageClient] = None - self._hris: typing.Optional[AsyncHrisClient] = None self._ticketing: typing.Optional[AsyncTicketingClient] = None + self._crm: typing.Optional[AsyncCrmClient] = None + self._hris: typing.Optional[AsyncHrisClient] = None self._accounting: typing.Optional[AsyncAccountingClient] = None @property @@ -226,14 +226,6 @@ def ats(self): self._ats = AsyncAtsClient(client_wrapper=self._client_wrapper) return self._ats - @property - def crm(self): - if self._crm is None: - from .resources.crm.client import AsyncCrmClient # noqa: E402 - - self._crm = AsyncCrmClient(client_wrapper=self._client_wrapper) - return self._crm - @property def filestorage(self): if self._filestorage is None: @@ -242,14 +234,6 @@ def filestorage(self): self._filestorage = AsyncFilestorageClient(client_wrapper=self._client_wrapper) return self._filestorage - @property - def hris(self): - if self._hris is None: - from .resources.hris.client import AsyncHrisClient # noqa: E402 - - self._hris = AsyncHrisClient(client_wrapper=self._client_wrapper) - return self._hris - @property def ticketing(self): if self._ticketing is None: @@ -258,6 +242,22 @@ def ticketing(self): self._ticketing = AsyncTicketingClient(client_wrapper=self._client_wrapper) return self._ticketing + @property + def crm(self): + if self._crm is None: + from .resources.crm.client import AsyncCrmClient # noqa: E402 + + self._crm = AsyncCrmClient(client_wrapper=self._client_wrapper) + return self._crm + + @property + def hris(self): + if self._hris is None: + from .resources.hris.client import AsyncHrisClient # noqa: E402 + + self._hris = AsyncHrisClient(client_wrapper=self._client_wrapper) + return self._hris + @property def accounting(self): if self._accounting is None: diff --git a/src/merge/resources/accounting/client.py b/src/merge/resources/accounting/client.py index 3f8f0a08..fcf4a37c 100644 --- a/src/merge/resources/accounting/client.py +++ b/src/merge/resources/accounting/client.py @@ -174,6 +174,10 @@ def addresses(self): @property def async_passthrough(self): if self._async_passthrough is None: + from .resources.async_passthrough.client import ( + AsyncPassthroughClient as resources_accounting_resources_async_passthrough_client_AsyncPassthroughClient, # noqa: E402 + ) + self._async_passthrough = resources_accounting_resources_async_passthrough_client_AsyncPassthroughClient( client_wrapper=self._client_wrapper ) @@ -834,9 +838,13 @@ def linked_accounts(self): @property def passthrough(self): if self._passthrough is None: - from .resources.passthrough.client import AsyncPassthroughClient # noqa: E402 + from .resources.passthrough.client import ( + AsyncPassthroughClient as resources_accounting_resources_passthrough_client_AsyncPassthroughClient, # noqa: E402 + ) - self._passthrough = AsyncPassthroughClient(client_wrapper=self._client_wrapper) + self._passthrough = resources_accounting_resources_passthrough_client_AsyncPassthroughClient( + client_wrapper=self._client_wrapper + ) return self._passthrough @property diff --git a/src/merge/resources/ats/client.py b/src/merge/resources/ats/client.py index 0a094c9e..cb5551d7 100644 --- a/src/merge/resources/ats/client.py +++ b/src/merge/resources/ats/client.py @@ -135,6 +135,10 @@ def applications(self): @property def async_passthrough(self): if self._async_passthrough is None: + from .resources.async_passthrough.client import ( + AsyncPassthroughClient as resources_ats_resources_async_passthrough_client_AsyncPassthroughClient, # noqa: E402 + ) + self._async_passthrough = resources_ats_resources_async_passthrough_client_AsyncPassthroughClient( client_wrapper=self._client_wrapper ) @@ -609,9 +613,13 @@ def offices(self): @property def passthrough(self): if self._passthrough is None: - from .resources.passthrough.client import AsyncPassthroughClient # noqa: E402 + from .resources.passthrough.client import ( + AsyncPassthroughClient as resources_ats_resources_passthrough_client_AsyncPassthroughClient, # noqa: E402 + ) - self._passthrough = AsyncPassthroughClient(client_wrapper=self._client_wrapper) + self._passthrough = resources_ats_resources_passthrough_client_AsyncPassthroughClient( + client_wrapper=self._client_wrapper + ) return self._passthrough @property diff --git a/src/merge/resources/crm/client.py b/src/merge/resources/crm/client.py index b478650e..2a64aa0d 100644 --- a/src/merge/resources/crm/client.py +++ b/src/merge/resources/crm/client.py @@ -123,6 +123,10 @@ def accounts(self): @property def async_passthrough(self): if self._async_passthrough is None: + from .resources.async_passthrough.client import ( + AsyncPassthroughClient as resources_crm_resources_async_passthrough_client_AsyncPassthroughClient, # noqa: E402 + ) + self._async_passthrough = resources_crm_resources_async_passthrough_client_AsyncPassthroughClient( client_wrapper=self._client_wrapper ) @@ -579,9 +583,13 @@ def opportunities(self): @property def passthrough(self): if self._passthrough is None: - from .resources.passthrough.client import AsyncPassthroughClient # noqa: E402 + from .resources.passthrough.client import ( + AsyncPassthroughClient as resources_crm_resources_passthrough_client_AsyncPassthroughClient, # noqa: E402 + ) - self._passthrough = AsyncPassthroughClient(client_wrapper=self._client_wrapper) + self._passthrough = resources_crm_resources_passthrough_client_AsyncPassthroughClient( + client_wrapper=self._client_wrapper + ) return self._passthrough @property diff --git a/src/merge/resources/filestorage/client.py b/src/merge/resources/filestorage/client.py index 0c9f5a0f..3e280ec0 100644 --- a/src/merge/resources/filestorage/client.py +++ b/src/merge/resources/filestorage/client.py @@ -97,6 +97,10 @@ def account_token(self): @property def async_passthrough(self): if self._async_passthrough is None: + from .resources.async_passthrough.client import ( + AsyncPassthroughClient as resources_filestorage_resources_async_passthrough_client_AsyncPassthroughClient, # noqa: E402 + ) + self._async_passthrough = resources_filestorage_resources_async_passthrough_client_AsyncPassthroughClient( client_wrapper=self._client_wrapper ) @@ -426,9 +430,13 @@ def linked_accounts(self): @property def passthrough(self): if self._passthrough is None: - from .resources.passthrough.client import AsyncPassthroughClient # noqa: E402 + from .resources.passthrough.client import ( + AsyncPassthroughClient as resources_filestorage_resources_passthrough_client_AsyncPassthroughClient, # noqa: E402 + ) - self._passthrough = AsyncPassthroughClient(client_wrapper=self._client_wrapper) + self._passthrough = resources_filestorage_resources_passthrough_client_AsyncPassthroughClient( + client_wrapper=self._client_wrapper + ) return self._passthrough @property diff --git a/src/merge/resources/hris/client.py b/src/merge/resources/hris/client.py index c990cae3..9687055a 100644 --- a/src/merge/resources/hris/client.py +++ b/src/merge/resources/hris/client.py @@ -119,6 +119,10 @@ def account_token(self): @property def async_passthrough(self): if self._async_passthrough is None: + from .resources.async_passthrough.client import ( + AsyncPassthroughClient as resources_hris_resources_async_passthrough_client_AsyncPassthroughClient, # noqa: E402 + ) + self._async_passthrough = resources_hris_resources_async_passthrough_client_AsyncPassthroughClient( client_wrapper=self._client_wrapper ) @@ -593,9 +597,13 @@ def locations(self): @property def passthrough(self): if self._passthrough is None: - from .resources.passthrough.client import AsyncPassthroughClient # noqa: E402 + from .resources.passthrough.client import ( + AsyncPassthroughClient as resources_hris_resources_passthrough_client_AsyncPassthroughClient, # noqa: E402 + ) - self._passthrough = AsyncPassthroughClient(client_wrapper=self._client_wrapper) + self._passthrough = resources_hris_resources_passthrough_client_AsyncPassthroughClient( + client_wrapper=self._client_wrapper + ) return self._passthrough @property diff --git a/src/merge/resources/hris/resources/dependents/client.py b/src/merge/resources/hris/resources/dependents/client.py index bfd225ff..0cf75736 100644 --- a/src/merge/resources/hris/resources/dependents/client.py +++ b/src/merge/resources/hris/resources/dependents/client.py @@ -31,6 +31,7 @@ def list( created_after: typing.Optional[dt.datetime] = None, created_before: typing.Optional[dt.datetime] = None, cursor: typing.Optional[str] = None, + employee_id: typing.Optional[str] = None, include_deleted_data: typing.Optional[bool] = None, include_remote_data: typing.Optional[bool] = None, include_sensitive_fields: typing.Optional[bool] = None, @@ -55,6 +56,9 @@ def list( cursor : typing.Optional[str] The pagination cursor value. + employee_id : typing.Optional[str] + If provided, will only return dependents for this employee. + include_deleted_data : typing.Optional[bool] Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/). @@ -103,6 +107,7 @@ def list( created_after=created_after, created_before=created_before, cursor=cursor, + employee_id=employee_id, include_deleted_data=include_deleted_data, include_remote_data=include_remote_data, include_sensitive_fields=include_sensitive_fields, @@ -191,6 +196,7 @@ async def list( created_after: typing.Optional[dt.datetime] = None, created_before: typing.Optional[dt.datetime] = None, cursor: typing.Optional[str] = None, + employee_id: typing.Optional[str] = None, include_deleted_data: typing.Optional[bool] = None, include_remote_data: typing.Optional[bool] = None, include_sensitive_fields: typing.Optional[bool] = None, @@ -215,6 +221,9 @@ async def list( cursor : typing.Optional[str] The pagination cursor value. + employee_id : typing.Optional[str] + If provided, will only return dependents for this employee. + include_deleted_data : typing.Optional[bool] Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/). @@ -271,6 +280,7 @@ async def main() -> None: created_after=created_after, created_before=created_before, cursor=cursor, + employee_id=employee_id, include_deleted_data=include_deleted_data, include_remote_data=include_remote_data, include_sensitive_fields=include_sensitive_fields, diff --git a/src/merge/resources/hris/resources/dependents/raw_client.py b/src/merge/resources/hris/resources/dependents/raw_client.py index 428f463a..a7d16b86 100644 --- a/src/merge/resources/hris/resources/dependents/raw_client.py +++ b/src/merge/resources/hris/resources/dependents/raw_client.py @@ -25,6 +25,7 @@ def list( created_after: typing.Optional[dt.datetime] = None, created_before: typing.Optional[dt.datetime] = None, cursor: typing.Optional[str] = None, + employee_id: typing.Optional[str] = None, include_deleted_data: typing.Optional[bool] = None, include_remote_data: typing.Optional[bool] = None, include_sensitive_fields: typing.Optional[bool] = None, @@ -49,6 +50,9 @@ def list( cursor : typing.Optional[str] The pagination cursor value. + employee_id : typing.Optional[str] + If provided, will only return dependents for this employee. + include_deleted_data : typing.Optional[bool] Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/). @@ -88,6 +92,7 @@ def list( "created_after": serialize_datetime(created_after) if created_after is not None else None, "created_before": serialize_datetime(created_before) if created_before is not None else None, "cursor": cursor, + "employee_id": employee_id, "include_deleted_data": include_deleted_data, "include_remote_data": include_remote_data, "include_sensitive_fields": include_sensitive_fields, @@ -183,6 +188,7 @@ async def list( created_after: typing.Optional[dt.datetime] = None, created_before: typing.Optional[dt.datetime] = None, cursor: typing.Optional[str] = None, + employee_id: typing.Optional[str] = None, include_deleted_data: typing.Optional[bool] = None, include_remote_data: typing.Optional[bool] = None, include_sensitive_fields: typing.Optional[bool] = None, @@ -207,6 +213,9 @@ async def list( cursor : typing.Optional[str] The pagination cursor value. + employee_id : typing.Optional[str] + If provided, will only return dependents for this employee. + include_deleted_data : typing.Optional[bool] Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/). @@ -246,6 +255,7 @@ async def list( "created_after": serialize_datetime(created_after) if created_after is not None else None, "created_before": serialize_datetime(created_before) if created_before is not None else None, "cursor": cursor, + "employee_id": employee_id, "include_deleted_data": include_deleted_data, "include_remote_data": include_remote_data, "include_sensitive_fields": include_sensitive_fields, diff --git a/src/merge/resources/hris/resources/employees/client.py b/src/merge/resources/hris/resources/employees/client.py index f1f60ae1..f6ae2e76 100644 --- a/src/merge/resources/hris/resources/employees/client.py +++ b/src/merge/resources/hris/resources/employees/client.py @@ -47,6 +47,7 @@ def list( created_before: typing.Optional[dt.datetime] = None, cursor: typing.Optional[str] = None, display_full_name: typing.Optional[str] = None, + employee_number: typing.Optional[str] = None, employment_status: typing.Optional[EmployeesListRequestEmploymentStatus] = None, employment_type: typing.Optional[str] = None, expand: typing.Optional[EmployeesListRequestExpand] = None, @@ -97,6 +98,9 @@ def list( display_full_name : typing.Optional[str] If provided, will only return employees with this display name. + employee_number : typing.Optional[str] + If provided, will only return employees with this employee number. + employment_status : typing.Optional[EmployeesListRequestEmploymentStatus] If provided, will only return employees with this employment status. @@ -211,6 +215,7 @@ def list( created_before=created_before, cursor=cursor, display_full_name=display_full_name, + employee_number=employee_number, employment_status=employment_status, employment_type=employment_type, expand=expand, @@ -455,6 +460,7 @@ async def list( created_before: typing.Optional[dt.datetime] = None, cursor: typing.Optional[str] = None, display_full_name: typing.Optional[str] = None, + employee_number: typing.Optional[str] = None, employment_status: typing.Optional[EmployeesListRequestEmploymentStatus] = None, employment_type: typing.Optional[str] = None, expand: typing.Optional[EmployeesListRequestExpand] = None, @@ -505,6 +511,9 @@ async def list( display_full_name : typing.Optional[str] If provided, will only return employees with this display name. + employee_number : typing.Optional[str] + If provided, will only return employees with this employee number. + employment_status : typing.Optional[EmployeesListRequestEmploymentStatus] If provided, will only return employees with this employment status. @@ -627,6 +636,7 @@ async def main() -> None: created_before=created_before, cursor=cursor, display_full_name=display_full_name, + employee_number=employee_number, employment_status=employment_status, employment_type=employment_type, expand=expand, diff --git a/src/merge/resources/hris/resources/employees/raw_client.py b/src/merge/resources/hris/resources/employees/raw_client.py index a85ffeac..15a17bf7 100644 --- a/src/merge/resources/hris/resources/employees/raw_client.py +++ b/src/merge/resources/hris/resources/employees/raw_client.py @@ -41,6 +41,7 @@ def list( created_before: typing.Optional[dt.datetime] = None, cursor: typing.Optional[str] = None, display_full_name: typing.Optional[str] = None, + employee_number: typing.Optional[str] = None, employment_status: typing.Optional[EmployeesListRequestEmploymentStatus] = None, employment_type: typing.Optional[str] = None, expand: typing.Optional[EmployeesListRequestExpand] = None, @@ -91,6 +92,9 @@ def list( display_full_name : typing.Optional[str] If provided, will only return employees with this display name. + employee_number : typing.Optional[str] + If provided, will only return employees with this employee number. + employment_status : typing.Optional[EmployeesListRequestEmploymentStatus] If provided, will only return employees with this employment status. @@ -196,6 +200,7 @@ def list( "created_before": serialize_datetime(created_before) if created_before is not None else None, "cursor": cursor, "display_full_name": display_full_name, + "employee_number": employee_number, "employment_status": employment_status, "employment_type": employment_type, "expand": expand, @@ -471,6 +476,7 @@ async def list( created_before: typing.Optional[dt.datetime] = None, cursor: typing.Optional[str] = None, display_full_name: typing.Optional[str] = None, + employee_number: typing.Optional[str] = None, employment_status: typing.Optional[EmployeesListRequestEmploymentStatus] = None, employment_type: typing.Optional[str] = None, expand: typing.Optional[EmployeesListRequestExpand] = None, @@ -521,6 +527,9 @@ async def list( display_full_name : typing.Optional[str] If provided, will only return employees with this display name. + employee_number : typing.Optional[str] + If provided, will only return employees with this employee number. + employment_status : typing.Optional[EmployeesListRequestEmploymentStatus] If provided, will only return employees with this employment status. @@ -626,6 +635,7 @@ async def list( "created_before": serialize_datetime(created_before) if created_before is not None else None, "cursor": cursor, "display_full_name": display_full_name, + "employee_number": employee_number, "employment_status": employment_status, "employment_type": employment_type, "expand": expand, diff --git a/src/merge/resources/ticketing/client.py b/src/merge/resources/ticketing/client.py index feec2cee..38570948 100644 --- a/src/merge/resources/ticketing/client.py +++ b/src/merge/resources/ticketing/client.py @@ -117,6 +117,10 @@ def accounts(self): @property def async_passthrough(self): if self._async_passthrough is None: + from .resources.async_passthrough.client import ( + AsyncPassthroughClient as resources_ticketing_resources_async_passthrough_client_AsyncPassthroughClient, # noqa: E402 + ) + self._async_passthrough = resources_ticketing_resources_async_passthrough_client_AsyncPassthroughClient( client_wrapper=self._client_wrapper ) @@ -500,9 +504,13 @@ def linked_accounts(self): @property def passthrough(self): if self._passthrough is None: - from .resources.passthrough.client import AsyncPassthroughClient # noqa: E402 + from .resources.passthrough.client import ( + AsyncPassthroughClient as resources_ticketing_resources_passthrough_client_AsyncPassthroughClient, # noqa: E402 + ) - self._passthrough = AsyncPassthroughClient(client_wrapper=self._client_wrapper) + self._passthrough = resources_ticketing_resources_passthrough_client_AsyncPassthroughClient( + client_wrapper=self._client_wrapper + ) return self._passthrough @property diff --git a/tests/utils/test_query_encoding.py b/tests/utils/test_query_encoding.py index 07b0704c..3a289ae5 100644 --- a/tests/utils/test_query_encoding.py +++ b/tests/utils/test_query_encoding.py @@ -1,6 +1,5 @@ # This file was auto-generated by Fern from our API Definition. - from merge.core.query_encoder import encode_query