diff --git a/README.md b/README.md index 0b26c6f5..41824d19 100644 --- a/README.md +++ b/README.md @@ -264,3 +264,4 @@ while response.next is not None: + diff --git a/reference.md b/reference.md index 89b537fa..0f023f71 100644 --- a/reference.md +++ b/reference.md @@ -22792,8 +22792,8 @@ client.crm.webhook_receivers.create( -## Filestorage AccountDetails -
client.filestorage.account_details.retrieve() +## Hris AccountDetails +
client.hris.account_details.retrieve()
@@ -22826,7 +22826,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.filestorage.account_details.retrieve() +client.hris.account_details.retrieve() ```
@@ -22854,8 +22854,8 @@ client.filestorage.account_details.retrieve()
-## Filestorage AccountToken -
client.filestorage.account_token.retrieve(...) +## Hris AccountToken +
client.hris.account_token.retrieve(...)
@@ -22888,7 +22888,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.filestorage.account_token.retrieve( +client.hris.account_token.retrieve( public_token="public_token", ) @@ -22926,8 +22926,8 @@ client.filestorage.account_token.retrieve(
-## Filestorage AsyncPassthrough -
client.filestorage.async_passthrough.create(...) +## Hris AsyncPassthrough +
client.hris.async_passthrough.create(...)
@@ -22955,13 +22955,13 @@ Asynchronously 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.hris import DataPassthroughRequest, MethodEnum client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.filestorage.async_passthrough.create( +client.hris.async_passthrough.create( request=DataPassthroughRequest( method=MethodEnum.GET, path="/scooters", @@ -23002,7 +23002,7 @@ client.filestorage.async_passthrough.create(
-
client.filestorage.async_passthrough.retrieve(...) +
client.hris.async_passthrough.retrieve(...)
@@ -23035,7 +23035,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.filestorage.async_passthrough.retrieve( +client.hris.async_passthrough.retrieve( async_passthrough_receipt_id="async_passthrough_receipt_id", ) @@ -23073,8 +23073,8 @@ client.filestorage.async_passthrough.retrieve(
-## Filestorage AuditTrail -
client.filestorage.audit_trail.list(...) +## Hris AuditTrail +
client.hris.audit_trail.list(...)
@@ -23107,7 +23107,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.filestorage.audit_trail.list( +client.hris.audit_trail.list( cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", end_date="end_date", event_type="event_type", @@ -23190,8 +23190,8 @@ client.filestorage.audit_trail.list(
-## Filestorage AvailableActions -
client.filestorage.available_actions.retrieve() +## Hris AvailableActions +
client.hris.available_actions.retrieve()
@@ -23224,7 +23224,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.filestorage.available_actions.retrieve() +client.hris.available_actions.retrieve() ```
@@ -23252,8 +23252,8 @@ client.filestorage.available_actions.retrieve()
-## Filestorage Scopes -
client.filestorage.scopes.default_scopes_retrieve() +## Hris BankInfo +
client.hris.bank_info.list(...)
@@ -23265,7 +23265,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). +Returns a list of `BankInfo` objects.
@@ -23280,13 +23280,42 @@ Get the default permissions for Merge Common Models and fields across all Linked
```python +import datetime + from merge import Merge +from merge.resources.hris.resources.bank_info import ( + BankInfoListRequestAccountType, + BankInfoListRequestOrderBy, +) client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.filestorage.scopes.default_scopes_retrieve() +client.hris.bank_info.list( + account_type=BankInfoListRequestAccountType.CHECKING, + bank_name="bank_name", + created_after=datetime.datetime.fromisoformat( + "2024-01-15 09:30:00+00:00", + ), + created_before=datetime.datetime.fromisoformat( + "2024-01-15 09:30:00+00:00", + ), + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + employee_id="employee_id", + include_deleted_data=True, + include_remote_data=True, + include_shell_data=True, + modified_after=datetime.datetime.fromisoformat( + "2024-01-15 09:30:00+00:00", + ), + modified_before=datetime.datetime.fromisoformat( + "2024-01-15 09:30:00+00:00", + ), + order_by=BankInfoListRequestOrderBy.REMOTE_CREATED_AT_DESCENDING, + page_size=1, + remote_id="remote_id", +) ```
@@ -23302,160 +23331,140 @@ client.filestorage.scopes.default_scopes_retrieve()
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. +**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. +
-
-
client.filestorage.scopes.linked_account_scopes_retrieve()
-#### 📝 Description +**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. + +
+
+
-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). -
-
+**cursor:** `typing.Optional[str]` — The pagination cursor value. + -#### 🔌 Usage -
+**employee_id:** `typing.Optional[str]` — If provided, will only return bank accounts for this employee. + +
+
+
-```python -from merge import Merge - -client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.filestorage.scopes.linked_account_scopes_retrieve() - -``` -
-
+**expand:** `typing.Optional[typing.Literal["employee"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. + -#### ⚙️ Parameters -
+**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.
- - +
+
+**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.filestorage.scopes.linked_account_scopes_create(...)
-#### 📝 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. + +
+
+
-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) -
-
+**order_by:** `typing.Optional[BankInfoListRequestOrderBy]` — Overrides the default ordering for this endpoint. Possible values include: remote_created_at, -remote_created_at. + -#### 🔌 Usage -
+**page_size:** `typing.Optional[int]` — Number of results to return per page. The maximum limit is 100. + +
+
+
-```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, - ) - }, - ), - ], -) - -``` -
-
+**remote_fields:** `typing.Optional[typing.Literal["account_type"]]` — Deprecated. Use show_enum_origins. + -#### ⚙️ Parameters -
+**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object. + +
+
+
-**common_models:** `typing.Sequence[IndividualCommonModelScopeDeserializerRequest]` — The common models you want to update the scopes for +**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)
@@ -23475,8 +23484,7 @@ client.filestorage.scopes.linked_account_scopes_create(
-## Filestorage DeleteAccount -
client.filestorage.delete_account.delete() +
client.hris.bank_info.retrieve(...)
@@ -23488,7 +23496,7 @@ client.filestorage.scopes.linked_account_scopes_create(
-Delete a linked account. +Returns a `BankInfo` object with the given `id`.
@@ -23509,7 +23517,11 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.filestorage.delete_account.delete() +client.hris.bank_info.retrieve( + id="id", + include_remote_data=True, + include_shell_data=True, +) ``` @@ -23525,39 +23537,87 @@ client.filestorage.delete_account.delete()
-**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. +
-
-## Filestorage Drives -
client.filestorage.drives.list(...)
-#### 📝 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 list of `Drive` objects. -
-
+**remote_fields:** `typing.Optional[typing.Literal["account_type"]]` — Deprecated. Use show_enum_origins. + -#### 🔌 Usage - +
+
+ +**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. + +
+
+ + + + + + +
+ +## Hris Benefits +
client.hris.benefits.list(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Returns a list of `Benefit` objects. +
+
+
+
+ +#### 🔌 Usage +
@@ -23573,7 +23633,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.filestorage.drives.list( +client.hris.benefits.list( created_after=datetime.datetime.fromisoformat( "2024-01-15 09:30:00+00:00", ), @@ -23581,6 +23641,7 @@ client.filestorage.drives.list( "2024-01-15 09:30:00+00:00", ), cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + employee_id="employee_id", include_deleted_data=True, include_remote_data=True, include_shell_data=True, @@ -23590,7 +23651,6 @@ client.filestorage.drives.list( modified_before=datetime.datetime.fromisoformat( "2024-01-15 09:30:00+00:00", ), - name="name", page_size=1, remote_id="remote_id", ) @@ -23633,7 +23693,7 @@ client.filestorage.drives.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_id:** `typing.Optional[str]` — If provided, will return the benefits associated with the employee.
@@ -23641,7 +23701,7 @@ client.filestorage.drives.list(
-**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[typing.Literal["employee"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -23649,7 +23709,7 @@ client.filestorage.drives.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/).
@@ -23657,7 +23717,7 @@ client.filestorage.drives.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.
@@ -23665,7 +23725,7 @@ client.filestorage.drives.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).
@@ -23673,7 +23733,7 @@ client.filestorage.drives.list(
-**name:** `typing.Optional[str]` — If provided, will only return drives with this name. This performs an exact match. +**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
@@ -23681,7 +23741,15 @@ client.filestorage.drives.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. + +
+
+ +
+
+ +**page_size:** `typing.Optional[int]` — Number of results to return per page. The maximum limit is 100.
@@ -23709,7 +23777,7 @@ client.filestorage.drives.list(
-
client.filestorage.drives.retrieve(...) +
client.hris.benefits.retrieve(...)
@@ -23721,7 +23789,7 @@ client.filestorage.drives.list(
-Returns a `Drive` object with the given `id`. +Returns a `Benefit` object with the given `id`.
@@ -23742,7 +23810,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.filestorage.drives.retrieve( +client.hris.benefits.retrieve( id="id", include_remote_data=True, include_shell_data=True, @@ -23770,6 +23838,14 @@ client.filestorage.drives.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.
@@ -23798,8 +23874,8 @@ client.filestorage.drives.retrieve(
-## Filestorage FieldMapping -
client.filestorage.field_mapping.field_mappings_retrieve(...) +## Hris Companies +
client.hris.companies.list(...)
@@ -23811,7 +23887,7 @@ client.filestorage.drives.retrieve(
-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 a list of `Company` objects.
@@ -23826,14 +23902,33 @@ Get all Field Mappings for this Linked Account. Field Mappings are mappings betw
```python +import datetime + from merge import Merge client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.filestorage.field_mapping.field_mappings_retrieve( - exclude_remote_field_metadata=True, +client.hris.companies.list( + created_after=datetime.datetime.fromisoformat( + "2024-01-15 09:30:00+00:00", + ), + created_before=datetime.datetime.fromisoformat( + "2024-01-15 09:30:00+00:00", + ), + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + include_deleted_data=True, + include_remote_data=True, + include_shell_data=True, + modified_after=datetime.datetime.fromisoformat( + "2024-01-15 09:30:00+00:00", + ), + modified_before=datetime.datetime.fromisoformat( + "2024-01-15 09:30:00+00:00", + ), + page_size=1, + remote_id="remote_id", ) ``` @@ -23850,7 +23945,7 @@ client.filestorage.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. +**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
@@ -23858,76 +23953,23 @@ client.filestorage.field_mapping.field_mappings_retrieve(
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. +**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
-
-
- - - - -
- -
client.filestorage.field_mapping.field_mappings_create(...) -
-
- -#### 📝 Description - -
-
- -
-
- -Create new Field Mappings that will be available after the next scheduled sync. This will cause the next sync for this Linked Account to sync **ALL** data from start. -
-
-
-
- -#### 🔌 Usage
-
-
- -```python -from merge import Merge - -client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.filestorage.field_mapping.field_mappings_create( - exclude_remote_field_metadata=True, - 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", -) - -``` -
-
+**cursor:** `typing.Optional[str]` — The pagination cursor value. +
-#### ⚙️ Parameters - -
-
-
-**target_field_name:** `str` — The name of the target field you want this remote field to map to. +**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/).
@@ -23935,7 +23977,7 @@ client.filestorage.field_mapping.field_mappings_create(
-**target_field_description:** `str` — The description of the target field you want this remote field to map to. +**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -23943,7 +23985,7 @@ client.filestorage.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. +**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).
@@ -23951,7 +23993,7 @@ client.filestorage.field_mapping.field_mappings_create(
-**remote_method:** `str` — The method of the remote endpoint where the remote field is coming from. +**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
@@ -23959,7 +24001,7 @@ client.filestorage.field_mapping.field_mappings_create(
-**remote_url_path:** `str` — The path of the remote endpoint where the remote field is coming from. +**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
@@ -23967,7 +24009,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. +**page_size:** `typing.Optional[int]` — Number of results to return per page. The maximum limit is 100.
@@ -23975,7 +24017,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. +**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
@@ -23995,7 +24037,7 @@ client.filestorage.field_mapping.field_mappings_create(
-
client.filestorage.field_mapping.field_mappings_destroy(...) +
client.hris.companies.retrieve(...)
@@ -24007,7 +24049,7 @@ client.filestorage.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 `Company` object with the given `id`.
@@ -24028,8 +24070,10 @@ 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", +client.hris.companies.retrieve( + id="id", + include_remote_data=True, + include_shell_data=True, ) ``` @@ -24046,7 +24090,23 @@ client.filestorage.field_mapping.field_mappings_destroy(
-**field_mapping_id:** `str` +**id:** `str` + +
+
+ +
+
+ +**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. + +
+
+ +
+
+ +**include_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).
@@ -24066,7 +24126,8 @@ client.filestorage.field_mapping.field_mappings_destroy(
-
client.filestorage.field_mapping.field_mappings_partial_update(...) +## Hris Scopes +
client.hris.scopes.default_scopes_retrieve()
@@ -24078,7 +24139,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. +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).
@@ -24099,9 +24160,7 @@ 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.hris.scopes.default_scopes_retrieve() ``` @@ -24117,63 +24176,92 @@ client.filestorage.field_mapping.field_mappings_partial_update(
-**field_mapping_id:** `str` +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+ +
-
-
-**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. -
+
+
client.hris.scopes.linked_account_scopes_retrieve()
-**remote_method:** `typing.Optional[str]` — The method of the remote endpoint where the remote field is coming from. - -
-
+#### 📝 Description
-**remote_url_path:** `typing.Optional[str]` — The path of the remote endpoint where the remote field is coming from. - -
-
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. - +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 - - -
- -
client.filestorage.field_mapping.remote_fields_retrieve(...)
-#### 📝 Description -
+```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 +
-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/). +
+
+ +**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)
@@ -24189,14 +24277,42 @@ Get all remote fields for a Linked Account. Remote fields are third-party fields ```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.filestorage.field_mapping.remote_fields_retrieve( - common_models="common_models", - include_example_values="include_example_values", +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, + ) + }, + ), + ], ) ``` @@ -24213,15 +24329,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. +**common_models:** `typing.Sequence[IndividualCommonModelScopeDeserializerRequest]` — The common models you want to update the scopes for
@@ -24241,7 +24349,8 @@ client.filestorage.field_mapping.remote_fields_retrieve(
-
client.filestorage.field_mapping.target_fields_retrieve() +## Hris DeleteAccount +
client.hris.delete_account.delete()
@@ -24253,7 +24362,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/). +Delete a linked account.
@@ -24274,7 +24383,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.filestorage.field_mapping.target_fields_retrieve() +client.hris.delete_account.delete() ``` @@ -24302,8 +24411,8 @@ client.filestorage.field_mapping.target_fields_retrieve()
-## Filestorage Files -
client.filestorage.files.list(...) +## Hris Dependents +
client.hris.dependents.list(...)
@@ -24315,7 +24424,7 @@ client.filestorage.field_mapping.target_fields_retrieve()
-Returns a list of `File` objects. +Returns a list of `Dependent` objects.
@@ -24333,16 +24442,12 @@ Returns a list of `File` objects. import datetime from merge import Merge -from merge.resources.filestorage.resources.files import ( - FilesListRequestExpand, - FilesListRequestOrderBy, -) client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.filestorage.files.list( +client.hris.dependents.list( created_after=datetime.datetime.fromisoformat( "2024-01-15 09:30:00+00:00", ), @@ -24350,28 +24455,18 @@ client.filestorage.files.list( "2024-01-15 09:30:00+00:00", ), cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", - drive_id="drive_id", - expand=FilesListRequestExpand.DRIVE, - folder_id="folder_id", + employee_id="employee_id", include_deleted_data=True, include_remote_data=True, + include_sensitive_fields=True, include_shell_data=True, - mime_type="mime_type", modified_after=datetime.datetime.fromisoformat( "2024-01-15 09:30:00+00:00", ), modified_before=datetime.datetime.fromisoformat( "2024-01-15 09:30:00+00:00", ), - name="name", - order_by=FilesListRequestOrderBy.CREATED_AT_DESCENDING, page_size=1, - remote_created_after=datetime.datetime.fromisoformat( - "2024-01-15 09:30:00+00:00", - ), - remote_created_before=datetime.datetime.fromisoformat( - "2024-01-15 09:30:00+00:00", - ), remote_id="remote_id", ) @@ -24413,23 +24508,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. - -
-
- -
-
- -**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. +**employee_id:** `typing.Optional[str]` — If provided, will only return dependents for this employee.
@@ -24453,7 +24532,7 @@ 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). +**include_sensitive_fields:** `typing.Optional[bool]` — Whether to include sensitive fields (such as social security numbers) in the response.
@@ -24461,7 +24540,7 @@ client.filestorage.files.list(
-**mime_type:** `typing.Optional[str]` — If provided, will only return files with these mime_types. Multiple values can be separated by commas. +**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).
@@ -24485,39 +24564,7 @@ client.filestorage.files.list(
-**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. - -
-
- -
-
- -**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. - -
-
- -
-
- -**remote_created_before:** `typing.Optional[dt.datetime]` — If provided, will only return files created in the third party platform before this datetime. +**page_size:** `typing.Optional[int]` — Number of results to return per page. The maximum limit is 100.
@@ -24545,7 +24592,7 @@ client.filestorage.files.list(
-
client.filestorage.files.create(...) +
client.hris.dependents.retrieve(...)
@@ -24557,7 +24604,7 @@ client.filestorage.files.list(
-Creates a `File` object with the given values. +Returns a `Dependent` object with the given `id`.
@@ -24573,16 +24620,16 @@ 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( - is_debug_mode=True, - run_async=True, - model=FileRequest(), +client.hris.dependents.retrieve( + id="id", + include_remote_data=True, + include_sensitive_fields=True, + include_shell_data=True, ) ``` @@ -24599,7 +24646,7 @@ client.filestorage.files.create(
-**model:** `FileRequest` +**id:** `str`
@@ -24607,7 +24654,7 @@ client.filestorage.files.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.
@@ -24615,7 +24662,15 @@ client.filestorage.files.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).
@@ -24635,7 +24690,8 @@ client.filestorage.files.create(
-
client.filestorage.files.retrieve(...) +## Hris EmployeePayrollRuns +
client.hris.employee_payroll_runs.list(...)
@@ -24647,7 +24703,7 @@ client.filestorage.files.create(
-Returns a `File` object with the given `id`. +Returns a list of `EmployeePayrollRun` objects.
@@ -24662,20 +24718,51 @@ Returns a `File` object with the given `id`.
```python +import datetime + from merge import Merge -from merge.resources.filestorage.resources.files import ( - FilesRetrieveRequestExpand, +from merge.resources.hris.resources.employee_payroll_runs import ( + EmployeePayrollRunsListRequestExpand, ) client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.filestorage.files.retrieve( - id="id", - expand=FilesRetrieveRequestExpand.DRIVE, +client.hris.employee_payroll_runs.list( + created_after=datetime.datetime.fromisoformat( + "2024-01-15 09:30:00+00:00", + ), + created_before=datetime.datetime.fromisoformat( + "2024-01-15 09:30:00+00:00", + ), + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + employee_id="employee_id", + ended_after=datetime.datetime.fromisoformat( + "2024-01-15 09:30:00+00:00", + ), + ended_before=datetime.datetime.fromisoformat( + "2024-01-15 09:30:00+00:00", + ), + expand=EmployeePayrollRunsListRequestExpand.EMPLOYEE, + include_deleted_data=True, include_remote_data=True, include_shell_data=True, + modified_after=datetime.datetime.fromisoformat( + "2024-01-15 09:30:00+00:00", + ), + modified_before=datetime.datetime.fromisoformat( + "2024-01-15 09:30:00+00:00", + ), + page_size=1, + payroll_run_id="payroll_run_id", + remote_id="remote_id", + started_after=datetime.datetime.fromisoformat( + "2024-01-15 09:30:00+00:00", + ), + started_before=datetime.datetime.fromisoformat( + "2024-01-15 09:30:00+00:00", + ), ) ``` @@ -24692,7 +24779,7 @@ client.filestorage.files.retrieve(
-**id:** `str` +**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
@@ -24700,7 +24787,55 @@ 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. +**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime. + +
+
+ +
+
+ +**cursor:** `typing.Optional[str]` — The pagination cursor value. + +
+
+ +
+
+ +**employee_id:** `typing.Optional[str]` — If provided, will only return employee payroll runs for this employee. + +
+
+ +
+
+ +**ended_after:** `typing.Optional[dt.datetime]` — If provided, will only return employee payroll runs ended after this datetime. + +
+
+ +
+
+ +**ended_before:** `typing.Optional[dt.datetime]` — If provided, will only return employee payroll runs ended before this datetime. + +
+
+ +
+
+ +**expand:** `typing.Optional[EmployeePayrollRunsListRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. + +
+
+ +
+
+ +**include_deleted_data:** `typing.Optional[bool]` — 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/).
@@ -24724,6 +24859,62 @@ client.filestorage.files.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. The maximum limit is 100. + +
+
+ +
+
+ +**payroll_run_id:** `typing.Optional[str]` — If provided, will only return employee payroll runs for this employee. + +
+
+ +
+
+ +**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object. + +
+
+ +
+
+ +**started_after:** `typing.Optional[dt.datetime]` — If provided, will only return employee payroll runs started after this datetime. + +
+
+ +
+
+ +**started_before:** `typing.Optional[dt.datetime]` — If provided, will only return employee payroll runs started before this datetime. + +
+
+ +
+
+ **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -24736,7 +24927,7 @@ client.filestorage.files.retrieve(
-
client.filestorage.files.download_request_meta_retrieve(...) +
client.hris.employee_payroll_runs.retrieve(...)
@@ -24748,7 +24939,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 an `EmployeePayrollRun` object with the given `id`.
@@ -24764,14 +24955,19 @@ Returns metadata to construct an authenticated file download request for a singu ```python from merge import Merge +from merge.resources.hris.resources.employee_payroll_runs import ( + EmployeePayrollRunsRetrieveRequestExpand, +) client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.filestorage.files.download_request_meta_retrieve( +client.hris.employee_payroll_runs.retrieve( id="id", - mime_type="mime_type", + expand=EmployeePayrollRunsRetrieveRequestExpand.EMPLOYEE, + include_remote_data=True, + include_shell_data=True, ) ``` @@ -24796,7 +24992,23 @@ client.filestorage.files.download_request_meta_retrieve(
-**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. +**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. + +
+
+ +
+
+ +**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).
@@ -24816,7 +25028,8 @@ client.filestorage.files.download_request_meta_retrieve(
-
client.filestorage.files.download_request_meta_list(...) +## Hris Employees +
client.hris.employees.list(...)
@@ -24828,7 +25041,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 `Employee` objects.
@@ -24843,25 +25056,71 @@ Returns metadata to construct authenticated file download requests, allowing you
```python +import datetime + from merge import Merge -from merge.resources.filestorage.resources.files import ( - FilesDownloadRequestMetaListRequestOrderBy, +from merge.resources.hris.resources.employees import ( + EmployeesListRequestEmploymentStatus, + EmployeesListRequestExpand, + EmployeesListRequestRemoteFields, + EmployeesListRequestShowEnumOrigins, ) client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.filestorage.files.download_request_meta_list( - created_after="created_after", - created_before="created_before", +client.hris.employees.list( + company_id="company_id", + created_after=datetime.datetime.fromisoformat( + "2024-01-15 09:30:00+00:00", + ), + created_before=datetime.datetime.fromisoformat( + "2024-01-15 09:30:00+00:00", + ), cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + display_full_name="display_full_name", + employee_number="employee_number", + employment_status=EmployeesListRequestEmploymentStatus.ACTIVE, + employment_type="employment_type", + expand=EmployeesListRequestExpand.COMPANY, + first_name="first_name", + groups="groups", + home_location_id="home_location_id", include_deleted_data=True, - mime_types="mime_types", - modified_after="modified_after", - modified_before="modified_before", - order_by=FilesDownloadRequestMetaListRequestOrderBy.CREATED_AT_DESCENDING, + include_remote_data=True, + include_sensitive_fields=True, + include_shell_data=True, + job_title="job_title", + last_name="last_name", + manager_id="manager_id", + modified_after=datetime.datetime.fromisoformat( + "2024-01-15 09:30:00+00:00", + ), + modified_before=datetime.datetime.fromisoformat( + "2024-01-15 09:30:00+00:00", + ), page_size=1, + pay_group_id="pay_group_id", + personal_email="personal_email", + remote_fields=EmployeesListRequestRemoteFields.EMPLOYMENT_STATUS, + remote_id="remote_id", + show_enum_origins=EmployeesListRequestShowEnumOrigins.EMPLOYMENT_STATUS, + started_after=datetime.datetime.fromisoformat( + "2024-01-15 09:30:00+00:00", + ), + started_before=datetime.datetime.fromisoformat( + "2024-01-15 09:30:00+00:00", + ), + team_id="team_id", + terminated_after=datetime.datetime.fromisoformat( + "2024-01-15 09:30:00+00:00", + ), + terminated_before=datetime.datetime.fromisoformat( + "2024-01-15 09:30:00+00:00", + ), + work_email="work_email", + work_location_id="work_location_id", ) ``` @@ -24878,7 +25137,7 @@ client.filestorage.files.download_request_meta_list(
-**created_after:** `typing.Optional[str]` — If provided, will only return objects created after this datetime. +**company_id:** `typing.Optional[str]` — If provided, will only return employees for this company.
@@ -24886,7 +25145,7 @@ client.filestorage.files.download_request_meta_list(
-**created_before:** `typing.Optional[str]` — If provided, will only return objects created before this datetime. +**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
@@ -24894,7 +25153,7 @@ client.filestorage.files.download_request_meta_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.
@@ -24902,7 +25161,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. +**cursor:** `typing.Optional[str]` — The pagination cursor value.
@@ -24910,7 +25169,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/). +**display_full_name:** `typing.Optional[str]` — If provided, will only return employees with this display name.
@@ -24918,7 +25177,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. +**employee_number:** `typing.Optional[str]` — If provided, will only return employees with this employee number.
@@ -24926,7 +25185,13 @@ client.filestorage.files.download_request_meta_list(
-**modified_after:** `typing.Optional[str]` — If provided, will only return objects modified after this datetime. +**employment_status:** `typing.Optional[EmployeesListRequestEmploymentStatus]` + +If provided, will only return employees with this employment status. + +* `ACTIVE` - ACTIVE +* `PENDING` - PENDING +* `INACTIVE` - INACTIVE
@@ -24934,7 +25199,7 @@ client.filestorage.files.download_request_meta_list(
-**modified_before:** `typing.Optional[str]` — If provided, will only return objects modified before this datetime. +**employment_type:** `typing.Optional[str]` — If provided, will only return employees that have an employment of the specified employment type.
@@ -24942,7 +25207,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. +**expand:** `typing.Optional[EmployeesListRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -24950,7 +25215,7 @@ client.filestorage.files.download_request_meta_list(
-**page_size:** `typing.Optional[int]` — Number of results to return per page. +**first_name:** `typing.Optional[str]` — If provided, will only return employees with this first name.
@@ -24958,158 +25223,87 @@ client.filestorage.files.download_request_meta_list(
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. +**groups:** `typing.Optional[str]` — If provided, will only return employees matching the group ids; multiple groups can be separated by commas.
-
-
+
+
+**home_location_id:** `typing.Optional[str]` — If provided, will only return employees for this home location. +
-
-
client.filestorage.files.meta_post_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 metadata for `FileStorageFile` POSTs. -
-
+**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.filestorage.files.meta_post_retrieve() - -``` -
-
+**include_sensitive_fields:** `typing.Optional[bool]` — Whether to include sensitive fields (such as social security numbers) in the response. +
-#### ⚙️ Parameters - -
-
-
-**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. +
-
-## Filestorage Folders -
client.filestorage.folders.list(...)
-#### 📝 Description - -
-
+**last_name:** `typing.Optional[str]` — If provided, will only return employees with this last name. + +
+
-Returns a list of `Folder` objects. -
-
+**manager_id:** `typing.Optional[str]` — If provided, will only return employees for this manager. +
-#### 🔌 Usage -
-
-
- -```python -import datetime - -from merge import Merge -from merge.resources.filestorage.resources.folders import ( - FoldersListRequestExpand, -) - -client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.filestorage.folders.list( - created_after=datetime.datetime.fromisoformat( - "2024-01-15 09:30:00+00:00", - ), - created_before=datetime.datetime.fromisoformat( - "2024-01-15 09:30:00+00:00", - ), - cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", - drive_id="drive_id", - expand=FoldersListRequestExpand.DRIVE, - include_deleted_data=True, - include_remote_data=True, - include_shell_data=True, - modified_after=datetime.datetime.fromisoformat( - "2024-01-15 09:30:00+00:00", - ), - modified_before=datetime.datetime.fromisoformat( - "2024-01-15 09:30:00+00:00", - ), - name="name", - page_size=1, - parent_folder_id="parent_folder_id", - remote_id="remote_id", -) - -``` -
-
+**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned. +
-#### ⚙️ Parameters - -
-
-
-**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime. +**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
@@ -25117,7 +25311,7 @@ client.filestorage.folders.list(
-**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime. +**page_size:** `typing.Optional[int]` — Number of results to return per page.
@@ -25125,7 +25319,7 @@ client.filestorage.folders.list(
-**cursor:** `typing.Optional[str]` — The pagination cursor value. +**pay_group_id:** `typing.Optional[str]` — If provided, will only return employees for this pay group
@@ -25133,7 +25327,7 @@ client.filestorage.folders.list(
-**drive_id:** `typing.Optional[str]` — If provided, will only return folders in this drive. +**personal_email:** `typing.Optional[str]` — If provided, will only return Employees with this personal email
@@ -25141,7 +25335,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. +**remote_fields:** `typing.Optional[EmployeesListRequestRemoteFields]` — Deprecated. Use show_enum_origins.
@@ -25149,7 +25343,7 @@ 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/). +**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
@@ -25157,7 +25351,7 @@ client.filestorage.folders.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[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)
@@ -25165,7 +25359,7 @@ client.filestorage.folders.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). +**started_after:** `typing.Optional[dt.datetime]` — If provided, will only return employees that started after this datetime.
@@ -25173,7 +25367,7 @@ client.filestorage.folders.list(
-**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned. +**started_before:** `typing.Optional[dt.datetime]` — If provided, will only return employees that started before this datetime.
@@ -25181,7 +25375,7 @@ client.filestorage.folders.list(
-**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned. +**team_id:** `typing.Optional[str]` — If provided, will only return employees for this team.
@@ -25189,7 +25383,7 @@ client.filestorage.folders.list(
-**name:** `typing.Optional[str]` — If provided, will only return folders with this name. This performs an exact match. +**terminated_after:** `typing.Optional[dt.datetime]` — If provided, will only return employees that were terminated after this datetime.
@@ -25197,7 +25391,7 @@ client.filestorage.folders.list(
-**page_size:** `typing.Optional[int]` — Number of results to return per page. +**terminated_before:** `typing.Optional[dt.datetime]` — If provided, will only return employees that were terminated before this datetime.
@@ -25205,7 +25399,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. +**work_email:** `typing.Optional[str]` — If provided, will only return Employees with this work email
@@ -25213,7 +25407,7 @@ client.filestorage.folders.list(
-**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object. +**work_location_id:** `typing.Optional[str]` — If provided, will only return employees for this location.
@@ -25233,7 +25427,7 @@ client.filestorage.folders.list(
-
client.filestorage.folders.create(...) +
client.hris.employees.create(...)
@@ -25245,7 +25439,7 @@ client.filestorage.folders.list(
-Creates a `Folder` object with the given values. +Creates an `Employee` object with the given values.
@@ -25261,16 +25455,16 @@ Creates a `Folder` object with the given values. ```python from merge import Merge -from merge.resources.filestorage import FolderRequest +from merge.resources.hris import EmployeeRequest client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.filestorage.folders.create( +client.hris.employees.create( is_debug_mode=True, run_async=True, - model=FolderRequest(), + model=EmployeeRequest(), ) ``` @@ -25287,7 +25481,7 @@ client.filestorage.folders.create(
-**model:** `FolderRequest` +**model:** `EmployeeRequest`
@@ -25323,7 +25517,7 @@ client.filestorage.folders.create(
-
client.filestorage.folders.retrieve(...) +
client.hris.employees.retrieve(...)
@@ -25335,7 +25529,7 @@ client.filestorage.folders.create(
-Returns a `Folder` object with the given `id`. +Returns an `Employee` object with the given `id`.
@@ -25351,19 +25545,24 @@ Returns a `Folder` object with the given `id`. ```python from merge import Merge -from merge.resources.filestorage.resources.folders import ( - FoldersRetrieveRequestExpand, +from merge.resources.hris.resources.employees import ( + EmployeesRetrieveRequestExpand, + EmployeesRetrieveRequestRemoteFields, + EmployeesRetrieveRequestShowEnumOrigins, ) client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.filestorage.folders.retrieve( +client.hris.employees.retrieve( id="id", - expand=FoldersRetrieveRequestExpand.DRIVE, + expand=EmployeesRetrieveRequestExpand.COMPANY, include_remote_data=True, + include_sensitive_fields=True, include_shell_data=True, + remote_fields=EmployeesRetrieveRequestRemoteFields.EMPLOYMENT_STATUS, + show_enum_origins=EmployeesRetrieveRequestShowEnumOrigins.EMPLOYMENT_STATUS, ) ``` @@ -25388,7 +25587,7 @@ 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. +**expand:** `typing.Optional[EmployeesRetrieveRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -25404,6 +25603,14 @@ client.filestorage.folders.retrieve(
+**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).
@@ -25412,6 +25619,22 @@ client.filestorage.folders.retrieve(
+**remote_fields:** `typing.Optional[EmployeesRetrieveRequestRemoteFields]` — Deprecated. Use show_enum_origins. + +
+
+ +
+
+ +**show_enum_origins:** `typing.Optional[EmployeesRetrieveRequestShowEnumOrigins]` — A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter) + +
+
+ +
+
+ **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -25424,7 +25647,7 @@ client.filestorage.folders.retrieve(
-
client.filestorage.folders.meta_post_retrieve() +
client.hris.employees.ignore_create(...)
@@ -25436,7 +25659,7 @@ client.filestorage.folders.retrieve(
-Returns metadata for `FileStorageFolder` POSTs. +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.
@@ -25452,12 +25675,16 @@ Returns metadata for `FileStorageFolder` POSTs. ```python from merge import Merge +from merge.resources.hris import ReasonEnum client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.filestorage.folders.meta_post_retrieve() +client.hris.employees.ignore_create( + model_id="model_id", + reason=ReasonEnum.GENERAL_CUSTOMER_REQUEST, +) ``` @@ -25473,6 +25700,30 @@ client.filestorage.folders.meta_post_retrieve()
+**model_id:** `str` + +
+
+ +
+
+ +**reason:** `IgnoreCommonModelRequestReason` + +
+
+ +
+
+ +**message:** `typing.Optional[str]` + +
+
+ +
+
+ **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -25485,8 +25736,7 @@ client.filestorage.folders.meta_post_retrieve()
-## Filestorage GenerateKey -
client.filestorage.generate_key.create(...) +
client.hris.employees.meta_post_retrieve()
@@ -25498,7 +25748,7 @@ client.filestorage.folders.meta_post_retrieve()
-Create a remote key. +Returns metadata for `Employee` POSTs.
@@ -25519,9 +25769,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.filestorage.generate_key.create( - name="Remote Deployment Key 1", -) +client.hris.employees.meta_post_retrieve() ``` @@ -25537,14 +25785,6 @@ client.filestorage.generate_key.create(
-**name:** `str` — The name of the remote key - -
-
- -
-
- **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -25557,8 +25797,8 @@ client.filestorage.generate_key.create(
-## Filestorage Groups -
client.filestorage.groups.list(...) +## Hris EmployerBenefits +
client.hris.employer_benefits.list(...)
@@ -25570,7 +25810,7 @@ client.filestorage.generate_key.create(
-Returns a list of `Group` objects. +Returns a list of `EmployerBenefit` objects.
@@ -25593,7 +25833,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.filestorage.groups.list( +client.hris.employer_benefits.list( created_after=datetime.datetime.fromisoformat( "2024-01-15 09:30:00+00:00", ), @@ -25652,14 +25892,6 @@ 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. - -
-
- -
-
- **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/).
@@ -25700,7 +25932,7 @@ client.filestorage.groups.list(
-**page_size:** `typing.Optional[int]` — Number of results to return per page. +**page_size:** `typing.Optional[int]` — Number of results to return per page. The maximum limit is 100.
@@ -25728,7 +25960,7 @@ client.filestorage.groups.list(
-
client.filestorage.groups.retrieve(...) +
client.hris.employer_benefits.retrieve(...)
@@ -25740,7 +25972,7 @@ client.filestorage.groups.list(
-Returns a `Group` object with the given `id`. +Returns an `EmployerBenefit` object with the given `id`.
@@ -25761,7 +25993,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.filestorage.groups.retrieve( +client.hris.employer_benefits.retrieve( id="id", include_remote_data=True, include_shell_data=True, @@ -25789,14 +26021,6 @@ 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. - -
-
- -
-
- **include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -25825,8 +26049,8 @@ client.filestorage.groups.retrieve(
-## Filestorage Issues -
client.filestorage.issues.list(...) +## Hris Employments +
client.hris.employments.list(...)
@@ -25838,7 +26062,7 @@ client.filestorage.groups.retrieve(
-Gets all issues for Organization. +Returns a list of `Employment` objects.
@@ -25856,35 +26080,41 @@ Gets all issues for Organization. import datetime from merge import Merge -from merge.resources.filestorage.resources.issues import IssuesListRequestStatus +from merge.resources.hris.resources.employments import ( + EmploymentsListRequestExpand, + EmploymentsListRequestOrderBy, + EmploymentsListRequestRemoteFields, + EmploymentsListRequestShowEnumOrigins, +) client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.filestorage.issues.list( - account_token="account_token", - cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", - end_date="end_date", - end_user_organization_name="end_user_organization_name", - first_incident_time_after=datetime.datetime.fromisoformat( +client.hris.employments.list( + created_after=datetime.datetime.fromisoformat( "2024-01-15 09:30:00+00:00", ), - first_incident_time_before=datetime.datetime.fromisoformat( + created_before=datetime.datetime.fromisoformat( "2024-01-15 09:30:00+00:00", ), - include_muted="include_muted", - integration_name="integration_name", - last_incident_time_after=datetime.datetime.fromisoformat( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + employee_id="employee_id", + expand=EmploymentsListRequestExpand.EMPLOYEE, + include_deleted_data=True, + include_remote_data=True, + include_shell_data=True, + modified_after=datetime.datetime.fromisoformat( "2024-01-15 09:30:00+00:00", ), - last_incident_time_before=datetime.datetime.fromisoformat( + modified_before=datetime.datetime.fromisoformat( "2024-01-15 09:30:00+00:00", ), - linked_account_id="linked_account_id", + order_by=EmploymentsListRequestOrderBy.EFFECTIVE_DATE_DESCENDING, page_size=1, - start_date="start_date", - status=IssuesListRequestStatus.ONGOING, + remote_fields=EmploymentsListRequestRemoteFields.EMPLOYMENT_TYPE, + remote_id="remote_id", + show_enum_origins=EmploymentsListRequestShowEnumOrigins.EMPLOYMENT_TYPE, ) ``` @@ -25901,7 +26131,7 @@ client.filestorage.issues.list(
-**account_token:** `typing.Optional[str]` +**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
@@ -25909,7 +26139,7 @@ client.filestorage.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.
@@ -25917,7 +26147,7 @@ client.filestorage.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.
@@ -25925,7 +26155,7 @@ client.filestorage.issues.list(
-**end_user_organization_name:** `typing.Optional[str]` +**employee_id:** `typing.Optional[str]` — If provided, will only return employments for this employee.
@@ -25933,7 +26163,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. +**expand:** `typing.Optional[EmploymentsListRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -25941,7 +26171,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. +**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/).
@@ -25949,7 +26179,7 @@ client.filestorage.issues.list(
-**include_muted:** `typing.Optional[str]` — If true, will include muted issues +**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -25957,7 +26187,7 @@ client.filestorage.issues.list(
-**integration_name:** `typing.Optional[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).
@@ -25965,7 +26195,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. +**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
@@ -25973,7 +26203,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_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
@@ -25981,7 +26211,7 @@ client.filestorage.issues.list(
-**linked_account_id:** `typing.Optional[str]` — If provided, will only include issues pertaining to the linked account passed in. +**order_by:** `typing.Optional[EmploymentsListRequestOrderBy]` — Overrides the default ordering for this endpoint. Possible values include: effective_date, -effective_date.
@@ -25989,7 +26219,7 @@ client.filestorage.issues.list(
-**page_size:** `typing.Optional[int]` — Number of results to return per page. +**page_size:** `typing.Optional[int]` — Number of results to return per page. The maximum limit is 100.
@@ -25997,7 +26227,7 @@ client.filestorage.issues.list(
-**start_date:** `typing.Optional[str]` — If included, will only include issues whose most recent action occurred after this time +**remote_fields:** `typing.Optional[EmploymentsListRequestRemoteFields]` — Deprecated. Use show_enum_origins.
@@ -26005,12 +26235,15 @@ client.filestorage.issues.list(
-**status:** `typing.Optional[IssuesListRequestStatus]` +**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object. + +
+
-Status of the issue. Options: ('ONGOING', 'RESOLVED') +
+
-* `ONGOING` - ONGOING -* `RESOLVED` - RESOLVED +**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)
@@ -26030,7 +26263,7 @@ Status of the issue. Options: ('ONGOING', 'RESOLVED')
-
client.filestorage.issues.retrieve(...) +
client.hris.employments.retrieve(...)
@@ -26042,7 +26275,7 @@ Status of the issue. Options: ('ONGOING', 'RESOLVED')
-Get a specific issue. +Returns an `Employment` object with the given `id`.
@@ -26058,13 +26291,23 @@ Get a specific issue. ```python from merge import Merge +from merge.resources.hris.resources.employments import ( + EmploymentsRetrieveRequestExpand, + EmploymentsRetrieveRequestRemoteFields, + EmploymentsRetrieveRequestShowEnumOrigins, +) client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.filestorage.issues.retrieve( +client.hris.employments.retrieve( id="id", + expand=EmploymentsRetrieveRequestExpand.EMPLOYEE, + include_remote_data=True, + include_shell_data=True, + remote_fields=EmploymentsRetrieveRequestRemoteFields.EMPLOYMENT_TYPE, + show_enum_origins=EmploymentsRetrieveRequestShowEnumOrigins.EMPLOYMENT_TYPE, ) ``` @@ -26089,6 +26332,46 @@ client.filestorage.issues.retrieve(
+**expand:** `typing.Optional[EmploymentsRetrieveRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. + +
+
+ +
+
+ +**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. + +
+
+ +
+
+ +**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[EmploymentsRetrieveRequestRemoteFields]` — Deprecated. Use show_enum_origins. + +
+
+ +
+
+ +**show_enum_origins:** `typing.Optional[EmploymentsRetrieveRequestShowEnumOrigins]` — A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter) + +
+
+ +
+
+ **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -26101,8 +26384,8 @@ client.filestorage.issues.retrieve(
-## Filestorage LinkToken -
client.filestorage.link_token.create(...) +## Hris FieldMapping +
client.hris.field_mapping.field_mappings_retrieve(...)
@@ -26114,7 +26397,7 @@ client.filestorage.issues.retrieve(
-Creates a link token to be used when linking a new end user. +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/).
@@ -26130,17 +26413,13 @@ 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.hris.field_mapping.field_mappings_retrieve( + exclude_remote_field_metadata=True, ) ``` @@ -26157,7 +26436,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. +**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.
@@ -26165,39 +26444,76 @@ client.filestorage.link_token.create(
-**end_user_organization_name:** `str` — Your end user's organization. +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+ +
-
-
-**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.hris.field_mapping.field_mappings_create(...)
-**categories:** `typing.Sequence[CategoriesEnum]` — The integration categories to show in Merge Link. - +#### 📝 Description + +
+
+ +
+
+ +Create new Field Mappings that will be available after the next scheduled sync. This will cause the next sync for this Linked Account to sync **ALL** data from start.
+
+
+ +#### 🔌 Usage
-**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/. - +
+
+ +```python +from merge import Merge + +client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.hris.field_mapping.field_mappings_create( + exclude_remote_field_metadata=True, + target_field_name="example_target_field_name", + target_field_description="this is a example description of the target field", + remote_field_traversal_path=["example_remote_field"], + remote_method="GET", + remote_url_path="/example-url-path", + common_model_name="ExampleCommonModel", +) + +``` +
+
+#### ⚙️ Parameters +
-**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. +
+
+ +**target_field_name:** `str` — The name of the target field you want this remote field to map to.
@@ -26205,7 +26521,7 @@ client.filestorage.link_token.create(
-**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. +**target_field_description:** `str` — The description of the target field you want this remote field to map to.
@@ -26213,7 +26529,7 @@ client.filestorage.link_token.create(
-**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. +**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.
@@ -26221,7 +26537,7 @@ client.filestorage.link_token.create(
-**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. +**remote_method:** `str` — The method of the remote endpoint where the remote field is coming from.
@@ -26229,14 +26545,7 @@ client.filestorage.link_token.create(
-**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. +**remote_url_path:** `str` — The path of the remote endpoint where the remote field is coming from.
@@ -26244,12 +26553,7 @@ client.filestorage.link_token.create(
-**language:** `typing.Optional[LanguageEnum]` - -The following subset of IETF language tags can be used to configure localization. - -* `en` - en -* `de` - de +**common_model_name:** `str` — The name of the Common Model that the remote field corresponds to in a given category.
@@ -26257,7 +26561,7 @@ The following subset of IETF language tags can be used to configure localization
-**are_syncs_disabled:** `typing.Optional[bool]` — The boolean that indicates whether initial, periodic, and force syncs will be disabled. +**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.
@@ -26265,7 +26569,7 @@ The following subset of IETF language tags can be used to configure localization
-**integration_specific_config:** `typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]]` — A JSON object containing integration-specific configuration options. +**jmes_path:** `typing.Optional[str]` — JMES path to specify json query expression to be used on field mapping.
@@ -26285,8 +26589,7 @@ The following subset of IETF language tags can be used to configure localization
-## Filestorage LinkedAccounts -
client.filestorage.linked_accounts.list(...) +
client.hris.field_mapping.field_mappings_destroy(...)
@@ -26298,7 +26601,7 @@ The following subset of IETF language tags can be used to configure localization
-List linked accounts for your organization. +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.
@@ -26314,28 +26617,13 @@ List linked accounts for your organization. ```python from merge import Merge -from merge.resources.filestorage.resources.linked_accounts import ( - LinkedAccountsListRequestCategory, -) client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.filestorage.linked_accounts.list( - category=LinkedAccountsListRequestCategory.ACCOUNTING, - cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", - end_user_email_address="end_user_email_address", - end_user_organization_name="end_user_organization_name", - end_user_origin_id="end_user_origin_id", - end_user_origin_ids="end_user_origin_ids", - id="id", - ids="ids", - include_duplicates=True, - integration_name="integration_name", - is_test_account="is_test_account", - page_size=1, - status="status", +client.hris.field_mapping.field_mappings_destroy( + field_mapping_id="field_mapping_id", ) ``` @@ -26352,17 +26640,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 +**field_mapping_id:** `str`
@@ -26370,63 +26648,70 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing`
-**cursor:** `typing.Optional[str]` — The pagination cursor value. +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+ +
-
-
-**end_user_email_address:** `typing.Optional[str]` — If provided, will only return linked accounts associated with the given email address. -
+
+
client.hris.field_mapping.field_mappings_partial_update(...)
-**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. - +Create or update existing Field Mappings for a Linked Account. Changes will be reflected after the next scheduled sync. This will cause the next sync for this Linked Account to sync **ALL** data from start. +
+
+#### 🔌 Usage +
-**id:** `typing.Optional[str]` - -
-
-
-**ids:** `typing.Optional[str]` — Comma-separated list of LinkedAccount IDs, making it possible to specify multiple LinkedAccounts at once. - +```python +from merge import Merge + +client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.hris.field_mapping.field_mappings_partial_update( + field_mapping_id="field_mapping_id", +) + +```
+ + + +#### ⚙️ Parameters
-**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. +
+
+ +**field_mapping_id:** `str`
@@ -26434,7 +26719,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. +**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.
@@ -26442,7 +26727,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. +**remote_method:** `typing.Optional[str]` — The method of the remote endpoint where the remote field is coming from.
@@ -26450,7 +26735,7 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing`
-**page_size:** `typing.Optional[int]` — Number of results to return per page. +**remote_url_path:** `typing.Optional[str]` — The path of the remote endpoint where the remote field is coming from.
@@ -26458,7 +26743,7 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing`
-**status:** `typing.Optional[str]` — Filter by status. Options: `COMPLETE`, `IDLE`, `INCOMPLETE`, `RELINK_NEEDED` +**jmes_path:** `typing.Optional[str]` — JMES path to specify json query expression to be used on field mapping.
@@ -26478,8 +26763,7 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing`
-## Filestorage Passthrough -
client.filestorage.passthrough.create(...) +
client.hris.field_mapping.remote_fields_retrieve(...)
@@ -26491,7 +26775,7 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing`
-Pull data from an endpoint not currently supported by Merge. +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/).
@@ -26507,17 +26791,14 @@ 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.passthrough.create( - request=DataPassthroughRequest( - method=MethodEnum.GET, - path="/scooters", - ), +client.hris.field_mapping.remote_fields_retrieve( + common_models="common_models", + include_example_values="include_example_values", ) ``` @@ -26534,7 +26815,15 @@ client.filestorage.passthrough.create(
-**request:** `DataPassthroughRequest` +**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.
@@ -26554,8 +26843,7 @@ client.filestorage.passthrough.create(
-## Filestorage RegenerateKey -
client.filestorage.regenerate_key.create(...) +
client.hris.field_mapping.target_fields_retrieve()
@@ -26567,7 +26855,7 @@ client.filestorage.passthrough.create(
-Exchange remote keys. +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/).
@@ -26588,9 +26876,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.filestorage.regenerate_key.create( - name="Remote Deployment Key 1", -) +client.hris.field_mapping.target_fields_retrieve() ``` @@ -26606,14 +26892,6 @@ client.filestorage.regenerate_key.create(
-**name:** `str` — The name of the remote key - -
-
- -
-
- **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -26626,8 +26904,8 @@ client.filestorage.regenerate_key.create(
-## Filestorage SyncStatus -
client.filestorage.sync_status.list(...) +## Hris GenerateKey +
client.hris.generate_key.create(...)
@@ -26639,7 +26917,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). +Create a remote key.
@@ -26660,9 +26938,8 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.filestorage.sync_status.list( - cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", - page_size=1, +client.hris.generate_key.create( + name="Remote Deployment Key 1", ) ``` @@ -26679,80 +26956,10 @@ client.filestorage.sync_status.list(
-**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. +**name:** `str` — The name of the remote key
- -
- - - - -
- -## Filestorage ForceResync -
client.filestorage.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.filestorage.force_resync.sync_status_resync_create() - -``` -
-
-
-
- -#### ⚙️ Parameters - -
-
@@ -26769,8 +26976,8 @@ client.filestorage.force_resync.sync_status_resync_create()
-## Filestorage Users -
client.filestorage.users.list(...) +## Hris Groups +
client.hris.groups.list(...)
@@ -26782,7 +26989,7 @@ client.filestorage.force_resync.sync_status_resync_create()
-Returns a list of `User` objects. +Returns a list of `Group` objects.
@@ -26805,7 +27012,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.filestorage.users.list( +client.hris.groups.list( created_after=datetime.datetime.fromisoformat( "2024-01-15 09:30:00+00:00", ), @@ -26816,15 +27023,17 @@ client.filestorage.users.list( include_deleted_data=True, include_remote_data=True, include_shell_data=True, - is_me="is_me", + is_commonly_used_as_team="is_commonly_used_as_team", modified_after=datetime.datetime.fromisoformat( "2024-01-15 09:30:00+00:00", ), modified_before=datetime.datetime.fromisoformat( "2024-01-15 09:30:00+00:00", ), + names="names", page_size=1, remote_id="remote_id", + types="types", ) ``` @@ -26889,7 +27098,7 @@ client.filestorage.users.list(
-**is_me:** `typing.Optional[str]` — If provided, will only return the user object for requestor. +**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.
@@ -26913,7 +27122,7 @@ client.filestorage.users.list(
-**page_size:** `typing.Optional[int]` — Number of results to return per page. +**names:** `typing.Optional[str]` — If provided, will only return groups with these names. Multiple values can be separated by commas.
@@ -26921,7 +27130,7 @@ client.filestorage.users.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. The maximum limit is 100.
@@ -26929,37 +27138,69 @@ client.filestorage.users.list(
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. +**remote_fields:** `typing.Optional[typing.Literal["type"]]` — Deprecated. Use show_enum_origins.
- -
+
+
+**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object. +
-
-
client.filestorage.users.retrieve(...)
-#### 📝 Description +**show_enum_origins:** `typing.Optional[typing.Literal["type"]]` — A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter) + +
+
+**types:** `typing.Optional[str]` — If provided, will only return groups of these types. Multiple values can be separated by commas. + +
+
+
-Returns a `User` object with the given `id`. +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. +
-#### 🔌 Usage + + + +
+ +
client.hris.groups.retrieve(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Returns a `Group` object with the given `id`. +
+
+
+
+ +#### 🔌 Usage
@@ -26974,7 +27215,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.filestorage.users.retrieve( +client.hris.groups.retrieve( id="id", include_remote_data=True, include_shell_data=True, @@ -27018,6 +27259,22 @@ client.filestorage.users.retrieve(
+**remote_fields:** `typing.Optional[typing.Literal["type"]]` — Deprecated. Use show_enum_origins. + +
+
+ +
+
+ +**show_enum_origins:** `typing.Optional[typing.Literal["type"]]` — A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter) + +
+
+ +
+
+ **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -27030,8 +27287,8 @@ client.filestorage.users.retrieve(
-## Filestorage WebhookReceivers -
client.filestorage.webhook_receivers.list() +## Hris Issues +
client.hris.issues.list(...)
@@ -27043,7 +27300,7 @@ client.filestorage.users.retrieve(
-Returns a list of `WebhookReceiver` objects. +Gets all issues for Organization.
@@ -27058,13 +27315,39 @@ Returns a list of `WebhookReceiver` objects.
```python +import datetime + from merge import Merge +from merge.resources.hris.resources.issues import IssuesListRequestStatus client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.filestorage.webhook_receivers.list() +client.hris.issues.list( + account_token="account_token", + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + end_date="end_date", + end_user_organization_name="end_user_organization_name", + first_incident_time_after=datetime.datetime.fromisoformat( + "2024-01-15 09:30:00+00:00", + ), + first_incident_time_before=datetime.datetime.fromisoformat( + "2024-01-15 09:30:00+00:00", + ), + include_muted="include_muted", + integration_name="integration_name", + last_incident_time_after=datetime.datetime.fromisoformat( + "2024-01-15 09:30:00+00:00", + ), + last_incident_time_before=datetime.datetime.fromisoformat( + "2024-01-15 09:30:00+00:00", + ), + linked_account_id="linked_account_id", + page_size=1, + start_date="start_date", + status=IssuesListRequestStatus.ONGOING, +) ```
@@ -27080,71 +27363,47 @@ client.filestorage.webhook_receivers.list()
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. +**account_token:** `typing.Optional[str]`
- -
+
+
+**cursor:** `typing.Optional[str]` — The pagination cursor value. +
-
-
client.filestorage.webhook_receivers.create(...)
-#### 📝 Description - -
-
+**end_date:** `typing.Optional[str]` — If included, will only include issues whose most recent action occurred before this time + +
+
-Creates a `WebhookReceiver` object with the given values. -
-
+**end_user_organization_name:** `typing.Optional[str]` +
-#### 🔌 Usage -
-
-
- -```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, -) - -``` -
-
+**first_incident_time_after:** `typing.Optional[dt.datetime]` — If provided, will only return issues whose first incident time was after this datetime. +
-#### ⚙️ Parameters - -
-
-
-**event:** `str` +**first_incident_time_before:** `typing.Optional[dt.datetime]` — If provided, will only return issues whose first incident time was before this datetime.
@@ -27152,7 +27411,7 @@ client.filestorage.webhook_receivers.create(
-**is_active:** `bool` +**include_muted:** `typing.Optional[str]` — If true, will include muted issues
@@ -27160,7 +27419,7 @@ client.filestorage.webhook_receivers.create(
-**key:** `typing.Optional[str]` +**integration_name:** `typing.Optional[str]`
@@ -27168,65 +27427,56 @@ client.filestorage.webhook_receivers.create(
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. +**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. +
-
-## Hris AccountDetails -
client.hris.account_details.retrieve()
-#### 📝 Description - -
-
+**linked_account_id:** `typing.Optional[str]` — If provided, will only include issues pertaining to the linked account passed in. + +
+
-Get details for a linked account. -
-
+**page_size:** `typing.Optional[int]` — Number of results to return per page. The maximum limit is 100. +
-#### 🔌 Usage -
+**start_date:** `typing.Optional[str]` — If included, will only include issues whose most recent action occurred after this time + +
+
+
-```python -from merge import Merge +**status:** `typing.Optional[IssuesListRequestStatus]` -client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.hris.account_details.retrieve() +Status of the issue. Options: ('ONGOING', 'RESOLVED') -``` -
-
+* `ONGOING` - ONGOING +* `RESOLVED` - RESOLVED + -#### ⚙️ Parameters - -
-
-
@@ -27242,8 +27492,7 @@ client.hris.account_details.retrieve()
-## Hris AccountToken -
client.hris.account_token.retrieve(...) +
client.hris.issues.retrieve(...)
@@ -27255,7 +27504,7 @@ client.hris.account_details.retrieve()
-Returns the account token for the end user with the provided public token. +Get a specific issue.
@@ -27276,8 +27525,8 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.account_token.retrieve( - public_token="public_token", +client.hris.issues.retrieve( + id="id", ) ``` @@ -27294,7 +27543,7 @@ client.hris.account_token.retrieve(
-**public_token:** `str` +**id:** `str`
@@ -27314,8 +27563,8 @@ client.hris.account_token.retrieve(
-## Hris AsyncPassthrough -
client.hris.async_passthrough.create(...) +## Hris LinkToken +
client.hris.link_token.create(...)
@@ -27327,7 +27576,7 @@ client.hris.account_token.retrieve(
-Asynchronously pull data from an endpoint not currently supported by Merge. +Creates a link token to be used when linking a new end user.
@@ -27343,17 +27592,17 @@ Asynchronously pull data from an endpoint not currently supported by Merge. ```python from merge import Merge -from merge.resources.hris import DataPassthroughRequest, MethodEnum +from merge.resources.hris import CategoriesEnum 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.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], ) ``` @@ -27370,7 +27619,7 @@ client.hris.async_passthrough.create(
-**request:** `DataPassthroughRequest` +**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.
@@ -27378,70 +27627,119 @@ client.hris.async_passthrough.create(
-**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. +
+
+
+**categories:** `typing.Sequence[CategoriesEnum]` — The integration categories to show in Merge Link. +
-
-
client.hris.async_passthrough.retrieve(...)
-#### 📝 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. + +
+
+
-Retrieves data from earlier async-passthrough POST request +**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. +
+ +
+
+ +**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. +
-#### 🔌 Usage -
+**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 - -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", -) - -``` +**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. + +
+
+
-**async_passthrough_receipt_id:** `str` +**completed_account_initial_screen:** `typing.Optional[EndUserDetailsRequestCompletedAccountInitialScreen]` + +When creating a Link token, you can specifiy the initial screen of Linking Flow for a completed Linked Account. + +* `SELECTIVE_SYNC` - SELECTIVE_SYNC
@@ -27461,8 +27759,8 @@ client.hris.async_passthrough.retrieve(
-## Hris AuditTrail -
client.hris.audit_trail.list(...) +## Hris LinkedAccounts +
client.hris.linked_accounts.list(...)
@@ -27474,7 +27772,7 @@ client.hris.async_passthrough.retrieve(
-Gets a list of audit trail events. +List linked accounts for your organization.
@@ -27490,18 +27788,28 @@ Gets a list of audit trail events. ```python from merge import Merge +from merge.resources.hris.resources.linked_accounts import ( + LinkedAccountsListRequestCategory, +) client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.audit_trail.list( +client.hris.linked_accounts.list( + category=LinkedAccountsListRequestCategory.ACCOUNTING, cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", - end_date="end_date", - event_type="event_type", + end_user_email_address="end_user_email_address", + end_user_organization_name="end_user_organization_name", + end_user_origin_id="end_user_origin_id", + end_user_origin_ids="end_user_origin_ids", + id="id", + ids="ids", + include_duplicates=True, + integration_name="integration_name", + is_test_account="is_test_account", page_size=1, - start_date="start_date", - user_email="user_email", + status="status", ) ``` @@ -27518,7 +27826,17 @@ client.hris.audit_trail.list(
-**cursor:** `typing.Optional[str]` — The pagination cursor value. +**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
@@ -27526,7 +27844,7 @@ client.hris.audit_trail.list(
-**end_date:** `typing.Optional[str]` — If included, will only include audit trail events that occurred before this time +**cursor:** `typing.Optional[str]` — The pagination cursor value.
@@ -27534,7 +27852,7 @@ client.hris.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` +**end_user_email_address:** `typing.Optional[str]` — If provided, will only return linked accounts associated with the given email address.
@@ -27542,7 +27860,7 @@ client.hris.audit_trail.list(
-**page_size:** `typing.Optional[int]` — Number of results to return per page. +**end_user_organization_name:** `typing.Optional[str]` — If provided, will only return linked accounts associated with the given organization name.
@@ -27550,7 +27868,7 @@ client.hris.audit_trail.list(
-**start_date:** `typing.Optional[str]` — If included, will only include audit trail events that occurred after this time +**end_user_origin_id:** `typing.Optional[str]` — If provided, will only return linked accounts associated with the given origin ID.
@@ -27558,7 +27876,7 @@ client.hris.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. +**end_user_origin_ids:** `typing.Optional[str]` — Comma-separated list of EndUser origin IDs, making it possible to specify multiple EndUsers at once.
@@ -27566,65 +27884,59 @@ client.hris.audit_trail.list(
-**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 AvailableActions -
client.hris.available_actions.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. + +
+
-Returns a list of models and actions available for an account. -
-
+**integration_name:** `typing.Optional[str]` — If provided, will only return linked accounts associated with the given integration name. +
-#### 🔌 Usage -
+**is_test_account:** `typing.Optional[str]` — If included, will only include test linked accounts. If not included, will only include non-test linked accounts. + +
+
+
-```python -from merge import Merge - -client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.hris.available_actions.retrieve() - -``` -
-
+**page_size:** `typing.Optional[int]` — Number of results to return per page. The maximum limit is 100. + -#### ⚙️ Parameters -
+**status:** `typing.Optional[str]` — Filter by status. Options: `COMPLETE`, `IDLE`, `INCOMPLETE`, `RELINK_NEEDED` + +
+
+
@@ -27640,8 +27952,8 @@ client.hris.available_actions.retrieve()
-## Hris BankInfo -
client.hris.bank_info.list(...) +## Hris Locations +
client.hris.locations.list(...)
@@ -27653,7 +27965,7 @@ client.hris.available_actions.retrieve()
-Returns a list of `BankInfo` objects. +Returns a list of `Location` objects.
@@ -27671,18 +27983,17 @@ Returns a list of `BankInfo` objects. import datetime from merge import Merge -from merge.resources.hris.resources.bank_info import ( - BankInfoListRequestAccountType, - BankInfoListRequestOrderBy, +from merge.resources.hris.resources.locations import ( + LocationsListRequestLocationType, + LocationsListRequestRemoteFields, + LocationsListRequestShowEnumOrigins, ) client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.bank_info.list( - account_type=BankInfoListRequestAccountType.CHECKING, - bank_name="bank_name", +client.hris.locations.list( created_after=datetime.datetime.fromisoformat( "2024-01-15 09:30:00+00:00", ), @@ -27690,19 +28001,20 @@ client.hris.bank_info.list( "2024-01-15 09:30:00+00:00", ), cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", - employee_id="employee_id", include_deleted_data=True, include_remote_data=True, include_shell_data=True, + location_type=LocationsListRequestLocationType.HOME, modified_after=datetime.datetime.fromisoformat( "2024-01-15 09:30:00+00:00", ), modified_before=datetime.datetime.fromisoformat( "2024-01-15 09:30:00+00:00", ), - order_by=BankInfoListRequestOrderBy.REMOTE_CREATED_AT_DESCENDING, page_size=1, + remote_fields=LocationsListRequestRemoteFields.COUNTRY, remote_id="remote_id", + show_enum_origins=LocationsListRequestShowEnumOrigins.COUNTRY, ) ``` @@ -27719,27 +28031,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.
@@ -27764,7 +28055,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. +**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/).
@@ -27772,7 +28063,7 @@ If provided, will only return BankInfo's with this account type. Options: ('SAVI
-**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.
@@ -27780,7 +28071,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_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).
@@ -27788,15 +28079,12 @@ 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. - -
-
+**location_type:** `typing.Optional[LocationsListRequestLocationType]` -
-
+If provided, will only return locations with this location type -**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). +* `HOME` - HOME +* `WORK` - WORK
@@ -27820,14 +28108,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. The maximum limit is 100.
@@ -27836,7 +28116,7 @@ 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_fields:** `typing.Optional[LocationsListRequestRemoteFields]` — Deprecated. Use show_enum_origins.
@@ -27852,7 +28132,7 @@ 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) +**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)
@@ -27872,7 +28152,7 @@ If provided, will only return BankInfo's with this account type. Options: ('SAVI
-
client.hris.bank_info.retrieve(...) +
client.hris.locations.retrieve(...)
@@ -27884,7 +28164,7 @@ If provided, will only return BankInfo's with this account type. Options: ('SAVI
-Returns a `BankInfo` object with the given `id`. +Returns a `Location` object with the given `id`.
@@ -27900,15 +28180,21 @@ Returns a `BankInfo` object with the given `id`. ```python from merge import Merge +from merge.resources.hris.resources.locations import ( + LocationsRetrieveRequestRemoteFields, + LocationsRetrieveRequestShowEnumOrigins, +) client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.bank_info.retrieve( +client.hris.locations.retrieve( id="id", include_remote_data=True, include_shell_data=True, + remote_fields=LocationsRetrieveRequestRemoteFields.COUNTRY, + show_enum_origins=LocationsRetrieveRequestShowEnumOrigins.COUNTRY, ) ``` @@ -27933,14 +28219,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.
@@ -27957,7 +28235,7 @@ client.hris.bank_info.retrieve(
-**remote_fields:** `typing.Optional[typing.Literal["account_type"]]` — Deprecated. Use show_enum_origins. +**remote_fields:** `typing.Optional[LocationsRetrieveRequestRemoteFields]` — Deprecated. Use show_enum_origins.
@@ -27965,7 +28243,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) +**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)
@@ -27985,8 +28263,8 @@ client.hris.bank_info.retrieve(
-## Hris Benefits -
client.hris.benefits.list(...) +## Hris Passthrough +
client.hris.passthrough.create(...)
@@ -27998,7 +28276,7 @@ client.hris.bank_info.retrieve(
-Returns a list of `Benefit` objects. +Pull data from an endpoint not currently supported by Merge.
@@ -28013,23 +28291,98 @@ Returns a list of `Benefit` objects.
```python -import datetime - 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.benefits.list( - created_after=datetime.datetime.fromisoformat( - "2024-01-15 09:30:00+00:00", +client.hris.passthrough.create( + request=DataPassthroughRequest( + method=MethodEnum.GET, + path="/scooters", + ), +) + +``` +
+
+ + + +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `DataPassthroughRequest` + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + + + +
+ +## Hris PayGroups +
client.hris.pay_groups.list(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Returns a list of `PayGroup` objects. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +import datetime + +from merge import Merge + +client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.hris.pay_groups.list( + created_after=datetime.datetime.fromisoformat( + "2024-01-15 09:30:00+00:00", ), created_before=datetime.datetime.fromisoformat( "2024-01-15 09:30:00+00:00", ), cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", - employee_id="employee_id", include_deleted_data=True, include_remote_data=True, include_shell_data=True, @@ -28081,22 +28434,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/).
@@ -28165,7 +28502,7 @@ client.hris.benefits.list(
-
client.hris.benefits.retrieve(...) +
client.hris.pay_groups.retrieve(...)
@@ -28177,7 +28514,7 @@ client.hris.benefits.list(
-Returns a `Benefit` object with the given `id`. +Returns a `PayGroup` object with the given `id`.
@@ -28198,7 +28535,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.benefits.retrieve( +client.hris.pay_groups.retrieve( id="id", include_remote_data=True, include_shell_data=True, @@ -28226,14 +28563,6 @@ 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. - -
-
- -
-
- **include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -28262,8 +28591,8 @@ client.hris.benefits.retrieve(
-## Hris Companies -
client.hris.companies.list(...) +## Hris PayrollRuns +
client.hris.payroll_runs.list(...)
@@ -28275,7 +28604,7 @@ client.hris.benefits.retrieve(
-Returns a list of `Company` objects. +Returns a list of `PayrollRun` objects.
@@ -28293,12 +28622,17 @@ Returns a list of `Company` objects. import datetime from merge import Merge +from merge.resources.hris.resources.payroll_runs import ( + PayrollRunsListRequestRemoteFields, + PayrollRunsListRequestRunType, + PayrollRunsListRequestShowEnumOrigins, +) client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.companies.list( +client.hris.payroll_runs.list( created_after=datetime.datetime.fromisoformat( "2024-01-15 09:30:00+00:00", ), @@ -28306,6 +28640,12 @@ client.hris.companies.list( "2024-01-15 09:30:00+00:00", ), cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ended_after=datetime.datetime.fromisoformat( + "2024-01-15 09:30:00+00:00", + ), + ended_before=datetime.datetime.fromisoformat( + "2024-01-15 09:30:00+00:00", + ), include_deleted_data=True, include_remote_data=True, include_shell_data=True, @@ -28316,7 +28656,16 @@ client.hris.companies.list( "2024-01-15 09:30:00+00:00", ), page_size=1, + remote_fields=PayrollRunsListRequestRemoteFields.RUN_STATE, remote_id="remote_id", + run_type=PayrollRunsListRequestRunType.CORRECTION, + show_enum_origins=PayrollRunsListRequestShowEnumOrigins.RUN_STATE, + started_after=datetime.datetime.fromisoformat( + "2024-01-15 09:30:00+00:00", + ), + started_before=datetime.datetime.fromisoformat( + "2024-01-15 09:30:00+00:00", + ), ) ``` @@ -28357,6 +28706,22 @@ client.hris.companies.list(
+**ended_after:** `typing.Optional[dt.datetime]` — If provided, will only return payroll runs ended after this datetime. + +
+
+ +
+
+ +**ended_before:** `typing.Optional[dt.datetime]` — If provided, will only return payroll runs ended before this datetime. + +
+
+ +
+
+ **include_deleted_data:** `typing.Optional[bool]` — 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/).
@@ -28405,6 +28770,14 @@ client.hris.companies.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.
@@ -28413,6 +28786,46 @@ client.hris.companies.list(
+**run_type:** `typing.Optional[PayrollRunsListRequestRunType]` + +If provided, will only return PayrollRun's with this status. Options: ('REGULAR', 'OFF_CYCLE', 'CORRECTION', 'TERMINATION', 'SIGN_ON_BONUS') + +* `REGULAR` - REGULAR +* `OFF_CYCLE` - OFF_CYCLE +* `CORRECTION` - CORRECTION +* `TERMINATION` - TERMINATION +* `SIGN_ON_BONUS` - SIGN_ON_BONUS + +
+
+ +
+
+ +**show_enum_origins:** `typing.Optional[PayrollRunsListRequestShowEnumOrigins]` — A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter) + +
+
+ +
+
+ +**started_after:** `typing.Optional[dt.datetime]` — If provided, will only return payroll runs started after this datetime. + +
+
+ +
+
+ +**started_before:** `typing.Optional[dt.datetime]` — If provided, will only return payroll runs started before this datetime. + +
+
+ +
+
+ **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -28425,7 +28838,7 @@ client.hris.companies.list(
-
client.hris.companies.retrieve(...) +
client.hris.payroll_runs.retrieve(...)
@@ -28437,7 +28850,7 @@ client.hris.companies.list(
-Returns a `Company` object with the given `id`. +Returns a `PayrollRun` object with the given `id`.
@@ -28453,15 +28866,21 @@ Returns a `Company` object with the given `id`. ```python from merge import Merge +from merge.resources.hris.resources.payroll_runs import ( + PayrollRunsRetrieveRequestRemoteFields, + PayrollRunsRetrieveRequestShowEnumOrigins, +) client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.companies.retrieve( +client.hris.payroll_runs.retrieve( id="id", include_remote_data=True, include_shell_data=True, + remote_fields=PayrollRunsRetrieveRequestRemoteFields.RUN_STATE, + show_enum_origins=PayrollRunsRetrieveRequestShowEnumOrigins.RUN_STATE, ) ``` @@ -28502,6 +28921,22 @@ client.hris.companies.retrieve(
+**remote_fields:** `typing.Optional[PayrollRunsRetrieveRequestRemoteFields]` — Deprecated. Use show_enum_origins. + +
+
+ +
+
+ +**show_enum_origins:** `typing.Optional[PayrollRunsRetrieveRequestShowEnumOrigins]` — A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter) + +
+
+ +
+
+ **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -28514,8 +28949,8 @@ client.hris.companies.retrieve(
-## Hris Scopes -
client.hris.scopes.default_scopes_retrieve() +## Hris RegenerateKey +
client.hris.regenerate_key.create(...)
@@ -28527,7 +28962,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). +Exchange remote keys.
@@ -28548,7 +28983,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.scopes.default_scopes_retrieve() +client.hris.regenerate_key.create( + name="Remote Deployment Key 1", +) ``` @@ -28564,6 +29001,14 @@ client.hris.scopes.default_scopes_retrieve()
+**name:** `str` — The name of the remote key + +
+
+ +
+
+ **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -28576,7 +29021,8 @@ client.hris.scopes.default_scopes_retrieve()
-
client.hris.scopes.linked_account_scopes_retrieve() +## Hris SyncStatus +
client.hris.sync_status.list(...)
@@ -28588,7 +29034,7 @@ client.hris.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). +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).
@@ -28609,7 +29055,10 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.scopes.linked_account_scopes_retrieve() +client.hris.sync_status.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + page_size=1, +) ``` @@ -28625,99 +29074,15 @@ client.hris.scopes.linked_account_scopes_retrieve()
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. +**cursor:** `typing.Optional[str]` — The pagination cursor value. -
-
- -
- - - - -
- -
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) -
-
-
-
- -#### 🔌 Usage - -
-
- -
-
- -```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, - ) - }, - ), - ], -) - -``` -
-
-#### ⚙️ Parameters - -
-
-
-**common_models:** `typing.Sequence[IndividualCommonModelScopeDeserializerRequest]` — The common models you want to update the scopes for +**page_size:** `typing.Optional[int]` — Number of results to return per page. The maximum limit is 100.
@@ -28737,8 +29102,8 @@ client.hris.scopes.linked_account_scopes_create(
-## Hris DeleteAccount -
client.hris.delete_account.delete() +## Hris ForceResync +
client.hris.force_resync.sync_status_resync_create()
@@ -28750,7 +29115,7 @@ client.hris.scopes.linked_account_scopes_create(
-Delete a linked account. +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.
@@ -28771,7 +29136,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.delete_account.delete() +client.hris.force_resync.sync_status_resync_create() ``` @@ -28799,8 +29164,8 @@ client.hris.delete_account.delete()
-## Hris Dependents -
client.hris.dependents.list(...) +## Hris Teams +
client.hris.teams.list(...)
@@ -28812,7 +29177,7 @@ client.hris.delete_account.delete()
-Returns a list of `Dependent` objects. +Returns a list of `Team` objects.
@@ -28835,7 +29200,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.dependents.list( +client.hris.teams.list( created_after=datetime.datetime.fromisoformat( "2024-01-15 09:30:00+00:00", ), @@ -28843,10 +29208,8 @@ client.hris.dependents.list( "2024-01-15 09:30:00+00:00", ), cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", - employee_id="employee_id", include_deleted_data=True, include_remote_data=True, - include_sensitive_fields=True, include_shell_data=True, modified_after=datetime.datetime.fromisoformat( "2024-01-15 09:30:00+00:00", @@ -28855,6 +29218,7 @@ client.hris.dependents.list( "2024-01-15 09:30:00+00:00", ), page_size=1, + parent_team_id="parent_team_id", remote_id="remote_id", ) @@ -28896,7 +29260,7 @@ client.hris.dependents.list(
-**employee_id:** `typing.Optional[str]` — If provided, will only return dependents for this employee. +**expand:** `typing.Optional[typing.Literal["parent_team"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -28920,14 +29284,6 @@ client.hris.dependents.list(
-**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).
@@ -28960,97 +29316,7 @@ client.hris.dependents.list(
-**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object. - -
-
- -
-
- -**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. - -
-
- -
- - - -
-
- -
client.hris.dependents.retrieve(...) -
-
- -#### 📝 Description - -
-
- -
-
- -Returns a `Dependent` object with the given `id`. -
-
-
-
- -#### 🔌 Usage - -
-
- -
-
- -```python -from merge import Merge - -client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.hris.dependents.retrieve( - id="id", - include_remote_data=True, - include_sensitive_fields=True, - include_shell_data=True, -) - -``` -
-
-
-
- -#### ⚙️ Parameters - -
-
- -
-
- -**id:** `str` - -
-
- -
-
- -**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. - -
-
- -
-
- -**include_sensitive_fields:** `typing.Optional[bool]` — Whether to include sensitive fields (such as social security numbers) in the response. +**parent_team_id:** `typing.Optional[str]` — If provided, will only return teams with this parent team.
@@ -29058,7 +29324,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). +**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
@@ -29078,8 +29344,7 @@ client.hris.dependents.retrieve(
-## Hris EmployeePayrollRuns -
client.hris.employee_payroll_runs.list(...) +
client.hris.teams.retrieve(...)
@@ -29091,7 +29356,7 @@ client.hris.dependents.retrieve(
-Returns a list of `EmployeePayrollRun` objects. +Returns a `Team` object with the given `id`.
@@ -29106,496 +29371,33 @@ Returns a list of `EmployeePayrollRun` objects.
```python -import datetime - from merge import Merge -from merge.resources.hris.resources.employee_payroll_runs import ( - EmployeePayrollRunsListRequestExpand, -) client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.employee_payroll_runs.list( - created_after=datetime.datetime.fromisoformat( - "2024-01-15 09:30:00+00:00", - ), - created_before=datetime.datetime.fromisoformat( - "2024-01-15 09:30:00+00:00", - ), - cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", - employee_id="employee_id", - ended_after=datetime.datetime.fromisoformat( - "2024-01-15 09:30:00+00:00", - ), - ended_before=datetime.datetime.fromisoformat( - "2024-01-15 09:30:00+00:00", - ), - expand=EmployeePayrollRunsListRequestExpand.EMPLOYEE, - include_deleted_data=True, +client.hris.teams.retrieve( + id="id", include_remote_data=True, include_shell_data=True, - modified_after=datetime.datetime.fromisoformat( - "2024-01-15 09:30:00+00:00", - ), - modified_before=datetime.datetime.fromisoformat( - "2024-01-15 09:30:00+00:00", - ), - page_size=1, - payroll_run_id="payroll_run_id", - remote_id="remote_id", - started_after=datetime.datetime.fromisoformat( - "2024-01-15 09:30:00+00:00", - ), - started_before=datetime.datetime.fromisoformat( - "2024-01-15 09:30:00+00:00", - ), -) - -``` -
-
- - - -#### ⚙️ Parameters - -
-
- -
-
- -**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime. - -
-
- -
-
- -**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime. - -
-
- -
-
- -**cursor:** `typing.Optional[str]` — The pagination cursor value. - -
-
- -
-
- -**employee_id:** `typing.Optional[str]` — If provided, will only return employee payroll runs for this employee. - -
-
- -
-
- -**ended_after:** `typing.Optional[dt.datetime]` — If provided, will only return employee payroll runs ended after this datetime. - -
-
- -
-
- -**ended_before:** `typing.Optional[dt.datetime]` — If provided, will only return employee payroll runs ended before this datetime. - -
-
- -
-
- -**expand:** `typing.Optional[EmployeePayrollRunsListRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. - -
-
- -
-
- -**include_deleted_data:** `typing.Optional[bool]` — 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). - -
-
- -
-
- -**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. The maximum limit is 100. - -
-
- -
-
- -**payroll_run_id:** `typing.Optional[str]` — If provided, will only return employee payroll runs for this employee. - -
-
- -
-
- -**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object. - -
-
- -
-
- -**started_after:** `typing.Optional[dt.datetime]` — If provided, will only return employee payroll runs started after this datetime. - -
-
- -
-
- -**started_before:** `typing.Optional[dt.datetime]` — If provided, will only return employee payroll runs started before this datetime. - -
-
- -
-
- -**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. - -
-
-
-
- - - - -
- -
client.hris.employee_payroll_runs.retrieve(...) -
-
- -#### 📝 Description - -
-
- -
-
- -Returns an `EmployeePayrollRun` object with the given `id`. -
-
-
-
- -#### 🔌 Usage - -
-
- -
-
- -```python -from merge import Merge -from merge.resources.hris.resources.employee_payroll_runs import ( - EmployeePayrollRunsRetrieveRequestExpand, -) - -client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.hris.employee_payroll_runs.retrieve( - id="id", - expand=EmployeePayrollRunsRetrieveRequestExpand.EMPLOYEE, - include_remote_data=True, - include_shell_data=True, -) - -``` -
-
-
-
- -#### ⚙️ Parameters - -
-
- -
-
- -**id:** `str` - -
-
- -
-
- -**expand:** `typing.Optional[EmployeePayrollRunsRetrieveRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. - -
-
- -
-
- -**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. - -
-
- -
-
- -**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. - -
-
-
-
- - -
-
-
- -## Hris Employees -
client.hris.employees.list(...) -
-
- -#### 📝 Description - -
-
- -
-
- -Returns a list of `Employee` objects. -
-
-
-
- -#### 🔌 Usage - -
-
- -
-
- -```python -import datetime - -from merge import Merge -from merge.resources.hris.resources.employees import ( - EmployeesListRequestEmploymentStatus, - EmployeesListRequestExpand, - EmployeesListRequestRemoteFields, - EmployeesListRequestShowEnumOrigins, -) - -client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.hris.employees.list( - company_id="company_id", - created_after=datetime.datetime.fromisoformat( - "2024-01-15 09:30:00+00:00", - ), - created_before=datetime.datetime.fromisoformat( - "2024-01-15 09:30:00+00:00", - ), - cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", - display_full_name="display_full_name", - employee_number="employee_number", - employment_status=EmployeesListRequestEmploymentStatus.ACTIVE, - employment_type="employment_type", - expand=EmployeesListRequestExpand.COMPANY, - first_name="first_name", - groups="groups", - home_location_id="home_location_id", - include_deleted_data=True, - include_remote_data=True, - include_sensitive_fields=True, - include_shell_data=True, - job_title="job_title", - last_name="last_name", - manager_id="manager_id", - modified_after=datetime.datetime.fromisoformat( - "2024-01-15 09:30:00+00:00", - ), - modified_before=datetime.datetime.fromisoformat( - "2024-01-15 09:30:00+00:00", - ), - page_size=1, - pay_group_id="pay_group_id", - personal_email="personal_email", - remote_fields=EmployeesListRequestRemoteFields.EMPLOYMENT_STATUS, - remote_id="remote_id", - show_enum_origins=EmployeesListRequestShowEnumOrigins.EMPLOYMENT_STATUS, - started_after=datetime.datetime.fromisoformat( - "2024-01-15 09:30:00+00:00", - ), - started_before=datetime.datetime.fromisoformat( - "2024-01-15 09:30:00+00:00", - ), - team_id="team_id", - terminated_after=datetime.datetime.fromisoformat( - "2024-01-15 09:30:00+00:00", - ), - terminated_before=datetime.datetime.fromisoformat( - "2024-01-15 09:30:00+00:00", - ), - work_email="work_email", - work_location_id="work_location_id", -) - -``` -
-
-
-
- -#### ⚙️ Parameters - -
-
- -
-
- -**company_id:** `typing.Optional[str]` — If provided, will only return employees for this company. - -
-
- -
-
- -**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime. - -
-
- -
-
- -**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime. - -
-
- -
-
- -**cursor:** `typing.Optional[str]` — The pagination cursor value. - -
-
- -
-
- -**display_full_name:** `typing.Optional[str]` — If provided, will only return employees with this display name. - -
-
- -
-
- -**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. - -* `ACTIVE` - ACTIVE -* `PENDING` - PENDING -* `INACTIVE` - INACTIVE - +) + +``` +
+
+#### ⚙️ Parameters +
-**employment_type:** `typing.Optional[str]` — If provided, will only return employees that have an employment of the specified employment type. - -
-
-
-**expand:** `typing.Optional[EmployeesListRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. +**id:** `str`
@@ -29603,7 +29405,7 @@ If provided, will only return employees with this employment status.
-**first_name:** `typing.Optional[str]` — If provided, will only return employees with this first name. +**expand:** `typing.Optional[typing.Literal["parent_team"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -29611,7 +29413,7 @@ 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. +**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -29619,7 +29421,7 @@ If provided, will only return employees with this employment status.
-**home_location_id:** `typing.Optional[str]` — If provided, will only return employees for this home location. +**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).
@@ -29627,71 +29429,116 @@ If provided, will only return employees with this employment status.
-**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. -
+
+## Hris TimeOff +
client.hris.time_off.list(...)
-**include_sensitive_fields:** `typing.Optional[bool]` — Whether to include sensitive fields (such as social security numbers) in the response. - -
-
+#### 📝 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). - -
-
-
-**job_title:** `typing.Optional[str]` — If provided, will only return employees that have an employment of the specified job title. - +Returns a list of `TimeOff` objects.
+ + + +#### 🔌 Usage
-**last_name:** `typing.Optional[str]` — If provided, will only return employees with this last name. - -
-
-
-**manager_id:** `typing.Optional[str]` — If provided, will only return employees for this manager. - +```python +import datetime + +from merge import Merge +from merge.resources.hris.resources.time_off import ( + TimeOffListRequestExpand, + TimeOffListRequestRemoteFields, + TimeOffListRequestRequestType, + TimeOffListRequestShowEnumOrigins, + TimeOffListRequestStatus, +) + +client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.hris.time_off.list( + approver_id="approver_id", + created_after=datetime.datetime.fromisoformat( + "2024-01-15 09:30:00+00:00", + ), + created_before=datetime.datetime.fromisoformat( + "2024-01-15 09:30:00+00:00", + ), + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + employee_id="employee_id", + ended_after=datetime.datetime.fromisoformat( + "2024-01-15 09:30:00+00:00", + ), + ended_before=datetime.datetime.fromisoformat( + "2024-01-15 09:30:00+00:00", + ), + expand=TimeOffListRequestExpand.APPROVER, + include_deleted_data=True, + include_remote_data=True, + include_shell_data=True, + modified_after=datetime.datetime.fromisoformat( + "2024-01-15 09:30:00+00:00", + ), + modified_before=datetime.datetime.fromisoformat( + "2024-01-15 09:30:00+00:00", + ), + page_size=1, + remote_fields=TimeOffListRequestRemoteFields.REQUEST_TYPE, + remote_id="remote_id", + request_type=TimeOffListRequestRequestType.BEREAVEMENT, + show_enum_origins=TimeOffListRequestShowEnumOrigins.REQUEST_TYPE, + started_after=datetime.datetime.fromisoformat( + "2024-01-15 09:30:00+00:00", + ), + started_before=datetime.datetime.fromisoformat( + "2024-01-15 09:30:00+00:00", + ), + status=TimeOffListRequestStatus.APPROVED, +) + +```
+ + + +#### ⚙️ 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. +**approver_id:** `typing.Optional[str]` — If provided, will only return time off for this approver.
@@ -29699,7 +29546,7 @@ If provided, will only return employees with this employment status.
-**page_size:** `typing.Optional[int]` — Number of results to return per page. +**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
@@ -29707,7 +29554,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 +**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
@@ -29715,7 +29562,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 +**cursor:** `typing.Optional[str]` — The pagination cursor value.
@@ -29723,7 +29570,7 @@ If provided, will only return employees with this employment status.
-**remote_fields:** `typing.Optional[EmployeesListRequestRemoteFields]` — Deprecated. Use show_enum_origins. +**employee_id:** `typing.Optional[str]` — If provided, will only return time off for this employee.
@@ -29731,7 +29578,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. +**ended_after:** `typing.Optional[dt.datetime]` — If provided, will only return employees that ended after this datetime.
@@ -29739,7 +29586,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) +**ended_before:** `typing.Optional[dt.datetime]` — If provided, will only return time-offs that ended before this datetime.
@@ -29747,7 +29594,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. +**expand:** `typing.Optional[TimeOffListRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -29755,7 +29602,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. +**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/).
@@ -29763,7 +29610,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. +**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -29771,7 +29618,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. +**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).
@@ -29779,7 +29626,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. +**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
@@ -29787,7 +29634,7 @@ 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 +**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
@@ -29795,7 +29642,7 @@ If provided, will only return employees with this employment status.
-**work_location_id:** `typing.Optional[str]` — If provided, will only return employees for this location. +**page_size:** `typing.Optional[int]` — Number of results to return per page. The maximum limit is 100.
@@ -29803,73 +29650,48 @@ If provided, will only return employees with this employment status.
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. +**remote_fields:** `typing.Optional[TimeOffListRequestRemoteFields]` — Deprecated. Use show_enum_origins.
- - +
+
+**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object. +
-
-
client.hris.employees.create(...)
-#### 📝 Description - -
-
+**request_type:** `typing.Optional[TimeOffListRequestRequestType]` -
-
+If provided, will only return TimeOff with this request type. Options: ('VACATION', 'SICK', 'PERSONAL', 'JURY_DUTY', 'VOLUNTEER', 'BEREAVEMENT') -Creates an `Employee` object with the given values. -
-
+* `VACATION` - VACATION +* `SICK` - SICK +* `PERSONAL` - PERSONAL +* `JURY_DUTY` - JURY_DUTY +* `VOLUNTEER` - VOLUNTEER +* `BEREAVEMENT` - BEREAVEMENT +
-#### 🔌 Usage - -
-
-
-```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( - is_debug_mode=True, - run_async=True, - model=EmployeeRequest(), -) - -``` -
-
+**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) +
-#### ⚙️ Parameters - -
-
-
-**model:** `EmployeeRequest` +**started_after:** `typing.Optional[dt.datetime]` — If provided, will only return time-offs that started after this datetime.
@@ -29877,7 +29699,7 @@ client.hris.employees.create(
-**is_debug_mode:** `typing.Optional[bool]` — Whether to include debug fields (such as log file links) in the response. +**started_before:** `typing.Optional[dt.datetime]` — If provided, will only return time-offs that started before this datetime.
@@ -29885,7 +29707,15 @@ client.hris.employees.create(
-**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously. +**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
@@ -29905,7 +29735,7 @@ client.hris.employees.create(
-
client.hris.employees.retrieve(...) +
client.hris.time_off.create(...)
@@ -29917,7 +29747,7 @@ client.hris.employees.create(
-Returns an `Employee` object with the given `id`. +Creates a `TimeOff` object with the given values.
@@ -29933,73 +29763,33 @@ Returns an `Employee` object with the given `id`. ```python from merge import Merge -from merge.resources.hris.resources.employees import ( - EmployeesRetrieveRequestExpand, - EmployeesRetrieveRequestRemoteFields, - EmployeesRetrieveRequestShowEnumOrigins, -) +from merge.resources.hris import TimeOffRequest client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.employees.retrieve( - id="id", - expand=EmployeesRetrieveRequestExpand.COMPANY, - include_remote_data=True, - include_sensitive_fields=True, - include_shell_data=True, - remote_fields=EmployeesRetrieveRequestRemoteFields.EMPLOYMENT_STATUS, - show_enum_origins=EmployeesRetrieveRequestShowEnumOrigins.EMPLOYMENT_STATUS, +client.hris.time_off.create( + is_debug_mode=True, + run_async=True, + model=TimeOffRequest(), ) -``` - -
- - - -#### ⚙️ Parameters - -
-
- -
-
- -**id:** `str` - +```
- -
-
- -**expand:** `typing.Optional[EmployeesRetrieveRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. -
-
-
- -**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. - -
-
+#### ⚙️ Parameters
-**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). +**model:** `TimeOffRequest`
@@ -30007,7 +29797,7 @@ client.hris.employees.retrieve(
-**remote_fields:** `typing.Optional[EmployeesRetrieveRequestRemoteFields]` — Deprecated. Use show_enum_origins. +**is_debug_mode:** `typing.Optional[bool]` — Whether to include debug fields (such as log file links) in the response.
@@ -30015,7 +29805,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) +**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously.
@@ -30035,7 +29825,7 @@ client.hris.employees.retrieve(
-
client.hris.employees.ignore_create(...) +
client.hris.time_off.retrieve(...)
@@ -30047,7 +29837,7 @@ client.hris.employees.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. +Returns a `TimeOff` object with the given `id`.
@@ -30063,15 +29853,23 @@ Ignores a specific row based on the `model_id` in the url. These records will ha ```python from merge import Merge -from merge.resources.hris import ReasonEnum +from merge.resources.hris.resources.time_off import ( + TimeOffRetrieveRequestExpand, + TimeOffRetrieveRequestRemoteFields, + TimeOffRetrieveRequestShowEnumOrigins, +) 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, +client.hris.time_off.retrieve( + id="id", + expand=TimeOffRetrieveRequestExpand.APPROVER, + include_remote_data=True, + include_shell_data=True, + remote_fields=TimeOffRetrieveRequestRemoteFields.REQUEST_TYPE, + show_enum_origins=TimeOffRetrieveRequestShowEnumOrigins.REQUEST_TYPE, ) ``` @@ -30088,7 +29886,7 @@ client.hris.employees.ignore_create(
-**model_id:** `str` +**id:** `str`
@@ -30096,7 +29894,7 @@ client.hris.employees.ignore_create(
-**reason:** `IgnoreCommonModelRequestReason` +**expand:** `typing.Optional[TimeOffRetrieveRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -30104,7 +29902,31 @@ client.hris.employees.ignore_create(
-**message:** `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. + +
+
+ +
+
+ +**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[TimeOffRetrieveRequestRemoteFields]` — Deprecated. Use show_enum_origins. + +
+
+ +
+
+ +**show_enum_origins:** `typing.Optional[TimeOffRetrieveRequestShowEnumOrigins]` — A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter)
@@ -30124,7 +29946,7 @@ client.hris.employees.ignore_create(
-
client.hris.employees.meta_post_retrieve() +
client.hris.time_off.meta_post_retrieve()
@@ -30136,7 +29958,7 @@ client.hris.employees.ignore_create(
-Returns metadata for `Employee` POSTs. +Returns metadata for `TimeOff` POSTs.
@@ -30157,7 +29979,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.employees.meta_post_retrieve() +client.hris.time_off.meta_post_retrieve() ``` @@ -30185,8 +30007,8 @@ client.hris.employees.meta_post_retrieve()
-## Hris EmployerBenefits -
client.hris.employer_benefits.list(...) +## Hris TimeOffBalances +
client.hris.time_off_balances.list(...)
@@ -30198,7 +30020,7 @@ client.hris.employees.meta_post_retrieve()
-Returns a list of `EmployerBenefit` objects. +Returns a list of `TimeOffBalance` objects.
@@ -30216,12 +30038,15 @@ Returns a list of `EmployerBenefit` objects. import datetime from merge import Merge +from merge.resources.hris.resources.time_off_balances import ( + TimeOffBalancesListRequestPolicyType, +) client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.employer_benefits.list( +client.hris.time_off_balances.list( created_after=datetime.datetime.fromisoformat( "2024-01-15 09:30:00+00:00", ), @@ -30229,6 +30054,7 @@ client.hris.employer_benefits.list( "2024-01-15 09:30:00+00:00", ), cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + employee_id="employee_id", include_deleted_data=True, include_remote_data=True, include_shell_data=True, @@ -30239,6 +30065,7 @@ client.hris.employer_benefits.list( "2024-01-15 09:30:00+00:00", ), page_size=1, + policy_type=TimeOffBalancesListRequestPolicyType.BEREAVEMENT, remote_id="remote_id", ) @@ -30280,6 +30107,22 @@ client.hris.employer_benefits.list(
+**employee_id:** `typing.Optional[str]` — If provided, will only return time off balances for this employee. + +
+
+ +
+
+ +**expand:** `typing.Optional[typing.Literal["employee"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. + +
+
+ +
+
+ **include_deleted_data:** `typing.Optional[bool]` — 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/).
@@ -30328,6 +30171,31 @@ client.hris.employer_benefits.list(
+**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.
@@ -30336,6 +30204,14 @@ client.hris.employer_benefits.list(
+**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.
@@ -30348,7 +30224,7 @@ client.hris.employer_benefits.list(
-
client.hris.employer_benefits.retrieve(...) +
client.hris.time_off_balances.retrieve(...)
@@ -30360,7 +30236,7 @@ client.hris.employer_benefits.list(
-Returns an `EmployerBenefit` object with the given `id`. +Returns a `TimeOffBalance` object with the given `id`.
@@ -30381,7 +30257,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.employer_benefits.retrieve( +client.hris.time_off_balances.retrieve( id="id", include_remote_data=True, include_shell_data=True, @@ -30409,6 +30285,14 @@ client.hris.employer_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. + +
+
+ +
+
+ **include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -30425,6 +30309,22 @@ client.hris.employer_benefits.retrieve(
+**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.
@@ -30437,8 +30337,8 @@ client.hris.employer_benefits.retrieve(
-## Hris Employments -
client.hris.employments.list(...) +## Hris TimesheetEntries +
client.hris.timesheet_entries.list(...)
@@ -30450,7 +30350,7 @@ client.hris.employer_benefits.retrieve(
-Returns a list of `Employment` objects. +Returns a list of `TimesheetEntry` objects.
@@ -30468,18 +30368,15 @@ Returns a list of `Employment` objects. import datetime from merge import Merge -from merge.resources.hris.resources.employments import ( - EmploymentsListRequestExpand, - EmploymentsListRequestOrderBy, - EmploymentsListRequestRemoteFields, - EmploymentsListRequestShowEnumOrigins, +from merge.resources.hris.resources.timesheet_entries import ( + TimesheetEntriesListRequestOrderBy, ) client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.employments.list( +client.hris.timesheet_entries.list( created_after=datetime.datetime.fromisoformat( "2024-01-15 09:30:00+00:00", ), @@ -30488,7 +30385,12 @@ client.hris.employments.list( ), cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", employee_id="employee_id", - expand=EmploymentsListRequestExpand.EMPLOYEE, + ended_after=datetime.datetime.fromisoformat( + "2024-01-15 09:30:00+00:00", + ), + ended_before=datetime.datetime.fromisoformat( + "2024-01-15 09:30:00+00:00", + ), include_deleted_data=True, include_remote_data=True, include_shell_data=True, @@ -30498,84 +30400,32 @@ client.hris.employments.list( modified_before=datetime.datetime.fromisoformat( "2024-01-15 09:30:00+00:00", ), - order_by=EmploymentsListRequestOrderBy.EFFECTIVE_DATE_DESCENDING, + order_by=TimesheetEntriesListRequestOrderBy.START_TIME_DESCENDING, page_size=1, - remote_fields=EmploymentsListRequestRemoteFields.EMPLOYMENT_TYPE, remote_id="remote_id", - show_enum_origins=EmploymentsListRequestShowEnumOrigins.EMPLOYMENT_TYPE, + started_after=datetime.datetime.fromisoformat( + "2024-01-15 09:30:00+00:00", + ), + started_before=datetime.datetime.fromisoformat( + "2024-01-15 09:30:00+00:00", + ), ) -``` - -
- - - -#### ⚙️ Parameters - -
-
- -
-
- -**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime. - -
-
- -
-
- -**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime. - -
-
- -
-
- -**cursor:** `typing.Optional[str]` — The pagination cursor value. - -
-
- -
-
- -**employee_id:** `typing.Optional[str]` — If provided, will only return employments for this employee. - -
-
- -
-
- -**expand:** `typing.Optional[EmploymentsListRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. - +```
- -
-
- -**include_deleted_data:** `typing.Optional[bool]` — 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. - -
-
-
-**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). +**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
@@ -30583,7 +30433,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. +**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
@@ -30591,7 +30441,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. +**cursor:** `typing.Optional[str]` — The pagination cursor value.
@@ -30599,7 +30449,7 @@ client.hris.employments.list(
-**order_by:** `typing.Optional[EmploymentsListRequestOrderBy]` — Overrides the default ordering for this endpoint. Possible values include: effective_date, -effective_date. +**employee_id:** `typing.Optional[str]` — If provided, will only return timesheet entries for this employee.
@@ -30607,7 +30457,7 @@ client.hris.employments.list(
-**page_size:** `typing.Optional[int]` — Number of results to return per page. The maximum limit is 100. +**ended_after:** `typing.Optional[dt.datetime]` — If provided, will only return timesheet entries ended after this datetime.
@@ -30615,7 +30465,7 @@ client.hris.employments.list(
-**remote_fields:** `typing.Optional[EmploymentsListRequestRemoteFields]` — Deprecated. Use show_enum_origins. +**ended_before:** `typing.Optional[dt.datetime]` — If provided, will only return timesheet entries ended before this datetime.
@@ -30623,7 +30473,7 @@ client.hris.employments.list(
-**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object. +**expand:** `typing.Optional[typing.Literal["employee"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -30631,7 +30481,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) +**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/).
@@ -30639,80 +30489,31 @@ client.hris.employments.list(
-**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.employments.retrieve(...) -
-
- -#### 📝 Description - -
-
-Returns an `Employment` object with the given `id`. -
-
+**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 -from merge.resources.hris.resources.employments import ( - EmploymentsRetrieveRequestExpand, - EmploymentsRetrieveRequestRemoteFields, - EmploymentsRetrieveRequestShowEnumOrigins, -) - -client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.hris.employments.retrieve( - id="id", - expand=EmploymentsRetrieveRequestExpand.EMPLOYEE, - include_remote_data=True, - include_shell_data=True, - remote_fields=EmploymentsRetrieveRequestRemoteFields.EMPLOYMENT_TYPE, - show_enum_origins=EmploymentsRetrieveRequestShowEnumOrigins.EMPLOYMENT_TYPE, -) - -``` -
-
+**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned. +
-#### ⚙️ Parameters - -
-
-
-**id:** `str` +**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
@@ -30720,7 +30521,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. +**order_by:** `typing.Optional[TimesheetEntriesListRequestOrderBy]` — Overrides the default ordering for this endpoint. Possible values include: start_time, -start_time.
@@ -30728,7 +30529,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. +**page_size:** `typing.Optional[int]` — Number of results to return per page. The maximum limit is 100.
@@ -30736,7 +30537,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). +**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
@@ -30744,7 +30545,7 @@ client.hris.employments.retrieve(
-**remote_fields:** `typing.Optional[EmploymentsRetrieveRequestRemoteFields]` — Deprecated. Use show_enum_origins. +**started_after:** `typing.Optional[dt.datetime]` — If provided, will only return timesheet entries started after this datetime.
@@ -30752,7 +30553,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) +**started_before:** `typing.Optional[dt.datetime]` — If provided, will only return timesheet entries started before this datetime.
@@ -30772,8 +30573,7 @@ client.hris.employments.retrieve(
-## Hris FieldMapping -
client.hris.field_mapping.field_mappings_retrieve(...) +
client.hris.timesheet_entries.create(...)
@@ -30785,7 +30585,7 @@ client.hris.employments.retrieve(
-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/). +Creates a `TimesheetEntry` object with the given values.
@@ -30801,13 +30601,16 @@ Get all Field Mappings for this Linked Account. Field Mappings are mappings betw ```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.field_mapping.field_mappings_retrieve( - exclude_remote_field_metadata=True, +client.hris.timesheet_entries.create( + is_debug_mode=True, + run_async=True, + model=TimesheetEntryRequest(), ) ``` @@ -30824,7 +30627,23 @@ client.hris.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. +**model:** `TimesheetEntryRequest` + +
+
+ +
+
+ +**is_debug_mode:** `typing.Optional[bool]` — Whether to include debug fields (such as log file links) in the response. + +
+
+ +
+
+ +**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously.
@@ -30844,7 +30663,7 @@ client.hris.field_mapping.field_mappings_retrieve(
-
client.hris.field_mapping.field_mappings_create(...) +
client.hris.timesheet_entries.retrieve(...)
@@ -30856,7 +30675,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 `TimesheetEntry` object with the given `id`.
@@ -30877,14 +30696,10 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.field_mapping.field_mappings_create( - exclude_remote_field_metadata=True, - 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.timesheet_entries.retrieve( + id="id", + include_remote_data=True, + include_shell_data=True, ) ``` @@ -30901,39 +30716,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. - -
-
- -
-
- -**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`
@@ -30941,7 +30724,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[typing.Literal["employee"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -30949,7 +30732,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_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -30957,7 +30740,7 @@ client.hris.field_mapping.field_mappings_create(
-**jmes_path:** `typing.Optional[str]` — JMES path to specify json query expression to be used on field mapping. +**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).
@@ -30977,7 +30760,7 @@ client.hris.field_mapping.field_mappings_create(
-
client.hris.field_mapping.field_mappings_destroy(...) +
client.hris.timesheet_entries.meta_post_retrieve()
@@ -30989,7 +30772,7 @@ client.hris.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 metadata for `TimesheetEntry` POSTs.
@@ -31010,9 +30793,7 @@ 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", -) +client.hris.timesheet_entries.meta_post_retrieve() ``` @@ -31028,14 +30809,6 @@ client.hris.field_mapping.field_mappings_destroy(
-**field_mapping_id:** `str` - -
-
- -
-
- **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -31048,7 +30821,8 @@ client.hris.field_mapping.field_mappings_destroy(
-
client.hris.field_mapping.field_mappings_partial_update(...) +## Hris WebhookReceivers +
client.hris.webhook_receivers.list()
@@ -31060,7 +30834,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. +Returns a list of `WebhookReceiver` objects.
@@ -31081,9 +30855,7 @@ 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.hris.webhook_receivers.list() ``` @@ -31091,50 +30863,10 @@ client.hris.field_mapping.field_mappings_partial_update(
-#### ⚙️ Parameters - -
-
- -
-
- -**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. - -
-
- -
-
- -**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. - -
-
- -
-
- -**jmes_path:** `typing.Optional[str]` — JMES path to specify json query expression to be used on field mapping. - -
-
+#### ⚙️ Parameters + +
+
@@ -31151,7 +30883,7 @@ client.hris.field_mapping.field_mappings_partial_update(
-
client.hris.field_mapping.remote_fields_retrieve(...) +
client.hris.webhook_receivers.create(...)
@@ -31163,7 +30895,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/). +Creates a `WebhookReceiver` object with the given values.
@@ -31184,9 +30916,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.field_mapping.remote_fields_retrieve( - common_models="common_models", - include_example_values="include_example_values", +client.hris.webhook_receivers.create( + event="event", + is_active=True, ) ``` @@ -31203,7 +30935,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. +**event:** `str`
@@ -31211,7 +30943,15 @@ 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. +**is_active:** `bool` + +
+
+ +
+
+ +**key:** `typing.Optional[str]`
@@ -31231,7 +30971,8 @@ client.hris.field_mapping.remote_fields_retrieve(
-
client.hris.field_mapping.target_fields_retrieve() +## Knowledgebase AccountDetails +
client.knowledgebase.account_details.retrieve()
@@ -31243,7 +30984,7 @@ client.hris.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/). +Get details for a linked account.
@@ -31264,7 +31005,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.field_mapping.target_fields_retrieve() +client.knowledgebase.account_details.retrieve() ``` @@ -31292,8 +31033,8 @@ client.hris.field_mapping.target_fields_retrieve()
-## Hris GenerateKey -
client.hris.generate_key.create(...) +## Knowledgebase AccountToken +
client.knowledgebase.account_token.retrieve(...)
@@ -31305,7 +31046,7 @@ client.hris.field_mapping.target_fields_retrieve()
-Create a remote key. +Returns the account token for the end user with the provided public token.
@@ -31326,8 +31067,8 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.generate_key.create( - name="Remote Deployment Key 1", +client.knowledgebase.account_token.retrieve( + public_token="public_token", ) ``` @@ -31344,7 +31085,7 @@ client.hris.generate_key.create(
-**name:** `str` — The name of the remote key +**public_token:** `str`
@@ -31364,8 +31105,8 @@ client.hris.generate_key.create(
-## Hris Groups -
client.hris.groups.list(...) +## Knowledgebase Articles +
client.knowledgebase.articles.list(...)
@@ -31377,7 +31118,7 @@ client.hris.generate_key.create(
-Returns a list of `Group` objects. +Returns a list of `Article` objects.
@@ -31395,12 +31136,16 @@ Returns a list of `Group` objects. import datetime from merge import Merge +from merge.resources.knowledgebase.resources.articles import ( + ArticlesListRequestExpand, + ArticlesListRequestType, +) client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.groups.list( +client.knowledgebase.articles.list( created_after=datetime.datetime.fromisoformat( "2024-01-15 09:30:00+00:00", ), @@ -31408,20 +31153,23 @@ client.hris.groups.list( "2024-01-15 09:30:00+00:00", ), cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + expand=ArticlesListRequestExpand.ATTACHMENTS, include_deleted_data=True, include_remote_data=True, include_shell_data=True, - is_commonly_used_as_team="is_commonly_used_as_team", modified_after=datetime.datetime.fromisoformat( "2024-01-15 09:30:00+00:00", ), modified_before=datetime.datetime.fromisoformat( "2024-01-15 09:30:00+00:00", ), - names="names", page_size=1, + parent_article_id="parent_article_id", + parent_container_id="parent_container_id", remote_id="remote_id", - types="types", + root_container_id="root_container_id", + status="status", + type=ArticlesListRequestType.EMPTY, ) ``` @@ -31462,7 +31210,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/). +**expand:** `typing.Optional[ArticlesListRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -31470,7 +31218,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_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/).
@@ -31478,7 +31226,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). +**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -31486,7 +31234,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. +**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).
@@ -31510,7 +31258,7 @@ client.hris.groups.list(
-**names:** `typing.Optional[str]` — If provided, will only return groups with these names. Multiple values can be separated by commas. +**page_size:** `typing.Optional[int]` — Number of results to return per page. The maximum limit is 100.
@@ -31518,7 +31266,7 @@ client.hris.groups.list(
-**page_size:** `typing.Optional[int]` — Number of results to return per page. The maximum limit is 100. +**parent_article_id:** `typing.Optional[str]` — If provided, will only return sub articles of the parent_article_id.
@@ -31526,7 +31274,7 @@ client.hris.groups.list(
-**remote_fields:** `typing.Optional[typing.Literal["type"]]` — Deprecated. Use show_enum_origins. +**parent_container_id:** `typing.Optional[str]` — If provided, will only return sub articles of the parent_container_id.
@@ -31542,7 +31290,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) +**root_container_id:** `typing.Optional[str]` — If provided, will only return sub articles of the root_container_id.
@@ -31550,7 +31298,15 @@ client.hris.groups.list(
-**types:** `typing.Optional[str]` — If provided, will only return groups of these types. Multiple values can be separated by commas. +**status:** `typing.Optional[str]` — If provided, will only return articles of the given status; multiple statuses can be separated by commas. + +
+
+ +
+
+ +**type:** `typing.Optional[ArticlesListRequestType]` — If provided, will only return articles of the given type.
@@ -31570,7 +31326,7 @@ client.hris.groups.list(
-
client.hris.groups.retrieve(...) +
client.knowledgebase.articles.retrieve(...)
@@ -31582,7 +31338,7 @@ client.hris.groups.list(
-Returns a `Group` object with the given `id`. +Returns an `Article` object with the given `id`.
@@ -31598,13 +31354,17 @@ Returns a `Group` object with the given `id`. ```python from merge import Merge +from merge.resources.knowledgebase.resources.articles import ( + ArticlesRetrieveRequestExpand, +) client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.groups.retrieve( +client.knowledgebase.articles.retrieve( id="id", + expand=ArticlesRetrieveRequestExpand.ATTACHMENTS, include_remote_data=True, include_shell_data=True, ) @@ -31631,15 +31391,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. - -
-
- -
-
- -**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[ArticlesRetrieveRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -31647,7 +31399,7 @@ client.hris.groups.retrieve(
-**remote_fields:** `typing.Optional[typing.Literal["type"]]` — Deprecated. Use show_enum_origins. +**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -31655,7 +31407,7 @@ 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) +**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).
@@ -31675,8 +31427,8 @@ client.hris.groups.retrieve(
-## Hris Issues -
client.hris.issues.list(...) +## Knowledgebase AsyncPassthrough +
client.knowledgebase.async_passthrough.create(...)
@@ -31688,7 +31440,7 @@ client.hris.groups.retrieve(
-Gets all issues for Organization. +Asynchronously pull data from an endpoint not currently supported by Merge.
@@ -31703,164 +31455,35 @@ Gets all issues for Organization.
```python -import datetime - from merge import Merge -from merge.resources.hris.resources.issues import IssuesListRequestStatus +from merge.resources.knowledgebase import DataPassthroughRequest, MethodEnum client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.issues.list( - account_token="account_token", - cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", - end_date="end_date", - end_user_organization_name="end_user_organization_name", - first_incident_time_after=datetime.datetime.fromisoformat( - "2024-01-15 09:30:00+00:00", - ), - first_incident_time_before=datetime.datetime.fromisoformat( - "2024-01-15 09:30:00+00:00", - ), - include_muted="include_muted", - integration_name="integration_name", - last_incident_time_after=datetime.datetime.fromisoformat( - "2024-01-15 09:30:00+00:00", - ), - last_incident_time_before=datetime.datetime.fromisoformat( - "2024-01-15 09:30:00+00:00", +client.knowledgebase.async_passthrough.create( + request=DataPassthroughRequest( + method=MethodEnum.GET, + path="/scooters", ), - linked_account_id="linked_account_id", - page_size=1, - start_date="start_date", - status=IssuesListRequestStatus.ONGOING, ) -``` -
-
- - - -#### ⚙️ Parameters - -
-
- -
-
- -**account_token:** `typing.Optional[str]` - -
-
- -
-
- -**cursor:** `typing.Optional[str]` — The pagination cursor value. - -
-
- -
-
- -**end_date:** `typing.Optional[str]` — If included, will only include issues whose most recent action occurred before this time - -
-
- -
-
- -**end_user_organization_name:** `typing.Optional[str]` - -
-
- -
-
- -**first_incident_time_after:** `typing.Optional[dt.datetime]` — If provided, will only return issues whose first incident time was after this datetime. - -
-
- -
-
- -**first_incident_time_before:** `typing.Optional[dt.datetime]` — If provided, will only return issues whose first incident time was before this datetime. - -
-
- -
-
- -**include_muted:** `typing.Optional[str]` — If true, will include muted issues - -
-
- -
-
- -**integration_name:** `typing.Optional[str]` - -
-
- -
-
- -**last_incident_time_after:** `typing.Optional[dt.datetime]` — If provided, will only return issues whose last incident time was after this datetime. - -
-
- -
-
- -**last_incident_time_before:** `typing.Optional[dt.datetime]` — If provided, will only return issues whose last incident time was before this datetime. - -
-
- -
-
- -**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. The maximum limit is 100. - +```
- -
-
- -**start_date:** `typing.Optional[str]` — If included, will only include issues whose most recent action occurred after this time -
+#### ⚙️ Parameters +
-**status:** `typing.Optional[IssuesListRequestStatus]` - -Status of the issue. Options: ('ONGOING', 'RESOLVED') +
+
-* `ONGOING` - ONGOING -* `RESOLVED` - RESOLVED +**request:** `DataPassthroughRequest`
@@ -31880,7 +31503,7 @@ Status of the issue. Options: ('ONGOING', 'RESOLVED')
-
client.hris.issues.retrieve(...) +
client.knowledgebase.async_passthrough.retrieve(...)
@@ -31892,7 +31515,7 @@ Status of the issue. Options: ('ONGOING', 'RESOLVED')
-Get a specific issue. +Retrieves data from earlier async-passthrough POST request
@@ -31913,8 +31536,8 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.issues.retrieve( - id="id", +client.knowledgebase.async_passthrough.retrieve( + async_passthrough_receipt_id="async_passthrough_receipt_id", ) ``` @@ -31931,7 +31554,7 @@ client.hris.issues.retrieve(
-**id:** `str` +**async_passthrough_receipt_id:** `str`
@@ -31951,8 +31574,8 @@ client.hris.issues.retrieve(
-## Hris LinkToken -
client.hris.link_token.create(...) +## Knowledgebase Attachments +
client.knowledgebase.attachments.list(...)
@@ -31964,7 +31587,7 @@ client.hris.issues.retrieve(
-Creates a link token to be used when linking a new end user. +Returns a list of `Attachment` objects.
@@ -31979,18 +31602,33 @@ Creates a link token to be used when linking a new end user.
```python +import datetime + from merge import Merge -from merge.resources.hris import CategoriesEnum client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.link_token.create( - end_user_email_address="example@gmail.com", - end_user_organization_name="Test Organization", - end_user_origin_id="12345", - categories=[CategoriesEnum.HRIS, CategoriesEnum.ATS], +client.knowledgebase.attachments.list( + created_after=datetime.datetime.fromisoformat( + "2024-01-15 09:30:00+00:00", + ), + created_before=datetime.datetime.fromisoformat( + "2024-01-15 09:30:00+00:00", + ), + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + include_deleted_data=True, + include_remote_data=True, + include_shell_data=True, + modified_after=datetime.datetime.fromisoformat( + "2024-01-15 09:30:00+00:00", + ), + modified_before=datetime.datetime.fromisoformat( + "2024-01-15 09:30:00+00:00", + ), + page_size=1, + remote_id="remote_id", ) ``` @@ -32007,7 +31645,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. +**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
@@ -32015,7 +31653,7 @@ client.hris.link_token.create(
-**end_user_organization_name:** `str` — Your end user's organization. +**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
@@ -32023,7 +31661,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. +**cursor:** `typing.Optional[str]` — The pagination cursor value.
@@ -32031,7 +31669,7 @@ client.hris.link_token.create(
-**categories:** `typing.Sequence[CategoriesEnum]` — The integration categories to show in Merge Link. +**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/).
@@ -32039,7 +31677,7 @@ 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/. +**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -32047,7 +31685,7 @@ client.hris.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. +**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).
@@ -32055,7 +31693,7 @@ client.hris.link_token.create(
-**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. +**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
@@ -32063,7 +31701,7 @@ client.hris.link_token.create(
-**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. +**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
@@ -32071,7 +31709,7 @@ client.hris.link_token.create(
-**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. +**page_size:** `typing.Optional[int]` — Number of results to return per page. The maximum limit is 100.
@@ -32079,14 +31717,7 @@ client.hris.link_token.create(
-**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. +**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
@@ -32094,28 +31725,72 @@ client.hris.link_token.create(
-**language:** `typing.Optional[EndUserDetailsRequestLanguage]` +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
-The following subset of IETF language tags can be used to configure localization. -* `en` - en -* `de` - de - +
+
client.knowledgebase.attachments.retrieve(...)
-**are_syncs_disabled:** `typing.Optional[bool]` — The boolean that indicates whether initial, periodic, and force syncs will be disabled. - +#### 📝 Description + +
+
+ +
+
+ +Returns an `Attachment` object with the given `id`. +
+
+#### 🔌 Usage +
-**integration_specific_config:** `typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]]` — A JSON object containing integration-specific configuration options. +
+
+ +```python +from merge import Merge + +client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.knowledgebase.attachments.retrieve( + id="id", + include_remote_data=True, + include_shell_data=True, +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**id:** `str`
@@ -32123,11 +31798,15 @@ The following subset of IETF language tags can be used to configure localization
-**completed_account_initial_screen:** `typing.Optional[EndUserDetailsRequestCompletedAccountInitialScreen]` +**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. + +
+
-When creating a Link token, you can specifiy the initial screen of Linking Flow for a completed Linked Account. +
+
-* `SELECTIVE_SYNC` - SELECTIVE_SYNC +**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).
@@ -32147,8 +31826,8 @@ When creating a Link token, you can specifiy the initial screen of Linking Flow
-## Hris LinkedAccounts -
client.hris.linked_accounts.list(...) +## Knowledgebase AuditTrail +
client.knowledgebase.audit_trail.list(...)
@@ -32160,7 +31839,7 @@ When creating a Link token, you can specifiy the initial screen of Linking Flow
-List linked accounts for your organization. +Gets a list of audit trail events.
@@ -32176,28 +31855,18 @@ List linked accounts for your organization. ```python from merge import Merge -from merge.resources.hris.resources.linked_accounts import ( - LinkedAccountsListRequestCategory, -) client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.linked_accounts.list( - category=LinkedAccountsListRequestCategory.ACCOUNTING, +client.knowledgebase.audit_trail.list( cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", - end_user_email_address="end_user_email_address", - end_user_organization_name="end_user_organization_name", - end_user_origin_id="end_user_origin_id", - end_user_origin_ids="end_user_origin_ids", - id="id", - ids="ids", - include_duplicates=True, - integration_name="integration_name", - is_test_account="is_test_account", + end_date="end_date", + event_type="event_type", page_size=1, - status="status", + start_date="start_date", + user_email="user_email", ) ``` @@ -32214,17 +31883,7 @@ 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 +**cursor:** `typing.Optional[str]` — The pagination cursor value.
@@ -32232,7 +31891,7 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing`
-**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
@@ -32240,7 +31899,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. +**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`
@@ -32248,7 +31907,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. +**page_size:** `typing.Optional[int]` — Number of results to return per page.
@@ -32256,7 +31915,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. +**start_date:** `typing.Optional[str]` — If included, will only include audit trail events that occurred after this time
@@ -32264,7 +31923,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. +**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.
@@ -32272,59 +31931,65 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing`
-**id:** `typing.Optional[str]` +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+ +
-
-
-**ids:** `typing.Optional[str]` — Comma-separated list of LinkedAccount IDs, making it possible to specify multiple LinkedAccounts at once. -
+
+## Knowledgebase AvailableActions +
client.knowledgebase.available_actions.retrieve()
-**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. - -
-
+#### 📝 Description
-**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. - +Returns a list of models and actions available for an account. +
+
+#### 🔌 Usage +
-**page_size:** `typing.Optional[int]` — Number of results to return per page. The maximum limit is 100. - -
-
-
-**status:** `typing.Optional[str]` — Filter by status. Options: `COMPLETE`, `IDLE`, `INCOMPLETE`, `RELINK_NEEDED` - +```python +from merge import Merge + +client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.knowledgebase.available_actions.retrieve() + +``` +
+
+#### ⚙️ Parameters + +
+
+
@@ -32340,8 +32005,8 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing`
-## Hris Locations -
client.hris.locations.list(...) +## Knowledgebase Containers +
client.knowledgebase.containers.list(...)
@@ -32353,7 +32018,7 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing`
-Returns a list of `Location` objects. +Returns a list of `Container` objects.
@@ -32371,17 +32036,16 @@ Returns a list of `Location` objects. import datetime from merge import Merge -from merge.resources.hris.resources.locations import ( - LocationsListRequestLocationType, - LocationsListRequestRemoteFields, - LocationsListRequestShowEnumOrigins, +from merge.resources.knowledgebase.resources.containers import ( + ContainersListRequestExpand, + ContainersListRequestType, ) client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.locations.list( +client.knowledgebase.containers.list( created_after=datetime.datetime.fromisoformat( "2024-01-15 09:30:00+00:00", ), @@ -32389,10 +32053,10 @@ client.hris.locations.list( "2024-01-15 09:30:00+00:00", ), cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + expand=ContainersListRequestExpand.PARENT_ARTICLE, include_deleted_data=True, include_remote_data=True, include_shell_data=True, - location_type=LocationsListRequestLocationType.HOME, modified_after=datetime.datetime.fromisoformat( "2024-01-15 09:30:00+00:00", ), @@ -32400,9 +32064,10 @@ client.hris.locations.list( "2024-01-15 09:30:00+00:00", ), page_size=1, - remote_fields=LocationsListRequestRemoteFields.COUNTRY, + parent_article_id="parent_article_id", + parent_container_id="parent_container_id", remote_id="remote_id", - show_enum_origins=LocationsListRequestShowEnumOrigins.COUNTRY, + type=ContainersListRequestType.EMPTY, ) ``` @@ -32443,7 +32108,7 @@ client.hris.locations.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[ContainersListRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -32451,7 +32116,7 @@ client.hris.locations.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/).
@@ -32459,7 +32124,7 @@ client.hris.locations.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.
@@ -32467,12 +32132,7 @@ client.hris.locations.list(
-**location_type:** `typing.Optional[LocationsListRequestLocationType]` - -If provided, will only return locations with this location type - -* `HOME` - HOME -* `WORK` - WORK +**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).
@@ -32504,7 +32164,15 @@ If provided, will only return locations with this location type
-**remote_fields:** `typing.Optional[LocationsListRequestRemoteFields]` — Deprecated. Use show_enum_origins. +**parent_article_id:** `typing.Optional[str]` — If provided, will only return sub containers of the parent_article_id. + +
+
+ +
+
+ +**parent_container_id:** `typing.Optional[str]` — If provided, will only return sub containers of the parent_container_id.
@@ -32520,7 +32188,7 @@ If provided, will only return locations with this location type
-**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) +**type:** `typing.Optional[ContainersListRequestType]` — If provided, will only return containers of the given type.
@@ -32540,7 +32208,7 @@ If provided, will only return locations with this location type
-
client.hris.locations.retrieve(...) +
client.knowledgebase.containers.retrieve(...)
@@ -32552,7 +32220,7 @@ If provided, will only return locations with this location type
-Returns a `Location` object with the given `id`. +Returns a `Container` object with the given `id`.
@@ -32568,21 +32236,19 @@ Returns a `Location` object with the given `id`. ```python from merge import Merge -from merge.resources.hris.resources.locations import ( - LocationsRetrieveRequestRemoteFields, - LocationsRetrieveRequestShowEnumOrigins, +from merge.resources.knowledgebase.resources.containers import ( + ContainersRetrieveRequestExpand, ) client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.locations.retrieve( +client.knowledgebase.containers.retrieve( id="id", + expand=ContainersRetrieveRequestExpand.PARENT_ARTICLE, include_remote_data=True, include_shell_data=True, - remote_fields=LocationsRetrieveRequestRemoteFields.COUNTRY, - show_enum_origins=LocationsRetrieveRequestShowEnumOrigins.COUNTRY, ) ``` @@ -32607,15 +32273,7 @@ client.hris.locations.retrieve(
-**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). +**expand:** `typing.Optional[ContainersRetrieveRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -32623,7 +32281,7 @@ client.hris.locations.retrieve(
-**remote_fields:** `typing.Optional[LocationsRetrieveRequestRemoteFields]` — Deprecated. Use show_enum_origins. +**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -32631,7 +32289,7 @@ 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) +**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).
@@ -32651,8 +32309,8 @@ client.hris.locations.retrieve(
-## Hris Passthrough -
client.hris.passthrough.create(...) +## Knowledgebase Scopes +
client.knowledgebase.scopes.default_scopes_retrieve()
@@ -32664,7 +32322,7 @@ client.hris.locations.retrieve(
-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).
@@ -32680,18 +32338,12 @@ 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.knowledgebase.scopes.default_scopes_retrieve() ``` @@ -32707,14 +32359,6 @@ client.hris.passthrough.create(
-**request:** `DataPassthroughRequest` - -
-
- -
-
- **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -32727,8 +32371,7 @@ client.hris.passthrough.create(
-## Hris PayGroups -
client.hris.pay_groups.list(...) +
client.knowledgebase.scopes.linked_account_scopes_retrieve()
@@ -32740,7 +32383,7 @@ client.hris.passthrough.create(
-Returns a list of `PayGroup` objects. +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).
@@ -32755,34 +32398,13 @@ Returns a list of `PayGroup` objects.
```python -import datetime - from merge import Merge client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.pay_groups.list( - created_after=datetime.datetime.fromisoformat( - "2024-01-15 09:30:00+00:00", - ), - created_before=datetime.datetime.fromisoformat( - "2024-01-15 09:30:00+00:00", - ), - cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", - include_deleted_data=True, - include_remote_data=True, - include_shell_data=True, - modified_after=datetime.datetime.fromisoformat( - "2024-01-15 09:30:00+00:00", - ), - modified_before=datetime.datetime.fromisoformat( - "2024-01-15 09:30:00+00:00", - ), - page_size=1, - remote_id="remote_id", -) +client.knowledgebase.scopes.linked_account_scopes_retrieve() ```
@@ -32798,47 +32420,99 @@ client.hris.pay_groups.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. -
+
+
client.knowledgebase.scopes.linked_account_scopes_create(...)
-**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/). - +
+
+ +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) +
+
+#### 🔌 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.knowledgebase import ( + FieldPermissionDeserializerRequest, + IndividualCommonModelScopeDeserializerRequest, + ModelPermissionDeserializerRequest, +) + +client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.knowledgebase.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, + ) + }, + ), + ], +) + +``` +
+
+#### ⚙️ 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). +
+
+ +**common_models:** `typing.Sequence[IndividualCommonModelScopeDeserializerRequest]` — The common models you want to update the scopes for
@@ -32846,35 +32520,65 @@ 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. +**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. -
+
+ +## Knowledgebase DeleteAccount +
client.knowledgebase.delete_account.delete() +
+
+ +#### 📝 Description
-**page_size:** `typing.Optional[int]` — Number of results to return per page. The maximum limit is 100. - +
+
+ +Delete a linked account.
+
+
+ +#### 🔌 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.knowledgebase.delete_account.delete() + +``` +
+
+#### ⚙️ Parameters + +
+
+
@@ -32890,7 +32594,8 @@ client.hris.pay_groups.list(
-
client.hris.pay_groups.retrieve(...) +## Knowledgebase FieldMapping +
client.knowledgebase.field_mapping.field_mappings_retrieve(...)
@@ -32902,7 +32607,7 @@ client.hris.pay_groups.list(
-Returns a `PayGroup` object with the given `id`. +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/).
@@ -32923,10 +32628,8 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.pay_groups.retrieve( - id="id", - include_remote_data=True, - include_shell_data=True, +client.knowledgebase.field_mapping.field_mappings_retrieve( + exclude_remote_field_metadata=True, ) ``` @@ -32943,23 +32646,7 @@ client.hris.pay_groups.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). +**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.
@@ -32979,8 +32666,7 @@ client.hris.pay_groups.retrieve(
-## Hris PayrollRuns -
client.hris.payroll_runs.list(...) +
client.knowledgebase.field_mapping.field_mappings_create(...)
@@ -32992,7 +32678,7 @@ client.hris.pay_groups.retrieve(
-Returns a list of `PayrollRun` 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.
@@ -33007,53 +32693,20 @@ Returns a list of `PayrollRun` objects.
```python -import datetime - from merge import Merge -from merge.resources.hris.resources.payroll_runs import ( - PayrollRunsListRequestRemoteFields, - PayrollRunsListRequestRunType, - PayrollRunsListRequestShowEnumOrigins, -) client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.payroll_runs.list( - created_after=datetime.datetime.fromisoformat( - "2024-01-15 09:30:00+00:00", - ), - created_before=datetime.datetime.fromisoformat( - "2024-01-15 09:30:00+00:00", - ), - cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", - ended_after=datetime.datetime.fromisoformat( - "2024-01-15 09:30:00+00:00", - ), - ended_before=datetime.datetime.fromisoformat( - "2024-01-15 09:30:00+00:00", - ), - include_deleted_data=True, - include_remote_data=True, - include_shell_data=True, - modified_after=datetime.datetime.fromisoformat( - "2024-01-15 09:30:00+00:00", - ), - modified_before=datetime.datetime.fromisoformat( - "2024-01-15 09:30:00+00:00", - ), - page_size=1, - remote_fields=PayrollRunsListRequestRemoteFields.RUN_STATE, - remote_id="remote_id", - run_type=PayrollRunsListRequestRunType.CORRECTION, - show_enum_origins=PayrollRunsListRequestShowEnumOrigins.RUN_STATE, - started_after=datetime.datetime.fromisoformat( - "2024-01-15 09:30:00+00:00", - ), - started_before=datetime.datetime.fromisoformat( - "2024-01-15 09:30:00+00:00", - ), +client.knowledgebase.field_mapping.field_mappings_create( + exclude_remote_field_metadata=True, + 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", ) ``` @@ -33070,7 +32723,7 @@ client.hris.payroll_runs.list(
-**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime. +**target_field_name:** `str` — The name of the target field you want this remote field to map to.
@@ -33078,7 +32731,7 @@ client.hris.payroll_runs.list(
-**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime. +**target_field_description:** `str` — The description of the target field you want this remote field to map to.
@@ -33086,7 +32739,7 @@ client.hris.payroll_runs.list(
-**cursor:** `typing.Optional[str]` — The pagination cursor value. +**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.
@@ -33094,7 +32747,7 @@ client.hris.payroll_runs.list(
-**ended_after:** `typing.Optional[dt.datetime]` — If provided, will only return payroll runs ended after this datetime. +**remote_method:** `str` — The method of the remote endpoint where the remote field is coming from.
@@ -33102,7 +32755,7 @@ client.hris.payroll_runs.list(
-**ended_before:** `typing.Optional[dt.datetime]` — If provided, will only return payroll runs ended before this datetime. +**remote_url_path:** `str` — The path of the remote endpoint where the remote field is coming from.
@@ -33110,7 +32763,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/). +**common_model_name:** `str` — The name of the Common Model that the remote field corresponds to in a given category.
@@ -33118,7 +32771,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. +**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.
@@ -33126,7 +32779,7 @@ client.hris.payroll_runs.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). +**jmes_path:** `typing.Optional[str]` — JMES path to specify json query expression to be used on field mapping.
@@ -33134,79 +32787,70 @@ client.hris.payroll_runs.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.
+
+
-
-
-**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned. -
+
+
client.knowledgebase.field_mapping.field_mappings_destroy(...)
-**page_size:** `typing.Optional[int]` — Number of results to return per page. The maximum limit is 100. - -
-
+#### 📝 Description
-**remote_fields:** `typing.Optional[PayrollRunsListRequestRemoteFields]` — Deprecated. Use show_enum_origins. - -
-
-
-**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object. - +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
-**run_type:** `typing.Optional[PayrollRunsListRequestRunType]` +
+
-If provided, will only return PayrollRun's with this status. Options: ('REGULAR', 'OFF_CYCLE', 'CORRECTION', 'TERMINATION', 'SIGN_ON_BONUS') +```python +from merge import Merge -* `REGULAR` - REGULAR -* `OFF_CYCLE` - OFF_CYCLE -* `CORRECTION` - CORRECTION -* `TERMINATION` - TERMINATION -* `SIGN_ON_BONUS` - SIGN_ON_BONUS - +client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.knowledgebase.field_mapping.field_mappings_destroy( + field_mapping_id="field_mapping_id", +) + +```
- -
-
- -**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. +**field_mapping_id:** `str`
@@ -33226,7 +32870,7 @@ If provided, will only return PayrollRun's with this status. Options: ('REGULAR'
-
client.hris.payroll_runs.retrieve(...) +
client.knowledgebase.field_mapping.field_mappings_partial_update(...)
@@ -33238,7 +32882,7 @@ If provided, will only return PayrollRun's with this status. Options: ('REGULAR'
-Returns a `PayrollRun` 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.
@@ -33254,21 +32898,13 @@ Returns a `PayrollRun` object with the given `id`. ```python from merge import Merge -from merge.resources.hris.resources.payroll_runs import ( - PayrollRunsRetrieveRequestRemoteFields, - PayrollRunsRetrieveRequestShowEnumOrigins, -) client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.payroll_runs.retrieve( - id="id", - include_remote_data=True, - include_shell_data=True, - remote_fields=PayrollRunsRetrieveRequestRemoteFields.RUN_STATE, - show_enum_origins=PayrollRunsRetrieveRequestShowEnumOrigins.RUN_STATE, +client.knowledgebase.field_mapping.field_mappings_partial_update( + field_mapping_id="field_mapping_id", ) ``` @@ -33285,7 +32921,7 @@ client.hris.payroll_runs.retrieve(
-**id:** `str` +**field_mapping_id:** `str`
@@ -33293,7 +32929,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. +**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.
@@ -33301,7 +32937,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). +**remote_method:** `typing.Optional[str]` — The method of the remote endpoint where the remote field is coming from.
@@ -33309,7 +32945,7 @@ client.hris.payroll_runs.retrieve(
-**remote_fields:** `typing.Optional[PayrollRunsRetrieveRequestRemoteFields]` — Deprecated. Use show_enum_origins. +**remote_url_path:** `typing.Optional[str]` — The path of the remote endpoint where the remote field is coming from.
@@ -33317,7 +32953,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) +**jmes_path:** `typing.Optional[str]` — JMES path to specify json query expression to be used on field mapping.
@@ -33337,8 +32973,7 @@ client.hris.payroll_runs.retrieve(
-## Hris RegenerateKey -
client.hris.regenerate_key.create(...) +
client.knowledgebase.field_mapping.remote_fields_retrieve(...)
@@ -33350,7 +32985,7 @@ client.hris.payroll_runs.retrieve(
-Exchange remote keys. +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/).
@@ -33371,8 +33006,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.regenerate_key.create( - name="Remote Deployment Key 1", +client.knowledgebase.field_mapping.remote_fields_retrieve( + common_models="common_models", + include_example_values="include_example_values", ) ``` @@ -33389,7 +33025,15 @@ client.hris.regenerate_key.create(
-**name:** `str` — The name of the remote key +**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.
@@ -33409,8 +33053,7 @@ client.hris.regenerate_key.create(
-## Hris SyncStatus -
client.hris.sync_status.list(...) +
client.knowledgebase.field_mapping.target_fields_retrieve()
@@ -33422,7 +33065,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). +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/).
@@ -33443,10 +33086,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.sync_status.list( - cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", - page_size=1, -) +client.knowledgebase.field_mapping.target_fields_retrieve() ``` @@ -33462,22 +33102,6 @@ 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. The maximum limit is 100. - -
-
- -
-
- **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -33490,8 +33114,8 @@ client.hris.sync_status.list(
-## Hris ForceResync -
client.hris.force_resync.sync_status_resync_create() +## Knowledgebase GenerateKey +
client.knowledgebase.generate_key.create(...)
@@ -33503,7 +33127,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. +Create a remote key.
@@ -33524,7 +33148,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.force_resync.sync_status_resync_create() +client.knowledgebase.generate_key.create( + name="Remote Deployment Key 1", +) ``` @@ -33540,6 +33166,14 @@ client.hris.force_resync.sync_status_resync_create()
+**name:** `str` — The name of the remote key + +
+
+ +
+
+ **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -33552,8 +33186,8 @@ client.hris.force_resync.sync_status_resync_create()
-## Hris Teams -
client.hris.teams.list(...) +## Knowledgebase Groups +
client.knowledgebase.groups.list(...)
@@ -33565,7 +33199,7 @@ client.hris.force_resync.sync_status_resync_create()
-Returns a list of `Team` objects. +Returns a list of `Group` objects.
@@ -33583,12 +33217,15 @@ Returns a list of `Team` objects. import datetime from merge import Merge +from merge.resources.knowledgebase.resources.groups import ( + GroupsListRequestExpand, +) client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.teams.list( +client.knowledgebase.groups.list( created_after=datetime.datetime.fromisoformat( "2024-01-15 09:30:00+00:00", ), @@ -33596,6 +33233,7 @@ client.hris.teams.list( "2024-01-15 09:30:00+00:00", ), cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + expand=GroupsListRequestExpand.PARENT_GROUP, include_deleted_data=True, include_remote_data=True, include_shell_data=True, @@ -33606,7 +33244,6 @@ client.hris.teams.list( "2024-01-15 09:30:00+00:00", ), page_size=1, - parent_team_id="parent_team_id", remote_id="remote_id", ) @@ -33648,7 +33285,7 @@ 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. +**expand:** `typing.Optional[GroupsListRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -33704,14 +33341,6 @@ client.hris.teams.list(
-**parent_team_id:** `typing.Optional[str]` — If provided, will only return teams with this parent team. - -
-
- -
-
- **remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
@@ -33732,7 +33361,7 @@ client.hris.teams.list(
-
client.hris.teams.retrieve(...) +
client.knowledgebase.groups.retrieve(...)
@@ -33744,7 +33373,7 @@ client.hris.teams.list(
-Returns a `Team` object with the given `id`. +Returns a `Group` object with the given `id`.
@@ -33760,13 +33389,17 @@ Returns a `Team` object with the given `id`. ```python from merge import Merge +from merge.resources.knowledgebase.resources.groups import ( + GroupsRetrieveRequestExpand, +) client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.teams.retrieve( +client.knowledgebase.groups.retrieve( id="id", + expand=GroupsRetrieveRequestExpand.PARENT_GROUP, include_remote_data=True, include_shell_data=True, ) @@ -33793,7 +33426,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. +**expand:** `typing.Optional[GroupsRetrieveRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -33829,8 +33462,8 @@ client.hris.teams.retrieve(
-## Hris TimeOff -
client.hris.time_off.list(...) +## Knowledgebase Issues +
client.knowledgebase.issues.list(...)
@@ -33842,7 +33475,7 @@ client.hris.teams.retrieve(
-Returns a list of `TimeOff` objects. +Gets all issues for Organization.
@@ -33860,56 +33493,37 @@ Returns a list of `TimeOff` objects. import datetime from merge import Merge -from merge.resources.hris.resources.time_off import ( - TimeOffListRequestExpand, - TimeOffListRequestRemoteFields, - TimeOffListRequestRequestType, - TimeOffListRequestShowEnumOrigins, - TimeOffListRequestStatus, +from merge.resources.knowledgebase.resources.issues import ( + IssuesListRequestStatus, ) client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.time_off.list( - approver_id="approver_id", - created_after=datetime.datetime.fromisoformat( - "2024-01-15 09:30:00+00:00", - ), - created_before=datetime.datetime.fromisoformat( - "2024-01-15 09:30:00+00:00", - ), +client.knowledgebase.issues.list( + account_token="account_token", cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", - employee_id="employee_id", - ended_after=datetime.datetime.fromisoformat( + end_date="end_date", + end_user_organization_name="end_user_organization_name", + first_incident_time_after=datetime.datetime.fromisoformat( "2024-01-15 09:30:00+00:00", ), - ended_before=datetime.datetime.fromisoformat( + first_incident_time_before=datetime.datetime.fromisoformat( "2024-01-15 09:30:00+00:00", ), - expand=TimeOffListRequestExpand.APPROVER, - include_deleted_data=True, - include_remote_data=True, - include_shell_data=True, - modified_after=datetime.datetime.fromisoformat( + include_muted="include_muted", + integration_name="integration_name", + last_incident_time_after=datetime.datetime.fromisoformat( "2024-01-15 09:30:00+00:00", ), - modified_before=datetime.datetime.fromisoformat( + last_incident_time_before=datetime.datetime.fromisoformat( "2024-01-15 09:30:00+00:00", ), + linked_account_id="linked_account_id", page_size=1, - remote_fields=TimeOffListRequestRemoteFields.REQUEST_TYPE, - remote_id="remote_id", - request_type=TimeOffListRequestRequestType.BEREAVEMENT, - show_enum_origins=TimeOffListRequestShowEnumOrigins.REQUEST_TYPE, - started_after=datetime.datetime.fromisoformat( - "2024-01-15 09:30:00+00:00", - ), - started_before=datetime.datetime.fromisoformat( - "2024-01-15 09:30:00+00:00", - ), - status=TimeOffListRequestStatus.APPROVED, + start_date="start_date", + status=IssuesListRequestStatus.ONGOING, ) ``` @@ -33926,7 +33540,7 @@ client.hris.time_off.list(
-**approver_id:** `typing.Optional[str]` — If provided, will only return time off for this approver. +**account_token:** `typing.Optional[str]`
@@ -33934,7 +33548,7 @@ client.hris.time_off.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.
@@ -33942,7 +33556,7 @@ client.hris.time_off.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
@@ -33950,7 +33564,7 @@ client.hris.time_off.list(
-**cursor:** `typing.Optional[str]` — The pagination cursor value. +**end_user_organization_name:** `typing.Optional[str]`
@@ -33958,7 +33572,7 @@ client.hris.time_off.list(
-**employee_id:** `typing.Optional[str]` — If provided, will only return time off for this employee. +**first_incident_time_after:** `typing.Optional[dt.datetime]` — If provided, will only return issues whose first incident time was after this datetime.
@@ -33966,7 +33580,7 @@ client.hris.time_off.list(
-**ended_after:** `typing.Optional[dt.datetime]` — If provided, will only return employees that ended 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.
@@ -33974,7 +33588,7 @@ client.hris.time_off.list(
-**ended_before:** `typing.Optional[dt.datetime]` — If provided, will only return time-offs that ended before this datetime. +**include_muted:** `typing.Optional[str]` — If true, will include muted issues
@@ -33982,7 +33596,7 @@ client.hris.time_off.list(
-**expand:** `typing.Optional[TimeOffListRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. +**integration_name:** `typing.Optional[str]`
@@ -33990,7 +33604,7 @@ client.hris.time_off.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/). +**last_incident_time_after:** `typing.Optional[dt.datetime]` — If provided, will only return issues whose last incident time was after this datetime.
@@ -33998,7 +33612,7 @@ client.hris.time_off.list(
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. +**last_incident_time_before:** `typing.Optional[dt.datetime]` — If provided, will only return issues whose last incident time was before this datetime.
@@ -34006,7 +33620,7 @@ client.hris.time_off.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). +**linked_account_id:** `typing.Optional[str]` — If provided, will only include issues pertaining to the linked account passed in.
@@ -34014,7 +33628,7 @@ client.hris.time_off.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. The maximum limit is 100.
@@ -34022,7 +33636,7 @@ client.hris.time_off.list(
-**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned. +**start_date:** `typing.Optional[str]` — If included, will only include issues whose most recent action occurred after this time
@@ -34030,7 +33644,12 @@ client.hris.time_off.list(
-**page_size:** `typing.Optional[int]` — Number of results to return per page. The maximum limit is 100. +**status:** `typing.Optional[IssuesListRequestStatus]` + +Status of the issue. Options: ('ONGOING', 'RESOLVED') + +* `ONGOING` - ONGOING +* `RESOLVED` - RESOLVED
@@ -34038,32 +33657,70 @@ client.hris.time_off.list(
-**remote_fields:** `typing.Optional[TimeOffListRequestRemoteFields]` — Deprecated. Use show_enum_origins. +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+ +
+ + + + +
+
client.knowledgebase.issues.retrieve(...)
-**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object. - +#### 📝 Description + +
+
+ +
+
+ +Get a specific issue. +
+
+#### 🔌 Usage +
-**request_type:** `typing.Optional[TimeOffListRequestRequestType]` +
+
-If provided, will only return TimeOff with this request type. Options: ('VACATION', 'SICK', 'PERSONAL', 'JURY_DUTY', 'VOLUNTEER', 'BEREAVEMENT') +```python +from merge import Merge -* `VACATION` - VACATION -* `SICK` - SICK -* `PERSONAL` - PERSONAL -* `JURY_DUTY` - JURY_DUTY -* `VOLUNTEER` - VOLUNTEER -* `BEREAVEMENT` - BEREAVEMENT +client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.knowledgebase.issues.retrieve( + id="id", +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**id:** `str`
@@ -34071,15 +33728,75 @@ If provided, will only return TimeOff with this request type. Options: ('VACATIO
-**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) +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+ + +
+
+
+## Knowledgebase LinkToken +
client.knowledgebase.link_token.create(...)
-**started_after:** `typing.Optional[dt.datetime]` — If provided, will only return time-offs that started after this datetime. +#### 📝 Description + +
+
+ +
+
+ +Creates a link token to be used when linking a new end user. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from merge import Merge +from merge.resources.knowledgebase import CategoriesEnum + +client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.knowledgebase.link_token.create( + end_user_email_address="example@gmail.com", + end_user_organization_name="Test Organization", + end_user_origin_id="12345", + categories=[CategoriesEnum.HRIS, CategoriesEnum.ATS], +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**end_user_email_address:** `str` — Your end user's email address. This is purely for identification purposes - setting this value will not cause any emails to be sent.
@@ -34087,7 +33804,7 @@ 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. +**end_user_organization_name:** `str` — Your end user's organization.
@@ -34095,15 +33812,15 @@ If provided, will only return TimeOff with this request type. Options: ('VACATIO
-**status:** `typing.Optional[TimeOffListRequestStatus]` +**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. + +
+
-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 +**categories:** `typing.Sequence[CategoriesEnum]` — The integration categories to show in Merge Link.
@@ -34111,73 +33828,75 @@ If provided, will only return TimeOff with this status. Options: ('REQUESTED', '
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. +**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. +
-
-
client.hris.time_off.create(...)
-#### 📝 Description +**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. + +
+
+**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. + +
+
+
-Creates a `TimeOff` object with the given values. -
-
+**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. + -#### 🔌 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. + +
+
+
-```python -from merge import Merge -from merge.resources.hris import TimeOffRequest +**language:** `typing.Optional[EndUserDetailsRequestLanguage]` -client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.hris.time_off.create( - is_debug_mode=True, - run_async=True, - model=TimeOffRequest(), -) +The following subset of IETF language tags can be used to configure localization. -``` -
-
+* `en` - en +* `de` - de + -#### ⚙️ Parameters - -
-
-
-**model:** `TimeOffRequest` +**are_syncs_disabled:** `typing.Optional[bool]` — The boolean that indicates whether initial, periodic, and force syncs will be disabled.
@@ -34185,7 +33904,7 @@ client.hris.time_off.create(
-**is_debug_mode:** `typing.Optional[bool]` — Whether to include debug fields (such as log file links) in the response. +**integration_specific_config:** `typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]]` — A JSON object containing integration-specific configuration options.
@@ -34193,7 +33912,11 @@ client.hris.time_off.create(
-**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously. +**completed_account_initial_screen:** `typing.Optional[EndUserDetailsRequestCompletedAccountInitialScreen]` + +When creating a Link token, you can specifiy the initial screen of Linking Flow for a completed Linked Account. + +* `SELECTIVE_SYNC` - SELECTIVE_SYNC
@@ -34213,7 +33936,8 @@ client.hris.time_off.create(
-
client.hris.time_off.retrieve(...) +## Knowledgebase LinkedAccounts +
client.knowledgebase.linked_accounts.list(...)
@@ -34225,7 +33949,7 @@ client.hris.time_off.create(
-Returns a `TimeOff` object with the given `id`. +List linked accounts for your organization.
@@ -34241,23 +33965,28 @@ Returns a `TimeOff` object with the given `id`. ```python from merge import Merge -from merge.resources.hris.resources.time_off import ( - TimeOffRetrieveRequestExpand, - TimeOffRetrieveRequestRemoteFields, - TimeOffRetrieveRequestShowEnumOrigins, +from merge.resources.knowledgebase.resources.linked_accounts import ( + LinkedAccountsListRequestCategory, ) client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.time_off.retrieve( +client.knowledgebase.linked_accounts.list( + category=LinkedAccountsListRequestCategory.ACCOUNTING, + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + end_user_email_address="end_user_email_address", + end_user_organization_name="end_user_organization_name", + end_user_origin_id="end_user_origin_id", + end_user_origin_ids="end_user_origin_ids", id="id", - expand=TimeOffRetrieveRequestExpand.APPROVER, - include_remote_data=True, - include_shell_data=True, - remote_fields=TimeOffRetrieveRequestRemoteFields.REQUEST_TYPE, - show_enum_origins=TimeOffRetrieveRequestShowEnumOrigins.REQUEST_TYPE, + ids="ids", + include_duplicates=True, + integration_name="integration_name", + is_test_account="is_test_account", + page_size=1, + status="status", ) ``` @@ -34274,7 +34003,18 @@ client.hris.time_off.retrieve(
-**id:** `str` +**category:** `typing.Optional[LinkedAccountsListRequestCategory]` + +Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `knowledgebase`, `mktg`, `ticketing` + +* `hris` - hris +* `ats` - ats +* `accounting` - accounting +* `ticketing` - ticketing +* `crm` - crm +* `mktg` - mktg +* `filestorage` - filestorage +* `knowledgebase` - knowledgebase
@@ -34282,7 +34022,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. +**cursor:** `typing.Optional[str]` — The pagination cursor value.
@@ -34290,7 +34030,7 @@ client.hris.time_off.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.
@@ -34298,7 +34038,7 @@ client.hris.time_off.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.
@@ -34306,7 +34046,7 @@ client.hris.time_off.retrieve(
-**remote_fields:** `typing.Optional[TimeOffRetrieveRequestRemoteFields]` — 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.
@@ -34314,7 +34054,7 @@ 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) +**end_user_origin_ids:** `typing.Optional[str]` — Comma-separated list of EndUser origin IDs, making it possible to specify multiple EndUsers at once.
@@ -34322,64 +34062,59 @@ client.hris.time_off.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. +
-
-
client.hris.time_off.meta_post_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. + +
+
-Returns metadata for `TimeOff` POSTs. -
-
+**integration_name:** `typing.Optional[str]` — If provided, will only return linked accounts associated with the given integration name. +
-#### 🔌 Usage -
+**is_test_account:** `typing.Optional[str]` — If included, will only include test linked accounts. If not included, will only include non-test linked accounts. + +
+
+
-```python -from merge import Merge - -client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.hris.time_off.meta_post_retrieve() - -``` -
-
+**page_size:** `typing.Optional[int]` — Number of results to return per page. The maximum limit is 100. + -#### ⚙️ Parameters -
+**status:** `typing.Optional[str]` — Filter by status. Options: `COMPLETE`, `IDLE`, `INCOMPLETE`, `RELINK_NEEDED` + +
+
+
@@ -34395,8 +34130,8 @@ client.hris.time_off.meta_post_retrieve()
-## Hris TimeOffBalances -
client.hris.time_off_balances.list(...) +## Knowledgebase Passthrough +
client.knowledgebase.passthrough.create(...)
@@ -34408,7 +34143,7 @@ client.hris.time_off.meta_post_retrieve()
-Returns a list of `TimeOffBalance` objects. +Pull data from an endpoint not currently supported by Merge.
@@ -34423,38 +34158,18 @@ Returns a list of `TimeOffBalance` objects.
```python -import datetime - from merge import Merge -from merge.resources.hris.resources.time_off_balances import ( - TimeOffBalancesListRequestPolicyType, -) +from merge.resources.knowledgebase import DataPassthroughRequest, MethodEnum client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.time_off_balances.list( - created_after=datetime.datetime.fromisoformat( - "2024-01-15 09:30:00+00:00", - ), - created_before=datetime.datetime.fromisoformat( - "2024-01-15 09:30:00+00:00", - ), - cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", - employee_id="employee_id", - include_deleted_data=True, - include_remote_data=True, - include_shell_data=True, - modified_after=datetime.datetime.fromisoformat( - "2024-01-15 09:30:00+00:00", - ), - modified_before=datetime.datetime.fromisoformat( - "2024-01-15 09:30:00+00:00", +client.knowledgebase.passthrough.create( + request=DataPassthroughRequest( + method=MethodEnum.GET, + path="/scooters", ), - page_size=1, - policy_type=TimeOffBalancesListRequestPolicyType.BEREAVEMENT, - remote_id="remote_id", ) ``` @@ -34466,52 +34181,12 @@ client.hris.time_off_balances.list( #### ⚙️ Parameters
-
- -
-
- -**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime. - -
-
- -
-
- -**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime. - -
-
- -
-
- -**cursor:** `typing.Optional[str]` — The pagination cursor value. - -
-
- -
-
- -**employee_id:** `typing.Optional[str]` — If provided, will only return time off balances for this employee. - -
-
- -
-
- -**expand:** `typing.Optional[typing.Literal["employee"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. - -
-
+
-**include_deleted_data:** `typing.Optional[bool]` — 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:** `DataPassthroughRequest`
@@ -34519,80 +34194,71 @@ client.hris.time_off_balances.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_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). -
+
+## Knowledgebase RegenerateKey +
client.knowledgebase.regenerate_key.create(...)
-**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned. - -
-
+#### 📝 Description
-**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. The maximum limit is 100. - +Exchange remote keys. +
+
+#### 🔌 Usage +
-**policy_type:** `typing.Optional[TimeOffBalancesListRequestPolicyType]` +
+
-If provided, will only return TimeOffBalance with this policy type. Options: ('VACATION', 'SICK', 'PERSONAL', 'JURY_DUTY', 'VOLUNTEER', 'BEREAVEMENT') +```python +from merge import Merge -* `VACATION` - VACATION -* `SICK` - SICK -* `PERSONAL` - PERSONAL -* `JURY_DUTY` - JURY_DUTY -* `VOLUNTEER` - VOLUNTEER -* `BEREAVEMENT` - BEREAVEMENT - +client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.knowledgebase.regenerate_key.create( + name="Remote Deployment Key 1", +) + +```
- -
-
- -**remote_fields:** `typing.Optional[typing.Literal["policy_type"]]` — 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[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) +**name:** `str` — The name of the remote key
@@ -34612,7 +34278,8 @@ If provided, will only return TimeOffBalance with this policy type. Options: ('V
-
client.hris.time_off_balances.retrieve(...) +## Knowledgebase SyncStatus +
client.knowledgebase.sync_status.list(...)
@@ -34624,7 +34291,7 @@ If provided, will only return TimeOffBalance with this policy type. Options: ('V
-Returns a `TimeOffBalance` 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).
@@ -34645,10 +34312,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.time_off_balances.retrieve( - id="id", - include_remote_data=True, - include_shell_data=True, +client.knowledgebase.sync_status.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + page_size=1, ) ``` @@ -34665,7 +34331,7 @@ client.hris.time_off_balances.retrieve(
-**id:** `str` +**cursor:** `typing.Optional[str]` — The pagination cursor value.
@@ -34673,7 +34339,7 @@ client.hris.time_off_balances.retrieve(
-**expand:** `typing.Optional[typing.Literal["employee"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. +**page_size:** `typing.Optional[int]` — Number of results to return per page. The maximum limit is 100.
@@ -34681,35 +34347,65 @@ client.hris.time_off_balances.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.
+ +
-
-
-**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). -
+
+## Knowledgebase ForceResync +
client.knowledgebase.force_resync.sync_status_resync_create()
-**remote_fields:** `typing.Optional[typing.Literal["policy_type"]]` — Deprecated. Use show_enum_origins. - +#### 📝 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 +
-**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) - +
+
+ +```python +from merge import Merge + +client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.knowledgebase.force_resync.sync_status_resync_create() + +``` +
+
+#### ⚙️ Parameters + +
+
+
@@ -34725,8 +34421,8 @@ client.hris.time_off_balances.retrieve(
-## Hris TimesheetEntries -
client.hris.timesheet_entries.list(...) +## Knowledgebase Users +
client.knowledgebase.users.list(...)
@@ -34738,7 +34434,7 @@ client.hris.time_off_balances.retrieve(
-Returns a list of `TimesheetEntry` objects. +Returns a list of `User` objects.
@@ -34756,15 +34452,12 @@ Returns a list of `TimesheetEntry` objects. import datetime from merge import Merge -from merge.resources.hris.resources.timesheet_entries import ( - TimesheetEntriesListRequestOrderBy, -) client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.timesheet_entries.list( +client.knowledgebase.users.list( created_after=datetime.datetime.fromisoformat( "2024-01-15 09:30:00+00:00", ), @@ -34772,13 +34465,6 @@ client.hris.timesheet_entries.list( "2024-01-15 09:30:00+00:00", ), cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", - employee_id="employee_id", - ended_after=datetime.datetime.fromisoformat( - "2024-01-15 09:30:00+00:00", - ), - ended_before=datetime.datetime.fromisoformat( - "2024-01-15 09:30:00+00:00", - ), include_deleted_data=True, include_remote_data=True, include_shell_data=True, @@ -34788,15 +34474,8 @@ client.hris.timesheet_entries.list( modified_before=datetime.datetime.fromisoformat( "2024-01-15 09:30:00+00:00", ), - order_by=TimesheetEntriesListRequestOrderBy.START_TIME_DESCENDING, page_size=1, remote_id="remote_id", - started_after=datetime.datetime.fromisoformat( - "2024-01-15 09:30:00+00:00", - ), - started_before=datetime.datetime.fromisoformat( - "2024-01-15 09:30:00+00:00", - ), ) ``` @@ -34837,7 +34516,7 @@ client.hris.timesheet_entries.list(
-**employee_id:** `typing.Optional[str]` — If provided, will only return timesheet entries 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/).
@@ -34845,7 +34524,7 @@ client.hris.timesheet_entries.list(
-**ended_after:** `typing.Optional[dt.datetime]` — If provided, will only return timesheet entries ended 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.
@@ -34853,7 +34532,7 @@ client.hris.timesheet_entries.list(
-**ended_before:** `typing.Optional[dt.datetime]` — If provided, will only return timesheet entries ended 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).
@@ -34861,7 +34540,7 @@ 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. +**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
@@ -34869,7 +34548,96 @@ client.hris.timesheet_entries.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. + +
+
+ +
+
+ +**page_size:** `typing.Optional[int]` — Number of results to return per page. The maximum limit is 100. + +
+
+ +
+
+ +**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object. + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+ +
+ + + + +
+ +
client.knowledgebase.users.retrieve(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Returns a `User` object with the given `id`. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from merge import Merge + +client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.knowledgebase.users.retrieve( + id="id", + include_remote_data=True, + include_shell_data=True, +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**id:** `str`
@@ -34893,59 +34661,65 @@ client.hris.timesheet_entries.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.
+
+
-
-
-**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned. -
+
+## Knowledgebase WebhookReceivers +
client.knowledgebase.webhook_receivers.list()
-**order_by:** `typing.Optional[TimesheetEntriesListRequestOrderBy]` — Overrides the default ordering for this endpoint. Possible values include: start_time, -start_time. - -
-
+#### 📝 Description
-**page_size:** `typing.Optional[int]` — Number of results to return per page. The maximum limit is 100. - -
-
-
-**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object. - +Returns a list of `WebhookReceiver` objects.
+ + + +#### 🔌 Usage
-**started_after:** `typing.Optional[dt.datetime]` — If provided, will only return timesheet entries started after this datetime. - -
-
-
-**started_before:** `typing.Optional[dt.datetime]` — If provided, will only return timesheet entries started before this datetime. - +```python +from merge import Merge + +client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.knowledgebase.webhook_receivers.list() + +``` +
+
+#### ⚙️ Parameters + +
+
+
@@ -34961,7 +34735,7 @@ client.hris.timesheet_entries.list(
-
client.hris.timesheet_entries.create(...) +
client.knowledgebase.webhook_receivers.create(...)
@@ -34973,7 +34747,7 @@ client.hris.timesheet_entries.list(
-Creates a `TimesheetEntry` object with the given values. +Creates a `WebhookReceiver` object with the given values.
@@ -34989,16 +34763,14 @@ 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( - is_debug_mode=True, - run_async=True, - model=TimesheetEntryRequest(), +client.knowledgebase.webhook_receivers.create( + event="event", + is_active=True, ) ``` @@ -35015,7 +34787,7 @@ client.hris.timesheet_entries.create(
-**model:** `TimesheetEntryRequest` +**event:** `str`
@@ -35023,7 +34795,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. +**is_active:** `bool`
@@ -35031,7 +34803,7 @@ client.hris.timesheet_entries.create(
-**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously. +**key:** `typing.Optional[str]`
@@ -35051,7 +34823,8 @@ client.hris.timesheet_entries.create(
-
client.hris.timesheet_entries.retrieve(...) +## Ticketing AccountDetails +
client.ticketing.account_details.retrieve()
@@ -35063,7 +34836,7 @@ client.hris.timesheet_entries.create(
-Returns a `TimesheetEntry` object with the given `id`. +Get details for a linked account.
@@ -35084,11 +34857,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.timesheet_entries.retrieve( - id="id", - include_remote_data=True, - include_shell_data=True, -) +client.ticketing.account_details.retrieve() ``` @@ -35104,31 +34873,71 @@ client.hris.timesheet_entries.retrieve(
-**id:** `str` +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+ +
+ + + + +
+## Ticketing AccountToken +
client.ticketing.account_token.retrieve(...)
-**expand:** `typing.Optional[typing.Literal["employee"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. - +#### 📝 Description + +
+
+ +
+
+ +Returns the account token for the end user with the provided public token. +
+
+#### 🔌 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.ticketing.account_token.retrieve( + public_token="public_token", +) + +```
+
+
+ +#### ⚙️ 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). +
+
+ +**public_token:** `str`
@@ -35148,7 +34957,8 @@ client.hris.timesheet_entries.retrieve(
-
client.hris.timesheet_entries.meta_post_retrieve() +## Ticketing Accounts +
client.ticketing.accounts.list(...)
@@ -35160,7 +34970,7 @@ client.hris.timesheet_entries.retrieve(
-Returns metadata for `TimesheetEntry` POSTs. +Returns a list of `Account` objects.
@@ -35175,13 +34985,34 @@ Returns metadata for `TimesheetEntry` POSTs.
```python +import datetime + from merge import Merge client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.timesheet_entries.meta_post_retrieve() +client.ticketing.accounts.list( + created_after=datetime.datetime.fromisoformat( + "2024-01-15 09:30:00+00:00", + ), + created_before=datetime.datetime.fromisoformat( + "2024-01-15 09:30:00+00:00", + ), + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + include_deleted_data=True, + include_remote_data=True, + include_shell_data=True, + modified_after=datetime.datetime.fromisoformat( + "2024-01-15 09:30:00+00:00", + ), + modified_before=datetime.datetime.fromisoformat( + "2024-01-15 09:30:00+00:00", + ), + page_size=1, + remote_id="remote_id", +) ```
@@ -35197,65 +35028,83 @@ client.hris.timesheet_entries.meta_post_retrieve()
-**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. +
-
-## Hris WebhookReceivers -
client.hris.webhook_receivers.list()
-#### 📝 Description +**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/). + +
+
+
-Returns a list of `WebhookReceiver` objects. -
-
+**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.hris.webhook_receivers.list() +
+
-``` +**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. + +
+
+
@@ -35271,7 +35120,7 @@ client.hris.webhook_receivers.list()
-
client.hris.webhook_receivers.create(...) +
client.ticketing.accounts.retrieve(...)
@@ -35283,7 +35132,7 @@ client.hris.webhook_receivers.list()
-Creates a `WebhookReceiver` object with the given values. +Returns an `Account` object with the given `id`.
@@ -35304,9 +35153,10 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.webhook_receivers.create( - event="event", - is_active=True, +client.ticketing.accounts.retrieve( + id="id", + include_remote_data=True, + include_shell_data=True, ) ``` @@ -35323,7 +35173,7 @@ client.hris.webhook_receivers.create(
-**event:** `str` +**id:** `str`
@@ -35331,7 +35181,7 @@ client.hris.webhook_receivers.create(
-**is_active:** `bool` +**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -35339,7 +35189,7 @@ client.hris.webhook_receivers.create(
-**key:** `typing.Optional[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).
@@ -35359,8 +35209,8 @@ client.hris.webhook_receivers.create(
-## Knowledgebase AccountDetails -
client.knowledgebase.account_details.retrieve() +## Ticketing AsyncPassthrough +
client.ticketing.async_passthrough.create(...)
@@ -35372,7 +35222,7 @@ client.hris.webhook_receivers.create(
-Get details for a linked account. +Asynchronously pull data from an endpoint not currently supported by Merge.
@@ -35388,12 +35238,18 @@ Get details for a linked account. ```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.knowledgebase.account_details.retrieve() +client.ticketing.async_passthrough.create( + request=DataPassthroughRequest( + method=MethodEnum.GET, + path="/scooters", + ), +) ``` @@ -35409,6 +35265,14 @@ client.knowledgebase.account_details.retrieve()
+**request:** `DataPassthroughRequest` + +
+
+ +
+
+ **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -35421,8 +35285,7 @@ client.knowledgebase.account_details.retrieve()
-## Knowledgebase AccountToken -
client.knowledgebase.account_token.retrieve(...) +
client.ticketing.async_passthrough.retrieve(...)
@@ -35434,7 +35297,7 @@ client.knowledgebase.account_details.retrieve()
-Returns the account token for the end user with the provided public token. +Retrieves data from earlier async-passthrough POST request
@@ -35455,8 +35318,8 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.knowledgebase.account_token.retrieve( - public_token="public_token", +client.ticketing.async_passthrough.retrieve( + async_passthrough_receipt_id="async_passthrough_receipt_id", ) ``` @@ -35473,7 +35336,7 @@ client.knowledgebase.account_token.retrieve(
-**public_token:** `str` +**async_passthrough_receipt_id:** `str`
@@ -35493,8 +35356,8 @@ client.knowledgebase.account_token.retrieve(
-## Knowledgebase Articles -
client.knowledgebase.articles.list(...) +## Ticketing Attachments +
client.ticketing.attachments.list(...)
@@ -35506,7 +35369,7 @@ client.knowledgebase.account_token.retrieve(
-Returns a list of `Article` objects. +Returns a list of `Attachment` objects.
@@ -35524,16 +35387,12 @@ Returns a list of `Article` objects. import datetime from merge import Merge -from merge.resources.knowledgebase.resources.articles import ( - ArticlesListRequestExpand, - ArticlesListRequestType, -) client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.knowledgebase.articles.list( +client.ticketing.attachments.list( created_after=datetime.datetime.fromisoformat( "2024-01-15 09:30:00+00:00", ), @@ -35541,7 +35400,6 @@ client.knowledgebase.articles.list( "2024-01-15 09:30:00+00:00", ), cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", - expand=ArticlesListRequestExpand.ATTACHMENTS, include_deleted_data=True, include_remote_data=True, include_shell_data=True, @@ -35552,12 +35410,11 @@ client.knowledgebase.articles.list( "2024-01-15 09:30:00+00:00", ), page_size=1, - parent_article_id="parent_article_id", - parent_container_id="parent_container_id", + remote_created_after=datetime.datetime.fromisoformat( + "2024-01-15 09:30:00+00:00", + ), remote_id="remote_id", - root_container_id="root_container_id", - status="status", - type=ArticlesListRequestType.EMPTY, + ticket_id="ticket_id", ) ``` @@ -35598,7 +35455,7 @@ client.knowledgebase.articles.list(
-**expand:** `typing.Optional[ArticlesListRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. +**expand:** `typing.Optional[typing.Literal["ticket"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -35654,7 +35511,7 @@ client.knowledgebase.articles.list(
-**parent_article_id:** `typing.Optional[str]` — If provided, will only return sub articles of the parent_article_id. +**remote_created_after:** `typing.Optional[dt.datetime]` — If provided, will only return attachments created in the third party platform after this datetime.
@@ -35662,7 +35519,7 @@ client.knowledgebase.articles.list(
-**parent_container_id:** `typing.Optional[str]` — If provided, will only return sub articles of the parent_container_id. +**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
@@ -35670,7 +35527,7 @@ client.knowledgebase.articles.list(
-**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object. +**ticket_id:** `typing.Optional[str]` — If provided, will only return comments for this ticket.
@@ -35678,15 +35535,73 @@ client.knowledgebase.articles.list(
-**root_container_id:** `typing.Optional[str]` — If provided, will only return sub articles of the root_container_id. +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+ +
+ + + + +
+
client.ticketing.attachments.create(...)
-**status:** `typing.Optional[str]` — If provided, will only return articles of the given status; multiple statuses can be separated by commas. +#### 📝 Description + +
+
+ +
+
+ +Creates an `Attachment` object with the given values. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```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( + is_debug_mode=True, + run_async=True, + model=AttachmentRequest(), +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**model:** `AttachmentRequest`
@@ -35694,7 +35609,15 @@ client.knowledgebase.articles.list(
-**type:** `typing.Optional[ArticlesListRequestType]` — If provided, will only return articles of the given type. +**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.
@@ -35714,7 +35637,7 @@ client.knowledgebase.articles.list(
-
client.knowledgebase.articles.retrieve(...) +
client.ticketing.attachments.retrieve(...)
@@ -35726,7 +35649,7 @@ client.knowledgebase.articles.list(
-Returns an `Article` object with the given `id`. +Returns an `Attachment` object with the given `id`.
@@ -35742,17 +35665,13 @@ Returns an `Article` object with the given `id`. ```python from merge import Merge -from merge.resources.knowledgebase.resources.articles import ( - ArticlesRetrieveRequestExpand, -) client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.knowledgebase.articles.retrieve( +client.ticketing.attachments.retrieve( id="id", - expand=ArticlesRetrieveRequestExpand.ATTACHMENTS, include_remote_data=True, include_shell_data=True, ) @@ -35779,7 +35698,7 @@ client.knowledgebase.articles.retrieve(
-**expand:** `typing.Optional[ArticlesRetrieveRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. +**expand:** `typing.Optional[typing.Literal["ticket"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -35815,8 +35734,69 @@ client.knowledgebase.articles.retrieve(
-## Knowledgebase AsyncPassthrough -
client.knowledgebase.async_passthrough.create(...) +
client.ticketing.attachments.meta_post_retrieve() +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Returns metadata for `TicketingAttachment` POSTs. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from merge import Merge + +client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.ticketing.attachments.meta_post_retrieve() + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +## Ticketing AuditTrail +
client.ticketing.audit_trail.list(...)
@@ -35828,50 +35808,91 @@ client.knowledgebase.articles.retrieve(
-Asynchronously pull data from an endpoint not currently supported by Merge. -
-
+Gets a list of audit trail events. +
+
+ + + +#### 🔌 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", + end_date="end_date", + event_type="event_type", + page_size=1, + start_date="start_date", + user_email="user_email", +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**cursor:** `typing.Optional[str]` — The pagination cursor value. + +
+
+ +
+
+ +**end_date:** `typing.Optional[str]` — If included, will only include audit trail events that occurred before this time + +
+
+ +
+
+ +**event_type:** `typing.Optional[str]` — If included, will only include events with the given event type. Possible values include: `CREATED_REMOTE_PRODUCTION_API_KEY`, `DELETED_REMOTE_PRODUCTION_API_KEY`, `CREATED_TEST_API_KEY`, `DELETED_TEST_API_KEY`, `REGENERATED_PRODUCTION_API_KEY`, `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` +
-#### 🔌 Usage - -
-
-
-```python -from merge import Merge -from merge.resources.knowledgebase import DataPassthroughRequest, MethodEnum - -client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.knowledgebase.async_passthrough.create( - request=DataPassthroughRequest( - method=MethodEnum.GET, - path="/scooters", - ), -) - -``` -
-
+**page_size:** `typing.Optional[int]` — Number of results to return per page. The maximum limit is 100. +
-#### ⚙️ Parameters -
+**start_date:** `typing.Optional[str]` — If included, will only include audit trail events that occurred after this time + +
+
+
-**request:** `DataPassthroughRequest` +**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.
@@ -35891,7 +35912,8 @@ client.knowledgebase.async_passthrough.create(
-
client.knowledgebase.async_passthrough.retrieve(...) +## Ticketing AvailableActions +
client.ticketing.available_actions.retrieve()
@@ -35903,7 +35925,7 @@ client.knowledgebase.async_passthrough.create(
-Retrieves data from earlier async-passthrough POST request +Returns a list of models and actions available for an account.
@@ -35924,9 +35946,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.knowledgebase.async_passthrough.retrieve( - async_passthrough_receipt_id="async_passthrough_receipt_id", -) +client.ticketing.available_actions.retrieve() ``` @@ -35942,14 +35962,6 @@ client.knowledgebase.async_passthrough.retrieve(
-**async_passthrough_receipt_id:** `str` - -
-
- -
-
- **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -35962,8 +35974,8 @@ client.knowledgebase.async_passthrough.retrieve(
-## Knowledgebase Attachments -
client.knowledgebase.attachments.list(...) +## Ticketing Collections +
client.ticketing.collections.list(...)
@@ -35975,7 +35987,7 @@ client.knowledgebase.async_passthrough.retrieve(
-Returns a list of `Attachment` objects. +Returns a list of `Collection` objects.
@@ -35993,12 +36005,16 @@ Returns a list of `Attachment` objects. import datetime from merge import Merge +from merge.resources.ticketing.resources.collections import ( + CollectionsListRequestCollectionType, +) client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.knowledgebase.attachments.list( +client.ticketing.collections.list( + collection_type=CollectionsListRequestCollectionType.EMPTY, created_after=datetime.datetime.fromisoformat( "2024-01-15 09:30:00+00:00", ), @@ -36015,7 +36031,9 @@ client.knowledgebase.attachments.list( modified_before=datetime.datetime.fromisoformat( "2024-01-15 09:30:00+00:00", ), + name="name", page_size=1, + parent_collection_id="parent_collection_id", remote_id="remote_id", ) @@ -36033,7 +36051,7 @@ client.knowledgebase.attachments.list(
-**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime. +**collection_type:** `typing.Optional[CollectionsListRequestCollectionType]` — If provided, will only return collections of the given type.
@@ -36041,7 +36059,7 @@ client.knowledgebase.attachments.list(
-**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime. +**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
@@ -36049,7 +36067,7 @@ client.knowledgebase.attachments.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.
@@ -36057,7 +36075,7 @@ client.knowledgebase.attachments.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/). +**cursor:** `typing.Optional[str]` — The pagination cursor value.
@@ -36065,7 +36083,7 @@ client.knowledgebase.attachments.list(
-**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[typing.Literal["parent_collection"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -36073,7 +36091,7 @@ client.knowledgebase.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_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/).
@@ -36081,7 +36099,7 @@ client.knowledgebase.attachments.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.
@@ -36089,7 +36107,7 @@ client.knowledgebase.attachments.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).
@@ -36097,7 +36115,7 @@ client.knowledgebase.attachments.list(
-**page_size:** `typing.Optional[int]` — Number of results to return per page. The maximum limit is 100. +**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
@@ -36105,7 +36123,7 @@ client.knowledgebase.attachments.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.
@@ -36113,72 +36131,31 @@ client.knowledgebase.attachments.list(
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. +**name:** `typing.Optional[str]` — If provided, will only return collections with this name.
- -
- - - - -
- -
client.knowledgebase.attachments.retrieve(...) -
-
- -#### 📝 Description - -
-
-Returns an `Attachment` object with the given `id`. -
-
+**page_size:** `typing.Optional[int]` — Number of results to return per page. The maximum limit is 100. +
-#### 🔌 Usage - -
-
-
-```python -from merge import Merge - -client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.knowledgebase.attachments.retrieve( - id="id", - include_remote_data=True, - include_shell_data=True, -) - -``` -
-
+**parent_collection_id:** `typing.Optional[str]` — If provided, will only return collections whose parent collection matches the given id. +
-#### ⚙️ Parameters - -
-
-
-**id:** `str` +**remote_fields:** `typing.Optional[typing.Literal["collection_type"]]` — Deprecated. Use show_enum_origins.
@@ -36186,7 +36163,7 @@ client.knowledgebase.attachments.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.
@@ -36194,7 +36171,7 @@ client.knowledgebase.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). +**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)
@@ -36214,8 +36191,7 @@ client.knowledgebase.attachments.retrieve(
-## Knowledgebase AuditTrail -
client.knowledgebase.audit_trail.list(...) +
client.ticketing.collections.viewers_list(...)
@@ -36227,7 +36203,7 @@ client.knowledgebase.attachments.retrieve(
-Gets a list of audit trail events. +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)
@@ -36243,18 +36219,22 @@ Gets a list of audit trail events. ```python from merge import Merge +from merge.resources.ticketing.resources.collections import ( + CollectionsViewersListRequestExpand, +) client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.knowledgebase.audit_trail.list( +client.ticketing.collections.viewers_list( + collection_id="collection_id", cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", - end_date="end_date", - event_type="event_type", + expand=CollectionsViewersListRequestExpand.TEAM, + include_deleted_data=True, + include_remote_data=True, + include_shell_data=True, page_size=1, - start_date="start_date", - user_email="user_email", ) ``` @@ -36271,6 +36251,14 @@ client.knowledgebase.audit_trail.list(
+**collection_id:** `str` + +
+
+ +
+
+ **cursor:** `typing.Optional[str]` — The pagination cursor value.
@@ -36279,7 +36267,7 @@ client.knowledgebase.audit_trail.list(
-**end_date:** `typing.Optional[str]` — If included, will only include audit trail events that occurred before this time +**expand:** `typing.Optional[CollectionsViewersListRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -36287,7 +36275,7 @@ client.knowledgebase.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` +**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/).
@@ -36295,7 +36283,7 @@ client.knowledgebase.audit_trail.list(
-**page_size:** `typing.Optional[int]` — Number of results to return per page. +**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -36303,7 +36291,7 @@ client.knowledgebase.audit_trail.list(
-**start_date:** `typing.Optional[str]` — If included, will only include audit trail events that occurred after this time +**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).
@@ -36311,7 +36299,7 @@ client.knowledgebase.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. +**page_size:** `typing.Optional[int]` — Number of results to return per page.
@@ -36331,8 +36319,7 @@ client.knowledgebase.audit_trail.list(
-## Knowledgebase AvailableActions -
client.knowledgebase.available_actions.retrieve() +
client.ticketing.collections.retrieve(...)
@@ -36344,7 +36331,7 @@ client.knowledgebase.audit_trail.list(
-Returns a list of models and actions available for an account. +Returns a `Collection` object with the given `id`.
@@ -36365,7 +36352,11 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.knowledgebase.available_actions.retrieve() +client.ticketing.collections.retrieve( + id="id", + include_remote_data=True, + include_shell_data=True, +) ``` @@ -36381,6 +36372,54 @@ client.knowledgebase.available_actions.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). + +
+
+ +
+
+ +**remote_fields:** `typing.Optional[typing.Literal["collection_type"]]` — Deprecated. Use show_enum_origins. + +
+
+ +
+
+ +**show_enum_origins:** `typing.Optional[typing.Literal["collection_type"]]` — A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter) + +
+
+ +
+
+ **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -36393,8 +36432,8 @@ client.knowledgebase.available_actions.retrieve()
-## Knowledgebase Containers -
client.knowledgebase.containers.list(...) +## Ticketing Comments +
client.ticketing.comments.list(...)
@@ -36406,7 +36445,7 @@ client.knowledgebase.available_actions.retrieve()
-Returns a list of `Container` objects. +Returns a list of `Comment` objects.
@@ -36424,16 +36463,15 @@ Returns a list of `Container` objects. import datetime from merge import Merge -from merge.resources.knowledgebase.resources.containers import ( - ContainersListRequestExpand, - ContainersListRequestType, +from merge.resources.ticketing.resources.comments import ( + CommentsListRequestExpand, ) client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.knowledgebase.containers.list( +client.ticketing.comments.list( created_after=datetime.datetime.fromisoformat( "2024-01-15 09:30:00+00:00", ), @@ -36441,7 +36479,7 @@ client.knowledgebase.containers.list( "2024-01-15 09:30:00+00:00", ), cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", - expand=ContainersListRequestExpand.PARENT_ARTICLE, + expand=CommentsListRequestExpand.CONTACT, include_deleted_data=True, include_remote_data=True, include_shell_data=True, @@ -36452,10 +36490,11 @@ client.knowledgebase.containers.list( "2024-01-15 09:30:00+00:00", ), page_size=1, - parent_article_id="parent_article_id", - parent_container_id="parent_container_id", + remote_created_after=datetime.datetime.fromisoformat( + "2024-01-15 09:30:00+00:00", + ), remote_id="remote_id", - type=ContainersListRequestType.EMPTY, + ticket_id="ticket_id", ) ``` @@ -36496,7 +36535,7 @@ client.knowledgebase.containers.list(
-**expand:** `typing.Optional[ContainersListRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. +**expand:** `typing.Optional[CommentsListRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -36552,15 +36591,7 @@ client.knowledgebase.containers.list(
-**parent_article_id:** `typing.Optional[str]` — If provided, will only return sub containers of the parent_article_id. - -
-
- -
-
- -**parent_container_id:** `typing.Optional[str]` — If provided, will only return sub containers of the parent_container_id. +**remote_created_after:** `typing.Optional[dt.datetime]` — If provided, will only return Comments created in the third party platform after this datetime.
@@ -36576,7 +36607,7 @@ client.knowledgebase.containers.list(
-**type:** `typing.Optional[ContainersListRequestType]` — If provided, will only return containers of the given type. +**ticket_id:** `typing.Optional[str]` — If provided, will only return comments for this ticket.
@@ -36596,7 +36627,7 @@ client.knowledgebase.containers.list(
-
client.knowledgebase.containers.retrieve(...) +
client.ticketing.comments.create(...)
@@ -36608,7 +36639,7 @@ client.knowledgebase.containers.list(
-Returns a `Container` object with the given `id`. +Creates a `Comment` object with the given values.
@@ -36624,19 +36655,16 @@ Returns a `Container` object with the given `id`. ```python from merge import Merge -from merge.resources.knowledgebase.resources.containers import ( - ContainersRetrieveRequestExpand, -) +from merge.resources.ticketing import CommentRequest client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.knowledgebase.containers.retrieve( - id="id", - expand=ContainersRetrieveRequestExpand.PARENT_ARTICLE, - include_remote_data=True, - include_shell_data=True, +client.ticketing.comments.create( + is_debug_mode=True, + run_async=True, + model=CommentRequest(), ) ``` @@ -36653,15 +36681,7 @@ client.knowledgebase.containers.retrieve(
-**id:** `str` - -
-
- -
-
- -**expand:** `typing.Optional[ContainersRetrieveRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. +**model:** `CommentRequest`
@@ -36669,7 +36689,7 @@ client.knowledgebase.containers.retrieve(
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. +**is_debug_mode:** `typing.Optional[bool]` — Whether to include debug fields (such as log file links) in the response.
@@ -36677,7 +36697,7 @@ client.knowledgebase.containers.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). +**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously.
@@ -36697,8 +36717,7 @@ client.knowledgebase.containers.retrieve(
-## Knowledgebase Scopes -
client.knowledgebase.scopes.default_scopes_retrieve() +
client.ticketing.comments.retrieve(...)
@@ -36710,7 +36729,7 @@ client.knowledgebase.containers.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). +Returns a `Comment` object with the given `id`.
@@ -36726,12 +36745,20 @@ Get the default permissions for Merge Common Models and fields across all Linked ```python from merge import Merge +from merge.resources.ticketing.resources.comments import ( + CommentsRetrieveRequestExpand, +) client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.knowledgebase.scopes.default_scopes_retrieve() +client.ticketing.comments.retrieve( + id="id", + expand=CommentsRetrieveRequestExpand.CONTACT, + include_remote_data=True, + include_shell_data=True, +) ``` @@ -36747,6 +36774,38 @@ client.knowledgebase.scopes.default_scopes_retrieve()
+**id:** `str` + +
+
+ +
+
+ +**expand:** `typing.Optional[CommentsRetrieveRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. + +
+
+ +
+
+ +**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. + +
+
+ +
+
+ +**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.
@@ -36759,7 +36818,7 @@ client.knowledgebase.scopes.default_scopes_retrieve()
-
client.knowledgebase.scopes.linked_account_scopes_retrieve() +
client.ticketing.comments.meta_post_retrieve()
@@ -36771,7 +36830,7 @@ client.knowledgebase.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). +Returns metadata for `Comment` POSTs.
@@ -36792,7 +36851,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.knowledgebase.scopes.linked_account_scopes_retrieve() +client.ticketing.comments.meta_post_retrieve() ``` @@ -36820,7 +36879,8 @@ client.knowledgebase.scopes.linked_account_scopes_retrieve()
-
client.knowledgebase.scopes.linked_account_scopes_create(...) +## Ticketing Contacts +
client.ticketing.contacts.list(...)
@@ -36832,7 +36892,7 @@ client.knowledgebase.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 `Contact` objects.
@@ -36847,43 +36907,34 @@ Update permissions for any Common Model or field for a single Linked Account. An
```python +import datetime + from merge import Merge -from merge.resources.knowledgebase import ( - FieldPermissionDeserializerRequest, - IndividualCommonModelScopeDeserializerRequest, - ModelPermissionDeserializerRequest, -) client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.knowledgebase.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.ticketing.contacts.list( + created_after=datetime.datetime.fromisoformat( + "2024-01-15 09:30:00+00:00", + ), + created_before=datetime.datetime.fromisoformat( + "2024-01-15 09:30:00+00:00", + ), + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + email_address="email_address", + include_deleted_data=True, + include_remote_data=True, + include_shell_data=True, + modified_after=datetime.datetime.fromisoformat( + "2024-01-15 09:30:00+00:00", + ), + modified_before=datetime.datetime.fromisoformat( + "2024-01-15 09:30:00+00:00", + ), + page_size=1, + remote_id="remote_id", ) ``` @@ -36900,7 +36951,7 @@ client.knowledgebase.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.
@@ -36908,65 +36959,91 @@ client.knowledgebase.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. +
-
-## Knowledgebase DeleteAccount -
client.knowledgebase.delete_account.delete()
-#### 📝 Description +**email_address:** `typing.Optional[str]` — If provided, will only return Contacts that match this email. + +
+
+**expand:** `typing.Optional[typing.Literal["account"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. + +
+
+
-Delete a linked account. +**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.knowledgebase.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. The maximum limit is 100. +
-#### ⚙️ Parameters -
+**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object. + +
+
+
@@ -36982,8 +37059,7 @@ client.knowledgebase.delete_account.delete()
-## Knowledgebase FieldMapping -
client.knowledgebase.field_mapping.field_mappings_retrieve(...) +
client.ticketing.contacts.create(...)
@@ -36995,7 +37071,7 @@ client.knowledgebase.delete_account.delete()
-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/). +Creates a `Contact` object with the given values.
@@ -37011,13 +37087,16 @@ Get all Field Mappings for this Linked Account. Field Mappings are mappings betw ```python from merge import Merge +from merge.resources.ticketing import ContactRequest client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.knowledgebase.field_mapping.field_mappings_retrieve( - exclude_remote_field_metadata=True, +client.ticketing.contacts.create( + is_debug_mode=True, + run_async=True, + model=ContactRequest(), ) ``` @@ -37034,7 +37113,23 @@ client.knowledgebase.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. +**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.
@@ -37054,7 +37149,7 @@ client.knowledgebase.field_mapping.field_mappings_retrieve(
-
client.knowledgebase.field_mapping.field_mappings_create(...) +
client.ticketing.contacts.retrieve(...)
@@ -37066,7 +37161,7 @@ client.knowledgebase.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 `Contact` object with the given `id`.
@@ -37087,14 +37182,10 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.knowledgebase.field_mapping.field_mappings_create( - exclude_remote_field_metadata=True, - 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.contacts.retrieve( + id="id", + include_remote_data=True, + include_shell_data=True, ) ``` @@ -37111,39 +37202,7 @@ client.knowledgebase.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`
@@ -37151,7 +37210,7 @@ client.knowledgebase.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["account"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -37159,7 +37218,7 @@ client.knowledgebase.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.
@@ -37167,7 +37226,7 @@ client.knowledgebase.field_mapping.field_mappings_create(
-**jmes_path:** `typing.Optional[str]` — JMES path to specify json query expression to be used on field mapping. +**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).
@@ -37187,7 +37246,7 @@ client.knowledgebase.field_mapping.field_mappings_create(
-
client.knowledgebase.field_mapping.field_mappings_destroy(...) +
client.ticketing.contacts.meta_post_retrieve()
@@ -37199,7 +37258,7 @@ client.knowledgebase.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 metadata for `TicketingContact` POSTs.
@@ -37220,9 +37279,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.knowledgebase.field_mapping.field_mappings_destroy( - field_mapping_id="field_mapping_id", -) +client.ticketing.contacts.meta_post_retrieve() ``` @@ -37238,14 +37295,6 @@ client.knowledgebase.field_mapping.field_mappings_destroy(
-**field_mapping_id:** `str` - -
-
- -
-
- **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -37258,7 +37307,8 @@ client.knowledgebase.field_mapping.field_mappings_destroy(
-
client.knowledgebase.field_mapping.field_mappings_partial_update(...) +## Ticketing Scopes +
client.ticketing.scopes.default_scopes_retrieve()
@@ -37270,7 +37320,7 @@ client.knowledgebase.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. +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).
@@ -37291,9 +37341,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.knowledgebase.field_mapping.field_mappings_partial_update( - field_mapping_id="field_mapping_id", -) +client.ticketing.scopes.default_scopes_retrieve() ``` @@ -37309,42 +37357,63 @@ client.knowledgebase.field_mapping.field_mappings_partial_update(
-**field_mapping_id:** `str` +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+ +
-
-
-**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. -
+
+
client.ticketing.scopes.linked_account_scopes_retrieve()
-**remote_method:** `typing.Optional[str]` — The method of the remote endpoint where the remote field is coming from. - -
-
+#### 📝 Description
-**remote_url_path:** `typing.Optional[str]` — The path of the remote endpoint where the remote field is coming from. - +
+
+ +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 +
-**jmes_path:** `typing.Optional[str]` — JMES path to specify json query expression to be used on field mapping. - +
+
+ +```python +from merge import Merge + +client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.ticketing.scopes.linked_account_scopes_retrieve() + +```
+
+
+ +#### ⚙️ Parameters + +
+
@@ -37361,7 +37430,7 @@ client.knowledgebase.field_mapping.field_mappings_partial_update(
-
client.knowledgebase.field_mapping.remote_fields_retrieve(...) +
client.ticketing.scopes.linked_account_scopes_create(...)
@@ -37373,7 +37442,7 @@ client.knowledgebase.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/). +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)
@@ -37389,14 +37458,42 @@ Get all remote fields for a Linked Account. Remote fields are third-party fields ```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.knowledgebase.field_mapping.remote_fields_retrieve( - common_models="common_models", - include_example_values="include_example_values", +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, + ) + }, + ), + ], ) ``` @@ -37413,15 +37510,7 @@ client.knowledgebase.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. +**common_models:** `typing.Sequence[IndividualCommonModelScopeDeserializerRequest]` — The common models you want to update the scopes for
@@ -37441,7 +37530,8 @@ client.knowledgebase.field_mapping.remote_fields_retrieve(
-
client.knowledgebase.field_mapping.target_fields_retrieve() +## Ticketing DeleteAccount +
client.ticketing.delete_account.delete()
@@ -37453,7 +37543,7 @@ client.knowledgebase.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/). +Delete a linked account.
@@ -37474,7 +37564,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.knowledgebase.field_mapping.target_fields_retrieve() +client.ticketing.delete_account.delete() ``` @@ -37502,8 +37592,8 @@ client.knowledgebase.field_mapping.target_fields_retrieve()
-## Knowledgebase GenerateKey -
client.knowledgebase.generate_key.create(...) +## Ticketing FieldMapping +
client.ticketing.field_mapping.field_mappings_retrieve(...)
@@ -37515,7 +37605,7 @@ client.knowledgebase.field_mapping.target_fields_retrieve()
-Create a remote key. +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/).
@@ -37536,8 +37626,8 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.knowledgebase.generate_key.create( - name="Remote Deployment Key 1", +client.ticketing.field_mapping.field_mappings_retrieve( + exclude_remote_field_metadata=True, ) ``` @@ -37554,7 +37644,7 @@ client.knowledgebase.generate_key.create(
-**name:** `str` — The name of the remote key +**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.
@@ -37574,8 +37664,7 @@ client.knowledgebase.generate_key.create(
-## Knowledgebase Groups -
client.knowledgebase.groups.list(...) +
client.ticketing.field_mapping.field_mappings_create(...)
@@ -37587,7 +37676,7 @@ client.knowledgebase.generate_key.create(
-Returns a list of `Group` 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.
@@ -37602,37 +37691,20 @@ Returns a list of `Group` objects.
```python -import datetime - from merge import Merge -from merge.resources.knowledgebase.resources.groups import ( - GroupsListRequestExpand, -) client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.knowledgebase.groups.list( - created_after=datetime.datetime.fromisoformat( - "2024-01-15 09:30:00+00:00", - ), - created_before=datetime.datetime.fromisoformat( - "2024-01-15 09:30:00+00:00", - ), - cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", - expand=GroupsListRequestExpand.PARENT_GROUP, - include_deleted_data=True, - include_remote_data=True, - include_shell_data=True, - modified_after=datetime.datetime.fromisoformat( - "2024-01-15 09:30:00+00:00", - ), - modified_before=datetime.datetime.fromisoformat( - "2024-01-15 09:30:00+00:00", - ), - page_size=1, - remote_id="remote_id", +client.ticketing.field_mapping.field_mappings_create( + exclude_remote_field_metadata=True, + 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", ) ``` @@ -37649,7 +37721,23 @@ client.knowledgebase.groups.list(
-**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime. +**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.
@@ -37657,7 +37745,7 @@ client.knowledgebase.groups.list(
-**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime. +**remote_method:** `str` — The method of the remote endpoint where the remote field is coming from.
@@ -37665,7 +37753,7 @@ client.knowledgebase.groups.list(
-**cursor:** `typing.Optional[str]` — The pagination cursor value. +**remote_url_path:** `str` — The path of the remote endpoint where the remote field is coming from.
@@ -37673,7 +37761,7 @@ client.knowledgebase.groups.list(
-**expand:** `typing.Optional[GroupsListRequestExpand]` — 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.
@@ -37681,7 +37769,7 @@ client.knowledgebase.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/). +**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.
@@ -37689,7 +37777,7 @@ client.knowledgebase.groups.list(
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. +**jmes_path:** `typing.Optional[str]` — JMES path to specify json query expression to be used on field mapping.
@@ -37697,39 +37785,70 @@ client.knowledgebase.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). +**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.ticketing.field_mapping.field_mappings_destroy(...)
-**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned. - +#### 📝 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 +
-**page_size:** `typing.Optional[int]` — Number of results to return per page. The maximum limit is 100. - +
+
+ +```python +from merge import Merge + +client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.ticketing.field_mapping.field_mappings_destroy( + field_mapping_id="field_mapping_id", +) + +``` +
+
+#### ⚙️ Parameters +
-**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object. +
+
+ +**field_mapping_id:** `str`
@@ -37749,7 +37868,7 @@ client.knowledgebase.groups.list(
-
client.knowledgebase.groups.retrieve(...) +
client.ticketing.field_mapping.field_mappings_partial_update(...)
@@ -37761,7 +37880,7 @@ client.knowledgebase.groups.list(
-Returns a `Group` 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.
@@ -37777,19 +37896,13 @@ Returns a `Group` object with the given `id`. ```python from merge import Merge -from merge.resources.knowledgebase.resources.groups import ( - GroupsRetrieveRequestExpand, -) client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.knowledgebase.groups.retrieve( - id="id", - expand=GroupsRetrieveRequestExpand.PARENT_GROUP, - include_remote_data=True, - include_shell_data=True, +client.ticketing.field_mapping.field_mappings_partial_update( + field_mapping_id="field_mapping_id", ) ``` @@ -37806,7 +37919,7 @@ client.knowledgebase.groups.retrieve(
-**id:** `str` +**field_mapping_id:** `str`
@@ -37814,7 +37927,7 @@ client.knowledgebase.groups.retrieve(
-**expand:** `typing.Optional[GroupsRetrieveRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. +**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.
@@ -37822,7 +37935,7 @@ client.knowledgebase.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_method:** `typing.Optional[str]` — The method of the remote endpoint where the remote field is coming from.
@@ -37830,7 +37943,15 @@ client.knowledgebase.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). +**remote_url_path:** `typing.Optional[str]` — The path of the remote endpoint where the remote field is coming from. + +
+
+ +
+
+ +**jmes_path:** `typing.Optional[str]` — JMES path to specify json query expression to be used on field mapping.
@@ -37850,8 +37971,7 @@ client.knowledgebase.groups.retrieve(
-## Knowledgebase Issues -
client.knowledgebase.issues.list(...) +
client.ticketing.field_mapping.remote_fields_retrieve(...)
@@ -37863,7 +37983,7 @@ client.knowledgebase.groups.retrieve(
-Gets all issues for Organization. +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/).
@@ -37878,40 +37998,15 @@ Gets all issues for Organization.
```python -import datetime - from merge import Merge -from merge.resources.knowledgebase.resources.issues import ( - IssuesListRequestStatus, -) client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.knowledgebase.issues.list( - account_token="account_token", - cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", - end_date="end_date", - end_user_organization_name="end_user_organization_name", - first_incident_time_after=datetime.datetime.fromisoformat( - "2024-01-15 09:30:00+00:00", - ), - first_incident_time_before=datetime.datetime.fromisoformat( - "2024-01-15 09:30:00+00:00", - ), - include_muted="include_muted", - integration_name="integration_name", - last_incident_time_after=datetime.datetime.fromisoformat( - "2024-01-15 09:30:00+00:00", - ), - last_incident_time_before=datetime.datetime.fromisoformat( - "2024-01-15 09:30:00+00:00", - ), - linked_account_id="linked_account_id", - page_size=1, - start_date="start_date", - status=IssuesListRequestStatus.ONGOING, +client.ticketing.field_mapping.remote_fields_retrieve( + common_models="common_models", + include_example_values="include_example_values", ) ``` @@ -37928,7 +38023,7 @@ client.knowledgebase.issues.list(
-**account_token:** `typing.Optional[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.
@@ -37936,7 +38031,7 @@ client.knowledgebase.issues.list(
-**cursor:** `typing.Optional[str]` — The pagination cursor value. +**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.
@@ -37944,104 +38039,64 @@ client.knowledgebase.issues.list(
-**end_date:** `typing.Optional[str]` — If included, will only include issues whose most recent action occurred before this time +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
- -
-
- -**end_user_organization_name:** `typing.Optional[str]` -
-
-
-**first_incident_time_after:** `typing.Optional[dt.datetime]` — If provided, will only return issues whose first incident time was after this datetime. -
+
+
client.ticketing.field_mapping.target_fields_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]` - +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/).
- -
-
- -**last_incident_time_after:** `typing.Optional[dt.datetime]` — If provided, will only return issues whose last incident time was after this datetime. -
+#### 🔌 Usage +
-**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. - -
-
+```python +from merge import Merge -
-
+client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.ticketing.field_mapping.target_fields_retrieve() -**page_size:** `typing.Optional[int]` — Number of results to return per page. The maximum limit is 100. - +```
- -
-
- -**start_date:** `typing.Optional[str]` — If included, will only include issues whose most recent action occurred after this time -
+#### ⚙️ Parameters +
-**status:** `typing.Optional[IssuesListRequestStatus]` - -Status of the issue. Options: ('ONGOING', 'RESOLVED') - -* `ONGOING` - ONGOING -* `RESOLVED` - RESOLVED - -
-
-
@@ -38057,7 +38112,8 @@ Status of the issue. Options: ('ONGOING', 'RESOLVED')
-
client.knowledgebase.issues.retrieve(...) +## Ticketing GenerateKey +
client.ticketing.generate_key.create(...)
@@ -38069,7 +38125,7 @@ Status of the issue. Options: ('ONGOING', 'RESOLVED')
-Get a specific issue. +Create a remote key.
@@ -38090,8 +38146,8 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.knowledgebase.issues.retrieve( - id="id", +client.ticketing.generate_key.create( + name="Remote Deployment Key 1", ) ``` @@ -38108,7 +38164,7 @@ client.knowledgebase.issues.retrieve(
-**id:** `str` +**name:** `str` — The name of the remote key
@@ -38128,8 +38184,8 @@ client.knowledgebase.issues.retrieve(
-## Knowledgebase LinkToken -
client.knowledgebase.link_token.create(...) +## Ticketing Issues +
client.ticketing.issues.list(...)
@@ -38141,7 +38197,7 @@ client.knowledgebase.issues.retrieve(
-Creates a link token to be used when linking a new end user. +Gets all issues for Organization.
@@ -38156,18 +38212,38 @@ Creates a link token to be used when linking a new end user.
```python +import datetime + from merge import Merge -from merge.resources.knowledgebase import CategoriesEnum +from merge.resources.ticketing.resources.issues import IssuesListRequestStatus client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.knowledgebase.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.issues.list( + account_token="account_token", + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + end_date="end_date", + end_user_organization_name="end_user_organization_name", + first_incident_time_after=datetime.datetime.fromisoformat( + "2024-01-15 09:30:00+00:00", + ), + first_incident_time_before=datetime.datetime.fromisoformat( + "2024-01-15 09:30:00+00:00", + ), + include_muted="include_muted", + integration_name="integration_name", + last_incident_time_after=datetime.datetime.fromisoformat( + "2024-01-15 09:30:00+00:00", + ), + last_incident_time_before=datetime.datetime.fromisoformat( + "2024-01-15 09:30:00+00:00", + ), + linked_account_id="linked_account_id", + page_size=1, + start_date="start_date", + status=IssuesListRequestStatus.ONGOING, ) ``` @@ -38184,7 +38260,7 @@ client.knowledgebase.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. +**account_token:** `typing.Optional[str]`
@@ -38192,7 +38268,7 @@ client.knowledgebase.link_token.create(
-**end_user_organization_name:** `str` — Your end user's organization. +**cursor:** `typing.Optional[str]` — The pagination cursor value.
@@ -38200,7 +38276,7 @@ client.knowledgebase.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. +**end_date:** `typing.Optional[str]` — If included, will only include issues whose most recent action occurred before this time
@@ -38208,7 +38284,7 @@ client.knowledgebase.link_token.create(
-**categories:** `typing.Sequence[CategoriesEnum]` — The integration categories to show in Merge Link. +**end_user_organization_name:** `typing.Optional[str]`
@@ -38216,7 +38292,7 @@ client.knowledgebase.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/. +**first_incident_time_after:** `typing.Optional[dt.datetime]` — If provided, will only return issues whose first incident time was after this datetime.
@@ -38224,7 +38300,7 @@ client.knowledgebase.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. +**first_incident_time_before:** `typing.Optional[dt.datetime]` — If provided, will only return issues whose first incident time was before this datetime.
@@ -38232,7 +38308,7 @@ client.knowledgebase.link_token.create(
-**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. +**include_muted:** `typing.Optional[str]` — If true, will include muted issues
@@ -38240,7 +38316,7 @@ client.knowledgebase.link_token.create(
-**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. +**integration_name:** `typing.Optional[str]`
@@ -38248,7 +38324,7 @@ client.knowledgebase.link_token.create(
-**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. +**last_incident_time_after:** `typing.Optional[dt.datetime]` — If provided, will only return issues whose last incident time was after this datetime.
@@ -38256,14 +38332,7 @@ client.knowledgebase.link_token.create(
-**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. +**last_incident_time_before:** `typing.Optional[dt.datetime]` — If provided, will only return issues whose last incident time was before this datetime.
@@ -38271,12 +38340,7 @@ client.knowledgebase.link_token.create(
-**language:** `typing.Optional[EndUserDetailsRequestLanguage]` - -The following subset of IETF language tags can be used to configure localization. - -* `en` - en -* `de` - de +**linked_account_id:** `typing.Optional[str]` — If provided, will only include issues pertaining to the linked account passed in.
@@ -38284,7 +38348,7 @@ The following subset of IETF language tags can be used to configure localization
-**are_syncs_disabled:** `typing.Optional[bool]` — The boolean that indicates whether initial, periodic, and force syncs will be disabled. +**page_size:** `typing.Optional[int]` — Number of results to return per page. The maximum limit is 100.
@@ -38292,7 +38356,7 @@ The following subset of IETF language tags can be used to configure localization
-**integration_specific_config:** `typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]]` — A JSON object containing integration-specific configuration options. +**start_date:** `typing.Optional[str]` — If included, will only include issues whose most recent action occurred after this time
@@ -38300,11 +38364,12 @@ The following subset of IETF language tags can be used to configure localization
-**completed_account_initial_screen:** `typing.Optional[EndUserDetailsRequestCompletedAccountInitialScreen]` +**status:** `typing.Optional[IssuesListRequestStatus]` -When creating a Link token, you can specifiy the initial screen of Linking Flow for a completed Linked Account. +Status of the issue. Options: ('ONGOING', 'RESOLVED') -* `SELECTIVE_SYNC` - SELECTIVE_SYNC +* `ONGOING` - ONGOING +* `RESOLVED` - RESOLVED
@@ -38324,8 +38389,7 @@ When creating a Link token, you can specifiy the initial screen of Linking Flow
-## Knowledgebase LinkedAccounts -
client.knowledgebase.linked_accounts.list(...) +
client.ticketing.issues.retrieve(...)
@@ -38337,7 +38401,7 @@ When creating a Link token, you can specifiy the initial screen of Linking Flow
-List linked accounts for your organization. +Get a specific issue.
@@ -38353,28 +38417,13 @@ List linked accounts for your organization. ```python from merge import Merge -from merge.resources.knowledgebase.resources.linked_accounts import ( - LinkedAccountsListRequestCategory, -) client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.knowledgebase.linked_accounts.list( - category=LinkedAccountsListRequestCategory.ACCOUNTING, - cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", - end_user_email_address="end_user_email_address", - end_user_organization_name="end_user_organization_name", - end_user_origin_id="end_user_origin_id", - end_user_origin_ids="end_user_origin_ids", +client.ticketing.issues.retrieve( id="id", - ids="ids", - include_duplicates=True, - integration_name="integration_name", - is_test_account="is_test_account", - page_size=1, - status="status", ) ``` @@ -38391,18 +38440,7 @@ client.knowledgebase.linked_accounts.list(
-**category:** `typing.Optional[LinkedAccountsListRequestCategory]` - -Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `knowledgebase`, `mktg`, `ticketing` - -* `hris` - hris -* `ats` - ats -* `accounting` - accounting -* `ticketing` - ticketing -* `crm` - crm -* `mktg` - mktg -* `filestorage` - filestorage -* `knowledgebase` - knowledgebase +**id:** `str`
@@ -38410,47 +38448,75 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `knowledgebase`, `mk
-**cursor:** `typing.Optional[str]` — The pagination cursor value. +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+ +
-
-
-**end_user_email_address:** `typing.Optional[str]` — If provided, will only return linked accounts associated with the given email address. -
+
+## Ticketing LinkToken +
client.ticketing.link_token.create(...)
-**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. - +
+
+ +Creates a link token to be used when linking a new end user. +
+
+#### 🔌 Usage +
-**end_user_origin_ids:** `typing.Optional[str]` — Comma-separated list of EndUser origin IDs, making it possible to specify multiple EndUsers at once. - +
+
+ +```python +from merge import Merge +from merge.resources.ticketing import CategoriesEnum + +client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.ticketing.link_token.create( + end_user_email_address="example@gmail.com", + end_user_organization_name="Test Organization", + end_user_origin_id="12345", + categories=[CategoriesEnum.HRIS, CategoriesEnum.ATS], +) + +``` +
+
+#### ⚙️ Parameters +
-**id:** `typing.Optional[str]` +
+
+ +**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.
@@ -38458,7 +38524,7 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `knowledgebase`, `mk
-**ids:** `typing.Optional[str]` — Comma-separated list of LinkedAccount IDs, making it possible to specify multiple LinkedAccounts at once. +**end_user_organization_name:** `str` — Your end user's organization.
@@ -38466,7 +38532,7 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `knowledgebase`, `mk
-**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. +**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.
@@ -38474,7 +38540,7 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `knowledgebase`, `mk
-**integration_name:** `typing.Optional[str]` — If provided, will only return linked accounts associated with the given integration name. +**categories:** `typing.Sequence[CategoriesEnum]` — The integration categories to show in Merge Link.
@@ -38482,7 +38548,7 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `knowledgebase`, `mk
-**is_test_account:** `typing.Optional[str]` — If included, will only include test linked accounts. If not included, will only include non-test linked accounts. +**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/.
@@ -38490,7 +38556,7 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `knowledgebase`, `mk
-**page_size:** `typing.Optional[int]` — Number of results to return per page. The maximum limit is 100. +**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.
@@ -38498,7 +38564,7 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `knowledgebase`, `mk
-**status:** `typing.Optional[str]` — Filter by status. Options: `COMPLETE`, `IDLE`, `INCOMPLETE`, `RELINK_NEEDED` +**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.
@@ -38506,75 +38572,71 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `knowledgebase`, `mk
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. +**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. +
-
-## Knowledgebase Passthrough -
client.knowledgebase.passthrough.create(...)
-#### 📝 Description +**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]` -Pull data from an endpoint not currently supported by Merge. -
-
+The following subset of IETF language tags can be used to configure localization. + +* `en` - en +* `de` - de +
-#### 🔌 Usage -
+**are_syncs_disabled:** `typing.Optional[bool]` — The boolean that indicates whether initial, periodic, and force syncs will be disabled. + +
+
+
-```python -from merge import Merge -from merge.resources.knowledgebase import DataPassthroughRequest, MethodEnum - -client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.knowledgebase.passthrough.create( - request=DataPassthroughRequest( - method=MethodEnum.GET, - path="/scooters", - ), -) - -``` -
-
+**integration_specific_config:** `typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]]` — A JSON object containing integration-specific configuration options. + -#### ⚙️ Parameters -
-
-
+**completed_account_initial_screen:** `typing.Optional[EndUserDetailsRequestCompletedAccountInitialScreen]` -**request:** `DataPassthroughRequest` +When creating a Link token, you can specifiy the initial screen of Linking Flow for a completed Linked Account. + +* `SELECTIVE_SYNC` - SELECTIVE_SYNC
@@ -38594,8 +38656,8 @@ client.knowledgebase.passthrough.create(
-## Knowledgebase RegenerateKey -
client.knowledgebase.regenerate_key.create(...) +## Ticketing LinkedAccounts +
client.ticketing.linked_accounts.list(...)
@@ -38607,7 +38669,7 @@ client.knowledgebase.passthrough.create(
-Exchange remote keys. +List linked accounts for your organization.
@@ -38623,13 +38685,28 @@ Exchange remote keys. ```python from merge import Merge +from merge.resources.ticketing.resources.linked_accounts import ( + LinkedAccountsListRequestCategory, +) client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.knowledgebase.regenerate_key.create( - name="Remote Deployment Key 1", +client.ticketing.linked_accounts.list( + category=LinkedAccountsListRequestCategory.ACCOUNTING, + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + end_user_email_address="end_user_email_address", + end_user_organization_name="end_user_organization_name", + end_user_origin_id="end_user_origin_id", + end_user_origin_ids="end_user_origin_ids", + id="id", + ids="ids", + include_duplicates=True, + integration_name="integration_name", + is_test_account="is_test_account", + page_size=1, + status="status", ) ``` @@ -38638,15 +38715,41 @@ client.knowledgebase.regenerate_key.create(
-#### ⚙️ Parameters - +#### ⚙️ Parameters + +
+
+ +
+
+ +**category:** `typing.Optional[LinkedAccountsListRequestCategory]` + +Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing` + +* `hris` - hris +* `ats` - ats +* `accounting` - accounting +* `ticketing` - ticketing +* `crm` - crm +* `mktg` - mktg +* `filestorage` - filestorage + +
+
+
+**cursor:** `typing.Optional[str]` — The pagination cursor value. + +
+
+
-**name:** `str` — The name of the remote key +**end_user_email_address:** `typing.Optional[str]` — If provided, will only return linked accounts associated with the given email address.
@@ -38654,72 +38757,71 @@ client.knowledgebase.regenerate_key.create(
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. +**end_user_organization_name:** `typing.Optional[str]` — If provided, will only return linked accounts associated with the given organization name.
-
-
+
+
+**end_user_origin_id:** `typing.Optional[str]` — If provided, will only return linked accounts associated with the given origin ID. +
-
-## Knowledgebase SyncStatus -
client.knowledgebase.sync_status.list(...)
-#### 📝 Description +**end_user_origin_ids:** `typing.Optional[str]` — Comma-separated list of EndUser origin IDs, making it possible to specify multiple EndUsers at once. + +
+
+**id:** `typing.Optional[str]` + +
+
+
-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). -
-
+**ids:** `typing.Optional[str]` — Comma-separated list of LinkedAccount IDs, making it possible to specify multiple LinkedAccounts at once. + -#### 🔌 Usage -
+**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.knowledgebase.sync_status.list( - cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", - page_size=1, -) - -``` -
-
+**integration_name:** `typing.Optional[str]` — If provided, will only return linked accounts associated with the given integration name. + -#### ⚙️ Parameters -
+**is_test_account:** `typing.Optional[str]` — If included, will only include test linked accounts. If not included, will only include non-test linked accounts. + +
+
+
-**cursor:** `typing.Optional[str]` — The pagination cursor value. +**page_size:** `typing.Optional[int]` — Number of results to return per page. The maximum limit is 100.
@@ -38727,7 +38829,7 @@ client.knowledgebase.sync_status.list(
-**page_size:** `typing.Optional[int]` — Number of results to return per page. The maximum limit is 100. +**status:** `typing.Optional[str]` — Filter by status. Options: `COMPLETE`, `IDLE`, `INCOMPLETE`, `RELINK_NEEDED`
@@ -38747,8 +38849,8 @@ client.knowledgebase.sync_status.list(
-## Knowledgebase ForceResync -
client.knowledgebase.force_resync.sync_status_resync_create() +## Ticketing Passthrough +
client.ticketing.passthrough.create(...)
@@ -38760,7 +38862,7 @@ client.knowledgebase.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. +Pull data from an endpoint not currently supported by Merge.
@@ -38776,12 +38878,18 @@ Force re-sync of all models. This endpoint is available for monthly, quarterly, ```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.knowledgebase.force_resync.sync_status_resync_create() +client.ticketing.passthrough.create( + request=DataPassthroughRequest( + method=MethodEnum.GET, + path="/scooters", + ), +) ``` @@ -38797,6 +38905,14 @@ client.knowledgebase.force_resync.sync_status_resync_create()
+**request:** `DataPassthroughRequest` + +
+
+ +
+
+ **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -38809,8 +38925,8 @@ client.knowledgebase.force_resync.sync_status_resync_create()
-## Knowledgebase Users -
client.knowledgebase.users.list(...) +## Ticketing Projects +
client.ticketing.projects.list(...)
@@ -38822,7 +38938,7 @@ client.knowledgebase.force_resync.sync_status_resync_create()
-Returns a list of `User` objects. +Returns a list of `Project` objects.
@@ -38845,7 +38961,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.knowledgebase.users.list( +client.ticketing.projects.list( created_after=datetime.datetime.fromisoformat( "2024-01-15 09:30:00+00:00", ), @@ -38972,7 +39088,7 @@ client.knowledgebase.users.list(
-
client.knowledgebase.users.retrieve(...) +
client.ticketing.projects.retrieve(...)
@@ -38984,7 +39100,7 @@ client.knowledgebase.users.list(
-Returns a `User` object with the given `id`. +Returns a `Project` object with the given `id`.
@@ -39005,7 +39121,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.knowledgebase.users.retrieve( +client.ticketing.projects.retrieve( id="id", include_remote_data=True, include_shell_data=True, @@ -39061,8 +39177,7 @@ client.knowledgebase.users.retrieve(
-## Knowledgebase WebhookReceivers -
client.knowledgebase.webhook_receivers.list() +
client.ticketing.projects.users_list(...)
@@ -39074,7 +39189,7 @@ client.knowledgebase.users.retrieve(
-Returns a list of `WebhookReceiver` objects. +Returns a list of `User` objects.
@@ -39090,12 +39205,143 @@ Returns a list of `WebhookReceiver` objects. ```python from merge import Merge +from merge.resources.ticketing.resources.projects import ( + ProjectsUsersListRequestExpand, +) client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.knowledgebase.webhook_receivers.list() +client.ticketing.projects.users_list( + parent_id="parent_id", + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + expand=ProjectsUsersListRequestExpand.ROLES, + include_deleted_data=True, + include_remote_data=True, + include_shell_data=True, + page_size=1, +) + +``` + +
+ + + +#### ⚙️ Parameters + +
+
+ +
+
+ +**parent_id:** `str` + +
+
+ +
+
+ +**cursor:** `typing.Optional[str]` — The pagination cursor value. + +
+
+ +
+
+ +**expand:** `typing.Optional[ProjectsUsersListRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. + +
+
+ +
+
+ +**include_deleted_data:** `typing.Optional[bool]` — 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. The maximum limit is 100. + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + + + +
+ +## Ticketing RegenerateKey +
client.ticketing.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.ticketing.regenerate_key.create( + name="Remote Deployment Key 1", +) ```
@@ -39111,6 +39357,14 @@ client.knowledgebase.webhook_receivers.list()
+**name:** `str` — The name of the remote key + +
+
+ +
+
+ **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -39123,7 +39377,8 @@ client.knowledgebase.webhook_receivers.list()
-
client.knowledgebase.webhook_receivers.create(...) +## Ticketing Roles +
client.ticketing.roles.list(...)
@@ -39135,7 +39390,7 @@ client.knowledgebase.webhook_receivers.list()
-Creates a `WebhookReceiver` object with the given values. +Returns a list of `Role` objects.
@@ -39150,15 +39405,33 @@ Creates a `WebhookReceiver` object with the given values.
```python +import datetime + from merge import Merge client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.knowledgebase.webhook_receivers.create( - event="event", - is_active=True, +client.ticketing.roles.list( + created_after=datetime.datetime.fromisoformat( + "2024-01-15 09:30:00+00:00", + ), + created_before=datetime.datetime.fromisoformat( + "2024-01-15 09:30:00+00:00", + ), + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + include_deleted_data=True, + include_remote_data=True, + include_shell_data=True, + modified_after=datetime.datetime.fromisoformat( + "2024-01-15 09:30:00+00:00", + ), + modified_before=datetime.datetime.fromisoformat( + "2024-01-15 09:30:00+00:00", + ), + page_size=1, + remote_id="remote_id", ) ``` @@ -39175,7 +39448,7 @@ client.knowledgebase.webhook_receivers.create(
-**event:** `str` +**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
@@ -39183,7 +39456,7 @@ client.knowledgebase.webhook_receivers.create(
-**is_active:** `bool` +**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
@@ -39191,7 +39464,7 @@ client.knowledgebase.webhook_receivers.create(
-**key:** `typing.Optional[str]` +**cursor:** `typing.Optional[str]` — The pagination cursor value.
@@ -39199,65 +39472,59 @@ client.knowledgebase.webhook_receivers.create(
-**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. +
-
-## Ticketing AccountDetails -
client.ticketing.account_details.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). + +
+
-Get details for a linked account. -
-
+**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.ticketing.account_details.retrieve() - -``` -
-
+**page_size:** `typing.Optional[int]` — Number of results to return per page. The maximum limit is 100. + -#### ⚙️ Parameters -
+**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object. + +
+
+
@@ -39273,8 +39540,7 @@ client.ticketing.account_details.retrieve()
-## Ticketing AccountToken -
client.ticketing.account_token.retrieve(...) +
client.ticketing.roles.retrieve(...)
@@ -39286,7 +39552,7 @@ client.ticketing.account_details.retrieve()
-Returns the account token for the end user with the provided public token. +Returns a `Role` object with the given `id`.
@@ -39307,8 +39573,10 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.account_token.retrieve( - public_token="public_token", +client.ticketing.roles.retrieve( + id="id", + include_remote_data=True, + include_shell_data=True, ) ``` @@ -39325,7 +39593,23 @@ client.ticketing.account_token.retrieve(
-**public_token:** `str` +**id:** `str` + +
+
+ +
+
+ +**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. + +
+
+ +
+
+ +**include_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).
@@ -39345,8 +39629,8 @@ client.ticketing.account_token.retrieve(
-## Ticketing Accounts -
client.ticketing.accounts.list(...) +## Ticketing SyncStatus +
client.ticketing.sync_status.list(...)
@@ -39358,7 +39642,7 @@ client.ticketing.account_token.retrieve(
-Returns a list of `Account` objects. +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).
@@ -39373,33 +39657,15 @@ Returns a list of `Account` objects.
```python -import datetime - from merge import Merge client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.accounts.list( - created_after=datetime.datetime.fromisoformat( - "2024-01-15 09:30:00+00:00", - ), - created_before=datetime.datetime.fromisoformat( - "2024-01-15 09:30:00+00:00", - ), +client.ticketing.sync_status.list( cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", - include_deleted_data=True, - include_remote_data=True, - include_shell_data=True, - modified_after=datetime.datetime.fromisoformat( - "2024-01-15 09:30:00+00:00", - ), - modified_before=datetime.datetime.fromisoformat( - "2024-01-15 09:30:00+00:00", - ), page_size=1, - remote_id="remote_id", ) ``` @@ -39416,7 +39682,7 @@ client.ticketing.accounts.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.
@@ -39424,7 +39690,7 @@ client.ticketing.accounts.list(
-**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime. +**page_size:** `typing.Optional[int]` — Number of results to return per page. The maximum limit is 100.
@@ -39432,67 +39698,65 @@ client.ticketing.accounts.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 ForceResync +
client.ticketing.force_resync.sync_status_resync_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). - -
-
-
-**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.
+ + + +#### 🔌 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.ticketing.force_resync.sync_status_resync_create() + +``` +
+
+#### ⚙️ Parameters +
-**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object. - -
-
-
@@ -39508,7 +39772,8 @@ client.ticketing.accounts.list(
-
client.ticketing.accounts.retrieve(...) +## Ticketing Tags +
client.ticketing.tags.list(...)
@@ -39520,7 +39785,7 @@ client.ticketing.accounts.list(
-Returns an `Account` object with the given `id`. +Returns a list of `Tag` objects.
@@ -39535,16 +39800,33 @@ Returns an `Account` object with the given `id`.
```python +import datetime + from merge import Merge client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.accounts.retrieve( - id="id", +client.ticketing.tags.list( + created_after=datetime.datetime.fromisoformat( + "2024-01-15 09:30:00+00:00", + ), + created_before=datetime.datetime.fromisoformat( + "2024-01-15 09:30:00+00:00", + ), + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + include_deleted_data=True, include_remote_data=True, include_shell_data=True, + modified_after=datetime.datetime.fromisoformat( + "2024-01-15 09:30:00+00:00", + ), + modified_before=datetime.datetime.fromisoformat( + "2024-01-15 09:30:00+00:00", + ), + page_size=1, + remote_id="remote_id", ) ``` @@ -39561,7 +39843,7 @@ client.ticketing.accounts.retrieve(
-**id:** `str` +**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
@@ -39569,7 +39851,7 @@ client.ticketing.accounts.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.
@@ -39577,7 +39859,7 @@ client.ticketing.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). +**cursor:** `typing.Optional[str]` — The pagination cursor value.
@@ -39585,75 +39867,55 @@ client.ticketing.accounts.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/).
-
-
- - - - -
-## Ticketing AsyncPassthrough -
client.ticketing.async_passthrough.create(...)
-#### 📝 Description - -
-
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. + +
+
-Asynchronously pull data from an endpoint not currently supported by 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). +
-#### 🔌 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.ticketing import DataPassthroughRequest, MethodEnum - -client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.ticketing.async_passthrough.create( - request=DataPassthroughRequest( - method=MethodEnum.GET, - path="/scooters", - ), -) - -``` -
-
+**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. The maximum limit is 100. + +
+
+
-**request:** `DataPassthroughRequest` +**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
@@ -39673,7 +39935,7 @@ client.ticketing.async_passthrough.create(
-
client.ticketing.async_passthrough.retrieve(...) +
client.ticketing.tags.retrieve(...)
@@ -39685,7 +39947,7 @@ client.ticketing.async_passthrough.create(
-Retrieves data from earlier async-passthrough POST request +Returns a `Tag` object with the given `id`.
@@ -39706,8 +39968,10 @@ 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.ticketing.tags.retrieve( + id="id", + include_remote_data=True, + include_shell_data=True, ) ``` @@ -39724,7 +39988,23 @@ client.ticketing.async_passthrough.retrieve(
-**async_passthrough_receipt_id:** `str` +**id:** `str` + +
+
+ +
+
+ +**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. + +
+
+ +
+
+ +**include_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).
@@ -39744,8 +40024,8 @@ client.ticketing.async_passthrough.retrieve(
-## Ticketing Attachments -
client.ticketing.attachments.list(...) +## Ticketing Teams +
client.ticketing.teams.list(...)
@@ -39757,7 +40037,7 @@ client.ticketing.async_passthrough.retrieve(
-Returns a list of `Attachment` objects. +Returns a list of `Team` objects.
@@ -39780,7 +40060,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.attachments.list( +client.ticketing.teams.list( created_after=datetime.datetime.fromisoformat( "2024-01-15 09:30:00+00:00", ), @@ -39798,11 +40078,7 @@ client.ticketing.attachments.list( "2024-01-15 09:30:00+00:00", ), page_size=1, - remote_created_after=datetime.datetime.fromisoformat( - "2024-01-15 09:30:00+00:00", - ), remote_id="remote_id", - ticket_id="ticket_id", ) ``` @@ -39843,14 +40119,6 @@ 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. - -
-
- -
-
- **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/).
@@ -39899,14 +40167,6 @@ 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. - -
-
- -
-
- **remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
@@ -39915,14 +40175,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.
@@ -39935,7 +40187,7 @@ client.ticketing.attachments.list(
-
client.ticketing.attachments.create(...) +
client.ticketing.teams.retrieve(...)
@@ -39947,7 +40199,7 @@ client.ticketing.attachments.list(
-Creates an `Attachment` object with the given values. +Returns a `Team` object with the given `id`.
@@ -39963,16 +40215,15 @@ 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( - is_debug_mode=True, - run_async=True, - model=AttachmentRequest(), +client.ticketing.teams.retrieve( + id="id", + include_remote_data=True, + include_shell_data=True, ) ``` @@ -39989,7 +40240,7 @@ client.ticketing.attachments.create(
-**model:** `AttachmentRequest` +**id:** `str`
@@ -39997,7 +40248,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.
@@ -40005,7 +40256,7 @@ client.ticketing.attachments.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).
@@ -40025,7 +40276,8 @@ client.ticketing.attachments.create(
-
client.ticketing.attachments.retrieve(...) +## Ticketing Tickets +
client.ticketing.tickets.list(...)
@@ -40037,7 +40289,7 @@ client.ticketing.attachments.create(
-Returns an `Attachment` object with the given `id`. +Returns a list of `Ticket` objects.
@@ -40052,16 +40304,81 @@ Returns an `Attachment` object with the given `id`.
```python +import datetime + from merge import Merge +from merge.resources.ticketing.resources.tickets import ( + TicketsListRequestExpand, + TicketsListRequestPriority, + TicketsListRequestRemoteFields, + TicketsListRequestShowEnumOrigins, + TicketsListRequestStatus, +) client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.attachments.retrieve( - id="id", +client.ticketing.tickets.list( + account_id="account_id", + assignee_ids="assignee_ids", + collection_ids="collection_ids", + completed_after=datetime.datetime.fromisoformat( + "2024-01-15 09:30:00+00:00", + ), + completed_before=datetime.datetime.fromisoformat( + "2024-01-15 09:30:00+00:00", + ), + contact_id="contact_id", + created_after=datetime.datetime.fromisoformat( + "2024-01-15 09:30:00+00:00", + ), + created_before=datetime.datetime.fromisoformat( + "2024-01-15 09:30:00+00:00", + ), + creator_id="creator_id", + creator_ids="creator_ids", + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + due_after=datetime.datetime.fromisoformat( + "2024-01-15 09:30:00+00:00", + ), + due_before=datetime.datetime.fromisoformat( + "2024-01-15 09:30:00+00:00", + ), + expand=TicketsListRequestExpand.ACCOUNT, + include_deleted_data=True, include_remote_data=True, + include_remote_fields=True, include_shell_data=True, + modified_after=datetime.datetime.fromisoformat( + "2024-01-15 09:30:00+00:00", + ), + modified_before=datetime.datetime.fromisoformat( + "2024-01-15 09:30:00+00:00", + ), + name="name", + page_size=1, + parent_ticket_id="parent_ticket_id", + priority=TicketsListRequestPriority.HIGH, + remote_created_after=datetime.datetime.fromisoformat( + "2024-01-15 09:30:00+00:00", + ), + remote_created_before=datetime.datetime.fromisoformat( + "2024-01-15 09:30:00+00:00", + ), + remote_fields=TicketsListRequestRemoteFields.PRIORITY, + remote_id="remote_id", + remote_updated_after=datetime.datetime.fromisoformat( + "2024-01-15 09:30:00+00:00", + ), + remote_updated_before=datetime.datetime.fromisoformat( + "2024-01-15 09:30:00+00:00", + ), + show_enum_origins=TicketsListRequestShowEnumOrigins.PRIORITY, + status=TicketsListRequestStatus.EMPTY, + tags="tags", + ticket_type="ticket_type", + ticket_url="ticket_url", ) ``` @@ -40078,7 +40395,7 @@ client.ticketing.attachments.retrieve(
-**id:** `str` +**account_id:** `typing.Optional[str]` — If provided, will only return tickets for this account.
@@ -40086,7 +40403,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. +**assignee_ids:** `typing.Optional[str]` — If provided, will only return tickets assigned to the assignee_ids; multiple assignee_ids can be separated by commas.
@@ -40094,7 +40411,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. +**collection_ids:** `typing.Optional[str]` — If provided, will only return tickets assigned to the collection_ids; multiple collection_ids can be separated by commas.
@@ -40102,7 +40419,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). +**completed_after:** `typing.Optional[dt.datetime]` — If provided, will only return tickets completed after this datetime.
@@ -40110,137 +40427,119 @@ client.ticketing.attachments.retrieve(
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. +**completed_before:** `typing.Optional[dt.datetime]` — If provided, will only return tickets completed before this datetime.
-
-
+
+
+**contact_id:** `typing.Optional[str]` — If provided, will only return tickets for this contact. +
-
-
client.ticketing.attachments.meta_post_retrieve()
-#### 📝 Description - -
-
+**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime. + +
+
-Returns metadata for `TicketingAttachment` POSTs. -
-
+**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created 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() - -``` -
-
+**creator_id:** `typing.Optional[str]` — If provided, will only return tickets created by this creator_id. +
-#### ⚙️ Parameters -
+**creator_ids:** `typing.Optional[str]` — If provided, will only return tickets created by the creator_ids; multiple creator_ids can be separated by commas. + +
+
+
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. +**cursor:** `typing.Optional[str]` — The pagination cursor value.
- - +
+
+**due_after:** `typing.Optional[dt.datetime]` — If provided, will only return tickets due after this datetime. +
-
-## Ticketing AuditTrail -
client.ticketing.audit_trail.list(...)
-#### 📝 Description +**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. + +
+
+
-Gets a list of audit trail events. -
-
+**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.ticketing.audit_trail.list( - cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", - end_date="end_date", - event_type="event_type", - page_size=1, - start_date="start_date", - user_email="user_email", -) - -``` -
-
+**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 -
+**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. +**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
@@ -40248,7 +40547,7 @@ client.ticketing.audit_trail.list(
-**end_date:** `typing.Optional[str]` — If included, will only include audit trail events that occurred before this time +**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
@@ -40256,7 +40555,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` +**name:** `typing.Optional[str]` — If provided, will only return tickets with this name.
@@ -40272,7 +40571,7 @@ client.ticketing.audit_trail.list(
-**start_date:** `typing.Optional[str]` — If included, will only include audit trail events that occurred after this time +**parent_ticket_id:** `typing.Optional[str]` — If provided, will only return sub tickets of the parent_ticket_id.
@@ -40280,7 +40579,14 @@ 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. +**priority:** `typing.Optional[TicketsListRequestPriority]` + +If provided, will only return tickets of this priority. + +* `URGENT` - URGENT +* `HIGH` - HIGH +* `NORMAL` - NORMAL +* `LOW` - LOW
@@ -40288,65 +40594,91 @@ client.ticketing.audit_trail.list(
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. +**remote_created_after:** `typing.Optional[dt.datetime]` — If provided, will only return tickets created in the third party platform after this datetime.
- - +
+
+**remote_created_before:** `typing.Optional[dt.datetime]` — If provided, will only return tickets created in the third party platform before this datetime. +
-
-## Ticketing AvailableActions -
client.ticketing.available_actions.retrieve()
-#### 📝 Description +**remote_fields:** `typing.Optional[TicketsListRequestRemoteFields]` — Deprecated. Use show_enum_origins. + +
+
+**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object. + +
+
+
-Returns a list of models and actions available for an account. +**remote_updated_after:** `typing.Optional[dt.datetime]` — If provided, will only return tickets updated in the third party platform after this datetime. +
+ +
+
+ +**remote_updated_before:** `typing.Optional[dt.datetime]` — If provided, will only return tickets updated in the third party platform before this datetime. +
-#### 🔌 Usage -
+**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) + +
+
+
-```python -from merge import Merge +**status:** `typing.Optional[TicketsListRequestStatus]` — If provided, will only return tickets of this status. + +
+
-client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.ticketing.available_actions.retrieve() +
+
-``` +**tags:** `typing.Optional[str]` — If provided, will only return tickets matching the tags; multiple tags can be separated by commas. +
+ +
+
+ +**ticket_type:** `typing.Optional[str]` — If provided, will only return tickets of this type. +
-#### ⚙️ Parameters -
+**ticket_url:** `typing.Optional[str]` — If provided, will only return tickets where the URL matches or contains the substring + +
+
+
@@ -40362,8 +40694,7 @@ client.ticketing.available_actions.retrieve()
-## Ticketing Collections -
client.ticketing.collections.list(...) +
client.ticketing.tickets.create(...)
@@ -40375,7 +40706,7 @@ client.ticketing.available_actions.retrieve()
-Returns a list of `Collection` objects. +Creates a `Ticket` object with the given values.
@@ -40390,39 +40721,17 @@ Returns a list of `Collection` objects.
```python -import datetime - from merge import Merge -from merge.resources.ticketing.resources.collections import ( - CollectionsListRequestCollectionType, -) +from merge.resources.ticketing import TicketRequest client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.collections.list( - collection_type=CollectionsListRequestCollectionType.EMPTY, - created_after=datetime.datetime.fromisoformat( - "2024-01-15 09:30:00+00:00", - ), - created_before=datetime.datetime.fromisoformat( - "2024-01-15 09:30:00+00:00", - ), - cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", - include_deleted_data=True, - include_remote_data=True, - include_shell_data=True, - modified_after=datetime.datetime.fromisoformat( - "2024-01-15 09:30:00+00:00", - ), - modified_before=datetime.datetime.fromisoformat( - "2024-01-15 09:30:00+00:00", - ), - name="name", - page_size=1, - parent_collection_id="parent_collection_id", - remote_id="remote_id", +client.ticketing.tickets.create( + is_debug_mode=True, + run_async=True, + model=TicketRequest(), ) ``` @@ -40439,7 +40748,7 @@ client.ticketing.collections.list(
-**collection_type:** `typing.Optional[CollectionsListRequestCollectionType]` — If provided, will only return collections of the given type. +**model:** `TicketRequest`
@@ -40447,7 +40756,7 @@ client.ticketing.collections.list(
-**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime. +**is_debug_mode:** `typing.Optional[bool]` — Whether to include debug fields (such as log file links) in the response.
@@ -40455,7 +40764,7 @@ client.ticketing.collections.list(
-**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime. +**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously.
@@ -40463,55 +40772,81 @@ client.ticketing.collections.list(
-**cursor:** `typing.Optional[str]` — The pagination cursor value. +**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. -
+
+
client.ticketing.tickets.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 `Ticket` 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 +from merge.resources.ticketing.resources.tickets import ( + TicketsRetrieveRequestExpand, + TicketsRetrieveRequestRemoteFields, + TicketsRetrieveRequestShowEnumOrigins, +) + +client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.ticketing.tickets.retrieve( + id="id", + expand=TicketsRetrieveRequestExpand.ACCOUNT, + include_remote_data=True, + include_remote_fields=True, + include_shell_data=True, + remote_fields=TicketsRetrieveRequestRemoteFields.PRIORITY, + show_enum_origins=TicketsRetrieveRequestShowEnumOrigins.PRIORITY, +) + +``` +
+
+#### ⚙️ Parameters +
-**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned. +
+
+ +**id:** `str`
@@ -40519,7 +40854,7 @@ client.ticketing.collections.list(
-**name:** `typing.Optional[str]` — If provided, will only return collections with this name. +**expand:** `typing.Optional[TicketsRetrieveRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -40527,7 +40862,7 @@ client.ticketing.collections.list(
-**page_size:** `typing.Optional[int]` — Number of results to return per page. The maximum limit is 100. +**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -40535,7 +40870,7 @@ client.ticketing.collections.list(
-**parent_collection_id:** `typing.Optional[str]` — If provided, will only return collections whose parent collection matches 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.
@@ -40543,7 +40878,7 @@ client.ticketing.collections.list(
-**remote_fields:** `typing.Optional[typing.Literal["collection_type"]]` — Deprecated. Use show_enum_origins. +**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).
@@ -40551,7 +40886,7 @@ client.ticketing.collections.list(
-**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object. +**remote_fields:** `typing.Optional[TicketsRetrieveRequestRemoteFields]` — Deprecated. Use show_enum_origins.
@@ -40559,7 +40894,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) +**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)
@@ -40579,7 +40914,7 @@ client.ticketing.collections.list(
-
client.ticketing.collections.viewers_list(...) +
client.ticketing.tickets.partial_update(...)
@@ -40591,7 +40926,7 @@ client.ticketing.collections.list(
-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) +Updates a `Ticket` object with the given `id`.
@@ -40607,22 +40942,17 @@ Returns a list of `Viewer` objects that point to a User id or Team id that is ei ```python from merge import Merge -from merge.resources.ticketing.resources.collections import ( - CollectionsViewersListRequestExpand, -) +from merge.resources.ticketing import PatchedTicketRequest client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.collections.viewers_list( - collection_id="collection_id", - cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", - expand=CollectionsViewersListRequestExpand.TEAM, - include_deleted_data=True, - include_remote_data=True, - include_shell_data=True, - page_size=1, +client.ticketing.tickets.partial_update( + id="id", + is_debug_mode=True, + run_async=True, + model=PatchedTicketRequest(), ) ``` @@ -40639,31 +40969,7 @@ client.ticketing.collections.viewers_list(
-**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/). +**id:** `str`
@@ -40671,7 +40977,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. +**model:** `PatchedTicketRequest`
@@ -40679,7 +40985,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). +**is_debug_mode:** `typing.Optional[bool]` — Whether to include debug fields (such as log file links) in the response.
@@ -40687,7 +40993,7 @@ client.ticketing.collections.viewers_list(
-**page_size:** `typing.Optional[int]` — Number of results to return per page. +**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously.
@@ -40707,7 +41013,7 @@ client.ticketing.collections.viewers_list(
-
client.ticketing.collections.retrieve(...) +
client.ticketing.tickets.viewers_list(...)
@@ -40719,7 +41025,7 @@ client.ticketing.collections.viewers_list(
-Returns a `Collection` object with the given `id`. +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)
@@ -40735,15 +41041,22 @@ Returns a `Collection` object with the given `id`. ```python from merge import Merge +from merge.resources.ticketing.resources.tickets import ( + TicketsViewersListRequestExpand, +) client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.collections.retrieve( - id="id", +client.ticketing.tickets.viewers_list( + ticket_id="ticket_id", + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + expand=TicketsViewersListRequestExpand.TEAM, + include_deleted_data=True, include_remote_data=True, include_shell_data=True, + page_size=1, ) ``` @@ -40760,7 +41073,7 @@ client.ticketing.collections.retrieve(
-**id:** `str` +**ticket_id:** `str`
@@ -40768,7 +41081,7 @@ client.ticketing.collections.retrieve(
-**expand:** `typing.Optional[typing.Literal["parent_collection"]]` — 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.
@@ -40776,7 +41089,7 @@ client.ticketing.collections.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[TicketsViewersListRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -40784,7 +41097,7 @@ client.ticketing.collections.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_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/).
@@ -40792,7 +41105,7 @@ client.ticketing.collections.retrieve(
-**remote_fields:** `typing.Optional[typing.Literal["collection_type"]]` — Deprecated. Use show_enum_origins. +**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -40800,7 +41113,15 @@ 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) +**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. The maximum limit is 100.
@@ -40820,8 +41141,7 @@ client.ticketing.collections.retrieve(
-## Ticketing Comments -
client.ticketing.comments.list(...) +
client.ticketing.tickets.meta_patch_retrieve(...)
@@ -40833,7 +41153,7 @@ client.ticketing.collections.retrieve(
-Returns a list of `Comment` objects. +Returns metadata for `Ticket` PATCHs.
@@ -40848,41 +41168,14 @@ Returns a list of `Comment` objects.
```python -import datetime - from merge import Merge -from merge.resources.ticketing.resources.comments import ( - CommentsListRequestExpand, -) client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.comments.list( - created_after=datetime.datetime.fromisoformat( - "2024-01-15 09:30:00+00:00", - ), - created_before=datetime.datetime.fromisoformat( - "2024-01-15 09:30:00+00:00", - ), - cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", - expand=CommentsListRequestExpand.CONTACT, - include_deleted_data=True, - include_remote_data=True, - include_shell_data=True, - modified_after=datetime.datetime.fromisoformat( - "2024-01-15 09:30:00+00:00", - ), - modified_before=datetime.datetime.fromisoformat( - "2024-01-15 09:30:00+00:00", - ), - page_size=1, - remote_created_after=datetime.datetime.fromisoformat( - "2024-01-15 09:30:00+00:00", - ), - remote_id="remote_id", - ticket_id="ticket_id", +client.ticketing.tickets.meta_patch_retrieve( + id="id", ) ``` @@ -40899,7 +41192,7 @@ client.ticketing.comments.list(
-**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime. +**id:** `str`
@@ -40907,87 +41200,71 @@ client.ticketing.comments.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. -
-
-
-**expand:** `typing.Optional[CommentsListRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. -
+
+
client.ticketing.tickets.meta_post_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 metadata for `Ticket` POSTs.
- -
-
- -**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. The maximum limit is 100. - +```python +from merge import Merge + +client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.ticketing.tickets.meta_post_retrieve( + collection_id="collection_id", + ticket_type="ticket_type", +) + +```
+ + + +#### ⚙️ Parameters
-**remote_created_after:** `typing.Optional[dt.datetime]` — If provided, will only return Comments created in the third party platform after this datetime. - -
-
-
-**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object. +**collection_id:** `typing.Optional[str]` — If provided, will only return tickets for this collection.
@@ -40995,7 +41272,7 @@ client.ticketing.comments.list(
-**ticket_id:** `typing.Optional[str]` — If provided, will only return comments for this ticket. +**ticket_type:** `typing.Optional[str]` — If provided, will only return tickets for this ticket type.
@@ -41015,7 +41292,7 @@ client.ticketing.comments.list(
-
client.ticketing.comments.create(...) +
client.ticketing.tickets.remote_field_classes_list(...)
@@ -41027,7 +41304,7 @@ client.ticketing.comments.list(
-Creates a `Comment` object with the given values. +Returns a list of `RemoteFieldClass` objects.
@@ -41043,16 +41320,20 @@ 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( - is_debug_mode=True, - run_async=True, - model=CommentRequest(), +client.ticketing.tickets.remote_field_classes_list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + ids="ids", + include_deleted_data=True, + include_remote_data=True, + include_shell_data=True, + is_common_model_field=True, + is_custom=True, + page_size=1, ) ``` @@ -41069,7 +41350,47 @@ client.ticketing.comments.create(
-**model:** `CommentRequest` +**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 + +
+
+ +
+
+ +**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). + +
+
+ +
+
+ +**is_common_model_field:** `typing.Optional[bool]` — If provided, will only return remote field classes with this is_common_model_field value
@@ -41077,7 +41398,7 @@ client.ticketing.comments.create(
-**is_debug_mode:** `typing.Optional[bool]` — Whether to include debug fields (such as log file links) in the response. +**is_custom:** `typing.Optional[bool]` — If provided, will only return remote fields classes with this is_custom value
@@ -41085,7 +41406,7 @@ client.ticketing.comments.create(
-**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously. +**page_size:** `typing.Optional[int]` — Number of results to return per page. The maximum limit is 100.
@@ -41105,7 +41426,8 @@ client.ticketing.comments.create(
-
client.ticketing.comments.retrieve(...) +## Ticketing Users +
client.ticketing.users.list(...)
@@ -41117,7 +41439,7 @@ client.ticketing.comments.create(
-Returns a `Comment` object with the given `id`. +Returns a list of `User` objects.
@@ -41132,20 +41454,37 @@ Returns a `Comment` object with the given `id`.
```python +import datetime + from merge import Merge -from merge.resources.ticketing.resources.comments import ( - CommentsRetrieveRequestExpand, -) +from merge.resources.ticketing.resources.users import UsersListRequestExpand client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.comments.retrieve( - id="id", - expand=CommentsRetrieveRequestExpand.CONTACT, +client.ticketing.users.list( + created_after=datetime.datetime.fromisoformat( + "2024-01-15 09:30:00+00:00", + ), + created_before=datetime.datetime.fromisoformat( + "2024-01-15 09:30:00+00:00", + ), + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + email_address="email_address", + expand=UsersListRequestExpand.ROLES, + include_deleted_data=True, include_remote_data=True, include_shell_data=True, + modified_after=datetime.datetime.fromisoformat( + "2024-01-15 09:30:00+00:00", + ), + modified_before=datetime.datetime.fromisoformat( + "2024-01-15 09:30:00+00:00", + ), + page_size=1, + remote_id="remote_id", + team="team", ) ``` @@ -41162,7 +41501,7 @@ client.ticketing.comments.retrieve(
-**id:** `str` +**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
@@ -41170,7 +41509,7 @@ 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.
@@ -41178,7 +41517,7 @@ client.ticketing.comments.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.
@@ -41186,7 +41525,7 @@ client.ticketing.comments.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_address:** `typing.Optional[str]` — If provided, will only return users with emails equal to this value (case insensitive).
@@ -41194,64 +41533,75 @@ client.ticketing.comments.retrieve(
-**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.
-
-
+
+
+**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.comments.meta_post_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). + +
+
+
-Returns metadata for `Comment` POSTs. -
-
+**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.ticketing.comments.meta_post_retrieve() - -``` +**page_size:** `typing.Optional[int]` — Number of results to return per page. The maximum limit is 100. +
+ +
+
+ +**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object. +
-#### ⚙️ Parameters -
+**team:** `typing.Optional[str]` — If provided, will only return users matching in this team. + +
+
+
@@ -41267,8 +41617,7 @@ client.ticketing.comments.meta_post_retrieve()
-## Ticketing Contacts -
client.ticketing.contacts.list(...) +
client.ticketing.users.retrieve(...)
@@ -41280,7 +41629,7 @@ client.ticketing.comments.meta_post_retrieve()
-Returns a list of `Contact` objects. +Returns a `User` object with the given `id`.
@@ -41295,34 +41644,18 @@ Returns a list of `Contact` objects.
```python -import datetime - from merge import Merge +from merge.resources.ticketing.resources.users import UsersRetrieveRequestExpand client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.contacts.list( - created_after=datetime.datetime.fromisoformat( - "2024-01-15 09:30:00+00:00", - ), - created_before=datetime.datetime.fromisoformat( - "2024-01-15 09:30:00+00:00", - ), - cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", - email_address="email_address", - include_deleted_data=True, +client.ticketing.users.retrieve( + id="id", + expand=UsersRetrieveRequestExpand.ROLES, include_remote_data=True, include_shell_data=True, - modified_after=datetime.datetime.fromisoformat( - "2024-01-15 09:30:00+00:00", - ), - modified_before=datetime.datetime.fromisoformat( - "2024-01-15 09:30:00+00:00", - ), - page_size=1, - remote_id="remote_id", ) ``` @@ -41339,7 +41672,7 @@ client.ticketing.contacts.list(
-**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime. +**id:** `str`
@@ -41347,7 +41680,7 @@ client.ticketing.contacts.list(
-**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime. +**expand:** `typing.Optional[UsersRetrieveRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -41355,7 +41688,7 @@ client.ticketing.contacts.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.
@@ -41363,7 +41696,7 @@ client.ticketing.contacts.list(
-**email_address:** `typing.Optional[str]` — If provided, will only return Contacts that match this 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).
@@ -41371,67 +41704,65 @@ 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. +**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 WebhookReceivers +
client.ticketing.webhook_receivers.list()
-**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). - -
-
-
-**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. The maximum limit is 100. - +```python +from merge import Merge + +client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.ticketing.webhook_receivers.list() + +``` +
+
+#### ⚙️ Parameters +
-**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object. - -
-
-
@@ -41447,7 +41778,7 @@ client.ticketing.contacts.list(
-
client.ticketing.contacts.create(...) +
client.ticketing.webhook_receivers.create(...)
@@ -41459,7 +41790,7 @@ client.ticketing.contacts.list(
-Creates a `Contact` object with the given values. +Creates a `WebhookReceiver` object with the given values.
@@ -41475,16 +41806,14 @@ Creates a `Contact` object with the given values. ```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( - is_debug_mode=True, - run_async=True, - model=ContactRequest(), +client.ticketing.webhook_receivers.create( + event="event", + is_active=True, ) ``` @@ -41501,7 +41830,7 @@ client.ticketing.contacts.create(
-**model:** `ContactRequest` +**event:** `str`
@@ -41509,7 +41838,7 @@ client.ticketing.contacts.create(
-**is_debug_mode:** `typing.Optional[bool]` — Whether to include debug fields (such as log file links) in the response. +**is_active:** `bool`
@@ -41517,7 +41846,7 @@ client.ticketing.contacts.create(
-**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously. +**key:** `typing.Optional[str]`
@@ -41537,7 +41866,8 @@ client.ticketing.contacts.create(
-
client.ticketing.contacts.retrieve(...) +## Filestorage AccountDetails +
client.filestorage.account_details.retrieve()
@@ -41549,7 +41879,7 @@ client.ticketing.contacts.create(
-Returns a `Contact` object with the given `id`. +Get details for a linked account.
@@ -41570,11 +41900,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.contacts.retrieve( - id="id", - include_remote_data=True, - include_shell_data=True, -) +client.filestorage.account_details.retrieve() ``` @@ -41582,43 +41908,11 @@ client.ticketing.contacts.retrieve(
-#### ⚙️ Parameters - -
-
- -
-
- -**id:** `str` - -
-
- -
-
- -**expand:** `typing.Optional[typing.Literal["account"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. - -
-
- -
-
- -**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. - -
-
+#### ⚙️ 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). - -
-
-
@@ -41634,7 +41928,8 @@ client.ticketing.contacts.retrieve(
-
client.ticketing.contacts.meta_post_retrieve() +## Filestorage AccountToken +
client.filestorage.account_token.retrieve(...)
@@ -41646,7 +41941,7 @@ client.ticketing.contacts.retrieve(
-Returns metadata for `TicketingContact` POSTs. +Returns the account token for the end user with the provided public token.
@@ -41667,7 +41962,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.contacts.meta_post_retrieve() +client.filestorage.account_token.retrieve( + public_token="public_token", +) ``` @@ -41683,6 +41980,14 @@ client.ticketing.contacts.meta_post_retrieve()
+**public_token:** `str` + +
+
+ +
+
+ **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -41695,8 +42000,8 @@ client.ticketing.contacts.meta_post_retrieve()
-## Ticketing Scopes -
client.ticketing.scopes.default_scopes_retrieve() +## Filestorage AsyncPassthrough +
client.filestorage.async_passthrough.create(...)
@@ -41708,7 +42013,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). +Asynchronously pull data from an endpoint not currently supported by Merge.
@@ -41724,12 +42029,18 @@ Get the default permissions for Merge Common Models and fields across all Linked ```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.ticketing.scopes.default_scopes_retrieve() +client.filestorage.async_passthrough.create( + request=DataPassthroughRequest( + method=MethodEnum.GET, + path="/scooters", + ), +) ``` @@ -41745,6 +42056,14 @@ client.ticketing.scopes.default_scopes_retrieve()
+**request:** `DataPassthroughRequest` + +
+
+ +
+
+ **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -41757,7 +42076,7 @@ client.ticketing.scopes.default_scopes_retrieve()
-
client.ticketing.scopes.linked_account_scopes_retrieve() +
client.filestorage.async_passthrough.retrieve(...)
@@ -41769,7 +42088,7 @@ client.ticketing.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). +Retrieves data from earlier async-passthrough POST request
@@ -41790,7 +42109,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.scopes.linked_account_scopes_retrieve() +client.filestorage.async_passthrough.retrieve( + async_passthrough_receipt_id="async_passthrough_receipt_id", +) ``` @@ -41806,6 +42127,14 @@ client.ticketing.scopes.linked_account_scopes_retrieve()
+**async_passthrough_receipt_id:** `str` + +
+
+ +
+
+ **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -41818,7 +42147,8 @@ client.ticketing.scopes.linked_account_scopes_retrieve()
-
client.ticketing.scopes.linked_account_scopes_create(...) +## Filestorage AuditTrail +
client.filestorage.audit_trail.list(...)
@@ -41830,7 +42160,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) +Gets a list of audit trail events.
@@ -41846,42 +42176,18 @@ 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.filestorage.audit_trail.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + end_date="end_date", + event_type="event_type", + page_size=1, + start_date="start_date", + user_email="user_email", ) ``` @@ -41898,7 +42204,47 @@ client.ticketing.scopes.linked_account_scopes_create(
-**common_models:** `typing.Sequence[IndividualCommonModelScopeDeserializerRequest]` — The common models you want to update the scopes for +**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.
@@ -41918,8 +42264,8 @@ client.ticketing.scopes.linked_account_scopes_create(
-## Ticketing DeleteAccount -
client.ticketing.delete_account.delete() +## Filestorage AvailableActions +
client.filestorage.available_actions.retrieve()
@@ -41931,7 +42277,7 @@ client.ticketing.scopes.linked_account_scopes_create(
-Delete a linked account. +Returns a list of models and actions available for an account.
@@ -41952,7 +42298,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.delete_account.delete() +client.filestorage.available_actions.retrieve() ``` @@ -41980,8 +42326,8 @@ client.ticketing.delete_account.delete()
-## Ticketing FieldMapping -
client.ticketing.field_mapping.field_mappings_retrieve(...) +## Filestorage Scopes +
client.filestorage.scopes.default_scopes_retrieve()
@@ -41993,7 +42339,7 @@ client.ticketing.delete_account.delete()
-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/). +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).
@@ -42014,9 +42360,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.field_mapping.field_mappings_retrieve( - exclude_remote_field_metadata=True, -) +client.filestorage.scopes.default_scopes_retrieve() ``` @@ -42032,14 +42376,6 @@ client.ticketing.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.
@@ -42052,7 +42388,7 @@ client.ticketing.field_mapping.field_mappings_retrieve(
-
client.ticketing.field_mapping.field_mappings_create(...) +
client.filestorage.scopes.linked_account_scopes_retrieve()
@@ -42064,7 +42400,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 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).
@@ -42085,15 +42421,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.field_mapping.field_mappings_create( - exclude_remote_field_metadata=True, - 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.filestorage.scopes.linked_account_scopes_retrieve() ``` @@ -42109,63 +42437,99 @@ 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. +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+ +
-
-
-**target_field_description:** `str` — The description of the target field you want this remote field to map to. -
+
+
client.filestorage.scopes.linked_account_scopes_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. - -
-
+#### 📝 Description
-**remote_method:** `str` — The method of the remote endpoint where the remote field is coming from. - +
+
+ +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) +
+
+#### 🔌 Usage +
-**remote_url_path:** `str` — The path of the remote endpoint where the remote field is coming from. - +
+
+ +```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, + ) + }, + ), + ], +) + +```
- -
-
- -**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. - -
-
-
-**jmes_path:** `typing.Optional[str]` — JMES path to specify json query expression to be used on field mapping. +**common_models:** `typing.Sequence[IndividualCommonModelScopeDeserializerRequest]` — The common models you want to update the scopes for
@@ -42185,7 +42549,8 @@ client.ticketing.field_mapping.field_mappings_create(
-
client.ticketing.field_mapping.field_mappings_destroy(...) +## Filestorage DeleteAccount +
client.filestorage.delete_account.delete()
@@ -42197,7 +42562,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. +Delete a linked account.
@@ -42218,9 +42583,7 @@ 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.filestorage.delete_account.delete() ``` @@ -42236,14 +42599,6 @@ client.ticketing.field_mapping.field_mappings_destroy(
-**field_mapping_id:** `str` - -
-
- -
-
- **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -42256,7 +42611,8 @@ client.ticketing.field_mapping.field_mappings_destroy(
-
client.ticketing.field_mapping.field_mappings_partial_update(...) +## Filestorage Drives +
client.filestorage.drives.list(...)
@@ -42268,7 +42624,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 `Drive` objects.
@@ -42283,14 +42639,34 @@ Create or update existing Field Mappings for a Linked Account. Changes will be r
```python +import datetime + from merge import Merge client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.field_mapping.field_mappings_partial_update( - field_mapping_id="field_mapping_id", +client.filestorage.drives.list( + created_after=datetime.datetime.fromisoformat( + "2024-01-15 09:30:00+00:00", + ), + created_before=datetime.datetime.fromisoformat( + "2024-01-15 09:30:00+00:00", + ), + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + include_deleted_data=True, + include_remote_data=True, + include_shell_data=True, + modified_after=datetime.datetime.fromisoformat( + "2024-01-15 09:30:00+00:00", + ), + modified_before=datetime.datetime.fromisoformat( + "2024-01-15 09:30:00+00:00", + ), + name="name", + page_size=1, + remote_id="remote_id", ) ``` @@ -42307,7 +42683,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.
@@ -42315,7 +42691,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.
@@ -42323,7 +42699,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.
@@ -42331,7 +42707,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/).
@@ -42339,7 +42715,7 @@ client.ticketing.field_mapping.field_mappings_partial_update(
-**jmes_path:** `typing.Optional[str]` — JMES path to specify json query expression to be used on field mapping. +**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -42347,71 +42723,39 @@ client.ticketing.field_mapping.field_mappings_partial_update(
-**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).
-
-
- - - - -
-
client.ticketing.field_mapping.remote_fields_retrieve(...)
-#### 📝 Description - -
-
+**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 - -
-
-
-```python -from merge import Merge - -client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.ticketing.field_mapping.remote_fields_retrieve( - common_models="common_models", - include_example_values="include_example_values", -) - -``` -
-
+**name:** `typing.Optional[str]` — If provided, will only return drives with this name. This performs an exact match. +
-#### ⚙️ Parameters - -
-
-
-**common_models:** `typing.Optional[str]` — A comma seperated list of Common Model names. If included, will only return Remote Fields for those Common Models. +**page_size:** `typing.Optional[int]` — Number of results to return per page.
@@ -42419,7 +42763,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. +**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
@@ -42439,7 +42783,7 @@ client.ticketing.field_mapping.remote_fields_retrieve(
-
client.ticketing.field_mapping.target_fields_retrieve() +
client.filestorage.drives.retrieve(...)
@@ -42451,7 +42795,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 `Drive` object with the given `id`.
@@ -42472,7 +42816,11 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.field_mapping.target_fields_retrieve() +client.filestorage.drives.retrieve( + id="id", + include_remote_data=True, + include_shell_data=True, +) ``` @@ -42488,71 +42836,23 @@ 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 - -
-
- -
-
- -Create a remote key. -
-
-
-
- -#### 🔌 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", -) - -``` -
-
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. +
-#### ⚙️ Parameters - -
-
-
-**name:** `str` — The name of the 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).
@@ -42572,8 +42872,8 @@ client.ticketing.generate_key.create(
-## Ticketing Issues -
client.ticketing.issues.list(...) +## Filestorage FieldMapping +
client.filestorage.field_mapping.field_mappings_retrieve(...)
@@ -42585,7 +42885,7 @@ client.ticketing.generate_key.create(
-Gets all issues for Organization. +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/).
@@ -42600,38 +42900,14 @@ Gets all issues for Organization.
```python -import datetime - from merge import Merge -from merge.resources.ticketing.resources.issues import IssuesListRequestStatus client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.issues.list( - account_token="account_token", - cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", - end_date="end_date", - end_user_organization_name="end_user_organization_name", - first_incident_time_after=datetime.datetime.fromisoformat( - "2024-01-15 09:30:00+00:00", - ), - first_incident_time_before=datetime.datetime.fromisoformat( - "2024-01-15 09:30:00+00:00", - ), - include_muted="include_muted", - integration_name="integration_name", - last_incident_time_after=datetime.datetime.fromisoformat( - "2024-01-15 09:30:00+00:00", - ), - last_incident_time_before=datetime.datetime.fromisoformat( - "2024-01-15 09:30:00+00:00", - ), - linked_account_id="linked_account_id", - page_size=1, - start_date="start_date", - status=IssuesListRequestStatus.ONGOING, +client.filestorage.field_mapping.field_mappings_retrieve( + exclude_remote_field_metadata=True, ) ``` @@ -42648,7 +42924,7 @@ client.ticketing.issues.list(
-**account_token:** `typing.Optional[str]` +**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.
@@ -42656,55 +42932,76 @@ client.ticketing.issues.list(
-**cursor:** `typing.Optional[str]` — The pagination cursor value. +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
-
-
-**end_date:** `typing.Optional[str]` — If included, will only include issues whose most recent action occurred before this time -
+
+
client.filestorage.field_mapping.field_mappings_create(...)
-**end_user_organization_name:** `typing.Optional[str]` - -
-
+#### 📝 Description
-**first_incident_time_after:** `typing.Optional[dt.datetime]` — If provided, will only return issues whose first incident time was after this datetime. - +
+
+ +Create new Field Mappings that will be available after the next scheduled sync. This will cause the next sync for this Linked Account to sync **ALL** data from start. +
+
+#### 🔌 Usage + +
+
+
-**first_incident_time_before:** `typing.Optional[dt.datetime]` — If provided, will only return issues whose first incident time was before this datetime. - +```python +from merge import Merge + +client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.filestorage.field_mapping.field_mappings_create( + exclude_remote_field_metadata=True, + target_field_name="example_target_field_name", + target_field_description="this is a example description of the target field", + remote_field_traversal_path=["example_remote_field"], + remote_method="GET", + remote_url_path="/example-url-path", + common_model_name="ExampleCommonModel", +) + +```
+
+
+ +#### ⚙️ Parameters
-**include_muted:** `typing.Optional[str]` — If true, will include muted issues - -
-
-
-**integration_name:** `typing.Optional[str]` +**target_field_name:** `str` — The name of the target field you want this remote field to map to.
@@ -42712,7 +43009,7 @@ client.ticketing.issues.list(
-**last_incident_time_after:** `typing.Optional[dt.datetime]` — If provided, will only return issues whose last incident time was after this datetime. +**target_field_description:** `str` — The description of the target field you want this remote field to map to.
@@ -42720,7 +43017,7 @@ client.ticketing.issues.list(
-**last_incident_time_before:** `typing.Optional[dt.datetime]` — If provided, will only return issues whose last incident time was 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.
@@ -42728,7 +43025,7 @@ client.ticketing.issues.list(
-**linked_account_id:** `typing.Optional[str]` — If provided, will only include issues pertaining to the linked account passed in. +**remote_method:** `str` — The method of the remote endpoint where the remote field is coming from.
@@ -42736,7 +43033,7 @@ client.ticketing.issues.list(
-**page_size:** `typing.Optional[int]` — Number of results to return per page. The maximum limit is 100. +**remote_url_path:** `str` — The path of the remote endpoint where the remote field is coming from.
@@ -42744,7 +43041,7 @@ client.ticketing.issues.list(
-**start_date:** `typing.Optional[str]` — If included, will only include issues whose most recent action occurred after this time +**common_model_name:** `str` — The name of the Common Model that the remote field corresponds to in a given category.
@@ -42752,12 +43049,7 @@ client.ticketing.issues.list(
-**status:** `typing.Optional[IssuesListRequestStatus]` - -Status of the issue. Options: ('ONGOING', 'RESOLVED') - -* `ONGOING` - ONGOING -* `RESOLVED` - RESOLVED +**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.
@@ -42777,7 +43069,7 @@ Status of the issue. Options: ('ONGOING', 'RESOLVED')
-
client.ticketing.issues.retrieve(...) +
client.filestorage.field_mapping.field_mappings_destroy(...)
@@ -42789,7 +43081,7 @@ Status of the issue. Options: ('ONGOING', 'RESOLVED')
-Get a specific issue. +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.
@@ -42810,8 +43102,8 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.issues.retrieve( - id="id", +client.filestorage.field_mapping.field_mappings_destroy( + field_mapping_id="field_mapping_id", ) ``` @@ -42828,7 +43120,7 @@ client.ticketing.issues.retrieve(
-**id:** `str` +**field_mapping_id:** `str`
@@ -42848,8 +43140,7 @@ client.ticketing.issues.retrieve(
-## Ticketing LinkToken -
client.ticketing.link_token.create(...) +
client.filestorage.field_mapping.field_mappings_partial_update(...)
@@ -42861,7 +43152,7 @@ client.ticketing.issues.retrieve(
-Creates a link token to be used when linking a new end user. +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.
@@ -42877,17 +43168,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 client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.link_token.create( - end_user_email_address="example@gmail.com", - end_user_organization_name="Test Organization", - end_user_origin_id="12345", - categories=[CategoriesEnum.HRIS, CategoriesEnum.ATS], +client.filestorage.field_mapping.field_mappings_partial_update( + field_mapping_id="field_mapping_id", ) ``` @@ -42904,7 +43191,7 @@ client.ticketing.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. +**field_mapping_id:** `str`
@@ -42912,7 +43199,7 @@ client.ticketing.link_token.create(
-**end_user_organization_name:** `str` — Your end user's organization. +**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.
@@ -42920,7 +43207,7 @@ client.ticketing.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. +**remote_method:** `typing.Optional[str]` — The method of the remote endpoint where the remote field is coming from.
@@ -42928,7 +43215,7 @@ client.ticketing.link_token.create(
-**categories:** `typing.Sequence[CategoriesEnum]` — The integration categories to show in Merge Link. +**remote_url_path:** `typing.Optional[str]` — The path of the remote endpoint where the remote field is coming from.
@@ -42936,39 +43223,71 @@ client.ticketing.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.filestorage.field_mapping.remote_fields_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 + +
+
+ +
+
+ +Get all remote fields for a Linked Account. Remote fields are third-party fields that are accessible after initial sync if remote_data is enabled. You can use remote fields to override existing Merge fields or map a new Merge field. [Learn more](https://docs.merge.dev/supplemental-data/field-mappings/overview/).
+
+
+ +#### 🔌 Usage
-**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. - +
+
+ +```python +from merge import Merge + +client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.filestorage.field_mapping.remote_fields_retrieve( + common_models="common_models", + include_example_values="include_example_values", +) + +``` +
+
+#### ⚙️ Parameters +
-**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. +
+
+ +**common_models:** `typing.Optional[str]` — A comma seperated list of Common Model names. If included, will only return Remote Fields for those Common Models.
@@ -42976,14 +43295,7 @@ client.ticketing.link_token.create(
-**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. +**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.
@@ -42991,44 +43303,64 @@ client.ticketing.link_token.create(
-**language:** `typing.Optional[EndUserDetailsRequestLanguage]` +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
-The following subset of IETF language tags can be used to configure localization. -* `en` - en -* `de` - de -
+
+
client.filestorage.field_mapping.target_fields_retrieve()
-**are_syncs_disabled:** `typing.Optional[bool]` — The boolean that indicates whether initial, periodic, and force syncs will be disabled. - -
-
+#### 📝 Description
-**integration_specific_config:** `typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]]` — A JSON object containing integration-specific configuration options. - +
+
+ +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
-**completed_account_initial_screen:** `typing.Optional[EndUserDetailsRequestCompletedAccountInitialScreen]` +
+
-When creating a Link token, you can specifiy the initial screen of Linking Flow for a completed Linked Account. +```python +from merge import Merge -* `SELECTIVE_SYNC` - SELECTIVE_SYNC - +client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.filestorage.field_mapping.target_fields_retrieve() + +``` +
+
+#### ⚙️ Parameters + +
+
+
@@ -43044,8 +43376,8 @@ When creating a Link token, you can specifiy the initial screen of Linking Flow
-## Ticketing LinkedAccounts -
client.ticketing.linked_accounts.list(...) +## Filestorage Files +
client.filestorage.files.list(...)
@@ -43057,13 +43389,73 @@ When creating a Link token, you can specifiy the initial screen of Linking Flow
-List linked accounts for your organization. +Returns a list of `File` objects. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +import datetime + +from merge import Merge +from merge.resources.filestorage.resources.files import ( + FilesListRequestExpand, + FilesListRequestOrderBy, +) + +client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.filestorage.files.list( + created_after=datetime.datetime.fromisoformat( + "2024-01-15 09:30:00+00:00", + ), + created_before=datetime.datetime.fromisoformat( + "2024-01-15 09:30:00+00:00", + ), + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + drive_id="drive_id", + expand=FilesListRequestExpand.DRIVE, + folder_id="folder_id", + include_deleted_data=True, + include_remote_data=True, + include_shell_data=True, + mime_type="mime_type", + modified_after=datetime.datetime.fromisoformat( + "2024-01-15 09:30:00+00:00", + ), + modified_before=datetime.datetime.fromisoformat( + "2024-01-15 09:30:00+00:00", + ), + name="name", + order_by=FilesListRequestOrderBy.CREATED_AT_DESCENDING, + page_size=1, + remote_created_after=datetime.datetime.fromisoformat( + "2024-01-15 09:30:00+00:00", + ), + remote_created_before=datetime.datetime.fromisoformat( + "2024-01-15 09:30:00+00:00", + ), + remote_id="remote_id", +) + +```
-#### 🔌 Usage +#### ⚙️ Parameters
@@ -43071,57 +43463,47 @@ List linked accounts for your organization.
-```python -from merge import Merge -from merge.resources.ticketing.resources.linked_accounts import ( - LinkedAccountsListRequestCategory, -) +**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime. + +
+
-client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.ticketing.linked_accounts.list( - category=LinkedAccountsListRequestCategory.ACCOUNTING, - cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", - end_user_email_address="end_user_email_address", - end_user_organization_name="end_user_organization_name", - end_user_origin_id="end_user_origin_id", - end_user_origin_ids="end_user_origin_ids", - id="id", - ids="ids", - include_duplicates=True, - integration_name="integration_name", - is_test_account="is_test_account", - page_size=1, - status="status", -) +
+
-``` +**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime. +
+ +
+
+ +**cursor:** `typing.Optional[str]` — The pagination cursor value. +
-#### ⚙️ Parameters -
+**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. + +
+
+
-**category:** `typing.Optional[LinkedAccountsListRequestCategory]` +**expand:** `typing.Optional[FilesListRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. + +
+
-Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing` +
+
-* `hris` - hris -* `ats` - ats -* `accounting` - accounting -* `ticketing` - ticketing -* `crm` - crm -* `mktg` - mktg -* `filestorage` - filestorage +**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.
@@ -43129,7 +43511,7 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing`
-**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/).
@@ -43137,7 +43519,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. +**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -43145,7 +43527,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. +**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).
@@ -43153,7 +43535,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. +**mime_type:** `typing.Optional[str]` — If provided, will only return files with these mime_types. Multiple values can be separated by commas.
@@ -43161,7 +43543,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. +**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
@@ -43169,7 +43551,7 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing`
-**id:** `typing.Optional[str]` +**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
@@ -43177,7 +43559,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. +**name:** `typing.Optional[str]` — If provided, will only return files with this name. This performs an exact match.
@@ -43185,7 +43567,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. +**order_by:** `typing.Optional[FilesListRequestOrderBy]` — Overrides the default ordering for this endpoint. Possible values include: created_at, -created_at, modified_at, -modified_at.
@@ -43193,7 +43575,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. +**page_size:** `typing.Optional[int]` — Number of results to return per page.
@@ -43201,7 +43583,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. +**remote_created_after:** `typing.Optional[dt.datetime]` — If provided, will only return files created in the third party platform after this datetime.
@@ -43209,7 +43591,7 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing`
-**page_size:** `typing.Optional[int]` — Number of results to return per page. The maximum limit is 100. +**remote_created_before:** `typing.Optional[dt.datetime]` — If provided, will only return files created in the third party platform before this datetime.
@@ -43217,7 +43599,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.
@@ -43237,8 +43619,7 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing`
-## Ticketing Passthrough -
client.ticketing.passthrough.create(...) +
client.filestorage.files.create(...)
@@ -43250,7 +43631,7 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing`
-Pull data from an endpoint not currently supported by Merge. +Creates a `File` object with the given values.
@@ -43266,17 +43647,16 @@ 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.filestorage import FileRequest client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.passthrough.create( - request=DataPassthroughRequest( - method=MethodEnum.GET, - path="/scooters", - ), +client.filestorage.files.create( + is_debug_mode=True, + run_async=True, + model=FileRequest(), ) ``` @@ -43293,7 +43673,23 @@ client.ticketing.passthrough.create(
-**request:** `DataPassthroughRequest` +**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.
@@ -43313,8 +43709,7 @@ client.ticketing.passthrough.create(
-## Ticketing Projects -
client.ticketing.projects.list(...) +
client.filestorage.files.retrieve(...)
@@ -43326,7 +43721,7 @@ client.ticketing.passthrough.create(
-Returns a list of `Project` objects. +Returns a `File` object with the given `id`.
@@ -43341,33 +43736,20 @@ Returns a list of `Project` objects.
```python -import datetime - from merge import Merge +from merge.resources.filestorage.resources.files import ( + FilesRetrieveRequestExpand, +) client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.projects.list( - created_after=datetime.datetime.fromisoformat( - "2024-01-15 09:30:00+00:00", - ), - created_before=datetime.datetime.fromisoformat( - "2024-01-15 09:30:00+00:00", - ), - cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", - include_deleted_data=True, +client.filestorage.files.retrieve( + id="id", + expand=FilesRetrieveRequestExpand.DRIVE, include_remote_data=True, include_shell_data=True, - modified_after=datetime.datetime.fromisoformat( - "2024-01-15 09:30:00+00:00", - ), - modified_before=datetime.datetime.fromisoformat( - "2024-01-15 09:30:00+00:00", - ), - page_size=1, - remote_id="remote_id", ) ``` @@ -43384,23 +43766,7 @@ client.ticketing.projects.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. +**id:** `str`
@@ -43408,7 +43774,7 @@ client.ticketing.projects.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[FilesRetrieveRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -43432,38 +43798,6 @@ client.ticketing.projects.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[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. The maximum limit is 100. - -
-
- -
-
- -**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object. - -
-
- -
-
- **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -43476,7 +43810,7 @@ client.ticketing.projects.list(
-
client.ticketing.projects.retrieve(...) +
client.filestorage.files.download_request_meta_retrieve(...)
@@ -43488,7 +43822,7 @@ client.ticketing.projects.list(
-Returns a `Project` object with the given `id`. +Returns metadata to construct an authenticated file download request for a singular file, allowing you to download file directly from the third-party.
@@ -43509,10 +43843,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.projects.retrieve( +client.filestorage.files.download_request_meta_retrieve( id="id", - include_remote_data=True, - include_shell_data=True, + mime_type="mime_type", ) ``` @@ -43537,15 +43870,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. - -
-
- -
-
- -**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). +**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.
@@ -43565,7 +43890,7 @@ client.ticketing.projects.retrieve(
-
client.ticketing.projects.users_list(...) +
client.filestorage.files.download_request_meta_list(...)
@@ -43577,7 +43902,7 @@ client.ticketing.projects.retrieve(
-Returns a list of `User` objects. +Returns metadata to construct authenticated file download requests, allowing you to download files directly from the third-party.
@@ -43593,39 +43918,65 @@ Returns a list of `User` objects. ```python from merge import Merge -from merge.resources.ticketing.resources.projects import ( - ProjectsUsersListRequestExpand, +from merge.resources.filestorage.resources.files import ( + FilesDownloadRequestMetaListRequestOrderBy, ) client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.projects.users_list( - parent_id="parent_id", +client.filestorage.files.download_request_meta_list( + created_after="created_after", + created_before="created_before", cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", - expand=ProjectsUsersListRequestExpand.ROLES, include_deleted_data=True, - include_remote_data=True, - include_shell_data=True, + mime_types="mime_types", + modified_after="modified_after", + modified_before="modified_before", + order_by=FilesDownloadRequestMetaListRequestOrderBy.CREATED_AT_DESCENDING, page_size=1, ) -``` +``` + +
+ + + +#### ⚙️ Parameters + +
+
+ +
+
+ +**created_after:** `typing.Optional[str]` — If provided, will only return objects created after this datetime. +
+ +
+
+ +**created_before:** `typing.Optional[str]` — If provided, will only return objects created before this datetime. +
-#### ⚙️ Parameters -
+**cursor:** `typing.Optional[str]` — The pagination cursor value. + +
+
+
-**parent_id:** `str` +**ids:** `typing.Optional[typing.Union[str, typing.Sequence[str]]]` — If provided, will only return objects with the given IDs. Comma-separated list of strings.
@@ -43633,7 +43984,7 @@ client.ticketing.projects.users_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/).
@@ -43641,7 +43992,7 @@ client.ticketing.projects.users_list(
-**expand:** `typing.Optional[ProjectsUsersListRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. +**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.
@@ -43649,7 +44000,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/). +**modified_after:** `typing.Optional[str]` — If provided, will only return objects modified after this datetime.
@@ -43657,7 +44008,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. +**modified_before:** `typing.Optional[str]` — If provided, will only return objects modified before this datetime.
@@ -43665,7 +44016,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). +**order_by:** `typing.Optional[FilesDownloadRequestMetaListRequestOrderBy]` — Overrides the default ordering for this endpoint. Possible values include: created_at, -created_at, modified_at, -modified_at.
@@ -43673,7 +44024,7 @@ client.ticketing.projects.users_list(
-**page_size:** `typing.Optional[int]` — Number of results to return per page. The maximum limit is 100. +**page_size:** `typing.Optional[int]` — Number of results to return per page.
@@ -43693,8 +44044,7 @@ client.ticketing.projects.users_list(
-## Ticketing RegenerateKey -
client.ticketing.regenerate_key.create(...) +
client.filestorage.files.meta_post_retrieve()
@@ -43706,7 +44056,7 @@ client.ticketing.projects.users_list(
-Exchange remote keys. +Returns metadata for `FileStorageFile` POSTs.
@@ -43727,9 +44077,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.regenerate_key.create( - name="Remote Deployment Key 1", -) +client.filestorage.files.meta_post_retrieve() ``` @@ -43745,14 +44093,6 @@ client.ticketing.regenerate_key.create(
-**name:** `str` — The name of the remote key - -
-
- -
-
- **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -43765,8 +44105,8 @@ client.ticketing.regenerate_key.create(
-## Ticketing Roles -
client.ticketing.roles.list(...) +## Filestorage Folders +
client.filestorage.folders.list(...)
@@ -43778,7 +44118,7 @@ client.ticketing.regenerate_key.create(
-Returns a list of `Role` objects. +Returns a list of `Folder` objects.
@@ -43796,12 +44136,15 @@ Returns a list of `Role` objects. import datetime from merge import Merge +from merge.resources.filestorage.resources.folders import ( + FoldersListRequestExpand, +) client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.roles.list( +client.filestorage.folders.list( created_after=datetime.datetime.fromisoformat( "2024-01-15 09:30:00+00:00", ), @@ -43809,6 +44152,8 @@ client.ticketing.roles.list( "2024-01-15 09:30:00+00:00", ), cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + drive_id="drive_id", + expand=FoldersListRequestExpand.DRIVE, include_deleted_data=True, include_remote_data=True, include_shell_data=True, @@ -43818,7 +44163,9 @@ client.ticketing.roles.list( modified_before=datetime.datetime.fromisoformat( "2024-01-15 09:30:00+00:00", ), + name="name", page_size=1, + parent_folder_id="parent_folder_id", remote_id="remote_id", ) @@ -43860,7 +44207,7 @@ client.ticketing.roles.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/). +**drive_id:** `typing.Optional[str]` — If provided, will only return folders in this drive.
@@ -43868,7 +44215,7 @@ client.ticketing.roles.list(
-**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[FoldersListRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -43876,7 +44223,7 @@ client.ticketing.roles.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/).
@@ -43884,7 +44231,7 @@ client.ticketing.roles.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.
@@ -43892,7 +44239,7 @@ client.ticketing.roles.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).
@@ -43900,7 +44247,7 @@ client.ticketing.roles.list(
-**page_size:** `typing.Optional[int]` — Number of results to return per page. The maximum limit is 100. +**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
@@ -43908,7 +44255,7 @@ client.ticketing.roles.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.
@@ -43916,72 +44263,15 @@ client.ticketing.roles.list(
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. +**name:** `typing.Optional[str]` — If provided, will only return folders with this name. This performs an exact match.
- -
- - - - -
- -
client.ticketing.roles.retrieve(...) -
-
- -#### 📝 Description - -
-
- -
-
- -Returns a `Role` 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.roles.retrieve( - id="id", - include_remote_data=True, - include_shell_data=True, -) - -``` -
-
-
-
- -#### ⚙️ Parameters - -
-
-**id:** `str` +**page_size:** `typing.Optional[int]` — Number of results to return per page.
@@ -43989,7 +44279,7 @@ client.ticketing.roles.retrieve(
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. +**parent_folder_id:** `typing.Optional[str]` — If provided, will only return folders in this parent folder. If null, will return folders in root directory.
@@ -43997,7 +44287,7 @@ client.ticketing.roles.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.
@@ -44017,8 +44307,7 @@ client.ticketing.roles.retrieve(
-## Ticketing SyncStatus -
client.ticketing.sync_status.list(...) +
client.filestorage.folders.create(...)
@@ -44030,7 +44319,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). +Creates a `Folder` object with the given values.
@@ -44046,14 +44335,16 @@ Get sync status for the current sync and the most recently finished sync. `last_ ```python from merge import Merge +from merge.resources.filestorage import FolderRequest client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.sync_status.list( - cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", - page_size=1, +client.filestorage.folders.create( + is_debug_mode=True, + run_async=True, + model=FolderRequest(), ) ``` @@ -44070,7 +44361,7 @@ client.ticketing.sync_status.list(
-**cursor:** `typing.Optional[str]` — The pagination cursor value. +**model:** `FolderRequest`
@@ -44078,7 +44369,7 @@ client.ticketing.sync_status.list(
-**page_size:** `typing.Optional[int]` — Number of results to return per page. The maximum limit is 100. +**is_debug_mode:** `typing.Optional[bool]` — Whether to include debug fields (such as log file links) in the response.
@@ -44086,64 +44377,10 @@ client.ticketing.sync_status.list(
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. +**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously.
- -
- - - - -
- -## Ticketing ForceResync -
client.ticketing.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.ticketing.force_resync.sync_status_resync_create() - -``` -
-
-
-
- -#### ⚙️ Parameters - -
-
@@ -44160,8 +44397,7 @@ client.ticketing.force_resync.sync_status_resync_create()
-## Ticketing Tags -
client.ticketing.tags.list(...) +
client.filestorage.folders.retrieve(...)
@@ -44173,7 +44409,7 @@ client.ticketing.force_resync.sync_status_resync_create()
-Returns a list of `Tag` objects. +Returns a `Folder` object with the given `id`.
@@ -44188,33 +44424,20 @@ Returns a list of `Tag` objects.
```python -import datetime - from merge import Merge +from merge.resources.filestorage.resources.folders import ( + FoldersRetrieveRequestExpand, +) client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.tags.list( - created_after=datetime.datetime.fromisoformat( - "2024-01-15 09:30:00+00:00", - ), - created_before=datetime.datetime.fromisoformat( - "2024-01-15 09:30:00+00:00", - ), - cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", - include_deleted_data=True, +client.filestorage.folders.retrieve( + id="id", + expand=FoldersRetrieveRequestExpand.DRIVE, include_remote_data=True, include_shell_data=True, - modified_after=datetime.datetime.fromisoformat( - "2024-01-15 09:30:00+00:00", - ), - modified_before=datetime.datetime.fromisoformat( - "2024-01-15 09:30:00+00:00", - ), - page_size=1, - remote_id="remote_id", ) ``` @@ -44231,23 +44454,7 @@ client.ticketing.tags.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. +**id:** `str`
@@ -44255,7 +44462,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/). +**expand:** `typing.Optional[FoldersRetrieveRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -44279,35 +44486,64 @@ client.ticketing.tags.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.
+
+
-
-
-**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned. -
+
+
client.filestorage.folders.meta_post_retrieve()
-**page_size:** `typing.Optional[int]` — Number of results to return per page. The maximum limit is 100. - +#### 📝 Description + +
+
+ +
+
+ +Returns metadata for `FileStorageFolder` POSTs. +
+
+#### 🔌 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.filestorage.folders.meta_post_retrieve() + +``` +
+
+#### ⚙️ Parameters + +
+
+
@@ -44323,7 +44559,8 @@ client.ticketing.tags.list(
-
client.ticketing.tags.retrieve(...) +## Filestorage GenerateKey +
client.filestorage.generate_key.create(...)
@@ -44335,7 +44572,7 @@ client.ticketing.tags.list(
-Returns a `Tag` object with the given `id`. +Create a remote key.
@@ -44356,10 +44593,8 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.tags.retrieve( - id="id", - include_remote_data=True, - include_shell_data=True, +client.filestorage.generate_key.create( + name="Remote Deployment Key 1", ) ``` @@ -44376,23 +44611,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. - -
-
- -
-
- -**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). +**name:** `str` — The name of the remote key
@@ -44412,8 +44631,8 @@ client.ticketing.tags.retrieve(
-## Ticketing Teams -
client.ticketing.teams.list(...) +## Filestorage Groups +
client.filestorage.groups.list(...)
@@ -44425,7 +44644,7 @@ client.ticketing.tags.retrieve(
-Returns a list of `Team` objects. +Returns a list of `Group` objects.
@@ -44448,7 +44667,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.teams.list( +client.filestorage.groups.list( created_after=datetime.datetime.fromisoformat( "2024-01-15 09:30:00+00:00", ), @@ -44507,6 +44726,14 @@ client.ticketing.teams.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. + +
+
+ +
+
+ **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/).
@@ -44547,7 +44774,7 @@ client.ticketing.teams.list(
-**page_size:** `typing.Optional[int]` — Number of results to return per page. The maximum limit is 100. +**page_size:** `typing.Optional[int]` — Number of results to return per page.
@@ -44575,7 +44802,7 @@ client.ticketing.teams.list(
-
client.ticketing.teams.retrieve(...) +
client.filestorage.groups.retrieve(...)
@@ -44587,7 +44814,7 @@ client.ticketing.teams.list(
-Returns a `Team` object with the given `id`. +Returns a `Group` object with the given `id`.
@@ -44608,7 +44835,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.teams.retrieve( +client.filestorage.groups.retrieve( id="id", include_remote_data=True, include_shell_data=True, @@ -44636,6 +44863,14 @@ client.ticketing.teams.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. + +
+
+ +
+
+ **include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -44664,8 +44899,8 @@ client.ticketing.teams.retrieve(
-## Ticketing Tickets -
client.ticketing.tickets.list(...) +## Filestorage Issues +
client.filestorage.issues.list(...)
@@ -44677,7 +44912,7 @@ client.ticketing.teams.retrieve(
-Returns a list of `Ticket` objects. +Gets all issues for Organization.
@@ -44695,175 +44930,52 @@ Returns a list of `Ticket` objects. import datetime from merge import Merge -from merge.resources.ticketing.resources.tickets import ( - TicketsListRequestExpand, - TicketsListRequestPriority, - TicketsListRequestRemoteFields, - TicketsListRequestShowEnumOrigins, - TicketsListRequestStatus, -) +from merge.resources.filestorage.resources.issues import IssuesListRequestStatus client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.tickets.list( - account_id="account_id", - assignee_ids="assignee_ids", - collection_ids="collection_ids", - completed_after=datetime.datetime.fromisoformat( - "2024-01-15 09:30:00+00:00", - ), - completed_before=datetime.datetime.fromisoformat( - "2024-01-15 09:30:00+00:00", - ), - contact_id="contact_id", - created_after=datetime.datetime.fromisoformat( - "2024-01-15 09:30:00+00:00", - ), - created_before=datetime.datetime.fromisoformat( - "2024-01-15 09:30:00+00:00", - ), - creator_id="creator_id", - creator_ids="creator_ids", +client.filestorage.issues.list( + account_token="account_token", cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", - due_after=datetime.datetime.fromisoformat( + end_date="end_date", + end_user_organization_name="end_user_organization_name", + first_incident_time_after=datetime.datetime.fromisoformat( "2024-01-15 09:30:00+00:00", ), - due_before=datetime.datetime.fromisoformat( + first_incident_time_before=datetime.datetime.fromisoformat( "2024-01-15 09:30:00+00:00", ), - expand=TicketsListRequestExpand.ACCOUNT, - include_deleted_data=True, - include_remote_data=True, - include_remote_fields=True, - include_shell_data=True, - modified_after=datetime.datetime.fromisoformat( + include_muted="include_muted", + integration_name="integration_name", + last_incident_time_after=datetime.datetime.fromisoformat( "2024-01-15 09:30:00+00:00", ), - modified_before=datetime.datetime.fromisoformat( + last_incident_time_before=datetime.datetime.fromisoformat( "2024-01-15 09:30:00+00:00", ), - name="name", + linked_account_id="linked_account_id", page_size=1, - parent_ticket_id="parent_ticket_id", - priority=TicketsListRequestPriority.HIGH, - remote_created_after=datetime.datetime.fromisoformat( - "2024-01-15 09:30:00+00:00", - ), - remote_created_before=datetime.datetime.fromisoformat( - "2024-01-15 09:30:00+00:00", - ), - remote_fields=TicketsListRequestRemoteFields.PRIORITY, - remote_id="remote_id", - remote_updated_after=datetime.datetime.fromisoformat( - "2024-01-15 09:30:00+00:00", - ), - remote_updated_before=datetime.datetime.fromisoformat( - "2024-01-15 09:30:00+00:00", - ), - show_enum_origins=TicketsListRequestShowEnumOrigins.PRIORITY, - status=TicketsListRequestStatus.EMPTY, - tags="tags", - ticket_type="ticket_type", - ticket_url="ticket_url", -) - -``` - -
- - - -#### ⚙️ Parameters - -
-
- -
-
- -**account_id:** `typing.Optional[str]` — If provided, will only return tickets for this account. - -
-
- -
-
- -**assignee_ids:** `typing.Optional[str]` — If provided, will only return tickets assigned to the assignee_ids; multiple assignee_ids can be separated by commas. - -
-
- -
-
- -**collection_ids:** `typing.Optional[str]` — If provided, will only return tickets assigned to the collection_ids; multiple collection_ids can be separated by commas. - -
-
- -
-
- -**completed_after:** `typing.Optional[dt.datetime]` — If provided, will only return tickets completed after this datetime. - -
-
- -
-
- -**completed_before:** `typing.Optional[dt.datetime]` — If provided, will only return tickets completed before this datetime. - -
-
- -
-
- -**contact_id:** `typing.Optional[str]` — If provided, will only return tickets for this contact. - -
-
- -
-
+ start_date="start_date", + status=IssuesListRequestStatus.ONGOING, +) -**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime. - +```
- -
-
- -**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime. -
-
-
- -**creator_id:** `typing.Optional[str]` — If provided, will only return tickets created by this creator_id. - -
-
+#### ⚙️ Parameters
-**creator_ids:** `typing.Optional[str]` — If provided, will only return tickets created by the creator_ids; multiple creator_ids can be separated by commas. - -
-
-
-**cursor:** `typing.Optional[str]` — The pagination cursor value. +**account_token:** `typing.Optional[str]`
@@ -44871,7 +44983,7 @@ client.ticketing.tickets.list(
-**due_after:** `typing.Optional[dt.datetime]` — If provided, will only return tickets due after this datetime. +**cursor:** `typing.Optional[str]` — The pagination cursor value.
@@ -44879,7 +44991,7 @@ client.ticketing.tickets.list(
-**due_before:** `typing.Optional[dt.datetime]` — If provided, will only return tickets due before this datetime. +**end_date:** `typing.Optional[str]` — If included, will only include issues whose most recent action occurred before this time
@@ -44887,7 +44999,7 @@ client.ticketing.tickets.list(
-**expand:** `typing.Optional[TicketsListRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. +**end_user_organization_name:** `typing.Optional[str]`
@@ -44895,7 +45007,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/). +**first_incident_time_after:** `typing.Optional[dt.datetime]` — If provided, will only return issues whose first incident time was after this datetime.
@@ -44903,7 +45015,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. +**first_incident_time_before:** `typing.Optional[dt.datetime]` — If provided, will only return issues whose first incident time was before this datetime.
@@ -44911,7 +45023,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. +**include_muted:** `typing.Optional[str]` — If true, will include muted issues
@@ -44919,7 +45031,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). +**integration_name:** `typing.Optional[str]`
@@ -44927,7 +45039,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. +**last_incident_time_after:** `typing.Optional[dt.datetime]` — If provided, will only return issues whose last incident time was after this datetime.
@@ -44935,7 +45047,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. +**last_incident_time_before:** `typing.Optional[dt.datetime]` — If provided, will only return issues whose last incident time was before this datetime.
@@ -44943,7 +45055,7 @@ client.ticketing.tickets.list(
-**name:** `typing.Optional[str]` — If provided, will only return tickets with this name. +**linked_account_id:** `typing.Optional[str]` — If provided, will only include issues pertaining to the linked account passed in.
@@ -44951,7 +45063,7 @@ client.ticketing.tickets.list(
-**page_size:** `typing.Optional[int]` — Number of results to return per page. The maximum limit is 100. +**page_size:** `typing.Optional[int]` — Number of results to return per page.
@@ -44959,7 +45071,7 @@ client.ticketing.tickets.list(
-**parent_ticket_id:** `typing.Optional[str]` — If provided, will only return sub tickets of the parent_ticket_id. +**start_date:** `typing.Optional[str]` — If included, will only include issues whose most recent action occurred after this time
@@ -44967,14 +45079,12 @@ client.ticketing.tickets.list(
-**priority:** `typing.Optional[TicketsListRequestPriority]` +**status:** `typing.Optional[IssuesListRequestStatus]` -If provided, will only return tickets of this priority. +Status of the issue. Options: ('ONGOING', 'RESOLVED') -* `URGENT` - URGENT -* `HIGH` - HIGH -* `NORMAL` - NORMAL -* `LOW` - LOW +* `ONGOING` - ONGOING +* `RESOLVED` - RESOLVED
@@ -44982,87 +45092,70 @@ 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. +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
- -
-
- -**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. -
+
+
client.filestorage.issues.retrieve(...)
-**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object. - -
-
+#### 📝 Description
-**remote_updated_after:** `typing.Optional[dt.datetime]` — If provided, will only return tickets updated in the third party platform after this datetime. - -
-
-
-**remote_updated_before:** `typing.Optional[dt.datetime]` — If provided, will only return tickets updated in the third party platform before this datetime. - +Get a specific issue.
- -
-
- -**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) -
+#### 🔌 Usage +
-**status:** `typing.Optional[TicketsListRequestStatus]` — If provided, will only return tickets of this status. - -
-
-
-**tags:** `typing.Optional[str]` — If provided, will only return tickets matching the tags; multiple tags can be separated by commas. - +```python +from merge import Merge + +client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.filestorage.issues.retrieve( + id="id", +) + +``` +
+
+#### ⚙️ Parameters +
-**ticket_type:** `typing.Optional[str]` — If provided, will only return tickets of this type. - -
-
-
-**ticket_url:** `typing.Optional[str]` — If provided, will only return tickets where the URL matches or contains the substring +**id:** `str`
@@ -45082,7 +45175,8 @@ If provided, will only return tickets of this priority.
-
client.ticketing.tickets.create(...) +## Filestorage LinkToken +
client.filestorage.link_token.create(...)
@@ -45094,7 +45188,7 @@ If provided, will only return tickets of this priority.
-Creates a `Ticket` object with the given values. +Creates a link token to be used when linking a new end user.
@@ -45110,16 +45204,17 @@ Creates a `Ticket` object with the given values. ```python from merge import Merge -from merge.resources.ticketing import TicketRequest +from merge.resources.filestorage import CategoriesEnum client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.tickets.create( - is_debug_mode=True, - run_async=True, - model=TicketRequest(), +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], ) ``` @@ -45136,7 +45231,7 @@ client.ticketing.tickets.create(
-**model:** `TicketRequest` +**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.
@@ -45144,7 +45239,7 @@ client.ticketing.tickets.create(
-**is_debug_mode:** `typing.Optional[bool]` — Whether to include debug fields (such as log file links) in the response. +**end_user_organization_name:** `str` — Your end user's organization.
@@ -45152,7 +45247,7 @@ client.ticketing.tickets.create(
-**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously. +**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.
@@ -45160,81 +45255,31 @@ client.ticketing.tickets.create(
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. +**categories:** `typing.Sequence[CategoriesEnum]` — The integration categories to show in Merge Link.
- -
- - - - -
- -
client.ticketing.tickets.retrieve(...) -
-
- -#### 📝 Description - -
-
-Returns a `Ticket` object with the given `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/. +
-#### 🔌 Usage -
-
-
- -```python -from merge import Merge -from merge.resources.ticketing.resources.tickets import ( - TicketsRetrieveRequestExpand, - TicketsRetrieveRequestRemoteFields, - TicketsRetrieveRequestShowEnumOrigins, -) - -client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.ticketing.tickets.retrieve( - id="id", - expand=TicketsRetrieveRequestExpand.ACCOUNT, - include_remote_data=True, - include_remote_fields=True, - include_shell_data=True, - remote_fields=TicketsRetrieveRequestRemoteFields.PRIORITY, - show_enum_origins=TicketsRetrieveRequestShowEnumOrigins.PRIORITY, -) - -``` -
-
+**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. +
-#### ⚙️ Parameters -
-
-
- -**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.
@@ -45242,7 +45287,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. +**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.
@@ -45250,7 +45295,7 @@ client.ticketing.tickets.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.
@@ -45258,7 +45303,14 @@ 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. +**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.
@@ -45266,7 +45318,12 @@ client.ticketing.tickets.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[LanguageEnum]` + +The following subset of IETF language tags can be used to configure localization. + +* `en` - en +* `de` - de
@@ -45274,7 +45331,7 @@ client.ticketing.tickets.retrieve(
-**remote_fields:** `typing.Optional[TicketsRetrieveRequestRemoteFields]` — Deprecated. Use show_enum_origins. +**are_syncs_disabled:** `typing.Optional[bool]` — The boolean that indicates whether initial, periodic, and force syncs will be disabled.
@@ -45282,7 +45339,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) +**integration_specific_config:** `typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]]` — A JSON object containing integration-specific configuration options.
@@ -45302,7 +45359,8 @@ client.ticketing.tickets.retrieve(
-
client.ticketing.tickets.partial_update(...) +## Filestorage LinkedAccounts +
client.filestorage.linked_accounts.list(...)
@@ -45314,7 +45372,7 @@ client.ticketing.tickets.retrieve(
-Updates a `Ticket` object with the given `id`. +List linked accounts for your organization.
@@ -45330,17 +45388,28 @@ Updates a `Ticket` object with the given `id`. ```python from merge import Merge -from merge.resources.ticketing import PatchedTicketRequest +from merge.resources.filestorage.resources.linked_accounts import ( + LinkedAccountsListRequestCategory, +) client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.tickets.partial_update( +client.filestorage.linked_accounts.list( + category=LinkedAccountsListRequestCategory.ACCOUNTING, + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", + end_user_email_address="end_user_email_address", + end_user_organization_name="end_user_organization_name", + end_user_origin_id="end_user_origin_id", + end_user_origin_ids="end_user_origin_ids", id="id", - is_debug_mode=True, - run_async=True, - model=PatchedTicketRequest(), + ids="ids", + include_duplicates=True, + integration_name="integration_name", + is_test_account="is_test_account", + page_size=1, + status="status", ) ``` @@ -45357,15 +45426,17 @@ client.ticketing.tickets.partial_update(
-**id:** `str` - -
-
+**category:** `typing.Optional[LinkedAccountsListRequestCategory]` -
-
+Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing` -**model:** `PatchedTicketRequest` +* `hris` - hris +* `ats` - ats +* `accounting` - accounting +* `ticketing` - ticketing +* `crm` - crm +* `mktg` - mktg +* `filestorage` - filestorage
@@ -45373,7 +45444,7 @@ client.ticketing.tickets.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.
@@ -45381,7 +45452,7 @@ client.ticketing.tickets.partial_update(
-**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously. +**end_user_email_address:** `typing.Optional[str]` — If provided, will only return linked accounts associated with the given email address.
@@ -45389,79 +45460,31 @@ client.ticketing.tickets.partial_update(
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. +**end_user_organization_name:** `typing.Optional[str]` — If provided, will only return linked accounts associated with the given organization name.
- -
- - - - -
- -
client.ticketing.tickets.viewers_list(...) -
-
- -#### 📝 Description - -
-
-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) -
-
+**end_user_origin_id:** `typing.Optional[str]` — If provided, will only return linked accounts associated with the given origin ID. +
-#### 🔌 Usage -
-
-
- -```python -from merge import Merge -from merge.resources.ticketing.resources.tickets import ( - TicketsViewersListRequestExpand, -) - -client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.ticketing.tickets.viewers_list( - ticket_id="ticket_id", - cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", - expand=TicketsViewersListRequestExpand.TEAM, - include_deleted_data=True, - include_remote_data=True, - include_shell_data=True, - page_size=1, -) - -``` -
-
+**end_user_origin_ids:** `typing.Optional[str]` — Comma-separated list of EndUser origin IDs, making it possible to specify multiple EndUsers at once. +
-#### ⚙️ Parameters - -
-
-
-**ticket_id:** `str` +**id:** `typing.Optional[str]`
@@ -45469,7 +45492,7 @@ client.ticketing.tickets.viewers_list(
-**cursor:** `typing.Optional[str]` — The pagination cursor value. +**ids:** `typing.Optional[str]` — Comma-separated list of LinkedAccount IDs, making it possible to specify multiple LinkedAccounts at once.
@@ -45477,7 +45500,7 @@ 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. +**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.
@@ -45485,7 +45508,7 @@ client.ticketing.tickets.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/). +**integration_name:** `typing.Optional[str]` — If provided, will only return linked accounts associated with the given integration name.
@@ -45493,7 +45516,7 @@ client.ticketing.tickets.viewers_list(
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. +**is_test_account:** `typing.Optional[str]` — If included, will only include test linked accounts. If not included, will only include non-test linked accounts.
@@ -45501,7 +45524,7 @@ client.ticketing.tickets.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). +**page_size:** `typing.Optional[int]` — Number of results to return per page.
@@ -45509,7 +45532,7 @@ client.ticketing.tickets.viewers_list(
-**page_size:** `typing.Optional[int]` — Number of results to return per page. The maximum limit is 100. +**status:** `typing.Optional[str]` — Filter by status. Options: `COMPLETE`, `IDLE`, `INCOMPLETE`, `RELINK_NEEDED`
@@ -45529,7 +45552,8 @@ client.ticketing.tickets.viewers_list(
-
client.ticketing.tickets.meta_patch_retrieve(...) +## Filestorage Passthrough +
client.filestorage.passthrough.create(...)
@@ -45541,7 +45565,7 @@ client.ticketing.tickets.viewers_list(
-Returns metadata for `Ticket` PATCHs. +Pull data from an endpoint not currently supported by Merge.
@@ -45557,13 +45581,17 @@ Returns metadata for `Ticket` PATCHs. ```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.ticketing.tickets.meta_patch_retrieve( - id="id", +client.filestorage.passthrough.create( + request=DataPassthroughRequest( + method=MethodEnum.GET, + path="/scooters", + ), ) ``` @@ -45580,7 +45608,7 @@ client.ticketing.tickets.meta_patch_retrieve(
-**id:** `str` +**request:** `DataPassthroughRequest`
@@ -45600,7 +45628,8 @@ client.ticketing.tickets.meta_patch_retrieve(
-
client.ticketing.tickets.meta_post_retrieve(...) +## Filestorage RegenerateKey +
client.filestorage.regenerate_key.create(...)
@@ -45612,7 +45641,7 @@ client.ticketing.tickets.meta_patch_retrieve(
-Returns metadata for `Ticket` POSTs. +Exchange remote keys.
@@ -45633,9 +45662,8 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.tickets.meta_post_retrieve( - collection_id="collection_id", - ticket_type="ticket_type", +client.filestorage.regenerate_key.create( + name="Remote Deployment Key 1", ) ``` @@ -45652,15 +45680,7 @@ client.ticketing.tickets.meta_post_retrieve(
-**collection_id:** `typing.Optional[str]` — If provided, will only return tickets for this collection. - -
-
- -
-
- -**ticket_type:** `typing.Optional[str]` — If provided, will only return tickets for this ticket type. +**name:** `str` — The name of the remote key
@@ -45680,7 +45700,8 @@ client.ticketing.tickets.meta_post_retrieve(
-
client.ticketing.tickets.remote_field_classes_list(...) +## Filestorage SyncStatus +
client.filestorage.sync_status.list(...)
@@ -45692,7 +45713,7 @@ client.ticketing.tickets.meta_post_retrieve(
-Returns a list of `RemoteFieldClass` objects. +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).
@@ -45713,14 +45734,8 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.tickets.remote_field_classes_list( +client.filestorage.sync_status.list( cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", - ids="ids", - include_deleted_data=True, - include_remote_data=True, - include_shell_data=True, - is_common_model_field=True, - is_custom=True, page_size=1, ) @@ -45746,7 +45761,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 +**page_size:** `typing.Optional[int]` — Number of results to return per page.
@@ -45754,50 +45769,64 @@ 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/). +**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 ForceResync +
client.filestorage.force_resync.sync_status_resync_create()
-**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
-**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 - +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 +
-**page_size:** `typing.Optional[int]` — Number of results to return per page. The maximum limit is 100. - +
+
+ +```python +from merge import Merge + +client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.filestorage.force_resync.sync_status_resync_create() + +```
+
+
+ +#### ⚙️ Parameters + +
+
@@ -45814,8 +45843,8 @@ client.ticketing.tickets.remote_field_classes_list(
-## Ticketing Users -
client.ticketing.users.list(...) +## Filestorage Users +
client.filestorage.users.list(...)
@@ -45845,13 +45874,12 @@ Returns a list of `User` objects. import datetime from merge import Merge -from merge.resources.ticketing.resources.users import UsersListRequestExpand client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.users.list( +client.filestorage.users.list( created_after=datetime.datetime.fromisoformat( "2024-01-15 09:30:00+00:00", ), @@ -45859,11 +45887,10 @@ client.ticketing.users.list( "2024-01-15 09:30:00+00:00", ), cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", - email_address="email_address", - expand=UsersListRequestExpand.ROLES, include_deleted_data=True, include_remote_data=True, include_shell_data=True, + is_me="is_me", modified_after=datetime.datetime.fromisoformat( "2024-01-15 09:30:00+00:00", ), @@ -45872,7 +45899,6 @@ client.ticketing.users.list( ), page_size=1, remote_id="remote_id", - team="team", ) ``` @@ -45913,22 +45939,6 @@ client.ticketing.users.list(
-**email_address:** `typing.Optional[str]` — If provided, will only return users with emails equal to this value (case insensitive). - -
-
- -
-
- -**expand:** `typing.Optional[UsersListRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. - -
-
- -
-
- **include_deleted_data:** `typing.Optional[bool]` — 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/).
@@ -45953,7 +45963,7 @@ client.ticketing.users.list(
-**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned. +**is_me:** `typing.Optional[str]` — If provided, will only return the user object for requestor.
@@ -45961,7 +45971,7 @@ client.ticketing.users.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.
@@ -45969,7 +45979,7 @@ client.ticketing.users.list(
-**page_size:** `typing.Optional[int]` — Number of results to return per page. The maximum limit is 100. +**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
@@ -45977,7 +45987,7 @@ client.ticketing.users.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.
@@ -45985,7 +45995,7 @@ client.ticketing.users.list(
-**team:** `typing.Optional[str]` — If provided, will only return users matching in this team. +**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
@@ -46005,7 +46015,7 @@ client.ticketing.users.list(
-
client.ticketing.users.retrieve(...) +
client.filestorage.users.retrieve(...)
@@ -46033,15 +46043,13 @@ Returns a `User` object with the given `id`. ```python from merge import Merge -from merge.resources.ticketing.resources.users import UsersRetrieveRequestExpand client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.users.retrieve( +client.filestorage.users.retrieve( id="id", - expand=UsersRetrieveRequestExpand.ROLES, include_remote_data=True, include_shell_data=True, ) @@ -46068,14 +46076,6 @@ client.ticketing.users.retrieve(
-**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.
@@ -46104,8 +46104,8 @@ client.ticketing.users.retrieve(
-## Ticketing WebhookReceivers -
client.ticketing.webhook_receivers.list() +## Filestorage WebhookReceivers +
client.filestorage.webhook_receivers.list()
@@ -46138,7 +46138,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.webhook_receivers.list() +client.filestorage.webhook_receivers.list() ```
@@ -46166,7 +46166,7 @@ client.ticketing.webhook_receivers.list()
-
client.ticketing.webhook_receivers.create(...) +
client.filestorage.webhook_receivers.create(...)
@@ -46199,7 +46199,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.webhook_receivers.create( +client.filestorage.webhook_receivers.create( event="event", is_active=True, ) diff --git a/src/merge/client.py b/src/merge/client.py index d5250372..ff255527 100644 --- a/src/merge/client.py +++ b/src/merge/client.py @@ -91,10 +91,10 @@ def __init__( self._chat: typing.Optional[ChatClient] = None 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._knowledgebase: typing.Optional[KnowledgebaseClient] = None self._ticketing: typing.Optional[TicketingClient] = None + self._filestorage: typing.Optional[FilestorageClient] = None self._accounting: typing.Optional[AccountingClient] = None @property @@ -121,14 +121,6 @@ def crm(self): self._crm = CrmClient(client_wrapper=self._client_wrapper) return self._crm - @property - def filestorage(self): - if self._filestorage is None: - from .resources.filestorage.client import FilestorageClient # noqa: E402 - - self._filestorage = FilestorageClient(client_wrapper=self._client_wrapper) - return self._filestorage - @property def hris(self): if self._hris is None: @@ -153,6 +145,14 @@ def ticketing(self): self._ticketing = TicketingClient(client_wrapper=self._client_wrapper) return self._ticketing + @property + def filestorage(self): + if self._filestorage is None: + from .resources.filestorage.client import FilestorageClient # noqa: E402 + + self._filestorage = FilestorageClient(client_wrapper=self._client_wrapper) + return self._filestorage + @property def accounting(self): if self._accounting is None: @@ -234,10 +234,10 @@ def __init__( self._chat: typing.Optional[AsyncChatClient] = None 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._knowledgebase: typing.Optional[AsyncKnowledgebaseClient] = None self._ticketing: typing.Optional[AsyncTicketingClient] = None + self._filestorage: typing.Optional[AsyncFilestorageClient] = None self._accounting: typing.Optional[AsyncAccountingClient] = None @property @@ -264,14 +264,6 @@ def crm(self): self._crm = AsyncCrmClient(client_wrapper=self._client_wrapper) return self._crm - @property - def filestorage(self): - if self._filestorage is None: - from .resources.filestorage.client import AsyncFilestorageClient # noqa: E402 - - self._filestorage = AsyncFilestorageClient(client_wrapper=self._client_wrapper) - return self._filestorage - @property def hris(self): if self._hris is None: @@ -296,6 +288,14 @@ def ticketing(self): self._ticketing = AsyncTicketingClient(client_wrapper=self._client_wrapper) return self._ticketing + @property + def filestorage(self): + if self._filestorage is None: + from .resources.filestorage.client import AsyncFilestorageClient # noqa: E402 + + self._filestorage = AsyncFilestorageClient(client_wrapper=self._client_wrapper) + return self._filestorage + @property def accounting(self): if self._accounting is None: diff --git a/src/merge/resources/filestorage/types/drive.py b/src/merge/resources/filestorage/types/drive.py index 50a5f2bf..c0f931ee 100644 --- a/src/merge/resources/filestorage/types/drive.py +++ b/src/merge/resources/filestorage/types/drive.py @@ -49,6 +49,11 @@ class Drive(UncheckedBaseModel): The drive's url. """ + size: typing.Optional[int] = pydantic.Field(default=None) + """ + The drive's size, in bytes. + """ + remote_was_deleted: typing.Optional[bool] = pydantic.Field(default=None) """ 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/).