diff --git a/.fern/metadata.json b/.fern/metadata.json
new file mode 100644
index 00000000..8b71c723
--- /dev/null
+++ b/.fern/metadata.json
@@ -0,0 +1,15 @@
+{
+ "cliVersion": "3.31.1",
+ "generatorName": "fernapi/fern-python-sdk",
+ "generatorVersion": "4.38.4",
+ "generatorConfig": {
+ "client_class_name": "Merge",
+ "inline_request_params": false,
+ "improved_imports": false,
+ "pydantic_config": {
+ "skip_validation": true,
+ "enum_type": "python_enums",
+ "use_pydantic_field_aliases": true
+ }
+ }
+}
\ No newline at end of file
diff --git a/.fernignore b/.fernignore
index 6dccf381..f2c615bf 100644
--- a/.fernignore
+++ b/.fernignore
@@ -10,4 +10,5 @@ LICENSE.md
src/merge/resources/accounting/types/currency_enum.py
tests/integration/test_filestorage.py
-tests/integration/test_knowledgebase.py
\ No newline at end of file
+tests/integration/test_knowledgebase.py
+changelog.md
diff --git a/README.md b/README.md
index 290a4f5c..c94b08b4 100644
--- a/README.md
+++ b/README.md
@@ -51,8 +51,6 @@ client = Merge(
api_key="YOUR_API_KEY",
)
client.ats.activities.create(
- is_debug_mode=True,
- run_async=True,
model=ActivityRequest(),
remote_user_id="remote_user_id",
)
@@ -83,7 +81,7 @@ client.hris. # APIs specific to the HRIS Category
## Async Client
-The SDK also exports an `async` client so that you can make non-blocking calls to our API.
+The SDK also exports an `async` client so that you can make non-blocking calls to our API. Note that if you are constructing an Async httpx client class to pass into this client, use `httpx.AsyncClient()` instead of `httpx.Client()` (e.g. for the `httpx_client` parameter of this client).
```python
import asyncio
@@ -99,8 +97,6 @@ client = AsyncMerge(
async def main() -> None:
await client.ats.activities.create(
- is_debug_mode=True,
- run_async=True,
model=ActivityRequest(),
remote_user_id="remote_user_id",
)
@@ -140,6 +136,14 @@ client = Merge(
response = client.ats.activities.with_raw_response.create(...)
print(response.headers) # access the response headers
print(response.data) # access the underlying object
+pager = client.ats.activities.list(...)
+print(pager.response) # access the typed response for the first page
+for item in pager:
+ print(item) # access the underlying object(s)
+for page in pager.iter_pages():
+ print(page.response) # access the typed response for each page
+ for item in page:
+ print(item) # access the underlying object(s)
```
### Retries
@@ -233,32 +237,31 @@ with open(local_filename, "wb") as f:
## 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.
+Paginated requests will return a `SyncPager` or `AsyncPager`, which can be used as generators for the underlying object.
-Below is an example of iterating over all pages:
```python
+from merge import Merge
-# 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")
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+response = client.ats.activities.list(
+ cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
+)
+for item in response:
+ yield item
+# alternatively, you can paginate page-by-page
+for page in response.iter_pages():
+ yield page
```
-
-
-
-
-
-
-
-
-
+```python
+# You can also iterate through pages and access the typed response per page
+pager = client.ats.activities.list(...)
+for page in pager.iter_pages():
+ print(page.response) # access the typed response for each page
+ for item in page:
+ print(item)
+```
diff --git a/changelog.md b/changelog.md
new file mode 100644
index 00000000..4bc9ad61
--- /dev/null
+++ b/changelog.md
@@ -0,0 +1,4 @@
+## 2.6.2 - 2026-01-16
+* SDK regeneration
+* Unable to analyze changes with AI, incrementing PATCH version.
+
diff --git a/poetry.lock b/poetry.lock
index 69701adb..ea0fda47 100644
--- a/poetry.lock
+++ b/poetry.lock
@@ -75,6 +75,20 @@ typing-extensions = {version = ">=4.6.0", markers = "python_version < \"3.13\""}
[package.extras]
test = ["pytest (>=6)"]
+[[package]]
+name = "execnet"
+version = "2.1.2"
+description = "execnet: rapid multi-Python deployment"
+optional = false
+python-versions = ">=3.8"
+files = [
+ {file = "execnet-2.1.2-py3-none-any.whl", hash = "sha256:67fba928dd5a544b783f6056f449e5e3931a5c378b128bc18501f7ea79e296ec"},
+ {file = "execnet-2.1.2.tar.gz", hash = "sha256:63d83bfdd9a23e35b9c6a3261412324f964c2ec8dcd8d3c6916ee9373e0befcd"},
+]
+
+[package.extras]
+testing = ["hatch", "pre-commit", "pytest", "tox"]
+
[[package]]
name = "h11"
version = "0.16.0"
@@ -418,6 +432,26 @@ pytest = ">=7.0.0,<9"
docs = ["sphinx (>=5.3)", "sphinx-rtd-theme (>=1.0)"]
testing = ["coverage (>=6.2)", "hypothesis (>=5.7.1)"]
+[[package]]
+name = "pytest-xdist"
+version = "3.6.1"
+description = "pytest xdist plugin for distributed testing, most importantly across multiple CPUs"
+optional = false
+python-versions = ">=3.8"
+files = [
+ {file = "pytest_xdist-3.6.1-py3-none-any.whl", hash = "sha256:9ed4adfb68a016610848639bb7e02c9352d5d9f03d04809919e2dafc3be4cca7"},
+ {file = "pytest_xdist-3.6.1.tar.gz", hash = "sha256:ead156a4db231eec769737f57668ef58a2084a34b2e55c4a8fa20d861107300d"},
+]
+
+[package.dependencies]
+execnet = ">=2.1"
+pytest = ">=7.0.0"
+
+[package.extras]
+psutil = ["psutil (>=3.0)"]
+setproctitle = ["setproctitle"]
+testing = ["filelock"]
+
[[package]]
name = "python-dateutil"
version = "2.9.0.post0"
@@ -562,4 +596,4 @@ files = [
[metadata]
lock-version = "2.0"
python-versions = "^3.8"
-content-hash = "8551b871abee465e23fb0966d51f2c155fd257b55bdcb0c02d095de19f92f358"
+content-hash = "bcf31a142c86d9e556553c8c260a93b563ac64a043076dbd48b26111d422c26e"
diff --git a/pyproject.toml b/pyproject.toml
index 6e9177d0..67c71bb5 100644
--- a/pyproject.toml
+++ b/pyproject.toml
@@ -3,7 +3,7 @@ name = "MergePythonClient"
[tool.poetry]
name = "MergePythonClient"
-version = "2.6.1"
+version = "2.6.2"
description = ""
readme = "README.md"
authors = []
@@ -30,7 +30,7 @@ packages = [
{ include = "merge", from = "src"}
]
-[project.urls]
+[tool.poetry.urls]
Repository = 'https://github.com/merge-api/merge-python-client'
[tool.poetry.dependencies]
@@ -44,6 +44,7 @@ typing_extensions = ">= 4.0.0"
mypy = "==1.13.0"
pytest = "^7.4.0"
pytest-asyncio = "^0.23.5"
+pytest-xdist = "^3.6.1"
python-dateutil = "^2.9.0"
types-python-dateutil = "^2.9.0.20240316"
ruff = "==0.11.5"
diff --git a/reference.md b/reference.md
index 3bf686bb..87620a7b 100644
--- a/reference.md
+++ b/reference.md
@@ -161,41 +161,20 @@ Returns a list of `Activity` objects.
```python
-import datetime
-
from merge import Merge
-from merge.resources.ats.resources.activities import (
- ActivitiesListRequestRemoteFields,
- ActivitiesListRequestShowEnumOrigins,
-)
client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.ats.activities.list(
- created_after=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- created_before=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
+response = client.ats.activities.list(
cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
- include_deleted_data=True,
- include_remote_data=True,
- include_shell_data=True,
- modified_after=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- modified_before=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- page_size=1,
- remote_fields=ActivitiesListRequestRemoteFields.ACTIVITY_TYPE,
- remote_id="remote_id",
- show_enum_origins=ActivitiesListRequestShowEnumOrigins.ACTIVITY_TYPE,
- user_id="user_id",
)
+for item in response:
+ yield item
+# alternatively, you can paginate page-by-page
+for page in response.iter_pages():
+ yield page
```
@@ -235,7 +214,12 @@ client.ats.activities.list(
-
-**expand:** `typing.Optional[typing.Literal["user"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+**expand:** `typing.Optional[
+ typing.Union[
+ ActivitiesListRequestExpandItem,
+ typing.Sequence[ActivitiesListRequestExpandItem],
+ ]
+]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -370,8 +354,6 @@ client = Merge(
api_key="YOUR_API_KEY",
)
client.ats.activities.create(
- is_debug_mode=True,
- run_async=True,
model=ActivityRequest(),
remote_user_id="remote_user_id",
)
@@ -462,10 +444,6 @@ Returns an `Activity` object with the given `id`.
```python
from merge import Merge
-from merge.resources.ats.resources.activities import (
- ActivitiesRetrieveRequestRemoteFields,
- ActivitiesRetrieveRequestShowEnumOrigins,
-)
client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
@@ -473,10 +451,6 @@ client = Merge(
)
client.ats.activities.retrieve(
id="id",
- include_remote_data=True,
- include_shell_data=True,
- remote_fields=ActivitiesRetrieveRequestRemoteFields.ACTIVITY_TYPE,
- show_enum_origins=ActivitiesRetrieveRequestShowEnumOrigins.ACTIVITY_TYPE,
)
```
@@ -501,7 +475,12 @@ client.ats.activities.retrieve(
-
-**expand:** `typing.Optional[typing.Literal["user"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+**expand:** `typing.Optional[
+ typing.Union[
+ ActivitiesRetrieveRequestExpandItem,
+ typing.Sequence[ActivitiesRetrieveRequestExpandItem],
+ ]
+]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -642,44 +621,20 @@ Returns a list of `Application` objects.
```python
-import datetime
-
from merge import Merge
-from merge.resources.ats.resources.applications import (
- ApplicationsListRequestExpand,
-)
client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.ats.applications.list(
- candidate_id="candidate_id",
- created_after=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- created_before=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- credited_to_id="credited_to_id",
- current_stage_id="current_stage_id",
+response = client.ats.applications.list(
cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
- expand=ApplicationsListRequestExpand.CANDIDATE,
- include_deleted_data=True,
- include_remote_data=True,
- include_shell_data=True,
- job_id="job_id",
- modified_after=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- modified_before=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- page_size=1,
- reject_reason_id="reject_reason_id",
- remote_id="remote_id",
- source="source",
)
+for item in response:
+ yield item
+# alternatively, you can paginate page-by-page
+for page in response.iter_pages():
+ yield page
```
@@ -743,7 +698,12 @@ client.ats.applications.list(
-
-**expand:** `typing.Optional[ApplicationsListRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+**expand:** `typing.Optional[
+ typing.Union[
+ ApplicationsListRequestExpandItem,
+ typing.Sequence[ApplicationsListRequestExpandItem],
+ ]
+]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -881,8 +841,6 @@ client = Merge(
api_key="YOUR_API_KEY",
)
client.ats.applications.create(
- is_debug_mode=True,
- run_async=True,
model=ApplicationRequest(),
remote_user_id="remote_user_id",
)
@@ -973,9 +931,6 @@ Returns an `Application` object with the given `id`.
```python
from merge import Merge
-from merge.resources.ats.resources.applications import (
- ApplicationsRetrieveRequestExpand,
-)
client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
@@ -983,9 +938,6 @@ client = Merge(
)
client.ats.applications.retrieve(
id="id",
- expand=ApplicationsRetrieveRequestExpand.CANDIDATE,
- include_remote_data=True,
- include_shell_data=True,
)
```
@@ -1010,7 +962,12 @@ client.ats.applications.retrieve(
-
-**expand:** `typing.Optional[ApplicationsRetrieveRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+**expand:** `typing.Optional[
+ typing.Union[
+ ApplicationsRetrieveRequestExpandItem,
+ typing.Sequence[ApplicationsRetrieveRequestExpandItem],
+ ]
+]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -1081,8 +1038,6 @@ client = Merge(
)
client.ats.applications.change_stage_create(
id="id",
- is_debug_mode=True,
- run_async=True,
)
```
@@ -1184,9 +1139,7 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.ats.applications.meta_post_retrieve(
- application_remote_template_id="application_remote_template_id",
-)
+client.ats.applications.meta_post_retrieve()
```
@@ -1397,35 +1350,20 @@ Returns a list of `Attachment` objects.
```python
-import datetime
-
from merge import Merge
client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.ats.attachments.list(
- candidate_id="candidate_id",
- created_after=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- created_before=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
+response = client.ats.attachments.list(
cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
- include_deleted_data=True,
- include_remote_data=True,
- include_shell_data=True,
- modified_after=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- modified_before=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- page_size=1,
- remote_id="remote_id",
)
+for item in response:
+ yield item
+# alternatively, you can paginate page-by-page
+for page in response.iter_pages():
+ yield page
```
@@ -1473,7 +1411,12 @@ client.ats.attachments.list(
-
-**expand:** `typing.Optional[typing.Literal["candidate"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+**expand:** `typing.Optional[
+ typing.Union[
+ AttachmentsListRequestExpandItem,
+ typing.Sequence[AttachmentsListRequestExpandItem],
+ ]
+]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -1529,7 +1472,7 @@ client.ats.attachments.list(
-
-**remote_fields:** `typing.Optional[typing.Literal["attachment_type"]]` — Deprecated. Use show_enum_origins.
+**remote_fields:** `typing.Optional[AttachmentsListRequestRemoteFields]` — Deprecated. Use show_enum_origins.
@@ -1545,7 +1488,7 @@ client.ats.attachments.list(
-
-**show_enum_origins:** `typing.Optional[typing.Literal["attachment_type"]]` — A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter)
+**show_enum_origins:** `typing.Optional[AttachmentsListRequestShowEnumOrigins]` — 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)
@@ -1600,8 +1543,6 @@ client = Merge(
api_key="YOUR_API_KEY",
)
client.ats.attachments.create(
- is_debug_mode=True,
- run_async=True,
model=AttachmentRequest(),
remote_user_id="remote_user_id",
)
@@ -1699,8 +1640,6 @@ client = Merge(
)
client.ats.attachments.retrieve(
id="id",
- include_remote_data=True,
- include_shell_data=True,
)
```
@@ -1725,7 +1664,12 @@ client.ats.attachments.retrieve(
-
-**expand:** `typing.Optional[typing.Literal["candidate"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+**expand:** `typing.Optional[
+ typing.Union[
+ AttachmentsRetrieveRequestExpandItem,
+ typing.Sequence[AttachmentsRetrieveRequestExpandItem],
+ ]
+]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -1749,7 +1693,7 @@ client.ats.attachments.retrieve(
-
-**remote_fields:** `typing.Optional[typing.Literal["attachment_type"]]` — Deprecated. Use show_enum_origins.
+**remote_fields:** `typing.Optional[AttachmentsRetrieveRequestRemoteFields]` — Deprecated. Use show_enum_origins.
@@ -1757,7 +1701,7 @@ client.ats.attachments.retrieve(
-
-**show_enum_origins:** `typing.Optional[typing.Literal["attachment_type"]]` — A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter)
+**show_enum_origins:** `typing.Optional[AttachmentsRetrieveRequestShowEnumOrigins]` — 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)
@@ -1872,14 +1816,14 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.ats.audit_trail.list(
+response = client.ats.audit_trail.list(
cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
- end_date="end_date",
- event_type="event_type",
- page_size=1,
- start_date="start_date",
- user_email="user_email",
)
+for item in response:
+ yield item
+# alternatively, you can paginate page-by-page
+for page in response.iter_pages():
+ yield page
```
@@ -2045,40 +1989,20 @@ Returns a list of `Candidate` objects.
```python
-import datetime
-
from merge import Merge
-from merge.resources.ats.resources.candidates import CandidatesListRequestExpand
client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.ats.candidates.list(
- created_after=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- created_before=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
+response = client.ats.candidates.list(
cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
- email_addresses="email_addresses",
- expand=CandidatesListRequestExpand.APPLICATIONS,
- first_name="first_name",
- include_deleted_data=True,
- include_remote_data=True,
- include_shell_data=True,
- last_name="last_name",
- modified_after=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- modified_before=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- page_size=1,
- remote_id="remote_id",
- tags="tags",
)
+for item in response:
+ yield item
+# alternatively, you can paginate page-by-page
+for page in response.iter_pages():
+ yield page
```
@@ -2126,7 +2050,12 @@ client.ats.candidates.list(
-
-**expand:** `typing.Optional[CandidatesListRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+**expand:** `typing.Optional[
+ typing.Union[
+ CandidatesListRequestExpandItem,
+ typing.Sequence[CandidatesListRequestExpandItem],
+ ]
+]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -2261,8 +2190,6 @@ client = Merge(
api_key="YOUR_API_KEY",
)
client.ats.candidates.create(
- is_debug_mode=True,
- run_async=True,
model=CandidateRequest(),
remote_user_id="remote_user_id",
)
@@ -2353,9 +2280,6 @@ Returns a `Candidate` object with the given `id`.
```python
from merge import Merge
-from merge.resources.ats.resources.candidates import (
- CandidatesRetrieveRequestExpand,
-)
client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
@@ -2363,9 +2287,6 @@ client = Merge(
)
client.ats.candidates.retrieve(
id="id",
- expand=CandidatesRetrieveRequestExpand.APPLICATIONS,
- include_remote_data=True,
- include_shell_data=True,
)
```
@@ -2390,7 +2311,12 @@ client.ats.candidates.retrieve(
-
-**expand:** `typing.Optional[CandidatesRetrieveRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+**expand:** `typing.Optional[
+ typing.Union[
+ CandidatesRetrieveRequestExpandItem,
+ typing.Sequence[CandidatesRetrieveRequestExpandItem],
+ ]
+]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -2462,8 +2388,6 @@ client = Merge(
)
client.ats.candidates.partial_update(
id="id",
- is_debug_mode=True,
- run_async=True,
model=PatchedCandidateRequest(),
remote_user_id="remote_user_id",
)
@@ -2562,7 +2486,7 @@ Ignores a specific row based on the `model_id` in the url. These records will ha
```python
from merge import Merge
-from merge.resources.ats import ReasonEnum
+from merge.resources.ats import IgnoreCommonModelRequest, ReasonEnum
client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
@@ -2570,7 +2494,9 @@ client = Merge(
)
client.ats.candidates.ignore_create(
model_id="model_id",
- reason=ReasonEnum.GENERAL_CUSTOMER_REQUEST,
+ request=IgnoreCommonModelRequest(
+ reason=ReasonEnum.GENERAL_CUSTOMER_REQUEST,
+ ),
)
```
@@ -2595,15 +2521,7 @@ client.ats.candidates.ignore_create(
-
-**reason:** `IgnoreCommonModelRequestReason`
-
-
-
-
-
--
-
-**message:** `typing.Optional[str]`
+**request:** `IgnoreCommonModelRequest`
@@ -3068,34 +2986,20 @@ Returns a list of `Department` objects.
```python
-import datetime
-
from merge import Merge
client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.ats.departments.list(
- created_after=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- created_before=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
+response = client.ats.departments.list(
cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
- include_deleted_data=True,
- include_remote_data=True,
- include_shell_data=True,
- modified_after=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- modified_before=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- page_size=1,
- remote_id="remote_id",
)
+for item in response:
+ yield item
+# alternatively, you can paginate page-by-page
+for page in response.iter_pages():
+ yield page
```
@@ -3238,8 +3142,6 @@ client = Merge(
)
client.ats.departments.retrieve(
id="id",
- include_remote_data=True,
- include_shell_data=True,
)
```
@@ -3320,41 +3222,20 @@ Returns a list of `EEOC` objects.
```python
-import datetime
-
from merge import Merge
-from merge.resources.ats.resources.eeocs import (
- EeocsListRequestRemoteFields,
- EeocsListRequestShowEnumOrigins,
-)
client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.ats.eeocs.list(
- candidate_id="candidate_id",
- created_after=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- created_before=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
+response = client.ats.eeocs.list(
cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
- include_deleted_data=True,
- include_remote_data=True,
- include_shell_data=True,
- modified_after=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- modified_before=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- page_size=1,
- remote_fields=EeocsListRequestRemoteFields.DISABILITY_STATUS,
- remote_id="remote_id",
- show_enum_origins=EeocsListRequestShowEnumOrigins.DISABILITY_STATUS,
)
+for item in response:
+ yield item
+# alternatively, you can paginate page-by-page
+for page in response.iter_pages():
+ yield page
```
@@ -3402,7 +3283,11 @@ client.ats.eeocs.list(
-
-**expand:** `typing.Optional[typing.Literal["candidate"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+**expand:** `typing.Optional[
+ typing.Union[
+ EeocsListRequestExpandItem, typing.Sequence[EeocsListRequestExpandItem]
+ ]
+]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -3522,10 +3407,6 @@ Returns an `EEOC` object with the given `id`.
```python
from merge import Merge
-from merge.resources.ats.resources.eeocs import (
- EeocsRetrieveRequestRemoteFields,
- EeocsRetrieveRequestShowEnumOrigins,
-)
client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
@@ -3533,10 +3414,6 @@ client = Merge(
)
client.ats.eeocs.retrieve(
id="id",
- include_remote_data=True,
- include_shell_data=True,
- remote_fields=EeocsRetrieveRequestRemoteFields.DISABILITY_STATUS,
- show_enum_origins=EeocsRetrieveRequestShowEnumOrigins.DISABILITY_STATUS,
)
```
@@ -3561,7 +3438,12 @@ client.ats.eeocs.retrieve(
-
-**expand:** `typing.Optional[typing.Literal["candidate"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+**expand:** `typing.Optional[
+ typing.Union[
+ EeocsRetrieveRequestExpandItem,
+ typing.Sequence[EeocsRetrieveRequestExpandItem],
+ ]
+]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -3647,9 +3529,7 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.ats.field_mapping.field_mappings_retrieve(
- exclude_remote_field_metadata=True,
-)
+client.ats.field_mapping.field_mappings_retrieve()
```
@@ -3719,7 +3599,6 @@ client = Merge(
api_key="YOUR_API_KEY",
)
client.ats.field_mapping.field_mappings_create(
- exclude_remote_field_metadata=True,
target_field_name="example_target_field_name",
target_field_description="this is a example description of the target field",
remote_field_traversal_path=["example_remote_field"],
@@ -3758,7 +3637,7 @@ client.ats.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.
+**remote_field_traversal_path:** `typing.Sequence[typing.Any]` — The field traversal path of the remote field listed when you hit the GET /remote-fields endpoint.
@@ -3940,7 +3819,7 @@ client.ats.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.
+**remote_field_traversal_path:** `typing.Optional[typing.Sequence[typing.Any]]` — The field traversal path of the remote field listed when you hit the GET /remote-fields endpoint.
@@ -4009,10 +3888,7 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.ats.field_mapping.remote_fields_retrieve(
- common_models="common_models",
- include_example_values="include_example_values",
-)
+client.ats.field_mapping.remote_fields_retrieve()
```
@@ -4217,40 +4093,20 @@ Returns a list of `ScheduledInterview` objects.
```python
-import datetime
-
from merge import Merge
-from merge.resources.ats.resources.interviews import InterviewsListRequestExpand
client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.ats.interviews.list(
- application_id="application_id",
- created_after=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- created_before=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
+response = client.ats.interviews.list(
cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
- expand=InterviewsListRequestExpand.APPLICATION,
- include_deleted_data=True,
- include_remote_data=True,
- include_shell_data=True,
- job_id="job_id",
- job_interview_stage_id="job_interview_stage_id",
- modified_after=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- modified_before=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- organizer_id="organizer_id",
- page_size=1,
- remote_id="remote_id",
)
+for item in response:
+ yield item
+# alternatively, you can paginate page-by-page
+for page in response.iter_pages():
+ yield page
```
@@ -4298,7 +4154,12 @@ client.ats.interviews.list(
-
-**expand:** `typing.Optional[InterviewsListRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+**expand:** `typing.Optional[
+ typing.Union[
+ InterviewsListRequestExpandItem,
+ typing.Sequence[InterviewsListRequestExpandItem],
+ ]
+]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -4378,7 +4239,7 @@ client.ats.interviews.list(
-
-**remote_fields:** `typing.Optional[typing.Literal["status"]]` — Deprecated. Use show_enum_origins.
+**remote_fields:** `typing.Optional[InterviewsListRequestRemoteFields]` — Deprecated. Use show_enum_origins.
@@ -4394,7 +4255,7 @@ client.ats.interviews.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)
+**show_enum_origins:** `typing.Optional[InterviewsListRequestShowEnumOrigins]` — 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)
@@ -4449,8 +4310,6 @@ client = Merge(
api_key="YOUR_API_KEY",
)
client.ats.interviews.create(
- is_debug_mode=True,
- run_async=True,
model=ScheduledInterviewRequest(),
remote_user_id="remote_user_id",
)
@@ -4541,9 +4400,6 @@ Returns a `ScheduledInterview` object with the given `id`.
```python
from merge import Merge
-from merge.resources.ats.resources.interviews import (
- InterviewsRetrieveRequestExpand,
-)
client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
@@ -4551,9 +4407,6 @@ client = Merge(
)
client.ats.interviews.retrieve(
id="id",
- expand=InterviewsRetrieveRequestExpand.APPLICATION,
- include_remote_data=True,
- include_shell_data=True,
)
```
@@ -4578,7 +4431,12 @@ client.ats.interviews.retrieve(
-
-**expand:** `typing.Optional[InterviewsRetrieveRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+**expand:** `typing.Optional[
+ typing.Union[
+ InterviewsRetrieveRequestExpandItem,
+ typing.Sequence[InterviewsRetrieveRequestExpandItem],
+ ]
+]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -4602,7 +4460,7 @@ client.ats.interviews.retrieve(
-
-**remote_fields:** `typing.Optional[typing.Literal["status"]]` — Deprecated. Use show_enum_origins.
+**remote_fields:** `typing.Optional[InterviewsRetrieveRequestRemoteFields]` — Deprecated. Use show_enum_origins.
@@ -4610,7 +4468,7 @@ client.ats.interviews.retrieve(
-
-**show_enum_origins:** `typing.Optional[typing.Literal["status"]]` — A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter)
+**show_enum_origins:** `typing.Optional[InterviewsRetrieveRequestShowEnumOrigins]` — 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)
@@ -4719,39 +4577,20 @@ Gets all issues for Organization.
```python
-import datetime
-
from merge import Merge
-from merge.resources.ats.resources.issues import IssuesListRequestStatus
client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.ats.issues.list(
- account_token="account_token",
+response = client.ats.issues.list(
cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
- end_date="end_date",
- end_user_organization_name="end_user_organization_name",
- first_incident_time_after=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- first_incident_time_before=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- include_muted="include_muted",
- integration_name="integration_name",
- last_incident_time_after=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- last_incident_time_before=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- linked_account_id="linked_account_id",
- page_size=1,
- start_date="start_date",
- status=IssuesListRequestStatus.ONGOING,
)
+for item in response:
+ yield item
+# alternatively, you can paginate page-by-page
+for page in response.iter_pages():
+ yield page
```
@@ -4995,35 +4834,20 @@ Returns a list of `JobInterviewStage` objects.
```python
-import datetime
-
from merge import Merge
client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.ats.job_interview_stages.list(
- created_after=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- created_before=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
+response = client.ats.job_interview_stages.list(
cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
- include_deleted_data=True,
- include_remote_data=True,
- include_shell_data=True,
- job_id="job_id",
- modified_after=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- modified_before=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- page_size=1,
- remote_id="remote_id",
)
+for item in response:
+ yield item
+# alternatively, you can paginate page-by-page
+for page in response.iter_pages():
+ yield page
```
@@ -5063,7 +4887,12 @@ client.ats.job_interview_stages.list(
-
-**expand:** `typing.Optional[typing.Literal["job"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+**expand:** `typing.Optional[
+ typing.Union[
+ JobInterviewStagesListRequestExpandItem,
+ typing.Sequence[JobInterviewStagesListRequestExpandItem],
+ ]
+]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -5182,8 +5011,6 @@ client = Merge(
)
client.ats.job_interview_stages.retrieve(
id="id",
- include_remote_data=True,
- include_shell_data=True,
)
```
@@ -5208,7 +5035,12 @@ client.ats.job_interview_stages.retrieve(
-
-**expand:** `typing.Optional[typing.Literal["job"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+**expand:** `typing.Optional[
+ typing.Union[
+ JobInterviewStagesRetrieveRequestExpandItem,
+ typing.Sequence[JobInterviewStagesRetrieveRequestExpandItem],
+ ]
+]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -5272,38 +5104,20 @@ Returns a list of `JobPosting` objects.
```python
-import datetime
-
from merge import Merge
-from merge.resources.ats.resources.job_postings import (
- JobPostingsListRequestStatus,
-)
client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.ats.job_postings.list(
- created_after=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- created_before=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
+response = client.ats.job_postings.list(
cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
- include_deleted_data=True,
- include_remote_data=True,
- include_shell_data=True,
- modified_after=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- modified_before=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- page_size=1,
- remote_id="remote_id",
- status=JobPostingsListRequestStatus.CLOSED,
)
+for item in response:
+ yield item
+# alternatively, you can paginate page-by-page
+for page in response.iter_pages():
+ yield page
```
@@ -5343,7 +5157,12 @@ client.ats.job_postings.list(
-
-**expand:** `typing.Optional[typing.Literal["job"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+**expand:** `typing.Optional[
+ typing.Union[
+ JobPostingsListRequestExpandItem,
+ typing.Sequence[JobPostingsListRequestExpandItem],
+ ]
+]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -5470,8 +5289,6 @@ client = Merge(
)
client.ats.job_postings.retrieve(
id="id",
- include_remote_data=True,
- include_shell_data=True,
)
```
@@ -5496,7 +5313,12 @@ client.ats.job_postings.retrieve(
-
-**expand:** `typing.Optional[typing.Literal["job"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+**expand:** `typing.Optional[
+ typing.Union[
+ JobPostingsRetrieveRequestExpandItem,
+ typing.Sequence[JobPostingsRetrieveRequestExpandItem],
+ ]
+]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -5560,42 +5382,20 @@ Returns a list of `Job` objects.
```python
-import datetime
-
from merge import Merge
-from merge.resources.ats.resources.jobs import (
- JobsListRequestExpand,
- JobsListRequestStatus,
-)
client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.ats.jobs.list(
- code="code",
- created_after=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- created_before=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
+response = client.ats.jobs.list(
cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
- expand=JobsListRequestExpand.DEPARTMENTS,
- include_deleted_data=True,
- include_remote_data=True,
- include_shell_data=True,
- modified_after=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- modified_before=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- offices="offices",
- page_size=1,
- remote_id="remote_id",
- status=JobsListRequestStatus.ARCHIVED,
)
+for item in response:
+ yield item
+# alternatively, you can paginate page-by-page
+for page in response.iter_pages():
+ yield page
```
@@ -5643,7 +5443,11 @@ client.ats.jobs.list(
-
-**expand:** `typing.Optional[JobsListRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+**expand:** `typing.Optional[
+ typing.Union[
+ JobsListRequestExpandItem, typing.Sequence[JobsListRequestExpandItem]
+ ]
+]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -5707,7 +5511,7 @@ client.ats.jobs.list(
-
-**remote_fields:** `typing.Optional[typing.Literal["status"]]` — Deprecated. Use show_enum_origins.
+**remote_fields:** `typing.Optional[JobsListRequestRemoteFields]` — Deprecated. Use show_enum_origins.
@@ -5723,7 +5527,7 @@ client.ats.jobs.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)
+**show_enum_origins:** `typing.Optional[JobsListRequestShowEnumOrigins]` — 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)
@@ -5787,7 +5591,6 @@ Returns a `Job` object with the given `id`.
```python
from merge import Merge
-from merge.resources.ats.resources.jobs import JobsRetrieveRequestExpand
client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
@@ -5795,9 +5598,6 @@ client = Merge(
)
client.ats.jobs.retrieve(
id="id",
- expand=JobsRetrieveRequestExpand.DEPARTMENTS,
- include_remote_data=True,
- include_shell_data=True,
)
```
@@ -5822,7 +5622,12 @@ client.ats.jobs.retrieve(
-
-**expand:** `typing.Optional[JobsRetrieveRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+**expand:** `typing.Optional[
+ typing.Union[
+ JobsRetrieveRequestExpandItem,
+ typing.Sequence[JobsRetrieveRequestExpandItem],
+ ]
+]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -5846,7 +5651,7 @@ client.ats.jobs.retrieve(
-
-**remote_fields:** `typing.Optional[typing.Literal["status"]]` — Deprecated. Use show_enum_origins.
+**remote_fields:** `typing.Optional[JobsRetrieveRequestRemoteFields]` — Deprecated. Use show_enum_origins.
@@ -5854,7 +5659,7 @@ client.ats.jobs.retrieve(
-
-**show_enum_origins:** `typing.Optional[typing.Literal["status"]]` — A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter)
+**show_enum_origins:** `typing.Optional[JobsRetrieveRequestShowEnumOrigins]` — 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)
@@ -5902,23 +5707,20 @@ Returns a list of `ScreeningQuestion` objects.
```python
from merge import Merge
-from merge.resources.ats.resources.jobs import (
- JobsScreeningQuestionsListRequestExpand,
-)
client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.ats.jobs.screening_questions_list(
+response = client.ats.jobs.screening_questions_list(
job_id="job_id",
cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
- expand=JobsScreeningQuestionsListRequestExpand.JOB,
- include_deleted_data=True,
- include_remote_data=True,
- include_shell_data=True,
- page_size=1,
)
+for item in response:
+ yield item
+# alternatively, you can paginate page-by-page
+for page in response.iter_pages():
+ yield page
```
@@ -5950,7 +5752,12 @@ client.ats.jobs.screening_questions_list(
-
-**expand:** `typing.Optional[JobsScreeningQuestionsListRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+**expand:** `typing.Optional[
+ typing.Union[
+ JobsScreeningQuestionsListRequestExpandItem,
+ typing.Sequence[JobsScreeningQuestionsListRequestExpandItem],
+ ]
+]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -6166,7 +5973,7 @@ The following subset of IETF language tags can be used to configure localization
-
-**integration_specific_config:** `typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]]` — A JSON object containing integration-specific configuration options.
+**integration_specific_config:** `typing.Optional[typing.Dict[str, typing.Any]]` — A JSON object containing integration-specific configuration options.
@@ -6215,29 +6022,19 @@ List linked accounts for your organization.
```python
from merge import Merge
-from merge.resources.ats.resources.linked_accounts import (
- LinkedAccountsListRequestCategory,
-)
client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.ats.linked_accounts.list(
- category=LinkedAccountsListRequestCategory.ACCOUNTING,
+response = client.ats.linked_accounts.list(
cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
- end_user_email_address="end_user_email_address",
- end_user_organization_name="end_user_organization_name",
- end_user_origin_id="end_user_origin_id",
- end_user_origin_ids="end_user_origin_ids",
- id="id",
- ids="ids",
- include_duplicates=True,
- integration_name="integration_name",
- is_test_account="is_test_account",
- page_size=1,
- status="status",
)
+for item in response:
+ yield item
+# alternatively, you can paginate page-by-page
+for page in response.iter_pages():
+ yield page
```
@@ -6407,38 +6204,20 @@ Returns a list of `Offer` objects.
```python
-import datetime
-
from merge import Merge
-from merge.resources.ats.resources.offers import OffersListRequestExpand
client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.ats.offers.list(
- application_id="application_id",
- created_after=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- created_before=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- creator_id="creator_id",
+response = client.ats.offers.list(
cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
- expand=OffersListRequestExpand.APPLICATION,
- include_deleted_data=True,
- include_remote_data=True,
- include_shell_data=True,
- modified_after=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- modified_before=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- page_size=1,
- remote_id="remote_id",
)
+for item in response:
+ yield item
+# alternatively, you can paginate page-by-page
+for page in response.iter_pages():
+ yield page
```
@@ -6494,7 +6273,12 @@ client.ats.offers.list(
-
-**expand:** `typing.Optional[OffersListRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+**expand:** `typing.Optional[
+ typing.Union[
+ OffersListRequestExpandItem,
+ typing.Sequence[OffersListRequestExpandItem],
+ ]
+]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -6550,7 +6334,7 @@ client.ats.offers.list(
-
-**remote_fields:** `typing.Optional[typing.Literal["status"]]` — Deprecated. Use show_enum_origins.
+**remote_fields:** `typing.Optional[OffersListRequestRemoteFields]` — Deprecated. Use show_enum_origins.
@@ -6566,7 +6350,7 @@ client.ats.offers.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)
+**show_enum_origins:** `typing.Optional[OffersListRequestShowEnumOrigins]` — 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)
@@ -6614,7 +6398,6 @@ Returns an `Offer` object with the given `id`.
```python
from merge import Merge
-from merge.resources.ats.resources.offers import OffersRetrieveRequestExpand
client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
@@ -6622,9 +6405,6 @@ client = Merge(
)
client.ats.offers.retrieve(
id="id",
- expand=OffersRetrieveRequestExpand.APPLICATION,
- include_remote_data=True,
- include_shell_data=True,
)
```
@@ -6649,7 +6429,12 @@ client.ats.offers.retrieve(
-
-**expand:** `typing.Optional[OffersRetrieveRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+**expand:** `typing.Optional[
+ typing.Union[
+ OffersRetrieveRequestExpandItem,
+ typing.Sequence[OffersRetrieveRequestExpandItem],
+ ]
+]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -6673,7 +6458,7 @@ client.ats.offers.retrieve(
-
-**remote_fields:** `typing.Optional[typing.Literal["status"]]` — Deprecated. Use show_enum_origins.
+**remote_fields:** `typing.Optional[OffersRetrieveRequestRemoteFields]` — Deprecated. Use show_enum_origins.
@@ -6681,7 +6466,7 @@ client.ats.offers.retrieve(
-
-**show_enum_origins:** `typing.Optional[typing.Literal["status"]]` — A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter)
+**show_enum_origins:** `typing.Optional[OffersRetrieveRequestShowEnumOrigins]` — 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)
@@ -6729,34 +6514,20 @@ Returns a list of `Office` objects.
```python
-import datetime
-
from merge import Merge
client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.ats.offices.list(
- created_after=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- created_before=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
+response = client.ats.offices.list(
cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
- include_deleted_data=True,
- include_remote_data=True,
- include_shell_data=True,
- modified_after=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- modified_before=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- page_size=1,
- remote_id="remote_id",
)
+for item in response:
+ yield item
+# alternatively, you can paginate page-by-page
+for page in response.iter_pages():
+ yield page
```
@@ -6899,8 +6670,6 @@ client = Merge(
)
client.ats.offices.retrieve(
id="id",
- include_remote_data=True,
- include_shell_data=True,
)
```
@@ -7129,34 +6898,20 @@ Returns a list of `RejectReason` objects.
```python
-import datetime
-
from merge import Merge
client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.ats.reject_reasons.list(
- created_after=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- created_before=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
+response = client.ats.reject_reasons.list(
cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
- include_deleted_data=True,
- include_remote_data=True,
- include_shell_data=True,
- modified_after=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- modified_before=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- page_size=1,
- remote_id="remote_id",
)
+for item in response:
+ yield item
+# alternatively, you can paginate page-by-page
+for page in response.iter_pages():
+ yield page
```
@@ -7299,8 +7054,6 @@ client = Merge(
)
client.ats.reject_reasons.retrieve(
id="id",
- include_remote_data=True,
- include_shell_data=True,
)
```
@@ -7381,39 +7134,20 @@ Returns a list of `Scorecard` objects.
```python
-import datetime
-
from merge import Merge
-from merge.resources.ats.resources.scorecards import ScorecardsListRequestExpand
client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.ats.scorecards.list(
- application_id="application_id",
- created_after=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- created_before=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
+response = client.ats.scorecards.list(
cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
- expand=ScorecardsListRequestExpand.APPLICATION,
- include_deleted_data=True,
- include_remote_data=True,
- include_shell_data=True,
- interview_id="interview_id",
- interviewer_id="interviewer_id",
- modified_after=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- modified_before=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- page_size=1,
- remote_id="remote_id",
)
+for item in response:
+ yield item
+# alternatively, you can paginate page-by-page
+for page in response.iter_pages():
+ yield page
```
@@ -7461,7 +7195,12 @@ client.ats.scorecards.list(
-
-**expand:** `typing.Optional[ScorecardsListRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+**expand:** `typing.Optional[
+ typing.Union[
+ ScorecardsListRequestExpandItem,
+ typing.Sequence[ScorecardsListRequestExpandItem],
+ ]
+]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -7533,7 +7272,7 @@ client.ats.scorecards.list(
-
-**remote_fields:** `typing.Optional[typing.Literal["overall_recommendation"]]` — Deprecated. Use show_enum_origins.
+**remote_fields:** `typing.Optional[ScorecardsListRequestRemoteFields]` — Deprecated. Use show_enum_origins.
@@ -7549,7 +7288,7 @@ client.ats.scorecards.list(
-
-**show_enum_origins:** `typing.Optional[typing.Literal["overall_recommendation"]]` — 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[ScorecardsListRequestShowEnumOrigins]` — 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)
@@ -7597,9 +7336,6 @@ Returns a `Scorecard` object with the given `id`.
```python
from merge import Merge
-from merge.resources.ats.resources.scorecards import (
- ScorecardsRetrieveRequestExpand,
-)
client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
@@ -7607,9 +7343,6 @@ client = Merge(
)
client.ats.scorecards.retrieve(
id="id",
- expand=ScorecardsRetrieveRequestExpand.APPLICATION,
- include_remote_data=True,
- include_shell_data=True,
)
```
@@ -7634,7 +7367,12 @@ client.ats.scorecards.retrieve(
-
-**expand:** `typing.Optional[ScorecardsRetrieveRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+**expand:** `typing.Optional[
+ typing.Union[
+ ScorecardsRetrieveRequestExpandItem,
+ typing.Sequence[ScorecardsRetrieveRequestExpandItem],
+ ]
+]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -7658,7 +7396,7 @@ client.ats.scorecards.retrieve(
-
-**remote_fields:** `typing.Optional[typing.Literal["overall_recommendation"]]` — Deprecated. Use show_enum_origins.
+**remote_fields:** `typing.Optional[ScorecardsRetrieveRequestRemoteFields]` — Deprecated. Use show_enum_origins.
@@ -7666,7 +7404,7 @@ client.ats.scorecards.retrieve(
-
-**show_enum_origins:** `typing.Optional[typing.Literal["overall_recommendation"]]` — 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[ScorecardsRetrieveRequestShowEnumOrigins]` — 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)
@@ -7720,10 +7458,14 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.ats.sync_status.list(
+response = client.ats.sync_status.list(
cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
- page_size=1,
)
+for item in response:
+ yield item
+# alternatively, you can paginate page-by-page
+for page in response.iter_pages():
+ yield page
```
@@ -7857,198 +7599,169 @@ Returns a list of `Tag` objects.
```python
-import datetime
+from merge import Merge
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+response = client.ats.tags.list(
+ cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
+)
+for item in response:
+ yield item
+# alternatively, you can paginate page-by-page
+for page in response.iter_pages():
+ yield page
+
+```
+
+
+
+
+
+#### ⚙️ 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).
+
+
+
+
+
+-
+
+**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.
+
+
+
+
+
+
+
+
+
+
+
+## Ats Users
+client.ats.users.list(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a list of `RemoteUser` objects.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
from merge import Merge
client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.ats.tags.list(
- created_after=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- created_before=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
+response = client.ats.users.list(
cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
- include_deleted_data=True,
- include_remote_data=True,
- include_shell_data=True,
- modified_after=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- modified_before=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- page_size=1,
- remote_id="remote_id",
-)
-
-```
-
-
-
-
-
-#### ⚙️ 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).
-
-
-
-
-
--
-
-**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.
-
-
-
-
-
-
-
-
-
-
-
-## Ats Users
-client.ats.users.list(...)
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Returns a list of `RemoteUser` objects.
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-import datetime
-
-from merge import Merge
-
-client = Merge(
- account_token="YOUR_ACCOUNT_TOKEN",
- api_key="YOUR_API_KEY",
-)
-client.ats.users.list(
- created_after=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- created_before=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
- email="email",
- include_deleted_data=True,
- include_remote_data=True,
- include_shell_data=True,
- modified_after=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- modified_before=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- page_size=1,
- remote_id="remote_id",
)
+for item in response:
+ yield item
+# alternatively, you can paginate page-by-page
+for page in response.iter_pages():
+ yield page
```
@@ -8144,7 +7857,7 @@ client.ats.users.list(
-
-**remote_fields:** `typing.Optional[typing.Literal["access_role"]]` — Deprecated. Use show_enum_origins.
+**remote_fields:** `typing.Optional[UsersListRequestRemoteFields]` — Deprecated. Use show_enum_origins.
@@ -8160,7 +7873,7 @@ client.ats.users.list(
-
-**show_enum_origins:** `typing.Optional[typing.Literal["access_role"]]` — 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[UsersListRequestShowEnumOrigins]` — 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)
@@ -8215,8 +7928,6 @@ client = Merge(
)
client.ats.users.retrieve(
id="id",
- include_remote_data=True,
- include_shell_data=True,
)
```
@@ -8257,7 +7968,7 @@ client.ats.users.retrieve(
-
-**remote_fields:** `typing.Optional[typing.Literal["access_role"]]` — Deprecated. Use show_enum_origins.
+**remote_fields:** `typing.Optional[UsersRetrieveRequestRemoteFields]` — Deprecated. Use show_enum_origins.
@@ -8265,7 +7976,7 @@ client.ats.users.retrieve(
-
-**show_enum_origins:** `typing.Optional[typing.Literal["access_role"]]` — 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[UsersRetrieveRequestShowEnumOrigins]` — 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)
@@ -8435,8 +8146,8 @@ client.ats.webhook_receivers.create(
-## Chat AccountDetails
-client.chat.account_details.retrieve()
+## Accounting AccountDetails
+client.accounting.account_details.retrieve()
-
@@ -8469,7 +8180,7 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.chat.account_details.retrieve()
+client.accounting.account_details.retrieve()
```
@@ -8497,8 +8208,8 @@ client.chat.account_details.retrieve()
-## Chat AccountToken
-client.chat.account_token.retrieve(...)
+## Accounting AccountToken
+client.accounting.account_token.retrieve(...)
-
@@ -8531,7 +8242,7 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.chat.account_token.retrieve(
+client.accounting.account_token.retrieve(
public_token="public_token",
)
@@ -8569,8 +8280,8 @@ client.chat.account_token.retrieve(
-## Chat AsyncPassthrough
-client.chat.async_passthrough.create(...)
+## Accounting AccountingPeriods
+client.accounting.accounting_periods.list(...)
-
@@ -8582,7 +8293,7 @@ client.chat.account_token.retrieve(
-
-Asynchronously pull data from an endpoint not currently supported by Merge.
+Returns a list of `AccountingPeriod` objects.
@@ -8598,18 +8309,19 @@ Asynchronously pull data from an endpoint not currently supported by Merge.
```python
from merge import Merge
-from merge.resources.chat import DataPassthroughRequest, MethodEnum
client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.chat.async_passthrough.create(
- request=DataPassthroughRequest(
- method=MethodEnum.GET,
- path="/scooters",
- ),
+response = client.accounting.accounting_periods.list(
+ cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
)
+for item in response:
+ yield item
+# alternatively, you can paginate page-by-page
+for page in response.iter_pages():
+ yield page
```
@@ -8625,7 +8337,7 @@ client.chat.async_passthrough.create(
-
-**request:** `DataPassthroughRequest`
+**cursor:** `typing.Optional[str]` — The pagination cursor value.
@@ -8633,70 +8345,31 @@ client.chat.async_passthrough.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/).
-
-
-
-
-
-
-
-
-client.chat.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.chat.async_passthrough.retrieve(
- async_passthrough_receipt_id="async_passthrough_receipt_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
-
-
--
-
-
-**async_passthrough_receipt_id:** `str`
+**page_size:** `typing.Optional[int]` — Number of results to return per page.
@@ -8716,8 +8389,7 @@ client.chat.async_passthrough.retrieve(
-## Chat AuditTrail
-client.chat.audit_trail.list(...)
+client.accounting.accounting_periods.retrieve(...)
-
@@ -8729,7 +8401,7 @@ client.chat.async_passthrough.retrieve(
-
-Gets a list of audit trail events.
+Returns an `AccountingPeriod` object with the given `id`.
@@ -8750,13 +8422,8 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.chat.audit_trail.list(
- cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
- end_date="end_date",
- event_type="event_type",
- page_size=1,
- start_date="start_date",
- user_email="user_email",
+client.accounting.accounting_periods.retrieve(
+ id="id",
)
```
@@ -8773,31 +8440,7 @@ client.chat.audit_trail.list(
-
-**cursor:** `typing.Optional[str]` — The pagination cursor value.
-
-
-
-
-
--
-
-**end_date:** `typing.Optional[str]` — If included, will only include audit trail events that occurred before this time
-
-
-
-
-
--
-
-**event_type:** `typing.Optional[str]` — If included, will only include events with the given event type. Possible values include: `CREATED_REMOTE_PRODUCTION_API_KEY`, `DELETED_REMOTE_PRODUCTION_API_KEY`, `CREATED_TEST_API_KEY`, `DELETED_TEST_API_KEY`, `REGENERATED_PRODUCTION_API_KEY`, `REGENERATED_WEBHOOK_SIGNATURE`, `INVITED_USER`, `TWO_FACTOR_AUTH_ENABLED`, `TWO_FACTOR_AUTH_DISABLED`, `DELETED_LINKED_ACCOUNT`, `DELETED_ALL_COMMON_MODELS_FOR_LINKED_ACCOUNT`, `CREATED_DESTINATION`, `DELETED_DESTINATION`, `CHANGED_DESTINATION`, `CHANGED_SCOPES`, `CHANGED_PERSONAL_INFORMATION`, `CHANGED_ORGANIZATION_SETTINGS`, `ENABLED_INTEGRATION`, `DISABLED_INTEGRATION`, `ENABLED_CATEGORY`, `DISABLED_CATEGORY`, `CHANGED_PASSWORD`, `RESET_PASSWORD`, `ENABLED_REDACT_UNMAPPED_DATA_FOR_ORGANIZATION`, `ENABLED_REDACT_UNMAPPED_DATA_FOR_LINKED_ACCOUNT`, `DISABLED_REDACT_UNMAPPED_DATA_FOR_ORGANIZATION`, `DISABLED_REDACT_UNMAPPED_DATA_FOR_LINKED_ACCOUNT`, `CREATED_INTEGRATION_WIDE_FIELD_MAPPING`, `CREATED_LINKED_ACCOUNT_FIELD_MAPPING`, `CHANGED_INTEGRATION_WIDE_FIELD_MAPPING`, `CHANGED_LINKED_ACCOUNT_FIELD_MAPPING`, `DELETED_INTEGRATION_WIDE_FIELD_MAPPING`, `DELETED_LINKED_ACCOUNT_FIELD_MAPPING`, `CREATED_LINKED_ACCOUNT_COMMON_MODEL_OVERRIDE`, `CHANGED_LINKED_ACCOUNT_COMMON_MODEL_OVERRIDE`, `DELETED_LINKED_ACCOUNT_COMMON_MODEL_OVERRIDE`, `FORCED_LINKED_ACCOUNT_RESYNC`, `MUTED_ISSUE`, `GENERATED_MAGIC_LINK`, `ENABLED_MERGE_WEBHOOK`, `DISABLED_MERGE_WEBHOOK`, `MERGE_WEBHOOK_TARGET_CHANGED`, `END_USER_CREDENTIALS_ACCESSED`
-
-
-
-
-
--
-
-**page_size:** `typing.Optional[int]` — Number of results to return per page. The maximum limit is 100.
+**id:** `str`
@@ -8805,7 +8448,7 @@ client.chat.audit_trail.list(
-
-**start_date:** `typing.Optional[str]` — If included, will only include audit trail events that occurred after this time
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -8813,7 +8456,7 @@ client.chat.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).
@@ -8833,8 +8476,8 @@ client.chat.audit_trail.list(
-## Chat AvailableActions
-client.chat.available_actions.retrieve()
+## Accounting Accounts
+client.accounting.accounts.list(...)
-
@@ -8846,7 +8489,7 @@ client.chat.audit_trail.list(
-
-Returns a list of models and actions available for an account.
+Returns a list of `Account` objects.
@@ -8867,7 +8510,14 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.chat.available_actions.retrieve()
+response = client.accounting.accounts.list(
+ cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
+)
+for item in response:
+ yield item
+# alternatively, you can paginate page-by-page
+for page in response.iter_pages():
+ yield page
```
@@ -8883,86 +8533,27 @@ client.chat.available_actions.retrieve()
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+**account_type:** `typing.Optional[str]` — If provided, will only return accounts with the passed in enum.
-
-
-
-
-
-
-
-
-## Chat Conversations
-client.chat.conversations.list(...)
-
--
-
-#### 📝 Description
-
-
--
-
-Returns a list of `Conversation` objects.
-
-
+**classification:** `typing.Optional[AccountsListRequestClassification]` — If provided, will only return accounts with this classification.
+
-#### 🔌 Usage
-
-
-
--
-
-```python
-import datetime
-
-from merge import Merge
-
-client = Merge(
- account_token="YOUR_ACCOUNT_TOKEN",
- api_key="YOUR_API_KEY",
-)
-client.chat.conversations.list(
- created_after=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- created_before=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
- include_deleted_data=True,
- include_remote_data=True,
- include_shell_data=True,
- modified_after=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- modified_before=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- page_size=1,
- remote_id="remote_id",
-)
-
-```
-
-
+**company_id:** `typing.Optional[str]` — If provided, will only return accounts for this company.
+
-#### ⚙️ Parameters
-
-
--
-
-
@@ -8990,7 +8581,12 @@ client.chat.conversations.list(
-
-**expand:** `typing.Optional[typing.Literal["members"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+**expand:** `typing.Optional[
+ typing.Union[
+ AccountsListRequestExpandItem,
+ typing.Sequence[AccountsListRequestExpandItem],
+ ]
+]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -9038,7 +8634,23 @@ client.chat.conversations.list(
-
-**page_size:** `typing.Optional[int]` — Number of results to return per page. The maximum limit is 100.
+**name:** `typing.Optional[str]` — If provided, will only return Accounts with this name.
+
+
+
+
+
+-
+
+**page_size:** `typing.Optional[int]` — Number of results to return per page.
+
+
+
+
+
+-
+
+**remote_fields:** `typing.Optional[AccountsListRequestRemoteFields]` — Deprecated. Use show_enum_origins.
@@ -9054,6 +8666,22 @@ client.chat.conversations.list(
-
+**show_enum_origins:** `typing.Optional[AccountsListRequestShowEnumOrigins]` — 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[AccountsListRequestStatus]` — If provided, will only return accounts with this status.
+
+
+
+
+
+-
+
**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -9066,7 +8694,7 @@ client.chat.conversations.list(
-client.chat.conversations.members_list(...)
+client.accounting.accounts.create(...)
-
@@ -9078,7 +8706,7 @@ client.chat.conversations.list(
-
-Returns a list of `Member` objects.
+Creates an `Account` object with the given values.
@@ -9094,22 +8722,14 @@ Returns a list of `Member` objects.
```python
from merge import Merge
-from merge.resources.chat.resources.conversations import (
- ConversationsMembersListRequestExpand,
-)
+from merge.resources.accounting import AccountRequest
client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.chat.conversations.members_list(
- conversation_id="conversation_id",
- cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
- expand=ConversationsMembersListRequestExpand.GROUP,
- include_deleted_data=True,
- include_remote_data=True,
- include_shell_data=True,
- page_size=1,
+client.accounting.accounts.create(
+ model=AccountRequest(),
)
```
@@ -9126,39 +8746,7 @@ client.chat.conversations.members_list(
-
-**conversation_id:** `str`
-
-
-
-
-
--
-
-**cursor:** `typing.Optional[str]` — The pagination cursor value.
-
-
-
-
-
--
-
-**expand:** `typing.Optional[ConversationsMembersListRequestExpand]` — 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.
+**model:** `AccountRequest`
@@ -9166,7 +8754,7 @@ client.chat.conversations.members_list(
-
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
+**is_debug_mode:** `typing.Optional[bool]` — Whether to include debug fields (such as log file links) in the response.
@@ -9174,7 +8762,7 @@ client.chat.conversations.members_list(
-
-**page_size:** `typing.Optional[int]` — Number of results to return per page. The maximum limit is 100.
+**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously.
@@ -9194,7 +8782,7 @@ client.chat.conversations.members_list(
-client.chat.conversations.retrieve(...)
+client.accounting.accounts.retrieve(...)
-
@@ -9206,7 +8794,7 @@ client.chat.conversations.members_list(
-
-Returns a `Conversation` object with the given `id`.
+Returns an `Account` object with the given `id`.
@@ -9227,10 +8815,8 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.chat.conversations.retrieve(
+client.accounting.accounts.retrieve(
id="id",
- include_remote_data=True,
- include_shell_data=True,
)
```
@@ -9255,7 +8841,12 @@ client.chat.conversations.retrieve(
-
-**expand:** `typing.Optional[typing.Literal["members"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+**expand:** `typing.Optional[
+ typing.Union[
+ AccountsRetrieveRequestExpandItem,
+ typing.Sequence[AccountsRetrieveRequestExpandItem],
+ ]
+]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -9279,6 +8870,22 @@ client.chat.conversations.retrieve(
-
+**remote_fields:** `typing.Optional[AccountsRetrieveRequestRemoteFields]` — Deprecated. Use show_enum_origins.
+
+
+
+
+
+-
+
+**show_enum_origins:** `typing.Optional[AccountsRetrieveRequestShowEnumOrigins]` — 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.
@@ -9291,8 +8898,7 @@ client.chat.conversations.retrieve(
-## Chat Scopes
-client.chat.scopes.default_scopes_retrieve()
+client.accounting.accounts.meta_post_retrieve()
-
@@ -9304,7 +8910,7 @@ client.chat.conversations.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 `Account` POSTs.
@@ -9325,7 +8931,7 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.chat.scopes.default_scopes_retrieve()
+client.accounting.accounts.meta_post_retrieve()
```
@@ -9353,7 +8959,8 @@ client.chat.scopes.default_scopes_retrieve()
-client.chat.scopes.linked_account_scopes_retrieve()
+## Accounting Addresses
+client.accounting.addresses.retrieve(...)
-
@@ -9365,7 +8972,7 @@ client.chat.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 `Address` object with the given `id`.
@@ -9386,7 +8993,9 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.chat.scopes.linked_account_scopes_retrieve()
+client.accounting.addresses.retrieve(
+ id="id",
+)
```
@@ -9402,6 +9011,46 @@ client.chat.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).
+
+
+
+
+
+-
+
+**remote_fields:** `typing.Optional[AddressesRetrieveRequestRemoteFields]` — Deprecated. Use show_enum_origins.
+
+
+
+
+
+-
+
+**show_enum_origins:** `typing.Optional[AddressesRetrieveRequestShowEnumOrigins]` — 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.
@@ -9414,7 +9063,8 @@ client.chat.scopes.linked_account_scopes_retrieve()
-client.chat.scopes.linked_account_scopes_create(...)
+## Accounting AsyncPassthrough
+client.accounting.async_passthrough.create(...)
-
@@ -9426,7 +9076,7 @@ client.chat.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.
@@ -9442,42 +9092,17 @@ Update permissions for any Common Model or field for a single Linked Account. An
```python
from merge import Merge
-from merge.resources.chat import (
- FieldPermissionDeserializerRequest,
- IndividualCommonModelScopeDeserializerRequest,
- ModelPermissionDeserializerRequest,
-)
+from merge.resources.accounting import DataPassthroughRequest, MethodEnum
client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.chat.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.accounting.async_passthrough.create(
+ request=DataPassthroughRequest(
+ method=MethodEnum.GET,
+ path="/scooters",
+ ),
)
```
@@ -9494,7 +9119,7 @@ client.chat.scopes.linked_account_scopes_create(
-
-**common_models:** `typing.Sequence[IndividualCommonModelScopeDeserializerRequest]` — The common models you want to update the scopes for
+**request:** `DataPassthroughRequest`
@@ -9514,8 +9139,7 @@ client.chat.scopes.linked_account_scopes_create(
-## Chat DeleteAccount
-client.chat.delete_account.delete()
+client.accounting.async_passthrough.retrieve(...)
-
@@ -9527,7 +9151,7 @@ client.chat.scopes.linked_account_scopes_create(
-
-Delete a linked account.
+Retrieves data from earlier async-passthrough POST request
@@ -9548,7 +9172,9 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.chat.delete_account.delete()
+client.accounting.async_passthrough.retrieve(
+ async_passthrough_receipt_id="async_passthrough_receipt_id",
+)
```
@@ -9564,6 +9190,14 @@ client.chat.delete_account.delete()
-
+**async_passthrough_receipt_id:** `str`
+
+
+
+
+
+-
+
**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -9576,8 +9210,8 @@ client.chat.delete_account.delete()
-## Chat FieldMapping
-client.chat.field_mapping.field_mappings_retrieve(...)
+## Accounting AsyncTasks
+client.accounting.async_tasks.retrieve(...)
-
@@ -9589,7 +9223,7 @@ client.chat.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/).
+Returns an `AsyncPostTask` object with the given `id`.
@@ -9610,8 +9244,8 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.chat.field_mapping.field_mappings_retrieve(
- exclude_remote_field_metadata=True,
+client.accounting.async_tasks.retrieve(
+ id="id",
)
```
@@ -9628,7 +9262,7 @@ client.chat.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.
+**id:** `str`
@@ -9648,7 +9282,8 @@ client.chat.field_mapping.field_mappings_retrieve(
-client.chat.field_mapping.field_mappings_create(...)
+## Accounting Attachments
+client.accounting.attachments.list(...)
-
@@ -9660,7 +9295,7 @@ client.chat.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 `AccountingAttachment` objects.
@@ -9681,15 +9316,14 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.chat.field_mapping.field_mappings_create(
- exclude_remote_field_metadata=True,
- target_field_name="example_target_field_name",
- target_field_description="this is a example description of the target field",
- remote_field_traversal_path=["example_remote_field"],
- remote_method="GET",
- remote_url_path="/example-url-path",
- common_model_name="ExampleCommonModel",
+response = client.accounting.attachments.list(
+ cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
)
+for item in response:
+ yield item
+# alternatively, you can paginate page-by-page
+for page in response.iter_pages():
+ yield page
```
@@ -9705,7 +9339,7 @@ client.chat.field_mapping.field_mappings_create(
-
-**target_field_name:** `str` — The name of the target field you want this remote field to map to.
+**company_id:** `typing.Optional[str]` — If provided, will only return accounting attachments for this company.
@@ -9713,7 +9347,7 @@ client.chat.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.
@@ -9721,7 +9355,7 @@ client.chat.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.
@@ -9729,7 +9363,7 @@ client.chat.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.
@@ -9737,7 +9371,7 @@ client.chat.field_mapping.field_mappings_create(
-
-**remote_url_path:** `str` — The path of the remote endpoint where the remote field is coming from.
+**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
@@ -9745,7 +9379,7 @@ client.chat.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.
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -9753,7 +9387,7 @@ client.chat.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_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -9761,7 +9395,7 @@ client.chat.field_mapping.field_mappings_create(
-
-**jmes_path:** `typing.Optional[str]` — JMES path to specify json query expression to be used on field mapping.
+**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
@@ -9769,70 +9403,23 @@ client.chat.field_mapping.field_mappings_create(
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
-
-
-
-
-
-
-
-
-client.chat.field_mapping.field_mappings_destroy(...)
-
--
-
-#### 📝 Description
-
-
--
-
-Deletes Field Mappings for a Linked Account. All data related to this Field Mapping will be deleted and these changes will be reflected after the next scheduled sync. This will cause the next sync for this Linked Account to sync **ALL** data from start.
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from merge import Merge
-
-client = Merge(
- account_token="YOUR_ACCOUNT_TOKEN",
- api_key="YOUR_API_KEY",
-)
-client.chat.field_mapping.field_mappings_destroy(
- field_mapping_id="field_mapping_id",
-)
-
-```
-
-
+**page_size:** `typing.Optional[int]` — Number of results to return per page.
+
-#### ⚙️ Parameters
-
-
-
--
-
-**field_mapping_id:** `str`
+**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
@@ -9852,7 +9439,7 @@ client.chat.field_mapping.field_mappings_destroy(
-client.chat.field_mapping.field_mappings_partial_update(...)
+client.accounting.attachments.create(...)
-
@@ -9864,7 +9451,7 @@ client.chat.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 an `AccountingAttachment` object with the given values.
@@ -9880,13 +9467,14 @@ Create or update existing Field Mappings for a Linked Account. Changes will be r
```python
from merge import Merge
+from merge.resources.accounting import AccountingAttachmentRequest
client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.chat.field_mapping.field_mappings_partial_update(
- field_mapping_id="field_mapping_id",
+client.accounting.attachments.create(
+ model=AccountingAttachmentRequest(),
)
```
@@ -9903,23 +9491,7 @@ client.chat.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.
+**model:** `AccountingAttachmentRequest`
@@ -9927,7 +9499,7 @@ client.chat.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.
+**is_debug_mode:** `typing.Optional[bool]` — Whether to include debug fields (such as log file links) in the response.
@@ -9935,7 +9507,7 @@ client.chat.field_mapping.field_mappings_partial_update(
-
-**jmes_path:** `typing.Optional[str]` — JMES path to specify json query expression to be used on field mapping.
+**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously.
@@ -9955,7 +9527,7 @@ client.chat.field_mapping.field_mappings_partial_update(
-client.chat.field_mapping.remote_fields_retrieve(...)
+client.accounting.attachments.retrieve(...)
-
@@ -9967,7 +9539,7 @@ client.chat.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 an `AccountingAttachment` object with the given `id`.
@@ -9988,9 +9560,8 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.chat.field_mapping.remote_fields_retrieve(
- common_models="common_models",
- include_example_values="include_example_values",
+client.accounting.attachments.retrieve(
+ id="id",
)
```
@@ -10007,7 +9578,7 @@ client.chat.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`
@@ -10015,7 +9586,15 @@ client.chat.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.
+**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).
@@ -10035,7 +9614,7 @@ client.chat.field_mapping.remote_fields_retrieve(
-client.chat.field_mapping.target_fields_retrieve()
+client.accounting.attachments.meta_post_retrieve()
-
@@ -10047,7 +9626,7 @@ client.chat.field_mapping.remote_fields_retrieve(
-
-Get all organization-wide Target Fields, this will not include any Linked Account specific Target Fields. Organization-wide Target Fields are additional fields appended to the Merge Common Model for all Linked Accounts in a category. [Learn more](https://docs.merge.dev/supplemental-data/field-mappings/target-fields/).
+Returns metadata for `AccountingAttachment` POSTs.
@@ -10068,7 +9647,7 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.chat.field_mapping.target_fields_retrieve()
+client.accounting.attachments.meta_post_retrieve()
```
@@ -10096,80 +9675,8 @@ client.chat.field_mapping.target_fields_retrieve()
-## Chat GenerateKey
-client.chat.generate_key.create(...)
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Create a remote key.
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from merge import Merge
-
-client = Merge(
- account_token="YOUR_ACCOUNT_TOKEN",
- api_key="YOUR_API_KEY",
-)
-client.chat.generate_key.create(
- name="Remote Deployment Key 1",
-)
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**name:** `str` — The name of the remote key
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-
-
-## Chat Groups
-client.chat.groups.list(...)
+## Accounting AuditTrail
+client.accounting.audit_trail.list(...)
-
@@ -10181,7 +9688,7 @@ client.chat.generate_key.create(
-
-Returns a list of `Group` objects.
+Gets a list of audit trail events.
@@ -10196,34 +9703,20 @@ Returns a list of `Group` objects.
-
```python
-import datetime
-
from merge import Merge
client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.chat.groups.list(
- created_after=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- created_before=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
+response = client.accounting.audit_trail.list(
cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
- include_deleted_data=True,
- include_remote_data=True,
- include_shell_data=True,
- modified_after=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- modified_before=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- page_size=1,
- remote_id="remote_id",
)
+for item in response:
+ yield item
+# alternatively, you can paginate page-by-page
+for page in response.iter_pages():
+ yield page
```
@@ -10239,22 +9732,6 @@ client.chat.groups.list(
-
-**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
-
-
-
-
-
--
-
-**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
-
-
-
-
-
--
-
**cursor:** `typing.Optional[str]` — The pagination cursor value.
@@ -10263,31 +9740,7 @@ client.chat.groups.list(
-
-**expand:** `typing.Optional[typing.Literal["users"]]` — 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).
+**end_date:** `typing.Optional[str]` — If included, will only include audit trail events that occurred before this time
@@ -10295,7 +9748,7 @@ client.chat.groups.list(
-
-**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
+**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`
@@ -10303,7 +9756,7 @@ client.chat.groups.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.
@@ -10311,7 +9764,7 @@ client.chat.groups.list(
-
-**page_size:** `typing.Optional[int]` — Number of results to return per page. The maximum limit is 100.
+**start_date:** `typing.Optional[str]` — If included, will only include audit trail events that occurred after this time
@@ -10319,7 +9772,7 @@ client.chat.groups.list(
-
-**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
+**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.
@@ -10339,7 +9792,8 @@ client.chat.groups.list(
-client.chat.groups.retrieve(...)
+## Accounting AvailableActions
+client.accounting.available_actions.retrieve()
-
@@ -10351,7 +9805,7 @@ client.chat.groups.list(
-
-Returns a `Group` object with the given `id`.
+Returns a list of models and actions available for an account.
@@ -10372,11 +9826,7 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.chat.groups.retrieve(
- id="id",
- include_remote_data=True,
- include_shell_data=True,
-)
+client.accounting.available_actions.retrieve()
```
@@ -10392,38 +9842,6 @@ client.chat.groups.retrieve(
-
-**id:** `str`
-
-
-
-
-
--
-
-**expand:** `typing.Optional[typing.Literal["users"]]` — 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.
@@ -10436,8 +9854,8 @@ client.chat.groups.retrieve(
-## Chat Issues
-client.chat.issues.list(...)
+## Accounting BalanceSheets
+client.accounting.balance_sheets.list(...)
-
@@ -10449,7 +9867,7 @@ client.chat.groups.retrieve(
-
-Gets all issues for Organization.
+Returns a list of `BalanceSheet` objects.
@@ -10464,39 +9882,20 @@ Gets all issues for Organization.
-
```python
-import datetime
-
from merge import Merge
-from merge.resources.chat.resources.issues import IssuesListRequestStatus
client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.chat.issues.list(
- account_token="account_token",
+response = client.accounting.balance_sheets.list(
cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
- end_date="end_date",
- end_user_organization_name="end_user_organization_name",
- first_incident_time_after=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- first_incident_time_before=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- include_muted="include_muted",
- integration_name="integration_name",
- last_incident_time_after=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- last_incident_time_before=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- linked_account_id="linked_account_id",
- page_size=1,
- start_date="start_date",
- status=IssuesListRequestStatus.ONGOING,
)
+for item in response:
+ yield item
+# alternatively, you can paginate page-by-page
+for page in response.iter_pages():
+ yield page
```
@@ -10512,23 +9911,7 @@ client.chat.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
+**company_id:** `typing.Optional[str]` — If provided, will only return balance sheets for this company.
@@ -10536,7 +9919,7 @@ client.chat.issues.list(
-
-**end_user_organization_name:** `typing.Optional[str]`
+**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
@@ -10544,7 +9927,7 @@ client.chat.issues.list(
-
-**first_incident_time_after:** `typing.Optional[dt.datetime]` — If provided, will only return issues whose first incident time was after this datetime.
+**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
@@ -10552,7 +9935,7 @@ client.chat.issues.list(
-
-**first_incident_time_before:** `typing.Optional[dt.datetime]` — If provided, will only return issues whose first incident time was before this datetime.
+**cursor:** `typing.Optional[str]` — The pagination cursor value.
@@ -10560,7 +9943,12 @@ client.chat.issues.list(
-
-**include_muted:** `typing.Optional[str]` — If true, will include muted issues
+**expand:** `typing.Optional[
+ typing.Union[
+ BalanceSheetsListRequestExpandItem,
+ typing.Sequence[BalanceSheetsListRequestExpandItem],
+ ]
+]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -10568,7 +9956,7 @@ client.chat.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/).
@@ -10576,7 +9964,7 @@ client.chat.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.
@@ -10584,7 +9972,7 @@ client.chat.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_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -10592,7 +9980,7 @@ client.chat.issues.list(
-
-**linked_account_id:** `typing.Optional[str]` — If provided, will only include issues pertaining to the linked account passed in.
+**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
@@ -10600,7 +9988,7 @@ client.chat.issues.list(
-
-**page_size:** `typing.Optional[int]` — Number of results to return per page. The maximum limit is 100.
+**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
@@ -10608,7 +9996,7 @@ client.chat.issues.list(
-
-**start_date:** `typing.Optional[str]` — If included, will only include issues whose most recent action occurred after this time
+**page_size:** `typing.Optional[int]` — Number of results to return per page.
@@ -10616,12 +10004,7 @@ client.chat.issues.list(
-
-**status:** `typing.Optional[IssuesListRequestStatus]`
-
-Status of the issue. Options: ('ONGOING', 'RESOLVED')
-
-* `ONGOING` - ONGOING
-* `RESOLVED` - RESOLVED
+**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
@@ -10641,7 +10024,7 @@ Status of the issue. Options: ('ONGOING', 'RESOLVED')
-client.chat.issues.retrieve(...)
+client.accounting.balance_sheets.retrieve(...)
-
@@ -10653,7 +10036,7 @@ Status of the issue. Options: ('ONGOING', 'RESOLVED')
-
-Get a specific issue.
+Returns a `BalanceSheet` object with the given `id`.
@@ -10674,7 +10057,7 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.chat.issues.retrieve(
+client.accounting.balance_sheets.retrieve(
id="id",
)
@@ -10700,6 +10083,35 @@ client.chat.issues.retrieve(
-
+**expand:** `typing.Optional[
+ typing.Union[
+ BalanceSheetsRetrieveRequestExpandItem,
+ typing.Sequence[BalanceSheetsRetrieveRequestExpandItem],
+ ]
+]` — 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.
@@ -10712,8 +10124,8 @@ client.chat.issues.retrieve(
-## Chat LinkToken
-client.chat.link_token.create(...)
+## Accounting BankFeedAccounts
+client.accounting.bank_feed_accounts.list(...)
-
@@ -10725,7 +10137,7 @@ client.chat.issues.retrieve(
-
-Creates a link token to be used when linking a new end user. The link token expires after single use.
+Returns a list of `BankFeedAccount` objects.
@@ -10741,18 +10153,19 @@ Creates a link token to be used when linking a new end user. The link token expi
```python
from merge import Merge
-from merge.resources.chat import CategoriesEnum
client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.chat.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],
+response = client.accounting.bank_feed_accounts.list(
+ cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
)
+for item in response:
+ yield item
+# alternatively, you can paginate page-by-page
+for page in response.iter_pages():
+ yield page
```
@@ -10768,7 +10181,7 @@ client.chat.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.
@@ -10776,7 +10189,7 @@ client.chat.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/).
@@ -10784,7 +10197,7 @@ client.chat.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.
@@ -10792,7 +10205,7 @@ client.chat.link_token.create(
-
-**categories:** `typing.Sequence[CategoriesEnum]` — The integration categories to show in Merge Link.
+**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -10800,7 +10213,7 @@ client.chat.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/.
+**page_size:** `typing.Optional[int]` — Number of results to return per page.
@@ -10808,67 +10221,71 @@ client.chat.link_token.create(
-
-**link_expiry_mins:** `typing.Optional[int]` — An integer number of minutes between [30, 720 or 10080 if for a Magic Link URL] for how long this token is valid. Defaults to 30.
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
-
--
-**should_create_magic_link_url:** `typing.Optional[bool]` — Whether to generate a Magic Link URL. Defaults to false. For more information on Magic Link, see https://merge.dev/blog/integrations-fast-say-hello-to-magic-link.
-
+
+client.accounting.bank_feed_accounts.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.
-
-
-
+#### 📝 Description
-
-**common_models:** `typing.Optional[typing.Sequence[CommonModelScopesBodyRequest]]` — An array of objects to specify the models and fields that will be disabled for a given Linked Account. Each object uses model_id, enabled_actions, and disabled_fields to specify the model, method, and fields that are scoped for a given Linked Account.
-
-
-
-
-
-**category_common_model_scopes:** `typing.Optional[
- typing.Dict[
- str,
- typing.Optional[
- typing.Sequence[IndividualCommonModelScopeDeserializerRequest]
- ],
- ]
-]` — When creating a Link Token, you can set permissions for Common Models that will apply to the account that is going to be linked. Any model or field not specified in link token payload will default to existing settings.
-
+Creates a `BankFeedAccount` object with the given values.
+
+
+
+#### 🔌 Usage
-
-**language:** `typing.Optional[EndUserDetailsRequestLanguage]`
+
+-
-The following subset of IETF language tags can be used to configure localization.
+```python
+from merge import Merge
+from merge.resources.accounting import BankFeedAccountRequest
-* `en` - en
-* `de` - de
-
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.accounting.bank_feed_accounts.create(
+ model=BankFeedAccountRequest(),
+)
+
+```
+
+
+
+#### ⚙️ Parameters
-
-**are_syncs_disabled:** `typing.Optional[bool]` — The boolean that indicates whether initial, periodic, and force syncs will be disabled.
+
+-
+
+**model:** `BankFeedAccountRequest`
@@ -10876,7 +10293,7 @@ The following subset of IETF language tags can be used to configure localization
-
-**integration_specific_config:** `typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]]` — A JSON object containing integration-specific configuration options.
+**is_debug_mode:** `typing.Optional[bool]` — Whether to include debug fields (such as log file links) in the response.
@@ -10884,11 +10301,7 @@ The following subset of IETF language tags can be used to configure localization
-
-**completed_account_initial_screen:** `typing.Optional[EndUserDetailsRequestCompletedAccountInitialScreen]`
-
-When creating a Link token, you can specifiy the initial screen of Linking Flow for a completed Linked Account.
-
-* `SELECTIVE_SYNC` - SELECTIVE_SYNC
+**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously.
@@ -10908,8 +10321,7 @@ When creating a Link token, you can specifiy the initial screen of Linking Flow
-## Chat LinkedAccounts
-client.chat.linked_accounts.list(...)
+client.accounting.bank_feed_accounts.retrieve(...)
-
@@ -10921,7 +10333,7 @@ When creating a Link token, you can specifiy the initial screen of Linking Flow
-
-List linked accounts for your organization.
+Returns a `BankFeedAccount` object with the given `id`.
@@ -10937,28 +10349,13 @@ List linked accounts for your organization.
```python
from merge import Merge
-from merge.resources.chat.resources.linked_accounts import (
- LinkedAccountsListRequestCategory,
-)
client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.chat.linked_accounts.list(
- category=LinkedAccountsListRequestCategory.ACCOUNTING,
- cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
- end_user_email_address="end_user_email_address",
- end_user_organization_name="end_user_organization_name",
- end_user_origin_id="end_user_origin_id",
- end_user_origin_ids="end_user_origin_ids",
+client.accounting.bank_feed_accounts.retrieve(
id="id",
- ids="ids",
- include_duplicates=True,
- integration_name="integration_name",
- is_test_account="is_test_account",
- page_size=1,
- status="status",
)
```
@@ -10975,19 +10372,7 @@ client.chat.linked_accounts.list(
-
-**category:** `typing.Optional[LinkedAccountsListRequestCategory]`
-
-Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `knowledgebase`, `mktg`, `ticketing`
-
-* `hris` - hris
-* `ats` - ats
-* `accounting` - accounting
-* `ticketing` - ticketing
-* `crm` - crm
-* `mktg` - mktg
-* `filestorage` - filestorage
-* `knowledgebase` - knowledgebase
-* `chat` - chat
+**id:** `str`
@@ -10995,7 +10380,7 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `knowledgebase`, `mk
-
-**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.
@@ -11003,7 +10388,7 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `knowledgebase`, `mk
-
-**end_user_email_address:** `typing.Optional[str]` — If provided, will only return linked accounts associated with the given email address.
+**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -11011,83 +10396,64 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `knowledgebase`, `mk
-
-**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.
-
-
--
-
-**end_user_origin_id:** `typing.Optional[str]` — If provided, will only return linked accounts associated with the given origin ID.
-
-
--
-**end_user_origin_ids:** `typing.Optional[str]` — Comma-separated list of EndUser origin IDs, making it possible to specify multiple EndUsers at once.
-
+
+client.accounting.bank_feed_accounts.meta_post_retrieve()
-
-**id:** `typing.Optional[str]`
-
-
-
+#### 📝 Description
-
-**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.
-
+Returns metadata for `BankFeedAccount` POSTs.
-
-
--
-
-**integration_name:** `typing.Optional[str]` — If provided, will only return linked accounts associated with the given integration name.
-
+#### 🔌 Usage
+
-
-**is_test_account:** `typing.Optional[str]` — If included, will only include test linked accounts. If not included, will only include non-test linked accounts.
-
-
-
-
-
-**page_size:** `typing.Optional[int]` — Number of results to return per page. The maximum limit is 100.
-
+```python
+from merge import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.accounting.bank_feed_accounts.meta_post_retrieve()
+
+```
+
+
+#### ⚙️ Parameters
+
-
-**status:** `typing.Optional[str]` — Filter by status. Options: `COMPLETE`, `IDLE`, `INCOMPLETE`, `RELINK_NEEDED`
-
-
-
-
-
@@ -11103,8 +10469,8 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `knowledgebase`, `mk
-## Chat Messages
-client.chat.messages.list(...)
+## Accounting BankFeedTransactions
+client.accounting.bank_feed_transactions.list(...)
-
@@ -11116,7 +10482,7 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `knowledgebase`, `mk
-
-Returns a list of `Message` objects.
+Returns a list of `BankFeedTransaction` objects.
@@ -11131,38 +10497,20 @@ Returns a list of `Message` objects.
-
```python
-import datetime
-
from merge import Merge
-from merge.resources.chat.resources.messages import MessagesListRequestOrderBy
client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.chat.messages.list(
- conversation_id="conversation_id",
- created_after=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- created_before=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
+response = client.accounting.bank_feed_transactions.list(
cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
- include_deleted_data=True,
- include_remote_data=True,
- include_shell_data=True,
- modified_after=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- modified_before=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- order_by=MessagesListRequestOrderBy.REMOTE_CREATED_AT_DESCENDING,
- page_size=1,
- remote_id="remote_id",
- root_message="root_message",
)
+for item in response:
+ yield item
+# alternatively, you can paginate page-by-page
+for page in response.iter_pages():
+ yield page
```
@@ -11178,7 +10526,7 @@ client.chat.messages.list(
-
-**conversation_id:** `typing.Optional[str]` — Filter messages by conversation ID.
+**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
@@ -11186,7 +10534,7 @@ client.chat.messages.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.
@@ -11194,7 +10542,7 @@ client.chat.messages.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.
@@ -11202,7 +10550,12 @@ client.chat.messages.list(
-
-**cursor:** `typing.Optional[str]` — The pagination cursor value.
+**expand:** `typing.Optional[
+ typing.Union[
+ BankFeedTransactionsListRequestExpandItem,
+ typing.Sequence[BankFeedTransactionsListRequestExpandItem],
+ ]
+]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -11234,7 +10587,7 @@ client.chat.messages.list(
-
-**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
+**is_processed:** `typing.Optional[bool]` — If provided, will only return bank feed transactions with this is_processed value
@@ -11242,7 +10595,7 @@ client.chat.messages.list(
-
-**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
+**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
@@ -11250,7 +10603,7 @@ client.chat.messages.list(
-
-**order_by:** `typing.Optional[MessagesListRequestOrderBy]` — Overrides the default ordering for this endpoint. Possible values include: remote_created_at, -remote_created_at.
+**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
@@ -11258,7 +10611,7 @@ client.chat.messages.list(
-
-**page_size:** `typing.Optional[int]` — Number of results to return per page. The maximum limit is 100.
+**page_size:** `typing.Optional[int]` — Number of results to return per page.
@@ -11274,14 +10627,6 @@ client.chat.messages.list(
-
-**root_message:** `typing.Optional[str]` — If provided as 'true', will only return root messages (messages without a parent message).
-
-
-
-
-
--
-
**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -11294,7 +10639,7 @@ client.chat.messages.list(
-client.chat.messages.retrieve(...)
+client.accounting.bank_feed_transactions.create(...)
-
@@ -11306,7 +10651,7 @@ client.chat.messages.list(
-
-Returns a `Message` object with the given `id`.
+Creates a `BankFeedTransaction` object with the given values.
@@ -11322,15 +10667,14 @@ Returns a `Message` object with the given `id`.
```python
from merge import Merge
+from merge.resources.accounting import BankFeedTransactionRequestRequest
client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.chat.messages.retrieve(
- id="id",
- include_remote_data=True,
- include_shell_data=True,
+client.accounting.bank_feed_transactions.create(
+ model=BankFeedTransactionRequestRequest(),
)
```
@@ -11347,7 +10691,7 @@ client.chat.messages.retrieve(
-
-**id:** `str`
+**model:** `BankFeedTransactionRequestRequest`
@@ -11355,7 +10699,7 @@ client.chat.messages.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.
@@ -11363,7 +10707,7 @@ client.chat.messages.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.
@@ -11383,7 +10727,7 @@ client.chat.messages.retrieve(
-client.chat.messages.replies_list(...)
+client.accounting.bank_feed_transactions.retrieve(...)
-
@@ -11395,7 +10739,7 @@ client.chat.messages.retrieve(
-
-Returns a list of `Message` objects.
+Returns a `BankFeedTransaction` object with the given `id`.
@@ -11411,22 +10755,13 @@ Returns a list of `Message` objects.
```python
from merge import Merge
-from merge.resources.chat.resources.messages import (
- MessagesRepliesListRequestOrderBy,
-)
client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.chat.messages.replies_list(
- message_id="message_id",
- cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
- include_deleted_data=True,
- include_remote_data=True,
- include_shell_data=True,
- order_by=MessagesRepliesListRequestOrderBy.REMOTE_CREATED_AT_DESCENDING,
- page_size=1,
+client.accounting.bank_feed_transactions.retrieve(
+ id="id",
)
```
@@ -11443,7 +10778,7 @@ client.chat.messages.replies_list(
-
-**message_id:** `str`
+**id:** `str`
@@ -11451,7 +10786,12 @@ client.chat.messages.replies_list(
-
-**cursor:** `typing.Optional[str]` — The pagination cursor value.
+**expand:** `typing.Optional[
+ typing.Union[
+ BankFeedTransactionsRetrieveRequestExpandItem,
+ typing.Sequence[BankFeedTransactionsRetrieveRequestExpandItem],
+ ]
+]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -11459,7 +10799,7 @@ client.chat.messages.replies_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.
@@ -11467,7 +10807,7 @@ client.chat.messages.replies_list(
-
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
+**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -11475,27 +10815,64 @@ client.chat.messages.replies_list(
-
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+client.accounting.bank_feed_transactions.meta_post_retrieve()
-
-**order_by:** `typing.Optional[MessagesRepliesListRequestOrderBy]` — Overrides the default ordering for this endpoint. Possible values include: remote_created_at, -remote_created_at.
-
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns metadata for `BankFeedTransaction` POSTs.
+
+
+#### 🔌 Usage
+
-
-**page_size:** `typing.Optional[int]` — Number of results to return per page. The maximum limit is 100.
-
+
+-
+
+```python
+from merge import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.accounting.bank_feed_transactions.meta_post_retrieve()
+
+```
+
+
+#### ⚙️ Parameters
+
+
+-
+
-
@@ -11511,8 +10888,8 @@ client.chat.messages.replies_list(
-## Chat Passthrough
-client.chat.passthrough.create(...)
+## Accounting CashFlowStatements
+client.accounting.cash_flow_statements.list(...)
-
@@ -11524,7 +10901,7 @@ client.chat.messages.replies_list(
-
-Pull data from an endpoint not currently supported by Merge.
+Returns a list of `CashFlowStatement` objects.
@@ -11540,18 +10917,19 @@ Pull data from an endpoint not currently supported by Merge.
```python
from merge import Merge
-from merge.resources.chat import DataPassthroughRequest, MethodEnum
client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.chat.passthrough.create(
- request=DataPassthroughRequest(
- method=MethodEnum.GET,
- path="/scooters",
- ),
+response = client.accounting.cash_flow_statements.list(
+ cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
)
+for item in response:
+ yield item
+# alternatively, you can paginate page-by-page
+for page in response.iter_pages():
+ yield page
```
@@ -11567,7 +10945,7 @@ client.chat.passthrough.create(
-
-**request:** `DataPassthroughRequest`
+**company_id:** `typing.Optional[str]` — If provided, will only return cash flow statements for this company.
@@ -11575,71 +10953,92 @@ client.chat.passthrough.create(
-
-**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.
+
-
-## Chat RegenerateKey
-client.chat.regenerate_key.create(...)
-
-#### 📝 Description
+**cursor:** `typing.Optional[str]` — The pagination cursor value.
+
+
+
-
+**expand:** `typing.Optional[
+ typing.Union[
+ CashFlowStatementsListRequestExpandItem,
+ typing.Sequence[CashFlowStatementsListRequestExpandItem],
+ ]
+]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+
+
+
+
-
-Exchange remote keys.
-
-
+**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
+
-#### 🔌 Usage
-
-
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
+
+
+
+
-
-```python
-from merge import Merge
+**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
+
+
+
-client = Merge(
- account_token="YOUR_ACCOUNT_TOKEN",
- api_key="YOUR_API_KEY",
-)
-client.chat.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.
+
+
+
+
-
-**name:** `str` — The name of the remote key
+**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
@@ -11659,8 +11058,7 @@ client.chat.regenerate_key.create(
-## Chat SyncStatus
-client.chat.sync_status.list(...)
+client.accounting.cash_flow_statements.retrieve(...)
-
@@ -11672,7 +11070,7 @@ client.chat.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 `CashFlowStatement` object with the given `id`.
@@ -11693,9 +11091,8 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.chat.sync_status.list(
- cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
- page_size=1,
+client.accounting.cash_flow_statements.retrieve(
+ id="id",
)
```
@@ -11712,7 +11109,20 @@ client.chat.sync_status.list(
-
-**cursor:** `typing.Optional[str]` — The pagination cursor value.
+**id:** `str`
+
+
+
+
+
+-
+
+**expand:** `typing.Optional[
+ typing.Union[
+ CashFlowStatementsRetrieveRequestExpandItem,
+ typing.Sequence[CashFlowStatementsRetrieveRequestExpandItem],
+ ]
+]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -11720,7 +11130,15 @@ client.chat.sync_status.list(
-
-**page_size:** `typing.Optional[int]` — Number of results to return per page. The maximum limit is 100.
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
+
+
+
+
+
+-
+
+**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -11740,8 +11158,8 @@ client.chat.sync_status.list(
-## Chat ForceResync
-client.chat.force_resync.sync_status_resync_create()
+## Accounting CompanyInfo
+client.accounting.company_info.list(...)
-
@@ -11753,7 +11171,7 @@ client.chat.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 list of `CompanyInfo` objects.
@@ -11774,7 +11192,14 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.chat.force_resync.sync_status_resync_create()
+response = client.accounting.company_info.list(
+ cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
+)
+for item in response:
+ yield item
+# alternatively, you can paginate page-by-page
+for page in response.iter_pages():
+ yield page
```
@@ -11790,114 +11215,163 @@ client.chat.force_resync.sync_status_resync_create()
-
-**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.
+
+
+-
+**cursor:** `typing.Optional[str]` — The pagination cursor value.
+
-
-## Chat Users
-client.chat.users.list(...)
-
-#### 📝 Description
+**expand:** `typing.Optional[
+ typing.Union[
+ CompanyInfoListRequestExpandItem,
+ typing.Sequence[CompanyInfoListRequestExpandItem],
+ ]
+]` — 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 `User` objects.
+**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
+
+-
+
+**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
-import datetime
+**page_size:** `typing.Optional[int]` — Number of results to return per page.
+
+
+
-from merge import Merge
+
+-
-client = Merge(
- account_token="YOUR_ACCOUNT_TOKEN",
- api_key="YOUR_API_KEY",
-)
-client.chat.users.list(
- created_after=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- created_before=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
- include_deleted_data=True,
- include_remote_data=True,
- include_shell_data=True,
- modified_after=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- modified_before=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- page_size=1,
- remote_id="remote_id",
-)
+**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
+
+
+
-```
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
-#### ⚙️ Parameters
+
+
+
+
+client.accounting.company_info.retrieve(...)
-
+#### 📝 Description
+
-
-**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
-
-
-
-
-
-**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
-
+Returns a `CompanyInfo` object with the given `id`.
+
+
+#### 🔌 Usage
+
-
-**cursor:** `typing.Optional[str]` — The pagination cursor value.
-
+
+-
+
+```python
+from merge import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.accounting.company_info.retrieve(
+ id="id",
+)
+
+```
+
+
+
+#### ⚙️ Parameters
-
-**expand:** `typing.Optional[typing.Literal["groups"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+
+-
+
+**id:** `str`
@@ -11905,7 +11379,12 @@ client.chat.users.list(
-
-**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
+**expand:** `typing.Optional[
+ typing.Union[
+ CompanyInfoRetrieveRequestExpandItem,
+ typing.Sequence[CompanyInfoRetrieveRequestExpandItem],
+ ]
+]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -11929,38 +11408,6 @@ client.chat.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.
-
-
-
-
-
--
-
-**page_size:** `typing.Optional[int]` — Number of results to return per page. The maximum limit is 100.
-
-
-
-
-
--
-
-**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
-
-
-
-
-
--
-
**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -11973,7 +11420,8 @@ client.chat.users.list(
-client.chat.users.retrieve(...)
+## Accounting Contacts
+client.accounting.contacts.list(...)
-
@@ -11985,7 +11433,7 @@ client.chat.users.list(
-
-Returns a `User` object with the given `id`.
+Returns a list of `Contact` objects.
@@ -12006,11 +11454,14 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.chat.users.retrieve(
- id="id",
- include_remote_data=True,
- include_shell_data=True,
+response = client.accounting.contacts.list(
+ cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
)
+for item in response:
+ yield item
+# alternatively, you can paginate page-by-page
+for page in response.iter_pages():
+ yield page
```
@@ -12026,7 +11477,7 @@ client.chat.users.retrieve(
-
-**id:** `str`
+**company_id:** `typing.Optional[str]` — If provided, will only return contacts for this company.
@@ -12034,7 +11485,7 @@ client.chat.users.retrieve(
-
-**expand:** `typing.Optional[typing.Literal["groups"]]` — 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.
@@ -12042,7 +11493,7 @@ client.chat.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.
@@ -12050,7 +11501,7 @@ client.chat.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.
@@ -12058,65 +11509,136 @@ client.chat.users.retrieve(
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+**email_address:** `typing.Optional[str]` — If provided, will only return Contacts that match this email.
+
+
+-
+
+**expand:** `typing.Optional[
+ typing.Union[
+ ContactsListRequestExpandItem,
+ typing.Sequence[ContactsListRequestExpandItem],
+ ]
+]` — 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/).
+
-
-## Chat WebhookReceivers
-client.chat.webhook_receivers.list()
-
-#### 📝 Description
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
+
+
+
-
+**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.
+
+
+
+
-
-Returns a list of `WebhookReceiver` objects.
+**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
+
+
+
+-
+
+**is_customer:** `typing.Optional[str]` — If provided, will only return Contacts that are denoted as customers.
+
-#### 🔌 Usage
+
+-
+
+**is_supplier:** `typing.Optional[str]` — If provided, will only return Contacts that are denoted as suppliers.
+
+
+
-
+**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
+**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
+
+
+
-client = Merge(
- account_token="YOUR_ACCOUNT_TOKEN",
- api_key="YOUR_API_KEY",
-)
-client.chat.webhook_receivers.list()
+
+-
-```
+**name:** `typing.Optional[str]` — If provided, will only return Contacts that match this name.
+
+
+
+
+
+-
+
+**page_size:** `typing.Optional[int]` — Number of results to return per page.
+
+
+
+-
+
+**remote_fields:** `typing.Optional[ContactsListRequestRemoteFields]` — 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[ContactsListRequestShowEnumOrigins]` — 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[ContactsListRequestStatus]` — If provided, will only return Contacts that match this status.
+
+
+
+
-
@@ -12132,7 +11654,7 @@ client.chat.webhook_receivers.list()
-client.chat.webhook_receivers.create(...)
+client.accounting.contacts.create(...)
-
@@ -12144,7 +11666,7 @@ client.chat.webhook_receivers.list()
-
-Creates a `WebhookReceiver` object with the given values.
+Creates a `Contact` object with the given values.
@@ -12160,14 +11682,14 @@ Creates a `WebhookReceiver` object with the given values.
```python
from merge import Merge
+from merge.resources.accounting import ContactRequest
client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.chat.webhook_receivers.create(
- event="event",
- is_active=True,
+client.accounting.contacts.create(
+ model=ContactRequest(),
)
```
@@ -12184,7 +11706,7 @@ client.chat.webhook_receivers.create(
-
-**event:** `str`
+**model:** `ContactRequest`
@@ -12192,7 +11714,7 @@ client.chat.webhook_receivers.create(
-
-**is_active:** `bool`
+**is_debug_mode:** `typing.Optional[bool]` — Whether to include debug fields (such as log file links) in the response.
@@ -12200,7 +11722,7 @@ client.chat.webhook_receivers.create(
-
-**key:** `typing.Optional[str]`
+**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously.
@@ -12220,8 +11742,7 @@ client.chat.webhook_receivers.create(
-## Filestorage AccountDetails
-client.filestorage.account_details.retrieve()
+client.accounting.contacts.retrieve(...)
-
@@ -12233,7 +11754,7 @@ client.chat.webhook_receivers.create(
-
-Get details for a linked account.
+Returns a `Contact` object with the given `id`.
@@ -12254,7 +11775,9 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.filestorage.account_details.retrieve()
+client.accounting.contacts.retrieve(
+ id="id",
+)
```
@@ -12270,71 +11793,60 @@ client.filestorage.account_details.retrieve()
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+**id:** `str`
-
-
+
+-
+**expand:** `typing.Optional[
+ typing.Union[
+ ContactsRetrieveRequestExpandItem,
+ typing.Sequence[ContactsRetrieveRequestExpandItem],
+ ]
+]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+
-
-## Filestorage AccountToken
-client.filestorage.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
-
-
-
--
-
-```python
-from merge import Merge
-
-client = Merge(
- account_token="YOUR_ACCOUNT_TOKEN",
- api_key="YOUR_API_KEY",
-)
-client.filestorage.account_token.retrieve(
- public_token="public_token",
-)
-
-```
-
-
+**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
+
-#### ⚙️ Parameters
-
-
+**remote_fields:** `typing.Optional[ContactsRetrieveRequestRemoteFields]` — Deprecated. Use show_enum_origins.
+
+
+
+
-
-**public_token:** `str`
+**show_enum_origins:** `typing.Optional[ContactsRetrieveRequestShowEnumOrigins]` — 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)
@@ -12354,8 +11866,7 @@ client.filestorage.account_token.retrieve(
-## Filestorage AsyncPassthrough
-client.filestorage.async_passthrough.create(...)
+client.accounting.contacts.meta_post_retrieve()
-
@@ -12367,7 +11878,7 @@ client.filestorage.account_token.retrieve(
-
-Asynchronously pull data from an endpoint not currently supported by Merge.
+Returns metadata for `Contact` POSTs.
@@ -12383,18 +11894,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.accounting.contacts.meta_post_retrieve()
```
@@ -12410,14 +11915,6 @@ client.filestorage.async_passthrough.create(
-
-**request:** `DataPassthroughRequest`
-
-
-
-
-
--
-
**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -12430,7 +11927,7 @@ client.filestorage.async_passthrough.create(
-client.filestorage.async_passthrough.retrieve(...)
+client.accounting.contacts.remote_field_classes_list(...)
-
@@ -12442,7 +11939,7 @@ client.filestorage.async_passthrough.create(
-
-Retrieves data from earlier async-passthrough POST request
+Returns a list of `RemoteFieldClass` objects.
@@ -12463,9 +11960,14 @@ 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",
+response = client.accounting.contacts.remote_field_classes_list(
+ cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
)
+for item in response:
+ yield item
+# alternatively, you can paginate page-by-page
+for page in response.iter_pages():
+ yield page
```
@@ -12481,7 +11983,55 @@ client.filestorage.async_passthrough.retrieve(
-
-**async_passthrough_receipt_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/).
+
+
+
+
+
+-
+
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
+
+
+
+
+
+-
+
+**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
+
+
+
+
+
+-
+
+**is_common_model_field:** `typing.Optional[bool]` — If provided, will only return remote field classes with this is_common_model_field value
+
+
+
+
+
+-
+
+**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.
@@ -12501,8 +12051,8 @@ client.filestorage.async_passthrough.retrieve(
-## Filestorage AuditTrail
-client.filestorage.audit_trail.list(...)
+## Accounting CreditNotes
+client.accounting.credit_notes.list(...)
-
@@ -12514,7 +12064,7 @@ client.filestorage.async_passthrough.retrieve(
-
-Gets a list of audit trail events.
+Returns a list of `CreditNote` objects.
@@ -12535,14 +12085,14 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.filestorage.audit_trail.list(
+response = client.accounting.credit_notes.list(
cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
- end_date="end_date",
- event_type="event_type",
- page_size=1,
- start_date="start_date",
- user_email="user_email",
)
+for item in response:
+ yield item
+# alternatively, you can paginate page-by-page
+for page in response.iter_pages():
+ yield page
```
@@ -12558,7 +12108,7 @@ client.filestorage.audit_trail.list(
-
-**cursor:** `typing.Optional[str]` — The pagination cursor value.
+**company_id:** `typing.Optional[str]` — If provided, will only return credit notes for this company.
@@ -12566,7 +12116,7 @@ client.filestorage.audit_trail.list(
-
-**end_date:** `typing.Optional[str]` — If included, will only include audit trail events that occurred before this time
+**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
@@ -12574,7 +12124,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`
+**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
@@ -12582,7 +12132,7 @@ client.filestorage.audit_trail.list(
-
-**page_size:** `typing.Optional[int]` — Number of results to return per page.
+**cursor:** `typing.Optional[str]` — The pagination cursor value.
@@ -12590,7 +12140,12 @@ client.filestorage.audit_trail.list(
-
-**start_date:** `typing.Optional[str]` — If included, will only include audit trail events that occurred after this time
+**expand:** `typing.Optional[
+ typing.Union[
+ CreditNotesListRequestExpandItem,
+ typing.Sequence[CreditNotesListRequestExpandItem],
+ ]
+]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -12598,7 +12153,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_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
@@ -12606,65 +12161,83 @@ client.filestorage.audit_trail.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_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
+
-
-## Filestorage AvailableActions
-client.filestorage.available_actions.retrieve()
-
-#### 📝 Description
+**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
+
+
+
-
+**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
+
+
+
+
-
-Returns a list of models and actions available for an account.
-
-
+**page_size:** `typing.Optional[int]` — Number of results to return per page.
+
-#### 🔌 Usage
-
-
+**remote_fields:** `typing.Optional[CreditNotesListRequestRemoteFields]` — Deprecated. Use show_enum_origins.
+
+
+
+
-
-```python
-from merge import Merge
+**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
+
+
+
-client = Merge(
- account_token="YOUR_ACCOUNT_TOKEN",
- api_key="YOUR_API_KEY",
-)
-client.filestorage.available_actions.retrieve()
+
+-
-```
+**show_enum_origins:** `typing.Optional[CreditNotesListRequestShowEnumOrigins]` — 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)
+
+
+
+-
+
+**transaction_date_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
+
-#### ⚙️ Parameters
-
-
+**transaction_date_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
+
+
+
+
-
@@ -12680,8 +12253,7 @@ client.filestorage.available_actions.retrieve()
-## Filestorage Scopes
-client.filestorage.scopes.default_scopes_retrieve()
+client.accounting.credit_notes.create(...)
-
@@ -12693,7 +12265,7 @@ client.filestorage.available_actions.retrieve()
-
-Get the default permissions for Merge Common Models and fields across all Linked Accounts of a given category. [Learn more](https://help.merge.dev/en/articles/5950052-common-model-and-field-scopes).
+Creates a `CreditNote` object with the given values.
@@ -12709,12 +12281,15 @@ Get the default permissions for Merge Common Models and fields across all Linked
```python
from merge import Merge
+from merge.resources.accounting import CreditNoteRequest
client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.filestorage.scopes.default_scopes_retrieve()
+client.accounting.credit_notes.create(
+ model=CreditNoteRequest(),
+)
```
@@ -12730,6 +12305,30 @@ client.filestorage.scopes.default_scopes_retrieve()
-
+**model:** `CreditNoteRequest`
+
+
+
+
+
+-
+
+**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.
@@ -12742,7 +12341,7 @@ client.filestorage.scopes.default_scopes_retrieve()
-client.filestorage.scopes.linked_account_scopes_retrieve()
+client.accounting.credit_notes.retrieve(...)
-
@@ -12754,7 +12353,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 a `CreditNote` object with the given `id`.
@@ -12775,7 +12374,9 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.filestorage.scopes.linked_account_scopes_retrieve()
+client.accounting.credit_notes.retrieve(
+ id="id",
+)
```
@@ -12791,99 +12392,52 @@ client.filestorage.scopes.linked_account_scopes_retrieve()
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+**id:** `str`
-
-
+
+-
+**expand:** `typing.Optional[
+ typing.Union[
+ CreditNotesRetrieveRequestExpandItem,
+ typing.Sequence[CreditNotesRetrieveRequestExpandItem],
+ ]
+]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+
-
-client.filestorage.scopes.linked_account_scopes_create(...)
-
-#### 📝 Description
-
-
--
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
+
+
+
-
-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)
-
-
+**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
+
-#### 🔌 Usage
-
-
-
--
-
-```python
-from merge import Merge
-from merge.resources.filestorage import (
- FieldPermissionDeserializerRequest,
- IndividualCommonModelScopeDeserializerRequest,
- ModelPermissionDeserializerRequest,
-)
-
-client = Merge(
- account_token="YOUR_ACCOUNT_TOKEN",
- api_key="YOUR_API_KEY",
-)
-client.filestorage.scopes.linked_account_scopes_create(
- common_models=[
- IndividualCommonModelScopeDeserializerRequest(
- model_name="Employee",
- model_permissions={
- "READ": ModelPermissionDeserializerRequest(
- is_enabled=True,
- ),
- "WRITE": ModelPermissionDeserializerRequest(
- is_enabled=False,
- ),
- },
- field_permissions=FieldPermissionDeserializerRequest(
- enabled_fields=["avatar", "home_location"],
- disabled_fields=["work_location"],
- ),
- ),
- IndividualCommonModelScopeDeserializerRequest(
- model_name="Benefit",
- model_permissions={
- "WRITE": ModelPermissionDeserializerRequest(
- is_enabled=False,
- )
- },
- ),
- ],
-)
-
-```
-
-
+**remote_fields:** `typing.Optional[CreditNotesRetrieveRequestRemoteFields]` — Deprecated. Use show_enum_origins.
+
-#### ⚙️ Parameters
-
-
--
-
-
-**common_models:** `typing.Sequence[IndividualCommonModelScopeDeserializerRequest]` — The common models you want to update the scopes for
+**show_enum_origins:** `typing.Optional[CreditNotesRetrieveRequestShowEnumOrigins]` — 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)
@@ -12903,8 +12457,7 @@ client.filestorage.scopes.linked_account_scopes_create(
-## Filestorage DeleteAccount
-client.filestorage.delete_account.delete()
+client.accounting.credit_notes.meta_post_retrieve()
-
@@ -12916,7 +12469,7 @@ client.filestorage.scopes.linked_account_scopes_create(
-
-Delete a linked account.
+Returns metadata for `CreditNote` POSTs.
@@ -12937,7 +12490,7 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.filestorage.delete_account.delete()
+client.accounting.credit_notes.meta_post_retrieve()
```
@@ -12965,8 +12518,8 @@ client.filestorage.delete_account.delete()
-## Filestorage Drives
-client.filestorage.drives.list(...)
+## Accounting Scopes
+client.accounting.scopes.default_scopes_retrieve()
-
@@ -12978,7 +12531,7 @@ client.filestorage.delete_account.delete()
-
-Returns a list of `Drive` objects.
+Get the default permissions for Merge Common Models and fields across all Linked Accounts of a given category. [Learn more](https://help.merge.dev/en/articles/5950052-common-model-and-field-scopes).
@@ -12993,35 +12546,13 @@ Returns a list of `Drive` objects.
-
```python
-import datetime
-
from merge import Merge
client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.filestorage.drives.list(
- created_after=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- created_before=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
- include_deleted_data=True,
- include_remote_data=True,
- include_shell_data=True,
- modified_after=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- modified_before=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- name="name",
- page_size=1,
- remote_id="remote_id",
-)
+client.accounting.scopes.default_scopes_retrieve()
```
@@ -13037,91 +12568,64 @@ client.filestorage.drives.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.
-
+
+client.accounting.scopes.linked_account_scopes_retrieve()
-
-**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
-
-
-
+#### 📝 Description
-
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
-
-
-
-
-
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
-
+Get 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).
-
-
--
-
-**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 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.accounting.scopes.linked_account_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.
-
-
-
-
-
@@ -13137,7 +12641,7 @@ client.filestorage.drives.list(
-client.filestorage.drives.retrieve(...)
+client.accounting.scopes.linked_account_scopes_create(...)
-
@@ -13149,7 +12653,7 @@ client.filestorage.drives.list(
-
-Returns a `Drive` object with the given `id`.
+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)
@@ -13165,15 +12669,42 @@ Returns a `Drive` object with the given `id`.
```python
from merge import Merge
+from merge.resources.accounting import (
+ FieldPermissionDeserializerRequest,
+ IndividualCommonModelScopeDeserializerRequest,
+ ModelPermissionDeserializerRequest,
+)
client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.filestorage.drives.retrieve(
- id="id",
- include_remote_data=True,
- include_shell_data=True,
+client.accounting.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,
+ )
+ },
+ ),
+ ],
)
```
@@ -13190,23 +12721,7 @@ client.filestorage.drives.retrieve(
-
-**id:** `str`
-
-
-
-
-
--
-
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
-
-
-
-
-
--
-
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
+**common_models:** `typing.Sequence[IndividualCommonModelScopeDeserializerRequest]` — The common models you want to update the scopes for
@@ -13226,8 +12741,8 @@ client.filestorage.drives.retrieve(
-## Filestorage FieldMapping
-client.filestorage.field_mapping.field_mappings_retrieve(...)
+## Accounting DeleteAccount
+client.accounting.delete_account.delete()
-
@@ -13239,7 +12754,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/).
+Delete a linked account.
@@ -13260,9 +12775,7 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.filestorage.field_mapping.field_mappings_retrieve(
- exclude_remote_field_metadata=True,
-)
+client.accounting.delete_account.delete()
```
@@ -13278,14 +12791,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.
@@ -13298,7 +12803,8 @@ client.filestorage.field_mapping.field_mappings_retrieve(
-client.filestorage.field_mapping.field_mappings_create(...)
+## Accounting Employees
+client.accounting.employees.list(...)
-
@@ -13310,7 +12816,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 `Employee` objects.
@@ -13331,15 +12837,14 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.filestorage.field_mapping.field_mappings_create(
- exclude_remote_field_metadata=True,
- target_field_name="example_target_field_name",
- target_field_description="this is a example description of the target field",
- remote_field_traversal_path=["example_remote_field"],
- remote_method="GET",
- remote_url_path="/example-url-path",
- common_model_name="ExampleCommonModel",
+response = client.accounting.employees.list(
+ cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
)
+for item in response:
+ yield item
+# alternatively, you can paginate page-by-page
+for page in response.iter_pages():
+ yield page
```
@@ -13355,15 +12860,7 @@ client.filestorage.field_mapping.field_mappings_create(
-
-**target_field_name:** `str` — The name of the target field you want this remote field to map to.
-
-
-
-
-
--
-
-**target_field_description:** `str` — The description of the target field you want this remote field to map to.
+**cursor:** `typing.Optional[str]` — The pagination cursor value.
@@ -13371,7 +12868,12 @@ 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.
+**expand:** `typing.Optional[
+ typing.Union[
+ EmployeesListRequestExpandItem,
+ typing.Sequence[EmployeesListRequestExpandItem],
+ ]
+]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -13379,7 +12881,7 @@ client.filestorage.field_mapping.field_mappings_create(
-
-**remote_method:** `str` — The method of the remote endpoint where the remote field is coming from.
+**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
@@ -13387,7 +12889,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.
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -13395,7 +12897,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.
+**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -13403,7 +12905,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.
+**page_size:** `typing.Optional[int]` — Number of results to return per page.
@@ -13423,7 +12925,7 @@ client.filestorage.field_mapping.field_mappings_create(
-client.filestorage.field_mapping.field_mappings_destroy(...)
+client.accounting.employees.retrieve(...)
-
@@ -13435,7 +12937,7 @@ client.filestorage.field_mapping.field_mappings_create(
-
-Deletes Field Mappings for a Linked Account. All data related to this Field Mapping will be deleted and these changes will be reflected after the next scheduled sync. This will cause the next sync for this Linked Account to sync **ALL** data from start.
+Returns an `Employee` object with the given `id`.
@@ -13456,8 +12958,8 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.filestorage.field_mapping.field_mappings_destroy(
- field_mapping_id="field_mapping_id",
+client.accounting.employees.retrieve(
+ id="id",
)
```
@@ -13474,7 +12976,36 @@ client.filestorage.field_mapping.field_mappings_destroy(
-
-**field_mapping_id:** `str`
+**id:** `str`
+
+
+
+
+
+-
+
+**expand:** `typing.Optional[
+ typing.Union[
+ EmployeesRetrieveRequestExpandItem,
+ typing.Sequence[EmployeesRetrieveRequestExpandItem],
+ ]
+]` — 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).
@@ -13494,7 +13025,8 @@ client.filestorage.field_mapping.field_mappings_destroy(
-client.filestorage.field_mapping.field_mappings_partial_update(...)
+## Accounting Expenses
+client.accounting.expenses.list(...)
-
@@ -13506,7 +13038,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.
+Returns a list of `Expense` objects.
@@ -13527,9 +13059,14 @@ 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",
+response = client.accounting.expenses.list(
+ cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
)
+for item in response:
+ yield item
+# alternatively, you can paginate page-by-page
+for page in response.iter_pages():
+ yield page
```
@@ -13545,7 +13082,7 @@ client.filestorage.field_mapping.field_mappings_partial_update(
-
-**field_mapping_id:** `str`
+**company_id:** `typing.Optional[str]` — If provided, will only return expenses for this company.
@@ -13553,7 +13090,7 @@ client.filestorage.field_mapping.field_mappings_partial_update(
-
-**remote_field_traversal_path:** `typing.Optional[typing.Sequence[typing.Optional[typing.Any]]]` — The field traversal path of the remote field listed when you hit the GET /remote-fields endpoint.
+**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
@@ -13561,7 +13098,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.
+**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
@@ -13569,7 +13106,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.
+**cursor:** `typing.Optional[str]` — The pagination cursor value.
@@ -13577,71 +13114,84 @@ client.filestorage.field_mapping.field_mappings_partial_update(
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+**expand:** `typing.Optional[
+ typing.Union[
+ ExpensesListRequestExpandItem,
+ typing.Sequence[ExpensesListRequestExpandItem],
+ ]
+]` — 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(...)
-
-#### 📝 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 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/).
-
-
+**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
+
-#### 🔌 Usage
-
-
+**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
+
+
+
+
-
-```python
-from merge import Merge
-
-client = Merge(
- account_token="YOUR_ACCOUNT_TOKEN",
- api_key="YOUR_API_KEY",
-)
-client.filestorage.field_mapping.remote_fields_retrieve(
- common_models="common_models",
- include_example_values="include_example_values",
-)
-
-```
+**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.
+
+
+
+
-
-**common_models:** `typing.Optional[str]` — A comma seperated list of Common Model names. If included, will only return Remote Fields for those Common Models.
+**transaction_date_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
@@ -13649,7 +13199,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.
+**transaction_date_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
@@ -13669,7 +13219,7 @@ client.filestorage.field_mapping.remote_fields_retrieve(
-client.filestorage.field_mapping.target_fields_retrieve()
+client.accounting.expenses.create(...)
-
@@ -13681,7 +13231,7 @@ client.filestorage.field_mapping.remote_fields_retrieve(
-
-Get all organization-wide Target Fields, this will not include any Linked Account specific Target Fields. Organization-wide Target Fields are additional fields appended to the Merge Common Model for all Linked Accounts in a category. [Learn more](https://docs.merge.dev/supplemental-data/field-mappings/target-fields/).
+Creates an `Expense` object with the given values.
@@ -13697,12 +13247,15 @@ Get all organization-wide Target Fields, this will not include any Linked Accoun
```python
from merge import Merge
+from merge.resources.accounting import ExpenseRequest
client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.filestorage.field_mapping.target_fields_retrieve()
+client.accounting.expenses.create(
+ model=ExpenseRequest(),
+)
```
@@ -13718,6 +13271,30 @@ client.filestorage.field_mapping.target_fields_retrieve()
-
+**model:** `ExpenseRequest`
+
+
+
+
+
+-
+
+**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.
@@ -13730,8 +13307,7 @@ client.filestorage.field_mapping.target_fields_retrieve()
-## Filestorage Files
-client.filestorage.files.list(...)
+client.accounting.expenses.retrieve(...)
-
@@ -13743,7 +13319,7 @@ client.filestorage.field_mapping.target_fields_retrieve()
-
-Returns a list of `File` objects.
+Returns an `Expense` object with the given `id`.
@@ -13758,49 +13334,14 @@ Returns a list of `File` objects.
-
```python
-import datetime
-
from merge import Merge
-from merge.resources.filestorage.resources.files import (
- FilesListRequestExpand,
- FilesListRequestOrderBy,
-)
client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.filestorage.files.list(
- created_after=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- created_before=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
- drive_id="drive_id",
- expand=FilesListRequestExpand.DRIVE,
- folder_id="folder_id",
- include_deleted_data=True,
- include_remote_data=True,
- include_shell_data=True,
- mime_type="mime_type",
- modified_after=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- modified_before=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- name="name",
- order_by=FilesListRequestOrderBy.CREATED_AT_DESCENDING,
- page_size=1,
- remote_created_after=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- remote_created_before=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- remote_id="remote_id",
+client.accounting.expenses.retrieve(
+ id="id",
)
```
@@ -13817,7 +13358,7 @@ client.filestorage.files.list(
-
-**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
+**id:** `str`
@@ -13825,7 +13366,12 @@ client.filestorage.files.list(
-
-**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
+**expand:** `typing.Optional[
+ typing.Union[
+ ExpensesRetrieveRequestExpandItem,
+ typing.Sequence[ExpensesRetrieveRequestExpandItem],
+ ]
+]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -13833,7 +13379,7 @@ client.filestorage.files.list(
-
-**cursor:** `typing.Optional[str]` — The pagination cursor value.
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -13841,7 +13387,7 @@ client.filestorage.files.list(
-
-**drive_id:** `typing.Optional[str]` — Specifying a drive id returns only the files in that drive. Specifying null returns only the files outside the top-level drive.
+**include_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.
@@ -13849,7 +13395,7 @@ client.filestorage.files.list(
-
-**expand:** `typing.Optional[FilesListRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -13857,7 +13403,75 @@ client.filestorage.files.list(
-
-**folder_id:** `typing.Optional[str]` — Specifying a folder id returns only the files in that folder. Specifying null returns only the files in root directory.
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+
+
+client.accounting.expenses.lines_remote_field_classes_list(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a list of `RemoteFieldClass` objects.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+response = client.accounting.expenses.lines_remote_field_classes_list(
+ cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
+)
+for item in response:
+ yield item
+# alternatively, you can paginate page-by-page
+for page in response.iter_pages():
+ yield page
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**cursor:** `typing.Optional[str]` — The pagination cursor value.
@@ -13889,7 +13503,7 @@ client.filestorage.files.list(
-
-**mime_type:** `typing.Optional[str]` — If provided, will only return files with these mime_types. Multiple values can be separated by commas.
+**is_common_model_field:** `typing.Optional[bool]` — If provided, will only return remote field classes with this is_common_model_field value
@@ -13897,7 +13511,7 @@ client.filestorage.files.list(
-
-**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
+**is_custom:** `typing.Optional[bool]` — If provided, will only return remote fields classes with this is_custom value
@@ -13905,7 +13519,7 @@ client.filestorage.files.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.
@@ -13913,51 +13527,64 @@ client.filestorage.files.list(
-
-**name:** `typing.Optional[str]` — If provided, will only return files with this name. This performs an exact match.
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
-
--
-**order_by:** `typing.Optional[FilesListRequestOrderBy]` — Overrides the default ordering for this endpoint. Possible values include: created_at, -created_at, modified_at, -modified_at.
-
+
+client.accounting.expenses.meta_post_retrieve()
-
-**page_size:** `typing.Optional[int]` — Number of results to return per page.
-
-
-
+#### 📝 Description
-
-**remote_created_after:** `typing.Optional[dt.datetime]` — If provided, will only return files created in the third party platform after this datetime.
-
-
-
-
-
-**remote_created_before:** `typing.Optional[dt.datetime]` — If provided, will only return files created in the third party platform before this datetime.
-
+Returns metadata for `Expense` POSTs.
+
+
+#### 🔌 Usage
+
-
-**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
-
+
+-
+
+```python
+from merge import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.accounting.expenses.meta_post_retrieve()
+
+```
+
+
+#### ⚙️ Parameters
+
+
+-
+
-
@@ -13973,7 +13600,7 @@ client.filestorage.files.list(
-client.filestorage.files.create(...)
+client.accounting.expenses.remote_field_classes_list(...)
-
@@ -13985,7 +13612,7 @@ client.filestorage.files.list(
-
-Creates a `File` object with the given values.
+Returns a list of `RemoteFieldClass` objects.
@@ -14001,17 +13628,19 @@ Creates a `File` object with the given values.
```python
from merge import Merge
-from merge.resources.filestorage import FileRequest
client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.filestorage.files.create(
- is_debug_mode=True,
- run_async=True,
- model=FileRequest(),
+response = client.accounting.expenses.remote_field_classes_list(
+ cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
)
+for item in response:
+ yield item
+# alternatively, you can paginate page-by-page
+for page in response.iter_pages():
+ yield page
```
@@ -14027,7 +13656,7 @@ client.filestorage.files.create(
-
-**model:** `FileRequest`
+**cursor:** `typing.Optional[str]` — The pagination cursor value.
@@ -14035,7 +13664,7 @@ client.filestorage.files.create(
-
-**is_debug_mode:** `typing.Optional[bool]` — Whether to include debug fields (such as log file links) in the response.
+**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
@@ -14043,7 +13672,39 @@ client.filestorage.files.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).
+
+
+
+
+
+-
+
+**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.
@@ -14063,7 +13724,8 @@ client.filestorage.files.create(
-client.filestorage.files.retrieve(...)
+## Accounting FieldMapping
+client.accounting.field_mapping.field_mappings_retrieve(...)
-
@@ -14075,7 +13737,7 @@ client.filestorage.files.create(
-
-Returns a `File` object with the given `id`.
+Get all Field Mappings for this Linked Account. Field Mappings are mappings between third-party Remote Fields and user defined Merge fields. [Learn more](https://docs.merge.dev/supplemental-data/field-mappings/overview/).
@@ -14091,19 +13753,87 @@ Returns a `File` object with the given `id`.
```python
from merge import Merge
-from merge.resources.filestorage.resources.files import (
- FilesRetrieveRequestExpand,
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
)
+client.accounting.field_mapping.field_mappings_retrieve()
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**exclude_remote_field_metadata:** `typing.Optional[bool]` — If `true`, remote fields metadata is excluded from each field mapping instance (i.e. `remote_fields.remote_key_name` and `remote_fields.schema` will be null). This will increase the speed of the request since these fields require some calculations.
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+
+
+client.accounting.field_mapping.field_mappings_create(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Create new Field Mappings that will be available after the next scheduled sync. This will cause the next sync for this Linked Account to sync **ALL** data from start.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge import Merge
client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.filestorage.files.retrieve(
- id="id",
- expand=FilesRetrieveRequestExpand.DRIVE,
- include_remote_data=True,
- include_shell_data=True,
+client.accounting.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",
)
```
@@ -14120,7 +13850,7 @@ client.filestorage.files.retrieve(
-
-**id:** `str`
+**target_field_name:** `str` — The name of the target field you want this remote field to map to.
@@ -14128,7 +13858,7 @@ client.filestorage.files.retrieve(
-
-**expand:** `typing.Optional[FilesRetrieveRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+**target_field_description:** `str` — The description of the target field you want this remote field to map to.
@@ -14136,7 +13866,7 @@ client.filestorage.files.retrieve(
-
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
+**remote_field_traversal_path:** `typing.Sequence[typing.Any]` — The field traversal path of the remote field listed when you hit the GET /remote-fields endpoint.
@@ -14144,7 +13874,31 @@ client.filestorage.files.retrieve(
-
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
+**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.
@@ -14164,7 +13918,7 @@ client.filestorage.files.retrieve(
-client.filestorage.files.download_request_meta_retrieve(...)
+client.accounting.field_mapping.field_mappings_destroy(...)
-
@@ -14176,7 +13930,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.
+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.
@@ -14197,9 +13951,8 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.filestorage.files.download_request_meta_retrieve(
- id="id",
- mime_type="mime_type",
+client.accounting.field_mapping.field_mappings_destroy(
+ field_mapping_id="field_mapping_id",
)
```
@@ -14216,15 +13969,7 @@ client.filestorage.files.download_request_meta_retrieve(
-
-**id:** `str`
-
-
-
-
-
--
-
-**mime_type:** `typing.Optional[str]` — If provided, specifies the export format of the file to be downloaded. For information on supported export formats, please refer to our export format help center article.
+**field_mapping_id:** `str`
@@ -14244,7 +13989,7 @@ client.filestorage.files.download_request_meta_retrieve(
-client.filestorage.files.download_request_meta_list(...)
+client.accounting.field_mapping.field_mappings_partial_update(...)
-
@@ -14256,7 +14001,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.
+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.
@@ -14272,24 +14017,13 @@ Returns metadata to construct authenticated file download requests, allowing you
```python
from merge import Merge
-from merge.resources.filestorage.resources.files import (
- FilesDownloadRequestMetaListRequestOrderBy,
-)
client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.filestorage.files.download_request_meta_list(
- created_after="created_after",
- created_before="created_before",
- cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
- include_deleted_data=True,
- mime_types="mime_types",
- modified_after="modified_after",
- modified_before="modified_before",
- order_by=FilesDownloadRequestMetaListRequestOrderBy.CREATED_AT_DESCENDING,
- page_size=1,
+client.accounting.field_mapping.field_mappings_partial_update(
+ field_mapping_id="field_mapping_id",
)
```
@@ -14306,7 +14040,7 @@ client.filestorage.files.download_request_meta_list(
-
-**created_after:** `typing.Optional[str]` — If provided, will only return objects created after this datetime.
+**field_mapping_id:** `str`
@@ -14314,7 +14048,7 @@ client.filestorage.files.download_request_meta_list(
-
-**created_before:** `typing.Optional[str]` — If provided, will only return objects created before this datetime.
+**remote_field_traversal_path:** `typing.Optional[typing.Sequence[typing.Any]]` — The field traversal path of the remote field listed when you hit the GET /remote-fields endpoint.
@@ -14322,7 +14056,7 @@ client.filestorage.files.download_request_meta_list(
-
-**cursor:** `typing.Optional[str]` — The pagination cursor value.
+**remote_method:** `typing.Optional[str]` — The method of the remote endpoint where the remote field is coming from.
@@ -14330,7 +14064,7 @@ client.filestorage.files.download_request_meta_list(
-
-**ids:** `typing.Optional[typing.Union[str, typing.Sequence[str]]]` — If provided, will only return objects with the given IDs. Comma-separated list of strings.
+**remote_url_path:** `typing.Optional[str]` — The path of the remote endpoint where the remote field is coming from.
@@ -14338,39 +14072,68 @@ client.filestorage.files.download_request_meta_list(
-
-**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
-
--
-**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.
-
+
+client.accounting.field_mapping.remote_fields_retrieve(...)
-
-**modified_after:** `typing.Optional[str]` — If provided, will only return objects modified after this datetime.
-
+#### 📝 Description
+
+
+-
+
+
+-
+
+Get all remote fields for a Linked Account. Remote fields are third-party fields that are accessible after initial sync if remote_data is enabled. You can use remote fields to override existing Merge fields or map a new Merge field. [Learn more](https://docs.merge.dev/supplemental-data/field-mappings/overview/).
+
+
+#### 🔌 Usage
+
-
-**modified_before:** `typing.Optional[str]` — If provided, will only return objects modified before this datetime.
-
+
+-
+
+```python
+from merge import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.accounting.field_mapping.remote_fields_retrieve()
+
+```
+
+
+#### ⚙️ Parameters
+
-
-**order_by:** `typing.Optional[FilesDownloadRequestMetaListRequestOrderBy]` — Overrides the default ordering for this endpoint. Possible values include: created_at, -created_at, modified_at, -modified_at.
+
+-
+
+**common_models:** `typing.Optional[str]` — A comma seperated list of Common Model names. If included, will only return Remote Fields for those Common Models.
@@ -14378,7 +14141,7 @@ client.filestorage.files.download_request_meta_list(
-
-**page_size:** `typing.Optional[int]` — Number of results to return per page.
+**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.
@@ -14398,7 +14161,7 @@ client.filestorage.files.download_request_meta_list(
-client.filestorage.files.meta_post_retrieve()
+client.accounting.field_mapping.target_fields_retrieve()
-
@@ -14410,7 +14173,7 @@ client.filestorage.files.download_request_meta_list(
-
-Returns metadata for `FileStorageFile` POSTs.
+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/).
@@ -14431,7 +14194,7 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.filestorage.files.meta_post_retrieve()
+client.accounting.field_mapping.target_fields_retrieve()
```
@@ -14459,8 +14222,8 @@ client.filestorage.files.meta_post_retrieve()
-## Filestorage Folders
-client.filestorage.folders.list(...)
+## Accounting GeneralLedgerTransactions
+client.accounting.general_ledger_transactions.list(...)
-
@@ -14472,7 +14235,7 @@ client.filestorage.files.meta_post_retrieve()
-
-Returns a list of `Folder` objects.
+Returns a list of `GeneralLedgerTransaction` objects.
@@ -14487,41 +14250,20 @@ Returns a list of `Folder` objects.
-
```python
-import datetime
-
from merge import Merge
-from merge.resources.filestorage.resources.folders import (
- FoldersListRequestExpand,
-)
client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.filestorage.folders.list(
- created_after=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- created_before=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
+response = client.accounting.general_ledger_transactions.list(
cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
- drive_id="drive_id",
- expand=FoldersListRequestExpand.DRIVE,
- include_deleted_data=True,
- include_remote_data=True,
- include_shell_data=True,
- modified_after=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- modified_before=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- name="name",
- page_size=1,
- parent_folder_id="parent_folder_id",
- remote_id="remote_id",
)
+for item in response:
+ yield item
+# alternatively, you can paginate page-by-page
+for page in response.iter_pages():
+ yield page
```
@@ -14537,6 +14279,14 @@ client.filestorage.folders.list(
-
+**company_id:** `typing.Optional[str]` — If provided, will only return general ledger transactions for this company.
+
+
+
+
+
+-
+
**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
@@ -14561,15 +14311,12 @@ client.filestorage.folders.list(
-
-**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.
+**expand:** `typing.Optional[
+ typing.Union[
+ GeneralLedgerTransactionsListRequestExpandItem,
+ typing.Sequence[GeneralLedgerTransactionsListRequestExpandItem],
+ ]
+]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -14617,14 +14364,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.
@@ -14633,89 +14372,7 @@ client.filestorage.folders.list(
-
-**parent_folder_id:** `typing.Optional[str]` — If provided, will only return folders in this parent folder. If null, will return folders in root directory.
-
-
-
-
-
--
-
-**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-
-
-client.filestorage.folders.create(...)
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Creates a `Folder` object with the given values.
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from merge import Merge
-from merge.resources.filestorage import FolderRequest
-
-client = Merge(
- account_token="YOUR_ACCOUNT_TOKEN",
- api_key="YOUR_API_KEY",
-)
-client.filestorage.folders.create(
- is_debug_mode=True,
- run_async=True,
- model=FolderRequest(),
-)
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**model:** `FolderRequest`
+**posted_date_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects posted after this datetime.
@@ -14723,7 +14380,7 @@ client.filestorage.folders.create(
-
-**is_debug_mode:** `typing.Optional[bool]` — Whether to include debug fields (such as log file links) in the response.
+**posted_date_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects posted before this datetime.
@@ -14731,7 +14388,7 @@ client.filestorage.folders.create(
-
-**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.
@@ -14751,7 +14408,7 @@ client.filestorage.folders.create(
-client.filestorage.folders.retrieve(...)
+client.accounting.general_ledger_transactions.retrieve(...)
-
@@ -14763,7 +14420,7 @@ client.filestorage.folders.create(
-
-Returns a `Folder` object with the given `id`.
+Returns a `GeneralLedgerTransaction` object with the given `id`.
@@ -14779,19 +14436,13 @@ Returns a `Folder` object with the given `id`.
```python
from merge import Merge
-from merge.resources.filestorage.resources.folders import (
- FoldersRetrieveRequestExpand,
-)
client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.filestorage.folders.retrieve(
+client.accounting.general_ledger_transactions.retrieve(
id="id",
- expand=FoldersRetrieveRequestExpand.DRIVE,
- include_remote_data=True,
- include_shell_data=True,
)
```
@@ -14816,7 +14467,12 @@ 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.Union[
+ GeneralLedgerTransactionsRetrieveRequestExpandItem,
+ typing.Sequence[GeneralLedgerTransactionsRetrieveRequestExpandItem],
+ ]
+]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -14852,69 +14508,8 @@ 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(...)
+## Accounting GenerateKey
+client.accounting.generate_key.create(...)
-
@@ -14947,7 +14542,7 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.filestorage.generate_key.create(
+client.accounting.generate_key.create(
name="Remote Deployment Key 1",
)
@@ -14985,8 +14580,8 @@ client.filestorage.generate_key.create(
-## Filestorage Groups
-client.filestorage.groups.list(...)
+## Accounting IncomeStatements
+client.accounting.income_statements.list(...)
-
@@ -14998,7 +14593,7 @@ client.filestorage.generate_key.create(
-
-Returns a list of `Group` objects.
+Returns a list of `IncomeStatement` objects.
@@ -15013,34 +14608,20 @@ Returns a list of `Group` objects.
-
```python
-import datetime
-
from merge import Merge
client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.filestorage.groups.list(
- created_after=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- created_before=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
+response = client.accounting.income_statements.list(
cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
- include_deleted_data=True,
- include_remote_data=True,
- include_shell_data=True,
- modified_after=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- modified_before=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- page_size=1,
- remote_id="remote_id",
)
+for item in response:
+ yield item
+# alternatively, you can paginate page-by-page
+for page in response.iter_pages():
+ yield page
```
@@ -15056,6 +14637,14 @@ client.filestorage.groups.list(
-
+**company_id:** `typing.Optional[str]` — If provided, will only return income statements for this company.
+
+
+
+
+
+-
+
**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
@@ -15080,7 +14669,12 @@ client.filestorage.groups.list(
-
-**expand:** `typing.Optional[typing.Literal["child_groups"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+**expand:** `typing.Optional[
+ typing.Union[
+ IncomeStatementsListRequestExpandItem,
+ typing.Sequence[IncomeStatementsListRequestExpandItem],
+ ]
+]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -15156,7 +14750,7 @@ client.filestorage.groups.list(
-client.filestorage.groups.retrieve(...)
+client.accounting.income_statements.retrieve(...)
-
@@ -15168,7 +14762,7 @@ client.filestorage.groups.list(
-
-Returns a `Group` object with the given `id`.
+Returns an `IncomeStatement` object with the given `id`.
@@ -15189,10 +14783,8 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.filestorage.groups.retrieve(
+client.accounting.income_statements.retrieve(
id="id",
- include_remote_data=True,
- include_shell_data=True,
)
```
@@ -15217,7 +14809,12 @@ client.filestorage.groups.retrieve(
-
-**expand:** `typing.Optional[typing.Literal["child_groups"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+**expand:** `typing.Optional[
+ typing.Union[
+ IncomeStatementsRetrieveRequestExpandItem,
+ typing.Sequence[IncomeStatementsRetrieveRequestExpandItem],
+ ]
+]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -15253,8 +14850,8 @@ client.filestorage.groups.retrieve(
-## Filestorage Issues
-client.filestorage.issues.list(...)
+## Accounting Invoices
+client.accounting.invoices.list(...)
-
@@ -15266,7 +14863,7 @@ client.filestorage.groups.retrieve(
-
-Gets all issues for Organization.
+Returns a list of `Invoice` objects.
@@ -15281,39 +14878,20 @@ Gets all issues for Organization.
-
```python
-import datetime
-
from merge import Merge
-from merge.resources.filestorage.resources.issues import IssuesListRequestStatus
client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.filestorage.issues.list(
- account_token="account_token",
+response = client.accounting.invoices.list(
cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
- end_date="end_date",
- end_user_organization_name="end_user_organization_name",
- first_incident_time_after=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- first_incident_time_before=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- include_muted="include_muted",
- integration_name="integration_name",
- last_incident_time_after=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- last_incident_time_before=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- linked_account_id="linked_account_id",
- page_size=1,
- start_date="start_date",
- status=IssuesListRequestStatus.ONGOING,
)
+for item in response:
+ yield item
+# alternatively, you can paginate page-by-page
+for page in response.iter_pages():
+ yield page
```
@@ -15329,7 +14907,7 @@ client.filestorage.issues.list(
-
-**account_token:** `typing.Optional[str]`
+**company_id:** `typing.Optional[str]` — If provided, will only return invoices for this company.
@@ -15337,7 +14915,7 @@ client.filestorage.issues.list(
-
-**cursor:** `typing.Optional[str]` — The pagination cursor value.
+**contact_id:** `typing.Optional[str]` — If provided, will only return invoices for this contact.
@@ -15345,7 +14923,7 @@ client.filestorage.issues.list(
-
-**end_date:** `typing.Optional[str]` — If included, will only include issues whose most recent action occurred before this time
+**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
@@ -15353,7 +14931,7 @@ client.filestorage.issues.list(
-
-**end_user_organization_name:** `typing.Optional[str]`
+**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
@@ -15361,7 +14939,7 @@ client.filestorage.issues.list(
-
-**first_incident_time_after:** `typing.Optional[dt.datetime]` — If provided, will only return issues whose first incident time was after this datetime.
+**cursor:** `typing.Optional[str]` — The pagination cursor value.
@@ -15369,7 +14947,12 @@ client.filestorage.issues.list(
-
-**first_incident_time_before:** `typing.Optional[dt.datetime]` — If provided, will only return issues whose first incident time was before this datetime.
+**expand:** `typing.Optional[
+ typing.Union[
+ InvoicesListRequestExpandItem,
+ typing.Sequence[InvoicesListRequestExpandItem],
+ ]
+]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -15377,7 +14960,7 @@ client.filestorage.issues.list(
-
-**include_muted:** `typing.Optional[str]` — If true, will include muted issues
+**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
@@ -15385,7 +14968,7 @@ client.filestorage.issues.list(
-
-**integration_name:** `typing.Optional[str]`
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -15393,7 +14976,7 @@ client.filestorage.issues.list(
-
-**last_incident_time_after:** `typing.Optional[dt.datetime]` — If provided, will only return issues whose last incident time was after this datetime.
+**include_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.
@@ -15401,7 +14984,7 @@ client.filestorage.issues.list(
-
-**last_incident_time_before:** `typing.Optional[dt.datetime]` — If provided, will only return issues whose last incident time was before this datetime.
+**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -15409,7 +14992,7 @@ client.filestorage.issues.list(
-
-**linked_account_id:** `typing.Optional[str]` — If provided, will only include issues pertaining to the linked account passed in.
+**issue_date_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
@@ -15417,7 +15000,7 @@ client.filestorage.issues.list(
-
-**page_size:** `typing.Optional[int]` — Number of results to return per page.
+**issue_date_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
@@ -15425,7 +15008,7 @@ client.filestorage.issues.list(
-
-**start_date:** `typing.Optional[str]` — If included, will only include issues whose most recent action occurred after this time
+**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
@@ -15433,12 +15016,7 @@ client.filestorage.issues.list(
-
-**status:** `typing.Optional[IssuesListRequestStatus]`
-
-Status of the issue. Options: ('ONGOING', 'RESOLVED')
-
-* `ONGOING` - ONGOING
-* `RESOLVED` - RESOLVED
+**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
@@ -15446,70 +15024,69 @@ Status of the issue. Options: ('ONGOING', 'RESOLVED')
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+**number:** `typing.Optional[str]` — If provided, will only return Invoices with this number.
-
-
+
+-
+**page_size:** `typing.Optional[int]` — Number of results to return per page.
+
-
-client.filestorage.issues.retrieve(...)
-
-#### 📝 Description
-
-
--
+**remote_fields:** `typing.Optional[InvoicesListRequestRemoteFields]` — Deprecated. Use show_enum_origins.
+
+
+
-
-Get a specific issue.
-
-
+**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
+
-#### 🔌 Usage
-
-
+**show_enum_origins:** `typing.Optional[InvoicesListRequestShowEnumOrigins]` — A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter)
+
+
+
+
-
-```python
-from merge import Merge
+**status:** `typing.Optional[InvoicesListRequestStatus]`
-client = Merge(
- account_token="YOUR_ACCOUNT_TOKEN",
- api_key="YOUR_API_KEY",
-)
-client.filestorage.issues.retrieve(
- id="id",
-)
+If provided, will only return Invoices with this status.
-```
-
-
+* `PAID` - PAID
+* `DRAFT` - DRAFT
+* `SUBMITTED` - SUBMITTED
+* `PARTIALLY_PAID` - PARTIALLY_PAID
+* `OPEN` - OPEN
+* `VOID` - VOID
+
-#### ⚙️ Parameters
-
-
-
--
+**type:** `typing.Optional[InvoicesListRequestType]`
-**id:** `str`
+If provided, will only return Invoices with this type.
+
+* `ACCOUNTS_RECEIVABLE` - ACCOUNTS_RECEIVABLE
+* `ACCOUNTS_PAYABLE` - ACCOUNTS_PAYABLE
@@ -15529,8 +15106,7 @@ client.filestorage.issues.retrieve(
-## Filestorage LinkToken
-client.filestorage.link_token.create(...)
+client.accounting.invoices.create(...)
-
@@ -15542,7 +15118,9 @@ client.filestorage.issues.retrieve(
-
-Creates a link token to be used when linking a new end user.
+Creates an `Invoice` object with the given values.
+ Including a `PurchaseOrder` id in the `purchase_orders` property will generate an Accounts Payable Invoice from the specified Purchase Order(s).
+
@@ -15558,17 +15136,14 @@ Creates a link token to be used when linking a new end user.
```python
from merge import Merge
-from merge.resources.filestorage import CategoriesEnum
+from merge.resources.accounting import InvoiceRequest
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.accounting.invoices.create(
+ model=InvoiceRequest(),
)
```
@@ -15585,7 +15160,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.
+**model:** `InvoiceRequest`
@@ -15593,7 +15168,7 @@ client.filestorage.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.
@@ -15601,7 +15176,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.
+**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously.
@@ -15609,31 +15184,70 @@ client.filestorage.link_token.create(
-
-**categories:** `typing.Sequence[CategoriesEnum]` — The integration categories to show in Merge Link.
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+client.accounting.invoices.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 `Invoice` object with the given `id`.
+
+
+
+#### 🔌 Usage
-
-**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.
-
+
+-
+
+```python
+from merge import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.accounting.invoices.retrieve(
+ id="id",
+)
+
+```
+
+
+
+#### ⚙️ Parameters
-
-**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.
+
+-
+
+**id:** `str`
@@ -15641,7 +15255,12 @@ 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.
+**expand:** `typing.Optional[
+ typing.Union[
+ InvoicesRetrieveRequestExpandItem,
+ typing.Sequence[InvoicesRetrieveRequestExpandItem],
+ ]
+]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -15649,7 +15268,7 @@ client.filestorage.link_token.create(
-
-**common_models:** `typing.Optional[typing.Sequence[CommonModelScopesBodyRequest]]` — An array of objects to specify the models and fields that will be disabled for a given Linked Account. Each object uses model_id, enabled_actions, and disabled_fields to specify the model, method, and fields that are scoped for a given Linked Account.
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -15657,14 +15276,7 @@ client.filestorage.link_token.create(
-
-**category_common_model_scopes:** `typing.Optional[
- typing.Dict[
- str,
- typing.Optional[
- typing.Sequence[IndividualCommonModelScopeDeserializerRequest]
- ],
- ]
-]` — When creating a Link Token, you can set permissions for Common Models that will apply to the account that is going to be linked. Any model or field not specified in link token payload will default to existing settings.
+**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.
@@ -15672,12 +15284,7 @@ client.filestorage.link_token.create(
-
-**language:** `typing.Optional[LanguageEnum]`
-
-The following subset of IETF language tags can be used to configure localization.
-
-* `en` - en
-* `de` - de
+**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -15685,7 +15292,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.
+**remote_fields:** `typing.Optional[InvoicesRetrieveRequestRemoteFields]` — Deprecated. Use show_enum_origins.
@@ -15693,7 +15300,7 @@ The following subset of IETF language tags can be used to configure localization
-
-**integration_specific_config:** `typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]]` — A JSON object containing integration-specific configuration options.
+**show_enum_origins:** `typing.Optional[InvoicesRetrieveRequestShowEnumOrigins]` — 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)
@@ -15713,8 +15320,7 @@ The following subset of IETF language tags can be used to configure localization
-## Filestorage LinkedAccounts
-client.filestorage.linked_accounts.list(...)
+client.accounting.invoices.partial_update(...)
-
@@ -15726,7 +15332,7 @@ The following subset of IETF language tags can be used to configure localization
-
-List linked accounts for your organization.
+Updates an `Invoice` object with the given `id`.
@@ -15742,28 +15348,15 @@ List linked accounts for your organization.
```python
from merge import Merge
-from merge.resources.filestorage.resources.linked_accounts import (
- LinkedAccountsListRequestCategory,
-)
+from merge.resources.accounting import InvoiceRequest
client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.filestorage.linked_accounts.list(
- category=LinkedAccountsListRequestCategory.ACCOUNTING,
- cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
- end_user_email_address="end_user_email_address",
- end_user_organization_name="end_user_organization_name",
- end_user_origin_id="end_user_origin_id",
- end_user_origin_ids="end_user_origin_ids",
+client.accounting.invoices.partial_update(
id="id",
- ids="ids",
- include_duplicates=True,
- integration_name="integration_name",
- is_test_account="is_test_account",
- page_size=1,
- status="status",
+ model=InvoiceRequest(),
)
```
@@ -15780,17 +15373,15 @@ client.filestorage.linked_accounts.list(
-
-**category:** `typing.Optional[LinkedAccountsListRequestCategory]`
+**id:** `str`
+
+
+
-Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing`
+
+-
-* `hris` - hris
-* `ats` - ats
-* `accounting` - accounting
-* `ticketing` - ticketing
-* `crm` - crm
-* `mktg` - mktg
-* `filestorage` - filestorage
+**model:** `InvoiceRequest`
@@ -15798,7 +15389,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.
@@ -15806,7 +15397,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.
@@ -15814,31 +15405,75 @@ 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.accounting.invoices.line_items_remote_field_classes_list(...)
-
-**end_user_origin_id:** `typing.Optional[str]` — If provided, will only return linked accounts associated with the given origin ID.
-
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a list of `RemoteFieldClass` objects.
+
+
+#### 🔌 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",
+)
+response = client.accounting.invoices.line_items_remote_field_classes_list(
+ cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
+)
+for item in response:
+ yield item
+# alternatively, you can paginate page-by-page
+for page in response.iter_pages():
+ yield page
+
+```
+
+
+#### ⚙️ Parameters
+
-
-**id:** `typing.Optional[str]`
+
+-
+
+**cursor:** `typing.Optional[str]` — The pagination cursor value.
@@ -15846,7 +15481,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_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
@@ -15854,7 +15489,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.
@@ -15862,7 +15497,7 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing`
-
-**integration_name:** `typing.Optional[str]` — If provided, will only return linked accounts associated with the given integration name.
+**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -15870,7 +15505,7 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing`
-
-**is_test_account:** `typing.Optional[str]` — If included, will only include test linked accounts. If not included, will only include non-test linked accounts.
+**is_common_model_field:** `typing.Optional[bool]` — If provided, will only return remote field classes with this is_common_model_field value
@@ -15878,7 +15513,7 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing`
-
-**page_size:** `typing.Optional[int]` — Number of results to return per page.
+**is_custom:** `typing.Optional[bool]` — If provided, will only return remote fields classes with this is_custom value
@@ -15886,7 +15521,7 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing`
-
-**status:** `typing.Optional[str]` — Filter by status. Options: `COMPLETE`, `IDLE`, `INCOMPLETE`, `RELINK_NEEDED`
+**page_size:** `typing.Optional[int]` — Number of results to return per page.
@@ -15906,8 +15541,7 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing`
-## Filestorage Passthrough
-client.filestorage.passthrough.create(...)
+client.accounting.invoices.meta_patch_retrieve(...)
-
@@ -15919,7 +15553,7 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing`
-
-Pull data from an endpoint not currently supported by Merge.
+Returns metadata for `Invoice` PATCHs.
@@ -15935,17 +15569,13 @@ 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.accounting.invoices.meta_patch_retrieve(
+ id="id",
)
```
@@ -15962,7 +15592,7 @@ client.filestorage.passthrough.create(
-
-**request:** `DataPassthroughRequest`
+**id:** `str`
@@ -15982,8 +15612,7 @@ client.filestorage.passthrough.create(
-## Filestorage RegenerateKey
-client.filestorage.regenerate_key.create(...)
+client.accounting.invoices.meta_post_retrieve()
-
@@ -15995,7 +15624,7 @@ client.filestorage.passthrough.create(
-
-Exchange remote keys.
+Returns metadata for `Invoice` POSTs.
@@ -16016,9 +15645,7 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.filestorage.regenerate_key.create(
- name="Remote Deployment Key 1",
-)
+client.accounting.invoices.meta_post_retrieve()
```
@@ -16034,14 +15661,6 @@ client.filestorage.regenerate_key.create(
-
-**name:** `str` — The name of the remote key
-
-
-
-
-
--
-
**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -16054,8 +15673,7 @@ client.filestorage.regenerate_key.create(
-## Filestorage SyncStatus
-client.filestorage.sync_status.list(...)
+client.accounting.invoices.remote_field_classes_list(...)
-
@@ -16067,7 +15685,7 @@ client.filestorage.regenerate_key.create(
-
-Get sync status for the current sync and the most recently finished sync. `last_sync_start` represents the most recent time any sync began. `last_sync_finished` represents the most recent time any sync completed. These timestamps may correspond to different sync instances which may result in a sync start time being later than a separate sync completed time. To ensure you are retrieving the latest available data reference the `last_sync_finished` timestamp where `last_sync_result` is `DONE`. Possible values for `status` and `last_sync_result` are `DISABLED`, `DONE`, `FAILED`, `PARTIALLY_SYNCED`, `PAUSED`, `SYNCING`. Learn more about sync status in our [Help Center](https://help.merge.dev/en/articles/8184193-merge-sync-statuses).
+Returns a list of `RemoteFieldClass` objects.
@@ -16088,10 +15706,14 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.filestorage.sync_status.list(
+response = client.accounting.invoices.remote_field_classes_list(
cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
- page_size=1,
)
+for item in response:
+ yield item
+# alternatively, you can paginate page-by-page
+for page in response.iter_pages():
+ yield page
```
@@ -16115,7 +15737,7 @@ client.filestorage.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/).
@@ -16123,65 +15745,43 @@ client.filestorage.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_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
+
-
-## Filestorage ForceResync
-client.filestorage.force_resync.sync_status_resync_create()
-
-#### 📝 Description
-
-
--
+**is_common_model_field:** `typing.Optional[bool]` — If provided, will only return remote field classes with this is_common_model_field value
+
+
+
-
-Force re-sync of all models. This endpoint is available for monthly, quarterly, and highest sync frequency customers on the Professional or Enterprise plans. Doing so will consume a sync credit for the relevant linked account. Force re-syncs can also be triggered manually in the Merge Dashboard and is available for all customers.
-
-
+**is_custom:** `typing.Optional[bool]` — If provided, will only return remote fields classes with this is_custom value
+
-#### 🔌 Usage
-
-
--
-
-
-```python
-from merge import Merge
-
-client = Merge(
- account_token="YOUR_ACCOUNT_TOKEN",
- api_key="YOUR_API_KEY",
-)
-client.filestorage.force_resync.sync_status_resync_create()
-
-```
-
-
+**page_size:** `typing.Optional[int]` — Number of results to return per page.
+
-#### ⚙️ Parameters
-
-
--
-
-
@@ -16197,8 +15797,8 @@ client.filestorage.force_resync.sync_status_resync_create()
-## Filestorage Users
-client.filestorage.users.list(...)
+## Accounting Issues
+client.accounting.issues.list(...)
-
@@ -16210,7 +15810,7 @@ client.filestorage.force_resync.sync_status_resync_create()
-
-Returns a list of `User` objects.
+Gets all issues for Organization.
@@ -16225,35 +15825,20 @@ Returns a list of `User` objects.
-
```python
-import datetime
-
from merge import Merge
client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.filestorage.users.list(
- created_after=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- created_before=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
+response = client.accounting.issues.list(
cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
- include_deleted_data=True,
- include_remote_data=True,
- include_shell_data=True,
- is_me="is_me",
- modified_after=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- modified_before=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- page_size=1,
- remote_id="remote_id",
)
+for item in response:
+ yield item
+# alternatively, you can paginate page-by-page
+for page in response.iter_pages():
+ yield page
```
@@ -16269,7 +15854,7 @@ client.filestorage.users.list(
-
-**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
+**account_token:** `typing.Optional[str]`
@@ -16277,7 +15862,7 @@ client.filestorage.users.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.
@@ -16285,7 +15870,7 @@ client.filestorage.users.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
@@ -16293,7 +15878,7 @@ client.filestorage.users.list(
-
-**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
+**end_user_organization_name:** `typing.Optional[str]`
@@ -16301,7 +15886,7 @@ client.filestorage.users.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_after:** `typing.Optional[dt.datetime]` — If provided, will only return issues whose first incident time was after this datetime.
@@ -16309,7 +15894,7 @@ client.filestorage.users.list(
-
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
+**first_incident_time_before:** `typing.Optional[dt.datetime]` — If provided, will only return issues whose first incident time was before this datetime.
@@ -16317,7 +15902,7 @@ client.filestorage.users.list(
-
-**is_me:** `typing.Optional[str]` — If provided, will only return the user object for requestor.
+**include_muted:** `typing.Optional[str]` — If true, will include muted issues
@@ -16325,7 +15910,7 @@ client.filestorage.users.list(
-
-**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
+**integration_name:** `typing.Optional[str]`
@@ -16333,7 +15918,23 @@ client.filestorage.users.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.
+
+
+
+
+
+-
+
+**last_incident_time_before:** `typing.Optional[dt.datetime]` — If provided, will only return issues whose last incident time was before this datetime.
+
+
+
+
+
+-
+
+**linked_account_id:** `typing.Optional[str]` — If provided, will only include issues pertaining to the linked account passed in.
@@ -16349,7 +15950,20 @@ client.filestorage.users.list(
-
-**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
+**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
@@ -16369,7 +15983,7 @@ client.filestorage.users.list(
-client.filestorage.users.retrieve(...)
+client.accounting.issues.retrieve(...)
-
@@ -16381,7 +15995,7 @@ client.filestorage.users.list(
-
-Returns a `User` object with the given `id`.
+Get a specific issue.
@@ -16402,10 +16016,8 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.filestorage.users.retrieve(
+client.accounting.issues.retrieve(
id="id",
- include_remote_data=True,
- include_shell_data=True,
)
```
@@ -16430,22 +16042,6 @@ 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.
-
-
-
-
-
--
-
-**include_shell_data:** `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.
@@ -16458,8 +16054,8 @@ client.filestorage.users.retrieve(
-## Filestorage WebhookReceivers
-client.filestorage.webhook_receivers.list()
+## Accounting Items
+client.accounting.items.list(...)
-
@@ -16471,7 +16067,7 @@ client.filestorage.users.retrieve(
-
-Returns a list of `WebhookReceiver` objects.
+Returns a list of `Item` objects.
@@ -16492,7 +16088,14 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.filestorage.webhook_receivers.list()
+response = client.accounting.items.list(
+ cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
+)
+for item in response:
+ yield item
+# alternatively, you can paginate page-by-page
+for page in response.iter_pages():
+ yield page
```
@@ -16508,71 +16111,99 @@ client.filestorage.webhook_receivers.list()
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+**company_id:** `typing.Optional[str]` — If provided, will only return items for this company.
-
-
+
+-
+**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
+
-
-client.filestorage.webhook_receivers.create(...)
-
-#### 📝 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.
+
+
+
+
-
-Creates a `WebhookReceiver` object with the given values.
+**expand:** `typing.Optional[
+ typing.Union[
+ ItemsListRequestExpandItem, typing.Sequence[ItemsListRequestExpandItem]
+ ]
+]` — 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_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
+
+
+
-client = Merge(
- account_token="YOUR_ACCOUNT_TOKEN",
- api_key="YOUR_API_KEY",
-)
-client.filestorage.webhook_receivers.create(
- event="event",
- is_active=True,
-)
+
+-
-```
+**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.
+
+
+
+
-
-**event:** `str`
+**remote_fields:** `typing.Optional[ItemsListRequestRemoteFields]` — Deprecated. Use show_enum_origins.
@@ -16580,7 +16211,7 @@ client.filestorage.webhook_receivers.create(
-
-**is_active:** `bool`
+**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
@@ -16588,7 +16219,7 @@ client.filestorage.webhook_receivers.create(
-
-**key:** `typing.Optional[str]`
+**show_enum_origins:** `typing.Optional[ItemsListRequestShowEnumOrigins]` — 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)
@@ -16608,8 +16239,7 @@ client.filestorage.webhook_receivers.create(
-## Crm AccountDetails
-client.crm.account_details.retrieve()
+client.accounting.items.create(...)
-
@@ -16621,7 +16251,7 @@ client.filestorage.webhook_receivers.create(
-
-Get details for a linked account.
+Creates an `Item` object with the given values.
@@ -16637,12 +16267,15 @@ Get details for a linked account.
```python
from merge import Merge
+from merge.resources.accounting import ItemRequestRequest
client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.crm.account_details.retrieve()
+client.accounting.items.create(
+ model=ItemRequestRequest(),
+)
```
@@ -16658,6 +16291,30 @@ client.crm.account_details.retrieve()
-
+**model:** `ItemRequestRequest`
+
+
+
+
+
+-
+
+**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.
@@ -16670,8 +16327,7 @@ client.crm.account_details.retrieve()
-## Crm AccountToken
-client.crm.account_token.retrieve(...)
+client.accounting.items.retrieve(...)
-
@@ -16683,7 +16339,7 @@ client.crm.account_details.retrieve()
-
-Returns the account token for the end user with the provided public token.
+Returns an `Item` object with the given `id`.
@@ -16704,8 +16360,8 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.crm.account_token.retrieve(
- public_token="public_token",
+client.accounting.items.retrieve(
+ id="id",
)
```
@@ -16722,7 +16378,52 @@ client.crm.account_token.retrieve(
-
-**public_token:** `str`
+**id:** `str`
+
+
+
+
+
+-
+
+**expand:** `typing.Optional[
+ typing.Union[
+ ItemsRetrieveRequestExpandItem,
+ typing.Sequence[ItemsRetrieveRequestExpandItem],
+ ]
+]` — 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[ItemsRetrieveRequestRemoteFields]` — Deprecated. Use show_enum_origins.
+
+
+
+
+
+-
+
+**show_enum_origins:** `typing.Optional[ItemsRetrieveRequestShowEnumOrigins]` — 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)
@@ -16742,8 +16443,7 @@ client.crm.account_token.retrieve(
-## Crm Accounts
-client.crm.accounts.list(...)
+client.accounting.items.partial_update(...)
-
@@ -16755,7 +16455,7 @@ client.crm.account_token.retrieve(
-
-Returns a list of `Account` objects.
+Updates an `Item` object with the given `id`.
@@ -16770,36 +16470,16 @@ Returns a list of `Account` objects.
-
```python
-import datetime
-
from merge import Merge
+from merge.resources.accounting import PatchedItemRequestRequest
client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.crm.accounts.list(
- created_after=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- created_before=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
- include_deleted_data=True,
- include_remote_data=True,
- include_remote_fields=True,
- include_shell_data=True,
- modified_after=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- modified_before=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- name="name",
- owner_id="owner_id",
- page_size=1,
- remote_id="remote_id",
+client.accounting.items.partial_update(
+ id="id",
+ model=PatchedItemRequestRequest(),
)
```
@@ -16816,7 +16496,7 @@ client.crm.accounts.list(
-
-**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
+**id:** `str`
@@ -16824,7 +16504,7 @@ client.crm.accounts.list(
-
-**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
+**model:** `PatchedItemRequestRequest`
@@ -16832,7 +16512,7 @@ client.crm.accounts.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.
@@ -16840,7 +16520,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.
+**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously.
@@ -16848,47 +16528,70 @@ 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/).
+**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.accounting.items.meta_patch_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).
-
+
+-
+
+Returns metadata for `Item` PATCHs.
+
+
+#### 🔌 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.accounting.items.meta_patch_retrieve(
+ id="id",
+)
+
+```
+
+
+
+#### ⚙️ Parameters
-
-**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
+
+-
+
+**id:** `str`
@@ -16896,35 +16599,64 @@ client.crm.accounts.list(
-
-**name:** `typing.Optional[str]` — If provided, will only return accounts with this name.
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
-
--
-**owner_id:** `typing.Optional[str]` — If provided, will only return accounts with this owner.
-
+
+client.accounting.items.meta_post_retrieve()
-
-**page_size:** `typing.Optional[int]` — Number of results to return per page.
-
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns metadata for `Item` POSTs.
+
+
+
+#### 🔌 Usage
-
-**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
-
+
+-
+
+```python
+from merge import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.accounting.items.meta_post_retrieve()
+
+```
+
+
+#### ⚙️ Parameters
+
+
+-
+
-
@@ -16940,7 +16672,8 @@ client.crm.accounts.list(
-client.crm.accounts.create(...)
+## Accounting JournalEntries
+client.accounting.journal_entries.list(...)
-
@@ -16952,7 +16685,7 @@ client.crm.accounts.list(
-
-Creates an `Account` object with the given values.
+Returns a list of `JournalEntry` objects.
@@ -16968,17 +16701,19 @@ 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(
- is_debug_mode=True,
- run_async=True,
- model=AccountRequest(),
+response = client.accounting.journal_entries.list(
+ cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
)
+for item in response:
+ yield item
+# alternatively, you can paginate page-by-page
+for page in response.iter_pages():
+ yield page
```
@@ -16994,7 +16729,7 @@ client.crm.accounts.create(
-
-**model:** `AccountRequest`
+**company_id:** `typing.Optional[str]` — If provided, will only return journal entries for this company.
@@ -17002,7 +16737,7 @@ client.crm.accounts.create(
-
-**is_debug_mode:** `typing.Optional[bool]` — Whether to include debug fields (such as log file links) in the response.
+**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
@@ -17010,7 +16745,7 @@ client.crm.accounts.create(
-
-**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously.
+**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
@@ -17018,73 +16753,68 @@ client.crm.accounts.create(
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+**cursor:** `typing.Optional[str]` — The pagination cursor value.
-
-
+
+-
+**expand:** `typing.Optional[
+ typing.Union[
+ JournalEntriesListRequestExpandItem,
+ typing.Sequence[JournalEntriesListRequestExpandItem],
+ ]
+]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+
-
-client.crm.accounts.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 an `Account` 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
-
-
+**include_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.
+
+
+
+
-
-```python
-from merge import Merge
-
-client = Merge(
- account_token="YOUR_ACCOUNT_TOKEN",
- api_key="YOUR_API_KEY",
-)
-client.crm.accounts.retrieve(
- id="id",
- include_remote_data=True,
- include_remote_fields=True,
- include_shell_data=True,
-)
-
-```
-
-
+**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
+
-#### ⚙️ Parameters
-
-
+**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
+
+
+
+
-
-**id:** `str`
+**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
@@ -17092,7 +16822,7 @@ client.crm.accounts.retrieve(
-
-**expand:** `typing.Optional[typing.Literal["owner"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+**page_size:** `typing.Optional[int]` — Number of results to return per page.
@@ -17100,7 +16830,7 @@ client.crm.accounts.retrieve(
-
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
+**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
@@ -17108,7 +16838,7 @@ client.crm.accounts.retrieve(
-
-**include_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.
+**transaction_date_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
@@ -17116,7 +16846,7 @@ client.crm.accounts.retrieve(
-
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
+**transaction_date_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
@@ -17136,7 +16866,7 @@ client.crm.accounts.retrieve(
-client.crm.accounts.partial_update(...)
+client.accounting.journal_entries.create(...)
-
@@ -17148,7 +16878,7 @@ client.crm.accounts.retrieve(
-
-Updates an `Account` object with the given `id`.
+Creates a `JournalEntry` object with the given values.
@@ -17164,17 +16894,14 @@ Updates an `Account` object with the given `id`.
```python
from merge import Merge
-from merge.resources.crm import PatchedAccountRequest
+from merge.resources.accounting import JournalEntryRequest
client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.crm.accounts.partial_update(
- id="id",
- is_debug_mode=True,
- run_async=True,
- model=PatchedAccountRequest(),
+client.accounting.journal_entries.create(
+ model=JournalEntryRequest(),
)
```
@@ -17191,15 +16918,7 @@ client.crm.accounts.partial_update(
-
-**id:** `str`
-
-
-
-
-
--
-
-**model:** `PatchedAccountRequest`
+**model:** `JournalEntryRequest`
@@ -17235,7 +16954,7 @@ client.crm.accounts.partial_update(
-client.crm.accounts.meta_patch_retrieve(...)
+client.accounting.journal_entries.retrieve(...)
-
@@ -17247,7 +16966,7 @@ client.crm.accounts.partial_update(
-
-Returns metadata for `CRMAccount` PATCHs.
+Returns a `JournalEntry` object with the given `id`.
@@ -17268,7 +16987,7 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.crm.accounts.meta_patch_retrieve(
+client.accounting.journal_entries.retrieve(
id="id",
)
@@ -17294,64 +17013,40 @@ client.crm.accounts.meta_patch_retrieve(
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+**expand:** `typing.Optional[
+ typing.Union[
+ JournalEntriesRetrieveRequestExpandItem,
+ typing.Sequence[JournalEntriesRetrieveRequestExpandItem],
+ ]
+]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
-
-
-
-
-
-
-
-client.crm.accounts.meta_post_retrieve()
-
-#### 📝 Description
-
-
--
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
+
+
+
-
-Returns metadata for `CRMAccount` POSTs.
-
-
+**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.crm.accounts.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).
+
-#### ⚙️ Parameters
-
-
--
-
-
@@ -17367,7 +17062,7 @@ client.crm.accounts.meta_post_retrieve()
-client.crm.accounts.remote_field_classes_list(...)
+client.accounting.journal_entries.lines_remote_field_classes_list(...)
-
@@ -17400,16 +17095,14 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.crm.accounts.remote_field_classes_list(
+response = client.accounting.journal_entries.lines_remote_field_classes_list(
cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
- include_deleted_data=True,
- include_remote_data=True,
- include_remote_fields=True,
- include_shell_data=True,
- is_common_model_field=True,
- is_custom=True,
- page_size=1,
)
+for item in response:
+ yield item
+# alternatively, you can paginate page-by-page
+for page in response.iter_pages():
+ yield page
```
@@ -17449,14 +17142,6 @@ 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).
@@ -17501,8 +17186,7 @@ client.crm.accounts.remote_field_classes_list(
-## Crm AsyncPassthrough
-client.crm.async_passthrough.create(...)
+client.accounting.journal_entries.meta_post_retrieve()
-
@@ -17514,7 +17198,7 @@ client.crm.accounts.remote_field_classes_list(
-
-Asynchronously pull data from an endpoint not currently supported by Merge.
+Returns metadata for `JournalEntry` POSTs.
@@ -17530,18 +17214,12 @@ 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.accounting.journal_entries.meta_post_retrieve()
```
@@ -17557,14 +17235,6 @@ client.crm.async_passthrough.create(
-
-**request:** `DataPassthroughRequest`
-
-
-
-
-
--
-
**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -17577,7 +17247,7 @@ client.crm.async_passthrough.create(
-client.crm.async_passthrough.retrieve(...)
+client.accounting.journal_entries.remote_field_classes_list(...)
-
@@ -17589,7 +17259,7 @@ client.crm.async_passthrough.create(
-
-Retrieves data from earlier async-passthrough POST request
+Returns a list of `RemoteFieldClass` objects.
@@ -17610,9 +17280,14 @@ 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",
+response = client.accounting.journal_entries.remote_field_classes_list(
+ cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
)
+for item in response:
+ yield item
+# alternatively, you can paginate page-by-page
+for page in response.iter_pages():
+ yield page
```
@@ -17628,7 +17303,55 @@ client.crm.async_passthrough.retrieve(
-
-**async_passthrough_receipt_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/).
+
+
+
+
+
+-
+
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
+
+
+
+
+
+-
+
+**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
+
+
+
+
+
+-
+
+**is_common_model_field:** `typing.Optional[bool]` — If provided, will only return remote field classes with this is_common_model_field value
+
+
+
+
+
+-
+
+**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.
@@ -17648,8 +17371,8 @@ client.crm.async_passthrough.retrieve(
-## Crm AuditTrail
-client.crm.audit_trail.list(...)
+## Accounting LinkToken
+client.accounting.link_token.create(...)
-
@@ -17661,7 +17384,7 @@ client.crm.async_passthrough.retrieve(
-
-Gets a list of audit trail events.
+Creates a link token to be used when linking a new end user.
@@ -17677,18 +17400,17 @@ Gets a list of audit trail events.
```python
from merge import Merge
+from merge.resources.accounting import CategoriesEnum
client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.crm.audit_trail.list(
- cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
- end_date="end_date",
- event_type="event_type",
- page_size=1,
- start_date="start_date",
- user_email="user_email",
+client.accounting.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],
)
```
@@ -17705,7 +17427,7 @@ client.crm.audit_trail.list(
-
-**cursor:** `typing.Optional[str]` — The pagination cursor value.
+**end_user_email_address:** `str` — Your end user's email address. This is purely for identification purposes - setting this value will not cause any emails to be sent.
@@ -17713,7 +17435,7 @@ client.crm.audit_trail.list(
-
-**end_date:** `typing.Optional[str]` — If included, will only include audit trail events that occurred before this time
+**end_user_organization_name:** `str` — Your end user's organization.
@@ -17721,7 +17443,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`
+**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.
@@ -17729,7 +17451,7 @@ client.crm.audit_trail.list(
-
-**page_size:** `typing.Optional[int]` — Number of results to return per page.
+**categories:** `typing.Sequence[CategoriesEnum]` — The integration categories to show in Merge Link.
@@ -17737,7 +17459,7 @@ client.crm.audit_trail.list(
-
-**start_date:** `typing.Optional[str]` — If included, will only include audit trail events that occurred after this time
+**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/.
@@ -17745,7 +17467,7 @@ client.crm.audit_trail.list(
-
-**user_email:** `typing.Optional[str]` — If provided, this will return events associated with the specified user email. Please note that the email address reflects the user's email at the time of the event, and may not be their current email.
+**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.
@@ -17753,65 +17475,71 @@ client.crm.audit_trail.list(
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+**should_create_magic_link_url:** `typing.Optional[bool]` — Whether to generate a Magic Link URL. Defaults to false. For more information on Magic Link, see https://merge.dev/blog/integrations-fast-say-hello-to-magic-link.
-
-
+
+-
+**hide_admin_magic_link:** `typing.Optional[bool]` — Whether to generate a Magic Link URL on the Admin Needed screen during the linking flow. Defaults to false. For more information on Magic Link, see https://merge.dev/blog/integrations-fast-say-hello-to-magic-link.
+
-
-## Crm AvailableActions
-client.crm.available_actions.retrieve()
-
-#### 📝 Description
-
-
--
+**common_models:** `typing.Optional[typing.Sequence[CommonModelScopesBodyRequest]]` — An array of objects to specify the models and fields that will be disabled for a given Linked Account. Each object uses model_id, enabled_actions, and disabled_fields to specify the model, method, and fields that are scoped for a given Linked Account.
+
+
+
-
-Returns a list of models and actions available for an 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.
+
-#### 🔌 Usage
-
-
-
--
-
-```python
-from merge import Merge
+**language:** `typing.Optional[EndUserDetailsRequestLanguage]`
-client = Merge(
- account_token="YOUR_ACCOUNT_TOKEN",
- api_key="YOUR_API_KEY",
-)
-client.crm.available_actions.retrieve()
+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.Any]]` — A JSON object containing integration-specific configuration options.
+
+
+
+
-
@@ -17827,8 +17555,8 @@ client.crm.available_actions.retrieve()
-## Crm Contacts
-client.crm.contacts.list(...)
+## Accounting LinkedAccounts
+client.accounting.linked_accounts.list(...)
-
@@ -17840,7 +17568,7 @@ client.crm.available_actions.retrieve()
-
-Returns a list of `Contact` objects.
+List linked accounts for your organization.
@@ -17855,40 +17583,20 @@ Returns a list of `Contact` objects.
-
```python
-import datetime
-
from merge import Merge
-from merge.resources.crm.resources.contacts import ContactsListRequestExpand
client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.crm.contacts.list(
- account_id="account_id",
- created_after=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- created_before=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
+response = client.accounting.linked_accounts.list(
cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
- email_addresses="email_addresses",
- expand=ContactsListRequestExpand.ACCOUNT,
- include_deleted_data=True,
- include_remote_data=True,
- include_remote_fields=True,
- include_shell_data=True,
- modified_after=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- modified_before=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- page_size=1,
- phone_numbers="phone_numbers",
- remote_id="remote_id",
)
+for item in response:
+ yield item
+# alternatively, you can paginate page-by-page
+for page in response.iter_pages():
+ yield page
```
@@ -17904,23 +17612,17 @@ client.crm.contacts.list(
-
-**account_id:** `typing.Optional[str]` — If provided, will only return contacts with this account.
-
-
-
-
-
--
-
-**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
-
-
-
+**category:** `typing.Optional[LinkedAccountsListRequestCategory]`
-
--
+Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing`
-**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
+* `hris` - hris
+* `ats` - ats
+* `accounting` - accounting
+* `ticketing` - ticketing
+* `crm` - crm
+* `mktg` - mktg
+* `filestorage` - filestorage
@@ -17936,7 +17638,7 @@ client.crm.contacts.list(
-
-**email_addresses:** `typing.Optional[str]` — If provided, will only return contacts matching the email addresses; multiple email_addresses can be separated by commas.
+**end_user_email_address:** `typing.Optional[str]` — If provided, will only return linked accounts associated with the given email address.
@@ -17944,7 +17646,7 @@ client.crm.contacts.list(
-
-**expand:** `typing.Optional[ContactsListRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+**end_user_organization_name:** `typing.Optional[str]` — If provided, will only return linked accounts associated with the given organization name.
@@ -17952,7 +17654,7 @@ client.crm.contacts.list(
-
-**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
+**end_user_origin_id:** `typing.Optional[str]` — If provided, will only return linked accounts associated with the given origin ID.
@@ -17960,7 +17662,7 @@ client.crm.contacts.list(
-
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
+**end_user_origin_ids:** `typing.Optional[str]` — Comma-separated list of EndUser origin IDs, making it possible to specify multiple EndUsers at once.
@@ -17968,7 +17670,7 @@ client.crm.contacts.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.
+**id:** `typing.Optional[str]`
@@ -17976,7 +17678,7 @@ client.crm.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).
+**ids:** `typing.Optional[str]` — Comma-separated list of LinkedAccount IDs, making it possible to specify multiple LinkedAccounts at once.
@@ -17984,7 +17686,7 @@ client.crm.contacts.list(
-
-**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
+**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.
@@ -17992,7 +17694,7 @@ client.crm.contacts.list(
-
-**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
+**integration_name:** `typing.Optional[str]` — If provided, will only return linked accounts associated with the given integration name.
@@ -18000,7 +17702,7 @@ client.crm.contacts.list(
-
-**page_size:** `typing.Optional[int]` — Number of results to return per page.
+**is_test_account:** `typing.Optional[str]` — If included, will only include test linked accounts. If not included, will only include non-test linked accounts.
@@ -18008,7 +17710,7 @@ client.crm.contacts.list(
-
-**phone_numbers:** `typing.Optional[str]` — If provided, will only return contacts matching the phone numbers; multiple phone numbers can be separated by commas.
+**page_size:** `typing.Optional[int]` — Number of results to return per page.
@@ -18016,7 +17718,7 @@ client.crm.contacts.list(
-
-**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
+**status:** `typing.Optional[str]` — Filter by status. Options: `COMPLETE`, `IDLE`, `INCOMPLETE`, `RELINK_NEEDED`
@@ -18036,7 +17738,8 @@ client.crm.contacts.list(
-client.crm.contacts.create(...)
+## Accounting Passthrough
+client.accounting.passthrough.create(...)
-
@@ -18048,7 +17751,7 @@ client.crm.contacts.list(
-
-Creates a `Contact` object with the given values.
+Pull data from an endpoint not currently supported by Merge.
@@ -18064,16 +17767,17 @@ Creates a `Contact` object with the given values.
```python
from merge import Merge
-from merge.resources.crm import ContactRequest
+from merge.resources.accounting import DataPassthroughRequest, MethodEnum
client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.crm.contacts.create(
- is_debug_mode=True,
- run_async=True,
- model=ContactRequest(),
+client.accounting.passthrough.create(
+ request=DataPassthroughRequest(
+ method=MethodEnum.GET,
+ path="/scooters",
+ ),
)
```
@@ -18090,23 +17794,7 @@ 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:** `DataPassthroughRequest`
@@ -18126,7 +17814,8 @@ client.crm.contacts.create(
-client.crm.contacts.retrieve(...)
+## Accounting PaymentMethods
+client.accounting.payment_methods.list(...)
-
@@ -18138,7 +17827,7 @@ client.crm.contacts.create(
-
-Returns a `Contact` object with the given `id`.
+Returns a list of `PaymentMethod` objects.
@@ -18154,19 +17843,19 @@ Returns a `Contact` object with the given `id`.
```python
from merge import Merge
-from merge.resources.crm.resources.contacts import ContactsRetrieveRequestExpand
client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.crm.contacts.retrieve(
- id="id",
- expand=ContactsRetrieveRequestExpand.ACCOUNT,
- include_remote_data=True,
- include_remote_fields=True,
- include_shell_data=True,
+response = client.accounting.payment_methods.list(
+ cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
)
+for item in response:
+ yield item
+# alternatively, you can paginate page-by-page
+for page in response.iter_pages():
+ yield page
```
@@ -18182,7 +17871,7 @@ client.crm.contacts.retrieve(
-
-**id:** `str`
+**cursor:** `typing.Optional[str]` — The pagination cursor value.
@@ -18190,7 +17879,7 @@ client.crm.contacts.retrieve(
-
-**expand:** `typing.Optional[ContactsRetrieveRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
@@ -18206,7 +17895,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.
+**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -18214,7 +17903,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).
+**page_size:** `typing.Optional[int]` — Number of results to return per page.
@@ -18234,7 +17923,7 @@ client.crm.contacts.retrieve(
-client.crm.contacts.partial_update(...)
+client.accounting.payment_methods.retrieve(...)
-
@@ -18246,7 +17935,7 @@ client.crm.contacts.retrieve(
-
-Updates a `Contact` object with the given `id`.
+Returns a `PaymentMethod` object with the given `id`.
@@ -18262,17 +17951,13 @@ Updates a `Contact` object with the given `id`.
```python
from merge import Merge
-from merge.resources.crm import PatchedContactRequest
client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.crm.contacts.partial_update(
+client.accounting.payment_methods.retrieve(
id="id",
- is_debug_mode=True,
- run_async=True,
- model=PatchedContactRequest(),
)
```
@@ -18297,15 +17982,7 @@ client.crm.contacts.partial_update(
-
-**model:** `PatchedContactRequest`
-
-
-
-
-
--
-
-**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.
@@ -18313,7 +17990,7 @@ client.crm.contacts.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).
@@ -18333,7 +18010,8 @@ client.crm.contacts.partial_update(
-client.crm.contacts.ignore_create(...)
+## Accounting PaymentTerms
+client.accounting.payment_terms.list(...)
-
@@ -18345,7 +18023,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.
+Returns a list of `PaymentTerm` objects.
@@ -18361,18 +18039,19 @@ 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.contacts.ignore_create(
- model_id="model_id",
- request=IgnoreCommonModelRequest(
- reason=ReasonEnum.GENERAL_CUSTOMER_REQUEST,
- ),
+response = client.accounting.payment_terms.list(
+ cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
)
+for item in response:
+ yield item
+# alternatively, you can paginate page-by-page
+for page in response.iter_pages():
+ yield page
```
@@ -18388,7 +18067,7 @@ client.crm.contacts.ignore_create(
-
-**model_id:** `str`
+**cursor:** `typing.Optional[str]` — The pagination cursor value.
@@ -18396,7 +18075,44 @@ client.crm.contacts.ignore_create(
-
-**request:** `IgnoreCommonModelRequest`
+**expand:** `typing.Optional[
+ typing.Union[
+ PaymentTermsListRequestExpandItem,
+ typing.Sequence[PaymentTermsListRequestExpandItem],
+ ]
+]` — 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.
@@ -18416,7 +18132,7 @@ client.crm.contacts.ignore_create(
-client.crm.contacts.meta_patch_retrieve(...)
+client.accounting.payment_terms.retrieve(...)
-
@@ -18428,7 +18144,7 @@ client.crm.contacts.ignore_create(
-
-Returns metadata for `CRMContact` PATCHs.
+Returns a `PaymentTerm` object with the given `id`.
@@ -18449,7 +18165,7 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.crm.contacts.meta_patch_retrieve(
+client.accounting.payment_terms.retrieve(
id="id",
)
@@ -18475,64 +18191,32 @@ client.crm.contacts.meta_patch_retrieve(
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+**expand:** `typing.Optional[
+ typing.Union[
+ PaymentTermsRetrieveRequestExpandItem,
+ typing.Sequence[PaymentTermsRetrieveRequestExpandItem],
+ ]
+]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
-
-
-
-
-
-
-
-
-client.crm.contacts.meta_post_retrieve()
-
--
-
-#### 📝 Description
-
-
--
-
-Returns metadata for `CRMContact` POSTs.
-
-
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
+
-#### 🔌 Usage
-
-
--
-
-
-```python
-from merge import Merge
-
-client = Merge(
- account_token="YOUR_ACCOUNT_TOKEN",
- api_key="YOUR_API_KEY",
-)
-client.crm.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).
+
-#### ⚙️ Parameters
-
-
--
-
-
@@ -18548,7 +18232,8 @@ client.crm.contacts.meta_post_retrieve()
-client.crm.contacts.remote_field_classes_list(...)
+## Accounting Payments
+client.accounting.payments.list(...)
-
@@ -18560,7 +18245,7 @@ client.crm.contacts.meta_post_retrieve()
-
-Returns a list of `RemoteFieldClass` objects.
+Returns a list of `Payment` objects.
@@ -18581,16 +18266,14 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.crm.contacts.remote_field_classes_list(
+response = client.accounting.payments.list(
cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
- include_deleted_data=True,
- include_remote_data=True,
- include_remote_fields=True,
- include_shell_data=True,
- is_common_model_field=True,
- is_custom=True,
- page_size=1,
)
+for item in response:
+ yield item
+# alternatively, you can paginate page-by-page
+for page in response.iter_pages():
+ yield page
```
@@ -18606,7 +18289,7 @@ client.crm.contacts.remote_field_classes_list(
-
-**cursor:** `typing.Optional[str]` — The pagination cursor value.
+**account_id:** `typing.Optional[str]` — If provided, will only return payments for this account.
@@ -18614,7 +18297,7 @@ client.crm.contacts.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/).
+**company_id:** `typing.Optional[str]` — If provided, will only return payments for this company.
@@ -18622,7 +18305,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.
+**contact_id:** `typing.Optional[str]` — If provided, will only return payments for this contact.
@@ -18630,7 +18313,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.
+**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
@@ -18638,7 +18321,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).
+**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
@@ -18646,7 +18329,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
+**cursor:** `typing.Optional[str]` — The pagination cursor value.
@@ -18654,7 +18337,12 @@ 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
+**expand:** `typing.Optional[
+ typing.Union[
+ PaymentsListRequestExpandItem,
+ typing.Sequence[PaymentsListRequestExpandItem],
+ ]
+]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -18662,7 +18350,7 @@ client.crm.contacts.remote_field_classes_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/).
@@ -18670,90 +18358,47 @@ client.crm.contacts.remote_field_classes_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.
+
-
-## Crm CustomObjectClasses
-client.crm.custom_object_classes.list(...)
-
-#### 📝 Description
-
-
--
+**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
+
+
+
-
-Returns a list of `CustomObjectClass` objects.
-
-
+**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
+
-#### 🔌 Usage
-
-
--
-
-
-```python
-import datetime
-
-from merge import Merge
-
-client = Merge(
- account_token="YOUR_ACCOUNT_TOKEN",
- api_key="YOUR_API_KEY",
-)
-client.crm.custom_object_classes.list(
- created_after=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- created_before=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
- include_deleted_data=True,
- include_remote_data=True,
- include_shell_data=True,
- modified_after=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- modified_before=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- page_size=1,
- remote_id="remote_id",
-)
-
-```
-
-
+**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
+
-#### ⚙️ Parameters
-
-
-
--
-
-**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
+**page_size:** `typing.Optional[int]` — Number of results to return per page.
@@ -18761,7 +18406,7 @@ client.crm.custom_object_classes.list(
-
-**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
+**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
@@ -18769,7 +18414,7 @@ client.crm.custom_object_classes.list(
-
-**cursor:** `typing.Optional[str]` — The pagination cursor value.
+**transaction_date_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
@@ -18777,7 +18422,7 @@ client.crm.custom_object_classes.list(
-
-**expand:** `typing.Optional[typing.Literal["fields"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+**transaction_date_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
@@ -18785,39 +18430,71 @@ client.crm.custom_object_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.accounting.payments.create(...)
-
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
-
+#### 📝 Description
+
+
+-
+
+
+-
+
+Creates a `Payment` object with the given values.
+
+
+#### 🔌 Usage
+
-
-**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
-
+
+-
+
+```python
+from merge import Merge
+from merge.resources.accounting import PaymentRequest
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.accounting.payments.create(
+ model=PaymentRequest(),
+)
+
+```
+
+
+#### ⚙️ Parameters
+
-
-**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
+
+-
+
+**model:** `PaymentRequest`
@@ -18825,7 +18502,7 @@ client.crm.custom_object_classes.list(
-
-**page_size:** `typing.Optional[int]` — Number of results to return per page.
+**is_debug_mode:** `typing.Optional[bool]` — Whether to include debug fields (such as log file links) in the response.
@@ -18833,7 +18510,7 @@ client.crm.custom_object_classes.list(
-
-**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
+**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously.
@@ -18853,7 +18530,7 @@ client.crm.custom_object_classes.list(
-client.crm.custom_object_classes.retrieve(...)
+client.accounting.payments.retrieve(...)
-
@@ -18865,7 +18542,7 @@ client.crm.custom_object_classes.list(
-
-Returns a `CustomObjectClass` object with the given `id`.
+Returns a `Payment` object with the given `id`.
@@ -18886,10 +18563,8 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.crm.custom_object_classes.retrieve(
+client.accounting.payments.retrieve(
id="id",
- include_remote_data=True,
- include_shell_data=True,
)
```
@@ -18914,7 +18589,12 @@ client.crm.custom_object_classes.retrieve(
-
-**expand:** `typing.Optional[typing.Literal["fields"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+**expand:** `typing.Optional[
+ typing.Union[
+ PaymentsRetrieveRequestExpandItem,
+ typing.Sequence[PaymentsRetrieveRequestExpandItem],
+ ]
+]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -18930,6 +18610,14 @@ client.crm.custom_object_classes.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).
@@ -18950,8 +18638,7 @@ client.crm.custom_object_classes.retrieve(
-## Crm AssociationTypes
-client.crm.association_types.custom_object_classes_association_types_list(...)
+client.accounting.payments.partial_update(...)
-
@@ -18963,7 +18650,7 @@ client.crm.custom_object_classes.retrieve(
-
-Returns a list of `AssociationType` objects.
+Updates a `Payment` object with the given `id`.
@@ -18978,34 +18665,16 @@ Returns a list of `AssociationType` objects.
-
```python
-import datetime
-
from merge import Merge
+from merge.resources.accounting import PatchedPaymentRequest
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",
- created_after=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- created_before=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
- include_deleted_data=True,
- include_remote_data=True,
- include_shell_data=True,
- modified_after=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- modified_before=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- page_size=1,
- remote_id="remote_id",
+client.accounting.payments.partial_update(
+ id="id",
+ model=PatchedPaymentRequest(),
)
```
@@ -19022,71 +18691,7 @@ client.crm.association_types.custom_object_classes_association_types_list(
-
-**custom_object_class_id:** `str`
-
-
-
-
-
--
-
-**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
-
-
-
-
-
--
-
-**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["target_object_classes"]]` — 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.
+**id:** `str`
@@ -19094,7 +18699,7 @@ client.crm.association_types.custom_object_classes_association_types_list(
-
-**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
+**model:** `PatchedPaymentRequest`
@@ -19102,7 +18707,7 @@ client.crm.association_types.custom_object_classes_association_types_list(
-
-**page_size:** `typing.Optional[int]` — Number of results to return per page.
+**is_debug_mode:** `typing.Optional[bool]` — Whether to include debug fields (such as log file links) in the response.
@@ -19110,7 +18715,7 @@ client.crm.association_types.custom_object_classes_association_types_list(
-
-**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
+**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously.
@@ -19130,7 +18735,7 @@ client.crm.association_types.custom_object_classes_association_types_list(
-client.crm.association_types.custom_object_classes_association_types_create(...)
+client.accounting.payments.line_items_remote_field_classes_list(...)
-
@@ -19142,7 +18747,7 @@ client.crm.association_types.custom_object_classes_association_types_list(
-
-Creates an `AssociationType` object with the given values.
+Returns a list of `RemoteFieldClass` objects.
@@ -19158,34 +18763,19 @@ 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",
- is_debug_mode=True,
- run_async=True,
- 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",
- ),
+response = client.accounting.payments.line_items_remote_field_classes_list(
+ cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
)
+for item in response:
+ yield item
+# alternatively, you can paginate page-by-page
+for page in response.iter_pages():
+ yield page
```
@@ -19201,7 +18791,7 @@ client.crm.association_types.custom_object_classes_association_types_create(
-
-**custom_object_class_id:** `str`
+**cursor:** `typing.Optional[str]` — The pagination cursor value.
@@ -19209,7 +18799,7 @@ client.crm.association_types.custom_object_classes_association_types_create(
-
-**model:** `AssociationTypeRequestRequest`
+**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
@@ -19217,7 +18807,7 @@ client.crm.association_types.custom_object_classes_association_types_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.
@@ -19225,7 +18815,31 @@ client.crm.association_types.custom_object_classes_association_types_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).
+
+
+
+
+
+-
+
+**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.
@@ -19245,7 +18859,7 @@ client.crm.association_types.custom_object_classes_association_types_create(
-client.crm.association_types.custom_object_classes_association_types_retrieve(...)
+client.accounting.payments.meta_patch_retrieve(...)
-
@@ -19257,7 +18871,7 @@ client.crm.association_types.custom_object_classes_association_types_create(
-
-Returns an `AssociationType` object with the given `id`.
+Returns metadata for `Payment` PATCHs.
@@ -19278,11 +18892,8 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.crm.association_types.custom_object_classes_association_types_retrieve(
- custom_object_class_id="custom_object_class_id",
+client.accounting.payments.meta_patch_retrieve(
id="id",
- include_remote_data=True,
- include_shell_data=True,
)
```
@@ -19299,14 +18910,6 @@ client.crm.association_types.custom_object_classes_association_types_retrieve(
-
-**custom_object_class_id:** `str`
-
-
-
-
-
--
-
**id:** `str`
@@ -19315,30 +18918,6 @@ 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.
-
-
-
-
-
--
-
-**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.
@@ -19351,7 +18930,7 @@ client.crm.association_types.custom_object_classes_association_types_retrieve(
-client.crm.association_types.custom_object_classes_association_types_meta_post_retrieve(...)
+client.accounting.payments.meta_post_retrieve()
-
@@ -19363,7 +18942,7 @@ client.crm.association_types.custom_object_classes_association_types_retrieve(
-
-Returns metadata for `CRMAssociationType` POSTs.
+Returns metadata for `Payment` POSTs.
@@ -19384,9 +18963,7 @@ 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.accounting.payments.meta_post_retrieve()
```
@@ -19402,14 +18979,6 @@ client.crm.association_types.custom_object_classes_association_types_meta_post_r
-
-**custom_object_class_id:** `str`
-
-
-
-
-
--
-
**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -19422,8 +18991,7 @@ client.crm.association_types.custom_object_classes_association_types_meta_post_r
-## Crm CustomObjects
-client.crm.custom_objects.custom_object_classes_custom_objects_list(...)
+client.accounting.payments.remote_field_classes_list(...)
-
@@ -19435,7 +19003,7 @@ client.crm.association_types.custom_object_classes_association_types_meta_post_r
-
-Returns a list of `CustomObject` objects.
+Returns a list of `RemoteFieldClass` objects.
@@ -19450,36 +19018,20 @@ Returns a list of `CustomObject` objects.
-
```python
-import datetime
-
from merge import Merge
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",
- created_after=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- created_before=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
+response = client.accounting.payments.remote_field_classes_list(
cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
- include_deleted_data=True,
- include_remote_data=True,
- include_remote_fields=True,
- include_shell_data=True,
- modified_after=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- modified_before=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- page_size=1,
- remote_id="remote_id",
)
+for item in response:
+ yield item
+# alternatively, you can paginate page-by-page
+for page in response.iter_pages():
+ yield page
```
@@ -19495,30 +19047,6 @@ client.crm.custom_objects.custom_object_classes_custom_objects_list(
-
-**custom_object_class_id:** `str`
-
-
-
-
-
--
-
-**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
-
-
-
-
-
--
-
-**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
-
-
-
-
-
--
-
**cursor:** `typing.Optional[str]` — The pagination cursor value.
@@ -19543,14 +19071,6 @@ 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_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -19559,7 +19079,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.
+**is_common_model_field:** `typing.Optional[bool]` — If provided, will only return remote field classes with this is_common_model_field value
@@ -19567,7 +19087,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.
+**is_custom:** `typing.Optional[bool]` — If provided, will only return remote fields classes with this is_custom value
@@ -19583,14 +19103,6 @@ client.crm.custom_objects.custom_object_classes_custom_objects_list(
-
-**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
-
-
-
-
-
--
-
**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -19603,7 +19115,8 @@ client.crm.custom_objects.custom_object_classes_custom_objects_list(
-client.crm.custom_objects.custom_object_classes_custom_objects_create(...)
+## Accounting PhoneNumbers
+client.accounting.phone_numbers.retrieve(...)
-
@@ -19615,7 +19128,7 @@ client.crm.custom_objects.custom_object_classes_custom_objects_list(
-
-Creates a `CustomObject` object with the given values.
+Returns an `AccountingPhoneNumber` object with the given `id`.
@@ -19631,19 +19144,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",
- is_debug_mode=True,
- run_async=True,
- model=CustomObjectRequest(
- fields={"test_field": "hello"},
- ),
+client.accounting.phone_numbers.retrieve(
+ id="id",
)
```
@@ -19660,15 +19167,7 @@ client.crm.custom_objects.custom_object_classes_custom_objects_create(
-
-**custom_object_class_id:** `str`
-
-
-
-
-
--
-
-**model:** `CustomObjectRequest`
+**id:** `str`
@@ -19676,7 +19175,7 @@ client.crm.custom_objects.custom_object_classes_custom_objects_create(
-
-**is_debug_mode:** `typing.Optional[bool]` — Whether to include debug fields (such as log file links) in the response.
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -19684,7 +19183,7 @@ client.crm.custom_objects.custom_object_classes_custom_objects_create(
-
-**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously.
+**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -19704,7 +19203,8 @@ client.crm.custom_objects.custom_object_classes_custom_objects_create(
-client.crm.custom_objects.custom_object_classes_custom_objects_retrieve(...)
+## Accounting Projects
+client.accounting.projects.list(...)
-
@@ -19716,7 +19216,7 @@ client.crm.custom_objects.custom_object_classes_custom_objects_create(
-
-Returns a `CustomObject` object with the given `id`.
+Returns a list of `Project` objects.
@@ -19737,12 +19237,8 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.crm.custom_objects.custom_object_classes_custom_objects_retrieve(
- custom_object_class_id="custom_object_class_id",
- id="id",
- include_remote_data=True,
- include_remote_fields=True,
- include_shell_data=True,
+client.accounting.projects.list(
+ cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
)
```
@@ -19759,7 +19255,7 @@ client.crm.custom_objects.custom_object_classes_custom_objects_retrieve(
-
-**custom_object_class_id:** `str`
+**cursor:** `typing.Optional[str]` — The pagination cursor value.
@@ -19767,7 +19263,12 @@ client.crm.custom_objects.custom_object_classes_custom_objects_retrieve(
-
-**id:** `str`
+**expand:** `typing.Optional[
+ typing.Union[
+ ProjectsListRequestExpandItem,
+ typing.Sequence[ProjectsListRequestExpandItem],
+ ]
+]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -19775,7 +19276,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.
+**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
@@ -19783,7 +19284,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.
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -19799,6 +19300,14 @@ client.crm.custom_objects.custom_object_classes_custom_objects_retrieve(
-
+**page_size:** `typing.Optional[int]` — Number of results to return per page.
+
+
+
+
+
+-
+
**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -19811,7 +19320,7 @@ client.crm.custom_objects.custom_object_classes_custom_objects_retrieve(
-client.crm.custom_objects.custom_object_classes_custom_objects_meta_post_retrieve(...)
+client.accounting.projects.retrieve(...)
-
@@ -19823,7 +19332,7 @@ client.crm.custom_objects.custom_object_classes_custom_objects_retrieve(
-
-Returns metadata for `CRMCustomObject` POSTs.
+Returns a `Project` object with the given `id`.
@@ -19844,8 +19353,8 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.crm.custom_objects.custom_object_classes_custom_objects_meta_post_retrieve(
- custom_object_class_id="custom_object_class_id",
+client.accounting.projects.retrieve(
+ id="id",
)
```
@@ -19862,7 +19371,36 @@ client.crm.custom_objects.custom_object_classes_custom_objects_meta_post_retriev
-
-**custom_object_class_id:** `str`
+**id:** `str`
+
+
+
+
+
+-
+
+**expand:** `typing.Optional[
+ typing.Union[
+ ProjectsRetrieveRequestExpandItem,
+ typing.Sequence[ProjectsRetrieveRequestExpandItem],
+ ]
+]` — 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).
@@ -19882,7 +19420,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(...)
+## Accounting PurchaseOrders
+client.accounting.purchase_orders.list(...)
-
@@ -19894,7 +19433,7 @@ client.crm.custom_objects.custom_object_classes_custom_objects_meta_post_retriev
-
-Returns a list of `RemoteFieldClass` objects.
+Returns a list of `PurchaseOrder` objects.
@@ -19915,16 +19454,14 @@ 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(
+response = client.accounting.purchase_orders.list(
cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
- include_deleted_data=True,
- include_remote_data=True,
- include_remote_fields=True,
- include_shell_data=True,
- is_common_model_field=True,
- is_custom=True,
- page_size=1,
)
+for item in response:
+ yield item
+# alternatively, you can paginate page-by-page
+for page in response.iter_pages():
+ yield page
```
@@ -19940,7 +19477,7 @@ client.crm.custom_objects.custom_object_classes_custom_objects_remote_field_clas
-
-**cursor:** `typing.Optional[str]` — The pagination cursor value.
+**company_id:** `typing.Optional[str]` — If provided, will only return purchase orders for this company.
@@ -19948,7 +19485,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/).
+**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
@@ -19956,7 +19493,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.
+**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
@@ -19964,7 +19501,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.
+**cursor:** `typing.Optional[str]` — The pagination cursor value.
@@ -19972,7 +19509,12 @@ 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).
+**expand:** `typing.Optional[
+ typing.Union[
+ PurchaseOrdersListRequestExpandItem,
+ typing.Sequence[PurchaseOrdersListRequestExpandItem],
+ ]
+]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -19980,7 +19522,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
+**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
@@ -19988,7 +19530,7 @@ client.crm.custom_objects.custom_object_classes_custom_objects_remote_field_clas
-
-**is_custom:** `typing.Optional[bool]` — If provided, will only return remote fields classes with this is_custom value
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -19996,7 +19538,7 @@ client.crm.custom_objects.custom_object_classes_custom_objects_remote_field_clas
-
-**page_size:** `typing.Optional[int]` — Number of results to return per page.
+**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.
@@ -20004,93 +19546,31 @@ client.crm.custom_objects.custom_object_classes_custom_objects_remote_field_clas
-
-**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).
-
-
-
-
-
-
-
-
-## Crm Associations
-client.crm.associations.custom_object_classes_custom_objects_associations_list(...)
-
--
-
-#### 📝 Description
-
-
--
-
-Returns a list of `Association` objects.
-
-
+**issue_date_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
+
-#### 🔌 Usage
-
-
-
--
-
-```python
-import datetime
-
-from merge import Merge
-
-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",
- association_type_id="association_type_id",
- created_after=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- created_before=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
- include_deleted_data=True,
- include_remote_data=True,
- include_shell_data=True,
- modified_after=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- modified_before=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- page_size=1,
- remote_id="remote_id",
-)
-
-```
-
-
+**issue_date_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
+
-#### ⚙️ Parameters
-
-
--
-
-
-**custom_object_class_id:** `str`
+**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
@@ -20098,7 +19578,7 @@ client.crm.associations.custom_object_classes_custom_objects_associations_list(
-
-**object_id:** `str`
+**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
@@ -20106,7 +19586,7 @@ client.crm.associations.custom_object_classes_custom_objects_associations_list(
-
-**association_type_id:** `typing.Optional[str]` — If provided, will only return opportunities with this association_type.
+**page_size:** `typing.Optional[int]` — Number of results to return per page.
@@ -20114,7 +19594,7 @@ client.crm.associations.custom_object_classes_custom_objects_associations_list(
-
-**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
+**remote_fields:** `typing.Optional[PurchaseOrdersListRequestRemoteFields]` — Deprecated. Use show_enum_origins.
@@ -20122,7 +19602,7 @@ client.crm.associations.custom_object_classes_custom_objects_associations_list(
-
-**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
+**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
@@ -20130,7 +19610,7 @@ client.crm.associations.custom_object_classes_custom_objects_associations_list(
-
-**cursor:** `typing.Optional[str]` — The pagination cursor value.
+**show_enum_origins:** `typing.Optional[PurchaseOrdersListRequestShowEnumOrigins]` — 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)
@@ -20138,47 +19618,71 @@ client.crm.associations.custom_object_classes_custom_objects_associations_list(
-
-**expand:** `typing.Optional[typing.Literal["association_type"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+**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.accounting.purchase_orders.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).
-
+
+-
+
+Creates a `PurchaseOrder` object with the given values.
+
+
+#### 🔌 Usage
+
-
-**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
-
+
+-
+
+```python
+from merge import Merge
+from merge.resources.accounting import PurchaseOrderRequest
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.accounting.purchase_orders.create(
+ model=PurchaseOrderRequest(),
+)
+
+```
+
+
+#### ⚙️ Parameters
+
-
-**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
+
+-
+
+**model:** `PurchaseOrderRequest`
@@ -20186,7 +19690,7 @@ client.crm.associations.custom_object_classes_custom_objects_associations_list(
-
-**page_size:** `typing.Optional[int]` — Number of results to return per page.
+**is_debug_mode:** `typing.Optional[bool]` — Whether to include debug fields (such as log file links) in the response.
@@ -20194,7 +19698,7 @@ client.crm.associations.custom_object_classes_custom_objects_associations_list(
-
-**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
+**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously.
@@ -20214,7 +19718,7 @@ client.crm.associations.custom_object_classes_custom_objects_associations_list(
-client.crm.associations.custom_object_classes_custom_objects_associations_update(...)
+client.accounting.purchase_orders.retrieve(...)
-
@@ -20226,7 +19730,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`.
+Returns a `PurchaseOrder` object with the given `id`.
@@ -20247,14 +19751,8 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.crm.associations.custom_object_classes_custom_objects_associations_update(
- source_class_id="source_class_id",
- source_object_id="source_object_id",
- target_class_id="target_class_id",
- target_object_id="target_object_id",
- association_type_id="association_type_id",
- is_debug_mode=True,
- run_async=True,
+client.accounting.purchase_orders.retrieve(
+ id="id",
)
```
@@ -20271,7 +19769,7 @@ client.crm.associations.custom_object_classes_custom_objects_associations_update
-
-**source_class_id:** `str`
+**id:** `str`
@@ -20279,7 +19777,12 @@ client.crm.associations.custom_object_classes_custom_objects_associations_update
-
-**source_object_id:** `str`
+**expand:** `typing.Optional[
+ typing.Union[
+ PurchaseOrdersRetrieveRequestExpandItem,
+ typing.Sequence[PurchaseOrdersRetrieveRequestExpandItem],
+ ]
+]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -20287,7 +19790,7 @@ client.crm.associations.custom_object_classes_custom_objects_associations_update
-
-**target_class_id:** `str`
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -20295,7 +19798,7 @@ client.crm.associations.custom_object_classes_custom_objects_associations_update
-
-**target_object_id:** `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.
@@ -20303,7 +19806,7 @@ client.crm.associations.custom_object_classes_custom_objects_associations_update
-
-**association_type_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).
@@ -20311,7 +19814,7 @@ client.crm.associations.custom_object_classes_custom_objects_associations_update
-
-**is_debug_mode:** `typing.Optional[bool]` — Whether to include debug fields (such as log file links) in the response.
+**remote_fields:** `typing.Optional[PurchaseOrdersRetrieveRequestRemoteFields]` — Deprecated. Use show_enum_origins.
@@ -20319,7 +19822,7 @@ client.crm.associations.custom_object_classes_custom_objects_associations_update
-
-**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously.
+**show_enum_origins:** `typing.Optional[PurchaseOrdersRetrieveRequestShowEnumOrigins]` — 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)
@@ -20339,8 +19842,7 @@ client.crm.associations.custom_object_classes_custom_objects_associations_update
-## Crm Scopes
-client.crm.scopes.default_scopes_retrieve()
+client.accounting.purchase_orders.line_items_remote_field_classes_list(...)
-
@@ -20352,7 +19854,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 `RemoteFieldClass` objects.
@@ -20373,7 +19875,16 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.crm.scopes.default_scopes_retrieve()
+response = (
+ client.accounting.purchase_orders.line_items_remote_field_classes_list(
+ cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
+ )
+)
+for item in response:
+ yield item
+# alternatively, you can paginate page-by-page
+for page in response.iter_pages():
+ yield page
```
@@ -20389,6 +19900,62 @@ client.crm.scopes.default_scopes_retrieve()
-
+**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).
+
+
+
+
+
+-
+
+**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.
@@ -20401,7 +19968,7 @@ client.crm.scopes.default_scopes_retrieve()
-client.crm.scopes.linked_account_scopes_retrieve()
+client.accounting.purchase_orders.meta_post_retrieve()
-
@@ -20413,7 +19980,7 @@ client.crm.scopes.default_scopes_retrieve()
-
-Get all available permissions for Merge Common Models and fields for a single Linked Account. [Learn more](https://help.merge.dev/en/articles/5950052-common-model-and-field-scopes).
+Returns metadata for `PurchaseOrder` POSTs.
@@ -20434,7 +20001,7 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.crm.scopes.linked_account_scopes_retrieve()
+client.accounting.purchase_orders.meta_post_retrieve()
```
@@ -20462,7 +20029,7 @@ client.crm.scopes.linked_account_scopes_retrieve()
-client.crm.scopes.linked_account_scopes_create(...)
+client.accounting.purchase_orders.remote_field_classes_list(...)
-
@@ -20474,7 +20041,7 @@ client.crm.scopes.linked_account_scopes_retrieve()
-
-Update permissions for any Common Model or field for a single Linked Account. Any Scopes not set in this POST request will inherit the default Scopes. [Learn more](https://help.merge.dev/en/articles/5950052-common-model-and-field-scopes)
+Returns a list of `RemoteFieldClass` objects.
@@ -20490,43 +20057,19 @@ 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,
- )
- },
- ),
- ],
+response = client.accounting.purchase_orders.remote_field_classes_list(
+ cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
)
+for item in response:
+ yield item
+# alternatively, you can paginate page-by-page
+for page in response.iter_pages():
+ yield page
```
@@ -20542,7 +20085,7 @@ client.crm.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.
@@ -20550,65 +20093,51 @@ client.crm.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.
+
-
-## Crm DeleteAccount
-client.crm.delete_account.delete()
-
-#### 📝 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).
+
+
+
-
-Delete a linked account.
-
-
+**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.crm.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.
+
+
+
+
-
@@ -20624,8 +20153,8 @@ client.crm.delete_account.delete()
-## Crm EngagementTypes
-client.crm.engagement_types.list(...)
+## Accounting RegenerateKey
+client.accounting.regenerate_key.create(...)
-
@@ -20637,7 +20166,7 @@ client.crm.delete_account.delete()
-
-Returns a list of `EngagementType` objects.
+Exchange remote keys.
@@ -20652,34 +20181,14 @@ Returns a list of `EngagementType` objects.
-
```python
-import datetime
-
from merge import Merge
client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.crm.engagement_types.list(
- created_after=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- created_before=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
- include_deleted_data=True,
- include_remote_data=True,
- include_remote_fields=True,
- include_shell_data=True,
- modified_after=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- modified_before=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- page_size=1,
- remote_id="remote_id",
+client.accounting.regenerate_key.create(
+ name="Remote Deployment Key 1",
)
```
@@ -20696,7 +20205,7 @@ client.crm.engagement_types.list(
-
-**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
+**name:** `str` — The name of the remote key
@@ -20704,71 +20213,76 @@ client.crm.engagement_types.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.
-
+
+## Accounting SyncStatus
+client.accounting.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/).
-
-
-
+#### 📝 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 sync status for the current sync and the most recently finished sync. `last_sync_start` represents the most recent time any sync began. `last_sync_finished` represents the most recent time any sync completed. These timestamps may correspond to different sync instances which may result in a sync start time being later than a separate sync completed time. To ensure you are retrieving the latest available data reference the `last_sync_finished` timestamp where `last_sync_result` is `DONE`. Possible values for `status` and `last_sync_result` are `DISABLED`, `DONE`, `FAILED`, `PARTIALLY_SYNCED`, `PAUSED`, `SYNCING`. Learn more about sync status in our [Help Center](https://help.merge.dev/en/articles/8184193-merge-sync-statuses).
+
+
+
+#### 🔌 Usage
-
-**include_shell_data:** `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",
+)
+response = client.accounting.sync_status.list(
+ cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
+)
+for item in response:
+ yield item
+# alternatively, you can paginate page-by-page
+for page in response.iter_pages():
+ yield page
+
+```
+
+
+
+#### ⚙️ Parameters
-
-**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.
+**cursor:** `typing.Optional[str]` — The pagination cursor value.
@@ -20776,7 +20290,7 @@ client.crm.engagement_types.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.
@@ -20796,7 +20310,8 @@ client.crm.engagement_types.list(
-client.crm.engagement_types.retrieve(...)
+## Accounting ForceResync
+client.accounting.force_resync.sync_status_resync_create()
-
@@ -20808,7 +20323,7 @@ client.crm.engagement_types.list(
-
-Returns an `EngagementType` 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.
@@ -20829,12 +20344,7 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.crm.engagement_types.retrieve(
- id="id",
- include_remote_data=True,
- include_remote_fields=True,
- include_shell_data=True,
-)
+client.accounting.force_resync.sync_status_resync_create()
```
@@ -20850,38 +20360,6 @@ 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).
-
-
-
-
-
--
-
**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -20894,7 +20372,8 @@ client.crm.engagement_types.retrieve(
-client.crm.engagement_types.remote_field_classes_list(...)
+## Accounting TaxRates
+client.accounting.tax_rates.list(...)
-
@@ -20906,7 +20385,7 @@ client.crm.engagement_types.retrieve(
-
-Returns a list of `RemoteFieldClass` objects.
+Returns a list of `TaxRate` objects.
@@ -20927,16 +20406,14 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.crm.engagement_types.remote_field_classes_list(
+response = client.accounting.tax_rates.list(
cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
- include_deleted_data=True,
- include_remote_data=True,
- include_remote_fields=True,
- include_shell_data=True,
- is_common_model_field=True,
- is_custom=True,
- page_size=1,
)
+for item in response:
+ yield item
+# alternatively, you can paginate page-by-page
+for page in response.iter_pages():
+ yield page
```
@@ -20952,6 +20429,30 @@ client.crm.engagement_types.remote_field_classes_list(
-
+**company_id:** `typing.Optional[str]` — If provided, will only return tax rates for this company.
+
+
+
+
+
+-
+
+**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
+
+
+
+
+
+-
+
+**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
+
+
+
+
+
+-
+
**cursor:** `typing.Optional[str]` — The pagination cursor value.
@@ -20960,6 +20461,19 @@ client.crm.engagement_types.remote_field_classes_list(
-
+**expand:** `typing.Optional[
+ typing.Union[
+ TaxRatesListRequestExpandItem,
+ typing.Sequence[TaxRatesListRequestExpandItem],
+ ]
+]` — 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/).
@@ -20976,7 +20490,7 @@ client.crm.engagement_types.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).
@@ -20984,7 +20498,7 @@ client.crm.engagement_types.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.
@@ -20992,7 +20506,7 @@ client.crm.engagement_types.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.
@@ -21000,7 +20514,7 @@ client.crm.engagement_types.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 TaxRates with this name.
@@ -21016,6 +20530,14 @@ client.crm.engagement_types.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.
@@ -21028,8 +20550,7 @@ client.crm.engagement_types.remote_field_classes_list(
-## Crm Engagements
-client.crm.engagements.list(...)
+client.accounting.tax_rates.retrieve(...)
-
@@ -21041,7 +20562,7 @@ client.crm.engagement_types.remote_field_classes_list(
-
-Returns a list of `Engagement` objects.
+Returns a `TaxRate` object with the given `id`.
@@ -21056,44 +20577,14 @@ Returns a list of `Engagement` objects.
-
```python
-import datetime
-
from merge import Merge
-from merge.resources.crm.resources.engagements import (
- EngagementsListRequestExpand,
-)
client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.crm.engagements.list(
- created_after=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- created_before=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
- expand=EngagementsListRequestExpand.ACCOUNT,
- include_deleted_data=True,
- include_remote_data=True,
- include_remote_fields=True,
- include_shell_data=True,
- modified_after=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- modified_before=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- page_size=1,
- remote_id="remote_id",
- started_after=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- started_before=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
+client.accounting.tax_rates.retrieve(
+ id="id",
)
```
@@ -21110,7 +20601,7 @@ client.crm.engagements.list(
-
-**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
+**id:** `str`
@@ -21118,7 +20609,12 @@ client.crm.engagements.list(
-
-**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
+**expand:** `typing.Optional[
+ typing.Union[
+ TaxRatesRetrieveRequestExpandItem,
+ typing.Sequence[TaxRatesRetrieveRequestExpandItem],
+ ]
+]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -21126,7 +20622,7 @@ client.crm.engagements.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.
@@ -21134,7 +20630,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.
+**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -21142,39 +20638,76 @@ 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/).
+**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.
-
+
+## Accounting TrackingCategories
+client.accounting.tracking_categories.list(...)
-
-**include_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.
-
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a list of `TrackingCategory` objects.
+
+
+#### 🔌 Usage
+
-
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
-
+
+-
+
+```python
+from merge import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+response = client.accounting.tracking_categories.list(
+ cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
+)
+for item in response:
+ yield item
+# alternatively, you can paginate page-by-page
+for page in response.iter_pages():
+ yield page
+
+```
+
+
+
+#### ⚙️ Parameters
-
-**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
+
+-
+
+**category_type:** `typing.Optional[TrackingCategoriesListRequestCategoryType]` — If provided, will only return tracking categories with this type.
@@ -21182,7 +20715,7 @@ client.crm.engagements.list(
-
-**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
+**company_id:** `typing.Optional[str]` — If provided, will only return tracking categories for this company.
@@ -21190,7 +20723,7 @@ client.crm.engagements.list(
-
-**page_size:** `typing.Optional[int]` — Number of results to return per page.
+**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
@@ -21198,7 +20731,7 @@ client.crm.engagements.list(
-
-**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
+**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
@@ -21206,7 +20739,7 @@ client.crm.engagements.list(
-
-**started_after:** `typing.Optional[dt.datetime]` — If provided, will only return engagements started after this datetime.
+**cursor:** `typing.Optional[str]` — The pagination cursor value.
@@ -21214,7 +20747,12 @@ client.crm.engagements.list(
-
-**started_before:** `typing.Optional[dt.datetime]` — If provided, will only return engagements started before this datetime.
+**expand:** `typing.Optional[
+ typing.Union[
+ TrackingCategoriesListRequestExpandItem,
+ typing.Sequence[TrackingCategoriesListRequestExpandItem],
+ ]
+]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -21222,73 +20760,71 @@ client.crm.engagements.list(
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
-
-
+
+-
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
+
-
-client.crm.engagements.create(...)
-
-#### 📝 Description
+**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
+
+
+
-
+**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
+
+
+
+
-
-Creates an `Engagement` object with the given values.
-
-
+**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
+
-#### 🔌 Usage
-
-
+**name:** `typing.Optional[str]` — If provided, will only return tracking categories with this name.
+
+
+
+
-
-```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(
- is_debug_mode=True,
- run_async=True,
- model=EngagementRequest(),
-)
-
-```
-
-
+**page_size:** `typing.Optional[int]` — Number of results to return per page.
+
-#### ⚙️ Parameters
-
-
+**remote_fields:** `typing.Optional[TrackingCategoriesListRequestRemoteFields]` — Deprecated. Use show_enum_origins.
+
+
+
+
-
-**model:** `EngagementRequest`
+**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
@@ -21296,7 +20832,7 @@ client.crm.engagements.create(
-
-**is_debug_mode:** `typing.Optional[bool]` — Whether to include debug fields (such as log file links) in the response.
+**show_enum_origins:** `typing.Optional[TrackingCategoriesListRequestShowEnumOrigins]` — 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)
@@ -21304,7 +20840,7 @@ client.crm.engagements.create(
-
-**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously.
+**status:** `typing.Optional[TrackingCategoriesListRequestStatus]` — If provided, will only return tracking categories with this status.
@@ -21324,7 +20860,7 @@ client.crm.engagements.create(
-client.crm.engagements.retrieve(...)
+client.accounting.tracking_categories.retrieve(...)
-
@@ -21336,7 +20872,7 @@ client.crm.engagements.create(
-
-Returns an `Engagement` object with the given `id`.
+Returns a `TrackingCategory` object with the given `id`.
@@ -21352,20 +20888,13 @@ Returns an `Engagement` object with the given `id`.
```python
from merge import Merge
-from merge.resources.crm.resources.engagements import (
- EngagementsRetrieveRequestExpand,
-)
client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.crm.engagements.retrieve(
+client.accounting.tracking_categories.retrieve(
id="id",
- expand=EngagementsRetrieveRequestExpand.ACCOUNT,
- include_remote_data=True,
- include_remote_fields=True,
- include_shell_data=True,
)
```
@@ -21390,7 +20919,12 @@ 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.
+**expand:** `typing.Optional[
+ typing.Union[
+ TrackingCategoriesRetrieveRequestExpandItem,
+ typing.Sequence[TrackingCategoriesRetrieveRequestExpandItem],
+ ]
+]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -21406,7 +20940,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.
+**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -21414,7 +20948,15 @@ 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).
+**remote_fields:** `typing.Optional[TrackingCategoriesRetrieveRequestRemoteFields]` — Deprecated. Use show_enum_origins.
+
+
+
+
+
+-
+
+**show_enum_origins:** `typing.Optional[TrackingCategoriesRetrieveRequestShowEnumOrigins]` — 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)
@@ -21434,7 +20976,8 @@ client.crm.engagements.retrieve(
-client.crm.engagements.partial_update(...)
+## Accounting Transactions
+client.accounting.transactions.list(...)
-
@@ -21446,7 +20989,7 @@ client.crm.engagements.retrieve(
-
-Updates an `Engagement` object with the given `id`.
+Returns a list of `Transaction` objects.
@@ -21462,18 +21005,19 @@ Updates an `Engagement` object with the given `id`.
```python
from merge import Merge
-from merge.resources.crm import PatchedEngagementRequest
client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.crm.engagements.partial_update(
- id="id",
- is_debug_mode=True,
- run_async=True,
- model=PatchedEngagementRequest(),
+response = client.accounting.transactions.list(
+ cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
)
+for item in response:
+ yield item
+# alternatively, you can paginate page-by-page
+for page in response.iter_pages():
+ yield page
```
@@ -21489,7 +21033,7 @@ client.crm.engagements.partial_update(
-
-**id:** `str`
+**company_id:** `typing.Optional[str]` — If provided, will only return accounting transactions for this company.
@@ -21497,7 +21041,7 @@ client.crm.engagements.partial_update(
-
-**model:** `PatchedEngagementRequest`
+**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
@@ -21505,7 +21049,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.
+**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
@@ -21513,7 +21057,7 @@ client.crm.engagements.partial_update(
-
-**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously.
+**cursor:** `typing.Optional[str]` — The pagination cursor value.
@@ -21521,70 +21065,44 @@ client.crm.engagements.partial_update(
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+**expand:** `typing.Optional[
+ typing.Union[
+ TransactionsListRequestExpandItem,
+ typing.Sequence[TransactionsListRequestExpandItem],
+ ]
+]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
-
-
-
-
-
-
-
-client.crm.engagements.meta_patch_retrieve(...)
-
-#### 📝 Description
-
-
--
+**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
+
+
+
-
-Returns metadata for `Engagement` PATCHs.
-
-
+**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.engagements.meta_patch_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
-
-
-
--
-
-**id:** `str`
+**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
@@ -21592,64 +21110,43 @@ client.crm.engagements.meta_patch_retrieve(
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
-
-
+
+-
+**page_size:** `typing.Optional[int]` — Number of results to return per page.
+
-
-client.crm.engagements.meta_post_retrieve()
-
-#### 📝 Description
-
-
--
+**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
+
+
+
-
-Returns metadata for `Engagement` POSTs.
-
-
+**transaction_date_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
+
-#### 🔌 Usage
-
-
-
--
-
-```python
-from merge import Merge
-
-client = Merge(
- account_token="YOUR_ACCOUNT_TOKEN",
- api_key="YOUR_API_KEY",
-)
-client.crm.engagements.meta_post_retrieve()
-
-```
-
-
+**transaction_date_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
+
-#### ⚙️ Parameters
-
-
--
-
-
@@ -21665,7 +21162,7 @@ client.crm.engagements.meta_post_retrieve()
-client.crm.engagements.remote_field_classes_list(...)
+client.accounting.transactions.retrieve(...)
-
@@ -21677,7 +21174,7 @@ client.crm.engagements.meta_post_retrieve()
-
-Returns a list of `RemoteFieldClass` objects.
+Returns a `Transaction` object with the given `id`.
@@ -21698,15 +21195,8 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.crm.engagements.remote_field_classes_list(
- cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
- include_deleted_data=True,
- include_remote_data=True,
- include_remote_fields=True,
- include_shell_data=True,
- is_common_model_field=True,
- is_custom=True,
- page_size=1,
+client.accounting.transactions.retrieve(
+ id="id",
)
```
@@ -21723,7 +21213,7 @@ client.crm.engagements.remote_field_classes_list(
-
-**cursor:** `typing.Optional[str]` — The pagination cursor value.
+**id:** `str`
@@ -21731,7 +21221,12 @@ 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.Union[
+ TransactionsRetrieveRequestExpandItem,
+ typing.Sequence[TransactionsRetrieveRequestExpandItem],
+ ]
+]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -21747,14 +21242,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).
@@ -21763,30 +21250,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.
@@ -21799,8 +21262,8 @@ client.crm.engagements.remote_field_classes_list(
-## Crm FieldMapping
-client.crm.field_mapping.field_mappings_retrieve(...)
+## Accounting VendorCredits
+client.accounting.vendor_credits.list(...)
-
@@ -21812,7 +21275,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 `VendorCredit` objects.
@@ -21833,9 +21296,14 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.crm.field_mapping.field_mappings_retrieve(
- exclude_remote_field_metadata=True,
+response = client.accounting.vendor_credits.list(
+ cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
)
+for item in response:
+ yield item
+# alternatively, you can paginate page-by-page
+for page in response.iter_pages():
+ yield page
```
@@ -21851,7 +21319,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.
+**company_id:** `typing.Optional[str]` — If provided, will only return vendor credits for this company.
@@ -21859,76 +21327,60 @@ client.crm.field_mapping.field_mappings_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.field_mapping.field_mappings_create(...)
-
-#### 📝 Description
-
-
--
+**cursor:** `typing.Optional[str]` — The pagination cursor value.
+
+
+
-
-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.
-
-
+**expand:** `typing.Optional[
+ typing.Union[
+ VendorCreditsListRequestExpandItem,
+ typing.Sequence[VendorCreditsListRequestExpandItem],
+ ]
+]` — 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.field_mapping.field_mappings_create(
- exclude_remote_field_metadata=True,
- target_field_name="example_target_field_name",
- target_field_description="this is a example description of the target field",
- remote_field_traversal_path=["example_remote_field"],
- remote_method="GET",
- remote_url_path="/example-url-path",
- common_model_name="ExampleCommonModel",
-)
-
-```
-
-
+**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is 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.
+
+
+
+
-
-**target_field_name:** `str` — The name of the target field you want this remote field to map to.
+**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -21936,7 +21388,7 @@ client.crm.field_mapping.field_mappings_create(
-
-**target_field_description:** `str` — The description of the target field you want this remote field to map to.
+**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
@@ -21944,7 +21396,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.
+**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
@@ -21952,7 +21404,7 @@ client.crm.field_mapping.field_mappings_create(
-
-**remote_method:** `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.
@@ -21960,7 +21412,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.
+**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
@@ -21968,7 +21420,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.
+**transaction_date_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
@@ -21976,7 +21428,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.
+**transaction_date_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
@@ -21996,7 +21448,7 @@ client.crm.field_mapping.field_mappings_create(
-client.crm.field_mapping.field_mappings_destroy(...)
+client.accounting.vendor_credits.create(...)
-
@@ -22008,7 +21460,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.
+Creates a `VendorCredit` object with the given values.
@@ -22024,13 +21476,14 @@ Deletes Field Mappings for a Linked Account. All data related to this Field Mapp
```python
from merge import Merge
+from merge.resources.accounting import VendorCreditRequest
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.accounting.vendor_credits.create(
+ model=VendorCreditRequest(),
)
```
@@ -22047,7 +21500,23 @@ client.crm.field_mapping.field_mappings_destroy(
-
-**field_mapping_id:** `str`
+**model:** `VendorCreditRequest`
+
+
+
+
+
+-
+
+**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.
@@ -22067,7 +21536,7 @@ client.crm.field_mapping.field_mappings_destroy(
-client.crm.field_mapping.field_mappings_partial_update(...)
+client.accounting.vendor_credits.retrieve(...)
-
@@ -22079,7 +21548,7 @@ client.crm.field_mapping.field_mappings_destroy(
-
-Create or update existing Field Mappings for a Linked Account. Changes will be reflected after the next scheduled sync. This will cause the next sync for this Linked Account to sync **ALL** data from start.
+Returns a `VendorCredit` object with the given `id`.
@@ -22100,8 +21569,8 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.crm.field_mapping.field_mappings_partial_update(
- field_mapping_id="field_mapping_id",
+client.accounting.vendor_credits.retrieve(
+ id="id",
)
```
@@ -22118,7 +21587,7 @@ client.crm.field_mapping.field_mappings_partial_update(
-
-**field_mapping_id:** `str`
+**id:** `str`
@@ -22126,7 +21595,12 @@ client.crm.field_mapping.field_mappings_partial_update(
-
-**remote_field_traversal_path:** `typing.Optional[typing.Sequence[typing.Optional[typing.Any]]]` — The field traversal path of the remote field listed when you hit the GET /remote-fields endpoint.
+**expand:** `typing.Optional[
+ typing.Union[
+ VendorCreditsRetrieveRequestExpandItem,
+ typing.Sequence[VendorCreditsRetrieveRequestExpandItem],
+ ]
+]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -22134,7 +21608,7 @@ client.crm.field_mapping.field_mappings_partial_update(
-
-**remote_method:** `typing.Optional[str]` — The method of the remote endpoint where the remote field is coming from.
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -22142,7 +21616,7 @@ client.crm.field_mapping.field_mappings_partial_update(
-
-**remote_url_path:** `typing.Optional[str]` — The path of the remote endpoint where the remote field is coming from.
+**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -22162,7 +21636,7 @@ client.crm.field_mapping.field_mappings_partial_update(
-client.crm.field_mapping.remote_fields_retrieve(...)
+client.accounting.vendor_credits.meta_post_retrieve()
-
@@ -22174,7 +21648,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/).
+Returns metadata for `VendorCredit` POSTs.
@@ -22195,10 +21669,7 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.crm.field_mapping.remote_fields_retrieve(
- common_models="common_models",
- include_example_values="include_example_values",
-)
+client.accounting.vendor_credits.meta_post_retrieve()
```
@@ -22214,22 +21685,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.
@@ -22242,7 +21697,8 @@ client.crm.field_mapping.remote_fields_retrieve(
-client.crm.field_mapping.target_fields_retrieve()
+## Accounting WebhookReceivers
+client.accounting.webhook_receivers.list()
-
@@ -22254,7 +21710,7 @@ client.crm.field_mapping.remote_fields_retrieve(
-
-Get all organization-wide Target Fields, this will not include any Linked Account specific Target Fields. Organization-wide Target Fields are additional fields appended to the Merge Common Model for all Linked Accounts in a category. [Learn more](https://docs.merge.dev/supplemental-data/field-mappings/target-fields/).
+Returns a list of `WebhookReceiver` objects.
@@ -22275,7 +21731,7 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.crm.field_mapping.target_fields_retrieve()
+client.accounting.webhook_receivers.list()
```
@@ -22303,8 +21759,7 @@ client.crm.field_mapping.target_fields_retrieve()
-## Crm GenerateKey
-client.crm.generate_key.create(...)
+client.accounting.webhook_receivers.create(...)
-
@@ -22316,7 +21771,7 @@ client.crm.field_mapping.target_fields_retrieve()
-
-Create a remote key.
+Creates a `WebhookReceiver` object with the given values.
@@ -22337,8 +21792,9 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.crm.generate_key.create(
- name="Remote Deployment Key 1",
+client.accounting.webhook_receivers.create(
+ event="event",
+ is_active=True,
)
```
@@ -22355,7 +21811,23 @@ client.crm.generate_key.create(
-
-**name:** `str` — The name of the remote key
+**event:** `str`
+
+
+
+
+
+-
+
+**is_active:** `bool`
+
+
+
+
+
+-
+
+**key:** `typing.Optional[str]`
@@ -22375,8 +21847,8 @@ client.crm.generate_key.create(
-## Crm Issues
-client.crm.issues.list(...)
+## Crm AccountDetails
+client.crm.account_details.retrieve()
-
@@ -22388,7 +21860,7 @@ client.crm.generate_key.create(
-
-Gets all issues for Organization.
+Get details for a linked account.
@@ -22403,39 +21875,13 @@ Gets all issues for Organization.
-
```python
-import datetime
-
from merge import Merge
-from merge.resources.crm.resources.issues import IssuesListRequestStatus
client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.crm.issues.list(
- account_token="account_token",
- cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
- end_date="end_date",
- end_user_organization_name="end_user_organization_name",
- first_incident_time_after=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- first_incident_time_before=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- include_muted="include_muted",
- integration_name="integration_name",
- last_incident_time_after=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- last_incident_time_before=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- linked_account_id="linked_account_id",
- page_size=1,
- start_date="start_date",
- status=IssuesListRequestStatus.ONGOING,
-)
+client.crm.account_details.retrieve()
```
@@ -22451,116 +21897,71 @@ client.crm.issues.list(
-
-**account_token:** `typing.Optional[str]`
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
--
-
-**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
-
+
+## Crm AccountToken
+client.crm.account_token.retrieve(...)
-
-**end_user_organization_name:** `typing.Optional[str]`
-
-
-
+#### 📝 Description
-
-**first_incident_time_after:** `typing.Optional[dt.datetime]` — If provided, will only return issues whose first incident time was after this datetime.
-
-
-
-
-
-**first_incident_time_before:** `typing.Optional[dt.datetime]` — If provided, will only return issues whose first incident time was before this datetime.
-
+Returns the account token for the end user with the provided public token.
-
-
--
-
-**include_muted:** `typing.Optional[str]` — If true, will include muted issues
-
-
--
-
-**integration_name:** `typing.Optional[str]`
-
-
-
+#### 🔌 Usage
-
-**last_incident_time_after:** `typing.Optional[dt.datetime]` — If provided, will only return issues whose last incident time was after this datetime.
-
-
-
-
-
-**last_incident_time_before:** `typing.Optional[dt.datetime]` — If provided, will only return issues whose last incident time was before this datetime.
-
-
-
+```python
+from merge import Merge
-
--
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.crm.account_token.retrieve(
+ public_token="public_token",
+)
-**linked_account_id:** `typing.Optional[str]` — If provided, will only include issues pertaining to the linked account passed in.
-
+```
-
-
--
-
-**page_size:** `typing.Optional[int]` — Number of results to return per page.
-
+#### ⚙️ Parameters
+
-
-**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
+**public_token:** `str`
@@ -22580,7 +21981,8 @@ Status of the issue. Options: ('ONGOING', 'RESOLVED')
-client.crm.issues.retrieve(...)
+## Crm Accounts
+client.crm.accounts.list(...)
-
@@ -22592,7 +21994,7 @@ Status of the issue. Options: ('ONGOING', 'RESOLVED')
-
-Get a specific issue.
+Returns a list of `Account` objects.
@@ -22613,9 +22015,14 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.crm.issues.retrieve(
- id="id",
+response = client.crm.accounts.list(
+ cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
)
+for item in response:
+ yield item
+# alternatively, you can paginate page-by-page
+for page in response.iter_pages():
+ yield page
```
@@ -22631,7 +22038,7 @@ client.crm.issues.retrieve(
-
-**id:** `str`
+**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
@@ -22639,98 +22046,44 @@ client.crm.issues.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.
-
-
-
-
-
-
-
-## Crm Leads
-client.crm.leads.list(...)
-
-#### 📝 Description
-
-
--
+**cursor:** `typing.Optional[str]` — The pagination cursor value.
+
+
+
-
-Returns a list of `Lead` objects.
-
-
+**expand:** `typing.Optional[
+ typing.Union[
+ AccountsListRequestExpandItem,
+ typing.Sequence[AccountsListRequestExpandItem],
+ ]
+]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+
-#### 🔌 Usage
-
-
-
--
-
-```python
-import datetime
-
-from merge import Merge
-from merge.resources.crm.resources.leads import LeadsListRequestExpand
-
-client = Merge(
- account_token="YOUR_ACCOUNT_TOKEN",
- api_key="YOUR_API_KEY",
-)
-client.crm.leads.list(
- converted_account_id="converted_account_id",
- converted_contact_id="converted_contact_id",
- created_after=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- created_before=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
- email_addresses="email_addresses",
- expand=LeadsListRequestExpand.CONVERTED_ACCOUNT,
- include_deleted_data=True,
- include_remote_data=True,
- include_remote_fields=True,
- include_shell_data=True,
- modified_after=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- modified_before=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- owner_id="owner_id",
- page_size=1,
- phone_numbers="phone_numbers",
- remote_id="remote_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/).
+
-#### ⚙️ Parameters
-
-
--
-
-
-**converted_account_id:** `typing.Optional[str]` — If provided, will only return leads with this account.
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -22738,7 +22091,7 @@ client.crm.leads.list(
-
-**converted_contact_id:** `typing.Optional[str]` — If provided, will only return leads with this contact.
+**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.
@@ -22746,7 +22099,7 @@ client.crm.leads.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).
@@ -22754,7 +22107,7 @@ client.crm.leads.list(
-
-**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
+**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
@@ -22762,7 +22115,7 @@ client.crm.leads.list(
-
-**cursor:** `typing.Optional[str]` — The pagination cursor value.
+**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
@@ -22770,7 +22123,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.
+**name:** `typing.Optional[str]` — If provided, will only return accounts with this name.
@@ -22778,7 +22131,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.
+**owner_id:** `typing.Optional[str]` — If provided, will only return accounts with this owner.
@@ -22786,7 +22139,7 @@ client.crm.leads.list(
-
-**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
+**page_size:** `typing.Optional[int]` — Number of results to return per page.
@@ -22794,7 +22147,7 @@ client.crm.leads.list(
-
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
+**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
@@ -22802,47 +22155,71 @@ 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.
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
-
--
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
-
+
+client.crm.accounts.create(...)
-
-**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
-
-
-
+#### 📝 Description
-
-**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
-
+
+-
+
+Creates an `Account` object with the given values.
+
+
+#### 🔌 Usage
+
-
-**owner_id:** `typing.Optional[str]` — If provided, will only return leads with this owner.
-
+
+-
+
+```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(),
+)
+
+```
+
+
+#### ⚙️ Parameters
+
-
-**page_size:** `typing.Optional[int]` — Number of results to return per page.
+
+-
+
+**model:** `AccountRequest`
@@ -22850,7 +22227,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.
+**is_debug_mode:** `typing.Optional[bool]` — Whether to include debug fields (such as log file links) in the response.
@@ -22858,7 +22235,7 @@ client.crm.leads.list(
-
-**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
+**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously.
@@ -22878,7 +22255,7 @@ client.crm.leads.list(
-client.crm.leads.create(...)
+client.crm.accounts.retrieve(...)
-
@@ -22890,7 +22267,7 @@ client.crm.leads.list(
-
-Creates a `Lead` object with the given values.
+Returns an `Account` object with the given `id`.
@@ -22906,16 +22283,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(
- is_debug_mode=True,
- run_async=True,
- model=LeadRequest(),
+client.crm.accounts.retrieve(
+ id="id",
)
```
@@ -22932,7 +22306,7 @@ client.crm.leads.create(
-
-**model:** `LeadRequest`
+**id:** `str`
@@ -22940,7 +22314,12 @@ 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[
+ typing.Union[
+ AccountsRetrieveRequestExpandItem,
+ typing.Sequence[AccountsRetrieveRequestExpandItem],
+ ]
+]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -22948,7 +22327,23 @@ 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_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).
@@ -22968,7 +22363,7 @@ client.crm.leads.create(
-client.crm.leads.retrieve(...)
+client.crm.accounts.partial_update(...)
-
@@ -22980,7 +22375,7 @@ client.crm.leads.create(
-
-Returns a `Lead` object with the given `id`.
+Updates an `Account` object with the given `id`.
@@ -22996,18 +22391,15 @@ Returns a `Lead` object with the given `id`.
```python
from merge import Merge
-from merge.resources.crm.resources.leads import LeadsRetrieveRequestExpand
+from merge.resources.crm import PatchedAccountRequest
client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.crm.leads.retrieve(
+client.crm.accounts.partial_update(
id="id",
- expand=LeadsRetrieveRequestExpand.CONVERTED_ACCOUNT,
- include_remote_data=True,
- include_remote_fields=True,
- include_shell_data=True,
+ model=PatchedAccountRequest(),
)
```
@@ -23032,7 +22424,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.
+**model:** `PatchedAccountRequest`
@@ -23040,7 +22432,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.
+**is_debug_mode:** `typing.Optional[bool]` — Whether to include debug fields (such as log file links) in the response.
@@ -23048,7 +22440,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.
+**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously.
@@ -23056,7 +22448,70 @@ 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).
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+
+
+client.crm.accounts.meta_patch_retrieve(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns metadata for `CRMAccount` PATCHs.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.crm.accounts.meta_patch_retrieve(
+ id="id",
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**id:** `str`
@@ -23076,7 +22531,7 @@ client.crm.leads.retrieve(
-client.crm.leads.meta_post_retrieve()
+client.crm.accounts.meta_post_retrieve()
-
@@ -23088,7 +22543,7 @@ client.crm.leads.retrieve(
-
-Returns metadata for `Lead` POSTs.
+Returns metadata for `CRMAccount` POSTs.
@@ -23109,7 +22564,7 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.crm.leads.meta_post_retrieve()
+client.crm.accounts.meta_post_retrieve()
```
@@ -23137,7 +22592,7 @@ client.crm.leads.meta_post_retrieve()
-client.crm.leads.remote_field_classes_list(...)
+client.crm.accounts.remote_field_classes_list(...)
-
@@ -23170,16 +22625,14 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.crm.leads.remote_field_classes_list(
+response = client.crm.accounts.remote_field_classes_list(
cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
- include_deleted_data=True,
- include_remote_data=True,
- include_remote_fields=True,
- include_shell_data=True,
- is_common_model_field=True,
- is_custom=True,
- page_size=1,
)
+for item in response:
+ yield item
+# alternatively, you can paginate page-by-page
+for page in response.iter_pages():
+ yield page
```
@@ -23271,8 +22724,8 @@ client.crm.leads.remote_field_classes_list(
-## Crm LinkToken
-client.crm.link_token.create(...)
+## Crm AsyncPassthrough
+client.crm.async_passthrough.create(...)
-
@@ -23284,7 +22737,7 @@ client.crm.leads.remote_field_classes_list(
-
-Creates a link token to be used when linking a new end user.
+Asynchronously pull data from an endpoint not currently supported by Merge.
@@ -23300,17 +22753,17 @@ 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.crm import DataPassthroughRequest, MethodEnum
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.crm.async_passthrough.create(
+ request=DataPassthroughRequest(
+ method=MethodEnum.GET,
+ path="/scooters",
+ ),
)
```
@@ -23327,7 +22780,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.
+**request:** `DataPassthroughRequest`
@@ -23335,107 +22788,70 @@ client.crm.link_token.create(
-
-**end_user_organization_name:** `str` — Your end user's organization.
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
--
-
-**end_user_origin_id:** `str` — This unique identifier typically represents the ID for your end user in your product's database. This value must be distinct from other Linked Accounts' unique identifiers.
-
-
--
-**categories:** `typing.Sequence[CategoriesEnum]` — The integration categories to show in Merge Link.
-
+
+client.crm.async_passthrough.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
-
-**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.
-
+Retrieves data from earlier async-passthrough POST request
-
-
--
-
-**hide_admin_magic_link:** `typing.Optional[bool]` — Whether to generate a Magic Link URL on the Admin Needed screen during the linking flow. Defaults to false. For more information on Magic Link, see https://merge.dev/blog/integrations-fast-say-hello-to-magic-link.
-
-
--
-
-**common_models:** `typing.Optional[typing.Sequence[CommonModelScopesBodyRequest]]` — An array of objects to specify the models and fields that will be disabled for a given Linked Account. Each object uses model_id, enabled_actions, and disabled_fields to specify the model, method, and fields that are scoped for a given Linked Account.
-
-
-
+#### 🔌 Usage
-
-**category_common_model_scopes:** `typing.Optional[
- typing.Dict[
- str,
- typing.Optional[
- typing.Sequence[IndividualCommonModelScopeDeserializerRequest]
- ],
- ]
-]` — When creating a Link Token, you can set permissions for Common Models that will apply to the account that is going to be linked. Any model or field not specified in link token payload will default to existing settings.
-
-
-
-
-
-**language:** `typing.Optional[EndUserDetailsRequestLanguage]`
+```python
+from merge import Merge
-The following subset of IETF language tags can be used to configure localization.
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.crm.async_passthrough.retrieve(
+ async_passthrough_receipt_id="async_passthrough_receipt_id",
+)
-* `en` - en
-* `de` - de
-
+```
+
+
+
+#### ⚙️ Parameters
-
-**are_syncs_disabled:** `typing.Optional[bool]` — The boolean that indicates whether initial, periodic, and force syncs will be disabled.
-
-
-
-
-
-**integration_specific_config:** `typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]]` — A JSON object containing integration-specific configuration options.
+**async_passthrough_receipt_id:** `str`
@@ -23455,8 +22871,8 @@ The following subset of IETF language tags can be used to configure localization
-## Crm LinkedAccounts
-client.crm.linked_accounts.list(...)
+## Crm AuditTrail
+client.crm.audit_trail.list(...)
-
@@ -23468,7 +22884,7 @@ The following subset of IETF language tags can be used to configure localization
-
-List linked accounts for your organization.
+Gets a list of audit trail events.
@@ -23484,29 +22900,19 @@ List linked accounts for your organization.
```python
from merge import Merge
-from merge.resources.crm.resources.linked_accounts import (
- LinkedAccountsListRequestCategory,
-)
client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.crm.linked_accounts.list(
- category=LinkedAccountsListRequestCategory.ACCOUNTING,
+response = client.crm.audit_trail.list(
cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
- end_user_email_address="end_user_email_address",
- end_user_organization_name="end_user_organization_name",
- end_user_origin_id="end_user_origin_id",
- end_user_origin_ids="end_user_origin_ids",
- id="id",
- ids="ids",
- include_duplicates=True,
- integration_name="integration_name",
- is_test_account="is_test_account",
- page_size=1,
- status="status",
)
+for item in response:
+ yield item
+# alternatively, you can paginate page-by-page
+for page in response.iter_pages():
+ yield page
```
@@ -23522,17 +22928,7 @@ client.crm.linked_accounts.list(
-
-**category:** `typing.Optional[LinkedAccountsListRequestCategory]`
-
-Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing`
-
-* `hris` - hris
-* `ats` - ats
-* `accounting` - accounting
-* `ticketing` - ticketing
-* `crm` - crm
-* `mktg` - mktg
-* `filestorage` - filestorage
+**cursor:** `typing.Optional[str]` — The pagination cursor value.
@@ -23540,7 +22936,7 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing`
-
-**cursor:** `typing.Optional[str]` — The pagination cursor value.
+**end_date:** `typing.Optional[str]` — If included, will only include audit trail events that occurred before this time
@@ -23548,7 +22944,7 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing`
-
-**end_user_email_address:** `typing.Optional[str]` — If provided, will only return linked accounts associated with the given email address.
+**event_type:** `typing.Optional[str]` — If included, will only include events with the given event type. Possible values include: `CREATED_REMOTE_PRODUCTION_API_KEY`, `DELETED_REMOTE_PRODUCTION_API_KEY`, `CREATED_TEST_API_KEY`, `DELETED_TEST_API_KEY`, `REGENERATED_PRODUCTION_API_KEY`, `REGENERATED_WEBHOOK_SIGNATURE`, `INVITED_USER`, `TWO_FACTOR_AUTH_ENABLED`, `TWO_FACTOR_AUTH_DISABLED`, `DELETED_LINKED_ACCOUNT`, `DELETED_ALL_COMMON_MODELS_FOR_LINKED_ACCOUNT`, `CREATED_DESTINATION`, `DELETED_DESTINATION`, `CHANGED_DESTINATION`, `CHANGED_SCOPES`, `CHANGED_PERSONAL_INFORMATION`, `CHANGED_ORGANIZATION_SETTINGS`, `ENABLED_INTEGRATION`, `DISABLED_INTEGRATION`, `ENABLED_CATEGORY`, `DISABLED_CATEGORY`, `CHANGED_PASSWORD`, `RESET_PASSWORD`, `ENABLED_REDACT_UNMAPPED_DATA_FOR_ORGANIZATION`, `ENABLED_REDACT_UNMAPPED_DATA_FOR_LINKED_ACCOUNT`, `DISABLED_REDACT_UNMAPPED_DATA_FOR_ORGANIZATION`, `DISABLED_REDACT_UNMAPPED_DATA_FOR_LINKED_ACCOUNT`, `CREATED_INTEGRATION_WIDE_FIELD_MAPPING`, `CREATED_LINKED_ACCOUNT_FIELD_MAPPING`, `CHANGED_INTEGRATION_WIDE_FIELD_MAPPING`, `CHANGED_LINKED_ACCOUNT_FIELD_MAPPING`, `DELETED_INTEGRATION_WIDE_FIELD_MAPPING`, `DELETED_LINKED_ACCOUNT_FIELD_MAPPING`, `CREATED_LINKED_ACCOUNT_COMMON_MODEL_OVERRIDE`, `CHANGED_LINKED_ACCOUNT_COMMON_MODEL_OVERRIDE`, `DELETED_LINKED_ACCOUNT_COMMON_MODEL_OVERRIDE`, `FORCED_LINKED_ACCOUNT_RESYNC`, `MUTED_ISSUE`, `GENERATED_MAGIC_LINK`, `ENABLED_MERGE_WEBHOOK`, `DISABLED_MERGE_WEBHOOK`, `MERGE_WEBHOOK_TARGET_CHANGED`, `END_USER_CREDENTIALS_ACCESSED`
@@ -23556,7 +22952,7 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing`
-
-**end_user_organization_name:** `typing.Optional[str]` — If provided, will only return linked accounts associated with the given organization name.
+**page_size:** `typing.Optional[int]` — Number of results to return per page.
@@ -23564,7 +22960,7 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing`
-
-**end_user_origin_id:** `typing.Optional[str]` — If provided, will only return linked accounts associated with the given origin ID.
+**start_date:** `typing.Optional[str]` — If included, will only include audit trail events that occurred after this time
@@ -23572,7 +22968,7 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing`
-
-**end_user_origin_ids:** `typing.Optional[str]` — Comma-separated list of EndUser origin IDs, making it possible to specify multiple EndUsers at once.
+**user_email:** `typing.Optional[str]` — If provided, this will return events associated with the specified user email. Please note that the email address reflects the user's email at the time of the event, and may not be their current email.
@@ -23580,59 +22976,65 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing`
-
-**id:** `typing.Optional[str]`
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
-
--
-**ids:** `typing.Optional[str]` — Comma-separated list of LinkedAccount IDs, making it possible to specify multiple LinkedAccounts at once.
-
+
+## Crm AvailableActions
+client.crm.available_actions.retrieve()
-
-**include_duplicates:** `typing.Optional[bool]` — If `true`, will include complete production duplicates of the account specified by the `id` query parameter in the response. `id` must be for a complete production linked account.
-
-
-
+#### 📝 Description
-
-**integration_name:** `typing.Optional[str]` — If provided, will only return linked accounts associated with the given integration name.
-
-
-
-
-
-**is_test_account:** `typing.Optional[str]` — If included, will only include test linked accounts. If not included, will only include non-test linked accounts.
-
+Returns a list of models and actions available for an account.
+
+
+#### 🔌 Usage
+
-
-**page_size:** `typing.Optional[int]` — Number of results to return per page.
-
-
-
-
-
-**status:** `typing.Optional[str]` — Filter by status. Options: `COMPLETE`, `IDLE`, `INCOMPLETE`, `RELINK_NEEDED`
-
+```python
+from merge import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.crm.available_actions.retrieve()
+
+```
+
+
+#### ⚙️ Parameters
+
+
+-
+
-
@@ -23648,8 +23050,8 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing`
-## Crm Notes
-client.crm.notes.list(...)
+## Crm Contacts
+client.crm.contacts.list(...)
-
@@ -23661,7 +23063,7 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing`
-
-Returns a list of `Note` objects.
+Returns a list of `Contact` objects.
@@ -23676,41 +23078,20 @@ Returns a list of `Note` objects.
-
```python
-import datetime
-
from merge import Merge
-from merge.resources.crm.resources.notes import NotesListRequestExpand
client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.crm.notes.list(
- account_id="account_id",
- contact_id="contact_id",
- created_after=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- created_before=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
+response = client.crm.contacts.list(
cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
- expand=NotesListRequestExpand.ACCOUNT,
- include_deleted_data=True,
- include_remote_data=True,
- include_remote_fields=True,
- include_shell_data=True,
- modified_after=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- modified_before=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- opportunity_id="opportunity_id",
- owner_id="owner_id",
- page_size=1,
- remote_id="remote_id",
)
+for item in response:
+ yield item
+# alternatively, you can paginate page-by-page
+for page in response.iter_pages():
+ yield page
```
@@ -23726,15 +23107,7 @@ client.crm.notes.list(
-
-**account_id:** `typing.Optional[str]` — If provided, will only return notes with this account.
-
-
-
-
-
--
-
-**contact_id:** `typing.Optional[str]` — If provided, will only return notes with this contact.
+**account_id:** `typing.Optional[str]` — If provided, will only return contacts with this account.
@@ -23766,7 +23139,7 @@ client.crm.notes.list(
-
-**expand:** `typing.Optional[NotesListRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+**email_addresses:** `typing.Optional[str]` — If provided, will only return contacts matching the email addresses; multiple email_addresses can be separated by commas.
@@ -23774,7 +23147,12 @@ client.crm.notes.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.Union[
+ ContactsListRequestExpandItem,
+ typing.Sequence[ContactsListRequestExpandItem],
+ ]
+]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -23782,7 +23160,7 @@ client.crm.notes.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/).
@@ -23790,7 +23168,7 @@ client.crm.notes.list(
-
-**include_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -23798,7 +23176,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).
+**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.
@@ -23806,7 +23184,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.
+**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -23814,7 +23192,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.
+**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
@@ -23822,7 +23200,7 @@ client.crm.notes.list(
-
-**opportunity_id:** `typing.Optional[str]` — If provided, will only return notes with this opportunity.
+**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
@@ -23830,7 +23208,7 @@ client.crm.notes.list(
-
-**owner_id:** `typing.Optional[str]` — If provided, will only return notes with this owner.
+**page_size:** `typing.Optional[int]` — Number of results to return per page.
@@ -23838,7 +23216,7 @@ client.crm.notes.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.
@@ -23866,7 +23244,7 @@ client.crm.notes.list(
-client.crm.notes.create(...)
+client.crm.contacts.create(...)
-
@@ -23878,7 +23256,7 @@ client.crm.notes.list(
-
-Creates a `Note` object with the given values.
+Creates a `Contact` object with the given values.
@@ -23894,16 +23272,14 @@ Creates a `Note` object with the given values.
```python
from merge import Merge
-from merge.resources.crm import NoteRequest
+from merge.resources.crm import ContactRequest
client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.crm.notes.create(
- is_debug_mode=True,
- run_async=True,
- model=NoteRequest(),
+client.crm.contacts.create(
+ model=ContactRequest(),
)
```
@@ -23920,7 +23296,7 @@ client.crm.notes.create(
-
-**model:** `NoteRequest`
+**model:** `ContactRequest`
@@ -23956,7 +23332,7 @@ client.crm.notes.create(
-client.crm.notes.retrieve(...)
+client.crm.contacts.retrieve(...)
-
@@ -23968,7 +23344,7 @@ client.crm.notes.create(
-
-Returns a `Note` object with the given `id`.
+Returns a `Contact` object with the given `id`.
@@ -23984,18 +23360,13 @@ Returns a `Note` object with the given `id`.
```python
from merge import Merge
-from merge.resources.crm.resources.notes import NotesRetrieveRequestExpand
client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.crm.notes.retrieve(
+client.crm.contacts.retrieve(
id="id",
- expand=NotesRetrieveRequestExpand.ACCOUNT,
- include_remote_data=True,
- include_remote_fields=True,
- include_shell_data=True,
)
```
@@ -24020,7 +23391,12 @@ 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[
+ typing.Union[
+ ContactsRetrieveRequestExpandItem,
+ typing.Sequence[ContactsRetrieveRequestExpandItem],
+ ]
+]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -24064,68 +23440,7 @@ client.crm.notes.retrieve(
-client.crm.notes.meta_post_retrieve()
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Returns metadata for `Note` POSTs.
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from merge import Merge
-
-client = Merge(
- account_token="YOUR_ACCOUNT_TOKEN",
- api_key="YOUR_API_KEY",
-)
-client.crm.notes.meta_post_retrieve()
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-
-
-client.crm.notes.remote_field_classes_list(...)
+client.crm.contacts.partial_update(...)
-
@@ -24137,7 +23452,7 @@ client.crm.notes.meta_post_retrieve()
-
-Returns a list of `RemoteFieldClass` objects.
+Updates a `Contact` object with the given `id`.
@@ -24153,20 +23468,15 @@ Returns a list of `RemoteFieldClass` 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.crm.notes.remote_field_classes_list(
- cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
- include_deleted_data=True,
- include_remote_data=True,
- include_remote_fields=True,
- include_shell_data=True,
- is_common_model_field=True,
- is_custom=True,
- page_size=1,
+client.crm.contacts.partial_update(
+ id="id",
+ model=PatchedContactRequest(),
)
```
@@ -24183,39 +23493,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/).
-
-
-
-
-
--
-
-**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).
+**id:** `str`
@@ -24223,7 +23501,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
+**model:** `PatchedContactRequest`
@@ -24231,7 +23509,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
+**is_debug_mode:** `typing.Optional[bool]` — Whether to include debug fields (such as log file links) in the response.
@@ -24239,7 +23517,7 @@ client.crm.notes.remote_field_classes_list(
-
-**page_size:** `typing.Optional[int]` — Number of results to return per page.
+**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously.
@@ -24259,8 +23537,7 @@ client.crm.notes.remote_field_classes_list(
-## Crm Opportunities
-client.crm.opportunities.list(...)
+client.crm.contacts.ignore_create(...)
-
@@ -24272,7 +23549,7 @@ client.crm.notes.remote_field_classes_list(
-
-Returns a list of `Opportunity` objects.
+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.
@@ -24287,46 +23564,18 @@ Returns a list of `Opportunity` objects.
-
```python
-import datetime
-
from merge import Merge
-from merge.resources.crm.resources.opportunities import (
- OpportunitiesListRequestExpand,
- OpportunitiesListRequestStatus,
-)
+from merge.resources.crm import IgnoreCommonModelRequest, ReasonEnum
client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.crm.opportunities.list(
- account_id="account_id",
- created_after=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- created_before=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
- expand=OpportunitiesListRequestExpand.ACCOUNT,
- include_deleted_data=True,
- include_remote_data=True,
- include_remote_fields=True,
- include_shell_data=True,
- modified_after=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- modified_before=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- owner_id="owner_id",
- page_size=1,
- remote_created_after=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
+client.crm.contacts.ignore_create(
+ model_id="model_id",
+ request=IgnoreCommonModelRequest(
+ reason=ReasonEnum.GENERAL_CUSTOMER_REQUEST,
),
- remote_id="remote_id",
- stage_id="stage_id",
- status=OpportunitiesListRequestStatus.LOST,
)
```
@@ -24343,23 +23592,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.
+**model_id:** `str`
@@ -24367,7 +23600,7 @@ client.crm.opportunities.list(
-
-**cursor:** `typing.Optional[str]` — The pagination cursor value.
+**request:** `IgnoreCommonModelRequest`
@@ -24375,125 +23608,70 @@ client.crm.opportunities.list(
-
-**expand:** `typing.Optional[OpportunitiesListRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+**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.contacts.meta_patch_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.
-
+Returns metadata for `CRMContact` PATCHs.
-
-
--
-
-**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.
-
-
-
+#### 🔌 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.crm.contacts.meta_patch_retrieve(
+ id="id",
+)
-**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.
-
-
--
-
-**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)
-
-
-
+#### ⚙️ Parameters
-
-**stage_id:** `typing.Optional[str]` — If provided, will only return opportunities with this stage.
-
-
-
-
-
-**status:** `typing.Optional[OpportunitiesListRequestStatus]`
-
-If provided, will only return opportunities with this status. Options: ('OPEN', 'WON', 'LOST')
-
-* `OPEN` - OPEN
-* `WON` - WON
-* `LOST` - LOST
+**id:** `str`
@@ -24513,7 +23691,7 @@ If provided, will only return opportunities with this status. Options: ('OPEN',
-client.crm.opportunities.create(...)
+client.crm.contacts.meta_post_retrieve()
-
@@ -24525,7 +23703,7 @@ If provided, will only return opportunities with this status. Options: ('OPEN',
-
-Creates an `Opportunity` object with the given values.
+Returns metadata for `CRMContact` POSTs.
@@ -24541,17 +23719,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(
- is_debug_mode=True,
- run_async=True,
- model=OpportunityRequest(),
-)
+client.crm.contacts.meta_post_retrieve()
```
@@ -24567,30 +23740,6 @@ client.crm.opportunities.create(
-
-**model:** `OpportunityRequest`
-
-
-
-
-
--
-
-**is_debug_mode:** `typing.Optional[bool]` — Whether to include debug fields (such as log file links) in the response.
-
-
-
-
-
--
-
-**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously.
-
-
-
-
-
--
-
**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -24603,7 +23752,7 @@ client.crm.opportunities.create(
-client.crm.opportunities.retrieve(...)
+client.crm.contacts.remote_field_classes_list(...)
-
@@ -24615,7 +23764,7 @@ client.crm.opportunities.create(
-
-Returns an `Opportunity` object with the given `id`.
+Returns a list of `RemoteFieldClass` objects.
@@ -24631,21 +23780,19 @@ Returns an `Opportunity` object with the given `id`.
```python
from merge import Merge
-from merge.resources.crm.resources.opportunities import (
- OpportunitiesRetrieveRequestExpand,
-)
client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.crm.opportunities.retrieve(
- id="id",
- expand=OpportunitiesRetrieveRequestExpand.ACCOUNT,
- include_remote_data=True,
- include_remote_fields=True,
- include_shell_data=True,
+response = client.crm.contacts.remote_field_classes_list(
+ cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
)
+for item in response:
+ yield item
+# alternatively, you can paginate page-by-page
+for page in response.iter_pages():
+ yield page
```
@@ -24661,7 +23808,7 @@ client.crm.opportunities.retrieve(
-
-**id:** `str`
+**cursor:** `typing.Optional[str]` — The pagination cursor value.
@@ -24669,7 +23816,7 @@ client.crm.opportunities.retrieve(
-
-**expand:** `typing.Optional[OpportunitiesRetrieveRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
@@ -24701,7 +23848,7 @@ client.crm.opportunities.retrieve(
-
-**remote_fields:** `typing.Optional[typing.Literal["status"]]` — 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
@@ -24709,7 +23856,15 @@ client.crm.opportunities.retrieve(
-
-**show_enum_origins:** `typing.Optional[typing.Literal["status"]]` — A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter)
+**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.
@@ -24729,7 +23884,8 @@ client.crm.opportunities.retrieve(
-client.crm.opportunities.partial_update(...)
+## Crm CustomObjectClasses
+client.crm.custom_object_classes.list(...)
-
@@ -24741,7 +23897,7 @@ client.crm.opportunities.retrieve(
-
-Updates an `Opportunity` object with the given `id`.
+Returns a list of `CustomObjectClass` objects.
@@ -24757,18 +23913,19 @@ 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",
- is_debug_mode=True,
- run_async=True,
- model=PatchedOpportunityRequest(),
+response = client.crm.custom_object_classes.list(
+ cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
)
+for item in response:
+ yield item
+# alternatively, you can paginate page-by-page
+for page in response.iter_pages():
+ yield page
```
@@ -24784,7 +23941,7 @@ client.crm.opportunities.partial_update(
-
-**id:** `str`
+**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
@@ -24792,7 +23949,7 @@ client.crm.opportunities.partial_update(
-
-**model:** `PatchedOpportunityRequest`
+**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
@@ -24800,7 +23957,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.
@@ -24808,7 +23965,12 @@ client.crm.opportunities.partial_update(
-
-**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously.
+**expand:** `typing.Optional[
+ typing.Union[
+ CustomObjectClassesListRequestExpandItem,
+ typing.Sequence[CustomObjectClassesListRequestExpandItem],
+ ]
+]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -24816,70 +23978,55 @@ client.crm.opportunities.partial_update(
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
-
-
+
+-
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
+
-
-client.crm.opportunities.meta_patch_retrieve(...)
-
-#### 📝 Description
-
-
--
+**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
+
+
+
-
-Returns metadata for `Opportunity` PATCHs.
-
-
+**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
+
-#### 🔌 Usage
-
-
-
--
-
-```python
-from merge import Merge
-
-client = Merge(
- account_token="YOUR_ACCOUNT_TOKEN",
- api_key="YOUR_API_KEY",
-)
-client.crm.opportunities.meta_patch_retrieve(
- id="id",
-)
-
-```
-
-
+**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
+
-#### ⚙️ Parameters
-
-
+**page_size:** `typing.Optional[int]` — Number of results to return per page.
+
+
+
+
-
-**id:** `str`
+**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
@@ -24899,7 +24046,7 @@ client.crm.opportunities.meta_patch_retrieve(
-client.crm.opportunities.meta_post_retrieve()
+client.crm.custom_object_classes.retrieve(...)
-
@@ -24911,7 +24058,7 @@ client.crm.opportunities.meta_patch_retrieve(
-
-Returns metadata for `Opportunity` POSTs.
+Returns a `CustomObjectClass` object with the given `id`.
@@ -24932,7 +24079,9 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.crm.opportunities.meta_post_retrieve()
+client.crm.custom_object_classes.retrieve(
+ id="id",
+)
```
@@ -24948,6 +24097,43 @@ client.crm.opportunities.meta_post_retrieve()
-
+**id:** `str`
+
+
+
+
+
+-
+
+**expand:** `typing.Optional[
+ typing.Union[
+ CustomObjectClassesRetrieveRequestExpandItem,
+ typing.Sequence[CustomObjectClassesRetrieveRequestExpandItem],
+ ]
+]` — 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.
@@ -24960,7 +24146,8 @@ client.crm.opportunities.meta_post_retrieve()
-client.crm.opportunities.remote_field_classes_list(...)
+## Crm AssociationTypes
+client.crm.association_types.custom_object_classes_association_types_list(...)
-
@@ -24972,7 +24159,7 @@ client.crm.opportunities.meta_post_retrieve()
-
-Returns a list of `RemoteFieldClass` objects.
+Returns a list of `AssociationType` objects.
@@ -24993,16 +24180,17 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.crm.opportunities.remote_field_classes_list(
- cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
- include_deleted_data=True,
- include_remote_data=True,
- include_remote_fields=True,
- include_shell_data=True,
- is_common_model_field=True,
- is_custom=True,
- page_size=1,
+response = (
+ client.crm.association_types.custom_object_classes_association_types_list(
+ custom_object_class_id="custom_object_class_id",
+ cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
+ )
)
+for item in response:
+ yield item
+# alternatively, you can paginate page-by-page
+for page in response.iter_pages():
+ yield page
```
@@ -25018,7 +24206,7 @@ client.crm.opportunities.remote_field_classes_list(
-
-**cursor:** `typing.Optional[str]` — The pagination cursor value.
+**custom_object_class_id:** `str`
@@ -25026,7 +24214,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/).
+**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
@@ -25034,7 +24222,7 @@ client.crm.opportunities.remote_field_classes_list(
-
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
+**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
@@ -25042,7 +24230,7 @@ client.crm.opportunities.remote_field_classes_list(
-
-**include_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.
+**cursor:** `typing.Optional[str]` — The pagination cursor value.
@@ -25050,7 +24238,14 @@ 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).
+**expand:** `typing.Optional[
+ typing.Union[
+ CustomObjectClassesAssociationTypesListRequestExpandItem,
+ typing.Sequence[
+ CustomObjectClassesAssociationTypesListRequestExpandItem
+ ],
+ ]
+]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -25058,7 +24253,7 @@ client.crm.opportunities.remote_field_classes_list(
-
-**is_common_model_field:** `typing.Optional[bool]` — If provided, will only return remote field classes with this is_common_model_field value
+**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
@@ -25066,7 +24261,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_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -25074,7 +24269,7 @@ client.crm.opportunities.remote_field_classes_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).
@@ -25082,75 +24277,31 @@ client.crm.opportunities.remote_field_classes_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.
-
-
-
-
-
-
-
-
-## Crm Passthrough
-client.crm.passthrough.create(...)
-
--
-
-#### 📝 Description
-
-
--
-
-Pull data from an endpoint not currently supported by Merge.
-
-
+**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
+
-#### 🔌 Usage
-
-
--
-
-
-```python
-from merge import Merge
-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",
- ),
-)
-
-```
-
-
+**page_size:** `typing.Optional[int]` — Number of results to return per page.
+
-#### ⚙️ Parameters
-
-
-
--
-
-**request:** `DataPassthroughRequest`
+**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
@@ -25170,8 +24321,7 @@ client.crm.passthrough.create(
-## Crm RegenerateKey
-client.crm.regenerate_key.create(...)
+client.crm.association_types.custom_object_classes_association_types_create(...)
-
@@ -25183,7 +24333,7 @@ client.crm.passthrough.create(
-
-Exchange remote keys.
+Creates an `AssociationType` object with the given values.
@@ -25199,13 +24349,31 @@ Exchange remote keys.
```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.regenerate_key.create(
- name="Remote Deployment Key 1",
+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",
+ ),
)
```
@@ -25222,7 +24390,31 @@ client.crm.regenerate_key.create(
-
-**name:** `str` — The name of the remote key
+**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.
@@ -25242,8 +24434,7 @@ client.crm.regenerate_key.create(
-## Crm Stages
-client.crm.stages.list(...)
+client.crm.association_types.custom_object_classes_association_types_retrieve(...)
-
@@ -25255,7 +24446,7 @@ client.crm.regenerate_key.create(
-
-Returns a list of `Stage` objects.
+Returns an `AssociationType` object with the given `id`.
@@ -25270,34 +24461,15 @@ Returns a list of `Stage` objects.
-
```python
-import datetime
-
from merge import Merge
client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.crm.stages.list(
- created_after=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- created_before=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
- include_deleted_data=True,
- include_remote_data=True,
- include_remote_fields=True,
- include_shell_data=True,
- modified_after=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- modified_before=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- page_size=1,
- remote_id="remote_id",
+client.crm.association_types.custom_object_classes_association_types_retrieve(
+ custom_object_class_id="custom_object_class_id",
+ id="id",
)
```
@@ -25314,7 +24486,7 @@ client.crm.stages.list(
-
-**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
+**custom_object_class_id:** `str`
@@ -25322,7 +24494,7 @@ client.crm.stages.list(
-
-**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
+**id:** `str`
@@ -25330,7 +24502,14 @@ client.crm.stages.list(
-
-**cursor:** `typing.Optional[str]` — The pagination cursor value.
+**expand:** `typing.Optional[
+ typing.Union[
+ CustomObjectClassesAssociationTypesRetrieveRequestExpandItem,
+ typing.Sequence[
+ CustomObjectClassesAssociationTypesRetrieveRequestExpandItem
+ ],
+ ]
+]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -25338,7 +24517,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/).
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -25346,7 +24525,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.
+**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -25354,47 +24533,70 @@ 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.
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
-
--
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
-
+
+client.crm.association_types.custom_object_classes_association_types_meta_post_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.
-
+
+-
+
+Returns metadata for `CRMAssociationType` POSTs.
+
+
+#### 🔌 Usage
+
-
-**page_size:** `typing.Optional[int]` — Number of results to return per page.
-
+
+-
+
+```python
+from merge import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.crm.association_types.custom_object_classes_association_types_meta_post_retrieve(
+ custom_object_class_id="custom_object_class_id",
+)
+
+```
+
+
+#### ⚙️ Parameters
+
-
-**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
+
+-
+
+**custom_object_class_id:** `str`
@@ -25414,7 +24616,8 @@ client.crm.stages.list(
-client.crm.stages.retrieve(...)
+## Crm CustomObjects
+client.crm.custom_objects.custom_object_classes_custom_objects_list(...)
-
@@ -25426,7 +24629,7 @@ client.crm.stages.list(
-
-Returns a `Stage` object with the given `id`.
+Returns a list of `CustomObject` objects.
@@ -25447,12 +24650,15 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.crm.stages.retrieve(
- id="id",
- include_remote_data=True,
- include_remote_fields=True,
- include_shell_data=True,
+response = client.crm.custom_objects.custom_object_classes_custom_objects_list(
+ custom_object_class_id="custom_object_class_id",
+ cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
)
+for item in response:
+ yield item
+# alternatively, you can paginate page-by-page
+for page in response.iter_pages():
+ yield page
```
@@ -25468,7 +24674,39 @@ client.crm.stages.retrieve(
-
-**id:** `str`
+**custom_object_class_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/).
@@ -25500,6 +24738,38 @@ client.crm.stages.retrieve(
-
+**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
+
+
+
+
+
+-
+
+**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
+
+
+
+
+
+-
+
+**page_size:** `typing.Optional[int]` — Number of results to return per page.
+
+
+
+
+
+-
+
+**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
+
+
+
+
+
+-
+
**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -25512,7 +24782,7 @@ client.crm.stages.retrieve(
-client.crm.stages.remote_field_classes_list(...)
+client.crm.custom_objects.custom_object_classes_custom_objects_create(...)
-
@@ -25524,7 +24794,7 @@ client.crm.stages.retrieve(
-
-Returns a list of `RemoteFieldClass` objects.
+Creates a `CustomObject` object with the given values.
@@ -25540,20 +24810,17 @@ Returns a list of `RemoteFieldClass` objects.
```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.stages.remote_field_classes_list(
- cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
- include_deleted_data=True,
- include_remote_data=True,
- include_remote_fields=True,
- include_shell_data=True,
- is_common_model_field=True,
- is_custom=True,
- page_size=1,
+client.crm.custom_objects.custom_object_classes_custom_objects_create(
+ custom_object_class_id="custom_object_class_id",
+ model=CustomObjectRequest(
+ fields={"test_field": "hello"},
+ ),
)
```
@@ -25570,39 +24837,7 @@ client.crm.stages.remote_field_classes_list(
-
-**cursor:** `typing.Optional[str]` — The pagination cursor value.
-
-
-
-
-
--
-
-**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
-
-
-
-
-
--
-
-**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).
+**custom_object_class_id:** `str`
@@ -25610,7 +24845,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
+**model:** `CustomObjectRequest`
@@ -25618,7 +24853,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
+**is_debug_mode:** `typing.Optional[bool]` — Whether to include debug fields (such as log file links) in the response.
@@ -25626,7 +24861,7 @@ client.crm.stages.remote_field_classes_list(
-
-**page_size:** `typing.Optional[int]` — Number of results to return per page.
+**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously.
@@ -25646,8 +24881,7 @@ client.crm.stages.remote_field_classes_list(
-## Crm SyncStatus
-client.crm.sync_status.list(...)
+client.crm.custom_objects.custom_object_classes_custom_objects_retrieve(...)
-
@@ -25659,7 +24893,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 `CustomObject` object with the given `id`.
@@ -25680,9 +24914,9 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.crm.sync_status.list(
- cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
- page_size=1,
+client.crm.custom_objects.custom_object_classes_custom_objects_retrieve(
+ custom_object_class_id="custom_object_class_id",
+ id="id",
)
```
@@ -25699,7 +24933,7 @@ client.crm.sync_status.list(
-
-**cursor:** `typing.Optional[str]` — The pagination cursor value.
+**custom_object_class_id:** `str`
@@ -25707,7 +24941,31 @@ client.crm.sync_status.list(
-
-**page_size:** `typing.Optional[int]` — Number of results to return per page.
+**id:** `str`
+
+
+
+
+
+-
+
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
+
+
+
+
+
+-
+
+**include_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.
+
+
+
+
+
+-
+
+**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -25727,8 +24985,7 @@ client.crm.sync_status.list(
-## Crm ForceResync
-client.crm.force_resync.sync_status_resync_create()
+client.crm.custom_objects.custom_object_classes_custom_objects_meta_post_retrieve(...)
-
@@ -25740,7 +24997,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.
+Returns metadata for `CRMCustomObject` POSTs.
@@ -25761,7 +25018,9 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.crm.force_resync.sync_status_resync_create()
+client.crm.custom_objects.custom_object_classes_custom_objects_meta_post_retrieve(
+ custom_object_class_id="custom_object_class_id",
+)
```
@@ -25777,6 +25036,14 @@ client.crm.force_resync.sync_status_resync_create()
-
+**custom_object_class_id:** `str`
+
+
+
+
+
+-
+
**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -25789,8 +25056,7 @@ client.crm.force_resync.sync_status_resync_create()
-## Crm Tasks
-client.crm.tasks.list(...)
+client.crm.custom_objects.custom_object_classes_custom_objects_remote_field_classes_list(...)
-
@@ -25802,7 +25068,7 @@ client.crm.force_resync.sync_status_resync_create()
-
-Returns a list of `Task` objects.
+Returns a list of `RemoteFieldClass` objects.
@@ -25817,37 +25083,20 @@ Returns a list of `Task` objects.
-
```python
-import datetime
-
from merge import Merge
-from merge.resources.crm.resources.tasks import TasksListRequestExpand
client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.crm.tasks.list(
- created_after=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- created_before=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
+response = client.crm.custom_objects.custom_object_classes_custom_objects_remote_field_classes_list(
cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
- expand=TasksListRequestExpand.ACCOUNT,
- include_deleted_data=True,
- include_remote_data=True,
- include_remote_fields=True,
- include_shell_data=True,
- modified_after=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- modified_before=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- page_size=1,
- remote_id="remote_id",
)
+for item in response:
+ yield item
+# alternatively, you can paginate page-by-page
+for page in response.iter_pages():
+ yield page
```
@@ -25863,22 +25112,6 @@ client.crm.tasks.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.
@@ -25887,14 +25120,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/).
@@ -25927,7 +25152,7 @@ client.crm.tasks.list(
-
-**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
+**is_common_model_field:** `typing.Optional[bool]` — If provided, will only return remote field classes with this is_common_model_field value
@@ -25935,7 +25160,7 @@ client.crm.tasks.list(
-
-**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
+**is_custom:** `typing.Optional[bool]` — If provided, will only return remote fields classes with this is_custom value
@@ -25951,14 +25176,6 @@ client.crm.tasks.list(
-
-**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
-
-
-
-
-
--
-
**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -25971,7 +25188,8 @@ client.crm.tasks.list(
-client.crm.tasks.create(...)
+## Crm Associations
+client.crm.associations.custom_object_classes_custom_objects_associations_list(...)
-
@@ -25983,7 +25201,7 @@ client.crm.tasks.list(
-
-Creates a `Task` object with the given values.
+Returns a list of `Association` objects.
@@ -25999,17 +25217,21 @@ 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(
- is_debug_mode=True,
- run_async=True,
- model=TaskRequest(),
+response = client.crm.associations.custom_object_classes_custom_objects_associations_list(
+ custom_object_class_id="custom_object_class_id",
+ object_id="object_id",
+ cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
)
+for item in response:
+ yield item
+# alternatively, you can paginate page-by-page
+for page in response.iter_pages():
+ yield page
```
@@ -26025,7 +25247,7 @@ client.crm.tasks.create(
-
-**model:** `TaskRequest`
+**custom_object_class_id:** `str`
@@ -26033,7 +25255,7 @@ client.crm.tasks.create(
-
-**is_debug_mode:** `typing.Optional[bool]` — Whether to include debug fields (such as log file links) in the response.
+**object_id:** `str`
@@ -26041,7 +25263,7 @@ client.crm.tasks.create(
-
-**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously.
+**association_type_id:** `typing.Optional[str]` — If provided, will only return opportunities with this association_type.
@@ -26049,75 +25271,62 @@ client.crm.tasks.create(
-
-**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.retrieve(...)
-
-#### 📝 Description
-
-
--
+**cursor:** `typing.Optional[str]` — The pagination cursor value.
+
+
+
-
-Returns a `Task` object with the given `id`.
-
-
+**expand:** `typing.Optional[
+ typing.Union[
+ CustomObjectClassesCustomObjectsAssociationsListRequestExpandItem,
+ typing.Sequence[
+ CustomObjectClassesCustomObjectsAssociationsListRequestExpandItem
+ ],
+ ]
+]` — 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.crm.resources.tasks import TasksRetrieveRequestExpand
-
-client = Merge(
- account_token="YOUR_ACCOUNT_TOKEN",
- api_key="YOUR_API_KEY",
-)
-client.crm.tasks.retrieve(
- id="id",
- expand=TasksRetrieveRequestExpand.ACCOUNT,
- include_remote_data=True,
- include_remote_fields=True,
- include_shell_data=True,
-)
-
-```
-
-
+**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is 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.
+
+
+
+
-
-**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).
@@ -26125,7 +25334,7 @@ client.crm.tasks.retrieve(
-
-**expand:** `typing.Optional[TasksRetrieveRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
@@ -26133,7 +25342,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.
+**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
@@ -26141,7 +25350,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.
+**page_size:** `typing.Optional[int]` — Number of results to return per page.
@@ -26149,7 +25358,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).
+**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
@@ -26169,7 +25378,7 @@ client.crm.tasks.retrieve(
-client.crm.tasks.partial_update(...)
+client.crm.associations.custom_object_classes_custom_objects_associations_update(...)
-
@@ -26181,7 +25390,7 @@ client.crm.tasks.retrieve(
-
-Updates a `Task` object with the given `id`.
+Creates an Association between `source_object_id` and `target_object_id` of type `association_type_id`.
@@ -26197,17 +25406,17 @@ 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(
- id="id",
- is_debug_mode=True,
- run_async=True,
- model=PatchedTaskRequest(),
+client.crm.associations.custom_object_classes_custom_objects_associations_update(
+ source_class_id="source_class_id",
+ source_object_id="source_object_id",
+ target_class_id="target_class_id",
+ target_object_id="target_object_id",
+ association_type_id="association_type_id",
)
```
@@ -26224,7 +25433,7 @@ client.crm.tasks.partial_update(
-
-**id:** `str`
+**source_class_id:** `str`
@@ -26232,7 +25441,31 @@ client.crm.tasks.partial_update(
-
-**model:** `PatchedTaskRequest`
+**source_object_id:** `str`
+
+
+
+
+
+-
+
+**target_class_id:** `str`
+
+
+
+
+
+-
+
+**target_object_id:** `str`
+
+
+
+
+
+-
+
+**association_type_id:** `str`
@@ -26268,7 +25501,8 @@ client.crm.tasks.partial_update(
-client.crm.tasks.meta_patch_retrieve(...)
+## Crm Scopes
+client.crm.scopes.default_scopes_retrieve()
-
@@ -26280,7 +25514,7 @@ client.crm.tasks.partial_update(
-
-Returns metadata for `Task` PATCHs.
+Get the default permissions for Merge Common Models and fields across all Linked Accounts of a given category. [Learn more](https://help.merge.dev/en/articles/5950052-common-model-and-field-scopes).
@@ -26301,9 +25535,7 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.crm.tasks.meta_patch_retrieve(
- id="id",
-)
+client.crm.scopes.default_scopes_retrieve()
```
@@ -26319,14 +25551,6 @@ client.crm.tasks.meta_patch_retrieve(
-
-**id:** `str`
-
-
-
-
-
--
-
**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -26339,7 +25563,7 @@ client.crm.tasks.meta_patch_retrieve(
-client.crm.tasks.meta_post_retrieve()
+client.crm.scopes.linked_account_scopes_retrieve()
-
@@ -26351,7 +25575,7 @@ client.crm.tasks.meta_patch_retrieve(
-
-Returns metadata for `Task` POSTs.
+Get all available permissions for Merge Common Models and fields for a single Linked Account. [Learn more](https://help.merge.dev/en/articles/5950052-common-model-and-field-scopes).
@@ -26372,7 +25596,7 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.crm.tasks.meta_post_retrieve()
+client.crm.scopes.linked_account_scopes_retrieve()
```
@@ -26400,7 +25624,7 @@ client.crm.tasks.meta_post_retrieve()
-client.crm.tasks.remote_field_classes_list(...)
+client.crm.scopes.linked_account_scopes_create(...)
-
@@ -26412,7 +25636,7 @@ client.crm.tasks.meta_post_retrieve()
-
-Returns a list of `RemoteFieldClass` objects.
+Update permissions for any Common Model or field for a single Linked Account. Any Scopes not set in this POST request will inherit the default Scopes. [Learn more](https://help.merge.dev/en/articles/5950052-common-model-and-field-scopes)
@@ -26428,20 +25652,42 @@ Returns a list of `RemoteFieldClass` 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.crm.tasks.remote_field_classes_list(
- cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
- include_deleted_data=True,
- include_remote_data=True,
- include_remote_fields=True,
- include_shell_data=True,
- is_common_model_field=True,
- is_custom=True,
- page_size=1,
+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,
+ )
+ },
+ ),
+ ],
)
```
@@ -26458,7 +25704,7 @@ client.crm.tasks.remote_field_classes_list(
-
-**cursor:** `typing.Optional[str]` — The pagination cursor value.
+**common_models:** `typing.Sequence[IndividualCommonModelScopeDeserializerRequest]` — The common models you want to update the scopes for
@@ -26466,58 +25712,64 @@ client.crm.tasks.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.
-
+
+## Crm DeleteAccount
+client.crm.delete_account.delete()
-
-**include_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.
-
-
-
+#### 📝 Description
-
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
-
-
-
-
-
-**is_common_model_field:** `typing.Optional[bool]` — If provided, will only return remote field classes with this is_common_model_field value
-
+Delete a linked account.
+
+
+#### 🔌 Usage
+
-
-**is_custom:** `typing.Optional[bool]` — If provided, will only return remote fields classes with this is_custom value
-
-
-
-
-
-**page_size:** `typing.Optional[int]` — Number of results to return per page.
-
+```python
+from merge import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.crm.delete_account.delete()
+
+```
+
+
+
+#### ⚙️ Parameters
+
+
+-
-
@@ -26534,8 +25786,8 @@ client.crm.tasks.remote_field_classes_list(
-## Crm Users
-client.crm.users.list(...)
+## Crm EngagementTypes
+client.crm.engagement_types.list(...)
-
@@ -26547,7 +25799,7 @@ client.crm.tasks.remote_field_classes_list(
-
-Returns a list of `User` objects.
+Returns a list of `EngagementType` objects.
@@ -26562,36 +25814,20 @@ Returns a list of `User` objects.
-
```python
-import datetime
-
from merge import Merge
client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.crm.users.list(
- created_after=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- created_before=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
+response = client.crm.engagement_types.list(
cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
- email="email",
- include_deleted_data=True,
- include_remote_data=True,
- include_remote_fields=True,
- include_shell_data=True,
- modified_after=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- modified_before=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- page_size=1,
- remote_id="remote_id",
)
+for item in response:
+ yield item
+# alternatively, you can paginate page-by-page
+for page in response.iter_pages():
+ yield page
```
@@ -26631,14 +25867,6 @@ client.crm.users.list(
-
-**email:** `typing.Optional[str]` — If provided, will only return users with this email.
-
-
-
-
-
--
-
**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
@@ -26715,7 +25943,7 @@ client.crm.users.list(
-client.crm.users.retrieve(...)
+client.crm.engagement_types.retrieve(...)
-
@@ -26727,7 +25955,7 @@ client.crm.users.list(
-
-Returns a `User` object with the given `id`.
+Returns an `EngagementType` object with the given `id`.
@@ -26748,11 +25976,8 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.crm.users.retrieve(
+client.crm.engagement_types.retrieve(
id="id",
- include_remote_data=True,
- include_remote_fields=True,
- include_shell_data=True,
)
```
@@ -26813,7 +26038,7 @@ client.crm.users.retrieve(
-client.crm.users.ignore_create(...)
+client.crm.engagement_types.remote_field_classes_list(...)
-
@@ -26825,7 +26050,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 `RemoteFieldClass` objects.
@@ -26841,18 +26066,19 @@ 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,
- ),
+response = client.crm.engagement_types.remote_field_classes_list(
+ cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
)
+for item in response:
+ yield item
+# alternatively, you can paginate page-by-page
+for page in response.iter_pages():
+ yield page
```
@@ -26868,7 +26094,7 @@ client.crm.users.ignore_create(
-
-**model_id:** `str`
+**cursor:** `typing.Optional[str]` — The pagination cursor value.
@@ -26876,7 +26102,55 @@ client.crm.users.ignore_create(
-
-**request:** `IgnoreCommonModelRequest`
+**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is 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.
@@ -26896,7 +26170,8 @@ client.crm.users.ignore_create(
-client.crm.users.remote_field_classes_list(...)
+## Crm Engagements
+client.crm.engagements.list(...)
-
@@ -26908,7 +26183,7 @@ client.crm.users.ignore_create(
-
-Returns a list of `RemoteFieldClass` objects.
+Returns a list of `Engagement` objects.
@@ -26929,16 +26204,14 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.crm.users.remote_field_classes_list(
+response = client.crm.engagements.list(
cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
- include_deleted_data=True,
- include_remote_data=True,
- include_remote_fields=True,
- include_shell_data=True,
- is_common_model_field=True,
- is_custom=True,
- page_size=1,
)
+for item in response:
+ yield item
+# alternatively, you can paginate page-by-page
+for page in response.iter_pages():
+ yield page
```
@@ -26954,7 +26227,7 @@ client.crm.users.remote_field_classes_list(
-
-**cursor:** `typing.Optional[str]` — The pagination cursor value.
+**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
@@ -26962,7 +26235,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/).
+**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
@@ -26970,7 +26243,7 @@ client.crm.users.remote_field_classes_list(
-
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
+**cursor:** `typing.Optional[str]` — The pagination cursor value.
@@ -26978,7 +26251,12 @@ client.crm.users.remote_field_classes_list(
-
-**include_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.
+**expand:** `typing.Optional[
+ typing.Union[
+ EngagementsListRequestExpandItem,
+ typing.Sequence[EngagementsListRequestExpandItem],
+ ]
+]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -26986,7 +26264,7 @@ client.crm.users.remote_field_classes_list(
-
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
+**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
@@ -26994,7 +26272,7 @@ client.crm.users.remote_field_classes_list(
-
-**is_common_model_field:** `typing.Optional[bool]` — If provided, will only return remote field classes with this is_common_model_field value
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -27002,7 +26280,7 @@ client.crm.users.remote_field_classes_list(
-
-**is_custom:** `typing.Optional[bool]` — If provided, will only return remote fields classes with this is_custom value
+**include_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.
@@ -27010,7 +26288,7 @@ client.crm.users.remote_field_classes_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).
@@ -27018,65 +26296,51 @@ client.crm.users.remote_field_classes_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.
-
-
+
+-
+**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
+
-
-## Crm WebhookReceivers
-client.crm.webhook_receivers.list()
-
-#### 📝 Description
-
-
--
+**page_size:** `typing.Optional[int]` — Number of results to return per page.
+
+
+
-
-Returns a list of `WebhookReceiver` objects.
-
-
+**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
+
-#### 🔌 Usage
-
-
-
--
-
-```python
-from merge import Merge
-
-client = Merge(
- account_token="YOUR_ACCOUNT_TOKEN",
- api_key="YOUR_API_KEY",
-)
-client.crm.webhook_receivers.list()
-
-```
-
-
+**started_after:** `typing.Optional[dt.datetime]` — If provided, will only return engagements started after this datetime.
+
-#### ⚙️ Parameters
-
-
+**started_before:** `typing.Optional[dt.datetime]` — If provided, will only return engagements started before this datetime.
+
+
+
+
-
@@ -27092,7 +26356,7 @@ client.crm.webhook_receivers.list()
-client.crm.webhook_receivers.create(...)
+client.crm.engagements.create(...)
-
@@ -27104,7 +26368,7 @@ client.crm.webhook_receivers.list()
-
-Creates a `WebhookReceiver` object with the given values.
+Creates an `Engagement` object with the given values.
@@ -27120,14 +26384,14 @@ Creates a `WebhookReceiver` 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.webhook_receivers.create(
- event="event",
- is_active=True,
+client.crm.engagements.create(
+ model=EngagementRequest(),
)
```
@@ -27144,7 +26408,7 @@ client.crm.webhook_receivers.create(
-
-**event:** `str`
+**model:** `EngagementRequest`
@@ -27152,7 +26416,7 @@ client.crm.webhook_receivers.create(
-
-**is_active:** `bool`
+**is_debug_mode:** `typing.Optional[bool]` — Whether to include debug fields (such as log file links) in the response.
@@ -27160,7 +26424,7 @@ client.crm.webhook_receivers.create(
-
-**key:** `typing.Optional[str]`
+**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously.
@@ -27180,8 +26444,7 @@ client.crm.webhook_receivers.create(
-## Hris AccountDetails
-client.hris.account_details.retrieve()
+client.crm.engagements.retrieve(...)
-
@@ -27193,7 +26456,7 @@ client.crm.webhook_receivers.create(
-
-Get details for a linked account.
+Returns an `Engagement` object with the given `id`.
@@ -27214,7 +26477,9 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.hris.account_details.retrieve()
+client.crm.engagements.retrieve(
+ id="id",
+)
```
@@ -27230,6 +26495,51 @@ client.hris.account_details.retrieve()
-
+**id:** `str`
+
+
+
+
+
+-
+
+**expand:** `typing.Optional[
+ typing.Union[
+ EngagementsRetrieveRequestExpandItem,
+ typing.Sequence[EngagementsRetrieveRequestExpandItem],
+ ]
+]` — 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.
@@ -27242,8 +26552,7 @@ client.hris.account_details.retrieve()
-## Hris AccountToken
-client.hris.account_token.retrieve(...)
+client.crm.engagements.partial_update(...)
-
@@ -27255,7 +26564,7 @@ client.hris.account_details.retrieve()
-
-Returns the account token for the end user with the provided public token.
+Updates an `Engagement` object with the given `id`.
@@ -27271,13 +26580,15 @@ Returns the account token for the end user with the provided public token.
```python
from merge import Merge
+from merge.resources.crm import PatchedEngagementRequest
client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.hris.account_token.retrieve(
- public_token="public_token",
+client.crm.engagements.partial_update(
+ id="id",
+ model=PatchedEngagementRequest(),
)
```
@@ -27294,7 +26605,31 @@ client.hris.account_token.retrieve(
-
-**public_token:** `str`
+**id:** `str`
+
+
+
+
+
+-
+
+**model:** `PatchedEngagementRequest`
+
+
+
+
+
+-
+
+**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.
@@ -27314,8 +26649,7 @@ client.hris.account_token.retrieve(
-## Hris AsyncPassthrough
-client.hris.async_passthrough.create(...)
+client.crm.engagements.meta_patch_retrieve(...)
-
@@ -27327,7 +26661,7 @@ client.hris.account_token.retrieve(
-
-Asynchronously pull data from an endpoint not currently supported by Merge.
+Returns metadata for `Engagement` PATCHs.
@@ -27343,17 +26677,13 @@ Asynchronously pull data from an endpoint not currently supported by Merge.
```python
from merge import Merge
-from merge.resources.hris import DataPassthroughRequest, MethodEnum
client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.hris.async_passthrough.create(
- request=DataPassthroughRequest(
- method=MethodEnum.GET,
- path="/scooters",
- ),
+client.crm.engagements.meta_patch_retrieve(
+ id="id",
)
```
@@ -27370,7 +26700,7 @@ client.hris.async_passthrough.create(
-
-**request:** `DataPassthroughRequest`
+**id:** `str`
@@ -27390,7 +26720,7 @@ client.hris.async_passthrough.create(
-client.hris.async_passthrough.retrieve(...)
+client.crm.engagements.meta_post_retrieve()
-
@@ -27402,7 +26732,7 @@ client.hris.async_passthrough.create(
-
-Retrieves data from earlier async-passthrough POST request
+Returns metadata for `Engagement` POSTs.
@@ -27423,9 +26753,7 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.hris.async_passthrough.retrieve(
- async_passthrough_receipt_id="async_passthrough_receipt_id",
-)
+client.crm.engagements.meta_post_retrieve()
```
@@ -27441,14 +26769,6 @@ client.hris.async_passthrough.retrieve(
-
-**async_passthrough_receipt_id:** `str`
-
-
-
-
-
--
-
**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -27461,8 +26781,7 @@ client.hris.async_passthrough.retrieve(
-## Hris AuditTrail
-client.hris.audit_trail.list(...)
+client.crm.engagements.remote_field_classes_list(...)
-
@@ -27474,7 +26793,7 @@ client.hris.async_passthrough.retrieve(
-
-Gets a list of audit trail events.
+Returns a list of `RemoteFieldClass` objects.
@@ -27495,14 +26814,14 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.hris.audit_trail.list(
+response = client.crm.engagements.remote_field_classes_list(
cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
- end_date="end_date",
- event_type="event_type",
- page_size=1,
- start_date="start_date",
- user_email="user_email",
)
+for item in response:
+ yield item
+# alternatively, you can paginate page-by-page
+for page in response.iter_pages():
+ yield page
```
@@ -27526,7 +26845,7 @@ client.hris.audit_trail.list(
-
-**end_date:** `typing.Optional[str]` — If included, will only include audit trail events that occurred before this time
+**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
@@ -27534,7 +26853,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.
@@ -27542,7 +26861,7 @@ client.hris.audit_trail.list(
-
-**page_size:** `typing.Optional[int]` — Number of results to return per page.
+**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.
@@ -27550,7 +26869,7 @@ client.hris.audit_trail.list(
-
-**start_date:** `typing.Optional[str]` — If included, will only include audit trail events that occurred after this time
+**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -27558,7 +26877,23 @@ 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.
+**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.
@@ -27578,8 +26913,8 @@ client.hris.audit_trail.list(
-## Hris AvailableActions
-client.hris.available_actions.retrieve()
+## Crm FieldMapping
+client.crm.field_mapping.field_mappings_retrieve(...)
-
@@ -27591,7 +26926,7 @@ client.hris.audit_trail.list(
-
-Returns a list of models and actions available for an account.
+Get all Field Mappings for this Linked Account. Field Mappings are mappings between third-party Remote Fields and user defined Merge fields. [Learn more](https://docs.merge.dev/supplemental-data/field-mappings/overview/).
@@ -27612,7 +26947,7 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.hris.available_actions.retrieve()
+client.crm.field_mapping.field_mappings_retrieve()
```
@@ -27628,6 +26963,14 @@ client.hris.available_actions.retrieve()
-
+**exclude_remote_field_metadata:** `typing.Optional[bool]` — If `true`, remote fields metadata is excluded from each field mapping instance (i.e. `remote_fields.remote_key_name` and `remote_fields.schema` will be null). This will increase the speed of the request since these fields require some calculations.
+
+
+
+
+
+-
+
**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -27640,8 +26983,7 @@ client.hris.available_actions.retrieve()
-## Hris BankInfo
-client.hris.bank_info.list(...)
+client.crm.field_mapping.field_mappings_create(...)
-
@@ -27653,7 +26995,7 @@ client.hris.available_actions.retrieve()
-
-Returns a list of `BankInfo` 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.
@@ -27668,41 +27010,19 @@ Returns a list of `BankInfo` objects.
-
```python
-import datetime
-
from merge import Merge
-from merge.resources.hris.resources.bank_info import (
- BankInfoListRequestAccountType,
- BankInfoListRequestOrderBy,
-)
client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.hris.bank_info.list(
- account_type=BankInfoListRequestAccountType.CHECKING,
- bank_name="bank_name",
- created_after=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- created_before=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
- employee_id="employee_id",
- include_deleted_data=True,
- include_remote_data=True,
- include_shell_data=True,
- modified_after=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- modified_before=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- order_by=BankInfoListRequestOrderBy.REMOTE_CREATED_AT_DESCENDING,
- page_size=1,
- remote_id="remote_id",
+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",
)
```
@@ -27719,12 +27039,7 @@ client.hris.bank_info.list(
-
-**account_type:** `typing.Optional[BankInfoListRequestAccountType]`
-
-If provided, will only return BankInfo's with this account type. Options: ('SAVINGS', 'CHECKING')
-
-* `SAVINGS` - SAVINGS
-* `CHECKING` - CHECKING
+**target_field_name:** `str` — The name of the target field you want this remote field to map to.
@@ -27732,7 +27047,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.
+**target_field_description:** `str` — The description of the target field you want this remote field to map to.
@@ -27740,7 +27055,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.
+**remote_field_traversal_path:** `typing.Sequence[typing.Any]` — The field traversal path of the remote field listed when you hit the GET /remote-fields endpoint.
@@ -27748,7 +27063,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.
+**remote_method:** `str` — The method of the remote endpoint where the remote field is coming from.
@@ -27756,7 +27071,7 @@ If provided, will only return BankInfo's with this account type. Options: ('SAVI
-
-**cursor:** `typing.Optional[str]` — The pagination cursor value.
+**remote_url_path:** `str` — The path of the remote endpoint where the remote field is coming from.
@@ -27764,7 +27079,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.
+**common_model_name:** `str` — The name of the Common Model that the remote field corresponds to in a given category.
@@ -27772,7 +27087,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.
+**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.
@@ -27780,79 +27095,70 @@ 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/).
+**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.field_mapping.field_mappings_destroy(...)
-
-**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.
-
-
-
-
-
-**order_by:** `typing.Optional[BankInfoListRequestOrderBy]` — Overrides the default ordering for this endpoint. Possible values include: remote_created_at, -remote_created_at.
-
+Deletes Field Mappings for a Linked Account. All data related to this Field Mapping will be deleted and these changes will be reflected after the next scheduled sync. This will cause the next sync for this Linked Account to sync **ALL** data from start.
+
+
+
+#### 🔌 Usage
-
-**page_size:** `typing.Optional[int]` — Number of results to return per page. The maximum limit is 100.
-
-
-
-
-
-**remote_fields:** `typing.Optional[typing.Literal["account_type"]]` — Deprecated. Use show_enum_origins.
-
+```python
+from merge import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.crm.field_mapping.field_mappings_destroy(
+ field_mapping_id="field_mapping_id",
+)
+
+```
+
+
+
+#### ⚙️ Parameters
-
-**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
-
-
-
-
-
-**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)
+**field_mapping_id:** `str`
@@ -27872,7 +27178,7 @@ If provided, will only return BankInfo's with this account type. Options: ('SAVI
-client.hris.bank_info.retrieve(...)
+client.crm.field_mapping.field_mappings_partial_update(...)
-
@@ -27884,7 +27190,7 @@ If provided, will only return BankInfo's with this account type. Options: ('SAVI
-
-Returns a `BankInfo` object with the given `id`.
+Create or update existing Field Mappings for a Linked Account. Changes will be reflected after the next scheduled sync. This will cause the next sync for this Linked Account to sync **ALL** data from start.
@@ -27905,10 +27211,8 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.hris.bank_info.retrieve(
- id="id",
- include_remote_data=True,
- include_shell_data=True,
+client.crm.field_mapping.field_mappings_partial_update(
+ field_mapping_id="field_mapping_id",
)
```
@@ -27925,23 +27229,7 @@ client.hris.bank_info.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.
-
-
-
-
-
--
-
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
+**field_mapping_id:** `str`
@@ -27949,7 +27237,7 @@ client.hris.bank_info.retrieve(
-
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
+**remote_field_traversal_path:** `typing.Optional[typing.Sequence[typing.Any]]` — The field traversal path of the remote field listed when you hit the GET /remote-fields endpoint.
@@ -27957,7 +27245,7 @@ client.hris.bank_info.retrieve(
-
-**remote_fields:** `typing.Optional[typing.Literal["account_type"]]` — Deprecated. Use show_enum_origins.
+**remote_method:** `typing.Optional[str]` — The method of the remote endpoint where the remote field is coming from.
@@ -27965,7 +27253,7 @@ client.hris.bank_info.retrieve(
-
-**show_enum_origins:** `typing.Optional[typing.Literal["account_type"]]` — A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter)
+**remote_url_path:** `typing.Optional[str]` — The path of the remote endpoint where the remote field is coming from.
@@ -27985,8 +27273,7 @@ client.hris.bank_info.retrieve(
-## Hris Benefits
-client.hris.benefits.list(...)
+client.crm.field_mapping.remote_fields_retrieve(...)
-
@@ -27998,7 +27285,7 @@ client.hris.bank_info.retrieve(
-
-Returns a list of `Benefit` 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/).
@@ -28013,35 +27300,13 @@ Returns a list of `Benefit` objects.
-
```python
-import datetime
-
from merge import Merge
client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.hris.benefits.list(
- created_after=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- created_before=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
- employee_id="employee_id",
- include_deleted_data=True,
- include_remote_data=True,
- include_shell_data=True,
- modified_after=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- modified_before=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- page_size=1,
- remote_id="remote_id",
-)
+client.crm.field_mapping.remote_fields_retrieve()
```
@@ -28057,7 +27322,7 @@ client.hris.benefits.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.
@@ -28065,7 +27330,7 @@ client.hris.benefits.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.
@@ -28073,83 +27338,64 @@ client.hris.benefits.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 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.
-
+
+client.crm.field_mapping.target_fields_retrieve()
-
-**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
-
-
-
+#### 📝 Description
-
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
-
-
-
-
-
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
-
+Get 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_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
-
+#### 🔌 Usage
+
-
-**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
-
-
-
-
-
-**page_size:** `typing.Optional[int]` — Number of results to return per page. The maximum limit is 100.
-
+```python
+from merge import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.crm.field_mapping.target_fields_retrieve()
+
+```
+
+
+
+#### ⚙️ Parameters
-
-**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
-
-
-
-
-
@@ -28165,7 +27411,8 @@ client.hris.benefits.list(
-client.hris.benefits.retrieve(...)
+## Crm GenerateKey
+client.crm.generate_key.create(...)
-
@@ -28177,7 +27424,7 @@ client.hris.benefits.list(
-
-Returns a `Benefit` object with the given `id`.
+Create a remote key.
@@ -28198,10 +27445,8 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.hris.benefits.retrieve(
- id="id",
- include_remote_data=True,
- include_shell_data=True,
+client.crm.generate_key.create(
+ name="Remote Deployment Key 1",
)
```
@@ -28218,31 +27463,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.
-
-
-
-
-
--
-
-**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
@@ -28262,8 +27483,8 @@ client.hris.benefits.retrieve(
-## Hris Companies
-client.hris.companies.list(...)
+## Crm Issues
+client.crm.issues.list(...)
-
@@ -28275,7 +27496,7 @@ client.hris.benefits.retrieve(
-
-Returns a list of `Company` objects.
+Gets all issues for Organization.
@@ -28290,34 +27511,20 @@ Returns a list of `Company` objects.
-
```python
-import datetime
-
from merge import Merge
client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.hris.companies.list(
- created_after=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- created_before=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
+response = client.crm.issues.list(
cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
- include_deleted_data=True,
- include_remote_data=True,
- include_shell_data=True,
- modified_after=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- modified_before=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- page_size=1,
- remote_id="remote_id",
)
+for item in response:
+ yield item
+# alternatively, you can paginate page-by-page
+for page in response.iter_pages():
+ yield page
```
@@ -28333,7 +27540,7 @@ client.hris.companies.list(
-
-**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
+**account_token:** `typing.Optional[str]`
@@ -28341,7 +27548,7 @@ client.hris.companies.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.
@@ -28349,7 +27556,7 @@ client.hris.companies.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
@@ -28357,7 +27564,7 @@ client.hris.companies.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/).
+**end_user_organization_name:** `typing.Optional[str]`
@@ -28365,7 +27572,7 @@ client.hris.companies.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_after:** `typing.Optional[dt.datetime]` — If provided, will only return issues whose first incident time was after this datetime.
@@ -28373,7 +27580,7 @@ client.hris.companies.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_before:** `typing.Optional[dt.datetime]` — If provided, will only return issues whose first incident time was before this datetime.
@@ -28381,7 +27588,7 @@ client.hris.companies.list(
-
-**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
+**include_muted:** `typing.Optional[str]` — If true, will include muted issues
@@ -28389,7 +27596,7 @@ client.hris.companies.list(
-
-**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
+**integration_name:** `typing.Optional[str]`
@@ -28397,7 +27604,7 @@ client.hris.companies.list(
-
-**page_size:** `typing.Optional[int]` — Number of results to return per page. The maximum limit is 100.
+**last_incident_time_after:** `typing.Optional[dt.datetime]` — If provided, will only return issues whose last incident time was after this datetime.
@@ -28405,7 +27612,44 @@ client.hris.companies.list(
-
-**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
+**last_incident_time_before:** `typing.Optional[dt.datetime]` — If provided, will only return issues whose last incident time was before this datetime.
+
+
+
+
+
+-
+
+**linked_account_id:** `typing.Optional[str]` — If provided, will only include issues pertaining to the linked account passed in.
+
+
+
+
+
+-
+
+**page_size:** `typing.Optional[int]` — Number of results to return per page.
+
+
+
+
+
+-
+
+**start_date:** `typing.Optional[str]` — If included, will only include issues whose most recent action occurred after this time
+
+
+
+
+
+-
+
+**status:** `typing.Optional[IssuesListRequestStatus]`
+
+Status of the issue. Options: ('ONGOING', 'RESOLVED')
+
+* `ONGOING` - ONGOING
+* `RESOLVED` - RESOLVED
@@ -28425,7 +27669,7 @@ client.hris.companies.list(
-client.hris.companies.retrieve(...)
+client.crm.issues.retrieve(...)
-
@@ -28437,7 +27681,7 @@ client.hris.companies.list(
-
-Returns a `Company` object with the given `id`.
+Get a specific issue.
@@ -28458,10 +27702,8 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.hris.companies.retrieve(
+client.crm.issues.retrieve(
id="id",
- include_remote_data=True,
- include_shell_data=True,
)
```
@@ -28486,8695 +27728,6 @@ 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.
-
-
-
-
-
--
-
-**include_shell_data:** `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 Scopes
-client.hris.scopes.default_scopes_retrieve()
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Get the default permissions for Merge Common Models and fields across all Linked Accounts of a given category. [Learn more](https://help.merge.dev/en/articles/5950052-common-model-and-field-scopes).
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from merge import Merge
-
-client = Merge(
- account_token="YOUR_ACCOUNT_TOKEN",
- api_key="YOUR_API_KEY",
-)
-client.hris.scopes.default_scopes_retrieve()
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-
-
-client.hris.scopes.linked_account_scopes_retrieve()
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Get all available permissions for Merge Common Models and fields for a single Linked Account. [Learn more](https://help.merge.dev/en/articles/5950052-common-model-and-field-scopes).
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from merge import Merge
-
-client = Merge(
- account_token="YOUR_ACCOUNT_TOKEN",
- api_key="YOUR_API_KEY",
-)
-client.hris.scopes.linked_account_scopes_retrieve()
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-
-
-client.hris.scopes.linked_account_scopes_create(...)
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Update permissions for any Common Model or field for a single Linked Account. Any Scopes not set in this POST request will inherit the default Scopes. [Learn more](https://help.merge.dev/en/articles/5950052-common-model-and-field-scopes)
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from merge import Merge
-from merge.resources.hris import (
- FieldPermissionDeserializerRequest,
- IndividualCommonModelScopeDeserializerRequest,
- ModelPermissionDeserializerRequest,
-)
-
-client = Merge(
- account_token="YOUR_ACCOUNT_TOKEN",
- api_key="YOUR_API_KEY",
-)
-client.hris.scopes.linked_account_scopes_create(
- common_models=[
- IndividualCommonModelScopeDeserializerRequest(
- model_name="Employee",
- model_permissions={
- "READ": ModelPermissionDeserializerRequest(
- is_enabled=True,
- ),
- "WRITE": ModelPermissionDeserializerRequest(
- is_enabled=False,
- ),
- },
- field_permissions=FieldPermissionDeserializerRequest(
- enabled_fields=["avatar", "home_location"],
- disabled_fields=["work_location"],
- ),
- ),
- IndividualCommonModelScopeDeserializerRequest(
- model_name="Benefit",
- model_permissions={
- "WRITE": ModelPermissionDeserializerRequest(
- is_enabled=False,
- )
- },
- ),
- ],
-)
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**common_models:** `typing.Sequence[IndividualCommonModelScopeDeserializerRequest]` — The common models you want to update the scopes for
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-
-
-## Hris DeleteAccount
-client.hris.delete_account.delete()
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Delete a linked account.
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from merge import Merge
-
-client = Merge(
- account_token="YOUR_ACCOUNT_TOKEN",
- api_key="YOUR_API_KEY",
-)
-client.hris.delete_account.delete()
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-
-
-## Hris Dependents
-client.hris.dependents.list(...)
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Returns a list of `Dependent` objects.
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-import datetime
-
-from merge import Merge
-
-client = Merge(
- account_token="YOUR_ACCOUNT_TOKEN",
- api_key="YOUR_API_KEY",
-)
-client.hris.dependents.list(
- created_after=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- created_before=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
- employee_id="employee_id",
- include_deleted_data=True,
- include_remote_data=True,
- include_sensitive_fields=True,
- include_shell_data=True,
- modified_after=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- modified_before=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- page_size=1,
- remote_id="remote_id",
-)
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
-
-
-
-
-
--
-
-**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
-
-
-
-
-
--
-
-**cursor:** `typing.Optional[str]` — The pagination cursor value.
-
-
-
-
-
--
-
-**employee_id:** `typing.Optional[str]` — If provided, will only return dependents for this employee.
-
-
-
-
-
--
-
-**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
-
-
-
-
-
--
-
-**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).
-
-
-
-
-
--
-
-**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
-
-
-
-
-
--
-
-**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
-
-
-
-
-
--
-
-**page_size:** `typing.Optional[int]` — Number of results to return per page. The maximum limit is 100.
-
-
-
-
-
--
-
-**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-
-
-client.hris.dependents.retrieve(...)
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Returns a `Dependent` object with the given `id`.
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from merge import Merge
-
-client = Merge(
- account_token="YOUR_ACCOUNT_TOKEN",
- api_key="YOUR_API_KEY",
-)
-client.hris.dependents.retrieve(
- id="id",
- include_remote_data=True,
- include_sensitive_fields=True,
- include_shell_data=True,
-)
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**id:** `str`
-
-
-
-
-
--
-
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
-
-
-
-
-
--
-
-**include_sensitive_fields:** `typing.Optional[bool]` — Whether to include sensitive fields (such as social security numbers) in the response.
-
-
-
-
-
--
-
-**include_shell_data:** `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 EmployeePayrollRuns
-client.hris.employee_payroll_runs.list(...)
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Returns a list of `EmployeePayrollRun` objects.
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-import datetime
-
-from merge import Merge
-from merge.resources.hris.resources.employee_payroll_runs import (
- EmployeePayrollRunsListRequestExpand,
-)
-
-client = Merge(
- account_token="YOUR_ACCOUNT_TOKEN",
- api_key="YOUR_API_KEY",
-)
-client.hris.employee_payroll_runs.list(
- created_after=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- created_before=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
- employee_id="employee_id",
- ended_after=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- ended_before=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- expand=EmployeePayrollRunsListRequestExpand.EMPLOYEE,
- include_deleted_data=True,
- include_remote_data=True,
- include_shell_data=True,
- modified_after=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- modified_before=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- page_size=1,
- payroll_run_id="payroll_run_id",
- remote_id="remote_id",
- started_after=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- started_before=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
-)
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
-
-
-
-
-
--
-
-**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
-
-
-
-
-
--
-
-**cursor:** `typing.Optional[str]` — The pagination cursor value.
-
-
-
-
-
--
-
-**employee_id:** `typing.Optional[str]` — If provided, will only return employee payroll runs for this employee.
-
-
-
-
-
--
-
-**ended_after:** `typing.Optional[dt.datetime]` — If provided, will only return employee payroll runs ended after this datetime.
-
-
-
-
-
--
-
-**ended_before:** `typing.Optional[dt.datetime]` — If provided, will only return employee payroll runs ended before this datetime.
-
-
-
-
-
--
-
-**expand:** `typing.Optional[EmployeePayrollRunsListRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
-
-
-
-
-
--
-
-**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
-
-
-
-
-
--
-
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
-
-
-
-
-
--
-
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
-
-
-
-
-
--
-
-**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
-
-
-
-
-
--
-
-**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
-
-
-
-
-
--
-
-**page_size:** `typing.Optional[int]` — Number of results to return per page. The maximum limit is 100.
-
-
-
-
-
--
-
-**payroll_run_id:** `typing.Optional[str]` — If provided, will only return employee payroll runs for this employee.
-
-
-
-
-
--
-
-**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
-
-
-
-
-
--
-
-**started_after:** `typing.Optional[dt.datetime]` — If provided, will only return employee payroll runs started after this datetime.
-
-
-
-
-
--
-
-**started_before:** `typing.Optional[dt.datetime]` — If provided, will only return employee payroll runs started before this datetime.
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-
-
-client.hris.employee_payroll_runs.retrieve(...)
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Returns an `EmployeePayrollRun` object with the given `id`.
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from merge import Merge
-from merge.resources.hris.resources.employee_payroll_runs import (
- EmployeePayrollRunsRetrieveRequestExpand,
-)
-
-client = Merge(
- account_token="YOUR_ACCOUNT_TOKEN",
- api_key="YOUR_API_KEY",
-)
-client.hris.employee_payroll_runs.retrieve(
- id="id",
- expand=EmployeePayrollRunsRetrieveRequestExpand.EMPLOYEE,
- include_remote_data=True,
- include_shell_data=True,
-)
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**id:** `str`
-
-
-
-
-
--
-
-**expand:** `typing.Optional[EmployeePayrollRunsRetrieveRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
-
-
-
-
-
--
-
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
-
-
-
-
-
--
-
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-
-
-## Hris Employees
-client.hris.employees.list(...)
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Returns a list of `Employee` objects.
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-import datetime
-
-from merge import Merge
-from merge.resources.hris.resources.employees import (
- EmployeesListRequestEmploymentStatus,
- EmployeesListRequestExpand,
- EmployeesListRequestRemoteFields,
- EmployeesListRequestShowEnumOrigins,
-)
-
-client = Merge(
- account_token="YOUR_ACCOUNT_TOKEN",
- api_key="YOUR_API_KEY",
-)
-client.hris.employees.list(
- company_id="company_id",
- created_after=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- created_before=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
- display_full_name="display_full_name",
- employee_number="employee_number",
- employment_status=EmployeesListRequestEmploymentStatus.ACTIVE,
- employment_type="employment_type",
- expand=EmployeesListRequestExpand.COMPANY,
- first_name="first_name",
- groups="groups",
- home_location_id="home_location_id",
- include_deleted_data=True,
- include_remote_data=True,
- include_sensitive_fields=True,
- include_shell_data=True,
- job_title="job_title",
- last_name="last_name",
- manager_id="manager_id",
- modified_after=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- modified_before=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- page_size=1,
- pay_group_id="pay_group_id",
- personal_email="personal_email",
- remote_fields=EmployeesListRequestRemoteFields.EMPLOYMENT_STATUS,
- remote_id="remote_id",
- show_enum_origins=EmployeesListRequestShowEnumOrigins.EMPLOYMENT_STATUS,
- started_after=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- started_before=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- team_id="team_id",
- terminated_after=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- terminated_before=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- work_email="work_email",
- work_location_id="work_location_id",
-)
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**company_id:** `typing.Optional[str]` — If provided, will only return employees for this company.
-
-
-
-
-
--
-
-**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
-
-
-
-
-
--
-
-**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
-
-
-
-
-
--
-
-**cursor:** `typing.Optional[str]` — The pagination cursor value.
-
-
-
-
-
--
-
-**display_full_name:** `typing.Optional[str]` — If provided, will only return employees with this display name.
-
-
-
-
-
--
-
-**employee_number:** `typing.Optional[str]` — If provided, will only return employees with this employee number.
-
-
-
-
-
--
-
-**employment_status:** `typing.Optional[EmployeesListRequestEmploymentStatus]`
-
-If provided, will only return employees with this employment status.
-
-* `ACTIVE` - ACTIVE
-* `PENDING` - PENDING
-* `INACTIVE` - INACTIVE
-
-
-
-
-
--
-
-**employment_type:** `typing.Optional[str]` — If provided, will only return employees that have an employment of the specified employment type.
-
-
-
-
-
--
-
-**expand:** `typing.Optional[EmployeesListRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
-
-
-
-
-
--
-
-**first_name:** `typing.Optional[str]` — If provided, will only return employees with this first name.
-
-
-
-
-
--
-
-**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.
-
-
-
-
-
--
-
-**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is 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_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).
-
-
-
-
-
--
-
-**job_title:** `typing.Optional[str]` — If provided, will only return employees that have an employment of the specified job title.
-
-
-
-
-
--
-
-**last_name:** `typing.Optional[str]` — If provided, will only return employees with this last name.
-
-
-
-
-
--
-
-**manager_id:** `typing.Optional[str]` — If provided, will only return employees for this manager.
-
-
-
-
-
--
-
-**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
-
-
-
-
-
--
-
-**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.
-
-
-
-
-
--
-
-**pay_group_id:** `typing.Optional[str]` — If provided, will only return employees for this pay group
-
-
-
-
-
--
-
-**personal_email:** `typing.Optional[str]` — If provided, will only return Employees with this personal email
-
-
-
-
-
--
-
-**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.
-
-
-
-
-
-
-
-
-
-
-
-client.hris.employees.create(...)
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Creates an `Employee` object with the given values.
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from merge import Merge
-from merge.resources.hris import EmployeeRequest
-
-client = Merge(
- account_token="YOUR_ACCOUNT_TOKEN",
- api_key="YOUR_API_KEY",
-)
-client.hris.employees.create(
- is_debug_mode=True,
- run_async=True,
- model=EmployeeRequest(),
-)
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**model:** `EmployeeRequest`
-
-
-
-
-
--
-
-**is_debug_mode:** `typing.Optional[bool]` — Whether to include debug fields (such as log file links) in the response.
-
-
-
-
-
--
-
-**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously.
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-
-
-client.hris.employees.retrieve(...)
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Returns an `Employee` object with the given `id`.
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from merge import Merge
-from merge.resources.hris.resources.employees import (
- EmployeesRetrieveRequestExpand,
- EmployeesRetrieveRequestRemoteFields,
- EmployeesRetrieveRequestShowEnumOrigins,
-)
-
-client = Merge(
- account_token="YOUR_ACCOUNT_TOKEN",
- api_key="YOUR_API_KEY",
-)
-client.hris.employees.retrieve(
- id="id",
- expand=EmployeesRetrieveRequestExpand.COMPANY,
- include_remote_data=True,
- include_sensitive_fields=True,
- include_shell_data=True,
- remote_fields=EmployeesRetrieveRequestRemoteFields.EMPLOYMENT_STATUS,
- show_enum_origins=EmployeesRetrieveRequestShowEnumOrigins.EMPLOYMENT_STATUS,
-)
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**id:** `str`
-
-
-
-
-
--
-
-**expand:** `typing.Optional[EmployeesRetrieveRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
-
-
-
-
-
--
-
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
-
-
-
-
-
--
-
-**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).
-
-
-
-
-
--
-
-**remote_fields:** `typing.Optional[EmployeesRetrieveRequestRemoteFields]` — Deprecated. Use show_enum_origins.
-
-
-
-
-
--
-
-**show_enum_origins:** `typing.Optional[EmployeesRetrieveRequestShowEnumOrigins]` — A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter)
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-
-
-client.hris.employees.ignore_create(...)
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Ignores a specific row based on the `model_id` in the url. These records will have their properties set to null, and will not be updated in future syncs. The "reason" and "message" fields in the request body will be stored for audit purposes.
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```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`
-
-
-
-
-
--
-
-**reason:** `IgnoreCommonModelRequestReason`
-
-
-
-
-
--
-
-**message:** `typing.Optional[str]`
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-
-
-client.hris.employees.meta_post_retrieve()
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Returns metadata for `Employee` POSTs.
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from merge import Merge
-
-client = Merge(
- account_token="YOUR_ACCOUNT_TOKEN",
- api_key="YOUR_API_KEY",
-)
-client.hris.employees.meta_post_retrieve()
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-
-
-## Hris EmployerBenefits
-client.hris.employer_benefits.list(...)
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Returns a list of `EmployerBenefit` objects.
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-import datetime
-
-from merge import Merge
-
-client = Merge(
- account_token="YOUR_ACCOUNT_TOKEN",
- api_key="YOUR_API_KEY",
-)
-client.hris.employer_benefits.list(
- created_after=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- created_before=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
- include_deleted_data=True,
- include_remote_data=True,
- include_shell_data=True,
- modified_after=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- modified_before=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- page_size=1,
- remote_id="remote_id",
-)
-
-```
-
-
-
-
-
-#### ⚙️ 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).
-
-
-
-
-
--
-
-**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
-
-
-
-
-
--
-
-**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
-
-
-
-
-
--
-
-**page_size:** `typing.Optional[int]` — Number of results to return per page. The maximum limit is 100.
-
-
-
-
-
--
-
-**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-
-
-client.hris.employer_benefits.retrieve(...)
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Returns an `EmployerBenefit` 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.employer_benefits.retrieve(
- id="id",
- include_remote_data=True,
- include_shell_data=True,
-)
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**id:** `str`
-
-
-
-
-
--
-
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
-
-
-
-
-
--
-
-**include_shell_data:** `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
-
-
--
-
-
--
-
-Returns a list of `Employment` objects.
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-import datetime
-
-from merge import Merge
-from merge.resources.hris.resources.employments import (
- EmploymentsListRequestExpand,
- EmploymentsListRequestOrderBy,
- EmploymentsListRequestRemoteFields,
- EmploymentsListRequestShowEnumOrigins,
-)
-
-client = Merge(
- account_token="YOUR_ACCOUNT_TOKEN",
- api_key="YOUR_API_KEY",
-)
-client.hris.employments.list(
- created_after=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- created_before=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
- employee_id="employee_id",
- expand=EmploymentsListRequestExpand.EMPLOYEE,
- include_deleted_data=True,
- include_remote_data=True,
- include_shell_data=True,
- modified_after=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- modified_before=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- order_by=EmploymentsListRequestOrderBy.EFFECTIVE_DATE_DESCENDING,
- page_size=1,
- remote_fields=EmploymentsListRequestRemoteFields.EMPLOYMENT_TYPE,
- remote_id="remote_id",
- show_enum_origins=EmploymentsListRequestShowEnumOrigins.EMPLOYMENT_TYPE,
-)
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
-
-
-
-
-
--
-
-**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
-
-
-
-
-
--
-
-**cursor:** `typing.Optional[str]` — The pagination cursor value.
-
-
-
-
-
--
-
-**employee_id:** `typing.Optional[str]` — If provided, will only return employments for this employee.
-
-
-
-
-
--
-
-**expand:** `typing.Optional[EmploymentsListRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
-
-
-
-
-
--
-
-**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
-
-
-
-
-
--
-
-**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.
-
-
-
-
-
--
-
-**order_by:** `typing.Optional[EmploymentsListRequestOrderBy]` — Overrides the default ordering for this endpoint. Possible values include: effective_date, -effective_date.
-
-
-
-
-
--
-
-**page_size:** `typing.Optional[int]` — Number of results to return per page. The maximum limit is 100.
-
-
-
-
-
--
-
-**remote_fields:** `typing.Optional[EmploymentsListRequestRemoteFields]` — Deprecated. Use show_enum_origins.
-
-
-
-
-
--
-
-**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
-
-
-
-
-
--
-
-**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)
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-
-
-client.hris.employments.retrieve(...)
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Returns an `Employment` object with the given `id`.
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from merge import Merge
-from merge.resources.hris.resources.employments import (
- EmploymentsRetrieveRequestExpand,
- EmploymentsRetrieveRequestRemoteFields,
- EmploymentsRetrieveRequestShowEnumOrigins,
-)
-
-client = Merge(
- account_token="YOUR_ACCOUNT_TOKEN",
- api_key="YOUR_API_KEY",
-)
-client.hris.employments.retrieve(
- id="id",
- expand=EmploymentsRetrieveRequestExpand.EMPLOYEE,
- include_remote_data=True,
- include_shell_data=True,
- remote_fields=EmploymentsRetrieveRequestRemoteFields.EMPLOYMENT_TYPE,
- show_enum_origins=EmploymentsRetrieveRequestShowEnumOrigins.EMPLOYMENT_TYPE,
-)
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**id:** `str`
-
-
-
-
-
--
-
-**expand:** `typing.Optional[EmploymentsRetrieveRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
-
-
-
-
-
--
-
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
-
-
-
-
-
--
-
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
-
-
-
-
-
--
-
-**remote_fields:** `typing.Optional[EmploymentsRetrieveRequestRemoteFields]` — Deprecated. Use show_enum_origins.
-
-
-
-
-
--
-
-**show_enum_origins:** `typing.Optional[EmploymentsRetrieveRequestShowEnumOrigins]` — A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter)
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-
-
-## Hris FieldMapping
-client.hris.field_mapping.field_mappings_retrieve(...)
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Get all Field Mappings for this Linked Account. Field Mappings are mappings between third-party Remote Fields and user defined Merge fields. [Learn more](https://docs.merge.dev/supplemental-data/field-mappings/overview/).
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from merge import Merge
-
-client = Merge(
- account_token="YOUR_ACCOUNT_TOKEN",
- api_key="YOUR_API_KEY",
-)
-client.hris.field_mapping.field_mappings_retrieve(
- exclude_remote_field_metadata=True,
-)
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**exclude_remote_field_metadata:** `typing.Optional[bool]` — If `true`, remote fields metadata is excluded from each field mapping instance (i.e. `remote_fields.remote_key_name` and `remote_fields.schema` will be null). This will increase the speed of the request since these fields require some calculations.
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-
-
-client.hris.field_mapping.field_mappings_create(...)
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Create new Field Mappings that will be available after the next scheduled sync. This will cause the next sync for this Linked Account to sync **ALL** data from start.
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from merge import Merge
-
-client = Merge(
- account_token="YOUR_ACCOUNT_TOKEN",
- api_key="YOUR_API_KEY",
-)
-client.hris.field_mapping.field_mappings_create(
- exclude_remote_field_metadata=True,
- target_field_name="example_target_field_name",
- target_field_description="this is a example description of the target field",
- remote_field_traversal_path=["example_remote_field"],
- remote_method="GET",
- remote_url_path="/example-url-path",
- common_model_name="ExampleCommonModel",
-)
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**target_field_name:** `str` — The name of the target field you want this remote field to map to.
-
-
-
-
-
--
-
-**target_field_description:** `str` — The description of the target field you want this remote field to map to.
-
-
-
-
-
--
-
-**remote_field_traversal_path:** `typing.Sequence[typing.Optional[typing.Any]]` — The field traversal path of the remote field listed when you hit the GET /remote-fields endpoint.
-
-
-
-
-
--
-
-**remote_method:** `str` — The method of the remote endpoint where the remote field is coming from.
-
-
-
-
-
--
-
-**remote_url_path:** `str` — The path of the remote endpoint where the remote field is coming from.
-
-
-
-
-
--
-
-**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.
-
-
-
-
-
--
-
-**jmes_path:** `typing.Optional[str]` — JMES path to specify json query expression to be used on field mapping.
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-
-
-client.hris.field_mapping.field_mappings_destroy(...)
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Deletes Field Mappings for a Linked Account. All data related to this Field Mapping will be deleted and these changes will be reflected after the next scheduled sync. This will cause the next sync for this Linked Account to sync **ALL** data from start.
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from merge import Merge
-
-client = Merge(
- account_token="YOUR_ACCOUNT_TOKEN",
- api_key="YOUR_API_KEY",
-)
-client.hris.field_mapping.field_mappings_destroy(
- field_mapping_id="field_mapping_id",
-)
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**field_mapping_id:** `str`
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-
-
-client.hris.field_mapping.field_mappings_partial_update(...)
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-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
-
-
--
-
-
--
-
-```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
-
-
--
-
-
--
-
-**field_mapping_id:** `str`
-
-
-
-
-
--
-
-**remote_field_traversal_path:** `typing.Optional[typing.Sequence[typing.Optional[typing.Any]]]` — The field traversal path of the remote field listed when you hit the GET /remote-fields endpoint.
-
-
-
-
-
--
-
-**remote_method:** `typing.Optional[str]` — The method of the remote endpoint where the remote field is coming from.
-
-
-
-
-
--
-
-**remote_url_path:** `typing.Optional[str]` — The path of the remote endpoint where the remote field is coming from.
-
-
-
-
-
--
-
-**jmes_path:** `typing.Optional[str]` — JMES path to specify json query expression to be used on field mapping.
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-
-
-client.hris.field_mapping.remote_fields_retrieve(...)
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Get all remote fields for a Linked Account. Remote fields are third-party fields that are accessible after initial sync if remote_data is enabled. You can use remote fields to override existing Merge fields or map a new Merge field. [Learn more](https://docs.merge.dev/supplemental-data/field-mappings/overview/).
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from merge import Merge
-
-client = Merge(
- account_token="YOUR_ACCOUNT_TOKEN",
- api_key="YOUR_API_KEY",
-)
-client.hris.field_mapping.remote_fields_retrieve(
- common_models="common_models",
- include_example_values="include_example_values",
-)
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**common_models:** `typing.Optional[str]` — A comma seperated list of Common Model names. If included, will only return Remote Fields for those Common Models.
-
-
-
-
-
--
-
-**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.
-
-
-
-
-
-
-
-
-
-
-
-client.hris.field_mapping.target_fields_retrieve()
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Get all organization-wide Target Fields, this will not include any Linked Account specific Target Fields. Organization-wide Target Fields are additional fields appended to the Merge Common Model for all Linked Accounts in a category. [Learn more](https://docs.merge.dev/supplemental-data/field-mappings/target-fields/).
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from merge import Merge
-
-client = Merge(
- account_token="YOUR_ACCOUNT_TOKEN",
- api_key="YOUR_API_KEY",
-)
-client.hris.field_mapping.target_fields_retrieve()
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-
-
-## Hris GenerateKey
-client.hris.generate_key.create(...)
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Create a remote key.
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from merge import Merge
-
-client = Merge(
- account_token="YOUR_ACCOUNT_TOKEN",
- api_key="YOUR_API_KEY",
-)
-client.hris.generate_key.create(
- name="Remote Deployment Key 1",
-)
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**name:** `str` — The name of the remote key
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-
-
-## Hris Groups
-client.hris.groups.list(...)
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Returns a list of `Group` objects.
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-import datetime
-
-from merge import Merge
-
-client = Merge(
- account_token="YOUR_ACCOUNT_TOKEN",
- api_key="YOUR_API_KEY",
-)
-client.hris.groups.list(
- created_after=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- created_before=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
- include_deleted_data=True,
- include_remote_data=True,
- include_shell_data=True,
- is_commonly_used_as_team="is_commonly_used_as_team",
- modified_after=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- modified_before=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- names="names",
- page_size=1,
- remote_id="remote_id",
- types="types",
-)
-
-```
-
-
-
-
-
-#### ⚙️ 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).
-
-
-
-
-
--
-
-**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.
-
-
-
-
-
--
-
-**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.
-
-
-
-
-
--
-
-**page_size:** `typing.Optional[int]` — Number of results to return per page. The maximum limit is 100.
-
-
-
-
-
--
-
-**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.
-
-
-
-
-
--
-
-**show_enum_origins:** `typing.Optional[typing.Literal["type"]]` — A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter)
-
-
-
-
-
--
-
-**types:** `typing.Optional[str]` — If provided, will only return groups of these types. Multiple values can be separated by commas.
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-
-
-client.hris.groups.retrieve(...)
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Returns a `Group` 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.groups.retrieve(
- id="id",
- include_remote_data=True,
- include_shell_data=True,
-)
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**id:** `str`
-
-
-
-
-
--
-
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
-
-
-
-
-
--
-
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
-
-
-
-
-
--
-
-**remote_fields:** `typing.Optional[typing.Literal["type"]]` — Deprecated. Use show_enum_origins.
-
-
-
-
-
--
-
-**show_enum_origins:** `typing.Optional[typing.Literal["type"]]` — A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter)
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-
-
-## Hris Issues
-client.hris.issues.list(...)
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Gets all issues for Organization.
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-import datetime
-
-from merge import Merge
-from merge.resources.hris.resources.issues import IssuesListRequestStatus
-
-client = Merge(
- account_token="YOUR_ACCOUNT_TOKEN",
- api_key="YOUR_API_KEY",
-)
-client.hris.issues.list(
- account_token="account_token",
- cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
- end_date="end_date",
- end_user_organization_name="end_user_organization_name",
- first_incident_time_after=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- first_incident_time_before=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- include_muted="include_muted",
- integration_name="integration_name",
- last_incident_time_after=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- last_incident_time_before=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- linked_account_id="linked_account_id",
- page_size=1,
- start_date="start_date",
- status=IssuesListRequestStatus.ONGOING,
-)
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**account_token:** `typing.Optional[str]`
-
-
-
-
-
--
-
-**cursor:** `typing.Optional[str]` — The pagination cursor value.
-
-
-
-
-
--
-
-**end_date:** `typing.Optional[str]` — If included, will only include issues whose most recent action occurred before this time
-
-
-
-
-
--
-
-**end_user_organization_name:** `typing.Optional[str]`
-
-
-
-
-
--
-
-**first_incident_time_after:** `typing.Optional[dt.datetime]` — If provided, will only return issues whose first incident time was after this datetime.
-
-
-
-
-
--
-
-**first_incident_time_before:** `typing.Optional[dt.datetime]` — If provided, will only return issues whose first incident time was before this datetime.
-
-
-
-
-
--
-
-**include_muted:** `typing.Optional[str]` — If true, will include muted issues
-
-
-
-
-
--
-
-**integration_name:** `typing.Optional[str]`
-
-
-
-
-
--
-
-**last_incident_time_after:** `typing.Optional[dt.datetime]` — If provided, will only return issues whose last incident time was after this datetime.
-
-
-
-
-
--
-
-**last_incident_time_before:** `typing.Optional[dt.datetime]` — If provided, will only return issues whose last incident time was before this datetime.
-
-
-
-
-
--
-
-**linked_account_id:** `typing.Optional[str]` — If provided, will only include issues pertaining to the linked account passed in.
-
-
-
-
-
--
-
-**page_size:** `typing.Optional[int]` — Number of results to return per page. The maximum limit is 100.
-
-
-
-
-
--
-
-**start_date:** `typing.Optional[str]` — If included, will only include issues whose most recent action occurred after this time
-
-
-
-
-
--
-
-**status:** `typing.Optional[IssuesListRequestStatus]`
-
-Status of the issue. Options: ('ONGOING', 'RESOLVED')
-
-* `ONGOING` - ONGOING
-* `RESOLVED` - RESOLVED
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-
-
-client.hris.issues.retrieve(...)
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Get a specific issue.
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from merge import Merge
-
-client = Merge(
- account_token="YOUR_ACCOUNT_TOKEN",
- api_key="YOUR_API_KEY",
-)
-client.hris.issues.retrieve(
- id="id",
-)
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**id:** `str`
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-
-
-## Hris LinkToken
-client.hris.link_token.create(...)
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Creates a link token to be used when linking a new end user.
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from merge import Merge
-from merge.resources.hris import CategoriesEnum
-
-client = Merge(
- account_token="YOUR_ACCOUNT_TOKEN",
- api_key="YOUR_API_KEY",
-)
-client.hris.link_token.create(
- end_user_email_address="example@gmail.com",
- end_user_organization_name="Test Organization",
- end_user_origin_id="12345",
- categories=[CategoriesEnum.HRIS, CategoriesEnum.ATS],
-)
-
-```
-
-
-
-
-
-#### ⚙️ 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.
-
-
-
-
-
--
-
-**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.
-
-
-
-
-
--
-
-**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.
-
-
-
-
-
--
-
-**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.
-
-
-
-
-
--
-
-**common_models:** `typing.Optional[typing.Sequence[CommonModelScopesBodyRequest]]` — An array of objects to specify the models and fields that will be disabled for a given Linked Account. Each object uses model_id, enabled_actions, and disabled_fields to specify the model, method, and fields that are scoped for a given Linked Account.
-
-
-
-
-
--
-
-**category_common_model_scopes:** `typing.Optional[
- typing.Dict[
- str,
- typing.Optional[
- typing.Sequence[IndividualCommonModelScopeDeserializerRequest]
- ],
- ]
-]` — When creating a Link Token, you can set permissions for Common Models that will apply to the account that is going to be linked. Any model or field not specified in link token payload will default to existing settings.
-
-
-
-
-
--
-
-**language:** `typing.Optional[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.
-
-
-
-
-
--
-
-**completed_account_initial_screen:** `typing.Optional[EndUserDetailsRequestCompletedAccountInitialScreen]`
-
-When creating a Link token, you can specifiy the initial screen of Linking Flow for a completed Linked Account.
-
-* `SELECTIVE_SYNC` - SELECTIVE_SYNC
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-
-
-## Hris LinkedAccounts
-client.hris.linked_accounts.list(...)
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-List linked accounts for your organization.
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from merge import Merge
-from merge.resources.hris.resources.linked_accounts import (
- LinkedAccountsListRequestCategory,
-)
-
-client = Merge(
- account_token="YOUR_ACCOUNT_TOKEN",
- api_key="YOUR_API_KEY",
-)
-client.hris.linked_accounts.list(
- category=LinkedAccountsListRequestCategory.ACCOUNTING,
- cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
- end_user_email_address="end_user_email_address",
- end_user_organization_name="end_user_organization_name",
- end_user_origin_id="end_user_origin_id",
- end_user_origin_ids="end_user_origin_ids",
- id="id",
- ids="ids",
- include_duplicates=True,
- integration_name="integration_name",
- is_test_account="is_test_account",
- page_size=1,
- status="status",
-)
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**category:** `typing.Optional[LinkedAccountsListRequestCategory]`
-
-Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing`
-
-* `hris` - hris
-* `ats` - ats
-* `accounting` - accounting
-* `ticketing` - ticketing
-* `crm` - crm
-* `mktg` - mktg
-* `filestorage` - filestorage
-
-
-
-
-
--
-
-**cursor:** `typing.Optional[str]` — The pagination cursor value.
-
-
-
-
-
--
-
-**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.
-
-
-
-
-
--
-
-**is_test_account:** `typing.Optional[str]` — If included, will only include test linked accounts. If not included, will only include non-test linked accounts.
-
-
-
-
-
--
-
-**page_size:** `typing.Optional[int]` — Number of results to return per page. The maximum limit is 100.
-
-
-
-
-
--
-
-**status:** `typing.Optional[str]` — Filter by status. Options: `COMPLETE`, `IDLE`, `INCOMPLETE`, `RELINK_NEEDED`
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-
-
-## Hris Locations
-client.hris.locations.list(...)
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Returns a list of `Location` objects.
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-import datetime
-
-from merge import Merge
-from merge.resources.hris.resources.locations import (
- LocationsListRequestLocationType,
- LocationsListRequestRemoteFields,
- LocationsListRequestShowEnumOrigins,
-)
-
-client = Merge(
- account_token="YOUR_ACCOUNT_TOKEN",
- api_key="YOUR_API_KEY",
-)
-client.hris.locations.list(
- created_after=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- created_before=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
- include_deleted_data=True,
- include_remote_data=True,
- include_shell_data=True,
- location_type=LocationsListRequestLocationType.HOME,
- modified_after=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- modified_before=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- page_size=1,
- remote_fields=LocationsListRequestRemoteFields.COUNTRY,
- remote_id="remote_id",
- show_enum_origins=LocationsListRequestShowEnumOrigins.COUNTRY,
-)
-
-```
-
-
-
-
-
-#### ⚙️ 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
-
-
-
-
-
--
-
-**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
-
-
-
-
-
--
-
-**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
-
-
-
-
-
--
-
-**page_size:** `typing.Optional[int]` — Number of results to return per page. The maximum limit is 100.
-
-
-
-
-
--
-
-**remote_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.
-
-
-
-
-
-
-
-
-
-
-
-client.hris.locations.retrieve(...)
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Returns a `Location` object with the given `id`.
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from merge import Merge
-from merge.resources.hris.resources.locations import (
- LocationsRetrieveRequestRemoteFields,
- LocationsRetrieveRequestShowEnumOrigins,
-)
-
-client = Merge(
- account_token="YOUR_ACCOUNT_TOKEN",
- api_key="YOUR_API_KEY",
-)
-client.hris.locations.retrieve(
- id="id",
- include_remote_data=True,
- include_shell_data=True,
- remote_fields=LocationsRetrieveRequestRemoteFields.COUNTRY,
- show_enum_origins=LocationsRetrieveRequestShowEnumOrigins.COUNTRY,
-)
-
-```
-
-
-
-
-
-#### ⚙️ 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[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)
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-
-
-## Hris Passthrough
-client.hris.passthrough.create(...)
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Pull data from an endpoint not currently supported by Merge.
-
-
-
-
-
-#### 🔌 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.passthrough.create(
- request=DataPassthroughRequest(
- method=MethodEnum.GET,
- path="/scooters",
- ),
-)
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**request:** `DataPassthroughRequest`
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-
-
-## Hris PayGroups
-client.hris.pay_groups.list(...)
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Returns a list of `PayGroup` objects.
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-import datetime
-
-from merge import Merge
-
-client = Merge(
- account_token="YOUR_ACCOUNT_TOKEN",
- api_key="YOUR_API_KEY",
-)
-client.hris.pay_groups.list(
- created_after=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- created_before=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
- include_deleted_data=True,
- include_remote_data=True,
- include_shell_data=True,
- modified_after=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- modified_before=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- page_size=1,
- remote_id="remote_id",
-)
-
-```
-
-
-
-
-
-#### ⚙️ 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).
-
-
-
-
-
--
-
-**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
-
-
-
-
-
--
-
-**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
-
-
-
-
-
--
-
-**page_size:** `typing.Optional[int]` — Number of results to return per page. The maximum limit is 100.
-
-
-
-
-
--
-
-**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-
-
-client.hris.pay_groups.retrieve(...)
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Returns a `PayGroup` 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.pay_groups.retrieve(
- id="id",
- include_remote_data=True,
- include_shell_data=True,
-)
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**id:** `str`
-
-
-
-
-
--
-
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
-
-
-
-
-
--
-
-**include_shell_data:** `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 PayrollRuns
-client.hris.payroll_runs.list(...)
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Returns a list of `PayrollRun` objects.
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-import datetime
-
-from merge import Merge
-from merge.resources.hris.resources.payroll_runs import (
- PayrollRunsListRequestRemoteFields,
- PayrollRunsListRequestRunType,
- PayrollRunsListRequestShowEnumOrigins,
-)
-
-client = Merge(
- account_token="YOUR_ACCOUNT_TOKEN",
- api_key="YOUR_API_KEY",
-)
-client.hris.payroll_runs.list(
- created_after=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- created_before=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
- ended_after=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- ended_before=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- include_deleted_data=True,
- include_remote_data=True,
- include_shell_data=True,
- modified_after=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- modified_before=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- page_size=1,
- remote_fields=PayrollRunsListRequestRemoteFields.RUN_STATE,
- remote_id="remote_id",
- run_type=PayrollRunsListRequestRunType.CORRECTION,
- show_enum_origins=PayrollRunsListRequestShowEnumOrigins.RUN_STATE,
- started_after=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- started_before=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
-)
-
-```
-
-
-
-
-
-#### ⚙️ 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.
-
-
-
-
-
--
-
-**page_size:** `typing.Optional[int]` — Number of results to return per page. The maximum limit is 100.
-
-
-
-
-
--
-
-**remote_fields:** `typing.Optional[PayrollRunsListRequestRemoteFields]` — Deprecated. Use show_enum_origins.
-
-
-
-
-
--
-
-**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
-
-
-
-
-
--
-
-**run_type:** `typing.Optional[PayrollRunsListRequestRunType]`
-
-If provided, will only return PayrollRun's with this status. Options: ('REGULAR', 'OFF_CYCLE', 'CORRECTION', 'TERMINATION', 'SIGN_ON_BONUS')
-
-* `REGULAR` - REGULAR
-* `OFF_CYCLE` - OFF_CYCLE
-* `CORRECTION` - CORRECTION
-* `TERMINATION` - TERMINATION
-* `SIGN_ON_BONUS` - SIGN_ON_BONUS
-
-
-
-
-
--
-
-**show_enum_origins:** `typing.Optional[PayrollRunsListRequestShowEnumOrigins]` — A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter)
-
-
-
-
-
--
-
-**started_after:** `typing.Optional[dt.datetime]` — If provided, will only return payroll runs started after this datetime.
-
-
-
-
-
--
-
-**started_before:** `typing.Optional[dt.datetime]` — If provided, will only return payroll runs started before this datetime.
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-
-
-client.hris.payroll_runs.retrieve(...)
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Returns a `PayrollRun` object with the given `id`.
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from merge import Merge
-from merge.resources.hris.resources.payroll_runs import (
- PayrollRunsRetrieveRequestRemoteFields,
- PayrollRunsRetrieveRequestShowEnumOrigins,
-)
-
-client = Merge(
- account_token="YOUR_ACCOUNT_TOKEN",
- api_key="YOUR_API_KEY",
-)
-client.hris.payroll_runs.retrieve(
- id="id",
- include_remote_data=True,
- include_shell_data=True,
- remote_fields=PayrollRunsRetrieveRequestRemoteFields.RUN_STATE,
- show_enum_origins=PayrollRunsRetrieveRequestShowEnumOrigins.RUN_STATE,
-)
-
-```
-
-
-
-
-
-#### ⚙️ 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[PayrollRunsRetrieveRequestRemoteFields]` — Deprecated. Use show_enum_origins.
-
-
-
-
-
--
-
-**show_enum_origins:** `typing.Optional[PayrollRunsRetrieveRequestShowEnumOrigins]` — A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter)
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-
-
-## Hris RegenerateKey
-client.hris.regenerate_key.create(...)
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Exchange remote keys.
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from merge import Merge
-
-client = Merge(
- account_token="YOUR_ACCOUNT_TOKEN",
- api_key="YOUR_API_KEY",
-)
-client.hris.regenerate_key.create(
- name="Remote Deployment Key 1",
-)
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**name:** `str` — The name of the remote key
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-
-
-## Hris SyncStatus
-client.hris.sync_status.list(...)
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Get sync status for the current sync and the most recently finished sync. `last_sync_start` represents the most recent time any sync began. `last_sync_finished` represents the most recent time any sync completed. These timestamps may correspond to different sync instances which may result in a sync start time being later than a separate sync completed time. To ensure you are retrieving the latest available data reference the `last_sync_finished` timestamp where `last_sync_result` is `DONE`. Possible values for `status` and `last_sync_result` are `DISABLED`, `DONE`, `FAILED`, `PARTIALLY_SYNCED`, `PAUSED`, `SYNCING`. Learn more about sync status in our [Help Center](https://help.merge.dev/en/articles/8184193-merge-sync-statuses).
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from merge import Merge
-
-client = Merge(
- account_token="YOUR_ACCOUNT_TOKEN",
- api_key="YOUR_API_KEY",
-)
-client.hris.sync_status.list(
- cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
- page_size=1,
-)
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**cursor:** `typing.Optional[str]` — The pagination cursor value.
-
-
-
-
-
--
-
-**page_size:** `typing.Optional[int]` — Number of results to return per page. The maximum limit is 100.
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-
-
-## Hris ForceResync
-client.hris.force_resync.sync_status_resync_create()
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Force re-sync of all models. This endpoint is available for monthly, quarterly, and highest sync frequency customers on the Professional or Enterprise plans. Doing so will consume a sync credit for the relevant linked account. Force re-syncs can also be triggered manually in the Merge Dashboard and is available for all customers.
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from merge import Merge
-
-client = Merge(
- account_token="YOUR_ACCOUNT_TOKEN",
- api_key="YOUR_API_KEY",
-)
-client.hris.force_resync.sync_status_resync_create()
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-
-
-## Hris Teams
-client.hris.teams.list(...)
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Returns a list of `Team` objects.
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-import datetime
-
-from merge import Merge
-
-client = Merge(
- account_token="YOUR_ACCOUNT_TOKEN",
- api_key="YOUR_API_KEY",
-)
-client.hris.teams.list(
- created_after=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- created_before=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
- include_deleted_data=True,
- include_remote_data=True,
- include_shell_data=True,
- modified_after=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- modified_before=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- page_size=1,
- parent_team_id="parent_team_id",
- remote_id="remote_id",
-)
-
-```
-
-
-
-
-
-#### ⚙️ 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[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/).
-
-
-
-
-
--
-
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
-
-
-
-
-
--
-
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
-
-
-
-
-
--
-
-**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
-
-
-
-
-
--
-
-**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
-
-
-
-
-
--
-
-**page_size:** `typing.Optional[int]` — Number of results to return per page. The maximum limit is 100.
-
-
-
-
-
--
-
-**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.
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-
-
-client.hris.teams.retrieve(...)
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Returns a `Team` 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.teams.retrieve(
- id="id",
- include_remote_data=True,
- include_shell_data=True,
-)
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**id:** `str`
-
-
-
-
-
--
-
-**expand:** `typing.Optional[typing.Literal["parent_team"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
-
-
-
-
-
--
-
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
-
-
-
-
-
--
-
-**include_shell_data:** `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 TimeOff
-client.hris.time_off.list(...)
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Returns a list of `TimeOff` objects.
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-import datetime
-
-from merge import Merge
-from merge.resources.hris.resources.time_off import (
- TimeOffListRequestExpand,
- TimeOffListRequestRemoteFields,
- TimeOffListRequestRequestType,
- TimeOffListRequestShowEnumOrigins,
- TimeOffListRequestStatus,
-)
-
-client = Merge(
- account_token="YOUR_ACCOUNT_TOKEN",
- api_key="YOUR_API_KEY",
-)
-client.hris.time_off.list(
- approver_id="approver_id",
- created_after=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- created_before=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
- employee_id="employee_id",
- ended_after=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- ended_before=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- expand=TimeOffListRequestExpand.APPROVER,
- include_deleted_data=True,
- include_remote_data=True,
- include_shell_data=True,
- modified_after=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- modified_before=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- page_size=1,
- remote_fields=TimeOffListRequestRemoteFields.REQUEST_TYPE,
- remote_id="remote_id",
- request_type=TimeOffListRequestRequestType.BEREAVEMENT,
- show_enum_origins=TimeOffListRequestShowEnumOrigins.REQUEST_TYPE,
- started_after=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- started_before=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- status=TimeOffListRequestStatus.APPROVED,
-)
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**approver_id:** `typing.Optional[str]` — If provided, will only return time off for this approver.
-
-
-
-
-
--
-
-**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
-
-
-
-
-
--
-
-**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
-
-
-
-
-
--
-
-**cursor:** `typing.Optional[str]` — The pagination cursor value.
-
-
-
-
-
--
-
-**employee_id:** `typing.Optional[str]` — If provided, will only return time off for this employee.
-
-
-
-
-
--
-
-**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.
-
-
-
-
-
--
-
-**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/).
-
-
-
-
-
--
-
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
-
-
-
-
-
--
-
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
-
-
-
-
-
--
-
-**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
-
-
-
-
-
--
-
-**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
-
-
-
-
-
--
-
-**page_size:** `typing.Optional[int]` — Number of results to return per page. The maximum limit is 100.
-
-
-
-
-
--
-
-**remote_fields:** `typing.Optional[TimeOffListRequestRemoteFields]` — Deprecated. Use show_enum_origins.
-
-
-
-
-
--
-
-**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
-
-
-
-
-
--
-
-**request_type:** `typing.Optional[TimeOffListRequestRequestType]`
-
-If provided, will only return TimeOff with this request type. Options: ('VACATION', 'SICK', 'PERSONAL', 'JURY_DUTY', 'VOLUNTEER', 'BEREAVEMENT')
-
-* `VACATION` - VACATION
-* `SICK` - SICK
-* `PERSONAL` - PERSONAL
-* `JURY_DUTY` - JURY_DUTY
-* `VOLUNTEER` - VOLUNTEER
-* `BEREAVEMENT` - BEREAVEMENT
-
-
-
-
-
--
-
-**show_enum_origins:** `typing.Optional[TimeOffListRequestShowEnumOrigins]` — A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter)
-
-
-
-
-
--
-
-**started_after:** `typing.Optional[dt.datetime]` — If provided, will only return time-offs that started after this datetime.
-
-
-
-
-
--
-
-**started_before:** `typing.Optional[dt.datetime]` — If provided, will only return time-offs that started before this datetime.
-
-
-
-
-
--
-
-**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
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-
-
-client.hris.time_off.create(...)
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Creates a `TimeOff` object with the given values.
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from merge import Merge
-from merge.resources.hris import TimeOffRequest
-
-client = Merge(
- account_token="YOUR_ACCOUNT_TOKEN",
- api_key="YOUR_API_KEY",
-)
-client.hris.time_off.create(
- is_debug_mode=True,
- run_async=True,
- model=TimeOffRequest(),
-)
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**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.
-
-
-
-
-
-
-
-
-
-
-
-client.hris.time_off.retrieve(...)
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Returns a `TimeOff` object with the given `id`.
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from merge import Merge
-from merge.resources.hris.resources.time_off import (
- TimeOffRetrieveRequestExpand,
- TimeOffRetrieveRequestRemoteFields,
- TimeOffRetrieveRequestShowEnumOrigins,
-)
-
-client = Merge(
- account_token="YOUR_ACCOUNT_TOKEN",
- api_key="YOUR_API_KEY",
-)
-client.hris.time_off.retrieve(
- id="id",
- expand=TimeOffRetrieveRequestExpand.APPROVER,
- include_remote_data=True,
- include_shell_data=True,
- remote_fields=TimeOffRetrieveRequestRemoteFields.REQUEST_TYPE,
- show_enum_origins=TimeOffRetrieveRequestShowEnumOrigins.REQUEST_TYPE,
-)
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**id:** `str`
-
-
-
-
-
--
-
-**expand:** `typing.Optional[TimeOffRetrieveRequestExpand]` — 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[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)
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-
-
-client.hris.time_off.meta_post_retrieve()
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Returns metadata for `TimeOff` POSTs.
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from merge import Merge
-
-client = Merge(
- account_token="YOUR_ACCOUNT_TOKEN",
- api_key="YOUR_API_KEY",
-)
-client.hris.time_off.meta_post_retrieve()
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-
-
-## Hris TimeOffBalances
-client.hris.time_off_balances.list(...)
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Returns a list of `TimeOffBalance` objects.
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-import datetime
-
-from merge import Merge
-from merge.resources.hris.resources.time_off_balances import (
- TimeOffBalancesListRequestPolicyType,
-)
-
-client = Merge(
- account_token="YOUR_ACCOUNT_TOKEN",
- api_key="YOUR_API_KEY",
-)
-client.hris.time_off_balances.list(
- created_after=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- created_before=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
- employee_id="employee_id",
- include_deleted_data=True,
- include_remote_data=True,
- include_shell_data=True,
- modified_after=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- modified_before=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- page_size=1,
- policy_type=TimeOffBalancesListRequestPolicyType.BEREAVEMENT,
- remote_id="remote_id",
-)
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
-
-
-
-
-
--
-
-**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
-
-
-
-
-
--
-
-**cursor:** `typing.Optional[str]` — The pagination cursor value.
-
-
-
-
-
--
-
-**employee_id:** `typing.Optional[str]` — If provided, will only return time off balances for this employee.
-
-
-
-
-
--
-
-**expand:** `typing.Optional[typing.Literal["employee"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
-
-
-
-
-
--
-
-**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
-
-
-
-
-
--
-
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
-
-
-
-
-
--
-
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
-
-
-
-
-
--
-
-**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
-
-
-
-
-
--
-
-**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
-
-
-
-
-
--
-
-**page_size:** `typing.Optional[int]` — Number of results to return per page. The maximum limit is 100.
-
-
-
-
-
--
-
-**policy_type:** `typing.Optional[TimeOffBalancesListRequestPolicyType]`
-
-If provided, will only return TimeOffBalance with this policy type. Options: ('VACATION', 'SICK', 'PERSONAL', 'JURY_DUTY', 'VOLUNTEER', 'BEREAVEMENT')
-
-* `VACATION` - VACATION
-* `SICK` - SICK
-* `PERSONAL` - PERSONAL
-* `JURY_DUTY` - JURY_DUTY
-* `VOLUNTEER` - VOLUNTEER
-* `BEREAVEMENT` - BEREAVEMENT
-
-
-
-
-
--
-
-**remote_fields:** `typing.Optional[typing.Literal["policy_type"]]` — Deprecated. Use show_enum_origins.
-
-
-
-
-
--
-
-**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
-
-
-
-
-
--
-
-**show_enum_origins:** `typing.Optional[typing.Literal["policy_type"]]` — A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter)
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-
-
-client.hris.time_off_balances.retrieve(...)
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Returns a `TimeOffBalance` 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.time_off_balances.retrieve(
- id="id",
- include_remote_data=True,
- include_shell_data=True,
-)
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**id:** `str`
-
-
-
-
-
--
-
-**expand:** `typing.Optional[typing.Literal["employee"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
-
-
-
-
-
--
-
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
-
-
-
-
-
--
-
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
-
-
-
-
-
--
-
-**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.
-
-
-
-
-
-
-
-
-
-
-
-## Hris TimesheetEntries
-client.hris.timesheet_entries.list(...)
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Returns a list of `TimesheetEntry` objects.
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-import datetime
-
-from merge import Merge
-from merge.resources.hris.resources.timesheet_entries import (
- TimesheetEntriesListRequestOrderBy,
-)
-
-client = Merge(
- account_token="YOUR_ACCOUNT_TOKEN",
- api_key="YOUR_API_KEY",
-)
-client.hris.timesheet_entries.list(
- created_after=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- created_before=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
- employee_id="employee_id",
- ended_after=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- ended_before=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- include_deleted_data=True,
- include_remote_data=True,
- include_shell_data=True,
- modified_after=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- modified_before=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- order_by=TimesheetEntriesListRequestOrderBy.START_TIME_DESCENDING,
- page_size=1,
- remote_id="remote_id",
- started_after=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- started_before=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
-)
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
-
-
-
-
-
--
-
-**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
-
-
-
-
-
--
-
-**cursor:** `typing.Optional[str]` — The pagination cursor value.
-
-
-
-
-
--
-
-**employee_id:** `typing.Optional[str]` — If provided, will only return timesheet entries for this employee.
-
-
-
-
-
--
-
-**ended_after:** `typing.Optional[dt.datetime]` — If provided, will only return timesheet entries ended after this datetime.
-
-
-
-
-
--
-
-**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.
-
-
-
-
-
--
-
-**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is 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.
-
-
-
-
-
--
-
-**order_by:** `typing.Optional[TimesheetEntriesListRequestOrderBy]` — Overrides the default ordering for this endpoint. Possible values include: start_time, -start_time.
-
-
-
-
-
--
-
-**page_size:** `typing.Optional[int]` — Number of results to return per page. The maximum limit is 100.
-
-
-
-
-
--
-
-**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
-
-
-
-
-
--
-
-**started_after:** `typing.Optional[dt.datetime]` — If provided, will only return timesheet entries started after this datetime.
-
-
-
-
-
--
-
-**started_before:** `typing.Optional[dt.datetime]` — If provided, will only return timesheet entries started before this datetime.
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-
-
-client.hris.timesheet_entries.create(...)
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Creates a `TimesheetEntry` object with the given values.
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from merge import Merge
-from merge.resources.hris import TimesheetEntryRequest
-
-client = Merge(
- account_token="YOUR_ACCOUNT_TOKEN",
- api_key="YOUR_API_KEY",
-)
-client.hris.timesheet_entries.create(
- is_debug_mode=True,
- run_async=True,
- model=TimesheetEntryRequest(),
-)
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**model:** `TimesheetEntryRequest`
-
-
-
-
-
--
-
-**is_debug_mode:** `typing.Optional[bool]` — Whether to include debug fields (such as log file links) in the response.
-
-
-
-
-
--
-
-**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously.
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-
-
-client.hris.timesheet_entries.retrieve(...)
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Returns a `TimesheetEntry` 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.timesheet_entries.retrieve(
- id="id",
- include_remote_data=True,
- include_shell_data=True,
-)
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**id:** `str`
-
-
-
-
-
--
-
-**expand:** `typing.Optional[typing.Literal["employee"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
-
-
-
-
-
--
-
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
-
-
-
-
-
--
-
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-
-
-client.hris.timesheet_entries.meta_post_retrieve()
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Returns metadata for `TimesheetEntry` POSTs.
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from merge import Merge
-
-client = Merge(
- account_token="YOUR_ACCOUNT_TOKEN",
- api_key="YOUR_API_KEY",
-)
-client.hris.timesheet_entries.meta_post_retrieve()
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-
-
-## Hris WebhookReceivers
-client.hris.webhook_receivers.list()
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Returns a list of `WebhookReceiver` objects.
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from merge import Merge
-
-client = Merge(
- account_token="YOUR_ACCOUNT_TOKEN",
- api_key="YOUR_API_KEY",
-)
-client.hris.webhook_receivers.list()
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-
-
-client.hris.webhook_receivers.create(...)
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Creates a `WebhookReceiver` object with the given values.
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from merge import Merge
-
-client = Merge(
- account_token="YOUR_ACCOUNT_TOKEN",
- api_key="YOUR_API_KEY",
-)
-client.hris.webhook_receivers.create(
- event="event",
- is_active=True,
-)
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**event:** `str`
-
-
-
-
-
--
-
-**is_active:** `bool`
-
-
-
-
-
--
-
-**key:** `typing.Optional[str]`
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-
-
-## Knowledgebase AccountDetails
-client.knowledgebase.account_details.retrieve()
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Get details for a linked account.
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from merge import Merge
-
-client = Merge(
- account_token="YOUR_ACCOUNT_TOKEN",
- api_key="YOUR_API_KEY",
-)
-client.knowledgebase.account_details.retrieve()
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-
-
-## Knowledgebase AccountToken
-client.knowledgebase.account_token.retrieve(...)
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Returns the account token for the end user with the provided public token.
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from merge import Merge
-
-client = Merge(
- account_token="YOUR_ACCOUNT_TOKEN",
- api_key="YOUR_API_KEY",
-)
-client.knowledgebase.account_token.retrieve(
- public_token="public_token",
-)
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**public_token:** `str`
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-
-
-## Knowledgebase Articles
-client.knowledgebase.articles.list(...)
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Returns a list of `Article` objects.
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-import datetime
-
-from merge import Merge
-from merge.resources.knowledgebase.resources.articles import (
- ArticlesListRequestExpand,
- ArticlesListRequestType,
-)
-
-client = Merge(
- account_token="YOUR_ACCOUNT_TOKEN",
- api_key="YOUR_API_KEY",
-)
-client.knowledgebase.articles.list(
- created_after=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- created_before=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
- expand=ArticlesListRequestExpand.ATTACHMENTS,
- include_deleted_data=True,
- include_remote_data=True,
- include_shell_data=True,
- modified_after=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- modified_before=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- page_size=1,
- parent_article_id="parent_article_id",
- parent_container_id="parent_container_id",
- remote_id="remote_id",
- root_container_id="root_container_id",
- status="status",
- type=ArticlesListRequestType.EMPTY,
-)
-
-```
-
-
-
-
-
-#### ⚙️ 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[ArticlesListRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
-
-
-
-
-
--
-
-**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
-
-
-
-
-
--
-
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
-
-
-
-
-
--
-
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
-
-
-
-
-
--
-
-**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
-
-
-
-
-
--
-
-**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
-
-
-
-
-
--
-
-**page_size:** `typing.Optional[int]` — Number of results to return per page. The maximum limit is 100.
-
-
-
-
-
--
-
-**parent_article_id:** `typing.Optional[str]` — If provided, will only return sub articles of the parent_article_id.
-
-
-
-
-
--
-
-**parent_container_id:** `typing.Optional[str]` — If provided, will only return sub articles of the parent_container_id.
-
-
-
-
-
--
-
-**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
-
-
-
-
-
--
-
-**root_container_id:** `typing.Optional[str]` — If provided, will only return sub articles of the root_container_id.
-
-
-
-
-
--
-
-**status:** `typing.Optional[str]` — If provided, will only return articles of the given status; multiple statuses can be separated by commas.
-
-
-
-
-
--
-
-**type:** `typing.Optional[ArticlesListRequestType]` — If provided, will only return articles of the given type.
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-
-
-client.knowledgebase.articles.retrieve(...)
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Returns an `Article` object with the given `id`.
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from merge import Merge
-from merge.resources.knowledgebase.resources.articles import (
- ArticlesRetrieveRequestExpand,
-)
-
-client = Merge(
- account_token="YOUR_ACCOUNT_TOKEN",
- api_key="YOUR_API_KEY",
-)
-client.knowledgebase.articles.retrieve(
- id="id",
- expand=ArticlesRetrieveRequestExpand.ATTACHMENTS,
- include_remote_data=True,
- include_shell_data=True,
-)
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**id:** `str`
-
-
-
-
-
--
-
-**expand:** `typing.Optional[ArticlesRetrieveRequestExpand]` — 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.
-
-
-
-
-
-
-
-
-
-
-
-## Knowledgebase AsyncPassthrough
-client.knowledgebase.async_passthrough.create(...)
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Asynchronously pull data from an endpoint not currently supported by Merge.
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from merge import Merge
-from merge.resources.knowledgebase import DataPassthroughRequest, MethodEnum
-
-client = Merge(
- account_token="YOUR_ACCOUNT_TOKEN",
- api_key="YOUR_API_KEY",
-)
-client.knowledgebase.async_passthrough.create(
- request=DataPassthroughRequest(
- method=MethodEnum.GET,
- path="/scooters",
- ),
-)
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**request:** `DataPassthroughRequest`
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-
-
-client.knowledgebase.async_passthrough.retrieve(...)
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Retrieves data from earlier async-passthrough POST request
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from merge import Merge
-
-client = Merge(
- account_token="YOUR_ACCOUNT_TOKEN",
- api_key="YOUR_API_KEY",
-)
-client.knowledgebase.async_passthrough.retrieve(
- async_passthrough_receipt_id="async_passthrough_receipt_id",
-)
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**async_passthrough_receipt_id:** `str`
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-
-
-## Knowledgebase Attachments
-client.knowledgebase.attachments.list(...)
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Returns a list of `Attachment` objects.
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-import datetime
-
-from merge import Merge
-
-client = Merge(
- account_token="YOUR_ACCOUNT_TOKEN",
- api_key="YOUR_API_KEY",
-)
-client.knowledgebase.attachments.list(
- created_after=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- created_before=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
- include_deleted_data=True,
- include_remote_data=True,
- include_shell_data=True,
- modified_after=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- modified_before=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- page_size=1,
- remote_id="remote_id",
-)
-
-```
-
-
-
-
-
-#### ⚙️ 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).
-
-
-
-
-
--
-
-**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
-
-
-
-
-
--
-
-**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
-
-
-
-
-
--
-
-**page_size:** `typing.Optional[int]` — Number of results to return per page. The maximum limit is 100.
-
-
-
-
-
--
-
-**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-
-
-client.knowledgebase.attachments.retrieve(...)
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Returns an `Attachment` object with the given `id`.
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from merge import Merge
-
-client = Merge(
- account_token="YOUR_ACCOUNT_TOKEN",
- api_key="YOUR_API_KEY",
-)
-client.knowledgebase.attachments.retrieve(
- id="id",
- include_remote_data=True,
- include_shell_data=True,
-)
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**id:** `str`
-
-
-
-
-
--
-
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
-
-
-
-
-
--
-
-**include_shell_data:** `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.
-
-
-
-
-
-
-
-
-
-
-
-## Knowledgebase AuditTrail
-client.knowledgebase.audit_trail.list(...)
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Gets a list of audit trail events.
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from merge import Merge
-
-client = Merge(
- account_token="YOUR_ACCOUNT_TOKEN",
- api_key="YOUR_API_KEY",
-)
-client.knowledgebase.audit_trail.list(
- cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
- end_date="end_date",
- event_type="event_type",
- page_size=1,
- start_date="start_date",
- user_email="user_email",
-)
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**cursor:** `typing.Optional[str]` — The pagination cursor value.
-
-
-
-
-
--
-
-**end_date:** `typing.Optional[str]` — If included, will only include audit trail events that occurred before this time
-
-
-
-
-
--
-
-**event_type:** `typing.Optional[str]` — If included, will only include events with the given event type. Possible values include: `CREATED_REMOTE_PRODUCTION_API_KEY`, `DELETED_REMOTE_PRODUCTION_API_KEY`, `CREATED_TEST_API_KEY`, `DELETED_TEST_API_KEY`, `REGENERATED_PRODUCTION_API_KEY`, `REGENERATED_WEBHOOK_SIGNATURE`, `INVITED_USER`, `TWO_FACTOR_AUTH_ENABLED`, `TWO_FACTOR_AUTH_DISABLED`, `DELETED_LINKED_ACCOUNT`, `DELETED_ALL_COMMON_MODELS_FOR_LINKED_ACCOUNT`, `CREATED_DESTINATION`, `DELETED_DESTINATION`, `CHANGED_DESTINATION`, `CHANGED_SCOPES`, `CHANGED_PERSONAL_INFORMATION`, `CHANGED_ORGANIZATION_SETTINGS`, `ENABLED_INTEGRATION`, `DISABLED_INTEGRATION`, `ENABLED_CATEGORY`, `DISABLED_CATEGORY`, `CHANGED_PASSWORD`, `RESET_PASSWORD`, `ENABLED_REDACT_UNMAPPED_DATA_FOR_ORGANIZATION`, `ENABLED_REDACT_UNMAPPED_DATA_FOR_LINKED_ACCOUNT`, `DISABLED_REDACT_UNMAPPED_DATA_FOR_ORGANIZATION`, `DISABLED_REDACT_UNMAPPED_DATA_FOR_LINKED_ACCOUNT`, `CREATED_INTEGRATION_WIDE_FIELD_MAPPING`, `CREATED_LINKED_ACCOUNT_FIELD_MAPPING`, `CHANGED_INTEGRATION_WIDE_FIELD_MAPPING`, `CHANGED_LINKED_ACCOUNT_FIELD_MAPPING`, `DELETED_INTEGRATION_WIDE_FIELD_MAPPING`, `DELETED_LINKED_ACCOUNT_FIELD_MAPPING`, `CREATED_LINKED_ACCOUNT_COMMON_MODEL_OVERRIDE`, `CHANGED_LINKED_ACCOUNT_COMMON_MODEL_OVERRIDE`, `DELETED_LINKED_ACCOUNT_COMMON_MODEL_OVERRIDE`, `FORCED_LINKED_ACCOUNT_RESYNC`, `MUTED_ISSUE`, `GENERATED_MAGIC_LINK`, `ENABLED_MERGE_WEBHOOK`, `DISABLED_MERGE_WEBHOOK`, `MERGE_WEBHOOK_TARGET_CHANGED`, `END_USER_CREDENTIALS_ACCESSED`
-
-
-
-
-
--
-
-**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.
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-
-
-## Knowledgebase AvailableActions
-client.knowledgebase.available_actions.retrieve()
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Returns a list of models and actions available for an account.
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from merge import Merge
-
-client = Merge(
- account_token="YOUR_ACCOUNT_TOKEN",
- api_key="YOUR_API_KEY",
-)
-client.knowledgebase.available_actions.retrieve()
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-
-
-## Knowledgebase Containers
-client.knowledgebase.containers.list(...)
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Returns a list of `Container` objects.
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-import datetime
-
-from merge import Merge
-from merge.resources.knowledgebase.resources.containers import (
- ContainersListRequestExpand,
- ContainersListRequestType,
-)
-
-client = Merge(
- account_token="YOUR_ACCOUNT_TOKEN",
- api_key="YOUR_API_KEY",
-)
-client.knowledgebase.containers.list(
- created_after=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- created_before=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
- expand=ContainersListRequestExpand.PARENT_ARTICLE,
- include_deleted_data=True,
- include_remote_data=True,
- include_shell_data=True,
- modified_after=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- modified_before=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- page_size=1,
- parent_article_id="parent_article_id",
- parent_container_id="parent_container_id",
- remote_id="remote_id",
- type=ContainersListRequestType.EMPTY,
-)
-
-```
-
-
-
-
-
-#### ⚙️ 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[ContainersListRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
-
-
-
-
-
--
-
-**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
-
-
-
-
-
--
-
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
-
-
-
-
-
--
-
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
-
-
-
-
-
--
-
-**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
-
-
-
-
-
--
-
-**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
-
-
-
-
-
--
-
-**page_size:** `typing.Optional[int]` — Number of results to return per page. The maximum limit is 100.
-
-
-
-
-
--
-
-**parent_article_id:** `typing.Optional[str]` — If provided, will only return sub containers of the parent_article_id.
-
-
-
-
-
--
-
-**parent_container_id:** `typing.Optional[str]` — If provided, will only return sub containers of the parent_container_id.
-
-
-
-
-
--
-
-**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
-
-
-
-
-
--
-
-**type:** `typing.Optional[ContainersListRequestType]` — If provided, will only return containers of the given type.
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-
-
-client.knowledgebase.containers.retrieve(...)
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Returns a `Container` object with the given `id`.
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from merge import Merge
-from merge.resources.knowledgebase.resources.containers import (
- ContainersRetrieveRequestExpand,
-)
-
-client = Merge(
- account_token="YOUR_ACCOUNT_TOKEN",
- api_key="YOUR_API_KEY",
-)
-client.knowledgebase.containers.retrieve(
- id="id",
- expand=ContainersRetrieveRequestExpand.PARENT_ARTICLE,
- include_remote_data=True,
- include_shell_data=True,
-)
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**id:** `str`
-
-
-
-
-
--
-
-**expand:** `typing.Optional[ContainersRetrieveRequestExpand]` — 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.
-
-
-
-
-
-
-
-
-
-
-
-## Knowledgebase Scopes
-client.knowledgebase.scopes.default_scopes_retrieve()
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Get the default permissions for Merge Common Models and fields across all Linked Accounts of a given category. [Learn more](https://help.merge.dev/en/articles/5950052-common-model-and-field-scopes).
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from merge import Merge
-
-client = Merge(
- account_token="YOUR_ACCOUNT_TOKEN",
- api_key="YOUR_API_KEY",
-)
-client.knowledgebase.scopes.default_scopes_retrieve()
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-
-
-client.knowledgebase.scopes.linked_account_scopes_retrieve()
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Get all available permissions for Merge Common Models and fields for a single Linked Account. [Learn more](https://help.merge.dev/en/articles/5950052-common-model-and-field-scopes).
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from merge import Merge
-
-client = Merge(
- account_token="YOUR_ACCOUNT_TOKEN",
- api_key="YOUR_API_KEY",
-)
-client.knowledgebase.scopes.linked_account_scopes_retrieve()
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-
-
-client.knowledgebase.scopes.linked_account_scopes_create(...)
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Update permissions for any Common Model or field for a single Linked Account. Any Scopes not set in this POST request will inherit the default Scopes. [Learn more](https://help.merge.dev/en/articles/5950052-common-model-and-field-scopes)
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from merge import Merge
-from merge.resources.knowledgebase import (
- FieldPermissionDeserializerRequest,
- IndividualCommonModelScopeDeserializerRequest,
- ModelPermissionDeserializerRequest,
-)
-
-client = Merge(
- account_token="YOUR_ACCOUNT_TOKEN",
- api_key="YOUR_API_KEY",
-)
-client.knowledgebase.scopes.linked_account_scopes_create(
- common_models=[
- IndividualCommonModelScopeDeserializerRequest(
- model_name="Employee",
- model_permissions={
- "READ": ModelPermissionDeserializerRequest(
- is_enabled=True,
- ),
- "WRITE": ModelPermissionDeserializerRequest(
- is_enabled=False,
- ),
- },
- field_permissions=FieldPermissionDeserializerRequest(
- enabled_fields=["avatar", "home_location"],
- disabled_fields=["work_location"],
- ),
- ),
- IndividualCommonModelScopeDeserializerRequest(
- model_name="Benefit",
- model_permissions={
- "WRITE": ModelPermissionDeserializerRequest(
- is_enabled=False,
- )
- },
- ),
- ],
-)
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**common_models:** `typing.Sequence[IndividualCommonModelScopeDeserializerRequest]` — The common models you want to update the scopes for
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-
-
-## Knowledgebase DeleteAccount
-client.knowledgebase.delete_account.delete()
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Delete a linked account.
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from merge import Merge
-
-client = Merge(
- account_token="YOUR_ACCOUNT_TOKEN",
- api_key="YOUR_API_KEY",
-)
-client.knowledgebase.delete_account.delete()
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-
-
-## Knowledgebase FieldMapping
-client.knowledgebase.field_mapping.field_mappings_retrieve(...)
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Get all Field Mappings for this Linked Account. Field Mappings are mappings between third-party Remote Fields and user defined Merge fields. [Learn more](https://docs.merge.dev/supplemental-data/field-mappings/overview/).
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from merge import Merge
-
-client = Merge(
- account_token="YOUR_ACCOUNT_TOKEN",
- api_key="YOUR_API_KEY",
-)
-client.knowledgebase.field_mapping.field_mappings_retrieve(
- exclude_remote_field_metadata=True,
-)
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**exclude_remote_field_metadata:** `typing.Optional[bool]` — If `true`, remote fields metadata is excluded from each field mapping instance (i.e. `remote_fields.remote_key_name` and `remote_fields.schema` will be null). This will increase the speed of the request since these fields require some calculations.
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-
-
-client.knowledgebase.field_mapping.field_mappings_create(...)
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Create new Field Mappings that will be available after the next scheduled sync. This will cause the next sync for this Linked Account to sync **ALL** data from start.
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from merge import Merge
-
-client = Merge(
- account_token="YOUR_ACCOUNT_TOKEN",
- api_key="YOUR_API_KEY",
-)
-client.knowledgebase.field_mapping.field_mappings_create(
- exclude_remote_field_metadata=True,
- target_field_name="example_target_field_name",
- target_field_description="this is a example description of the target field",
- remote_field_traversal_path=["example_remote_field"],
- remote_method="GET",
- remote_url_path="/example-url-path",
- common_model_name="ExampleCommonModel",
-)
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**target_field_name:** `str` — The name of the target field you want this remote field to map to.
-
-
-
-
-
--
-
-**target_field_description:** `str` — The description of the target field you want this remote field to map to.
-
-
-
-
-
--
-
-**remote_field_traversal_path:** `typing.Sequence[typing.Optional[typing.Any]]` — The field traversal path of the remote field listed when you hit the GET /remote-fields endpoint.
-
-
-
-
-
--
-
-**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.
-
-
-
-
-
--
-
-**jmes_path:** `typing.Optional[str]` — JMES path to specify json query expression to be used on field mapping.
-
-
-
-
-
--
-
**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -37187,7 +27740,8 @@ client.knowledgebase.field_mapping.field_mappings_create(
-client.knowledgebase.field_mapping.field_mappings_destroy(...)
+## Crm Leads
+client.crm.leads.list(...)
-
@@ -37199,7 +27753,7 @@ client.knowledgebase.field_mapping.field_mappings_create(
-
-Deletes Field Mappings for a Linked Account. All data related to this Field Mapping will be deleted and these changes will be reflected after the next scheduled sync. This will cause the next sync for this Linked Account to sync **ALL** data from start.
+Returns a list of `Lead` objects.
@@ -37220,9 +27774,14 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.knowledgebase.field_mapping.field_mappings_destroy(
- field_mapping_id="field_mapping_id",
+response = client.crm.leads.list(
+ cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
)
+for item in response:
+ yield item
+# alternatively, you can paginate page-by-page
+for page in response.iter_pages():
+ yield page
```
@@ -37238,7 +27797,7 @@ client.knowledgebase.field_mapping.field_mappings_destroy(
-
-**field_mapping_id:** `str`
+**converted_account_id:** `typing.Optional[str]` — If provided, will only return leads with this account.
@@ -37246,70 +27805,39 @@ client.knowledgebase.field_mapping.field_mappings_destroy(
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+**converted_contact_id:** `typing.Optional[str]` — If provided, will only return leads with this contact.
-
-
-
-
-
-
-
-client.knowledgebase.field_mapping.field_mappings_partial_update(...)
-
-#### 📝 Description
-
-
--
+**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
+
+
+
-
-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.
-
-
+**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
+
-#### 🔌 Usage
-
-
--
-
-
-```python
-from merge import Merge
-
-client = Merge(
- account_token="YOUR_ACCOUNT_TOKEN",
- api_key="YOUR_API_KEY",
-)
-client.knowledgebase.field_mapping.field_mappings_partial_update(
- field_mapping_id="field_mapping_id",
-)
-
-```
-
-
+**cursor:** `typing.Optional[str]` — The pagination cursor value.
+
-#### ⚙️ Parameters
-
-
--
-
-
-**field_mapping_id:** `str`
+**email_addresses:** `typing.Optional[str]` — If provided, will only return contacts matching the email addresses; multiple email_addresses can be separated by commas.
@@ -37317,7 +27845,11 @@ client.knowledgebase.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.
+**expand:** `typing.Optional[
+ typing.Union[
+ LeadsListRequestExpandItem, typing.Sequence[LeadsListRequestExpandItem]
+ ]
+]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -37325,7 +27857,7 @@ client.knowledgebase.field_mapping.field_mappings_partial_update(
-
-**remote_method:** `typing.Optional[str]` — The method of the remote endpoint where the remote field is coming from.
+**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
@@ -37333,7 +27865,7 @@ client.knowledgebase.field_mapping.field_mappings_partial_update(
-
-**remote_url_path:** `typing.Optional[str]` — The path of the remote endpoint where the remote field is coming from.
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -37341,7 +27873,7 @@ client.knowledgebase.field_mapping.field_mappings_partial_update(
-
-**jmes_path:** `typing.Optional[str]` — JMES path to specify json query expression to be used on field mapping.
+**include_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.
@@ -37349,71 +27881,47 @@ client.knowledgebase.field_mapping.field_mappings_partial_update(
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
-
-
+
+-
+**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
+
-
-client.knowledgebase.field_mapping.remote_fields_retrieve(...)
-
-#### 📝 Description
-
-
--
+**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/).
-
-
+**owner_id:** `typing.Optional[str]` — If provided, will only return leads with this owner.
+
-#### 🔌 Usage
-
-
-
--
-
-```python
-from merge import Merge
-
-client = Merge(
- account_token="YOUR_ACCOUNT_TOKEN",
- api_key="YOUR_API_KEY",
-)
-client.knowledgebase.field_mapping.remote_fields_retrieve(
- common_models="common_models",
- include_example_values="include_example_values",
-)
-
-```
-
-
+**page_size:** `typing.Optional[int]` — Number of results to return per page.
+
-#### ⚙️ Parameters
-
-
--
-
-
-**common_models:** `typing.Optional[str]` — A comma seperated list of Common Model names. If included, will only return Remote Fields for those Common Models.
+**phone_numbers:** `typing.Optional[str]` — If provided, will only return contacts matching the phone numbers; multiple phone numbers can be separated by commas.
@@ -37421,7 +27929,7 @@ client.knowledgebase.field_mapping.remote_fields_retrieve(
-
-**include_example_values:** `typing.Optional[str]` — If true, will include example values, where available, for remote fields in the 3rd party platform. These examples come from active data from your customers.
+**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
@@ -37441,7 +27949,7 @@ client.knowledgebase.field_mapping.remote_fields_retrieve(
-client.knowledgebase.field_mapping.target_fields_retrieve()
+client.crm.leads.create(...)
-
@@ -37453,7 +27961,7 @@ client.knowledgebase.field_mapping.remote_fields_retrieve(
-
-Get all organization-wide Target Fields, this will not include any Linked Account specific Target Fields. Organization-wide Target Fields are additional fields appended to the Merge Common Model for all Linked Accounts in a category. [Learn more](https://docs.merge.dev/supplemental-data/field-mappings/target-fields/).
+Creates a `Lead` object with the given values.
@@ -37469,12 +27977,15 @@ Get all organization-wide Target Fields, this will not include any Linked Accoun
```python
from merge import Merge
+from merge.resources.crm import LeadRequest
client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.knowledgebase.field_mapping.target_fields_retrieve()
+client.crm.leads.create(
+ model=LeadRequest(),
+)
```
@@ -37490,71 +28001,23 @@ client.knowledgebase.field_mapping.target_fields_retrieve()
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+**model:** `LeadRequest`
-
-
-
-
-
-
-
-
-## Knowledgebase GenerateKey
-client.knowledgebase.generate_key.create(...)
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Create a remote key.
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-```python
-from merge import Merge
-
-client = Merge(
- account_token="YOUR_ACCOUNT_TOKEN",
- api_key="YOUR_API_KEY",
-)
-client.knowledgebase.generate_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.
@@ -37574,8 +28037,7 @@ client.knowledgebase.generate_key.create(
-## Knowledgebase Groups
-client.knowledgebase.groups.list(...)
+client.crm.leads.retrieve(...)
-
@@ -37587,7 +28049,7 @@ client.knowledgebase.generate_key.create(
-
-Returns a list of `Group` objects.
+Returns a `Lead` object with the given `id`.
@@ -37602,37 +28064,14 @@ Returns a list of `Group` objects.
-
```python
-import datetime
-
from merge import Merge
-from merge.resources.knowledgebase.resources.groups import (
- GroupsListRequestExpand,
-)
client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.knowledgebase.groups.list(
- created_after=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- created_before=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
- expand=GroupsListRequestExpand.PARENT_GROUP,
- include_deleted_data=True,
- include_remote_data=True,
- include_shell_data=True,
- modified_after=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- modified_before=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- page_size=1,
- remote_id="remote_id",
+client.crm.leads.retrieve(
+ id="id",
)
```
@@ -37649,31 +28088,7 @@ client.knowledgebase.groups.list(
-
-**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
-
-
-
-
-
--
-
-**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
-
-
-
-
-
--
-
-**cursor:** `typing.Optional[str]` — The pagination cursor value.
-
-
-
-
-
--
-
-**expand:** `typing.Optional[GroupsListRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+**id:** `str`
@@ -37681,7 +28096,12 @@ client.knowledgebase.groups.list(
-
-**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
+**expand:** `typing.Optional[
+ typing.Union[
+ LeadsRetrieveRequestExpandItem,
+ typing.Sequence[LeadsRetrieveRequestExpandItem],
+ ]
+]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -37697,31 +28117,7 @@ client.knowledgebase.groups.list(
-
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
-
-
-
-
-
--
-
-**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
-
-
-
-
-
--
-
-**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
-
-
-
-
-
--
-
-**page_size:** `typing.Optional[int]` — Number of results to return per page. The maximum limit is 100.
+**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.
@@ -37729,7 +28125,7 @@ client.knowledgebase.groups.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).
@@ -37749,7 +28145,7 @@ client.knowledgebase.groups.list(
-client.knowledgebase.groups.retrieve(...)
+client.crm.leads.meta_post_retrieve()
-
@@ -37761,7 +28157,7 @@ client.knowledgebase.groups.list(
-
-Returns a `Group` object with the given `id`.
+Returns metadata for `Lead` POSTs.
@@ -37777,20 +28173,12 @@ Returns a `Group` object with the given `id`.
```python
from merge import Merge
-from merge.resources.knowledgebase.resources.groups import (
- GroupsRetrieveRequestExpand,
-)
client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.knowledgebase.groups.retrieve(
- id="id",
- expand=GroupsRetrieveRequestExpand.PARENT_GROUP,
- include_remote_data=True,
- include_shell_data=True,
-)
+client.crm.leads.meta_post_retrieve()
```
@@ -37806,38 +28194,6 @@ client.knowledgebase.groups.retrieve(
-
-**id:** `str`
-
-
-
-
-
--
-
-**expand:** `typing.Optional[GroupsRetrieveRequestExpand]` — 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.
@@ -37850,8 +28206,7 @@ client.knowledgebase.groups.retrieve(
-## Knowledgebase Issues
-client.knowledgebase.issues.list(...)
+client.crm.leads.remote_field_classes_list(...)
-
@@ -37863,7 +28218,7 @@ client.knowledgebase.groups.retrieve(
-
-Gets all issues for Organization.
+Returns a list of `RemoteFieldClass` objects.
@@ -37878,41 +28233,20 @@ Gets all issues for Organization.
-
```python
-import datetime
-
from merge import Merge
-from merge.resources.knowledgebase.resources.issues import (
- IssuesListRequestStatus,
-)
client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.knowledgebase.issues.list(
- account_token="account_token",
+response = client.crm.leads.remote_field_classes_list(
cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
- end_date="end_date",
- end_user_organization_name="end_user_organization_name",
- first_incident_time_after=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- first_incident_time_before=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- include_muted="include_muted",
- integration_name="integration_name",
- last_incident_time_after=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- last_incident_time_before=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- linked_account_id="linked_account_id",
- page_size=1,
- start_date="start_date",
- status=IssuesListRequestStatus.ONGOING,
)
+for item in response:
+ yield item
+# alternatively, you can paginate page-by-page
+for page in response.iter_pages():
+ yield page
```
@@ -37928,14 +28262,6 @@ client.knowledgebase.issues.list(
-
-**account_token:** `typing.Optional[str]`
-
-
-
-
-
--
-
**cursor:** `typing.Optional[str]` — The pagination cursor value.
@@ -37944,63 +28270,7 @@ client.knowledgebase.issues.list(
-
-**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.
+**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
@@ -38008,7 +28278,7 @@ client.knowledgebase.issues.list(
-
-**linked_account_id:** `typing.Optional[str]` — If provided, will only include issues pertaining to the linked account passed in.
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -38016,7 +28286,7 @@ client.knowledgebase.issues.list(
-
-**page_size:** `typing.Optional[int]` — Number of results to return per page. The maximum limit is 100.
+**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.
@@ -38024,7 +28294,7 @@ client.knowledgebase.issues.list(
-
-**start_date:** `typing.Optional[str]` — If included, will only include issues whose most recent action occurred after this time
+**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -38032,12 +28302,7 @@ client.knowledgebase.issues.list(
-
-**status:** `typing.Optional[IssuesListRequestStatus]`
-
-Status of the issue. Options: ('ONGOING', 'RESOLVED')
-
-* `ONGOING` - ONGOING
-* `RESOLVED` - RESOLVED
+**is_common_model_field:** `typing.Optional[bool]` — If provided, will only return remote field classes with this is_common_model_field value
@@ -38045,70 +28310,15 @@ Status of the issue. Options: ('ONGOING', 'RESOLVED')
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+**is_custom:** `typing.Optional[bool]` — If provided, will only return remote fields classes with this is_custom value
-
-
-
-
-
-
-
-
-client.knowledgebase.issues.retrieve(...)
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Get a specific issue.
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from merge import Merge
-
-client = Merge(
- account_token="YOUR_ACCOUNT_TOKEN",
- api_key="YOUR_API_KEY",
-)
-client.knowledgebase.issues.retrieve(
- id="id",
-)
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-**id:** `str`
+**page_size:** `typing.Optional[int]` — Number of results to return per page.
@@ -38128,8 +28338,8 @@ client.knowledgebase.issues.retrieve(
-## Knowledgebase LinkToken
-client.knowledgebase.link_token.create(...)
+## Crm LinkToken
+client.crm.link_token.create(...)
-
@@ -38157,13 +28367,13 @@ Creates a link token to be used when linking a new end user.
```python
from merge import Merge
-from merge.resources.knowledgebase import CategoriesEnum
+from merge.resources.crm import CategoriesEnum
client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.knowledgebase.link_token.create(
+client.crm.link_token.create(
end_user_email_address="example@gmail.com",
end_user_organization_name="Test Organization",
end_user_origin_id="12345",
@@ -38292,19 +28502,7 @@ The following subset of IETF language tags can be used to configure localization
-
-**integration_specific_config:** `typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]]` — A JSON object containing integration-specific configuration options.
-
-
-
-
-
--
-
-**completed_account_initial_screen:** `typing.Optional[EndUserDetailsRequestCompletedAccountInitialScreen]`
-
-When creating a Link token, you can specifiy the initial screen of Linking Flow for a completed Linked Account.
-
-* `SELECTIVE_SYNC` - SELECTIVE_SYNC
+**integration_specific_config:** `typing.Optional[typing.Dict[str, typing.Any]]` — A JSON object containing integration-specific configuration options.
@@ -38324,8 +28522,8 @@ When creating a Link token, you can specifiy the initial screen of Linking Flow
-## Knowledgebase LinkedAccounts
-client.knowledgebase.linked_accounts.list(...)
+## Crm LinkedAccounts
+client.crm.linked_accounts.list(...)
-
@@ -38353,29 +28551,19 @@ List linked accounts for your organization.
```python
from merge import Merge
-from merge.resources.knowledgebase.resources.linked_accounts import (
- LinkedAccountsListRequestCategory,
-)
client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.knowledgebase.linked_accounts.list(
- category=LinkedAccountsListRequestCategory.ACCOUNTING,
+response = client.crm.linked_accounts.list(
cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
- end_user_email_address="end_user_email_address",
- end_user_organization_name="end_user_organization_name",
- end_user_origin_id="end_user_origin_id",
- end_user_origin_ids="end_user_origin_ids",
- id="id",
- ids="ids",
- include_duplicates=True,
- integration_name="integration_name",
- is_test_account="is_test_account",
- page_size=1,
- status="status",
)
+for item in response:
+ yield item
+# alternatively, you can paginate page-by-page
+for page in response.iter_pages():
+ yield page
```
@@ -38393,7 +28581,7 @@ client.knowledgebase.linked_accounts.list(
**category:** `typing.Optional[LinkedAccountsListRequestCategory]`
-Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `knowledgebase`, `mktg`, `ticketing`
+Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing`
* `hris` - hris
* `ats` - ats
@@ -38402,7 +28590,6 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `knowledgebase`, `mk
* `crm` - crm
* `mktg` - mktg
* `filestorage` - filestorage
-* `knowledgebase` - knowledgebase
@@ -38490,7 +28677,7 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `knowledgebase`, `mk
-
-**page_size:** `typing.Optional[int]` — Number of results to return per page. The maximum limit is 100.
+**page_size:** `typing.Optional[int]` — Number of results to return per page.
@@ -38518,8 +28705,8 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `knowledgebase`, `mk
-## Knowledgebase Passthrough
-client.knowledgebase.passthrough.create(...)
+## Crm Notes
+client.crm.notes.list(...)
-
@@ -38531,7 +28718,7 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `knowledgebase`, `mk
-
-Pull data from an endpoint not currently supported by Merge.
+Returns a list of `Note` objects.
@@ -38547,18 +28734,19 @@ Pull data from an endpoint not currently supported by Merge.
```python
from merge import Merge
-from merge.resources.knowledgebase import DataPassthroughRequest, MethodEnum
client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.knowledgebase.passthrough.create(
- request=DataPassthroughRequest(
- method=MethodEnum.GET,
- path="/scooters",
- ),
+response = client.crm.notes.list(
+ cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
)
+for item in response:
+ yield item
+# alternatively, you can paginate page-by-page
+for page in response.iter_pages():
+ yield page
```
@@ -38574,7 +28762,7 @@ client.knowledgebase.passthrough.create(
-
-**request:** `DataPassthroughRequest`
+**account_id:** `typing.Optional[str]` — If provided, will only return notes with this account.
@@ -38582,71 +28770,51 @@ client.knowledgebase.passthrough.create(
-
-**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.
+
-
-## Knowledgebase RegenerateKey
-client.knowledgebase.regenerate_key.create(...)
-
-#### 📝 Description
-
-
--
+**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
+
+
+
-
-Exchange remote keys.
-
-
+**cursor:** `typing.Optional[str]` — The pagination cursor value.
+
-#### 🔌 Usage
-
-
--
-
-
-```python
-from merge import Merge
-
-client = Merge(
- account_token="YOUR_ACCOUNT_TOKEN",
- api_key="YOUR_API_KEY",
-)
-client.knowledgebase.regenerate_key.create(
- name="Remote Deployment Key 1",
-)
-
-```
-
-
+**expand:** `typing.Optional[
+ typing.Union[
+ NotesListRequestExpandItem, typing.Sequence[NotesListRequestExpandItem]
+ ]
+]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+
-#### ⚙️ Parameters
-
-
-
--
-
-**name:** `str` — The name of the remote key
+**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
@@ -38654,72 +28822,63 @@ client.knowledgebase.regenerate_key.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.
+
-
-## Knowledgebase SyncStatus
-client.knowledgebase.sync_status.list(...)
-
-#### 📝 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 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).
-
-
+**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.knowledgebase.sync_status.list(
- cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
- page_size=1,
-)
-
-```
-
-
+**opportunity_id:** `typing.Optional[str]` — If provided, will only return notes with this opportunity.
+
-#### ⚙️ Parameters
-
-
+**owner_id:** `typing.Optional[str]` — If provided, will only return notes with this owner.
+
+
+
+
-
-**cursor:** `typing.Optional[str]` — The pagination cursor value.
+**page_size:** `typing.Optional[int]` — Number of results to return per page.
@@ -38727,7 +28886,7 @@ client.knowledgebase.sync_status.list(
-
-**page_size:** `typing.Optional[int]` — Number of results to return per page. The maximum limit is 100.
+**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
@@ -38747,8 +28906,7 @@ client.knowledgebase.sync_status.list(
-## Knowledgebase ForceResync
-client.knowledgebase.force_resync.sync_status_resync_create()
+client.crm.notes.create(...)
-
@@ -38760,7 +28918,7 @@ client.knowledgebase.sync_status.list(
-
-Force re-sync of all models. This endpoint is available for monthly, quarterly, and highest sync frequency customers on the Professional or Enterprise plans. Doing so will consume a sync credit for the relevant linked account. Force re-syncs can also be triggered manually in the Merge Dashboard and is available for all customers.
+Creates a `Note` object with the given values.
@@ -38776,12 +28934,15 @@ Force re-sync of all models. This endpoint is available for monthly, quarterly,
```python
from merge import Merge
+from merge.resources.crm import NoteRequest
client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.knowledgebase.force_resync.sync_status_resync_create()
+client.crm.notes.create(
+ model=NoteRequest(),
+)
```
@@ -38797,6 +28958,30 @@ client.knowledgebase.force_resync.sync_status_resync_create()
-
+**model:** `NoteRequest`
+
+
+
+
+
+-
+
+**is_debug_mode:** `typing.Optional[bool]` — Whether to include debug fields (such as log file links) in the response.
+
+
+
+
+
+-
+
+**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously.
+
+
+
+
+
+-
+
**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -38809,8 +28994,7 @@ client.knowledgebase.force_resync.sync_status_resync_create()
-## Knowledgebase Users
-client.knowledgebase.users.list(...)
+client.crm.notes.retrieve(...)
-
@@ -38822,7 +29006,7 @@ client.knowledgebase.force_resync.sync_status_resync_create()
-
-Returns a list of `User` objects.
+Returns a `Note` object with the given `id`.
@@ -38837,33 +29021,14 @@ Returns a list of `User` objects.
-
```python
-import datetime
-
from merge import Merge
client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.knowledgebase.users.list(
- created_after=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- created_before=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
- include_deleted_data=True,
- include_remote_data=True,
- include_shell_data=True,
- modified_after=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- modified_before=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- page_size=1,
- remote_id="remote_id",
+client.crm.notes.retrieve(
+ id="id",
)
```
@@ -38880,7 +29045,7 @@ client.knowledgebase.users.list(
-
-**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
+**id:** `str`
@@ -38888,7 +29053,12 @@ client.knowledgebase.users.list(
-
-**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
+**expand:** `typing.Optional[
+ typing.Union[
+ NotesRetrieveRequestExpandItem,
+ typing.Sequence[NotesRetrieveRequestExpandItem],
+ ]
+]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -38896,7 +29066,7 @@ client.knowledgebase.users.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.
@@ -38904,7 +29074,7 @@ client.knowledgebase.users.list(
-
-**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
+**include_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.
@@ -38912,7 +29082,7 @@ client.knowledgebase.users.list(
-
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
+**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -38920,43 +29090,64 @@ client.knowledgebase.users.list(
-
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
-
--
-**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
-
+
+client.crm.notes.meta_post_retrieve()
-
-**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
-
-
-
+#### 📝 Description
-
-**page_size:** `typing.Optional[int]` — Number of results to return per page. The maximum limit is 100.
-
+
+-
+
+Returns metadata for `Note` POSTs.
+
+
+#### 🔌 Usage
+
-
-**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
-
+
+-
+
+```python
+from merge import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.crm.notes.meta_post_retrieve()
+
+```
+
+
+#### ⚙️ Parameters
+
+
+-
+
-
@@ -38972,7 +29163,7 @@ client.knowledgebase.users.list(
-client.knowledgebase.users.retrieve(...)
+client.crm.notes.remote_field_classes_list(...)
-
@@ -38984,7 +29175,7 @@ client.knowledgebase.users.list(
-
-Returns a `User` object with the given `id`.
+Returns a list of `RemoteFieldClass` objects.
@@ -39005,11 +29196,14 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.knowledgebase.users.retrieve(
- id="id",
- include_remote_data=True,
- include_shell_data=True,
+response = client.crm.notes.remote_field_classes_list(
+ cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
)
+for item in response:
+ yield item
+# alternatively, you can paginate page-by-page
+for page in response.iter_pages():
+ yield page
```
@@ -39025,7 +29219,7 @@ client.knowledgebase.users.retrieve(
-
-**id:** `str`
+**cursor:** `typing.Optional[str]` — The pagination cursor value.
@@ -39033,7 +29227,7 @@ client.knowledgebase.users.retrieve(
-
-**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/).
@@ -39041,7 +29235,7 @@ client.knowledgebase.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).
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -39049,65 +29243,43 @@ client.knowledgebase.users.retrieve(
-
-**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).
+
-
-## Knowledgebase WebhookReceivers
-client.knowledgebase.webhook_receivers.list()
-
-#### 📝 Description
-
-
--
+**is_common_model_field:** `typing.Optional[bool]` — If provided, will only return remote field classes with this is_common_model_field value
+
+
+
-
-Returns a list of `WebhookReceiver` objects.
-
-
+**is_custom:** `typing.Optional[bool]` — If provided, will only return remote fields classes with this is_custom value
+
-#### 🔌 Usage
-
-
--
-
-
-```python
-from merge import Merge
-
-client = Merge(
- account_token="YOUR_ACCOUNT_TOKEN",
- api_key="YOUR_API_KEY",
-)
-client.knowledgebase.webhook_receivers.list()
-
-```
-
-
+**page_size:** `typing.Optional[int]` — Number of results to return per page.
+
-#### ⚙️ Parameters
-
-
--
-
-
@@ -39123,7 +29295,8 @@ client.knowledgebase.webhook_receivers.list()
-client.knowledgebase.webhook_receivers.create(...)
+## Crm Opportunities
+client.crm.opportunities.list(...)
-
@@ -39135,7 +29308,7 @@ client.knowledgebase.webhook_receivers.list()
-
-Creates a `WebhookReceiver` object with the given values.
+Returns a list of `Opportunity` objects.
@@ -39156,10 +29329,14 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.knowledgebase.webhook_receivers.create(
- event="event",
- is_active=True,
+response = client.crm.opportunities.list(
+ cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
)
+for item in response:
+ yield item
+# alternatively, you can paginate page-by-page
+for page in response.iter_pages():
+ yield page
```
@@ -39175,7 +29352,7 @@ client.knowledgebase.webhook_receivers.create(
-
-**event:** `str`
+**account_id:** `typing.Optional[str]` — If provided, will only return opportunities with this account.
@@ -39183,7 +29360,7 @@ client.knowledgebase.webhook_receivers.create(
-
-**is_active:** `bool`
+**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
@@ -39191,7 +29368,7 @@ client.knowledgebase.webhook_receivers.create(
-
-**key:** `typing.Optional[str]`
+**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
@@ -39199,65 +29376,142 @@ client.knowledgebase.webhook_receivers.create(
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+**cursor:** `typing.Optional[str]` — The pagination cursor value.
+
+
+-
+
+**expand:** `typing.Optional[
+ typing.Union[
+ OpportunitiesListRequestExpandItem,
+ typing.Sequence[OpportunitiesListRequestExpandItem],
+ ]
+]` — 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/).
+
-
-## Ticketing AccountDetails
-client.ticketing.account_details.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 details for a linked account.
+**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
+
+
+
+-
+
+**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.
+
+
+
-
+**owner_id:** `typing.Optional[str]` — If provided, will only return opportunities with this owner.
+
+
+
+
-
-```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.ticketing.account_details.retrieve()
+
+-
+
+**remote_created_after:** `typing.Optional[dt.datetime]` — If provided, will only return opportunities created in the third party platform after this datetime.
+
+
+
+
+
+-
+
+**remote_fields:** `typing.Optional[OpportunitiesListRequestRemoteFields]` — Deprecated. Use show_enum_origins.
+
+
+
+
+
+-
+
+**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
+
+
+
+
+
+-
-```
+**show_enum_origins:** `typing.Optional[OpportunitiesListRequestShowEnumOrigins]` — 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)
+
+
+
+-
+
+**stage_id:** `typing.Optional[str]` — If provided, will only return opportunities with this stage.
+
-#### ⚙️ Parameters
-
-
+**status:** `typing.Optional[OpportunitiesListRequestStatus]`
+
+If provided, will only return opportunities with this status. Options: ('OPEN', 'WON', 'LOST')
+
+* `OPEN` - OPEN
+* `WON` - WON
+* `LOST` - LOST
+
+
+
+
-
@@ -39273,8 +29527,7 @@ client.ticketing.account_details.retrieve()
-## Ticketing AccountToken
-client.ticketing.account_token.retrieve(...)
+client.crm.opportunities.create(...)
-
@@ -39286,7 +29539,7 @@ client.ticketing.account_details.retrieve()
-
-Returns the account token for the end user with the provided public token.
+Creates an `Opportunity` object with the given values.
@@ -39302,13 +29555,14 @@ Returns the account token for the end user with the provided public token.
```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.account_token.retrieve(
- public_token="public_token",
+client.crm.opportunities.create(
+ model=OpportunityRequest(),
)
```
@@ -39325,7 +29579,23 @@ client.ticketing.account_token.retrieve(
-
-**public_token:** `str`
+**model:** `OpportunityRequest`
+
+
+
+
+
+-
+
+**is_debug_mode:** `typing.Optional[bool]` — Whether to include debug fields (such as log file links) in the response.
+
+
+
+
+
+-
+
+**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously.
@@ -39345,8 +29615,7 @@ client.ticketing.account_token.retrieve(
-## Ticketing Accounts
-client.ticketing.accounts.list(...)
+client.crm.opportunities.retrieve(...)
-
@@ -39358,7 +29627,7 @@ client.ticketing.account_token.retrieve(
-
-Returns a list of `Account` objects.
+Returns an `Opportunity` object with the given `id`.
@@ -39373,33 +29642,14 @@ Returns a list of `Account` objects.
-
```python
-import datetime
-
from merge import Merge
client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.ticketing.accounts.list(
- created_after=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- created_before=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
- include_deleted_data=True,
- include_remote_data=True,
- include_shell_data=True,
- modified_after=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- modified_before=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- page_size=1,
- remote_id="remote_id",
+client.crm.opportunities.retrieve(
+ id="id",
)
```
@@ -39416,23 +29666,7 @@ client.ticketing.accounts.list(
-
-**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
-
-
-
-
-
--
-
-**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
-
-
-
-
-
--
-
-**cursor:** `typing.Optional[str]` — The pagination cursor value.
+**id:** `str`
@@ -39440,7 +29674,12 @@ client.ticketing.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/).
+**expand:** `typing.Optional[
+ typing.Union[
+ OpportunitiesRetrieveRequestExpandItem,
+ typing.Sequence[OpportunitiesRetrieveRequestExpandItem],
+ ]
+]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -39456,15 +29695,7 @@ client.ticketing.accounts.list(
-
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
-
-
-
-
-
--
-
-**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
+**include_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.
@@ -39472,7 +29703,7 @@ client.ticketing.accounts.list(
-
-**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
+**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -39480,7 +29711,7 @@ client.ticketing.accounts.list(
-
-**page_size:** `typing.Optional[int]` — Number of results to return per page.
+**remote_fields:** `typing.Optional[OpportunitiesRetrieveRequestRemoteFields]` — Deprecated. Use show_enum_origins.
@@ -39488,7 +29719,7 @@ client.ticketing.accounts.list(
-
-**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
+**show_enum_origins:** `typing.Optional[OpportunitiesRetrieveRequestShowEnumOrigins]` — 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)
@@ -39508,7 +29739,7 @@ client.ticketing.accounts.list(
-client.ticketing.accounts.retrieve(...)
+client.crm.opportunities.partial_update(...)
-
@@ -39520,7 +29751,7 @@ client.ticketing.accounts.list(
-
-Returns an `Account` object with the given `id`.
+Updates an `Opportunity` object with the given `id`.
@@ -39536,15 +29767,15 @@ Returns an `Account` 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.ticketing.accounts.retrieve(
+client.crm.opportunities.partial_update(
id="id",
- include_remote_data=True,
- include_shell_data=True,
+ model=PatchedOpportunityRequest(),
)
```
@@ -39569,7 +29800,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.
+**model:** `PatchedOpportunityRequest`
@@ -39577,7 +29808,15 @@ 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).
+**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.
@@ -39597,8 +29836,7 @@ client.ticketing.accounts.retrieve(
-## Ticketing AsyncPassthrough
-client.ticketing.async_passthrough.create(...)
+client.crm.opportunities.meta_patch_retrieve(...)
-
@@ -39610,7 +29848,7 @@ client.ticketing.accounts.retrieve(
-
-Asynchronously pull data from an endpoint not currently supported by Merge.
+Returns metadata for `Opportunity` PATCHs.
@@ -39626,17 +29864,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.opportunities.meta_patch_retrieve(
+ id="id",
)
```
@@ -39653,7 +29887,7 @@ client.ticketing.async_passthrough.create(
-
-**request:** `DataPassthroughRequest`
+**id:** `str`
@@ -39673,7 +29907,7 @@ client.ticketing.async_passthrough.create(
-client.ticketing.async_passthrough.retrieve(...)
+client.crm.opportunities.meta_post_retrieve()
-
@@ -39685,7 +29919,7 @@ client.ticketing.async_passthrough.create(
-
-Retrieves data from earlier async-passthrough POST request
+Returns metadata for `Opportunity` POSTs.
@@ -39706,9 +29940,7 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.ticketing.async_passthrough.retrieve(
- async_passthrough_receipt_id="async_passthrough_receipt_id",
-)
+client.crm.opportunities.meta_post_retrieve()
```
@@ -39724,14 +29956,6 @@ client.ticketing.async_passthrough.retrieve(
-
-**async_passthrough_receipt_id:** `str`
-
-
-
-
-
--
-
**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -39744,8 +29968,7 @@ client.ticketing.async_passthrough.retrieve(
-## Ticketing Attachments
-client.ticketing.attachments.list(...)
+client.crm.opportunities.remote_field_classes_list(...)
-
@@ -39757,7 +29980,7 @@ client.ticketing.async_passthrough.retrieve(
-
-Returns a list of `Attachment` objects.
+Returns a list of `RemoteFieldClass` objects.
@@ -39772,38 +29995,20 @@ Returns a list of `Attachment` objects.
-
```python
-import datetime
-
from merge import Merge
client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.ticketing.attachments.list(
- created_after=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- created_before=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
+response = client.crm.opportunities.remote_field_classes_list(
cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
- include_deleted_data=True,
- include_remote_data=True,
- include_shell_data=True,
- modified_after=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- modified_before=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- page_size=1,
- remote_created_after=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- remote_id="remote_id",
- ticket_id="ticket_id",
)
+for item in response:
+ yield item
+# alternatively, you can paginate page-by-page
+for page in response.iter_pages():
+ yield page
```
@@ -39819,22 +30024,6 @@ client.ticketing.attachments.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.
@@ -39843,14 +30032,6 @@ client.ticketing.attachments.list(
-
-**expand:** `typing.Optional[typing.Literal["ticket"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
-
-
-
-
-
--
-
**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
@@ -39867,23 +30048,7 @@ client.ticketing.attachments.list(
-
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
-
-
-
-
-
--
-
-**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.
+**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.
@@ -39891,7 +30056,7 @@ client.ticketing.attachments.list(
-
-**page_size:** `typing.Optional[int]` — Number of results to return per page. The maximum limit is 100.
+**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -39899,7 +30064,7 @@ client.ticketing.attachments.list(
-
-**remote_created_after:** `typing.Optional[dt.datetime]` — If provided, will only return attachments created in the third party platform after this datetime.
+**is_common_model_field:** `typing.Optional[bool]` — If provided, will only return remote field classes with this is_common_model_field value
@@ -39907,7 +30072,7 @@ client.ticketing.attachments.list(
-
-**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
+**is_custom:** `typing.Optional[bool]` — If provided, will only return remote fields classes with this is_custom value
@@ -39915,7 +30080,7 @@ client.ticketing.attachments.list(
-
-**ticket_id:** `typing.Optional[str]` — If provided, will only return comments for this ticket.
+**page_size:** `typing.Optional[int]` — Number of results to return per page.
@@ -39935,7 +30100,8 @@ client.ticketing.attachments.list(
-client.ticketing.attachments.create(...)
+## Crm Passthrough
+client.crm.passthrough.create(...)
-
@@ -39947,7 +30113,7 @@ client.ticketing.attachments.list(
-
-Creates an `Attachment` object with the given values.
+Pull data from an endpoint not currently supported by Merge.
@@ -39963,16 +30129,17 @@ Creates an `Attachment` object with the given values.
```python
from merge import Merge
-from merge.resources.ticketing import AttachmentRequest
+from merge.resources.crm import DataPassthroughRequest, MethodEnum
client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.ticketing.attachments.create(
- is_debug_mode=True,
- run_async=True,
- model=AttachmentRequest(),
+client.crm.passthrough.create(
+ request=DataPassthroughRequest(
+ method=MethodEnum.GET,
+ path="/scooters",
+ ),
)
```
@@ -39989,23 +30156,7 @@ 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:** `DataPassthroughRequest`
@@ -40025,7 +30176,8 @@ client.ticketing.attachments.create(
-client.ticketing.attachments.retrieve(...)
+## Crm RegenerateKey
+client.crm.regenerate_key.create(...)
-
@@ -40037,7 +30189,7 @@ client.ticketing.attachments.create(
-
-Returns an `Attachment` object with the given `id`.
+Exchange remote keys.
@@ -40058,10 +30210,8 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.ticketing.attachments.retrieve(
- id="id",
- include_remote_data=True,
- include_shell_data=True,
+client.crm.regenerate_key.create(
+ name="Remote Deployment Key 1",
)
```
@@ -40078,31 +30228,7 @@ client.ticketing.attachments.retrieve(
-
-**id:** `str`
-
-
-
-
-
--
-
-**expand:** `typing.Optional[typing.Literal["ticket"]]` — 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).
+**name:** `str` — The name of the remote key
@@ -40122,7 +30248,8 @@ client.ticketing.attachments.retrieve(
-client.ticketing.attachments.meta_post_retrieve()
+## Crm Stages
+client.crm.stages.list(...)
-
@@ -40134,7 +30261,7 @@ client.ticketing.attachments.retrieve(
-
-Returns metadata for `TicketingAttachment` POSTs.
+Returns a list of `Stage` objects.
@@ -40155,7 +30282,14 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.ticketing.attachments.meta_post_retrieve()
+response = client.crm.stages.list(
+ cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
+)
+for item in response:
+ yield item
+# alternatively, you can paginate page-by-page
+for page in response.iter_pages():
+ yield page
```
@@ -40171,76 +30305,47 @@ client.ticketing.attachments.meta_post_retrieve()
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
-
-
+
+-
+**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
+
-
-## Ticketing AuditTrail
-client.ticketing.audit_trail.list(...)
-
-#### 📝 Description
-
-
--
+**cursor:** `typing.Optional[str]` — The pagination cursor value.
+
+
+
-
-Gets a list of audit trail events.
-
-
+**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
+
-#### 🔌 Usage
-
-
--
-
-
-```python
-from merge import Merge
-
-client = Merge(
- account_token="YOUR_ACCOUNT_TOKEN",
- api_key="YOUR_API_KEY",
-)
-client.ticketing.audit_trail.list(
- cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
- end_date="end_date",
- event_type="event_type",
- page_size=1,
- start_date="start_date",
- user_email="user_email",
-)
-
-```
-
-
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
+
-#### ⚙️ Parameters
-
-
--
-
-
-**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.
@@ -40248,7 +30353,7 @@ client.ticketing.audit_trail.list(
-
-**end_date:** `typing.Optional[str]` — If included, will only include audit trail events that occurred before this time
+**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -40256,7 +30361,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`
+**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
@@ -40264,7 +30369,7 @@ client.ticketing.audit_trail.list(
-
-**page_size:** `typing.Optional[int]` — Number of results to return per page. The maximum limit is 100.
+**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
@@ -40272,7 +30377,7 @@ client.ticketing.audit_trail.list(
-
-**start_date:** `typing.Optional[str]` — If included, will only include audit trail events that occurred after this time
+**page_size:** `typing.Optional[int]` — Number of results to return per page.
@@ -40280,7 +30385,7 @@ client.ticketing.audit_trail.list(
-
-**user_email:** `typing.Optional[str]` — If provided, this will return events associated with the specified user email. Please note that the email address reflects the user's email at the time of the event, and may not be their current email.
+**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
@@ -40300,8 +30405,7 @@ client.ticketing.audit_trail.list(
-## Ticketing AvailableActions
-client.ticketing.available_actions.retrieve()
+client.crm.stages.retrieve(...)
-
@@ -40313,7 +30417,7 @@ client.ticketing.audit_trail.list(
-
-Returns a list of models and actions available for an account.
+Returns a `Stage` object with the given `id`.
@@ -40334,7 +30438,9 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.ticketing.available_actions.retrieve()
+client.crm.stages.retrieve(
+ id="id",
+)
```
@@ -40350,6 +30456,38 @@ client.ticketing.available_actions.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).
+
+
+
+
+
+-
+
**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -40362,8 +30500,7 @@ client.ticketing.available_actions.retrieve()
-## Ticketing Collections
-client.ticketing.collections.list(...)
+client.crm.stages.remote_field_classes_list(...)
-
@@ -40375,7 +30512,7 @@ client.ticketing.available_actions.retrieve()
-
-Returns a list of `Collection` objects.
+Returns a list of `RemoteFieldClass` objects.
@@ -40390,40 +30527,20 @@ Returns a list of `Collection` objects.
-
```python
-import datetime
-
from merge import Merge
-from merge.resources.ticketing.resources.collections import (
- CollectionsListRequestCollectionType,
-)
client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.ticketing.collections.list(
- collection_type=CollectionsListRequestCollectionType.EMPTY,
- created_after=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- created_before=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
+response = client.crm.stages.remote_field_classes_list(
cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
- include_deleted_data=True,
- include_remote_data=True,
- include_shell_data=True,
- modified_after=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- modified_before=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- name="name",
- page_size=1,
- parent_collection_id="parent_collection_id",
- remote_id="remote_id",
)
+for item in response:
+ yield item
+# alternatively, you can paginate page-by-page
+for page in response.iter_pages():
+ yield page
```
@@ -40439,30 +30556,6 @@ client.ticketing.collections.list(
-
-**collection_type:** `typing.Optional[CollectionsListRequestCollectionType]` — If provided, will only return collections of the given type.
-
-
-
-
-
--
-
-**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
-
-
-
-
-
--
-
-**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
-
-
-
-
-
--
-
**cursor:** `typing.Optional[str]` — The pagination cursor value.
@@ -40471,14 +30564,6 @@ 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.
-
-
-
-
-
--
-
**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
@@ -40495,39 +30580,7 @@ client.ticketing.collections.list(
-
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
-
-
-
-
-
--
-
-**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 collections with this name.
-
-
-
-
-
--
-
-**page_size:** `typing.Optional[int]` — Number of results to return per page. The maximum limit is 100.
+**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.
@@ -40535,7 +30588,7 @@ client.ticketing.collections.list(
-
-**parent_collection_id:** `typing.Optional[str]` — If provided, will only return collections whose parent collection matches the given id.
+**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -40543,7 +30596,7 @@ client.ticketing.collections.list(
-
-**remote_fields:** `typing.Optional[typing.Literal["collection_type"]]` — 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
@@ -40551,7 +30604,7 @@ client.ticketing.collections.list(
-
-**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
+**is_custom:** `typing.Optional[bool]` — If provided, will only return remote fields classes with this is_custom value
@@ -40559,7 +30612,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)
+**page_size:** `typing.Optional[int]` — Number of results to return per page.
@@ -40579,7 +30632,8 @@ client.ticketing.collections.list(
-client.ticketing.collections.viewers_list(...)
+## Crm SyncStatus
+client.crm.sync_status.list(...)
-
@@ -40591,7 +30645,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 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).
@@ -40607,22 +30661,13 @@ Returns a list of `Viewer` objects that point to a User id or Team id that is ei
```python
from merge import Merge
-from merge.resources.ticketing.resources.collections import (
- CollectionsViewersListRequestExpand,
-)
client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.ticketing.collections.viewers_list(
- collection_id="collection_id",
+client.crm.sync_status.list(
cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
- expand=CollectionsViewersListRequestExpand.TEAM,
- include_deleted_data=True,
- include_remote_data=True,
- include_shell_data=True,
- page_size=1,
)
```
@@ -40639,14 +30684,6 @@ client.ticketing.collections.viewers_list(
-
-**collection_id:** `str`
-
-
-
-
-
--
-
**cursor:** `typing.Optional[str]` — The pagination cursor value.
@@ -40655,38 +30692,6 @@ client.ticketing.collections.viewers_list(
-
-**expand:** `typing.Optional[CollectionsViewersListRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
-
-
-
-
-
--
-
-**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is 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.
@@ -40707,7 +30712,8 @@ client.ticketing.collections.viewers_list(
-client.ticketing.collections.retrieve(...)
+## Crm ForceResync
+client.crm.force_resync.sync_status_resync_create()
-
@@ -40719,7 +30725,7 @@ client.ticketing.collections.viewers_list(
-
-Returns a `Collection` 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.
@@ -40740,11 +30746,7 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.ticketing.collections.retrieve(
- id="id",
- include_remote_data=True,
- include_shell_data=True,
-)
+client.crm.force_resync.sync_status_resync_create()
```
@@ -40760,54 +30762,6 @@ 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)
-
-
-
-
-
--
-
**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -40820,8 +30774,8 @@ client.ticketing.collections.retrieve(
-## Ticketing Comments
-client.ticketing.comments.list(...)
+## Crm Tasks
+client.crm.tasks.list(...)
-
@@ -40833,7 +30787,7 @@ client.ticketing.collections.retrieve(
-
-Returns a list of `Comment` objects.
+Returns a list of `Task` objects.
@@ -40848,42 +30802,20 @@ Returns a list of `Comment` objects.
-
```python
-import datetime
-
from merge import Merge
-from merge.resources.ticketing.resources.comments import (
- CommentsListRequestExpand,
-)
client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.ticketing.comments.list(
- created_after=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- created_before=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
+response = client.crm.tasks.list(
cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
- expand=CommentsListRequestExpand.CONTACT,
- include_deleted_data=True,
- include_remote_data=True,
- include_shell_data=True,
- modified_after=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- modified_before=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- page_size=1,
- remote_created_after=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- remote_id="remote_id",
- ticket_id="ticket_id",
)
+for item in response:
+ yield item
+# alternatively, you can paginate page-by-page
+for page in response.iter_pages():
+ yield page
```
@@ -40923,7 +30855,11 @@ 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.
+**expand:** `typing.Optional[
+ typing.Union[
+ TasksListRequestExpandItem, typing.Sequence[TasksListRequestExpandItem]
+ ]
+]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -40947,7 +30883,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_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.
@@ -40955,7 +30891,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.
+**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -40963,7 +30899,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.
+**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
@@ -40971,7 +30907,7 @@ client.ticketing.comments.list(
-
-**page_size:** `typing.Optional[int]` — Number of results to return per page. The maximum limit is 100.
+**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
@@ -40979,7 +30915,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.
+**page_size:** `typing.Optional[int]` — Number of results to return per page.
@@ -40995,14 +30931,6 @@ client.ticketing.comments.list(
-
-**ticket_id:** `typing.Optional[str]` — If provided, will only return comments for this ticket.
-
-
-
-
-
--
-
**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -41015,7 +30943,7 @@ client.ticketing.comments.list(
-client.ticketing.comments.create(...)
+client.crm.tasks.create(...)
-
@@ -41027,7 +30955,7 @@ client.ticketing.comments.list(
-
-Creates a `Comment` object with the given values.
+Creates a `Task` object with the given values.
@@ -41043,16 +30971,14 @@ Creates a `Comment` object with the given values.
```python
from merge import Merge
-from merge.resources.ticketing import CommentRequest
+from merge.resources.crm import TaskRequest
client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.ticketing.comments.create(
- is_debug_mode=True,
- run_async=True,
- model=CommentRequest(),
+client.crm.tasks.create(
+ model=TaskRequest(),
)
```
@@ -41069,7 +30995,7 @@ client.ticketing.comments.create(
-
-**model:** `CommentRequest`
+**model:** `TaskRequest`
@@ -41105,7 +31031,7 @@ client.ticketing.comments.create(
-client.ticketing.comments.retrieve(...)
+client.crm.tasks.retrieve(...)
-
@@ -41117,7 +31043,7 @@ client.ticketing.comments.create(
-
-Returns a `Comment` object with the given `id`.
+Returns a `Task` object with the given `id`.
@@ -41133,19 +31059,13 @@ Returns a `Comment` object with the given `id`.
```python
from merge import Merge
-from merge.resources.ticketing.resources.comments import (
- CommentsRetrieveRequestExpand,
-)
client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.ticketing.comments.retrieve(
+client.crm.tasks.retrieve(
id="id",
- expand=CommentsRetrieveRequestExpand.CONTACT,
- include_remote_data=True,
- include_shell_data=True,
)
```
@@ -41170,7 +31090,12 @@ 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.
+**expand:** `typing.Optional[
+ typing.Union[
+ TasksRetrieveRequestExpandItem,
+ typing.Sequence[TasksRetrieveRequestExpandItem],
+ ]
+]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -41186,6 +31111,14 @@ client.ticketing.comments.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).
@@ -41206,7 +31139,7 @@ client.ticketing.comments.retrieve(
-client.ticketing.comments.meta_post_retrieve()
+client.crm.tasks.partial_update(...)
-
@@ -41218,7 +31151,7 @@ client.ticketing.comments.retrieve(
-
-Returns metadata for `Comment` POSTs.
+Updates a `Task` object with the given `id`.
@@ -41234,12 +31167,16 @@ Returns metadata for `Comment` POSTs.
```python
from merge import Merge
+from merge.resources.crm import PatchedTaskRequest
client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.ticketing.comments.meta_post_retrieve()
+client.crm.tasks.partial_update(
+ id="id",
+ model=PatchedTaskRequest(),
+)
```
@@ -41255,6 +31192,38 @@ client.ticketing.comments.meta_post_retrieve()
-
+**id:** `str`
+
+
+
+
+
+-
+
+**model:** `PatchedTaskRequest`
+
+
+
+
+
+-
+
+**is_debug_mode:** `typing.Optional[bool]` — Whether to include debug fields (such as log file links) in the response.
+
+
+
+
+
+-
+
+**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously.
+
+
+
+
+
+-
+
**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -41267,8 +31236,7 @@ client.ticketing.comments.meta_post_retrieve()
-## Ticketing Contacts
-client.ticketing.contacts.list(...)
+client.crm.tasks.meta_patch_retrieve(...)
-
@@ -41280,7 +31248,7 @@ client.ticketing.comments.meta_post_retrieve()
-
-Returns a list of `Contact` objects.
+Returns metadata for `Task` PATCHs.
@@ -41295,34 +31263,14 @@ Returns a list of `Contact` objects.
-
```python
-import datetime
-
from merge import Merge
client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.ticketing.contacts.list(
- created_after=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- created_before=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
- email_address="email_address",
- include_deleted_data=True,
- include_remote_data=True,
- include_shell_data=True,
- modified_after=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- modified_before=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- page_size=1,
- remote_id="remote_id",
+client.crm.tasks.meta_patch_retrieve(
+ id="id",
)
```
@@ -41339,7 +31287,7 @@ client.ticketing.contacts.list(
-
-**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
+**id:** `str`
@@ -41347,31 +31295,136 @@ client.ticketing.contacts.list(
-
-**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+client.crm.tasks.meta_post_retrieve()
-
-**cursor:** `typing.Optional[str]` — The pagination cursor value.
-
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns metadata for `Task` POSTs.
+
+
+
+#### 🔌 Usage
-
-**email_address:** `typing.Optional[str]` — If provided, will only return Contacts that match this email.
+
+-
+
+```python
+from merge import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.crm.tasks.meta_post_retrieve()
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+client.crm.tasks.remote_field_classes_list(...)
+
+-
+
+#### 📝 Description
-
-**expand:** `typing.Optional[typing.Literal["account"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+
+-
+
+Returns a list of `RemoteFieldClass` objects.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+response = client.crm.tasks.remote_field_classes_list(
+ cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
+)
+for item in response:
+ yield item
+# alternatively, you can paginate page-by-page
+for page in response.iter_pages():
+ yield page
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**cursor:** `typing.Optional[str]` — The pagination cursor value.
@@ -41395,7 +31448,7 @@ client.ticketing.contacts.list(
-
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
+**include_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.
@@ -41403,7 +31456,7 @@ client.ticketing.contacts.list(
-
-**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
+**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -41411,7 +31464,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.
+**is_common_model_field:** `typing.Optional[bool]` — If provided, will only return remote field classes with this is_common_model_field value
@@ -41419,7 +31472,7 @@ client.ticketing.contacts.list(
-
-**page_size:** `typing.Optional[int]` — Number of results to return per page. The maximum limit is 100.
+**is_custom:** `typing.Optional[bool]` — If provided, will only return remote fields classes with this is_custom value
@@ -41427,7 +31480,7 @@ client.ticketing.contacts.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.
@@ -41447,7 +31500,8 @@ client.ticketing.contacts.list(
-client.ticketing.contacts.create(...)
+## Crm Users
+client.crm.users.list(...)
-
@@ -41459,7 +31513,7 @@ client.ticketing.contacts.list(
-
-Creates a `Contact` object with the given values.
+Returns a list of `User` objects.
@@ -41475,17 +31529,19 @@ Creates a `Contact` object with the given values.
```python
from merge import Merge
-from merge.resources.ticketing import ContactRequest
client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.ticketing.contacts.create(
- is_debug_mode=True,
- run_async=True,
- model=ContactRequest(),
+response = client.crm.users.list(
+ cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
)
+for item in response:
+ yield item
+# alternatively, you can paginate page-by-page
+for page in response.iter_pages():
+ yield page
```
@@ -41501,7 +31557,7 @@ client.ticketing.contacts.create(
-
-**model:** `ContactRequest`
+**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
@@ -41509,7 +31565,7 @@ client.ticketing.contacts.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.
@@ -41517,7 +31573,79 @@ client.ticketing.contacts.create(
-
-**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously.
+**cursor:** `typing.Optional[str]` — The pagination cursor value.
+
+
+
+
+
+-
+
+**email:** `typing.Optional[str]` — If provided, will only return users with this email.
+
+
+
+
+
+-
+
+**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is 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.
+
+
+
+
+
+-
+
+**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.
@@ -41537,7 +31665,7 @@ client.ticketing.contacts.create(
-client.ticketing.contacts.retrieve(...)
+client.crm.users.retrieve(...)
-
@@ -41549,7 +31677,7 @@ client.ticketing.contacts.create(
-
-Returns a `Contact` object with the given `id`.
+Returns a `User` object with the given `id`.
@@ -41570,10 +31698,8 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.ticketing.contacts.retrieve(
+client.crm.users.retrieve(
id="id",
- include_remote_data=True,
- include_shell_data=True,
)
```
@@ -41598,7 +31724,7 @@ client.ticketing.contacts.retrieve(
-
-**expand:** `typing.Optional[typing.Literal["account"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -41606,7 +31732,7 @@ client.ticketing.contacts.retrieve(
-
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
+**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.
@@ -41634,7 +31760,7 @@ client.ticketing.contacts.retrieve(
-client.ticketing.contacts.meta_post_retrieve()
+client.crm.users.ignore_create(...)
-
@@ -41646,7 +31772,7 @@ client.ticketing.contacts.retrieve(
-
-Returns metadata for `TicketingContact` 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.
@@ -41662,12 +31788,18 @@ Returns metadata for `TicketingContact` 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.contacts.meta_post_retrieve()
+client.crm.users.ignore_create(
+ model_id="model_id",
+ request=IgnoreCommonModelRequest(
+ reason=ReasonEnum.GENERAL_CUSTOMER_REQUEST,
+ ),
+)
```
@@ -41683,6 +31815,22 @@ client.ticketing.contacts.meta_post_retrieve()
-
+**model_id:** `str`
+
+
+
+
+
+-
+
+**request:** `IgnoreCommonModelRequest`
+
+
+
+
+
+-
+
**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -41695,8 +31843,7 @@ client.ticketing.contacts.meta_post_retrieve()
-## Ticketing Scopes
-client.ticketing.scopes.default_scopes_retrieve()
+client.crm.users.remote_field_classes_list(...)
-
@@ -41708,7 +31855,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.
@@ -41729,7 +31876,14 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.ticketing.scopes.default_scopes_retrieve()
+response = client.crm.users.remote_field_classes_list(
+ cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
+)
+for item in response:
+ yield item
+# alternatively, you can paginate page-by-page
+for page in response.iter_pages():
+ yield page
```
@@ -41745,6 +31899,70 @@ client.ticketing.scopes.default_scopes_retrieve()
-
+**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.
@@ -41757,7 +31975,8 @@ client.ticketing.scopes.default_scopes_retrieve()
-client.ticketing.scopes.linked_account_scopes_retrieve()
+## Crm WebhookReceivers
+client.crm.webhook_receivers.list()
-
@@ -41769,7 +31988,7 @@ client.ticketing.scopes.default_scopes_retrieve()
-
-Get all available permissions for Merge Common Models and fields for a single Linked Account. [Learn more](https://help.merge.dev/en/articles/5950052-common-model-and-field-scopes).
+Returns a list of `WebhookReceiver` objects.
@@ -41790,7 +32009,7 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.ticketing.scopes.linked_account_scopes_retrieve()
+client.crm.webhook_receivers.list()
```
@@ -41818,7 +32037,7 @@ client.ticketing.scopes.linked_account_scopes_retrieve()
-client.ticketing.scopes.linked_account_scopes_create(...)
+client.crm.webhook_receivers.create(...)
-
@@ -41830,7 +32049,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 `WebhookReceiver` object with the given values.
@@ -41846,42 +32065,14 @@ Update permissions for any Common Model or field for a single Linked Account. An
```python
from merge import Merge
-from merge.resources.ticketing import (
- FieldPermissionDeserializerRequest,
- IndividualCommonModelScopeDeserializerRequest,
- ModelPermissionDeserializerRequest,
-)
client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.ticketing.scopes.linked_account_scopes_create(
- common_models=[
- IndividualCommonModelScopeDeserializerRequest(
- model_name="Employee",
- model_permissions={
- "READ": ModelPermissionDeserializerRequest(
- is_enabled=True,
- ),
- "WRITE": ModelPermissionDeserializerRequest(
- is_enabled=False,
- ),
- },
- field_permissions=FieldPermissionDeserializerRequest(
- enabled_fields=["avatar", "home_location"],
- disabled_fields=["work_location"],
- ),
- ),
- IndividualCommonModelScopeDeserializerRequest(
- model_name="Benefit",
- model_permissions={
- "WRITE": ModelPermissionDeserializerRequest(
- is_enabled=False,
- )
- },
- ),
- ],
+client.crm.webhook_receivers.create(
+ event="event",
+ is_active=True,
)
```
@@ -41898,7 +32089,23 @@ client.ticketing.scopes.linked_account_scopes_create(
-
-**common_models:** `typing.Sequence[IndividualCommonModelScopeDeserializerRequest]` — The common models you want to update the scopes for
+**event:** `str`
+
+
+
+
+
+-
+
+**is_active:** `bool`
+
+
+
+
+
+-
+
+**key:** `typing.Optional[str]`
@@ -41918,8 +32125,8 @@ client.ticketing.scopes.linked_account_scopes_create(
-## Ticketing DeleteAccount
-client.ticketing.delete_account.delete()
+## FileStorage AccountDetails
+client.file_storage.account_details.retrieve()
-
@@ -41931,7 +32138,7 @@ client.ticketing.scopes.linked_account_scopes_create(
-
-Delete a linked account.
+Get details for a linked account.
@@ -41952,7 +32159,7 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.ticketing.delete_account.delete()
+client.file_storage.account_details.retrieve()
```
@@ -41980,8 +32187,8 @@ client.ticketing.delete_account.delete()
-## Ticketing FieldMapping
-client.ticketing.field_mapping.field_mappings_retrieve(...)
+## FileStorage AccountToken
+client.file_storage.account_token.retrieve(...)
-
@@ -41993,7 +32200,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/).
+Returns the account token for the end user with the provided public token.
@@ -42014,8 +32221,8 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.ticketing.field_mapping.field_mappings_retrieve(
- exclude_remote_field_metadata=True,
+client.file_storage.account_token.retrieve(
+ public_token="public_token",
)
```
@@ -42032,7 +32239,7 @@ 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.
+**public_token:** `str`
@@ -42052,7 +32259,8 @@ client.ticketing.field_mapping.field_mappings_retrieve(
-client.ticketing.field_mapping.field_mappings_create(...)
+## FileStorage AsyncPassthrough
+client.file_storage.async_passthrough.create(...)
-
@@ -42064,7 +32272,7 @@ client.ticketing.field_mapping.field_mappings_retrieve(
-
-Create new Field Mappings that will be available after the next scheduled sync. This will cause the next sync for this Linked Account to sync **ALL** data from start.
+Asynchronously pull data from an endpoint not currently supported by Merge.
@@ -42080,19 +32288,17 @@ Create new Field Mappings that will be available after the next scheduled sync.
```python
from merge import Merge
+from merge.resources.file_storage import DataPassthroughRequest, MethodEnum
client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.ticketing.field_mapping.field_mappings_create(
- exclude_remote_field_metadata=True,
- target_field_name="example_target_field_name",
- target_field_description="this is a example description of the target field",
- remote_field_traversal_path=["example_remote_field"],
- remote_method="GET",
- remote_url_path="/example-url-path",
- common_model_name="ExampleCommonModel",
+client.file_storage.async_passthrough.create(
+ request=DataPassthroughRequest(
+ method=MethodEnum.GET,
+ path="/scooters",
+ ),
)
```
@@ -42109,63 +32315,7 @@ client.ticketing.field_mapping.field_mappings_create(
-
-**target_field_name:** `str` — The name of the target field you want this remote field to map to.
-
-
-
-
-
--
-
-**target_field_description:** `str` — The description of the target field you want this remote field to map to.
-
-
-
-
-
--
-
-**remote_field_traversal_path:** `typing.Sequence[typing.Optional[typing.Any]]` — The field traversal path of the remote field listed when you hit the GET /remote-fields endpoint.
-
-
-
-
-
--
-
-**remote_method:** `str` — The method of the remote endpoint where the remote field is coming from.
-
-
-
-
-
--
-
-**remote_url_path:** `str` — The path of the remote endpoint where the remote field is coming from.
-
-
-
-
-
--
-
-**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.
-
-
-
-
-
--
-
-**jmes_path:** `typing.Optional[str]` — JMES path to specify json query expression to be used on field mapping.
+**request:** `DataPassthroughRequest`
@@ -42185,7 +32335,7 @@ client.ticketing.field_mapping.field_mappings_create(
-client.ticketing.field_mapping.field_mappings_destroy(...)
+client.file_storage.async_passthrough.retrieve(...)
-
@@ -42197,7 +32347,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.
+Retrieves data from earlier async-passthrough POST request
@@ -42218,8 +32368,8 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.ticketing.field_mapping.field_mappings_destroy(
- field_mapping_id="field_mapping_id",
+client.file_storage.async_passthrough.retrieve(
+ async_passthrough_receipt_id="async_passthrough_receipt_id",
)
```
@@ -42236,7 +32386,7 @@ client.ticketing.field_mapping.field_mappings_destroy(
-
-**field_mapping_id:** `str`
+**async_passthrough_receipt_id:** `str`
@@ -42256,7 +32406,8 @@ client.ticketing.field_mapping.field_mappings_destroy(
-client.ticketing.field_mapping.field_mappings_partial_update(...)
+## FileStorage AuditTrail
+client.file_storage.audit_trail.list(...)
-
@@ -42268,7 +32419,7 @@ client.ticketing.field_mapping.field_mappings_destroy(
-
-Create or update existing Field Mappings for a Linked Account. Changes will be reflected after the next scheduled sync. This will cause the next sync for this Linked Account to sync **ALL** data from start.
+Gets a list of audit trail events.
@@ -42289,9 +32440,14 @@ 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",
+response = client.file_storage.audit_trail.list(
+ cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
)
+for item in response:
+ yield item
+# alternatively, you can paginate page-by-page
+for page in response.iter_pages():
+ yield page
```
@@ -42307,7 +32463,7 @@ client.ticketing.field_mapping.field_mappings_partial_update(
-
-**field_mapping_id:** `str`
+**cursor:** `typing.Optional[str]` — The pagination cursor value.
@@ -42315,7 +32471,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.
+**end_date:** `typing.Optional[str]` — If included, will only include audit trail events that occurred before this time
@@ -42323,7 +32479,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.
+**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`
@@ -42331,7 +32487,15 @@ 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.
+**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
@@ -42339,7 +32503,7 @@ client.ticketing.field_mapping.field_mappings_partial_update(
-
-**jmes_path:** `typing.Optional[str]` — JMES path to specify json query expression to be used on field mapping.
+**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.
@@ -42359,7 +32523,8 @@ client.ticketing.field_mapping.field_mappings_partial_update(
-client.ticketing.field_mapping.remote_fields_retrieve(...)
+## FileStorage AvailableActions
+client.file_storage.available_actions.retrieve()
-
@@ -42371,7 +32536,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/).
+Returns a list of models and actions available for an account.
@@ -42392,10 +32557,7 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.ticketing.field_mapping.remote_fields_retrieve(
- common_models="common_models",
- include_example_values="include_example_values",
-)
+client.file_storage.available_actions.retrieve()
```
@@ -42411,22 +32573,6 @@ 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.
-
-
-
-
-
--
-
-**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.
@@ -42439,7 +32585,8 @@ client.ticketing.field_mapping.remote_fields_retrieve(
-client.ticketing.field_mapping.target_fields_retrieve()
+## FileStorage Scopes
+client.file_storage.scopes.default_scopes_retrieve()
-
@@ -42451,7 +32598,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/).
+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).
@@ -42472,7 +32619,7 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.ticketing.field_mapping.target_fields_retrieve()
+client.file_storage.scopes.default_scopes_retrieve()
```
@@ -42500,8 +32647,7 @@ client.ticketing.field_mapping.target_fields_retrieve()
-## Ticketing GenerateKey
-client.ticketing.generate_key.create(...)
+client.file_storage.scopes.linked_account_scopes_retrieve()
-
@@ -42513,7 +32659,7 @@ client.ticketing.field_mapping.target_fields_retrieve()
-
-Create a remote key.
+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).
@@ -42534,9 +32680,7 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.ticketing.generate_key.create(
- name="Remote Deployment Key 1",
-)
+client.file_storage.scopes.linked_account_scopes_retrieve()
```
@@ -42552,14 +32696,6 @@ client.ticketing.generate_key.create(
-
-**name:** `str` — The name of the remote key
-
-
-
-
-
--
-
**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -42572,8 +32708,7 @@ client.ticketing.generate_key.create(
-## Ticketing Issues
-client.ticketing.issues.list(...)
+client.file_storage.scopes.linked_account_scopes_create(...)
-
@@ -42585,7 +32720,7 @@ client.ticketing.generate_key.create(
-
-Gets all issues for Organization.
+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)
@@ -42600,164 +32735,60 @@ Gets all issues for Organization.
-
```python
-import datetime
-
from merge import Merge
-from merge.resources.ticketing.resources.issues import IssuesListRequestStatus
+from merge.resources.file_storage import (
+ FieldPermissionDeserializerRequest,
+ IndividualCommonModelScopeDeserializerRequest,
+ ModelPermissionDeserializerRequest,
+)
client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.ticketing.issues.list(
- account_token="account_token",
- cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
- end_date="end_date",
- end_user_organization_name="end_user_organization_name",
- first_incident_time_after=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- first_incident_time_before=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- include_muted="include_muted",
- integration_name="integration_name",
- last_incident_time_after=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- last_incident_time_before=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- linked_account_id="linked_account_id",
- page_size=1,
- start_date="start_date",
- status=IssuesListRequestStatus.ONGOING,
-)
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**account_token:** `typing.Optional[str]`
-
-
-
-
-
--
-
-**cursor:** `typing.Optional[str]` — The pagination cursor value.
-
-
-
-
-
--
-
-**end_date:** `typing.Optional[str]` — If included, will only include issues whose most recent action occurred before this time
-
-
-
-
-
--
-
-**end_user_organization_name:** `typing.Optional[str]`
-
-
-
-
-
--
-
-**first_incident_time_after:** `typing.Optional[dt.datetime]` — If provided, will only return issues whose first incident time was after this datetime.
-
-
-
-
-
--
-
-**first_incident_time_before:** `typing.Optional[dt.datetime]` — If provided, will only return issues whose first incident time was before this datetime.
-
-
-
-
-
--
-
-**include_muted:** `typing.Optional[str]` — If true, will include muted issues
-
-
-
-
-
--
-
-**integration_name:** `typing.Optional[str]`
-
-
-
-
-
--
-
-**last_incident_time_after:** `typing.Optional[dt.datetime]` — If provided, will only return issues whose last incident time was after this datetime.
-
-
-
-
-
--
+client.file_storage.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,
+ )
+ },
+ ),
+ ],
+)
-**last_incident_time_before:** `typing.Optional[dt.datetime]` — If provided, will only return issues whose last incident time was before this datetime.
-
+```
-
-
--
-
-**linked_account_id:** `typing.Optional[str]` — If provided, will only include issues pertaining to the linked account passed in.
-
-
--
-
-**page_size:** `typing.Optional[int]` — Number of results to return per page. The maximum limit is 100.
-
-
-
+#### ⚙️ Parameters
-
-**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
+**common_models:** `typing.Sequence[IndividualCommonModelScopeDeserializerRequest]` — The common models you want to update the scopes for
@@ -42777,7 +32808,8 @@ Status of the issue. Options: ('ONGOING', 'RESOLVED')
-client.ticketing.issues.retrieve(...)
+## FileStorage DeleteAccount
+client.file_storage.delete_account.delete()
-
@@ -42789,7 +32821,7 @@ Status of the issue. Options: ('ONGOING', 'RESOLVED')
-
-Get a specific issue.
+Delete a linked account.
@@ -42810,9 +32842,7 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.ticketing.issues.retrieve(
- id="id",
-)
+client.file_storage.delete_account.delete()
```
@@ -42828,14 +32858,6 @@ client.ticketing.issues.retrieve(
-
-**id:** `str`
-
-
-
-
-
--
-
**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -42848,8 +32870,8 @@ client.ticketing.issues.retrieve(
-## Ticketing LinkToken
-client.ticketing.link_token.create(...)
+## FileStorage Drives
+client.file_storage.drives.list(...)
-
@@ -42861,7 +32883,7 @@ client.ticketing.issues.retrieve(
-
-Creates a link token to be used when linking a new end user.
+Returns a list of `Drive` objects.
@@ -42877,18 +32899,19 @@ Creates a link token to be used when linking a new end user.
```python
from merge import Merge
-from merge.resources.ticketing import CategoriesEnum
client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.ticketing.link_token.create(
- end_user_email_address="example@gmail.com",
- end_user_organization_name="Test Organization",
- end_user_origin_id="12345",
- categories=[CategoriesEnum.HRIS, CategoriesEnum.ATS],
+response = client.file_storage.drives.list(
+ cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
)
+for item in response:
+ yield item
+# alternatively, you can paginate page-by-page
+for page in response.iter_pages():
+ yield page
```
@@ -42904,7 +32927,7 @@ client.ticketing.link_token.create(
-
-**end_user_email_address:** `str` — Your end user's email address. This is purely for identification purposes - setting this value will not cause any emails to be sent.
+**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
@@ -42912,7 +32935,7 @@ client.ticketing.link_token.create(
-
-**end_user_organization_name:** `str` — Your end user's organization.
+**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
@@ -42920,7 +32943,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.
+**cursor:** `typing.Optional[str]` — The pagination cursor value.
@@ -42928,7 +32951,7 @@ client.ticketing.link_token.create(
-
-**categories:** `typing.Sequence[CategoriesEnum]` — The integration categories to show in Merge Link.
+**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
@@ -42936,7 +32959,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/.
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -42944,7 +32967,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.
+**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -42952,7 +32975,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.
+**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
@@ -42960,7 +32983,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.
+**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
@@ -42968,7 +32991,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.
+**name:** `typing.Optional[str]` — If provided, will only return drives with this name. This performs an exact match.
@@ -42976,14 +32999,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.
+**page_size:** `typing.Optional[int]` — Number of results to return per page.
@@ -42991,28 +33007,78 @@ client.ticketing.link_token.create(
-
-**language:** `typing.Optional[EndUserDetailsRequestLanguage]`
+**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
+
+
+
-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.file_storage.drives.retrieve(...)
-
-**are_syncs_disabled:** `typing.Optional[bool]` — The boolean that indicates whether initial, periodic, and force syncs will be disabled.
-
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a `Drive` object with the given `id`.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.file_storage.drives.retrieve(
+ id="id",
+)
+
+```
+
+
+
+#### ⚙️ Parameters
-
-**integration_specific_config:** `typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]]` — A JSON object containing integration-specific configuration options.
+
+-
+
+**id:** `str`
@@ -43020,11 +33086,15 @@ The following subset of IETF language tags can be used to configure localization
-
-**completed_account_initial_screen:** `typing.Optional[EndUserDetailsRequestCompletedAccountInitialScreen]`
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
+
+
+
-When creating a Link token, you can specifiy the initial screen of Linking Flow for a completed Linked Account.
+
+-
-* `SELECTIVE_SYNC` - SELECTIVE_SYNC
+**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -43044,8 +33114,8 @@ When creating a Link token, you can specifiy the initial screen of Linking Flow
-## Ticketing LinkedAccounts
-client.ticketing.linked_accounts.list(...)
+## FileStorage FieldMapping
+client.file_storage.field_mapping.field_mappings_retrieve(...)
-
@@ -43057,7 +33127,7 @@ When creating a Link token, you can specifiy the initial screen of Linking Flow
-
-List linked accounts for your organization.
+Get all Field Mappings for this Linked Account. Field Mappings are mappings between third-party Remote Fields and user defined Merge fields. [Learn more](https://docs.merge.dev/supplemental-data/field-mappings/overview/).
@@ -43073,29 +33143,12 @@ List linked accounts for your organization.
```python
from merge import Merge
-from merge.resources.ticketing.resources.linked_accounts import (
- LinkedAccountsListRequestCategory,
-)
client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.ticketing.linked_accounts.list(
- category=LinkedAccountsListRequestCategory.ACCOUNTING,
- cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
- end_user_email_address="end_user_email_address",
- end_user_organization_name="end_user_organization_name",
- end_user_origin_id="end_user_origin_id",
- end_user_origin_ids="end_user_origin_ids",
- id="id",
- ids="ids",
- include_duplicates=True,
- integration_name="integration_name",
- is_test_account="is_test_account",
- page_size=1,
- status="status",
-)
+client.file_storage.field_mapping.field_mappings_retrieve()
```
@@ -43111,17 +33164,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
+**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.
@@ -43129,47 +33172,75 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing`
-
-**cursor:** `typing.Optional[str]` — The pagination cursor value.
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
-
--
-**end_user_email_address:** `typing.Optional[str]` — If provided, will only return linked accounts associated with the given email address.
-
+
+client.file_storage.field_mapping.field_mappings_create(...)
-
-**end_user_organization_name:** `typing.Optional[str]` — If provided, will only return linked accounts associated with the given organization name.
-
-
-
+#### 📝 Description
-
-**end_user_origin_id:** `typing.Optional[str]` — If provided, will only return linked accounts associated with the given origin ID.
-
+
+-
+
+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
+
-
-**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.file_storage.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
-
-**id:** `typing.Optional[str]`
+
+-
+
+**target_field_name:** `str` — The name of the target field you want this remote field to map to.
@@ -43177,7 +33248,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.
+**target_field_description:** `str` — The description of the target field you want this remote field to map to.
@@ -43185,7 +33256,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.
+**remote_field_traversal_path:** `typing.Sequence[typing.Any]` — The field traversal path of the remote field listed when you hit the GET /remote-fields endpoint.
@@ -43193,7 +33264,7 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing`
-
-**integration_name:** `typing.Optional[str]` — If provided, will only return linked accounts associated with the given integration name.
+**remote_method:** `str` — The method of the remote endpoint where the remote field is coming from.
@@ -43201,7 +33272,7 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing`
-
-**is_test_account:** `typing.Optional[str]` — If included, will only include test linked accounts. If not included, will only include non-test linked accounts.
+**remote_url_path:** `str` — The path of the remote endpoint where the remote field is coming from.
@@ -43209,7 +33280,7 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing`
-
-**page_size:** `typing.Optional[int]` — Number of results to return per page. The maximum limit is 100.
+**common_model_name:** `str` — The name of the Common Model that the remote field corresponds to in a given category.
@@ -43217,7 +33288,7 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing`
-
-**status:** `typing.Optional[str]` — Filter by status. Options: `COMPLETE`, `IDLE`, `INCOMPLETE`, `RELINK_NEEDED`
+**exclude_remote_field_metadata:** `typing.Optional[bool]` — If `true`, remote fields metadata is excluded from each field mapping instance (i.e. `remote_fields.remote_key_name` and `remote_fields.schema` will be null). This will increase the speed of the request since these fields require some calculations.
@@ -43237,8 +33308,7 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing`
-## Ticketing Passthrough
-client.ticketing.passthrough.create(...)
+client.file_storage.field_mapping.field_mappings_destroy(...)
-
@@ -43250,7 +33320,7 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing`
-
-Pull data from an endpoint not currently supported by Merge.
+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.
@@ -43266,17 +33336,13 @@ 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.passthrough.create(
- request=DataPassthroughRequest(
- method=MethodEnum.GET,
- path="/scooters",
- ),
+client.file_storage.field_mapping.field_mappings_destroy(
+ field_mapping_id="field_mapping_id",
)
```
@@ -43293,7 +33359,7 @@ client.ticketing.passthrough.create(
-
-**request:** `DataPassthroughRequest`
+**field_mapping_id:** `str`
@@ -43313,8 +33379,7 @@ client.ticketing.passthrough.create(
-## Ticketing Projects
-client.ticketing.projects.list(...)
+client.file_storage.field_mapping.field_mappings_partial_update(...)
-
@@ -43326,7 +33391,7 @@ client.ticketing.passthrough.create(
-
-Returns a list of `Project` 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.
@@ -43341,33 +33406,14 @@ Returns a list of `Project` objects.
-
```python
-import datetime
-
from merge import Merge
client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.ticketing.projects.list(
- created_after=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- created_before=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
- include_deleted_data=True,
- include_remote_data=True,
- include_shell_data=True,
- modified_after=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- modified_before=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- page_size=1,
- remote_id="remote_id",
+client.file_storage.field_mapping.field_mappings_partial_update(
+ field_mapping_id="field_mapping_id",
)
```
@@ -43384,7 +33430,7 @@ client.ticketing.projects.list(
-
-**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
+**field_mapping_id:** `str`
@@ -43392,7 +33438,7 @@ client.ticketing.projects.list(
-
-**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
+**remote_field_traversal_path:** `typing.Optional[typing.Sequence[typing.Any]]` — The field traversal path of the remote field listed when you hit the GET /remote-fields endpoint.
@@ -43400,7 +33446,7 @@ client.ticketing.projects.list(
-
-**cursor:** `typing.Optional[str]` — The pagination cursor value.
+**remote_method:** `typing.Optional[str]` — The method of the remote endpoint where the remote field is coming from.
@@ -43408,7 +33454,7 @@ client.ticketing.projects.list(
-
-**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
+**remote_url_path:** `typing.Optional[str]` — The path of the remote endpoint where the remote field is coming from.
@@ -43416,39 +33462,68 @@ client.ticketing.projects.list(
-
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
-
--
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
-
+
+client.file_storage.field_mapping.remote_fields_retrieve(...)
-
-**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
-
+#### 📝 Description
+
+
+-
+
+
+-
+
+Get all remote fields for a Linked Account. Remote fields are third-party fields that are accessible after initial sync if remote_data is enabled. You can use remote fields to override existing Merge fields or map a new Merge field. [Learn more](https://docs.merge.dev/supplemental-data/field-mappings/overview/).
+
+
+#### 🔌 Usage
+
-
-**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.file_storage.field_mapping.remote_fields_retrieve()
+
+```
+
+
+
+#### ⚙️ Parameters
-
-**page_size:** `typing.Optional[int]` — Number of results to return per page. The maximum limit is 100.
+
+-
+
+**common_models:** `typing.Optional[str]` — A comma seperated list of Common Model names. If included, will only return Remote Fields for those Common Models.
@@ -43456,7 +33531,7 @@ client.ticketing.projects.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.
@@ -43476,7 +33551,7 @@ client.ticketing.projects.list(
-client.ticketing.projects.retrieve(...)
+client.file_storage.field_mapping.target_fields_retrieve()
-
@@ -43488,7 +33563,7 @@ client.ticketing.projects.list(
-
-Returns a `Project` 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/).
@@ -43509,11 +33584,7 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.ticketing.projects.retrieve(
- id="id",
- include_remote_data=True,
- include_shell_data=True,
-)
+client.file_storage.field_mapping.target_fields_retrieve()
```
@@ -43529,30 +33600,6 @@ client.ticketing.projects.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.
@@ -43565,7 +33612,8 @@ client.ticketing.projects.retrieve(
-client.ticketing.projects.users_list(...)
+## FileStorage Files
+client.file_storage.files.list(...)
-
@@ -43577,7 +33625,7 @@ client.ticketing.projects.retrieve(
-
-Returns a list of `User` objects.
+Returns a list of `File` objects.
@@ -43593,23 +33641,19 @@ Returns a list of `User` objects.
```python
from merge import Merge
-from merge.resources.ticketing.resources.projects import (
- ProjectsUsersListRequestExpand,
-)
client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.ticketing.projects.users_list(
- parent_id="parent_id",
+response = client.file_storage.files.list(
cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
- expand=ProjectsUsersListRequestExpand.ROLES,
- include_deleted_data=True,
- include_remote_data=True,
- include_shell_data=True,
- page_size=1,
)
+for item in response:
+ yield item
+# alternatively, you can paginate page-by-page
+for page in response.iter_pages():
+ yield page
```
@@ -43625,7 +33669,7 @@ client.ticketing.projects.users_list(
-
-**parent_id:** `str`
+**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
@@ -43633,7 +33677,7 @@ client.ticketing.projects.users_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.
@@ -43641,7 +33685,7 @@ client.ticketing.projects.users_list(
-
-**expand:** `typing.Optional[ProjectsUsersListRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+**cursor:** `typing.Optional[str]` — The pagination cursor value.
@@ -43649,7 +33693,7 @@ client.ticketing.projects.users_list(
-
-**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
+**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.
@@ -43657,7 +33701,11 @@ client.ticketing.projects.users_list(
-
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
+**expand:** `typing.Optional[
+ typing.Union[
+ FilesListRequestExpandItem, typing.Sequence[FilesListRequestExpandItem]
+ ]
+]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -43665,7 +33713,7 @@ client.ticketing.projects.users_list(
-
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
+**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.
@@ -43673,7 +33721,7 @@ client.ticketing.projects.users_list(
-
-**page_size:** `typing.Optional[int]` — Number of results to return per page. The maximum limit is 100.
+**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
@@ -43681,71 +33729,71 @@ client.ticketing.projects.users_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_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
+
-
-## Ticketing RegenerateKey
-client.ticketing.regenerate_key.create(...)
-
-#### 📝 Description
+**mime_type:** `typing.Optional[str]` — If provided, will only return files with these mime_types. Multiple values can be separated by commas.
+
+
+
-
+**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
+
+
+
+
-
-Exchange remote keys.
-
-
+**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
+
-#### 🔌 Usage
-
-
+**name:** `typing.Optional[str]` — If provided, will only return files 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.ticketing.regenerate_key.create(
- name="Remote Deployment Key 1",
-)
-
-```
-
-
+**order_by:** `typing.Optional[FilesListRequestOrderBy]` — Overrides the default ordering for this endpoint. Possible values include: created_at, -created_at, modified_at, -modified_at.
+
-#### ⚙️ Parameters
-
-
+**page_size:** `typing.Optional[int]` — Number of results to return per page.
+
+
+
+
-
-**name:** `str` — The name of the remote key
+**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
@@ -43765,8 +33813,7 @@ client.ticketing.regenerate_key.create(
-## Ticketing Roles
-client.ticketing.roles.list(...)
+client.file_storage.files.create(...)
-
@@ -43778,7 +33825,7 @@ client.ticketing.regenerate_key.create(
-
-Returns a list of `Role` objects.
+Creates a `File` object with the given values.
@@ -43793,33 +33840,15 @@ Returns a list of `Role` objects.
-
```python
-import datetime
-
from merge import Merge
+from merge.resources.file_storage import FileRequest
client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.ticketing.roles.list(
- created_after=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- created_before=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
- include_deleted_data=True,
- include_remote_data=True,
- include_shell_data=True,
- modified_after=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- modified_before=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- page_size=1,
- remote_id="remote_id",
+client.file_storage.files.create(
+ model=FileRequest(),
)
```
@@ -43836,7 +33865,7 @@ client.ticketing.roles.list(
-
-**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
+**model:** `FileRequest`
@@ -43844,7 +33873,7 @@ client.ticketing.roles.list(
-
-**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
+**is_debug_mode:** `typing.Optional[bool]` — Whether to include debug fields (such as log file links) in the response.
@@ -43852,7 +33881,7 @@ client.ticketing.roles.list(
-
-**cursor:** `typing.Optional[str]` — The pagination cursor value.
+**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously.
@@ -43860,31 +33889,70 @@ client.ticketing.roles.list(
-
-**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+client.file_storage.files.retrieve(...)
-
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
-
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a `File` object with the given `id`.
+
+
+
+#### 🔌 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.file_storage.files.retrieve(
+ id="id",
+)
+
+```
+
+
+
+#### ⚙️ Parameters
-
-**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
+
+-
+
+**id:** `str`
@@ -43892,7 +33960,12 @@ client.ticketing.roles.list(
-
-**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
+**expand:** `typing.Optional[
+ typing.Union[
+ FilesRetrieveRequestExpandItem,
+ typing.Sequence[FilesRetrieveRequestExpandItem],
+ ]
+]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -43900,7 +33973,7 @@ client.ticketing.roles.list(
-
-**page_size:** `typing.Optional[int]` — Number of results to return per page. The maximum limit is 100.
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -43908,7 +33981,7 @@ client.ticketing.roles.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).
@@ -43928,7 +34001,7 @@ client.ticketing.roles.list(
-client.ticketing.roles.retrieve(...)
+client.file_storage.files.download_request_meta_retrieve(...)
-
@@ -43940,7 +34013,7 @@ client.ticketing.roles.list(
-
-Returns a `Role` object with the given `id`.
+Returns metadata to construct an authenticated file download request for a singular file, allowing you to download file directly from the third-party.
@@ -43961,10 +34034,8 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.ticketing.roles.retrieve(
+client.file_storage.files.download_request_meta_retrieve(
id="id",
- include_remote_data=True,
- include_shell_data=True,
)
```
@@ -43989,15 +34060,7 @@ client.ticketing.roles.retrieve(
-
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
-
-
-
-
-
--
-
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
+**mime_type:** `typing.Optional[str]` — If provided, specifies the export format of the file to be downloaded. For information on supported export formats, please refer to our export format help center article.
@@ -44017,8 +34080,7 @@ client.ticketing.roles.retrieve(
-## Ticketing SyncStatus
-client.ticketing.sync_status.list(...)
+client.file_storage.files.download_request_meta_list(...)
-
@@ -44030,7 +34092,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 metadata to construct authenticated file download requests, allowing you to download files directly from the third-party.
@@ -44051,10 +34113,14 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.ticketing.sync_status.list(
+response = client.file_storage.files.download_request_meta_list(
cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
- page_size=1,
)
+for item in response:
+ yield item
+# alternatively, you can paginate page-by-page
+for page in response.iter_pages():
+ yield page
```
@@ -44070,6 +34136,22 @@ client.ticketing.sync_status.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.
@@ -44078,7 +34160,47 @@ client.ticketing.sync_status.list(
-
-**page_size:** `typing.Optional[int]` — Number of results to return per page. The maximum limit is 100.
+**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
+
+
+
+
+
+-
+
+**mime_types:** `typing.Optional[str]` — A comma-separated list of preferred MIME types in order of priority. If supported by the third-party provider, the file(s) will be returned in the first supported MIME type from the list. The default MIME type is PDF. To see supported MIME types by file type, refer to our export format help center article.
+
+
+
+
+
+-
+
+**modified_after:** `typing.Optional[str]` — If provided, will only return objects modified after this datetime.
+
+
+
+
+
+-
+
+**modified_before:** `typing.Optional[str]` — If provided, will only return objects modified before this datetime.
+
+
+
+
+
+-
+
+**order_by:** `typing.Optional[FilesDownloadRequestMetaListRequestOrderBy]` — 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.
@@ -44098,8 +34220,7 @@ client.ticketing.sync_status.list(
-## Ticketing ForceResync
-client.ticketing.force_resync.sync_status_resync_create()
+client.file_storage.files.meta_post_retrieve()
-
@@ -44111,7 +34232,7 @@ client.ticketing.sync_status.list(
-
-Force re-sync of all models. This endpoint is available for monthly, quarterly, and highest sync frequency customers on the Professional or Enterprise plans. Doing so will consume a sync credit for the relevant linked account. Force re-syncs can also be triggered manually in the Merge Dashboard and is available for all customers.
+Returns metadata for `FileStorageFile` POSTs.
@@ -44132,7 +34253,7 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.ticketing.force_resync.sync_status_resync_create()
+client.file_storage.files.meta_post_retrieve()
```
@@ -44160,8 +34281,8 @@ client.ticketing.force_resync.sync_status_resync_create()
-## Ticketing Tags
-client.ticketing.tags.list(...)
+## FileStorage Folders
+client.file_storage.folders.list(...)
-
@@ -44173,7 +34294,7 @@ client.ticketing.force_resync.sync_status_resync_create()
-
-Returns a list of `Tag` objects.
+Returns a list of `Folder` objects.
@@ -44188,34 +34309,20 @@ Returns a list of `Tag` objects.
-
```python
-import datetime
-
from merge import Merge
client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.ticketing.tags.list(
- created_after=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- created_before=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
+response = client.file_storage.folders.list(
cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
- include_deleted_data=True,
- include_remote_data=True,
- include_shell_data=True,
- modified_after=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- modified_before=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- page_size=1,
- remote_id="remote_id",
)
+for item in response:
+ yield item
+# alternatively, you can paginate page-by-page
+for page in response.iter_pages():
+ yield page
```
@@ -44255,6 +34362,27 @@ client.ticketing.tags.list(
-
+**drive_id:** `typing.Optional[str]` — If provided, will only return folders in this drive.
+
+
+
+
+
+-
+
+**expand:** `typing.Optional[
+ typing.Union[
+ FoldersListRequestExpandItem,
+ typing.Sequence[FoldersListRequestExpandItem],
+ ]
+]` — 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/).
@@ -44295,7 +34423,23 @@ client.ticketing.tags.list(
-
-**page_size:** `typing.Optional[int]` — Number of results to return per page. The maximum limit is 100.
+**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.
+
+
+
+
+
+-
+
+**parent_folder_id:** `typing.Optional[str]` — If provided, will only return folders in this parent folder. If null, will return folders in root directory.
@@ -44323,7 +34467,7 @@ client.ticketing.tags.list(
-client.ticketing.tags.retrieve(...)
+client.file_storage.folders.create(...)
-
@@ -44335,7 +34479,7 @@ client.ticketing.tags.list(
-
-Returns a `Tag` object with the given `id`.
+Creates a `Folder` object with the given values.
@@ -44351,15 +34495,14 @@ Returns a `Tag` object with the given `id`.
```python
from merge import Merge
+from merge.resources.file_storage import FolderRequest
client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.ticketing.tags.retrieve(
- id="id",
- include_remote_data=True,
- include_shell_data=True,
+client.file_storage.folders.create(
+ model=FolderRequest(),
)
```
@@ -44376,7 +34519,7 @@ client.ticketing.tags.retrieve(
-
-**id:** `str`
+**model:** `FolderRequest`
@@ -44384,7 +34527,7 @@ client.ticketing.tags.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.
@@ -44392,7 +34535,7 @@ client.ticketing.tags.retrieve(
-
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
+**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously.
@@ -44412,8 +34555,7 @@ client.ticketing.tags.retrieve(
-## Ticketing Teams
-client.ticketing.teams.list(...)
+client.file_storage.folders.retrieve(...)
-
@@ -44425,7 +34567,7 @@ client.ticketing.tags.retrieve(
-
-Returns a list of `Team` objects.
+Returns a `Folder` object with the given `id`.
@@ -44440,33 +34582,14 @@ Returns a list of `Team` objects.
-
```python
-import datetime
-
from merge import Merge
client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.ticketing.teams.list(
- created_after=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- created_before=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
- include_deleted_data=True,
- include_remote_data=True,
- include_shell_data=True,
- modified_after=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- modified_before=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- page_size=1,
- remote_id="remote_id",
+client.file_storage.folders.retrieve(
+ id="id",
)
```
@@ -44483,23 +34606,7 @@ client.ticketing.teams.list(
-
-**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
-
-
-
-
-
--
-
-**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
-
-
-
-
-
--
-
-**cursor:** `typing.Optional[str]` — The pagination cursor value.
+**id:** `str`
@@ -44507,7 +34614,12 @@ client.ticketing.teams.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.Union[
+ FoldersRetrieveRequestExpandItem,
+ typing.Sequence[FoldersRetrieveRequestExpandItem],
+ ]
+]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -44531,38 +34643,6 @@ client.ticketing.teams.list(
-
-**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
-
-
-
-
-
--
-
-**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
-
-
-
-
-
--
-
-**page_size:** `typing.Optional[int]` — Number of results to return per page. The maximum limit is 100.
-
-
-
-
-
--
-
-**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
-
-
-
-
-
--
-
**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -44575,7 +34655,7 @@ client.ticketing.teams.list(
-client.ticketing.teams.retrieve(...)
+client.file_storage.folders.meta_post_retrieve()
-
@@ -44587,7 +34667,7 @@ client.ticketing.teams.list(
-
-Returns a `Team` object with the given `id`.
+Returns metadata for `FileStorageFolder` POSTs.
@@ -44608,11 +34688,7 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.ticketing.teams.retrieve(
- id="id",
- include_remote_data=True,
- include_shell_data=True,
-)
+client.file_storage.folders.meta_post_retrieve()
```
@@ -44628,30 +34704,6 @@ client.ticketing.teams.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.
@@ -44664,8 +34716,8 @@ client.ticketing.teams.retrieve(
-## Ticketing Tickets
-client.ticketing.tickets.list(...)
+## FileStorage GenerateKey
+client.file_storage.generate_key.create(...)
-
@@ -44677,7 +34729,7 @@ client.ticketing.teams.retrieve(
-
-Returns a list of `Ticket` objects.
+Create a remote key.
@@ -44692,81 +34744,14 @@ Returns a list of `Ticket` objects.
-
```python
-import datetime
-
from merge import Merge
-from merge.resources.ticketing.resources.tickets import (
- TicketsListRequestExpand,
- TicketsListRequestPriority,
- TicketsListRequestRemoteFields,
- TicketsListRequestShowEnumOrigins,
- TicketsListRequestStatus,
-)
client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.ticketing.tickets.list(
- account_id="account_id",
- assignee_ids="assignee_ids",
- collection_ids="collection_ids",
- completed_after=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- completed_before=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- contact_id="contact_id",
- created_after=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- created_before=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- creator_id="creator_id",
- creator_ids="creator_ids",
- cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
- due_after=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- due_before=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- expand=TicketsListRequestExpand.ACCOUNT,
- include_deleted_data=True,
- include_remote_data=True,
- include_remote_fields=True,
- include_shell_data=True,
- modified_after=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- modified_before=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- name="name",
- page_size=1,
- parent_ticket_id="parent_ticket_id",
- priority=TicketsListRequestPriority.HIGH,
- remote_created_after=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- remote_created_before=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- remote_fields=TicketsListRequestRemoteFields.PRIORITY,
- remote_id="remote_id",
- remote_updated_after=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- remote_updated_before=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- show_enum_origins=TicketsListRequestShowEnumOrigins.PRIORITY,
- status=TicketsListRequestStatus.EMPTY,
- tags="tags",
- ticket_type="ticket_type",
- ticket_url="ticket_url",
+client.file_storage.generate_key.create(
+ name="Remote Deployment Key 1",
)
```
@@ -44783,7 +34768,7 @@ client.ticketing.tickets.list(
-
-**account_id:** `typing.Optional[str]` — If provided, will only return tickets for this account.
+**name:** `str` — The name of the remote key
@@ -44791,87 +34776,76 @@ 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.
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
--
-
-**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.
-
+
+## FileStorage Groups
+client.file_storage.groups.list(...)
-
-**completed_before:** `typing.Optional[dt.datetime]` — If provided, will only return tickets completed before this datetime.
-
-
-
+#### 📝 Description
-
-**contact_id:** `typing.Optional[str]` — If provided, will only return tickets for this contact.
-
-
-
-
-
-**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
-
+Returns a list of `Group` objects.
-
-
--
-
-**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
-
+#### 🔌 Usage
+
-
-**creator_id:** `typing.Optional[str]` — If provided, will only return tickets created by this creator_id.
-
-
-
-
-
-**creator_ids:** `typing.Optional[str]` — If provided, will only return tickets created by the creator_ids; multiple creator_ids can be separated by commas.
-
+```python
+from merge import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+response = client.file_storage.groups.list(
+ cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
+)
+for item in response:
+ yield item
+# alternatively, you can paginate page-by-page
+for page in response.iter_pages():
+ yield page
+
+```
+
+
+#### ⚙️ Parameters
+
-
-**cursor:** `typing.Optional[str]` — The pagination cursor value.
-
-
-
-
-
-**due_after:** `typing.Optional[dt.datetime]` — If provided, will only return tickets due after this datetime.
+**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
@@ -44879,7 +34853,7 @@ client.ticketing.tickets.list(
-
-**due_before:** `typing.Optional[dt.datetime]` — If provided, will only return tickets due before this datetime.
+**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
@@ -44887,7 +34861,7 @@ client.ticketing.tickets.list(
-
-**expand:** `typing.Optional[TicketsListRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+**cursor:** `typing.Optional[str]` — The pagination cursor value.
@@ -44895,7 +34869,12 @@ client.ticketing.tickets.list(
-
-**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
+**expand:** `typing.Optional[
+ typing.Union[
+ GroupsListRequestExpandItem,
+ typing.Sequence[GroupsListRequestExpandItem],
+ ]
+]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -44903,7 +34882,7 @@ client.ticketing.tickets.list(
-
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
+**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
@@ -44911,7 +34890,7 @@ client.ticketing.tickets.list(
-
-**include_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -44943,7 +34922,7 @@ client.ticketing.tickets.list(
-
-**name:** `typing.Optional[str]` — If provided, will only return tickets with this name.
+**page_size:** `typing.Optional[int]` — Number of results to return per page.
@@ -44951,7 +34930,7 @@ client.ticketing.tickets.list(
-
-**page_size:** `typing.Optional[int]` — Number of results to return per page. The maximum limit is 100.
+**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
@@ -44959,86 +34938,70 @@ client.ticketing.tickets.list(
-
-**parent_ticket_id:** `typing.Optional[str]` — If provided, will only return sub tickets of the parent_ticket_id.
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
--
-
-**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.
-
+
+client.file_storage.groups.retrieve(...)
-
-**remote_created_before:** `typing.Optional[dt.datetime]` — If provided, will only return tickets created in the third party platform before this datetime.
-
-
-
+#### 📝 Description
-
-**remote_fields:** `typing.Optional[TicketsListRequestRemoteFields]` — Deprecated. Use show_enum_origins.
-
-
-
-
-
-**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
-
+Returns a `Group` object with the given `id`.
+
+
+#### 🔌 Usage
+
-
-**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.file_storage.groups.retrieve(
+ id="id",
+)
+
+```
+
+
+#### ⚙️ Parameters
+
-
-**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[TicketsListRequestStatus]` — If provided, will only return tickets of this status.
+**id:** `str`
@@ -45046,7 +35009,12 @@ If provided, will only return tickets of this priority.
-
-**tags:** `typing.Optional[str]` — If provided, will only return tickets matching the tags; multiple tags can be separated by commas.
+**expand:** `typing.Optional[
+ typing.Union[
+ GroupsRetrieveRequestExpandItem,
+ typing.Sequence[GroupsRetrieveRequestExpandItem],
+ ]
+]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -45054,7 +35022,7 @@ If provided, will only return tickets of this priority.
-
-**ticket_type:** `typing.Optional[str]` — If provided, will only return tickets of this type.
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -45062,7 +35030,7 @@ If provided, will only return tickets of this priority.
-
-**ticket_url:** `typing.Optional[str]` — If provided, will only return tickets where the URL matches or contains the substring
+**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -45082,7 +35050,8 @@ If provided, will only return tickets of this priority.
-client.ticketing.tickets.create(...)
+## FileStorage Issues
+client.file_storage.issues.list(...)
-
@@ -45094,7 +35063,7 @@ If provided, will only return tickets of this priority.
-
-Creates a `Ticket` object with the given values.
+Gets all issues for Organization.
@@ -45110,17 +35079,19 @@ 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(
- is_debug_mode=True,
- run_async=True,
- model=TicketRequest(),
+response = client.file_storage.issues.list(
+ cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
)
+for item in response:
+ yield item
+# alternatively, you can paginate page-by-page
+for page in response.iter_pages():
+ yield page
```
@@ -45136,7 +35107,7 @@ client.ticketing.tickets.create(
-
-**model:** `TicketRequest`
+**account_token:** `typing.Optional[str]`
@@ -45144,7 +35115,7 @@ client.ticketing.tickets.create(
-
-**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.
@@ -45152,7 +35123,7 @@ client.ticketing.tickets.create(
-
-**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously.
+**end_date:** `typing.Optional[str]` — If included, will only include issues whose most recent action occurred before this time
@@ -45160,81 +35131,39 @@ client.ticketing.tickets.create(
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+**end_user_organization_name:** `typing.Optional[str]`
-
-
-
-
-
-
-
-client.ticketing.tickets.retrieve(...)
-
-#### 📝 Description
-
-
--
+**first_incident_time_after:** `typing.Optional[dt.datetime]` — If provided, will only return issues whose first incident time was after this datetime.
+
+
+
-
-Returns a `Ticket` object with the given `id`.
-
-
+**first_incident_time_before:** `typing.Optional[dt.datetime]` — If provided, will only return issues whose first incident time was before this datetime.
+
-#### 🔌 Usage
-
-
--
-
-
-```python
-from merge import Merge
-from merge.resources.ticketing.resources.tickets import (
- TicketsRetrieveRequestExpand,
- TicketsRetrieveRequestRemoteFields,
- TicketsRetrieveRequestShowEnumOrigins,
-)
-
-client = Merge(
- account_token="YOUR_ACCOUNT_TOKEN",
- api_key="YOUR_API_KEY",
-)
-client.ticketing.tickets.retrieve(
- id="id",
- expand=TicketsRetrieveRequestExpand.ACCOUNT,
- include_remote_data=True,
- include_remote_fields=True,
- include_shell_data=True,
- remote_fields=TicketsRetrieveRequestRemoteFields.PRIORITY,
- show_enum_origins=TicketsRetrieveRequestShowEnumOrigins.PRIORITY,
-)
-
-```
-
-
+**include_muted:** `typing.Optional[str]` — If true, will include muted issues
+
-#### ⚙️ Parameters
-
-
-
--
-
-**id:** `str`
+**integration_name:** `typing.Optional[str]`
@@ -45242,7 +35171,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.
+**last_incident_time_after:** `typing.Optional[dt.datetime]` — If provided, will only return issues whose last incident time was after this datetime.
@@ -45250,7 +35179,7 @@ client.ticketing.tickets.retrieve(
-
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
+**last_incident_time_before:** `typing.Optional[dt.datetime]` — If provided, will only return issues whose last incident time was before this datetime.
@@ -45258,7 +35187,7 @@ client.ticketing.tickets.retrieve(
-
-**include_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.
+**linked_account_id:** `typing.Optional[str]` — If provided, will only include issues pertaining to the linked account passed in.
@@ -45266,7 +35195,7 @@ client.ticketing.tickets.retrieve(
-
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
+**page_size:** `typing.Optional[int]` — Number of results to return per page.
@@ -45274,7 +35203,7 @@ client.ticketing.tickets.retrieve(
-
-**remote_fields:** `typing.Optional[TicketsRetrieveRequestRemoteFields]` — Deprecated. Use show_enum_origins.
+**start_date:** `typing.Optional[str]` — If included, will only include issues whose most recent action occurred after this time
@@ -45282,7 +35211,12 @@ 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)
+**status:** `typing.Optional[IssuesListRequestStatus]`
+
+Status of the issue. Options: ('ONGOING', 'RESOLVED')
+
+* `ONGOING` - ONGOING
+* `RESOLVED` - RESOLVED
@@ -45302,7 +35236,7 @@ client.ticketing.tickets.retrieve(
-client.ticketing.tickets.partial_update(...)
+client.file_storage.issues.retrieve(...)
-
@@ -45314,7 +35248,7 @@ client.ticketing.tickets.retrieve(
-
-Updates a `Ticket` object with the given `id`.
+Get a specific issue.
@@ -45330,17 +35264,13 @@ 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(
+client.file_storage.issues.retrieve(
id="id",
- is_debug_mode=True,
- run_async=True,
- model=PatchedTicketRequest(),
)
```
@@ -45365,30 +35295,6 @@ client.ticketing.tickets.partial_update(
-
-**model:** `PatchedTicketRequest`
-
-
-
-
-
--
-
-**is_debug_mode:** `typing.Optional[bool]` — Whether to include debug fields (such as log file links) in the response.
-
-
-
-
-
--
-
-**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously.
-
-
-
-
-
--
-
**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -45401,7 +35307,8 @@ client.ticketing.tickets.partial_update(
-client.ticketing.tickets.viewers_list(...)
+## FileStorage LinkToken
+client.file_storage.link_token.create(...)
-
@@ -45413,7 +35320,7 @@ client.ticketing.tickets.partial_update(
-
-Returns a list of `Viewer` objects that point to a User id or Team id that is either an assignee or viewer on a `Ticket` with the given id. [Learn more.](https://help.merge.dev/en/articles/10333658-ticketing-access-control-list-acls)
+Creates a link token to be used when linking a new end user.
@@ -45429,22 +35336,17 @@ Returns a list of `Viewer` objects that point to a User id or Team id that is ei
```python
from merge import Merge
-from merge.resources.ticketing.resources.tickets import (
- TicketsViewersListRequestExpand,
-)
+from merge.resources.file_storage import CategoriesEnum
client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.ticketing.tickets.viewers_list(
- ticket_id="ticket_id",
- cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
- expand=TicketsViewersListRequestExpand.TEAM,
- include_deleted_data=True,
- include_remote_data=True,
- include_shell_data=True,
- page_size=1,
+client.file_storage.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],
)
```
@@ -45461,7 +35363,7 @@ client.ticketing.tickets.viewers_list(
-
-**ticket_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.
@@ -45469,7 +35371,7 @@ client.ticketing.tickets.viewers_list(
-
-**cursor:** `typing.Optional[str]` — The pagination cursor value.
+**end_user_organization_name:** `str` — Your end user's organization.
@@ -45477,7 +35379,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.
+**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.
@@ -45485,7 +35387,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/).
+**categories:** `typing.Sequence[CategoriesEnum]` — The integration categories to show in Merge Link.
@@ -45493,7 +35395,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.
+**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/.
@@ -45501,7 +35403,67 @@ 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).
+**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.
+
+
+
+
+
+-
+
+**hide_admin_magic_link:** `typing.Optional[bool]` — Whether to generate a Magic Link URL on the Admin Needed screen during the linking flow. Defaults to false. For more information on Magic Link, see https://merge.dev/blog/integrations-fast-say-hello-to-magic-link.
+
+
+
+
+
+-
+
+**common_models:** `typing.Optional[typing.Sequence[CommonModelScopesBodyRequest]]` — An array of objects to specify the models and fields that will be disabled for a given Linked Account. Each object uses model_id, enabled_actions, and disabled_fields to specify the model, method, and fields that are scoped for a given Linked Account.
+
+
+
+
+
+-
+
+**category_common_model_scopes:** `typing.Optional[
+ typing.Dict[
+ str,
+ typing.Optional[
+ typing.Sequence[IndividualCommonModelScopeDeserializerRequest]
+ ],
+ ]
+]` — When creating a Link Token, you can set permissions for Common Models that will apply to the account that is going to be linked. Any model or field not specified in link token payload will default to existing settings.
+
+
+
+
+
+-
+
+**language:** `typing.Optional[EndUserDetailsRequestLanguage]`
+
+The following subset of IETF language tags can be used to configure localization.
+
+* `en` - en
+* `de` - de
+
+
+
+
+
+-
+
+**are_syncs_disabled:** `typing.Optional[bool]` — The boolean that indicates whether initial, periodic, and force syncs will be disabled.
@@ -45509,7 +35471,7 @@ client.ticketing.tickets.viewers_list(
-
-**page_size:** `typing.Optional[int]` — Number of results to return per page. The maximum limit is 100.
+**integration_specific_config:** `typing.Optional[typing.Dict[str, typing.Any]]` — A JSON object containing integration-specific configuration options.
@@ -45529,7 +35491,8 @@ client.ticketing.tickets.viewers_list(
-client.ticketing.tickets.meta_patch_retrieve(...)
+## FileStorage LinkedAccounts
+client.file_storage.linked_accounts.list(...)
-
@@ -45541,7 +35504,7 @@ client.ticketing.tickets.viewers_list(
-
-Returns metadata for `Ticket` PATCHs.
+List linked accounts for your organization.
@@ -45562,9 +35525,14 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.ticketing.tickets.meta_patch_retrieve(
- id="id",
+response = client.file_storage.linked_accounts.list(
+ cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
)
+for item in response:
+ yield item
+# alternatively, you can paginate page-by-page
+for page in response.iter_pages():
+ yield page
```
@@ -45580,7 +35548,113 @@ client.ticketing.tickets.meta_patch_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.
+
+
+
+
+
+-
+
+**is_test_account:** `typing.Optional[str]` — If included, will only include test linked accounts. If not included, will only include non-test linked accounts.
+
+
+
+
+
+-
+
+**page_size:** `typing.Optional[int]` — Number of results to return per page.
+
+
+
+
+
+-
+
+**status:** `typing.Optional[str]` — Filter by status. Options: `COMPLETE`, `IDLE`, `INCOMPLETE`, `RELINK_NEEDED`
@@ -45600,7 +35674,8 @@ client.ticketing.tickets.meta_patch_retrieve(
-client.ticketing.tickets.meta_post_retrieve(...)
+## FileStorage Passthrough
+client.file_storage.passthrough.create(...)
-
@@ -45612,7 +35687,7 @@ client.ticketing.tickets.meta_patch_retrieve(
-
-Returns metadata for `Ticket` POSTs.
+Pull data from an endpoint not currently supported by Merge.
@@ -45628,14 +35703,17 @@ Returns metadata for `Ticket` POSTs.
```python
from merge import Merge
+from merge.resources.file_storage import DataPassthroughRequest, MethodEnum
client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.ticketing.tickets.meta_post_retrieve(
- collection_id="collection_id",
- ticket_type="ticket_type",
+client.file_storage.passthrough.create(
+ request=DataPassthroughRequest(
+ method=MethodEnum.GET,
+ path="/scooters",
+ ),
)
```
@@ -45652,15 +35730,7 @@ client.ticketing.tickets.meta_post_retrieve(
-
-**collection_id:** `typing.Optional[str]` — If provided, will only return tickets for this collection.
-
-
-
-
-
--
-
-**ticket_type:** `typing.Optional[str]` — If provided, will only return tickets for this ticket type.
+**request:** `DataPassthroughRequest`
@@ -45680,7 +35750,8 @@ client.ticketing.tickets.meta_post_retrieve(
-client.ticketing.tickets.remote_field_classes_list(...)
+## FileStorage RegenerateKey
+client.file_storage.regenerate_key.create(...)
-
@@ -45692,7 +35763,7 @@ client.ticketing.tickets.meta_post_retrieve(
-
-Returns a list of `RemoteFieldClass` objects.
+Exchange remote keys.
@@ -45713,15 +35784,8 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.ticketing.tickets.remote_field_classes_list(
- cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
- ids="ids",
- include_deleted_data=True,
- include_remote_data=True,
- include_shell_data=True,
- is_common_model_field=True,
- is_custom=True,
- page_size=1,
+client.file_storage.regenerate_key.create(
+ name="Remote Deployment Key 1",
)
```
@@ -45738,7 +35802,7 @@ client.ticketing.tickets.remote_field_classes_list(
-
-**cursor:** `typing.Optional[str]` — The pagination cursor value.
+**name:** `str` — The name of the remote key
@@ -45746,47 +35810,76 @@ 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
+**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/).
-
+
+## FileStorage SyncStatus
+client.file_storage.sync_status.list(...)
-
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
-
-
-
+#### 📝 Description
-
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
-
+
+-
+
+Get sync status for the current sync and the most recently finished sync. `last_sync_start` represents the most recent time any sync began. `last_sync_finished` represents the most recent time any sync completed. These timestamps may correspond to different sync instances which may result in a sync start time being later than a separate sync completed time. To ensure you are retrieving the latest available data reference the `last_sync_finished` timestamp where `last_sync_result` is `DONE`. Possible values for `status` and `last_sync_result` are `DISABLED`, `DONE`, `FAILED`, `PARTIALLY_SYNCED`, `PAUSED`, `SYNCING`. Learn more about sync status in our [Help Center](https://help.merge.dev/en/articles/8184193-merge-sync-statuses).
+
+
+#### 🔌 Usage
+
-
-**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",
+)
+response = client.file_storage.sync_status.list(
+ cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
+)
+for item in response:
+ yield item
+# alternatively, you can paginate page-by-page
+for page in response.iter_pages():
+ yield page
+
+```
+
+
+
+#### ⚙️ Parameters
-
-**is_custom:** `typing.Optional[bool]` — If provided, will only return remote fields classes with this is_custom value
+
+-
+
+**cursor:** `typing.Optional[str]` — The pagination cursor value.
@@ -45794,7 +35887,7 @@ client.ticketing.tickets.remote_field_classes_list(
-
-**page_size:** `typing.Optional[int]` — Number of results to return per page. The maximum limit is 100.
+**page_size:** `typing.Optional[int]` — Number of results to return per page.
@@ -45814,8 +35907,8 @@ client.ticketing.tickets.remote_field_classes_list(
-## Ticketing Users
-client.ticketing.users.list(...)
+## FileStorage ForceResync
+client.file_storage.force_resync.sync_status_resync_create()
-
@@ -45827,7 +35920,7 @@ client.ticketing.tickets.remote_field_classes_list(
-
-Returns a list of `User` 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.
@@ -45842,38 +35935,13 @@ Returns a list of `User` objects.
-
```python
-import datetime
-
from merge import Merge
-from merge.resources.ticketing.resources.users import UsersListRequestExpand
client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.ticketing.users.list(
- created_after=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- created_before=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
- email_address="email_address",
- expand=UsersListRequestExpand.ROLES,
- include_deleted_data=True,
- include_remote_data=True,
- include_shell_data=True,
- modified_after=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- modified_before=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- page_size=1,
- remote_id="remote_id",
- team="team",
-)
+client.file_storage.force_resync.sync_status_resync_create()
```
@@ -45889,23 +35957,76 @@ client.ticketing.users.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.
+
+
+
+
+
+
+
+## FileStorage Users
+client.file_storage.users.list(...)
-
-**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
-
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a list of `User` objects.
+
+
+#### 🔌 Usage
+
-
-**cursor:** `typing.Optional[str]` — The pagination cursor value.
+
+-
+
+```python
+from merge import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+response = client.file_storage.users.list(
+ cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
+)
+for item in response:
+ yield item
+# alternatively, you can paginate page-by-page
+for page in response.iter_pages():
+ yield page
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
@@ -45913,7 +36034,7 @@ client.ticketing.users.list(
-
-**email_address:** `typing.Optional[str]` — If provided, will only return users with emails equal to this value (case insensitive).
+**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
@@ -45921,7 +36042,7 @@ client.ticketing.users.list(
-
-**expand:** `typing.Optional[UsersListRequestExpand]` — 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.
@@ -45953,7 +36074,7 @@ client.ticketing.users.list(
-
-**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
+**is_me:** `typing.Optional[str]` — If provided, will only return the user object for requestor.
@@ -45961,7 +36082,7 @@ client.ticketing.users.list(
-
-**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
+**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
@@ -45969,7 +36090,7 @@ client.ticketing.users.list(
-
-**page_size:** `typing.Optional[int]` — Number of results to return per page. The maximum limit is 100.
+**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
@@ -45977,7 +36098,7 @@ client.ticketing.users.list(
-
-**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
+**page_size:** `typing.Optional[int]` — Number of results to return per page.
@@ -45985,7 +36106,7 @@ client.ticketing.users.list(
-
-**team:** `typing.Optional[str]` — If provided, will only return users matching in this team.
+**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
@@ -46005,7 +36126,7 @@ client.ticketing.users.list(
-client.ticketing.users.retrieve(...)
+client.file_storage.users.retrieve(...)
-
@@ -46033,17 +36154,13 @@ Returns a `User` object with the given `id`.
```python
from merge import Merge
-from merge.resources.ticketing.resources.users import UsersRetrieveRequestExpand
client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.ticketing.users.retrieve(
+client.file_storage.users.retrieve(
id="id",
- expand=UsersRetrieveRequestExpand.ROLES,
- include_remote_data=True,
- include_shell_data=True,
)
```
@@ -46068,14 +36185,6 @@ client.ticketing.users.retrieve(
-
-**expand:** `typing.Optional[UsersRetrieveRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
-
-
-
-
-
--
-
**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -46104,8 +36213,8 @@ client.ticketing.users.retrieve(
-## Ticketing WebhookReceivers
-client.ticketing.webhook_receivers.list()
+## FileStorage WebhookReceivers
+client.file_storage.webhook_receivers.list()
-
@@ -46138,7 +36247,7 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.ticketing.webhook_receivers.list()
+client.file_storage.webhook_receivers.list()
```
@@ -46166,7 +36275,7 @@ client.ticketing.webhook_receivers.list()
-client.ticketing.webhook_receivers.create(...)
+client.file_storage.webhook_receivers.create(...)
-
@@ -46199,7 +36308,7 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.ticketing.webhook_receivers.create(
+client.file_storage.webhook_receivers.create(
event="event",
is_active=True,
)
@@ -46254,8 +36363,8 @@ client.ticketing.webhook_receivers.create(
-## Accounting AccountDetails
-client.accounting.account_details.retrieve()
+## Hris AccountDetails
+client.hris.account_details.retrieve()
-
@@ -46288,7 +36397,7 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.accounting.account_details.retrieve()
+client.hris.account_details.retrieve()
```
@@ -46316,8 +36425,8 @@ client.accounting.account_details.retrieve()
-## Accounting AccountToken
-client.accounting.account_token.retrieve(...)
+## Hris AccountToken
+client.hris.account_token.retrieve(...)
-
@@ -46350,7 +36459,7 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.accounting.account_token.retrieve(
+client.hris.account_token.retrieve(
public_token="public_token",
)
@@ -46388,8 +36497,8 @@ client.accounting.account_token.retrieve(
-## Accounting AccountingPeriods
-client.accounting.accounting_periods.list(...)
+## Hris AsyncPassthrough
+client.hris.async_passthrough.create(...)
-
@@ -46401,7 +36510,7 @@ client.accounting.account_token.retrieve(
-
-Returns a list of `AccountingPeriod` objects.
+Asynchronously pull data from an endpoint not currently supported by Merge.
@@ -46417,17 +36526,17 @@ Returns a list of `AccountingPeriod` 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.accounting.accounting_periods.list(
- cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
- include_deleted_data=True,
- include_remote_data=True,
- include_shell_data=True,
- page_size=1,
+client.hris.async_passthrough.create(
+ request=DataPassthroughRequest(
+ method=MethodEnum.GET,
+ path="/scooters",
+ ),
)
```
@@ -46444,39 +36553,7 @@ client.accounting.accounting_periods.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_shell_data:** `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`
@@ -46496,7 +36573,7 @@ client.accounting.accounting_periods.list(
-client.accounting.accounting_periods.retrieve(...)
+client.hris.async_passthrough.retrieve(...)
-
@@ -46508,7 +36585,7 @@ client.accounting.accounting_periods.list(
-
-Returns an `AccountingPeriod` object with the given `id`.
+Retrieves data from earlier async-passthrough POST request
@@ -46529,10 +36606,8 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.accounting.accounting_periods.retrieve(
- id="id",
- include_remote_data=True,
- include_shell_data=True,
+client.hris.async_passthrough.retrieve(
+ async_passthrough_receipt_id="async_passthrough_receipt_id",
)
```
@@ -46549,23 +36624,7 @@ client.accounting.accounting_periods.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).
+**async_passthrough_receipt_id:** `str`
@@ -46585,8 +36644,8 @@ client.accounting.accounting_periods.retrieve(
-## Accounting Accounts
-client.accounting.accounts.list(...)
+## Hris AuditTrail
+client.hris.audit_trail.list(...)
-
@@ -46598,7 +36657,7 @@ client.accounting.accounting_periods.retrieve(
-
-Returns a list of `Account` objects.
+Gets a list of audit trail events.
@@ -46613,47 +36672,20 @@ Returns a list of `Account` objects.
-
```python
-import datetime
-
from merge import Merge
-from merge.resources.accounting.resources.accounts import (
- AccountsListRequestClassification,
- AccountsListRequestRemoteFields,
- AccountsListRequestShowEnumOrigins,
- AccountsListRequestStatus,
-)
client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.accounting.accounts.list(
- account_type="account_type",
- classification=AccountsListRequestClassification.EMPTY,
- company_id="company_id",
- created_after=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- created_before=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
+response = client.hris.audit_trail.list(
cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
- include_deleted_data=True,
- include_remote_data=True,
- include_shell_data=True,
- modified_after=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- modified_before=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- name="name",
- page_size=1,
- remote_fields=AccountsListRequestRemoteFields.CLASSIFICATION,
- remote_id="remote_id",
- show_enum_origins=AccountsListRequestShowEnumOrigins.CLASSIFICATION,
- status=AccountsListRequestStatus.EMPTY,
)
+for item in response:
+ yield item
+# alternatively, you can paginate page-by-page
+for page in response.iter_pages():
+ yield page
```
@@ -46669,7 +36701,7 @@ client.accounting.accounts.list(
-
-**account_type:** `typing.Optional[str]` — If provided, will only return accounts with the passed in enum.
+**cursor:** `typing.Optional[str]` — The pagination cursor value.
@@ -46677,7 +36709,7 @@ client.accounting.accounts.list(
-
-**classification:** `typing.Optional[AccountsListRequestClassification]` — If provided, will only return accounts with this classification.
+**end_date:** `typing.Optional[str]` — If included, will only include audit trail events that occurred before this time
@@ -46685,7 +36717,7 @@ client.accounting.accounts.list(
-
-**company_id:** `typing.Optional[str]` — If provided, will only return accounts for this company.
+**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`, `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`
@@ -46693,7 +36725,7 @@ client.accounting.accounts.list(
-
-**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
+**page_size:** `typing.Optional[int]` — Number of results to return per page.
@@ -46701,7 +36733,7 @@ client.accounting.accounts.list(
-
-**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
+**start_date:** `typing.Optional[str]` — If included, will only include audit trail events that occurred after this time
@@ -46709,7 +36741,7 @@ client.accounting.accounts.list(
-
-**cursor:** `typing.Optional[str]` — The pagination cursor value.
+**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.
@@ -46717,99 +36749,65 @@ client.accounting.accounts.list(
-
-**expand:** `typing.Optional[typing.Literal["company"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
--
-
-**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
-
-
--
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
-
+
+## Hris AvailableActions
+client.hris.available_actions.retrieve()
-
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
-
-
-
+#### 📝 Description
-
-**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
-
-
-
-
-
-**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
-
+Returns a list of models and actions available for an account.
-
-
--
-
-**name:** `typing.Optional[str]` — If provided, will only return Accounts with this name.
-
+#### 🔌 Usage
+
-
-**page_size:** `typing.Optional[int]` — Number of results to return per page.
-
-
-
-
-
-**remote_fields:** `typing.Optional[AccountsListRequestRemoteFields]` — Deprecated. Use show_enum_origins.
-
-
-
+```python
+from merge import Merge
-
--
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.hris.available_actions.retrieve()
-**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
-
+```
-
-
--
-
-**show_enum_origins:** `typing.Optional[AccountsListRequestShowEnumOrigins]` — 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
+
-
-**status:** `typing.Optional[AccountsListRequestStatus]` — If provided, will only return accounts with this status.
-
-
-
-
-
@@ -46825,7 +36823,8 @@ client.accounting.accounts.list(
-client.accounting.accounts.create(...)
+## Hris BankInfo
+client.hris.bank_info.list(...)
-
@@ -46837,7 +36836,7 @@ client.accounting.accounts.list(
-
-Creates an `Account` object with the given values.
+Returns a list of `BankInfo` objects.
@@ -46853,17 +36852,19 @@ Creates an `Account` object with the given values.
```python
from merge import Merge
-from merge.resources.accounting import AccountRequest
client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.accounting.accounts.create(
- is_debug_mode=True,
- run_async=True,
- model=AccountRequest(),
+response = client.hris.bank_info.list(
+ cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
)
+for item in response:
+ yield item
+# alternatively, you can paginate page-by-page
+for page in response.iter_pages():
+ yield page
```
@@ -46879,7 +36880,12 @@ client.accounting.accounts.create(
-
-**model:** `AccountRequest`
+**account_type:** `typing.Optional[BankInfoListRequestAccountType]`
+
+If provided, will only return BankInfo's with this account type. Options: ('SAVINGS', 'CHECKING')
+
+* `SAVINGS` - SAVINGS
+* `CHECKING` - CHECKING
@@ -46887,7 +36893,7 @@ client.accounting.accounts.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.
@@ -46895,7 +36901,7 @@ client.accounting.accounts.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.
@@ -46903,78 +36909,36 @@ client.accounting.accounts.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.
-
-
-
-
-
-
-
-
-client.accounting.accounts.retrieve(...)
-
--
-
-#### 📝 Description
-
-
--
-
-Returns an `Account` object with the given `id`.
-
-
+**cursor:** `typing.Optional[str]` — The pagination cursor value.
+
-#### 🔌 Usage
-
-
-
--
-
-```python
-from merge import Merge
-from merge.resources.accounting.resources.accounts import (
- AccountsRetrieveRequestRemoteFields,
- AccountsRetrieveRequestShowEnumOrigins,
-)
-
-client = Merge(
- account_token="YOUR_ACCOUNT_TOKEN",
- api_key="YOUR_API_KEY",
-)
-client.accounting.accounts.retrieve(
- id="id",
- include_remote_data=True,
- include_shell_data=True,
- remote_fields=AccountsRetrieveRequestRemoteFields.CLASSIFICATION,
- show_enum_origins=AccountsRetrieveRequestShowEnumOrigins.CLASSIFICATION,
-)
-
-```
-
-
+**employee_id:** `typing.Optional[str]` — If provided, will only return bank accounts for this employee.
+
-#### ⚙️ Parameters
-
-
-
--
-
-**id:** `str`
+**expand:** `typing.Optional[
+ typing.Union[
+ BankInfoListRequestExpandItem,
+ typing.Sequence[BankInfoListRequestExpandItem],
+ ]
+]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -46982,7 +36946,7 @@ client.accounting.accounts.retrieve(
-
-**expand:** `typing.Optional[typing.Literal["company"]]` — 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/).
@@ -47006,7 +36970,7 @@ client.accounting.accounts.retrieve(
-
-**remote_fields:** `typing.Optional[AccountsRetrieveRequestRemoteFields]` — 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.
@@ -47014,7 +36978,7 @@ client.accounting.accounts.retrieve(
-
-**show_enum_origins:** `typing.Optional[AccountsRetrieveRequestShowEnumOrigins]` — 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.
@@ -47022,64 +36986,43 @@ client.accounting.accounts.retrieve(
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+**order_by:** `typing.Optional[BankInfoListRequestOrderBy]` — Overrides the default ordering for this endpoint. Possible values include: remote_created_at, -remote_created_at.
-
-
+
+-
+**page_size:** `typing.Optional[int]` — Number of results to return per page.
+
-
-client.accounting.accounts.meta_post_retrieve()
-
-#### 📝 Description
-
-
--
+**remote_fields:** `typing.Optional[BankInfoListRequestRemoteFields]` — Deprecated. Use show_enum_origins.
+
+
+
-
-Returns metadata for `Account` POSTs.
-
-
+**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
+
-#### 🔌 Usage
-
-
--
-
-
-```python
-from merge import Merge
-
-client = Merge(
- account_token="YOUR_ACCOUNT_TOKEN",
- api_key="YOUR_API_KEY",
-)
-client.accounting.accounts.meta_post_retrieve()
-
-```
-
-
+**show_enum_origins:** `typing.Optional[BankInfoListRequestShowEnumOrigins]` — 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
-
-
--
-
-
@@ -47095,8 +37038,7 @@ client.accounting.accounts.meta_post_retrieve()
-## Accounting Addresses
-client.accounting.addresses.retrieve(...)
+client.hris.bank_info.retrieve(...)
-
@@ -47108,7 +37050,7 @@ client.accounting.accounts.meta_post_retrieve()
-
-Returns an `Address` object with the given `id`.
+Returns a `BankInfo` object with the given `id`.
@@ -47129,10 +37071,8 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.accounting.addresses.retrieve(
+client.hris.bank_info.retrieve(
id="id",
- include_remote_data=True,
- include_shell_data=True,
)
```
@@ -47157,6 +37097,19 @@ client.accounting.addresses.retrieve(
-
+**expand:** `typing.Optional[
+ typing.Union[
+ BankInfoRetrieveRequestExpandItem,
+ typing.Sequence[BankInfoRetrieveRequestExpandItem],
+ ]
+]` — 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.
@@ -47173,7 +37126,7 @@ client.accounting.addresses.retrieve(
-
-**remote_fields:** `typing.Optional[typing.Literal["type"]]` — Deprecated. Use show_enum_origins.
+**remote_fields:** `typing.Optional[BankInfoRetrieveRequestRemoteFields]` — Deprecated. Use show_enum_origins.
@@ -47181,7 +37134,7 @@ client.accounting.addresses.retrieve(
-
-**show_enum_origins:** `typing.Optional[typing.Literal["type"]]` — A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter)
+**show_enum_origins:** `typing.Optional[BankInfoRetrieveRequestShowEnumOrigins]` — 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)
@@ -47201,8 +37154,8 @@ client.accounting.addresses.retrieve(
-## Accounting AsyncPassthrough
-client.accounting.async_passthrough.create(...)
+## Hris Benefits
+client.hris.benefits.list(...)
-
@@ -47214,7 +37167,7 @@ client.accounting.addresses.retrieve(
-
-Asynchronously pull data from an endpoint not currently supported by Merge.
+Returns a list of `Benefit` objects.
@@ -47230,18 +37183,19 @@ Asynchronously pull data from an endpoint not currently supported by Merge.
```python
from merge import Merge
-from merge.resources.accounting import DataPassthroughRequest, MethodEnum
client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.accounting.async_passthrough.create(
- request=DataPassthroughRequest(
- method=MethodEnum.GET,
- path="/scooters",
- ),
+response = client.hris.benefits.list(
+ cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
)
+for item in response:
+ yield item
+# alternatively, you can paginate page-by-page
+for page in response.iter_pages():
+ yield page
```
@@ -47257,7 +37211,7 @@ client.accounting.async_passthrough.create(
-
-**request:** `DataPassthroughRequest`
+**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
@@ -47265,70 +37219,92 @@ client.accounting.async_passthrough.create(
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
-
-
+
+-
+**cursor:** `typing.Optional[str]` — The pagination cursor value.
+
-
-client.accounting.async_passthrough.retrieve(...)
-
-#### 📝 Description
+**employee_id:** `typing.Optional[str]` — If provided, will return the benefits associated with the employee.
+
+
+
-
+**expand:** `typing.Optional[
+ typing.Union[
+ BenefitsListRequestExpandItem,
+ typing.Sequence[BenefitsListRequestExpandItem],
+ ]
+]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+
+
+
+
-
-Retrieves data from earlier async-passthrough POST request
-
-
+**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
+
-#### 🔌 Usage
-
-
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
+
+
+
+
-
-```python
-from merge import Merge
+**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
+
+
+
-client = Merge(
- account_token="YOUR_ACCOUNT_TOKEN",
- api_key="YOUR_API_KEY",
-)
-client.accounting.async_passthrough.retrieve(
- async_passthrough_receipt_id="async_passthrough_receipt_id",
-)
+
+-
-```
+**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
+
+
+
+-
+
+**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
+
-#### ⚙️ Parameters
-
-
+**page_size:** `typing.Optional[int]` — Number of results to return per page.
+
+
+
+
-
-**async_passthrough_receipt_id:** `str`
+**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
@@ -47348,8 +37324,7 @@ client.accounting.async_passthrough.retrieve(
-## Accounting AsyncTasks
-client.accounting.async_tasks.retrieve(...)
+client.hris.benefits.retrieve(...)
-
@@ -47361,7 +37336,7 @@ client.accounting.async_passthrough.retrieve(
-
-Returns an `AsyncPostTask` object with the given `id`.
+Returns a `Benefit` object with the given `id`.
@@ -47382,7 +37357,7 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.accounting.async_tasks.retrieve(
+client.hris.benefits.retrieve(
id="id",
)
@@ -47408,6 +37383,35 @@ client.accounting.async_tasks.retrieve(
-
+**expand:** `typing.Optional[
+ typing.Union[
+ BenefitsRetrieveRequestExpandItem,
+ typing.Sequence[BenefitsRetrieveRequestExpandItem],
+ ]
+]` — 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.
@@ -47420,8 +37424,8 @@ client.accounting.async_tasks.retrieve(
-## Accounting Attachments
-client.accounting.attachments.list(...)
+## Hris Companies
+client.hris.companies.list(...)
-
@@ -47433,7 +37437,7 @@ client.accounting.async_tasks.retrieve(
-
-Returns a list of `AccountingAttachment` objects.
+Returns a list of `Company` objects.
@@ -47448,35 +37452,20 @@ Returns a list of `AccountingAttachment` objects.
-
```python
-import datetime
-
from merge import Merge
client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.accounting.attachments.list(
- company_id="company_id",
- created_after=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- created_before=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
+response = client.hris.companies.list(
cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
- include_deleted_data=True,
- include_remote_data=True,
- include_shell_data=True,
- modified_after=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- modified_before=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- page_size=1,
- remote_id="remote_id",
)
+for item in response:
+ yield item
+# alternatively, you can paginate page-by-page
+for page in response.iter_pages():
+ yield page
```
@@ -47492,14 +37481,6 @@ client.accounting.attachments.list(
-
-**company_id:** `typing.Optional[str]` — If provided, will only return accounting attachments for this company.
-
-
-
-
-
--
-
**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
@@ -47592,7 +37573,7 @@ client.accounting.attachments.list(
-client.accounting.attachments.create(...)
+client.hris.companies.retrieve(...)
-
@@ -47604,7 +37585,7 @@ client.accounting.attachments.list(
-
-Creates an `AccountingAttachment` object with the given values.
+Returns a `Company` object with the given `id`.
@@ -47620,16 +37601,13 @@ Creates an `AccountingAttachment` object with the given values.
```python
from merge import Merge
-from merge.resources.accounting import AccountingAttachmentRequest
client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.accounting.attachments.create(
- is_debug_mode=True,
- run_async=True,
- model=AccountingAttachmentRequest(),
+client.hris.companies.retrieve(
+ id="id",
)
```
@@ -47646,7 +37624,7 @@ client.accounting.attachments.create(
-
-**model:** `AccountingAttachmentRequest`
+**id:** `str`
@@ -47654,7 +37632,7 @@ client.accounting.attachments.create(
-
-**is_debug_mode:** `typing.Optional[bool]` — Whether to include debug fields (such as log file links) in the response.
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -47662,7 +37640,7 @@ client.accounting.attachments.create(
-
-**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously.
+**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -47682,7 +37660,8 @@ client.accounting.attachments.create(
-client.accounting.attachments.retrieve(...)
+## Hris Scopes
+client.hris.scopes.default_scopes_retrieve()
-
@@ -47694,7 +37673,7 @@ client.accounting.attachments.create(
-
-Returns an `AccountingAttachment` 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).
@@ -47715,11 +37694,7 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.accounting.attachments.retrieve(
- id="id",
- include_remote_data=True,
- include_shell_data=True,
-)
+client.hris.scopes.default_scopes_retrieve()
```
@@ -47735,30 +37710,6 @@ client.accounting.attachments.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.
@@ -47771,7 +37722,7 @@ client.accounting.attachments.retrieve(
-client.accounting.attachments.meta_post_retrieve()
+client.hris.scopes.linked_account_scopes_retrieve()
-
@@ -47783,7 +37734,7 @@ client.accounting.attachments.retrieve(
-
-Returns metadata for `AccountingAttachment` POSTs.
+Get all available permissions for Merge Common Models and fields for a single Linked Account. [Learn more](https://help.merge.dev/en/articles/5950052-common-model-and-field-scopes).
@@ -47804,7 +37755,7 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.accounting.attachments.meta_post_retrieve()
+client.hris.scopes.linked_account_scopes_retrieve()
```
@@ -47832,8 +37783,7 @@ client.accounting.attachments.meta_post_retrieve()
-## Accounting AuditTrail
-client.accounting.audit_trail.list(...)
+client.hris.scopes.linked_account_scopes_create(...)
-
@@ -47845,7 +37795,7 @@ client.accounting.attachments.meta_post_retrieve()
-
-Gets a list of audit trail events.
+Update permissions for any Common Model or field for a single Linked Account. Any Scopes not set in this POST request will inherit the default Scopes. [Learn more](https://help.merge.dev/en/articles/5950052-common-model-and-field-scopes)
@@ -47861,18 +37811,42 @@ Gets a list of audit trail events.
```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.accounting.audit_trail.list(
- cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
- end_date="end_date",
- event_type="event_type",
- page_size=1,
- start_date="start_date",
- user_email="user_email",
+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,
+ )
+ },
+ ),
+ ],
)
```
@@ -47889,47 +37863,7 @@ client.accounting.audit_trail.list(
-
-**cursor:** `typing.Optional[str]` — The pagination cursor value.
-
-
-
-
-
--
-
-**end_date:** `typing.Optional[str]` — If included, will only include audit trail events that occurred before this time
-
-
-
-
-
--
-
-**event_type:** `typing.Optional[str]` — If included, will only include events with the given event type. Possible values include: `CREATED_REMOTE_PRODUCTION_API_KEY`, `DELETED_REMOTE_PRODUCTION_API_KEY`, `CREATED_TEST_API_KEY`, `DELETED_TEST_API_KEY`, `REGENERATED_PRODUCTION_API_KEY`, `REGENERATED_WEBHOOK_SIGNATURE`, `INVITED_USER`, `TWO_FACTOR_AUTH_ENABLED`, `TWO_FACTOR_AUTH_DISABLED`, `DELETED_LINKED_ACCOUNT`, `DELETED_ALL_COMMON_MODELS_FOR_LINKED_ACCOUNT`, `CREATED_DESTINATION`, `DELETED_DESTINATION`, `CHANGED_DESTINATION`, `CHANGED_SCOPES`, `CHANGED_PERSONAL_INFORMATION`, `CHANGED_ORGANIZATION_SETTINGS`, `ENABLED_INTEGRATION`, `DISABLED_INTEGRATION`, `ENABLED_CATEGORY`, `DISABLED_CATEGORY`, `CHANGED_PASSWORD`, `RESET_PASSWORD`, `ENABLED_REDACT_UNMAPPED_DATA_FOR_ORGANIZATION`, `ENABLED_REDACT_UNMAPPED_DATA_FOR_LINKED_ACCOUNT`, `DISABLED_REDACT_UNMAPPED_DATA_FOR_ORGANIZATION`, `DISABLED_REDACT_UNMAPPED_DATA_FOR_LINKED_ACCOUNT`, `CREATED_INTEGRATION_WIDE_FIELD_MAPPING`, `CREATED_LINKED_ACCOUNT_FIELD_MAPPING`, `CHANGED_INTEGRATION_WIDE_FIELD_MAPPING`, `CHANGED_LINKED_ACCOUNT_FIELD_MAPPING`, `DELETED_INTEGRATION_WIDE_FIELD_MAPPING`, `DELETED_LINKED_ACCOUNT_FIELD_MAPPING`, `CREATED_LINKED_ACCOUNT_COMMON_MODEL_OVERRIDE`, `CHANGED_LINKED_ACCOUNT_COMMON_MODEL_OVERRIDE`, `DELETED_LINKED_ACCOUNT_COMMON_MODEL_OVERRIDE`, `FORCED_LINKED_ACCOUNT_RESYNC`, `MUTED_ISSUE`, `GENERATED_MAGIC_LINK`, `ENABLED_MERGE_WEBHOOK`, `DISABLED_MERGE_WEBHOOK`, `MERGE_WEBHOOK_TARGET_CHANGED`, `END_USER_CREDENTIALS_ACCESSED`
-
-
-
-
-
--
-
-**page_size:** `typing.Optional[int]` — Number of results to return per page.
-
-
-
-
-
--
-
-**start_date:** `typing.Optional[str]` — If included, will only include audit trail events that occurred after this time
-
-
-
-
-
--
-
-**user_email:** `typing.Optional[str]` — If provided, this will return events associated with the specified user email. Please note that the email address reflects the user's email at the time of the event, and may not be their current email.
+**common_models:** `typing.Sequence[IndividualCommonModelScopeDeserializerRequest]` — The common models you want to update the scopes for
@@ -47949,8 +37883,8 @@ client.accounting.audit_trail.list(
-## Accounting AvailableActions
-client.accounting.available_actions.retrieve()
+## Hris DeleteAccount
+client.hris.delete_account.delete()
-
@@ -47962,7 +37896,7 @@ client.accounting.audit_trail.list(
-
-Returns a list of models and actions available for an account.
+Delete a linked account.
@@ -47983,7 +37917,7 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.accounting.available_actions.retrieve()
+client.hris.delete_account.delete()
```
@@ -48011,8 +37945,8 @@ client.accounting.available_actions.retrieve()
-## Accounting BalanceSheets
-client.accounting.balance_sheets.list(...)
+## Hris Dependents
+client.hris.dependents.list(...)
-
@@ -48024,7 +37958,7 @@ client.accounting.available_actions.retrieve()
-
-Returns a list of `BalanceSheet` objects.
+Returns a list of `Dependent` objects.
@@ -48039,35 +37973,20 @@ Returns a list of `BalanceSheet` objects.
-
```python
-import datetime
-
from merge import Merge
client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.accounting.balance_sheets.list(
- company_id="company_id",
- created_after=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- created_before=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
+response = client.hris.dependents.list(
cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
- include_deleted_data=True,
- include_remote_data=True,
- include_shell_data=True,
- modified_after=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- modified_before=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- page_size=1,
- remote_id="remote_id",
)
+for item in response:
+ yield item
+# alternatively, you can paginate page-by-page
+for page in response.iter_pages():
+ yield page
```
@@ -48083,14 +38002,6 @@ client.accounting.balance_sheets.list(
-
-**company_id:** `typing.Optional[str]` — If provided, will only return balance sheets for this company.
-
-
-
-
-
--
-
**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
@@ -48115,7 +38026,7 @@ client.accounting.balance_sheets.list(
-
-**expand:** `typing.Optional[typing.Literal["company"]]` — 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/).
@@ -48123,7 +38034,7 @@ client.accounting.balance_sheets.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.
@@ -48131,7 +38042,7 @@ client.accounting.balance_sheets.list(
-
-**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.
@@ -48191,7 +38102,7 @@ client.accounting.balance_sheets.list(
-client.accounting.balance_sheets.retrieve(...)
+client.hris.dependents.retrieve(...)
-
@@ -48203,7 +38114,7 @@ client.accounting.balance_sheets.list(
-
-Returns a `BalanceSheet` object with the given `id`.
+Returns a `Dependent` object with the given `id`.
@@ -48224,10 +38135,8 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.accounting.balance_sheets.retrieve(
+client.hris.dependents.retrieve(
id="id",
- include_remote_data=True,
- include_shell_data=True,
)
```
@@ -48252,7 +38161,161 @@ client.accounting.balance_sheets.retrieve(
-
-**expand:** `typing.Optional[typing.Literal["company"]]` — 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).
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+
+
+## Hris EmployeePayrollRuns
+client.hris.employee_payroll_runs.list(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a list of `EmployeePayrollRun` objects.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+response = client.hris.employee_payroll_runs.list(
+ cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
+)
+for item in response:
+ yield item
+# alternatively, you can paginate page-by-page
+for page in response.iter_pages():
+ yield page
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
+
+
+
+
+
+-
+
+**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
+
+
+
+
+
+-
+
+**cursor:** `typing.Optional[str]` — The pagination cursor value.
+
+
+
+
+
+-
+
+**employee_id:** `typing.Optional[str]` — If provided, will only return employee payroll runs for this employee.
+
+
+
+
+
+-
+
+**ended_after:** `typing.Optional[dt.datetime]` — If provided, will only return employee payroll runs ended after this datetime.
+
+
+
+
+
+-
+
+**ended_before:** `typing.Optional[dt.datetime]` — If provided, will only return employee payroll runs ended before this datetime.
+
+
+
+
+
+-
+
+**expand:** `typing.Optional[
+ typing.Union[
+ EmployeePayrollRunsListRequestExpandItem,
+ typing.Sequence[EmployeePayrollRunsListRequestExpandItem],
+ ]
+]` — 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/).
@@ -48276,75 +38339,23 @@ client.accounting.balance_sheets.retrieve(
-
-**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.
-
-
-
-
-
-
-
-
-## Accounting BankFeedAccounts
-client.accounting.bank_feed_accounts.list(...)
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Returns a list of `BankFeedAccount` objects.
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-```python
-from merge import Merge
-
-client = Merge(
- account_token="YOUR_ACCOUNT_TOKEN",
- api_key="YOUR_API_KEY",
-)
-client.accounting.bank_feed_accounts.list(
- cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
- include_deleted_data=True,
- include_remote_data=True,
- include_shell_data=True,
- page_size=1,
-)
-
-```
-
-
+**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
+
-#### ⚙️ Parameters
-
-
-
--
-
-**cursor:** `typing.Optional[str]` — The pagination cursor value.
+**page_size:** `typing.Optional[int]` — Number of results to return per page.
@@ -48352,7 +38363,7 @@ client.accounting.bank_feed_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/).
+**payroll_run_id:** `typing.Optional[str]` — If provided, will only return employee payroll runs for this employee.
@@ -48360,7 +38371,7 @@ client.accounting.bank_feed_accounts.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.
@@ -48368,7 +38379,7 @@ client.accounting.bank_feed_accounts.list(
-
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
+**started_after:** `typing.Optional[dt.datetime]` — If provided, will only return employee payroll runs started after this datetime.
@@ -48376,7 +38387,7 @@ client.accounting.bank_feed_accounts.list(
-
-**page_size:** `typing.Optional[int]` — Number of results to return per page.
+**started_before:** `typing.Optional[dt.datetime]` — If provided, will only return employee payroll runs started before this datetime.
@@ -48396,7 +38407,7 @@ client.accounting.bank_feed_accounts.list(
-client.accounting.bank_feed_accounts.create(...)
+client.hris.employee_payroll_runs.retrieve(...)
-
@@ -48408,7 +38419,7 @@ client.accounting.bank_feed_accounts.list(
-
-Creates a `BankFeedAccount` object with the given values.
+Returns an `EmployeePayrollRun` object with the given `id`.
@@ -48424,16 +38435,13 @@ Creates a `BankFeedAccount` object with the given values.
```python
from merge import Merge
-from merge.resources.accounting import BankFeedAccountRequest
client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.accounting.bank_feed_accounts.create(
- is_debug_mode=True,
- run_async=True,
- model=BankFeedAccountRequest(),
+client.hris.employee_payroll_runs.retrieve(
+ id="id",
)
```
@@ -48450,7 +38458,7 @@ client.accounting.bank_feed_accounts.create(
-
-**model:** `BankFeedAccountRequest`
+**id:** `str`
@@ -48458,7 +38466,12 @@ client.accounting.bank_feed_accounts.create(
-
-**is_debug_mode:** `typing.Optional[bool]` — Whether to include debug fields (such as log file links) in the response.
+**expand:** `typing.Optional[
+ typing.Union[
+ EmployeePayrollRunsRetrieveRequestExpandItem,
+ typing.Sequence[EmployeePayrollRunsRetrieveRequestExpandItem],
+ ]
+]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -48466,7 +38479,15 @@ client.accounting.bank_feed_accounts.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).
@@ -48486,7 +38507,8 @@ client.accounting.bank_feed_accounts.create(
-client.accounting.bank_feed_accounts.retrieve(...)
+## Hris Employees
+client.hris.employees.list(...)
-
@@ -48498,7 +38520,7 @@ client.accounting.bank_feed_accounts.create(
-
-Returns a `BankFeedAccount` object with the given `id`.
+Returns a list of `Employee` objects.
@@ -48519,11 +38541,14 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.accounting.bank_feed_accounts.retrieve(
- id="id",
- include_remote_data=True,
- include_shell_data=True,
+response = client.hris.employees.list(
+ cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
)
+for item in response:
+ yield item
+# alternatively, you can paginate page-by-page
+for page in response.iter_pages():
+ yield page
```
@@ -48539,7 +38564,7 @@ client.accounting.bank_feed_accounts.retrieve(
-
-**id:** `str`
+**company_id:** `typing.Optional[str]` — If provided, will only return employees for this company.
@@ -48547,7 +38572,7 @@ client.accounting.bank_feed_accounts.retrieve(
-
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
+**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
@@ -48555,7 +38580,7 @@ client.accounting.bank_feed_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).
+**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
@@ -48563,152 +38588,162 @@ client.accounting.bank_feed_accounts.retrieve(
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+**cursor:** `typing.Optional[str]` — The pagination cursor value.
-
-
+
+-
+**display_full_name:** `typing.Optional[str]` — If provided, will only return employees with this display name.
+
-
-client.accounting.bank_feed_accounts.meta_post_retrieve()
-
-#### 📝 Description
+**employment_status:** `typing.Optional[EmployeesListRequestEmploymentStatus]`
-
--
+If provided, will only return employees with this employment status.
+
+* `ACTIVE` - ACTIVE
+* `PENDING` - PENDING
+* `INACTIVE` - INACTIVE
+
+
+
-
-Returns metadata for `BankFeedAccount` POSTs.
-
-
+**employment_type:** `typing.Optional[str]` — If provided, will only return employees that have an employment of the specified employment_type.
+
-#### 🔌 Usage
-
-
+**expand:** `typing.Optional[
+ typing.Union[
+ EmployeesListRequestExpandItem,
+ typing.Sequence[EmployeesListRequestExpandItem],
+ ]
+]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+
+
+
+
-
-```python
-from merge import Merge
-
-client = Merge(
- account_token="YOUR_ACCOUNT_TOKEN",
- api_key="YOUR_API_KEY",
-)
-client.accounting.bank_feed_accounts.meta_post_retrieve()
-
-```
-
-
+**first_name:** `typing.Optional[str]` — If provided, will only return employees with this first name.
+
-#### ⚙️ Parameters
-
-
+**groups:** `typing.Optional[str]` — If provided, will only return employees matching the group ids; multiple groups can be separated by commas.
+
+
+
+
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+**home_location_id:** `typing.Optional[str]` — If provided, will only return employees for this home location.
-
-
+
+-
+**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
+
-
-## Accounting BankFeedTransactions
-client.accounting.bank_feed_transactions.list(...)
-
-#### 📝 Description
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
+
+
+
-
+**include_sensitive_fields:** `typing.Optional[bool]` — Whether to include sensitive fields (such as social security numbers) in the response.
+
+
+
+
-
-Returns a list of `BankFeedTransaction` objects.
+**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
+
+
+
+-
+
+**job_title:** `typing.Optional[str]` — If provided, will only return employees that have an employment of the specified job_title.
+
-#### 🔌 Usage
-
-
+**last_name:** `typing.Optional[str]` — If provided, will only return employees with this last name.
+
+
+
+
-
-```python
-import datetime
-
-from merge import Merge
+**manager_id:** `typing.Optional[str]` — If provided, will only return employees for this manager.
+
+
+
-client = Merge(
- account_token="YOUR_ACCOUNT_TOKEN",
- api_key="YOUR_API_KEY",
-)
-client.accounting.bank_feed_transactions.list(
- created_after=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- created_before=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
- include_deleted_data=True,
- include_remote_data=True,
- include_shell_data=True,
- is_processed=True,
- modified_after=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- modified_before=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- page_size=1,
- remote_id="remote_id",
-)
+
+-
-```
+**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.
+
+
+
+
-
-**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
+**pay_group_id:** `typing.Optional[str]` — If provided, will only return employees for this pay group
@@ -48716,7 +38751,7 @@ client.accounting.bank_feed_transactions.list(
-
-**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
+**personal_email:** `typing.Optional[str]` — If provided, will only return Employees with this personal email
@@ -48724,7 +38759,7 @@ client.accounting.bank_feed_transactions.list(
-
-**cursor:** `typing.Optional[str]` — The pagination cursor value.
+**remote_fields:** `typing.Optional[EmployeesListRequestRemoteFields]` — Deprecated. Use show_enum_origins.
@@ -48732,7 +38767,7 @@ client.accounting.bank_feed_transactions.list(
-
-**expand:** `typing.Optional[typing.Literal["bank_feed_account"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
@@ -48740,7 +38775,7 @@ client.accounting.bank_feed_transactions.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/).
+**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)
@@ -48748,7 +38783,7 @@ client.accounting.bank_feed_transactions.list(
-
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
+**started_after:** `typing.Optional[dt.datetime]` — If provided, will only return employees that started after this datetime.
@@ -48756,7 +38791,7 @@ client.accounting.bank_feed_transactions.list(
-
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
+**started_before:** `typing.Optional[dt.datetime]` — If provided, will only return employees that started before this datetime.
@@ -48764,7 +38799,7 @@ client.accounting.bank_feed_transactions.list(
-
-**is_processed:** `typing.Optional[bool]` — If provided, will only return bank feed transactions with this is_processed value
+**team_id:** `typing.Optional[str]` — If provided, will only return employees for this team.
@@ -48772,7 +38807,7 @@ client.accounting.bank_feed_transactions.list(
-
-**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
+**terminated_after:** `typing.Optional[dt.datetime]` — If provided, will only return employees that were terminated after this datetime.
@@ -48780,7 +38815,7 @@ client.accounting.bank_feed_transactions.list(
-
-**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
+**terminated_before:** `typing.Optional[dt.datetime]` — If provided, will only return employees that were terminated before this datetime.
@@ -48788,7 +38823,7 @@ client.accounting.bank_feed_transactions.list(
-
-**page_size:** `typing.Optional[int]` — Number of results to return per page.
+**work_email:** `typing.Optional[str]` — If provided, will only return Employees with this work email
@@ -48796,7 +38831,7 @@ client.accounting.bank_feed_transactions.list(
-
-**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
+**work_location_id:** `typing.Optional[str]` — If provided, will only return employees for this location.
@@ -48816,7 +38851,7 @@ client.accounting.bank_feed_transactions.list(
-client.accounting.bank_feed_transactions.create(...)
+client.hris.employees.create(...)
-
@@ -48828,7 +38863,7 @@ client.accounting.bank_feed_transactions.list(
-
-Creates a `BankFeedTransaction` object with the given values.
+Creates an `Employee` object with the given values.
@@ -48844,16 +38879,14 @@ Creates a `BankFeedTransaction` object with the given values.
```python
from merge import Merge
-from merge.resources.accounting import BankFeedTransactionRequestRequest
+from merge.resources.hris import EmployeeRequest
client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.accounting.bank_feed_transactions.create(
- is_debug_mode=True,
- run_async=True,
- model=BankFeedTransactionRequestRequest(),
+client.hris.employees.create(
+ model=EmployeeRequest(),
)
```
@@ -48870,7 +38903,7 @@ client.accounting.bank_feed_transactions.create(
-
-**model:** `BankFeedTransactionRequestRequest`
+**model:** `EmployeeRequest`
@@ -48906,7 +38939,7 @@ client.accounting.bank_feed_transactions.create(
-client.accounting.bank_feed_transactions.retrieve(...)
+client.hris.employees.retrieve(...)
-
@@ -48918,7 +38951,7 @@ client.accounting.bank_feed_transactions.create(
-
-Returns a `BankFeedTransaction` object with the given `id`.
+Returns an `Employee` object with the given `id`.
@@ -48939,10 +38972,8 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.accounting.bank_feed_transactions.retrieve(
+client.hris.employees.retrieve(
id="id",
- include_remote_data=True,
- include_shell_data=True,
)
```
@@ -48967,7 +38998,12 @@ client.accounting.bank_feed_transactions.retrieve(
-
-**expand:** `typing.Optional[typing.Literal["bank_feed_account"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+**expand:** `typing.Optional[
+ typing.Union[
+ EmployeesRetrieveRequestExpandItem,
+ typing.Sequence[EmployeesRetrieveRequestExpandItem],
+ ]
+]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -48983,7 +39019,7 @@ client.accounting.bank_feed_transactions.retrieve(
-
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
+**include_sensitive_fields:** `typing.Optional[bool]` — Whether to include sensitive fields (such as social security numbers) in the response.
@@ -48991,64 +39027,27 @@ client.accounting.bank_feed_transactions.retrieve(
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
-
-
-
-
-
-
-
-
-client.accounting.bank_feed_transactions.meta_post_retrieve()
-
--
-
-#### 📝 Description
-
-
-