diff --git a/README.md b/README.md index c7883f36..2667301c 100644 --- a/README.md +++ b/README.md @@ -19,6 +19,24 @@ pip install MergePythonClient A full reference for this library is available [here](https://github.com/merge-api/merge-python-client/blob/HEAD/./reference.md). +## Usage + +Instantiate and use the client with the following: + +```python +from merge import Merge +from merge.resources.ats import ActivityRequest + +client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.ats.activities.create( + model=ActivityRequest(), + remote_user_id="remote_user_id", +) +``` + ## Instantiation ```python @@ -42,24 +60,6 @@ client.ats. # APIs specific to the ATS Category client.hris. # APIs specific to the HRIS Category ``` -## Usage - -Instantiate and use the client with the following: - -```python -from merge import Merge -from merge.resources.ats import ActivityRequest - -client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.ats.activities.create( - model=ActivityRequest(), - remote_user_id="remote_user_id", -) -``` - ## Async Client The SDK also exports an `async` client so that you can make non-blocking calls to our API. @@ -101,49 +101,6 @@ except ApiError as e: print(e.body) ``` -## File Download - -```python -import merge -from merge.client import Merge - -merge_client = Merge( - api_key="", - account_token="") - -files = merge_client.filestorage.files.list(name="").results - -id = files[0].id -name = files[0].name -local_filename = f"/{name}" - -response = merge_client.filestorage.files.download_retrieve(id=id) -with open(local_filename, "wb") as f: - for chunk in response: - f.write(chunk) -``` - -## Pagination - -The SDK may return paginated results. Endpoints that return paginated results will -include a `next` and `prev` property on the response. To get the next page, you can -pass in the value of `next` to the cursor property on the request. Similarly, to -get the previous page, you can pass in the value of `prev` to the cursor property on -the request. - -Below is an example of iterating over all pages: -```python - -# response contains the first page -response = merge_client.hris.employees.list(created_after="2030-01-01") - -# if there is a next page, load it by passing `next` to the cursor argument -while response.next is not None: - response = hris_client.employees.list( - cursor=response.next, - created_after="2030-01-01") -``` - ## Advanced ### Access Raw Response Data @@ -229,3 +186,46 @@ a proof of concept, but know that we will not be able to merge it as-is. We sugg an issue first to discuss with us! On the other hand, contributions to the README are always very welcome! +## File Download + +```python +import merge +from merge.client import Merge + +merge_client = Merge( + api_key="", + account_token="") + +files = merge_client.filestorage.files.list(name="").results + +id = files[0].id +name = files[0].name +local_filename = f"/{name}" + +response = merge_client.filestorage.files.download_retrieve(id=id) +with open(local_filename, "wb") as f: + for chunk in response: + f.write(chunk) +``` + +## Pagination + +The SDK may return paginated results. Endpoints that return paginated results will +include a `next` and `prev` property on the response. To get the next page, you can +pass in the value of `next` to the cursor property on the request. Similarly, to +get the previous page, you can pass in the value of `prev` to the cursor property on +the request. + +Below is an example of iterating over all pages: +```python + +# response contains the first page +response = merge_client.hris.employees.list(created_after="2030-01-01") + +# if there is a next page, load it by passing `next` to the cursor argument +while response.next is not None: + response = hris_client.employees.list( + cursor=response.next, + created_after="2030-01-01") +``` + diff --git a/poetry.lock b/poetry.lock index c8e7e14a..3ddef646 100644 --- a/poetry.lock +++ b/poetry.lock @@ -38,13 +38,13 @@ trio = ["trio (>=0.26.1)"] [[package]] name = "certifi" -version = "2025.4.26" +version = "2025.6.15" description = "Python package for providing Mozilla's CA Bundle." optional = false -python-versions = ">=3.6" +python-versions = ">=3.7" files = [ - {file = "certifi-2025.4.26-py3-none-any.whl", hash = "sha256:30350364dfe371162649852c63336a15c70c6510c2ad5015b21c2345311805f3"}, - {file = "certifi-2025.4.26.tar.gz", hash = "sha256:0a816057ea3cdefcef70270d2c515e4506bbc954f417fa5ade2021213bb8f0c6"}, + {file = "certifi-2025.6.15-py3-none-any.whl", hash = "sha256:2e0c7ce7cb5d8f8634ca55d2ba7e6ec2689a2fd6537d8dec1296a477a4910057"}, + {file = "certifi-2025.6.15.tar.gz", hash = "sha256:d747aa5a8b9bbbb1bb8c22bb13e22bd1f18e9796defa16bab421f7f7a317323b"}, ] [[package]] @@ -547,4 +547,4 @@ files = [ [metadata] lock-version = "2.0" python-versions = "^3.8" -content-hash = "9c462a453d491f6c13e77f216c114935f5785c9e0c2288839fb0862ea2551003" +content-hash = "8551b871abee465e23fb0966d51f2c155fd257b55bdcb0c02d095de19f92f358" diff --git a/pyproject.toml b/pyproject.toml index 3e629282..5a5e5da9 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -3,7 +3,7 @@ name = "MergePythonClient" [tool.poetry] name = "MergePythonClient" -version = "2.0.0" +version = "2.1.0" description = "" readme = "README.md" authors = [] @@ -37,7 +37,7 @@ Repository = 'https://github.com/merge-api/merge-python-client' python = "^3.8" httpx = ">=0.21.2" pydantic = ">= 1.9.2" -pydantic-core = "^2.18.2" +pydantic-core = ">=2.18.2" typing_extensions = ">= 4.0.0" [tool.poetry.group.dev.dependencies] diff --git a/reference.md b/reference.md index 41b3c4f8..493d037f 100644 --- a/reference.md +++ b/reference.md @@ -7893,8 +7893,8 @@ client.ats.webhook_receivers.create( -## Filestorage AccountDetails -
client.filestorage.account_details.retrieve() +## Crm AccountDetails +
client.crm.account_details.retrieve()
@@ -7927,7 +7927,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.filestorage.account_details.retrieve() +client.crm.account_details.retrieve() ```
@@ -7955,8 +7955,8 @@ client.filestorage.account_details.retrieve()
-## Filestorage AccountToken -
client.filestorage.account_token.retrieve(...) +## Crm AccountToken +
client.crm.account_token.retrieve(...)
@@ -7989,7 +7989,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.filestorage.account_token.retrieve( +client.crm.account_token.retrieve( public_token="public_token", ) @@ -8027,8 +8027,8 @@ client.filestorage.account_token.retrieve(
-## Filestorage AsyncPassthrough -
client.filestorage.async_passthrough.create(...) +## Crm Accounts +
client.crm.accounts.list(...)
@@ -8040,7 +8040,7 @@ client.filestorage.account_token.retrieve(
-Asynchronously pull data from an endpoint not currently supported by Merge. +Returns a list of `Account` objects.
@@ -8056,18 +8056,12 @@ Asynchronously pull data from an endpoint not currently supported by Merge. ```python from merge import Merge -from merge.resources.filestorage import DataPassthroughRequest, MethodEnum client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.filestorage.async_passthrough.create( - request=DataPassthroughRequest( - method=MethodEnum.GET, - path="/scooters", - ), -) +client.crm.accounts.list() ``` @@ -8083,7 +8077,111 @@ client.filestorage.async_passthrough.create(
-**request:** `DataPassthroughRequest` +**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime. + +
+
+ +
+
+ +**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime. + +
+
+ +
+
+ +**cursor:** `typing.Optional[str]` — The pagination cursor value. + +
+
+ +
+
+ +**expand:** `typing.Optional[typing.Literal["owner"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. + +
+
+ +
+
+ +**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/). + +
+
+ +
+
+ +**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. + +
+
+ +
+
+ +**include_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format. + +
+
+ +
+
+ +**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). + +
+
+ +
+
+ +**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned. + +
+
+ +
+
+ +**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned. + +
+
+ +
+
+ +**name:** `typing.Optional[str]` — If provided, will only return accounts with this name. + +
+
+ +
+
+ +**owner_id:** `typing.Optional[str]` — If provided, will only return accounts with this owner. + +
+
+ +
+
+ +**page_size:** `typing.Optional[int]` — Number of results to return per page. + +
+
+ +
+
+ +**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
@@ -8103,7 +8201,7 @@ client.filestorage.async_passthrough.create(
-
client.filestorage.async_passthrough.retrieve(...) +
client.crm.accounts.create(...)
@@ -8115,7 +8213,7 @@ client.filestorage.async_passthrough.create(
-Retrieves data from earlier async-passthrough POST request +Creates an `Account` object with the given values.
@@ -8131,13 +8229,14 @@ Retrieves data from earlier async-passthrough POST request ```python from merge import Merge +from merge.resources.crm import AccountRequest client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.filestorage.async_passthrough.retrieve( - async_passthrough_receipt_id="async_passthrough_receipt_id", +client.crm.accounts.create( + model=AccountRequest(), ) ``` @@ -8154,7 +8253,23 @@ client.filestorage.async_passthrough.retrieve(
-**async_passthrough_receipt_id:** `str` +**model:** `AccountRequest` + +
+
+ +
+
+ +**is_debug_mode:** `typing.Optional[bool]` — Whether to include debug fields (such as log file links) in the response. + +
+
+ +
+
+ +**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously.
@@ -8174,8 +8289,7 @@ client.filestorage.async_passthrough.retrieve(
-## Filestorage AuditTrail -
client.filestorage.audit_trail.list(...) +
client.crm.accounts.retrieve(...)
@@ -8187,7 +8301,7 @@ client.filestorage.async_passthrough.retrieve(
-Gets a list of audit trail events. +Returns an `Account` object with the given `id`.
@@ -8208,7 +8322,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.filestorage.audit_trail.list() +client.crm.accounts.retrieve( + id="id", +) ``` @@ -8224,15 +8340,7 @@ client.filestorage.audit_trail.list()
-**cursor:** `typing.Optional[str]` — The pagination cursor value. - -
-
- -
-
- -**end_date:** `typing.Optional[str]` — If included, will only include audit trail events that occurred before this time +**id:** `str`
@@ -8240,7 +8348,7 @@ client.filestorage.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` +**expand:** `typing.Optional[typing.Literal["owner"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -8248,7 +8356,7 @@ client.filestorage.audit_trail.list()
-**page_size:** `typing.Optional[int]` — Number of results to return per page. +**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -8256,7 +8364,7 @@ client.filestorage.audit_trail.list()
-**start_date:** `typing.Optional[str]` — If included, will only include audit trail events that occurred after this time +**include_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.
@@ -8264,7 +8372,7 @@ client.filestorage.audit_trail.list()
-**user_email:** `typing.Optional[str]` — If provided, this will return events associated with the specified user email. Please note that the email address reflects the user's email at the time of the event, and may not be their current email. +**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -8284,8 +8392,7 @@ client.filestorage.audit_trail.list()
-## Filestorage AvailableActions -
client.filestorage.available_actions.retrieve() +
client.crm.accounts.partial_update(...)
@@ -8297,7 +8404,7 @@ client.filestorage.audit_trail.list()
-Returns a list of models and actions available for an account. +Updates an `Account` object with the given `id`.
@@ -8313,12 +8420,16 @@ Returns a list of models and actions available for an account. ```python from merge import Merge +from merge.resources.crm import PatchedAccountRequest client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.filestorage.available_actions.retrieve() +client.crm.accounts.partial_update( + id="id", + model=PatchedAccountRequest(), +) ``` @@ -8334,6 +8445,38 @@ client.filestorage.available_actions.retrieve()
+**id:** `str` + +
+
+ +
+
+ +**model:** `PatchedAccountRequest` + +
+
+ +
+
+ +**is_debug_mode:** `typing.Optional[bool]` — Whether to include debug fields (such as log file links) in the response. + +
+
+ +
+
+ +**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously. + +
+
+ +
+
+ **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -8346,8 +8489,7 @@ client.filestorage.available_actions.retrieve()
-## Filestorage Scopes -
client.filestorage.scopes.default_scopes_retrieve() +
client.crm.accounts.meta_patch_retrieve(...)
@@ -8359,7 +8501,7 @@ client.filestorage.available_actions.retrieve()
-Get the default permissions for Merge Common Models and fields across all Linked Accounts of a given category. [Learn more](https://help.merge.dev/en/articles/5950052-common-model-and-field-scopes). +Returns metadata for `CRMAccount` PATCHs.
@@ -8380,7 +8522,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.filestorage.scopes.default_scopes_retrieve() +client.crm.accounts.meta_patch_retrieve( + id="id", +) ``` @@ -8396,6 +8540,14 @@ client.filestorage.scopes.default_scopes_retrieve()
+**id:** `str` + +
+
+ +
+
+ **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -8408,7 +8560,7 @@ client.filestorage.scopes.default_scopes_retrieve()
-
client.filestorage.scopes.linked_account_scopes_retrieve() +
client.crm.accounts.meta_post_retrieve()
@@ -8420,7 +8572,7 @@ client.filestorage.scopes.default_scopes_retrieve()
-Get all available permissions for Merge Common Models and fields for a single Linked Account. [Learn more](https://help.merge.dev/en/articles/5950052-common-model-and-field-scopes). +Returns metadata for `CRMAccount` POSTs.
@@ -8441,7 +8593,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.filestorage.scopes.linked_account_scopes_retrieve() +client.crm.accounts.meta_post_retrieve() ``` @@ -8469,7 +8621,7 @@ client.filestorage.scopes.linked_account_scopes_retrieve()
-
client.filestorage.scopes.linked_account_scopes_create(...) +
client.crm.accounts.remote_field_classes_list(...)
@@ -8481,7 +8633,7 @@ client.filestorage.scopes.linked_account_scopes_retrieve()
-Update permissions for any Common Model or field for a single Linked Account. Any Scopes not set in this POST request will inherit the default Scopes. [Learn more](https://help.merge.dev/en/articles/5950052-common-model-and-field-scopes) +Returns a list of `RemoteFieldClass` objects.
@@ -8497,43 +8649,12 @@ Update permissions for any Common Model or field for a single Linked Account. An ```python from merge import Merge -from merge.resources.filestorage import ( - FieldPermissionDeserializerRequest, - IndividualCommonModelScopeDeserializerRequest, - ModelPermissionDeserializerRequest, -) client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.filestorage.scopes.linked_account_scopes_create( - common_models=[ - IndividualCommonModelScopeDeserializerRequest( - model_name="Employee", - model_permissions={ - "READ": ModelPermissionDeserializerRequest( - is_enabled=True, - ), - "WRITE": ModelPermissionDeserializerRequest( - is_enabled=False, - ), - }, - field_permissions=FieldPermissionDeserializerRequest( - enabled_fields=["avatar", "home_location"], - disabled_fields=["work_location"], - ), - ), - IndividualCommonModelScopeDeserializerRequest( - model_name="Benefit", - model_permissions={ - "WRITE": ModelPermissionDeserializerRequest( - is_enabled=False, - ) - }, - ), - ], -) +client.crm.accounts.remote_field_classes_list() ``` @@ -8549,7 +8670,7 @@ client.filestorage.scopes.linked_account_scopes_create(
-**common_models:** `typing.Sequence[IndividualCommonModelScopeDeserializerRequest]` — The common models you want to update the scopes for +**cursor:** `typing.Optional[str]` — The pagination cursor value.
@@ -8557,65 +8678,59 @@ client.filestorage.scopes.linked_account_scopes_create(
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. +**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
- -
+
+
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. +
-
-## Filestorage DeleteAccount -
client.filestorage.delete_account.delete()
-#### 📝 Description - -
-
+**include_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format. + +
+
-Delete a linked account. -
-
+**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). +
-#### 🔌 Usage -
+**is_common_model_field:** `typing.Optional[bool]` — If provided, will only return remote field classes with this is_common_model_field value + +
+
+
-```python -from merge import Merge - -client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.filestorage.delete_account.delete() - -``` -
-
+**is_custom:** `typing.Optional[bool]` — If provided, will only return remote fields classes with this is_custom value + -#### ⚙️ Parameters -
+**page_size:** `typing.Optional[int]` — Number of results to return per page. + +
+
+
@@ -8631,8 +8746,8 @@ client.filestorage.delete_account.delete()
-## Filestorage Drives -
client.filestorage.drives.list(...) +## Crm AsyncPassthrough +
client.crm.async_passthrough.create(...)
@@ -8644,7 +8759,7 @@ client.filestorage.delete_account.delete()
-Returns a list of `Drive` objects. +Asynchronously pull data from an endpoint not currently supported by Merge.
@@ -8660,12 +8775,18 @@ Returns a list of `Drive` objects. ```python from merge import Merge +from merge.resources.crm import DataPassthroughRequest, MethodEnum client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.filestorage.drives.list() +client.crm.async_passthrough.create( + request=DataPassthroughRequest( + method=MethodEnum.GET, + path="/scooters", + ), +) ``` @@ -8681,7 +8802,7 @@ client.filestorage.drives.list()
-**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime. +**request:** `DataPassthroughRequest`
@@ -8689,79 +8810,70 @@ client.filestorage.drives.list()
-**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime. +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
- -
-
- -**cursor:** `typing.Optional[str]` — The pagination cursor value. -
-
-
-**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/). -
+
+
client.crm.async_passthrough.retrieve(...)
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. - -
-
+#### 📝 Description
-**include_shell_data:** `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. - +Retrieves data from earlier async-passthrough POST request +
+
+#### 🔌 Usage +
-**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned. - -
-
-
-**name:** `typing.Optional[str]` — If provided, will only return drives with this name. This performs an exact match. - +```python +from merge import Merge + +client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.crm.async_passthrough.retrieve( + async_passthrough_receipt_id="async_passthrough_receipt_id", +) + +``` +
+
+#### ⚙️ Parameters +
-**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. +**async_passthrough_receipt_id:** `str`
@@ -8781,7 +8893,8 @@ client.filestorage.drives.list()
-
client.filestorage.drives.retrieve(...) +## Crm AuditTrail +
client.crm.audit_trail.list(...)
@@ -8793,7 +8906,7 @@ client.filestorage.drives.list()
-Returns a `Drive` object with the given `id`. +Gets a list of audit trail events.
@@ -8814,9 +8927,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.filestorage.drives.retrieve( - id="id", -) +client.crm.audit_trail.list() ``` @@ -8832,7 +8943,7 @@ client.filestorage.drives.retrieve(
-**id:** `str` +**cursor:** `typing.Optional[str]` — The pagination cursor value.
@@ -8840,7 +8951,7 @@ client.filestorage.drives.retrieve(
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. +**end_date:** `typing.Optional[str]` — If included, will only include audit trail events that occurred before this time
@@ -8848,7 +8959,31 @@ client.filestorage.drives.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). +**event_type:** `typing.Optional[str]` — If included, will only include events with the given event type. Possible values include: `CREATED_REMOTE_PRODUCTION_API_KEY`, `DELETED_REMOTE_PRODUCTION_API_KEY`, `CREATED_TEST_API_KEY`, `DELETED_TEST_API_KEY`, `REGENERATED_PRODUCTION_API_KEY`, `REGENERATED_WEBHOOK_SIGNATURE`, `INVITED_USER`, `TWO_FACTOR_AUTH_ENABLED`, `TWO_FACTOR_AUTH_DISABLED`, `DELETED_LINKED_ACCOUNT`, `DELETED_ALL_COMMON_MODELS_FOR_LINKED_ACCOUNT`, `CREATED_DESTINATION`, `DELETED_DESTINATION`, `CHANGED_DESTINATION`, `CHANGED_SCOPES`, `CHANGED_PERSONAL_INFORMATION`, `CHANGED_ORGANIZATION_SETTINGS`, `ENABLED_INTEGRATION`, `DISABLED_INTEGRATION`, `ENABLED_CATEGORY`, `DISABLED_CATEGORY`, `CHANGED_PASSWORD`, `RESET_PASSWORD`, `ENABLED_REDACT_UNMAPPED_DATA_FOR_ORGANIZATION`, `ENABLED_REDACT_UNMAPPED_DATA_FOR_LINKED_ACCOUNT`, `DISABLED_REDACT_UNMAPPED_DATA_FOR_ORGANIZATION`, `DISABLED_REDACT_UNMAPPED_DATA_FOR_LINKED_ACCOUNT`, `CREATED_INTEGRATION_WIDE_FIELD_MAPPING`, `CREATED_LINKED_ACCOUNT_FIELD_MAPPING`, `CHANGED_INTEGRATION_WIDE_FIELD_MAPPING`, `CHANGED_LINKED_ACCOUNT_FIELD_MAPPING`, `DELETED_INTEGRATION_WIDE_FIELD_MAPPING`, `DELETED_LINKED_ACCOUNT_FIELD_MAPPING`, `CREATED_LINKED_ACCOUNT_COMMON_MODEL_OVERRIDE`, `CHANGED_LINKED_ACCOUNT_COMMON_MODEL_OVERRIDE`, `DELETED_LINKED_ACCOUNT_COMMON_MODEL_OVERRIDE`, `FORCED_LINKED_ACCOUNT_RESYNC`, `MUTED_ISSUE`, `GENERATED_MAGIC_LINK`, `ENABLED_MERGE_WEBHOOK`, `DISABLED_MERGE_WEBHOOK`, `MERGE_WEBHOOK_TARGET_CHANGED`, `END_USER_CREDENTIALS_ACCESSED` + +
+
+ +
+
+ +**page_size:** `typing.Optional[int]` — Number of results to return per page. + +
+
+ +
+
+ +**start_date:** `typing.Optional[str]` — If included, will only include audit trail events that occurred after this time + +
+
+ +
+
+ +**user_email:** `typing.Optional[str]` — If provided, this will return events associated with the specified user email. Please note that the email address reflects the user's email at the time of the event, and may not be their current email.
@@ -8868,8 +9003,8 @@ client.filestorage.drives.retrieve(
-## Filestorage FieldMapping -
client.filestorage.field_mapping.field_mappings_retrieve(...) +## Crm AvailableActions +
client.crm.available_actions.retrieve()
@@ -8881,7 +9016,7 @@ client.filestorage.drives.retrieve(
-Get all Field Mappings for this Linked Account. Field Mappings are mappings between third-party Remote Fields and user defined Merge fields. [Learn more](https://docs.merge.dev/supplemental-data/field-mappings/overview/). +Returns a list of models and actions available for an account.
@@ -8902,7 +9037,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.filestorage.field_mapping.field_mappings_retrieve() +client.crm.available_actions.retrieve() ``` @@ -8918,14 +9053,6 @@ client.filestorage.field_mapping.field_mappings_retrieve()
-**exclude_remote_field_metadata:** `typing.Optional[bool]` — If `true`, remote fields metadata is excluded from each field mapping instance (i.e. `remote_fields.remote_key_name` and `remote_fields.schema` will be null). This will increase the speed of the request since these fields require some calculations. - -
-
- -
-
- **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -8938,7 +9065,8 @@ client.filestorage.field_mapping.field_mappings_retrieve()
-
client.filestorage.field_mapping.field_mappings_create(...) +## Crm Contacts +
client.crm.contacts.list(...)
@@ -8950,7 +9078,7 @@ client.filestorage.field_mapping.field_mappings_retrieve()
-Create new Field Mappings that will be available after the next scheduled sync. This will cause the next sync for this Linked Account to sync **ALL** data from start. +Returns a list of `Contact` objects.
@@ -8971,14 +9099,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.filestorage.field_mapping.field_mappings_create( - target_field_name="example_target_field_name", - target_field_description="this is a example description of the target field", - remote_field_traversal_path=["example_remote_field"], - remote_method="GET", - remote_url_path="/example-url-path", - common_model_name="ExampleCommonModel", -) +client.crm.contacts.list() ``` @@ -8994,7 +9115,7 @@ client.filestorage.field_mapping.field_mappings_create(
-**target_field_name:** `str` — The name of the target field you want this remote field to map to. +**account_id:** `typing.Optional[str]` — If provided, will only return contacts with this account.
@@ -9002,7 +9123,7 @@ client.filestorage.field_mapping.field_mappings_create(
-**target_field_description:** `str` — The description of the target field you want this remote field to map to. +**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
@@ -9010,7 +9131,7 @@ client.filestorage.field_mapping.field_mappings_create(
-**remote_field_traversal_path:** `typing.Sequence[typing.Optional[typing.Any]]` — The field traversal path of the remote field listed when you hit the GET /remote-fields endpoint. +**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
@@ -9018,7 +9139,7 @@ client.filestorage.field_mapping.field_mappings_create(
-**remote_method:** `str` — The method of the remote endpoint where the remote field is coming from. +**cursor:** `typing.Optional[str]` — The pagination cursor value.
@@ -9026,7 +9147,7 @@ client.filestorage.field_mapping.field_mappings_create(
-**remote_url_path:** `str` — The path of the remote endpoint where the remote field is coming from. +**email_addresses:** `typing.Optional[str]` — If provided, will only return contacts matching the email addresses; multiple email_addresses can be separated by commas.
@@ -9034,7 +9155,7 @@ client.filestorage.field_mapping.field_mappings_create(
-**common_model_name:** `str` — The name of the Common Model that the remote field corresponds to in a given category. +**expand:** `typing.Optional[ContactsListRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -9042,7 +9163,7 @@ client.filestorage.field_mapping.field_mappings_create(
-**exclude_remote_field_metadata:** `typing.Optional[bool]` — If `true`, remote fields metadata is excluded from each field mapping instance (i.e. `remote_fields.remote_key_name` and `remote_fields.schema` will be null). This will increase the speed of the request since these fields require some calculations. +**include_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/).
@@ -9050,70 +9171,63 @@ client.filestorage.field_mapping.field_mappings_create(
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. +**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
- -
+
+
+**include_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format. +
-
-
client.filestorage.field_mapping.field_mappings_destroy(...)
-#### 📝 Description - -
-
+**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). + +
+
-Deletes Field Mappings for a Linked Account. All data related to this Field Mapping will be deleted and these changes will be reflected after the next scheduled sync. This will cause the next sync for this Linked Account to sync **ALL** data from start. -
-
+**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned. +
-#### 🔌 Usage -
+**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned. + +
+
+
-```python -from merge import Merge - -client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.filestorage.field_mapping.field_mappings_destroy( - field_mapping_id="field_mapping_id", -) - -``` -
-
+**page_size:** `typing.Optional[int]` — Number of results to return per page. + -#### ⚙️ Parameters -
+**phone_numbers:** `typing.Optional[str]` — If provided, will only return contacts matching the phone numbers; multiple phone numbers can be separated by commas. + +
+
+
-**field_mapping_id:** `str` +**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
@@ -9133,7 +9247,7 @@ client.filestorage.field_mapping.field_mappings_destroy(
-
client.filestorage.field_mapping.field_mappings_partial_update(...) +
client.crm.contacts.create(...)
@@ -9145,7 +9259,7 @@ client.filestorage.field_mapping.field_mappings_destroy(
-Create or update existing Field Mappings for a Linked Account. Changes will be reflected after the next scheduled sync. This will cause the next sync for this Linked Account to sync **ALL** data from start. +Creates a `Contact` object with the given values.
@@ -9161,13 +9275,14 @@ Create or update existing Field Mappings for a Linked Account. Changes will be r ```python from merge import Merge +from merge.resources.crm import ContactRequest client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.filestorage.field_mapping.field_mappings_partial_update( - field_mapping_id="field_mapping_id", +client.crm.contacts.create( + model=ContactRequest(), ) ``` @@ -9184,15 +9299,7 @@ client.filestorage.field_mapping.field_mappings_partial_update(
-**field_mapping_id:** `str` - -
-
- -
-
- -**remote_field_traversal_path:** `typing.Optional[typing.Sequence[typing.Optional[typing.Any]]]` — The field traversal path of the remote field listed when you hit the GET /remote-fields endpoint. +**model:** `ContactRequest`
@@ -9200,7 +9307,7 @@ client.filestorage.field_mapping.field_mappings_partial_update(
-**remote_method:** `typing.Optional[str]` — The method of the remote endpoint where the remote field is coming from. +**is_debug_mode:** `typing.Optional[bool]` — Whether to include debug fields (such as log file links) in the response.
@@ -9208,7 +9315,7 @@ client.filestorage.field_mapping.field_mappings_partial_update(
-**remote_url_path:** `typing.Optional[str]` — The path of the remote endpoint where the remote field is coming from. +**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously.
@@ -9228,7 +9335,7 @@ client.filestorage.field_mapping.field_mappings_partial_update(
-
client.filestorage.field_mapping.remote_fields_retrieve(...) +
client.crm.contacts.retrieve(...)
@@ -9240,7 +9347,7 @@ client.filestorage.field_mapping.field_mappings_partial_update(
-Get all remote fields for a Linked Account. Remote fields are third-party fields that are accessible after initial sync if remote_data is enabled. You can use remote fields to override existing Merge fields or map a new Merge field. [Learn more](https://docs.merge.dev/supplemental-data/field-mappings/overview/). +Returns a `Contact` object with the given `id`.
@@ -9261,7 +9368,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.filestorage.field_mapping.remote_fields_retrieve() +client.crm.contacts.retrieve( + id="id", +) ``` @@ -9277,7 +9386,7 @@ client.filestorage.field_mapping.remote_fields_retrieve()
-**common_models:** `typing.Optional[str]` — A comma seperated list of Common Model names. If included, will only return Remote Fields for those Common Models. +**id:** `str`
@@ -9285,7 +9394,7 @@ client.filestorage.field_mapping.remote_fields_retrieve()
-**include_example_values:** `typing.Optional[str]` — If true, will include example values, where available, for remote fields in the 3rd party platform. These examples come from active data from your customers. +**expand:** `typing.Optional[ContactsRetrieveRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -9293,64 +9402,27 @@ client.filestorage.field_mapping.remote_fields_retrieve()
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. +**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
- -
- - - - -
- -
client.filestorage.field_mapping.target_fields_retrieve() -
-
- -#### 📝 Description
-
-
- -Get all organization-wide Target Fields, this will not include any Linked Account specific Target Fields. Organization-wide Target Fields are additional fields appended to the Merge Common Model for all Linked Accounts in a category. [Learn more](https://docs.merge.dev/supplemental-data/field-mappings/target-fields/). -
-
+**include_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format. +
-#### 🔌 Usage - -
-
-
-```python -from merge import Merge - -client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.filestorage.field_mapping.target_fields_retrieve() - -``` -
-
+**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). +
-#### ⚙️ Parameters - -
-
-
@@ -9366,8 +9438,7 @@ client.filestorage.field_mapping.target_fields_retrieve()
-## Filestorage Files -
client.filestorage.files.list(...) +
client.crm.contacts.partial_update(...)
@@ -9379,7 +9450,7 @@ client.filestorage.field_mapping.target_fields_retrieve()
-Returns a list of `File` objects. +Updates a `Contact` object with the given `id`.
@@ -9395,12 +9466,16 @@ Returns a list of `File` objects. ```python from merge import Merge +from merge.resources.crm import PatchedContactRequest client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.filestorage.files.list() +client.crm.contacts.partial_update( + id="id", + model=PatchedContactRequest(), +) ``` @@ -9416,7 +9491,7 @@ client.filestorage.files.list()
-**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime. +**id:** `str`
@@ -9424,7 +9499,7 @@ client.filestorage.files.list()
-**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime. +**model:** `PatchedContactRequest`
@@ -9432,7 +9507,7 @@ client.filestorage.files.list()
-**cursor:** `typing.Optional[str]` — The pagination cursor value. +**is_debug_mode:** `typing.Optional[bool]` — Whether to include debug fields (such as log file links) in the response.
@@ -9440,7 +9515,7 @@ client.filestorage.files.list()
-**drive_id:** `typing.Optional[str]` — Specifying a drive id returns only the files in that drive. Specifying null returns only the files outside the top-level drive. +**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously.
@@ -9448,87 +9523,74 @@ client.filestorage.files.list()
-**expand:** `typing.Optional[FilesListRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
- -
-
- -**folder_id:** `typing.Optional[str]` — Specifying a folder id returns only the files in that folder. Specifying null returns only the files in root directory. -
-
-
-**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/). -
+
+
client.crm.contacts.ignore_create(...)
-**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). - -
-
-
-**mime_type:** `typing.Optional[str]` — If provided, will only return files with these mime_types. Multiple values can be separated by commas. - +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.
- -
-
- -**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned. -
+#### 🔌 Usage +
-**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned. - -
-
-
-**name:** `typing.Optional[str]` — If provided, will only return files with this name. This performs an exact match. - +```python +from merge import Merge +from merge.resources.crm import IgnoreCommonModelRequest, ReasonEnum + +client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.crm.contacts.ignore_create( + model_id="model_id", + request=IgnoreCommonModelRequest( + reason=ReasonEnum.GENERAL_CUSTOMER_REQUEST, + ), +) + +``` +
+
+#### ⚙️ Parameters +
-**order_by:** `typing.Optional[FilesListRequestOrderBy]` — Overrides the default ordering for this endpoint. Possible values include: created_at, -created_at, modified_at, -modified_at. - -
-
-
-**page_size:** `typing.Optional[int]` — Number of results to return per page. +**model_id:** `str`
@@ -9536,7 +9598,7 @@ client.filestorage.files.list()
-**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object. +**request:** `IgnoreCommonModelRequest`
@@ -9556,7 +9618,7 @@ client.filestorage.files.list()
-
client.filestorage.files.create(...) +
client.crm.contacts.meta_patch_retrieve(...)
@@ -9568,7 +9630,7 @@ client.filestorage.files.list()
-Creates a `File` object with the given values. +Returns metadata for `CRMContact` PATCHs.
@@ -9584,14 +9646,13 @@ Creates a `File` object with the given values. ```python from merge import Merge -from merge.resources.filestorage import FileRequest client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.filestorage.files.create( - model=FileRequest(), +client.crm.contacts.meta_patch_retrieve( + id="id", ) ``` @@ -9608,23 +9669,7 @@ client.filestorage.files.create(
-**model:** `FileRequest` - -
-
- -
-
- -**is_debug_mode:** `typing.Optional[bool]` — Whether to include debug fields (such as log file links) in the response. - -
-
- -
-
- -**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously. +**id:** `str`
@@ -9644,7 +9689,7 @@ client.filestorage.files.create(
-
client.filestorage.files.retrieve(...) +
client.crm.contacts.meta_post_retrieve()
@@ -9656,7 +9701,7 @@ client.filestorage.files.create(
-Returns a `File` object with the given `id`. +Returns metadata for `CRMContact` POSTs.
@@ -9677,9 +9722,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.filestorage.files.retrieve( - id="id", -) +client.crm.contacts.meta_post_retrieve() ``` @@ -9695,39 +9738,7 @@ client.filestorage.files.retrieve(
-**id:** `str` - -
-
- -
-
- -**expand:** `typing.Optional[FilesRetrieveRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. - -
-
- -
-
- -**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. - -
-
- -
-
- -**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). - -
-
- -
-
- -**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -9739,7 +9750,7 @@ client.filestorage.files.retrieve(
-
client.filestorage.files.download_request_meta_retrieve(...) +
client.crm.contacts.remote_field_classes_list(...)
@@ -9751,7 +9762,7 @@ client.filestorage.files.retrieve(
-Returns metadata to construct an authenticated file download request for a singular file, allowing you to download file directly from the third-party. +Returns a list of `RemoteFieldClass` objects.
@@ -9772,9 +9783,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.filestorage.files.download_request_meta_retrieve( - id="id", -) +client.crm.contacts.remote_field_classes_list() ``` @@ -9790,7 +9799,7 @@ client.filestorage.files.download_request_meta_retrieve(
-**id:** `str` +**cursor:** `typing.Optional[str]` — The pagination cursor value.
@@ -9798,7 +9807,55 @@ client.filestorage.files.download_request_meta_retrieve(
-**mime_type:** `typing.Optional[str]` — If provided, specifies the export format of the file to be downloaded. For information on supported export formats, please refer to our export format help center article. +**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/). + +
+
+ +
+
+ +**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. + +
+
+ +
+
+ +**include_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format. + +
+
+ +
+
+ +**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). + +
+
+ +
+
+ +**is_common_model_field:** `typing.Optional[bool]` — If provided, will only return remote field classes with this is_common_model_field value + +
+
+ +
+
+ +**is_custom:** `typing.Optional[bool]` — If provided, will only return remote fields classes with this is_custom value + +
+
+ +
+
+ +**page_size:** `typing.Optional[int]` — Number of results to return per page.
@@ -9818,7 +9875,8 @@ client.filestorage.files.download_request_meta_retrieve(
-
client.filestorage.files.download_request_meta_list(...) +## Crm CustomObjectClasses +
client.crm.custom_object_classes.list(...)
@@ -9830,7 +9888,7 @@ client.filestorage.files.download_request_meta_retrieve(
-Returns metadata to construct authenticated file download requests, allowing you to download files directly from the third-party. +Returns a list of `CustomObjectClass` objects.
@@ -9851,7 +9909,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.filestorage.files.download_request_meta_list() +client.crm.custom_object_classes.list() ``` @@ -9867,7 +9925,7 @@ client.filestorage.files.download_request_meta_list()
-**created_after:** `typing.Optional[str]` — If provided, will only return objects created after this datetime. +**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
@@ -9875,7 +9933,7 @@ client.filestorage.files.download_request_meta_list()
-**created_before:** `typing.Optional[str]` — If provided, will only return objects created before this datetime. +**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
@@ -9891,6 +9949,14 @@ client.filestorage.files.download_request_meta_list()
+**expand:** `typing.Optional[typing.Literal["fields"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. + +
+
+ +
+
+ **include_deleted_data:** `typing.Optional[bool]` — 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/).
@@ -9899,7 +9965,7 @@ client.filestorage.files.download_request_meta_list()
-**mime_types:** `typing.Optional[str]` — A comma-separated list of preferred MIME types in order of priority. If supported by the third-party provider, the file(s) will be returned in the first supported MIME type from the list. The default MIME type is PDF. To see supported MIME types by file type, refer to our export format help center article. +**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -9907,7 +9973,7 @@ client.filestorage.files.download_request_meta_list()
-**modified_after:** `typing.Optional[str]` — If provided, will only return objects modified 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).
@@ -9915,7 +9981,7 @@ client.filestorage.files.download_request_meta_list()
-**modified_before:** `typing.Optional[str]` — If provided, will only return objects modified before this datetime. +**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
@@ -9923,7 +9989,7 @@ client.filestorage.files.download_request_meta_list()
-**order_by:** `typing.Optional[FilesDownloadRequestMetaListRequestOrderBy]` — Overrides the default ordering for this endpoint. Possible values include: created_at, -created_at, modified_at, -modified_at. +**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
@@ -9939,6 +10005,14 @@ client.filestorage.files.download_request_meta_list()
+**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object. + +
+
+ +
+
+ **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -9951,7 +10025,7 @@ client.filestorage.files.download_request_meta_list()
-
client.filestorage.files.meta_post_retrieve() +
client.crm.custom_object_classes.retrieve(...)
@@ -9963,7 +10037,7 @@ client.filestorage.files.download_request_meta_list()
-Returns metadata for `FileStorageFile` POSTs. +Returns a `CustomObjectClass` object with the given `id`.
@@ -9984,7 +10058,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.filestorage.files.meta_post_retrieve() +client.crm.custom_object_classes.retrieve( + id="id", +) ``` @@ -10000,6 +10076,38 @@ client.filestorage.files.meta_post_retrieve()
+**id:** `str` + +
+
+ +
+
+ +**expand:** `typing.Optional[typing.Literal["fields"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. + +
+
+ +
+
+ +**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. + +
+
+ +
+
+ +**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). + +
+
+ +
+
+ **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -10012,8 +10120,8 @@ client.filestorage.files.meta_post_retrieve()
-## Filestorage Folders -
client.filestorage.folders.list(...) +## Crm AssociationTypes +
client.crm.association_types.custom_object_classes_association_types_list(...)
@@ -10025,7 +10133,7 @@ client.filestorage.files.meta_post_retrieve()
-Returns a list of `Folder` objects. +Returns a list of `AssociationType` objects.
@@ -10046,7 +10154,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.filestorage.folders.list() +client.crm.association_types.custom_object_classes_association_types_list( + custom_object_class_id="custom_object_class_id", +) ``` @@ -10062,7 +10172,7 @@ client.filestorage.folders.list()
-**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime. +**custom_object_class_id:** `str`
@@ -10070,7 +10180,7 @@ client.filestorage.folders.list()
-**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime. +**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
@@ -10078,7 +10188,7 @@ client.filestorage.folders.list()
-**cursor:** `typing.Optional[str]` — The pagination cursor value. +**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
@@ -10086,7 +10196,7 @@ client.filestorage.folders.list()
-**drive_id:** `typing.Optional[str]` — If provided, will only return folders in this drive. +**cursor:** `typing.Optional[str]` — The pagination cursor value.
@@ -10094,7 +10204,7 @@ client.filestorage.folders.list()
-**expand:** `typing.Optional[FoldersListRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. +**expand:** `typing.Optional[typing.Literal["target_object_classes"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -10142,14 +10252,6 @@ client.filestorage.folders.list()
-**name:** `typing.Optional[str]` — If provided, will only return folders with this name. This performs an exact match. - -
-
- -
-
- **page_size:** `typing.Optional[int]` — Number of results to return per page.
@@ -10158,14 +10260,6 @@ client.filestorage.folders.list()
-**parent_folder_id:** `typing.Optional[str]` — If provided, will only return folders in this parent folder. If null, will return folders in root directory. - -
-
- -
-
- **remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
@@ -10186,7 +10280,7 @@ client.filestorage.folders.list()
-
client.filestorage.folders.create(...) +
client.crm.association_types.custom_object_classes_association_types_create(...)
@@ -10198,7 +10292,7 @@ client.filestorage.folders.list()
-Creates a `Folder` object with the given values. +Creates an `AssociationType` object with the given values.
@@ -10214,14 +10308,31 @@ Creates a `Folder` object with the given values. ```python from merge import Merge -from merge.resources.filestorage import FolderRequest +from merge.resources.crm import ( + AssociationTypeRequestRequest, + ObjectClassDescriptionRequest, + OriginTypeEnum, +) client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.filestorage.folders.create( - model=FolderRequest(), +client.crm.association_types.custom_object_classes_association_types_create( + custom_object_class_id="custom_object_class_id", + model=AssociationTypeRequestRequest( + source_object_class=ObjectClassDescriptionRequest( + id="id", + origin_type=OriginTypeEnum.CUSTOM_OBJECT, + ), + target_object_classes=[ + ObjectClassDescriptionRequest( + id="id", + origin_type=OriginTypeEnum.CUSTOM_OBJECT, + ) + ], + remote_key_name="remote_key_name", + ), ) ``` @@ -10238,7 +10349,15 @@ client.filestorage.folders.create(
-**model:** `FolderRequest` +**custom_object_class_id:** `str` + +
+
+ +
+
+ +**model:** `AssociationTypeRequestRequest`
@@ -10274,7 +10393,7 @@ client.filestorage.folders.create(
-
client.filestorage.folders.retrieve(...) +
client.crm.association_types.custom_object_classes_association_types_retrieve(...)
@@ -10286,7 +10405,7 @@ client.filestorage.folders.create(
-Returns a `Folder` object with the given `id`. +Returns an `AssociationType` object with the given `id`.
@@ -10307,7 +10426,8 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.filestorage.folders.retrieve( +client.crm.association_types.custom_object_classes_association_types_retrieve( + custom_object_class_id="custom_object_class_id", id="id", ) @@ -10325,6 +10445,14 @@ client.filestorage.folders.retrieve(
+**custom_object_class_id:** `str` + +
+
+ +
+
+ **id:** `str`
@@ -10333,7 +10461,7 @@ client.filestorage.folders.retrieve(
-**expand:** `typing.Optional[FoldersRetrieveRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. +**expand:** `typing.Optional[typing.Literal["target_object_classes"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -10369,69 +10497,7 @@ client.filestorage.folders.retrieve(
-
client.filestorage.folders.meta_post_retrieve() -
-
- -#### 📝 Description - -
-
- -
-
- -Returns metadata for `FileStorageFolder` POSTs. -
-
-
-
- -#### 🔌 Usage - -
-
- -
-
- -```python -from merge import Merge - -client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.filestorage.folders.meta_post_retrieve() - -``` -
-
-
-
- -#### ⚙️ Parameters - -
-
- -
-
- -**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. - -
-
-
-
- - -
-
-
- -## Filestorage GenerateKey -
client.filestorage.generate_key.create(...) +
client.crm.association_types.custom_object_classes_association_types_meta_post_retrieve(...)
@@ -10443,7 +10509,7 @@ client.filestorage.folders.meta_post_retrieve()
-Create a remote key. +Returns metadata for `CRMAssociationType` POSTs.
@@ -10464,8 +10530,8 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.filestorage.generate_key.create( - name="Remote Deployment Key 1", +client.crm.association_types.custom_object_classes_association_types_meta_post_retrieve( + custom_object_class_id="custom_object_class_id", ) ``` @@ -10482,7 +10548,7 @@ client.filestorage.generate_key.create(
-**name:** `str` — The name of the remote key +**custom_object_class_id:** `str`
@@ -10502,8 +10568,8 @@ client.filestorage.generate_key.create(
-## Filestorage Groups -
client.filestorage.groups.list(...) +## Crm CustomObjects +
client.crm.custom_objects.custom_object_classes_custom_objects_list(...)
@@ -10515,7 +10581,7 @@ client.filestorage.generate_key.create(
-Returns a list of `Group` objects. +Returns a list of `CustomObject` objects.
@@ -10536,7 +10602,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.filestorage.groups.list() +client.crm.custom_objects.custom_object_classes_custom_objects_list( + custom_object_class_id="custom_object_class_id", +) ``` @@ -10552,6 +10620,14 @@ client.filestorage.groups.list()
+**custom_object_class_id:** `str` + +
+
+ +
+
+ **created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
@@ -10576,7 +10652,7 @@ client.filestorage.groups.list()
-**expand:** `typing.Optional[typing.Literal["child_groups"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. +**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/).
@@ -10584,7 +10660,7 @@ client.filestorage.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.
@@ -10592,7 +10668,7 @@ client.filestorage.groups.list()
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. +**include_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.
@@ -10652,7 +10728,7 @@ client.filestorage.groups.list()
-
client.filestorage.groups.retrieve(...) +
client.crm.custom_objects.custom_object_classes_custom_objects_create(...)
@@ -10664,7 +10740,7 @@ client.filestorage.groups.list()
-Returns a `Group` object with the given `id`. +Creates a `CustomObject` object with the given values.
@@ -10680,13 +10756,17 @@ Returns a `Group` object with the given `id`. ```python from merge import Merge +from merge.resources.crm import CustomObjectRequest client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.filestorage.groups.retrieve( - id="id", +client.crm.custom_objects.custom_object_classes_custom_objects_create( + custom_object_class_id="custom_object_class_id", + model=CustomObjectRequest( + fields={"test_field": "hello"}, + ), ) ``` @@ -10703,7 +10783,7 @@ client.filestorage.groups.retrieve(
-**id:** `str` +**custom_object_class_id:** `str`
@@ -10711,7 +10791,7 @@ client.filestorage.groups.retrieve(
-**expand:** `typing.Optional[typing.Literal["child_groups"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. +**model:** `CustomObjectRequest`
@@ -10719,7 +10799,7 @@ client.filestorage.groups.retrieve(
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. +**is_debug_mode:** `typing.Optional[bool]` — Whether to include debug fields (such as log file links) in the response.
@@ -10727,7 +10807,7 @@ client.filestorage.groups.retrieve(
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). +**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously.
@@ -10747,8 +10827,7 @@ client.filestorage.groups.retrieve(
-## Filestorage Issues -
client.filestorage.issues.list(...) +
client.crm.custom_objects.custom_object_classes_custom_objects_retrieve(...)
@@ -10760,7 +10839,7 @@ client.filestorage.groups.retrieve(
-Gets all issues for Organization. +Returns a `CustomObject` object with the given `id`.
@@ -10781,7 +10860,10 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.filestorage.issues.list() +client.crm.custom_objects.custom_object_classes_custom_objects_retrieve( + custom_object_class_id="custom_object_class_id", + id="id", +) ``` @@ -10797,79 +10879,7 @@ client.filestorage.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]` - -
-
- -
-
- -**first_incident_time_after:** `typing.Optional[dt.datetime]` — If provided, will only return issues whose first incident time was after this datetime. - -
-
- -
-
- -**first_incident_time_before:** `typing.Optional[dt.datetime]` — If provided, will only return issues whose first incident time was before this datetime. - -
-
- -
-
- -**include_muted:** `typing.Optional[str]` — If true, will include muted issues - -
-
- -
-
- -**integration_name:** `typing.Optional[str]` - -
-
- -
-
- -**last_incident_time_after:** `typing.Optional[dt.datetime]` — If provided, will only return issues whose last incident time was after this datetime. - -
-
- -
-
- -**last_incident_time_before:** `typing.Optional[dt.datetime]` — If provided, will only return issues whose last incident time was before this datetime. +**custom_object_class_id:** `str`
@@ -10877,7 +10887,7 @@ client.filestorage.issues.list()
-**linked_account_id:** `typing.Optional[str]` — If provided, will only include issues pertaining to the linked account passed in. +**id:** `str`
@@ -10885,7 +10895,7 @@ client.filestorage.issues.list()
-**page_size:** `typing.Optional[int]` — Number of results to return per page. +**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -10893,7 +10903,7 @@ client.filestorage.issues.list()
-**start_date:** `typing.Optional[str]` — If included, will only include issues whose most recent action occurred after this time +**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.
@@ -10901,12 +10911,7 @@ client.filestorage.issues.list()
-**status:** `typing.Optional[IssuesListRequestStatus]` - -Status of the issue. Options: ('ONGOING', 'RESOLVED') - -* `ONGOING` - ONGOING -* `RESOLVED` - RESOLVED +**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -10926,7 +10931,7 @@ Status of the issue. Options: ('ONGOING', 'RESOLVED')
-
client.filestorage.issues.retrieve(...) +
client.crm.custom_objects.custom_object_classes_custom_objects_meta_post_retrieve(...)
@@ -10938,7 +10943,7 @@ Status of the issue. Options: ('ONGOING', 'RESOLVED')
-Get a specific issue. +Returns metadata for `CRMCustomObject` POSTs.
@@ -10959,8 +10964,8 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.filestorage.issues.retrieve( - id="id", +client.crm.custom_objects.custom_object_classes_custom_objects_meta_post_retrieve( + custom_object_class_id="custom_object_class_id", ) ``` @@ -10977,7 +10982,7 @@ client.filestorage.issues.retrieve(
-**id:** `str` +**custom_object_class_id:** `str`
@@ -10997,8 +11002,7 @@ client.filestorage.issues.retrieve(
-## Filestorage LinkToken -
client.filestorage.link_token.create(...) +
client.crm.custom_objects.custom_object_classes_custom_objects_remote_field_classes_list(...)
@@ -11010,7 +11014,7 @@ client.filestorage.issues.retrieve(
-Creates a link token to be used when linking a new end user. +Returns a list of `RemoteFieldClass` objects.
@@ -11026,18 +11030,12 @@ Creates a link token to be used when linking a new end user. ```python from merge import Merge -from merge.resources.filestorage import CategoriesEnum client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.filestorage.link_token.create( - end_user_email_address="example@gmail.com", - end_user_organization_name="Test Organization", - end_user_origin_id="12345", - categories=[CategoriesEnum.HRIS, CategoriesEnum.ATS], -) +client.crm.custom_objects.custom_object_classes_custom_objects_remote_field_classes_list() ``` @@ -11053,7 +11051,7 @@ client.filestorage.link_token.create(
-**end_user_email_address:** `str` — Your end user's email address. This is purely for identification purposes - setting this value will not cause any emails to be sent. +**cursor:** `typing.Optional[str]` — The pagination cursor value.
@@ -11061,7 +11059,7 @@ client.filestorage.link_token.create(
-**end_user_organization_name:** `str` — Your end user's organization. +**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/).
@@ -11069,7 +11067,7 @@ client.filestorage.link_token.create(
-**end_user_origin_id:** `str` — This unique identifier typically represents the ID for your end user in your product's database. This value must be distinct from other Linked Accounts' unique identifiers. +**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -11077,7 +11075,7 @@ client.filestorage.link_token.create(
-**categories:** `typing.Sequence[CategoriesEnum]` — The integration categories to show in Merge Link. +**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.
@@ -11085,7 +11083,7 @@ client.filestorage.link_token.create(
-**integration:** `typing.Optional[str]` — The slug of a specific pre-selected integration for this linking flow token. For examples of slugs, see https://docs.merge.dev/guides/merge-link/single-integration/. +**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -11093,7 +11091,7 @@ client.filestorage.link_token.create(
-**link_expiry_mins:** `typing.Optional[int]` — An integer number of minutes between [30, 720 or 10080 if for a Magic Link URL] for how long this token is valid. Defaults to 30. +**is_common_model_field:** `typing.Optional[bool]` — If provided, will only return remote field classes with this is_common_model_field value
@@ -11101,7 +11099,7 @@ client.filestorage.link_token.create(
-**should_create_magic_link_url:** `typing.Optional[bool]` — Whether to generate a Magic Link URL. Defaults to false. For more information on Magic Link, see https://merge.dev/blog/integrations-fast-say-hello-to-magic-link. +**is_custom:** `typing.Optional[bool]` — If provided, will only return remote fields classes with this is_custom value
@@ -11109,7 +11107,7 @@ client.filestorage.link_token.create(
-**hide_admin_magic_link:** `typing.Optional[bool]` — Whether to generate a Magic Link URL on the Admin Needed screen during the linking flow. Defaults to false. For more information on Magic Link, see https://merge.dev/blog/integrations-fast-say-hello-to-magic-link. +**page_size:** `typing.Optional[int]` — Number of results to return per page.
@@ -11117,62 +11115,10 @@ client.filestorage.link_token.create(
-**common_models:** `typing.Optional[typing.Sequence[CommonModelScopesBodyRequest]]` — An array of objects to specify the models and fields that will be disabled for a given Linked Account. Each object uses model_id, enabled_actions, and disabled_fields to specify the model, method, and fields that are scoped for a given Linked Account. +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. -
-
- -
-
- -**category_common_model_scopes:** `typing.Optional[ - typing.Dict[ - str, - typing.Optional[ - typing.Sequence[IndividualCommonModelScopeDeserializerRequest] - ], - ] -]` — When creating a Link Token, you can set permissions for Common Models that will apply to the account that is going to be linked. Any model or field not specified in link token payload will default to existing settings. - -
-
- -
-
- -**language:** `typing.Optional[LanguageEnum]` - -The following subset of IETF language tags can be used to configure localization. - -* `en` - en -* `de` - de - -
-
- -
-
- -**are_syncs_disabled:** `typing.Optional[bool]` — The boolean that indicates whether initial, periodic, and force syncs will be disabled. - -
-
- -
-
- -**integration_specific_config:** `typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]]` — A JSON object containing integration-specific configuration options. - -
-
- -
-
- -**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. - -
-
+ +
@@ -11181,8 +11127,8 @@ The following subset of IETF language tags can be used to configure localization
-## Filestorage LinkedAccounts -
client.filestorage.linked_accounts.list(...) +## Crm Associations +
client.crm.associations.custom_object_classes_custom_objects_associations_list(...)
@@ -11194,7 +11140,7 @@ The following subset of IETF language tags can be used to configure localization
-List linked accounts for your organization. +Returns a list of `Association` objects.
@@ -11215,7 +11161,10 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.filestorage.linked_accounts.list() +client.crm.associations.custom_object_classes_custom_objects_associations_list( + custom_object_class_id="custom_object_class_id", + object_id="object_id", +) ``` @@ -11231,17 +11180,15 @@ client.filestorage.linked_accounts.list()
-**category:** `typing.Optional[LinkedAccountsListRequestCategory]` +**custom_object_class_id:** `str` + +
+
-Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing` +
+
-* `hris` - hris -* `ats` - ats -* `accounting` - accounting -* `ticketing` - ticketing -* `crm` - crm -* `mktg` - mktg -* `filestorage` - filestorage +**object_id:** `str`
@@ -11249,7 +11196,7 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing`
-**cursor:** `typing.Optional[str]` — The pagination cursor value. +**association_type_id:** `typing.Optional[str]` — If provided, will only return opportunities with this association_type.
@@ -11257,7 +11204,7 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing`
-**end_user_email_address:** `typing.Optional[str]` — If provided, will only return linked accounts associated with the given email address. +**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
@@ -11265,7 +11212,7 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing`
-**end_user_organization_name:** `typing.Optional[str]` — If provided, will only return linked accounts associated with the given organization name. +**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
@@ -11273,7 +11220,7 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing`
-**end_user_origin_id:** `typing.Optional[str]` — If provided, will only return linked accounts associated with the given origin ID. +**cursor:** `typing.Optional[str]` — The pagination cursor value.
@@ -11281,7 +11228,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. +**expand:** `typing.Optional[typing.Literal["association_type"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -11289,7 +11236,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/).
@@ -11297,7 +11244,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.
@@ -11305,7 +11252,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).
@@ -11313,7 +11260,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.
@@ -11321,7 +11268,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.
@@ -11337,7 +11284,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.
@@ -11357,8 +11304,7 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing`
-## Filestorage Passthrough -
client.filestorage.passthrough.create(...) +
client.crm.associations.custom_object_classes_custom_objects_associations_update(...)
@@ -11370,7 +11316,7 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing`
-Pull data from an endpoint not currently supported by Merge. +Creates an Association between `source_object_id` and `target_object_id` of type `association_type_id`.
@@ -11386,17 +11332,17 @@ Pull data from an endpoint not currently supported by Merge. ```python from merge import Merge -from merge.resources.filestorage import DataPassthroughRequest, MethodEnum client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.filestorage.passthrough.create( - request=DataPassthroughRequest( - method=MethodEnum.GET, - path="/scooters", - ), +client.crm.associations.custom_object_classes_custom_objects_associations_update( + association_type_id="association_type_id", + source_class_id="source_class_id", + source_object_id="source_object_id", + target_class_id="target_class_id", + target_object_id="target_object_id", ) ``` @@ -11413,7 +11359,7 @@ client.filestorage.passthrough.create(
-**request:** `DataPassthroughRequest` +**association_type_id:** `str`
@@ -11421,71 +11367,47 @@ client.filestorage.passthrough.create(
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. +**source_class_id:** `str`
- -
+
+
+**source_object_id:** `str` +
-
-## Filestorage RegenerateKey -
client.filestorage.regenerate_key.create(...)
-#### 📝 Description - -
-
+**target_class_id:** `str` + +
+
-Exchange remote keys. -
-
+**target_object_id:** `str` +
-#### 🔌 Usage -
-
-
- -```python -from merge import Merge - -client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.filestorage.regenerate_key.create( - name="Remote Deployment Key 1", -) - -``` -
-
+**is_debug_mode:** `typing.Optional[bool]` — Whether to include debug fields (such as log file links) in the response. +
-#### ⚙️ Parameters - -
-
-
-**name:** `str` — The name of the remote key +**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously.
@@ -11505,8 +11427,8 @@ client.filestorage.regenerate_key.create(
-## Filestorage SyncStatus -
client.filestorage.sync_status.list(...) +## Crm Scopes +
client.crm.scopes.default_scopes_retrieve()
@@ -11518,7 +11440,7 @@ client.filestorage.regenerate_key.create(
-Get sync status for the current sync and the most recently finished sync. `last_sync_start` represents the most recent time any sync began. `last_sync_finished` represents the most recent time any sync completed. These timestamps may correspond to different sync instances which may result in a sync start time being later than a separate sync completed time. To ensure you are retrieving the latest available data reference the `last_sync_finished` timestamp where `last_sync_result` is `DONE`. Possible values for `status` and `last_sync_result` are `DISABLED`, `DONE`, `FAILED`, `PARTIALLY_SYNCED`, `PAUSED`, `SYNCING`. Learn more about sync status in our [Help Center](https://help.merge.dev/en/articles/8184193-merge-sync-statuses). +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).
@@ -11539,7 +11461,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.filestorage.sync_status.list() +client.crm.scopes.default_scopes_retrieve() ``` @@ -11555,22 +11477,6 @@ client.filestorage.sync_status.list()
-**cursor:** `typing.Optional[str]` — The pagination cursor value. - -
-
- -
-
- -**page_size:** `typing.Optional[int]` — Number of results to return per page. - -
-
- -
-
- **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -11583,8 +11489,7 @@ client.filestorage.sync_status.list()
-## Filestorage ForceResync -
client.filestorage.force_resync.sync_status_resync_create() +
client.crm.scopes.linked_account_scopes_retrieve()
@@ -11596,7 +11501,7 @@ client.filestorage.sync_status.list()
-Force re-sync of all models. This endpoint is available for monthly, quarterly, and highest sync frequency customers on the Professional or Enterprise plans. Doing so will consume a sync credit for the relevant linked account. Force re-syncs can also be triggered manually in the Merge Dashboard and is available for all customers. +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).
@@ -11617,7 +11522,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.filestorage.force_resync.sync_status_resync_create() +client.crm.scopes.linked_account_scopes_retrieve() ``` @@ -11645,8 +11550,7 @@ client.filestorage.force_resync.sync_status_resync_create()
-## Filestorage Users -
client.filestorage.users.list(...) +
client.crm.scopes.linked_account_scopes_create(...)
@@ -11658,7 +11562,7 @@ client.filestorage.force_resync.sync_status_resync_create()
-Returns a list of `User` objects. +Update permissions for any Common Model or field for a single Linked Account. Any Scopes not set in this POST request will inherit the default Scopes. [Learn more](https://help.merge.dev/en/articles/5950052-common-model-and-field-scopes)
@@ -11674,12 +11578,43 @@ Returns a list of `User` objects. ```python from merge import Merge +from merge.resources.crm import ( + FieldPermissionDeserializerRequest, + IndividualCommonModelScopeDeserializerRequest, + ModelPermissionDeserializerRequest, +) client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.filestorage.users.list() +client.crm.scopes.linked_account_scopes_create( + common_models=[ + IndividualCommonModelScopeDeserializerRequest( + model_name="Employee", + model_permissions={ + "READ": ModelPermissionDeserializerRequest( + is_enabled=True, + ), + "WRITE": ModelPermissionDeserializerRequest( + is_enabled=False, + ), + }, + field_permissions=FieldPermissionDeserializerRequest( + enabled_fields=["avatar", "home_location"], + disabled_fields=["work_location"], + ), + ), + IndividualCommonModelScopeDeserializerRequest( + model_name="Benefit", + model_permissions={ + "WRITE": ModelPermissionDeserializerRequest( + is_enabled=False, + ) + }, + ), + ], +) ``` @@ -11695,7 +11630,7 @@ client.filestorage.users.list()
-**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime. +**common_models:** `typing.Sequence[IndividualCommonModelScopeDeserializerRequest]` — The common models you want to update the scopes for
@@ -11703,83 +11638,65 @@ client.filestorage.users.list()
-**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime. +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+ +
-
-
-**cursor:** `typing.Optional[str]` — The pagination cursor value. -
+
+## Crm DeleteAccount +
client.crm.delete_account.delete()
-**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). - +Delete a linked account.
- -
-
- -**is_me:** `typing.Optional[str]` — If provided, will only return the user object for requestor. -
+#### 🔌 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 -
-
+client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.crm.delete_account.delete() -**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. - -
-
-
@@ -11795,7 +11712,8 @@ client.filestorage.users.list()
-
client.filestorage.users.retrieve(...) +## Crm EngagementTypes +
client.crm.engagement_types.list(...)
@@ -11807,7 +11725,7 @@ client.filestorage.users.list()
-Returns a `User` object with the given `id`. +Returns a list of `EngagementType` objects.
@@ -11828,9 +11746,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.filestorage.users.retrieve( - id="id", -) +client.crm.engagement_types.list() ``` @@ -11846,7 +11762,7 @@ client.filestorage.users.retrieve(
-**id:** `str` +**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
@@ -11854,7 +11770,7 @@ client.filestorage.users.retrieve(
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. +**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
@@ -11862,7 +11778,7 @@ client.filestorage.users.retrieve(
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). +**cursor:** `typing.Optional[str]` — The pagination cursor value.
@@ -11870,65 +11786,67 @@ client.filestorage.users.retrieve(
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. +**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
- -
+
+
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. +
-
-## Filestorage WebhookReceivers -
client.filestorage.webhook_receivers.list()
-#### 📝 Description +**include_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format. + +
+
+**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). + +
+
+
-Returns a list of `WebhookReceiver` objects. -
-
+**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned. + -#### 🔌 Usage -
+**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned. + +
+
+
-```python -from merge import Merge - -client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.filestorage.webhook_receivers.list() - -``` -
-
+**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. + +
+
+
@@ -11944,7 +11862,7 @@ client.filestorage.webhook_receivers.list()
-
client.filestorage.webhook_receivers.create(...) +
client.crm.engagement_types.retrieve(...)
@@ -11956,7 +11874,7 @@ client.filestorage.webhook_receivers.list()
-Creates a `WebhookReceiver` object with the given values. +Returns an `EngagementType` object with the given `id`.
@@ -11977,9 +11895,8 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.filestorage.webhook_receivers.create( - event="event", - is_active=True, +client.crm.engagement_types.retrieve( + id="id", ) ``` @@ -11996,7 +11913,7 @@ client.filestorage.webhook_receivers.create(
-**event:** `str` +**id:** `str`
@@ -12004,7 +11921,7 @@ client.filestorage.webhook_receivers.create(
-**is_active:** `bool` +**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -12012,7 +11929,15 @@ client.filestorage.webhook_receivers.create(
-**key:** `typing.Optional[str]` +**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).
@@ -12032,8 +11957,7 @@ client.filestorage.webhook_receivers.create(
-## Ticketing AccountDetails -
client.ticketing.account_details.retrieve() +
client.crm.engagement_types.remote_field_classes_list(...)
@@ -12045,7 +11969,7 @@ client.filestorage.webhook_receivers.create(
-Get details for a linked account. +Returns a list of `RemoteFieldClass` objects.
@@ -12066,7 +11990,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.account_details.retrieve() +client.crm.engagement_types.remote_field_classes_list() ``` @@ -12082,71 +12006,63 @@ client.ticketing.account_details.retrieve()
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. +**cursor:** `typing.Optional[str]` — The pagination cursor value.
- -
+
+
+**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/). +
-
-## Ticketing AccountToken -
client.ticketing.account_token.retrieve(...)
-#### 📝 Description - -
-
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. + +
+
-Returns the account token for the end user with the provided public token. -
-
+**include_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format. +
-#### 🔌 Usage -
+**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). + +
+
+
-```python -from merge import Merge - -client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.ticketing.account_token.retrieve( - public_token="public_token", -) - -``` -
-
+**is_common_model_field:** `typing.Optional[bool]` — If provided, will only return remote field classes with this is_common_model_field value + -#### ⚙️ Parameters -
+**is_custom:** `typing.Optional[bool]` — If provided, will only return remote fields classes with this is_custom value + +
+
+
-**public_token:** `str` +**page_size:** `typing.Optional[int]` — Number of results to return per page.
@@ -12166,8 +12082,8 @@ client.ticketing.account_token.retrieve(
-## Ticketing Accounts -
client.ticketing.accounts.list(...) +## Crm Engagements +
client.crm.engagements.list(...)
@@ -12179,7 +12095,7 @@ client.ticketing.account_token.retrieve(
-Returns a list of `Account` objects. +Returns a list of `Engagement` objects.
@@ -12200,7 +12116,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.accounts.list() +client.crm.engagements.list() ``` @@ -12240,6 +12156,14 @@ client.ticketing.accounts.list()
+**expand:** `typing.Optional[EngagementsListRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. + +
+
+ +
+
+ **include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
@@ -12256,6 +12180,14 @@ client.ticketing.accounts.list()
+**include_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format. + +
+
+ +
+
+ **include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -12296,6 +12228,22 @@ client.ticketing.accounts.list()
+**started_after:** `typing.Optional[dt.datetime]` — If provided, will only return engagements started after this datetime. + +
+
+ +
+
+ +**started_before:** `typing.Optional[dt.datetime]` — If provided, will only return engagements started before this datetime. + +
+
+ +
+
+ **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -12308,7 +12256,7 @@ client.ticketing.accounts.list()
-
client.ticketing.accounts.retrieve(...) +
client.crm.engagements.create(...)
@@ -12320,7 +12268,7 @@ client.ticketing.accounts.list()
-Returns an `Account` object with the given `id`. +Creates an `Engagement` object with the given values.
@@ -12336,13 +12284,14 @@ Returns an `Account` object with the given `id`. ```python from merge import Merge +from merge.resources.crm import EngagementRequest client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.accounts.retrieve( - id="id", +client.crm.engagements.create( + model=EngagementRequest(), ) ``` @@ -12359,7 +12308,7 @@ client.ticketing.accounts.retrieve(
-**id:** `str` +**model:** `EngagementRequest`
@@ -12367,7 +12316,7 @@ client.ticketing.accounts.retrieve(
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. +**is_debug_mode:** `typing.Optional[bool]` — Whether to include debug fields (such as log file links) in the response.
@@ -12375,7 +12324,7 @@ client.ticketing.accounts.retrieve(
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). +**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously.
@@ -12395,8 +12344,7 @@ client.ticketing.accounts.retrieve(
-## Ticketing AsyncPassthrough -
client.ticketing.async_passthrough.create(...) +
client.crm.engagements.retrieve(...)
@@ -12408,7 +12356,7 @@ client.ticketing.accounts.retrieve(
-Asynchronously pull data from an endpoint not currently supported by Merge. +Returns an `Engagement` object with the given `id`.
@@ -12424,17 +12372,13 @@ Asynchronously pull data from an endpoint not currently supported by Merge. ```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", - ), +client.crm.engagements.retrieve( + id="id", ) ``` @@ -12451,7 +12395,7 @@ client.ticketing.async_passthrough.create(
-**request:** `DataPassthroughRequest` +**id:** `str`
@@ -12459,70 +12403,31 @@ client.ticketing.async_passthrough.create(
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. +**expand:** `typing.Optional[EngagementsRetrieveRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
- -
- - - - -
- -
client.ticketing.async_passthrough.retrieve(...) -
-
- -#### 📝 Description - -
-
-Retrieves data from earlier async-passthrough POST request -
-
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. +
-#### 🔌 Usage - -
-
-
-```python -from merge import Merge - -client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.ticketing.async_passthrough.retrieve( - async_passthrough_receipt_id="async_passthrough_receipt_id", -) - -``` -
-
+**include_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format. +
-#### ⚙️ Parameters - -
-
-
-**async_passthrough_receipt_id:** `str` +**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -12542,8 +12447,7 @@ client.ticketing.async_passthrough.retrieve(
-## Ticketing Attachments -
client.ticketing.attachments.list(...) +
client.crm.engagements.partial_update(...)
@@ -12555,7 +12459,7 @@ client.ticketing.async_passthrough.retrieve(
-Returns a list of `Attachment` objects. +Updates an `Engagement` object with the given `id`.
@@ -12571,12 +12475,16 @@ Returns a list of `Attachment` objects. ```python from merge import Merge +from merge.resources.crm import PatchedEngagementRequest client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.attachments.list() +client.crm.engagements.partial_update( + id="id", + model=PatchedEngagementRequest(), +) ``` @@ -12592,7 +12500,7 @@ client.ticketing.attachments.list()
-**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime. +**id:** `str`
@@ -12600,7 +12508,7 @@ client.ticketing.attachments.list()
-**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime. +**model:** `PatchedEngagementRequest`
@@ -12608,7 +12516,7 @@ client.ticketing.attachments.list()
-**cursor:** `typing.Optional[str]` — The pagination cursor value. +**is_debug_mode:** `typing.Optional[bool]` — Whether to include debug fields (such as log file links) in the response.
@@ -12616,7 +12524,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. +**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously.
@@ -12624,71 +12532,70 @@ client.ticketing.attachments.list()
-**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/). +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+ +
-
-
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. -
+
+
client.crm.engagements.meta_patch_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 metadata for `Engagement` PATCHs. +
+
+#### 🔌 Usage +
-**page_size:** `typing.Optional[int]` — Number of results to return per page. - -
-
-
-**remote_created_after:** `typing.Optional[dt.datetime]` — If provided, will only return attachments created in the third party platform after this datetime. - +```python +from merge import Merge + +client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.crm.engagements.meta_patch_retrieve( + id="id", +) + +```
+ + + +#### ⚙️ Parameters
-**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object. - -
-
-
-**ticket_id:** `typing.Optional[str]` — If provided, will only return comments for this ticket. +**id:** `str`
@@ -12708,7 +12615,7 @@ client.ticketing.attachments.list()
-
client.ticketing.attachments.create(...) +
client.crm.engagements.meta_post_retrieve()
@@ -12720,7 +12627,7 @@ client.ticketing.attachments.list()
-Creates an `Attachment` object with the given values. +Returns metadata for `Engagement` POSTs.
@@ -12736,15 +12643,12 @@ 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.crm.engagements.meta_post_retrieve() ``` @@ -12760,30 +12664,6 @@ client.ticketing.attachments.create(
-**model:** `AttachmentRequest` - -
-
- -
-
- -**is_debug_mode:** `typing.Optional[bool]` — Whether to include debug fields (such as log file links) in the response. - -
-
- -
-
- -**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously. - -
-
- -
-
- **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -12796,7 +12676,7 @@ client.ticketing.attachments.create(
-
client.ticketing.attachments.retrieve(...) +
client.crm.engagements.remote_field_classes_list(...)
@@ -12808,7 +12688,7 @@ client.ticketing.attachments.create(
-Returns an `Attachment` object with the given `id`. +Returns a list of `RemoteFieldClass` objects.
@@ -12829,9 +12709,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.attachments.retrieve( - id="id", -) +client.crm.engagements.remote_field_classes_list() ``` @@ -12847,7 +12725,7 @@ client.ticketing.attachments.retrieve(
-**id:** `str` +**cursor:** `typing.Optional[str]` — The pagination cursor value.
@@ -12855,7 +12733,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. +**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/).
@@ -12871,6 +12749,14 @@ client.ticketing.attachments.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).
@@ -12879,6 +12765,30 @@ client.ticketing.attachments.retrieve(
+**is_common_model_field:** `typing.Optional[bool]` — If provided, will only return remote field classes with this is_common_model_field value + +
+
+ +
+
+ +**is_custom:** `typing.Optional[bool]` — If provided, will only return remote fields classes with this is_custom value + +
+
+ +
+
+ +**page_size:** `typing.Optional[int]` — Number of results to return per page. + +
+
+ +
+
+ **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -12891,7 +12801,8 @@ client.ticketing.attachments.retrieve(
-
client.ticketing.attachments.meta_post_retrieve() +## Crm FieldMapping +
client.crm.field_mapping.field_mappings_retrieve(...)
@@ -12903,7 +12814,7 @@ client.ticketing.attachments.retrieve(
-Returns metadata for `TicketingAttachment` 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/).
@@ -12924,7 +12835,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.attachments.meta_post_retrieve() +client.crm.field_mapping.field_mappings_retrieve() ``` @@ -12940,6 +12851,14 @@ client.ticketing.attachments.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.
@@ -12952,8 +12871,7 @@ client.ticketing.attachments.meta_post_retrieve()
-## Ticketing AuditTrail -
client.ticketing.audit_trail.list(...) +
client.crm.field_mapping.field_mappings_create(...)
@@ -12965,7 +12883,7 @@ client.ticketing.attachments.meta_post_retrieve()
-Gets a list of audit trail events. +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.
@@ -12986,7 +12904,14 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.audit_trail.list() +client.crm.field_mapping.field_mappings_create( + target_field_name="example_target_field_name", + target_field_description="this is a example description of the target field", + remote_field_traversal_path=["example_remote_field"], + remote_method="GET", + remote_url_path="/example-url-path", + common_model_name="ExampleCommonModel", +) ``` @@ -13002,7 +12927,7 @@ client.ticketing.audit_trail.list()
-**cursor:** `typing.Optional[str]` — The pagination cursor value. +**target_field_name:** `str` — The name of the target field you want this remote field to map to.
@@ -13010,7 +12935,7 @@ client.ticketing.audit_trail.list()
-**end_date:** `typing.Optional[str]` — If included, will only include audit trail events that occurred before this time +**target_field_description:** `str` — The description of the target field you want this remote field to map to.
@@ -13018,7 +12943,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` +**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.
@@ -13026,7 +12951,7 @@ client.ticketing.audit_trail.list()
-**page_size:** `typing.Optional[int]` — Number of results to return per page. +**remote_method:** `str` — The method of the remote endpoint where the remote field is coming from.
@@ -13034,7 +12959,7 @@ client.ticketing.audit_trail.list()
-**start_date:** `typing.Optional[str]` — If included, will only include audit trail events that occurred after this time +**remote_url_path:** `str` — The path of the remote endpoint where the remote field is coming from.
@@ -13042,7 +12967,15 @@ 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. +**common_model_name:** `str` — The name of the Common Model that the remote field corresponds to in a given category. + +
+
+ +
+
+ +**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.
@@ -13062,8 +12995,7 @@ client.ticketing.audit_trail.list()
-## Ticketing AvailableActions -
client.ticketing.available_actions.retrieve() +
client.crm.field_mapping.field_mappings_destroy(...)
@@ -13075,7 +13007,7 @@ client.ticketing.audit_trail.list()
-Returns a list of models and actions available for an account. +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.
@@ -13096,7 +13028,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.available_actions.retrieve() +client.crm.field_mapping.field_mappings_destroy( + field_mapping_id="field_mapping_id", +) ``` @@ -13112,6 +13046,14 @@ client.ticketing.available_actions.retrieve()
+**field_mapping_id:** `str` + +
+
+ +
+
+ **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -13124,8 +13066,7 @@ client.ticketing.available_actions.retrieve()
-## Ticketing Collections -
client.ticketing.collections.list(...) +
client.crm.field_mapping.field_mappings_partial_update(...)
@@ -13137,7 +13078,7 @@ client.ticketing.available_actions.retrieve()
-Returns a list of `Collection` 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.
@@ -13158,7 +13099,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.collections.list() +client.crm.field_mapping.field_mappings_partial_update( + field_mapping_id="field_mapping_id", +) ``` @@ -13174,7 +13117,7 @@ client.ticketing.collections.list()
-**collection_type:** `typing.Optional[str]` — If provided, will only return collections of the given type. +**field_mapping_id:** `str`
@@ -13182,7 +13125,7 @@ client.ticketing.collections.list()
-**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after 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.
@@ -13190,7 +13133,7 @@ client.ticketing.collections.list()
-**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime. +**remote_method:** `typing.Optional[str]` — The method of the remote endpoint where the remote field is coming from.
@@ -13198,7 +13141,7 @@ client.ticketing.collections.list()
-**cursor:** `typing.Optional[str]` — The pagination cursor value. +**remote_url_path:** `typing.Optional[str]` — The path of the remote endpoint where the remote field is coming from.
@@ -13206,79 +13149,68 @@ 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. +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
- -
-
- -**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/). -
-
-
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. -
+
+
client.crm.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 +
-**page_size:** `typing.Optional[int]` — Number of results to return per page. - -
-
-
-**parent_collection_id:** `typing.Optional[str]` — If provided, will only return collections whose parent collection matches the given id. - +```python +from merge import Merge + +client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.crm.field_mapping.remote_fields_retrieve() + +``` +
+
+#### ⚙️ Parameters +
-**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. +**common_models:** `typing.Optional[str]` — A comma seperated list of Common Model names. If included, will only return Remote Fields for those Common Models.
@@ -13286,7 +13218,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_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.
@@ -13306,7 +13238,7 @@ client.ticketing.collections.list()
-
client.ticketing.collections.viewers_list(...) +
client.crm.field_mapping.target_fields_retrieve()
@@ -13318,7 +13250,7 @@ client.ticketing.collections.list()
-Returns a list of `Viewer` objects that point to a User id or Team id that is either an assignee or viewer on a `Collection` with the given id. [Learn more.](https://help.merge.dev/en/articles/10333658-ticketing-access-control-list-acls) +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/).
@@ -13339,9 +13271,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.collections.viewers_list( - collection_id="collection_id", -) +client.crm.field_mapping.target_fields_retrieve() ``` @@ -13357,62 +13287,6 @@ client.ticketing.collections.viewers_list(
-**collection_id:** `str` - -
-
- -
-
- -**cursor:** `typing.Optional[str]` — The pagination cursor value. - -
-
- -
-
- -**expand:** `typing.Optional[CollectionsViewersListRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. - -
-
- -
-
- -**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/). - -
-
- -
-
- -**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. - -
-
- -
-
- -**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). - -
-
- -
-
- -**page_size:** `typing.Optional[int]` — Number of results to return per page. - -
-
- -
-
- **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -13425,7 +13299,8 @@ client.ticketing.collections.viewers_list(
-
client.ticketing.collections.retrieve(...) +## Crm GenerateKey +
client.crm.generate_key.create(...)
@@ -13437,7 +13312,7 @@ client.ticketing.collections.viewers_list(
-Returns a `Collection` object with the given `id`. +Create a remote key.
@@ -13458,8 +13333,8 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.collections.retrieve( - id="id", +client.crm.generate_key.create( + name="Remote Deployment Key 1", ) ``` @@ -13476,47 +13351,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). - -
-
- -
-
- -**remote_fields:** `typing.Optional[typing.Literal["collection_type"]]` — Deprecated. Use show_enum_origins. - -
-
- -
-
- -**show_enum_origins:** `typing.Optional[typing.Literal["collection_type"]]` — A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter) +**name:** `str` — The name of the remote key
@@ -13536,8 +13371,8 @@ client.ticketing.collections.retrieve(
-## Ticketing Comments -
client.ticketing.comments.list(...) +## Crm Issues +
client.crm.issues.list(...)
@@ -13549,7 +13384,7 @@ client.ticketing.collections.retrieve(
-Returns a list of `Comment` objects. +Gets all issues for Organization.
@@ -13570,7 +13405,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.comments.list() +client.crm.issues.list() ``` @@ -13586,7 +13421,7 @@ client.ticketing.comments.list()
-**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime. +**account_token:** `typing.Optional[str]`
@@ -13594,7 +13429,7 @@ client.ticketing.comments.list()
-**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime. +**cursor:** `typing.Optional[str]` — The pagination cursor value.
@@ -13602,7 +13437,7 @@ client.ticketing.comments.list()
-**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
@@ -13610,7 +13445,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. +**end_user_organization_name:** `typing.Optional[str]`
@@ -13618,7 +13453,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/). +**first_incident_time_after:** `typing.Optional[dt.datetime]` — If provided, will only return issues whose first incident time was after this datetime.
@@ -13626,7 +13461,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. +**first_incident_time_before:** `typing.Optional[dt.datetime]` — If provided, will only return issues whose first incident time was before this datetime.
@@ -13634,7 +13469,7 @@ 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). +**include_muted:** `typing.Optional[str]` — If true, will include muted issues
@@ -13642,7 +13477,7 @@ client.ticketing.comments.list()
-**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned. +**integration_name:** `typing.Optional[str]`
@@ -13650,7 +13485,7 @@ client.ticketing.comments.list()
-**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned. +**last_incident_time_after:** `typing.Optional[dt.datetime]` — If provided, will only return issues whose last incident time was after this datetime.
@@ -13658,7 +13493,7 @@ client.ticketing.comments.list()
-**page_size:** `typing.Optional[int]` — Number of results to return per page. +**last_incident_time_before:** `typing.Optional[dt.datetime]` — If provided, will only return issues whose last incident time was before this datetime.
@@ -13666,7 +13501,7 @@ client.ticketing.comments.list()
-**remote_created_after:** `typing.Optional[dt.datetime]` — If provided, will only return Comments created in the third party platform after this datetime. +**linked_account_id:** `typing.Optional[str]` — If provided, will only include issues pertaining to the linked account passed in.
@@ -13674,7 +13509,7 @@ client.ticketing.comments.list()
-**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object. +**page_size:** `typing.Optional[int]` — Number of results to return per page.
@@ -13682,7 +13517,20 @@ client.ticketing.comments.list()
-**ticket_id:** `typing.Optional[str]` — If provided, will only return comments for this ticket. +**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
@@ -13702,7 +13550,7 @@ client.ticketing.comments.list()
-
client.ticketing.comments.create(...) +
client.crm.issues.retrieve(...)
@@ -13714,7 +13562,7 @@ client.ticketing.comments.list()
-Creates a `Comment` object with the given values. +Get a specific issue.
@@ -13730,14 +13578,13 @@ 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.crm.issues.retrieve( + id="id", ) ``` @@ -13754,23 +13601,7 @@ 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. +**id:** `str`
@@ -13790,7 +13621,8 @@ client.ticketing.comments.create(
-
client.ticketing.comments.retrieve(...) +## Crm Leads +
client.crm.leads.list(...)
@@ -13802,7 +13634,7 @@ client.ticketing.comments.create(
-Returns a `Comment` object with the given `id`. +Returns a list of `Lead` objects.
@@ -13823,9 +13655,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.comments.retrieve( - id="id", -) +client.crm.leads.list() ``` @@ -13841,7 +13671,7 @@ client.ticketing.comments.retrieve(
-**id:** `str` +**converted_account_id:** `typing.Optional[str]` — If provided, will only return leads with this account.
@@ -13849,7 +13679,7 @@ client.ticketing.comments.retrieve(
-**expand:** `typing.Optional[CommentsRetrieveRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. +**converted_contact_id:** `typing.Optional[str]` — If provided, will only return leads with this contact.
@@ -13857,7 +13687,7 @@ client.ticketing.comments.retrieve(
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. +**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
@@ -13865,7 +13695,7 @@ client.ticketing.comments.retrieve(
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). +**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
@@ -13873,130 +13703,23 @@ client.ticketing.comments.retrieve(
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. +**cursor:** `typing.Optional[str]` — The pagination cursor value. -
-
- -
- - - - -
- -
client.ticketing.comments.meta_post_retrieve() -
-
- -#### 📝 Description - -
-
- -
-
- -Returns metadata for `Comment` POSTs. -
-
-
-
- -#### 🔌 Usage - -
-
- -
-
- -```python -from merge import Merge - -client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.ticketing.comments.meta_post_retrieve() - -``` -
-
-#### ⚙️ Parameters - -
-
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. +**email_addresses:** `typing.Optional[str]` — If provided, will only return contacts matching the email addresses; multiple email_addresses can be separated by commas. -
-
-
-
- - -
-
-
- -## Ticketing Contacts -
client.ticketing.contacts.list(...) -
-
- -#### 📝 Description - -
-
- -
-
- -Returns a list of `Contact` objects. -
-
-
-
- -#### 🔌 Usage - -
-
- -
-
- -```python -from merge import Merge - -client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.ticketing.contacts.list() - -``` -
-
-#### ⚙️ Parameters - -
-
-
-**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime. +**expand:** `typing.Optional[LeadsListRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -14004,7 +13727,7 @@ client.ticketing.contacts.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/).
@@ -14012,7 +13735,7 @@ client.ticketing.contacts.list()
-**cursor:** `typing.Optional[str]` — The pagination cursor value. +**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -14020,7 +13743,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. +**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.
@@ -14028,7 +13751,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/). +**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -14036,7 +13759,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. +**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
@@ -14044,7 +13767,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). +**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
@@ -14052,7 +13775,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. +**owner_id:** `typing.Optional[str]` — If provided, will only return leads with this owner.
@@ -14060,7 +13783,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. +**page_size:** `typing.Optional[int]` — Number of results to return per page.
@@ -14068,7 +13791,7 @@ client.ticketing.contacts.list()
-**page_size:** `typing.Optional[int]` — Number of results to return per page. +**phone_numbers:** `typing.Optional[str]` — If provided, will only return contacts matching the phone numbers; multiple phone numbers can be separated by commas.
@@ -14096,7 +13819,7 @@ client.ticketing.contacts.list()
-
client.ticketing.contacts.create(...) +
client.crm.leads.create(...)
@@ -14108,7 +13831,7 @@ client.ticketing.contacts.list()
-Creates a `Contact` object with the given values. +Creates a `Lead` object with the given values.
@@ -14124,14 +13847,14 @@ Creates a `Contact` object with the given values. ```python from merge import Merge -from merge.resources.ticketing import ContactRequest +from merge.resources.crm import LeadRequest client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.contacts.create( - model=ContactRequest(), +client.crm.leads.create( + model=LeadRequest(), ) ``` @@ -14148,7 +13871,7 @@ client.ticketing.contacts.create(
-**model:** `ContactRequest` +**model:** `LeadRequest`
@@ -14184,7 +13907,7 @@ client.ticketing.contacts.create(
-
client.ticketing.contacts.retrieve(...) +
client.crm.leads.retrieve(...)
@@ -14196,7 +13919,7 @@ client.ticketing.contacts.create(
-Returns a `Contact` object with the given `id`. +Returns a `Lead` object with the given `id`.
@@ -14217,7 +13940,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.contacts.retrieve( +client.crm.leads.retrieve( id="id", ) @@ -14243,7 +13966,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. +**expand:** `typing.Optional[LeadsRetrieveRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -14259,6 +13982,14 @@ client.ticketing.contacts.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).
@@ -14279,7 +14010,7 @@ client.ticketing.contacts.retrieve(
-
client.ticketing.contacts.meta_post_retrieve() +
client.crm.leads.meta_post_retrieve()
@@ -14291,7 +14022,7 @@ client.ticketing.contacts.retrieve(
-Returns metadata for `TicketingContact` POSTs. +Returns metadata for `Lead` POSTs.
@@ -14312,7 +14043,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.contacts.meta_post_retrieve() +client.crm.leads.meta_post_retrieve() ``` @@ -14340,8 +14071,7 @@ client.ticketing.contacts.meta_post_retrieve()
-## Ticketing Scopes -
client.ticketing.scopes.default_scopes_retrieve() +
client.crm.leads.remote_field_classes_list(...)
@@ -14353,7 +14083,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). +Returns a list of `RemoteFieldClass` objects.
@@ -14374,7 +14104,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.scopes.default_scopes_retrieve() +client.crm.leads.remote_field_classes_list() ``` @@ -14390,64 +14120,67 @@ client.ticketing.scopes.default_scopes_retrieve()
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. +**cursor:** `typing.Optional[str]` — The pagination cursor value.
- -
+
+
+**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/). +
-
-
client.ticketing.scopes.linked_account_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. + +
+
+**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. + +
+
+
-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). -
-
+**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). + -#### 🔌 Usage -
+**is_common_model_field:** `typing.Optional[bool]` — If provided, will only return remote field classes with this is_common_model_field value + +
+
+
-```python -from merge import Merge - -client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.ticketing.scopes.linked_account_scopes_retrieve() - -``` -
-
+**is_custom:** `typing.Optional[bool]` — If provided, will only return remote fields classes with this is_custom value + -#### ⚙️ Parameters -
+**page_size:** `typing.Optional[int]` — Number of results to return per page. + +
+
+
@@ -14463,7 +14196,8 @@ client.ticketing.scopes.linked_account_scopes_retrieve()
-
client.ticketing.scopes.linked_account_scopes_create(...) +## Crm LinkToken +
client.crm.link_token.create(...)
@@ -14475,7 +14209,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) +Creates a link token to be used when linking a new end user.
@@ -14491,42 +14225,17 @@ 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, -) +from merge.resources.crm import CategoriesEnum 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.crm.link_token.create( + end_user_email_address="example@gmail.com", + end_user_organization_name="Test Organization", + end_user_origin_id="12345", + categories=[CategoriesEnum.HRIS, CategoriesEnum.ATS], ) ``` @@ -14543,7 +14252,7 @@ client.ticketing.scopes.linked_account_scopes_create(
-**common_models:** `typing.Sequence[IndividualCommonModelScopeDeserializerRequest]` — The common models you want to update the scopes for +**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.
@@ -14551,65 +14260,111 @@ client.ticketing.scopes.linked_account_scopes_create(
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. +**end_user_organization_name:** `str` — Your end user's organization.
+ +
+
+ +**end_user_origin_id:** `str` — This unique identifier typically represents the ID for your end user in your product's database. This value must be distinct from other Linked Accounts' unique identifiers. +
+
+
+**categories:** `typing.Sequence[CategoriesEnum]` — The integration categories to show in Merge Link. +
-
-## Ticketing DeleteAccount -
client.ticketing.delete_account.delete()
-#### 📝 Description +**integration:** `typing.Optional[str]` — The slug of a specific pre-selected integration for this linking flow token. For examples of slugs, see https://docs.merge.dev/guides/merge-link/single-integration/. + +
+
+**link_expiry_mins:** `typing.Optional[int]` — An integer number of minutes between [30, 720 or 10080 if for a Magic Link URL] for how long this token is valid. Defaults to 30. + +
+
+
-Delete a linked account. +**should_create_magic_link_url:** `typing.Optional[bool]` — Whether to generate a Magic Link URL. Defaults to false. For more information on Magic Link, see https://merge.dev/blog/integrations-fast-say-hello-to-magic-link. +
+ +
+
+ +**hide_admin_magic_link:** `typing.Optional[bool]` — Whether to generate a Magic Link URL on the Admin Needed screen during the linking flow. Defaults to false. For more information on Magic Link, see https://merge.dev/blog/integrations-fast-say-hello-to-magic-link. +
-#### 🔌 Usage +
+
+ +**common_models:** `typing.Optional[typing.Sequence[CommonModelScopesBodyRequest]]` — An array of objects to specify the models and fields that will be disabled for a given Linked Account. Each object uses model_id, enabled_actions, and disabled_fields to specify the model, method, and fields that are scoped for a given Linked Account. + +
+
+**category_common_model_scopes:** `typing.Optional[ + typing.Dict[ + str, + typing.Optional[ + typing.Sequence[IndividualCommonModelScopeDeserializerRequest] + ], + ] +]` — When creating a Link Token, you can set permissions for Common Models that will apply to the account that is going to be linked. Any model or field not specified in link token payload will default to existing settings. + +
+
+
-```python -from merge import Merge +**language:** `typing.Optional[EndUserDetailsRequestLanguage]` -client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.ticketing.delete_account.delete() +The following subset of IETF language tags can be used to configure localization. -``` +* `en` - en +* `de` - de +
+ +
+
+ +**are_syncs_disabled:** `typing.Optional[bool]` — The boolean that indicates whether initial, periodic, and force syncs will be disabled. +
-#### ⚙️ Parameters -
+**integration_specific_config:** `typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]]` — A JSON object containing integration-specific configuration options. + +
+
+
@@ -14625,8 +14380,8 @@ client.ticketing.delete_account.delete()
-## Ticketing FieldMapping -
client.ticketing.field_mapping.field_mappings_retrieve(...) +## Crm LinkedAccounts +
client.crm.linked_accounts.list(...)
@@ -14638,7 +14393,7 @@ client.ticketing.delete_account.delete()
-Get all Field Mappings for this Linked Account. Field Mappings are mappings between third-party Remote Fields and user defined Merge fields. [Learn more](https://docs.merge.dev/supplemental-data/field-mappings/overview/). +List linked accounts for your organization.
@@ -14659,7 +14414,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.field_mapping.field_mappings_retrieve() +client.crm.linked_accounts.list() ``` @@ -14675,7 +14430,17 @@ client.ticketing.field_mapping.field_mappings_retrieve()
-**exclude_remote_field_metadata:** `typing.Optional[bool]` — If `true`, remote fields metadata is excluded from each field mapping instance (i.e. `remote_fields.remote_key_name` and `remote_fields.schema` will be null). This will increase the speed of the request since these fields require some calculations. +**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
@@ -14683,75 +14448,47 @@ client.ticketing.field_mapping.field_mappings_retrieve()
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. +**cursor:** `typing.Optional[str]` — The pagination cursor value.
- -
+
+
+**end_user_email_address:** `typing.Optional[str]` — If provided, will only return linked accounts associated with the given email address. +
-
-
client.ticketing.field_mapping.field_mappings_create(...)
-#### 📝 Description - -
-
+**end_user_organization_name:** `typing.Optional[str]` — If provided, will only return linked accounts associated with the given organization name. + +
+
-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. -
-
+**end_user_origin_id:** `typing.Optional[str]` — If provided, will only return linked accounts associated with the given origin ID. +
-#### 🔌 Usage -
-
-
- -```python -from merge import Merge - -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", -) - -``` -
-
+**end_user_origin_ids:** `typing.Optional[str]` — Comma-separated list of EndUser origin IDs, making it possible to specify multiple EndUsers at once. +
-#### ⚙️ Parameters - -
-
-
-**target_field_name:** `str` — The name of the target field you want this remote field to map to. +**id:** `typing.Optional[str]`
@@ -14759,7 +14496,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. +**ids:** `typing.Optional[str]` — Comma-separated list of LinkedAccount IDs, making it possible to specify multiple LinkedAccounts at once.
@@ -14767,7 +14504,7 @@ 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. +**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.
@@ -14775,7 +14512,7 @@ client.ticketing.field_mapping.field_mappings_create(
-**remote_method:** `str` — The method of the remote endpoint where the remote field is coming from. +**integration_name:** `typing.Optional[str]` — If provided, will only return linked accounts associated with the given integration name.
@@ -14783,7 +14520,7 @@ client.ticketing.field_mapping.field_mappings_create(
-**remote_url_path:** `str` — The path of the remote endpoint where the remote field is coming from. +**is_test_account:** `typing.Optional[str]` — If included, will only include test linked accounts. If not included, will only include non-test linked accounts.
@@ -14791,7 +14528,7 @@ client.ticketing.field_mapping.field_mappings_create(
-**common_model_name:** `str` — The name of the Common Model that the remote field corresponds to in a given category. +**page_size:** `typing.Optional[int]` — Number of results to return per page.
@@ -14799,7 +14536,7 @@ client.ticketing.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. +**status:** `typing.Optional[str]` — Filter by status. Options: `COMPLETE`, `IDLE`, `INCOMPLETE`, `RELINK_NEEDED`
@@ -14819,7 +14556,8 @@ client.ticketing.field_mapping.field_mappings_create(
-
client.ticketing.field_mapping.field_mappings_destroy(...) +## Crm Notes +
client.crm.notes.list(...)
@@ -14831,7 +14569,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. +Returns a list of `Note` objects.
@@ -14852,9 +14590,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.field_mapping.field_mappings_destroy( - field_mapping_id="field_mapping_id", -) +client.crm.notes.list() ``` @@ -14870,7 +14606,7 @@ client.ticketing.field_mapping.field_mappings_destroy(
-**field_mapping_id:** `str` +**account_id:** `typing.Optional[str]` — If provided, will only return notes with this account.
@@ -14878,70 +14614,95 @@ client.ticketing.field_mapping.field_mappings_destroy(
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. +**contact_id:** `typing.Optional[str]` — If provided, will only return notes with this contact.
- -
+
+
+**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime. +
-
-
client.ticketing.field_mapping.field_mappings_partial_update(...)
-#### 📝 Description +**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime. + +
+
+**cursor:** `typing.Optional[str]` — The pagination cursor value. + +
+
+
-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. +**expand:** `typing.Optional[NotesListRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. +
+ +
+
+ +**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/). +
-#### 🔌 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_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format. + +
+
-client = 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", -) +
+
-``` +**include_shell_data:** `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. +
-#### ⚙️ Parameters -
+**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned. + +
+
+
-**field_mapping_id:** `str` +**opportunity_id:** `typing.Optional[str]` — If provided, will only return notes with this opportunity.
@@ -14949,7 +14710,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. +**owner_id:** `typing.Optional[str]` — If provided, will only return notes with this owner.
@@ -14957,7 +14718,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. +**page_size:** `typing.Optional[int]` — Number of results to return per page.
@@ -14965,7 +14726,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. +**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
@@ -14985,7 +14746,7 @@ client.ticketing.field_mapping.field_mappings_partial_update(
-
client.ticketing.field_mapping.remote_fields_retrieve(...) +
client.crm.notes.create(...)
@@ -14997,7 +14758,7 @@ client.ticketing.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 `Note` object with the given values.
@@ -15013,12 +14774,15 @@ Get all remote fields for a Linked Account. Remote fields are third-party fields ```python from merge import Merge +from merge.resources.crm import NoteRequest client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.field_mapping.remote_fields_retrieve() +client.crm.notes.create( + model=NoteRequest(), +) ``` @@ -15034,7 +14798,7 @@ client.ticketing.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. +**model:** `NoteRequest`
@@ -15042,7 +14806,15 @@ 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. +**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.
@@ -15062,7 +14834,7 @@ client.ticketing.field_mapping.remote_fields_retrieve()
-
client.ticketing.field_mapping.target_fields_retrieve() +
client.crm.notes.retrieve(...)
@@ -15074,7 +14846,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 `Note` object with the given `id`.
@@ -15095,7 +14867,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.field_mapping.target_fields_retrieve() +client.crm.notes.retrieve( + id="id", +) ``` @@ -15111,71 +14885,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 - -
-
+**expand:** `typing.Optional[NotesRetrieveRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. + +
+
-Create a remote key. -
-
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. +
-#### 🔌 Usage -
-
-
- -```python -from merge import Merge - -client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.ticketing.generate_key.create( - name="Remote Deployment Key 1", -) - -``` -
-
+**include_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format. +
-#### ⚙️ Parameters - -
-
-
-**name:** `str` — The name of the remote key +**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -15195,8 +14937,7 @@ client.ticketing.generate_key.create(
-## Ticketing Issues -
client.ticketing.issues.list(...) +
client.crm.notes.meta_post_retrieve()
@@ -15208,7 +14949,7 @@ client.ticketing.generate_key.create(
-Gets all issues for Organization. +Returns metadata for `Note` POSTs.
@@ -15229,7 +14970,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.issues.list() +client.crm.notes.meta_post_retrieve() ``` @@ -15245,55 +14986,68 @@ client.ticketing.issues.list()
-**account_token:** `typing.Optional[str]` +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+ +
-
-
-**cursor:** `typing.Optional[str]` — The pagination cursor value. -
+
+
client.crm.notes.remote_field_classes_list(...)
-**end_date:** `typing.Optional[str]` — If included, will only include issues whose most recent action occurred before this time - -
-
+#### 📝 Description
-**end_user_organization_name:** `typing.Optional[str]` - -
-
-
-**first_incident_time_after:** `typing.Optional[dt.datetime]` — If provided, will only return issues whose first incident time was after this datetime. - +Returns a list of `RemoteFieldClass` objects.
+ + + +#### 🔌 Usage
-**first_incident_time_before:** `typing.Optional[dt.datetime]` — If provided, will only return issues whose first incident time was before this datetime. - +
+
+ +```python +from merge import Merge + +client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.crm.notes.remote_field_classes_list() + +``` +
+
+#### ⚙️ Parameters +
-**include_muted:** `typing.Optional[str]` — If true, will include muted issues +
+
+ +**cursor:** `typing.Optional[str]` — The pagination cursor value.
@@ -15301,7 +15055,7 @@ client.ticketing.issues.list()
-**integration_name:** `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/).
@@ -15309,7 +15063,7 @@ client.ticketing.issues.list()
-**last_incident_time_after:** `typing.Optional[dt.datetime]` — If provided, will only return issues whose last incident time was after this datetime. +**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -15317,7 +15071,7 @@ client.ticketing.issues.list()
-**last_incident_time_before:** `typing.Optional[dt.datetime]` — If provided, will only return issues whose last incident time was before this datetime. +**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.
@@ -15325,7 +15079,7 @@ client.ticketing.issues.list()
-**linked_account_id:** `typing.Optional[str]` — If provided, will only include issues pertaining to the linked account passed in. +**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -15333,7 +15087,7 @@ client.ticketing.issues.list()
-**page_size:** `typing.Optional[int]` — Number of results to return per page. +**is_common_model_field:** `typing.Optional[bool]` — If provided, will only return remote field classes with this is_common_model_field value
@@ -15341,7 +15095,7 @@ client.ticketing.issues.list()
-**start_date:** `typing.Optional[str]` — If included, will only include issues whose most recent action occurred after this time +**is_custom:** `typing.Optional[bool]` — If provided, will only return remote fields classes with this is_custom value
@@ -15349,12 +15103,7 @@ client.ticketing.issues.list()
-**status:** `typing.Optional[IssuesListRequestStatus]` - -Status of the issue. Options: ('ONGOING', 'RESOLVED') - -* `ONGOING` - ONGOING -* `RESOLVED` - RESOLVED +**page_size:** `typing.Optional[int]` — Number of results to return per page.
@@ -15374,7 +15123,8 @@ Status of the issue. Options: ('ONGOING', 'RESOLVED')
-
client.ticketing.issues.retrieve(...) +## Crm Opportunities +
client.crm.opportunities.list(...)
@@ -15386,7 +15136,7 @@ Status of the issue. Options: ('ONGOING', 'RESOLVED')
-Get a specific issue. +Returns a list of `Opportunity` objects.
@@ -15407,9 +15157,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.issues.retrieve( - id="id", -) +client.crm.opportunities.list() ``` @@ -15425,7 +15173,7 @@ client.ticketing.issues.retrieve(
-**id:** `str` +**account_id:** `typing.Optional[str]` — If provided, will only return opportunities with this account.
@@ -15433,75 +15181,47 @@ client.ticketing.issues.retrieve(
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. +**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
- -
+
+
+**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime. +
-
-## Ticketing LinkToken -
client.ticketing.link_token.create(...)
-#### 📝 Description - -
-
+**cursor:** `typing.Optional[str]` — The pagination cursor value. + +
+
-Creates a link token to be used when linking a new end user. -
-
+**expand:** `typing.Optional[OpportunitiesListRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. +
-#### 🔌 Usage -
-
-
- -```python -from merge import Merge -from merge.resources.ticketing import CategoriesEnum - -client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.ticketing.link_token.create( - end_user_email_address="example@gmail.com", - end_user_organization_name="Test Organization", - end_user_origin_id="12345", - categories=[CategoriesEnum.HRIS, CategoriesEnum.ATS], -) - -``` -
-
+**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 - -
-
-
-**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. +**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -15509,7 +15229,7 @@ client.ticketing.link_token.create(
-**end_user_organization_name:** `str` — Your end user's organization. +**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.
@@ -15517,7 +15237,7 @@ client.ticketing.link_token.create(
-**end_user_origin_id:** `str` — This unique identifier typically represents the ID for your end user in your product's database. This value must be distinct from other Linked Accounts' unique identifiers. +**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -15525,7 +15245,7 @@ client.ticketing.link_token.create(
-**categories:** `typing.Sequence[CategoriesEnum]` — The integration categories to show in Merge Link. +**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
@@ -15533,7 +15253,7 @@ client.ticketing.link_token.create(
-**integration:** `typing.Optional[str]` — The slug of a specific pre-selected integration for this linking flow token. For examples of slugs, see https://docs.merge.dev/guides/merge-link/single-integration/. +**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
@@ -15541,7 +15261,7 @@ client.ticketing.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. +**owner_id:** `typing.Optional[str]` — If provided, will only return opportunities with this owner.
@@ -15549,7 +15269,7 @@ client.ticketing.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.
@@ -15557,7 +15277,7 @@ client.ticketing.link_token.create(
-**hide_admin_magic_link:** `typing.Optional[bool]` — Whether to generate a Magic Link URL on the Admin Needed screen during the linking flow. Defaults to false. For more information on Magic Link, see https://merge.dev/blog/integrations-fast-say-hello-to-magic-link. +**remote_created_after:** `typing.Optional[dt.datetime]` — If provided, will only return opportunities created in the third party platform after this datetime.
@@ -15565,7 +15285,7 @@ client.ticketing.link_token.create(
-**common_models:** `typing.Optional[typing.Sequence[CommonModelScopesBodyRequest]]` — An array of objects to specify the models and fields that will be disabled for a given Linked Account. Each object uses model_id, enabled_actions, and disabled_fields to specify the model, method, and fields that are scoped for a given Linked Account. +**remote_fields:** `typing.Optional[typing.Literal["status"]]` — Deprecated. Use show_enum_origins.
@@ -15573,14 +15293,7 @@ client.ticketing.link_token.create(
-**category_common_model_scopes:** `typing.Optional[ - typing.Dict[ - str, - typing.Optional[ - typing.Sequence[IndividualCommonModelScopeDeserializerRequest] - ], - ] -]` — When creating a Link Token, you can set permissions for Common Models that will apply to the account that is going to be linked. Any model or field not specified in link token payload will default to existing settings. +**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
@@ -15588,12 +15301,7 @@ client.ticketing.link_token.create(
-**language:** `typing.Optional[EndUserDetailsRequestLanguage]` - -The following subset of IETF language tags can be used to configure localization. - -* `en` - en -* `de` - de +**show_enum_origins:** `typing.Optional[typing.Literal["status"]]` — A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter)
@@ -15601,7 +15309,7 @@ The following subset of IETF language tags can be used to configure localization
-**are_syncs_disabled:** `typing.Optional[bool]` — The boolean that indicates whether initial, periodic, and force syncs will be disabled. +**stage_id:** `typing.Optional[str]` — If provided, will only return opportunities with this stage.
@@ -15609,7 +15317,13 @@ The following subset of IETF language tags can be used to configure localization
-**integration_specific_config:** `typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]]` — A JSON object containing integration-specific configuration options. +**status:** `typing.Optional[OpportunitiesListRequestStatus]` + +If provided, will only return opportunities with this status. Options: ('OPEN', 'WON', 'LOST') + +* `OPEN` - OPEN +* `WON` - WON +* `LOST` - LOST
@@ -15629,8 +15343,7 @@ The following subset of IETF language tags can be used to configure localization
-## Ticketing LinkedAccounts -
client.ticketing.linked_accounts.list(...) +
client.crm.opportunities.create(...)
@@ -15642,7 +15355,7 @@ The following subset of IETF language tags can be used to configure localization
-List linked accounts for your organization. +Creates an `Opportunity` object with the given values.
@@ -15658,12 +15371,15 @@ List linked accounts for your organization. ```python from merge import Merge +from merge.resources.crm import OpportunityRequest client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.linked_accounts.list() +client.crm.opportunities.create( + model=OpportunityRequest(), +) ``` @@ -15679,17 +15395,7 @@ client.ticketing.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 +**model:** `OpportunityRequest`
@@ -15697,7 +15403,7 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing`
-**cursor:** `typing.Optional[str]` — The pagination cursor value. +**is_debug_mode:** `typing.Optional[bool]` — Whether to include debug fields (such as log file links) in the response.
@@ -15705,7 +15411,7 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing`
-**end_user_email_address:** `typing.Optional[str]` — If provided, will only return linked accounts associated with the given email address. +**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously.
@@ -15713,31 +15419,70 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing`
-**end_user_organization_name:** `typing.Optional[str]` — If provided, will only return linked accounts associated with the given organization name. +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+ +
+ + + + +
+ +
client.crm.opportunities.retrieve(...) +
+
+ +#### 📝 Description
-**end_user_origin_id:** `typing.Optional[str]` — If provided, will only return linked accounts associated with the given origin ID. - +
+
+ +Returns an `Opportunity` object with the given `id`. +
+
+#### 🔌 Usage +
-**end_user_origin_ids:** `typing.Optional[str]` — Comma-separated list of EndUser origin IDs, making it possible to specify multiple EndUsers at once. - +
+
+ +```python +from merge import Merge + +client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.crm.opportunities.retrieve( + id="id", +) + +```
+
+
+ +#### ⚙️ Parameters
-**id:** `typing.Optional[str]` +
+
+ +**id:** `str`
@@ -15745,7 +15490,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. +**expand:** `typing.Optional[OpportunitiesRetrieveRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -15753,7 +15498,7 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing`
-**include_duplicates:** `typing.Optional[bool]` — If `true`, will include complete production duplicates of the account specified by the `id` query parameter in the response. `id` must be for a complete production linked account. +**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -15761,7 +15506,7 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing`
-**integration_name:** `typing.Optional[str]` — If provided, will only return linked accounts associated with the given integration name. +**include_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.
@@ -15769,7 +15514,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. +**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -15777,7 +15522,7 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing`
-**page_size:** `typing.Optional[int]` — Number of results to return per page. +**remote_fields:** `typing.Optional[typing.Literal["status"]]` — Deprecated. Use show_enum_origins.
@@ -15785,7 +15530,7 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing`
-**status:** `typing.Optional[str]` — Filter by status. Options: `COMPLETE`, `IDLE`, `INCOMPLETE`, `RELINK_NEEDED` +**show_enum_origins:** `typing.Optional[typing.Literal["status"]]` — A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter)
@@ -15805,8 +15550,7 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing`
-## Ticketing Passthrough -
client.ticketing.passthrough.create(...) +
client.crm.opportunities.partial_update(...)
@@ -15818,7 +15562,7 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing`
-Pull data from an endpoint not currently supported by Merge. +Updates an `Opportunity` object with the given `id`.
@@ -15834,17 +15578,15 @@ 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.crm import PatchedOpportunityRequest client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.passthrough.create( - request=DataPassthroughRequest( - method=MethodEnum.GET, - path="/scooters", - ), +client.crm.opportunities.partial_update( + id="id", + model=PatchedOpportunityRequest(), ) ``` @@ -15861,7 +15603,31 @@ client.ticketing.passthrough.create(
-**request:** `DataPassthroughRequest` +**id:** `str` + +
+
+ +
+
+ +**model:** `PatchedOpportunityRequest` + +
+
+ +
+
+ +**is_debug_mode:** `typing.Optional[bool]` — Whether to include debug fields (such as log file links) in the response. + +
+
+ +
+
+ +**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously.
@@ -15881,8 +15647,7 @@ client.ticketing.passthrough.create(
-## Ticketing Projects -
client.ticketing.projects.list(...) +
client.crm.opportunities.meta_patch_retrieve(...)
@@ -15894,7 +15659,7 @@ client.ticketing.passthrough.create(
-Returns a list of `Project` objects. +Returns metadata for `Opportunity` PATCHs.
@@ -15915,7 +15680,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.projects.list() +client.crm.opportunities.meta_patch_retrieve( + id="id", +) ``` @@ -15931,7 +15698,7 @@ client.ticketing.projects.list()
-**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime. +**id:** `str`
@@ -15939,75 +15706,64 @@ client.ticketing.projects.list()
-**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime. +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
- -
-
- -**cursor:** `typing.Optional[str]` — The pagination cursor value. -
-
-
-**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/). -
+
+
client.crm.opportunities.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 `Opportunity` 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.crm.opportunities.meta_post_retrieve() + +``` +
+
+#### ⚙️ Parameters +
-**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object. - -
-
-
@@ -16023,7 +15779,7 @@ client.ticketing.projects.list()
-
client.ticketing.projects.retrieve(...) +
client.crm.opportunities.remote_field_classes_list(...)
@@ -16035,7 +15791,7 @@ client.ticketing.projects.list()
-Returns a `Project` object with the given `id`. +Returns a list of `RemoteFieldClass` objects.
@@ -16056,9 +15812,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.projects.retrieve( - id="id", -) +client.crm.opportunities.remote_field_classes_list() ``` @@ -16074,7 +15828,15 @@ client.ticketing.projects.retrieve(
-**id:** `str` +**cursor:** `typing.Optional[str]` — The pagination cursor value. + +
+
+ +
+
+ +**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
@@ -16090,6 +15852,14 @@ client.ticketing.projects.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).
@@ -16098,6 +15868,30 @@ client.ticketing.projects.retrieve(
+**is_common_model_field:** `typing.Optional[bool]` — If provided, will only return remote field classes with this is_common_model_field value + +
+
+ +
+
+ +**is_custom:** `typing.Optional[bool]` — If provided, will only return remote fields classes with this is_custom value + +
+
+ +
+
+ +**page_size:** `typing.Optional[int]` — Number of results to return per page. + +
+
+ +
+
+ **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -16110,7 +15904,8 @@ client.ticketing.projects.retrieve(
-
client.ticketing.projects.users_list(...) +## Crm Passthrough +
client.crm.passthrough.create(...)
@@ -16122,7 +15917,7 @@ client.ticketing.projects.retrieve(
-Returns a list of `User` objects. +Pull data from an endpoint not currently supported by Merge.
@@ -16138,13 +15933,17 @@ Returns a list of `User` objects. ```python from merge import Merge +from merge.resources.crm import DataPassthroughRequest, MethodEnum client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.projects.users_list( - parent_id="parent_id", +client.crm.passthrough.create( + request=DataPassthroughRequest( + method=MethodEnum.GET, + path="/scooters", + ), ) ``` @@ -16161,55 +15960,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. - -
-
- -
-
- -**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/). - -
-
- -
-
- -**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. - -
-
- -
-
- -**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). - -
-
- -
-
- -**page_size:** `typing.Optional[int]` — Number of results to return per page. +**request:** `DataPassthroughRequest`
@@ -16229,8 +15980,8 @@ client.ticketing.projects.users_list(
-## Ticketing RegenerateKey -
client.ticketing.regenerate_key.create(...) +## Crm RegenerateKey +
client.crm.regenerate_key.create(...)
@@ -16263,7 +16014,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.regenerate_key.create( +client.crm.regenerate_key.create( name="Remote Deployment Key 1", ) @@ -16301,8 +16052,8 @@ client.ticketing.regenerate_key.create(
-## Ticketing Roles -
client.ticketing.roles.list(...) +## Crm Stages +
client.crm.stages.list(...)
@@ -16314,7 +16065,7 @@ client.ticketing.regenerate_key.create(
-Returns a list of `Role` objects. +Returns a list of `Stage` objects.
@@ -16335,7 +16086,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.roles.list() +client.crm.stages.list() ``` @@ -16391,6 +16142,14 @@ client.ticketing.roles.list()
+**include_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format. + +
+
+ +
+
+ **include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -16443,7 +16202,7 @@ client.ticketing.roles.list()
-
client.ticketing.roles.retrieve(...) +
client.crm.stages.retrieve(...)
@@ -16455,7 +16214,7 @@ client.ticketing.roles.list()
-Returns a `Role` object with the given `id`. +Returns a `Stage` object with the given `id`.
@@ -16476,7 +16235,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.roles.retrieve( +client.crm.stages.retrieve( id="id", ) @@ -16510,6 +16269,14 @@ client.ticketing.roles.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).
@@ -16530,8 +16297,7 @@ client.ticketing.roles.retrieve(
-## Ticketing SyncStatus -
client.ticketing.sync_status.list(...) +
client.crm.stages.remote_field_classes_list(...)
@@ -16543,7 +16309,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 `RemoteFieldClass` objects.
@@ -16564,7 +16330,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.sync_status.list() +client.crm.stages.remote_field_classes_list() ``` @@ -16588,7 +16354,7 @@ client.ticketing.sync_status.list()
-**page_size:** `typing.Optional[int]` — Number of results to return per page. +**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/).
@@ -16596,65 +16362,51 @@ client.ticketing.sync_status.list()
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. +**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
- -
+
+
+**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. +
-
-## 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). + +
+
-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. -
-
+**is_common_model_field:** `typing.Optional[bool]` — If provided, will only return remote field classes with this is_common_model_field value +
-#### 🔌 Usage - -
-
-
-```python -from merge import Merge - -client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.ticketing.force_resync.sync_status_resync_create() - -``` -
-
+**is_custom:** `typing.Optional[bool]` — If provided, will only return remote fields classes with this is_custom value +
-#### ⚙️ Parameters -
+**page_size:** `typing.Optional[int]` — Number of results to return per page. + +
+
+
@@ -16670,8 +16422,8 @@ client.ticketing.force_resync.sync_status_resync_create()
-## Ticketing Tags -
client.ticketing.tags.list(...) +## Crm SyncStatus +
client.crm.sync_status.list(...)
@@ -16683,7 +16435,7 @@ client.ticketing.force_resync.sync_status_resync_create()
-Returns a list of `Tag` objects. +Get sync status for the current sync and the most recently finished sync. `last_sync_start` represents the most recent time any sync began. `last_sync_finished` represents the most recent time any sync completed. These timestamps may correspond to different sync instances which may result in a sync start time being later than a separate sync completed time. To ensure you are retrieving the latest available data reference the `last_sync_finished` timestamp where `last_sync_result` is `DONE`. Possible values for `status` and `last_sync_result` are `DISABLED`, `DONE`, `FAILED`, `PARTIALLY_SYNCED`, `PAUSED`, `SYNCING`. Learn more about sync status in our [Help Center](https://help.merge.dev/en/articles/8184193-merge-sync-statuses).
@@ -16704,7 +16456,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.tags.list() +client.crm.sync_status.list() ``` @@ -16720,7 +16472,7 @@ client.ticketing.tags.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.
@@ -16728,7 +16480,7 @@ client.ticketing.tags.list()
-**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime. +**page_size:** `typing.Optional[int]` — Number of results to return per page.
@@ -16736,83 +16488,20 @@ client.ticketing.tags.list()
-**cursor:** `typing.Optional[str]` — The pagination cursor value. +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+ +
-
-
-**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/). -
+
-
-
- -**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. - -
-
- -
-
- -**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object. - -
-
- -
-
- -**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. - -
-
- - - - - - -
- -
client.ticketing.tags.retrieve(...) +## Crm ForceResync +
client.crm.force_resync.sync_status_resync_create()
@@ -16824,7 +16513,7 @@ client.ticketing.tags.list()
-Returns a `Tag` object with the given `id`. +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.
@@ -16845,9 +16534,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.tags.retrieve( - id="id", -) +client.crm.force_resync.sync_status_resync_create() ``` @@ -16863,30 +16550,6 @@ client.ticketing.tags.retrieve(
-**id:** `str` - -
-
- -
-
- -**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. - -
-
- -
-
- -**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). - -
-
- -
-
- **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -16899,8 +16562,8 @@ client.ticketing.tags.retrieve(
-## Ticketing Teams -
client.ticketing.teams.list(...) +## Crm Tasks +
client.crm.tasks.list(...)
@@ -16912,7 +16575,7 @@ client.ticketing.tags.retrieve(
-Returns a list of `Team` objects. +Returns a list of `Task` objects.
@@ -16933,7 +16596,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.teams.list() +client.crm.tasks.list() ``` @@ -16973,6 +16636,14 @@ client.ticketing.teams.list()
+**expand:** `typing.Optional[TasksListRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. + +
+
+ +
+
+ **include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
@@ -16989,6 +16660,14 @@ client.ticketing.teams.list()
+**include_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format. + +
+
+ +
+
+ **include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -17041,7 +16720,7 @@ client.ticketing.teams.list()
-
client.ticketing.teams.retrieve(...) +
client.crm.tasks.create(...)
@@ -17053,7 +16732,7 @@ client.ticketing.teams.list()
-Returns a `Team` object with the given `id`. +Creates a `Task` object with the given values.
@@ -17069,13 +16748,14 @@ Returns a `Team` object with the given `id`. ```python from merge import Merge +from merge.resources.crm import TaskRequest client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.teams.retrieve( - id="id", +client.crm.tasks.create( + model=TaskRequest(), ) ``` @@ -17092,7 +16772,7 @@ client.ticketing.teams.retrieve(
-**id:** `str` +**model:** `TaskRequest`
@@ -17100,7 +16780,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. +**is_debug_mode:** `typing.Optional[bool]` — Whether to include debug fields (such as log file links) in the response.
@@ -17108,7 +16788,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). +**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously.
@@ -17128,8 +16808,7 @@ client.ticketing.teams.retrieve(
-## Ticketing Tickets -
client.ticketing.tickets.list(...) +
client.crm.tasks.retrieve(...)
@@ -17141,7 +16820,7 @@ client.ticketing.teams.retrieve(
-Returns a list of `Ticket` objects. +Returns a `Task` object with the given `id`.
@@ -17162,7 +16841,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.tickets.list() +client.crm.tasks.retrieve( + id="id", +) ``` @@ -17178,7 +16859,7 @@ client.ticketing.tickets.list()
-**account_id:** `typing.Optional[str]` — If provided, will only return tickets for this account. +**id:** `str`
@@ -17186,7 +16867,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[TasksRetrieveRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -17194,7 +16875,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.
@@ -17202,7 +16883,7 @@ client.ticketing.tickets.list()
-**completed_after:** `typing.Optional[dt.datetime]` — If provided, will only return tickets completed 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.
@@ -17210,7 +16891,7 @@ client.ticketing.tickets.list()
-**completed_before:** `typing.Optional[dt.datetime]` — If provided, will only return tickets completed 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).
@@ -17218,79 +16899,72 @@ client.ticketing.tickets.list()
-**contact_id:** `typing.Optional[str]` — If provided, will only return tickets for this contact. +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
- -
-
- -**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime. -
-
-
-**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime. -
+
+
client.crm.tasks.partial_update(...)
-**cursor:** `typing.Optional[str]` — The pagination cursor value. - -
-
+#### 📝 Description
-**due_after:** `typing.Optional[dt.datetime]` — If provided, will only return tickets due after this datetime. - -
-
-
-**due_before:** `typing.Optional[dt.datetime]` — If provided, will only return tickets due before this datetime. - +Updates a `Task` object with the given `id`.
+ + + +#### 🔌 Usage
-**expand:** `typing.Optional[TicketsListRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. - -
-
-
-**include_deleted_data:** `typing.Optional[bool]` — 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 +from merge.resources.crm import PatchedTaskRequest + +client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.crm.tasks.partial_update( + id="id", + model=PatchedTaskRequest(), +) + +``` +
+
+#### ⚙️ Parameters +
-**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. +**id:** `str`
@@ -17298,7 +16972,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). +**model:** `PatchedTaskRequest`
@@ -17306,7 +16980,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. +**is_debug_mode:** `typing.Optional[bool]` — Whether to include debug fields (such as log file links) in the response.
@@ -17314,7 +16988,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. +**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously.
@@ -17322,118 +16996,70 @@ client.ticketing.tickets.list()
-**page_size:** `typing.Optional[int]` — Number of results to return per page. +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+ + -
-
-**parent_ticket_id:** `typing.Optional[str]` — If provided, will only return sub tickets of the parent_ticket_id. -
+
+
client.crm.tasks.meta_patch_retrieve(...)
-**priority:** `typing.Optional[TicketsListRequestPriority]` - -If provided, will only return tickets of this priority. - -* `URGENT` - URGENT -* `HIGH` - HIGH -* `NORMAL` - NORMAL -* `LOW` - LOW - -
-
+#### 📝 Description
-**remote_created_after:** `typing.Optional[dt.datetime]` — If provided, will only return tickets created in the third party platform after this datetime. - -
-
-
-**remote_created_before:** `typing.Optional[dt.datetime]` — If provided, will only return tickets created in the third party platform before this datetime. - +Returns metadata for `Task` PATCHs.
+ + + +#### 🔌 Usage
-**remote_fields:** `typing.Optional[TicketsListRequestRemoteFields]` — Deprecated. Use show_enum_origins. - -
-
- -
-
- -**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object. - -
-
- -
-
- -**remote_updated_after:** `typing.Optional[dt.datetime]` — If provided, will only return tickets updated in the third party platform after this datetime. - -
-
-
-**remote_updated_before:** `typing.Optional[dt.datetime]` — If provided, will only return tickets updated in the third party platform before this datetime. - -
-
+```python +from merge import Merge -
-
+client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.crm.tasks.meta_patch_retrieve( + id="id", +) -**show_enum_origins:** `typing.Optional[TicketsListRequestShowEnumOrigins]` — A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter) - +```
- -
-
- -**status:** `typing.Optional[str]` — If provided, will only return tickets of this status. -
-
-
- -**tags:** `typing.Optional[str]` — If provided, will only return tickets matching the tags; multiple tags can be separated by commas. - -
-
+#### ⚙️ Parameters
-**ticket_type:** `typing.Optional[str]` — If provided, will only return tickets of this type. - -
-
-
-**ticket_url:** `typing.Optional[str]` — If provided, will only return tickets where the URL matches or contains the substring +**id:** `str`
@@ -17453,7 +17079,7 @@ If provided, will only return tickets of this priority.
-
client.ticketing.tickets.create(...) +
client.crm.tasks.meta_post_retrieve()
@@ -17465,7 +17091,7 @@ If provided, will only return tickets of this priority.
-Creates a `Ticket` object with the given values. +Returns metadata for `Task` POSTs.
@@ -17481,15 +17107,12 @@ Creates a `Ticket` object with the given values. ```python from merge import Merge -from merge.resources.ticketing import TicketRequest client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.tickets.create( - model=TicketRequest(), -) +client.crm.tasks.meta_post_retrieve() ``` @@ -17505,30 +17128,6 @@ client.ticketing.tickets.create(
-**model:** `TicketRequest` - -
-
- -
-
- -**is_debug_mode:** `typing.Optional[bool]` — Whether to include debug fields (such as log file links) in the response. - -
-
- -
-
- -**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously. - -
-
- -
-
- **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -17541,7 +17140,7 @@ client.ticketing.tickets.create(
-
client.ticketing.tickets.retrieve(...) +
client.crm.tasks.remote_field_classes_list(...)
@@ -17553,7 +17152,7 @@ client.ticketing.tickets.create(
-Returns a `Ticket` object with the given `id`. +Returns a list of `RemoteFieldClass` objects.
@@ -17574,9 +17173,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.tickets.retrieve( - id="id", -) +client.crm.tasks.remote_field_classes_list() ``` @@ -17592,7 +17189,7 @@ client.ticketing.tickets.retrieve(
-**id:** `str` +**cursor:** `typing.Optional[str]` — The pagination cursor value.
@@ -17600,7 +17197,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. +**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/).
@@ -17632,7 +17229,7 @@ client.ticketing.tickets.retrieve(
-**remote_fields:** `typing.Optional[TicketsRetrieveRequestRemoteFields]` — Deprecated. Use show_enum_origins. +**is_common_model_field:** `typing.Optional[bool]` — If provided, will only return remote field classes with this is_common_model_field value
@@ -17640,7 +17237,15 @@ 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) +**is_custom:** `typing.Optional[bool]` — If provided, will only return remote fields classes with this is_custom value + +
+
+ +
+
+ +**page_size:** `typing.Optional[int]` — Number of results to return per page.
@@ -17660,7 +17265,8 @@ client.ticketing.tickets.retrieve(
-
client.ticketing.tickets.partial_update(...) +## Crm Users +
client.crm.users.list(...)
@@ -17672,7 +17278,7 @@ client.ticketing.tickets.retrieve(
-Updates a `Ticket` object with the given `id`. +Returns a list of `User` objects.
@@ -17688,16 +17294,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.crm.users.list() ``` @@ -17713,7 +17315,7 @@ client.ticketing.tickets.partial_update(
-**id:** `str` +**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
@@ -17721,7 +17323,7 @@ client.ticketing.tickets.partial_update(
-**model:** `PatchedTicketRequest` +**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
@@ -17729,7 +17331,7 @@ client.ticketing.tickets.partial_update(
-**is_debug_mode:** `typing.Optional[bool]` — Whether to include debug fields (such as log file links) in the response. +**cursor:** `typing.Optional[str]` — The pagination cursor value.
@@ -17737,7 +17339,7 @@ client.ticketing.tickets.partial_update(
-**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously. +**email:** `typing.Optional[str]` — If provided, will only return users with this email.
@@ -17745,70 +17347,15 @@ client.ticketing.tickets.partial_update(
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. +**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
- -
- - - - -
- -
client.ticketing.tickets.viewers_list(...) -
-
- -#### 📝 Description - -
-
- -
-
- -Returns a list of `Viewer` objects that point to a User id or Team id that is either an assignee or viewer on a `Ticket` with the given id. [Learn more.](https://help.merge.dev/en/articles/10333658-ticketing-access-control-list-acls) -
-
-
-
- -#### 🔌 Usage - -
-
- -
-
- -```python -from merge import Merge - -client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.ticketing.tickets.viewers_list( - ticket_id="ticket_id", -) - -``` -
-
-
-
- -#### ⚙️ Parameters - -
-
-**ticket_id:** `str` +**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -17816,7 +17363,7 @@ client.ticketing.tickets.viewers_list(
-**cursor:** `typing.Optional[str]` — The pagination cursor value. +**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.
@@ -17824,7 +17371,7 @@ client.ticketing.tickets.viewers_list(
-**expand:** `typing.Optional[TicketsViewersListRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. +**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -17832,7 +17379,7 @@ client.ticketing.tickets.viewers_list(
-**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/). +**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
@@ -17840,7 +17387,7 @@ client.ticketing.tickets.viewers_list(
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. +**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
@@ -17848,7 +17395,7 @@ client.ticketing.tickets.viewers_list(
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). +**page_size:** `typing.Optional[int]` — Number of results to return per page.
@@ -17856,7 +17403,7 @@ client.ticketing.tickets.viewers_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.
@@ -17876,7 +17423,7 @@ client.ticketing.tickets.viewers_list(
-
client.ticketing.tickets.meta_patch_retrieve(...) +
client.crm.users.retrieve(...)
@@ -17888,7 +17435,7 @@ client.ticketing.tickets.viewers_list(
-Returns metadata for `Ticket` PATCHs. +Returns a `User` object with the given `id`.
@@ -17909,7 +17456,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.tickets.meta_patch_retrieve( +client.crm.users.retrieve( id="id", ) @@ -17935,6 +17482,30 @@ client.ticketing.tickets.meta_patch_retrieve(
+**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). + +
+
+ +
+
+ **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -17947,7 +17518,7 @@ client.ticketing.tickets.meta_patch_retrieve(
-
client.ticketing.tickets.meta_post_retrieve(...) +
client.crm.users.ignore_create(...)
@@ -17959,7 +17530,7 @@ client.ticketing.tickets.meta_patch_retrieve(
-Returns metadata for `Ticket` POSTs. +Ignores a specific row based on the `model_id` in the url. These records will have their properties set to null, and will not be updated in future syncs. The "reason" and "message" fields in the request body will be stored for audit purposes.
@@ -17975,12 +17546,18 @@ Returns metadata for `Ticket` POSTs. ```python from merge import Merge +from merge.resources.crm import IgnoreCommonModelRequest, ReasonEnum client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.tickets.meta_post_retrieve() +client.crm.users.ignore_create( + model_id="model_id", + request=IgnoreCommonModelRequest( + reason=ReasonEnum.GENERAL_CUSTOMER_REQUEST, + ), +) ``` @@ -17996,7 +17573,7 @@ client.ticketing.tickets.meta_post_retrieve()
-**collection_id:** `typing.Optional[str]` — If provided, will only return tickets for this collection. +**model_id:** `str`
@@ -18004,7 +17581,7 @@ client.ticketing.tickets.meta_post_retrieve()
-**ticket_type:** `typing.Optional[str]` — If provided, will only return tickets for this ticket type. +**request:** `IgnoreCommonModelRequest`
@@ -18024,7 +17601,7 @@ client.ticketing.tickets.meta_post_retrieve()
-
client.ticketing.tickets.remote_field_classes_list(...) +
client.crm.users.remote_field_classes_list(...)
@@ -18057,7 +17634,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.tickets.remote_field_classes_list() +client.crm.users.remote_field_classes_list() ```
@@ -18081,7 +17658,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 +**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/).
@@ -18089,7 +17666,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/). +**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -18097,7 +17674,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. +**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.
@@ -18149,8 +17726,8 @@ client.ticketing.tickets.remote_field_classes_list()
-## Ticketing Users -
client.ticketing.users.list(...) +## Crm WebhookReceivers +
client.crm.webhook_receivers.list()
@@ -18162,7 +17739,7 @@ client.ticketing.tickets.remote_field_classes_list()
-Returns a list of `User` objects. +Returns a list of `WebhookReceiver` objects.
@@ -18183,7 +17760,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.users.list() +client.crm.webhook_receivers.list() ``` @@ -18199,110 +17776,6 @@ client.ticketing.users.list()
-**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime. - -
-
- -
-
- -**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime. - -
-
- -
-
- -**cursor:** `typing.Optional[str]` — The pagination cursor value. - -
-
- -
-
- -**email_address:** `typing.Optional[str]` — If provided, will only return users with emails equal to this value (case insensitive). - -
-
- -
-
- -**expand:** `typing.Optional[UsersListRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. - -
-
- -
-
- -**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/). - -
-
- -
-
- -**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. - -
-
- -
-
- -**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object. - -
-
- -
-
- -**team:** `typing.Optional[str]` — If provided, will only return users matching in this team. - -
-
- -
-
- **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -18315,7 +17788,7 @@ client.ticketing.users.list()
-
client.ticketing.users.retrieve(...) +
client.crm.webhook_receivers.create(...)
@@ -18327,7 +17800,7 @@ client.ticketing.users.list()
-Returns a `User` object with the given `id`. +Creates a `WebhookReceiver` object with the given values.
@@ -18348,8 +17821,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.users.retrieve( - id="id", +client.crm.webhook_receivers.create( + event="event", + is_active=True, ) ``` @@ -18366,15 +17840,7 @@ 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. +**event:** `str`
@@ -18382,7 +17848,7 @@ client.ticketing.users.retrieve(
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. +**is_active:** `bool`
@@ -18390,7 +17856,7 @@ client.ticketing.users.retrieve(
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). +**key:** `typing.Optional[str]`
@@ -18410,8 +17876,8 @@ client.ticketing.users.retrieve(
-## Ticketing WebhookReceivers -
client.ticketing.webhook_receivers.list() +## Filestorage AccountDetails +
client.filestorage.account_details.retrieve()
@@ -18423,7 +17889,7 @@ client.ticketing.users.retrieve(
-Returns a list of `WebhookReceiver` objects. +Get details for a linked account.
@@ -18444,7 +17910,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.webhook_receivers.list() +client.filestorage.account_details.retrieve() ``` @@ -18472,7 +17938,8 @@ client.ticketing.webhook_receivers.list()
-
client.ticketing.webhook_receivers.create(...) +## Filestorage AccountToken +
client.filestorage.account_token.retrieve(...)
@@ -18484,7 +17951,7 @@ client.ticketing.webhook_receivers.list()
-Creates a `WebhookReceiver` object with the given values. +Returns the account token for the end user with the provided public token.
@@ -18505,9 +17972,8 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.ticketing.webhook_receivers.create( - event="event", - is_active=True, +client.filestorage.account_token.retrieve( + public_token="public_token", ) ``` @@ -18524,23 +17990,7 @@ client.ticketing.webhook_receivers.create(
-**event:** `str` - -
-
- -
-
- -**is_active:** `bool` - -
-
- -
-
- -**key:** `typing.Optional[str]` +**public_token:** `str`
@@ -18560,8 +18010,8 @@ client.ticketing.webhook_receivers.create(
-## Crm AccountDetails -
client.crm.account_details.retrieve() +## Filestorage AsyncPassthrough +
client.filestorage.async_passthrough.create(...)
@@ -18573,7 +18023,7 @@ client.ticketing.webhook_receivers.create(
-Get details for a linked account. +Asynchronously pull data from an endpoint not currently supported by Merge.
@@ -18589,12 +18039,18 @@ Get details for a linked account. ```python from merge import Merge +from merge.resources.filestorage import DataPassthroughRequest, MethodEnum client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.account_details.retrieve() +client.filestorage.async_passthrough.create( + request=DataPassthroughRequest( + method=MethodEnum.GET, + path="/scooters", + ), +) ``` @@ -18610,6 +18066,14 @@ client.crm.account_details.retrieve()
+**request:** `DataPassthroughRequest` + +
+
+ +
+
+ **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -18622,8 +18086,7 @@ client.crm.account_details.retrieve()
-## Crm AccountToken -
client.crm.account_token.retrieve(...) +
client.filestorage.async_passthrough.retrieve(...)
@@ -18635,7 +18098,7 @@ client.crm.account_details.retrieve()
-Returns the account token for the end user with the provided public token. +Retrieves data from earlier async-passthrough POST request
@@ -18656,8 +18119,8 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.account_token.retrieve( - public_token="public_token", +client.filestorage.async_passthrough.retrieve( + async_passthrough_receipt_id="async_passthrough_receipt_id", ) ``` @@ -18674,7 +18137,7 @@ client.crm.account_token.retrieve(
-**public_token:** `str` +**async_passthrough_receipt_id:** `str`
@@ -18694,8 +18157,8 @@ client.crm.account_token.retrieve(
-## Crm Accounts -
client.crm.accounts.list(...) +## Filestorage AuditTrail +
client.filestorage.audit_trail.list(...)
@@ -18707,7 +18170,7 @@ client.crm.account_token.retrieve(
-Returns a list of `Account` objects. +Gets a list of audit trail events.
@@ -18728,7 +18191,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.accounts.list() +client.filestorage.audit_trail.list() ``` @@ -18744,7 +18207,7 @@ client.crm.accounts.list()
-**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime. +**cursor:** `typing.Optional[str]` — The pagination cursor value.
@@ -18752,7 +18215,7 @@ client.crm.accounts.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
@@ -18760,7 +18223,7 @@ client.crm.accounts.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`
@@ -18768,7 +18231,7 @@ client.crm.accounts.list()
-**expand:** `typing.Optional[typing.Literal["owner"]]` — 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.
@@ -18776,7 +18239,7 @@ client.crm.accounts.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/). +**start_date:** `typing.Optional[str]` — If included, will only include audit trail events that occurred after this time
@@ -18784,7 +18247,7 @@ client.crm.accounts.list()
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. +**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.
@@ -18792,95 +18255,32 @@ client.crm.accounts.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. +**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). -
-
-
-**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned. -
+
+## Filestorage AvailableActions +
client.filestorage.available_actions.retrieve()
-**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned. - -
-
+#### 📝 Description
-**name:** `typing.Optional[str]` — If provided, will only return accounts with this name. - -
-
-
-**owner_id:** `typing.Optional[str]` — If provided, will only return accounts with this owner. - -
-
- -
-
- -**page_size:** `typing.Optional[int]` — Number of results to return per page. - -
-
- -
-
- -**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object. - -
-
- -
-
- -**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. - -
-
- - - - - - -
- -
client.crm.accounts.create(...) -
-
- -#### 📝 Description - -
-
- -
-
- -Creates an `Account` object with the given values. +Returns a list of models and actions available for an account.
@@ -18896,15 +18296,12 @@ Creates an `Account` object with the given values. ```python from merge import Merge -from merge.resources.crm import AccountRequest client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.accounts.create( - model=AccountRequest(), -) +client.filestorage.available_actions.retrieve() ```
@@ -18920,30 +18317,6 @@ client.crm.accounts.create(
-**model:** `AccountRequest` - -
-
- -
-
- -**is_debug_mode:** `typing.Optional[bool]` — Whether to include debug fields (such as log file links) in the response. - -
-
- -
-
- -**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously. - -
-
- -
-
- **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -18956,7 +18329,8 @@ client.crm.accounts.create(
-
client.crm.accounts.retrieve(...) +## Filestorage Scopes +
client.filestorage.scopes.default_scopes_retrieve()
@@ -18968,7 +18342,7 @@ client.crm.accounts.create(
-Returns an `Account` 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).
@@ -18989,9 +18363,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.accounts.retrieve( - id="id", -) +client.filestorage.scopes.default_scopes_retrieve() ``` @@ -19007,46 +18379,6 @@ client.crm.accounts.retrieve(
-**id:** `str` - -
-
- -
-
- -**expand:** `typing.Optional[typing.Literal["owner"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. - -
-
- -
-
- -**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. - -
-
- -
-
- -**include_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format. - -
-
- -
-
- -**include_shell_data:** `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.
@@ -19059,7 +18391,7 @@ client.crm.accounts.retrieve(
-
client.crm.accounts.partial_update(...) +
client.filestorage.scopes.linked_account_scopes_retrieve()
@@ -19071,7 +18403,7 @@ client.crm.accounts.retrieve(
-Updates an `Account` object with the given `id`. +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).
@@ -19087,16 +18419,12 @@ Updates an `Account` object with the given `id`. ```python from merge import Merge -from merge.resources.crm import PatchedAccountRequest client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.accounts.partial_update( - id="id", - model=PatchedAccountRequest(), -) +client.filestorage.scopes.linked_account_scopes_retrieve() ``` @@ -19112,38 +18440,6 @@ client.crm.accounts.partial_update(
-**id:** `str` - -
-
- -
-
- -**model:** `PatchedAccountRequest` - -
-
- -
-
- -**is_debug_mode:** `typing.Optional[bool]` — Whether to include debug fields (such as log file links) in the response. - -
-
- -
-
- -**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously. - -
-
- -
-
- **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -19156,7 +18452,7 @@ client.crm.accounts.partial_update(
-
client.crm.accounts.meta_patch_retrieve(...) +
client.filestorage.scopes.linked_account_scopes_create(...)
@@ -19168,7 +18464,7 @@ client.crm.accounts.partial_update(
-Returns metadata for `CRMAccount` PATCHs. +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)
@@ -19184,13 +18480,42 @@ Returns metadata for `CRMAccount` PATCHs. ```python from merge import Merge +from merge.resources.filestorage import ( + FieldPermissionDeserializerRequest, + IndividualCommonModelScopeDeserializerRequest, + ModelPermissionDeserializerRequest, +) client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.accounts.meta_patch_retrieve( - id="id", +client.filestorage.scopes.linked_account_scopes_create( + common_models=[ + IndividualCommonModelScopeDeserializerRequest( + model_name="Employee", + model_permissions={ + "READ": ModelPermissionDeserializerRequest( + is_enabled=True, + ), + "WRITE": ModelPermissionDeserializerRequest( + is_enabled=False, + ), + }, + field_permissions=FieldPermissionDeserializerRequest( + enabled_fields=["avatar", "home_location"], + disabled_fields=["work_location"], + ), + ), + IndividualCommonModelScopeDeserializerRequest( + model_name="Benefit", + model_permissions={ + "WRITE": ModelPermissionDeserializerRequest( + is_enabled=False, + ) + }, + ), + ], ) ``` @@ -19207,7 +18532,7 @@ client.crm.accounts.meta_patch_retrieve(
-**id:** `str` +**common_models:** `typing.Sequence[IndividualCommonModelScopeDeserializerRequest]` — The common models you want to update the scopes for
@@ -19227,7 +18552,8 @@ client.crm.accounts.meta_patch_retrieve(
-
client.crm.accounts.meta_post_retrieve() +## Filestorage DeleteAccount +
client.filestorage.delete_account.delete()
@@ -19239,7 +18565,7 @@ client.crm.accounts.meta_patch_retrieve(
-Returns metadata for `CRMAccount` POSTs. +Delete a linked account.
@@ -19260,7 +18586,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.accounts.meta_post_retrieve() +client.filestorage.delete_account.delete() ``` @@ -19288,7 +18614,8 @@ client.crm.accounts.meta_post_retrieve()
-
client.crm.accounts.remote_field_classes_list(...) +## Filestorage Drives +
client.filestorage.drives.list(...)
@@ -19300,7 +18627,7 @@ client.crm.accounts.meta_post_retrieve()
-Returns a list of `RemoteFieldClass` objects. +Returns a list of `Drive` objects.
@@ -19321,7 +18648,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.accounts.remote_field_classes_list() +client.filestorage.drives.list() ``` @@ -19337,6 +18664,22 @@ client.crm.accounts.remote_field_classes_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.
@@ -19361,7 +18704,7 @@ client.crm.accounts.remote_field_classes_list()
-**include_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format. +**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -19369,7 +18712,7 @@ client.crm.accounts.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). +**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
@@ -19377,7 +18720,7 @@ client.crm.accounts.remote_field_classes_list()
-**is_common_model_field:** `typing.Optional[bool]` — If provided, will only return remote field classes with this is_common_model_field value +**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
@@ -19385,7 +18728,7 @@ client.crm.accounts.remote_field_classes_list()
-**is_custom:** `typing.Optional[bool]` — If provided, will only return remote fields classes with this is_custom value +**name:** `typing.Optional[str]` — If provided, will only return drives with this name. This performs an exact match.
@@ -19401,6 +18744,14 @@ client.crm.accounts.remote_field_classes_list()
+**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object. + +
+
+ +
+
+ **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -19413,8 +18764,7 @@ client.crm.accounts.remote_field_classes_list()
-## Crm AsyncPassthrough -
client.crm.async_passthrough.create(...) +
client.filestorage.drives.retrieve(...)
@@ -19426,7 +18776,7 @@ client.crm.accounts.remote_field_classes_list()
-Asynchronously pull data from an endpoint not currently supported by Merge. +Returns a `Drive` object with the given `id`.
@@ -19442,17 +18792,13 @@ Asynchronously pull data from an endpoint not currently supported by Merge. ```python from merge import Merge -from merge.resources.crm import DataPassthroughRequest, MethodEnum client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.async_passthrough.create( - request=DataPassthroughRequest( - method=MethodEnum.GET, - path="/scooters", - ), +client.filestorage.drives.retrieve( + id="id", ) ``` @@ -19469,7 +18815,23 @@ client.crm.async_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).
@@ -19489,7 +18851,8 @@ client.crm.async_passthrough.create(
-
client.crm.async_passthrough.retrieve(...) +## Filestorage FieldMapping +
client.filestorage.field_mapping.field_mappings_retrieve(...)
@@ -19501,7 +18864,7 @@ client.crm.async_passthrough.create(
-Retrieves data from earlier async-passthrough POST request +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/).
@@ -19522,9 +18885,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.async_passthrough.retrieve( - async_passthrough_receipt_id="async_passthrough_receipt_id", -) +client.filestorage.field_mapping.field_mappings_retrieve() ``` @@ -19540,7 +18901,7 @@ client.crm.async_passthrough.retrieve(
-**async_passthrough_receipt_id:** `str` +**exclude_remote_field_metadata:** `typing.Optional[bool]` — If `true`, remote fields metadata is excluded from each field mapping instance (i.e. `remote_fields.remote_key_name` and `remote_fields.schema` will be null). This will increase the speed of the request since these fields require some calculations.
@@ -19560,8 +18921,7 @@ client.crm.async_passthrough.retrieve(
-## Crm AuditTrail -
client.crm.audit_trail.list(...) +
client.filestorage.field_mapping.field_mappings_create(...)
@@ -19573,7 +18933,7 @@ client.crm.async_passthrough.retrieve(
-Gets a list of audit trail events. +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.
@@ -19594,7 +18954,14 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.audit_trail.list() +client.filestorage.field_mapping.field_mappings_create( + target_field_name="example_target_field_name", + target_field_description="this is a example description of the target field", + remote_field_traversal_path=["example_remote_field"], + remote_method="GET", + remote_url_path="/example-url-path", + common_model_name="ExampleCommonModel", +) ``` @@ -19610,7 +18977,7 @@ client.crm.audit_trail.list()
-**cursor:** `typing.Optional[str]` — The pagination cursor value. +**target_field_name:** `str` — The name of the target field you want this remote field to map to.
@@ -19618,7 +18985,7 @@ client.crm.audit_trail.list()
-**end_date:** `typing.Optional[str]` — If included, will only include audit trail events that occurred before this time +**target_field_description:** `str` — The description of the target field you want this remote field to map to.
@@ -19626,7 +18993,7 @@ client.crm.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` +**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.
@@ -19634,7 +19001,7 @@ client.crm.audit_trail.list()
-**page_size:** `typing.Optional[int]` — Number of results to return per page. +**remote_method:** `str` — The method of the remote endpoint where the remote field is coming from.
@@ -19642,7 +19009,7 @@ client.crm.audit_trail.list()
-**start_date:** `typing.Optional[str]` — If included, will only include audit trail events that occurred after this time +**remote_url_path:** `str` — The path of the remote endpoint where the remote field is coming from.
@@ -19650,7 +19017,15 @@ client.crm.audit_trail.list()
-**user_email:** `typing.Optional[str]` — If provided, this will return events associated with the specified user email. Please note that the email address reflects the user's email at the time of the event, and may not be their current email. +**common_model_name:** `str` — The name of the Common Model that the remote field corresponds to in a given category. + +
+
+ +
+
+ +**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.
@@ -19670,8 +19045,7 @@ client.crm.audit_trail.list()
-## Crm AvailableActions -
client.crm.available_actions.retrieve() +
client.filestorage.field_mapping.field_mappings_destroy(...)
@@ -19683,7 +19057,7 @@ client.crm.audit_trail.list()
-Returns a list of models and actions available for an account. +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.
@@ -19704,7 +19078,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.available_actions.retrieve() +client.filestorage.field_mapping.field_mappings_destroy( + field_mapping_id="field_mapping_id", +) ``` @@ -19720,6 +19096,14 @@ client.crm.available_actions.retrieve()
+**field_mapping_id:** `str` + +
+
+ +
+
+ **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -19732,8 +19116,7 @@ client.crm.available_actions.retrieve()
-## Crm Contacts -
client.crm.contacts.list(...) +
client.filestorage.field_mapping.field_mappings_partial_update(...)
@@ -19745,7 +19128,7 @@ client.crm.available_actions.retrieve()
-Returns a list of `Contact` 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.
@@ -19766,7 +19149,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.contacts.list() +client.filestorage.field_mapping.field_mappings_partial_update( + field_mapping_id="field_mapping_id", +) ``` @@ -19782,7 +19167,7 @@ client.crm.contacts.list()
-**account_id:** `typing.Optional[str]` — If provided, will only return contacts with this account. +**field_mapping_id:** `str`
@@ -19790,7 +19175,7 @@ client.crm.contacts.list()
-**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after 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.
@@ -19798,7 +19183,7 @@ client.crm.contacts.list()
-**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime. +**remote_method:** `typing.Optional[str]` — The method of the remote endpoint where the remote field is coming from.
@@ -19806,7 +19191,7 @@ client.crm.contacts.list()
-**cursor:** `typing.Optional[str]` — The pagination cursor value. +**remote_url_path:** `typing.Optional[str]` — The path of the remote endpoint where the remote field is coming from.
@@ -19814,79 +19199,68 @@ client.crm.contacts.list()
-**email_addresses:** `typing.Optional[str]` — If provided, will only return contacts matching the email addresses; multiple email_addresses can be separated by commas. +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
- -
-
- -**expand:** `typing.Optional[ContactsListRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. -
-
-
-**include_deleted_data:** `typing.Optional[bool]` — 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.filestorage.field_mapping.remote_fields_retrieve(...)
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. - -
-
+#### 📝 Description
-**include_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format. - -
-
-
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). - +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
-**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 + +client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.filestorage.field_mapping.remote_fields_retrieve() + +``` +
+
+#### ⚙️ Parameters +
-**page_size:** `typing.Optional[int]` — Number of results to return per page. - -
-
-
-**phone_numbers:** `typing.Optional[str]` — If provided, will only return contacts matching the phone numbers; multiple phone numbers can be separated by commas. +**common_models:** `typing.Optional[str]` — A comma seperated list of Common Model names. If included, will only return Remote Fields for those Common Models.
@@ -19894,7 +19268,7 @@ client.crm.contacts.list()
-**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object. +**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.
@@ -19914,7 +19288,7 @@ client.crm.contacts.list()
-
client.crm.contacts.create(...) +
client.filestorage.field_mapping.target_fields_retrieve()
@@ -19926,7 +19300,7 @@ client.crm.contacts.list()
-Creates a `Contact` object with the given values. +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/).
@@ -19942,15 +19316,12 @@ Creates a `Contact` object with the given values. ```python from merge import Merge -from merge.resources.crm import ContactRequest client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.contacts.create( - model=ContactRequest(), -) +client.filestorage.field_mapping.target_fields_retrieve() ``` @@ -19966,30 +19337,6 @@ client.crm.contacts.create(
-**model:** `ContactRequest` - -
-
- -
-
- -**is_debug_mode:** `typing.Optional[bool]` — Whether to include debug fields (such as log file links) in the response. - -
-
- -
-
- -**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously. - -
-
- -
-
- **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -20002,7 +19349,8 @@ client.crm.contacts.create(
-
client.crm.contacts.retrieve(...) +## Filestorage Files +
client.filestorage.files.list(...)
@@ -20014,7 +19362,7 @@ client.crm.contacts.create(
-Returns a `Contact` object with the given `id`. +Returns a list of `File` objects.
@@ -20035,9 +19383,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.contacts.retrieve( - id="id", -) +client.filestorage.files.list() ``` @@ -20053,7 +19399,7 @@ client.crm.contacts.retrieve(
-**id:** `str` +**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
@@ -20061,7 +19407,7 @@ client.crm.contacts.retrieve(
-**expand:** `typing.Optional[ContactsRetrieveRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. +**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
@@ -20069,7 +19415,7 @@ client.crm.contacts.retrieve(
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. +**cursor:** `typing.Optional[str]` — The pagination cursor value.
@@ -20077,7 +19423,7 @@ client.crm.contacts.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. +**drive_id:** `typing.Optional[str]` — Specifying a drive id returns only the files in that drive. Specifying null returns only the files outside the top-level drive.
@@ -20085,7 +19431,7 @@ client.crm.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). +**expand:** `typing.Optional[FilesListRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -20093,72 +19439,63 @@ client.crm.contacts.retrieve(
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. +**folder_id:** `typing.Optional[str]` — Specifying a folder id returns only the files in that folder. Specifying null returns only the files in root directory.
- -
+
+
+**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/). +
-
-
client.crm.contacts.partial_update(...)
-#### 📝 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). + +
+
+
-Updates a `Contact` object with the given `id`. -
-
+**mime_type:** `typing.Optional[str]` — If provided, will only return files with these mime_types. Multiple values can be separated by commas. + -#### 🔌 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.crm import PatchedContactRequest - -client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.crm.contacts.partial_update( - id="id", - model=PatchedContactRequest(), -) - -``` -
-
+**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned. + -#### ⚙️ Parameters - -
-
-
-**id:** `str` +**name:** `typing.Optional[str]` — If provided, will only return files with this name. This performs an exact match.
@@ -20166,7 +19503,7 @@ client.crm.contacts.partial_update(
-**model:** `PatchedContactRequest` +**order_by:** `typing.Optional[FilesListRequestOrderBy]` — Overrides the default ordering for this endpoint. Possible values include: created_at, -created_at, modified_at, -modified_at.
@@ -20174,7 +19511,7 @@ client.crm.contacts.partial_update(
-**is_debug_mode:** `typing.Optional[bool]` — Whether to include debug fields (such as log file links) in the response. +**page_size:** `typing.Optional[int]` — Number of results to return per page.
@@ -20182,7 +19519,7 @@ client.crm.contacts.partial_update(
-**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously. +**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
@@ -20202,7 +19539,7 @@ client.crm.contacts.partial_update(
-
client.crm.contacts.ignore_create(...) +
client.filestorage.files.create(...)
@@ -20214,7 +19551,7 @@ client.crm.contacts.partial_update(
-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. +Creates a `File` object with the given values.
@@ -20230,17 +19567,14 @@ Ignores a specific row based on the `model_id` in the url. These records will ha ```python from merge import Merge -from merge.resources.crm import IgnoreCommonModelRequest, ReasonEnum +from merge.resources.filestorage import FileRequest client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.contacts.ignore_create( - model_id="model_id", - request=IgnoreCommonModelRequest( - reason=ReasonEnum.GENERAL_CUSTOMER_REQUEST, - ), +client.filestorage.files.create( + model=FileRequest(), ) ``` @@ -20257,7 +19591,7 @@ client.crm.contacts.ignore_create(
-**model_id:** `str` +**model:** `FileRequest`
@@ -20265,7 +19599,15 @@ client.crm.contacts.ignore_create(
-**request:** `IgnoreCommonModelRequest` +**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.
@@ -20285,7 +19627,7 @@ client.crm.contacts.ignore_create(
-
client.crm.contacts.meta_patch_retrieve(...) +
client.filestorage.files.retrieve(...)
@@ -20297,7 +19639,7 @@ client.crm.contacts.ignore_create(
-Returns metadata for `CRMContact` PATCHs. +Returns a `File` object with the given `id`.
@@ -20318,7 +19660,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.contacts.meta_patch_retrieve( +client.filestorage.files.retrieve( id="id", ) @@ -20344,6 +19686,30 @@ client.crm.contacts.meta_patch_retrieve(
+**expand:** `typing.Optional[FilesRetrieveRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. + +
+
+ +
+
+ +**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. + +
+
+ +
+
+ +**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). + +
+
+ +
+
+ **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -20356,7 +19722,7 @@ client.crm.contacts.meta_patch_retrieve(
-
client.crm.contacts.meta_post_retrieve() +
client.filestorage.files.download_request_meta_retrieve(...)
@@ -20368,7 +19734,7 @@ client.crm.contacts.meta_patch_retrieve(
-Returns metadata for `CRMContact` POSTs. +Returns metadata to construct an authenticated file download request for a singular file, allowing you to download file directly from the third-party.
@@ -20389,7 +19755,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.contacts.meta_post_retrieve() +client.filestorage.files.download_request_meta_retrieve( + id="id", +) ``` @@ -20405,6 +19773,22 @@ client.crm.contacts.meta_post_retrieve()
+**id:** `str` + +
+
+ +
+
+ +**mime_type:** `typing.Optional[str]` — If provided, specifies the export format of the file to be downloaded. For information on supported export formats, please refer to our export format help center article. + +
+
+ +
+
+ **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -20417,7 +19801,7 @@ client.crm.contacts.meta_post_retrieve()
-
client.crm.contacts.remote_field_classes_list(...) +
client.filestorage.files.download_request_meta_list(...)
@@ -20429,7 +19813,7 @@ client.crm.contacts.meta_post_retrieve()
-Returns a list of `RemoteFieldClass` objects. +Returns metadata to construct authenticated file download requests, allowing you to download files directly from the third-party.
@@ -20450,7 +19834,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.contacts.remote_field_classes_list() +client.filestorage.files.download_request_meta_list() ``` @@ -20466,6 +19850,22 @@ client.crm.contacts.remote_field_classes_list()
+**created_after:** `typing.Optional[str]` — If provided, will only return objects created after this datetime. + +
+
+ +
+
+ +**created_before:** `typing.Optional[str]` — If provided, will only return objects created before this datetime. + +
+
+ +
+
+ **cursor:** `typing.Optional[str]` — The pagination cursor value.
@@ -20482,7 +19882,7 @@ client.crm.contacts.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. +**mime_types:** `typing.Optional[str]` — A comma-separated list of preferred MIME types in order of priority. If supported by the third-party provider, the file(s) will be returned in the first supported MIME type from the list. The default MIME type is PDF. To see supported MIME types by file type, refer to our export format help center article.
@@ -20490,7 +19890,7 @@ client.crm.contacts.remote_field_classes_list()
-**include_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format. +**modified_after:** `typing.Optional[str]` — If provided, will only return objects modified after this datetime.
@@ -20498,7 +19898,7 @@ client.crm.contacts.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). +**modified_before:** `typing.Optional[str]` — If provided, will only return objects modified before this datetime.
@@ -20506,7 +19906,7 @@ client.crm.contacts.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 +**order_by:** `typing.Optional[FilesDownloadRequestMetaListRequestOrderBy]` — Overrides the default ordering for this endpoint. Possible values include: created_at, -created_at, modified_at, -modified_at.
@@ -20514,7 +19914,7 @@ client.crm.contacts.remote_field_classes_list()
-**is_custom:** `typing.Optional[bool]` — If provided, will only return remote fields classes with this is_custom value +**page_size:** `typing.Optional[int]` — Number of results to return per page.
@@ -20522,10 +19922,63 @@ client.crm.contacts.remote_field_classes_list()
-**page_size:** `typing.Optional[int]` — Number of results to return per page. +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+ +
+ + + +
+
+ +
client.filestorage.files.meta_post_retrieve() +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Returns metadata for `FileStorageFile` POSTs. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from merge import Merge + +client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.filestorage.files.meta_post_retrieve() + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
@@ -20542,8 +19995,8 @@ client.crm.contacts.remote_field_classes_list()
-## Crm CustomObjectClasses -
client.crm.custom_object_classes.list(...) +## Filestorage Folders +
client.filestorage.folders.list(...)
@@ -20555,7 +20008,7 @@ client.crm.contacts.remote_field_classes_list()
-Returns a list of `CustomObjectClass` objects. +Returns a list of `Folder` objects.
@@ -20576,7 +20029,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.custom_object_classes.list() +client.filestorage.folders.list() ``` @@ -20616,7 +20069,15 @@ client.crm.custom_object_classes.list()
-**expand:** `typing.Optional[typing.Literal["fields"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. +**drive_id:** `typing.Optional[str]` — If provided, will only return folders in this drive. + +
+
+ +
+
+ +**expand:** `typing.Optional[FoldersListRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -20664,6 +20125,14 @@ client.crm.custom_object_classes.list()
+**name:** `typing.Optional[str]` — If provided, will only return folders with this name. This performs an exact match. + +
+
+ +
+
+ **page_size:** `typing.Optional[int]` — Number of results to return per page.
@@ -20672,6 +20141,14 @@ client.crm.custom_object_classes.list()
+**parent_folder_id:** `typing.Optional[str]` — If provided, will only return folders in this parent folder. If null, will return folders in root directory. + +
+
+ +
+
+ **remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
@@ -20692,7 +20169,7 @@ client.crm.custom_object_classes.list()
-
client.crm.custom_object_classes.retrieve(...) +
client.filestorage.folders.create(...)
@@ -20704,7 +20181,7 @@ client.crm.custom_object_classes.list()
-Returns a `CustomObjectClass` object with the given `id`. +Creates a `Folder` object with the given values.
@@ -20720,13 +20197,14 @@ Returns a `CustomObjectClass` object with the given `id`. ```python from merge import Merge +from merge.resources.filestorage import FolderRequest client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.custom_object_classes.retrieve( - id="id", +client.filestorage.folders.create( + model=FolderRequest(), ) ``` @@ -20743,15 +20221,7 @@ client.crm.custom_object_classes.retrieve(
-**id:** `str` - -
-
- -
-
- -**expand:** `typing.Optional[typing.Literal["fields"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. +**model:** `FolderRequest`
@@ -20759,7 +20229,7 @@ client.crm.custom_object_classes.retrieve(
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. +**is_debug_mode:** `typing.Optional[bool]` — Whether to include debug fields (such as log file links) in the response.
@@ -20767,7 +20237,7 @@ client.crm.custom_object_classes.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.
@@ -20787,8 +20257,7 @@ client.crm.custom_object_classes.retrieve(
-## Crm AssociationTypes -
client.crm.association_types.custom_object_classes_association_types_list(...) +
client.filestorage.folders.retrieve(...)
@@ -20800,7 +20269,7 @@ client.crm.custom_object_classes.retrieve(
-Returns a list of `AssociationType` objects. +Returns a `Folder` object with the given `id`.
@@ -20821,8 +20290,8 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.association_types.custom_object_classes_association_types_list( - custom_object_class_id="custom_object_class_id", +client.filestorage.folders.retrieve( + id="id", ) ``` @@ -20839,7 +20308,7 @@ client.crm.association_types.custom_object_classes_association_types_list(
-**custom_object_class_id:** `str` +**id:** `str`
@@ -20847,7 +20316,7 @@ client.crm.association_types.custom_object_classes_association_types_list(
-**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime. +**expand:** `typing.Optional[FoldersRetrieveRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -20855,7 +20324,7 @@ client.crm.association_types.custom_object_classes_association_types_list(
-**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime. +**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -20863,7 +20332,7 @@ client.crm.association_types.custom_object_classes_association_types_list(
-**cursor:** `typing.Optional[str]` — The pagination cursor value. +**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -20871,67 +20340,64 @@ client.crm.association_types.custom_object_classes_association_types_list(
-**expand:** `typing.Optional[typing.Literal["target_object_classes"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. +**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.filestorage.folders.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 `FileStorageFolder` 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.filestorage.folders.meta_post_retrieve() + +``` +
+
+#### ⚙️ Parameters +
-**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object. - -
-
-
@@ -20947,7 +20413,8 @@ client.crm.association_types.custom_object_classes_association_types_list(
-
client.crm.association_types.custom_object_classes_association_types_create(...) +## Filestorage GenerateKey +
client.filestorage.generate_key.create(...)
@@ -20959,7 +20426,7 @@ client.crm.association_types.custom_object_classes_association_types_list(
-Creates an `AssociationType` object with the given values. +Create a remote key.
@@ -20975,31 +20442,13 @@ Creates an `AssociationType` object with the given values. ```python from merge import Merge -from merge.resources.crm import ( - AssociationTypeRequestRequest, - ObjectClassDescriptionRequest, - OriginTypeEnum, -) client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.association_types.custom_object_classes_association_types_create( - custom_object_class_id="custom_object_class_id", - model=AssociationTypeRequestRequest( - source_object_class=ObjectClassDescriptionRequest( - id="id", - origin_type=OriginTypeEnum.CUSTOM_OBJECT, - ), - target_object_classes=[ - ObjectClassDescriptionRequest( - id="id", - origin_type=OriginTypeEnum.CUSTOM_OBJECT, - ) - ], - remote_key_name="remote_key_name", - ), +client.filestorage.generate_key.create( + name="Remote Deployment Key 1", ) ``` @@ -21016,31 +20465,7 @@ client.crm.association_types.custom_object_classes_association_types_create(
-**custom_object_class_id:** `str` - -
-
- -
-
- -**model:** `AssociationTypeRequestRequest` - -
-
- -
-
- -**is_debug_mode:** `typing.Optional[bool]` — Whether to include debug fields (such as log file links) in the response. - -
-
- -
-
- -**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously. +**name:** `str` — The name of the remote key
@@ -21060,7 +20485,8 @@ client.crm.association_types.custom_object_classes_association_types_create(
-
client.crm.association_types.custom_object_classes_association_types_retrieve(...) +## Filestorage Groups +
client.filestorage.groups.list(...)
@@ -21072,7 +20498,7 @@ client.crm.association_types.custom_object_classes_association_types_create(
-Returns an `AssociationType` object with the given `id`. +Returns a list of `Group` objects.
@@ -21093,10 +20519,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.association_types.custom_object_classes_association_types_retrieve( - custom_object_class_id="custom_object_class_id", - id="id", -) +client.filestorage.groups.list() ``` @@ -21112,7 +20535,7 @@ client.crm.association_types.custom_object_classes_association_types_retrieve(
-**custom_object_class_id:** `str` +**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
@@ -21120,7 +20543,7 @@ client.crm.association_types.custom_object_classes_association_types_retrieve(
-**id:** `str` +**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
@@ -21128,7 +20551,23 @@ client.crm.association_types.custom_object_classes_association_types_retrieve(
-**expand:** `typing.Optional[typing.Literal["target_object_classes"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. +**cursor:** `typing.Optional[str]` — The pagination cursor value. + +
+
+ +
+
+ +**expand:** `typing.Optional[typing.Literal["child_groups"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. + +
+
+ +
+
+ +**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
@@ -21152,6 +20591,38 @@ client.crm.association_types.custom_object_classes_association_types_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.
@@ -21164,7 +20635,7 @@ client.crm.association_types.custom_object_classes_association_types_retrieve(
-
client.crm.association_types.custom_object_classes_association_types_meta_post_retrieve(...) +
client.filestorage.groups.retrieve(...)
@@ -21176,7 +20647,7 @@ client.crm.association_types.custom_object_classes_association_types_retrieve(
-Returns metadata for `CRMAssociationType` POSTs. +Returns a `Group` object with the given `id`.
@@ -21197,8 +20668,8 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.association_types.custom_object_classes_association_types_meta_post_retrieve( - custom_object_class_id="custom_object_class_id", +client.filestorage.groups.retrieve( + id="id", ) ``` @@ -21215,7 +20686,31 @@ client.crm.association_types.custom_object_classes_association_types_meta_post_r
-**custom_object_class_id:** `str` +**id:** `str` + +
+
+ +
+
+ +**expand:** `typing.Optional[typing.Literal["child_groups"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. + +
+
+ +
+
+ +**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. + +
+
+ +
+
+ +**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -21235,8 +20730,8 @@ client.crm.association_types.custom_object_classes_association_types_meta_post_r
-## Crm CustomObjects -
client.crm.custom_objects.custom_object_classes_custom_objects_list(...) +## Filestorage Issues +
client.filestorage.issues.list(...)
@@ -21248,7 +20743,7 @@ client.crm.association_types.custom_object_classes_association_types_meta_post_r
-Returns a list of `CustomObject` objects. +Gets all issues for Organization.
@@ -21269,9 +20764,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.custom_objects.custom_object_classes_custom_objects_list( - custom_object_class_id="custom_object_class_id", -) +client.filestorage.issues.list() ``` @@ -21287,7 +20780,7 @@ client.crm.custom_objects.custom_object_classes_custom_objects_list(
-**custom_object_class_id:** `str` +**account_token:** `typing.Optional[str]`
@@ -21295,7 +20788,7 @@ client.crm.custom_objects.custom_object_classes_custom_objects_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.
@@ -21303,7 +20796,7 @@ client.crm.custom_objects.custom_object_classes_custom_objects_list(
-**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime. +**end_date:** `typing.Optional[str]` — If included, will only include issues whose most recent action occurred before this time
@@ -21311,7 +20804,7 @@ client.crm.custom_objects.custom_object_classes_custom_objects_list(
-**cursor:** `typing.Optional[str]` — The pagination cursor value. +**end_user_organization_name:** `typing.Optional[str]`
@@ -21319,7 +20812,7 @@ client.crm.custom_objects.custom_object_classes_custom_objects_list(
-**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/). +**first_incident_time_after:** `typing.Optional[dt.datetime]` — If provided, will only return issues whose first incident time was after this datetime.
@@ -21327,7 +20820,7 @@ client.crm.custom_objects.custom_object_classes_custom_objects_list(
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. +**first_incident_time_before:** `typing.Optional[dt.datetime]` — If provided, will only return issues whose first incident time was before this datetime.
@@ -21335,7 +20828,7 @@ client.crm.custom_objects.custom_object_classes_custom_objects_list(
-**include_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format. +**include_muted:** `typing.Optional[str]` — If true, will include muted issues
@@ -21343,7 +20836,7 @@ client.crm.custom_objects.custom_object_classes_custom_objects_list(
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). +**integration_name:** `typing.Optional[str]`
@@ -21351,7 +20844,7 @@ client.crm.custom_objects.custom_object_classes_custom_objects_list(
-**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned. +**last_incident_time_after:** `typing.Optional[dt.datetime]` — If provided, will only return issues whose last incident time was after this datetime.
@@ -21359,7 +20852,7 @@ client.crm.custom_objects.custom_object_classes_custom_objects_list(
-**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned. +**last_incident_time_before:** `typing.Optional[dt.datetime]` — If provided, will only return issues whose last incident time was before this datetime.
@@ -21367,7 +20860,7 @@ client.crm.custom_objects.custom_object_classes_custom_objects_list(
-**page_size:** `typing.Optional[int]` — Number of results to return per page. +**linked_account_id:** `typing.Optional[str]` — If provided, will only include issues pertaining to the linked account passed in.
@@ -21375,7 +20868,7 @@ client.crm.custom_objects.custom_object_classes_custom_objects_list(
-**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object. +**page_size:** `typing.Optional[int]` — Number of results to return per page.
@@ -21383,19 +20876,40 @@ client.crm.custom_objects.custom_object_classes_custom_objects_list(
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. +**start_date:** `typing.Optional[str]` — If included, will only include issues whose most recent action occurred after this time
- -
- + +
+
+ +**status:** `typing.Optional[IssuesListRequestStatus]` + +Status of the issue. Options: ('ONGOING', 'RESOLVED') + +* `ONGOING` - ONGOING +* `RESOLVED` - RESOLVED + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+ + +
-
client.crm.custom_objects.custom_object_classes_custom_objects_create(...) +
client.filestorage.issues.retrieve(...)
@@ -21407,7 +20921,7 @@ client.crm.custom_objects.custom_object_classes_custom_objects_list(
-Creates a `CustomObject` object with the given values. +Get a specific issue.
@@ -21423,17 +20937,13 @@ Creates a `CustomObject` object with the given values. ```python from merge import Merge -from merge.resources.crm import CustomObjectRequest client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.custom_objects.custom_object_classes_custom_objects_create( - custom_object_class_id="custom_object_class_id", - model=CustomObjectRequest( - fields={"test_field": "hello"}, - ), +client.filestorage.issues.retrieve( + id="id", ) ``` @@ -21450,31 +20960,7 @@ client.crm.custom_objects.custom_object_classes_custom_objects_create(
-**custom_object_class_id:** `str` - -
-
- -
-
- -**model:** `CustomObjectRequest` - -
-
- -
-
- -**is_debug_mode:** `typing.Optional[bool]` — Whether to include debug fields (such as log file links) in the response. - -
-
- -
-
- -**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously. +**id:** `str`
@@ -21494,7 +20980,8 @@ client.crm.custom_objects.custom_object_classes_custom_objects_create(
-
client.crm.custom_objects.custom_object_classes_custom_objects_retrieve(...) +## Filestorage LinkToken +
client.filestorage.link_token.create(...)
@@ -21506,7 +20993,7 @@ client.crm.custom_objects.custom_object_classes_custom_objects_create(
-Returns a `CustomObject` object with the given `id`. +Creates a link token to be used when linking a new end user.
@@ -21522,14 +21009,17 @@ Returns a `CustomObject` object with the given `id`. ```python from merge import Merge +from merge.resources.filestorage import CategoriesEnum client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.custom_objects.custom_object_classes_custom_objects_retrieve( - custom_object_class_id="custom_object_class_id", - id="id", +client.filestorage.link_token.create( + end_user_email_address="example@gmail.com", + end_user_organization_name="Test Organization", + end_user_origin_id="12345", + categories=[CategoriesEnum.HRIS, CategoriesEnum.ATS], ) ``` @@ -21546,7 +21036,7 @@ client.crm.custom_objects.custom_object_classes_custom_objects_retrieve(
-**custom_object_class_id:** `str` +**end_user_email_address:** `str` — Your end user's email address. This is purely for identification purposes - setting this value will not cause any emails to be sent.
@@ -21554,7 +21044,7 @@ client.crm.custom_objects.custom_object_classes_custom_objects_retrieve(
-**id:** `str` +**end_user_organization_name:** `str` — Your end user's organization.
@@ -21562,7 +21052,7 @@ client.crm.custom_objects.custom_object_classes_custom_objects_retrieve(
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. +**end_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.
@@ -21570,7 +21060,7 @@ client.crm.custom_objects.custom_object_classes_custom_objects_retrieve(
-**include_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format. +**categories:** `typing.Sequence[CategoriesEnum]` — The integration categories to show in Merge Link.
@@ -21578,7 +21068,7 @@ client.crm.custom_objects.custom_object_classes_custom_objects_retrieve(
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). +**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/.
@@ -21586,70 +21076,75 @@ client.crm.custom_objects.custom_object_classes_custom_objects_retrieve(
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. +**link_expiry_mins:** `typing.Optional[int]` — An integer number of minutes between [30, 720 or 10080 if for a Magic Link URL] for how long this token is valid. Defaults to 30.
- -
+
+
+**should_create_magic_link_url:** `typing.Optional[bool]` — Whether to generate a Magic Link URL. Defaults to false. For more information on Magic Link, see https://merge.dev/blog/integrations-fast-say-hello-to-magic-link. +
-
-
client.crm.custom_objects.custom_object_classes_custom_objects_meta_post_retrieve(...)
-#### 📝 Description - -
-
+**hide_admin_magic_link:** `typing.Optional[bool]` — Whether to generate a Magic Link URL on the Admin Needed screen during the linking flow. Defaults to false. For more information on Magic Link, see https://merge.dev/blog/integrations-fast-say-hello-to-magic-link. + +
+
-Returns metadata for `CRMCustomObject` POSTs. -
-
+**common_models:** `typing.Optional[typing.Sequence[CommonModelScopesBodyRequest]]` — An array of objects to specify the models and fields that will be disabled for a given Linked Account. Each object uses model_id, enabled_actions, and disabled_fields to specify the model, method, and fields that are scoped for a given Linked Account. +
-#### 🔌 Usage -
+**category_common_model_scopes:** `typing.Optional[ + typing.Dict[ + str, + typing.Optional[ + typing.Sequence[IndividualCommonModelScopeDeserializerRequest] + ], + ] +]` — When creating a Link Token, you can set permissions for Common Models that will apply to the account that is going to be linked. Any model or field not specified in link token payload will default to existing settings. + +
+
+
-```python -from merge import Merge +**language:** `typing.Optional[LanguageEnum]` -client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.crm.custom_objects.custom_object_classes_custom_objects_meta_post_retrieve( - custom_object_class_id="custom_object_class_id", -) +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. + +
+
+
-**custom_object_class_id:** `str` +**integration_specific_config:** `typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]]` — A JSON object containing integration-specific configuration options.
@@ -21669,7 +21164,8 @@ client.crm.custom_objects.custom_object_classes_custom_objects_meta_post_retriev
-
client.crm.custom_objects.custom_object_classes_custom_objects_remote_field_classes_list(...) +## Filestorage LinkedAccounts +
client.filestorage.linked_accounts.list(...)
@@ -21681,7 +21177,7 @@ client.crm.custom_objects.custom_object_classes_custom_objects_meta_post_retriev
-Returns a list of `RemoteFieldClass` objects. +List linked accounts for your organization.
@@ -21702,7 +21198,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.custom_objects.custom_object_classes_custom_objects_remote_field_classes_list() +client.filestorage.linked_accounts.list() ``` @@ -21718,6 +21214,24 @@ client.crm.custom_objects.custom_object_classes_custom_objects_remote_field_clas
+**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.
@@ -21726,7 +21240,7 @@ client.crm.custom_objects.custom_object_classes_custom_objects_remote_field_clas
-**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/). +**end_user_email_address:** `typing.Optional[str]` — If provided, will only return linked accounts associated with the given email address.
@@ -21734,7 +21248,7 @@ client.crm.custom_objects.custom_object_classes_custom_objects_remote_field_clas
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. +**end_user_organization_name:** `typing.Optional[str]` — If provided, will only return linked accounts associated with the given organization name.
@@ -21742,7 +21256,7 @@ client.crm.custom_objects.custom_object_classes_custom_objects_remote_field_clas
-**include_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format. +**end_user_origin_id:** `typing.Optional[str]` — If provided, will only return linked accounts associated with the given origin ID.
@@ -21750,7 +21264,7 @@ client.crm.custom_objects.custom_object_classes_custom_objects_remote_field_clas
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). +**end_user_origin_ids:** `typing.Optional[str]` — Comma-separated list of EndUser origin IDs, making it possible to specify multiple EndUsers at once.
@@ -21758,7 +21272,7 @@ client.crm.custom_objects.custom_object_classes_custom_objects_remote_field_clas
-**is_common_model_field:** `typing.Optional[bool]` — If provided, will only return remote field classes with this is_common_model_field value +**id:** `typing.Optional[str]`
@@ -21766,7 +21280,31 @@ client.crm.custom_objects.custom_object_classes_custom_objects_remote_field_clas
-**is_custom:** `typing.Optional[bool]` — If provided, will only return remote fields classes with this is_custom value +**ids:** `typing.Optional[str]` — Comma-separated list of LinkedAccount IDs, making it possible to specify multiple LinkedAccounts at once. + +
+
+ +
+
+ +**include_duplicates:** `typing.Optional[bool]` — If `true`, will include complete production duplicates of the account specified by the `id` query parameter in the response. `id` must be for a complete production linked account. + +
+
+ +
+
+ +**integration_name:** `typing.Optional[str]` — If provided, will only return linked accounts associated with the given integration name. + +
+
+ +
+
+ +**is_test_account:** `typing.Optional[str]` — If included, will only include test linked accounts. If not included, will only include non-test linked accounts.
@@ -21782,6 +21320,14 @@ client.crm.custom_objects.custom_object_classes_custom_objects_remote_field_clas
+**status:** `typing.Optional[str]` — Filter by status. Options: `COMPLETE`, `IDLE`, `INCOMPLETE`, `RELINK_NEEDED` + +
+
+ +
+
+ **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -21794,8 +21340,8 @@ client.crm.custom_objects.custom_object_classes_custom_objects_remote_field_clas
-## Crm Associations -
client.crm.associations.custom_object_classes_custom_objects_associations_list(...) +## Filestorage Passthrough +
client.filestorage.passthrough.create(...)
@@ -21807,7 +21353,7 @@ client.crm.custom_objects.custom_object_classes_custom_objects_remote_field_clas
-Returns a list of `Association` objects. +Pull data from an endpoint not currently supported by Merge.
@@ -21823,14 +21369,17 @@ Returns a list of `Association` objects. ```python from merge import Merge +from merge.resources.filestorage import DataPassthroughRequest, MethodEnum client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.associations.custom_object_classes_custom_objects_associations_list( - custom_object_class_id="custom_object_class_id", - object_id="object_id", +client.filestorage.passthrough.create( + request=DataPassthroughRequest( + method=MethodEnum.GET, + path="/scooters", + ), ) ``` @@ -21847,7 +21396,7 @@ client.crm.associations.custom_object_classes_custom_objects_associations_list(
-**custom_object_class_id:** `str` +**request:** `DataPassthroughRequest`
@@ -21855,103 +21404,71 @@ client.crm.associations.custom_object_classes_custom_objects_associations_list(
-**object_id:** `str` +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+ +
-
-
-**association_type_id:** `typing.Optional[str]` — If provided, will only return opportunities with this association_type. -
+
+## Filestorage RegenerateKey +
client.filestorage.regenerate_key.create(...)
-**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. - -
-
-
-**cursor:** `typing.Optional[str]` — The pagination cursor value. - +Exchange remote keys.
- -
-
- -**expand:** `typing.Optional[typing.Literal["association_type"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. -
-
-
- -**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/). - -
-
+#### 🔌 Usage
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. - -
-
-
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). - -
-
+```python +from merge import Merge -
-
+client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.filestorage.regenerate_key.create( + name="Remote Deployment Key 1", +) -**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned. - +```
- -
-
- -**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned. -
+#### ⚙️ Parameters +
-**page_size:** `typing.Optional[int]` — Number of results to return per page. - -
-
-
-**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object. +**name:** `str` — The name of the remote key
@@ -21971,7 +21488,8 @@ client.crm.associations.custom_object_classes_custom_objects_associations_list(
-
client.crm.associations.custom_object_classes_custom_objects_associations_update(...) +## Filestorage SyncStatus +
client.filestorage.sync_status.list(...)
@@ -21983,7 +21501,7 @@ client.crm.associations.custom_object_classes_custom_objects_associations_list(
-Creates an Association between `source_object_id` and `target_object_id` of type `association_type_id`. +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).
@@ -22004,13 +21522,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.associations.custom_object_classes_custom_objects_associations_update( - association_type_id="association_type_id", - source_class_id="source_class_id", - source_object_id="source_object_id", - target_class_id="target_class_id", - target_object_id="target_object_id", -) +client.filestorage.sync_status.list() ``` @@ -22026,7 +21538,7 @@ client.crm.associations.custom_object_classes_custom_objects_associations_update
-**association_type_id:** `str` +**cursor:** `typing.Optional[str]` — The pagination cursor value.
@@ -22034,7 +21546,7 @@ client.crm.associations.custom_object_classes_custom_objects_associations_update
-**source_class_id:** `str` +**page_size:** `typing.Optional[int]` — Number of results to return per page.
@@ -22042,43 +21554,65 @@ client.crm.associations.custom_object_classes_custom_objects_associations_update
-**source_object_id:** `str` +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+ +
-
-
-**target_class_id:** `str` -
+
+## Filestorage ForceResync +
client.filestorage.force_resync.sync_status_resync_create()
-**target_object_id:** `str` - -
-
+#### 📝 Description
-**is_debug_mode:** `typing.Optional[bool]` — Whether to include debug fields (such as log file links) in the response. - +
+
+ +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 +
-**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously. - +
+
+ +```python +from merge import Merge + +client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.filestorage.force_resync.sync_status_resync_create() + +``` +
+
+#### ⚙️ Parameters + +
+
+
@@ -22094,8 +21628,8 @@ client.crm.associations.custom_object_classes_custom_objects_associations_update
-## Crm Scopes -
client.crm.scopes.default_scopes_retrieve() +## Filestorage Users +
client.filestorage.users.list(...)
@@ -22107,7 +21641,7 @@ client.crm.associations.custom_object_classes_custom_objects_associations_update
-Get the default permissions for Merge Common Models and fields across all Linked Accounts of a given category. [Learn more](https://help.merge.dev/en/articles/5950052-common-model-and-field-scopes). +Returns a list of `User` objects.
@@ -22128,7 +21662,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.scopes.default_scopes_retrieve() +client.filestorage.users.list() ``` @@ -22144,64 +21678,91 @@ client.crm.scopes.default_scopes_retrieve()
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. +**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
- -
+
+
+**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime. +
-
-
client.crm.scopes.linked_account_scopes_retrieve()
-#### 📝 Description +**cursor:** `typing.Optional[str]` — The pagination cursor value. + +
+
+**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/). + +
+
+
-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). +**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). +
-#### 🔌 Usage -
+**is_me:** `typing.Optional[str]` — If provided, will only return the user object for requestor. + +
+
+
-```python -from merge import Merge +**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned. + +
+
-client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.crm.scopes.linked_account_scopes_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. + +
+
+
@@ -22217,7 +21778,7 @@ client.crm.scopes.linked_account_scopes_retrieve()
-
client.crm.scopes.linked_account_scopes_create(...) +
client.filestorage.users.retrieve(...)
@@ -22229,7 +21790,7 @@ client.crm.scopes.linked_account_scopes_retrieve()
-Update permissions for any Common Model or field for a single Linked Account. Any Scopes not set in this POST request will inherit the default Scopes. [Learn more](https://help.merge.dev/en/articles/5950052-common-model-and-field-scopes) +Returns a `User` object with the given `id`.
@@ -22245,42 +21806,13 @@ Update permissions for any Common Model or field for a single Linked Account. An ```python from merge import Merge -from merge.resources.crm import ( - FieldPermissionDeserializerRequest, - IndividualCommonModelScopeDeserializerRequest, - ModelPermissionDeserializerRequest, -) client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.scopes.linked_account_scopes_create( - common_models=[ - IndividualCommonModelScopeDeserializerRequest( - model_name="Employee", - model_permissions={ - "READ": ModelPermissionDeserializerRequest( - is_enabled=True, - ), - "WRITE": ModelPermissionDeserializerRequest( - is_enabled=False, - ), - }, - field_permissions=FieldPermissionDeserializerRequest( - enabled_fields=["avatar", "home_location"], - disabled_fields=["work_location"], - ), - ), - IndividualCommonModelScopeDeserializerRequest( - model_name="Benefit", - model_permissions={ - "WRITE": ModelPermissionDeserializerRequest( - is_enabled=False, - ) - }, - ), - ], +client.filestorage.users.retrieve( + id="id", ) ``` @@ -22297,7 +21829,23 @@ client.crm.scopes.linked_account_scopes_create(
-**common_models:** `typing.Sequence[IndividualCommonModelScopeDeserializerRequest]` — The common models you want to update the scopes for +**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).
@@ -22317,8 +21865,8 @@ client.crm.scopes.linked_account_scopes_create(
-## Crm DeleteAccount -
client.crm.delete_account.delete() +## Filestorage WebhookReceivers +
client.filestorage.webhook_receivers.list()
@@ -22330,7 +21878,7 @@ client.crm.scopes.linked_account_scopes_create(
-Delete a linked account. +Returns a list of `WebhookReceiver` objects.
@@ -22351,7 +21899,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.delete_account.delete() +client.filestorage.webhook_receivers.list() ``` @@ -22379,8 +21927,7 @@ client.crm.delete_account.delete()
-## Crm EngagementTypes -
client.crm.engagement_types.list(...) +
client.filestorage.webhook_receivers.create(...)
@@ -22392,7 +21939,7 @@ client.crm.delete_account.delete()
-Returns a list of `EngagementType` objects. +Creates a `WebhookReceiver` object with the given values.
@@ -22413,7 +21960,10 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.engagement_types.list() +client.filestorage.webhook_receivers.create( + event="event", + is_active=True, +) ``` @@ -22429,7 +21979,7 @@ client.crm.engagement_types.list()
-**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime. +**event:** `str`
@@ -22437,7 +21987,7 @@ client.crm.engagement_types.list()
-**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime. +**is_active:** `bool`
@@ -22445,7 +21995,7 @@ client.crm.engagement_types.list()
-**cursor:** `typing.Optional[str]` — The pagination cursor value. +**key:** `typing.Optional[str]`
@@ -22453,67 +22003,65 @@ client.crm.engagement_types.list()
-**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/). +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+ +
-
-
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. -
+
+## Hris AccountDetails +
client.hris.account_details.retrieve()
-**include_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format. - -
-
+#### 📝 Description
-**include_shell_data:** `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. - +Get details for a linked account.
+ + + +#### 🔌 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.hris.account_details.retrieve() + +``` +
+
+#### ⚙️ Parameters +
-**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object. - -
-
-
@@ -22529,7 +22077,8 @@ client.crm.engagement_types.list()
-
client.crm.engagement_types.retrieve(...) +## Hris AccountToken +
client.hris.account_token.retrieve(...)
@@ -22541,7 +22090,7 @@ client.crm.engagement_types.list()
-Returns an `EngagementType` object with the given `id`. +Returns the account token for the end user with the provided public token.
@@ -22562,8 +22111,8 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.engagement_types.retrieve( - id="id", +client.hris.account_token.retrieve( + public_token="public_token", ) ``` @@ -22580,31 +22129,7 @@ client.crm.engagement_types.retrieve(
-**id:** `str` - -
-
- -
-
- -**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. - -
-
- -
-
- -**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). +**public_token:** `str`
@@ -22624,7 +22149,8 @@ client.crm.engagement_types.retrieve(
-
client.crm.engagement_types.remote_field_classes_list(...) +## Hris AsyncPassthrough +
client.hris.async_passthrough.create(...)
@@ -22636,7 +22162,7 @@ client.crm.engagement_types.retrieve(
-Returns a list of `RemoteFieldClass` objects. +Asynchronously pull data from an endpoint not currently supported by Merge.
@@ -22652,12 +22178,18 @@ Returns a list of `RemoteFieldClass` objects. ```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.crm.engagement_types.remote_field_classes_list() +client.hris.async_passthrough.create( + request=DataPassthroughRequest( + method=MethodEnum.GET, + path="/scooters", + ), +) ``` @@ -22673,7 +22205,7 @@ client.crm.engagement_types.remote_field_classes_list()
-**cursor:** `typing.Optional[str]` — The pagination cursor value. +**request:** `DataPassthroughRequest`
@@ -22681,55 +22213,70 @@ client.crm.engagement_types.remote_field_classes_list()
-**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/). +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+ +
-
-
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. -
+
+
client.hris.async_passthrough.retrieve(...)
-**include_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format. - -
-
+#### 📝 Description
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). - -
-
-
-**is_common_model_field:** `typing.Optional[bool]` — If provided, will only return remote field classes with this is_common_model_field value - +Retrieves data from earlier async-passthrough POST request +
+
+#### 🔌 Usage +
-**is_custom:** `typing.Optional[bool]` — If provided, will only return remote fields classes with this is_custom value - +
+
+ +```python +from merge import Merge + +client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.hris.async_passthrough.retrieve( + async_passthrough_receipt_id="async_passthrough_receipt_id", +) + +```
+
+
+ +#### ⚙️ Parameters
-**page_size:** `typing.Optional[int]` — Number of results to return per page. +
+
+ +**async_passthrough_receipt_id:** `str`
@@ -22749,8 +22296,8 @@ client.crm.engagement_types.remote_field_classes_list()
-## Crm Engagements -
client.crm.engagements.list(...) +## Hris AuditTrail +
client.hris.audit_trail.list(...)
@@ -22762,7 +22309,7 @@ client.crm.engagement_types.remote_field_classes_list()
-Returns a list of `Engagement` objects. +Gets a list of audit trail events.
@@ -22783,7 +22330,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.engagements.list() +client.hris.audit_trail.list() ``` @@ -22799,7 +22346,7 @@ client.crm.engagements.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.
@@ -22807,7 +22354,7 @@ client.crm.engagements.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
@@ -22815,7 +22362,7 @@ client.crm.engagements.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`
@@ -22823,7 +22370,7 @@ client.crm.engagements.list()
-**expand:** `typing.Optional[EngagementsListRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. +**page_size:** `typing.Optional[int]` — Number of results to return per page.
@@ -22831,7 +22378,7 @@ client.crm.engagements.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/). +**start_date:** `typing.Optional[str]` — If included, will only include audit trail events that occurred after this time
@@ -22839,7 +22386,7 @@ client.crm.engagements.list()
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. +**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.
@@ -22847,67 +22394,65 @@ client.crm.engagements.list()
-**include_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format. +**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 AvailableActions +
client.hris.available_actions.retrieve()
-**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned. - -
-
+#### 📝 Description
-**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned. - -
-
-
-**page_size:** `typing.Optional[int]` — Number of results to return per page. - +Returns a list of models and actions available for an account. +
+
+#### 🔌 Usage +
-**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object. - -
-
-
-**started_after:** `typing.Optional[dt.datetime]` — If provided, will only return engagements started after this datetime. - +```python +from merge import Merge + +client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.hris.available_actions.retrieve() + +``` +
+
+#### ⚙️ Parameters +
-**started_before:** `typing.Optional[dt.datetime]` — If provided, will only return engagements started before this datetime. - -
-
-
@@ -22923,7 +22468,8 @@ client.crm.engagements.list()
-
client.crm.engagements.create(...) +## Hris BankInfo +
client.hris.bank_info.list(...)
@@ -22935,7 +22481,7 @@ client.crm.engagements.list()
-Creates an `Engagement` object with the given values. +Returns a list of `BankInfo` objects.
@@ -22951,15 +22497,12 @@ Creates an `Engagement` object with the given values. ```python from merge import Merge -from merge.resources.crm import EngagementRequest client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.engagements.create( - model=EngagementRequest(), -) +client.hris.bank_info.list() ``` @@ -22975,7 +22518,12 @@ client.crm.engagements.create(
-**model:** `EngagementRequest` +**account_type:** `typing.Optional[BankInfoListRequestAccountType]` + +If provided, will only return BankInfo's with this account type. Options: ('SAVINGS', 'CHECKING') + +* `SAVINGS` - SAVINGS +* `CHECKING` - CHECKING
@@ -22983,7 +22531,7 @@ client.crm.engagements.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.
@@ -22991,7 +22539,7 @@ client.crm.engagements.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.
@@ -22999,70 +22547,79 @@ client.crm.engagements.create(
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. +**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
- -
+
+
+**cursor:** `typing.Optional[str]` — The pagination cursor value. +
-
-
client.crm.engagements.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 an `Engagement` 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 - -client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.crm.engagements.retrieve( - id="id", -) - -``` +**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). +
+ +
+
+ +**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned. +
-#### ⚙️ Parameters -
+**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned. + +
+
+
-**id:** `str` +**order_by:** `typing.Optional[BankInfoListRequestOrderBy]` — Overrides the default ordering for this endpoint. Possible values include: remote_created_at, -remote_created_at.
@@ -23070,7 +22627,7 @@ client.crm.engagements.retrieve(
-**expand:** `typing.Optional[EngagementsRetrieveRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. +**page_size:** `typing.Optional[int]` — Number of results to return per page.
@@ -23078,7 +22635,7 @@ client.crm.engagements.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[typing.Literal["account_type"]]` — Deprecated. Use show_enum_origins.
@@ -23086,7 +22643,7 @@ client.crm.engagements.retrieve(
-**include_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format. +**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
@@ -23094,7 +22651,7 @@ client.crm.engagements.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)
@@ -23114,7 +22671,7 @@ client.crm.engagements.retrieve(
-
client.crm.engagements.partial_update(...) +
client.hris.bank_info.retrieve(...)
@@ -23126,7 +22683,7 @@ client.crm.engagements.retrieve(
-Updates an `Engagement` object with the given `id`. +Returns a `BankInfo` object with the given `id`.
@@ -23142,15 +22699,13 @@ Updates an `Engagement` object with the given `id`. ```python from merge import Merge -from merge.resources.crm import PatchedEngagementRequest client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.engagements.partial_update( +client.hris.bank_info.retrieve( id="id", - model=PatchedEngagementRequest(), ) ``` @@ -23175,7 +22730,7 @@ client.crm.engagements.partial_update(
-**model:** `PatchedEngagementRequest` +**expand:** `typing.Optional[typing.Literal["employee"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -23183,7 +22738,7 @@ client.crm.engagements.partial_update(
-**is_debug_mode:** `typing.Optional[bool]` — Whether to include debug fields (such as log file links) in the response. +**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -23191,7 +22746,23 @@ client.crm.engagements.partial_update(
-**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously. +**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). + +
+
+ +
+
+ +**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)
@@ -23211,7 +22782,8 @@ client.crm.engagements.partial_update(
-
client.crm.engagements.meta_patch_retrieve(...) +## Hris Benefits +
client.hris.benefits.list(...)
@@ -23223,7 +22795,7 @@ client.crm.engagements.partial_update(
-Returns metadata for `Engagement` PATCHs. +Returns a list of `Benefit` objects.
@@ -23244,9 +22816,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.engagements.meta_patch_retrieve( - id="id", -) +client.hris.benefits.list() ``` @@ -23262,7 +22832,7 @@ client.crm.engagements.meta_patch_retrieve(
-**id:** `str` +**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
@@ -23270,64 +22840,91 @@ client.crm.engagements.meta_patch_retrieve(
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. +**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
- -
+
+
+**cursor:** `typing.Optional[str]` — The pagination cursor value. +
-
-
client.crm.engagements.meta_post_retrieve()
-#### 📝 Description +**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. + +
+
+
-Returns metadata for `Engagement` POSTs. +**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/). +
+ +
+
+ +**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. +
-#### 🔌 Usage -
+**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). + +
+
+
-```python -from merge import Merge +**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned. + +
+
-client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.crm.engagements.meta_post_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. + +
+
+
@@ -23343,7 +22940,7 @@ client.crm.engagements.meta_post_retrieve()
-
client.crm.engagements.remote_field_classes_list(...) +
client.hris.benefits.retrieve(...)
@@ -23355,7 +22952,7 @@ client.crm.engagements.meta_post_retrieve()
-Returns a list of `RemoteFieldClass` objects. +Returns a `Benefit` object with the given `id`.
@@ -23376,7 +22973,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.engagements.remote_field_classes_list() +client.hris.benefits.retrieve( + id="id", +) ``` @@ -23392,7 +22991,7 @@ client.crm.engagements.remote_field_classes_list()
-**cursor:** `typing.Optional[str]` — The pagination cursor value. +**id:** `str`
@@ -23400,7 +22999,7 @@ client.crm.engagements.remote_field_classes_list()
-**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/). +**expand:** `typing.Optional[typing.Literal["employee"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -23416,14 +23015,6 @@ client.crm.engagements.remote_field_classes_list()
-**include_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format. - -
-
- -
-
- **include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -23432,30 +23023,6 @@ client.crm.engagements.remote_field_classes_list()
-**is_common_model_field:** `typing.Optional[bool]` — If provided, will only return remote field classes with this is_common_model_field value - -
-
- -
-
- -**is_custom:** `typing.Optional[bool]` — If provided, will only return remote fields classes with this is_custom value - -
-
- -
-
- -**page_size:** `typing.Optional[int]` — Number of results to return per page. - -
-
- -
-
- **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -23468,8 +23035,8 @@ client.crm.engagements.remote_field_classes_list()
-## Crm FieldMapping -
client.crm.field_mapping.field_mappings_retrieve(...) +## Hris Companies +
client.hris.companies.list(...)
@@ -23481,7 +23048,7 @@ client.crm.engagements.remote_field_classes_list()
-Get all Field Mappings for this Linked Account. Field Mappings are mappings between third-party Remote Fields and user defined Merge fields. [Learn more](https://docs.merge.dev/supplemental-data/field-mappings/overview/). +Returns a list of `Company` objects.
@@ -23502,7 +23069,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.field_mapping.field_mappings_retrieve() +client.hris.companies.list() ``` @@ -23518,7 +23085,7 @@ client.crm.field_mapping.field_mappings_retrieve()
-**exclude_remote_field_metadata:** `typing.Optional[bool]` — If `true`, remote fields metadata is excluded from each field mapping instance (i.e. `remote_fields.remote_key_name` and `remote_fields.schema` will be null). This will increase the speed of the request since these fields require some calculations. +**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
@@ -23526,83 +23093,31 @@ client.crm.field_mapping.field_mappings_retrieve()
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. +**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
- -
+
+
+**cursor:** `typing.Optional[str]` — The pagination cursor value. +
-
-
client.crm.field_mapping.field_mappings_create(...)
-#### 📝 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/). + +
+
-
-
- -Create new Field Mappings that will be available after the next scheduled sync. This will cause the next sync for this Linked Account to sync **ALL** data from start. -
-
-
-
- -#### 🔌 Usage - -
-
- -
-
- -```python -from merge import Merge - -client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.crm.field_mapping.field_mappings_create( - target_field_name="example_target_field_name", - target_field_description="this is a example description of the target field", - remote_field_traversal_path=["example_remote_field"], - remote_method="GET", - remote_url_path="/example-url-path", - common_model_name="ExampleCommonModel", -) - -``` -
-
-
-
- -#### ⚙️ Parameters - -
-
- -
-
- -**target_field_name:** `str` — The name of the target field you want this remote field to map to. - -
-
- -
-
- -**target_field_description:** `str` — The description of the target field you want this remote field to map to. +**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -23610,7 +23125,7 @@ client.crm.field_mapping.field_mappings_create(
-**remote_field_traversal_path:** `typing.Sequence[typing.Optional[typing.Any]]` — The field traversal path of the remote field listed when you hit the GET /remote-fields endpoint. +**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -23618,7 +23133,7 @@ client.crm.field_mapping.field_mappings_create(
-**remote_method:** `str` — The method of the remote endpoint where the remote field is coming from. +**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
@@ -23626,7 +23141,7 @@ client.crm.field_mapping.field_mappings_create(
-**remote_url_path:** `str` — The path of the remote endpoint where the remote field is coming from. +**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
@@ -23634,7 +23149,7 @@ client.crm.field_mapping.field_mappings_create(
-**common_model_name:** `str` — The name of the Common Model that the remote field corresponds to in a given category. +**page_size:** `typing.Optional[int]` — Number of results to return per page.
@@ -23642,7 +23157,7 @@ client.crm.field_mapping.field_mappings_create(
-**exclude_remote_field_metadata:** `typing.Optional[bool]` — If `true`, remote fields metadata is excluded from each field mapping instance (i.e. `remote_fields.remote_key_name` and `remote_fields.schema` will be null). This will increase the speed of the request since these fields require some calculations. +**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
@@ -23662,7 +23177,7 @@ client.crm.field_mapping.field_mappings_create(
-
client.crm.field_mapping.field_mappings_destroy(...) +
client.hris.companies.retrieve(...)
@@ -23674,7 +23189,7 @@ client.crm.field_mapping.field_mappings_create(
-Deletes Field Mappings for a Linked Account. All data related to this Field Mapping will be deleted and these changes will be reflected after the next scheduled sync. This will cause the next sync for this Linked Account to sync **ALL** data from start. +Returns a `Company` object with the given `id`.
@@ -23695,8 +23210,8 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.field_mapping.field_mappings_destroy( - field_mapping_id="field_mapping_id", +client.hris.companies.retrieve( + id="id", ) ``` @@ -23713,7 +23228,23 @@ client.crm.field_mapping.field_mappings_destroy(
-**field_mapping_id:** `str` +**id:** `str` + +
+
+ +
+
+ +**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. + +
+
+ +
+
+ +**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -23733,7 +23264,8 @@ client.crm.field_mapping.field_mappings_destroy(
-
client.crm.field_mapping.field_mappings_partial_update(...) +## Hris Scopes +
client.hris.scopes.default_scopes_retrieve()
@@ -23745,7 +23277,7 @@ client.crm.field_mapping.field_mappings_destroy(
-Create or update existing Field Mappings for a Linked Account. Changes will be reflected after the next scheduled sync. This will cause the next sync for this Linked Account to sync **ALL** data from start. +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).
@@ -23766,9 +23298,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.field_mapping.field_mappings_partial_update( - field_mapping_id="field_mapping_id", -) +client.hris.scopes.default_scopes_retrieve() ``` @@ -23784,38 +23314,6 @@ client.crm.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. - -
-
- -
-
- **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -23828,7 +23326,7 @@ client.crm.field_mapping.field_mappings_partial_update(
-
client.crm.field_mapping.remote_fields_retrieve(...) +
client.hris.scopes.linked_account_scopes_retrieve()
@@ -23840,7 +23338,7 @@ client.crm.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/). +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).
@@ -23861,7 +23359,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.field_mapping.remote_fields_retrieve() +client.hris.scopes.linked_account_scopes_retrieve() ``` @@ -23877,22 +23375,6 @@ client.crm.field_mapping.remote_fields_retrieve()
-**common_models:** `typing.Optional[str]` — A comma seperated list of Common Model names. If included, will only return Remote Fields for those Common Models. - -
-
- -
-
- -**include_example_values:** `typing.Optional[str]` — If true, will include example values, where available, for remote fields in the 3rd party platform. These examples come from active data from your customers. - -
-
- -
-
- **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -23905,7 +23387,7 @@ client.crm.field_mapping.remote_fields_retrieve()
-
client.crm.field_mapping.target_fields_retrieve() +
client.hris.scopes.linked_account_scopes_create(...)
@@ -23917,7 +23399,7 @@ client.crm.field_mapping.remote_fields_retrieve()
-Get all organization-wide Target Fields, this will not include any Linked Account specific Target Fields. Organization-wide Target Fields are additional fields appended to the Merge Common Model for all Linked Accounts in a category. [Learn more](https://docs.merge.dev/supplemental-data/field-mappings/target-fields/). +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)
@@ -23933,12 +23415,43 @@ Get all organization-wide Target Fields, this will not include any Linked Accoun ```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.crm.field_mapping.target_fields_retrieve() +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, + ) + }, + ), + ], +) ``` @@ -23954,6 +23467,14 @@ client.crm.field_mapping.target_fields_retrieve()
+**common_models:** `typing.Sequence[IndividualCommonModelScopeDeserializerRequest]` — The common models you want to update the scopes for + +
+
+ +
+
+ **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -23966,8 +23487,8 @@ client.crm.field_mapping.target_fields_retrieve()
-## Crm GenerateKey -
client.crm.generate_key.create(...) +## Hris DeleteAccount +
client.hris.delete_account.delete()
@@ -23979,7 +23500,7 @@ client.crm.field_mapping.target_fields_retrieve()
-Create a remote key. +Delete a linked account.
@@ -24000,9 +23521,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.generate_key.create( - name="Remote Deployment Key 1", -) +client.hris.delete_account.delete() ``` @@ -24018,14 +23537,6 @@ client.crm.generate_key.create(
-**name:** `str` — The name of the remote key - -
-
- -
-
- **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -24038,8 +23549,8 @@ client.crm.generate_key.create(
-## Crm Issues -
client.crm.issues.list(...) +## Hris Dependents +
client.hris.dependents.list(...)
@@ -24051,7 +23562,7 @@ client.crm.generate_key.create(
-Gets all issues for Organization. +Returns a list of `Dependent` objects.
@@ -24072,7 +23583,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.issues.list() +client.hris.dependents.list() ``` @@ -24088,7 +23599,7 @@ client.crm.issues.list()
-**account_token:** `typing.Optional[str]` +**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
@@ -24096,7 +23607,7 @@ client.crm.issues.list()
-**cursor:** `typing.Optional[str]` — The pagination cursor value. +**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
@@ -24104,7 +23615,7 @@ client.crm.issues.list()
-**end_date:** `typing.Optional[str]` — If included, will only include issues whose most recent action occurred before this time +**cursor:** `typing.Optional[str]` — The pagination cursor value.
@@ -24112,7 +23623,7 @@ client.crm.issues.list()
-**end_user_organization_name:** `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/).
@@ -24120,7 +23631,7 @@ client.crm.issues.list()
-**first_incident_time_after:** `typing.Optional[dt.datetime]` — If provided, will only return issues whose first incident time was after this datetime. +**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -24128,7 +23639,7 @@ client.crm.issues.list()
-**first_incident_time_before:** `typing.Optional[dt.datetime]` — If provided, will only return issues whose first incident time was before this datetime. +**include_sensitive_fields:** `typing.Optional[bool]` — Whether to include sensitive fields (such as social security numbers) in the response.
@@ -24136,7 +23647,7 @@ client.crm.issues.list()
-**include_muted:** `typing.Optional[str]` — If true, will include muted issues +**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -24144,7 +23655,7 @@ client.crm.issues.list()
-**integration_name:** `typing.Optional[str]` +**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
@@ -24152,7 +23663,7 @@ client.crm.issues.list()
-**last_incident_time_after:** `typing.Optional[dt.datetime]` — If provided, will only return issues whose last incident time was after this datetime. +**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
@@ -24160,7 +23671,7 @@ client.crm.issues.list()
-**last_incident_time_before:** `typing.Optional[dt.datetime]` — If provided, will only return issues whose last incident time was before this datetime. +**page_size:** `typing.Optional[int]` — Number of results to return per page.
@@ -24168,7 +23679,7 @@ client.crm.issues.list()
-**linked_account_id:** `typing.Optional[str]` — If provided, will only include issues pertaining to the linked account passed in. +**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
@@ -24176,39 +23687,10 @@ client.crm.issues.list()
-**page_size:** `typing.Optional[int]` — Number of results to return per page. +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. -
-
- -
-
- -**start_date:** `typing.Optional[str]` — If included, will only include issues whose most recent action occurred after this time - -
-
- -
-
- -**status:** `typing.Optional[IssuesListRequestStatus]` - -Status of the issue. Options: ('ONGOING', 'RESOLVED') - -* `ONGOING` - ONGOING -* `RESOLVED` - RESOLVED - -
-
- -
-
- -**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. - -
-
+ +
@@ -24217,7 +23699,7 @@ Status of the issue. Options: ('ONGOING', 'RESOLVED')
-
client.crm.issues.retrieve(...) +
client.hris.dependents.retrieve(...)
@@ -24229,7 +23711,7 @@ Status of the issue. Options: ('ONGOING', 'RESOLVED')
-Get a specific issue. +Returns a `Dependent` object with the given `id`.
@@ -24250,7 +23732,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.issues.retrieve( +client.hris.dependents.retrieve( id="id", ) @@ -24276,6 +23758,30 @@ client.crm.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_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). + +
+
+ +
+
+ **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -24288,8 +23794,8 @@ client.crm.issues.retrieve(
-## Crm Leads -
client.crm.leads.list(...) +## Hris EmployeePayrollRuns +
client.hris.employee_payroll_runs.list(...)
@@ -24301,7 +23807,7 @@ client.crm.issues.retrieve(
-Returns a list of `Lead` objects. +Returns a list of `EmployeePayrollRun` objects.
@@ -24322,7 +23828,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.leads.list() +client.hris.employee_payroll_runs.list() ``` @@ -24338,7 +23844,7 @@ client.crm.leads.list()
-**converted_account_id:** `typing.Optional[str]` — If provided, will only return leads with this account. +**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
@@ -24346,7 +23852,7 @@ client.crm.leads.list()
-**converted_contact_id:** `typing.Optional[str]` — If provided, will only return leads with this contact. +**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
@@ -24354,7 +23860,7 @@ client.crm.leads.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.
@@ -24362,7 +23868,7 @@ client.crm.leads.list()
-**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime. +**employee_id:** `typing.Optional[str]` — If provided, will only return employee payroll runs for this employee.
@@ -24370,7 +23876,7 @@ client.crm.leads.list()
-**cursor:** `typing.Optional[str]` — The pagination cursor value. +**ended_after:** `typing.Optional[dt.datetime]` — If provided, will only return employee payroll runs ended after this datetime.
@@ -24378,7 +23884,7 @@ client.crm.leads.list()
-**email_addresses:** `typing.Optional[str]` — If provided, will only return contacts matching the email addresses; multiple email_addresses can be separated by commas. +**ended_before:** `typing.Optional[dt.datetime]` — If provided, will only return employee payroll runs ended before this datetime.
@@ -24386,7 +23892,7 @@ client.crm.leads.list()
-**expand:** `typing.Optional[LeadsListRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. +**expand:** `typing.Optional[EmployeePayrollRunsListRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -24410,7 +23916,7 @@ client.crm.leads.list()
-**include_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format. +**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -24418,7 +23924,7 @@ client.crm.leads.list()
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). +**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
@@ -24426,7 +23932,7 @@ client.crm.leads.list()
-**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned. +**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
@@ -24434,7 +23940,7 @@ client.crm.leads.list()
-**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned. +**page_size:** `typing.Optional[int]` — Number of results to return per page.
@@ -24442,7 +23948,7 @@ client.crm.leads.list()
-**owner_id:** `typing.Optional[str]` — If provided, will only return leads with this owner. +**payroll_run_id:** `typing.Optional[str]` — If provided, will only return employee payroll runs for this employee.
@@ -24450,7 +23956,7 @@ client.crm.leads.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.
@@ -24458,7 +23964,7 @@ client.crm.leads.list()
-**phone_numbers:** `typing.Optional[str]` — If provided, will only return contacts matching the phone numbers; multiple phone numbers can be separated by commas. +**started_after:** `typing.Optional[dt.datetime]` — If provided, will only return employee payroll runs started after this datetime.
@@ -24466,7 +23972,7 @@ client.crm.leads.list()
-**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object. +**started_before:** `typing.Optional[dt.datetime]` — If provided, will only return employee payroll runs started before this datetime.
@@ -24486,7 +23992,7 @@ client.crm.leads.list()
-
client.crm.leads.create(...) +
client.hris.employee_payroll_runs.retrieve(...)
@@ -24498,7 +24004,7 @@ client.crm.leads.list()
-Creates a `Lead` object with the given values. +Returns an `EmployeePayrollRun` object with the given `id`.
@@ -24514,14 +24020,13 @@ Creates a `Lead` object with the given values. ```python from merge import Merge -from merge.resources.crm import LeadRequest client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.leads.create( - model=LeadRequest(), +client.hris.employee_payroll_runs.retrieve( + id="id", ) ``` @@ -24538,7 +24043,7 @@ client.crm.leads.create(
-**model:** `LeadRequest` +**id:** `str`
@@ -24546,7 +24051,7 @@ client.crm.leads.create(
-**is_debug_mode:** `typing.Optional[bool]` — Whether to include debug fields (such as log file links) in the response. +**expand:** `typing.Optional[EmployeePayrollRunsRetrieveRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -24554,7 +24059,15 @@ client.crm.leads.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).
@@ -24574,7 +24087,8 @@ client.crm.leads.create(
-
client.crm.leads.retrieve(...) +## Hris Employees +
client.hris.employees.list(...)
@@ -24586,7 +24100,7 @@ client.crm.leads.create(
-Returns a `Lead` object with the given `id`. +Returns a list of `Employee` objects.
@@ -24607,9 +24121,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.leads.retrieve( - id="id", -) +client.hris.employees.list() ``` @@ -24625,7 +24137,7 @@ client.crm.leads.retrieve(
-**id:** `str` +**company_id:** `typing.Optional[str]` — If provided, will only return employees for this company.
@@ -24633,7 +24145,7 @@ client.crm.leads.retrieve(
-**expand:** `typing.Optional[LeadsRetrieveRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. +**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
@@ -24641,7 +24153,7 @@ client.crm.leads.retrieve(
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. +**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
@@ -24649,7 +24161,7 @@ client.crm.leads.retrieve(
-**include_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format. +**cursor:** `typing.Optional[str]` — The pagination cursor value.
@@ -24657,7 +24169,7 @@ client.crm.leads.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). +**display_full_name:** `typing.Optional[str]` — If provided, will only return employees with this display name.
@@ -24665,129 +24177,93 @@ client.crm.leads.retrieve(
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. - -
-
- -
+**employment_status:** `typing.Optional[EmployeesListRequestEmploymentStatus]` +If provided, will only return employees with this employment status. +* `ACTIVE` - ACTIVE +* `PENDING` - PENDING +* `INACTIVE` - INACTIVE + -
-
client.crm.leads.meta_post_retrieve()
-#### 📝 Description - -
-
+**employment_type:** `typing.Optional[str]` — If provided, will only return employees that have an employment of the specified employment_type. + +
+
-Returns metadata for `Lead` POSTs. -
-
+**expand:** `typing.Optional[EmployeesListRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. +
-#### 🔌 Usage - -
-
-
-```python -from merge import Merge - -client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.crm.leads.meta_post_retrieve() - -``` -
-
+**first_name:** `typing.Optional[str]` — If provided, will only return employees with this first name. +
-#### ⚙️ Parameters - -
-
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. +**groups:** `typing.Optional[str]` — If provided, will only return employees matching the group ids; multiple groups can be separated by commas.
-
-
+
+
+**home_location_id:** `typing.Optional[str]` — If provided, will only return employees for this home location. +
-
-
client.crm.leads.remote_field_classes_list(...)
-#### 📝 Description - -
-
+**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/). + +
+
-Returns a list of `RemoteFieldClass` objects. -
-
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. +
-#### 🔌 Usage - -
-
-
-```python -from merge import Merge - -client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.crm.leads.remote_field_classes_list() - -``` -
-
+**include_sensitive_fields:** `typing.Optional[bool]` — Whether to include sensitive fields (such as social security numbers) in the response. +
-#### ⚙️ Parameters -
+**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). + +
+
+
-**cursor:** `typing.Optional[str]` — The pagination cursor value. +**job_title:** `typing.Optional[str]` — If provided, will only return employees that have an employment of the specified job_title.
@@ -24795,7 +24271,7 @@ client.crm.leads.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/). +**last_name:** `typing.Optional[str]` — If provided, will only return employees with this last name.
@@ -24803,7 +24279,7 @@ client.crm.leads.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. +**manager_id:** `typing.Optional[str]` — If provided, will only return employees for this manager.
@@ -24811,7 +24287,7 @@ client.crm.leads.remote_field_classes_list()
-**include_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format. +**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
@@ -24819,7 +24295,7 @@ client.crm.leads.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). +**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
@@ -24827,7 +24303,7 @@ client.crm.leads.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 +**page_size:** `typing.Optional[int]` — Number of results to return per page.
@@ -24835,7 +24311,7 @@ client.crm.leads.remote_field_classes_list()
-**is_custom:** `typing.Optional[bool]` — If provided, will only return remote fields classes with this is_custom value +**pay_group_id:** `typing.Optional[str]` — If provided, will only return employees for this pay group
@@ -24843,7 +24319,7 @@ client.crm.leads.remote_field_classes_list()
-**page_size:** `typing.Optional[int]` — Number of results to return per page. +**personal_email:** `typing.Optional[str]` — If provided, will only return Employees with this personal email
@@ -24851,7 +24327,87 @@ client.crm.leads.remote_field_classes_list()
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. +**remote_fields:** `typing.Optional[EmployeesListRequestRemoteFields]` — Deprecated. Use show_enum_origins. + +
+
+ +
+
+ +**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object. + +
+
+ +
+
+ +**show_enum_origins:** `typing.Optional[EmployeesListRequestShowEnumOrigins]` — A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter) + +
+
+ +
+
+ +**started_after:** `typing.Optional[dt.datetime]` — If provided, will only return employees that started after this datetime. + +
+
+ +
+
+ +**started_before:** `typing.Optional[dt.datetime]` — If provided, will only return employees that started before this datetime. + +
+
+ +
+
+ +**team_id:** `typing.Optional[str]` — If provided, will only return employees for this team. + +
+
+ +
+
+ +**terminated_after:** `typing.Optional[dt.datetime]` — If provided, will only return employees that were terminated after this datetime. + +
+
+ +
+
+ +**terminated_before:** `typing.Optional[dt.datetime]` — If provided, will only return employees that were terminated before this datetime. + +
+
+ +
+
+ +**work_email:** `typing.Optional[str]` — If provided, will only return Employees with this work email + +
+
+ +
+
+ +**work_location_id:** `typing.Optional[str]` — If provided, will only return employees for this location. + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -24863,8 +24419,7 @@ client.crm.leads.remote_field_classes_list()
-## Crm LinkToken -
client.crm.link_token.create(...) +
client.hris.employees.create(...)
@@ -24876,7 +24431,7 @@ client.crm.leads.remote_field_classes_list()
-Creates a link token to be used when linking a new end user. +Creates an `Employee` object with the given values.
@@ -24892,17 +24447,14 @@ Creates a link token to be used when linking a new end user. ```python from merge import Merge -from merge.resources.crm import CategoriesEnum +from merge.resources.hris import EmployeeRequest client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.link_token.create( - end_user_email_address="example@gmail.com", - end_user_organization_name="Test Organization", - end_user_origin_id="12345", - categories=[CategoriesEnum.HRIS, CategoriesEnum.ATS], +client.hris.employees.create( + model=EmployeeRequest(), ) ``` @@ -24919,7 +24471,7 @@ client.crm.link_token.create(
-**end_user_email_address:** `str` — Your end user's email address. This is purely for identification purposes - setting this value will not cause any emails to be sent. +**model:** `EmployeeRequest`
@@ -24927,7 +24479,7 @@ client.crm.link_token.create(
-**end_user_organization_name:** `str` — Your end user's organization. +**is_debug_mode:** `typing.Optional[bool]` — Whether to include debug fields (such as log file links) in the response.
@@ -24935,7 +24487,7 @@ client.crm.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. +**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously.
@@ -24943,15 +24495,70 @@ client.crm.link_token.create(
-**categories:** `typing.Sequence[CategoriesEnum]` — The integration categories to show in Merge Link. +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+ +
+ + + + +
+
client.hris.employees.retrieve(...)
-**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/. +#### 📝 Description + +
+
+ +
+
+ +Returns an `Employee` object with the given `id`. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from merge import Merge + +client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.hris.employees.retrieve( + id="id", +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**id:** `str`
@@ -24959,7 +24566,7 @@ client.crm.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. +**expand:** `typing.Optional[EmployeesRetrieveRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -24967,7 +24574,7 @@ client.crm.link_token.create(
-**should_create_magic_link_url:** `typing.Optional[bool]` — Whether to generate a Magic Link URL. Defaults to false. For more information on Magic Link, see https://merge.dev/blog/integrations-fast-say-hello-to-magic-link. +**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -24975,7 +24582,7 @@ client.crm.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. +**include_sensitive_fields:** `typing.Optional[bool]` — Whether to include sensitive fields (such as social security numbers) in the response.
@@ -24983,7 +24590,7 @@ client.crm.link_token.create(
-**common_models:** `typing.Optional[typing.Sequence[CommonModelScopesBodyRequest]]` — An array of objects to specify the models and fields that will be disabled for a given Linked Account. Each object uses model_id, enabled_actions, and disabled_fields to specify the model, method, and fields that are scoped for a given Linked Account. +**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -24991,14 +24598,7 @@ client.crm.link_token.create(
-**category_common_model_scopes:** `typing.Optional[ - typing.Dict[ - str, - typing.Optional[ - typing.Sequence[IndividualCommonModelScopeDeserializerRequest] - ], - ] -]` — When creating a Link Token, you can set permissions for Common Models that will apply to the account that is going to be linked. Any model or field not specified in link token payload will default to existing settings. +**remote_fields:** `typing.Optional[EmployeesRetrieveRequestRemoteFields]` — Deprecated. Use show_enum_origins.
@@ -25006,20 +24606,80 @@ client.crm.link_token.create(
-**language:** `typing.Optional[EndUserDetailsRequestLanguage]` +**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) + +
+
-The following subset of IETF language tags can be used to configure localization. +
+
-* `en` - en -* `de` - de +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+ + +
+
+
+
client.hris.employees.ignore_create(...)
-**are_syncs_disabled:** `typing.Optional[bool]` — The boolean that indicates whether initial, periodic, and force syncs will be disabled. +#### 📝 Description + +
+
+ +
+
+ +Ignores a specific row based on the `model_id` in the url. These records will have their properties set to null, and will not be updated in future syncs. The "reason" and "message" fields in the request body will be stored for audit purposes. +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from merge import Merge +from merge.resources.hris import ReasonEnum + +client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.hris.employees.ignore_create( + model_id="model_id", + reason=ReasonEnum.GENERAL_CUSTOMER_REQUEST, +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**model_id:** `str`
@@ -25027,7 +24687,15 @@ The following subset of IETF language tags can be used to configure localization
-**integration_specific_config:** `typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]]` — A JSON object containing integration-specific configuration options. +**reason:** `IgnoreCommonModelRequestReason` + +
+
+ +
+
+ +**message:** `typing.Optional[str]`
@@ -25047,8 +24715,7 @@ The following subset of IETF language tags can be used to configure localization
-## Crm LinkedAccounts -
client.crm.linked_accounts.list(...) +
client.hris.employees.meta_post_retrieve()
@@ -25060,7 +24727,7 @@ The following subset of IETF language tags can be used to configure localization
-List linked accounts for your organization. +Returns metadata for `Employee` POSTs.
@@ -25081,7 +24748,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.linked_accounts.list() +client.hris.employees.meta_post_retrieve() ``` @@ -25097,41 +24764,69 @@ client.crm.linked_accounts.list()
-**category:** `typing.Optional[LinkedAccountsListRequestCategory]` +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+ +
-Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing` -* `hris` - hris -* `ats` - ats -* `accounting` - accounting -* `ticketing` - ticketing -* `crm` - crm -* `mktg` - mktg -* `filestorage` - filestorage - +
+## Hris EmployerBenefits +
client.hris.employer_benefits.list(...)
-**cursor:** `typing.Optional[str]` — The pagination cursor value. - +#### 📝 Description + +
+
+ +
+
+ +Returns a list of `EmployerBenefit` objects.
+
+
+ +#### 🔌 Usage
-**end_user_email_address:** `typing.Optional[str]` — If provided, will only return linked accounts associated with the given email address. - +
+
+ +```python +from merge import Merge + +client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.hris.employer_benefits.list() + +``` +
+
+#### ⚙️ Parameters +
-**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.
@@ -25139,7 +24834,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.
@@ -25147,7 +24842,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.
@@ -25155,7 +24850,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/).
@@ -25163,7 +24858,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.
@@ -25171,7 +24866,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).
@@ -25179,7 +24874,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.
@@ -25187,7 +24882,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.
@@ -25203,7 +24898,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.
@@ -25223,8 +24918,7 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing`
-## Crm Notes -
client.crm.notes.list(...) +
client.hris.employer_benefits.retrieve(...)
@@ -25236,7 +24930,7 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing`
-Returns a list of `Note` objects. +Returns an `EmployerBenefit` object with the given `id`.
@@ -25257,7 +24951,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.notes.list() +client.hris.employer_benefits.retrieve( + id="id", +) ``` @@ -25273,7 +24969,7 @@ client.crm.notes.list()
-**account_id:** `typing.Optional[str]` — If provided, will only return notes with this account. +**id:** `str`
@@ -25281,7 +24977,7 @@ client.crm.notes.list()
-**contact_id:** `typing.Optional[str]` — If provided, will only return notes with this contact. +**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -25289,55 +24985,77 @@ client.crm.notes.list()
-**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created 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). + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+ +
+ + + + +
+ +## Hris Employments +
client.hris.employments.list(...) +
+
+ +#### 📝 Description
-**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime. - -
-
-
-**cursor:** `typing.Optional[str]` — The pagination cursor value. - +Returns a list of `Employment` objects.
+
+
+ +#### 🔌 Usage
-**expand:** `typing.Optional[NotesListRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. - -
-
-
-**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/). - +```python +from merge import Merge + +client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.hris.employments.list() + +``` +
+
+#### ⚙️ Parameters +
-**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. +**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
@@ -25345,7 +25063,7 @@ client.crm.notes.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.
@@ -25353,7 +25071,7 @@ client.crm.notes.list()
-**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned. +**cursor:** `typing.Optional[str]` — The pagination cursor value.
@@ -25361,7 +25079,7 @@ client.crm.notes.list()
-**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned. +**employee_id:** `typing.Optional[str]` — If provided, will only return employments for this employee.
@@ -25369,7 +25087,7 @@ client.crm.notes.list()
-**opportunity_id:** `typing.Optional[str]` — If provided, will only return notes with this opportunity. +**expand:** `typing.Optional[EmploymentsListRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -25377,7 +25095,7 @@ client.crm.notes.list()
-**owner_id:** `typing.Optional[str]` — If provided, will only return notes with this owner. +**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/).
@@ -25385,7 +25103,7 @@ client.crm.notes.list()
-**page_size:** `typing.Optional[int]` — Number of results to return per page. +**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -25393,7 +25111,7 @@ client.crm.notes.list()
-**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object. +**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -25401,71 +25119,39 @@ client.crm.notes.list()
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. +**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
- - - - - - -
-
client.crm.notes.create(...)
-#### 📝 Description - -
-
+**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned. + +
+
-Creates a `Note` object with the given values. -
-
+**order_by:** `typing.Optional[EmploymentsListRequestOrderBy]` — Overrides the default ordering for this endpoint. Possible values include: effective_date, -effective_date. +
-#### 🔌 Usage - -
-
-
-```python -from merge import Merge -from merge.resources.crm import NoteRequest - -client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.crm.notes.create( - model=NoteRequest(), -) - -``` -
-
+**page_size:** `typing.Optional[int]` — Number of results to return per page. +
-#### ⚙️ Parameters - -
-
-
-**model:** `NoteRequest` +**remote_fields:** `typing.Optional[EmploymentsListRequestRemoteFields]` — Deprecated. Use show_enum_origins.
@@ -25473,7 +25159,7 @@ client.crm.notes.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.
@@ -25481,7 +25167,7 @@ client.crm.notes.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)
@@ -25501,7 +25187,7 @@ client.crm.notes.create(
-
client.crm.notes.retrieve(...) +
client.hris.employments.retrieve(...)
@@ -25513,7 +25199,7 @@ client.crm.notes.create(
-Returns a `Note` object with the given `id`. +Returns an `Employment` object with the given `id`.
@@ -25534,7 +25220,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.notes.retrieve( +client.hris.employments.retrieve( id="id", ) @@ -25560,7 +25246,7 @@ client.crm.notes.retrieve(
-**expand:** `typing.Optional[NotesRetrieveRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. +**expand:** `typing.Optional[EmploymentsRetrieveRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -25576,7 +25262,7 @@ client.crm.notes.retrieve(
-**include_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format. +**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -25584,7 +25270,15 @@ client.crm.notes.retrieve(
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). +**remote_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)
@@ -25604,7 +25298,8 @@ client.crm.notes.retrieve(
-
client.crm.notes.meta_post_retrieve() +## Hris FieldMapping +
client.hris.field_mapping.field_mappings_retrieve(...)
@@ -25616,7 +25311,7 @@ client.crm.notes.retrieve(
-Returns metadata for `Note` 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/).
@@ -25637,7 +25332,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.notes.meta_post_retrieve() +client.hris.field_mapping.field_mappings_retrieve() ``` @@ -25653,6 +25348,14 @@ client.crm.notes.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.
@@ -25665,7 +25368,7 @@ client.crm.notes.meta_post_retrieve()
-
client.crm.notes.remote_field_classes_list(...) +
client.hris.field_mapping.field_mappings_create(...)
@@ -25677,7 +25380,7 @@ client.crm.notes.meta_post_retrieve()
-Returns a list of `RemoteFieldClass` objects. +Create new Field Mappings that will be available after the next scheduled sync. This will cause the next sync for this Linked Account to sync **ALL** data from start.
@@ -25698,7 +25401,14 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.notes.remote_field_classes_list() +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", +) ``` @@ -25714,15 +25424,7 @@ client.crm.notes.remote_field_classes_list()
-**cursor:** `typing.Optional[str]` — The pagination cursor value. - -
-
- -
-
- -**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/). +**target_field_name:** `str` — The name of the target field you want this remote field to map to.
@@ -25730,7 +25432,7 @@ client.crm.notes.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. +**target_field_description:** `str` — The description of the target field you want this remote field to map to.
@@ -25738,7 +25440,7 @@ client.crm.notes.remote_field_classes_list()
-**include_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format. +**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.
@@ -25746,7 +25448,7 @@ client.crm.notes.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). +**remote_method:** `str` — The method of the remote endpoint where the remote field is coming from.
@@ -25754,7 +25456,7 @@ client.crm.notes.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_url_path:** `str` — The path of the remote endpoint where the remote field is coming from.
@@ -25762,7 +25464,7 @@ client.crm.notes.remote_field_classes_list()
-**is_custom:** `typing.Optional[bool]` — If provided, will only return remote fields classes with this is_custom value +**common_model_name:** `str` — The name of the Common Model that the remote field corresponds to in a given category.
@@ -25770,7 +25472,7 @@ client.crm.notes.remote_field_classes_list()
-**page_size:** `typing.Optional[int]` — Number of results to return per page. +**exclude_remote_field_metadata:** `typing.Optional[bool]` — If `true`, remote fields metadata is excluded from each field mapping instance (i.e. `remote_fields.remote_key_name` and `remote_fields.schema` will be null). This will increase the speed of the request since these fields require some calculations.
@@ -25790,8 +25492,7 @@ client.crm.notes.remote_field_classes_list()
-## Crm Opportunities -
client.crm.opportunities.list(...) +
client.hris.field_mapping.field_mappings_destroy(...)
@@ -25803,7 +25504,7 @@ client.crm.notes.remote_field_classes_list()
-Returns a list of `Opportunity` objects. +Deletes Field Mappings for a Linked Account. All data related to this Field Mapping will be deleted and these changes will be reflected after the next scheduled sync. This will cause the next sync for this Linked Account to sync **ALL** data from start.
@@ -25824,7 +25525,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.opportunities.list() +client.hris.field_mapping.field_mappings_destroy( + field_mapping_id="field_mapping_id", +) ``` @@ -25840,47 +25543,7 @@ client.crm.opportunities.list()
-**account_id:** `typing.Optional[str]` — If provided, will only return opportunities with this account. - -
-
- -
-
- -**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime. - -
-
- -
-
- -**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime. - -
-
- -
-
- -**cursor:** `typing.Optional[str]` — The pagination cursor value. - -
-
- -
-
- -**expand:** `typing.Optional[OpportunitiesListRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. - -
-
- -
-
- -**include_deleted_data:** `typing.Optional[bool]` — 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/). +**field_mapping_id:** `str`
@@ -25888,79 +25551,70 @@ client.crm.opportunities.list()
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
- -
-
- -**include_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format. -
-
-
-**include_shell_data:** `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.hris.field_mapping.field_mappings_partial_update(...)
-**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned. - -
-
+#### 📝 Description
-
- -**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned. - -
-
+
-**owner_id:** `typing.Optional[str]` — If provided, will only return opportunities with this owner. - +Create or update existing Field Mappings for a Linked Account. Changes will be reflected after the next scheduled sync. This will cause the next sync for this Linked Account to sync **ALL** data from start.
+
+ + +#### 🔌 Usage
-**page_size:** `typing.Optional[int]` — Number of results to return per page. - -
-
-
-**remote_created_after:** `typing.Optional[dt.datetime]` — If provided, will only return opportunities created in the third party platform after this datetime. - +```python +from merge import Merge + +client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.hris.field_mapping.field_mappings_partial_update( + field_mapping_id="field_mapping_id", +) + +``` +
+
+#### ⚙️ Parameters +
-**remote_fields:** `typing.Optional[typing.Literal["status"]]` — Deprecated. Use show_enum_origins. - -
-
-
-**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object. +**field_mapping_id:** `str`
@@ -25968,7 +25622,7 @@ client.crm.opportunities.list()
-**show_enum_origins:** `typing.Optional[typing.Literal["status"]]` — A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter) +**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.
@@ -25976,7 +25630,7 @@ client.crm.opportunities.list()
-**stage_id:** `typing.Optional[str]` — If provided, will only return opportunities with this stage. +**remote_method:** `typing.Optional[str]` — The method of the remote endpoint where the remote field is coming from.
@@ -25984,13 +25638,7 @@ client.crm.opportunities.list()
-**status:** `typing.Optional[OpportunitiesListRequestStatus]` - -If provided, will only return opportunities with this status. Options: ('OPEN', 'WON', 'LOST') - -* `OPEN` - OPEN -* `WON` - WON -* `LOST` - LOST +**remote_url_path:** `typing.Optional[str]` — The path of the remote endpoint where the remote field is coming from.
@@ -26010,7 +25658,7 @@ If provided, will only return opportunities with this status. Options: ('OPEN',
-
client.crm.opportunities.create(...) +
client.hris.field_mapping.remote_fields_retrieve(...)
@@ -26022,7 +25670,7 @@ If provided, will only return opportunities with this status. Options: ('OPEN',
-Creates an `Opportunity` object with the given values. +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/).
@@ -26038,15 +25686,12 @@ Creates an `Opportunity` object with the given values. ```python from merge import Merge -from merge.resources.crm import OpportunityRequest client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.opportunities.create( - model=OpportunityRequest(), -) +client.hris.field_mapping.remote_fields_retrieve() ``` @@ -26062,15 +25707,7 @@ client.crm.opportunities.create(
-**model:** `OpportunityRequest` - -
-
- -
-
- -**is_debug_mode:** `typing.Optional[bool]` — Whether to include debug fields (such as log file links) in the response. +**common_models:** `typing.Optional[str]` — A comma seperated list of Common Model names. If included, will only return Remote Fields for those Common Models.
@@ -26078,7 +25715,7 @@ client.crm.opportunities.create(
-**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously. +**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.
@@ -26098,7 +25735,7 @@ client.crm.opportunities.create(
-
client.crm.opportunities.retrieve(...) +
client.hris.field_mapping.target_fields_retrieve()
@@ -26110,7 +25747,7 @@ client.crm.opportunities.create(
-Returns an `Opportunity` 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/).
@@ -26131,9 +25768,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.opportunities.retrieve( - id="id", -) +client.hris.field_mapping.target_fields_retrieve() ``` @@ -26149,55 +25784,71 @@ client.crm.opportunities.retrieve(
-**id:** `str` +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+ +
-
-
-**expand:** `typing.Optional[OpportunitiesRetrieveRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. -
+
+## Hris GenerateKey +
client.hris.generate_key.create(...)
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. - -
-
+#### 📝 Description
-**include_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format. - -
-
-
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). - +Create a remote key. +
+
+#### 🔌 Usage +
-**remote_fields:** `typing.Optional[typing.Literal["status"]]` — Deprecated. Use show_enum_origins. - +
+
+ +```python +from merge import Merge + +client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.hris.generate_key.create( + name="Remote Deployment Key 1", +) + +```
+
+
+ +#### ⚙️ Parameters
-**show_enum_origins:** `typing.Optional[typing.Literal["status"]]` — A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter) +
+
+ +**name:** `str` — The name of the remote key
@@ -26217,7 +25868,8 @@ client.crm.opportunities.retrieve(
-
client.crm.opportunities.partial_update(...) +## Hris Groups +
client.hris.groups.list(...)
@@ -26229,7 +25881,7 @@ client.crm.opportunities.retrieve(
-Updates an `Opportunity` object with the given `id`. +Returns a list of `Group` objects.
@@ -26245,16 +25897,12 @@ Updates an `Opportunity` object with the given `id`. ```python from merge import Merge -from merge.resources.crm import PatchedOpportunityRequest client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.opportunities.partial_update( - id="id", - model=PatchedOpportunityRequest(), -) +client.hris.groups.list() ``` @@ -26270,7 +25918,7 @@ client.crm.opportunities.partial_update(
-**id:** `str` +**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
@@ -26278,7 +25926,7 @@ client.crm.opportunities.partial_update(
-**model:** `PatchedOpportunityRequest` +**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
@@ -26286,7 +25934,7 @@ client.crm.opportunities.partial_update(
-**is_debug_mode:** `typing.Optional[bool]` — Whether to include debug fields (such as log file links) in the response. +**cursor:** `typing.Optional[str]` — The pagination cursor value.
@@ -26294,7 +25942,7 @@ client.crm.opportunities.partial_update(
-**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously. +**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/).
@@ -26302,70 +25950,87 @@ client.crm.opportunities.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.crm.opportunities.meta_patch_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. + +
+
+
-Returns metadata for `Opportunity` PATCHs. -
-
+**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 +**page_size:** `typing.Optional[int]` — Number of results to return per page. + +
+
-client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.crm.opportunities.meta_patch_retrieve( - id="id", -) +
+
-``` +**remote_fields:** `typing.Optional[typing.Literal["type"]]` — Deprecated. Use show_enum_origins. +
+ +
+
+ +**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object. +
-#### ⚙️ Parameters -
+**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) + +
+
+
-**id:** `str` +**types:** `typing.Optional[str]` — If provided, will only return groups of these types. Multiple values can be separated by commas.
@@ -26385,7 +26050,7 @@ client.crm.opportunities.meta_patch_retrieve(
-
client.crm.opportunities.meta_post_retrieve() +
client.hris.groups.retrieve(...)
@@ -26397,7 +26062,7 @@ client.crm.opportunities.meta_patch_retrieve(
-Returns metadata for `Opportunity` POSTs. +Returns a `Group` object with the given `id`.
@@ -26418,7 +26083,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.opportunities.meta_post_retrieve() +client.hris.groups.retrieve( + id="id", +) ``` @@ -26426,11 +26093,51 @@ client.crm.opportunities.meta_post_retrieve()
-#### ⚙️ Parameters - +#### ⚙️ Parameters + +
+
+ +
+
+ +**id:** `str` + +
+
+ +
+
+ +**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. + +
+
+ +
+
+ +**include_shell_data:** `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) + +
+
+
@@ -26446,7 +26153,8 @@ client.crm.opportunities.meta_post_retrieve()
-
client.crm.opportunities.remote_field_classes_list(...) +## Hris Issues +
client.hris.issues.list(...)
@@ -26458,7 +26166,7 @@ client.crm.opportunities.meta_post_retrieve()
-Returns a list of `RemoteFieldClass` objects. +Gets all issues for Organization.
@@ -26479,7 +26187,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.opportunities.remote_field_classes_list() +client.hris.issues.list() ``` @@ -26495,7 +26203,7 @@ client.crm.opportunities.remote_field_classes_list()
-**cursor:** `typing.Optional[str]` — The pagination cursor value. +**account_token:** `typing.Optional[str]`
@@ -26503,7 +26211,7 @@ client.crm.opportunities.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/). +**cursor:** `typing.Optional[str]` — The pagination cursor value.
@@ -26511,7 +26219,7 @@ client.crm.opportunities.remote_field_classes_list()
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. +**end_date:** `typing.Optional[str]` — If included, will only include issues whose most recent action occurred before this time
@@ -26519,7 +26227,7 @@ client.crm.opportunities.remote_field_classes_list()
-**include_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format. +**end_user_organization_name:** `typing.Optional[str]`
@@ -26527,7 +26235,7 @@ client.crm.opportunities.remote_field_classes_list()
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). +**first_incident_time_after:** `typing.Optional[dt.datetime]` — If provided, will only return issues whose first incident time was after this datetime.
@@ -26535,7 +26243,7 @@ client.crm.opportunities.remote_field_classes_list()
-**is_common_model_field:** `typing.Optional[bool]` — If provided, will only return remote field classes with this is_common_model_field value +**first_incident_time_before:** `typing.Optional[dt.datetime]` — If provided, will only return issues whose first incident time was before this datetime.
@@ -26543,7 +26251,7 @@ client.crm.opportunities.remote_field_classes_list()
-**is_custom:** `typing.Optional[bool]` — If provided, will only return remote fields classes with this is_custom value +**include_muted:** `typing.Optional[str]` — If true, will include muted issues
@@ -26551,7 +26259,7 @@ client.crm.opportunities.remote_field_classes_list()
-**page_size:** `typing.Optional[int]` — Number of results to return per page. +**integration_name:** `typing.Optional[str]`
@@ -26559,75 +26267,52 @@ client.crm.opportunities.remote_field_classes_list()
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. +**last_incident_time_after:** `typing.Optional[dt.datetime]` — If provided, will only return issues whose last incident time was after this datetime.
- -
+
+
+**last_incident_time_before:** `typing.Optional[dt.datetime]` — If provided, will only return issues whose last incident time was before this datetime. +
-
-## Crm Passthrough -
client.crm.passthrough.create(...)
-#### 📝 Description - -
-
+**linked_account_id:** `typing.Optional[str]` — If provided, will only include issues pertaining to the linked account passed in. + +
+
-Pull data from an endpoint not currently supported by Merge. -
-
+**page_size:** `typing.Optional[int]` — Number of results to return per page. +
-#### 🔌 Usage - -
-
-
-```python -from merge import Merge -from merge.resources.crm import DataPassthroughRequest, MethodEnum - -client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.crm.passthrough.create( - request=DataPassthroughRequest( - method=MethodEnum.GET, - path="/scooters", - ), -) - -``` -
-
+**start_date:** `typing.Optional[str]` — If included, will only include issues whose most recent action occurred after this time +
-#### ⚙️ Parameters -
-
-
+**status:** `typing.Optional[IssuesListRequestStatus]` -**request:** `DataPassthroughRequest` +Status of the issue. Options: ('ONGOING', 'RESOLVED') + +* `ONGOING` - ONGOING +* `RESOLVED` - RESOLVED
@@ -26647,8 +26332,7 @@ client.crm.passthrough.create(
-## Crm RegenerateKey -
client.crm.regenerate_key.create(...) +
client.hris.issues.retrieve(...)
@@ -26660,7 +26344,7 @@ client.crm.passthrough.create(
-Exchange remote keys. +Get a specific issue.
@@ -26681,8 +26365,8 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.regenerate_key.create( - name="Remote Deployment Key 1", +client.hris.issues.retrieve( + id="id", ) ``` @@ -26699,7 +26383,7 @@ client.crm.regenerate_key.create(
-**name:** `str` — The name of the remote key +**id:** `str`
@@ -26719,8 +26403,8 @@ client.crm.regenerate_key.create(
-## Crm Stages -
client.crm.stages.list(...) +## Hris LinkToken +
client.hris.link_token.create(...)
@@ -26732,7 +26416,7 @@ client.crm.regenerate_key.create(
-Returns a list of `Stage` objects. +Creates a link token to be used when linking a new end user.
@@ -26748,12 +26432,18 @@ Returns a list of `Stage` objects. ```python from merge import Merge +from merge.resources.hris import CategoriesEnum client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.stages.list() +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], +) ``` @@ -26769,7 +26459,7 @@ client.crm.stages.list()
-**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime. +**end_user_email_address:** `str` — Your end user's email address. This is purely for identification purposes - setting this value will not cause any emails to be sent.
@@ -26777,7 +26467,7 @@ client.crm.stages.list()
-**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime. +**end_user_organization_name:** `str` — Your end user's organization.
@@ -26785,7 +26475,7 @@ client.crm.stages.list()
-**cursor:** `typing.Optional[str]` — The pagination cursor value. +**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.
@@ -26793,7 +26483,7 @@ client.crm.stages.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/). +**categories:** `typing.Sequence[CategoriesEnum]` — The integration categories to show in Merge Link.
@@ -26801,7 +26491,7 @@ client.crm.stages.list()
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. +**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/.
@@ -26809,7 +26499,7 @@ client.crm.stages.list()
-**include_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format. +**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.
@@ -26817,7 +26507,7 @@ client.crm.stages.list()
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). +**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.
@@ -26825,7 +26515,7 @@ client.crm.stages.list()
-**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned. +**hide_admin_magic_link:** `typing.Optional[bool]` — Whether to generate a Magic Link URL on the Admin Needed screen during the linking flow. Defaults to false. For more information on Magic Link, see https://merge.dev/blog/integrations-fast-say-hello-to-magic-link.
@@ -26833,7 +26523,7 @@ client.crm.stages.list()
-**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned. +**common_models:** `typing.Optional[typing.Sequence[CommonModelScopesBodyRequest]]` — An array of objects to specify the models and fields that will be disabled for a given Linked Account. Each object uses model_id, enabled_actions, and disabled_fields to specify the model, method, and fields that are scoped for a given Linked Account.
@@ -26841,7 +26531,14 @@ client.crm.stages.list()
-**page_size:** `typing.Optional[int]` — Number of results to return per page. +**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.
@@ -26849,7 +26546,28 @@ client.crm.stages.list()
-**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object. +**language:** `typing.Optional[EndUserDetailsRequestLanguage]` + +The following subset of IETF language tags can be used to configure localization. + +* `en` - en +* `de` - de + +
+
+ +
+
+ +**are_syncs_disabled:** `typing.Optional[bool]` — The boolean that indicates whether initial, periodic, and force syncs will be disabled. + +
+
+ +
+
+ +**integration_specific_config:** `typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]]` — A JSON object containing integration-specific configuration options.
@@ -26869,7 +26587,8 @@ client.crm.stages.list()
-
client.crm.stages.retrieve(...) +## Hris LinkedAccounts +
client.hris.linked_accounts.list(...)
@@ -26881,7 +26600,7 @@ client.crm.stages.list()
-Returns a `Stage` object with the given `id`. +List linked accounts for your organization.
@@ -26902,9 +26621,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.stages.retrieve( - id="id", -) +client.hris.linked_accounts.list() ``` @@ -26920,7 +26637,89 @@ client.crm.stages.retrieve(
-**id:** `str` +**category:** `typing.Optional[LinkedAccountsListRequestCategory]` + +Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing` + +* `hris` - hris +* `ats` - ats +* `accounting` - accounting +* `ticketing` - ticketing +* `crm` - crm +* `mktg` - mktg +* `filestorage` - filestorage + +
+
+ +
+
+ +**cursor:** `typing.Optional[str]` — The pagination cursor value. + +
+
+ +
+
+ +**end_user_email_address:** `typing.Optional[str]` — If provided, will only return linked accounts associated with the given email address. + +
+
+ +
+
+ +**end_user_organization_name:** `typing.Optional[str]` — If provided, will only return linked accounts associated with the given organization name. + +
+
+ +
+
+ +**end_user_origin_id:** `typing.Optional[str]` — If provided, will only return linked accounts associated with the given origin ID. + +
+
+ +
+
+ +**end_user_origin_ids:** `typing.Optional[str]` — Comma-separated list of EndUser origin IDs, making it possible to specify multiple EndUsers at once. + +
+
+ +
+
+ +**id:** `typing.Optional[str]` + +
+
+ +
+
+ +**ids:** `typing.Optional[str]` — Comma-separated list of LinkedAccount IDs, making it possible to specify multiple LinkedAccounts at once. + +
+
+ +
+
+ +**include_duplicates:** `typing.Optional[bool]` — If `true`, will include complete production duplicates of the account specified by the `id` query parameter in the response. `id` must be for a complete production linked account. + +
+
+ +
+
+ +**integration_name:** `typing.Optional[str]` — If provided, will only return linked accounts associated with the given integration name.
@@ -26928,7 +26727,7 @@ client.crm.stages.retrieve(
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. +**is_test_account:** `typing.Optional[str]` — If included, will only include test linked accounts. If not included, will only include non-test linked accounts.
@@ -26936,7 +26735,7 @@ client.crm.stages.retrieve(
-**include_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format. +**page_size:** `typing.Optional[int]` — Number of results to return per page.
@@ -26944,7 +26743,7 @@ client.crm.stages.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). +**status:** `typing.Optional[str]` — Filter by status. Options: `COMPLETE`, `IDLE`, `INCOMPLETE`, `RELINK_NEEDED`
@@ -26964,7 +26763,8 @@ client.crm.stages.retrieve(
-
client.crm.stages.remote_field_classes_list(...) +## Hris Locations +
client.hris.locations.list(...)
@@ -26976,7 +26776,7 @@ client.crm.stages.retrieve(
-Returns a list of `RemoteFieldClass` objects. +Returns a list of `Location` objects.
@@ -26997,7 +26797,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.stages.remote_field_classes_list() +client.hris.locations.list() ``` @@ -27013,6 +26813,22 @@ client.crm.stages.remote_field_classes_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.
@@ -27037,7 +26853,7 @@ client.crm.stages.remote_field_classes_list()
-**include_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format. +**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -27045,7 +26861,12 @@ client.crm.stages.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). +**location_type:** `typing.Optional[LocationsListRequestLocationType]` + +If provided, will only return locations with this location_type + +* `HOME` - HOME +* `WORK` - WORK
@@ -27053,7 +26874,7 @@ client.crm.stages.remote_field_classes_list()
-**is_common_model_field:** `typing.Optional[bool]` — If provided, will only return remote field classes with this is_common_model_field value +**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
@@ -27061,7 +26882,7 @@ client.crm.stages.remote_field_classes_list()
-**is_custom:** `typing.Optional[bool]` — If provided, will only return remote fields classes with this is_custom value +**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
@@ -27077,6 +26898,30 @@ client.crm.stages.remote_field_classes_list()
+**remote_fields:** `typing.Optional[LocationsListRequestRemoteFields]` — Deprecated. Use show_enum_origins. + +
+
+ +
+
+ +**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object. + +
+
+ +
+
+ +**show_enum_origins:** `typing.Optional[LocationsListRequestShowEnumOrigins]` — A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter) + +
+
+ +
+
+ **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -27089,8 +26934,7 @@ client.crm.stages.remote_field_classes_list()
-## Crm SyncStatus -
client.crm.sync_status.list(...) +
client.hris.locations.retrieve(...)
@@ -27102,7 +26946,7 @@ client.crm.stages.remote_field_classes_list()
-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 `Location` object with the given `id`.
@@ -27123,7 +26967,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.sync_status.list() +client.hris.locations.retrieve( + id="id", +) ``` @@ -27139,7 +26985,7 @@ client.crm.sync_status.list()
-**cursor:** `typing.Optional[str]` — The pagination cursor value. +**id:** `str`
@@ -27147,7 +26993,31 @@ client.crm.sync_status.list()
-**page_size:** `typing.Optional[int]` — Number of results to return per page. +**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. + +
+
+ +
+
+ +**include_shell_data:** `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. + +
+
+ +
+
+ +**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)
@@ -27167,8 +27037,8 @@ client.crm.sync_status.list()
-## Crm ForceResync -
client.crm.force_resync.sync_status_resync_create() +## Hris Passthrough +
client.hris.passthrough.create(...)
@@ -27180,7 +27050,7 @@ client.crm.sync_status.list()
-Force re-sync of all models. This endpoint is available for monthly, quarterly, and highest sync frequency customers on the Professional or Enterprise plans. Doing so will consume a sync credit for the relevant linked account. Force re-syncs can also be triggered manually in the Merge Dashboard and is available for all customers. +Pull data from an endpoint not currently supported by Merge.
@@ -27196,12 +27066,18 @@ Force re-sync of all models. This endpoint is available for monthly, quarterly, ```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.crm.force_resync.sync_status_resync_create() +client.hris.passthrough.create( + request=DataPassthroughRequest( + method=MethodEnum.GET, + path="/scooters", + ), +) ``` @@ -27217,6 +27093,14 @@ client.crm.force_resync.sync_status_resync_create()
+**request:** `DataPassthroughRequest` + +
+
+ +
+
+ **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -27229,8 +27113,8 @@ client.crm.force_resync.sync_status_resync_create()
-## Crm Tasks -
client.crm.tasks.list(...) +## Hris PayGroups +
client.hris.pay_groups.list(...)
@@ -27242,7 +27126,7 @@ client.crm.force_resync.sync_status_resync_create()
-Returns a list of `Task` objects. +Returns a list of `PayGroup` objects.
@@ -27263,7 +27147,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.tasks.list() +client.hris.pay_groups.list() ``` @@ -27303,14 +27187,6 @@ client.crm.tasks.list()
-**expand:** `typing.Optional[TasksListRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. - -
-
- -
-
- **include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
@@ -27327,14 +27203,6 @@ client.crm.tasks.list()
-**include_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format. - -
-
- -
-
- **include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -27387,7 +27255,7 @@ client.crm.tasks.list()
-
client.crm.tasks.create(...) +
client.hris.pay_groups.retrieve(...)
@@ -27399,7 +27267,7 @@ client.crm.tasks.list()
-Creates a `Task` object with the given values. +Returns a `PayGroup` object with the given `id`.
@@ -27415,14 +27283,13 @@ Creates a `Task` object with the given values. ```python from merge import Merge -from merge.resources.crm import TaskRequest client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.tasks.create( - model=TaskRequest(), +client.hris.pay_groups.retrieve( + id="id", ) ``` @@ -27439,7 +27306,7 @@ client.crm.tasks.create(
-**model:** `TaskRequest` +**id:** `str`
@@ -27447,7 +27314,7 @@ client.crm.tasks.create(
-**is_debug_mode:** `typing.Optional[bool]` — Whether to include debug fields (such as log file links) in the response. +**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -27455,7 +27322,7 @@ client.crm.tasks.create(
-**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously. +**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -27475,7 +27342,8 @@ client.crm.tasks.create(
-
client.crm.tasks.retrieve(...) +## Hris PayrollRuns +
client.hris.payroll_runs.list(...)
@@ -27487,7 +27355,7 @@ client.crm.tasks.create(
-Returns a `Task` object with the given `id`. +Returns a list of `PayrollRun` objects.
@@ -27508,25 +27376,119 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.tasks.retrieve( - id="id", -) +client.hris.payroll_runs.list() + +``` + +
+ + + +#### ⚙️ Parameters + +
+
+ +
+
+ +**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime. + +
+
+ +
+
+ +**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime. + +
+
+ +
+
+ +**cursor:** `typing.Optional[str]` — The pagination cursor value. + +
+
+ +
+
+ +**ended_after:** `typing.Optional[dt.datetime]` — If provided, will only return payroll runs ended after this datetime. + +
+
+ +
+
+ +**ended_before:** `typing.Optional[dt.datetime]` — If provided, will only return payroll runs ended before this datetime. + +
+
+ +
+
+ +**include_deleted_data:** `typing.Optional[bool]` — 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. +
-#### ⚙️ Parameters +
+
+ +**page_size:** `typing.Optional[int]` — Number of results to return per page. + +
+
+**remote_fields:** `typing.Optional[PayrollRunsListRequestRemoteFields]` — Deprecated. Use show_enum_origins. + +
+
+
-**id:** `str` +**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
@@ -27534,7 +27496,15 @@ client.crm.tasks.retrieve(
-**expand:** `typing.Optional[TasksRetrieveRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. +**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
@@ -27542,7 +27512,7 @@ client.crm.tasks.retrieve(
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. +**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)
@@ -27550,7 +27520,7 @@ client.crm.tasks.retrieve(
-**include_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format. +**started_after:** `typing.Optional[dt.datetime]` — If provided, will only return payroll runs started after this datetime.
@@ -27558,7 +27528,7 @@ client.crm.tasks.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). +**started_before:** `typing.Optional[dt.datetime]` — If provided, will only return payroll runs started before this datetime.
@@ -27578,7 +27548,7 @@ client.crm.tasks.retrieve(
-
client.crm.tasks.partial_update(...) +
client.hris.payroll_runs.retrieve(...)
@@ -27590,7 +27560,7 @@ client.crm.tasks.retrieve(
-Updates a `Task` object with the given `id`. +Returns a `PayrollRun` object with the given `id`.
@@ -27606,15 +27576,13 @@ Updates a `Task` object with the given `id`. ```python from merge import Merge -from merge.resources.crm import PatchedTaskRequest client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.tasks.partial_update( +client.hris.payroll_runs.retrieve( id="id", - model=PatchedTaskRequest(), ) ``` @@ -27639,7 +27607,7 @@ client.crm.tasks.partial_update(
-**model:** `PatchedTaskRequest` +**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -27647,7 +27615,7 @@ client.crm.tasks.partial_update(
-**is_debug_mode:** `typing.Optional[bool]` — Whether to include debug fields (such as log file links) 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).
@@ -27655,7 +27623,15 @@ client.crm.tasks.partial_update(
-**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously. +**remote_fields:** `typing.Optional[PayrollRunsRetrieveRequestRemoteFields]` — Deprecated. Use show_enum_origins. + +
+
+ +
+
+ +**show_enum_origins:** `typing.Optional[PayrollRunsRetrieveRequestShowEnumOrigins]` — A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter)
@@ -27675,7 +27651,8 @@ client.crm.tasks.partial_update(
-
client.crm.tasks.meta_patch_retrieve(...) +## Hris RegenerateKey +
client.hris.regenerate_key.create(...)
@@ -27687,7 +27664,7 @@ client.crm.tasks.partial_update(
-Returns metadata for `Task` PATCHs. +Exchange remote keys.
@@ -27708,8 +27685,8 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.tasks.meta_patch_retrieve( - id="id", +client.hris.regenerate_key.create( + name="Remote Deployment Key 1", ) ``` @@ -27726,7 +27703,7 @@ client.crm.tasks.meta_patch_retrieve(
-**id:** `str` +**name:** `str` — The name of the remote key
@@ -27746,7 +27723,8 @@ client.crm.tasks.meta_patch_retrieve(
-
client.crm.tasks.meta_post_retrieve() +## Hris SyncStatus +
client.hris.sync_status.list(...)
@@ -27758,7 +27736,7 @@ client.crm.tasks.meta_patch_retrieve(
-Returns metadata for `Task` POSTs. +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).
@@ -27779,7 +27757,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.tasks.meta_post_retrieve() +client.hris.sync_status.list() ``` @@ -27795,6 +27773,22 @@ client.crm.tasks.meta_post_retrieve()
+**cursor:** `typing.Optional[str]` — The pagination cursor value. + +
+
+ +
+
+ +**page_size:** `typing.Optional[int]` — Number of results to return per page. + +
+
+ +
+
+ **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -27807,7 +27801,8 @@ client.crm.tasks.meta_post_retrieve()
-
client.crm.tasks.remote_field_classes_list(...) +## Hris ForceResync +
client.hris.force_resync.sync_status_resync_create()
@@ -27819,7 +27814,7 @@ client.crm.tasks.meta_post_retrieve()
-Returns a list of `RemoteFieldClass` 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.
@@ -27840,7 +27835,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.tasks.remote_field_classes_list() +client.hris.force_resync.sync_status_resync_create() ``` @@ -27856,70 +27851,6 @@ client.crm.tasks.remote_field_classes_list()
-**cursor:** `typing.Optional[str]` — The pagination cursor value. - -
-
- -
-
- -**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/). - -
-
- -
-
- -**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. - -
-
- -
-
- -**include_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format. - -
-
- -
-
- -**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). - -
-
- -
-
- -**is_common_model_field:** `typing.Optional[bool]` — If provided, will only return remote field classes with this is_common_model_field value - -
-
- -
-
- -**is_custom:** `typing.Optional[bool]` — If provided, will only return remote fields classes with this is_custom value - -
-
- -
-
- -**page_size:** `typing.Optional[int]` — Number of results to return per page. - -
-
- -
-
- **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -27932,8 +27863,8 @@ client.crm.tasks.remote_field_classes_list()
-## Crm Users -
client.crm.users.list(...) +## Hris Teams +
client.hris.teams.list(...)
@@ -27945,7 +27876,7 @@ client.crm.tasks.remote_field_classes_list()
-Returns a list of `User` objects. +Returns a list of `Team` objects.
@@ -27966,7 +27897,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.users.list() +client.hris.teams.list() ``` @@ -28006,7 +27937,7 @@ client.crm.users.list()
-**email:** `typing.Optional[str]` — If provided, will only return users with this email. +**expand:** `typing.Optional[typing.Literal["parent_team"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -28030,7 +27961,7 @@ client.crm.users.list()
-**include_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format. +**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -28038,7 +27969,7 @@ client.crm.users.list()
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). +**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
@@ -28046,7 +27977,7 @@ client.crm.users.list()
-**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned. +**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
@@ -28054,7 +27985,7 @@ client.crm.users.list()
-**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned. +**page_size:** `typing.Optional[int]` — Number of results to return per page.
@@ -28062,7 +27993,7 @@ client.crm.users.list()
-**page_size:** `typing.Optional[int]` — Number of results to return per page. +**parent_team_id:** `typing.Optional[str]` — If provided, will only return teams with this parent team.
@@ -28090,7 +28021,7 @@ client.crm.users.list()
-
client.crm.users.retrieve(...) +
client.hris.teams.retrieve(...)
@@ -28102,7 +28033,7 @@ client.crm.users.list()
-Returns a `User` object with the given `id`. +Returns a `Team` object with the given `id`.
@@ -28123,7 +28054,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.users.retrieve( +client.hris.teams.retrieve( id="id", ) @@ -28149,7 +28080,7 @@ client.crm.users.retrieve(
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. +**expand:** `typing.Optional[typing.Literal["parent_team"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -28157,7 +28088,7 @@ client.crm.users.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_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -28185,7 +28116,8 @@ client.crm.users.retrieve(
-
client.crm.users.ignore_create(...) +## Hris TimeOff +
client.hris.time_off.list(...)
@@ -28197,7 +28129,7 @@ client.crm.users.retrieve(
-Ignores a specific row based on the `model_id` in the url. These records will have their properties set to null, and will not be updated in future syncs. The "reason" and "message" fields in the request body will be stored for audit purposes. +Returns a list of `TimeOff` objects.
@@ -28213,18 +28145,12 @@ Ignores a specific row based on the `model_id` in the url. These records will ha ```python from merge import Merge -from merge.resources.crm import IgnoreCommonModelRequest, ReasonEnum client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.users.ignore_create( - model_id="model_id", - request=IgnoreCommonModelRequest( - reason=ReasonEnum.GENERAL_CUSTOMER_REQUEST, - ), -) +client.hris.time_off.list() ``` @@ -28240,7 +28166,7 @@ client.crm.users.ignore_create(
-**model_id:** `str` +**approver_id:** `typing.Optional[str]` — If provided, will only return time off for this approver.
@@ -28248,7 +28174,7 @@ client.crm.users.ignore_create(
-**request:** `IgnoreCommonModelRequest` +**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
@@ -28256,68 +28182,95 @@ client.crm.users.ignore_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. +
+
+
+**employee_id:** `typing.Optional[str]` — If provided, will only return time off for this employee. +
-
-
client.crm.users.remote_field_classes_list(...)
-#### 📝 Description +**ended_after:** `typing.Optional[dt.datetime]` — If provided, will only return employees that ended after this datetime. + +
+
+**ended_before:** `typing.Optional[dt.datetime]` — If provided, will only return time-offs that ended before this datetime. + +
+
+
-Returns a list of `RemoteFieldClass` objects. +**expand:** `typing.Optional[TimeOffListRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. +
+ +
+
+ +**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/). +
-#### 🔌 Usage +
+
+ +**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. + +
+
+**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). + +
+
+
-```python -from merge import Merge - -client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.crm.users.remote_field_classes_list() - -``` -
-
+**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned. + -#### ⚙️ 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. +**page_size:** `typing.Optional[int]` — Number of results to return per page.
@@ -28325,7 +28278,7 @@ client.crm.users.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/). +**remote_fields:** `typing.Optional[TimeOffListRequestRemoteFields]` — Deprecated. Use show_enum_origins.
@@ -28333,7 +28286,7 @@ client.crm.users.remote_field_classes_list()
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. +**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
@@ -28341,7 +28294,16 @@ client.crm.users.remote_field_classes_list()
-**include_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format. +**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
@@ -28349,7 +28311,7 @@ client.crm.users.remote_field_classes_list()
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). +**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)
@@ -28357,7 +28319,7 @@ client.crm.users.remote_field_classes_list()
-**is_common_model_field:** `typing.Optional[bool]` — If provided, will only return remote field classes with this is_common_model_field value +**started_after:** `typing.Optional[dt.datetime]` — If provided, will only return time-offs that started after this datetime.
@@ -28365,7 +28327,7 @@ client.crm.users.remote_field_classes_list()
-**is_custom:** `typing.Optional[bool]` — If provided, will only return remote fields classes with this is_custom value +**started_before:** `typing.Optional[dt.datetime]` — If provided, will only return time-offs that started before this datetime.
@@ -28373,7 +28335,15 @@ client.crm.users.remote_field_classes_list()
-**page_size:** `typing.Optional[int]` — Number of results to return per page. +**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
@@ -28393,8 +28363,7 @@ client.crm.users.remote_field_classes_list()
-## Crm WebhookReceivers -
client.crm.webhook_receivers.list() +
client.hris.time_off.create(...)
@@ -28406,7 +28375,7 @@ client.crm.users.remote_field_classes_list()
-Returns a list of `WebhookReceiver` objects. +Creates a `TimeOff` object with the given values.
@@ -28422,12 +28391,15 @@ Returns a list of `WebhookReceiver` objects. ```python from merge import Merge +from merge.resources.hris import TimeOffRequest client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.webhook_receivers.list() +client.hris.time_off.create( + model=TimeOffRequest(), +) ``` @@ -28443,6 +28415,30 @@ client.crm.webhook_receivers.list()
+**model:** `TimeOffRequest` + +
+
+ +
+
+ +**is_debug_mode:** `typing.Optional[bool]` — Whether to include debug fields (such as log file links) in the response. + +
+
+ +
+
+ +**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously. + +
+
+ +
+
+ **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -28455,7 +28451,7 @@ client.crm.webhook_receivers.list()
-
client.crm.webhook_receivers.create(...) +
client.hris.time_off.retrieve(...)
@@ -28467,7 +28463,7 @@ client.crm.webhook_receivers.list()
-Creates a `WebhookReceiver` object with the given values. +Returns a `TimeOff` object with the given `id`.
@@ -28488,9 +28484,8 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.crm.webhook_receivers.create( - event="event", - is_active=True, +client.hris.time_off.retrieve( + id="id", ) ``` @@ -28507,7 +28502,7 @@ client.crm.webhook_receivers.create(
-**event:** `str` +**id:** `str`
@@ -28515,7 +28510,7 @@ client.crm.webhook_receivers.create(
-**is_active:** `bool` +**expand:** `typing.Optional[TimeOffRetrieveRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -28523,7 +28518,31 @@ client.crm.webhook_receivers.create(
-**key:** `typing.Optional[str]` +**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. + +
+
+ +
+
+ +**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). + +
+
+ +
+
+ +**remote_fields:** `typing.Optional[TimeOffRetrieveRequestRemoteFields]` — Deprecated. Use show_enum_origins. + +
+
+ +
+
+ +**show_enum_origins:** `typing.Optional[TimeOffRetrieveRequestShowEnumOrigins]` — A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter)
@@ -28543,8 +28562,7 @@ client.crm.webhook_receivers.create(
-## Hris AccountDetails -
client.hris.account_details.retrieve() +
client.hris.time_off.meta_post_retrieve()
@@ -28556,7 +28574,7 @@ client.crm.webhook_receivers.create(
-Get details for a linked account. +Returns metadata for `TimeOff` POSTs.
@@ -28577,7 +28595,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.account_details.retrieve() +client.hris.time_off.meta_post_retrieve() ``` @@ -28605,8 +28623,8 @@ client.hris.account_details.retrieve()
-## Hris AccountToken -
client.hris.account_token.retrieve(...) +## Hris TimeOffBalances +
client.hris.time_off_balances.list(...)
@@ -28618,7 +28636,7 @@ client.hris.account_details.retrieve()
-Returns the account token for the end user with the provided public token. +Returns a list of `TimeOffBalance` objects.
@@ -28639,9 +28657,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.account_token.retrieve( - public_token="public_token", -) +client.hris.time_off_balances.list() ``` @@ -28657,7 +28673,7 @@ client.hris.account_token.retrieve(
-**public_token:** `str` +**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
@@ -28665,75 +28681,55 @@ client.hris.account_token.retrieve(
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. +**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
- -
+
+
+**cursor:** `typing.Optional[str]` — The pagination cursor value. +
-
-## Hris AsyncPassthrough -
client.hris.async_passthrough.create(...)
-#### 📝 Description - -
-
+**employee_id:** `typing.Optional[str]` — If provided, will only return time off balances for this employee. + +
+
-Asynchronously pull data from an endpoint not currently supported by Merge. -
-
+**expand:** `typing.Optional[typing.Literal["employee"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. +
-#### 🔌 Usage - -
-
-
-```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", - ), -) - -``` -
-
+**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. + +
+
+
-**request:** `DataPassthroughRequest` +**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -28741,70 +28737,64 @@ client.hris.async_passthrough.create(
-**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. +
-
-
client.hris.async_passthrough.retrieve(...)
-#### 📝 Description +**page_size:** `typing.Optional[int]` — Number of results to return per page. + +
+
-
-
+**policy_type:** `typing.Optional[TimeOffBalancesListRequestPolicyType]` -Retrieves data from earlier async-passthrough POST request -
-
+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 +
-#### 🔌 Usage - -
-
-
-```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", -) - -``` -
-
+**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. + +
+
+
-**async_passthrough_receipt_id:** `str` +**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)
@@ -28824,8 +28814,7 @@ client.hris.async_passthrough.retrieve(
-## Hris AuditTrail -
client.hris.audit_trail.list(...) +
client.hris.time_off_balances.retrieve(...)
@@ -28837,7 +28826,7 @@ client.hris.async_passthrough.retrieve(
-Gets a list of audit trail events. +Returns a `TimeOffBalance` object with the given `id`.
@@ -28858,7 +28847,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.audit_trail.list() +client.hris.time_off_balances.retrieve( + id="id", +) ``` @@ -28874,7 +28865,7 @@ client.hris.audit_trail.list()
-**cursor:** `typing.Optional[str]` — The pagination cursor value. +**id:** `str`
@@ -28882,7 +28873,7 @@ client.hris.audit_trail.list()
-**end_date:** `typing.Optional[str]` — If included, will only include audit trail events that occurred before this time +**expand:** `typing.Optional[typing.Literal["employee"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -28890,7 +28881,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_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -28898,7 +28889,7 @@ client.hris.audit_trail.list()
-**page_size:** `typing.Optional[int]` — Number of results to return per page. +**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -28906,7 +28897,7 @@ client.hris.audit_trail.list()
-**start_date:** `typing.Optional[str]` — If included, will only include audit trail events that occurred after this time +**remote_fields:** `typing.Optional[typing.Literal["policy_type"]]` — Deprecated. Use show_enum_origins.
@@ -28914,7 +28905,7 @@ client.hris.audit_trail.list()
-**user_email:** `typing.Optional[str]` — If provided, this will return events associated with the specified user email. Please note that the email address reflects the user's email at the time of the event, and may not be their current email. +**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)
@@ -28934,8 +28925,8 @@ client.hris.audit_trail.list()
-## Hris AvailableActions -
client.hris.available_actions.retrieve() +## Hris TimesheetEntries +
client.hris.timesheet_entries.list(...)
@@ -28947,7 +28938,7 @@ client.hris.audit_trail.list()
-Returns a list of models and actions available for an account. +Returns a list of `TimesheetEntry` objects.
@@ -28968,7 +28959,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.available_actions.retrieve() +client.hris.timesheet_entries.list() ``` @@ -28984,74 +28975,55 @@ client.hris.available_actions.retrieve()
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. +**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
- -
+
+
+**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime. +
-
-## Hris BankInfo -
client.hris.bank_info.list(...)
-#### 📝 Description - -
-
+**cursor:** `typing.Optional[str]` — The pagination cursor value. + +
+
-Returns a list of `BankInfo` objects. -
-
+**employee_id:** `typing.Optional[str]` — If provided, will only return timesheet entries for this employee. +
-#### 🔌 Usage - -
-
-
-```python -from merge import Merge - -client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.hris.bank_info.list() - -``` -
-
+**ended_after:** `typing.Optional[dt.datetime]` — If provided, will only return timesheet entries ended after this datetime. +
-#### ⚙️ Parameters -
+**ended_before:** `typing.Optional[dt.datetime]` — If provided, will only return timesheet entries ended before this datetime. + +
+
+
-**account_type:** `typing.Optional[BankInfoListRequestAccountType]` - -If provided, will only return BankInfo's with this account type. Options: ('SAVINGS', 'CHECKING') - -* `SAVINGS` - SAVINGS -* `CHECKING` - CHECKING +**expand:** `typing.Optional[typing.Literal["employee"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -29059,7 +29031,7 @@ If provided, will only return BankInfo's with this account type. Options: ('SAVI
-**bank_name:** `typing.Optional[str]` — If provided, will only return BankInfo's with this bank name. +**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/).
@@ -29067,7 +29039,7 @@ If provided, will only return BankInfo's with this account type. Options: ('SAVI
-**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime. +**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -29075,7 +29047,7 @@ If provided, will only return BankInfo's with this account type. Options: ('SAVI
-**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime. +**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -29083,7 +29055,7 @@ If provided, will only return BankInfo's with this account type. Options: ('SAVI
-**cursor:** `typing.Optional[str]` — The pagination cursor value. +**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
@@ -29091,7 +29063,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. +**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
@@ -29099,7 +29071,7 @@ If provided, will only return BankInfo's with this account type. Options: ('SAVI
-**expand:** `typing.Optional[typing.Literal["employee"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. +**order_by:** `typing.Optional[TimesheetEntriesListRequestOrderBy]` — Overrides the default ordering for this endpoint. Possible values include: start_time, -start_time.
@@ -29107,7 +29079,7 @@ If provided, will only return BankInfo's with this account type. Options: ('SAVI
-**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/). +**page_size:** `typing.Optional[int]` — Number of results to return per page.
@@ -29115,7 +29087,7 @@ If provided, will only return BankInfo's with this account type. Options: ('SAVI
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. +**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
@@ -29123,7 +29095,7 @@ If provided, will only return BankInfo's with this account type. Options: ('SAVI
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). +**started_after:** `typing.Optional[dt.datetime]` — If provided, will only return timesheet entries started after this datetime.
@@ -29131,7 +29103,7 @@ If provided, will only return BankInfo's with this account type. Options: ('SAVI
-**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned. +**started_before:** `typing.Optional[dt.datetime]` — If provided, will only return timesheet entries started before this datetime.
@@ -29139,31 +29111,71 @@ If provided, will only return BankInfo's with this account type. Options: ('SAVI
-**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.hris.timesheet_entries.create(...)
-**order_by:** `typing.Optional[BankInfoListRequestOrderBy]` — Overrides the default ordering for this endpoint. Possible values include: remote_created_at, -remote_created_at. - +#### 📝 Description + +
+
+ +
+
+ +Creates a `TimesheetEntry` object with the given values. +
+
+#### 🔌 Usage +
-**page_size:** `typing.Optional[int]` — Number of results to return per page. - +
+
+ +```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(), +) + +``` +
+
+#### ⚙️ Parameters +
-**remote_fields:** `typing.Optional[typing.Literal["account_type"]]` — Deprecated. Use show_enum_origins. +
+
+ +**model:** `TimesheetEntryRequest`
@@ -29171,7 +29183,7 @@ If provided, will only return BankInfo's with this account type. Options: ('SAVI
-**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object. +**is_debug_mode:** `typing.Optional[bool]` — Whether to include debug fields (such as log file links) in the response.
@@ -29179,7 +29191,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) +**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously.
@@ -29199,7 +29211,7 @@ If provided, will only return BankInfo's with this account type. Options: ('SAVI
-
client.hris.bank_info.retrieve(...) +
client.hris.timesheet_entries.retrieve(...)
@@ -29211,7 +29223,7 @@ If provided, will only return BankInfo's with this account type. Options: ('SAVI
-Returns a `BankInfo` object with the given `id`. +Returns a `TimesheetEntry` object with the given `id`.
@@ -29232,7 +29244,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.bank_info.retrieve( +client.hris.timesheet_entries.retrieve( id="id", ) @@ -29282,22 +29294,6 @@ client.hris.bank_info.retrieve(
-**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.
@@ -29310,8 +29306,7 @@ client.hris.bank_info.retrieve(
-## Hris Benefits -
client.hris.benefits.list(...) +
client.hris.timesheet_entries.meta_post_retrieve()
@@ -29323,7 +29318,7 @@ client.hris.bank_info.retrieve(
-Returns a list of `Benefit` objects. +Returns metadata for `TimesheetEntry` POSTs.
@@ -29344,7 +29339,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.benefits.list() +client.hris.timesheet_entries.meta_post_retrieve() ``` @@ -29360,99 +29355,65 @@ client.hris.benefits.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. -
-
-
-**cursor:** `typing.Optional[str]` — The pagination cursor value. -
+
+## Hris WebhookReceivers +
client.hris.webhook_receivers.list()
-**employee_id:** `typing.Optional[str]` — If provided, will return the benefits associated with the employee. - -
-
+#### 📝 Description
-**expand:** `typing.Optional[typing.Literal["employee"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. - -
-
-
-**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/). - +Returns a list of `WebhookReceiver` objects.
- -
-
- -**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. -
+#### 🔌 Usage +
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). - -
-
-
-**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.webhook_receivers.list() -**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned. - +```
- -
-
- -**page_size:** `typing.Optional[int]` — Number of results to return per page. -
+#### ⚙️ Parameters +
-**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object. - -
-
-
@@ -29468,7 +29429,7 @@ client.hris.benefits.list()
-
client.hris.benefits.retrieve(...) +
client.hris.webhook_receivers.create(...)
@@ -29480,7 +29441,7 @@ client.hris.benefits.list()
-Returns a `Benefit` object with the given `id`. +Creates a `WebhookReceiver` object with the given values.
@@ -29501,8 +29462,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.benefits.retrieve( - id="id", +client.hris.webhook_receivers.create( + event="event", + is_active=True, ) ``` @@ -29519,15 +29481,7 @@ client.hris.benefits.retrieve(
-**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. +**event:** `str`
@@ -29535,7 +29489,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. +**is_active:** `bool`
@@ -29543,7 +29497,7 @@ client.hris.benefits.retrieve(
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). +**key:** `typing.Optional[str]`
@@ -29563,8 +29517,8 @@ client.hris.benefits.retrieve(
-## Hris Companies -
client.hris.companies.list(...) +## Ticketing AccountDetails +
client.ticketing.account_details.retrieve()
@@ -29576,7 +29530,7 @@ client.hris.benefits.retrieve(
-Returns a list of `Company` objects. +Get details for a linked account.
@@ -29597,7 +29551,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.companies.list() +client.ticketing.account_details.retrieve() ``` @@ -29613,79 +29567,71 @@ client.hris.companies.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. -
-
-
-**cursor:** `typing.Optional[str]` — The pagination cursor value. -
+
+## Ticketing AccountToken +
client.ticketing.account_token.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 the account token for the end user with the provided public token. +
+
+#### 🔌 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 + +client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.ticketing.account_token.retrieve( + public_token="public_token", +) + +``` +
+
+#### ⚙️ Parameters +
-**page_size:** `typing.Optional[int]` — Number of results to return per page. - -
-
-
-**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object. +**public_token:** `str`
@@ -29705,7 +29651,8 @@ client.hris.companies.list()
-
client.hris.companies.retrieve(...) +## Ticketing Accounts +
client.ticketing.accounts.list(...)
@@ -29717,7 +29664,7 @@ client.hris.companies.list()
-Returns a `Company` object with the given `id`. +Returns a list of `Account` objects.
@@ -29738,9 +29685,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.companies.retrieve( - id="id", -) +client.ticketing.accounts.list() ``` @@ -29756,7 +29701,7 @@ client.hris.companies.retrieve(
-**id:** `str` +**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
@@ -29764,7 +29709,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. +**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
@@ -29772,7 +29717,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). +**cursor:** `typing.Optional[str]` — The pagination cursor value.
@@ -29780,65 +29725,59 @@ 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/).
- -
+
+
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. +
-
-## Hris Scopes -
client.hris.scopes.default_scopes_retrieve()
-#### 📝 Description - -
-
+**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). + +
+
-Get 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). -
-
+**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned. +
-#### 🔌 Usage -
+**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned. + +
+
+
-```python -from merge import Merge - -client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.hris.scopes.default_scopes_retrieve() - -``` -
-
+**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. + +
+
+
@@ -29854,7 +29793,7 @@ client.hris.scopes.default_scopes_retrieve()
-
client.hris.scopes.linked_account_scopes_retrieve() +
client.ticketing.accounts.retrieve(...)
@@ -29866,7 +29805,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 an `Account` object with the given `id`.
@@ -29887,7 +29826,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.scopes.linked_account_scopes_retrieve() +client.ticketing.accounts.retrieve( + id="id", +) ``` @@ -29903,6 +29844,30 @@ client.hris.scopes.linked_account_scopes_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.
@@ -29915,7 +29880,8 @@ client.hris.scopes.linked_account_scopes_retrieve()
-
client.hris.scopes.linked_account_scopes_create(...) +## Ticketing AsyncPassthrough +
client.ticketing.async_passthrough.create(...)
@@ -29927,7 +29893,7 @@ client.hris.scopes.linked_account_scopes_retrieve()
-Update permissions for any Common Model or field for a single Linked Account. Any Scopes not set in this POST request will inherit the default Scopes. [Learn more](https://help.merge.dev/en/articles/5950052-common-model-and-field-scopes) +Asynchronously pull data from an endpoint not currently supported by Merge.
@@ -29939,46 +29905,21 @@ Update permissions for any Common Model or field for a single Linked Account. An
-
- -```python -from merge import Merge -from merge.resources.hris import ( - FieldPermissionDeserializerRequest, - IndividualCommonModelScopeDeserializerRequest, - ModelPermissionDeserializerRequest, -) - -client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.hris.scopes.linked_account_scopes_create( - common_models=[ - IndividualCommonModelScopeDeserializerRequest( - model_name="Employee", - model_permissions={ - "READ": ModelPermissionDeserializerRequest( - is_enabled=True, - ), - "WRITE": ModelPermissionDeserializerRequest( - is_enabled=False, - ), - }, - field_permissions=FieldPermissionDeserializerRequest( - enabled_fields=["avatar", "home_location"], - disabled_fields=["work_location"], - ), - ), - IndividualCommonModelScopeDeserializerRequest( - model_name="Benefit", - model_permissions={ - "WRITE": ModelPermissionDeserializerRequest( - is_enabled=False, - ) - }, - ), - ], +
+ +```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", + ), ) ``` @@ -29995,7 +29936,7 @@ client.hris.scopes.linked_account_scopes_create(
-**common_models:** `typing.Sequence[IndividualCommonModelScopeDeserializerRequest]` — The common models you want to update the scopes for +**request:** `DataPassthroughRequest`
@@ -30015,8 +29956,7 @@ client.hris.scopes.linked_account_scopes_create(
-## Hris DeleteAccount -
client.hris.delete_account.delete() +
client.ticketing.async_passthrough.retrieve(...)
@@ -30028,7 +29968,7 @@ client.hris.scopes.linked_account_scopes_create(
-Delete a linked account. +Retrieves data from earlier async-passthrough POST request
@@ -30049,7 +29989,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.delete_account.delete() +client.ticketing.async_passthrough.retrieve( + async_passthrough_receipt_id="async_passthrough_receipt_id", +) ``` @@ -30065,6 +30007,14 @@ client.hris.delete_account.delete()
+**async_passthrough_receipt_id:** `str` + +
+
+ +
+
+ **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -30077,8 +30027,8 @@ client.hris.delete_account.delete()
-## Hris Dependents -
client.hris.dependents.list(...) +## Ticketing Attachments +
client.ticketing.attachments.list(...)
@@ -30090,7 +30040,7 @@ client.hris.delete_account.delete()
-Returns a list of `Dependent` objects. +Returns a list of `Attachment` objects.
@@ -30111,7 +30061,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.dependents.list() +client.ticketing.attachments.list() ``` @@ -30151,7 +30101,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[typing.Literal["ticket"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -30159,7 +30109,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/).
@@ -30167,7 +30117,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.
@@ -30207,6 +30157,14 @@ client.hris.dependents.list()
+**remote_created_after:** `typing.Optional[dt.datetime]` — If provided, will only return attachments created in the third party platform after this datetime. + +
+
+ +
+
+ **remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
@@ -30215,6 +30173,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.
@@ -30227,7 +30193,7 @@ client.hris.dependents.list()
-
client.hris.dependents.retrieve(...) +
client.ticketing.attachments.create(...)
@@ -30239,7 +30205,7 @@ client.hris.dependents.list()
-Returns a `Dependent` object with the given `id`. +Creates an `Attachment` object with the given values.
@@ -30255,13 +30221,14 @@ Returns a `Dependent` 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.dependents.retrieve( - id="id", +client.ticketing.attachments.create( + model=AttachmentRequest(), ) ``` @@ -30278,15 +30245,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:** `AttachmentRequest`
@@ -30294,7 +30253,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.
@@ -30302,7 +30261,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.
@@ -30322,8 +30281,7 @@ client.hris.dependents.retrieve(
-## Hris EmployeePayrollRuns -
client.hris.employee_payroll_runs.list(...) +
client.ticketing.attachments.retrieve(...)
@@ -30335,7 +30293,7 @@ client.hris.dependents.retrieve(
-Returns a list of `EmployeePayrollRun` objects. +Returns an `Attachment` object with the given `id`.
@@ -30356,7 +30314,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.employee_payroll_runs.list() +client.ticketing.attachments.retrieve( + id="id", +) ``` @@ -30372,7 +30332,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`
@@ -30380,7 +30340,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[typing.Literal["ticket"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -30388,7 +30348,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.
@@ -30396,7 +30356,7 @@ client.hris.employee_payroll_runs.list()
-**employee_id:** `typing.Optional[str]` — If provided, will only return employee payroll runs 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).
@@ -30404,63 +30364,130 @@ client.hris.employee_payroll_runs.list()
-**ended_after:** `typing.Optional[dt.datetime]` — If provided, will only return employee payroll runs ended after this datetime. +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+ +
-
-
-**ended_before:** `typing.Optional[dt.datetime]` — If provided, will only return employee payroll runs ended before this datetime. -
+
+
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. - +#### 📝 Description + +
+
+ +
+
+ +Returns metadata for `TicketingAttachment` POSTs. +
+
+#### 🔌 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.attachments.meta_post_retrieve() + +```
+
+
+ +#### ⚙️ Parameters
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+ + +
+
+
+## Ticketing AuditTrail +
client.ticketing.audit_trail.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 + +
+
+ +
+
+ +Gets a list of audit trail events. +
+
+#### 🔌 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.audit_trail.list() + +```
+
+
+ +#### ⚙️ 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.
@@ -30468,7 +30495,7 @@ client.hris.employee_payroll_runs.list()
-**page_size:** `typing.Optional[int]` — Number of results to return per page. +**end_date:** `typing.Optional[str]` — If included, will only include audit trail events that occurred before this time
@@ -30476,7 +30503,7 @@ client.hris.employee_payroll_runs.list()
-**payroll_run_id:** `typing.Optional[str]` — If provided, will only return employee payroll runs for this employee. +**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`
@@ -30484,7 +30511,7 @@ client.hris.employee_payroll_runs.list()
-**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object. +**page_size:** `typing.Optional[int]` — Number of results to return per page.
@@ -30492,7 +30519,7 @@ client.hris.employee_payroll_runs.list()
-**started_after:** `typing.Optional[dt.datetime]` — If provided, will only return employee payroll runs started after this datetime. +**start_date:** `typing.Optional[str]` — If included, will only include audit trail events that occurred after this time
@@ -30500,7 +30527,7 @@ client.hris.employee_payroll_runs.list()
-**started_before:** `typing.Optional[dt.datetime]` — If provided, will only return employee payroll runs started before this datetime. +**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.
@@ -30520,7 +30547,8 @@ client.hris.employee_payroll_runs.list()
-
client.hris.employee_payroll_runs.retrieve(...) +## Ticketing AvailableActions +
client.ticketing.available_actions.retrieve()
@@ -30532,7 +30560,7 @@ client.hris.employee_payroll_runs.list()
-Returns an `EmployeePayrollRun` object with the given `id`. +Returns a list of models and actions available for an account.
@@ -30553,9 +30581,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.employee_payroll_runs.retrieve( - id="id", -) +client.ticketing.available_actions.retrieve() ``` @@ -30563,42 +30589,10 @@ client.hris.employee_payroll_runs.retrieve(
-#### ⚙️ Parameters - -
-
- -
-
- -**id:** `str` - -
-
- -
-
- -**expand:** `typing.Optional[EmployeePayrollRunsRetrieveRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. - -
-
- -
-
- -**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. - -
-
- -
-
- -**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). - -
-
+#### ⚙️ Parameters + +
+
@@ -30615,8 +30609,8 @@ client.hris.employee_payroll_runs.retrieve(
-## Hris Employees -
client.hris.employees.list(...) +## Ticketing Collections +
client.ticketing.collections.list(...)
@@ -30628,7 +30622,7 @@ client.hris.employee_payroll_runs.retrieve(
-Returns a list of `Employee` objects. +Returns a list of `Collection` objects.
@@ -30649,7 +30643,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.employees.list() +client.ticketing.collections.list() ``` @@ -30665,7 +30659,7 @@ client.hris.employees.list()
-**company_id:** `typing.Optional[str]` — If provided, will only return employees for this company. +**collection_type:** `typing.Optional[str]` — If provided, will only return collections of the given type.
@@ -30697,7 +30691,7 @@ client.hris.employees.list()
-**display_full_name:** `typing.Optional[str]` — If provided, will only return employees with this display name. +**expand:** `typing.Optional[typing.Literal["parent_collection"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -30705,13 +30699,15 @@ client.hris.employees.list()
-**employment_status:** `typing.Optional[EmployeesListRequestEmploymentStatus]` +**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 employees with this employment status. +
+
-* `ACTIVE` - ACTIVE -* `PENDING` - PENDING -* `INACTIVE` - INACTIVE +**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -30719,7 +30715,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_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -30727,7 +30723,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. +**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
@@ -30735,7 +30731,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. +**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
@@ -30743,7 +30739,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. +**page_size:** `typing.Optional[int]` — Number of results to return per page.
@@ -30751,7 +30747,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. +**parent_collection_id:** `typing.Optional[str]` — If provided, will only return collections whose parent collection matches the given id.
@@ -30759,7 +30755,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/). +**remote_fields:** `typing.Optional[typing.Literal["collection_type"]]` — Deprecated. Use show_enum_origins.
@@ -30767,7 +30763,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.
@@ -30775,7 +30771,7 @@ 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. +**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)
@@ -30783,31 +30779,70 @@ If provided, will only return employees with this employment status.
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+ +
+ + + +
+ +
client.ticketing.collections.viewers_list(...)
-**job_title:** `typing.Optional[str]` — If provided, will only return employees that have an employment of the specified job_title. - +#### 📝 Description + +
+
+ +
+
+ +Returns a list of `Viewer` objects that point to a User id or Team id that is either an assignee or viewer on a `Collection` with the given id. [Learn more.](https://help.merge.dev/en/articles/10333658-ticketing-access-control-list-acls) +
+
+#### 🔌 Usage +
-**last_name:** `typing.Optional[str]` — If provided, will only return employees with this last name. - +
+
+ +```python +from merge import Merge + +client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.ticketing.collections.viewers_list( + collection_id="collection_id", +) + +``` +
+
+#### ⚙️ Parameters +
-**manager_id:** `typing.Optional[str]` — If provided, will only return employees for this manager. +
+
+ +**collection_id:** `str`
@@ -30815,7 +30850,7 @@ If provided, will only return employees with this employment status.
-**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned. +**cursor:** `typing.Optional[str]` — The pagination cursor value.
@@ -30823,7 +30858,7 @@ If provided, will only return employees with this employment status.
-**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned. +**expand:** `typing.Optional[CollectionsViewersListRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -30831,7 +30866,7 @@ If provided, will only return employees with this employment status.
-**page_size:** `typing.Optional[int]` — Number of results to return per page. +**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/).
@@ -30839,7 +30874,7 @@ If provided, will only return employees with this employment status.
-**pay_group_id:** `typing.Optional[str]` — If provided, will only return employees for this pay group +**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -30847,7 +30882,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 +**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -30855,7 +30890,7 @@ If provided, will only return employees with this employment status.
-**remote_fields:** `typing.Optional[EmployeesListRequestRemoteFields]` — Deprecated. Use show_enum_origins. +**page_size:** `typing.Optional[int]` — Number of results to return per page.
@@ -30863,31 +30898,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.
+
+
+ + +
+
+
+
client.ticketing.collections.retrieve(...)
-**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) - +#### 📝 Description + +
+
+ +
+
+ +Returns a `Collection` object with the given `id`.
+
+
+ +#### 🔌 Usage
-**started_after:** `typing.Optional[dt.datetime]` — If provided, will only return employees that started after this datetime. - +
+
+ +```python +from merge import Merge + +client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.ticketing.collections.retrieve( + id="id", +) + +``` +
+
+#### ⚙️ Parameters +
-**started_before:** `typing.Optional[dt.datetime]` — If provided, will only return employees that started before this datetime. +
+
+ +**id:** `str`
@@ -30895,7 +30969,7 @@ If provided, will only return employees with this employment status.
-**team_id:** `typing.Optional[str]` — If provided, will only return employees for this team. +**expand:** `typing.Optional[typing.Literal["parent_collection"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -30903,7 +30977,7 @@ If provided, will only return employees with this employment status.
-**terminated_after:** `typing.Optional[dt.datetime]` — If provided, will only return employees that were terminated after this datetime. +**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -30911,7 +30985,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. +**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -30919,7 +30993,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 +**remote_fields:** `typing.Optional[typing.Literal["collection_type"]]` — Deprecated. Use show_enum_origins.
@@ -30927,7 +31001,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. +**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)
@@ -30947,7 +31021,8 @@ If provided, will only return employees with this employment status.
-
client.hris.employees.create(...) +## Ticketing Comments +
client.ticketing.comments.list(...)
@@ -30959,7 +31034,7 @@ If provided, will only return employees with this employment status.
-Creates an `Employee` object with the given values. +Returns a list of `Comment` objects.
@@ -30975,31 +31050,108 @@ 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.comments.list() + +``` + +
+ + + +#### ⚙️ Parameters + +
+
+ +
+
+ +**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime. + +
+
+ +
+
+ +**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime. + +
+
+ +
+
+ +**cursor:** `typing.Optional[str]` — The pagination cursor value. + +
+
+ +
+
+ +**expand:** `typing.Optional[CommentsListRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. + +
+
+ +
+
+ +**include_deleted_data:** `typing.Optional[bool]` — 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. +
-#### ⚙️ Parameters -
+**page_size:** `typing.Optional[int]` — Number of results to return per page. + +
+
+
-**model:** `EmployeeRequest` +**remote_created_after:** `typing.Optional[dt.datetime]` — If provided, will only return Comments created in the third party platform after this datetime.
@@ -31007,7 +31159,7 @@ client.hris.employees.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.
@@ -31015,7 +31167,7 @@ client.hris.employees.create(
-**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously. +**ticket_id:** `typing.Optional[str]` — If provided, will only return comments for this ticket.
@@ -31035,7 +31187,7 @@ client.hris.employees.create(
-
client.hris.employees.retrieve(...) +
client.ticketing.comments.create(...)
@@ -31047,7 +31199,7 @@ client.hris.employees.create(
-Returns an `Employee` object with the given `id`. +Creates a `Comment` object with the given values.
@@ -31063,13 +31215,14 @@ Returns an `Employee` 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.employees.retrieve( - id="id", +client.ticketing.comments.create( + model=CommentRequest(), ) ``` @@ -31086,39 +31239,7 @@ client.hris.employees.retrieve(
-**id:** `str` - -
-
- -
-
- -**expand:** `typing.Optional[EmployeesRetrieveRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. - -
-
- -
-
- -**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. - -
-
- -
-
- -**include_sensitive_fields:** `typing.Optional[bool]` — Whether to include sensitive fields (such as social security numbers) in the response. - -
-
- -
-
- -**include_shell_data:** `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:** `CommentRequest`
@@ -31126,7 +31247,7 @@ client.hris.employees.retrieve(
-**remote_fields:** `typing.Optional[EmployeesRetrieveRequestRemoteFields]` — Deprecated. Use show_enum_origins. +**is_debug_mode:** `typing.Optional[bool]` — Whether to include debug fields (such as log file links) in the response.
@@ -31134,7 +31255,7 @@ client.hris.employees.retrieve(
-**show_enum_origins:** `typing.Optional[EmployeesRetrieveRequestShowEnumOrigins]` — A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter) +**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously.
@@ -31154,7 +31275,7 @@ client.hris.employees.retrieve(
-
client.hris.employees.ignore_create(...) +
client.ticketing.comments.retrieve(...)
@@ -31166,7 +31287,7 @@ client.hris.employees.retrieve(
-Ignores a specific row based on the `model_id` in the url. These records will have their properties set to null, and will not be updated in future syncs. The "reason" and "message" fields in the request body will be stored for audit purposes. +Returns a `Comment` object with the given `id`.
@@ -31182,15 +31303,13 @@ 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 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.comments.retrieve( + id="id", ) ``` @@ -31207,7 +31326,7 @@ client.hris.employees.ignore_create(
-**model_id:** `str` +**id:** `str`
@@ -31215,7 +31334,7 @@ client.hris.employees.ignore_create(
-**reason:** `IgnoreCommonModelRequestReason` +**expand:** `typing.Optional[CommentsRetrieveRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -31223,7 +31342,15 @@ client.hris.employees.ignore_create(
-**message:** `typing.Optional[str]` +**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. + +
+
+ +
+
+ +**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -31243,7 +31370,7 @@ client.hris.employees.ignore_create(
-
client.hris.employees.meta_post_retrieve() +
client.ticketing.comments.meta_post_retrieve()
@@ -31255,7 +31382,7 @@ client.hris.employees.ignore_create(
-Returns metadata for `Employee` POSTs. +Returns metadata for `Comment` POSTs.
@@ -31276,7 +31403,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.employees.meta_post_retrieve() +client.ticketing.comments.meta_post_retrieve() ``` @@ -31304,8 +31431,8 @@ client.hris.employees.meta_post_retrieve()
-## Hris EmployerBenefits -
client.hris.employer_benefits.list(...) +## Ticketing Contacts +
client.ticketing.contacts.list(...)
@@ -31317,7 +31444,7 @@ client.hris.employees.meta_post_retrieve()
-Returns a list of `EmployerBenefit` objects. +Returns a list of `Contact` objects.
@@ -31338,7 +31465,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.employer_benefits.list() +client.ticketing.contacts.list() ``` @@ -31378,6 +31505,14 @@ client.hris.employer_benefits.list()
+**expand:** `typing.Optional[typing.Literal["account"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. + +
+
+ +
+
+ **include_deleted_data:** `typing.Optional[bool]` — 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/).
@@ -31446,7 +31581,7 @@ client.hris.employer_benefits.list()
-
client.hris.employer_benefits.retrieve(...) +
client.ticketing.contacts.create(...)
@@ -31458,7 +31593,7 @@ client.hris.employer_benefits.list()
-Returns an `EmployerBenefit` object with the given `id`. +Creates a `Contact` object with the given values.
@@ -31474,13 +31609,14 @@ Returns an `EmployerBenefit` object with the given `id`. ```python from merge import Merge +from merge.resources.ticketing import ContactRequest client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.employer_benefits.retrieve( - id="id", +client.ticketing.contacts.create( + model=ContactRequest(), ) ``` @@ -31497,7 +31633,7 @@ client.hris.employer_benefits.retrieve(
-**id:** `str` +**model:** `ContactRequest`
@@ -31505,7 +31641,7 @@ client.hris.employer_benefits.retrieve(
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. +**is_debug_mode:** `typing.Optional[bool]` — Whether to include debug fields (such as log file links) in the response.
@@ -31513,7 +31649,7 @@ client.hris.employer_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). +**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously.
@@ -31533,8 +31669,7 @@ client.hris.employer_benefits.retrieve(
-## Hris Employments -
client.hris.employments.list(...) +
client.ticketing.contacts.retrieve(...)
@@ -31546,7 +31681,7 @@ client.hris.employer_benefits.retrieve(
-Returns a list of `Employment` objects. +Returns a `Contact` object with the given `id`.
@@ -31567,7 +31702,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.employments.list() +client.ticketing.contacts.retrieve( + id="id", +) ``` @@ -31583,7 +31720,7 @@ client.hris.employments.list()
-**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime. +**id:** `str`
@@ -31591,7 +31728,7 @@ client.hris.employments.list()
-**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created 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.
@@ -31599,7 +31736,7 @@ client.hris.employments.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.
@@ -31607,7 +31744,7 @@ client.hris.employments.list()
-**employee_id:** `typing.Optional[str]` — If provided, will only return employments 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).
@@ -31615,91 +31752,64 @@ 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.contacts.meta_post_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 metadata for `TicketingContact` POSTs.
- -
-
- -**order_by:** `typing.Optional[EmploymentsListRequestOrderBy]` — Overrides the default ordering for this endpoint. Possible values include: effective_date, -effective_date. -
+#### 🔌 Usage +
-**page_size:** `typing.Optional[int]` — Number of results to return per page. - -
-
-
-**remote_fields:** `typing.Optional[EmploymentsListRequestRemoteFields]` — Deprecated. Use show_enum_origins. - -
-
+```python +from merge import Merge -
-
+client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.ticketing.contacts.meta_post_retrieve() -**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object. - +``` +
+
+#### ⚙️ Parameters +
-**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) - -
-
-
@@ -31715,7 +31825,8 @@ client.hris.employments.list()
-
client.hris.employments.retrieve(...) +## Ticketing Scopes +
client.ticketing.scopes.default_scopes_retrieve()
@@ -31727,7 +31838,7 @@ client.hris.employments.list()
-Returns an `Employment` 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).
@@ -31748,69 +31859,19 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.employments.retrieve( - id="id", -) +client.ticketing.scopes.default_scopes_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. - -
-
+ +#### ⚙️ Parameters
-**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) - -
-
-
@@ -31826,8 +31887,7 @@ client.hris.employments.retrieve(
-## Hris FieldMapping -
client.hris.field_mapping.field_mappings_retrieve(...) +
client.ticketing.scopes.linked_account_scopes_retrieve()
@@ -31839,7 +31899,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/). +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).
@@ -31860,7 +31920,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.field_mapping.field_mappings_retrieve() +client.ticketing.scopes.linked_account_scopes_retrieve() ``` @@ -31876,14 +31936,6 @@ 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. - -
-
- -
-
- **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -31896,7 +31948,7 @@ client.hris.field_mapping.field_mappings_retrieve()
-
client.hris.field_mapping.field_mappings_create(...) +
client.ticketing.scopes.linked_account_scopes_create(...)
@@ -31908,7 +31960,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. +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)
@@ -31924,18 +31976,42 @@ Create new Field Mappings that will be available after the next scheduled sync. ```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.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.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, + ) + }, + ), + ], ) ``` @@ -31952,7 +32028,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. +**common_models:** `typing.Sequence[IndividualCommonModelScopeDeserializerRequest]` — The common models you want to update the scopes for
@@ -31960,51 +32036,65 @@ 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. +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+ +
-
-
-**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. -
+
+## Ticketing DeleteAccount +
client.ticketing.delete_account.delete()
-**remote_method:** `str` — The method of the remote endpoint where the remote field is coming from. - -
-
+#### 📝 Description
-**remote_url_path:** `str` — The path of the remote endpoint where the remote field is coming from. - -
-
-
-**common_model_name:** `str` — The name of the Common Model that the remote field corresponds to in a given category. - +Delete a linked account.
+ + + +#### 🔌 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.ticketing.delete_account.delete() + +``` +
+
+#### ⚙️ Parameters + +
+
+
@@ -32020,7 +32110,8 @@ client.hris.field_mapping.field_mappings_create(
-
client.hris.field_mapping.field_mappings_destroy(...) +## Ticketing FieldMapping +
client.ticketing.field_mapping.field_mappings_retrieve(...)
@@ -32032,7 +32123,7 @@ client.hris.field_mapping.field_mappings_create(
-Deletes Field Mappings for a Linked Account. All data related to this Field Mapping will be deleted and these changes will be reflected after the next scheduled sync. This will cause the next sync for this Linked Account to sync **ALL** data from start. +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/).
@@ -32053,9 +32144,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.field_mapping.field_mappings_destroy( - field_mapping_id="field_mapping_id", -) +client.ticketing.field_mapping.field_mappings_retrieve() ``` @@ -32071,7 +32160,7 @@ client.hris.field_mapping.field_mappings_destroy(
-**field_mapping_id:** `str` +**exclude_remote_field_metadata:** `typing.Optional[bool]` — If `true`, remote fields metadata is excluded from each field mapping instance (i.e. `remote_fields.remote_key_name` and `remote_fields.schema` will be null). This will increase the speed of the request since these fields require some calculations.
@@ -32091,7 +32180,7 @@ client.hris.field_mapping.field_mappings_destroy(
-
client.hris.field_mapping.field_mappings_partial_update(...) +
client.ticketing.field_mapping.field_mappings_create(...)
@@ -32103,7 +32192,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. +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.
@@ -32124,8 +32213,13 @@ 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.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", ) ``` @@ -32142,7 +32236,7 @@ client.hris.field_mapping.field_mappings_partial_update(
-**field_mapping_id:** `str` +**target_field_name:** `str` — The name of the target field you want this remote field to map to.
@@ -32150,7 +32244,7 @@ client.hris.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. +**target_field_description:** `str` — The description of the target field you want this remote field to map to.
@@ -32158,7 +32252,7 @@ client.hris.field_mapping.field_mappings_partial_update(
-**remote_method:** `typing.Optional[str]` — The method of the remote endpoint where the remote field is coming from. +**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.
@@ -32166,7 +32260,31 @@ client.hris.field_mapping.field_mappings_partial_update(
-**remote_url_path:** `typing.Optional[str]` — The path of the remote endpoint where the remote field is coming from. +**remote_method:** `str` — The method of the remote endpoint where the remote field is coming from. + +
+
+ +
+
+ +**remote_url_path:** `str` — The path of the remote endpoint where the remote field is coming from. + +
+
+ +
+
+ +**common_model_name:** `str` — The name of the Common Model that the remote field corresponds to in a given category. + +
+
+ +
+
+ +**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.
@@ -32186,7 +32304,7 @@ client.hris.field_mapping.field_mappings_partial_update(
-
client.hris.field_mapping.remote_fields_retrieve(...) +
client.ticketing.field_mapping.field_mappings_destroy(...)
@@ -32198,7 +32316,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/). +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.
@@ -32219,7 +32337,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.field_mapping.remote_fields_retrieve() +client.ticketing.field_mapping.field_mappings_destroy( + field_mapping_id="field_mapping_id", +) ``` @@ -32235,15 +32355,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. - -
-
- -
-
- -**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. +**field_mapping_id:** `str`
@@ -32263,7 +32375,7 @@ client.hris.field_mapping.remote_fields_retrieve()
-
client.hris.field_mapping.target_fields_retrieve() +
client.ticketing.field_mapping.field_mappings_partial_update(...)
@@ -32275,7 +32387,7 @@ client.hris.field_mapping.remote_fields_retrieve()
-Get all organization-wide Target Fields, this will not include any Linked Account specific Target Fields. Organization-wide Target Fields are additional fields appended to the Merge Common Model for all Linked Accounts in a category. [Learn more](https://docs.merge.dev/supplemental-data/field-mappings/target-fields/). +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.
@@ -32296,7 +32408,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.field_mapping.target_fields_retrieve() +client.ticketing.field_mapping.field_mappings_partial_update( + field_mapping_id="field_mapping_id", +) ``` @@ -32312,71 +32426,31 @@ client.hris.field_mapping.target_fields_retrieve()
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. +**field_mapping_id:** `str`
- -
- - - - -
- -## Hris GenerateKey -
client.hris.generate_key.create(...) -
-
- -#### 📝 Description
-
-
- -Create a remote key. -
-
+**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.hris.generate_key.create( - name="Remote Deployment Key 1", -) - -``` -
-
+**remote_method:** `typing.Optional[str]` — The method of the remote endpoint where the remote field is coming from. +
-#### ⚙️ Parameters - -
-
-
-**name:** `str` — The name of the remote key +**remote_url_path:** `typing.Optional[str]` — The path of the remote endpoint where the remote field is coming from.
@@ -32396,8 +32470,7 @@ client.hris.generate_key.create(
-## Hris Groups -
client.hris.groups.list(...) +
client.ticketing.field_mapping.remote_fields_retrieve(...)
@@ -32409,7 +32482,7 @@ client.hris.generate_key.create(
-Returns a list of `Group` objects. +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/).
@@ -32430,7 +32503,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.groups.list() +client.ticketing.field_mapping.remote_fields_retrieve() ``` @@ -32446,7 +32519,7 @@ client.hris.groups.list()
-**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime. +**common_models:** `typing.Optional[str]` — A comma seperated list of Common Model names. If included, will only return Remote Fields for those Common Models.
@@ -32454,7 +32527,7 @@ client.hris.groups.list()
-**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime. +**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.
@@ -32462,107 +32535,64 @@ client.hris.groups.list()
-**cursor:** `typing.Optional[str]` — The pagination cursor value. +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
- -
-
- -**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/). -
-
-
-**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.target_fields_retrieve()
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). - -
-
+#### 📝 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 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/).
- -
-
- -**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned. -
-
-
- -**names:** `typing.Optional[str]` — If provided, will only return groups with these names. Multiple values can be separated by commas. - -
-
+#### 🔌 Usage
-**page_size:** `typing.Optional[int]` — Number of results to return per page. - -
-
-
-**remote_fields:** `typing.Optional[typing.Literal["type"]]` — Deprecated. Use show_enum_origins. - -
-
+```python +from merge import Merge -
-
+client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.ticketing.field_mapping.target_fields_retrieve() -**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object. - +```
- -
-
- -**show_enum_origins:** `typing.Optional[typing.Literal["type"]]` — A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter) -
+#### ⚙️ Parameters +
-**types:** `typing.Optional[str]` — If provided, will only return groups of these types. Multiple values can be separated by commas. - -
-
-
@@ -32578,7 +32608,8 @@ client.hris.groups.list()
-
client.hris.groups.retrieve(...) +## Ticketing GenerateKey +
client.ticketing.generate_key.create(...)
@@ -32590,7 +32621,7 @@ client.hris.groups.list()
-Returns a `Group` object with the given `id`. +Create a remote key.
@@ -32611,8 +32642,8 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.groups.retrieve( - id="id", +client.ticketing.generate_key.create( + name="Remote Deployment Key 1", ) ``` @@ -32629,39 +32660,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) +**name:** `str` — The name of the remote key
@@ -32681,8 +32680,8 @@ client.hris.groups.retrieve(
-## Hris Issues -
client.hris.issues.list(...) +## Ticketing Issues +
client.ticketing.issues.list(...)
@@ -32715,7 +32714,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.issues.list() +client.ticketing.issues.list() ```
@@ -32860,7 +32859,7 @@ Status of the issue. Options: ('ONGOING', 'RESOLVED')
-
client.hris.issues.retrieve(...) +
client.ticketing.issues.retrieve(...)
@@ -32893,7 +32892,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.issues.retrieve( +client.ticketing.issues.retrieve( id="id", ) @@ -32931,8 +32930,8 @@ client.hris.issues.retrieve(
-## Hris LinkToken -
client.hris.link_token.create(...) +## Ticketing LinkToken +
client.ticketing.link_token.create(...)
@@ -32960,13 +32959,13 @@ Creates a link token to be used when linking a new end user. ```python from merge import Merge -from merge.resources.hris import CategoriesEnum +from merge.resources.ticketing import CategoriesEnum client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.link_token.create( +client.ticketing.link_token.create( end_user_email_address="example@gmail.com", end_user_organization_name="Test Organization", end_user_origin_id="12345", @@ -33115,8 +33114,8 @@ The following subset of IETF language tags can be used to configure localization
-## Hris LinkedAccounts -
client.hris.linked_accounts.list(...) +## Ticketing LinkedAccounts +
client.ticketing.linked_accounts.list(...)
@@ -33149,7 +33148,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.linked_accounts.list() +client.ticketing.linked_accounts.list() ```
@@ -33291,8 +33290,8 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing`
-## Hris Locations -
client.hris.locations.list(...) +## Ticketing Passthrough +
client.ticketing.passthrough.create(...)
@@ -33304,145 +33303,50 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing`
-Returns a list of `Location` objects. -
-
-
-
- -#### 🔌 Usage - -
-
- -
-
- -```python -from merge import Merge - -client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.hris.locations.list() - -``` -
-
-
-
- -#### ⚙️ Parameters - -
-
- -
-
- -**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime. - -
-
- -
-
- -**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime. - -
-
- -
-
- -**cursor:** `typing.Optional[str]` — The pagination cursor value. - -
-
- -
-
- -**include_deleted_data:** `typing.Optional[bool]` — 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). - -
-
- -
-
- -**location_type:** `typing.Optional[LocationsListRequestLocationType]` - -If provided, will only return locations with this location_type - -* `HOME` - HOME -* `WORK` - WORK - +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. -
+#### 🔌 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 +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", + ), +) -**remote_fields:** `typing.Optional[LocationsListRequestRemoteFields]` — Deprecated. Use show_enum_origins. - +``` +
+
+#### ⚙️ Parameters +
-**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object. - -
-
-
-**show_enum_origins:** `typing.Optional[LocationsListRequestShowEnumOrigins]` — A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter) +**request:** `DataPassthroughRequest`
@@ -33462,7 +33366,8 @@ If provided, will only return locations with this location_type
-
client.hris.locations.retrieve(...) +## Ticketing Projects +
client.ticketing.projects.list(...)
@@ -33474,7 +33379,7 @@ If provided, will only return locations with this location_type
-Returns a `Location` object with the given `id`. +Returns a list of `Project` objects.
@@ -33495,9 +33400,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.locations.retrieve( - id="id", -) +client.ticketing.projects.list() ``` @@ -33513,7 +33416,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/).
@@ -33537,7 +33464,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.
@@ -33545,7 +33472,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.
@@ -33565,8 +33508,7 @@ client.hris.locations.retrieve(
-## Hris Passthrough -
client.hris.passthrough.create(...) +
client.ticketing.projects.retrieve(...)
@@ -33578,7 +33520,7 @@ client.hris.locations.retrieve(
-Pull data from an endpoint not currently supported by Merge. +Returns a `Project` object with the given `id`.
@@ -33594,17 +33536,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.projects.retrieve( + id="id", ) ``` @@ -33621,7 +33559,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).
@@ -33641,8 +33595,7 @@ client.hris.passthrough.create(
-## Hris PayGroups -
client.hris.pay_groups.list(...) +
client.ticketing.projects.users_list(...)
@@ -33654,7 +33607,7 @@ client.hris.passthrough.create(
-Returns a list of `PayGroup` objects. +Returns a list of `User` objects.
@@ -33675,7 +33628,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.pay_groups.list() +client.ticketing.projects.users_list( + parent_id="parent_id", +) ``` @@ -33691,7 +33646,7 @@ client.hris.pay_groups.list()
-**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime. +**parent_id:** `str`
@@ -33699,7 +33654,7 @@ client.hris.pay_groups.list()
-**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime. +**cursor:** `typing.Optional[str]` — The pagination cursor value.
@@ -33707,7 +33662,7 @@ client.hris.pay_groups.list()
-**cursor:** `typing.Optional[str]` — The pagination cursor value. +**expand:** `typing.Optional[ProjectsUsersListRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -33739,22 +33694,6 @@ client.hris.pay_groups.list()
-**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned. - -
-
- -
-
- -**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.
@@ -33763,14 +33702,6 @@ client.hris.pay_groups.list()
-**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object. - -
-
- -
-
- **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -33783,7 +33714,8 @@ client.hris.pay_groups.list()
-
client.hris.pay_groups.retrieve(...) +## Ticketing RegenerateKey +
client.ticketing.regenerate_key.create(...)
@@ -33795,7 +33727,7 @@ client.hris.pay_groups.list()
-Returns a `PayGroup` object with the given `id`. +Exchange remote keys.
@@ -33816,8 +33748,8 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.pay_groups.retrieve( - id="id", +client.ticketing.regenerate_key.create( + name="Remote Deployment Key 1", ) ``` @@ -33834,23 +33766,7 @@ client.hris.pay_groups.retrieve(
-**id:** `str` - -
-
- -
-
- -**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. - -
-
- -
-
- -**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). +**name:** `str` — The name of the remote key
@@ -33870,8 +33786,8 @@ client.hris.pay_groups.retrieve(
-## Hris PayrollRuns -
client.hris.payroll_runs.list(...) +## Ticketing Roles +
client.ticketing.roles.list(...)
@@ -33883,7 +33799,7 @@ client.hris.pay_groups.retrieve(
-Returns a list of `PayrollRun` objects. +Returns a list of `Role` objects.
@@ -33904,7 +33820,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.payroll_runs.list() +client.ticketing.roles.list() ``` @@ -33944,7 +33860,7 @@ client.hris.payroll_runs.list()
-**ended_after:** `typing.Optional[dt.datetime]` — If provided, will only return payroll runs ended after this datetime. +**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
@@ -33952,7 +33868,7 @@ client.hris.payroll_runs.list()
-**ended_before:** `typing.Optional[dt.datetime]` — If provided, will only return payroll runs ended 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.
@@ -33960,7 +33876,7 @@ client.hris.payroll_runs.list()
-**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/). +**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -33968,7 +33884,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. +**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
@@ -33976,7 +33892,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). +**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
@@ -33984,7 +33900,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. +**page_size:** `typing.Optional[int]` — Number of results to return per page.
@@ -33992,7 +33908,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. +**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
@@ -34000,47 +33916,70 @@ client.hris.payroll_runs.list()
-**page_size:** `typing.Optional[int]` — Number of results to return per page. +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+ +
-
-
-**remote_fields:** `typing.Optional[PayrollRunsListRequestRemoteFields]` — Deprecated. Use show_enum_origins. -
+
+ +
client.ticketing.roles.retrieve(...) +
+
+ +#### 📝 Description
-**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object. - +
+
+ +Returns a `Role` object with the given `id`. +
+
+#### 🔌 Usage +
-**run_type:** `typing.Optional[PayrollRunsListRequestRunType]` +
+
-If provided, will only return PayrollRun's with this status. Options: ('REGULAR', 'OFF_CYCLE', 'CORRECTION', 'TERMINATION', 'SIGN_ON_BONUS') +```python +from merge import Merge -* `REGULAR` - REGULAR -* `OFF_CYCLE` - OFF_CYCLE -* `CORRECTION` - CORRECTION -* `TERMINATION` - TERMINATION -* `SIGN_ON_BONUS` - SIGN_ON_BONUS - +client = Merge( + account_token="YOUR_ACCOUNT_TOKEN", + api_key="YOUR_API_KEY", +) +client.ticketing.roles.retrieve( + id="id", +) + +```
+
+
+ +#### ⚙️ Parameters
-**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) +
+
+ +**id:** `str`
@@ -34048,7 +33987,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_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -34056,7 +33995,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).
@@ -34076,7 +34015,8 @@ If provided, will only return PayrollRun's with this status. Options: ('REGULAR'
-
client.hris.payroll_runs.retrieve(...) +## Ticketing SyncStatus +
client.ticketing.sync_status.list(...)
@@ -34088,7 +34028,7 @@ If provided, will only return PayrollRun's with this status. Options: ('REGULAR'
-Returns a `PayrollRun` 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).
@@ -34109,9 +34049,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.payroll_runs.retrieve( - id="id", -) +client.ticketing.sync_status.list() ``` @@ -34127,31 +34065,7 @@ client.hris.payroll_runs.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[PayrollRunsRetrieveRequestRemoteFields]` — Deprecated. Use show_enum_origins. +**cursor:** `typing.Optional[str]` — The pagination cursor value.
@@ -34159,7 +34073,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) +**page_size:** `typing.Optional[int]` — Number of results to return per page.
@@ -34179,8 +34093,8 @@ client.hris.payroll_runs.retrieve(
-## Hris RegenerateKey -
client.hris.regenerate_key.create(...) +## Ticketing ForceResync +
client.ticketing.force_resync.sync_status_resync_create()
@@ -34192,7 +34106,7 @@ client.hris.payroll_runs.retrieve(
-Exchange remote keys. +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.
@@ -34213,9 +34127,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.regenerate_key.create( - name="Remote Deployment Key 1", -) +client.ticketing.force_resync.sync_status_resync_create() ``` @@ -34231,14 +34143,6 @@ client.hris.regenerate_key.create(
-**name:** `str` — The name of the remote key - -
-
- -
-
- **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -34251,8 +34155,8 @@ client.hris.regenerate_key.create(
-## Hris SyncStatus -
client.hris.sync_status.list(...) +## Ticketing Tags +
client.ticketing.tags.list(...)
@@ -34264,7 +34168,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 list of `Tag` objects.
@@ -34285,7 +34189,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.sync_status.list() +client.ticketing.tags.list() ``` @@ -34301,6 +34205,22 @@ client.hris.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.
@@ -34309,6 +34229,46 @@ client.hris.sync_status.list()
+**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/). + +
+
+ +
+
+ +**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. + +
+
+ +
+
+ +**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). + +
+
+ +
+
+ +**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.
@@ -34317,6 +34277,14 @@ client.hris.sync_status.list()
+**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object. + +
+
+ +
+
+ **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -34329,8 +34297,7 @@ client.hris.sync_status.list()
-## Hris ForceResync -
client.hris.force_resync.sync_status_resync_create() +
client.ticketing.tags.retrieve(...)
@@ -34342,7 +34309,7 @@ client.hris.sync_status.list()
-Force re-sync of all models. This endpoint is available for monthly, quarterly, and highest sync frequency customers on the Professional or Enterprise plans. Doing so will consume a sync credit for the relevant linked account. Force re-syncs can also be triggered manually in the Merge Dashboard and is available for all customers. +Returns a `Tag` object with the given `id`.
@@ -34363,7 +34330,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.force_resync.sync_status_resync_create() +client.ticketing.tags.retrieve( + id="id", +) ``` @@ -34379,6 +34348,30 @@ client.hris.force_resync.sync_status_resync_create()
+**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.
@@ -34391,8 +34384,8 @@ client.hris.force_resync.sync_status_resync_create()
-## Hris Teams -
client.hris.teams.list(...) +## Ticketing Teams +
client.ticketing.teams.list(...)
@@ -34425,7 +34418,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.teams.list() +client.ticketing.teams.list() ```
@@ -34465,14 +34458,6 @@ client.hris.teams.list()
-**expand:** `typing.Optional[typing.Literal["parent_team"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. - -
-
- -
-
- **include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
@@ -34521,14 +34506,6 @@ client.hris.teams.list()
-**parent_team_id:** `typing.Optional[str]` — If provided, will only return teams with this parent team. - -
-
- -
-
- **remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
@@ -34549,7 +34526,7 @@ client.hris.teams.list()
-
client.hris.teams.retrieve(...) +
client.ticketing.teams.retrieve(...)
@@ -34582,7 +34559,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.teams.retrieve( +client.ticketing.teams.retrieve( id="id", ) @@ -34608,14 +34585,6 @@ client.hris.teams.retrieve(
-**expand:** `typing.Optional[typing.Literal["parent_team"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. - -
-
- -
-
- **include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -34644,8 +34613,8 @@ client.hris.teams.retrieve(
-## Hris TimeOff -
client.hris.time_off.list(...) +## Ticketing Tickets +
client.ticketing.tickets.list(...)
@@ -34657,7 +34626,7 @@ client.hris.teams.retrieve(
-Returns a list of `TimeOff` objects. +Returns a list of `Ticket` objects.
@@ -34678,7 +34647,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.time_off.list() +client.ticketing.tickets.list() ``` @@ -34686,15 +34655,55 @@ client.hris.time_off.list()
-#### ⚙️ Parameters - +#### ⚙️ Parameters + +
+
+ +
+
+ +**account_id:** `typing.Optional[str]` — If provided, will only return tickets for this account. + +
+
+ +
+
+ +**assignee_ids:** `typing.Optional[str]` — If provided, will only return tickets assigned to the assignee_ids; multiple assignee_ids can be separated by commas. + +
+
+ +
+
+ +**collection_ids:** `typing.Optional[str]` — If provided, will only return tickets assigned to the collection_ids; multiple collection_ids can be separated by commas. + +
+
+ +
+
+ +**completed_after:** `typing.Optional[dt.datetime]` — If provided, will only return tickets completed after this datetime. + +
+
+
+**completed_before:** `typing.Optional[dt.datetime]` — If provided, will only return tickets completed before this datetime. + +
+
+
-**approver_id:** `typing.Optional[str]` — If provided, will only return time off for this approver. +**contact_id:** `typing.Optional[str]` — If provided, will only return tickets for this contact.
@@ -34726,7 +34735,7 @@ client.hris.time_off.list()
-**employee_id:** `typing.Optional[str]` — If provided, will only return time off for this employee. +**due_after:** `typing.Optional[dt.datetime]` — If provided, will only return tickets due after this datetime.
@@ -34734,7 +34743,7 @@ client.hris.time_off.list()
-**ended_after:** `typing.Optional[dt.datetime]` — If provided, will only return employees that ended after this datetime. +**due_before:** `typing.Optional[dt.datetime]` — If provided, will only return tickets due before this datetime.
@@ -34742,7 +34751,7 @@ client.hris.time_off.list()
-**ended_before:** `typing.Optional[dt.datetime]` — If provided, will only return time-offs that ended before this datetime. +**expand:** `typing.Optional[TicketsListRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -34750,7 +34759,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. +**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/).
@@ -34758,7 +34767,7 @@ client.hris.time_off.list()
-**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/). +**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -34766,7 +34775,7 @@ client.hris.time_off.list()
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. +**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.
@@ -34806,7 +34815,46 @@ client.hris.time_off.list()
-**remote_fields:** `typing.Optional[TimeOffListRequestRemoteFields]` — Deprecated. Use show_enum_origins. +**parent_ticket_id:** `typing.Optional[str]` — If provided, will only return sub tickets of the parent_ticket_id. + +
+
+ +
+
+ +**priority:** `typing.Optional[TicketsListRequestPriority]` + +If provided, will only return tickets of this priority. + +* `URGENT` - URGENT +* `HIGH` - HIGH +* `NORMAL` - NORMAL +* `LOW` - LOW + +
+
+ +
+
+ +**remote_created_after:** `typing.Optional[dt.datetime]` — If provided, will only return tickets created in the third party platform after this datetime. + +
+
+ +
+
+ +**remote_created_before:** `typing.Optional[dt.datetime]` — If provided, will only return tickets created in the third party platform before this datetime. + +
+
+ +
+
+ +**remote_fields:** `typing.Optional[TicketsListRequestRemoteFields]` — Deprecated. Use show_enum_origins.
@@ -34822,16 +34870,15 @@ client.hris.time_off.list()
-**request_type:** `typing.Optional[TimeOffListRequestRequestType]` +**remote_updated_after:** `typing.Optional[dt.datetime]` — If provided, will only return tickets updated in the third party platform after this datetime. + +
+
-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 +**remote_updated_before:** `typing.Optional[dt.datetime]` — If provided, will only return tickets updated in the third party platform before this datetime.
@@ -34839,7 +34886,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) +**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)
@@ -34847,7 +34894,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. +**status:** `typing.Optional[str]` — If provided, will only return tickets of this status.
@@ -34855,7 +34902,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. +**tags:** `typing.Optional[str]` — If provided, will only return tickets matching the tags; multiple tags can be separated by commas.
@@ -34863,15 +34910,15 @@ If provided, will only return TimeOff with this request type. Options: ('VACATIO
-**status:** `typing.Optional[TimeOffListRequestStatus]` +**ticket_type:** `typing.Optional[str]` — If provided, will only return tickets of this type. + +
+
-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 +**ticket_url:** `typing.Optional[str]` — If provided, will only return tickets where the URL matches or contains the substring
@@ -34891,7 +34938,7 @@ If provided, will only return TimeOff with this status. Options: ('REQUESTED', '
-
client.hris.time_off.create(...) +
client.ticketing.tickets.create(...)
@@ -34903,7 +34950,7 @@ If provided, will only return TimeOff with this status. Options: ('REQUESTED', '
-Creates a `TimeOff` object with the given values. +Creates a `Ticket` object with the given values.
@@ -34919,14 +34966,14 @@ Creates a `TimeOff` object with the given values. ```python from merge import Merge -from merge.resources.hris import TimeOffRequest +from merge.resources.ticketing import TicketRequest client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.time_off.create( - model=TimeOffRequest(), +client.ticketing.tickets.create( + model=TicketRequest(), ) ``` @@ -34943,7 +34990,7 @@ client.hris.time_off.create(
-**model:** `TimeOffRequest` +**model:** `TicketRequest`
@@ -34979,7 +35026,7 @@ client.hris.time_off.create(
-
client.hris.time_off.retrieve(...) +
client.ticketing.tickets.retrieve(...)
@@ -34991,7 +35038,7 @@ client.hris.time_off.create(
-Returns a `TimeOff` object with the given `id`. +Returns a `Ticket` object with the given `id`.
@@ -35012,7 +35059,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.time_off.retrieve( +client.ticketing.tickets.retrieve( id="id", ) @@ -35038,7 +35085,7 @@ client.hris.time_off.retrieve(
-**expand:** `typing.Optional[TimeOffRetrieveRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. +**expand:** `typing.Optional[TicketsRetrieveRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -35054,6 +35101,14 @@ client.hris.time_off.retrieve(
+**include_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format. + +
+
+ +
+
+ **include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -35062,7 +35117,7 @@ client.hris.time_off.retrieve(
-**remote_fields:** `typing.Optional[TimeOffRetrieveRequestRemoteFields]` — Deprecated. Use show_enum_origins. +**remote_fields:** `typing.Optional[TicketsRetrieveRequestRemoteFields]` — Deprecated. Use show_enum_origins.
@@ -35070,7 +35125,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) +**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)
@@ -35090,7 +35145,7 @@ client.hris.time_off.retrieve(
-
client.hris.time_off.meta_post_retrieve() +
client.ticketing.tickets.partial_update(...)
@@ -35102,7 +35157,7 @@ client.hris.time_off.retrieve(
-Returns metadata for `TimeOff` POSTs. +Updates a `Ticket` object with the given `id`.
@@ -35118,12 +35173,16 @@ Returns metadata for `TimeOff` POSTs. ```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.time_off.meta_post_retrieve() +client.ticketing.tickets.partial_update( + id="id", + model=PatchedTicketRequest(), +) ``` @@ -35139,133 +35198,102 @@ client.hris.time_off.meta_post_retrieve()
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. +**id:** `str`
- -
+
+
+**model:** `PatchedTicketRequest` +
-
-## Hris TimeOffBalances -
client.hris.time_off_balances.list(...)
-#### 📝 Description - -
-
+**is_debug_mode:** `typing.Optional[bool]` — Whether to include debug fields (such as log file links) in the response. + +
+
-Returns a list of `TimeOffBalance` objects. -
-
+**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously. +
-#### 🔌 Usage - -
-
-
-```python -from merge import Merge - -client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.hris.time_off_balances.list() - -``` +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. +
-#### ⚙️ Parameters - -
-
- -
-
-**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime. -
+
+
client.ticketing.tickets.viewers_list(...)
-**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime. - -
-
+#### 📝 Description
-**cursor:** `typing.Optional[str]` — The pagination cursor value. - -
-
-
-**employee_id:** `typing.Optional[str]` — If provided, will only return time off balances for this employee. - +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)
- -
-
- -**expand:** `typing.Optional[typing.Literal["employee"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. -
+#### 🔌 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/). - -
-
-
-**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.tickets.viewers_list( + ticket_id="ticket_id", +) + +``` +
+
+#### ⚙️ Parameters +
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). - -
-
-
-**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned. +**ticket_id:** `str`
@@ -35273,7 +35301,7 @@ client.hris.time_off_balances.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.
@@ -35281,7 +35309,7 @@ client.hris.time_off_balances.list()
-**page_size:** `typing.Optional[int]` — Number of results to return per page. +**expand:** `typing.Optional[TicketsViewersListRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -35289,16 +35317,7 @@ client.hris.time_off_balances.list()
-**policy_type:** `typing.Optional[TimeOffBalancesListRequestPolicyType]` - -If provided, will only return TimeOffBalance with this policy type. Options: ('VACATION', 'SICK', 'PERSONAL', 'JURY_DUTY', 'VOLUNTEER', 'BEREAVEMENT') - -* `VACATION` - VACATION -* `SICK` - SICK -* `PERSONAL` - PERSONAL -* `JURY_DUTY` - JURY_DUTY -* `VOLUNTEER` - VOLUNTEER -* `BEREAVEMENT` - BEREAVEMENT +**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/).
@@ -35306,7 +35325,7 @@ If provided, will only return TimeOffBalance with this policy type. Options: ('V
-**remote_fields:** `typing.Optional[typing.Literal["policy_type"]]` — Deprecated. Use show_enum_origins. +**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -35314,7 +35333,7 @@ If provided, will only return TimeOffBalance with this policy type. Options: ('V
-**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object. +**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -35322,7 +35341,7 @@ If provided, will only return TimeOffBalance with this policy type. Options: ('V
-**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) +**page_size:** `typing.Optional[int]` — Number of results to return per page.
@@ -35342,7 +35361,7 @@ If provided, will only return TimeOffBalance with this policy type. Options: ('V
-
client.hris.time_off_balances.retrieve(...) +
client.ticketing.tickets.meta_patch_retrieve(...)
@@ -35354,7 +35373,7 @@ If provided, will only return TimeOffBalance with this policy type. Options: ('V
-Returns a `TimeOffBalance` object with the given `id`. +Returns metadata for `Ticket` PATCHs.
@@ -35375,7 +35394,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.time_off_balances.retrieve( +client.ticketing.tickets.meta_patch_retrieve( id="id", ) @@ -35401,46 +35420,6 @@ client.hris.time_off_balances.retrieve(
-**expand:** `typing.Optional[typing.Literal["employee"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. - -
-
- -
-
- -**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.
@@ -35453,8 +35432,7 @@ client.hris.time_off_balances.retrieve(
-## Hris TimesheetEntries -
client.hris.timesheet_entries.list(...) +
client.ticketing.tickets.meta_post_retrieve(...)
@@ -35466,7 +35444,7 @@ client.hris.time_off_balances.retrieve(
-Returns a list of `TimesheetEntry` objects. +Returns metadata for `Ticket` POSTs.
@@ -35487,7 +35465,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.timesheet_entries.list() +client.ticketing.tickets.meta_post_retrieve() ``` @@ -35503,7 +35481,7 @@ client.hris.timesheet_entries.list()
-**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime. +**collection_id:** `typing.Optional[str]` — If provided, will only return tickets for this collection.
@@ -35511,7 +35489,7 @@ client.hris.timesheet_entries.list()
-**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime. +**ticket_type:** `typing.Optional[str]` — If provided, will only return tickets for this ticket type.
@@ -35519,63 +35497,68 @@ client.hris.timesheet_entries.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 timesheet entries for this employee. -
+
+
client.ticketing.tickets.remote_field_classes_list(...)
-**ended_after:** `typing.Optional[dt.datetime]` — If provided, will only return timesheet entries ended after this datetime. - -
-
+#### 📝 Description
-**ended_before:** `typing.Optional[dt.datetime]` — If provided, will only return timesheet entries ended before this datetime. - -
-
-
-**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 list of `RemoteFieldClass` objects. +
+
+#### 🔌 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/). - -
-
-
-**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.tickets.remote_field_classes_list() + +```
+ + + +#### ⚙️ Parameters
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). +
+
+ +**cursor:** `typing.Optional[str]` — The pagination cursor value.
@@ -35583,7 +35566,7 @@ client.hris.timesheet_entries.list()
-**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned. +**ids:** `typing.Optional[str]` — If provided, will only return remote field classes with the `ids` in this list
@@ -35591,7 +35574,7 @@ client.hris.timesheet_entries.list()
-**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned. +**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/).
@@ -35599,7 +35582,7 @@ client.hris.timesheet_entries.list()
-**order_by:** `typing.Optional[TimesheetEntriesListRequestOrderBy]` — Overrides the default ordering for this endpoint. Possible values include: start_time, -start_time. +**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -35607,7 +35590,7 @@ client.hris.timesheet_entries.list()
-**page_size:** `typing.Optional[int]` — Number of results to return per page. +**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -35615,7 +35598,7 @@ client.hris.timesheet_entries.list()
-**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object. +**is_common_model_field:** `typing.Optional[bool]` — If provided, will only return remote field classes with this is_common_model_field value
@@ -35623,7 +35606,7 @@ client.hris.timesheet_entries.list()
-**started_after:** `typing.Optional[dt.datetime]` — If provided, will only return timesheet entries started after this datetime. +**is_custom:** `typing.Optional[bool]` — If provided, will only return remote fields classes with this is_custom value
@@ -35631,7 +35614,7 @@ client.hris.timesheet_entries.list()
-**started_before:** `typing.Optional[dt.datetime]` — If provided, will only return timesheet entries started before this datetime. +**page_size:** `typing.Optional[int]` — Number of results to return per page.
@@ -35651,7 +35634,8 @@ client.hris.timesheet_entries.list()
-
client.hris.timesheet_entries.create(...) +## Ticketing Users +
client.ticketing.users.list(...)
@@ -35663,7 +35647,7 @@ client.hris.timesheet_entries.list()
-Creates a `TimesheetEntry` object with the given values. +Returns a list of `User` objects.
@@ -35679,15 +35663,12 @@ 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.ticketing.users.list() ``` @@ -35703,7 +35684,7 @@ client.hris.timesheet_entries.create(
-**model:** `TimesheetEntryRequest` +**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
@@ -35711,7 +35692,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. +**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
@@ -35719,7 +35700,7 @@ client.hris.timesheet_entries.create(
-**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously. +**cursor:** `typing.Optional[str]` — The pagination cursor value.
@@ -35727,70 +35708,55 @@ client.hris.timesheet_entries.create(
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. +**email_address:** `typing.Optional[str]` — If provided, will only return users with emails equal to this value (case insensitive).
- -
+
+
+**expand:** `typing.Optional[UsersListRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. +
-
-
client.hris.timesheet_entries.retrieve(...)
-#### 📝 Description - -
-
+**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/). + +
+
-Returns a `TimesheetEntry` object with the given `id`. -
-
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models. +
-#### 🔌 Usage -
-
-
- -```python -from merge import Merge - -client = Merge( - account_token="YOUR_ACCOUNT_TOKEN", - api_key="YOUR_API_KEY", -) -client.hris.timesheet_entries.retrieve( - id="id", -) - -``` -
-
+**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). +
-#### ⚙️ Parameters -
+**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned. + +
+
+
-**id:** `str` +**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
@@ -35798,7 +35764,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. +**page_size:** `typing.Optional[int]` — Number of results to return per page.
@@ -35806,7 +35772,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.
@@ -35814,7 +35780,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). +**team:** `typing.Optional[str]` — If provided, will only return users matching in this team.
@@ -35834,7 +35800,7 @@ client.hris.timesheet_entries.retrieve(
-
client.hris.timesheet_entries.meta_post_retrieve() +
client.ticketing.users.retrieve(...)
@@ -35846,7 +35812,7 @@ client.hris.timesheet_entries.retrieve(
-Returns metadata for `TimesheetEntry` POSTs. +Returns a `User` object with the given `id`.
@@ -35867,7 +35833,9 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.timesheet_entries.meta_post_retrieve() +client.ticketing.users.retrieve( + id="id", +) ``` @@ -35883,6 +35851,38 @@ client.hris.timesheet_entries.meta_post_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.
@@ -35895,8 +35895,8 @@ client.hris.timesheet_entries.meta_post_retrieve()
-## Hris WebhookReceivers -
client.hris.webhook_receivers.list() +## Ticketing WebhookReceivers +
client.ticketing.webhook_receivers.list()
@@ -35929,7 +35929,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.webhook_receivers.list() +client.ticketing.webhook_receivers.list() ```
@@ -35957,7 +35957,7 @@ client.hris.webhook_receivers.list()
-
client.hris.webhook_receivers.create(...) +
client.ticketing.webhook_receivers.create(...)
@@ -35990,7 +35990,7 @@ client = Merge( account_token="YOUR_ACCOUNT_TOKEN", api_key="YOUR_API_KEY", ) -client.hris.webhook_receivers.create( +client.ticketing.webhook_receivers.create( event="event", is_active=True, ) diff --git a/requirements.txt b/requirements.txt index 170f5122..e80f640a 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,4 +1,4 @@ httpx>=0.21.2 pydantic>= 1.9.2 -pydantic-core==2.18.2 +pydantic-core>=2.18.2 typing_extensions>= 4.0.0 diff --git a/src/merge/client.py b/src/merge/client.py index d75a16a3..c55e9a2a 100644 --- a/src/merge/client.py +++ b/src/merge/client.py @@ -33,6 +33,9 @@ class Merge: account_token : typing.Optional[str] api_key : typing.Union[str, typing.Callable[[], str]] + headers : typing.Optional[typing.Dict[str, str]] + Additional headers to send with every request. + timeout : typing.Optional[float] The timeout to be used, in seconds, for requests. By default the timeout is 60 seconds, unless a custom httpx client is used, in which case this default is not enforced. @@ -59,6 +62,7 @@ def __init__( environment: MergeEnvironment = MergeEnvironment.PRODUCTION, account_token: typing.Optional[str] = None, api_key: typing.Union[str, typing.Callable[[], str]], + headers: typing.Optional[typing.Dict[str, str]] = None, timeout: typing.Optional[float] = None, follow_redirects: typing.Optional[bool] = True, httpx_client: typing.Optional[httpx.Client] = None, @@ -70,6 +74,7 @@ def __init__( base_url=_get_base_url(base_url=base_url, environment=environment), account_token=account_token, api_key=api_key, + headers=headers, httpx_client=httpx_client if httpx_client is not None else httpx.Client(timeout=_defaulted_timeout, follow_redirects=follow_redirects) @@ -78,10 +83,10 @@ def __init__( timeout=_defaulted_timeout, ) self.ats = AtsClient(client_wrapper=self._client_wrapper) - self.filestorage = FilestorageClient(client_wrapper=self._client_wrapper) - self.ticketing = TicketingClient(client_wrapper=self._client_wrapper) self.crm = CrmClient(client_wrapper=self._client_wrapper) + self.filestorage = FilestorageClient(client_wrapper=self._client_wrapper) self.hris = HrisClient(client_wrapper=self._client_wrapper) + self.ticketing = TicketingClient(client_wrapper=self._client_wrapper) self.accounting = AccountingClient(client_wrapper=self._client_wrapper) @@ -105,6 +110,9 @@ class AsyncMerge: account_token : typing.Optional[str] api_key : typing.Union[str, typing.Callable[[], str]] + headers : typing.Optional[typing.Dict[str, str]] + Additional headers to send with every request. + timeout : typing.Optional[float] The timeout to be used, in seconds, for requests. By default the timeout is 60 seconds, unless a custom httpx client is used, in which case this default is not enforced. @@ -131,6 +139,7 @@ def __init__( environment: MergeEnvironment = MergeEnvironment.PRODUCTION, account_token: typing.Optional[str] = None, api_key: typing.Union[str, typing.Callable[[], str]], + headers: typing.Optional[typing.Dict[str, str]] = None, timeout: typing.Optional[float] = None, follow_redirects: typing.Optional[bool] = True, httpx_client: typing.Optional[httpx.AsyncClient] = None, @@ -142,6 +151,7 @@ def __init__( base_url=_get_base_url(base_url=base_url, environment=environment), account_token=account_token, api_key=api_key, + headers=headers, httpx_client=httpx_client if httpx_client is not None else httpx.AsyncClient(timeout=_defaulted_timeout, follow_redirects=follow_redirects) @@ -150,10 +160,10 @@ def __init__( timeout=_defaulted_timeout, ) self.ats = AsyncAtsClient(client_wrapper=self._client_wrapper) - self.filestorage = AsyncFilestorageClient(client_wrapper=self._client_wrapper) - self.ticketing = AsyncTicketingClient(client_wrapper=self._client_wrapper) self.crm = AsyncCrmClient(client_wrapper=self._client_wrapper) + self.filestorage = AsyncFilestorageClient(client_wrapper=self._client_wrapper) self.hris = AsyncHrisClient(client_wrapper=self._client_wrapper) + self.ticketing = AsyncTicketingClient(client_wrapper=self._client_wrapper) self.accounting = AsyncAccountingClient(client_wrapper=self._client_wrapper) diff --git a/src/merge/core/client_wrapper.py b/src/merge/core/client_wrapper.py index 013eaca0..a844b5dd 100644 --- a/src/merge/core/client_wrapper.py +++ b/src/merge/core/client_wrapper.py @@ -12,20 +12,23 @@ def __init__( *, account_token: typing.Optional[str] = None, api_key: typing.Union[str, typing.Callable[[], str]], + headers: typing.Optional[typing.Dict[str, str]] = None, base_url: str, timeout: typing.Optional[float] = None, ): self._account_token = account_token self._api_key = api_key + self._headers = headers self._base_url = base_url self._timeout = timeout def get_headers(self) -> typing.Dict[str, str]: headers: typing.Dict[str, str] = { - "User-Agent": "MergePythonClient/2.0.0", + "User-Agent": "MergePythonClient/2.1.0", "X-Fern-Language": "Python", "X-Fern-SDK-Name": "MergePythonClient", - "X-Fern-SDK-Version": "2.0.0", + "X-Fern-SDK-Version": "2.1.0", + **(self.get_custom_headers() or {}), } if self._account_token is not None: headers["X-Account-Token"] = self._account_token @@ -38,6 +41,9 @@ def _get_api_key(self) -> str: else: return self._api_key() + def get_custom_headers(self) -> typing.Optional[typing.Dict[str, str]]: + return self._headers + def get_base_url(self) -> str: return self._base_url @@ -51,11 +57,14 @@ def __init__( *, account_token: typing.Optional[str] = None, api_key: typing.Union[str, typing.Callable[[], str]], + headers: typing.Optional[typing.Dict[str, str]] = None, base_url: str, timeout: typing.Optional[float] = None, httpx_client: httpx.Client, ): - super().__init__(account_token=account_token, api_key=api_key, base_url=base_url, timeout=timeout) + super().__init__( + account_token=account_token, api_key=api_key, headers=headers, base_url=base_url, timeout=timeout + ) self.httpx_client = HttpClient( httpx_client=httpx_client, base_headers=self.get_headers, @@ -70,11 +79,14 @@ def __init__( *, account_token: typing.Optional[str] = None, api_key: typing.Union[str, typing.Callable[[], str]], + headers: typing.Optional[typing.Dict[str, str]] = None, base_url: str, timeout: typing.Optional[float] = None, httpx_client: httpx.AsyncClient, ): - super().__init__(account_token=account_token, api_key=api_key, base_url=base_url, timeout=timeout) + super().__init__( + account_token=account_token, api_key=api_key, headers=headers, base_url=base_url, timeout=timeout + ) self.httpx_client = AsyncHttpClient( httpx_client=httpx_client, base_headers=self.get_headers,