From 811ac289d80e1508957995cca1829581d8d99096 Mon Sep 17 00:00:00 2001 From: fern-api <115122769+fern-api[bot]@users.noreply.github.com> Date: Tue, 23 Sep 2025 01:24:43 +0000 Subject: [PATCH] SDK regeneration --- .mock/definition/hris/dependents.yml | 3 + .mock/definition/hris/employees.yml | 3 + .mock/definition/ticketing/__package__.yml | 12 + .mock/definition/ticketing/collections.yml | 9 + .mock/definition/ticketing/contacts.yml | 3 + .mock/definition/ticketing/tickets.yml | 3 + README.md | 3 +- pyproject.toml | 2 +- reference.md | 5832 +++++++++-------- src/merge/client.py | 36 +- src/merge/core/client_wrapper.py | 4 +- src/merge/resources/accounting/client.py | 12 +- src/merge/resources/ats/client.py | 12 +- src/merge/resources/crm/client.py | 12 +- src/merge/resources/filestorage/client.py | 12 +- src/merge/resources/hris/client.py | 12 +- .../hris/resources/dependents/client.py | 10 + .../hris/resources/dependents/raw_client.py | 10 + .../hris/resources/employees/client.py | 10 + .../hris/resources/employees/raw_client.py | 10 + src/merge/resources/ticketing/client.py | 12 +- .../ticketing/resources/collections/client.py | 10 + .../resources/collections/raw_client.py | 10 + .../ticketing/resources/contacts/client.py | 10 + .../resources/contacts/raw_client.py | 10 + .../ticketing/resources/tickets/client.py | 10 + .../ticketing/resources/tickets/raw_client.py | 10 + .../resources/ticketing/types/collection.py | 15 + tests/utils/test_query_encoding.py | 1 - 29 files changed, 3167 insertions(+), 2931 deletions(-) diff --git a/.mock/definition/hris/dependents.yml b/.mock/definition/hris/dependents.yml index bab4360c..75cac5b7 100644 --- a/.mock/definition/hris/dependents.yml +++ b/.mock/definition/hris/dependents.yml @@ -25,6 +25,9 @@ service: cursor: type: optional docs: The pagination cursor value. + employee_id: + type: optional + docs: If provided, will only return dependents for this employee. include_deleted_data: type: optional docs: >- diff --git a/.mock/definition/hris/employees.yml b/.mock/definition/hris/employees.yml index df2cd00f..04d39059 100644 --- a/.mock/definition/hris/employees.yml +++ b/.mock/definition/hris/employees.yml @@ -1183,6 +1183,9 @@ service: display_full_name: type: optional docs: If provided, will only return employees with this display name. + employee_number: + type: optional + docs: If provided, will only return employees with this employee number. employment_status: type: optional docs: >- diff --git a/.mock/definition/ticketing/__package__.yml b/.mock/definition/ticketing/__package__.yml index 640595be..a9ceb98e 100644 --- a/.mock/definition/ticketing/__package__.yml +++ b/.mock/definition/ticketing/__package__.yml @@ -843,6 +843,18 @@ types: parent_collection: type: optional docs: The parent collection for this collection. + collection_url: + type: optional + docs: The 3rd party url of the Collection. + validation: + format: uri + maxLength: 2000 + remote_created_at: + type: optional + docs: When the third party's collection was created. + remote_updated_at: + type: optional + docs: When the third party's collection was updated. remote_was_deleted: type: optional docs: >- diff --git a/.mock/definition/ticketing/collections.yml b/.mock/definition/ticketing/collections.yml index 0861c825..57359737 100644 --- a/.mock/definition/ticketing/collections.yml +++ b/.mock/definition/ticketing/collections.yml @@ -61,6 +61,9 @@ service: docs: >- If provided, only objects synced by Merge before this date time will be returned. + name: + type: optional + docs: If provided, will only return collections with this name. page_size: type: optional docs: Number of results to return per page. @@ -105,6 +108,9 @@ service: access_level: PRIVATE collection_type: LIST parent_collection: parent_collection + collection_url: https://example.com + remote_created_at: '2022-01-01T00:00:00Z' + remote_updated_at: '2022-01-01T00:00:00Z' remote_was_deleted: true field_mappings: organization_defined_targets: @@ -237,6 +243,9 @@ service: access_level: PRIVATE collection_type: LIST parent_collection: parent_collection + collection_url: https://example.com + remote_created_at: '2022-01-01T00:00:00Z' + remote_updated_at: '2022-01-01T00:00:00Z' remote_was_deleted: true field_mappings: organization_defined_targets: diff --git a/.mock/definition/ticketing/contacts.yml b/.mock/definition/ticketing/contacts.yml index 6bc83943..5296646e 100644 --- a/.mock/definition/ticketing/contacts.yml +++ b/.mock/definition/ticketing/contacts.yml @@ -25,6 +25,9 @@ service: cursor: type: optional docs: The pagination cursor value. + email_address: + type: optional + docs: If provided, will only return Contacts that match this email. expand: type: optional> docs: >- diff --git a/.mock/definition/ticketing/tickets.yml b/.mock/definition/ticketing/tickets.yml index 2d4a7ec5..74e70284 100644 --- a/.mock/definition/ticketing/tickets.yml +++ b/.mock/definition/ticketing/tickets.yml @@ -1208,6 +1208,9 @@ service: docs: >- If provided, only objects synced by Merge before this date time will be returned. + name: + type: optional + docs: If provided, will only return tickets with this name. page_size: type: optional docs: Number of results to return per page. diff --git a/README.md b/README.md index ff213acf..e003f4a1 100644 --- a/README.md +++ b/README.md @@ -171,7 +171,7 @@ from merge import Merge client = Merge( ..., httpx_client=httpx.Client( - proxies="http://my.test.proxy.example.com", + proxy="http://my.test.proxy.example.com", transport=httpx.HTTPTransport(local_address="0.0.0.0"), ), ) @@ -233,3 +233,4 @@ while response.next is not None: + diff --git a/pyproject.toml b/pyproject.toml index e09f7d3b..411fd66a 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -3,7 +3,7 @@ name = "MergePythonClient" [tool.poetry] name = "MergePythonClient" -version = "2.3.1" +version = "2.3.2" description = "" readme = "README.md" authors = [] diff --git a/reference.md b/reference.md index 8c298141..f1e59a3f 100644 --- a/reference.md +++ b/reference.md @@ -22155,8 +22155,8 @@ client.filestorage.webhook_receivers.create( -## Hris AccountDetails -
client.hris.account_details.retrieve() +## Ticketing AccountDetails +
client.ticketing.account_details.retrieve()
@@ -22189,7 +22189,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.account_details.retrieve() +client.ticketing.account_details.retrieve() ```
@@ -22217,8 +22217,8 @@ client.hris.account_details.retrieve()
-## Hris AccountToken -
client.hris.account_token.retrieve(...) +## Ticketing AccountToken +
client.ticketing.account_token.retrieve(...)
@@ -22251,7 +22251,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.account_token.retrieve( +client.ticketing.account_token.retrieve( public_token="public_token", ) @@ -22289,8 +22289,8 @@ client.hris.account_token.retrieve(
-## Hris AsyncPassthrough -
client.hris.async_passthrough.create(...) +## Ticketing Accounts +
client.ticketing.accounts.list(...)
@@ -22302,7 +22302,7 @@ client.hris.account_token.retrieve(
-Asynchronously pull data from an endpoint not currently supported by Merge. +Returns a list of `Account` objects.
@@ -22318,17 +22318,13 @@ Asynchronously pull data from an endpoint not currently supported by Merge. ```python from merge import Merge -from merge.resources.hris import DataPassthroughRequest, MethodEnum client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.async_passthrough.create( - request=DataPassthroughRequest( - method=MethodEnum.GET, - path="/scooters", - ), +client.ticketing.accounts.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", ) ``` @@ -22345,7 +22341,7 @@ client.hris.async_passthrough.create(
-**request:** `DataPassthroughRequest` +**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
@@ -22353,70 +22349,71 @@ client.hris.async_passthrough.create(
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. +**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
- -
+
+
+**cursor:** `typing.Optional[str]` — The pagination cursor value. +
-
-
client.hris.async_passthrough.retrieve(...)
-#### 📝 Description +**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/). + +
+
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. + +
+
+
-Retrieves data from earlier async-passthrough POST request -
-
+**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). + -#### 🔌 Usage -
+**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned. + +
+
+
-```python -from merge import Merge - -client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.hris.async_passthrough.retrieve( - async_passthrough_receipt_id="async_passthrough_receipt_id", -) - -``` -
-
+**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned. + -#### ⚙️ Parameters -
+**page_size:** `typing.Optional[int]` — Number of results to return per page. + +
+
+
-**async_passthrough_receipt_id:** `str` +**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
@@ -22436,8 +22433,7 @@ client.hris.async_passthrough.retrieve(
-## Hris AuditTrail -
client.hris.audit_trail.list(...) +
client.ticketing.accounts.retrieve(...)
@@ -22449,7 +22445,7 @@ client.hris.async_passthrough.retrieve(
-Gets a list of audit trail events. +Returns an `Account` object with the given `id`.
@@ -22470,8 +22466,8 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.audit_trail.list( - cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +client.ticketing.accounts.retrieve( + id="id", ) ``` @@ -22488,7 +22484,7 @@ client.hris.audit_trail.list(
-**cursor:** `typing.Optional[str]` — The pagination cursor value. +**id:** `str`
@@ -22496,7 +22492,7 @@ client.hris.audit_trail.list(
-**end_date:** `typing.Optional[str]` — If included, will only include audit trail events that occurred before this time +**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -22504,7 +22500,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` +**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -22512,23 +22508,75 @@ client.hris.audit_trail.list(
-**page_size:** `typing.Optional[int]` — Number of results to return per page. +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+ +
+ + + +
+ +## Ticketing AsyncPassthrough +
client.ticketing.async_passthrough.create(...)
-**start_date:** `typing.Optional[str]` — If included, will only include audit trail events that occurred after this time - +#### 📝 Description + +
+
+ +
+
+ +Asynchronously pull data from an endpoint not currently supported by Merge. +
+
+#### 🔌 Usage +
-**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. +
+
+ +```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", + ), +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request:** `DataPassthroughRequest`
@@ -22548,8 +22596,7 @@ client.hris.audit_trail.list(
-## Hris AvailableActions -
client.hris.available_actions.retrieve() +
client.ticketing.async_passthrough.retrieve(...)
@@ -22561,7 +22608,7 @@ client.hris.audit_trail.list(
-Returns a list of models and actions available for an account. +Retrieves data from earlier async-passthrough POST request
@@ -22582,7 +22629,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.available_actions.retrieve() +client.ticketing.async_passthrough.retrieve( + async_passthrough_receipt_id="async_passthrough_receipt_id", +) ``` @@ -22598,6 +22647,14 @@ client.hris.available_actions.retrieve()
+**async_passthrough_receipt_id:** `str` + +
+
+ +
+
+ **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -22610,8 +22667,8 @@ client.hris.available_actions.retrieve()
-## Hris BankInfo -
client.hris.bank_info.list(...) +## Ticketing Attachments +
client.ticketing.attachments.list(...)
@@ -22623,7 +22680,7 @@ client.hris.available_actions.retrieve()
-Returns a list of `BankInfo` objects. +Returns a list of `Attachment` objects.
@@ -22644,7 +22701,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.bank_info.list( +client.ticketing.attachments.list( cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", ) @@ -22662,27 +22719,6 @@ client.hris.bank_info.list(
-**account_type:** `typing.Optional[BankInfoListRequestAccountType]` - -If provided, will only return BankInfo's with this account type. Options: ('SAVINGS', 'CHECKING') - -* `SAVINGS` - SAVINGS -* `CHECKING` - CHECKING - -
-
- -
-
- -**bank_name:** `typing.Optional[str]` — If provided, will only return BankInfo's with this bank name. - -
-
- -
-
- **created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
@@ -22707,15 +22743,7 @@ If provided, will only return BankInfo's with this account type. Options: ('SAVI
-**employee_id:** `typing.Optional[str]` — If provided, will only return bank accounts for this employee. - -
-
- -
-
- -**expand:** `typing.Optional[typing.Literal["employee"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. +**expand:** `typing.Optional[typing.Literal["ticket"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -22763,14 +22791,6 @@ If provided, will only return BankInfo's with this account type. Options: ('SAVI
-**order_by:** `typing.Optional[BankInfoListRequestOrderBy]` — Overrides the default ordering for this endpoint. Possible values include: remote_created_at, -remote_created_at. - -
-
- -
-
- **page_size:** `typing.Optional[int]` — Number of results to return per page.
@@ -22779,7 +22799,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_created_after:** `typing.Optional[dt.datetime]` — If provided, will only return attachments created in the third party platform after this datetime.
@@ -22795,7 +22815,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) +**ticket_id:** `typing.Optional[str]` — If provided, will only return comments for this ticket.
@@ -22815,7 +22835,7 @@ If provided, will only return BankInfo's with this account type. Options: ('SAVI
-
client.hris.bank_info.retrieve(...) +
client.ticketing.attachments.create(...)
@@ -22827,7 +22847,7 @@ If provided, will only return BankInfo's with this account type. Options: ('SAVI
-Returns a `BankInfo` object with the given `id`. +Creates an `Attachment` object with the given values.
@@ -22843,13 +22863,14 @@ Returns a `BankInfo` object with the given `id`. ```python from merge import Merge +from merge.resources.ticketing import AttachmentRequest client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.bank_info.retrieve( - id="id", +client.ticketing.attachments.create( + model=AttachmentRequest(), ) ``` @@ -22866,7 +22887,7 @@ client.hris.bank_info.retrieve(
-**id:** `str` +**model:** `AttachmentRequest`
@@ -22874,7 +22895,7 @@ 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. +**is_debug_mode:** `typing.Optional[bool]` — Whether to include debug fields (such as log file links) in the response.
@@ -22882,7 +22903,7 @@ client.hris.bank_info.retrieve(
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. +**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously.
@@ -22890,44 +22911,19 @@ client.hris.bank_info.retrieve(
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+ +
-
-
-**remote_fields:** `typing.Optional[typing.Literal["account_type"]]` — Deprecated. Use show_enum_origins. -
+
-
-
- -**show_enum_origins:** `typing.Optional[typing.Literal["account_type"]]` — A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter) - -
-
- -
-
- -**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. - -
-
- - - - - - -
- -## Hris Benefits -
client.hris.benefits.list(...) +
client.ticketing.attachments.retrieve(...)
@@ -22939,7 +22935,7 @@ client.hris.bank_info.retrieve(
-Returns a list of `Benefit` objects. +Returns an `Attachment` object with the given `id`.
@@ -22960,8 +22956,8 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.benefits.list( - cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +client.ticketing.attachments.retrieve( + id="id", ) ``` @@ -22978,7 +22974,7 @@ client.hris.benefits.list(
-**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime. +**id:** `str`
@@ -22986,7 +22982,7 @@ client.hris.benefits.list(
-**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime. +**expand:** `typing.Optional[typing.Literal["ticket"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -22994,7 +22990,7 @@ client.hris.benefits.list(
-**cursor:** `typing.Optional[str]` — The pagination cursor value. +**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -23002,7 +22998,7 @@ client.hris.benefits.list(
-**employee_id:** `typing.Optional[str]` — If provided, will return the benefits associated with the employee. +**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -23010,67 +23006,64 @@ client.hris.benefits.list(
-**expand:** `typing.Optional[typing.Literal["employee"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+ +
-
-
-**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/). -
+
+
client.ticketing.attachments.meta_post_retrieve()
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. - -
-
+#### 📝 Description
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). - -
-
-
-**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned. - +Returns metadata for `TicketingAttachment` POSTs. +
+
+#### 🔌 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.attachments.meta_post_retrieve() + +```
+ + + +#### ⚙️ Parameters
-**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object. - -
-
-
@@ -23086,7 +23079,8 @@ client.hris.benefits.list(
-
client.hris.benefits.retrieve(...) +## Ticketing AuditTrail +
client.ticketing.audit_trail.list(...)
@@ -23098,7 +23092,7 @@ client.hris.benefits.list(
-Returns a `Benefit` object with the given `id`. +Gets a list of audit trail events.
@@ -23119,8 +23113,8 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.benefits.retrieve( - id="id", +client.ticketing.audit_trail.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", ) ``` @@ -23137,7 +23131,7 @@ client.hris.benefits.retrieve(
-**id:** `str` +**cursor:** `typing.Optional[str]` — The pagination cursor value.
@@ -23145,7 +23139,7 @@ client.hris.benefits.retrieve(
-**expand:** `typing.Optional[typing.Literal["employee"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. +**end_date:** `typing.Optional[str]` — If included, will only include audit trail events that occurred before this time
@@ -23153,7 +23147,7 @@ client.hris.benefits.retrieve(
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. +**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`
@@ -23161,7 +23155,23 @@ client.hris.benefits.retrieve(
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). +**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.
@@ -23181,8 +23191,8 @@ client.hris.benefits.retrieve(
-## Hris Companies -
client.hris.companies.list(...) +## Ticketing AvailableActions +
client.ticketing.available_actions.retrieve()
@@ -23194,7 +23204,7 @@ client.hris.benefits.retrieve(
-Returns a list of `Company` objects. +Returns a list of models and actions available for an account.
@@ -23215,7 +23225,69 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.companies.list( +client.ticketing.available_actions.retrieve() + +``` + +
+ + + +#### ⚙️ Parameters + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + + + +
+ +## Ticketing Collections +
client.ticketing.collections.list(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Returns a list of `Collection` objects. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from merge import Merge + +client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.ticketing.collections.list( cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", ) @@ -23233,6 +23305,14 @@ client.hris.companies.list(
+**collection_type:** `typing.Optional[str]` — If provided, will only return collections of the given type. + +
+
+ +
+
+ **created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
@@ -23257,6 +23337,14 @@ client.hris.companies.list(
+**expand:** `typing.Optional[typing.Literal["parent_collection"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. + +
+
+ +
+
+ **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/).
@@ -23297,6 +23385,14 @@ client.hris.companies.list(
+**name:** `typing.Optional[str]` — If provided, will only return collections with this name. + +
+
+ +
+
+ **page_size:** `typing.Optional[int]` — Number of results to return per page.
@@ -23305,6 +23401,22 @@ client.hris.companies.list(
+**parent_collection_id:** `typing.Optional[str]` — If provided, will only return collections whose parent collection matches the given id. + +
+
+ +
+
+ +**remote_fields:** `typing.Optional[typing.Literal["collection_type"]]` — Deprecated. Use show_enum_origins. + +
+
+ +
+
+ **remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
@@ -23313,6 +23425,14 @@ client.hris.companies.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) + +
+
+ +
+
+ **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -23325,7 +23445,7 @@ client.hris.companies.list(
-
client.hris.companies.retrieve(...) +
client.ticketing.collections.viewers_list(...)
@@ -23337,7 +23457,7 @@ client.hris.companies.list(
-Returns a `Company` 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 `Collection` with the given id. [Learn more.](https://help.merge.dev/en/articles/10333658-ticketing-access-control-list-acls)
@@ -23358,8 +23478,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.companies.retrieve( - id="id", +client.ticketing.collections.viewers_list( + collection_id="collection_id", + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", ) ``` @@ -23376,7 +23497,7 @@ client.hris.companies.retrieve(
-**id:** `str` +**collection_id:** `str`
@@ -23384,7 +23505,7 @@ client.hris.companies.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.
@@ -23392,7 +23513,7 @@ client.hris.companies.retrieve(
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). +**expand:** `typing.Optional[CollectionsViewersListRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -23400,65 +23521,35 @@ client.hris.companies.retrieve(
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. +**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
- -
- - - - -
-## Hris Scopes -
client.hris.scopes.default_scopes_retrieve()
-#### 📝 Description - -
-
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. + +
+
-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). -
-
+**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). +
-#### 🔌 Usage -
-
-
- -```python -from merge import Merge - -client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.hris.scopes.default_scopes_retrieve() - -``` -
-
+**page_size:** `typing.Optional[int]` — Number of results to return per page. +
-#### ⚙️ Parameters - -
-
-
@@ -23474,7 +23565,7 @@ client.hris.scopes.default_scopes_retrieve()
-
client.hris.scopes.linked_account_scopes_retrieve() +
client.ticketing.collections.retrieve(...)
@@ -23486,7 +23577,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). +Returns a `Collection` object with the given `id`.
@@ -23507,7 +23598,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.scopes.linked_account_scopes_retrieve() +client.ticketing.collections.retrieve( + id="id", +) ``` @@ -23523,99 +23616,23 @@ client.hris.scopes.linked_account_scopes_retrieve()
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. +**id:** `str`
- -
- - - - -
- -
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, - ) - }, - ), - ], -) - -``` -
-
+**expand:** `typing.Optional[typing.Literal["parent_collection"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. +
-#### ⚙️ Parameters - -
-
-
-**common_models:** `typing.Sequence[IndividualCommonModelScopeDeserializerRequest]` — The common models you want to update the scopes for +**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -23623,65 +23640,27 @@ client.hris.scopes.linked_account_scopes_create(
-**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).
-
-
- - -
-
-
- -## Hris DeleteAccount -
client.hris.delete_account.delete() -
-
- -#### 📝 Description - -
-
-Delete a linked account. -
-
+**remote_fields:** `typing.Optional[typing.Literal["collection_type"]]` — Deprecated. Use show_enum_origins. +
-#### 🔌 Usage -
-
-
- -```python -from merge import Merge - -client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.hris.delete_account.delete() - -``` -
-
+**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) +
-#### ⚙️ Parameters - -
-
-
@@ -23697,8 +23676,8 @@ client.hris.delete_account.delete()
-## Hris Dependents -
client.hris.dependents.list(...) +## Ticketing Comments +
client.ticketing.comments.list(...)
@@ -23710,7 +23689,7 @@ client.hris.delete_account.delete()
-Returns a list of `Dependent` objects. +Returns a list of `Comment` objects.
@@ -23731,7 +23710,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.dependents.list( +client.ticketing.comments.list( cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", ) @@ -23773,7 +23752,7 @@ client.hris.dependents.list(
-**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/). +**expand:** `typing.Optional[CommentsListRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -23781,7 +23760,7 @@ client.hris.dependents.list(
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. +**include_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/).
@@ -23789,7 +23768,7 @@ client.hris.dependents.list(
-**include_sensitive_fields:** `typing.Optional[bool]` — Whether to include sensitive fields (such as social security numbers) 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.
@@ -23829,6 +23808,14 @@ client.hris.dependents.list(
+**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.
@@ -23837,6 +23824,14 @@ client.hris.dependents.list(
+**ticket_id:** `typing.Optional[str]` — If provided, will only return comments for this ticket. + +
+
+ +
+
+ **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -23849,7 +23844,7 @@ client.hris.dependents.list(
-
client.hris.dependents.retrieve(...) +
client.ticketing.comments.create(...)
@@ -23861,7 +23856,7 @@ client.hris.dependents.list(
-Returns a `Dependent` object with the given `id`. +Creates a `Comment` object with the given values.
@@ -23877,13 +23872,14 @@ Returns a `Dependent` object with the given `id`. ```python from merge import Merge +from merge.resources.ticketing import CommentRequest client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.dependents.retrieve( - id="id", +client.ticketing.comments.create( + model=CommentRequest(), ) ``` @@ -23900,15 +23896,7 @@ client.hris.dependents.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. +**model:** `CommentRequest`
@@ -23916,7 +23904,7 @@ client.hris.dependents.retrieve(
-**include_sensitive_fields:** `typing.Optional[bool]` — Whether to include sensitive fields (such as social security numbers) in the response. +**is_debug_mode:** `typing.Optional[bool]` — Whether to include debug fields (such as log file links) in the response.
@@ -23924,7 +23912,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). +**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously.
@@ -23944,8 +23932,7 @@ client.hris.dependents.retrieve(
-## Hris EmployeePayrollRuns -
client.hris.employee_payroll_runs.list(...) +
client.ticketing.comments.retrieve(...)
@@ -23957,7 +23944,7 @@ client.hris.dependents.retrieve(
-Returns a list of `EmployeePayrollRun` objects. +Returns a `Comment` object with the given `id`.
@@ -23978,8 +23965,8 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.employee_payroll_runs.list( - cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +client.ticketing.comments.retrieve( + id="id", ) ``` @@ -23996,7 +23983,7 @@ client.hris.employee_payroll_runs.list(
-**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime. +**id:** `str`
@@ -24004,7 +23991,7 @@ client.hris.employee_payroll_runs.list(
-**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime. +**expand:** `typing.Optional[CommentsRetrieveRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -24012,7 +23999,7 @@ client.hris.employee_payroll_runs.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.
@@ -24020,111 +24007,7 @@ client.hris.employee_payroll_runs.list(
-**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. - -
-
- -
-
- -**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. +**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -24144,7 +24027,7 @@ client.hris.employee_payroll_runs.list(
-
client.hris.employee_payroll_runs.retrieve(...) +
client.ticketing.comments.meta_post_retrieve()
@@ -24156,7 +24039,7 @@ client.hris.employee_payroll_runs.list(
-Returns an `EmployeePayrollRun` object with the given `id`. +Returns metadata for `Comment` POSTs.
@@ -24177,9 +24060,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.employee_payroll_runs.retrieve( - id="id", -) +client.ticketing.comments.meta_post_retrieve() ``` @@ -24195,38 +24076,6 @@ client.hris.employee_payroll_runs.retrieve(
-**id:** `str` - -
-
- -
-
- -**expand:** `typing.Optional[EmployeePayrollRunsRetrieveRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. - -
-
- -
-
- -**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. - -
-
- -
-
- -**include_shell_data:** `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.
@@ -24239,8 +24088,8 @@ client.hris.employee_payroll_runs.retrieve(
-## Hris Employees -
client.hris.employees.list(...) +## Ticketing Contacts +
client.ticketing.contacts.list(...)
@@ -24252,7 +24101,7 @@ client.hris.employee_payroll_runs.retrieve(
-Returns a list of `Employee` objects. +Returns a list of `Contact` objects.
@@ -24273,7 +24122,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.employees.list( +client.ticketing.contacts.list( cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", ) @@ -24291,14 +24140,6 @@ client.hris.employees.list(
-**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.
@@ -24323,7 +24164,7 @@ client.hris.employees.list(
-**display_full_name:** `typing.Optional[str]` — If provided, will only return employees with this display name. +**email_address:** `typing.Optional[str]` — If provided, will only return Contacts that match this email.
@@ -24331,13 +24172,7 @@ client.hris.employees.list(
-**employment_status:** `typing.Optional[EmployeesListRequestEmploymentStatus]` - -If provided, will only return employees with this employment status. - -* `ACTIVE` - ACTIVE -* `PENDING` - PENDING -* `INACTIVE` - INACTIVE +**expand:** `typing.Optional[typing.Literal["account"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -24345,7 +24180,7 @@ If provided, will only return employees with this employment status.
-**employment_type:** `typing.Optional[str]` — If provided, will only return employees that have an employment of the specified employment_type. +**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/).
@@ -24353,7 +24188,7 @@ If provided, will only return employees with this employment status.
-**expand:** `typing.Optional[EmployeesListRequestExpand]` — 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.
@@ -24361,7 +24196,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. +**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -24369,7 +24204,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. +**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
@@ -24377,7 +24212,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. +**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
@@ -24385,7 +24220,7 @@ 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/). +**page_size:** `typing.Optional[int]` — Number of results to return per page.
@@ -24393,7 +24228,7 @@ If provided, will only return employees with this employment status.
-**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.
@@ -24401,71 +24236,71 @@ If provided, will only return employees with this employment status.
-**include_sensitive_fields:** `typing.Optional[bool]` — Whether to include sensitive fields (such as social security numbers) in the response. +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+ +
-
-
-**include_shell_data:** `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.contacts.create(...)
-**job_title:** `typing.Optional[str]` — If provided, will only return employees that have an employment of the specified job_title. - -
-
+#### 📝 Description
-**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. - +Creates a `Contact` object with the given values. +
+
+#### 🔌 Usage +
-**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. - +```python +from merge import Merge +from merge.resources.ticketing import ContactRequest + +client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.ticketing.contacts.create( + model=ContactRequest(), +) + +``` +
+
+#### ⚙️ Parameters +
-**page_size:** `typing.Optional[int]` — Number of results to return per page. - -
-
-
-**pay_group_id:** `typing.Optional[str]` — If provided, will only return employees for this pay group +**model:** `ContactRequest`
@@ -24473,7 +24308,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 +**is_debug_mode:** `typing.Optional[bool]` — Whether to include debug fields (such as log file links) in the response.
@@ -24481,7 +24316,7 @@ If provided, will only return employees with this employment status.
-**remote_fields:** `typing.Optional[EmployeesListRequestRemoteFields]` — Deprecated. Use show_enum_origins. +**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously.
@@ -24489,47 +24324,70 @@ If provided, will only return employees with this employment status.
-**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object. +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+ + -
-
-**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) -
+
+
client.ticketing.contacts.retrieve(...)
-**started_after:** `typing.Optional[dt.datetime]` — If provided, will only return employees that started after this datetime. - -
-
+#### 📝 Description
-**started_before:** `typing.Optional[dt.datetime]` — If provided, will only return employees that started before this datetime. - +
+
+ +Returns a `Contact` object with the given `id`. +
+
+#### 🔌 Usage +
-**team_id:** `typing.Optional[str]` — If provided, will only return employees for this team. - +
+
+ +```python +from merge import Merge + +client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.ticketing.contacts.retrieve( + id="id", +) + +``` +
+
+#### ⚙️ Parameters +
-**terminated_after:** `typing.Optional[dt.datetime]` — If provided, will only return employees that were terminated after this datetime. +
+
+ +**id:** `str`
@@ -24537,7 +24395,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. +**expand:** `typing.Optional[typing.Literal["account"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -24545,7 +24403,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 +**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -24553,7 +24411,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. +**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -24573,7 +24431,7 @@ If provided, will only return employees with this employment status.
-
client.hris.employees.create(...) +
client.ticketing.contacts.meta_post_retrieve()
@@ -24585,7 +24443,7 @@ If provided, will only return employees with this employment status.
-Creates an `Employee` object with the given values. +Returns metadata for `TicketingContact` POSTs.
@@ -24601,15 +24459,12 @@ Creates an `Employee` object with the given values. ```python from merge import Merge -from merge.resources.hris import EmployeeRequest client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.employees.create( - model=EmployeeRequest(), -) +client.ticketing.contacts.meta_post_retrieve() ``` @@ -24625,30 +24480,6 @@ client.hris.employees.create(
-**model:** `EmployeeRequest` - -
-
- -
-
- -**is_debug_mode:** `typing.Optional[bool]` — Whether to include debug fields (such as log file links) in the response. - -
-
- -
-
- -**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously. - -
-
- -
-
- **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -24661,7 +24492,8 @@ client.hris.employees.create(
-
client.hris.employees.retrieve(...) +## Ticketing Scopes +
client.ticketing.scopes.default_scopes_retrieve()
@@ -24673,7 +24505,7 @@ client.hris.employees.create(
-Returns an `Employee` object with the given `id`. +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).
@@ -24694,9 +24526,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.employees.retrieve( - id="id", -) +client.ticketing.scopes.default_scopes_retrieve() ``` @@ -24712,58 +24542,63 @@ client.hris.employees.retrieve(
-**id:** `str` +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+ +
-
-
-**expand:** `typing.Optional[EmployeesRetrieveRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. -
+
+
client.ticketing.scopes.linked_account_scopes_retrieve()
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. - -
-
+#### 📝 Description
-**include_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). - +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
-**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) - +```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 + +
+
@@ -24780,7 +24615,7 @@ client.hris.employees.retrieve(
-
client.hris.employees.ignore_create(...) +
client.ticketing.scopes.linked_account_scopes_create(...)
@@ -24792,7 +24627,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. +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)
@@ -24808,15 +24643,42 @@ 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.ticketing import ( + FieldPermissionDeserializerRequest, + IndividualCommonModelScopeDeserializerRequest, + ModelPermissionDeserializerRequest, +) 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.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, + ) + }, + ), + ], ) ``` @@ -24833,23 +24695,7 @@ client.hris.employees.ignore_create(
-**model_id:** `str` - -
-
- -
-
- -**reason:** `IgnoreCommonModelRequestReason` - -
-
- -
-
- -**message:** `typing.Optional[str]` +**common_models:** `typing.Sequence[IndividualCommonModelScopeDeserializerRequest]` — The common models you want to update the scopes for
@@ -24869,7 +24715,8 @@ client.hris.employees.ignore_create(
-
client.hris.employees.meta_post_retrieve() +## Ticketing DeleteAccount +
client.ticketing.delete_account.delete()
@@ -24881,7 +24728,7 @@ client.hris.employees.ignore_create(
-Returns metadata for `Employee` POSTs. +Delete a linked account.
@@ -24902,7 +24749,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.employees.meta_post_retrieve() +client.ticketing.delete_account.delete() ``` @@ -24930,8 +24777,8 @@ client.hris.employees.meta_post_retrieve()
-## Hris EmployerBenefits -
client.hris.employer_benefits.list(...) +## Ticketing FieldMapping +
client.ticketing.field_mapping.field_mappings_retrieve(...)
@@ -24943,7 +24790,7 @@ client.hris.employees.meta_post_retrieve()
-Returns a list of `EmployerBenefit` objects. +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/).
@@ -24964,9 +24811,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.employer_benefits.list( - cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", -) +client.ticketing.field_mapping.field_mappings_retrieve() ``` @@ -24982,7 +24827,7 @@ client.hris.employer_benefits.list(
-**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime. +**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.
@@ -24990,23 +24835,75 @@ client.hris.employer_benefits.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.
+ +
+ + + +
+ +
client.ticketing.field_mapping.field_mappings_create(...)
-**cursor:** `typing.Optional[str]` — The pagination cursor value. - +#### 📝 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 +
-**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/). +
+
+ +```python +from merge import Merge + +client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.ticketing.field_mapping.field_mappings_create( + target_field_name="example_target_field_name", + target_field_description="this is a example description of the target field", + remote_field_traversal_path=["example_remote_field"], + remote_method="GET", + remote_url_path="/example-url-path", + common_model_name="ExampleCommonModel", +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**target_field_name:** `str` — The name of the target field you want this remote field to map to.
@@ -25014,7 +24911,7 @@ client.hris.employer_benefits.list(
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. +**target_field_description:** `str` — The description of the target field you want this remote field to map to.
@@ -25022,7 +24919,7 @@ client.hris.employer_benefits.list(
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). +**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.
@@ -25030,7 +24927,7 @@ client.hris.employer_benefits.list(
-**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned. +**remote_method:** `str` — The method of the remote endpoint where the remote field is coming from.
@@ -25038,7 +24935,7 @@ client.hris.employer_benefits.list(
-**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned. +**remote_url_path:** `str` — The path of the remote endpoint where the remote field is coming from.
@@ -25046,7 +24943,7 @@ client.hris.employer_benefits.list(
-**page_size:** `typing.Optional[int]` — Number of results to return per page. +**common_model_name:** `str` — The name of the Common Model that the remote field corresponds to in a given category.
@@ -25054,7 +24951,7 @@ client.hris.employer_benefits.list(
-**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object. +**exclude_remote_field_metadata:** `typing.Optional[bool]` — If `true`, remote fields metadata is excluded from each field mapping instance (i.e. `remote_fields.remote_key_name` and `remote_fields.schema` will be null). This will increase the speed of the request since these fields require some calculations.
@@ -25074,7 +24971,7 @@ client.hris.employer_benefits.list(
-
client.hris.employer_benefits.retrieve(...) +
client.ticketing.field_mapping.field_mappings_destroy(...)
@@ -25086,7 +24983,7 @@ client.hris.employer_benefits.list(
-Returns an `EmployerBenefit` object with the given `id`. +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.
@@ -25107,8 +25004,8 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.employer_benefits.retrieve( - id="id", +client.ticketing.field_mapping.field_mappings_destroy( + field_mapping_id="field_mapping_id", ) ``` @@ -25125,23 +25022,7 @@ client.hris.employer_benefits.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). +**field_mapping_id:** `str`
@@ -25161,8 +25042,7 @@ client.hris.employer_benefits.retrieve(
-## Hris Employments -
client.hris.employments.list(...) +
client.ticketing.field_mapping.field_mappings_partial_update(...)
@@ -25174,7 +25054,7 @@ client.hris.employer_benefits.retrieve(
-Returns a list of `Employment` objects. +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.
@@ -25195,8 +25075,8 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.employments.list( - cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +client.ticketing.field_mapping.field_mappings_partial_update( + field_mapping_id="field_mapping_id", ) ``` @@ -25213,7 +25093,7 @@ client.hris.employments.list(
-**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime. +**field_mapping_id:** `str`
@@ -25221,7 +25101,7 @@ client.hris.employments.list(
-**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime. +**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.
@@ -25229,7 +25109,7 @@ client.hris.employments.list(
-**cursor:** `typing.Optional[str]` — The pagination cursor value. +**remote_method:** `typing.Optional[str]` — The method of the remote endpoint where the remote field is coming from.
@@ -25237,7 +25117,7 @@ client.hris.employments.list(
-**employee_id:** `typing.Optional[str]` — If provided, will only return employments for this employee. +**remote_url_path:** `typing.Optional[str]` — The path of the remote endpoint where the remote field is coming from.
@@ -25245,79 +25125,68 @@ client.hris.employments.list(
-**expand:** `typing.Optional[EmploymentsListRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
- -
-
- -**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/). -
-
-
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. -
+
+
client.ticketing.field_mapping.remote_fields_retrieve(...)
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). - -
-
+#### 📝 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. - +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 +
-**order_by:** `typing.Optional[EmploymentsListRequestOrderBy]` — Overrides the default ordering for this endpoint. Possible values include: effective_date, -effective_date. - -
-
-
-**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.field_mapping.remote_fields_retrieve() + +``` +
+
+#### ⚙️ Parameters +
-**remote_fields:** `typing.Optional[EmploymentsListRequestRemoteFields]` — Deprecated. Use show_enum_origins. - -
-
-
-**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object. +**common_models:** `typing.Optional[str]` — A comma seperated list of Common Model names. If included, will only return Remote Fields for those Common Models.
@@ -25325,7 +25194,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_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.
@@ -25345,7 +25214,7 @@ client.hris.employments.list(
-
client.hris.employments.retrieve(...) +
client.ticketing.field_mapping.target_fields_retrieve()
@@ -25357,7 +25226,7 @@ client.hris.employments.list(
-Returns an `Employment` object with the given `id`. +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/).
@@ -25378,9 +25247,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.employments.retrieve( - id="id", -) +client.ticketing.field_mapping.target_fields_retrieve() ``` @@ -25388,58 +25255,10 @@ client.hris.employments.retrieve(
-#### ⚙️ Parameters - -
-
- -
-
- -**id:** `str` - -
-
- -
-
- -**expand:** `typing.Optional[EmploymentsRetrieveRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. - -
-
- -
-
- -**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. - -
-
- -
-
- -**include_shell_data:** `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) - -
-
+#### ⚙️ Parameters + +
+
@@ -25456,8 +25275,8 @@ client.hris.employments.retrieve(
-## Hris FieldMapping -
client.hris.field_mapping.field_mappings_retrieve(...) +## Ticketing GenerateKey +
client.ticketing.generate_key.create(...)
@@ -25469,7 +25288,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/). +Create a remote key.
@@ -25490,7 +25309,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.field_mapping.field_mappings_retrieve() +client.ticketing.generate_key.create( + name="Remote Deployment Key 1", +) ``` @@ -25506,7 +25327,7 @@ 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. +**name:** `str` — The name of the remote key
@@ -25526,7 +25347,8 @@ client.hris.field_mapping.field_mappings_retrieve()
-
client.hris.field_mapping.field_mappings_create(...) +## Ticketing Issues +
client.ticketing.issues.list(...)
@@ -25538,7 +25360,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. +Gets all issues for Organization.
@@ -25559,13 +25381,8 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.field_mapping.field_mappings_create( - target_field_name="example_target_field_name", - target_field_description="this is a example description of the target field", - remote_field_traversal_path=["example_remote_field"], - remote_method="GET", - remote_url_path="/example-url-path", - common_model_name="ExampleCommonModel", +client.ticketing.issues.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", ) ``` @@ -25582,7 +25399,7 @@ client.hris.field_mapping.field_mappings_create(
-**target_field_name:** `str` — The name of the target field you want this remote field to map to. +**account_token:** `typing.Optional[str]`
@@ -25590,7 +25407,7 @@ client.hris.field_mapping.field_mappings_create(
-**target_field_description:** `str` — The description of the target field you want this remote field to map to. +**cursor:** `typing.Optional[str]` — The pagination cursor value.
@@ -25598,7 +25415,7 @@ client.hris.field_mapping.field_mappings_create(
-**remote_field_traversal_path:** `typing.Sequence[typing.Optional[typing.Any]]` — The field traversal path of the remote field listed when you hit the GET /remote-fields endpoint. +**end_date:** `typing.Optional[str]` — If included, will only include issues whose most recent action occurred before this time
@@ -25606,7 +25423,7 @@ client.hris.field_mapping.field_mappings_create(
-**remote_method:** `str` — The method of the remote endpoint where the remote field is coming from. +**end_user_organization_name:** `typing.Optional[str]`
@@ -25614,7 +25431,7 @@ client.hris.field_mapping.field_mappings_create(
-**remote_url_path:** `str` — The path of the remote endpoint where the remote field is coming from. +**first_incident_time_after:** `typing.Optional[dt.datetime]` — If provided, will only return issues whose first incident time was after this datetime.
@@ -25622,7 +25439,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. +**first_incident_time_before:** `typing.Optional[dt.datetime]` — If provided, will only return issues whose first incident time was before this datetime.
@@ -25630,7 +25447,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_muted:** `typing.Optional[str]` — If true, will include muted issues
@@ -25638,70 +25455,60 @@ client.hris.field_mapping.field_mappings_create(
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. +**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. +
-
-
client.hris.field_mapping.field_mappings_destroy(...)
-#### 📝 Description - -
-
+**last_incident_time_before:** `typing.Optional[dt.datetime]` — If provided, will only return issues whose last incident time was before this datetime. + +
+
-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. -
-
+**linked_account_id:** `typing.Optional[str]` — If provided, will only include issues pertaining to the linked account passed in. +
-#### 🔌 Usage -
+**page_size:** `typing.Optional[int]` — Number of results to return per page. + +
+
+
-```python -from merge import Merge - -client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.hris.field_mapping.field_mappings_destroy( - field_mapping_id="field_mapping_id", -) - -``` -
-
+**start_date:** `typing.Optional[str]` — If included, will only include issues whose most recent action occurred after this time + -#### ⚙️ Parameters -
-
-
+**status:** `typing.Optional[IssuesListRequestStatus]` -**field_mapping_id:** `str` +Status of the issue. Options: ('ONGOING', 'RESOLVED') + +* `ONGOING` - ONGOING +* `RESOLVED` - RESOLVED
@@ -25721,7 +25528,7 @@ client.hris.field_mapping.field_mappings_destroy(
-
client.hris.field_mapping.field_mappings_partial_update(...) +
client.ticketing.issues.retrieve(...)
@@ -25733,7 +25540,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. +Get a specific issue.
@@ -25754,8 +25561,8 @@ 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.ticketing.issues.retrieve( + id="id", ) ``` @@ -25772,31 +25579,7 @@ client.hris.field_mapping.field_mappings_partial_update(
-**field_mapping_id:** `str` - -
-
- -
-
- -**remote_field_traversal_path:** `typing.Optional[typing.Sequence[typing.Optional[typing.Any]]]` — The field traversal path of the remote field listed when you hit the GET /remote-fields endpoint. - -
-
- -
-
- -**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. +**id:** `str`
@@ -25816,7 +25599,8 @@ client.hris.field_mapping.field_mappings_partial_update(
-
client.hris.field_mapping.remote_fields_retrieve(...) +## Ticketing LinkToken +
client.ticketing.link_token.create(...)
@@ -25828,7 +25612,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 link token to be used when linking a new end user.
@@ -25844,12 +25628,18 @@ Get all remote fields for a Linked Account. Remote fields are third-party fields ```python from merge import Merge +from merge.resources.ticketing import CategoriesEnum client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.field_mapping.remote_fields_retrieve() +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], +) ``` @@ -25865,7 +25655,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. +**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.
@@ -25873,7 +25663,7 @@ client.hris.field_mapping.remote_fields_retrieve()
-**include_example_values:** `typing.Optional[str]` — If true, will include example values, where available, for remote fields in the 3rd party platform. These examples come from active data from your customers. +**end_user_organization_name:** `str` — Your end user's organization.
@@ -25881,132 +25671,99 @@ client.hris.field_mapping.remote_fields_retrieve()
-**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.target_fields_retrieve()
-#### 📝 Description - -
-
+**categories:** `typing.Sequence[CategoriesEnum]` — The integration categories to show in Merge Link. + +
+
-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/). -
-
+**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 - -client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.hris.field_mapping.target_fields_retrieve() - -``` -
-
+**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 - -
-
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. +**should_create_magic_link_url:** `typing.Optional[bool]` — Whether to generate a Magic Link URL. Defaults to false. For more information on Magic Link, see https://merge.dev/blog/integrations-fast-say-hello-to-magic-link.
-
-
+
+
+**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. +
-
-## Hris GenerateKey -
client.hris.generate_key.create(...)
-#### 📝 Description - -
-
+**common_models:** `typing.Optional[typing.Sequence[CommonModelScopesBodyRequest]]` — An array of objects to specify the models and fields that will be disabled for a given Linked Account. Each object uses model_id, enabled_actions, and disabled_fields to specify the model, method, and fields that are scoped for a given Linked Account. + +
+
-Create a remote key. -
-
+**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. +
-#### 🔌 Usage - -
-
-
-```python -from merge import Merge +**language:** `typing.Optional[EndUserDetailsRequestLanguage]` -client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.hris.generate_key.create( - name="Remote Deployment Key 1", -) +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. + +
+
+
-**name:** `str` — The name of the remote key +**integration_specific_config:** `typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]]` — A JSON object containing integration-specific configuration options.
@@ -26026,8 +25783,8 @@ client.hris.generate_key.create(
-## Hris Groups -
client.hris.groups.list(...) +## Ticketing LinkedAccounts +
client.ticketing.linked_accounts.list(...)
@@ -26039,7 +25796,7 @@ client.hris.generate_key.create(
-Returns a list of `Group` objects. +List linked accounts for your organization.
@@ -26060,7 +25817,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.groups.list( +client.ticketing.linked_accounts.list( cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", ) @@ -26078,15 +25835,17 @@ client.hris.groups.list(
-**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime. - -
-
+**category:** `typing.Optional[LinkedAccountsListRequestCategory]` -
-
+Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing` -**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime. +* `hris` - hris +* `ats` - ats +* `accounting` - accounting +* `ticketing` - ticketing +* `crm` - crm +* `mktg` - mktg +* `filestorage` - filestorage
@@ -26102,15 +25861,7 @@ client.hris.groups.list(
-**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/). - -
-
- -
-
- -**include_remote_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.
@@ -26118,7 +25869,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). +**end_user_organization_name:** `typing.Optional[str]` — If provided, will only return linked accounts associated with the given organization name.
@@ -26126,7 +25877,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. +**end_user_origin_id:** `typing.Optional[str]` — If provided, will only return linked accounts associated with the given origin ID.
@@ -26134,7 +25885,7 @@ client.hris.groups.list(
-**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned. +**end_user_origin_ids:** `typing.Optional[str]` — Comma-separated list of EndUser origin IDs, making it possible to specify multiple EndUsers at once.
@@ -26142,7 +25893,7 @@ client.hris.groups.list(
-**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned. +**id:** `typing.Optional[str]`
@@ -26150,7 +25901,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. +**ids:** `typing.Optional[str]` — Comma-separated list of LinkedAccount IDs, making it possible to specify multiple LinkedAccounts at once.
@@ -26158,7 +25909,7 @@ client.hris.groups.list(
-**page_size:** `typing.Optional[int]` — Number of results to return per page. +**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.
@@ -26166,7 +25917,7 @@ client.hris.groups.list(
-**remote_fields:** `typing.Optional[typing.Literal["type"]]` — Deprecated. Use show_enum_origins. +**integration_name:** `typing.Optional[str]` — If provided, will only return linked accounts associated with the given integration name.
@@ -26174,7 +25925,7 @@ client.hris.groups.list(
-**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object. +**is_test_account:** `typing.Optional[str]` — If included, will only include test linked accounts. If not included, will only include non-test linked accounts.
@@ -26182,7 +25933,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) +**page_size:** `typing.Optional[int]` — Number of results to return per page.
@@ -26190,7 +25941,7 @@ client.hris.groups.list(
-**types:** `typing.Optional[str]` — If provided, will only return groups of these types. Multiple values can be separated by commas. +**status:** `typing.Optional[str]` — Filter by status. Options: `COMPLETE`, `IDLE`, `INCOMPLETE`, `RELINK_NEEDED`
@@ -26210,7 +25961,8 @@ client.hris.groups.list(
-
client.hris.groups.retrieve(...) +## Ticketing Passthrough +
client.ticketing.passthrough.create(...)
@@ -26222,7 +25974,7 @@ client.hris.groups.list(
-Returns a `Group` object with the given `id`. +Pull data from an endpoint not currently supported by Merge.
@@ -26238,13 +25990,17 @@ Returns a `Group` object with the given `id`. ```python from merge import Merge +from merge.resources.ticketing import DataPassthroughRequest, MethodEnum client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.groups.retrieve( - id="id", +client.ticketing.passthrough.create( + request=DataPassthroughRequest( + method=MethodEnum.GET, + path="/scooters", + ), ) ``` @@ -26261,39 +26017,7 @@ client.hris.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). - -
-
- -
-
- -**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:** `DataPassthroughRequest`
@@ -26313,8 +26037,8 @@ client.hris.groups.retrieve(
-## Hris Issues -
client.hris.issues.list(...) +## Ticketing Projects +
client.ticketing.projects.list(...)
@@ -26326,7 +26050,7 @@ client.hris.groups.retrieve(
-Gets all issues for Organization. +Returns a list of `Project` objects.
@@ -26347,7 +26071,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.issues.list( +client.ticketing.projects.list( cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", ) @@ -26365,31 +26089,7 @@ client.hris.issues.list(
-**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]` +**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
@@ -26397,7 +26097,7 @@ client.hris.issues.list(
-**first_incident_time_after:** `typing.Optional[dt.datetime]` — If provided, will only return issues whose first incident time was after this datetime. +**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
@@ -26405,7 +26105,7 @@ client.hris.issues.list(
-**first_incident_time_before:** `typing.Optional[dt.datetime]` — If provided, will only return issues whose first incident time was before this datetime. +**cursor:** `typing.Optional[str]` — The pagination cursor value.
@@ -26413,7 +26113,7 @@ client.hris.issues.list(
-**include_muted:** `typing.Optional[str]` — If true, will include muted issues +**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
@@ -26421,7 +26121,7 @@ client.hris.issues.list(
-**integration_name:** `typing.Optional[str]` +**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -26429,7 +26129,7 @@ client.hris.issues.list(
-**last_incident_time_after:** `typing.Optional[dt.datetime]` — If provided, will only return issues whose last incident time was after this datetime. +**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -26437,7 +26137,7 @@ client.hris.issues.list(
-**last_incident_time_before:** `typing.Optional[dt.datetime]` — If provided, will only return issues whose last incident time was before this datetime. +**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
@@ -26445,7 +26145,7 @@ client.hris.issues.list(
-**linked_account_id:** `typing.Optional[str]` — If provided, will only include issues pertaining to the linked account passed in. +**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
@@ -26461,20 +26161,7 @@ client.hris.issues.list(
-**start_date:** `typing.Optional[str]` — If included, will only include issues whose most recent action occurred after this time - -
-
- -
-
- -**status:** `typing.Optional[IssuesListRequestStatus]` - -Status of the issue. Options: ('ONGOING', 'RESOLVED') - -* `ONGOING` - ONGOING -* `RESOLVED` - RESOLVED +**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
@@ -26494,7 +26181,7 @@ Status of the issue. Options: ('ONGOING', 'RESOLVED')
-
client.hris.issues.retrieve(...) +
client.ticketing.projects.retrieve(...)
@@ -26506,7 +26193,7 @@ Status of the issue. Options: ('ONGOING', 'RESOLVED')
-Get a specific issue. +Returns a `Project` object with the given `id`.
@@ -26527,7 +26214,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.issues.retrieve( +client.ticketing.projects.retrieve( id="id", ) @@ -26553,6 +26240,22 @@ client.hris.issues.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). + +
+
+ +
+
+ **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -26565,8 +26268,7 @@ client.hris.issues.retrieve(
-## Hris LinkToken -
client.hris.link_token.create(...) +
client.ticketing.projects.users_list(...)
@@ -26578,7 +26280,7 @@ client.hris.issues.retrieve(
-Creates a link token to be used when linking a new end user. +Returns a list of `User` objects.
@@ -26594,17 +26296,14 @@ Creates a link token to be used when linking a new end user. ```python 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.ticketing.projects.users_list( + parent_id="parent_id", + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", ) ``` @@ -26621,7 +26320,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. +**parent_id:** `str`
@@ -26629,7 +26328,7 @@ client.hris.link_token.create(
-**end_user_organization_name:** `str` — Your end user's organization. +**cursor:** `typing.Optional[str]` — The pagination cursor value.
@@ -26637,7 +26336,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. +**expand:** `typing.Optional[ProjectsUsersListRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -26645,7 +26344,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/).
@@ -26653,7 +26352,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.
@@ -26661,7 +26360,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).
@@ -26669,7 +26368,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. +**page_size:** `typing.Optional[int]` — Number of results to return per page.
@@ -26677,59 +26376,71 @@ 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. +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+ +
-
-
-**common_models:** `typing.Optional[typing.Sequence[CommonModelScopesBodyRequest]]` — An array of objects to specify the models and fields that will be disabled for a given Linked Account. Each object uses model_id, enabled_actions, and disabled_fields to specify the model, method, and fields that are scoped for a given Linked Account. -
+
+## Ticketing RegenerateKey +
client.ticketing.regenerate_key.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. - +#### 📝 Description + +
+
+ +
+
+ +Exchange remote keys. +
+
+#### 🔌 Usage +
-**language:** `typing.Optional[EndUserDetailsRequestLanguage]` +
+
+ +```python +from merge import Merge -The following subset of IETF language tags can be used to configure localization. +client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.ticketing.regenerate_key.create( + name="Remote Deployment Key 1", +) -* `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. +**name:** `str` — The name of the remote key
@@ -26749,8 +26460,8 @@ The following subset of IETF language tags can be used to configure localization
-## Hris LinkedAccounts -
client.hris.linked_accounts.list(...) +## Ticketing Roles +
client.ticketing.roles.list(...)
@@ -26762,7 +26473,7 @@ The following subset of IETF language tags can be used to configure localization
-List linked accounts for your organization. +Returns a list of `Role` objects.
@@ -26783,7 +26494,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.linked_accounts.list( +client.ticketing.roles.list( cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", ) @@ -26801,41 +26512,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. - -
-
- -
-
- -**end_user_email_address:** `typing.Optional[str]` — If provided, will only return linked accounts associated with the given email address. - -
-
- -
-
- -**end_user_organization_name:** `typing.Optional[str]` — If provided, will only return linked accounts associated with the given organization name. +**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
@@ -26843,7 +26520,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. +**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
@@ -26851,7 +26528,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. +**cursor:** `typing.Optional[str]` — The pagination cursor value.
@@ -26859,7 +26536,7 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing`
-**id:** `typing.Optional[str]` +**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
@@ -26867,7 +26544,7 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing`
-**ids:** `typing.Optional[str]` — Comma-separated list of LinkedAccount IDs, making it possible to specify multiple LinkedAccounts at once. +**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -26875,7 +26552,7 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing`
-**include_duplicates:** `typing.Optional[bool]` — If `true`, will include complete production duplicates of the account specified by the `id` query parameter in the response. `id` must be for a complete production linked account. +**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -26883,7 +26560,7 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing`
-**integration_name:** `typing.Optional[str]` — If provided, will only return linked accounts associated with the given integration name. +**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
@@ -26891,7 +26568,7 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing`
-**is_test_account:** `typing.Optional[str]` — If included, will only include test linked accounts. If not included, will only include non-test linked accounts. +**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
@@ -26907,7 +26584,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.
@@ -26927,8 +26604,7 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing`
-## Hris Locations -
client.hris.locations.list(...) +
client.ticketing.roles.retrieve(...)
@@ -26940,7 +26616,7 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing`
-Returns a list of `Location` objects. +Returns a `Role` object with the given `id`.
@@ -26961,8 +26637,8 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.locations.list( - cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +client.ticketing.roles.retrieve( + id="id", ) ``` @@ -26979,7 +26655,7 @@ client.hris.locations.list(
-**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime. +**id:** `str`
@@ -26987,7 +26663,7 @@ client.hris.locations.list(
-**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime. +**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -26995,7 +26671,7 @@ client.hris.locations.list(
-**cursor:** `typing.Optional[str]` — The pagination cursor value. +**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -27003,52 +26679,71 @@ 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/). +**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. -
+
+## Ticketing SyncStatus +
client.ticketing.sync_status.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). - -
-
+#### 📝 Description
-**location_type:** `typing.Optional[LocationsListRequestLocationType]` - -If provided, will only return locations with this location_type +
+
-* `HOME` - HOME -* `WORK` - WORK - +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).
+
+
+ +#### 🔌 Usage
-**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned. - +
+
+ +```python +from merge import Merge + +client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.ticketing.sync_status.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) + +``` +
+
+#### ⚙️ Parameters +
-**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.
@@ -27064,27 +26759,65 @@ If provided, will only return locations with this location_type
-**remote_fields:** `typing.Optional[LocationsListRequestRemoteFields]` — Deprecated. Use show_enum_origins. +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+ + + + +
+## Ticketing ForceResync +
client.ticketing.force_resync.sync_status_resync_create()
-**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object. - +#### 📝 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[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) - +
+
+ +```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 + +
+
+
@@ -27100,7 +26833,8 @@ If provided, will only return locations with this location_type
-
client.hris.locations.retrieve(...) +## Ticketing Tags +
client.ticketing.tags.list(...)
@@ -27112,7 +26846,7 @@ If provided, will only return locations with this location_type
-Returns a `Location` object with the given `id`. +Returns a list of `Tag` objects.
@@ -27133,8 +26867,8 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.locations.retrieve( - id="id", +client.ticketing.tags.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", ) ``` @@ -27151,7 +26885,31 @@ client.hris.locations.retrieve(
-**id:** `str` +**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime. + +
+
+ +
+
+ +**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime. + +
+
+ +
+
+ +**cursor:** `typing.Optional[str]` — The pagination cursor value. + +
+
+ +
+
+ +**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
@@ -27175,7 +26933,7 @@ client.hris.locations.retrieve(
-**remote_fields:** `typing.Optional[LocationsRetrieveRequestRemoteFields]` — Deprecated. Use show_enum_origins. +**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
@@ -27183,7 +26941,23 @@ client.hris.locations.retrieve(
-**show_enum_origins:** `typing.Optional[LocationsRetrieveRequestShowEnumOrigins]` — A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter) +**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned. + +
+
+ +
+
+ +**page_size:** `typing.Optional[int]` — Number of results to return per page. + +
+
+ +
+
+ +**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
@@ -27203,8 +26977,7 @@ client.hris.locations.retrieve(
-## Hris Passthrough -
client.hris.passthrough.create(...) +
client.ticketing.tags.retrieve(...)
@@ -27216,7 +26989,7 @@ client.hris.locations.retrieve(
-Pull data from an endpoint not currently supported by Merge. +Returns a `Tag` object with the given `id`.
@@ -27232,17 +27005,13 @@ Pull data from an endpoint not currently supported by Merge. ```python from merge import Merge -from merge.resources.hris import DataPassthroughRequest, MethodEnum client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.passthrough.create( - request=DataPassthroughRequest( - method=MethodEnum.GET, - path="/scooters", - ), +client.ticketing.tags.retrieve( + id="id", ) ``` @@ -27259,7 +27028,23 @@ client.hris.passthrough.create(
-**request:** `DataPassthroughRequest` +**id:** `str` + +
+
+ +
+
+ +**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. + +
+
+ +
+
+ +**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -27279,8 +27064,8 @@ client.hris.passthrough.create(
-## Hris PayGroups -
client.hris.pay_groups.list(...) +## Ticketing Teams +
client.ticketing.teams.list(...)
@@ -27292,7 +27077,7 @@ client.hris.passthrough.create(
-Returns a list of `PayGroup` objects. +Returns a list of `Team` objects.
@@ -27313,7 +27098,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.pay_groups.list( +client.ticketing.teams.list( cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", ) @@ -27423,7 +27208,7 @@ client.hris.pay_groups.list(
-
client.hris.pay_groups.retrieve(...) +
client.ticketing.teams.retrieve(...)
@@ -27435,7 +27220,7 @@ client.hris.pay_groups.list(
-Returns a `PayGroup` object with the given `id`. +Returns a `Team` object with the given `id`.
@@ -27456,7 +27241,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.pay_groups.retrieve( +client.ticketing.teams.retrieve( id="id", ) @@ -27510,8 +27295,8 @@ client.hris.pay_groups.retrieve(
-## Hris PayrollRuns -
client.hris.payroll_runs.list(...) +## Ticketing Tickets +
client.ticketing.tickets.list(...)
@@ -27523,7 +27308,7 @@ client.hris.pay_groups.retrieve(
-Returns a list of `PayrollRun` objects. +Returns a list of `Ticket` objects.
@@ -27544,7 +27329,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.payroll_runs.list( +client.ticketing.tickets.list( cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", ) @@ -27562,7 +27347,7 @@ client.hris.payroll_runs.list(
-**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime. +**account_id:** `typing.Optional[str]` — If provided, will only return tickets for this account.
@@ -27570,7 +27355,7 @@ client.hris.payroll_runs.list(
-**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime. +**assignee_ids:** `typing.Optional[str]` — If provided, will only return tickets assigned to the assignee_ids; multiple assignee_ids can be separated by commas.
@@ -27578,7 +27363,7 @@ client.hris.payroll_runs.list(
-**cursor:** `typing.Optional[str]` — The pagination cursor value. +**collection_ids:** `typing.Optional[str]` — If provided, will only return tickets assigned to the collection_ids; multiple collection_ids can be separated by commas.
@@ -27586,7 +27371,7 @@ client.hris.payroll_runs.list(
-**ended_after:** `typing.Optional[dt.datetime]` — If provided, will only return payroll runs ended after this datetime. +**completed_after:** `typing.Optional[dt.datetime]` — If provided, will only return tickets completed after this datetime.
@@ -27594,7 +27379,7 @@ client.hris.payroll_runs.list(
-**ended_before:** `typing.Optional[dt.datetime]` — If provided, will only return payroll runs ended before this datetime. +**completed_before:** `typing.Optional[dt.datetime]` — If provided, will only return tickets completed before this datetime.
@@ -27602,7 +27387,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/). +**contact_id:** `typing.Optional[str]` — If provided, will only return tickets for this contact.
@@ -27610,7 +27395,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. +**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
@@ -27618,7 +27403,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). +**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
@@ -27626,7 +27411,7 @@ 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. +**creator_id:** `typing.Optional[str]` — If provided, will only return tickets created by this creator_id.
@@ -27634,7 +27419,7 @@ client.hris.payroll_runs.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.
@@ -27642,7 +27427,7 @@ client.hris.payroll_runs.list(
-**page_size:** `typing.Optional[int]` — Number of results to return per page. +**due_after:** `typing.Optional[dt.datetime]` — If provided, will only return tickets due after this datetime.
@@ -27650,7 +27435,7 @@ client.hris.payroll_runs.list(
-**remote_fields:** `typing.Optional[PayrollRunsListRequestRemoteFields]` — Deprecated. Use show_enum_origins. +**due_before:** `typing.Optional[dt.datetime]` — If provided, will only return tickets due before this datetime.
@@ -27658,7 +27443,7 @@ client.hris.payroll_runs.list(
-**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object. +**expand:** `typing.Optional[TicketsListRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -27666,15 +27451,7 @@ client.hris.payroll_runs.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 +**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/).
@@ -27682,7 +27459,7 @@ If provided, will only return PayrollRun's with this status. Options: ('REGULAR'
-**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) +**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -27690,7 +27467,7 @@ If provided, will only return PayrollRun's with this status. Options: ('REGULAR'
-**started_after:** `typing.Optional[dt.datetime]` — If provided, will only return payroll runs started after this datetime. +**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.
@@ -27698,7 +27475,7 @@ If provided, will only return PayrollRun's with this status. Options: ('REGULAR'
-**started_before:** `typing.Optional[dt.datetime]` — If provided, will only return payroll runs started before this datetime. +**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -27706,70 +27483,110 @@ If provided, will only return PayrollRun's with this status. Options: ('REGULAR'
-**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.
+ +
+
+ +**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned. +
+
+
+**name:** `typing.Optional[str]` — If provided, will only return tickets with this name. +
-
-
client.hris.payroll_runs.retrieve(...)
-#### 📝 Description +**page_size:** `typing.Optional[int]` — Number of results to return per page. + +
+
+**parent_ticket_id:** `typing.Optional[str]` — If provided, will only return sub tickets of the parent_ticket_id. + +
+
+
-Returns a `PayrollRun` object with the given `id`. +**priority:** `typing.Optional[TicketsListRequestPriority]` + +If provided, will only return tickets of this priority. + +* `URGENT` - URGENT +* `HIGH` - HIGH +* `NORMAL` - NORMAL +* `LOW` - LOW +
+ +
+
+ +**remote_created_after:** `typing.Optional[dt.datetime]` — If provided, will only return tickets created in the third party platform after this datetime. +
-#### 🔌 Usage -
+**remote_created_before:** `typing.Optional[dt.datetime]` — If provided, will only return tickets created in the third party platform before this datetime. + +
+
+
-```python -from merge import Merge +**remote_fields:** `typing.Optional[TicketsListRequestRemoteFields]` — Deprecated. Use show_enum_origins. + +
+
-client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.hris.payroll_runs.retrieve( - id="id", -) +
+
-``` +**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object. +
+ +
+
+ +**remote_updated_after:** `typing.Optional[dt.datetime]` — If provided, will only return tickets updated in the third party platform after this datetime. +
-#### ⚙️ Parameters -
+**remote_updated_before:** `typing.Optional[dt.datetime]` — If provided, will only return tickets updated in the third party platform before this datetime. + +
+
+
-**id:** `str` +**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)
@@ -27777,7 +27594,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. +**status:** `typing.Optional[str]` — If provided, will only return tickets of this status.
@@ -27785,7 +27602,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). +**tags:** `typing.Optional[str]` — If provided, will only return tickets matching the tags; multiple tags can be separated by commas.
@@ -27793,7 +27610,7 @@ client.hris.payroll_runs.retrieve(
-**remote_fields:** `typing.Optional[PayrollRunsRetrieveRequestRemoteFields]` — Deprecated. Use show_enum_origins. +**ticket_type:** `typing.Optional[str]` — If provided, will only return tickets of this type.
@@ -27801,7 +27618,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) +**ticket_url:** `typing.Optional[str]` — If provided, will only return tickets where the URL matches or contains the substring
@@ -27821,8 +27638,7 @@ client.hris.payroll_runs.retrieve(
-## Hris RegenerateKey -
client.hris.regenerate_key.create(...) +
client.ticketing.tickets.create(...)
@@ -27834,7 +27650,7 @@ client.hris.payroll_runs.retrieve(
-Exchange remote keys. +Creates a `Ticket` object with the given values.
@@ -27850,13 +27666,14 @@ Exchange remote keys. ```python from merge import Merge +from merge.resources.ticketing import TicketRequest client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.regenerate_key.create( - name="Remote Deployment Key 1", +client.ticketing.tickets.create( + model=TicketRequest(), ) ``` @@ -27873,7 +27690,23 @@ client.hris.regenerate_key.create(
-**name:** `str` — The name of the remote key +**model:** `TicketRequest` + +
+
+ +
+
+ +**is_debug_mode:** `typing.Optional[bool]` — Whether to include debug fields (such as log file links) in the response. + +
+
+ +
+
+ +**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously.
@@ -27893,8 +27726,7 @@ client.hris.regenerate_key.create(
-## Hris SyncStatus -
client.hris.sync_status.list(...) +
client.ticketing.tickets.retrieve(...)
@@ -27906,7 +27738,7 @@ client.hris.regenerate_key.create(
-Get sync status for the current sync and the most recently finished sync. `last_sync_start` represents the most recent time any sync began. `last_sync_finished` represents the most recent time any sync completed. These timestamps may correspond to different sync instances which may result in a sync start time being later than a separate sync completed time. To ensure you are retrieving the latest available data reference the `last_sync_finished` timestamp where `last_sync_result` is `DONE`. Possible values for `status` and `last_sync_result` are `DISABLED`, `DONE`, `FAILED`, `PARTIALLY_SYNCED`, `PAUSED`, `SYNCING`. Learn more about sync status in our [Help Center](https://help.merge.dev/en/articles/8184193-merge-sync-statuses). +Returns a `Ticket` object with the given `id`.
@@ -27927,8 +27759,8 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.sync_status.list( - cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +client.ticketing.tickets.retrieve( + id="id", ) ``` @@ -27937,15 +27769,55 @@ client.hris.sync_status.list(
-#### ⚙️ Parameters - +#### ⚙️ Parameters + +
+
+ +
+
+ +**id:** `str` + +
+
+ +
+
+ +**expand:** `typing.Optional[TicketsRetrieveRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. + +
+
+ +
+
+ +**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. + +
+
+ +
+
+ +**include_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format. + +
+
+
+**include_shell_data:** `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. +**remote_fields:** `typing.Optional[TicketsRetrieveRequestRemoteFields]` — Deprecated. Use show_enum_origins.
@@ -27953,7 +27825,7 @@ client.hris.sync_status.list(
-**page_size:** `typing.Optional[int]` — Number of results to return per page. +**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)
@@ -27973,8 +27845,7 @@ client.hris.sync_status.list(
-## Hris ForceResync -
client.hris.force_resync.sync_status_resync_create() +
client.ticketing.tickets.partial_update(...)
@@ -27986,7 +27857,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. +Updates a `Ticket` object with the given `id`.
@@ -28002,12 +27873,16 @@ Force re-sync of all models. This endpoint is available for monthly, quarterly, ```python from merge import Merge +from merge.resources.ticketing import PatchedTicketRequest client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.force_resync.sync_status_resync_create() +client.ticketing.tickets.partial_update( + id="id", + model=PatchedTicketRequest(), +) ``` @@ -28023,6 +27898,38 @@ client.hris.force_resync.sync_status_resync_create()
+**id:** `str` + +
+
+ +
+
+ +**model:** `PatchedTicketRequest` + +
+
+ +
+
+ +**is_debug_mode:** `typing.Optional[bool]` — Whether to include debug fields (such as log file links) in the response. + +
+
+ +
+
+ +**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously. + +
+
+ +
+
+ **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -28035,8 +27942,7 @@ client.hris.force_resync.sync_status_resync_create()
-## Hris Teams -
client.hris.teams.list(...) +
client.ticketing.tickets.viewers_list(...)
@@ -28048,7 +27954,7 @@ client.hris.force_resync.sync_status_resync_create()
-Returns a list of `Team` objects. +Returns a list of `Viewer` objects that point to a User id or Team id that is either an assignee or viewer on a `Ticket` with the given id. [Learn more.](https://help.merge.dev/en/articles/10333658-ticketing-access-control-list-acls)
@@ -28069,7 +27975,8 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.teams.list( +client.ticketing.tickets.viewers_list( + ticket_id="ticket_id", cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", ) @@ -28087,15 +27994,7 @@ client.hris.teams.list(
-**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime. - -
-
- -
-
- -**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime. +**ticket_id:** `str`
@@ -28111,7 +28010,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[TicketsViewersListRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -28143,7 +28042,7 @@ client.hris.teams.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.
@@ -28151,31 +28050,70 @@ client.hris.teams.list(
-**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned. +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+ +
+ + + + +
+
client.ticketing.tickets.meta_patch_retrieve(...)
-**page_size:** `typing.Optional[int]` — Number of results to return per page. - +#### 📝 Description + +
+
+ +
+
+ +Returns metadata for `Ticket` PATCHs. +
+
+#### 🔌 Usage +
-**parent_team_id:** `typing.Optional[str]` — If provided, will only return teams with this parent team. - +
+
+ +```python +from merge import Merge + +client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.ticketing.tickets.meta_patch_retrieve( + id="id", +) + +``` +
+
+#### ⚙️ Parameters +
-**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object. +
+
+ +**id:** `str`
@@ -28195,7 +28133,7 @@ client.hris.teams.list(
-
client.hris.teams.retrieve(...) +
client.ticketing.tickets.meta_post_retrieve(...)
@@ -28207,7 +28145,7 @@ client.hris.teams.list(
-Returns a `Team` object with the given `id`. +Returns metadata for `Ticket` POSTs.
@@ -28228,9 +28166,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.teams.retrieve( - id="id", -) +client.ticketing.tickets.meta_post_retrieve() ``` @@ -28246,23 +28182,7 @@ client.hris.teams.retrieve(
-**id:** `str` - -
-
- -
-
- -**expand:** `typing.Optional[typing.Literal["parent_team"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. - -
-
- -
-
- -**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. +**collection_id:** `typing.Optional[str]` — If provided, will only return tickets for this collection.
@@ -28270,7 +28190,7 @@ client.hris.teams.retrieve(
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). +**ticket_type:** `typing.Optional[str]` — If provided, will only return tickets for this ticket type.
@@ -28290,8 +28210,7 @@ client.hris.teams.retrieve(
-## Hris TimeOff -
client.hris.time_off.list(...) +
client.ticketing.tickets.remote_field_classes_list(...)
@@ -28303,7 +28222,7 @@ client.hris.teams.retrieve(
-Returns a list of `TimeOff` objects. +Returns a list of `RemoteFieldClass` objects.
@@ -28324,7 +28243,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.time_off.list( +client.ticketing.tickets.remote_field_classes_list( cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", ) @@ -28342,7 +28261,7 @@ client.hris.time_off.list(
-**approver_id:** `typing.Optional[str]` — If provided, will only return time off for this approver. +**cursor:** `typing.Optional[str]` — The pagination cursor value.
@@ -28350,7 +28269,7 @@ client.hris.time_off.list(
-**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime. +**ids:** `typing.Optional[str]` — If provided, will only return remote field classes with the `ids` in this list
@@ -28358,7 +28277,7 @@ client.hris.time_off.list(
-**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime. +**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
@@ -28366,7 +28285,7 @@ client.hris.time_off.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.
@@ -28374,7 +28293,7 @@ client.hris.time_off.list(
-**employee_id:** `typing.Optional[str]` — If provided, will only return time off for this employee. +**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -28382,7 +28301,7 @@ client.hris.time_off.list(
-**ended_after:** `typing.Optional[dt.datetime]` — If provided, will only return employees that ended after this datetime. +**is_common_model_field:** `typing.Optional[bool]` — If provided, will only return remote field classes with this is_common_model_field value
@@ -28390,7 +28309,7 @@ client.hris.time_off.list(
-**ended_before:** `typing.Optional[dt.datetime]` — If provided, will only return time-offs that ended before this datetime. +**is_custom:** `typing.Optional[bool]` — If provided, will only return remote fields classes with this is_custom value
@@ -28398,7 +28317,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. +**page_size:** `typing.Optional[int]` — Number of results to return per page.
@@ -28406,31 +28325,71 @@ 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/). +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+ +
+ + + + +
+## Ticketing Users +
client.ticketing.users.list(...)
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. - +#### 📝 Description + +
+
+ +
+
+ +Returns a list of `User` objects. +
+
+#### 🔌 Usage +
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). - +
+
+ +```python +from merge import Merge + +client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.ticketing.users.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) + +``` +
+
+#### ⚙️ Parameters +
-**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned. +
+
+ +**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
@@ -28438,7 +28397,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. +**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
@@ -28446,7 +28405,7 @@ client.hris.time_off.list(
-**page_size:** `typing.Optional[int]` — Number of results to return per page. +**cursor:** `typing.Optional[str]` — The pagination cursor value.
@@ -28454,7 +28413,7 @@ client.hris.time_off.list(
-**remote_fields:** `typing.Optional[TimeOffListRequestRemoteFields]` — Deprecated. Use show_enum_origins. +**email_address:** `typing.Optional[str]` — If provided, will only return users with emails equal to this value (case insensitive).
@@ -28462,7 +28421,7 @@ client.hris.time_off.list(
-**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object. +**expand:** `typing.Optional[UsersListRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -28470,16 +28429,23 @@ client.hris.time_off.list(
-**request_type:** `typing.Optional[TimeOffListRequestRequestType]` +**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/). + +
+
-If provided, will only return TimeOff with this request type. Options: ('VACATION', 'SICK', 'PERSONAL', 'JURY_DUTY', 'VOLUNTEER', 'BEREAVEMENT') +
+
-* `VACATION` - VACATION -* `SICK` - SICK -* `PERSONAL` - PERSONAL -* `JURY_DUTY` - JURY_DUTY -* `VOLUNTEER` - VOLUNTEER -* `BEREAVEMENT` - BEREAVEMENT +**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).
@@ -28487,7 +28453,7 @@ 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) +**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
@@ -28495,7 +28461,7 @@ If provided, will only return TimeOff with this request type. Options: ('VACATIO
-**started_after:** `typing.Optional[dt.datetime]` — If provided, will only return time-offs that started after this datetime. +**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
@@ -28503,7 +28469,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. +**page_size:** `typing.Optional[int]` — Number of results to return per page.
@@ -28511,15 +28477,15 @@ If provided, will only return TimeOff with this request type. Options: ('VACATIO
-**status:** `typing.Optional[TimeOffListRequestStatus]` +**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object. + +
+
-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 +**team:** `typing.Optional[str]` — If provided, will only return users matching in this team.
@@ -28539,7 +28505,7 @@ If provided, will only return TimeOff with this status. Options: ('REQUESTED', '
-
client.hris.time_off.create(...) +
client.ticketing.users.retrieve(...)
@@ -28551,7 +28517,7 @@ If provided, will only return TimeOff with this status. Options: ('REQUESTED', '
-Creates a `TimeOff` object with the given values. +Returns a `User` object with the given `id`.
@@ -28567,14 +28533,13 @@ Creates a `TimeOff` object with the given values. ```python from merge import Merge -from merge.resources.hris import TimeOffRequest client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.time_off.create( - model=TimeOffRequest(), +client.ticketing.users.retrieve( + id="id", ) ``` @@ -28591,7 +28556,7 @@ client.hris.time_off.create(
-**model:** `TimeOffRequest` +**id:** `str`
@@ -28599,7 +28564,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. +**expand:** `typing.Optional[UsersRetrieveRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -28607,7 +28572,15 @@ client.hris.time_off.create(
-**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously. +**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).
@@ -28627,7 +28600,8 @@ client.hris.time_off.create(
-
client.hris.time_off.retrieve(...) +## Ticketing WebhookReceivers +
client.ticketing.webhook_receivers.list()
@@ -28639,7 +28613,7 @@ client.hris.time_off.create(
-Returns a `TimeOff` object with the given `id`. +Returns a list of `WebhookReceiver` objects.
@@ -28660,9 +28634,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.time_off.retrieve( - id="id", -) +client.ticketing.webhook_receivers.list() ``` @@ -28678,31 +28650,71 @@ client.hris.time_off.retrieve(
-**id:** `str` +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+ +
+ + + + +
+
client.ticketing.webhook_receivers.create(...)
-**expand:** `typing.Optional[TimeOffRetrieveRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. - +#### 📝 Description + +
+
+ +
+
+ +Creates a `WebhookReceiver` object with the given values. +
+
+#### 🔌 Usage +
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. - +
+
+ +```python +from merge import Merge + +client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.ticketing.webhook_receivers.create( + event="event", + is_active=True, +) + +``` +
+
+#### ⚙️ 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). +
+
+ +**event:** `str`
@@ -28710,7 +28722,7 @@ client.hris.time_off.retrieve(
-**remote_fields:** `typing.Optional[TimeOffRetrieveRequestRemoteFields]` — Deprecated. Use show_enum_origins. +**is_active:** `bool`
@@ -28718,7 +28730,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) +**key:** `typing.Optional[str]`
@@ -28738,7 +28750,8 @@ client.hris.time_off.retrieve(
-
client.hris.time_off.meta_post_retrieve() +## Hris AccountDetails +
client.hris.account_details.retrieve()
@@ -28750,7 +28763,7 @@ client.hris.time_off.retrieve(
-Returns metadata for `TimeOff` POSTs. +Get details for a linked account.
@@ -28771,7 +28784,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.time_off.meta_post_retrieve() +client.hris.account_details.retrieve() ``` @@ -28799,8 +28812,8 @@ client.hris.time_off.meta_post_retrieve()
-## Hris TimeOffBalances -
client.hris.time_off_balances.list(...) +## Hris AccountToken +
client.hris.account_token.retrieve(...)
@@ -28812,7 +28825,7 @@ client.hris.time_off.meta_post_retrieve()
-Returns a list of `TimeOffBalance` objects. +Returns the account token for the end user with the provided public token.
@@ -28833,8 +28846,8 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.time_off_balances.list( - cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +client.hris.account_token.retrieve( + public_token="public_token", ) ``` @@ -28851,15 +28864,7 @@ client.hris.time_off_balances.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. +**public_token:** `str`
@@ -28867,112 +28872,75 @@ client.hris.time_off_balances.list(
-**cursor:** `typing.Optional[str]` — The pagination cursor value. +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
- -
-
- -**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. -
+
+## Hris AsyncPassthrough +
client.hris.async_passthrough.create(...)
-**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/). - -
-
+#### 📝 Description
-**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). - +Asynchronously pull data from an endpoint not currently supported by Merge.
- -
-
- -**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. - -
-
+#### 🔌 Usage
-**page_size:** `typing.Optional[int]` — Number of results to return per page. - -
-
-
-**policy_type:** `typing.Optional[TimeOffBalancesListRequestPolicyType]` +```python +from merge import Merge +from merge.resources.hris import DataPassthroughRequest, MethodEnum -If provided, will only return TimeOffBalance with this policy type. Options: ('VACATION', 'SICK', 'PERSONAL', 'JURY_DUTY', 'VOLUNTEER', 'BEREAVEMENT') +client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.hris.async_passthrough.create( + request=DataPassthroughRequest( + method=MethodEnum.GET, + path="/scooters", + ), +) -* `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. -
+#### ⚙️ 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) +**request:** `DataPassthroughRequest`
@@ -28992,7 +28960,7 @@ If provided, will only return TimeOffBalance with this policy type. Options: ('V
-
client.hris.time_off_balances.retrieve(...) +
client.hris.async_passthrough.retrieve(...)
@@ -29004,7 +28972,7 @@ If provided, will only return TimeOffBalance with this policy type. Options: ('V
-Returns a `TimeOffBalance` object with the given `id`. +Retrieves data from earlier async-passthrough POST request
@@ -29025,65 +28993,25 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.time_off_balances.retrieve( - id="id", +client.hris.async_passthrough.retrieve( + async_passthrough_receipt_id="async_passthrough_receipt_id", ) -``` - -
- - - -#### ⚙️ Parameters - -
-
- -
-
- -**id:** `str` - -
-
- -
-
- -**expand:** `typing.Optional[typing.Literal["employee"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. - +```
- -
-
- -**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. -
-
-
- -**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). - -
-
+#### ⚙️ Parameters
-**remote_fields:** `typing.Optional[typing.Literal["policy_type"]]` — Deprecated. Use show_enum_origins. - -
-
-
-**show_enum_origins:** `typing.Optional[typing.Literal["policy_type"]]` — A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter) +**async_passthrough_receipt_id:** `str`
@@ -29103,8 +29031,8 @@ client.hris.time_off_balances.retrieve(
-## Hris TimesheetEntries -
client.hris.timesheet_entries.list(...) +## Hris AuditTrail +
client.hris.audit_trail.list(...)
@@ -29116,7 +29044,7 @@ client.hris.time_off_balances.retrieve(
-Returns a list of `TimesheetEntry` objects. +Gets a list of audit trail events.
@@ -29137,7 +29065,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.timesheet_entries.list( +client.hris.audit_trail.list( cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", ) @@ -29155,7 +29083,7 @@ client.hris.timesheet_entries.list(
-**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime. +**cursor:** `typing.Optional[str]` — The pagination cursor value.
@@ -29163,7 +29091,7 @@ client.hris.timesheet_entries.list(
-**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime. +**end_date:** `typing.Optional[str]` — If included, will only include audit trail events that occurred before this time
@@ -29171,7 +29099,7 @@ client.hris.timesheet_entries.list(
-**cursor:** `typing.Optional[str]` — The pagination cursor value. +**event_type:** `typing.Optional[str]` — If included, will only include events with the given event type. Possible values include: `CREATED_REMOTE_PRODUCTION_API_KEY`, `DELETED_REMOTE_PRODUCTION_API_KEY`, `CREATED_TEST_API_KEY`, `DELETED_TEST_API_KEY`, `REGENERATED_PRODUCTION_API_KEY`, `REGENERATED_WEBHOOK_SIGNATURE`, `INVITED_USER`, `TWO_FACTOR_AUTH_ENABLED`, `TWO_FACTOR_AUTH_DISABLED`, `DELETED_LINKED_ACCOUNT`, `DELETED_ALL_COMMON_MODELS_FOR_LINKED_ACCOUNT`, `CREATED_DESTINATION`, `DELETED_DESTINATION`, `CHANGED_DESTINATION`, `CHANGED_SCOPES`, `CHANGED_PERSONAL_INFORMATION`, `CHANGED_ORGANIZATION_SETTINGS`, `ENABLED_INTEGRATION`, `DISABLED_INTEGRATION`, `ENABLED_CATEGORY`, `DISABLED_CATEGORY`, `CHANGED_PASSWORD`, `RESET_PASSWORD`, `ENABLED_REDACT_UNMAPPED_DATA_FOR_ORGANIZATION`, `ENABLED_REDACT_UNMAPPED_DATA_FOR_LINKED_ACCOUNT`, `DISABLED_REDACT_UNMAPPED_DATA_FOR_ORGANIZATION`, `DISABLED_REDACT_UNMAPPED_DATA_FOR_LINKED_ACCOUNT`, `CREATED_INTEGRATION_WIDE_FIELD_MAPPING`, `CREATED_LINKED_ACCOUNT_FIELD_MAPPING`, `CHANGED_INTEGRATION_WIDE_FIELD_MAPPING`, `CHANGED_LINKED_ACCOUNT_FIELD_MAPPING`, `DELETED_INTEGRATION_WIDE_FIELD_MAPPING`, `DELETED_LINKED_ACCOUNT_FIELD_MAPPING`, `CREATED_LINKED_ACCOUNT_COMMON_MODEL_OVERRIDE`, `CHANGED_LINKED_ACCOUNT_COMMON_MODEL_OVERRIDE`, `DELETED_LINKED_ACCOUNT_COMMON_MODEL_OVERRIDE`, `FORCED_LINKED_ACCOUNT_RESYNC`, `MUTED_ISSUE`, `GENERATED_MAGIC_LINK`, `ENABLED_MERGE_WEBHOOK`, `DISABLED_MERGE_WEBHOOK`, `MERGE_WEBHOOK_TARGET_CHANGED`, `END_USER_CREDENTIALS_ACCESSED`
@@ -29179,7 +29107,7 @@ client.hris.timesheet_entries.list(
-**employee_id:** `typing.Optional[str]` — If provided, will only return timesheet entries for this employee. +**page_size:** `typing.Optional[int]` — Number of results to return per page.
@@ -29187,7 +29115,7 @@ client.hris.timesheet_entries.list(
-**ended_after:** `typing.Optional[dt.datetime]` — If provided, will only return timesheet entries ended after this datetime. +**start_date:** `typing.Optional[str]` — If included, will only include audit trail events that occurred after this time
@@ -29195,7 +29123,7 @@ client.hris.timesheet_entries.list(
-**ended_before:** `typing.Optional[dt.datetime]` — If provided, will only return timesheet entries ended before this datetime. +**user_email:** `typing.Optional[str]` — If provided, this will return events associated with the specified user email. Please note that the email address reflects the user's email at the time of the event, and may not be their current email.
@@ -29203,91 +29131,65 @@ client.hris.timesheet_entries.list(
-**expand:** `typing.Optional[typing.Literal["employee"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
- -
-
- -**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/). -
-
-
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. -
+
+## Hris AvailableActions +
client.hris.available_actions.retrieve()
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). - -
-
+#### 📝 Description
-**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned. - -
-
-
-**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned. - +Returns a list of models and actions available for an account.
- -
-
- -**order_by:** `typing.Optional[TimesheetEntriesListRequestOrderBy]` — Overrides the default ordering for this endpoint. Possible values include: start_time, -start_time. -
+#### 🔌 Usage +
-**page_size:** `typing.Optional[int]` — Number of results to return per page. - -
-
-
-**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object. - -
-
+```python +from merge import Merge -
-
+client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.hris.available_actions.retrieve() -**started_after:** `typing.Optional[dt.datetime]` — If provided, will only return timesheet entries started after this datetime. - +``` +
+
+#### ⚙️ Parameters +
-**started_before:** `typing.Optional[dt.datetime]` — If provided, will only return timesheet entries started before this datetime. - -
-
-
@@ -29303,7 +29205,8 @@ client.hris.timesheet_entries.list(
-
client.hris.timesheet_entries.create(...) +## Hris BankInfo +
client.hris.bank_info.list(...)
@@ -29315,7 +29218,7 @@ client.hris.timesheet_entries.list(
-Creates a `TimesheetEntry` object with the given values. +Returns a list of `BankInfo` objects.
@@ -29331,14 +29234,13 @@ Creates a `TimesheetEntry` object with the given values. ```python from merge import Merge -from merge.resources.hris import TimesheetEntryRequest client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.timesheet_entries.create( - model=TimesheetEntryRequest(), +client.hris.bank_info.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", ) ``` @@ -29355,7 +29257,12 @@ client.hris.timesheet_entries.create(
-**model:** `TimesheetEntryRequest` +**account_type:** `typing.Optional[BankInfoListRequestAccountType]` + +If provided, will only return BankInfo's with this account type. Options: ('SAVINGS', 'CHECKING') + +* `SAVINGS` - SAVINGS +* `CHECKING` - CHECKING
@@ -29363,7 +29270,7 @@ client.hris.timesheet_entries.create(
-**is_debug_mode:** `typing.Optional[bool]` — Whether to include debug fields (such as log file links) in the response. +**bank_name:** `typing.Optional[str]` — If provided, will only return BankInfo's with this bank name.
@@ -29371,7 +29278,7 @@ client.hris.timesheet_entries.create(
-**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously. +**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
@@ -29379,70 +29286,87 @@ client.hris.timesheet_entries.create(
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. +**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
- -
+
+
+**cursor:** `typing.Optional[str]` — The pagination cursor value. +
-
-
client.hris.timesheet_entries.retrieve(...)
-#### 📝 Description +**employee_id:** `typing.Optional[str]` — If provided, will only return bank accounts for this employee. + +
+
+**expand:** `typing.Optional[typing.Literal["employee"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. + +
+
+
-Returns a `TimesheetEntry` object with the given `id`. -
-
+**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/). + -#### 🔌 Usage -
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. + +
+
+
-```python -from merge import Merge +**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). + +
+
-client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.hris.timesheet_entries.retrieve( - id="id", -) +
+
-``` +**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned. +
+ +
+
+ +**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned. +
-#### ⚙️ Parameters -
+**order_by:** `typing.Optional[BankInfoListRequestOrderBy]` — Overrides the default ordering for this endpoint. Possible values include: remote_created_at, -remote_created_at. + +
+
+
-**id:** `str` +**page_size:** `typing.Optional[int]` — Number of results to return per page.
@@ -29450,7 +29374,7 @@ client.hris.timesheet_entries.retrieve(
-**expand:** `typing.Optional[typing.Literal["employee"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. +**remote_fields:** `typing.Optional[typing.Literal["account_type"]]` — Deprecated. Use show_enum_origins.
@@ -29458,7 +29382,7 @@ client.hris.timesheet_entries.retrieve(
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. +**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
@@ -29466,7 +29390,7 @@ client.hris.timesheet_entries.retrieve(
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). +**show_enum_origins:** `typing.Optional[typing.Literal["account_type"]]` — A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter)
@@ -29486,7 +29410,7 @@ client.hris.timesheet_entries.retrieve(
-
client.hris.timesheet_entries.meta_post_retrieve() +
client.hris.bank_info.retrieve(...)
@@ -29498,7 +29422,7 @@ client.hris.timesheet_entries.retrieve(
-Returns metadata for `TimesheetEntry` POSTs. +Returns a `BankInfo` object with the given `id`.
@@ -29519,7 +29443,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.timesheet_entries.meta_post_retrieve() +client.hris.bank_info.retrieve( + id="id", +) ``` @@ -29535,65 +29461,51 @@ client.hris.timesheet_entries.meta_post_retrieve()
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. +**id:** `str`
- -
+
+
+**expand:** `typing.Optional[typing.Literal["employee"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. +
-
-## Hris WebhookReceivers -
client.hris.webhook_receivers.list()
-#### 📝 Description - -
-
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. + +
+
-Returns a list of `WebhookReceiver` objects. -
-
+**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). +
-#### 🔌 Usage -
-
-
- -```python -from merge import Merge - -client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.hris.webhook_receivers.list() - -``` -
-
+**remote_fields:** `typing.Optional[typing.Literal["account_type"]]` — Deprecated. Use show_enum_origins. +
-
- -#### ⚙️ Parameters +
+**show_enum_origins:** `typing.Optional[typing.Literal["account_type"]]` — A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter) + +
+
+
@@ -29609,7 +29521,8 @@ client.hris.webhook_receivers.list()
-
client.hris.webhook_receivers.create(...) +## Hris Benefits +
client.hris.benefits.list(...)
@@ -29621,7 +29534,7 @@ client.hris.webhook_receivers.list()
-Creates a `WebhookReceiver` object with the given values. +Returns a list of `Benefit` objects.
@@ -29642,9 +29555,8 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.webhook_receivers.create( - event="event", - is_active=True, +client.hris.benefits.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", ) ``` @@ -29661,7 +29573,7 @@ client.hris.webhook_receivers.create(
-**event:** `str` +**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
@@ -29669,7 +29581,7 @@ client.hris.webhook_receivers.create(
-**is_active:** `bool` +**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
@@ -29677,7 +29589,7 @@ client.hris.webhook_receivers.create(
-**key:** `typing.Optional[str]` +**cursor:** `typing.Optional[str]` — The pagination cursor value.
@@ -29685,65 +29597,75 @@ client.hris.webhook_receivers.create(
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. +**employee_id:** `typing.Optional[str]` — If provided, will return the benefits associated with the employee.
- -
+
+
+**expand:** `typing.Optional[typing.Literal["employee"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. +
-
-## Ticketing AccountDetails -
client.ticketing.account_details.retrieve()
-#### 📝 Description +**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/). + +
+
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. + +
+
+
-Get details for a linked account. -
-
+**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). + -#### 🔌 Usage -
+**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned. + +
+
+
-```python -from merge import Merge - -client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.ticketing.account_details.retrieve() - -``` +**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned. +
+ +
+
+ +**page_size:** `typing.Optional[int]` — Number of results to return per page. +
-#### ⚙️ Parameters -
+**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object. + +
+
+
@@ -29759,8 +29681,7 @@ client.ticketing.account_details.retrieve()
-## Ticketing AccountToken -
client.ticketing.account_token.retrieve(...) +
client.hris.benefits.retrieve(...)
@@ -29772,7 +29693,7 @@ client.ticketing.account_details.retrieve()
-Returns the account token for the end user with the provided public token. +Returns a `Benefit` object with the given `id`.
@@ -29793,8 +29714,8 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.account_token.retrieve( - public_token="public_token", +client.hris.benefits.retrieve( + id="id", ) ``` @@ -29811,7 +29732,31 @@ client.ticketing.account_token.retrieve(
-**public_token:** `str` +**id:** `str` + +
+
+ +
+
+ +**expand:** `typing.Optional[typing.Literal["employee"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. + +
+
+ +
+
+ +**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. + +
+
+ +
+
+ +**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -29831,8 +29776,8 @@ client.ticketing.account_token.retrieve(
-## Ticketing Accounts -
client.ticketing.accounts.list(...) +## Hris Companies +
client.hris.companies.list(...)
@@ -29844,7 +29789,7 @@ client.ticketing.account_token.retrieve(
-Returns a list of `Account` objects. +Returns a list of `Company` objects.
@@ -29865,7 +29810,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.accounts.list( +client.hris.companies.list( cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", ) @@ -29975,7 +29920,7 @@ client.ticketing.accounts.list(
-
client.ticketing.accounts.retrieve(...) +
client.hris.companies.retrieve(...)
@@ -29987,7 +29932,7 @@ client.ticketing.accounts.list(
-Returns an `Account` object with the given `id`. +Returns a `Company` object with the given `id`.
@@ -30008,7 +29953,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.accounts.retrieve( +client.hris.companies.retrieve( id="id", ) @@ -30062,8 +30007,8 @@ client.ticketing.accounts.retrieve(
-## Ticketing AsyncPassthrough -
client.ticketing.async_passthrough.create(...) +## Hris Scopes +
client.hris.scopes.default_scopes_retrieve()
@@ -30075,7 +30020,129 @@ client.ticketing.accounts.retrieve(
-Asynchronously pull data from an endpoint not currently supported by Merge. +Get the default permissions for Merge Common Models and fields across all Linked Accounts of a given category. [Learn more](https://help.merge.dev/en/articles/5950052-common-model-and-field-scopes). +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from merge import Merge + +client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.hris.scopes.default_scopes_retrieve() + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + + + +
+ +
client.hris.scopes.linked_account_scopes_retrieve() +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Get all available permissions for Merge Common Models and fields for a single Linked Account. [Learn more](https://help.merge.dev/en/articles/5950052-common-model-and-field-scopes). +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from merge import Merge + +client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.hris.scopes.linked_account_scopes_retrieve() + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +
client.hris.scopes.linked_account_scopes_create(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Update permissions for any Common Model or field for a single Linked Account. Any Scopes not set in this POST request will inherit the default Scopes. [Learn more](https://help.merge.dev/en/articles/5950052-common-model-and-field-scopes)
@@ -30091,17 +30158,42 @@ Asynchronously pull data from an endpoint not currently supported by Merge. ```python from merge import Merge -from merge.resources.ticketing import DataPassthroughRequest, MethodEnum +from merge.resources.hris import ( + FieldPermissionDeserializerRequest, + IndividualCommonModelScopeDeserializerRequest, + ModelPermissionDeserializerRequest, +) client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.async_passthrough.create( - request=DataPassthroughRequest( - method=MethodEnum.GET, - path="/scooters", - ), +client.hris.scopes.linked_account_scopes_create( + common_models=[ + IndividualCommonModelScopeDeserializerRequest( + model_name="Employee", + model_permissions={ + "READ": ModelPermissionDeserializerRequest( + is_enabled=True, + ), + "WRITE": ModelPermissionDeserializerRequest( + is_enabled=False, + ), + }, + field_permissions=FieldPermissionDeserializerRequest( + enabled_fields=["avatar", "home_location"], + disabled_fields=["work_location"], + ), + ), + IndividualCommonModelScopeDeserializerRequest( + model_name="Benefit", + model_permissions={ + "WRITE": ModelPermissionDeserializerRequest( + is_enabled=False, + ) + }, + ), + ], ) ``` @@ -30118,7 +30210,7 @@ client.ticketing.async_passthrough.create(
-**request:** `DataPassthroughRequest` +**common_models:** `typing.Sequence[IndividualCommonModelScopeDeserializerRequest]` — The common models you want to update the scopes for
@@ -30138,7 +30230,8 @@ client.ticketing.async_passthrough.create(
-
client.ticketing.async_passthrough.retrieve(...) +## Hris DeleteAccount +
client.hris.delete_account.delete()
@@ -30150,7 +30243,7 @@ client.ticketing.async_passthrough.create(
-Retrieves data from earlier async-passthrough POST request +Delete a linked account.
@@ -30171,9 +30264,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.async_passthrough.retrieve( - async_passthrough_receipt_id="async_passthrough_receipt_id", -) +client.hris.delete_account.delete() ``` @@ -30189,14 +30280,6 @@ client.ticketing.async_passthrough.retrieve(
-**async_passthrough_receipt_id:** `str` - -
-
- -
-
- **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -30209,8 +30292,8 @@ client.ticketing.async_passthrough.retrieve(
-## Ticketing Attachments -
client.ticketing.attachments.list(...) +## Hris Dependents +
client.hris.dependents.list(...)
@@ -30222,7 +30305,7 @@ client.ticketing.async_passthrough.retrieve(
-Returns a list of `Attachment` objects. +Returns a list of `Dependent` objects.
@@ -30243,7 +30326,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.attachments.list( +client.hris.dependents.list( cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", ) @@ -30285,7 +30368,7 @@ client.ticketing.attachments.list(
-**expand:** `typing.Optional[typing.Literal["ticket"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. +**employee_id:** `typing.Optional[str]` — If provided, will only return dependents for this employee.
@@ -30309,7 +30392,7 @@ client.ticketing.attachments.list(
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). +**include_sensitive_fields:** `typing.Optional[bool]` — Whether to include sensitive fields (such as social security numbers) in the response.
@@ -30317,7 +30400,7 @@ client.ticketing.attachments.list(
-**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned. +**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -30325,7 +30408,7 @@ client.ticketing.attachments.list(
-**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned. +**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
@@ -30333,7 +30416,7 @@ client.ticketing.attachments.list(
-**page_size:** `typing.Optional[int]` — Number of results to return per page. +**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
@@ -30341,7 +30424,7 @@ client.ticketing.attachments.list(
-**remote_created_after:** `typing.Optional[dt.datetime]` — If provided, will only return attachments created in the third party platform after this datetime. +**page_size:** `typing.Optional[int]` — Number of results to return per page.
@@ -30357,14 +30440,6 @@ client.ticketing.attachments.list(
-**ticket_id:** `typing.Optional[str]` — If provided, will only return comments for this ticket. - -
-
- -
-
- **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -30377,7 +30452,7 @@ client.ticketing.attachments.list(
-
client.ticketing.attachments.create(...) +
client.hris.dependents.retrieve(...)
@@ -30389,7 +30464,7 @@ client.ticketing.attachments.list(
-Creates an `Attachment` object with the given values. +Returns a `Dependent` object with the given `id`.
@@ -30405,14 +30480,13 @@ Creates an `Attachment` object with the given values. ```python from merge import Merge -from merge.resources.ticketing import AttachmentRequest client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.attachments.create( - model=AttachmentRequest(), +client.hris.dependents.retrieve( + id="id", ) ``` @@ -30429,7 +30503,7 @@ client.ticketing.attachments.create(
-**model:** `AttachmentRequest` +**id:** `str`
@@ -30437,7 +30511,7 @@ client.ticketing.attachments.create(
-**is_debug_mode:** `typing.Optional[bool]` — Whether to include debug fields (such as log file links) in the response. +**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -30445,7 +30519,15 @@ client.ticketing.attachments.create(
-**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously. +**include_sensitive_fields:** `typing.Optional[bool]` — Whether to include sensitive fields (such as social security numbers) in the response. + +
+
+ +
+
+ +**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -30465,7 +30547,8 @@ client.ticketing.attachments.create(
-
client.ticketing.attachments.retrieve(...) +## Hris EmployeePayrollRuns +
client.hris.employee_payroll_runs.list(...)
@@ -30477,7 +30560,7 @@ client.ticketing.attachments.create(
-Returns an `Attachment` object with the given `id`. +Returns a list of `EmployeePayrollRun` objects.
@@ -30498,8 +30581,8 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.attachments.retrieve( - id="id", +client.hris.employee_payroll_runs.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", ) ``` @@ -30516,7 +30599,7 @@ client.ticketing.attachments.retrieve(
-**id:** `str` +**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
@@ -30524,7 +30607,7 @@ client.ticketing.attachments.retrieve(
-**expand:** `typing.Optional[typing.Literal["ticket"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. +**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
@@ -30532,7 +30615,7 @@ client.ticketing.attachments.retrieve(
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. +**cursor:** `typing.Optional[str]` — The pagination cursor value.
@@ -30540,7 +30623,7 @@ client.ticketing.attachments.retrieve(
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). +**employee_id:** `typing.Optional[str]` — If provided, will only return employee payroll runs for this employee.
@@ -30548,132 +30631,63 @@ client.ticketing.attachments.retrieve(
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. +**ended_after:** `typing.Optional[dt.datetime]` — If provided, will only return employee payroll runs ended after this datetime.
- -
- - - - -
- -
client.ticketing.attachments.meta_post_retrieve() -
-
- -#### 📝 Description - -
-
-Returns metadata for `TicketingAttachment` POSTs. -
-
+**ended_before:** `typing.Optional[dt.datetime]` — If provided, will only return employee payroll runs ended before this datetime. +
-#### 🔌 Usage - -
-
-
-```python -from merge import Merge - -client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.ticketing.attachments.meta_post_retrieve() - -``` -
-
+**expand:** `typing.Optional[EmployeePayrollRunsListRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. +
-#### ⚙️ Parameters -
-
-
- -**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. +**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
-
-
- - -
-
-
-## Ticketing AuditTrail -
client.ticketing.audit_trail.list(...)
-#### 📝 Description - -
-
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. + +
+
-Gets a list of audit trail events. -
-
+**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). +
-#### 🔌 Usage - -
-
-
-```python -from merge import Merge - -client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.ticketing.audit_trail.list( - cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", -) - -``` -
-
+**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned. +
-#### ⚙️ Parameters - -
-
-
-**cursor:** `typing.Optional[str]` — The pagination cursor value. +**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
@@ -30681,7 +30695,7 @@ client.ticketing.audit_trail.list(
-**end_date:** `typing.Optional[str]` — If included, will only include audit trail events that occurred before this time +**page_size:** `typing.Optional[int]` — Number of results to return per page.
@@ -30689,7 +30703,7 @@ client.ticketing.audit_trail.list(
-**event_type:** `typing.Optional[str]` — If included, will only include events with the given event type. Possible values include: `CREATED_REMOTE_PRODUCTION_API_KEY`, `DELETED_REMOTE_PRODUCTION_API_KEY`, `CREATED_TEST_API_KEY`, `DELETED_TEST_API_KEY`, `REGENERATED_PRODUCTION_API_KEY`, `REGENERATED_WEBHOOK_SIGNATURE`, `INVITED_USER`, `TWO_FACTOR_AUTH_ENABLED`, `TWO_FACTOR_AUTH_DISABLED`, `DELETED_LINKED_ACCOUNT`, `DELETED_ALL_COMMON_MODELS_FOR_LINKED_ACCOUNT`, `CREATED_DESTINATION`, `DELETED_DESTINATION`, `CHANGED_DESTINATION`, `CHANGED_SCOPES`, `CHANGED_PERSONAL_INFORMATION`, `CHANGED_ORGANIZATION_SETTINGS`, `ENABLED_INTEGRATION`, `DISABLED_INTEGRATION`, `ENABLED_CATEGORY`, `DISABLED_CATEGORY`, `CHANGED_PASSWORD`, `RESET_PASSWORD`, `ENABLED_REDACT_UNMAPPED_DATA_FOR_ORGANIZATION`, `ENABLED_REDACT_UNMAPPED_DATA_FOR_LINKED_ACCOUNT`, `DISABLED_REDACT_UNMAPPED_DATA_FOR_ORGANIZATION`, `DISABLED_REDACT_UNMAPPED_DATA_FOR_LINKED_ACCOUNT`, `CREATED_INTEGRATION_WIDE_FIELD_MAPPING`, `CREATED_LINKED_ACCOUNT_FIELD_MAPPING`, `CHANGED_INTEGRATION_WIDE_FIELD_MAPPING`, `CHANGED_LINKED_ACCOUNT_FIELD_MAPPING`, `DELETED_INTEGRATION_WIDE_FIELD_MAPPING`, `DELETED_LINKED_ACCOUNT_FIELD_MAPPING`, `CREATED_LINKED_ACCOUNT_COMMON_MODEL_OVERRIDE`, `CHANGED_LINKED_ACCOUNT_COMMON_MODEL_OVERRIDE`, `DELETED_LINKED_ACCOUNT_COMMON_MODEL_OVERRIDE`, `FORCED_LINKED_ACCOUNT_RESYNC`, `MUTED_ISSUE`, `GENERATED_MAGIC_LINK`, `ENABLED_MERGE_WEBHOOK`, `DISABLED_MERGE_WEBHOOK`, `MERGE_WEBHOOK_TARGET_CHANGED`, `END_USER_CREDENTIALS_ACCESSED` +**payroll_run_id:** `typing.Optional[str]` — If provided, will only return employee payroll runs for this employee.
@@ -30697,7 +30711,7 @@ client.ticketing.audit_trail.list(
-**page_size:** `typing.Optional[int]` — Number of results to return per page. +**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
@@ -30705,7 +30719,7 @@ client.ticketing.audit_trail.list(
-**start_date:** `typing.Optional[str]` — If included, will only include audit trail events that occurred after this time +**started_after:** `typing.Optional[dt.datetime]` — If provided, will only return employee payroll runs started after this datetime.
@@ -30713,7 +30727,7 @@ client.ticketing.audit_trail.list(
-**user_email:** `typing.Optional[str]` — If provided, this will return events associated with the specified user email. Please note that the email address reflects the user's email at the time of the event, and may not be their current email. +**started_before:** `typing.Optional[dt.datetime]` — If provided, will only return employee payroll runs started before this datetime.
@@ -30733,8 +30747,7 @@ client.ticketing.audit_trail.list(
-## Ticketing AvailableActions -
client.ticketing.available_actions.retrieve() +
client.hris.employee_payroll_runs.retrieve(...)
@@ -30746,7 +30759,7 @@ client.ticketing.audit_trail.list(
-Returns a list of models and actions available for an account. +Returns an `EmployeePayrollRun` object with the given `id`.
@@ -30767,19 +30780,53 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.available_actions.retrieve() +client.hris.employee_payroll_runs.retrieve( + id="id", +) + +``` + +
+ + + +#### ⚙️ Parameters + +
+
+ +
+
-``` +**id:** `str` +
+ +
+
+ +**expand:** `typing.Optional[EmployeePayrollRunsRetrieveRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. +
-#### ⚙️ Parameters +
+
+ +**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. + +
+
+**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). + +
+
+
@@ -30795,8 +30842,8 @@ client.ticketing.available_actions.retrieve()
-## Ticketing Collections -
client.ticketing.collections.list(...) +## Hris Employees +
client.hris.employees.list(...)
@@ -30808,7 +30855,7 @@ client.ticketing.available_actions.retrieve()
-Returns a list of `Collection` objects. +Returns a list of `Employee` objects.
@@ -30829,7 +30876,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.collections.list( +client.hris.employees.list( cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", ) @@ -30847,7 +30894,7 @@ client.ticketing.collections.list(
-**collection_type:** `typing.Optional[str]` — If provided, will only return collections of the given type. +**company_id:** `typing.Optional[str]` — If provided, will only return employees for this company.
@@ -30879,7 +30926,7 @@ client.ticketing.collections.list(
-**expand:** `typing.Optional[typing.Literal["parent_collection"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. +**display_full_name:** `typing.Optional[str]` — If provided, will only return employees with this display name.
@@ -30887,7 +30934,7 @@ client.ticketing.collections.list(
-**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/). +**employee_number:** `typing.Optional[str]` — If provided, will only return employees with this employee number.
@@ -30895,7 +30942,13 @@ client.ticketing.collections.list(
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. +**employment_status:** `typing.Optional[EmployeesListRequestEmploymentStatus]` + +If provided, will only return employees with this employment status. + +* `ACTIVE` - ACTIVE +* `PENDING` - PENDING +* `INACTIVE` - INACTIVE
@@ -30903,7 +30956,7 @@ client.ticketing.collections.list(
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). +**employment_type:** `typing.Optional[str]` — If provided, will only return employees that have an employment of the specified employment_type.
@@ -30911,7 +30964,7 @@ client.ticketing.collections.list(
-**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned. +**expand:** `typing.Optional[EmployeesListRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -30919,7 +30972,7 @@ client.ticketing.collections.list(
-**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned. +**first_name:** `typing.Optional[str]` — If provided, will only return employees with this first name.
@@ -30927,7 +30980,7 @@ client.ticketing.collections.list(
-**page_size:** `typing.Optional[int]` — Number of results to return per page. +**groups:** `typing.Optional[str]` — If provided, will only return employees matching the group ids; multiple groups can be separated by commas.
@@ -30935,7 +30988,7 @@ client.ticketing.collections.list(
-**parent_collection_id:** `typing.Optional[str]` — If provided, will only return collections whose parent collection matches the given id. +**home_location_id:** `typing.Optional[str]` — If provided, will only return employees for this home location.
@@ -30943,7 +30996,7 @@ client.ticketing.collections.list(
-**remote_fields:** `typing.Optional[typing.Literal["collection_type"]]` — Deprecated. Use show_enum_origins. +**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
@@ -30951,7 +31004,7 @@ client.ticketing.collections.list(
-**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object. +**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -30959,7 +31012,7 @@ client.ticketing.collections.list(
-**show_enum_origins:** `typing.Optional[typing.Literal["collection_type"]]` — A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter) +**include_sensitive_fields:** `typing.Optional[bool]` — Whether to include sensitive fields (such as social security numbers) in the response.
@@ -30967,71 +31020,103 @@ client.ticketing.collections.list(
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. +**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
+ +
+
+ +**job_title:** `typing.Optional[str]` — If provided, will only return employees that have an employment of the specified job_title. +
+
+
+**last_name:** `typing.Optional[str]` — If provided, will only return employees with this last name. +
-
-
client.ticketing.collections.viewers_list(...)
-#### 📝 Description +**manager_id:** `typing.Optional[str]` — If provided, will only return employees for this manager. + +
+
+**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned. + +
+
+
-Returns a list of `Viewer` objects that point to a User id or Team id that is either an assignee or viewer on a `Collection` with the given id. [Learn more.](https://help.merge.dev/en/articles/10333658-ticketing-access-control-list-acls) +**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned. +
+ +
+
+ +**page_size:** `typing.Optional[int]` — Number of results to return per page. +
-#### 🔌 Usage -
+**pay_group_id:** `typing.Optional[str]` — If provided, will only return employees for this pay group + +
+
+
-```python -from merge import Merge +**personal_email:** `typing.Optional[str]` — If provided, will only return Employees with this personal email + +
+
-client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.ticketing.collections.viewers_list( - collection_id="collection_id", - cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", -) +
+
-``` +**remote_fields:** `typing.Optional[EmployeesListRequestRemoteFields]` — Deprecated. Use show_enum_origins. +
+ +
+
+ +**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object. +
-#### ⚙️ Parameters -
+**show_enum_origins:** `typing.Optional[EmployeesListRequestShowEnumOrigins]` — A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter) + +
+
+
-**collection_id:** `str` +**started_after:** `typing.Optional[dt.datetime]` — If provided, will only return employees that started after this datetime.
@@ -31039,7 +31124,7 @@ client.ticketing.collections.viewers_list(
-**cursor:** `typing.Optional[str]` — The pagination cursor value. +**started_before:** `typing.Optional[dt.datetime]` — If provided, will only return employees that started before this datetime.
@@ -31047,7 +31132,7 @@ client.ticketing.collections.viewers_list(
-**expand:** `typing.Optional[CollectionsViewersListRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. +**team_id:** `typing.Optional[str]` — If provided, will only return employees for this team.
@@ -31055,7 +31140,7 @@ client.ticketing.collections.viewers_list(
-**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/). +**terminated_after:** `typing.Optional[dt.datetime]` — If provided, will only return employees that were terminated after this datetime.
@@ -31063,7 +31148,7 @@ client.ticketing.collections.viewers_list(
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. +**terminated_before:** `typing.Optional[dt.datetime]` — If provided, will only return employees that were terminated before this datetime.
@@ -31071,7 +31156,7 @@ client.ticketing.collections.viewers_list(
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). +**work_email:** `typing.Optional[str]` — If provided, will only return Employees with this work email
@@ -31079,7 +31164,7 @@ client.ticketing.collections.viewers_list(
-**page_size:** `typing.Optional[int]` — Number of results to return per page. +**work_location_id:** `typing.Optional[str]` — If provided, will only return employees for this location.
@@ -31099,7 +31184,7 @@ client.ticketing.collections.viewers_list(
-
client.ticketing.collections.retrieve(...) +
client.hris.employees.create(...)
@@ -31111,7 +31196,7 @@ client.ticketing.collections.viewers_list(
-Returns a `Collection` object with the given `id`. +Creates an `Employee` object with the given values.
@@ -31127,13 +31212,14 @@ Returns a `Collection` object with the given `id`. ```python from merge import Merge +from merge.resources.hris import EmployeeRequest client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.collections.retrieve( - id="id", +client.hris.employees.create( + model=EmployeeRequest(), ) ``` @@ -31150,31 +31236,7 @@ client.ticketing.collections.retrieve(
-**id:** `str` - -
-
- -
-
- -**expand:** `typing.Optional[typing.Literal["parent_collection"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. - -
-
- -
-
- -**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. - -
-
- -
-
- -**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). +**model:** `EmployeeRequest`
@@ -31182,7 +31244,7 @@ client.ticketing.collections.retrieve(
-**remote_fields:** `typing.Optional[typing.Literal["collection_type"]]` — Deprecated. Use show_enum_origins. +**is_debug_mode:** `typing.Optional[bool]` — Whether to include debug fields (such as log file links) in the response.
@@ -31190,7 +31252,7 @@ client.ticketing.collections.retrieve(
-**show_enum_origins:** `typing.Optional[typing.Literal["collection_type"]]` — A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter) +**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously.
@@ -31210,8 +31272,7 @@ client.ticketing.collections.retrieve(
-## Ticketing Comments -
client.ticketing.comments.list(...) +
client.hris.employees.retrieve(...)
@@ -31223,7 +31284,7 @@ client.ticketing.collections.retrieve(
-Returns a list of `Comment` objects. +Returns an `Employee` object with the given `id`.
@@ -31244,8 +31305,8 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.comments.list( - cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +client.hris.employees.retrieve( + id="id", ) ``` @@ -31262,7 +31323,7 @@ client.ticketing.comments.list(
-**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime. +**id:** `str`
@@ -31270,7 +31331,7 @@ client.ticketing.comments.list(
-**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime. +**expand:** `typing.Optional[EmployeesRetrieveRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -31278,7 +31339,7 @@ client.ticketing.comments.list(
-**cursor:** `typing.Optional[str]` — The pagination cursor value. +**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -31286,7 +31347,7 @@ client.ticketing.comments.list(
-**expand:** `typing.Optional[CommentsListRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. +**include_sensitive_fields:** `typing.Optional[bool]` — Whether to include sensitive fields (such as social security numbers) in the response.
@@ -31294,7 +31355,7 @@ client.ticketing.comments.list(
-**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/). +**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -31302,7 +31363,7 @@ client.ticketing.comments.list(
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. +**remote_fields:** `typing.Optional[EmployeesRetrieveRequestRemoteFields]` — Deprecated. Use show_enum_origins.
@@ -31310,39 +31371,80 @@ client.ticketing.comments.list(
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). +**show_enum_origins:** `typing.Optional[EmployeesRetrieveRequestShowEnumOrigins]` — A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter) + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. +
+
+ +
+ + + + +
+ +
client.hris.employees.ignore_create(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Ignores a specific row based on the `model_id` in the url. These records will have their properties set to null, and will not be updated in future syncs. The "reason" and "message" fields in the request body will be stored for audit purposes. +
+
+#### 🔌 Usage + +
+
+
-**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned. - +```python +from merge import Merge +from merge.resources.hris import ReasonEnum + +client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.hris.employees.ignore_create( + model_id="model_id", + reason=ReasonEnum.GENERAL_CUSTOMER_REQUEST, +) + +```
- -
-
- -**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned. -
+#### ⚙️ Parameters +
-**page_size:** `typing.Optional[int]` — Number of results to return per page. - -
-
-
-**remote_created_after:** `typing.Optional[dt.datetime]` — If provided, will only return Comments created in the third party platform after this datetime. +**model_id:** `str`
@@ -31350,7 +31452,7 @@ client.ticketing.comments.list(
-**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object. +**reason:** `IgnoreCommonModelRequestReason`
@@ -31358,7 +31460,7 @@ client.ticketing.comments.list(
-**ticket_id:** `typing.Optional[str]` — If provided, will only return comments for this ticket. +**message:** `typing.Optional[str]`
@@ -31378,7 +31480,7 @@ client.ticketing.comments.list(
-
client.ticketing.comments.create(...) +
client.hris.employees.meta_post_retrieve()
@@ -31390,7 +31492,7 @@ client.ticketing.comments.list(
-Creates a `Comment` object with the given values. +Returns metadata for `Employee` POSTs.
@@ -31406,15 +31508,12 @@ Creates a `Comment` object with the given values. ```python from merge import Merge -from merge.resources.ticketing import CommentRequest client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.comments.create( - model=CommentRequest(), -) +client.hris.employees.meta_post_retrieve() ``` @@ -31430,30 +31529,6 @@ client.ticketing.comments.create(
-**model:** `CommentRequest` - -
-
- -
-
- -**is_debug_mode:** `typing.Optional[bool]` — Whether to include debug fields (such as log file links) in the response. - -
-
- -
-
- -**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously. - -
-
- -
-
- **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -31466,7 +31541,8 @@ client.ticketing.comments.create(
-
client.ticketing.comments.retrieve(...) +## Hris EmployerBenefits +
client.hris.employer_benefits.list(...)
@@ -31478,7 +31554,7 @@ client.ticketing.comments.create(
-Returns a `Comment` object with the given `id`. +Returns a list of `EmployerBenefit` objects.
@@ -31499,8 +31575,8 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.comments.retrieve( - id="id", +client.hris.employer_benefits.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", ) ``` @@ -31517,7 +31593,7 @@ client.ticketing.comments.retrieve(
-**id:** `str` +**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
@@ -31525,7 +31601,23 @@ client.ticketing.comments.retrieve(
-**expand:** `typing.Optional[CommentsRetrieveRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. +**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime. + +
+
+ +
+
+ +**cursor:** `typing.Optional[str]` — The pagination cursor value. + +
+
+ +
+
+ +**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
@@ -31549,6 +31641,38 @@ client.ticketing.comments.retrieve(
+**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned. + +
+
+ +
+
+ +**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned. + +
+
+ +
+
+ +**page_size:** `typing.Optional[int]` — Number of results to return per page. + +
+
+ +
+
+ +**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object. + +
+
+ +
+
+ **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -31561,7 +31685,7 @@ client.ticketing.comments.retrieve(
-
client.ticketing.comments.meta_post_retrieve() +
client.hris.employer_benefits.retrieve(...)
@@ -31573,7 +31697,7 @@ client.ticketing.comments.retrieve(
-Returns metadata for `Comment` POSTs. +Returns an `EmployerBenefit` object with the given `id`.
@@ -31594,7 +31718,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.comments.meta_post_retrieve() +client.hris.employer_benefits.retrieve( + id="id", +) ``` @@ -31610,6 +31736,30 @@ client.ticketing.comments.meta_post_retrieve()
+**id:** `str` + +
+
+ +
+
+ +**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. + +
+
+ +
+
+ +**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). + +
+
+ +
+
+ **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -31622,8 +31772,8 @@ client.ticketing.comments.meta_post_retrieve()
-## Ticketing Contacts -
client.ticketing.contacts.list(...) +## Hris Employments +
client.hris.employments.list(...)
@@ -31635,7 +31785,7 @@ client.ticketing.comments.meta_post_retrieve()
-Returns a list of `Contact` objects. +Returns a list of `Employment` objects.
@@ -31656,7 +31806,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.contacts.list( +client.hris.employments.list( cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", ) @@ -31698,7 +31848,7 @@ client.ticketing.contacts.list(
-**expand:** `typing.Optional[typing.Literal["account"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. +**employee_id:** `typing.Optional[str]` — If provided, will only return employments for this employee.
@@ -31706,7 +31856,7 @@ client.ticketing.contacts.list(
-**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/). +**expand:** `typing.Optional[EmploymentsListRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -31714,7 +31864,7 @@ client.ticketing.contacts.list(
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. +**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
@@ -31722,7 +31872,7 @@ client.ticketing.contacts.list(
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). +**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -31730,7 +31880,7 @@ client.ticketing.contacts.list(
-**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned. +**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -31738,7 +31888,7 @@ client.ticketing.contacts.list(
-**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned. +**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
@@ -31746,7 +31896,7 @@ client.ticketing.contacts.list(
-**page_size:** `typing.Optional[int]` — Number of results to return per page. +**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
@@ -31754,7 +31904,7 @@ client.ticketing.contacts.list(
-**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object. +**order_by:** `typing.Optional[EmploymentsListRequestOrderBy]` — Overrides the default ordering for this endpoint. Possible values include: effective_date, -effective_date.
@@ -31762,71 +31912,15 @@ client.ticketing.contacts.list(
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. +**page_size:** `typing.Optional[int]` — Number of results to return per page.
- -
- - - - -
- -
client.ticketing.contacts.create(...) -
-
- -#### 📝 Description - -
-
- -
-
- -Creates a `Contact` object with the given values. -
-
-
-
- -#### 🔌 Usage - -
-
- -
-
- -```python -from merge import Merge -from merge.resources.ticketing import ContactRequest - -client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.ticketing.contacts.create( - model=ContactRequest(), -) - -``` -
-
-
-
- -#### ⚙️ Parameters - -
-
-**model:** `ContactRequest` +**remote_fields:** `typing.Optional[EmploymentsListRequestRemoteFields]` — Deprecated. Use show_enum_origins.
@@ -31834,7 +31928,7 @@ client.ticketing.contacts.create(
-**is_debug_mode:** `typing.Optional[bool]` — Whether to include debug fields (such as log file links) in the response. +**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
@@ -31842,7 +31936,7 @@ client.ticketing.contacts.create(
-**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously. +**show_enum_origins:** `typing.Optional[EmploymentsListRequestShowEnumOrigins]` — A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter)
@@ -31862,7 +31956,7 @@ client.ticketing.contacts.create(
-
client.ticketing.contacts.retrieve(...) +
client.hris.employments.retrieve(...)
@@ -31874,7 +31968,7 @@ client.ticketing.contacts.create(
-Returns a `Contact` object with the given `id`. +Returns an `Employment` object with the given `id`.
@@ -31895,7 +31989,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.contacts.retrieve( +client.hris.employments.retrieve( id="id", ) @@ -31905,15 +31999,31 @@ client.ticketing.contacts.retrieve(
-#### ⚙️ Parameters - +#### ⚙️ Parameters + +
+
+ +
+
+ +**id:** `str` + +
+
+
+**expand:** `typing.Optional[EmploymentsRetrieveRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. + +
+
+
-**id:** `str` +**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -31921,7 +32031,7 @@ client.ticketing.contacts.retrieve(
-**expand:** `typing.Optional[typing.Literal["account"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. +**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -31929,7 +32039,7 @@ client.ticketing.contacts.retrieve(
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. +**remote_fields:** `typing.Optional[EmploymentsRetrieveRequestRemoteFields]` — Deprecated. Use show_enum_origins.
@@ -31937,7 +32047,7 @@ client.ticketing.contacts.retrieve(
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). +**show_enum_origins:** `typing.Optional[EmploymentsRetrieveRequestShowEnumOrigins]` — A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter)
@@ -31957,7 +32067,8 @@ client.ticketing.contacts.retrieve(
-
client.ticketing.contacts.meta_post_retrieve() +## Hris FieldMapping +
client.hris.field_mapping.field_mappings_retrieve(...)
@@ -31969,7 +32080,7 @@ client.ticketing.contacts.retrieve(
-Returns metadata for `TicketingContact` POSTs. +Get all Field Mappings for this Linked Account. Field Mappings are mappings between third-party Remote Fields and user defined Merge fields. [Learn more](https://docs.merge.dev/supplemental-data/field-mappings/overview/).
@@ -31990,7 +32101,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.contacts.meta_post_retrieve() +client.hris.field_mapping.field_mappings_retrieve() ``` @@ -32006,6 +32117,14 @@ client.ticketing.contacts.meta_post_retrieve()
+**exclude_remote_field_metadata:** `typing.Optional[bool]` — If `true`, remote fields metadata is excluded from each field mapping instance (i.e. `remote_fields.remote_key_name` and `remote_fields.schema` will be null). This will increase the speed of the request since these fields require some calculations. + +
+
+ +
+
+ **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -32018,8 +32137,7 @@ client.ticketing.contacts.meta_post_retrieve()
-## Ticketing Scopes -
client.ticketing.scopes.default_scopes_retrieve() +
client.hris.field_mapping.field_mappings_create(...)
@@ -32031,7 +32149,7 @@ client.ticketing.contacts.meta_post_retrieve()
-Get the default permissions for Merge Common Models and fields across all Linked Accounts of a given category. [Learn more](https://help.merge.dev/en/articles/5950052-common-model-and-field-scopes). +Create new Field Mappings that will be available after the next scheduled sync. This will cause the next sync for this Linked Account to sync **ALL** data from start.
@@ -32052,7 +32170,14 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.scopes.default_scopes_retrieve() +client.hris.field_mapping.field_mappings_create( + target_field_name="example_target_field_name", + target_field_description="this is a example description of the target field", + remote_field_traversal_path=["example_remote_field"], + remote_method="GET", + remote_url_path="/example-url-path", + common_model_name="ExampleCommonModel", +) ``` @@ -32068,64 +32193,59 @@ client.ticketing.scopes.default_scopes_retrieve()
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. +**target_field_name:** `str` — The name of the target field you want this remote field to map to.
- -
+
+
+**target_field_description:** `str` — The description of the target field you want this remote field to map to. +
-
-
client.ticketing.scopes.linked_account_scopes_retrieve()
-#### 📝 Description - -
-
+**remote_field_traversal_path:** `typing.Sequence[typing.Optional[typing.Any]]` — The field traversal path of the remote field listed when you hit the GET /remote-fields endpoint. + +
+
-Get all available permissions for Merge Common Models and fields for a single Linked Account. [Learn more](https://help.merge.dev/en/articles/5950052-common-model-and-field-scopes). -
-
+**remote_method:** `str` — The method of the remote endpoint where the remote field is coming from. +
-#### 🔌 Usage -
+**remote_url_path:** `str` — The path of the remote endpoint where the remote field is coming from. + +
+
+
-```python -from merge import Merge - -client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.ticketing.scopes.linked_account_scopes_retrieve() - -``` -
-
+**common_model_name:** `str` — The name of the Common Model that the remote field corresponds to in a given category. + -#### ⚙️ Parameters -
+**exclude_remote_field_metadata:** `typing.Optional[bool]` — If `true`, remote fields metadata is excluded from each field mapping instance (i.e. `remote_fields.remote_key_name` and `remote_fields.schema` will be null). This will increase the speed of the request since these fields require some calculations. + +
+
+
@@ -32141,7 +32261,7 @@ client.ticketing.scopes.linked_account_scopes_retrieve()
-
client.ticketing.scopes.linked_account_scopes_create(...) +
client.hris.field_mapping.field_mappings_destroy(...)
@@ -32153,7 +32273,7 @@ client.ticketing.scopes.linked_account_scopes_retrieve()
-Update permissions for any Common Model or field for a single Linked Account. Any Scopes not set in this POST request will inherit the default Scopes. [Learn more](https://help.merge.dev/en/articles/5950052-common-model-and-field-scopes) +Deletes Field Mappings for a Linked Account. All data related to this Field Mapping will be deleted and these changes will be reflected after the next scheduled sync. This will cause the next sync for this Linked Account to sync **ALL** data from start.
@@ -32169,42 +32289,13 @@ Update permissions for any Common Model or field for a single Linked Account. An ```python from merge import Merge -from merge.resources.ticketing import ( - FieldPermissionDeserializerRequest, - IndividualCommonModelScopeDeserializerRequest, - ModelPermissionDeserializerRequest, -) client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.scopes.linked_account_scopes_create( - common_models=[ - IndividualCommonModelScopeDeserializerRequest( - model_name="Employee", - model_permissions={ - "READ": ModelPermissionDeserializerRequest( - is_enabled=True, - ), - "WRITE": ModelPermissionDeserializerRequest( - is_enabled=False, - ), - }, - field_permissions=FieldPermissionDeserializerRequest( - enabled_fields=["avatar", "home_location"], - disabled_fields=["work_location"], - ), - ), - IndividualCommonModelScopeDeserializerRequest( - model_name="Benefit", - model_permissions={ - "WRITE": ModelPermissionDeserializerRequest( - is_enabled=False, - ) - }, - ), - ], +client.hris.field_mapping.field_mappings_destroy( + field_mapping_id="field_mapping_id", ) ``` @@ -32221,7 +32312,7 @@ client.ticketing.scopes.linked_account_scopes_create(
-**common_models:** `typing.Sequence[IndividualCommonModelScopeDeserializerRequest]` — The common models you want to update the scopes for +**field_mapping_id:** `str`
@@ -32241,8 +32332,7 @@ client.ticketing.scopes.linked_account_scopes_create(
-## Ticketing DeleteAccount -
client.ticketing.delete_account.delete() +
client.hris.field_mapping.field_mappings_partial_update(...)
@@ -32254,7 +32344,7 @@ client.ticketing.scopes.linked_account_scopes_create(
-Delete a linked account. +Create or update existing Field Mappings for a Linked Account. Changes will be reflected after the next scheduled sync. This will cause the next sync for this Linked Account to sync **ALL** data from start.
@@ -32275,7 +32365,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.delete_account.delete() +client.hris.field_mapping.field_mappings_partial_update( + field_mapping_id="field_mapping_id", +) ``` @@ -32291,69 +32383,31 @@ client.ticketing.delete_account.delete()
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. +**field_mapping_id:** `str`
- -
- - - - -
- -## Ticketing FieldMapping -
client.ticketing.field_mapping.field_mappings_retrieve(...) -
-
- -#### 📝 Description
-
-
- -Get all Field Mappings for this Linked Account. Field Mappings are mappings between third-party Remote Fields and user defined Merge fields. [Learn more](https://docs.merge.dev/supplemental-data/field-mappings/overview/). -
-
+**remote_field_traversal_path:** `typing.Optional[typing.Sequence[typing.Optional[typing.Any]]]` — The field traversal path of the remote field listed when you hit the GET /remote-fields endpoint. +
-#### 🔌 Usage - -
-
-
-```python -from merge import Merge - -client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.ticketing.field_mapping.field_mappings_retrieve() - -``` -
-
+**remote_method:** `typing.Optional[str]` — The method of the remote endpoint where the remote field is coming from. +
-#### ⚙️ Parameters - -
-
-
-**exclude_remote_field_metadata:** `typing.Optional[bool]` — If `true`, remote fields metadata is excluded from each field mapping instance (i.e. `remote_fields.remote_key_name` and `remote_fields.schema` will be null). This will increase the speed of the request since these fields require some calculations. +**remote_url_path:** `typing.Optional[str]` — The path of the remote endpoint where the remote field is coming from.
@@ -32373,7 +32427,7 @@ client.ticketing.field_mapping.field_mappings_retrieve()
-
client.ticketing.field_mapping.field_mappings_create(...) +
client.hris.field_mapping.remote_fields_retrieve(...)
@@ -32385,7 +32439,7 @@ client.ticketing.field_mapping.field_mappings_retrieve()
-Create new Field Mappings that will be available after the next scheduled sync. This will cause the next sync for this Linked Account to sync **ALL** data from start. +Get all remote fields for a Linked Account. Remote fields are third-party fields that are accessible after initial sync if remote_data is enabled. You can use remote fields to override existing Merge fields or map a new Merge field. [Learn more](https://docs.merge.dev/supplemental-data/field-mappings/overview/).
@@ -32406,14 +32460,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.field_mapping.field_mappings_create( - target_field_name="example_target_field_name", - target_field_description="this is a example description of the target field", - remote_field_traversal_path=["example_remote_field"], - remote_method="GET", - remote_url_path="/example-url-path", - common_model_name="ExampleCommonModel", -) +client.hris.field_mapping.remote_fields_retrieve() ``` @@ -32429,7 +32476,7 @@ client.ticketing.field_mapping.field_mappings_create(
-**target_field_name:** `str` — The name of the target field you want this remote field to map to. +**common_models:** `typing.Optional[str]` — A comma seperated list of Common Model names. If included, will only return Remote Fields for those Common Models.
@@ -32437,7 +32484,7 @@ client.ticketing.field_mapping.field_mappings_create(
-**target_field_description:** `str` — The description of the target field you want this remote field to map to. +**include_example_values:** `typing.Optional[str]` — If true, will include example values, where available, for remote fields in the 3rd party platform. These examples come from active data from your customers.
@@ -32445,43 +32492,64 @@ client.ticketing.field_mapping.field_mappings_create(
-**remote_field_traversal_path:** `typing.Sequence[typing.Optional[typing.Any]]` — The field traversal path of the remote field listed when you hit the GET /remote-fields endpoint. +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+ +
-
-
-**remote_method:** `str` — The method of the remote endpoint where the remote field is coming from. -
+
+
client.hris.field_mapping.target_fields_retrieve()
-**remote_url_path:** `str` — The path of the remote endpoint where the remote field is coming from. - -
-
+#### 📝 Description
-**common_model_name:** `str` — The name of the Common Model that the remote field corresponds to in a given category. - +
+
+ +Get all organization-wide Target Fields, this will not include any Linked Account specific Target Fields. Organization-wide Target Fields are additional fields appended to the Merge Common Model for all Linked Accounts in a category. [Learn more](https://docs.merge.dev/supplemental-data/field-mappings/target-fields/).
+
+
+ +#### 🔌 Usage
-**exclude_remote_field_metadata:** `typing.Optional[bool]` — If `true`, remote fields metadata is excluded from each field mapping instance (i.e. `remote_fields.remote_key_name` and `remote_fields.schema` will be null). This will increase the speed of the request since these fields require some calculations. - +
+
+ +```python +from merge import Merge + +client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.hris.field_mapping.target_fields_retrieve() + +``` +
+
+#### ⚙️ Parameters + +
+
+
@@ -32497,7 +32565,8 @@ client.ticketing.field_mapping.field_mappings_create(
-
client.ticketing.field_mapping.field_mappings_destroy(...) +## Hris GenerateKey +
client.hris.generate_key.create(...)
@@ -32509,7 +32578,7 @@ client.ticketing.field_mapping.field_mappings_create(
-Deletes Field Mappings for a Linked Account. All data related to this Field Mapping will be deleted and these changes will be reflected after the next scheduled sync. This will cause the next sync for this Linked Account to sync **ALL** data from start. +Create a remote key.
@@ -32530,8 +32599,8 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.field_mapping.field_mappings_destroy( - field_mapping_id="field_mapping_id", +client.hris.generate_key.create( + name="Remote Deployment Key 1", ) ``` @@ -32548,7 +32617,7 @@ client.ticketing.field_mapping.field_mappings_destroy(
-**field_mapping_id:** `str` +**name:** `str` — The name of the remote key
@@ -32568,7 +32637,8 @@ client.ticketing.field_mapping.field_mappings_destroy(
-
client.ticketing.field_mapping.field_mappings_partial_update(...) +## Hris Groups +
client.hris.groups.list(...)
@@ -32580,7 +32650,7 @@ client.ticketing.field_mapping.field_mappings_destroy(
-Create or update existing Field Mappings for a Linked Account. Changes will be reflected after the next scheduled sync. This will cause the next sync for this Linked Account to sync **ALL** data from start. +Returns a list of `Group` objects.
@@ -32601,8 +32671,8 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.field_mapping.field_mappings_partial_update( - field_mapping_id="field_mapping_id", +client.hris.groups.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", ) ``` @@ -32619,7 +32689,7 @@ client.ticketing.field_mapping.field_mappings_partial_update(
-**field_mapping_id:** `str` +**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
@@ -32627,7 +32697,7 @@ client.ticketing.field_mapping.field_mappings_partial_update(
-**remote_field_traversal_path:** `typing.Optional[typing.Sequence[typing.Optional[typing.Any]]]` — The field traversal path of the remote field listed when you hit the GET /remote-fields endpoint. +**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
@@ -32635,7 +32705,7 @@ client.ticketing.field_mapping.field_mappings_partial_update(
-**remote_method:** `typing.Optional[str]` — The method of the remote endpoint where the remote field is coming from. +**cursor:** `typing.Optional[str]` — The pagination cursor value.
@@ -32643,7 +32713,7 @@ client.ticketing.field_mapping.field_mappings_partial_update(
-**remote_url_path:** `typing.Optional[str]` — The path of the remote endpoint where the remote field is coming from. +**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
@@ -32651,68 +32721,79 @@ client.ticketing.field_mapping.field_mappings_partial_update(
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. +**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
- -
+
+
+**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). +
-
-
client.ticketing.field_mapping.remote_fields_retrieve(...)
-#### 📝 Description +**is_commonly_used_as_team:** `typing.Optional[str]` — If provided, specifies whether to return only Group objects which refer to a team in the third party platform. Note that this is an opinionated view based on how a team may be represented in the third party platform. + +
+
+**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned. + +
+
+
-Get all remote fields for a Linked Account. Remote fields are third-party fields that are accessible after initial sync if remote_data is enabled. You can use remote fields to override existing Merge fields or map a new Merge field. [Learn more](https://docs.merge.dev/supplemental-data/field-mappings/overview/). -
-
+**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned. + -#### 🔌 Usage -
+**names:** `typing.Optional[str]` — If provided, will only return groups with these names. Multiple values can be separated by commas. + +
+
+
-```python -from merge import Merge - -client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.ticketing.field_mapping.remote_fields_retrieve() - -``` +**page_size:** `typing.Optional[int]` — Number of results to return per page. +
+ +
+
+ +**remote_fields:** `typing.Optional[typing.Literal["type"]]` — Deprecated. Use show_enum_origins. +
-#### ⚙️ Parameters -
+**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object. + +
+
+
-**common_models:** `typing.Optional[str]` — A comma seperated list of Common Model names. If included, will only return Remote Fields for those Common Models. +**show_enum_origins:** `typing.Optional[typing.Literal["type"]]` — A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter)
@@ -32720,7 +32801,7 @@ client.ticketing.field_mapping.remote_fields_retrieve()
-**include_example_values:** `typing.Optional[str]` — If true, will include example values, where available, for remote fields in the 3rd party platform. These examples come from active data from your customers. +**types:** `typing.Optional[str]` — If provided, will only return groups of these types. Multiple values can be separated by commas.
@@ -32740,7 +32821,7 @@ client.ticketing.field_mapping.remote_fields_retrieve()
-
client.ticketing.field_mapping.target_fields_retrieve() +
client.hris.groups.retrieve(...)
@@ -32752,7 +32833,7 @@ client.ticketing.field_mapping.remote_fields_retrieve()
-Get all organization-wide Target Fields, this will not include any Linked Account specific Target Fields. Organization-wide Target Fields are additional fields appended to the Merge Common Model for all Linked Accounts in a category. [Learn more](https://docs.merge.dev/supplemental-data/field-mappings/target-fields/). +Returns a `Group` object with the given `id`.
@@ -32773,7 +32854,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.field_mapping.target_fields_retrieve() +client.hris.groups.retrieve( + id="id", +) ``` @@ -32789,71 +32872,39 @@ client.ticketing.field_mapping.target_fields_retrieve()
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. +**id:** `str`
- -
- - - - -
-## Ticketing GenerateKey -
client.ticketing.generate_key.create(...)
-#### 📝 Description - -
-
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. + +
+
-Create a remote key. -
-
+**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). +
-#### 🔌 Usage - -
-
-
-```python -from merge import Merge - -client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.ticketing.generate_key.create( - name="Remote Deployment Key 1", -) - -``` -
-
+**remote_fields:** `typing.Optional[typing.Literal["type"]]` — Deprecated. Use show_enum_origins. +
-#### ⚙️ Parameters - -
-
-
-**name:** `str` — The name of the remote key +**show_enum_origins:** `typing.Optional[typing.Literal["type"]]` — A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter)
@@ -32873,8 +32924,8 @@ client.ticketing.generate_key.create(
-## Ticketing Issues -
client.ticketing.issues.list(...) +## Hris Issues +
client.hris.issues.list(...)
@@ -32907,7 +32958,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.issues.list( +client.hris.issues.list( cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", ) @@ -33054,7 +33105,7 @@ Status of the issue. Options: ('ONGOING', 'RESOLVED')
-
client.ticketing.issues.retrieve(...) +
client.hris.issues.retrieve(...)
@@ -33087,7 +33138,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.issues.retrieve( +client.hris.issues.retrieve( id="id", ) @@ -33125,8 +33176,8 @@ client.ticketing.issues.retrieve(
-## Ticketing LinkToken -
client.ticketing.link_token.create(...) +## Hris LinkToken +
client.hris.link_token.create(...)
@@ -33154,13 +33205,13 @@ Creates a link token to be used when linking a new end user. ```python from merge import Merge -from merge.resources.ticketing import CategoriesEnum +from merge.resources.hris import CategoriesEnum client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.link_token.create( +client.hris.link_token.create( end_user_email_address="example@gmail.com", end_user_organization_name="Test Organization", end_user_origin_id="12345", @@ -33309,8 +33360,8 @@ The following subset of IETF language tags can be used to configure localization
-## Ticketing LinkedAccounts -
client.ticketing.linked_accounts.list(...) +## Hris LinkedAccounts +
client.hris.linked_accounts.list(...)
@@ -33343,7 +33394,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.linked_accounts.list( +client.hris.linked_accounts.list( cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", ) @@ -33487,84 +33538,8 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing`
-## Ticketing Passthrough -
client.ticketing.passthrough.create(...) -
-
- -#### 📝 Description - -
-
- -
-
- -Pull data from an endpoint not currently supported by Merge. -
-
-
-
- -#### 🔌 Usage - -
-
- -
-
- -```python -from merge import Merge -from merge.resources.ticketing import DataPassthroughRequest, MethodEnum - -client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.ticketing.passthrough.create( - request=DataPassthroughRequest( - method=MethodEnum.GET, - path="/scooters", - ), -) - -``` -
-
-
-
- -#### ⚙️ Parameters - -
-
- -
-
- -**request:** `DataPassthroughRequest` - -
-
- -
-
- -**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. - -
-
-
-
- - -
-
-
- -## Ticketing Projects -
client.ticketing.projects.list(...) +## Hris Locations +
client.hris.locations.list(...)
@@ -33576,7 +33551,7 @@ client.ticketing.passthrough.create(
-Returns a list of `Project` objects. +Returns a list of `Location` objects.
@@ -33597,7 +33572,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.projects.list( +client.hris.locations.list( cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", ) @@ -33663,15 +33638,12 @@ client.ticketing.projects.list(
-**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned. - -
-
+**location_type:** `typing.Optional[LocationsListRequestLocationType]` -
-
+If provided, will only return locations with this location_type -**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned. +* `HOME` - HOME +* `WORK` - WORK
@@ -33679,7 +33651,7 @@ client.ticketing.projects.list(
-**page_size:** `typing.Optional[int]` — Number of results to return per page. +**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
@@ -33687,7 +33659,7 @@ client.ticketing.projects.list(
-**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object. +**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
@@ -33695,70 +33667,15 @@ client.ticketing.projects.list(
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. +**page_size:** `typing.Optional[int]` — Number of results to return per page.
- -
- - - - -
- -
client.ticketing.projects.retrieve(...) -
-
- -#### 📝 Description - -
-
- -
-
- -Returns a `Project` object with the given `id`. -
-
-
-
- -#### 🔌 Usage - -
-
- -
-
- -```python -from merge import Merge - -client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.ticketing.projects.retrieve( - id="id", -) - -``` -
-
-
-
- -#### ⚙️ Parameters
-
-
- -**id:** `str` +**remote_fields:** `typing.Optional[LocationsListRequestRemoteFields]` — Deprecated. Use show_enum_origins.
@@ -33766,7 +33683,7 @@ client.ticketing.projects.retrieve(
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. +**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
@@ -33774,7 +33691,7 @@ client.ticketing.projects.retrieve(
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). +**show_enum_origins:** `typing.Optional[LocationsListRequestShowEnumOrigins]` — A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter)
@@ -33794,7 +33711,7 @@ client.ticketing.projects.retrieve(
-
client.ticketing.projects.users_list(...) +
client.hris.locations.retrieve(...)
@@ -33806,7 +33723,7 @@ client.ticketing.projects.retrieve(
-Returns a list of `User` objects. +Returns a `Location` object with the given `id`.
@@ -33827,9 +33744,8 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.projects.users_list( - parent_id="parent_id", - cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +client.hris.locations.retrieve( + id="id", ) ``` @@ -33846,23 +33762,7 @@ client.ticketing.projects.users_list(
-**parent_id:** `str` - -
-
- -
-
- -**cursor:** `typing.Optional[str]` — The pagination cursor value. - -
-
- -
-
- -**expand:** `typing.Optional[ProjectsUsersListRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. +**id:** `str`
@@ -33870,7 +33770,7 @@ client.ticketing.projects.users_list(
-**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/). +**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -33878,7 +33778,7 @@ client.ticketing.projects.users_list(
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. +**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -33886,7 +33786,7 @@ client.ticketing.projects.users_list(
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). +**remote_fields:** `typing.Optional[LocationsRetrieveRequestRemoteFields]` — Deprecated. Use show_enum_origins.
@@ -33894,7 +33794,7 @@ client.ticketing.projects.users_list(
-**page_size:** `typing.Optional[int]` — Number of results to return per page. +**show_enum_origins:** `typing.Optional[LocationsRetrieveRequestShowEnumOrigins]` — A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter)
@@ -33914,8 +33814,8 @@ client.ticketing.projects.users_list(
-## Ticketing RegenerateKey -
client.ticketing.regenerate_key.create(...) +## Hris Passthrough +
client.hris.passthrough.create(...)
@@ -33927,7 +33827,7 @@ client.ticketing.projects.users_list(
-Exchange remote keys. +Pull data from an endpoint not currently supported by Merge.
@@ -33943,13 +33843,17 @@ Exchange remote keys. ```python from merge import Merge +from merge.resources.hris import DataPassthroughRequest, MethodEnum client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.regenerate_key.create( - name="Remote Deployment Key 1", +client.hris.passthrough.create( + request=DataPassthroughRequest( + method=MethodEnum.GET, + path="/scooters", + ), ) ``` @@ -33966,7 +33870,7 @@ client.ticketing.regenerate_key.create(
-**name:** `str` — The name of the remote key +**request:** `DataPassthroughRequest`
@@ -33986,8 +33890,8 @@ client.ticketing.regenerate_key.create(
-## Ticketing Roles -
client.ticketing.roles.list(...) +## Hris PayGroups +
client.hris.pay_groups.list(...)
@@ -33999,7 +33903,7 @@ client.ticketing.regenerate_key.create(
-Returns a list of `Role` objects. +Returns a list of `PayGroup` objects.
@@ -34020,7 +33924,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.roles.list( +client.hris.pay_groups.list( cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", ) @@ -34130,7 +34034,7 @@ client.ticketing.roles.list(
-
client.ticketing.roles.retrieve(...) +
client.hris.pay_groups.retrieve(...)
@@ -34142,7 +34046,7 @@ client.ticketing.roles.list(
-Returns a `Role` object with the given `id`. +Returns a `PayGroup` object with the given `id`.
@@ -34163,7 +34067,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.roles.retrieve( +client.hris.pay_groups.retrieve( id="id", ) @@ -34217,8 +34121,8 @@ client.ticketing.roles.retrieve(
-## Ticketing SyncStatus -
client.ticketing.sync_status.list(...) +## Hris PayrollRuns +
client.hris.payroll_runs.list(...)
@@ -34230,7 +34134,7 @@ client.ticketing.roles.retrieve(
-Get sync status for the current sync and the most recently finished sync. `last_sync_start` represents the most recent time any sync began. `last_sync_finished` represents the most recent time any sync completed. These timestamps may correspond to different sync instances which may result in a sync start time being later than a separate sync completed time. To ensure you are retrieving the latest available data reference the `last_sync_finished` timestamp where `last_sync_result` is `DONE`. Possible values for `status` and `last_sync_result` are `DISABLED`, `DONE`, `FAILED`, `PARTIALLY_SYNCED`, `PAUSED`, `SYNCING`. Learn more about sync status in our [Help Center](https://help.merge.dev/en/articles/8184193-merge-sync-statuses). +Returns a list of `PayrollRun` objects.
@@ -34251,7 +34155,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.sync_status.list( +client.hris.payroll_runs.list( cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", ) @@ -34269,6 +34173,22 @@ client.ticketing.sync_status.list(
+**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime. + +
+
+ +
+
+ +**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime. + +
+
+ +
+
+ **cursor:** `typing.Optional[str]` — The pagination cursor value.
@@ -34277,7 +34197,7 @@ client.ticketing.sync_status.list(
-**page_size:** `typing.Optional[int]` — Number of results to return per page. +**ended_after:** `typing.Optional[dt.datetime]` — If provided, will only return payroll runs ended after this datetime.
@@ -34285,65 +34205,115 @@ client.ticketing.sync_status.list(
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. +**ended_before:** `typing.Optional[dt.datetime]` — If provided, will only return payroll runs ended before this datetime.
+ +
+
+ +**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/). +
+
+
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. +
-
-## Ticketing ForceResync -
client.ticketing.force_resync.sync_status_resync_create()
-#### 📝 Description +**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). + +
+
+**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned. + +
+
+
-Force re-sync of all models. This endpoint is available for monthly, quarterly, and highest sync frequency customers on the Professional or Enterprise plans. Doing so will consume a sync credit for the relevant linked account. Force re-syncs can also be triggered manually in the Merge Dashboard and is available for all customers. +**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned. +
+ +
+
+ +**page_size:** `typing.Optional[int]` — Number of results to return per page. +
-#### 🔌 Usage +
+
+ +**remote_fields:** `typing.Optional[PayrollRunsListRequestRemoteFields]` — Deprecated. Use show_enum_origins. + +
+
+**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object. + +
+
+
-```python -from merge import Merge +**run_type:** `typing.Optional[PayrollRunsListRequestRunType]` -client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.ticketing.force_resync.sync_status_resync_create() +If provided, will only return PayrollRun's with this status. Options: ('REGULAR', 'OFF_CYCLE', 'CORRECTION', 'TERMINATION', 'SIGN_ON_BONUS') -``` +* `REGULAR` - REGULAR +* `OFF_CYCLE` - OFF_CYCLE +* `CORRECTION` - CORRECTION +* `TERMINATION` - TERMINATION +* `SIGN_ON_BONUS` - SIGN_ON_BONUS +
+ +
+
+ +**show_enum_origins:** `typing.Optional[PayrollRunsListRequestShowEnumOrigins]` — A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter) +
-#### ⚙️ Parameters +
+
+ +**started_after:** `typing.Optional[dt.datetime]` — If provided, will only return payroll runs started after this datetime. + +
+
+**started_before:** `typing.Optional[dt.datetime]` — If provided, will only return payroll runs started before this datetime. + +
+
+
@@ -34359,8 +34329,7 @@ client.ticketing.force_resync.sync_status_resync_create()
-## Ticketing Tags -
client.ticketing.tags.list(...) +
client.hris.payroll_runs.retrieve(...)
@@ -34372,7 +34341,7 @@ client.ticketing.force_resync.sync_status_resync_create()
-Returns a list of `Tag` objects. +Returns a `PayrollRun` object with the given `id`.
@@ -34393,8 +34362,8 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.tags.list( - cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +client.hris.payroll_runs.retrieve( + id="id", ) ``` @@ -34411,7 +34380,7 @@ client.ticketing.tags.list(
-**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime. +**id:** `str`
@@ -34419,7 +34388,7 @@ client.ticketing.tags.list(
-**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime. +**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -34427,7 +34396,7 @@ client.ticketing.tags.list(
-**cursor:** `typing.Optional[str]` — The pagination cursor value. +**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -34435,7 +34404,7 @@ client.ticketing.tags.list(
-**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/). +**remote_fields:** `typing.Optional[PayrollRunsRetrieveRequestRemoteFields]` — Deprecated. Use show_enum_origins.
@@ -34443,7 +34412,7 @@ client.ticketing.tags.list(
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. +**show_enum_origins:** `typing.Optional[PayrollRunsRetrieveRequestShowEnumOrigins]` — A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter)
@@ -34451,39 +34420,71 @@ client.ticketing.tags.list(
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+ +
-
-
-**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned. -
+
+## Hris RegenerateKey +
client.hris.regenerate_key.create(...)
-**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned. - +#### 📝 Description + +
+
+ +
+
+ +Exchange remote keys. +
+
+#### 🔌 Usage +
-**page_size:** `typing.Optional[int]` — Number of results to return per page. - +
+
+ +```python +from merge import Merge + +client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.hris.regenerate_key.create( + name="Remote Deployment Key 1", +) + +```
+
+
+ +#### ⚙️ Parameters
-**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object. +
+
+ +**name:** `str` — The name of the remote key
@@ -34503,7 +34504,8 @@ client.ticketing.tags.list(
-
client.ticketing.tags.retrieve(...) +## Hris SyncStatus +
client.hris.sync_status.list(...)
@@ -34515,7 +34517,7 @@ client.ticketing.tags.list(
-Returns a `Tag` object with the given `id`. +Get sync status for the current sync and the most recently finished sync. `last_sync_start` represents the most recent time any sync began. `last_sync_finished` represents the most recent time any sync completed. These timestamps may correspond to different sync instances which may result in a sync start time being later than a separate sync completed time. To ensure you are retrieving the latest available data reference the `last_sync_finished` timestamp where `last_sync_result` is `DONE`. Possible values for `status` and `last_sync_result` are `DISABLED`, `DONE`, `FAILED`, `PARTIALLY_SYNCED`, `PAUSED`, `SYNCING`. Learn more about sync status in our [Help Center](https://help.merge.dev/en/articles/8184193-merge-sync-statuses).
@@ -34536,8 +34538,8 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.tags.retrieve( - id="id", +client.hris.sync_status.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", ) ``` @@ -34554,15 +34556,7 @@ client.ticketing.tags.retrieve(
-**id:** `str` - -
-
- -
-
- -**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. +**cursor:** `typing.Optional[str]` — The pagination cursor value.
@@ -34570,7 +34564,7 @@ client.ticketing.tags.retrieve(
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). +**page_size:** `typing.Optional[int]` — Number of results to return per page.
@@ -34590,8 +34584,8 @@ client.ticketing.tags.retrieve(
-## Ticketing Teams -
client.ticketing.teams.list(...) +## Hris ForceResync +
client.hris.force_resync.sync_status_resync_create()
@@ -34603,7 +34597,7 @@ client.ticketing.tags.retrieve(
-Returns a list of `Team` objects. +Force re-sync of all models. This endpoint is available for monthly, quarterly, and highest sync frequency customers on the Professional or Enterprise plans. Doing so will consume a sync credit for the relevant linked account. Force re-syncs can also be triggered manually in the Merge Dashboard and is available for all customers.
@@ -34624,9 +34618,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.teams.list( - cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", -) +client.hris.force_resync.sync_status_resync_create() ``` @@ -34642,55 +34634,71 @@ client.ticketing.teams.list(
-**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime. +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+ +
-
-
-**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime. -
+
+## Hris Teams +
client.hris.teams.list(...)
-**cursor:** `typing.Optional[str]` — The pagination cursor value. - -
-
+#### 📝 Description
-**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/). - -
-
-
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. - +Returns a list of `Team` objects.
+ + + +#### 🔌 Usage
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). - +
+
+ +```python +from merge import Merge + +client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.hris.teams.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) + +``` +
+
+#### ⚙️ Parameters +
-**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned. +
+
+ +**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
@@ -34698,7 +34706,7 @@ client.ticketing.teams.list(
-**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned. +**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
@@ -34706,7 +34714,7 @@ client.ticketing.teams.list(
-**page_size:** `typing.Optional[int]` — Number of results to return per page. +**cursor:** `typing.Optional[str]` — The pagination cursor value.
@@ -34714,7 +34722,7 @@ client.ticketing.teams.list(
-**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object. +**expand:** `typing.Optional[typing.Literal["parent_team"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -34722,70 +34730,47 @@ client.ticketing.teams.list(
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. +**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
-
-
+
+
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. +
-
-
client.ticketing.teams.retrieve(...)
-#### 📝 Description - -
-
+**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). + +
+
-Returns a `Team` object with the given `id`. -
-
+**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned. +
-#### 🔌 Usage - -
-
-
-```python -from merge import Merge - -client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.ticketing.teams.retrieve( - id="id", -) - -``` -
-
+**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned. +
-#### ⚙️ Parameters - -
-
-
-**id:** `str` +**page_size:** `typing.Optional[int]` — Number of results to return per page.
@@ -34793,7 +34778,7 @@ client.ticketing.teams.retrieve(
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. +**parent_team_id:** `typing.Optional[str]` — If provided, will only return teams with this parent team.
@@ -34801,7 +34786,7 @@ client.ticketing.teams.retrieve(
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). +**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
@@ -34821,8 +34806,7 @@ client.ticketing.teams.retrieve(
-## Ticketing Tickets -
client.ticketing.tickets.list(...) +
client.hris.teams.retrieve(...)
@@ -34834,7 +34818,7 @@ client.ticketing.teams.retrieve(
-Returns a list of `Ticket` objects. +Returns a `Team` object with the given `id`.
@@ -34855,8 +34839,8 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.tickets.list( - cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +client.hris.teams.retrieve( + id="id", ) ``` @@ -34873,7 +34857,7 @@ client.ticketing.tickets.list(
-**account_id:** `typing.Optional[str]` — If provided, will only return tickets for this account. +**id:** `str`
@@ -34881,7 +34865,7 @@ client.ticketing.tickets.list(
-**assignee_ids:** `typing.Optional[str]` — If provided, will only return tickets assigned to the assignee_ids; multiple assignee_ids can be separated by commas. +**expand:** `typing.Optional[typing.Literal["parent_team"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -34889,7 +34873,7 @@ client.ticketing.tickets.list(
-**collection_ids:** `typing.Optional[str]` — If provided, will only return tickets assigned to the collection_ids; multiple collection_ids can be separated by commas. +**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -34897,7 +34881,7 @@ client.ticketing.tickets.list(
-**completed_after:** `typing.Optional[dt.datetime]` — If provided, will only return tickets completed after this datetime. +**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -34905,71 +34889,71 @@ client.ticketing.tickets.list(
-**completed_before:** `typing.Optional[dt.datetime]` — If provided, will only return tickets completed before this datetime. +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+ +
-
-
-**contact_id:** `typing.Optional[str]` — If provided, will only return tickets for this contact. -
+
+## Hris TimeOff +
client.hris.time_off.list(...)
-**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime. - -
-
+#### 📝 Description
-**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime. - -
-
-
-**creator_id:** `typing.Optional[str]` — If provided, will only return tickets created by this creator_id. - +Returns a list of `TimeOff` objects.
+ + + +#### 🔌 Usage
-**cursor:** `typing.Optional[str]` — The pagination cursor value. - -
-
-
-**due_after:** `typing.Optional[dt.datetime]` — If provided, will only return tickets due after this datetime. - +```python +from merge import Merge + +client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.hris.time_off.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) + +``` +
+
+#### ⚙️ Parameters +
-**due_before:** `typing.Optional[dt.datetime]` — If provided, will only return tickets due before this datetime. - -
-
-
-**expand:** `typing.Optional[TicketsListRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. +**approver_id:** `typing.Optional[str]` — If provided, will only return time off for this approver.
@@ -34977,7 +34961,7 @@ client.ticketing.tickets.list(
-**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/). +**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
@@ -34985,7 +34969,7 @@ client.ticketing.tickets.list(
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. +**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
@@ -34993,7 +34977,7 @@ client.ticketing.tickets.list(
-**include_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format. +**cursor:** `typing.Optional[str]` — The pagination cursor value.
@@ -35001,7 +34985,7 @@ client.ticketing.tickets.list(
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). +**employee_id:** `typing.Optional[str]` — If provided, will only return time off for this employee.
@@ -35009,7 +34993,7 @@ client.ticketing.tickets.list(
-**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned. +**ended_after:** `typing.Optional[dt.datetime]` — If provided, will only return employees that ended after this datetime.
@@ -35017,7 +35001,7 @@ client.ticketing.tickets.list(
-**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned. +**ended_before:** `typing.Optional[dt.datetime]` — If provided, will only return time-offs that ended before this datetime.
@@ -35025,7 +35009,7 @@ client.ticketing.tickets.list(
-**page_size:** `typing.Optional[int]` — Number of results to return per page. +**expand:** `typing.Optional[TimeOffListRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -35033,7 +35017,7 @@ client.ticketing.tickets.list(
-**parent_ticket_id:** `typing.Optional[str]` — If provided, will only return sub tickets of the parent_ticket_id. +**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
@@ -35041,14 +35025,7 @@ client.ticketing.tickets.list(
-**priority:** `typing.Optional[TicketsListRequestPriority]` - -If provided, will only return tickets of this priority. - -* `URGENT` - URGENT -* `HIGH` - HIGH -* `NORMAL` - NORMAL -* `LOW` - LOW +**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -35056,7 +35033,7 @@ If provided, will only return tickets of this priority.
-**remote_created_after:** `typing.Optional[dt.datetime]` — If provided, will only return tickets created in the third party platform after this datetime. +**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -35064,7 +35041,7 @@ If provided, will only return tickets of this priority.
-**remote_created_before:** `typing.Optional[dt.datetime]` — If provided, will only return tickets created in the third party platform before this datetime. +**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
@@ -35072,7 +35049,7 @@ If provided, will only return tickets of this priority.
-**remote_fields:** `typing.Optional[TicketsListRequestRemoteFields]` — Deprecated. Use show_enum_origins. +**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
@@ -35080,7 +35057,7 @@ If provided, will only return tickets of this priority.
-**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object. +**page_size:** `typing.Optional[int]` — Number of results to return per page.
@@ -35088,7 +35065,7 @@ If provided, will only return tickets of this priority.
-**remote_updated_after:** `typing.Optional[dt.datetime]` — If provided, will only return tickets updated in the third party platform after this datetime. +**remote_fields:** `typing.Optional[TimeOffListRequestRemoteFields]` — Deprecated. Use show_enum_origins.
@@ -35096,7 +35073,7 @@ If provided, will only return tickets of this priority.
-**remote_updated_before:** `typing.Optional[dt.datetime]` — If provided, will only return tickets updated in the third party platform before this datetime. +**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
@@ -35104,7 +35081,16 @@ If provided, will only return tickets of this priority.
-**show_enum_origins:** `typing.Optional[TicketsListRequestShowEnumOrigins]` — A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter) +**request_type:** `typing.Optional[TimeOffListRequestRequestType]` + +If provided, will only return TimeOff with this request type. Options: ('VACATION', 'SICK', 'PERSONAL', 'JURY_DUTY', 'VOLUNTEER', 'BEREAVEMENT') + +* `VACATION` - VACATION +* `SICK` - SICK +* `PERSONAL` - PERSONAL +* `JURY_DUTY` - JURY_DUTY +* `VOLUNTEER` - VOLUNTEER +* `BEREAVEMENT` - BEREAVEMENT
@@ -35112,7 +35098,7 @@ If provided, will only return tickets of this priority.
-**status:** `typing.Optional[str]` — If provided, will only return tickets of this status. +**show_enum_origins:** `typing.Optional[TimeOffListRequestShowEnumOrigins]` — A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter)
@@ -35120,7 +35106,7 @@ If provided, will only return tickets of this priority.
-**tags:** `typing.Optional[str]` — If provided, will only return tickets matching the tags; multiple tags can be separated by commas. +**started_after:** `typing.Optional[dt.datetime]` — If provided, will only return time-offs that started after this datetime.
@@ -35128,7 +35114,7 @@ If provided, will only return tickets of this priority.
-**ticket_type:** `typing.Optional[str]` — If provided, will only return tickets of this type. +**started_before:** `typing.Optional[dt.datetime]` — If provided, will only return time-offs that started before this datetime.
@@ -35136,7 +35122,15 @@ If provided, will only return tickets of this priority.
-**ticket_url:** `typing.Optional[str]` — If provided, will only return tickets where the URL matches or contains the substring +**status:** `typing.Optional[TimeOffListRequestStatus]` + +If provided, will only return TimeOff with this status. Options: ('REQUESTED', 'APPROVED', 'DECLINED', 'CANCELLED', 'DELETED') + +* `REQUESTED` - REQUESTED +* `APPROVED` - APPROVED +* `DECLINED` - DECLINED +* `CANCELLED` - CANCELLED +* `DELETED` - DELETED
@@ -35156,7 +35150,7 @@ If provided, will only return tickets of this priority.
-
client.ticketing.tickets.create(...) +
client.hris.time_off.create(...)
@@ -35168,7 +35162,7 @@ If provided, will only return tickets of this priority.
-Creates a `Ticket` object with the given values. +Creates a `TimeOff` object with the given values.
@@ -35184,14 +35178,14 @@ Creates a `Ticket` object with the given values. ```python from merge import Merge -from merge.resources.ticketing import TicketRequest +from merge.resources.hris import TimeOffRequest client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.tickets.create( - model=TicketRequest(), +client.hris.time_off.create( + model=TimeOffRequest(), ) ``` @@ -35208,7 +35202,7 @@ client.ticketing.tickets.create(
-**model:** `TicketRequest` +**model:** `TimeOffRequest`
@@ -35244,7 +35238,7 @@ client.ticketing.tickets.create(
-
client.ticketing.tickets.retrieve(...) +
client.hris.time_off.retrieve(...)
@@ -35256,7 +35250,7 @@ client.ticketing.tickets.create(
-Returns a `Ticket` object with the given `id`. +Returns a `TimeOff` object with the given `id`.
@@ -35277,7 +35271,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.tickets.retrieve( +client.hris.time_off.retrieve( id="id", ) @@ -35303,7 +35297,7 @@ client.ticketing.tickets.retrieve(
-**expand:** `typing.Optional[TicketsRetrieveRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. +**expand:** `typing.Optional[TimeOffRetrieveRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -35319,14 +35313,6 @@ client.ticketing.tickets.retrieve(
-**include_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format. - -
-
- -
-
- **include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -35335,7 +35321,7 @@ client.ticketing.tickets.retrieve(
-**remote_fields:** `typing.Optional[TicketsRetrieveRequestRemoteFields]` — Deprecated. Use show_enum_origins. +**remote_fields:** `typing.Optional[TimeOffRetrieveRequestRemoteFields]` — Deprecated. Use show_enum_origins.
@@ -35343,7 +35329,7 @@ client.ticketing.tickets.retrieve(
-**show_enum_origins:** `typing.Optional[TicketsRetrieveRequestShowEnumOrigins]` — A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter) +**show_enum_origins:** `typing.Optional[TimeOffRetrieveRequestShowEnumOrigins]` — A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter)
@@ -35363,7 +35349,7 @@ client.ticketing.tickets.retrieve(
-
client.ticketing.tickets.partial_update(...) +
client.hris.time_off.meta_post_retrieve()
@@ -35375,7 +35361,7 @@ client.ticketing.tickets.retrieve(
-Updates a `Ticket` object with the given `id`. +Returns metadata for `TimeOff` POSTs.
@@ -35391,16 +35377,12 @@ Updates a `Ticket` object with the given `id`. ```python from merge import Merge -from merge.resources.ticketing import PatchedTicketRequest client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.tickets.partial_update( - id="id", - model=PatchedTicketRequest(), -) +client.hris.time_off.meta_post_retrieve() ``` @@ -35416,38 +35398,6 @@ client.ticketing.tickets.partial_update(
-**id:** `str` - -
-
- -
-
- -**model:** `PatchedTicketRequest` - -
-
- -
-
- -**is_debug_mode:** `typing.Optional[bool]` — Whether to include debug fields (such as log file links) in the response. - -
-
- -
-
- -**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously. - -
-
- -
-
- **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -35460,7 +35410,8 @@ client.ticketing.tickets.partial_update(
-
client.ticketing.tickets.viewers_list(...) +## Hris TimeOffBalances +
client.hris.time_off_balances.list(...)
@@ -35472,7 +35423,7 @@ client.ticketing.tickets.partial_update(
-Returns a list of `Viewer` objects that point to a User id or Team id that is either an assignee or viewer on a `Ticket` with the given id. [Learn more.](https://help.merge.dev/en/articles/10333658-ticketing-access-control-list-acls) +Returns a list of `TimeOffBalance` objects.
@@ -35493,8 +35444,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.tickets.viewers_list( - ticket_id="ticket_id", +client.hris.time_off_balances.list( cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", ) @@ -35512,7 +35462,15 @@ client.ticketing.tickets.viewers_list(
-**ticket_id:** `str` +**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime. + +
+
+ +
+
+ +**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
@@ -35528,7 +35486,15 @@ client.ticketing.tickets.viewers_list(
-**expand:** `typing.Optional[TicketsViewersListRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. +**employee_id:** `typing.Optional[str]` — If provided, will only return time off balances for this employee. + +
+
+ +
+
+ +**expand:** `typing.Optional[typing.Literal["employee"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -35560,7 +35526,64 @@ client.ticketing.tickets.viewers_list(
-**page_size:** `typing.Optional[int]` — Number of results to return per page. +**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned. + +
+
+ +
+
+ +**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned. + +
+
+ +
+
+ +**page_size:** `typing.Optional[int]` — Number of results to return per page. + +
+
+ +
+
+ +**policy_type:** `typing.Optional[TimeOffBalancesListRequestPolicyType]` + +If provided, will only return TimeOffBalance with this policy type. Options: ('VACATION', 'SICK', 'PERSONAL', 'JURY_DUTY', 'VOLUNTEER', 'BEREAVEMENT') + +* `VACATION` - VACATION +* `SICK` - SICK +* `PERSONAL` - PERSONAL +* `JURY_DUTY` - JURY_DUTY +* `VOLUNTEER` - VOLUNTEER +* `BEREAVEMENT` - BEREAVEMENT + +
+
+ +
+
+ +**remote_fields:** `typing.Optional[typing.Literal["policy_type"]]` — Deprecated. Use show_enum_origins. + +
+
+ +
+
+ +**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object. + +
+
+ +
+
+ +**show_enum_origins:** `typing.Optional[typing.Literal["policy_type"]]` — A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter)
@@ -35580,7 +35603,7 @@ client.ticketing.tickets.viewers_list(
-
client.ticketing.tickets.meta_patch_retrieve(...) +
client.hris.time_off_balances.retrieve(...)
@@ -35592,7 +35615,7 @@ client.ticketing.tickets.viewers_list(
-Returns metadata for `Ticket` PATCHs. +Returns a `TimeOffBalance` object with the given `id`.
@@ -35613,7 +35636,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.tickets.meta_patch_retrieve( +client.hris.time_off_balances.retrieve( id="id", ) @@ -35639,6 +35662,46 @@ client.ticketing.tickets.meta_patch_retrieve(
+**expand:** `typing.Optional[typing.Literal["employee"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. + +
+
+ +
+
+ +**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. + +
+
+ +
+
+ +**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). + +
+
+ +
+
+ +**remote_fields:** `typing.Optional[typing.Literal["policy_type"]]` — Deprecated. Use show_enum_origins. + +
+
+ +
+
+ +**show_enum_origins:** `typing.Optional[typing.Literal["policy_type"]]` — A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter) + +
+
+ +
+
+ **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -35651,7 +35714,8 @@ client.ticketing.tickets.meta_patch_retrieve(
-
client.ticketing.tickets.meta_post_retrieve(...) +## Hris TimesheetEntries +
client.hris.timesheet_entries.list(...)
@@ -35663,7 +35727,7 @@ client.ticketing.tickets.meta_patch_retrieve(
-Returns metadata for `Ticket` POSTs. +Returns a list of `TimesheetEntry` objects.
@@ -35684,7 +35748,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.tickets.meta_post_retrieve() +client.hris.timesheet_entries.list( + cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +) ``` @@ -35700,7 +35766,7 @@ client.ticketing.tickets.meta_post_retrieve()
-**collection_id:** `typing.Optional[str]` — If provided, will only return tickets for this collection. +**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
@@ -35708,7 +35774,7 @@ client.ticketing.tickets.meta_post_retrieve()
-**ticket_type:** `typing.Optional[str]` — If provided, will only return tickets for this ticket type. +**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
@@ -35716,70 +35782,63 @@ client.ticketing.tickets.meta_post_retrieve()
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. +**cursor:** `typing.Optional[str]` — The pagination cursor value.
- -
+
+
+**employee_id:** `typing.Optional[str]` — If provided, will only return timesheet entries for this employee. +
-
-
client.ticketing.tickets.remote_field_classes_list(...)
-#### 📝 Description - -
-
+**ended_after:** `typing.Optional[dt.datetime]` — If provided, will only return timesheet entries ended after this datetime. + +
+
-Returns a list of `RemoteFieldClass` objects. -
-
+**ended_before:** `typing.Optional[dt.datetime]` — If provided, will only return timesheet entries ended before this datetime. +
-#### 🔌 Usage -
+**expand:** `typing.Optional[typing.Literal["employee"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. + +
+
+
-```python -from merge import Merge - -client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.ticketing.tickets.remote_field_classes_list( - cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", -) - -``` -
-
+**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/). + -#### ⚙️ Parameters -
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. + +
+
+
-**cursor:** `typing.Optional[str]` — The pagination cursor value. +**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -35787,7 +35846,7 @@ client.ticketing.tickets.remote_field_classes_list(
-**ids:** `typing.Optional[str]` — If provided, will only return remote field classes with the `ids` in this list +**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
@@ -35795,7 +35854,7 @@ client.ticketing.tickets.remote_field_classes_list(
-**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/). +**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
@@ -35803,7 +35862,7 @@ client.ticketing.tickets.remote_field_classes_list(
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. +**order_by:** `typing.Optional[TimesheetEntriesListRequestOrderBy]` — Overrides the default ordering for this endpoint. Possible values include: start_time, -start_time.
@@ -35811,7 +35870,7 @@ client.ticketing.tickets.remote_field_classes_list(
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). +**page_size:** `typing.Optional[int]` — Number of results to return per page.
@@ -35819,7 +35878,7 @@ client.ticketing.tickets.remote_field_classes_list(
-**is_common_model_field:** `typing.Optional[bool]` — If provided, will only return remote field classes with this is_common_model_field value +**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
@@ -35827,7 +35886,7 @@ client.ticketing.tickets.remote_field_classes_list(
-**is_custom:** `typing.Optional[bool]` — If provided, will only return remote fields classes with this is_custom value +**started_after:** `typing.Optional[dt.datetime]` — If provided, will only return timesheet entries started after this datetime.
@@ -35835,7 +35894,7 @@ client.ticketing.tickets.remote_field_classes_list(
-**page_size:** `typing.Optional[int]` — Number of results to return per page. +**started_before:** `typing.Optional[dt.datetime]` — If provided, will only return timesheet entries started before this datetime.
@@ -35855,8 +35914,7 @@ client.ticketing.tickets.remote_field_classes_list(
-## Ticketing Users -
client.ticketing.users.list(...) +
client.hris.timesheet_entries.create(...)
@@ -35868,7 +35926,7 @@ client.ticketing.tickets.remote_field_classes_list(
-Returns a list of `User` objects. +Creates a `TimesheetEntry` object with the given values.
@@ -35884,13 +35942,14 @@ Returns a list of `User` objects. ```python from merge import Merge +from merge.resources.hris import TimesheetEntryRequest client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.users.list( - cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", +client.hris.timesheet_entries.create( + model=TimesheetEntryRequest(), ) ``` @@ -35907,7 +35966,7 @@ client.ticketing.users.list(
-**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime. +**model:** `TimesheetEntryRequest`
@@ -35915,7 +35974,7 @@ client.ticketing.users.list(
-**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime. +**is_debug_mode:** `typing.Optional[bool]` — Whether to include debug fields (such as log file links) in the response.
@@ -35923,7 +35982,7 @@ client.ticketing.users.list(
-**cursor:** `typing.Optional[str]` — The pagination cursor value. +**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously.
@@ -35931,55 +35990,70 @@ client.ticketing.users.list(
-**email_address:** `typing.Optional[str]` — If provided, will only return users with emails equal to this value (case insensitive). +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+ +
-
-
-**expand:** `typing.Optional[UsersListRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. -
+
+
client.hris.timesheet_entries.retrieve(...)
-**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/). - -
-
+#### 📝 Description
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. - -
-
-
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). - +Returns a `TimesheetEntry` object with the given `id`. +
+
+#### 🔌 Usage +
-**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned. - +
+
+ +```python +from merge import Merge + +client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.hris.timesheet_entries.retrieve( + id="id", +) + +``` +
+
+#### ⚙️ Parameters +
-**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned. +
+
+ +**id:** `str`
@@ -35987,7 +36061,7 @@ client.ticketing.users.list(
-**page_size:** `typing.Optional[int]` — Number of results to return per page. +**expand:** `typing.Optional[typing.Literal["employee"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -35995,7 +36069,7 @@ client.ticketing.users.list(
-**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object. +**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -36003,7 +36077,7 @@ client.ticketing.users.list(
-**team:** `typing.Optional[str]` — If provided, will only return users matching in this team. +**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -36023,7 +36097,7 @@ client.ticketing.users.list(
-
client.ticketing.users.retrieve(...) +
client.hris.timesheet_entries.meta_post_retrieve()
@@ -36035,7 +36109,7 @@ client.ticketing.users.list(
-Returns a `User` object with the given `id`. +Returns metadata for `TimesheetEntry` POSTs.
@@ -36056,9 +36130,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.users.retrieve( - id="id", -) +client.hris.timesheet_entries.meta_post_retrieve() ``` @@ -36074,38 +36146,6 @@ client.ticketing.users.retrieve(
-**id:** `str` - -
-
- -
-
- -**expand:** `typing.Optional[UsersRetrieveRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. - -
-
- -
-
- -**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. - -
-
- -
-
- -**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). - -
-
- -
-
- **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -36118,8 +36158,8 @@ client.ticketing.users.retrieve(
-## Ticketing WebhookReceivers -
client.ticketing.webhook_receivers.list() +## Hris WebhookReceivers +
client.hris.webhook_receivers.list()
@@ -36152,7 +36192,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.webhook_receivers.list() +client.hris.webhook_receivers.list() ```
@@ -36180,7 +36220,7 @@ client.ticketing.webhook_receivers.list()
-
client.ticketing.webhook_receivers.create(...) +
client.hris.webhook_receivers.create(...)
@@ -36213,7 +36253,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.webhook_receivers.create( +client.hris.webhook_receivers.create( event="event", is_active=True, ) diff --git a/src/merge/client.py b/src/merge/client.py index f421282c..55d2ce06 100644 --- a/src/merge/client.py +++ b/src/merge/client.py @@ -89,8 +89,8 @@ def __init__( self._ats: typing.Optional[AtsClient] = None self._crm: typing.Optional[CrmClient] = None self._filestorage: typing.Optional[FilestorageClient] = None - self._hris: typing.Optional[HrisClient] = None self._ticketing: typing.Optional[TicketingClient] = None + self._hris: typing.Optional[HrisClient] = None self._accounting: typing.Optional[AccountingClient] = None @property @@ -117,14 +117,6 @@ def filestorage(self): self._filestorage = FilestorageClient(client_wrapper=self._client_wrapper) return self._filestorage - @property - def hris(self): - if self._hris is None: - from .resources.hris.client import HrisClient # noqa: E402 - - self._hris = HrisClient(client_wrapper=self._client_wrapper) - return self._hris - @property def ticketing(self): if self._ticketing is None: @@ -133,6 +125,14 @@ def ticketing(self): self._ticketing = TicketingClient(client_wrapper=self._client_wrapper) return self._ticketing + @property + def hris(self): + if self._hris is None: + from .resources.hris.client import HrisClient # noqa: E402 + + self._hris = HrisClient(client_wrapper=self._client_wrapper) + return self._hris + @property def accounting(self): if self._accounting is None: @@ -214,8 +214,8 @@ def __init__( self._ats: typing.Optional[AsyncAtsClient] = None self._crm: typing.Optional[AsyncCrmClient] = None self._filestorage: typing.Optional[AsyncFilestorageClient] = None - self._hris: typing.Optional[AsyncHrisClient] = None self._ticketing: typing.Optional[AsyncTicketingClient] = None + self._hris: typing.Optional[AsyncHrisClient] = None self._accounting: typing.Optional[AsyncAccountingClient] = None @property @@ -242,14 +242,6 @@ def filestorage(self): self._filestorage = AsyncFilestorageClient(client_wrapper=self._client_wrapper) return self._filestorage - @property - def hris(self): - if self._hris is None: - from .resources.hris.client import AsyncHrisClient # noqa: E402 - - self._hris = AsyncHrisClient(client_wrapper=self._client_wrapper) - return self._hris - @property def ticketing(self): if self._ticketing is None: @@ -258,6 +250,14 @@ def ticketing(self): self._ticketing = AsyncTicketingClient(client_wrapper=self._client_wrapper) return self._ticketing + @property + def hris(self): + if self._hris is None: + from .resources.hris.client import AsyncHrisClient # noqa: E402 + + self._hris = AsyncHrisClient(client_wrapper=self._client_wrapper) + return self._hris + @property def accounting(self): if self._accounting is None: diff --git a/src/merge/core/client_wrapper.py b/src/merge/core/client_wrapper.py index 6a57682e..79daf204 100644 --- a/src/merge/core/client_wrapper.py +++ b/src/merge/core/client_wrapper.py @@ -24,10 +24,10 @@ def __init__( def get_headers(self) -> typing.Dict[str, str]: headers: typing.Dict[str, str] = { - "User-Agent": "MergePythonClient/2.3.1", + "User-Agent": "MergePythonClient/2.3.2", "X-Fern-Language": "Python", "X-Fern-SDK-Name": "MergePythonClient", - "X-Fern-SDK-Version": "2.3.1", + "X-Fern-SDK-Version": "2.3.2", **(self.get_custom_headers() or {}), } if self._account_token is not None: diff --git a/src/merge/resources/accounting/client.py b/src/merge/resources/accounting/client.py index 3f8f0a08..fcf4a37c 100644 --- a/src/merge/resources/accounting/client.py +++ b/src/merge/resources/accounting/client.py @@ -174,6 +174,10 @@ def addresses(self): @property def async_passthrough(self): if self._async_passthrough is None: + from .resources.async_passthrough.client import ( + AsyncPassthroughClient as resources_accounting_resources_async_passthrough_client_AsyncPassthroughClient, # noqa: E402 + ) + self._async_passthrough = resources_accounting_resources_async_passthrough_client_AsyncPassthroughClient( client_wrapper=self._client_wrapper ) @@ -834,9 +838,13 @@ def linked_accounts(self): @property def passthrough(self): if self._passthrough is None: - from .resources.passthrough.client import AsyncPassthroughClient # noqa: E402 + from .resources.passthrough.client import ( + AsyncPassthroughClient as resources_accounting_resources_passthrough_client_AsyncPassthroughClient, # noqa: E402 + ) - self._passthrough = AsyncPassthroughClient(client_wrapper=self._client_wrapper) + self._passthrough = resources_accounting_resources_passthrough_client_AsyncPassthroughClient( + client_wrapper=self._client_wrapper + ) return self._passthrough @property diff --git a/src/merge/resources/ats/client.py b/src/merge/resources/ats/client.py index 0a094c9e..cb5551d7 100644 --- a/src/merge/resources/ats/client.py +++ b/src/merge/resources/ats/client.py @@ -135,6 +135,10 @@ def applications(self): @property def async_passthrough(self): if self._async_passthrough is None: + from .resources.async_passthrough.client import ( + AsyncPassthroughClient as resources_ats_resources_async_passthrough_client_AsyncPassthroughClient, # noqa: E402 + ) + self._async_passthrough = resources_ats_resources_async_passthrough_client_AsyncPassthroughClient( client_wrapper=self._client_wrapper ) @@ -609,9 +613,13 @@ def offices(self): @property def passthrough(self): if self._passthrough is None: - from .resources.passthrough.client import AsyncPassthroughClient # noqa: E402 + from .resources.passthrough.client import ( + AsyncPassthroughClient as resources_ats_resources_passthrough_client_AsyncPassthroughClient, # noqa: E402 + ) - self._passthrough = AsyncPassthroughClient(client_wrapper=self._client_wrapper) + self._passthrough = resources_ats_resources_passthrough_client_AsyncPassthroughClient( + client_wrapper=self._client_wrapper + ) return self._passthrough @property diff --git a/src/merge/resources/crm/client.py b/src/merge/resources/crm/client.py index b478650e..2a64aa0d 100644 --- a/src/merge/resources/crm/client.py +++ b/src/merge/resources/crm/client.py @@ -123,6 +123,10 @@ def accounts(self): @property def async_passthrough(self): if self._async_passthrough is None: + from .resources.async_passthrough.client import ( + AsyncPassthroughClient as resources_crm_resources_async_passthrough_client_AsyncPassthroughClient, # noqa: E402 + ) + self._async_passthrough = resources_crm_resources_async_passthrough_client_AsyncPassthroughClient( client_wrapper=self._client_wrapper ) @@ -579,9 +583,13 @@ def opportunities(self): @property def passthrough(self): if self._passthrough is None: - from .resources.passthrough.client import AsyncPassthroughClient # noqa: E402 + from .resources.passthrough.client import ( + AsyncPassthroughClient as resources_crm_resources_passthrough_client_AsyncPassthroughClient, # noqa: E402 + ) - self._passthrough = AsyncPassthroughClient(client_wrapper=self._client_wrapper) + self._passthrough = resources_crm_resources_passthrough_client_AsyncPassthroughClient( + client_wrapper=self._client_wrapper + ) return self._passthrough @property diff --git a/src/merge/resources/filestorage/client.py b/src/merge/resources/filestorage/client.py index 0c9f5a0f..3e280ec0 100644 --- a/src/merge/resources/filestorage/client.py +++ b/src/merge/resources/filestorage/client.py @@ -97,6 +97,10 @@ def account_token(self): @property def async_passthrough(self): if self._async_passthrough is None: + from .resources.async_passthrough.client import ( + AsyncPassthroughClient as resources_filestorage_resources_async_passthrough_client_AsyncPassthroughClient, # noqa: E402 + ) + self._async_passthrough = resources_filestorage_resources_async_passthrough_client_AsyncPassthroughClient( client_wrapper=self._client_wrapper ) @@ -426,9 +430,13 @@ def linked_accounts(self): @property def passthrough(self): if self._passthrough is None: - from .resources.passthrough.client import AsyncPassthroughClient # noqa: E402 + from .resources.passthrough.client import ( + AsyncPassthroughClient as resources_filestorage_resources_passthrough_client_AsyncPassthroughClient, # noqa: E402 + ) - self._passthrough = AsyncPassthroughClient(client_wrapper=self._client_wrapper) + self._passthrough = resources_filestorage_resources_passthrough_client_AsyncPassthroughClient( + client_wrapper=self._client_wrapper + ) return self._passthrough @property diff --git a/src/merge/resources/hris/client.py b/src/merge/resources/hris/client.py index c990cae3..9687055a 100644 --- a/src/merge/resources/hris/client.py +++ b/src/merge/resources/hris/client.py @@ -119,6 +119,10 @@ def account_token(self): @property def async_passthrough(self): if self._async_passthrough is None: + from .resources.async_passthrough.client import ( + AsyncPassthroughClient as resources_hris_resources_async_passthrough_client_AsyncPassthroughClient, # noqa: E402 + ) + self._async_passthrough = resources_hris_resources_async_passthrough_client_AsyncPassthroughClient( client_wrapper=self._client_wrapper ) @@ -593,9 +597,13 @@ def locations(self): @property def passthrough(self): if self._passthrough is None: - from .resources.passthrough.client import AsyncPassthroughClient # noqa: E402 + from .resources.passthrough.client import ( + AsyncPassthroughClient as resources_hris_resources_passthrough_client_AsyncPassthroughClient, # noqa: E402 + ) - self._passthrough = AsyncPassthroughClient(client_wrapper=self._client_wrapper) + self._passthrough = resources_hris_resources_passthrough_client_AsyncPassthroughClient( + client_wrapper=self._client_wrapper + ) return self._passthrough @property diff --git a/src/merge/resources/hris/resources/dependents/client.py b/src/merge/resources/hris/resources/dependents/client.py index bfd225ff..0cf75736 100644 --- a/src/merge/resources/hris/resources/dependents/client.py +++ b/src/merge/resources/hris/resources/dependents/client.py @@ -31,6 +31,7 @@ def list( created_after: typing.Optional[dt.datetime] = None, created_before: typing.Optional[dt.datetime] = None, cursor: typing.Optional[str] = None, + employee_id: typing.Optional[str] = None, include_deleted_data: typing.Optional[bool] = None, include_remote_data: typing.Optional[bool] = None, include_sensitive_fields: typing.Optional[bool] = None, @@ -55,6 +56,9 @@ def list( cursor : typing.Optional[str] The pagination cursor value. + employee_id : typing.Optional[str] + If provided, will only return dependents for this employee. + include_deleted_data : typing.Optional[bool] Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/). @@ -103,6 +107,7 @@ def list( created_after=created_after, created_before=created_before, cursor=cursor, + employee_id=employee_id, include_deleted_data=include_deleted_data, include_remote_data=include_remote_data, include_sensitive_fields=include_sensitive_fields, @@ -191,6 +196,7 @@ async def list( created_after: typing.Optional[dt.datetime] = None, created_before: typing.Optional[dt.datetime] = None, cursor: typing.Optional[str] = None, + employee_id: typing.Optional[str] = None, include_deleted_data: typing.Optional[bool] = None, include_remote_data: typing.Optional[bool] = None, include_sensitive_fields: typing.Optional[bool] = None, @@ -215,6 +221,9 @@ async def list( cursor : typing.Optional[str] The pagination cursor value. + employee_id : typing.Optional[str] + If provided, will only return dependents for this employee. + include_deleted_data : typing.Optional[bool] Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/). @@ -271,6 +280,7 @@ async def main() -> None: created_after=created_after, created_before=created_before, cursor=cursor, + employee_id=employee_id, include_deleted_data=include_deleted_data, include_remote_data=include_remote_data, include_sensitive_fields=include_sensitive_fields, diff --git a/src/merge/resources/hris/resources/dependents/raw_client.py b/src/merge/resources/hris/resources/dependents/raw_client.py index 428f463a..a7d16b86 100644 --- a/src/merge/resources/hris/resources/dependents/raw_client.py +++ b/src/merge/resources/hris/resources/dependents/raw_client.py @@ -25,6 +25,7 @@ def list( created_after: typing.Optional[dt.datetime] = None, created_before: typing.Optional[dt.datetime] = None, cursor: typing.Optional[str] = None, + employee_id: typing.Optional[str] = None, include_deleted_data: typing.Optional[bool] = None, include_remote_data: typing.Optional[bool] = None, include_sensitive_fields: typing.Optional[bool] = None, @@ -49,6 +50,9 @@ def list( cursor : typing.Optional[str] The pagination cursor value. + employee_id : typing.Optional[str] + If provided, will only return dependents for this employee. + include_deleted_data : typing.Optional[bool] Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/). @@ -88,6 +92,7 @@ def list( "created_after": serialize_datetime(created_after) if created_after is not None else None, "created_before": serialize_datetime(created_before) if created_before is not None else None, "cursor": cursor, + "employee_id": employee_id, "include_deleted_data": include_deleted_data, "include_remote_data": include_remote_data, "include_sensitive_fields": include_sensitive_fields, @@ -183,6 +188,7 @@ async def list( created_after: typing.Optional[dt.datetime] = None, created_before: typing.Optional[dt.datetime] = None, cursor: typing.Optional[str] = None, + employee_id: typing.Optional[str] = None, include_deleted_data: typing.Optional[bool] = None, include_remote_data: typing.Optional[bool] = None, include_sensitive_fields: typing.Optional[bool] = None, @@ -207,6 +213,9 @@ async def list( cursor : typing.Optional[str] The pagination cursor value. + employee_id : typing.Optional[str] + If provided, will only return dependents for this employee. + include_deleted_data : typing.Optional[bool] Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/). @@ -246,6 +255,7 @@ async def list( "created_after": serialize_datetime(created_after) if created_after is not None else None, "created_before": serialize_datetime(created_before) if created_before is not None else None, "cursor": cursor, + "employee_id": employee_id, "include_deleted_data": include_deleted_data, "include_remote_data": include_remote_data, "include_sensitive_fields": include_sensitive_fields, diff --git a/src/merge/resources/hris/resources/employees/client.py b/src/merge/resources/hris/resources/employees/client.py index f1f60ae1..f6ae2e76 100644 --- a/src/merge/resources/hris/resources/employees/client.py +++ b/src/merge/resources/hris/resources/employees/client.py @@ -47,6 +47,7 @@ def list( created_before: typing.Optional[dt.datetime] = None, cursor: typing.Optional[str] = None, display_full_name: typing.Optional[str] = None, + employee_number: typing.Optional[str] = None, employment_status: typing.Optional[EmployeesListRequestEmploymentStatus] = None, employment_type: typing.Optional[str] = None, expand: typing.Optional[EmployeesListRequestExpand] = None, @@ -97,6 +98,9 @@ def list( display_full_name : typing.Optional[str] If provided, will only return employees with this display name. + employee_number : typing.Optional[str] + If provided, will only return employees with this employee number. + employment_status : typing.Optional[EmployeesListRequestEmploymentStatus] If provided, will only return employees with this employment status. @@ -211,6 +215,7 @@ def list( created_before=created_before, cursor=cursor, display_full_name=display_full_name, + employee_number=employee_number, employment_status=employment_status, employment_type=employment_type, expand=expand, @@ -455,6 +460,7 @@ async def list( created_before: typing.Optional[dt.datetime] = None, cursor: typing.Optional[str] = None, display_full_name: typing.Optional[str] = None, + employee_number: typing.Optional[str] = None, employment_status: typing.Optional[EmployeesListRequestEmploymentStatus] = None, employment_type: typing.Optional[str] = None, expand: typing.Optional[EmployeesListRequestExpand] = None, @@ -505,6 +511,9 @@ async def list( display_full_name : typing.Optional[str] If provided, will only return employees with this display name. + employee_number : typing.Optional[str] + If provided, will only return employees with this employee number. + employment_status : typing.Optional[EmployeesListRequestEmploymentStatus] If provided, will only return employees with this employment status. @@ -627,6 +636,7 @@ async def main() -> None: created_before=created_before, cursor=cursor, display_full_name=display_full_name, + employee_number=employee_number, employment_status=employment_status, employment_type=employment_type, expand=expand, diff --git a/src/merge/resources/hris/resources/employees/raw_client.py b/src/merge/resources/hris/resources/employees/raw_client.py index a85ffeac..15a17bf7 100644 --- a/src/merge/resources/hris/resources/employees/raw_client.py +++ b/src/merge/resources/hris/resources/employees/raw_client.py @@ -41,6 +41,7 @@ def list( created_before: typing.Optional[dt.datetime] = None, cursor: typing.Optional[str] = None, display_full_name: typing.Optional[str] = None, + employee_number: typing.Optional[str] = None, employment_status: typing.Optional[EmployeesListRequestEmploymentStatus] = None, employment_type: typing.Optional[str] = None, expand: typing.Optional[EmployeesListRequestExpand] = None, @@ -91,6 +92,9 @@ def list( display_full_name : typing.Optional[str] If provided, will only return employees with this display name. + employee_number : typing.Optional[str] + If provided, will only return employees with this employee number. + employment_status : typing.Optional[EmployeesListRequestEmploymentStatus] If provided, will only return employees with this employment status. @@ -196,6 +200,7 @@ def list( "created_before": serialize_datetime(created_before) if created_before is not None else None, "cursor": cursor, "display_full_name": display_full_name, + "employee_number": employee_number, "employment_status": employment_status, "employment_type": employment_type, "expand": expand, @@ -471,6 +476,7 @@ async def list( created_before: typing.Optional[dt.datetime] = None, cursor: typing.Optional[str] = None, display_full_name: typing.Optional[str] = None, + employee_number: typing.Optional[str] = None, employment_status: typing.Optional[EmployeesListRequestEmploymentStatus] = None, employment_type: typing.Optional[str] = None, expand: typing.Optional[EmployeesListRequestExpand] = None, @@ -521,6 +527,9 @@ async def list( display_full_name : typing.Optional[str] If provided, will only return employees with this display name. + employee_number : typing.Optional[str] + If provided, will only return employees with this employee number. + employment_status : typing.Optional[EmployeesListRequestEmploymentStatus] If provided, will only return employees with this employment status. @@ -626,6 +635,7 @@ async def list( "created_before": serialize_datetime(created_before) if created_before is not None else None, "cursor": cursor, "display_full_name": display_full_name, + "employee_number": employee_number, "employment_status": employment_status, "employment_type": employment_type, "expand": expand, diff --git a/src/merge/resources/ticketing/client.py b/src/merge/resources/ticketing/client.py index feec2cee..38570948 100644 --- a/src/merge/resources/ticketing/client.py +++ b/src/merge/resources/ticketing/client.py @@ -117,6 +117,10 @@ def accounts(self): @property def async_passthrough(self): if self._async_passthrough is None: + from .resources.async_passthrough.client import ( + AsyncPassthroughClient as resources_ticketing_resources_async_passthrough_client_AsyncPassthroughClient, # noqa: E402 + ) + self._async_passthrough = resources_ticketing_resources_async_passthrough_client_AsyncPassthroughClient( client_wrapper=self._client_wrapper ) @@ -500,9 +504,13 @@ def linked_accounts(self): @property def passthrough(self): if self._passthrough is None: - from .resources.passthrough.client import AsyncPassthroughClient # noqa: E402 + from .resources.passthrough.client import ( + AsyncPassthroughClient as resources_ticketing_resources_passthrough_client_AsyncPassthroughClient, # noqa: E402 + ) - self._passthrough = AsyncPassthroughClient(client_wrapper=self._client_wrapper) + self._passthrough = resources_ticketing_resources_passthrough_client_AsyncPassthroughClient( + client_wrapper=self._client_wrapper + ) return self._passthrough @property diff --git a/src/merge/resources/ticketing/resources/collections/client.py b/src/merge/resources/ticketing/resources/collections/client.py index 74184c4e..11d7f2b2 100644 --- a/src/merge/resources/ticketing/resources/collections/client.py +++ b/src/merge/resources/ticketing/resources/collections/client.py @@ -40,6 +40,7 @@ def list( include_shell_data: typing.Optional[bool] = None, modified_after: typing.Optional[dt.datetime] = None, modified_before: typing.Optional[dt.datetime] = None, + name: typing.Optional[str] = None, page_size: typing.Optional[int] = None, parent_collection_id: typing.Optional[str] = None, remote_fields: typing.Optional[typing.Literal["collection_type"]] = None, @@ -82,6 +83,9 @@ def list( modified_before : typing.Optional[dt.datetime] If provided, only objects synced by Merge before this date time will be returned. + name : typing.Optional[str] + If provided, will only return collections with this name. + page_size : typing.Optional[int] Number of results to return per page. @@ -128,6 +132,7 @@ def list( include_shell_data=include_shell_data, modified_after=modified_after, modified_before=modified_before, + name=name, page_size=page_size, parent_collection_id=parent_collection_id, remote_fields=remote_fields, @@ -300,6 +305,7 @@ async def list( include_shell_data: typing.Optional[bool] = None, modified_after: typing.Optional[dt.datetime] = None, modified_before: typing.Optional[dt.datetime] = None, + name: typing.Optional[str] = None, page_size: typing.Optional[int] = None, parent_collection_id: typing.Optional[str] = None, remote_fields: typing.Optional[typing.Literal["collection_type"]] = None, @@ -342,6 +348,9 @@ async def list( modified_before : typing.Optional[dt.datetime] If provided, only objects synced by Merge before this date time will be returned. + name : typing.Optional[str] + If provided, will only return collections with this name. + page_size : typing.Optional[int] Number of results to return per page. @@ -396,6 +405,7 @@ async def main() -> None: include_shell_data=include_shell_data, modified_after=modified_after, modified_before=modified_before, + name=name, page_size=page_size, parent_collection_id=parent_collection_id, remote_fields=remote_fields, diff --git a/src/merge/resources/ticketing/resources/collections/raw_client.py b/src/merge/resources/ticketing/resources/collections/raw_client.py index b1aa44fc..c6e9c765 100644 --- a/src/merge/resources/ticketing/resources/collections/raw_client.py +++ b/src/merge/resources/ticketing/resources/collections/raw_client.py @@ -34,6 +34,7 @@ def list( include_shell_data: typing.Optional[bool] = None, modified_after: typing.Optional[dt.datetime] = None, modified_before: typing.Optional[dt.datetime] = None, + name: typing.Optional[str] = None, page_size: typing.Optional[int] = None, parent_collection_id: typing.Optional[str] = None, remote_fields: typing.Optional[typing.Literal["collection_type"]] = None, @@ -76,6 +77,9 @@ def list( modified_before : typing.Optional[dt.datetime] If provided, only objects synced by Merge before this date time will be returned. + name : typing.Optional[str] + If provided, will only return collections with this name. + page_size : typing.Optional[int] Number of results to return per page. @@ -113,6 +117,7 @@ def list( "include_shell_data": include_shell_data, "modified_after": serialize_datetime(modified_after) if modified_after is not None else None, "modified_before": serialize_datetime(modified_before) if modified_before is not None else None, + "name": name, "page_size": page_size, "parent_collection_id": parent_collection_id, "remote_fields": remote_fields, @@ -295,6 +300,7 @@ async def list( include_shell_data: typing.Optional[bool] = None, modified_after: typing.Optional[dt.datetime] = None, modified_before: typing.Optional[dt.datetime] = None, + name: typing.Optional[str] = None, page_size: typing.Optional[int] = None, parent_collection_id: typing.Optional[str] = None, remote_fields: typing.Optional[typing.Literal["collection_type"]] = None, @@ -337,6 +343,9 @@ async def list( modified_before : typing.Optional[dt.datetime] If provided, only objects synced by Merge before this date time will be returned. + name : typing.Optional[str] + If provided, will only return collections with this name. + page_size : typing.Optional[int] Number of results to return per page. @@ -374,6 +383,7 @@ async def list( "include_shell_data": include_shell_data, "modified_after": serialize_datetime(modified_after) if modified_after is not None else None, "modified_before": serialize_datetime(modified_before) if modified_before is not None else None, + "name": name, "page_size": page_size, "parent_collection_id": parent_collection_id, "remote_fields": remote_fields, diff --git a/src/merge/resources/ticketing/resources/contacts/client.py b/src/merge/resources/ticketing/resources/contacts/client.py index d36d28fc..2b29b8c0 100644 --- a/src/merge/resources/ticketing/resources/contacts/client.py +++ b/src/merge/resources/ticketing/resources/contacts/client.py @@ -37,6 +37,7 @@ def list( created_after: typing.Optional[dt.datetime] = None, created_before: typing.Optional[dt.datetime] = None, cursor: typing.Optional[str] = None, + email_address: typing.Optional[str] = None, expand: typing.Optional[typing.Literal["account"]] = None, include_deleted_data: typing.Optional[bool] = None, include_remote_data: typing.Optional[bool] = None, @@ -61,6 +62,9 @@ def list( cursor : typing.Optional[str] The pagination cursor value. + 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. @@ -109,6 +113,7 @@ def list( created_after=created_after, created_before=created_before, cursor=cursor, + email_address=email_address, expand=expand, include_deleted_data=include_deleted_data, include_remote_data=include_remote_data, @@ -271,6 +276,7 @@ async def list( created_after: typing.Optional[dt.datetime] = None, created_before: typing.Optional[dt.datetime] = None, cursor: typing.Optional[str] = None, + email_address: typing.Optional[str] = None, expand: typing.Optional[typing.Literal["account"]] = None, include_deleted_data: typing.Optional[bool] = None, include_remote_data: typing.Optional[bool] = None, @@ -295,6 +301,9 @@ async def list( cursor : typing.Optional[str] The pagination cursor value. + 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. @@ -351,6 +360,7 @@ async def main() -> None: created_after=created_after, created_before=created_before, cursor=cursor, + email_address=email_address, expand=expand, include_deleted_data=include_deleted_data, include_remote_data=include_remote_data, diff --git a/src/merge/resources/ticketing/resources/contacts/raw_client.py b/src/merge/resources/ticketing/resources/contacts/raw_client.py index f1a96051..2ba84bbb 100644 --- a/src/merge/resources/ticketing/resources/contacts/raw_client.py +++ b/src/merge/resources/ticketing/resources/contacts/raw_client.py @@ -31,6 +31,7 @@ def list( created_after: typing.Optional[dt.datetime] = None, created_before: typing.Optional[dt.datetime] = None, cursor: typing.Optional[str] = None, + email_address: typing.Optional[str] = None, expand: typing.Optional[typing.Literal["account"]] = None, include_deleted_data: typing.Optional[bool] = None, include_remote_data: typing.Optional[bool] = None, @@ -55,6 +56,9 @@ def list( cursor : typing.Optional[str] The pagination cursor value. + 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. @@ -94,6 +98,7 @@ def list( "created_after": serialize_datetime(created_after) if created_after is not None else None, "created_before": serialize_datetime(created_before) if created_before is not None else None, "cursor": cursor, + "email_address": email_address, "expand": expand, "include_deleted_data": include_deleted_data, "include_remote_data": include_remote_data, @@ -285,6 +290,7 @@ async def list( created_after: typing.Optional[dt.datetime] = None, created_before: typing.Optional[dt.datetime] = None, cursor: typing.Optional[str] = None, + email_address: typing.Optional[str] = None, expand: typing.Optional[typing.Literal["account"]] = None, include_deleted_data: typing.Optional[bool] = None, include_remote_data: typing.Optional[bool] = None, @@ -309,6 +315,9 @@ async def list( cursor : typing.Optional[str] The pagination cursor value. + 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. @@ -348,6 +357,7 @@ async def list( "created_after": serialize_datetime(created_after) if created_after is not None else None, "created_before": serialize_datetime(created_before) if created_before is not None else None, "cursor": cursor, + "email_address": email_address, "expand": expand, "include_deleted_data": include_deleted_data, "include_remote_data": include_remote_data, diff --git a/src/merge/resources/ticketing/resources/tickets/client.py b/src/merge/resources/ticketing/resources/tickets/client.py index f942dea4..fe5cccad 100644 --- a/src/merge/resources/ticketing/resources/tickets/client.py +++ b/src/merge/resources/ticketing/resources/tickets/client.py @@ -64,6 +64,7 @@ def list( include_shell_data: typing.Optional[bool] = None, modified_after: typing.Optional[dt.datetime] = None, modified_before: typing.Optional[dt.datetime] = None, + name: typing.Optional[str] = None, page_size: typing.Optional[int] = None, parent_ticket_id: typing.Optional[str] = None, priority: typing.Optional[TicketsListRequestPriority] = None, @@ -142,6 +143,9 @@ def list( modified_before : typing.Optional[dt.datetime] If provided, only objects synced by Merge before this date time will be returned. + name : typing.Optional[str] + If provided, will only return tickets with this name. + page_size : typing.Optional[int] Number of results to return per page. @@ -229,6 +233,7 @@ def list( include_shell_data=include_shell_data, modified_after=modified_after, modified_before=modified_before, + name=name, page_size=page_size, parent_ticket_id=parent_ticket_id, priority=priority, @@ -669,6 +674,7 @@ async def list( include_shell_data: typing.Optional[bool] = None, modified_after: typing.Optional[dt.datetime] = None, modified_before: typing.Optional[dt.datetime] = None, + name: typing.Optional[str] = None, page_size: typing.Optional[int] = None, parent_ticket_id: typing.Optional[str] = None, priority: typing.Optional[TicketsListRequestPriority] = None, @@ -747,6 +753,9 @@ async def list( modified_before : typing.Optional[dt.datetime] If provided, only objects synced by Merge before this date time will be returned. + name : typing.Optional[str] + If provided, will only return tickets with this name. + page_size : typing.Optional[int] Number of results to return per page. @@ -842,6 +851,7 @@ async def main() -> None: include_shell_data=include_shell_data, modified_after=modified_after, modified_before=modified_before, + name=name, page_size=page_size, parent_ticket_id=parent_ticket_id, priority=priority, diff --git a/src/merge/resources/ticketing/resources/tickets/raw_client.py b/src/merge/resources/ticketing/resources/tickets/raw_client.py index 5aac4f88..27ebad8e 100644 --- a/src/merge/resources/ticketing/resources/tickets/raw_client.py +++ b/src/merge/resources/ticketing/resources/tickets/raw_client.py @@ -58,6 +58,7 @@ def list( include_shell_data: typing.Optional[bool] = None, modified_after: typing.Optional[dt.datetime] = None, modified_before: typing.Optional[dt.datetime] = None, + name: typing.Optional[str] = None, page_size: typing.Optional[int] = None, parent_ticket_id: typing.Optional[str] = None, priority: typing.Optional[TicketsListRequestPriority] = None, @@ -136,6 +137,9 @@ def list( modified_before : typing.Optional[dt.datetime] If provided, only objects synced by Merge before this date time will be returned. + name : typing.Optional[str] + If provided, will only return tickets with this name. + page_size : typing.Optional[int] Number of results to return per page. @@ -214,6 +218,7 @@ def list( "include_shell_data": include_shell_data, "modified_after": serialize_datetime(modified_after) if modified_after is not None else None, "modified_before": serialize_datetime(modified_before) if modified_before is not None else None, + "name": name, "page_size": page_size, "parent_ticket_id": parent_ticket_id, "priority": priority, @@ -718,6 +723,7 @@ async def list( include_shell_data: typing.Optional[bool] = None, modified_after: typing.Optional[dt.datetime] = None, modified_before: typing.Optional[dt.datetime] = None, + name: typing.Optional[str] = None, page_size: typing.Optional[int] = None, parent_ticket_id: typing.Optional[str] = None, priority: typing.Optional[TicketsListRequestPriority] = None, @@ -796,6 +802,9 @@ async def list( modified_before : typing.Optional[dt.datetime] If provided, only objects synced by Merge before this date time will be returned. + name : typing.Optional[str] + If provided, will only return tickets with this name. + page_size : typing.Optional[int] Number of results to return per page. @@ -874,6 +883,7 @@ async def list( "include_shell_data": include_shell_data, "modified_after": serialize_datetime(modified_after) if modified_after is not None else None, "modified_before": serialize_datetime(modified_before) if modified_before is not None else None, + "name": name, "page_size": page_size, "parent_ticket_id": parent_ticket_id, "priority": priority, diff --git a/src/merge/resources/ticketing/types/collection.py b/src/merge/resources/ticketing/types/collection.py index e6a84024..b74584a0 100644 --- a/src/merge/resources/ticketing/types/collection.py +++ b/src/merge/resources/ticketing/types/collection.py @@ -72,6 +72,21 @@ class Collection(UncheckedBaseModel): The parent collection for this collection. """ + collection_url: typing.Optional[str] = pydantic.Field(default=None) + """ + The 3rd party url of the Collection. + """ + + remote_created_at: typing.Optional[dt.datetime] = pydantic.Field(default=None) + """ + When the third party's collection was created. + """ + + remote_updated_at: typing.Optional[dt.datetime] = pydantic.Field(default=None) + """ + When the third party's collection was updated. + """ + 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/). diff --git a/tests/utils/test_query_encoding.py b/tests/utils/test_query_encoding.py index 07b0704c..3a289ae5 100644 --- a/tests/utils/test_query_encoding.py +++ b/tests/utils/test_query_encoding.py @@ -1,6 +1,5 @@ # This file was auto-generated by Fern from our API Definition. - from merge.core.query_encoder import encode_query