diff --git a/README.md b/README.md
index 73bd2a65..36588bfa 100644
--- a/README.md
+++ b/README.md
@@ -140,6 +140,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.headers) # access the response headers for the first page
+for item in pager:
+ print(item) # access the underlying object(s)
+for page in pager.iter_pages():
+ print(page.response.headers) # access the response headers for each page
+ for item in page:
+ print(item) # access the underlying object(s)
```
### Retries
@@ -233,33 +241,48 @@ 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
+import datetime
-# response contains the first page
-response = merge_client.hris.employees.list(created_after="2030-01-01")
+from merge import Merge
+from merge.resources.ats.resources.activities import (
+ ActivitiesListRequestRemoteFields,
+ ActivitiesListRequestShowEnumOrigins,
+)
-# 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(
+ 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_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
```
-
-
-
-
-
-
-
-
-
-
-
diff --git a/pyproject.toml b/pyproject.toml
index 62139c69..30811706 100644
--- a/pyproject.toml
+++ b/pyproject.toml
@@ -3,7 +3,7 @@ name = "MergePythonClient"
[tool.poetry]
name = "MergePythonClient"
-version = "2.6.2"
+version = "3.0.0a1"
description = ""
readme = "README.md"
authors = []
diff --git a/reference.md b/reference.md
index 72c3f6b5..7e797bf9 100644
--- a/reference.md
+++ b/reference.md
@@ -173,7 +173,7 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.ats.activities.list(
+response = client.ats.activities.list(
created_after=datetime.datetime.fromisoformat(
"2024-01-15 09:30:00+00:00",
),
@@ -196,6 +196,11 @@ client.ats.activities.list(
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 +240,11 @@ 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[
+ typing.Literal["user"], typing.Sequence[typing.Literal["user"]]
+ ]
+]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -501,7 +510,11 @@ 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[
+ typing.Literal["user"], typing.Sequence[typing.Literal["user"]]
+ ]
+]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -645,15 +658,12 @@ Returns a list of `Application` objects.
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(
+response = client.ats.applications.list(
candidate_id="candidate_id",
created_after=datetime.datetime.fromisoformat(
"2024-01-15 09:30:00+00:00",
@@ -664,7 +674,6 @@ client.ats.applications.list(
credited_to_id="credited_to_id",
current_stage_id="current_stage_id",
cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
- expand=ApplicationsListRequestExpand.CANDIDATE,
include_deleted_data=True,
include_remote_data=True,
include_shell_data=True,
@@ -680,6 +689,11 @@ client.ats.applications.list(
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 +757,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.
@@ -973,9 +992,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,7 +999,6 @@ client = Merge(
)
client.ats.applications.retrieve(
id="id",
- expand=ApplicationsRetrieveRequestExpand.CANDIDATE,
include_remote_data=True,
include_shell_data=True,
)
@@ -1010,7 +1025,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.
@@ -1405,7 +1425,7 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.ats.attachments.list(
+response = client.ats.attachments.list(
candidate_id="candidate_id",
created_after=datetime.datetime.fromisoformat(
"2024-01-15 09:30:00+00:00",
@@ -1426,6 +1446,11 @@ client.ats.attachments.list(
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 +1498,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[
+ typing.Literal["candidate"],
+ typing.Sequence[typing.Literal["candidate"]],
+ ]
+]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -1725,7 +1755,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[
+ typing.Literal["candidate"],
+ typing.Sequence[typing.Literal["candidate"]],
+ ]
+]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -1872,7 +1907,7 @@ 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",
@@ -1880,6 +1915,11 @@ client.ats.audit_trail.list(
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
```
@@ -2048,13 +2088,12 @@ Returns a list of `Candidate` objects.
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(
+response = client.ats.candidates.list(
created_after=datetime.datetime.fromisoformat(
"2024-01-15 09:30:00+00:00",
),
@@ -2063,7 +2102,6 @@ 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,
@@ -2079,6 +2117,11 @@ client.ats.candidates.list(
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 +2169,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.
@@ -2353,9 +2401,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,7 +2408,6 @@ client = Merge(
)
client.ats.candidates.retrieve(
id="id",
- expand=CandidatesRetrieveRequestExpand.APPLICATIONS,
include_remote_data=True,
include_shell_data=True,
)
@@ -2390,7 +2434,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.
@@ -2562,7 +2611,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 +2619,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 +2646,7 @@ client.ats.candidates.ignore_create(
-
-**reason:** `IgnoreCommonModelRequestReason`
-
-
-
-
-
--
-
-**message:** `typing.Optional[str]`
+**request:** `IgnoreCommonModelRequest`
@@ -3076,7 +3119,7 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.ats.departments.list(
+response = client.ats.departments.list(
created_after=datetime.datetime.fromisoformat(
"2024-01-15 09:30:00+00:00",
),
@@ -3096,6 +3139,11 @@ client.ats.departments.list(
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
```
@@ -3332,7 +3380,7 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.ats.eeocs.list(
+response = client.ats.eeocs.list(
candidate_id="candidate_id",
created_after=datetime.datetime.fromisoformat(
"2024-01-15 09:30:00+00:00",
@@ -3355,6 +3403,11 @@ client.ats.eeocs.list(
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 +3455,12 @@ 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[
+ typing.Literal["candidate"],
+ typing.Sequence[typing.Literal["candidate"]],
+ ]
+]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -3561,7 +3619,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[
+ typing.Literal["candidate"],
+ typing.Sequence[typing.Literal["candidate"]],
+ ]
+]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -4220,13 +4283,12 @@ Returns a list of `ScheduledInterview` objects.
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(
+response = client.ats.interviews.list(
application_id="application_id",
created_after=datetime.datetime.fromisoformat(
"2024-01-15 09:30:00+00:00",
@@ -4235,7 +4297,6 @@ client.ats.interviews.list(
"2024-01-15 09:30:00+00:00",
),
cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
- expand=InterviewsListRequestExpand.APPLICATION,
include_deleted_data=True,
include_remote_data=True,
include_shell_data=True,
@@ -4251,6 +4312,11 @@ client.ats.interviews.list(
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 +4364,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.
@@ -4541,9 +4612,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,7 +4619,6 @@ client = Merge(
)
client.ats.interviews.retrieve(
id="id",
- expand=InterviewsRetrieveRequestExpand.APPLICATION,
include_remote_data=True,
include_shell_data=True,
)
@@ -4578,7 +4645,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.
@@ -4728,7 +4800,7 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.ats.issues.list(
+response = client.ats.issues.list(
account_token="account_token",
cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
end_date="end_date",
@@ -4752,6 +4824,11 @@ client.ats.issues.list(
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
```
@@ -5003,7 +5080,7 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.ats.job_interview_stages.list(
+response = client.ats.job_interview_stages.list(
created_after=datetime.datetime.fromisoformat(
"2024-01-15 09:30:00+00:00",
),
@@ -5024,6 +5101,11 @@ client.ats.job_interview_stages.list(
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 +5145,9 @@ 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[typing.Literal["job"], typing.Sequence[typing.Literal["job"]]]
+]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -5208,7 +5292,9 @@ 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[typing.Literal["job"], typing.Sequence[typing.Literal["job"]]]
+]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -5283,7 +5369,7 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.ats.job_postings.list(
+response = client.ats.job_postings.list(
created_after=datetime.datetime.fromisoformat(
"2024-01-15 09:30:00+00:00",
),
@@ -5304,6 +5390,11 @@ client.ats.job_postings.list(
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 +5434,9 @@ 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[typing.Literal["job"], typing.Sequence[typing.Literal["job"]]]
+]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -5496,7 +5589,9 @@ 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[typing.Literal["job"], typing.Sequence[typing.Literal["job"]]]
+]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -5563,16 +5658,13 @@ Returns a list of `Job` objects.
import datetime
from merge import Merge
-from merge.resources.ats.resources.jobs import (
- JobsListRequestExpand,
- JobsListRequestStatus,
-)
+from merge.resources.ats.resources.jobs import JobsListRequestStatus
client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.ats.jobs.list(
+response = client.ats.jobs.list(
code="code",
created_after=datetime.datetime.fromisoformat(
"2024-01-15 09:30:00+00:00",
@@ -5581,7 +5673,6 @@ client.ats.jobs.list(
"2024-01-15 09:30:00+00:00",
),
cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
- expand=JobsListRequestExpand.DEPARTMENTS,
include_deleted_data=True,
include_remote_data=True,
include_shell_data=True,
@@ -5596,6 +5687,11 @@ client.ats.jobs.list(
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 +5739,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.
@@ -5787,7 +5887,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,7 +5894,6 @@ client = Merge(
)
client.ats.jobs.retrieve(
id="id",
- expand=JobsRetrieveRequestExpand.DEPARTMENTS,
include_remote_data=True,
include_shell_data=True,
)
@@ -5822,7 +5920,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.
@@ -5902,23 +6005,24 @@ 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 +6054,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.
@@ -6223,7 +6332,7 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.ats.linked_accounts.list(
+response = client.ats.linked_accounts.list(
category=LinkedAccountsListRequestCategory.ACCOUNTING,
cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
end_user_email_address="end_user_email_address",
@@ -6238,6 +6347,11 @@ client.ats.linked_accounts.list(
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
```
@@ -6410,13 +6524,12 @@ Returns a list of `Offer` objects.
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(
+response = client.ats.offers.list(
application_id="application_id",
created_after=datetime.datetime.fromisoformat(
"2024-01-15 09:30:00+00:00",
@@ -6426,7 +6539,6 @@ client.ats.offers.list(
),
creator_id="creator_id",
cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
- expand=OffersListRequestExpand.APPLICATION,
include_deleted_data=True,
include_remote_data=True,
include_shell_data=True,
@@ -6439,6 +6551,11 @@ client.ats.offers.list(
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 +6611,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.
@@ -6614,7 +6736,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,7 +6743,6 @@ client = Merge(
)
client.ats.offers.retrieve(
id="id",
- expand=OffersRetrieveRequestExpand.APPLICATION,
include_remote_data=True,
include_shell_data=True,
)
@@ -6649,7 +6769,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.
@@ -6737,7 +6862,7 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.ats.offices.list(
+response = client.ats.offices.list(
created_after=datetime.datetime.fromisoformat(
"2024-01-15 09:30:00+00:00",
),
@@ -6757,6 +6882,11 @@ client.ats.offices.list(
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
```
@@ -7137,7 +7267,7 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.ats.reject_reasons.list(
+response = client.ats.reject_reasons.list(
created_after=datetime.datetime.fromisoformat(
"2024-01-15 09:30:00+00:00",
),
@@ -7157,6 +7287,11 @@ client.ats.reject_reasons.list(
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
```
@@ -7384,13 +7519,12 @@ Returns a list of `Scorecard` objects.
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(
+response = client.ats.scorecards.list(
application_id="application_id",
created_after=datetime.datetime.fromisoformat(
"2024-01-15 09:30:00+00:00",
@@ -7399,7 +7533,6 @@ client.ats.scorecards.list(
"2024-01-15 09:30:00+00:00",
),
cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
- expand=ScorecardsListRequestExpand.APPLICATION,
include_deleted_data=True,
include_remote_data=True,
include_shell_data=True,
@@ -7414,6 +7547,11 @@ client.ats.scorecards.list(
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 +7599,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.
@@ -7597,9 +7740,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,7 +7747,6 @@ client = Merge(
)
client.ats.scorecards.retrieve(
id="id",
- expand=ScorecardsRetrieveRequestExpand.APPLICATION,
include_remote_data=True,
include_shell_data=True,
)
@@ -7634,7 +7773,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.
@@ -7720,10 +7864,15 @@ 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
```
@@ -7865,7 +8014,7 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.ats.tags.list(
+response = client.ats.tags.list(
created_after=datetime.datetime.fromisoformat(
"2024-01-15 09:30:00+00:00",
),
@@ -7885,6 +8034,11 @@ client.ats.tags.list(
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
```
@@ -8028,7 +8182,7 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.ats.users.list(
+response = client.ats.users.list(
created_after=datetime.datetime.fromisoformat(
"2024-01-15 09:30:00+00:00",
),
@@ -8049,6 +8203,11 @@ client.ats.users.list(
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
```
@@ -8435,8 +8594,8 @@ client.ats.webhook_receivers.create(
-## Chat AccountDetails
-client.chat.account_details.retrieve()
+## Accounting AccountDetails
+client.accounting.account_details.retrieve()
-
@@ -8469,7 +8628,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 +8656,8 @@ client.chat.account_details.retrieve()
client.chat.account_token.retrieve(...)
+## Accounting AccountToken
+client.accounting.account_token.retrieve(...)
-
@@ -8531,7 +8690,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 +8728,8 @@ client.chat.account_token.retrieve(
client.chat.async_passthrough.create(...)
+## Accounting AccountingPeriods
+client.accounting.accounting_periods.list(...)
-
@@ -8582,7 +8741,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 +8757,23 @@ 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",
+ 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
```
@@ -8625,7 +8789,7 @@ client.chat.async_passthrough.create(
-
-**request:** `DataPassthroughRequest`
+**cursor:** `typing.Optional[str]` — The pagination cursor value.
@@ -8633,70 +8797,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 +8841,7 @@ client.chat.async_passthrough.retrieve(
client.chat.audit_trail.list(...)
+client.accounting.accounting_periods.retrieve(...)
-
@@ -8729,7 +8853,7 @@ client.chat.async_passthrough.retrieve(
-
-Gets a list of audit trail events.
+Returns an `AccountingPeriod` object with the given `id`.
@@ -8750,13 +8874,10 @@ 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",
+ include_remote_data=True,
+ include_shell_data=True,
)
```
@@ -8773,31 +8894,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 +8902,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 +8910,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 +8930,8 @@ client.chat.audit_trail.list(
client.chat.available_actions.retrieve()
+## Accounting Accounts
+client.accounting.accounts.list(...)
-
@@ -8846,7 +8943,7 @@ client.chat.audit_trail.list(
-
-Returns a list of models and actions available for an account.
+Returns a list of `Account` objects.
@@ -8861,13 +8958,52 @@ Returns a list of models and actions available for an account.
-
```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.chat.available_actions.retrieve()
+response = 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",
+ ),
+ 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
```
@@ -8883,90 +9019,67 @@ 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.
-
-
+
+-
+**classification:** `typing.Optional[AccountsListRequestClassification]` — If provided, will only return accounts with this classification.
+
-client.chat.conversations.list(...)
-
-#### 📝 Description
-
-
--
+**company_id:** `typing.Optional[str]` — If provided, will only return accounts for this company.
+
+
+
-
-Returns a list of `Conversation` objects.
-
-
+**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
+
-#### 🔌 Usage
-
-
+**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
+
+
+
+
-
-```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",
-)
-
-```
-
-
+**cursor:** `typing.Optional[str]` — The pagination cursor value.
+
-#### ⚙️ Parameters
-
-
+**expand:** `typing.Optional[
+ typing.Union[
+ typing.Literal["company"], typing.Sequence[typing.Literal["company"]]
+ ]
+]` — 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.
+**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
@@ -8974,7 +9087,7 @@ client.chat.conversations.list(
-
-**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -8982,7 +9095,7 @@ client.chat.conversations.list(
-
-**cursor:** `typing.Optional[str]` — The pagination cursor value.
+**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -8990,7 +9103,7 @@ 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.
+**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
@@ -8998,7 +9111,7 @@ client.chat.conversations.list(
-
-**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
+**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
@@ -9006,7 +9119,7 @@ client.chat.conversations.list(
-
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
+**name:** `typing.Optional[str]` — If provided, will only return Accounts with this name.
@@ -9014,7 +9127,7 @@ client.chat.conversations.list(
-
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
+**page_size:** `typing.Optional[int]` — Number of results to return per page.
@@ -9022,7 +9135,7 @@ client.chat.conversations.list(
-
-**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
+**remote_fields:** `typing.Optional[AccountsListRequestRemoteFields]` — Deprecated. Use show_enum_origins.
@@ -9030,7 +9143,7 @@ client.chat.conversations.list(
-
-**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
+**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
@@ -9038,7 +9151,7 @@ client.chat.conversations.list(
-
-**page_size:** `typing.Optional[int]` — Number of results to return per page. The maximum limit is 100.
+**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)
@@ -9046,7 +9159,7 @@ client.chat.conversations.list(
-
-**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
+**status:** `typing.Optional[AccountsListRequestStatus]` — If provided, will only return accounts with this status.
@@ -9066,7 +9179,7 @@ client.chat.conversations.list(
client.chat.conversations.members_list(...)
+client.accounting.accounts.create(...)
-
@@ -9078,7 +9191,7 @@ client.chat.conversations.list(
-
-Returns a list of `Member` objects.
+Creates an `Account` object with the given values.
@@ -9094,22 +9207,16 @@ 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(
+ is_debug_mode=True,
+ run_async=True,
+ model=AccountRequest(),
)
```
@@ -9126,39 +9233,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 +9241,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 +9249,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 +9269,7 @@ client.chat.conversations.members_list(
client.chat.conversations.retrieve(...)
+client.accounting.accounts.retrieve(...)
-
@@ -9206,7 +9281,7 @@ client.chat.conversations.members_list(
-
-Returns a `Conversation` object with the given `id`.
+Returns an `Account` object with the given `id`.
@@ -9222,15 +9297,21 @@ Returns a `Conversation` object with the given `id`.
```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.chat.conversations.retrieve(
+client.accounting.accounts.retrieve(
id="id",
include_remote_data=True,
include_shell_data=True,
+ remote_fields=AccountsRetrieveRequestRemoteFields.CLASSIFICATION,
+ show_enum_origins=AccountsRetrieveRequestShowEnumOrigins.CLASSIFICATION,
)
```
@@ -9255,7 +9336,11 @@ 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[
+ typing.Literal["company"], typing.Sequence[typing.Literal["company"]]
+ ]
+]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -9279,6 +9364,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 +9392,7 @@ client.chat.conversations.retrieve(
client.chat.scopes.default_scopes_retrieve()
+client.accounting.accounts.meta_post_retrieve()
-
@@ -9304,7 +9404,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 +9425,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 +9453,8 @@ client.chat.scopes.default_scopes_retrieve()
client.chat.scopes.linked_account_scopes_retrieve()
+## Accounting Addresses
+client.accounting.addresses.retrieve(...)
-
@@ -9365,7 +9466,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 +9487,11 @@ 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",
+ include_remote_data=True,
+ include_shell_data=True,
+)
```
@@ -9402,6 +9507,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[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.
@@ -9414,7 +9559,8 @@ client.chat.scopes.linked_account_scopes_retrieve()
client.chat.scopes.linked_account_scopes_create(...)
+## Accounting AsyncPassthrough
+client.accounting.async_passthrough.create(...)
-
@@ -9426,7 +9572,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 +9588,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 +9615,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 +9635,7 @@ client.chat.scopes.linked_account_scopes_create(
client.chat.delete_account.delete()
+client.accounting.async_passthrough.retrieve(...)
-
@@ -9527,7 +9647,7 @@ client.chat.scopes.linked_account_scopes_create(
-
-Delete a linked account.
+Retrieves data from earlier async-passthrough POST request
@@ -9548,7 +9668,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 +9686,14 @@ client.chat.delete_account.delete()
-
+**async_passthrough_receipt_id:** `str`
+
+
+
+
+
+-
+
**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -9576,8 +9706,8 @@ client.chat.delete_account.delete()
client.chat.field_mapping.field_mappings_retrieve(...)
+## Accounting AsyncTasks
+client.accounting.async_tasks.retrieve(...)
-
@@ -9589,7 +9719,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 +9740,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 +9758,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 +9778,8 @@ client.chat.field_mapping.field_mappings_retrieve(
client.chat.field_mapping.field_mappings_create(...)
+## Accounting Attachments
+client.accounting.attachments.list(...)
-
@@ -9660,7 +9791,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.
@@ -9675,21 +9806,40 @@ Create new Field Mappings that will be available after the next scheduled sync.
-
```python
+import datetime
+
from merge import Merge
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(
+ 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",
+ 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
```
@@ -9705,7 +9855,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 +9863,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 +9871,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 +9879,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 +9887,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 +9895,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 +9903,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 +9911,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 +9919,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 +9955,7 @@ client.chat.field_mapping.field_mappings_destroy(
client.chat.field_mapping.field_mappings_partial_update(...)
+client.accounting.attachments.create(...)
-
@@ -9864,7 +9967,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 +9983,16 @@ 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(
+ is_debug_mode=True,
+ run_async=True,
+ model=AccountingAttachmentRequest(),
)
```
@@ -9903,23 +10009,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 +10017,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 +10025,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 +10045,7 @@ client.chat.field_mapping.field_mappings_partial_update(
client.chat.field_mapping.remote_fields_retrieve(...)
+client.accounting.attachments.retrieve(...)
-
@@ -9967,7 +10057,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 +10078,10 @@ 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",
+ include_remote_data=True,
+ include_shell_data=True,
)
```
@@ -10007,7 +10098,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 +10106,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 +10134,7 @@ client.chat.field_mapping.remote_fields_retrieve(
client.chat.field_mapping.target_fields_retrieve()
+client.accounting.attachments.meta_post_retrieve()
-
@@ -10047,7 +10146,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 +10167,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 +10195,8 @@ client.chat.field_mapping.target_fields_retrieve()
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.
-
-
-
-
-
-
-
-
-
-client.chat.groups.list(...)
+## Accounting AuditTrail
+client.accounting.audit_trail.list(...)
-
@@ -10181,7 +10208,7 @@ client.chat.generate_key.create(
-
-Returns a list of `Group` objects.
+Gets a list of audit trail events.
@@ -10196,34 +10223,25 @@ 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",
- ),
+ end_date="end_date",
+ event_type="event_type",
page_size=1,
- remote_id="remote_id",
+ 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
```
@@ -10239,22 +10257,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 +10265,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 +10273,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 +10281,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 +10289,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 +10297,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 +10317,8 @@ client.chat.groups.list(
client.chat.groups.retrieve(...)
+## Accounting AvailableActions
+client.accounting.available_actions.retrieve()
-
@@ -10351,7 +10330,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 +10351,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 +10367,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 +10379,8 @@ client.chat.groups.retrieve(
client.chat.issues.list(...)
+## Accounting BalanceSheets
+client.accounting.balance_sheets.list(...)
-
@@ -10449,7 +10392,7 @@ client.chat.groups.retrieve(
-
-Gets all issues for Organization.
+Returns a list of `BalanceSheet` objects.
@@ -10467,36 +10410,37 @@ Gets all issues for Organization.
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",
- cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
- end_date="end_date",
- end_user_organization_name="end_user_organization_name",
- first_incident_time_after=datetime.datetime.fromisoformat(
+response = client.accounting.balance_sheets.list(
+ company_id="company_id",
+ created_after=datetime.datetime.fromisoformat(
"2024-01-15 09:30:00+00:00",
),
- first_incident_time_before=datetime.datetime.fromisoformat(
+ created_before=datetime.datetime.fromisoformat(
"2024-01-15 09:30:00+00:00",
),
- include_muted="include_muted",
- integration_name="integration_name",
- last_incident_time_after=datetime.datetime.fromisoformat(
+ cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
+ include_deleted_data=True,
+ include_remote_data=True,
+ include_shell_data=True,
+ modified_after=datetime.datetime.fromisoformat(
"2024-01-15 09:30:00+00:00",
),
- last_incident_time_before=datetime.datetime.fromisoformat(
+ modified_before=datetime.datetime.fromisoformat(
"2024-01-15 09:30:00+00:00",
),
- linked_account_id="linked_account_id",
page_size=1,
- start_date="start_date",
- status=IssuesListRequestStatus.ONGOING,
+ 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
```
@@ -10512,23 +10456,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 +10464,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 +10472,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 +10480,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 +10488,11 @@ client.chat.issues.list(
-
-**include_muted:** `typing.Optional[str]` — If true, will include muted issues
+**expand:** `typing.Optional[
+ typing.Union[
+ typing.Literal["company"], typing.Sequence[typing.Literal["company"]]
+ ]
+]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -10568,7 +10500,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 +10508,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 +10516,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 +10524,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 +10532,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 +10540,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 +10548,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 +10568,7 @@ Status of the issue. Options: ('ONGOING', 'RESOLVED')
client.chat.issues.retrieve(...)
+client.accounting.balance_sheets.retrieve(...)
-
@@ -10653,7 +10580,7 @@ Status of the issue. Options: ('ONGOING', 'RESOLVED')
-
-Get a specific issue.
+Returns a `BalanceSheet` object with the given `id`.
@@ -10674,8 +10601,10 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.chat.issues.retrieve(
+client.accounting.balance_sheets.retrieve(
id="id",
+ include_remote_data=True,
+ include_shell_data=True,
)
```
@@ -10700,6 +10629,34 @@ client.chat.issues.retrieve(
-
+**expand:** `typing.Optional[
+ typing.Union[
+ typing.Literal["company"], typing.Sequence[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_shell_data:** `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 +10669,8 @@ client.chat.issues.retrieve(
client.chat.link_token.create(...)
+## Accounting BankFeedAccounts
+client.accounting.bank_feed_accounts.list(...)
-
@@ -10725,7 +10682,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 +10698,23 @@ 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",
+ 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
```
@@ -10768,7 +10730,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 +10738,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 +10746,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 +10754,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 +10762,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 +10770,73 @@ 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(
+ is_debug_mode=True,
+ run_async=True,
+ 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 +10844,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 +10852,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 +10872,7 @@ When creating a Link token, you can specifiy the initial screen of Linking Flow
client.chat.linked_accounts.list(...)
+client.accounting.bank_feed_accounts.retrieve(...)
-
@@ -10921,7 +10884,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 +10900,15 @@ 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",
+ include_remote_data=True,
+ include_shell_data=True,
)
```
@@ -10975,19 +10925,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 +10933,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 +10941,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 +10949,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 +11022,8 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `knowledgebase`, `mk
client.chat.messages.list(...)
+## Accounting BankFeedTransactions
+client.accounting.bank_feed_transactions.list(...)
-
@@ -11116,7 +11035,7 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `knowledgebase`, `mk
-
-Returns a list of `Message` objects.
+Returns a list of `BankFeedTransaction` objects.
@@ -11134,14 +11053,12 @@ Returns a list of `Message` objects.
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",
+response = client.accounting.bank_feed_transactions.list(
created_after=datetime.datetime.fromisoformat(
"2024-01-15 09:30:00+00:00",
),
@@ -11152,17 +11069,21 @@ client.chat.messages.list(
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",
),
- 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 +11099,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 +11107,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 +11115,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 +11123,12 @@ client.chat.messages.list(
-
-**cursor:** `typing.Optional[str]` — The pagination cursor value.
+**expand:** `typing.Optional[
+ typing.Union[
+ typing.Literal["bank_feed_account"],
+ typing.Sequence[typing.Literal["bank_feed_account"]],
+ ]
+]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -11234,7 +11160,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 +11168,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 +11176,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 +11184,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 +11200,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 +11212,7 @@ client.chat.messages.list(
client.chat.messages.retrieve(...)
+client.accounting.bank_feed_transactions.create(...)
-
@@ -11306,7 +11224,7 @@ client.chat.messages.list(
-
-Returns a `Message` object with the given `id`.
+Creates a `BankFeedTransaction` object with the given values.
@@ -11322,15 +11240,16 @@ 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(
+ is_debug_mode=True,
+ run_async=True,
+ model=BankFeedTransactionRequestRequest(),
)
```
@@ -11347,7 +11266,7 @@ client.chat.messages.retrieve(
-
-**id:** `str`
+**model:** `BankFeedTransactionRequestRequest`
@@ -11355,7 +11274,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 +11282,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 +11302,7 @@ client.chat.messages.retrieve(
client.chat.messages.replies_list(...)
+client.accounting.bank_feed_transactions.retrieve(...)
-
@@ -11395,7 +11314,7 @@ client.chat.messages.retrieve(
-
-Returns a list of `Message` objects.
+Returns a `BankFeedTransaction` object with the given `id`.
@@ -11411,22 +11330,15 @@ 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,
+client.accounting.bank_feed_transactions.retrieve(
+ id="id",
include_remote_data=True,
include_shell_data=True,
- order_by=MessagesRepliesListRequestOrderBy.REMOTE_CREATED_AT_DESCENDING,
- page_size=1,
)
```
@@ -11443,15 +11355,7 @@ client.chat.messages.replies_list(
-
-**message_id:** `str`
-
-
-
-
-
--
-
-**cursor:** `typing.Optional[str]` — The pagination cursor value.
+**id:** `str`
@@ -11459,7 +11363,12 @@ 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/).
+**expand:** `typing.Optional[
+ typing.Union[
+ typing.Literal["bank_feed_account"],
+ typing.Sequence[typing.Literal["bank_feed_account"]],
+ ]
+]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -11483,22 +11392,6 @@ client.chat.messages.replies_list(
-
-**order_by:** `typing.Optional[MessagesRepliesListRequestOrderBy]` — Overrides the default ordering for this endpoint. Possible values include: remote_created_at, -remote_created_at.
-
-
-
-
-
--
-
-**page_size:** `typing.Optional[int]` — Number of results to return per page. The maximum limit is 100.
-
-
-
-
-
--
-
**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -11511,8 +11404,7 @@ client.chat.messages.replies_list(
client.chat.passthrough.create(...)
+client.accounting.bank_feed_transactions.meta_post_retrieve()
-
@@ -11524,7 +11416,7 @@ client.chat.messages.replies_list(
-
-Pull data from an endpoint not currently supported by Merge.
+Returns metadata for `BankFeedTransaction` POSTs.
@@ -11540,18 +11432,12 @@ 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",
- ),
-)
+client.accounting.bank_feed_transactions.meta_post_retrieve()
```
@@ -11567,14 +11453,6 @@ client.chat.passthrough.create(
-
-**request:** `DataPassthroughRequest`
-
-
-
-
-
--
-
**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -11587,8 +11465,8 @@ client.chat.passthrough.create(
client.chat.regenerate_key.create(...)
+## Accounting CashFlowStatements
+client.accounting.cash_flow_statements.list(...)
-
@@ -11600,7 +11478,7 @@ client.chat.passthrough.create(
-
-Exchange remote keys.
+Returns a list of `CashFlowStatement` objects.
@@ -11615,15 +11493,40 @@ Exchange remote keys.
-
```python
+import datetime
+
from merge import Merge
client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.chat.regenerate_key.create(
- name="Remote Deployment Key 1",
+response = client.accounting.cash_flow_statements.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",
+ 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
```
@@ -11639,7 +11542,7 @@ client.chat.regenerate_key.create(
-
-**name:** `str` — The name of the remote key
+**company_id:** `typing.Optional[str]` — If provided, will only return cash flow statements for this company.
@@ -11647,72 +11550,83 @@ client.chat.regenerate_key.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.chat.sync_status.list(...)
-
-#### 📝 Description
+**cursor:** `typing.Optional[str]` — The pagination cursor value.
+
+
+
-
+**expand:** `typing.Optional[
+ typing.Union[
+ typing.Literal["company"], typing.Sequence[typing.Literal["company"]]
+ ]
+]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+
+
+
+
-
-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).
-
-
+**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
+
-#### 🔌 Usage
-
-
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
+
+
+
+
-
-```python
-from merge import Merge
-
-client = Merge(
- account_token="YOUR_ACCOUNT_TOKEN",
- api_key="YOUR_API_KEY",
-)
-client.chat.sync_status.list(
- cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
- page_size=1,
-)
-
-```
+**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
+
+
+
+-
+
+**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
+
-#### ⚙️ Parameters
-
-
+**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
+
+
+
+
-
-**cursor:** `typing.Optional[str]` — The pagination cursor value.
+**page_size:** `typing.Optional[int]` — Number of results to return per page.
@@ -11720,7 +11634,7 @@ client.chat.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.
@@ -11740,8 +11654,7 @@ client.chat.sync_status.list(
client.chat.force_resync.sync_status_resync_create()
+client.accounting.cash_flow_statements.retrieve(...)
-
@@ -11753,7 +11666,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 `CashFlowStatement` object with the given `id`.
@@ -11774,7 +11687,11 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.chat.force_resync.sync_status_resync_create()
+client.accounting.cash_flow_statements.retrieve(
+ id="id",
+ include_remote_data=True,
+ include_shell_data=True,
+)
```
@@ -11790,6 +11707,42 @@ client.chat.force_resync.sync_status_resync_create()
-
+**id:** `str`
+
+
+
+
+
+-
+
+**expand:** `typing.Optional[
+ typing.Union[
+ typing.Literal["company"], typing.Sequence[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_shell_data:** `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.
@@ -11802,8 +11755,8 @@ client.chat.force_resync.sync_status_resync_create()
client.chat.users.list(...)
+## Accounting CompanyInfo
+client.accounting.company_info.list(...)
-
@@ -11815,7 +11768,7 @@ client.chat.force_resync.sync_status_resync_create()
-
-Returns a list of `User` objects.
+Returns a list of `CompanyInfo` objects.
@@ -11838,7 +11791,7 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.chat.users.list(
+response = client.accounting.company_info.list(
created_after=datetime.datetime.fromisoformat(
"2024-01-15 09:30:00+00:00",
),
@@ -11858,6 +11811,11 @@ client.chat.users.list(
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
```
@@ -11897,7 +11855,12 @@ client.chat.users.list(
-
-**expand:** `typing.Optional[typing.Literal["groups"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+**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.
@@ -11945,7 +11908,7 @@ client.chat.users.list(
-
-**page_size:** `typing.Optional[int]` — Number of results to return per page. The maximum limit is 100.
+**page_size:** `typing.Optional[int]` — Number of results to return per page.
@@ -11973,7 +11936,7 @@ client.chat.users.list(
client.chat.users.retrieve(...)
+client.accounting.company_info.retrieve(...)
-
@@ -11985,7 +11948,7 @@ client.chat.users.list(
-
-Returns a `User` object with the given `id`.
+Returns a `CompanyInfo` object with the given `id`.
@@ -12006,7 +11969,7 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.chat.users.retrieve(
+client.accounting.company_info.retrieve(
id="id",
include_remote_data=True,
include_shell_data=True,
@@ -12034,7 +11997,12 @@ 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.
+**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.
@@ -12070,8 +12038,8 @@ client.chat.users.retrieve(
client.chat.webhook_receivers.list()
+## Accounting Contacts
+client.accounting.contacts.list(...)
-
@@ -12083,7 +12051,7 @@ client.chat.users.retrieve(
-
-Returns a list of `WebhookReceiver` objects.
+Returns a list of `Contact` objects.
@@ -12098,13 +12066,49 @@ Returns a list of `WebhookReceiver` objects.
-
```python
+import datetime
+
from merge import Merge
+from merge.resources.accounting.resources.contacts import (
+ ContactsListRequestStatus,
+)
client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.chat.webhook_receivers.list()
+response = client.accounting.contacts.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",
+ email_address="email_address",
+ include_deleted_data=True,
+ include_remote_data=True,
+ include_remote_fields=True,
+ include_shell_data=True,
+ is_customer="is_customer",
+ is_supplier="is_supplier",
+ 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",
+ status=ContactsListRequestStatus.EMPTY,
+)
+for item in response:
+ yield item
+# alternatively, you can paginate page-by-page
+for page in response.iter_pages():
+ yield page
```
@@ -12120,71 +12124,76 @@ client.chat.webhook_receivers.list()
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+**company_id:** `typing.Optional[str]` — If provided, will only return contacts for this company.
-
-
+
+-
+**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
+
-client.chat.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.
-
-
+**email_address:** `typing.Optional[str]` — If provided, will only return Contacts that match this email.
+
-#### 🔌 Usage
-
-
+**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.
+
+
+
+
-
-```python
-from merge import Merge
-
-client = Merge(
- account_token="YOUR_ACCOUNT_TOKEN",
- api_key="YOUR_API_KEY",
-)
-client.chat.webhook_receivers.create(
- event="event",
- is_active=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.
+
+
+
+
-
-**event:** `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.
@@ -12192,7 +12201,7 @@ client.chat.webhook_receivers.create(
-
-**is_active:** `bool`
+**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -12200,7 +12209,7 @@ client.chat.webhook_receivers.create(
-
-**key:** `typing.Optional[str]`
+**is_customer:** `typing.Optional[str]` — If provided, will only return Contacts that are denoted as customers.
@@ -12208,65 +12217,75 @@ client.chat.webhook_receivers.create(
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+**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.
+
-client.crm.account_details.retrieve()
-
-#### 📝 Description
+**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 Contacts that match this name.
+
+
+
+
-
-Get details for a linked account.
-
-
+**page_size:** `typing.Optional[int]` — Number of results to return per page.
+
-#### 🔌 Usage
-
-
+**remote_fields:** `typing.Optional[typing.Literal["status"]]` — Deprecated. Use show_enum_origins.
+
+
+
+
-
-```python
-from merge import Merge
-
-client = Merge(
- account_token="YOUR_ACCOUNT_TOKEN",
- api_key="YOUR_API_KEY",
-)
-client.crm.account_details.retrieve()
-
-```
+**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
-
-
+**status:** `typing.Optional[ContactsListRequestStatus]` — If provided, will only return Contacts that match this status.
+
+
+
+
-
@@ -12282,8 +12301,7 @@ client.crm.account_details.retrieve()
client.crm.account_token.retrieve(...)
+client.accounting.contacts.create(...)
-
@@ -12295,7 +12313,7 @@ client.crm.account_details.retrieve()
-
-Returns the account token for the end user with the provided public token.
+Creates a `Contact` object with the given values.
@@ -12311,13 +12329,16 @@ Returns the account token for the end user with the provided public token.
```python
from merge import Merge
+from merge.resources.accounting import ContactRequest
client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.crm.account_token.retrieve(
- public_token="public_token",
+client.accounting.contacts.create(
+ is_debug_mode=True,
+ run_async=True,
+ model=ContactRequest(),
)
```
@@ -12334,7 +12355,23 @@ client.crm.account_token.retrieve(
-
-**public_token:** `str`
+**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.
@@ -12354,8 +12391,7 @@ client.crm.account_token.retrieve(
client.crm.accounts.list(...)
+client.accounting.contacts.retrieve(...)
-
@@ -12367,7 +12403,7 @@ client.crm.account_token.retrieve(
-
-Returns a list of `Account` objects.
+Returns a `Contact` object with the given `id`.
@@ -12382,36 +12418,17 @@ 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.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,
+client.accounting.contacts.retrieve(
+ id="id",
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",
)
```
@@ -12428,31 +12445,7 @@ client.crm.accounts.list(
-
-**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
-
-
-
-
-
--
-
-**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
-
-
-
-
-
--
-
-**cursor:** `typing.Optional[str]` — The pagination cursor value.
-
-
-
-
-
--
-
-**expand:** `typing.Optional[typing.Literal["owner"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+**id:** `str`
@@ -12460,7 +12453,12 @@ 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/).
+**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.
@@ -12492,39 +12490,7 @@ client.crm.accounts.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.
-
-
-
-
-
--
-
-**name:** `typing.Optional[str]` — If provided, will only return accounts with this name.
-
-
-
-
-
--
-
-**owner_id:** `typing.Optional[str]` — If provided, will only return accounts with this owner.
-
-
-
-
-
--
-
-**page_size:** `typing.Optional[int]` — Number of results to return per page.
+**remote_fields:** `typing.Optional[typing.Literal["status"]]` — Deprecated. Use show_enum_origins.
@@ -12532,7 +12498,7 @@ client.crm.accounts.list(
-
-**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)
@@ -12552,7 +12518,7 @@ client.crm.accounts.list(
client.crm.accounts.create(...)
+client.accounting.contacts.meta_post_retrieve()
-
@@ -12564,7 +12530,7 @@ client.crm.accounts.list(
-
-Creates an `Account` object with the given values.
+Returns metadata for `Contact` POSTs.
@@ -12580,17 +12546,12 @@ Creates an `Account` object with the given values.
```python
from merge import Merge
-from merge.resources.crm import AccountRequest
client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.crm.accounts.create(
- is_debug_mode=True,
- run_async=True,
- model=AccountRequest(),
-)
+client.accounting.contacts.meta_post_retrieve()
```
@@ -12606,30 +12567,6 @@ client.crm.accounts.create(
-
-**model:** `AccountRequest`
-
-
-
-
-
--
-
-**is_debug_mode:** `typing.Optional[bool]` — Whether to include debug fields (such as log file links) in the response.
-
-
-
-
-
--
-
-**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously.
-
-
-
-
-
--
-
**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -12642,7 +12579,7 @@ client.crm.accounts.create(
client.crm.accounts.retrieve(...)
+client.accounting.contacts.remote_field_classes_list(...)
-
@@ -12654,7 +12591,7 @@ client.crm.accounts.create(
-
-Returns an `Account` object with the given `id`.
+Returns a list of `RemoteFieldClass` objects.
@@ -12675,12 +12612,20 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.crm.accounts.retrieve(
- id="id",
+response = client.accounting.contacts.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
```
@@ -12696,7 +12641,7 @@ client.crm.accounts.retrieve(
-
-**id:** `str`
+**cursor:** `typing.Optional[str]` — The pagination cursor value.
@@ -12704,7 +12649,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.
+**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
@@ -12720,7 +12665,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.
+**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -12728,7 +12673,23 @@ 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).
+**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.
@@ -12748,7 +12709,8 @@ client.crm.accounts.retrieve(
client.crm.accounts.partial_update(...)
+## Accounting CreditNotes
+client.accounting.credit_notes.list(...)
-
@@ -12760,7 +12722,7 @@ client.crm.accounts.retrieve(
-
-Updates an `Account` object with the given `id`.
+Returns a list of `CreditNote` objects.
@@ -12775,19 +12737,52 @@ Updates an `Account` object with the given `id`.
-
```python
+import datetime
+
from merge import Merge
-from merge.resources.crm import PatchedAccountRequest
+from merge.resources.accounting.resources.credit_notes import (
+ CreditNotesListRequestRemoteFields,
+ CreditNotesListRequestShowEnumOrigins,
+)
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(),
+response = client.accounting.credit_notes.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",
+ 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=CreditNotesListRequestRemoteFields.STATUS,
+ remote_id="remote_id",
+ show_enum_origins=CreditNotesListRequestShowEnumOrigins.STATUS,
+ transaction_date_after=datetime.datetime.fromisoformat(
+ "2024-01-15 09:30:00+00:00",
+ ),
+ transaction_date_before=datetime.datetime.fromisoformat(
+ "2024-01-15 09:30:00+00:00",
+ ),
)
+for item in response:
+ yield item
+# alternatively, you can paginate page-by-page
+for page in response.iter_pages():
+ yield page
```
@@ -12803,7 +12798,7 @@ client.crm.accounts.partial_update(
-
-**id:** `str`
+**company_id:** `typing.Optional[str]` — If provided, will only return credit notes for this company.
@@ -12811,7 +12806,7 @@ client.crm.accounts.partial_update(
-
-**model:** `PatchedAccountRequest`
+**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
@@ -12819,7 +12814,7 @@ client.crm.accounts.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.
@@ -12827,7 +12822,7 @@ client.crm.accounts.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.
@@ -12835,70 +12830,100 @@ client.crm.accounts.partial_update(
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+**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.
-
-
+
+-
+**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
+
-client.crm.accounts.meta_patch_retrieve(...)
-
-#### 📝 Description
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
+
+
+
-
+**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
+
+
+
+
-
-Returns metadata for `CRMAccount` PATCHs.
+**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
+
+
+
+-
+
+**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
+
-#### 🔌 Usage
-
-
+**page_size:** `typing.Optional[int]` — Number of results to return per page.
+
+
+
+
-
-```python
-from merge import Merge
+**remote_fields:** `typing.Optional[CreditNotesListRequestRemoteFields]` — Deprecated. Use show_enum_origins.
+
+
+
-client = Merge(
- account_token="YOUR_ACCOUNT_TOKEN",
- api_key="YOUR_API_KEY",
-)
-client.crm.accounts.meta_patch_retrieve(
- id="id",
-)
+
+-
-```
+**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
+
+
+
+-
+
+**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)
+
-#### ⚙️ Parameters
-
-
+**transaction_date_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
+
+
+
+
-
-**id:** `str`
+**transaction_date_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
@@ -12918,7 +12943,7 @@ client.crm.accounts.meta_patch_retrieve(
client.crm.accounts.meta_post_retrieve()
+client.accounting.credit_notes.create(...)
-
@@ -12930,7 +12955,7 @@ client.crm.accounts.meta_patch_retrieve(
-
-Returns metadata for `CRMAccount` POSTs.
+Creates a `CreditNote` object with the given values.
@@ -12946,12 +12971,17 @@ Returns metadata for `CRMAccount` POSTs.
```python
from merge import Merge
+from merge.resources.accounting import CreditNoteRequest
client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.crm.accounts.meta_post_retrieve()
+client.accounting.credit_notes.create(
+ is_debug_mode=True,
+ run_async=True,
+ model=CreditNoteRequest(),
+)
```
@@ -12967,6 +12997,30 @@ client.crm.accounts.meta_post_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.
@@ -12979,7 +13033,7 @@ client.crm.accounts.meta_post_retrieve()
client.crm.accounts.remote_field_classes_list(...)
+client.accounting.credit_notes.retrieve(...)
-
@@ -12991,7 +13045,7 @@ client.crm.accounts.meta_post_retrieve()
-
-Returns a list of `RemoteFieldClass` objects.
+Returns a `CreditNote` object with the given `id`.
@@ -13007,20 +13061,21 @@ Returns a list of `RemoteFieldClass` objects.
```python
from merge import Merge
+from merge.resources.accounting.resources.credit_notes import (
+ CreditNotesRetrieveRequestRemoteFields,
+ CreditNotesRetrieveRequestShowEnumOrigins,
+)
client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.crm.accounts.remote_field_classes_list(
- cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
- include_deleted_data=True,
+client.accounting.credit_notes.retrieve(
+ id="id",
include_remote_data=True,
- include_remote_fields=True,
include_shell_data=True,
- is_common_model_field=True,
- is_custom=True,
- page_size=1,
+ remote_fields=CreditNotesRetrieveRequestRemoteFields.STATUS,
+ show_enum_origins=CreditNotesRetrieveRequestShowEnumOrigins.STATUS,
)
```
@@ -13037,7 +13092,7 @@ client.crm.accounts.remote_field_classes_list(
-
-**cursor:** `typing.Optional[str]` — The pagination cursor value.
+**id:** `str`
@@ -13045,7 +13100,12 @@ client.crm.accounts.remote_field_classes_list(
-
-**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
+**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.
@@ -13061,14 +13121,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).
@@ -13077,15 +13129,7 @@ client.crm.accounts.remote_field_classes_list(
-
-**is_common_model_field:** `typing.Optional[bool]` — If provided, will only return remote field classes with this is_common_model_field value
-
-
-
-
-
--
-
-**is_custom:** `typing.Optional[bool]` — If provided, will only return remote fields classes with this is_custom value
+**remote_fields:** `typing.Optional[CreditNotesRetrieveRequestRemoteFields]` — Deprecated. Use show_enum_origins.
@@ -13093,7 +13137,7 @@ client.crm.accounts.remote_field_classes_list(
-
-**page_size:** `typing.Optional[int]` — Number of results to return per page.
+**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)
@@ -13113,8 +13157,7 @@ client.crm.accounts.remote_field_classes_list(
client.crm.async_passthrough.create(...)
+client.accounting.credit_notes.meta_post_retrieve()
-
@@ -13126,7 +13169,7 @@ client.crm.accounts.remote_field_classes_list(
-
-Asynchronously pull data from an endpoint not currently supported by Merge.
+Returns metadata for `CreditNote` POSTs.
@@ -13142,18 +13185,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.credit_notes.meta_post_retrieve()
```
@@ -13169,14 +13206,6 @@ client.crm.async_passthrough.create(
-
-**request:** `DataPassthroughRequest`
-
-
-
-
-
--
-
**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -13189,7 +13218,8 @@ client.crm.async_passthrough.create(
client.crm.async_passthrough.retrieve(...)
+## Accounting Scopes
+client.accounting.scopes.default_scopes_retrieve()
-
@@ -13201,7 +13231,7 @@ client.crm.async_passthrough.create(
-
-Retrieves data from earlier async-passthrough POST request
+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).
@@ -13222,9 +13252,7 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.crm.async_passthrough.retrieve(
- async_passthrough_receipt_id="async_passthrough_receipt_id",
-)
+client.accounting.scopes.default_scopes_retrieve()
```
@@ -13240,14 +13268,6 @@ client.crm.async_passthrough.retrieve(
-
-**async_passthrough_receipt_id:** `str`
-
-
-
-
-
--
-
**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -13260,8 +13280,7 @@ client.crm.async_passthrough.retrieve(
client.crm.audit_trail.list(...)
+client.accounting.scopes.linked_account_scopes_retrieve()
-
@@ -13273,7 +13292,7 @@ client.crm.async_passthrough.retrieve(
-
-Gets a list of audit trail events.
+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).
@@ -13294,14 +13313,7 @@ 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.scopes.linked_account_scopes_retrieve()
```
@@ -13317,47 +13329,99 @@ client.crm.audit_trail.list(
-
-**cursor:** `typing.Optional[str]` — The pagination cursor value.
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
-
--
-**end_date:** `typing.Optional[str]` — If included, will only include audit trail events that occurred before this time
-
+client.accounting.scopes.linked_account_scopes_create(...)
-
-**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`
-
-
-
+#### 📝 Description
-
-**page_size:** `typing.Optional[int]` — Number of results to return per page.
-
+
+-
+
+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
+
-
-**start_date:** `typing.Optional[str]` — If included, will only include audit trail events that occurred after this time
-
+
+-
+
+```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.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,
+ )
+ },
+ ),
+ ],
+)
+
+```
+
+
+
+#### ⚙️ Parameters
-
-**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
@@ -13377,8 +13441,8 @@ client.crm.audit_trail.list(
client.crm.available_actions.retrieve()
+## Accounting DeleteAccount
+client.accounting.delete_account.delete()
-
@@ -13390,7 +13454,7 @@ client.crm.audit_trail.list(
-
-Returns a list of models and actions available for an account.
+Delete a linked account.
@@ -13411,7 +13475,7 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.crm.available_actions.retrieve()
+client.accounting.delete_account.delete()
```
@@ -13439,8 +13503,8 @@ client.crm.available_actions.retrieve()
client.crm.contacts.list(...)
+## Accounting Employees
+client.accounting.employees.list(...)
-
@@ -13452,7 +13516,7 @@ client.crm.available_actions.retrieve()
-
-Returns a list of `Contact` objects.
+Returns a list of `Employee` objects.
@@ -13467,40 +13531,24 @@ 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.employees.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
```
@@ -13516,30 +13564,6 @@ 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.
-
-
-
-
-
--
-
-**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
-
-
-
-
-
--
-
**cursor:** `typing.Optional[str]` — The pagination cursor value.
@@ -13548,15 +13572,11 @@ 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.
-
-
-
-
-
--
-
-**expand:** `typing.Optional[ContactsListRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+**expand:** `typing.Optional[
+ typing.Union[
+ typing.Literal["company"], typing.Sequence[typing.Literal["company"]]
+ ]
+]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -13580,14 +13600,6 @@ 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.
-
-
-
-
-
--
-
**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -13596,22 +13608,6 @@ client.crm.contacts.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.
@@ -13620,22 +13616,6 @@ 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.
-
-
-
-
-
--
-
-**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
-
-
-
-
-
--
-
**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -13648,7 +13628,7 @@ client.crm.contacts.list(
client.crm.contacts.create(...)
+client.accounting.employees.retrieve(...)
-
@@ -13660,7 +13640,7 @@ client.crm.contacts.list(
-
-Creates a `Contact` object with the given values.
+Returns an `Employee` object with the given `id`.
@@ -13676,16 +13656,15 @@ Creates a `Contact` object with the given values.
```python
from merge import Merge
-from merge.resources.crm import ContactRequest
client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.crm.contacts.create(
- is_debug_mode=True,
- run_async=True,
- model=ContactRequest(),
+client.accounting.employees.retrieve(
+ id="id",
+ include_remote_data=True,
+ include_shell_data=True,
)
```
@@ -13702,7 +13681,7 @@ client.crm.contacts.create(
-
-**model:** `ContactRequest`
+**id:** `str`
@@ -13710,7 +13689,11 @@ client.crm.contacts.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[
+ typing.Literal["company"], typing.Sequence[typing.Literal["company"]]
+ ]
+]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -13718,7 +13701,15 @@ client.crm.contacts.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).
@@ -13738,7 +13729,8 @@ client.crm.contacts.create(
client.crm.contacts.retrieve(...)
+## Accounting Expenses
+client.accounting.expenses.list(...)
-
@@ -13750,7 +13742,7 @@ client.crm.contacts.create(
-
-Returns a `Contact` object with the given `id`.
+Returns a list of `Expense` objects.
@@ -13765,20 +13757,47 @@ Returns a `Contact` object with the given `id`.
-
```python
+import datetime
+
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,
+response = client.accounting.expenses.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",
+ 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",
+ transaction_date_after=datetime.datetime.fromisoformat(
+ "2024-01-15 09:30:00+00:00",
+ ),
+ transaction_date_before=datetime.datetime.fromisoformat(
+ "2024-01-15 09:30:00+00:00",
+ ),
)
+for item in response:
+ yield item
+# alternatively, you can paginate page-by-page
+for page in response.iter_pages():
+ yield page
```
@@ -13794,7 +13813,7 @@ client.crm.contacts.retrieve(
-
-**id:** `str`
+**company_id:** `typing.Optional[str]` — If provided, will only return expenses for this company.
@@ -13802,7 +13821,7 @@ client.crm.contacts.retrieve(
-
-**expand:** `typing.Optional[ContactsRetrieveRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
@@ -13810,7 +13829,7 @@ client.crm.contacts.retrieve(
-
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
+**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
@@ -13818,7 +13837,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.
+**cursor:** `typing.Optional[str]` — The pagination cursor value.
@@ -13826,7 +13845,12 @@ client.crm.contacts.retrieve(
-
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
+**expand:** `typing.Optional[
+ typing.Union[
+ ExpensesListRequestExpandItem,
+ typing.Sequence[ExpensesListRequestExpandItem],
+ ]
+]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -13834,74 +13858,55 @@ client.crm.contacts.retrieve(
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
-
-
+
+-
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
+
-client.crm.contacts.partial_update(...)
-
-#### 📝 Description
-
-
--
+**include_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.
+
+
+
-
-Updates a `Contact` object with the given `id`.
-
-
+**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
+
-#### 🔌 Usage
-
-
-
--
-
-```python
-from merge import Merge
-from merge.resources.crm import PatchedContactRequest
-
-client = Merge(
- account_token="YOUR_ACCOUNT_TOKEN",
- api_key="YOUR_API_KEY",
-)
-client.crm.contacts.partial_update(
- id="id",
- is_debug_mode=True,
- run_async=True,
- model=PatchedContactRequest(),
-)
-
-```
-
-
+**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
+
-#### ⚙️ Parameters
-
-
+**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
+
+
+
+
-
-**id:** `str`
+**page_size:** `typing.Optional[int]` — Number of results to return per page.
@@ -13909,7 +13914,7 @@ client.crm.contacts.partial_update(
-
-**model:** `PatchedContactRequest`
+**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
@@ -13917,7 +13922,7 @@ client.crm.contacts.partial_update(
-
-**is_debug_mode:** `typing.Optional[bool]` — Whether to include debug fields (such as log file links) in the response.
+**transaction_date_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
@@ -13925,7 +13930,7 @@ client.crm.contacts.partial_update(
-
-**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously.
+**transaction_date_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
@@ -13945,7 +13950,7 @@ client.crm.contacts.partial_update(
client.crm.contacts.ignore_create(...)
+client.accounting.expenses.create(...)
-
@@ -13957,7 +13962,7 @@ client.crm.contacts.partial_update(
-
-Ignores a specific row based on the `model_id` in the url. These records will have their properties set to null, and will not be updated in future syncs. The "reason" and "message" fields in the request body will be stored for audit purposes.
+Creates an `Expense` object with the given values.
@@ -13973,17 +13978,16 @@ Ignores a specific row based on the `model_id` in the url. These records will ha
```python
from merge import Merge
-from merge.resources.crm import IgnoreCommonModelRequest, ReasonEnum
+from merge.resources.accounting import ExpenseRequest
client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.crm.contacts.ignore_create(
- model_id="model_id",
- request=IgnoreCommonModelRequest(
- reason=ReasonEnum.GENERAL_CUSTOMER_REQUEST,
- ),
+client.accounting.expenses.create(
+ is_debug_mode=True,
+ run_async=True,
+ model=ExpenseRequest(),
)
```
@@ -14000,7 +14004,7 @@ client.crm.contacts.ignore_create(
-
-**model_id:** `str`
+**model:** `ExpenseRequest`
@@ -14008,7 +14012,15 @@ client.crm.contacts.ignore_create(
-
-**request:** `IgnoreCommonModelRequest`
+**is_debug_mode:** `typing.Optional[bool]` — Whether to include debug fields (such as log file links) in the response.
+
+
+
+
+
+-
+
+**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously.
@@ -14028,7 +14040,7 @@ client.crm.contacts.ignore_create(
client.crm.contacts.meta_patch_retrieve(...)
+client.accounting.expenses.retrieve(...)
-
@@ -14040,7 +14052,7 @@ client.crm.contacts.ignore_create(
-
-Returns metadata for `CRMContact` PATCHs.
+Returns an `Expense` object with the given `id`.
@@ -14061,8 +14073,11 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.crm.contacts.meta_patch_retrieve(
+client.accounting.expenses.retrieve(
id="id",
+ include_remote_data=True,
+ include_remote_fields=True,
+ include_shell_data=True,
)
```
@@ -14087,64 +14102,40 @@ client.crm.contacts.meta_patch_retrieve(
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+**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.
-
-
-
-
-
-
-client.crm.contacts.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 `CRMContact` 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.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
-
-
--
-
-
@@ -14160,7 +14151,7 @@ client.crm.contacts.meta_post_retrieve()
client.crm.contacts.remote_field_classes_list(...)
+client.accounting.expenses.lines_remote_field_classes_list(...)
-
@@ -14193,16 +14184,20 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.crm.contacts.remote_field_classes_list(
+response = client.accounting.expenses.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
```
@@ -14242,14 +14237,6 @@ 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.
-
-
-
-
-
--
-
**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -14294,8 +14281,7 @@ client.crm.contacts.remote_field_classes_list(
client.crm.custom_object_classes.list(...)
+client.accounting.expenses.meta_post_retrieve()
-
@@ -14307,7 +14293,7 @@ client.crm.contacts.remote_field_classes_list(
-
-Returns a list of `CustomObjectClass` objects.
+Returns metadata for `Expense` POSTs.
@@ -14322,34 +14308,13 @@ Returns a list of `CustomObjectClass` objects.
-
```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",
-)
+client.accounting.expenses.meta_post_retrieve()
```
@@ -14365,39 +14330,81 @@ client.crm.custom_object_classes.list(
-
-**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
-
--
-**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
-
+client.accounting.expenses.remote_field_classes_list(...)
-
-**cursor:** `typing.Optional[str]` — The pagination cursor value.
-
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a list of `RemoteFieldClass` objects.
+
+
+#### 🔌 Usage
+
-
-**expand:** `typing.Optional[typing.Literal["fields"]]` — 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",
+)
+response = client.accounting.expenses.remote_field_classes_list(
+ cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
+ include_deleted_data=True,
+ include_remote_data=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
+
+```
+
+
+#### ⚙️ Parameters
+
-
-**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
+
+-
+
+**cursor:** `typing.Optional[str]` — The pagination cursor value.
@@ -14405,7 +14412,7 @@ client.crm.custom_object_classes.list(
-
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
+**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
@@ -14413,7 +14420,7 @@ client.crm.custom_object_classes.list(
-
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -14421,7 +14428,7 @@ client.crm.custom_object_classes.list(
-
-**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
+**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -14429,7 +14436,7 @@ client.crm.custom_object_classes.list(
-
-**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
+**is_common_model_field:** `typing.Optional[bool]` — If provided, will only return remote field classes with this is_common_model_field value
@@ -14437,7 +14444,7 @@ client.crm.custom_object_classes.list(
-
-**page_size:** `typing.Optional[int]` — Number of results to return per page.
+**is_custom:** `typing.Optional[bool]` — If provided, will only return remote fields classes with this is_custom value
@@ -14445,7 +14452,7 @@ client.crm.custom_object_classes.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.
@@ -14465,7 +14472,8 @@ client.crm.custom_object_classes.list(
client.crm.custom_object_classes.retrieve(...)
+## Accounting FieldMapping
+client.accounting.field_mapping.field_mappings_retrieve(...)
-
@@ -14477,7 +14485,7 @@ client.crm.custom_object_classes.list(
-
-Returns a `CustomObjectClass` 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/).
@@ -14498,10 +14506,8 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.crm.custom_object_classes.retrieve(
- id="id",
- include_remote_data=True,
- include_shell_data=True,
+client.accounting.field_mapping.field_mappings_retrieve(
+ exclude_remote_field_metadata=True,
)
```
@@ -14518,31 +14524,7 @@ client.crm.custom_object_classes.retrieve(
-
-**id:** `str`
-
-
-
-
-
--
-
-**expand:** `typing.Optional[typing.Literal["fields"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
-
-
-
-
-
--
-
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
-
-
-
-
-
--
-
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
+**exclude_remote_field_metadata:** `typing.Optional[bool]` — If `true`, remote fields metadata is excluded from each field mapping instance (i.e. `remote_fields.remote_key_name` and `remote_fields.schema` will be null). This will increase the speed of the request since these fields require some calculations.
@@ -14562,8 +14544,7 @@ client.crm.custom_object_classes.retrieve(
client.crm.association_types.custom_object_classes_association_types_list(...)
+client.accounting.field_mapping.field_mappings_create(...)
-
@@ -14575,7 +14556,7 @@ client.crm.custom_object_classes.retrieve(
-
-Returns a list of `AssociationType` 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.
@@ -14590,34 +14571,20 @@ Returns a list of `AssociationType` objects.
-
```python
-import datetime
-
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_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.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",
)
```
@@ -14634,7 +14601,7 @@ client.crm.association_types.custom_object_classes_association_types_list(
-
-**custom_object_class_id:** `str`
+**target_field_name:** `str` — The name of the target field you want this remote field to map to.
@@ -14642,7 +14609,7 @@ client.crm.association_types.custom_object_classes_association_types_list(
-
-**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
+**target_field_description:** `str` — The description of the target field you want this remote field to map to.
@@ -14650,7 +14617,7 @@ client.crm.association_types.custom_object_classes_association_types_list(
-
-**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
+**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.
@@ -14658,7 +14625,7 @@ client.crm.association_types.custom_object_classes_association_types_list(
-
-**cursor:** `typing.Optional[str]` — The pagination cursor value.
+**remote_method:** `str` — The method of the remote endpoint where the remote field is coming from.
@@ -14666,7 +14633,7 @@ client.crm.association_types.custom_object_classes_association_types_list(
-
-**expand:** `typing.Optional[typing.Literal["target_object_classes"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+**remote_url_path:** `str` — The path of the remote endpoint where the remote field is coming from.
@@ -14674,7 +14641,7 @@ client.crm.association_types.custom_object_classes_association_types_list(
-
-**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
+**common_model_name:** `str` — The name of the Common Model that the remote field corresponds to in a given category.
@@ -14682,7 +14649,7 @@ client.crm.association_types.custom_object_classes_association_types_list(
-
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
+**exclude_remote_field_metadata:** `typing.Optional[bool]` — If `true`, remote fields metadata is excluded from each field mapping instance (i.e. `remote_fields.remote_key_name` and `remote_fields.schema` will be null). This will increase the speed of the request since these fields require some calculations.
@@ -14690,39 +14657,70 @@ client.crm.association_types.custom_object_classes_association_types_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.accounting.field_mapping.field_mappings_destroy(...)
-
-**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
-
+#### 📝 Description
+
+
+-
+
+
+-
+
+Deletes Field Mappings for a Linked Account. All data related to this Field Mapping will be deleted and these changes will be reflected after the next scheduled sync. This will cause the next sync for this Linked Account to sync **ALL** data from start.
+
+
+#### 🔌 Usage
+
-
-**page_size:** `typing.Optional[int]` — Number of results to return per page.
-
+
+-
+
+```python
+from merge import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.accounting.field_mapping.field_mappings_destroy(
+ field_mapping_id="field_mapping_id",
+)
+
+```
+
+
+#### ⚙️ Parameters
+
-
-**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
+
+-
+
+**field_mapping_id:** `str`
@@ -14742,7 +14740,7 @@ client.crm.association_types.custom_object_classes_association_types_list(
client.crm.association_types.custom_object_classes_association_types_create(...)
+client.accounting.field_mapping.field_mappings_partial_update(...)
-
@@ -14754,7 +14752,7 @@ client.crm.association_types.custom_object_classes_association_types_list(
-
-Creates an `AssociationType` object with the given values.
+Create or update existing Field Mappings for a Linked Account. Changes will be reflected after the next scheduled sync. This will cause the next sync for this Linked Account to sync **ALL** data from start.
@@ -14770,33 +14768,13 @@ Creates an `AssociationType` object with the given values.
```python
from merge import Merge
-from merge.resources.crm import (
- AssociationTypeRequestRequest,
- ObjectClassDescriptionRequest,
- OriginTypeEnum,
-)
client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.crm.association_types.custom_object_classes_association_types_create(
- custom_object_class_id="custom_object_class_id",
- 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",
- ),
+client.accounting.field_mapping.field_mappings_partial_update(
+ field_mapping_id="field_mapping_id",
)
```
@@ -14813,7 +14791,7 @@ client.crm.association_types.custom_object_classes_association_types_create(
-
-**custom_object_class_id:** `str`
+**field_mapping_id:** `str`
@@ -14821,7 +14799,7 @@ client.crm.association_types.custom_object_classes_association_types_create(
-
-**model:** `AssociationTypeRequestRequest`
+**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.
@@ -14829,7 +14807,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.
+**remote_method:** `typing.Optional[str]` — The method of the remote endpoint where the remote field is coming from.
@@ -14837,7 +14815,7 @@ 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.
+**remote_url_path:** `typing.Optional[str]` — The path of the remote endpoint where the remote field is coming from.
@@ -14857,7 +14835,7 @@ client.crm.association_types.custom_object_classes_association_types_create(
client.crm.association_types.custom_object_classes_association_types_retrieve(...)
+client.accounting.field_mapping.remote_fields_retrieve(...)
-
@@ -14869,7 +14847,7 @@ client.crm.association_types.custom_object_classes_association_types_create(
-
-Returns an `AssociationType` object with the given `id`.
+Get all remote fields for a Linked Account. Remote fields are third-party fields that are accessible after initial sync if remote_data is enabled. You can use remote fields to override existing Merge fields or map a new Merge field. [Learn more](https://docs.merge.dev/supplemental-data/field-mappings/overview/).
@@ -14890,11 +14868,9 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.crm.association_types.custom_object_classes_association_types_retrieve(
- custom_object_class_id="custom_object_class_id",
- id="id",
- include_remote_data=True,
- include_shell_data=True,
+client.accounting.field_mapping.remote_fields_retrieve(
+ common_models="common_models",
+ include_example_values="include_example_values",
)
```
@@ -14911,31 +14887,7 @@ client.crm.association_types.custom_object_classes_association_types_retrieve(
-
-**custom_object_class_id:** `str`
-
-
-
-
-
--
-
-**id:** `str`
-
-
-
-
-
--
-
-**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.
+**common_models:** `typing.Optional[str]` — A comma seperated list of Common Model names. If included, will only return Remote Fields for those Common Models.
@@ -14943,7 +14895,7 @@ client.crm.association_types.custom_object_classes_association_types_retrieve(
-
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
+**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.
@@ -14963,7 +14915,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.field_mapping.target_fields_retrieve()
-
@@ -14975,7 +14927,7 @@ client.crm.association_types.custom_object_classes_association_types_retrieve(
-
-Returns metadata for `CRMAssociationType` 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/).
@@ -14996,9 +14948,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.field_mapping.target_fields_retrieve()
```
@@ -15014,14 +14964,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.
@@ -15034,8 +14976,8 @@ client.crm.association_types.custom_object_classes_association_types_meta_post_r
client.crm.custom_objects.custom_object_classes_custom_objects_list(...)
+## Accounting GeneralLedgerTransactions
+client.accounting.general_ledger_transactions.list(...)
-
@@ -15047,7 +14989,7 @@ client.crm.association_types.custom_object_classes_association_types_meta_post_r
-
-Returns a list of `CustomObject` objects.
+Returns a list of `GeneralLedgerTransaction` objects.
@@ -15070,8 +15012,8 @@ 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",
+response = client.accounting.general_ledger_transactions.list(
+ company_id="company_id",
created_after=datetime.datetime.fromisoformat(
"2024-01-15 09:30:00+00:00",
),
@@ -15081,7 +15023,6 @@ client.crm.custom_objects.custom_object_classes_custom_objects_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",
@@ -15090,8 +15031,19 @@ client.crm.custom_objects.custom_object_classes_custom_objects_list(
"2024-01-15 09:30:00+00:00",
),
page_size=1,
+ posted_date_after=datetime.datetime.fromisoformat(
+ "2024-01-15 09:30:00+00:00",
+ ),
+ posted_date_before=datetime.datetime.fromisoformat(
+ "2024-01-15 09:30:00+00:00",
+ ),
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
```
@@ -15107,7 +15059,7 @@ client.crm.custom_objects.custom_object_classes_custom_objects_list(
-
-**custom_object_class_id:** `str`
+**company_id:** `typing.Optional[str]` — If provided, will only return general ledger transactions for this company.
@@ -15139,7 +15091,12 @@ client.crm.custom_objects.custom_object_classes_custom_objects_list(
-
-**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
+**expand:** `typing.Optional[
+ typing.Union[
+ GeneralLedgerTransactionsListRequestExpandItem,
+ typing.Sequence[GeneralLedgerTransactionsListRequestExpandItem],
+ ]
+]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -15147,7 +15104,7 @@ client.crm.custom_objects.custom_object_classes_custom_objects_list(
-
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
+**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
@@ -15155,7 +15112,7 @@ client.crm.custom_objects.custom_object_classes_custom_objects_list(
-
-**include_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -15195,6 +15152,22 @@ client.crm.custom_objects.custom_object_classes_custom_objects_list(
-
+**posted_date_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects posted after this datetime.
+
+
+
+
+
+-
+
+**posted_date_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects posted before this datetime.
+
+
+
+
+
+-
+
**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
@@ -15215,7 +15188,7 @@ client.crm.custom_objects.custom_object_classes_custom_objects_list(
client.crm.custom_objects.custom_object_classes_custom_objects_create(...)
+client.accounting.general_ledger_transactions.retrieve(...)
-
@@ -15227,7 +15200,7 @@ client.crm.custom_objects.custom_object_classes_custom_objects_list(
-
-Creates a `CustomObject` object with the given values.
+Returns a `GeneralLedgerTransaction` object with the given `id`.
@@ -15243,19 +15216,15 @@ 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.general_ledger_transactions.retrieve(
+ id="id",
+ include_remote_data=True,
+ include_shell_data=True,
)
```
@@ -15272,7 +15241,7 @@ client.crm.custom_objects.custom_object_classes_custom_objects_create(
-
-**custom_object_class_id:** `str`
+**id:** `str`
@@ -15280,7 +15249,12 @@ client.crm.custom_objects.custom_object_classes_custom_objects_create(
-
-**model:** `CustomObjectRequest`
+**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.
@@ -15288,7 +15262,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.
@@ -15296,7 +15270,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).
@@ -15316,7 +15290,8 @@ client.crm.custom_objects.custom_object_classes_custom_objects_create(
client.crm.custom_objects.custom_object_classes_custom_objects_retrieve(...)
+## Accounting GenerateKey
+client.accounting.generate_key.create(...)
-
@@ -15328,7 +15303,7 @@ client.crm.custom_objects.custom_object_classes_custom_objects_create(
-
-Returns a `CustomObject` object with the given `id`.
+Create a remote key.
@@ -15349,12 +15324,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.generate_key.create(
+ name="Remote Deployment Key 1",
)
```
@@ -15371,7 +15342,7 @@ client.crm.custom_objects.custom_object_classes_custom_objects_retrieve(
-
-**custom_object_class_id:** `str`
+**name:** `str` — The name of the remote key
@@ -15379,31 +15350,96 @@ client.crm.custom_objects.custom_object_classes_custom_objects_retrieve(
-
-**id:** `str`
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+client.accounting.income_statements.list(...)
-
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
-
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a list of `IncomeStatement` objects.
+
+
+#### 🔌 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
+import datetime
+
+from merge import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+response = client.accounting.income_statements.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",
+ 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
+
+```
+
+
+
+#### ⚙️ Parameters
-
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
+
+-
+
+**company_id:** `typing.Optional[str]` — If provided, will only return income statements for this company.
@@ -15411,70 +15447,91 @@ client.crm.custom_objects.custom_object_classes_custom_objects_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.custom_objects.custom_object_classes_custom_objects_meta_post_retrieve(...)
-
-#### 📝 Description
+**cursor:** `typing.Optional[str]` — The pagination cursor value.
+
+
+
-
+**expand:** `typing.Optional[
+ typing.Union[
+ typing.Literal["company"], typing.Sequence[typing.Literal["company"]]
+ ]
+]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+
+
+
+
-
-Returns metadata for `CRMCustomObject` POSTs.
-
-
+**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
+
-#### 🔌 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.crm.custom_objects.custom_object_classes_custom_objects_meta_post_retrieve(
- custom_object_class_id="custom_object_class_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.
+
+
+
+
-
-**custom_object_class_id:** `str`
+**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
@@ -15494,7 +15551,7 @@ 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(...)
+client.accounting.income_statements.retrieve(...)
-
@@ -15506,7 +15563,7 @@ client.crm.custom_objects.custom_object_classes_custom_objects_meta_post_retriev
-
-Returns a list of `RemoteFieldClass` objects.
+Returns an `IncomeStatement` object with the given `id`.
@@ -15527,15 +15584,10 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.crm.custom_objects.custom_object_classes_custom_objects_remote_field_classes_list(
- cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
- include_deleted_data=True,
+client.accounting.income_statements.retrieve(
+ id="id",
include_remote_data=True,
- include_remote_fields=True,
include_shell_data=True,
- is_common_model_field=True,
- is_custom=True,
- page_size=1,
)
```
@@ -15552,7 +15604,7 @@ client.crm.custom_objects.custom_object_classes_custom_objects_remote_field_clas
-
-**cursor:** `typing.Optional[str]` — The pagination cursor value.
+**id:** `str`
@@ -15560,7 +15612,11 @@ 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/).
+**expand:** `typing.Optional[
+ typing.Union[
+ typing.Literal["company"], typing.Sequence[typing.Literal["company"]]
+ ]
+]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -15576,14 +15632,6 @@ 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.
-
-
-
-
-
--
-
**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -15592,30 +15640,6 @@ 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
-
-
-
-
-
--
-
-**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.
@@ -15628,8 +15652,8 @@ client.crm.custom_objects.custom_object_classes_custom_objects_remote_field_clas
client.crm.associations.custom_object_classes_custom_objects_associations_list(...)
+## Accounting Invoices
+client.accounting.invoices.list(...)
-
@@ -15641,7 +15665,7 @@ client.crm.custom_objects.custom_object_classes_custom_objects_remote_field_clas
-
-Returns a list of `Association` objects.
+Returns a list of `Invoice` objects.
@@ -15659,15 +15683,18 @@ Returns a list of `Association` objects.
import datetime
from merge import Merge
+from merge.resources.accounting.resources.invoices import (
+ InvoicesListRequestStatus,
+ InvoicesListRequestType,
+)
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",
+response = client.accounting.invoices.list(
+ company_id="company_id",
+ contact_id="contact_id",
created_after=datetime.datetime.fromisoformat(
"2024-01-15 09:30:00+00:00",
),
@@ -15677,16 +15704,31 @@ client.crm.associations.custom_object_classes_custom_objects_associations_list(
cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
include_deleted_data=True,
include_remote_data=True,
+ include_remote_fields=True,
include_shell_data=True,
+ issue_date_after=datetime.datetime.fromisoformat(
+ "2024-01-15 09:30:00+00:00",
+ ),
+ issue_date_before=datetime.datetime.fromisoformat(
+ "2024-01-15 09:30:00+00:00",
+ ),
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",
),
+ number="number",
page_size=1,
remote_id="remote_id",
+ status=InvoicesListRequestStatus.DRAFT,
+ type=InvoicesListRequestType.ACCOUNTS_PAYABLE,
)
+for item in response:
+ yield item
+# alternatively, you can paginate page-by-page
+for page in response.iter_pages():
+ yield page
```
@@ -15702,15 +15744,7 @@ client.crm.associations.custom_object_classes_custom_objects_associations_list(
-
-**custom_object_class_id:** `str`
-
-
-
-
-
--
-
-**object_id:** `str`
+**company_id:** `typing.Optional[str]` — If provided, will only return invoices for this company.
@@ -15718,7 +15752,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.
+**contact_id:** `typing.Optional[str]` — If provided, will only return invoices for this contact.
@@ -15750,7 +15784,12 @@ 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.
+**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.
@@ -15774,7 +15813,7 @@ client.crm.associations.custom_object_classes_custom_objects_associations_list(
-
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
+**include_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.
@@ -15782,7 +15821,7 @@ client.crm.associations.custom_object_classes_custom_objects_associations_list(
-
-**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
+**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -15790,7 +15829,7 @@ client.crm.associations.custom_object_classes_custom_objects_associations_list(
-
-**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
+**issue_date_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
@@ -15798,7 +15837,7 @@ client.crm.associations.custom_object_classes_custom_objects_associations_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.
@@ -15806,7 +15845,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.
+**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
@@ -15814,76 +15853,31 @@ client.crm.associations.custom_object_classes_custom_objects_associations_list(
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
-
-
-
-
-
-
-client.crm.associations.custom_object_classes_custom_objects_associations_update(...)
-
-#### 📝 Description
-
-
--
-
-
--
-
-Creates an Association between `source_object_id` and `target_object_id` of type `association_type_id`.
-
-
+**number:** `typing.Optional[str]` — If provided, will only return Invoices with this number.
+
-#### 🔌 Usage
-
-
--
-
-
-```python
-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_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,
-)
-
-```
-
-
+**page_size:** `typing.Optional[int]` — Number of results to return per page.
+
-#### ⚙️ Parameters
-
-
--
-
-
-**source_class_id:** `str`
+**remote_fields:** `typing.Optional[typing.Literal["type"]]` — Deprecated. Use show_enum_origins.
@@ -15891,7 +15885,7 @@ client.crm.associations.custom_object_classes_custom_objects_associations_update
-
-**source_object_id:** `str`
+**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
@@ -15899,7 +15893,7 @@ client.crm.associations.custom_object_classes_custom_objects_associations_update
-
-**target_class_id:** `str`
+**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)
@@ -15907,15 +15901,16 @@ client.crm.associations.custom_object_classes_custom_objects_associations_update
-
-**target_object_id:** `str`
-
-
-
+**status:** `typing.Optional[InvoicesListRequestStatus]`
-
--
+If provided, will only return Invoices with this status.
-**association_type_id:** `str`
+* `PAID` - PAID
+* `DRAFT` - DRAFT
+* `SUBMITTED` - SUBMITTED
+* `PARTIALLY_PAID` - PARTIALLY_PAID
+* `OPEN` - OPEN
+* `VOID` - VOID
@@ -15923,15 +15918,12 @@ 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.
-
-
-
+**type:** `typing.Optional[InvoicesListRequestType]`
-
--
+If provided, will only return Invoices with this type.
-**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously.
+* `ACCOUNTS_RECEIVABLE` - ACCOUNTS_RECEIVABLE
+* `ACCOUNTS_PAYABLE` - ACCOUNTS_PAYABLE
@@ -15951,8 +15943,7 @@ client.crm.associations.custom_object_classes_custom_objects_associations_update
client.crm.scopes.default_scopes_retrieve()
+client.accounting.invoices.create(...)
-
@@ -15964,7 +15955,9 @@ 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).
+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).
+
@@ -15980,12 +15973,17 @@ Get the default permissions for Merge Common Models and fields across all Linked
```python
from merge import Merge
+from merge.resources.accounting import InvoiceRequest
client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.crm.scopes.default_scopes_retrieve()
+client.accounting.invoices.create(
+ is_debug_mode=True,
+ run_async=True,
+ model=InvoiceRequest(),
+)
```
@@ -16001,6 +15999,30 @@ client.crm.scopes.default_scopes_retrieve()
-
+**model:** `InvoiceRequest`
+
+
+
+
+
+-
+
+**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.
@@ -16013,7 +16035,7 @@ client.crm.scopes.default_scopes_retrieve()
client.crm.scopes.linked_account_scopes_retrieve()
+client.accounting.invoices.retrieve(...)
-
@@ -16025,7 +16047,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 an `Invoice` object with the given `id`.
@@ -16046,7 +16068,12 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.crm.scopes.linked_account_scopes_retrieve()
+client.accounting.invoices.retrieve(
+ id="id",
+ include_remote_data=True,
+ include_remote_fields=True,
+ include_shell_data=True,
+)
```
@@ -16062,99 +16089,60 @@ client.crm.scopes.linked_account_scopes_retrieve()
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+**id:** `str`
-
-
+
+-
+**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.
+
-client.crm.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_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
-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,
- )
- },
- ),
- ],
-)
-
-```
-
-
+**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
+
-#### ⚙️ Parameters
-
-
+**remote_fields:** `typing.Optional[typing.Literal["type"]]` — Deprecated. Use show_enum_origins.
+
+
+
+
-
-**common_models:** `typing.Sequence[IndividualCommonModelScopeDeserializerRequest]` — The common models you want to update the scopes for
+**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)
@@ -16174,8 +16162,7 @@ client.crm.scopes.linked_account_scopes_create(
client.crm.delete_account.delete()
+client.accounting.invoices.partial_update(...)
-
@@ -16187,7 +16174,7 @@ client.crm.scopes.linked_account_scopes_create(
-
-Delete a linked account.
+Updates an `Invoice` object with the given `id`.
@@ -16203,12 +16190,18 @@ Delete a linked account.
```python
from merge import Merge
+from merge.resources.accounting import InvoiceRequest
client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.crm.delete_account.delete()
+client.accounting.invoices.partial_update(
+ id="id",
+ is_debug_mode=True,
+ run_async=True,
+ model=InvoiceRequest(),
+)
```
@@ -16224,6 +16217,38 @@ client.crm.delete_account.delete()
-
+**id:** `str`
+
+
+
+
+
+-
+
+**model:** `InvoiceRequest`
+
+
+
+
+
+-
+
+**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.
@@ -16236,8 +16261,7 @@ client.crm.delete_account.delete()
client.crm.engagement_types.list(...)
+client.accounting.invoices.line_items_remote_field_classes_list(...)
-
@@ -16249,7 +16273,7 @@ client.crm.delete_account.delete()
-
-Returns a list of `EngagementType` objects.
+Returns a list of `RemoteFieldClass` objects.
@@ -16264,35 +16288,26 @@ 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",
- ),
+response = client.accounting.invoices.line_items_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",
- ),
+ is_common_model_field=True,
+ is_custom=True,
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
```
@@ -16308,22 +16323,6 @@ client.crm.engagement_types.list(
-
-**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
-
-
-
-
-
--
-
-**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
-
-
-
-
-
--
-
**cursor:** `typing.Optional[str]` — The pagination cursor value.
@@ -16348,14 +16347,6 @@ client.crm.engagement_types.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).
@@ -16364,7 +16355,7 @@ client.crm.engagement_types.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
@@ -16372,7 +16363,7 @@ client.crm.engagement_types.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
@@ -16388,14 +16379,6 @@ client.crm.engagement_types.list(
-
-**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
-
-
-
-
-
--
-
**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -16408,7 +16391,7 @@ client.crm.engagement_types.list(
client.crm.engagement_types.retrieve(...)
+client.accounting.invoices.meta_patch_retrieve(...)
-
@@ -16420,7 +16403,7 @@ client.crm.engagement_types.list(
-
-Returns an `EngagementType` object with the given `id`.
+Returns metadata for `Invoice` PATCHs.
@@ -16441,11 +16424,8 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.crm.engagement_types.retrieve(
+client.accounting.invoices.meta_patch_retrieve(
id="id",
- include_remote_data=True,
- include_remote_fields=True,
- include_shell_data=True,
)
```
@@ -16470,27 +16450,64 @@ client.crm.engagement_types.retrieve(
-
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+client.accounting.invoices.meta_post_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
+
+
+-
+
+
+-
+
+Returns metadata for `Invoice` POSTs.
+
+
+#### 🔌 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.accounting.invoices.meta_post_retrieve()
+
+```
+
+
+#### ⚙️ Parameters
+
+
+-
+
-
@@ -16506,7 +16523,7 @@ client.crm.engagement_types.retrieve(
client.crm.engagement_types.remote_field_classes_list(...)
+client.accounting.invoices.remote_field_classes_list(...)
-
@@ -16539,16 +16556,20 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.crm.engagement_types.remote_field_classes_list(
+response = client.accounting.invoices.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
```
@@ -16588,14 +16609,6 @@ 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).
@@ -16640,8 +16653,8 @@ client.crm.engagement_types.remote_field_classes_list(
client.crm.engagements.list(...)
+## Accounting Issues
+client.accounting.issues.list(...)
-
@@ -16653,7 +16666,7 @@ client.crm.engagement_types.remote_field_classes_list(
-
-Returns a list of `Engagement` objects.
+Gets all issues for Organization.
@@ -16671,42 +16684,41 @@ Returns a list of `Engagement` objects.
import datetime
from merge import Merge
-from merge.resources.crm.resources.engagements import (
- EngagementsListRequestExpand,
-)
+from merge.resources.accounting.resources.issues import IssuesListRequestStatus
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",
- ),
+response = client.accounting.issues.list(
+ account_token="account_token",
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(
+ 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",
),
- modified_before=datetime.datetime.fromisoformat(
+ first_incident_time_before=datetime.datetime.fromisoformat(
"2024-01-15 09:30:00+00:00",
),
- page_size=1,
- remote_id="remote_id",
- started_after=datetime.datetime.fromisoformat(
+ include_muted="include_muted",
+ integration_name="integration_name",
+ last_incident_time_after=datetime.datetime.fromisoformat(
"2024-01-15 09:30:00+00:00",
),
- started_before=datetime.datetime.fromisoformat(
+ last_incident_time_before=datetime.datetime.fromisoformat(
"2024-01-15 09:30:00+00:00",
),
+ linked_account_id="linked_account_id",
+ page_size=1,
+ 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
```
@@ -16722,7 +16734,7 @@ client.crm.engagements.list(
-
-**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
+**account_token:** `typing.Optional[str]`
@@ -16730,7 +16742,7 @@ client.crm.engagements.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.
@@ -16738,7 +16750,7 @@ client.crm.engagements.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
@@ -16746,7 +16758,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.
+**end_user_organization_name:** `typing.Optional[str]`
@@ -16754,7 +16766,7 @@ client.crm.engagements.list(
-
-**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
+**first_incident_time_after:** `typing.Optional[dt.datetime]` — If provided, will only return issues whose first incident time was after this datetime.
@@ -16762,7 +16774,7 @@ client.crm.engagements.list(
-
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
+**first_incident_time_before:** `typing.Optional[dt.datetime]` — If provided, will only return issues whose first incident time was before this datetime.
@@ -16770,7 +16782,7 @@ client.crm.engagements.list(
-
-**include_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.
+**include_muted:** `typing.Optional[str]` — If true, will include muted issues
@@ -16778,7 +16790,7 @@ client.crm.engagements.list(
-
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
+**integration_name:** `typing.Optional[str]`
@@ -16786,7 +16798,7 @@ client.crm.engagements.list(
-
-**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
+**last_incident_time_after:** `typing.Optional[dt.datetime]` — If provided, will only return issues whose last incident time was after this datetime.
@@ -16794,7 +16806,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.
+**last_incident_time_before:** `typing.Optional[dt.datetime]` — If provided, will only return issues whose last incident time was before this datetime.
@@ -16802,7 +16814,7 @@ client.crm.engagements.list(
-
-**page_size:** `typing.Optional[int]` — Number of results to return per page.
+**linked_account_id:** `typing.Optional[str]` — If provided, will only include issues pertaining to the linked account passed in.
@@ -16810,7 +16822,7 @@ client.crm.engagements.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.
@@ -16818,7 +16830,7 @@ client.crm.engagements.list(
-
-**started_after:** `typing.Optional[dt.datetime]` — If provided, will only return engagements started after this datetime.
+**start_date:** `typing.Optional[str]` — If included, will only include issues whose most recent action occurred after this time
@@ -16826,7 +16838,12 @@ client.crm.engagements.list(
-
-**started_before:** `typing.Optional[dt.datetime]` — If provided, will only return engagements started before this datetime.
+**status:** `typing.Optional[IssuesListRequestStatus]`
+
+Status of the issue. Options: ('ONGOING', 'RESOLVED')
+
+* `ONGOING` - ONGOING
+* `RESOLVED` - RESOLVED
@@ -16846,7 +16863,7 @@ client.crm.engagements.list(
client.crm.engagements.create(...)
+client.accounting.issues.retrieve(...)
-
@@ -16858,7 +16875,7 @@ client.crm.engagements.list(
-
-Creates an `Engagement` object with the given values.
+Get a specific issue.
@@ -16874,16 +16891,13 @@ Creates an `Engagement` object with the given values.
```python
from merge import Merge
-from merge.resources.crm import EngagementRequest
client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.crm.engagements.create(
- is_debug_mode=True,
- run_async=True,
- model=EngagementRequest(),
+client.accounting.issues.retrieve(
+ id="id",
)
```
@@ -16900,23 +16914,7 @@ client.crm.engagements.create(
-
-**model:** `EngagementRequest`
-
-
-
-
-
--
-
-**is_debug_mode:** `typing.Optional[bool]` — Whether to include debug fields (such as log file links) in the response.
-
-
-
-
-
--
-
-**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously.
+**id:** `str`
@@ -16936,7 +16934,8 @@ client.crm.engagements.create(
client.crm.engagements.retrieve(...)
+## Accounting Items
+client.accounting.items.list(...)
-
@@ -16948,7 +16947,7 @@ client.crm.engagements.create(
-
-Returns an `Engagement` object with the given `id`.
+Returns a list of `Item` objects.
@@ -16963,22 +16962,40 @@ Returns an `Engagement` object with the given `id`.
-
```python
+import datetime
+
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(
- id="id",
- expand=EngagementsRetrieveRequestExpand.ACCOUNT,
+response = client.accounting.items.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",
+ 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
```
@@ -16994,7 +17011,7 @@ client.crm.engagements.retrieve(
-
-**id:** `str`
+**company_id:** `typing.Optional[str]` — If provided, will only return items for this company.
@@ -17002,7 +17019,7 @@ client.crm.engagements.retrieve(
-
-**expand:** `typing.Optional[EngagementsRetrieveRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
@@ -17010,7 +17027,7 @@ client.crm.engagements.retrieve(
-
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
+**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
@@ -17018,7 +17035,35 @@ 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.
+**cursor:** `typing.Optional[str]` — The pagination cursor value.
+
+
+
+
+
+-
+
+**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/).
+
+
+
+
+
+-
+
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -17034,6 +17079,54 @@ client.crm.engagements.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_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)
+
+
+
+
+
+-
+
**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -17046,7 +17139,7 @@ client.crm.engagements.retrieve(
client.crm.engagements.partial_update(...)
+client.accounting.items.create(...)
-
@@ -17058,7 +17151,7 @@ client.crm.engagements.retrieve(
-
-Updates an `Engagement` object with the given `id`.
+Creates an `Item` object with the given values.
@@ -17074,17 +17167,16 @@ Updates an `Engagement` object with the given `id`.
```python
from merge import Merge
-from merge.resources.crm import PatchedEngagementRequest
+from merge.resources.accounting import ItemRequestRequest
client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.crm.engagements.partial_update(
- id="id",
+client.accounting.items.create(
is_debug_mode=True,
run_async=True,
- model=PatchedEngagementRequest(),
+ model=ItemRequestRequest(),
)
```
@@ -17101,15 +17193,7 @@ client.crm.engagements.partial_update(
-
-**id:** `str`
-
-
-
-
-
--
-
-**model:** `PatchedEngagementRequest`
+**model:** `ItemRequestRequest`
@@ -17145,7 +17229,7 @@ client.crm.engagements.partial_update(
client.crm.engagements.meta_patch_retrieve(...)
+client.accounting.items.retrieve(...)
-
@@ -17157,7 +17241,7 @@ client.crm.engagements.partial_update(
-
-Returns metadata for `Engagement` PATCHs.
+Returns an `Item` object with the given `id`.
@@ -17178,8 +17262,10 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.crm.engagements.meta_patch_retrieve(
+client.accounting.items.retrieve(
id="id",
+ include_remote_data=True,
+ include_shell_data=True,
)
```
@@ -17204,64 +17290,48 @@ client.crm.engagements.meta_patch_retrieve(
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+**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.
+
-client.crm.engagements.meta_post_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 `Engagement` POSTs.
-
-
+**remote_fields:** `typing.Optional[typing.Literal["status"]]` — Deprecated. Use show_enum_origins.
+
-#### 🔌 Usage
-
-
--
-
-
-```python
-from merge import Merge
-
-client = Merge(
- account_token="YOUR_ACCOUNT_TOKEN",
- api_key="YOUR_API_KEY",
-)
-client.crm.engagements.meta_post_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)
+
-#### ⚙️ Parameters
-
-
--
-
-
@@ -17277,7 +17347,7 @@ client.crm.engagements.meta_post_retrieve()
client.crm.engagements.remote_field_classes_list(...)
+client.accounting.items.partial_update(...)
-
@@ -17289,7 +17359,7 @@ client.crm.engagements.meta_post_retrieve()
-
-Returns a list of `RemoteFieldClass` objects.
+Updates an `Item` object with the given `id`.
@@ -17305,20 +17375,17 @@ Returns a list of `RemoteFieldClass` objects.
```python
from merge import Merge
+from merge.resources.accounting import PatchedItemRequestRequest
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.items.partial_update(
+ id="id",
+ is_debug_mode=True,
+ run_async=True,
+ model=PatchedItemRequestRequest(),
)
```
@@ -17335,39 +17402,7 @@ client.crm.engagements.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`
@@ -17375,7 +17410,7 @@ 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
+**model:** `PatchedItemRequestRequest`
@@ -17383,7 +17418,7 @@ client.crm.engagements.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.
@@ -17391,7 +17426,7 @@ client.crm.engagements.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.
@@ -17411,8 +17446,7 @@ client.crm.engagements.remote_field_classes_list(
client.crm.field_mapping.field_mappings_retrieve(...)
+client.accounting.items.meta_patch_retrieve(...)
-
@@ -17424,7 +17458,7 @@ client.crm.engagements.remote_field_classes_list(
-
-Get all Field Mappings for this Linked Account. Field Mappings are mappings between third-party Remote Fields and user defined Merge fields. [Learn more](https://docs.merge.dev/supplemental-data/field-mappings/overview/).
+Returns metadata for `Item` PATCHs.
@@ -17445,8 +17479,8 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.crm.field_mapping.field_mappings_retrieve(
- exclude_remote_field_metadata=True,
+client.accounting.items.meta_patch_retrieve(
+ id="id",
)
```
@@ -17463,7 +17497,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.
+**id:** `str`
@@ -17483,7 +17517,7 @@ client.crm.field_mapping.field_mappings_retrieve(
client.crm.field_mapping.field_mappings_create(...)
+client.accounting.items.meta_post_retrieve()
-
@@ -17495,7 +17529,7 @@ client.crm.field_mapping.field_mappings_retrieve(
-
-Create new Field Mappings that will be available after the next scheduled sync. This will cause the next sync for this Linked Account to sync **ALL** data from start.
+Returns metadata for `Item` POSTs.
@@ -17516,15 +17550,7 @@ 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",
-)
+client.accounting.items.meta_post_retrieve()
```
@@ -17540,62 +17566,6 @@ client.crm.field_mapping.field_mappings_create(
-
-**target_field_name:** `str` — The name of the target field you want this remote field to map to.
-
-
-
-
-
--
-
-**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.
-
-
-
-
-
--
-
**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -17608,7 +17578,8 @@ client.crm.field_mapping.field_mappings_create(
client.crm.field_mapping.field_mappings_destroy(...)
+## Accounting JournalEntries
+client.accounting.journal_entries.list(...)
-
@@ -17620,7 +17591,7 @@ client.crm.field_mapping.field_mappings_create(
-
-Deletes Field Mappings for a Linked Account. All data related to this Field Mapping will be deleted and these changes will be reflected after the next scheduled sync. This will cause the next sync for this Linked Account to sync **ALL** data from start.
+Returns a list of `JournalEntry` objects.
@@ -17635,15 +17606,47 @@ Deletes Field Mappings for a Linked Account. All data related to this Field Mapp
-
```python
+import datetime
+
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",
+response = client.accounting.journal_entries.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",
+ 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",
+ transaction_date_after=datetime.datetime.fromisoformat(
+ "2024-01-15 09:30:00+00:00",
+ ),
+ transaction_date_before=datetime.datetime.fromisoformat(
+ "2024-01-15 09:30:00+00:00",
+ ),
)
+for item in response:
+ yield item
+# alternatively, you can paginate page-by-page
+for page in response.iter_pages():
+ yield page
```
@@ -17659,7 +17662,7 @@ client.crm.field_mapping.field_mappings_destroy(
-
-**field_mapping_id:** `str`
+**company_id:** `typing.Optional[str]` — If provided, will only return journal entries for this company.
@@ -17667,70 +17670,92 @@ client.crm.field_mapping.field_mappings_destroy(
-
-**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_partial_update(...)
-
-#### 📝 Description
+**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.
+
+
+
+
-
-Create or update existing Field Mappings for a Linked Account. Changes will be reflected after the next scheduled sync. This will cause the next sync for this Linked Account to sync **ALL** data from start.
-
-
+**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
+
-#### 🔌 Usage
-
-
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
+
+
+
+
-
-```python
-from merge import Merge
+**include_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.
+
+
+
-client = Merge(
- account_token="YOUR_ACCOUNT_TOKEN",
- api_key="YOUR_API_KEY",
-)
-client.crm.field_mapping.field_mappings_partial_update(
- field_mapping_id="field_mapping_id",
-)
+
+-
-```
+**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
+
+
+
+-
+
+**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
+
-#### ⚙️ Parameters
-
-
+**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
+
+
+
+
-
-**field_mapping_id:** `str`
+**page_size:** `typing.Optional[int]` — Number of results to return per page.
@@ -17738,7 +17763,7 @@ client.crm.field_mapping.field_mappings_partial_update(
-
-**remote_field_traversal_path:** `typing.Optional[typing.Sequence[typing.Optional[typing.Any]]]` — The field traversal path of the remote field listed when you hit the GET /remote-fields endpoint.
+**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
@@ -17746,7 +17771,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.
+**transaction_date_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
@@ -17754,7 +17779,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.
+**transaction_date_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
@@ -17774,7 +17799,7 @@ client.crm.field_mapping.field_mappings_partial_update(
client.crm.field_mapping.remote_fields_retrieve(...)
+client.accounting.journal_entries.create(...)
-
@@ -17786,7 +17811,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/).
+Creates a `JournalEntry` object with the given values.
@@ -17802,14 +17827,16 @@ Get all remote fields for a Linked Account. Remote fields are third-party fields
```python
from merge import Merge
+from merge.resources.accounting import JournalEntryRequest
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.journal_entries.create(
+ is_debug_mode=True,
+ run_async=True,
+ model=JournalEntryRequest(),
)
```
@@ -17826,7 +17853,7 @@ 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.
+**model:** `JournalEntryRequest`
@@ -17834,7 +17861,15 @@ client.crm.field_mapping.remote_fields_retrieve(
-
-**include_example_values:** `typing.Optional[str]` — If true, will include example values, where available, for remote fields in the 3rd party platform. These examples come from active data from your customers.
+**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.
@@ -17854,7 +17889,7 @@ client.crm.field_mapping.remote_fields_retrieve(
client.crm.field_mapping.target_fields_retrieve()
+client.accounting.journal_entries.retrieve(...)
-
@@ -17866,7 +17901,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 `JournalEntry` object with the given `id`.
@@ -17887,7 +17922,12 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.crm.field_mapping.target_fields_retrieve()
+client.accounting.journal_entries.retrieve(
+ id="id",
+ include_remote_data=True,
+ include_remote_fields=True,
+ include_shell_data=True,
+)
```
@@ -17903,71 +17943,44 @@ client.crm.field_mapping.target_fields_retrieve()
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+**id:** `str`
-
-
-
-
-
-
-client.crm.generate_key.create(...)
-
-#### 📝 Description
-
-
--
+**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.
+
+
+
-
-Create a remote key.
-
-
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
+
-#### 🔌 Usage
-
-
--
-
-
-```python
-from merge import Merge
-
-client = Merge(
- account_token="YOUR_ACCOUNT_TOKEN",
- api_key="YOUR_API_KEY",
-)
-client.crm.generate_key.create(
- name="Remote Deployment Key 1",
-)
-
-```
-
-
+**include_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.
+
-#### ⚙️ Parameters
-
-
--
-
-
-**name:** `str` — The name of the remote key
+**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -17987,8 +18000,7 @@ client.crm.generate_key.create(
client.crm.issues.list(...)
+client.accounting.journal_entries.lines_remote_field_classes_list(...)
-
@@ -18000,7 +18012,7 @@ client.crm.generate_key.create(
-
-Gets all issues for Organization.
+Returns a list of `RemoteFieldClass` objects.
@@ -18015,39 +18027,26 @@ 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",
+response = client.accounting.journal_entries.lines_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",
+ include_deleted_data=True,
+ include_remote_data=True,
+ include_shell_data=True,
+ is_common_model_field=True,
+ is_custom=True,
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
```
@@ -18063,7 +18062,7 @@ client.crm.issues.list(
-
-**account_token:** `typing.Optional[str]`
+**cursor:** `typing.Optional[str]` — The pagination cursor value.
@@ -18071,7 +18070,7 @@ client.crm.issues.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/).
@@ -18079,7 +18078,7 @@ client.crm.issues.list(
-
-**end_date:** `typing.Optional[str]` — If included, will only include issues whose most recent action occurred before this time
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -18087,7 +18086,7 @@ client.crm.issues.list(
-
-**end_user_organization_name:** `typing.Optional[str]`
+**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -18095,7 +18094,7 @@ client.crm.issues.list(
-
-**first_incident_time_after:** `typing.Optional[dt.datetime]` — If provided, will only return issues whose first incident time was after this datetime.
+**is_common_model_field:** `typing.Optional[bool]` — If provided, will only return remote field classes with this is_common_model_field value
@@ -18103,7 +18102,7 @@ client.crm.issues.list(
-
-**first_incident_time_before:** `typing.Optional[dt.datetime]` — If provided, will only return issues whose first incident time was before this datetime.
+**is_custom:** `typing.Optional[bool]` — If provided, will only return remote fields classes with this is_custom value
@@ -18111,7 +18110,7 @@ client.crm.issues.list(
-
-**include_muted:** `typing.Optional[str]` — If true, will include muted issues
+**page_size:** `typing.Optional[int]` — Number of results to return per page.
@@ -18119,64 +18118,64 @@ client.crm.issues.list(
-
-**integration_name:** `typing.Optional[str]`
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
-
--
-**last_incident_time_after:** `typing.Optional[dt.datetime]` — If provided, will only return issues whose last incident time was after this datetime.
-
+client.accounting.journal_entries.meta_post_retrieve()
-
-**last_incident_time_before:** `typing.Optional[dt.datetime]` — If provided, will only return issues whose last incident time was before this datetime.
-
-
-
+#### 📝 Description
-
-**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.
-
+Returns metadata for `JournalEntry` POSTs.
+
+
+#### 🔌 Usage
+
-
-**start_date:** `typing.Optional[str]` — If included, will only include issues whose most recent action occurred after this time
-
-
-
-
-
-**status:** `typing.Optional[IssuesListRequestStatus]`
+```python
+from merge import Merge
-Status of the issue. Options: ('ONGOING', 'RESOLVED')
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.accounting.journal_entries.meta_post_retrieve()
-* `ONGOING` - ONGOING
-* `RESOLVED` - RESOLVED
-
+```
+
+
+#### ⚙️ Parameters
+
+
+-
+
-
@@ -18192,7 +18191,7 @@ Status of the issue. Options: ('ONGOING', 'RESOLVED')
client.crm.issues.retrieve(...)
+client.accounting.journal_entries.remote_field_classes_list(...)
-
@@ -18204,7 +18203,7 @@ Status of the issue. Options: ('ONGOING', 'RESOLVED')
-
-Get a specific issue.
+Returns a list of `RemoteFieldClass` objects.
@@ -18225,9 +18224,20 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.crm.issues.retrieve(
- id="id",
+response = client.accounting.journal_entries.remote_field_classes_list(
+ cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
+ include_deleted_data=True,
+ include_remote_data=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
```
@@ -18243,7 +18253,55 @@ client.crm.issues.retrieve(
-
-**id:** `str`
+**cursor:** `typing.Optional[str]` — The pagination cursor value.
+
+
+
+
+
+-
+
+**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
+
+
+
+
+
+-
+
+**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.
@@ -18263,8 +18321,8 @@ client.crm.issues.retrieve(
client.crm.leads.list(...)
+## Accounting LinkToken
+client.accounting.link_token.create(...)
-
@@ -18276,7 +18334,7 @@ client.crm.issues.retrieve(
-
-Returns a list of `Lead` objects.
+Creates a link token to be used when linking a new end user.
@@ -18291,41 +18349,18 @@ Returns a list of `Lead` objects.
-
```python
-import datetime
-
from merge import Merge
-from merge.resources.crm.resources.leads import LeadsListRequestExpand
+from merge.resources.accounting import CategoriesEnum
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",
+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],
)
```
@@ -18342,7 +18377,7 @@ client.crm.leads.list(
-
-**converted_account_id:** `typing.Optional[str]` — If provided, will only return leads with this account.
+**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.
@@ -18350,7 +18385,7 @@ client.crm.leads.list(
-
-**converted_contact_id:** `typing.Optional[str]` — If provided, will only return leads with this contact.
+**end_user_organization_name:** `str` — Your end user's organization.
@@ -18358,7 +18393,7 @@ client.crm.leads.list(
-
-**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
+**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.
@@ -18366,7 +18401,7 @@ client.crm.leads.list(
-
-**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
+**categories:** `typing.Sequence[CategoriesEnum]` — The integration categories to show in Merge Link.
@@ -18374,7 +18409,7 @@ client.crm.leads.list(
-
-**cursor:** `typing.Optional[str]` — The pagination cursor value.
+**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/.
@@ -18382,7 +18417,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.
+**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.
@@ -18390,7 +18425,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.
+**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.
@@ -18398,7 +18433,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/).
+**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.
@@ -18406,7 +18441,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.
+**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.
@@ -18414,7 +18449,14 @@ 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.
+**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.
@@ -18422,7 +18464,12 @@ client.crm.leads.list(
-
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
+**language:** `typing.Optional[EndUserDetailsRequestLanguage]`
+
+The following subset of IETF language tags can be used to configure localization.
+
+* `en` - en
+* `de` - de
@@ -18430,7 +18477,7 @@ client.crm.leads.list(
-
-**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
+**are_syncs_disabled:** `typing.Optional[bool]` — The boolean that indicates whether initial, periodic, and force syncs will be disabled.
@@ -18438,7 +18485,7 @@ client.crm.leads.list(
-
-**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
+**integration_specific_config:** `typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]]` — A JSON object containing integration-specific configuration options.
@@ -18446,42 +18493,10 @@ client.crm.leads.list(
-
-**owner_id:** `typing.Optional[str]` — If provided, will only return leads with this owner.
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
--
-
-**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.
-
-
-
-
-
--
-
-**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
+
+
@@ -18490,7 +18505,8 @@ client.crm.leads.list(
client.crm.leads.create(...)
+## Accounting LinkedAccounts
+client.accounting.linked_accounts.list(...)
-
@@ -18502,7 +18518,7 @@ client.crm.leads.list(
-
-Creates a `Lead` object with the given values.
+List linked accounts for your organization.
@@ -18518,17 +18534,34 @@ Creates a `Lead` object with the given values.
```python
from merge import Merge
-from merge.resources.crm import LeadRequest
+from merge.resources.accounting.resources.linked_accounts import (
+ LinkedAccountsListRequestCategory,
+)
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(),
+response = client.accounting.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",
)
+for item in response:
+ yield item
+# alternatively, you can paginate page-by-page
+for page in response.iter_pages():
+ yield page
```
@@ -18544,7 +18577,17 @@ client.crm.leads.create(
-
-**model:** `LeadRequest`
+**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
@@ -18552,7 +18595,7 @@ client.crm.leads.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.
@@ -18560,7 +18603,7 @@ client.crm.leads.create(
-
-**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously.
+**end_user_email_address:** `typing.Optional[str]` — If provided, will only return linked accounts associated with the given email address.
@@ -18568,75 +18611,47 @@ client.crm.leads.create(
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+**end_user_organization_name:** `typing.Optional[str]` — If provided, will only return linked accounts associated with the given organization name.
-
-
+
+-
+**end_user_origin_id:** `typing.Optional[str]` — If provided, will only return linked accounts associated with the given origin ID.
+
-client.crm.leads.retrieve(...)
-
-#### 📝 Description
-
-
--
+**end_user_origin_ids:** `typing.Optional[str]` — Comma-separated list of EndUser origin IDs, making it possible to specify multiple EndUsers at once.
+
+
+
-
-Returns a `Lead` object with the given `id`.
-
-
+**id:** `typing.Optional[str]`
+
-#### 🔌 Usage
-
-
-
--
-
-```python
-from merge import Merge
-from merge.resources.crm.resources.leads import LeadsRetrieveRequestExpand
-
-client = Merge(
- account_token="YOUR_ACCOUNT_TOKEN",
- api_key="YOUR_API_KEY",
-)
-client.crm.leads.retrieve(
- id="id",
- expand=LeadsRetrieveRequestExpand.CONVERTED_ACCOUNT,
- include_remote_data=True,
- include_remote_fields=True,
- include_shell_data=True,
-)
-
-```
-
-
+**ids:** `typing.Optional[str]` — Comma-separated list of LinkedAccount IDs, making it possible to specify multiple LinkedAccounts at once.
+
-#### ⚙️ Parameters
-
-
-
--
-
-**id:** `str`
+**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.
@@ -18644,7 +18659,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.
+**integration_name:** `typing.Optional[str]` — If provided, will only return linked accounts associated with the given integration name.
@@ -18652,7 +18667,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_test_account:** `typing.Optional[str]` — If included, will only include test linked accounts. If not included, will only include non-test linked accounts.
@@ -18660,7 +18675,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.
+**page_size:** `typing.Optional[int]` — Number of results to return per page.
@@ -18668,7 +18683,7 @@ client.crm.leads.retrieve(
-
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
+**status:** `typing.Optional[str]` — Filter by status. Options: `COMPLETE`, `IDLE`, `INCOMPLETE`, `RELINK_NEEDED`
@@ -18688,7 +18703,8 @@ client.crm.leads.retrieve(
client.crm.leads.meta_post_retrieve()
+## Accounting Passthrough
+client.accounting.passthrough.create(...)
-
@@ -18700,7 +18716,7 @@ client.crm.leads.retrieve(
-
-Returns metadata for `Lead` POSTs.
+Pull data from an endpoint not currently supported by Merge.
@@ -18716,12 +18732,18 @@ Returns metadata for `Lead` POSTs.
```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.crm.leads.meta_post_retrieve()
+client.accounting.passthrough.create(
+ request=DataPassthroughRequest(
+ method=MethodEnum.GET,
+ path="/scooters",
+ ),
+)
```
@@ -18737,6 +18759,14 @@ client.crm.leads.meta_post_retrieve()
-
+**request:** `DataPassthroughRequest`
+
+
+
+
+
+-
+
**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -18749,7 +18779,8 @@ client.crm.leads.meta_post_retrieve()
client.crm.leads.remote_field_classes_list(...)
+## Accounting PaymentMethods
+client.accounting.payment_methods.list(...)
-
@@ -18761,7 +18792,7 @@ client.crm.leads.meta_post_retrieve()
-
-Returns a list of `RemoteFieldClass` objects.
+Returns a list of `PaymentMethod` objects.
@@ -18782,16 +18813,18 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.crm.leads.remote_field_classes_list(
+response = client.accounting.payment_methods.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
```
@@ -18831,14 +18864,6 @@ client.crm.leads.remote_field_classes_list(
-
-**include_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.
-
-
-
-
-
--
-
**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -18847,22 +18872,6 @@ client.crm.leads.remote_field_classes_list(
-
-**is_common_model_field:** `typing.Optional[bool]` — If provided, will only return remote field classes with this is_common_model_field value
-
-
-
-
-
--
-
-**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.
@@ -18883,8 +18892,7 @@ client.crm.leads.remote_field_classes_list(
client.crm.link_token.create(...)
+client.accounting.payment_methods.retrieve(...)
-
@@ -18896,7 +18904,7 @@ client.crm.leads.remote_field_classes_list(
-
-Creates a link token to be used when linking a new end user.
+Returns a `PaymentMethod` object with the given `id`.
@@ -18912,17 +18920,15 @@ Creates a link token to be used when linking a new end user.
```python
from merge import Merge
-from merge.resources.crm import CategoriesEnum
client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.crm.link_token.create(
- end_user_email_address="example@gmail.com",
- end_user_organization_name="Test Organization",
- end_user_origin_id="12345",
- categories=[CategoriesEnum.HRIS, CategoriesEnum.ATS],
+client.accounting.payment_methods.retrieve(
+ id="id",
+ include_remote_data=True,
+ include_shell_data=True,
)
```
@@ -18939,7 +18945,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.
+**id:** `str`
@@ -18947,7 +18953,7 @@ client.crm.link_token.create(
-
-**end_user_organization_name:** `str` — Your end user's organization.
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -18955,7 +18961,7 @@ client.crm.link_token.create(
-
-**end_user_origin_id:** `str` — This unique identifier typically represents the ID for your end user in your product's database. This value must be distinct from other Linked Accounts' unique identifiers.
+**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -18963,47 +18969,80 @@ client.crm.link_token.create(
-
-**categories:** `typing.Sequence[CategoriesEnum]` — The integration categories to show in Merge Link.
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
-
--
-**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/.
-
+client.accounting.payment_terms.list(...)
-
-**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.
-
-
-
+#### 📝 Description
-
-**should_create_magic_link_url:** `typing.Optional[bool]` — Whether to generate a Magic Link URL. Defaults to false. For more information on Magic Link, see https://merge.dev/blog/integrations-fast-say-hello-to-magic-link.
-
+
+-
+
+Returns a list of `PaymentTerm` objects.
+
+
+#### 🔌 Usage
+
-
-**hide_admin_magic_link:** `typing.Optional[bool]` — Whether to generate a Magic Link URL on the Admin Needed screen during the linking flow. Defaults to false. For more information on Magic Link, see https://merge.dev/blog/integrations-fast-say-hello-to-magic-link.
-
+
+-
+
+```python
+from merge import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+response = client.accounting.payment_terms.list(
+ cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
+ 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
+
+```
+
+
+#### ⚙️ Parameters
+
-
-**common_models:** `typing.Optional[typing.Sequence[CommonModelScopesBodyRequest]]` — An array of objects to specify the models and fields that will be disabled for a given Linked Account. Each object uses model_id, enabled_actions, and disabled_fields to specify the model, method, and fields that are scoped for a given Linked Account.
+
+-
+
+**cursor:** `typing.Optional[str]` — The pagination cursor value.
@@ -19011,14 +19050,11 @@ client.crm.link_token.create(
-
-**category_common_model_scopes:** `typing.Optional[
- typing.Dict[
- str,
- typing.Optional[
- typing.Sequence[IndividualCommonModelScopeDeserializerRequest]
- ],
+**expand:** `typing.Optional[
+ typing.Union[
+ typing.Literal["company"], typing.Sequence[typing.Literal["company"]]
]
-]` — 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.
+]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -19026,12 +19062,15 @@ client.crm.link_token.create(
-
-**language:** `typing.Optional[EndUserDetailsRequestLanguage]`
+**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
+
+
+
-The following subset of IETF language tags can be used to configure localization.
+
+-
-* `en` - en
-* `de` - de
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -19039,7 +19078,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.
+**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -19047,7 +19086,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.
+**page_size:** `typing.Optional[int]` — Number of results to return per page.
@@ -19067,8 +19106,7 @@ The following subset of IETF language tags can be used to configure localization
client.crm.linked_accounts.list(...)
+client.accounting.payment_terms.retrieve(...)
-
@@ -19080,7 +19118,7 @@ The following subset of IETF language tags can be used to configure localization
-
-List linked accounts for your organization.
+Returns a `PaymentTerm` object with the given `id`.
@@ -19096,28 +19134,15 @@ 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,
- 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.payment_terms.retrieve(
id="id",
- ids="ids",
- include_duplicates=True,
- integration_name="integration_name",
- is_test_account="is_test_account",
- page_size=1,
- status="status",
+ include_remote_data=True,
+ include_shell_data=True,
)
```
@@ -19134,89 +19159,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.
-
-
-
-
-
--
-
-**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.
+**id:** `str`
@@ -19224,7 +19167,11 @@ 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.
+**expand:** `typing.Optional[
+ typing.Union[
+ typing.Literal["company"], typing.Sequence[typing.Literal["company"]]
+ ]
+]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -19232,7 +19179,7 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing`
-
-**page_size:** `typing.Optional[int]` — Number of results to return per page.
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -19240,7 +19187,7 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing`
-
-**status:** `typing.Optional[str]` — Filter by status. Options: `COMPLETE`, `IDLE`, `INCOMPLETE`, `RELINK_NEEDED`
+**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -19260,8 +19207,8 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing`
client.crm.notes.list(...)
+## Accounting Payments
+client.accounting.payments.list(...)
-
@@ -19273,7 +19220,7 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing`
-
-Returns a list of `Note` objects.
+Returns a list of `Payment` objects.
@@ -19291,14 +19238,14 @@ Returns a list of `Note` objects.
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(
+response = client.accounting.payments.list(
account_id="account_id",
+ company_id="company_id",
contact_id="contact_id",
created_after=datetime.datetime.fromisoformat(
"2024-01-15 09:30:00+00:00",
@@ -19307,7 +19254,6 @@ client.crm.notes.list(
"2024-01-15 09:30:00+00:00",
),
cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
- expand=NotesListRequestExpand.ACCOUNT,
include_deleted_data=True,
include_remote_data=True,
include_remote_fields=True,
@@ -19318,11 +19264,20 @@ client.crm.notes.list(
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",
+ transaction_date_after=datetime.datetime.fromisoformat(
+ "2024-01-15 09:30:00+00:00",
+ ),
+ transaction_date_before=datetime.datetime.fromisoformat(
+ "2024-01-15 09:30:00+00:00",
+ ),
)
+for item in response:
+ yield item
+# alternatively, you can paginate page-by-page
+for page in response.iter_pages():
+ yield page
```
@@ -19338,7 +19293,7 @@ client.crm.notes.list(
-
-**account_id:** `typing.Optional[str]` — If provided, will only return notes with this account.
+**account_id:** `typing.Optional[str]` — If provided, will only return payments for this account.
@@ -19346,7 +19301,15 @@ client.crm.notes.list(
-
-**contact_id:** `typing.Optional[str]` — If provided, will only return notes with this contact.
+**company_id:** `typing.Optional[str]` — If provided, will only return payments for this company.
+
+
+
+
+
+-
+
+**contact_id:** `typing.Optional[str]` — If provided, will only return payments for this contact.
@@ -19378,7 +19341,12 @@ 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.
+**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.
@@ -19434,7 +19402,7 @@ client.crm.notes.list(
-
-**opportunity_id:** `typing.Optional[str]` — If provided, will only return notes with this opportunity.
+**page_size:** `typing.Optional[int]` — Number of results to return per page.
@@ -19442,7 +19410,7 @@ client.crm.notes.list(
-
-**owner_id:** `typing.Optional[str]` — If provided, will only return notes with this owner.
+**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
@@ -19450,7 +19418,7 @@ client.crm.notes.list(
-
-**page_size:** `typing.Optional[int]` — Number of results to return per page.
+**transaction_date_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
@@ -19458,7 +19426,7 @@ client.crm.notes.list(
-
-**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
+**transaction_date_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
@@ -19478,7 +19446,7 @@ client.crm.notes.list(
client.crm.notes.create(...)
+client.accounting.payments.create(...)
-
@@ -19490,7 +19458,7 @@ client.crm.notes.list(
-
-Creates a `Note` object with the given values.
+Creates a `Payment` object with the given values.
@@ -19506,16 +19474,16 @@ Creates a `Note` object with the given values.
```python
from merge import Merge
-from merge.resources.crm import NoteRequest
+from merge.resources.accounting import PaymentRequest
client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.crm.notes.create(
+client.accounting.payments.create(
is_debug_mode=True,
run_async=True,
- model=NoteRequest(),
+ model=PaymentRequest(),
)
```
@@ -19532,7 +19500,7 @@ client.crm.notes.create(
-
-**model:** `NoteRequest`
+**model:** `PaymentRequest`
@@ -19568,7 +19536,7 @@ client.crm.notes.create(
client.crm.notes.retrieve(...)
+client.accounting.payments.retrieve(...)
-
@@ -19580,7 +19548,7 @@ client.crm.notes.create(
-
-Returns a `Note` object with the given `id`.
+Returns a `Payment` object with the given `id`.
@@ -19596,15 +19564,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.accounting.payments.retrieve(
id="id",
- expand=NotesRetrieveRequestExpand.ACCOUNT,
include_remote_data=True,
include_remote_fields=True,
include_shell_data=True,
@@ -19632,7 +19598,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[
+ PaymentsRetrieveRequestExpandItem,
+ typing.Sequence[PaymentsRetrieveRequestExpandItem],
+ ]
+]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -19676,7 +19647,7 @@ client.crm.notes.retrieve(
client.crm.notes.meta_post_retrieve()
+client.accounting.payments.partial_update(...)
-
@@ -19688,7 +19659,7 @@ client.crm.notes.retrieve(
-
-Returns metadata for `Note` POSTs.
+Updates a `Payment` object with the given `id`.
@@ -19704,12 +19675,18 @@ Returns metadata for `Note` POSTs.
```python
from merge import Merge
+from merge.resources.accounting import PatchedPaymentRequest
client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.crm.notes.meta_post_retrieve()
+client.accounting.payments.partial_update(
+ id="id",
+ is_debug_mode=True,
+ run_async=True,
+ model=PatchedPaymentRequest(),
+)
```
@@ -19725,6 +19702,38 @@ client.crm.notes.meta_post_retrieve()
-
+**id:** `str`
+
+
+
+
+
+-
+
+**model:** `PatchedPaymentRequest`
+
+
+
+
+
+-
+
+**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.
@@ -19737,7 +19746,7 @@ client.crm.notes.meta_post_retrieve()
client.crm.notes.remote_field_classes_list(...)
+client.accounting.payments.line_items_remote_field_classes_list(...)
-
@@ -19770,16 +19779,20 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.crm.notes.remote_field_classes_list(
+response = client.accounting.payments.line_items_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
```
@@ -19819,14 +19832,6 @@ client.crm.notes.remote_field_classes_list(
-
-**include_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.
-
-
-
-
-
--
-
**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -19871,8 +19876,7 @@ client.crm.notes.remote_field_classes_list(
client.crm.opportunities.list(...)
+client.accounting.payments.meta_patch_retrieve(...)
-
@@ -19884,7 +19888,7 @@ client.crm.notes.remote_field_classes_list(
-
-Returns a list of `Opportunity` objects.
+Returns metadata for `Payment` PATCHs.
@@ -19899,46 +19903,14 @@ Returns a list of `Opportunity` objects.
-
```python
-import datetime
-
from merge import Merge
-from merge.resources.crm.resources.opportunities import (
- OpportunitiesListRequestExpand,
- OpportunitiesListRequestStatus,
-)
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",
- ),
- remote_id="remote_id",
- stage_id="stage_id",
- status=OpportunitiesListRequestStatus.LOST,
+client.accounting.payments.meta_patch_retrieve(
+ id="id",
)
```
@@ -19955,39 +19927,7 @@ client.crm.opportunities.list(
-
-**account_id:** `typing.Optional[str]` — If provided, will only return opportunities with this account.
-
-
-
-
-
--
-
-**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
-
-
-
-
-
--
-
-**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
-
-
-
-
-
--
-
-**cursor:** `typing.Optional[str]` — The pagination cursor value.
-
-
-
-
-
--
-
-**expand:** `typing.Optional[OpportunitiesListRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+**id:** `str`
@@ -19995,121 +19935,64 @@ client.crm.opportunities.list(
-
-**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
--
-
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
-
-
--
-**include_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.
-
+
client.accounting.payments.meta_post_retrieve()
-
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
-
-
-
+#### 📝 Description
-
-**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
-
-
-
-
-
-**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
-
+Returns metadata for `Payment` POSTs.
-
-
--
-
-**owner_id:** `typing.Optional[str]` — If provided, will only return opportunities with this owner.
-
-
--
-
-**page_size:** `typing.Optional[int]` — Number of results to return per page.
-
-
-
+#### 🔌 Usage
-
-**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[typing.Literal["status"]]` — Deprecated. Use show_enum_origins.
-
-
-
+```python
+from merge import Merge
-
--
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.accounting.payments.meta_post_retrieve()
-**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)
-
-
--
-
-**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
-
-
-
-
-
@@ -20125,7 +20008,7 @@ If provided, will only return opportunities with this status. Options: ('OPEN',
client.crm.opportunities.create(...)
+client.accounting.payments.remote_field_classes_list(...)
-
@@ -20137,7 +20020,7 @@ If provided, will only return opportunities with this status. Options: ('OPEN',
-
-Creates an `Opportunity` object with the given values.
+Returns a list of `RemoteFieldClass` objects.
@@ -20153,17 +20036,25 @@ 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(),
+response = client.accounting.payments.remote_field_classes_list(
+ cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
+ include_deleted_data=True,
+ include_remote_data=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
```
@@ -20179,7 +20070,7 @@ client.crm.opportunities.create(
-
-**model:** `OpportunityRequest`
+**cursor:** `typing.Optional[str]` — The pagination cursor value.
@@ -20187,7 +20078,7 @@ client.crm.opportunities.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/).
@@ -20195,7 +20086,39 @@ client.crm.opportunities.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.
@@ -20215,7 +20138,8 @@ client.crm.opportunities.create(
client.crm.opportunities.retrieve(...)
+## Accounting PhoneNumbers
+client.accounting.phone_numbers.retrieve(...)
-
@@ -20227,7 +20151,7 @@ client.crm.opportunities.create(
-
-Returns an `Opportunity` object with the given `id`.
+Returns an `AccountingPhoneNumber` object with the given `id`.
@@ -20243,19 +20167,14 @@ 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(
+client.accounting.phone_numbers.retrieve(
id="id",
- expand=OpportunitiesRetrieveRequestExpand.ACCOUNT,
include_remote_data=True,
- include_remote_fields=True,
include_shell_data=True,
)
@@ -20281,14 +20200,6 @@ 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_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -20297,14 +20208,6 @@ client.crm.opportunities.retrieve(
-
-**include_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.
-
-
-
-
-
--
-
**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -20313,22 +20216,6 @@ client.crm.opportunities.retrieve(
-
-**remote_fields:** `typing.Optional[typing.Literal["status"]]` — Deprecated. Use show_enum_origins.
-
-
-
-
-
--
-
-**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)
-
-
-
-
-
--
-
**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -20341,7 +20228,8 @@ client.crm.opportunities.retrieve(
client.crm.opportunities.partial_update(...)
+## Accounting Projects
+client.accounting.projects.list(...)
-
@@ -20353,7 +20241,7 @@ client.crm.opportunities.retrieve(
-
-Updates an `Opportunity` object with the given `id`.
+Returns a list of `Project` objects.
@@ -20369,17 +20257,17 @@ 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(),
+client.accounting.projects.list(
+ cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
+ include_deleted_data=True,
+ include_remote_data=True,
+ include_shell_data=True,
+ page_size=1,
)
```
@@ -20396,7 +20284,7 @@ client.crm.opportunities.partial_update(
-
-**id:** `str`
+**cursor:** `typing.Optional[str]` — The pagination cursor value.
@@ -20404,7 +20292,12 @@ client.crm.opportunities.partial_update(
-
-**model:** `PatchedOpportunityRequest`
+**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.
@@ -20412,7 +20305,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.
+**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
@@ -20420,7 +20313,23 @@ client.crm.opportunities.partial_update(
-
-**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).
+
+
+
+
+
+-
+
+**page_size:** `typing.Optional[int]` — Number of results to return per page.
@@ -20440,7 +20349,7 @@ client.crm.opportunities.partial_update(
client.crm.opportunities.meta_patch_retrieve(...)
+client.accounting.projects.retrieve(...)
-
@@ -20452,7 +20361,7 @@ client.crm.opportunities.partial_update(
-
-Returns metadata for `Opportunity` PATCHs.
+Returns a `Project` object with the given `id`.
@@ -20473,8 +20382,10 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.crm.opportunities.meta_patch_retrieve(
+client.accounting.projects.retrieve(
id="id",
+ include_remote_data=True,
+ include_shell_data=True,
)
```
@@ -20499,64 +20410,32 @@ client.crm.opportunities.meta_patch_retrieve(
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+**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.
-
-
-
-
-
-
-client.crm.opportunities.meta_post_retrieve()
-
--
-
-#### 📝 Description
-
-
--
-
-Returns metadata for `Opportunity` 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.opportunities.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
-
-
--
-
-
@@ -20572,7 +20451,8 @@ client.crm.opportunities.meta_post_retrieve()
client.crm.opportunities.remote_field_classes_list(...)
+## Accounting PurchaseOrders
+client.accounting.purchase_orders.list(...)
-
@@ -20584,7 +20464,7 @@ client.crm.opportunities.meta_post_retrieve()
-
-Returns a list of `RemoteFieldClass` objects.
+Returns a list of `PurchaseOrder` objects.
@@ -20599,22 +20479,47 @@ Returns a list of `RemoteFieldClass` objects.
-
```python
+import datetime
+
from merge import Merge
client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.crm.opportunities.remote_field_classes_list(
+response = client.accounting.purchase_orders.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",
include_deleted_data=True,
include_remote_data=True,
include_remote_fields=True,
include_shell_data=True,
- is_common_model_field=True,
- is_custom=True,
+ issue_date_after=datetime.datetime.fromisoformat(
+ "2024-01-15 09:30:00+00:00",
+ ),
+ issue_date_before=datetime.datetime.fromisoformat(
+ "2024-01-15 09:30:00+00:00",
+ ),
+ 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
```
@@ -20630,7 +20535,7 @@ client.crm.opportunities.remote_field_classes_list(
-
-**cursor:** `typing.Optional[str]` — The pagination cursor value.
+**company_id:** `typing.Optional[str]` — If provided, will only return purchase orders for this company.
@@ -20638,7 +20543,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.
@@ -20646,7 +20551,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.
@@ -20654,7 +20559,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.
@@ -20662,7 +20567,12 @@ 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[
+ PurchaseOrdersListRequestExpandItem,
+ typing.Sequence[PurchaseOrdersListRequestExpandItem],
+ ]
+]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -20670,7 +20580,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/).
@@ -20678,7 +20588,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.
@@ -20686,7 +20596,7 @@ client.crm.opportunities.remote_field_classes_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.
@@ -20694,75 +20604,71 @@ client.crm.opportunities.remote_field_classes_list(
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
-
-
+
+-
+**issue_date_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
+
-client.crm.passthrough.create(...)
-
-#### 📝 Description
+**issue_date_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.
+
+
+
+
-
-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
-
-
+**page_size:** `typing.Optional[int]` — Number of results to return per page.
+
+
+
+
-
-```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",
- ),
-)
-
-```
-
-
+**remote_fields:** `typing.Optional[typing.Literal["status"]]` — Deprecated. Use show_enum_origins.
+
-#### ⚙️ Parameters
-
-
+**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
+
+
+
+
-
-**request:** `DataPassthroughRequest`
+**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)
@@ -20782,8 +20688,7 @@ client.crm.passthrough.create(
client.crm.regenerate_key.create(...)
+client.accounting.purchase_orders.create(...)
-
@@ -20795,7 +20700,7 @@ client.crm.passthrough.create(
-
-Exchange remote keys.
+Creates a `PurchaseOrder` object with the given values.
@@ -20811,13 +20716,16 @@ Exchange remote keys.
```python
from merge import Merge
+from merge.resources.accounting import PurchaseOrderRequest
client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.crm.regenerate_key.create(
- name="Remote Deployment Key 1",
+client.accounting.purchase_orders.create(
+ is_debug_mode=True,
+ run_async=True,
+ model=PurchaseOrderRequest(),
)
```
@@ -20834,7 +20742,23 @@ client.crm.regenerate_key.create(
-
-**name:** `str` — The name of the remote key
+**model:** `PurchaseOrderRequest`
+
+
+
+
+
+-
+
+**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.
@@ -20854,8 +20778,7 @@ client.crm.regenerate_key.create(
client.crm.stages.list(...)
+client.accounting.purchase_orders.retrieve(...)
-
@@ -20867,7 +20790,7 @@ client.crm.regenerate_key.create(
-
-Returns a list of `Stage` objects.
+Returns a `PurchaseOrder` object with the given `id`.
@@ -20882,34 +20805,17 @@ 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,
+client.accounting.purchase_orders.retrieve(
+ id="id",
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",
)
```
@@ -20926,23 +20832,7 @@ client.crm.stages.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`
@@ -20950,7 +20840,12 @@ 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/).
+**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.
@@ -20982,23 +20877,7 @@ client.crm.stages.list(
-
-**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
-
-
-
-
-
--
-
-**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_fields:** `typing.Optional[typing.Literal["status"]]` — Deprecated. Use show_enum_origins.
@@ -21006,7 +20885,7 @@ client.crm.stages.list(
-
-**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)
@@ -21026,7 +20905,7 @@ client.crm.stages.list(
client.crm.stages.retrieve(...)
+client.accounting.purchase_orders.line_items_remote_field_classes_list(...)
-
@@ -21038,7 +20917,7 @@ client.crm.stages.list(
-
-Returns a `Stage` object with the given `id`.
+Returns a list of `RemoteFieldClass` objects.
@@ -21059,12 +20938,22 @@ 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.accounting.purchase_orders.line_items_remote_field_classes_list(
+ cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
+ include_deleted_data=True,
+ include_remote_data=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
```
@@ -21080,7 +20969,7 @@ client.crm.stages.retrieve(
-
-**id:** `str`
+**cursor:** `typing.Optional[str]` — The pagination cursor value.
@@ -21088,7 +20977,7 @@ client.crm.stages.retrieve(
-
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
+**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
@@ -21096,7 +20985,7 @@ client.crm.stages.retrieve(
-
-**include_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -21112,6 +21001,30 @@ client.crm.stages.retrieve(
-
+**is_common_model_field:** `typing.Optional[bool]` — If provided, will only return remote field classes with this is_common_model_field value
+
+
+
+
+
+-
+
+**is_custom:** `typing.Optional[bool]` — If provided, will only return remote fields classes with this is_custom value
+
+
+
+
+
+-
+
+**page_size:** `typing.Optional[int]` — Number of results to return per page.
+
+
+
+
+
+-
+
**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -21124,7 +21037,68 @@ client.crm.stages.retrieve(
client.crm.stages.remote_field_classes_list(...)
+client.accounting.purchase_orders.meta_post_retrieve()
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns metadata for `PurchaseOrder` POSTs.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.accounting.purchase_orders.meta_post_retrieve()
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.accounting.purchase_orders.remote_field_classes_list(...)
-
@@ -21157,16 +21131,20 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.crm.stages.remote_field_classes_list(
+response = client.accounting.purchase_orders.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
```
@@ -21206,7 +21184,7 @@ client.crm.stages.remote_field_classes_list(
-
-**include_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.
+**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -21214,7 +21192,7 @@ client.crm.stages.remote_field_classes_list(
-
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
+**is_common_model_field:** `typing.Optional[bool]` — If provided, will only return remote field classes with this is_common_model_field value
@@ -21222,7 +21200,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
+**is_custom:** `typing.Optional[bool]` — If provided, will only return remote fields classes with this is_custom value
@@ -21230,7 +21208,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
+**page_size:** `typing.Optional[int]` — Number of results to return per page.
@@ -21238,7 +21216,71 @@ client.crm.stages.remote_field_classes_list(
-
-**page_size:** `typing.Optional[int]` — Number of results to return per page.
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.accounting.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.accounting.regenerate_key.create(
+ name="Remote Deployment Key 1",
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**name:** `str` — The name of the remote key
@@ -21258,8 +21300,8 @@ client.crm.stages.remote_field_classes_list(
client.crm.sync_status.list(...)
+## Accounting SyncStatus
+client.accounting.sync_status.list(...)
-
@@ -21292,10 +21334,15 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.crm.sync_status.list(
+response = client.accounting.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
```
@@ -21339,8 +21386,8 @@ client.crm.sync_status.list(
client.crm.force_resync.sync_status_resync_create()
+## Accounting ForceResync
+client.accounting.force_resync.sync_status_resync_create()
-
@@ -21373,7 +21420,7 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.crm.force_resync.sync_status_resync_create()
+client.accounting.force_resync.sync_status_resync_create()
```
@@ -21401,8 +21448,8 @@ client.crm.force_resync.sync_status_resync_create()
client.crm.tasks.list(...)
+## Accounting TaxRates
+client.accounting.tax_rates.list(...)
-
@@ -21414,7 +21461,7 @@ client.crm.force_resync.sync_status_resync_create()
-
-Returns a list of `Task` objects.
+Returns a list of `TaxRate` objects.
@@ -21432,13 +21479,13 @@ Returns a list of `Task` objects.
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(
+response = client.accounting.tax_rates.list(
+ company_id="company_id",
created_after=datetime.datetime.fromisoformat(
"2024-01-15 09:30:00+00:00",
),
@@ -21446,10 +21493,8 @@ client.crm.tasks.list(
"2024-01-15 09:30:00+00:00",
),
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",
@@ -21457,9 +21502,15 @@ client.crm.tasks.list(
modified_before=datetime.datetime.fromisoformat(
"2024-01-15 09:30:00+00:00",
),
+ name="name",
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
```
@@ -21475,7 +21526,7 @@ client.crm.tasks.list(
-
-**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
+**company_id:** `typing.Optional[str]` — If provided, will only return tax rates for this company.
@@ -21483,7 +21534,7 @@ client.crm.tasks.list(
-
-**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
+**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
@@ -21491,7 +21542,7 @@ client.crm.tasks.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.
@@ -21499,7 +21550,7 @@ client.crm.tasks.list(
-
-**expand:** `typing.Optional[TasksListRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+**cursor:** `typing.Optional[str]` — The pagination cursor value.
@@ -21507,7 +21558,11 @@ client.crm.tasks.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[
+ typing.Literal["company"], typing.Sequence[typing.Literal["company"]]
+ ]
+]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -21515,7 +21570,7 @@ client.crm.tasks.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/).
@@ -21523,7 +21578,7 @@ client.crm.tasks.list(
-
-**include_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -21555,89 +21610,7 @@ client.crm.tasks.list(
-
-**page_size:** `typing.Optional[int]` — Number of results to return per page.
-
-
-
-
-
--
-
-**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.crm.tasks.create(...)
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Creates a `Task` object with the given values.
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```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(),
-)
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**model:** `TaskRequest`
+**name:** `typing.Optional[str]` — If provided, will only return TaxRates with this name.
@@ -21645,7 +21618,7 @@ client.crm.tasks.create(
-
-**is_debug_mode:** `typing.Optional[bool]` — Whether to include debug fields (such as log file links) in the response.
+**page_size:** `typing.Optional[int]` — Number of results to return per page.
@@ -21653,7 +21626,7 @@ client.crm.tasks.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.
@@ -21673,7 +21646,7 @@ client.crm.tasks.create(
client.crm.tasks.retrieve(...)
+client.accounting.tax_rates.retrieve(...)
-
@@ -21685,7 +21658,7 @@ client.crm.tasks.create(
-
-Returns a `Task` object with the given `id`.
+Returns a `TaxRate` object with the given `id`.
@@ -21701,17 +21674,14 @@ Returns a `Task` object with the given `id`.
```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(
+client.accounting.tax_rates.retrieve(
id="id",
- expand=TasksRetrieveRequestExpand.ACCOUNT,
include_remote_data=True,
- include_remote_fields=True,
include_shell_data=True,
)
@@ -21737,7 +21707,11 @@ 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.
+**expand:** `typing.Optional[
+ typing.Union[
+ typing.Literal["company"], typing.Sequence[typing.Literal["company"]]
+ ]
+]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -21753,14 +21727,6 @@ client.crm.tasks.retrieve(
-
-**include_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.
-
-
-
-
-
--
-
**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -21781,7 +21747,8 @@ client.crm.tasks.retrieve(
client.crm.tasks.partial_update(...)
+## Accounting TrackingCategories
+client.accounting.tracking_categories.list(...)
-
@@ -21793,7 +21760,7 @@ client.crm.tasks.retrieve(
-
-Updates a `Task` object with the given `id`.
+Returns a list of `TrackingCategory` objects.
@@ -21808,19 +21775,47 @@ Updates a `Task` object with the given `id`.
-
```python
+import datetime
+
from merge import Merge
-from merge.resources.crm import PatchedTaskRequest
+from merge.resources.accounting.resources.tracking_categories import (
+ TrackingCategoriesListRequestCategoryType,
+ TrackingCategoriesListRequestStatus,
+)
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(),
+response = client.accounting.tracking_categories.list(
+ category_type=TrackingCategoriesListRequestCategoryType.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",
+ ),
+ 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",
+ status=TrackingCategoriesListRequestStatus.EMPTY,
)
+for item in response:
+ yield item
+# alternatively, you can paginate page-by-page
+for page in response.iter_pages():
+ yield page
```
@@ -21836,7 +21831,7 @@ client.crm.tasks.partial_update(
-
-**id:** `str`
+**category_type:** `typing.Optional[TrackingCategoriesListRequestCategoryType]` — If provided, will only return tracking categories with this type.
@@ -21844,7 +21839,7 @@ client.crm.tasks.partial_update(
-
-**model:** `PatchedTaskRequest`
+**company_id:** `typing.Optional[str]` — If provided, will only return tracking categories for this company.
@@ -21852,7 +21847,7 @@ client.crm.tasks.partial_update(
-
-**is_debug_mode:** `typing.Optional[bool]` — Whether to include debug fields (such as log file links) in the response.
+**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
@@ -21860,7 +21855,7 @@ client.crm.tasks.partial_update(
-
-**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.
@@ -21868,70 +21863,51 @@ client.crm.tasks.partial_update(
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+**cursor:** `typing.Optional[str]` — The pagination cursor value.
-
-
+
+-
+**expand:** `typing.Optional[
+ typing.Union[
+ typing.Literal["company"], typing.Sequence[typing.Literal["company"]]
+ ]
+]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+
-client.crm.tasks.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 `Task` 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.tasks.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.
@@ -21939,64 +21915,59 @@ client.crm.tasks.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.
-
-
+
+-
+**name:** `typing.Optional[str]` — If provided, will only return tracking categories with this name.
+
-client.crm.tasks.meta_post_retrieve()
-
-#### 📝 Description
-
-
--
+**page_size:** `typing.Optional[int]` — Number of results to return per page.
+
+
+
-
-Returns metadata for `Task` POSTs.
-
-
+**remote_fields:** `typing.Optional[typing.Literal["status"]]` — Deprecated. Use show_enum_origins.
+
-#### 🔌 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.tasks.meta_post_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)
+
-#### ⚙️ Parameters
-
-
+**status:** `typing.Optional[TrackingCategoriesListRequestStatus]` — If provided, will only return tracking categories with this status.
+
+
+
+
-
@@ -22012,7 +21983,7 @@ client.crm.tasks.meta_post_retrieve()
client.crm.tasks.remote_field_classes_list(...)
+client.accounting.tracking_categories.retrieve(...)
-
@@ -22024,7 +21995,7 @@ client.crm.tasks.meta_post_retrieve()
-
-Returns a list of `RemoteFieldClass` objects.
+Returns a `TrackingCategory` object with the given `id`.
@@ -22045,15 +22016,10 @@ 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,
+client.accounting.tracking_categories.retrieve(
+ id="id",
include_remote_data=True,
- include_remote_fields=True,
include_shell_data=True,
- is_common_model_field=True,
- is_custom=True,
- page_size=1,
)
```
@@ -22070,7 +22036,7 @@ client.crm.tasks.remote_field_classes_list(
-
-**cursor:** `typing.Optional[str]` — The pagination cursor value.
+**id:** `str`
@@ -22078,7 +22044,11 @@ 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/).
+**expand:** `typing.Optional[
+ typing.Union[
+ typing.Literal["company"], typing.Sequence[typing.Literal["company"]]
+ ]
+]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -22094,14 +22064,6 @@ client.crm.tasks.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).
@@ -22110,15 +22072,7 @@ client.crm.tasks.remote_field_classes_list(
-
-**is_common_model_field:** `typing.Optional[bool]` — If provided, will only return remote field classes with this is_common_model_field value
-
-
-
-
-
--
-
-**is_custom:** `typing.Optional[bool]` — If provided, will only return remote fields classes with this is_custom value
+**remote_fields:** `typing.Optional[typing.Literal["status"]]` — Deprecated. Use show_enum_origins.
@@ -22126,7 +22080,7 @@ client.crm.tasks.remote_field_classes_list(
-
-**page_size:** `typing.Optional[int]` — Number of results to return per page.
+**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)
@@ -22146,8 +22100,8 @@ client.crm.tasks.remote_field_classes_list(
client.crm.users.list(...)
+## Accounting Transactions
+client.accounting.transactions.list(...)
-
@@ -22159,7 +22113,7 @@ client.crm.tasks.remote_field_classes_list(
-
-Returns a list of `User` objects.
+Returns a list of `Transaction` objects.
@@ -22182,7 +22136,8 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.crm.users.list(
+response = client.accounting.transactions.list(
+ company_id="company_id",
created_after=datetime.datetime.fromisoformat(
"2024-01-15 09:30:00+00:00",
),
@@ -22190,10 +22145,8 @@ client.crm.users.list(
"2024-01-15 09:30:00+00:00",
),
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",
@@ -22203,7 +22156,18 @@ client.crm.users.list(
),
page_size=1,
remote_id="remote_id",
+ transaction_date_after=datetime.datetime.fromisoformat(
+ "2024-01-15 09:30:00+00:00",
+ ),
+ transaction_date_before=datetime.datetime.fromisoformat(
+ "2024-01-15 09:30:00+00:00",
+ ),
)
+for item in response:
+ yield item
+# alternatively, you can paginate page-by-page
+for page in response.iter_pages():
+ yield page
```
@@ -22219,7 +22183,7 @@ client.crm.users.list(
-
-**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
+**company_id:** `typing.Optional[str]` — If provided, will only return accounting transactions for this company.
@@ -22227,7 +22191,7 @@ client.crm.users.list(
-
-**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
+**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
@@ -22235,7 +22199,7 @@ client.crm.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.
@@ -22243,7 +22207,7 @@ client.crm.users.list(
-
-**email:** `typing.Optional[str]` — If provided, will only return users with this email.
+**cursor:** `typing.Optional[str]` — The pagination cursor value.
@@ -22251,7 +22215,12 @@ client.crm.users.list(
-
-**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
+**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.
@@ -22259,7 +22228,7 @@ client.crm.users.list(
-
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
+**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
@@ -22267,7 +22236,7 @@ client.crm.users.list(
-
-**include_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -22315,6 +22284,22 @@ client.crm.users.list(
-
+**transaction_date_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
+
+
+
+
+
+-
+
+**transaction_date_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
+
+
+
+
+
+-
+
**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -22327,7 +22312,7 @@ client.crm.users.list(
client.crm.users.retrieve(...)
+client.accounting.transactions.retrieve(...)
-
@@ -22339,7 +22324,7 @@ client.crm.users.list(
-
-Returns a `User` object with the given `id`.
+Returns a `Transaction` object with the given `id`.
@@ -22360,10 +22345,9 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.crm.users.retrieve(
+client.accounting.transactions.retrieve(
id="id",
include_remote_data=True,
- include_remote_fields=True,
include_shell_data=True,
)
@@ -22389,7 +22373,12 @@ client.crm.users.retrieve(
-
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
+**expand:** `typing.Optional[
+ typing.Union[
+ TransactionsRetrieveRequestExpandItem,
+ typing.Sequence[TransactionsRetrieveRequestExpandItem],
+ ]
+]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -22397,7 +22386,7 @@ client.crm.users.retrieve(
-
-**include_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -22425,7 +22414,8 @@ client.crm.users.retrieve(
client.crm.users.ignore_create(...)
+## Accounting VendorCredits
+client.accounting.vendor_credits.list(...)
-
@@ -22437,7 +22427,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 `VendorCredit` objects.
@@ -22452,19 +22442,46 @@ Ignores a specific row based on the `model_id` in the url. These records will ha
-
```python
+import datetime
+
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.accounting.vendor_credits.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",
+ 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",
+ transaction_date_after=datetime.datetime.fromisoformat(
+ "2024-01-15 09:30:00+00:00",
+ ),
+ transaction_date_before=datetime.datetime.fromisoformat(
+ "2024-01-15 09:30:00+00:00",
),
)
+for item in response:
+ yield item
+# alternatively, you can paginate page-by-page
+for page in response.iter_pages():
+ yield page
```
@@ -22480,7 +22497,7 @@ client.crm.users.ignore_create(
-
-**model_id:** `str`
+**company_id:** `typing.Optional[str]` — If provided, will only return vendor credits for this company.
@@ -22488,7 +22505,7 @@ client.crm.users.ignore_create(
-
-**request:** `IgnoreCommonModelRequest`
+**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
@@ -22496,77 +22513,28 @@ client.crm.users.ignore_create(
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
-
-
-
-
-
-
-client.crm.users.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",
-)
-client.crm.users.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,
-)
-
-```
-
-
+**cursor:** `typing.Optional[str]` — The pagination cursor value.
+
-#### ⚙️ Parameters
-
-
-
--
-
-**cursor:** `typing.Optional[str]` — The pagination cursor value.
+**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.
@@ -22590,14 +22558,6 @@ 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.
-
-
-
-
-
--
-
**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -22606,7 +22566,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
+**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
@@ -22614,7 +22574,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
+**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
@@ -22630,65 +22590,27 @@ client.crm.users.remote_field_classes_list(
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
-
-
-
-
-
-
-client.crm.webhook_receivers.list()
-
--
-
-#### 📝 Description
-
-
--
-
-Returns a list of `WebhookReceiver` objects.
-
-
+**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.webhook_receivers.list()
-
-```
-
-
+**transaction_date_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
+
-#### ⚙️ Parameters
-
-
--
-
-
@@ -22704,7 +22626,7 @@ client.crm.webhook_receivers.list()
client.crm.webhook_receivers.create(...)
+client.accounting.vendor_credits.create(...)
-
@@ -22716,7 +22638,7 @@ client.crm.webhook_receivers.list()
-
-Creates a `WebhookReceiver` object with the given values.
+Creates a `VendorCredit` object with the given values.
@@ -22732,14 +22654,16 @@ Creates a `WebhookReceiver` object with the given values.
```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.webhook_receivers.create(
- event="event",
- is_active=True,
+client.accounting.vendor_credits.create(
+ is_debug_mode=True,
+ run_async=True,
+ model=VendorCreditRequest(),
)
```
@@ -22756,7 +22680,7 @@ client.crm.webhook_receivers.create(
-
-**event:** `str`
+**model:** `VendorCreditRequest`
@@ -22764,7 +22688,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.
@@ -22772,7 +22696,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.
@@ -22792,8 +22716,7 @@ client.crm.webhook_receivers.create(
client.filestorage.account_details.retrieve()
+client.accounting.vendor_credits.retrieve(...)
-
@@ -22805,7 +22728,7 @@ client.crm.webhook_receivers.create(
-
-Get details for a linked account.
+Returns a `VendorCredit` object with the given `id`.
@@ -22826,7 +22749,11 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.filestorage.account_details.retrieve()
+client.accounting.vendor_credits.retrieve(
+ id="id",
+ include_remote_data=True,
+ include_shell_data=True,
+)
```
@@ -22842,71 +22769,36 @@ client.filestorage.account_details.retrieve()
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+**id:** `str`
-
-
-
-
-
-
-client.filestorage.account_token.retrieve(...)
-
--
-
-#### 📝 Description
-
-
--
-
-Returns the account token for the end user with the provided public token.
-
-
+**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.
+
-#### 🔌 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_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
+
-#### ⚙️ Parameters
-
-
-
--
-
-**public_token:** `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).
@@ -22926,8 +22818,7 @@ client.filestorage.account_token.retrieve(
client.filestorage.async_passthrough.create(...)
+client.accounting.vendor_credits.meta_post_retrieve()
-
@@ -22939,7 +22830,7 @@ client.filestorage.account_token.retrieve(
-
-Asynchronously pull data from an endpoint not currently supported by Merge.
+Returns metadata for `VendorCredit` POSTs.
@@ -22955,18 +22846,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.vendor_credits.meta_post_retrieve()
```
@@ -22982,14 +22867,6 @@ client.filestorage.async_passthrough.create(
-
-**request:** `DataPassthroughRequest`
-
-
-
-
-
--
-
**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -23002,7 +22879,8 @@ client.filestorage.async_passthrough.create(
client.filestorage.async_passthrough.retrieve(...)
+## Accounting WebhookReceivers
+client.accounting.webhook_receivers.list()
-
@@ -23014,7 +22892,7 @@ client.filestorage.async_passthrough.create(
-
-Retrieves data from earlier async-passthrough POST request
+Returns a list of `WebhookReceiver` objects.
@@ -23035,9 +22913,7 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.filestorage.async_passthrough.retrieve(
- async_passthrough_receipt_id="async_passthrough_receipt_id",
-)
+client.accounting.webhook_receivers.list()
```
@@ -23053,14 +22929,6 @@ client.filestorage.async_passthrough.retrieve(
-
-**async_passthrough_receipt_id:** `str`
-
-
-
-
-
--
-
**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -23073,8 +22941,7 @@ client.filestorage.async_passthrough.retrieve(
client.filestorage.audit_trail.list(...)
+client.accounting.webhook_receivers.create(...)
-
@@ -23086,7 +22953,7 @@ client.filestorage.async_passthrough.retrieve(
-
-Gets a list of audit trail events.
+Creates a `WebhookReceiver` object with the given values.
@@ -23107,13 +22974,9 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.filestorage.audit_trail.list(
- cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
- end_date="end_date",
- event_type="event_type",
- page_size=1,
- start_date="start_date",
- user_email="user_email",
+client.accounting.webhook_receivers.create(
+ event="event",
+ is_active=True,
)
```
@@ -23130,31 +22993,7 @@ client.filestorage.audit_trail.list(
-
-**cursor:** `typing.Optional[str]` — The pagination cursor value.
-
-
-
-
-
--
-
-**end_date:** `typing.Optional[str]` — If included, will only include audit trail events that occurred before this time
-
-
-
-
-
--
-
-**event_type:** `typing.Optional[str]` — If included, will only include events with the given event type. Possible values include: `CREATED_REMOTE_PRODUCTION_API_KEY`, `DELETED_REMOTE_PRODUCTION_API_KEY`, `CREATED_TEST_API_KEY`, `DELETED_TEST_API_KEY`, `REGENERATED_PRODUCTION_API_KEY`, `REGENERATED_WEBHOOK_SIGNATURE`, `INVITED_USER`, `TWO_FACTOR_AUTH_ENABLED`, `TWO_FACTOR_AUTH_DISABLED`, `DELETED_LINKED_ACCOUNT`, `DELETED_ALL_COMMON_MODELS_FOR_LINKED_ACCOUNT`, `CREATED_DESTINATION`, `DELETED_DESTINATION`, `CHANGED_DESTINATION`, `CHANGED_SCOPES`, `CHANGED_PERSONAL_INFORMATION`, `CHANGED_ORGANIZATION_SETTINGS`, `ENABLED_INTEGRATION`, `DISABLED_INTEGRATION`, `ENABLED_CATEGORY`, `DISABLED_CATEGORY`, `CHANGED_PASSWORD`, `RESET_PASSWORD`, `ENABLED_REDACT_UNMAPPED_DATA_FOR_ORGANIZATION`, `ENABLED_REDACT_UNMAPPED_DATA_FOR_LINKED_ACCOUNT`, `DISABLED_REDACT_UNMAPPED_DATA_FOR_ORGANIZATION`, `DISABLED_REDACT_UNMAPPED_DATA_FOR_LINKED_ACCOUNT`, `CREATED_INTEGRATION_WIDE_FIELD_MAPPING`, `CREATED_LINKED_ACCOUNT_FIELD_MAPPING`, `CHANGED_INTEGRATION_WIDE_FIELD_MAPPING`, `CHANGED_LINKED_ACCOUNT_FIELD_MAPPING`, `DELETED_INTEGRATION_WIDE_FIELD_MAPPING`, `DELETED_LINKED_ACCOUNT_FIELD_MAPPING`, `CREATED_LINKED_ACCOUNT_COMMON_MODEL_OVERRIDE`, `CHANGED_LINKED_ACCOUNT_COMMON_MODEL_OVERRIDE`, `DELETED_LINKED_ACCOUNT_COMMON_MODEL_OVERRIDE`, `FORCED_LINKED_ACCOUNT_RESYNC`, `MUTED_ISSUE`, `GENERATED_MAGIC_LINK`, `ENABLED_MERGE_WEBHOOK`, `DISABLED_MERGE_WEBHOOK`, `MERGE_WEBHOOK_TARGET_CHANGED`, `END_USER_CREDENTIALS_ACCESSED`
-
-
-
-
-
--
-
-**page_size:** `typing.Optional[int]` — Number of results to return per page.
+**event:** `str`
@@ -23162,7 +23001,7 @@ client.filestorage.audit_trail.list(
-
-**start_date:** `typing.Optional[str]` — If included, will only include audit trail events that occurred after this time
+**is_active:** `bool`
@@ -23170,7 +23009,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.
+**key:** `typing.Optional[str]`
@@ -23190,8 +23029,8 @@ client.filestorage.audit_trail.list(
client.filestorage.available_actions.retrieve()
+## Crm AccountDetails
+client.crm.account_details.retrieve()
-
@@ -23203,7 +23042,7 @@ client.filestorage.audit_trail.list(
-
-Returns a list of models and actions available for an account.
+Get details for a linked account.
@@ -23224,7 +23063,7 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.filestorage.available_actions.retrieve()
+client.crm.account_details.retrieve()
```
@@ -23252,8 +23091,8 @@ client.filestorage.available_actions.retrieve()
client.filestorage.scopes.default_scopes_retrieve()
+## Crm AccountToken
+client.crm.account_token.retrieve(...)
-
@@ -23265,7 +23104,7 @@ client.filestorage.available_actions.retrieve()
-
-Get the default permissions for Merge Common Models and fields across all Linked Accounts of a given category. [Learn more](https://help.merge.dev/en/articles/5950052-common-model-and-field-scopes).
+Returns the account token for the end user with the provided public token.
@@ -23286,7 +23125,9 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.filestorage.scopes.default_scopes_retrieve()
+client.crm.account_token.retrieve(
+ public_token="public_token",
+)
```
@@ -23302,6 +23143,14 @@ client.filestorage.scopes.default_scopes_retrieve()
-
+**public_token:** `str`
+
+
+
+
+
+-
+
**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -23314,7 +23163,8 @@ client.filestorage.scopes.default_scopes_retrieve()
client.filestorage.scopes.linked_account_scopes_retrieve()
+## Crm Accounts
+client.crm.accounts.list(...)
-
@@ -23326,7 +23176,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 list of `Account` objects.
@@ -23341,13 +23191,42 @@ Get all available permissions for Merge Common Models and fields for a single Li
-
```python
+import datetime
+
from merge import Merge
client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.filestorage.scopes.linked_account_scopes_retrieve()
+response = 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",
+)
+for item in response:
+ yield item
+# alternatively, you can paginate page-by-page
+for page in response.iter_pages():
+ yield page
```
@@ -23363,99 +23242,115 @@ client.filestorage.scopes.linked_account_scopes_retrieve()
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
+
+
+-
+
+**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
+
+
+-
+**cursor:** `typing.Optional[str]` — The pagination cursor value.
+
-
client.filestorage.scopes.linked_account_scopes_create(...)
-
-#### 📝 Description
+**expand:** `typing.Optional[
+ typing.Union[
+ typing.Literal["owner"], typing.Sequence[typing.Literal["owner"]]
+ ]
+]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+
+
+
-
+**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
+
+
+
+
-
-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_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.
+
-#### 🔌 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
-from merge.resources.filestorage import (
- FieldPermissionDeserializerRequest,
- IndividualCommonModelScopeDeserializerRequest,
- ModelPermissionDeserializerRequest,
-)
+**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
+
+
+
-client = Merge(
- account_token="YOUR_ACCOUNT_TOKEN",
- api_key="YOUR_API_KEY",
-)
-client.filestorage.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,
- )
- },
- ),
- ],
-)
+
+-
-```
+**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
+
+
+
+-
+
+**name:** `typing.Optional[str]` — If provided, will only return accounts with this name.
+
-#### ⚙️ Parameters
+
+-
+
+**owner_id:** `typing.Optional[str]` — If provided, will only return accounts with this owner.
+
+
+
-
+**page_size:** `typing.Optional[int]` — Number of results to return per page.
+
+
+
+
-
-**common_models:** `typing.Sequence[IndividualCommonModelScopeDeserializerRequest]` — The common models you want to update the scopes for
+**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
@@ -23475,8 +23370,7 @@ client.filestorage.scopes.linked_account_scopes_create(
client.filestorage.delete_account.delete()
+client.crm.accounts.create(...)
-
@@ -23488,7 +23382,7 @@ client.filestorage.scopes.linked_account_scopes_create(
-
-Delete a linked account.
+Creates an `Account` object with the given values.
@@ -23504,12 +23398,17 @@ Delete a linked account.
```python
from merge import Merge
+from merge.resources.crm import AccountRequest
client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.filestorage.delete_account.delete()
+client.crm.accounts.create(
+ is_debug_mode=True,
+ run_async=True,
+ model=AccountRequest(),
+)
```
@@ -23525,6 +23424,30 @@ client.filestorage.delete_account.delete()
-
+**model:** `AccountRequest`
+
+
+
+
+
+-
+
+**is_debug_mode:** `typing.Optional[bool]` — Whether to include debug fields (such as log file links) in the response.
+
+
+
+
+
+-
+
+**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously.
+
+
+
+
+
+-
+
**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -23537,8 +23460,7 @@ client.filestorage.delete_account.delete()
client.filestorage.drives.list(...)
+client.crm.accounts.retrieve(...)
-
@@ -23550,7 +23472,7 @@ client.filestorage.delete_account.delete()
-
-Returns a list of `Drive` objects.
+Returns an `Account` object with the given `id`.
@@ -23565,34 +23487,17 @@ 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,
+client.crm.accounts.retrieve(
+ id="id",
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,
- remote_id="remote_id",
)
```
@@ -23609,23 +23514,7 @@ client.filestorage.drives.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`
@@ -23633,7 +23522,11 @@ client.filestorage.drives.list(
-
-**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
+**expand:** `typing.Optional[
+ typing.Union[
+ typing.Literal["owner"], typing.Sequence[typing.Literal["owner"]]
+ ]
+]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -23649,39 +23542,7 @@ client.filestorage.drives.list(
-
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
-
-
-
-
-
--
-
-**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 drives with this name. This performs an exact match.
-
-
-
-
-
--
-
-**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.
@@ -23689,7 +23550,7 @@ client.filestorage.drives.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).
@@ -23709,7 +23570,7 @@ client.filestorage.drives.list(
client.filestorage.drives.retrieve(...)
+client.crm.accounts.partial_update(...)
-
@@ -23721,7 +23582,7 @@ client.filestorage.drives.list(
-
-Returns a `Drive` object with the given `id`.
+Updates an `Account` object with the given `id`.
@@ -23737,15 +23598,17 @@ Returns a `Drive` object with the given `id`.
```python
from merge import Merge
+from merge.resources.crm import PatchedAccountRequest
client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.filestorage.drives.retrieve(
+client.crm.accounts.partial_update(
id="id",
- include_remote_data=True,
- include_shell_data=True,
+ is_debug_mode=True,
+ run_async=True,
+ model=PatchedAccountRequest(),
)
```
@@ -23770,7 +23633,7 @@ client.filestorage.drives.retrieve(
-
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
+**model:** `PatchedAccountRequest`
@@ -23778,7 +23641,15 @@ client.filestorage.drives.retrieve(
-
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
+**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.
@@ -23798,8 +23669,7 @@ client.filestorage.drives.retrieve(
client.filestorage.field_mapping.field_mappings_retrieve(...)
+client.crm.accounts.meta_patch_retrieve(...)
-
@@ -23811,7 +23681,7 @@ client.filestorage.drives.retrieve(
-
-Get all Field Mappings for this Linked Account. Field Mappings are mappings between third-party Remote Fields and user defined Merge fields. [Learn more](https://docs.merge.dev/supplemental-data/field-mappings/overview/).
+Returns metadata for `CRMAccount` PATCHs.
@@ -23832,8 +23702,8 @@ 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.crm.accounts.meta_patch_retrieve(
+ id="id",
)
```
@@ -23850,7 +23720,7 @@ client.filestorage.field_mapping.field_mappings_retrieve(
-
-**exclude_remote_field_metadata:** `typing.Optional[bool]` — If `true`, remote fields metadata is excluded from each field mapping instance (i.e. `remote_fields.remote_key_name` and `remote_fields.schema` will be null). This will increase the speed of the request since these fields require some calculations.
+**id:** `str`
@@ -23870,7 +23740,7 @@ client.filestorage.field_mapping.field_mappings_retrieve(
client.filestorage.field_mapping.field_mappings_create(...)
+client.crm.accounts.meta_post_retrieve()
-
@@ -23882,7 +23752,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 metadata for `CRMAccount` POSTs.
@@ -23903,15 +23773,82 @@ 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",
+client.crm.accounts.meta_post_retrieve()
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.crm.accounts.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.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
```
@@ -23927,7 +23864,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.
+**cursor:** `typing.Optional[str]` — The pagination cursor value.
@@ -23935,7 +23872,7 @@ client.filestorage.field_mapping.field_mappings_create(
-
-**target_field_description:** `str` — The description of the target field you want this remote field to map to.
+**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
@@ -23943,7 +23880,7 @@ client.filestorage.field_mapping.field_mappings_create(
-
-**remote_field_traversal_path:** `typing.Sequence[typing.Optional[typing.Any]]` — The field traversal path of the remote field listed when you hit the GET /remote-fields endpoint.
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -23951,7 +23888,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_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.
@@ -23959,7 +23896,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_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -23967,7 +23904,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.
+**is_common_model_field:** `typing.Optional[bool]` — If provided, will only return remote field classes with this is_common_model_field value
@@ -23975,7 +23912,15 @@ 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.
+**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.
@@ -23995,7 +23940,8 @@ client.filestorage.field_mapping.field_mappings_create(
client.filestorage.field_mapping.field_mappings_destroy(...)
+## Crm AsyncPassthrough
+client.crm.async_passthrough.create(...)
-
@@ -24007,7 +23953,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.
+Asynchronously pull data from an endpoint not currently supported by Merge.
@@ -24023,13 +23969,17 @@ Deletes Field Mappings for a Linked Account. All data related to this Field Mapp
```python
from merge import Merge
+from merge.resources.crm import DataPassthroughRequest, MethodEnum
client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.filestorage.field_mapping.field_mappings_destroy(
- field_mapping_id="field_mapping_id",
+client.crm.async_passthrough.create(
+ request=DataPassthroughRequest(
+ method=MethodEnum.GET,
+ path="/scooters",
+ ),
)
```
@@ -24046,7 +23996,7 @@ client.filestorage.field_mapping.field_mappings_destroy(
-
-**field_mapping_id:** `str`
+**request:** `DataPassthroughRequest`
@@ -24066,7 +24016,7 @@ client.filestorage.field_mapping.field_mappings_destroy(
client.filestorage.field_mapping.field_mappings_partial_update(...)
+client.crm.async_passthrough.retrieve(...)
-
@@ -24078,7 +24028,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.
+Retrieves data from earlier async-passthrough POST request
@@ -24099,8 +24049,8 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.filestorage.field_mapping.field_mappings_partial_update(
- field_mapping_id="field_mapping_id",
+client.crm.async_passthrough.retrieve(
+ async_passthrough_receipt_id="async_passthrough_receipt_id",
)
```
@@ -24117,31 +24067,7 @@ client.filestorage.field_mapping.field_mappings_partial_update(
-
-**field_mapping_id:** `str`
-
-
-
-
-
--
-
-**remote_field_traversal_path:** `typing.Optional[typing.Sequence[typing.Optional[typing.Any]]]` — The field traversal path of the remote field listed when you hit the GET /remote-fields endpoint.
-
-
-
-
-
--
-
-**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.
+**async_passthrough_receipt_id:** `str`
@@ -24161,7 +24087,8 @@ client.filestorage.field_mapping.field_mappings_partial_update(
client.filestorage.field_mapping.remote_fields_retrieve(...)
+## Crm AuditTrail
+client.crm.audit_trail.list(...)
-
@@ -24173,7 +24100,7 @@ client.filestorage.field_mapping.field_mappings_partial_update(
-
-Get all remote fields for a Linked Account. Remote fields are third-party fields that are accessible after initial sync if remote_data is enabled. You can use remote fields to override existing Merge fields or map a new Merge field. [Learn more](https://docs.merge.dev/supplemental-data/field-mappings/overview/).
+Gets a list of audit trail events.
@@ -24194,10 +24121,19 @@ 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",
+response = 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",
)
+for item in response:
+ yield item
+# alternatively, you can paginate page-by-page
+for page in response.iter_pages():
+ yield page
```
@@ -24213,7 +24149,7 @@ client.filestorage.field_mapping.remote_fields_retrieve(
-
-**common_models:** `typing.Optional[str]` — A comma seperated list of Common Model names. If included, will only return Remote Fields for those Common Models.
+**cursor:** `typing.Optional[str]` — The pagination cursor value.
@@ -24221,7 +24157,39 @@ 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.
+**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.
@@ -24241,7 +24209,8 @@ client.filestorage.field_mapping.remote_fields_retrieve(
client.filestorage.field_mapping.target_fields_retrieve()
+## Crm AvailableActions
+client.crm.available_actions.retrieve()
-
@@ -24253,7 +24222,7 @@ client.filestorage.field_mapping.remote_fields_retrieve(
-
-Get all organization-wide Target Fields, this will not include any Linked Account specific Target Fields. Organization-wide Target Fields are additional fields appended to the Merge Common Model for all Linked Accounts in a category. [Learn more](https://docs.merge.dev/supplemental-data/field-mappings/target-fields/).
+Returns a list of models and actions available for an account.
@@ -24274,7 +24243,7 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.filestorage.field_mapping.target_fields_retrieve()
+client.crm.available_actions.retrieve()
```
@@ -24302,8 +24271,8 @@ client.filestorage.field_mapping.target_fields_retrieve()
client.filestorage.files.list(...)
+## Crm Contacts
+client.crm.contacts.list(...)
-
@@ -24315,7 +24284,7 @@ client.filestorage.field_mapping.target_fields_retrieve()
-
-Returns a list of `File` objects.
+Returns a list of `Contact` objects.
@@ -24333,16 +24302,13 @@ Returns a list of `File` objects.
import datetime
from merge import Merge
-from merge.resources.filestorage.resources.files import (
- FilesListRequestExpand,
- FilesListRequestOrderBy,
-)
client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.filestorage.files.list(
+response = client.crm.contacts.list(
+ account_id="account_id",
created_after=datetime.datetime.fromisoformat(
"2024-01-15 09:30:00+00:00",
),
@@ -24350,30 +24316,26 @@ client.filestorage.files.list(
"2024-01-15 09:30:00+00:00",
),
cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
- drive_id="drive_id",
- expand=FilesListRequestExpand.DRIVE,
- folder_id="folder_id",
+ email_addresses="email_addresses",
include_deleted_data=True,
include_remote_data=True,
+ include_remote_fields=True,
include_shell_data=True,
- mime_type="mime_type",
modified_after=datetime.datetime.fromisoformat(
"2024-01-15 09:30:00+00:00",
),
modified_before=datetime.datetime.fromisoformat(
"2024-01-15 09:30:00+00:00",
),
- name="name",
- order_by=FilesListRequestOrderBy.CREATED_AT_DESCENDING,
page_size=1,
- remote_created_after=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- remote_created_before=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
+ 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
```
@@ -24389,7 +24351,7 @@ client.filestorage.files.list(
-
-**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
+**account_id:** `typing.Optional[str]` — If provided, will only return contacts with this account.
@@ -24397,7 +24359,7 @@ client.filestorage.files.list(
-
-**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
+**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
@@ -24405,7 +24367,7 @@ client.filestorage.files.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.
@@ -24413,7 +24375,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.
+**cursor:** `typing.Optional[str]` — The pagination cursor value.
@@ -24421,7 +24383,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.
+**email_addresses:** `typing.Optional[str]` — If provided, will only return contacts matching the email addresses; multiple email_addresses can be separated by commas.
@@ -24429,7 +24391,12 @@ 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.
+**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.
@@ -24453,7 +24420,7 @@ client.filestorage.files.list(
-
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
+**include_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.
@@ -24461,7 +24428,7 @@ client.filestorage.files.list(
-
-**mime_type:** `typing.Optional[str]` — If provided, will only return files with these mime_types. Multiple values can be separated by commas.
+**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -24485,22 +24452,6 @@ client.filestorage.files.list(
-
-**name:** `typing.Optional[str]` — If provided, will only return files with this name. This performs an exact match.
-
-
-
-
-
--
-
-**order_by:** `typing.Optional[FilesListRequestOrderBy]` — Overrides the default ordering for this endpoint. Possible values include: created_at, -created_at, modified_at, -modified_at.
-
-
-
-
-
--
-
**page_size:** `typing.Optional[int]` — Number of results to return per page.
@@ -24509,15 +24460,7 @@ client.filestorage.files.list(
-
-**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.
+**phone_numbers:** `typing.Optional[str]` — If provided, will only return contacts matching the phone numbers; multiple phone numbers can be separated by commas.
@@ -24545,7 +24488,7 @@ client.filestorage.files.list(
client.filestorage.files.create(...)
+client.crm.contacts.create(...)
-
@@ -24557,7 +24500,7 @@ client.filestorage.files.list(
-
-Creates a `File` object with the given values.
+Creates a `Contact` object with the given values.
@@ -24573,16 +24516,16 @@ Creates a `File` object with the given values.
```python
from merge import Merge
-from merge.resources.filestorage import FileRequest
+from merge.resources.crm import ContactRequest
client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.filestorage.files.create(
+client.crm.contacts.create(
is_debug_mode=True,
run_async=True,
- model=FileRequest(),
+ model=ContactRequest(),
)
```
@@ -24599,7 +24542,7 @@ client.filestorage.files.create(
-
-**model:** `FileRequest`
+**model:** `ContactRequest`
@@ -24635,7 +24578,7 @@ client.filestorage.files.create(
client.filestorage.files.retrieve(...)
+client.crm.contacts.retrieve(...)
-
@@ -24647,7 +24590,7 @@ client.filestorage.files.create(
-
-Returns a `File` object with the given `id`.
+Returns a `Contact` object with the given `id`.
@@ -24663,18 +24606,15 @@ 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.filestorage.files.retrieve(
+client.crm.contacts.retrieve(
id="id",
- expand=FilesRetrieveRequestExpand.DRIVE,
include_remote_data=True,
+ include_remote_fields=True,
include_shell_data=True,
)
@@ -24700,7 +24640,12 @@ 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.
+**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.
@@ -24716,6 +24661,14 @@ client.filestorage.files.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).
@@ -24736,7 +24689,7 @@ client.filestorage.files.retrieve(
client.filestorage.files.download_request_meta_retrieve(...)
+client.crm.contacts.partial_update(...)
-
@@ -24748,7 +24701,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.
+Updates a `Contact` object with the given `id`.
@@ -24764,14 +24717,17 @@ Returns metadata to construct an authenticated file download request for a singu
```python
from merge import Merge
+from merge.resources.crm import PatchedContactRequest
client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.filestorage.files.download_request_meta_retrieve(
+client.crm.contacts.partial_update(
id="id",
- mime_type="mime_type",
+ is_debug_mode=True,
+ run_async=True,
+ model=PatchedContactRequest(),
)
```
@@ -24796,7 +24752,23 @@ client.filestorage.files.download_request_meta_retrieve(
-
-**mime_type:** `typing.Optional[str]` — If provided, specifies the export format of the file to be downloaded. For information on supported export formats, please refer to our export format help center article.
+**model:** `PatchedContactRequest`
+
+
+
+
+
+-
+
+**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.
@@ -24816,7 +24788,7 @@ client.filestorage.files.download_request_meta_retrieve(
client.filestorage.files.download_request_meta_list(...)
+client.crm.contacts.ignore_create(...)
-
@@ -24828,7 +24800,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.
+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.
@@ -24844,24 +24816,17 @@ Returns metadata to construct authenticated file download requests, allowing you
```python
from merge import Merge
-from merge.resources.filestorage.resources.files import (
- FilesDownloadRequestMetaListRequestOrderBy,
-)
+from merge.resources.crm import IgnoreCommonModelRequest, ReasonEnum
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.crm.contacts.ignore_create(
+ model_id="model_id",
+ request=IgnoreCommonModelRequest(
+ reason=ReasonEnum.GENERAL_CUSTOMER_REQUEST,
+ ),
)
```
@@ -24878,7 +24843,7 @@ client.filestorage.files.download_request_meta_list(
-
-**created_after:** `typing.Optional[str]` — If provided, will only return objects created after this datetime.
+**model_id:** `str`
@@ -24886,7 +24851,7 @@ client.filestorage.files.download_request_meta_list(
-
-**created_before:** `typing.Optional[str]` — If provided, will only return objects created before this datetime.
+**request:** `IgnoreCommonModelRequest`
@@ -24894,63 +24859,70 @@ client.filestorage.files.download_request_meta_list(
-
-**cursor:** `typing.Optional[str]` — The pagination cursor value.
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
-
--
-**ids:** `typing.Optional[typing.Union[str, typing.Sequence[str]]]` — If provided, will only return objects with the given IDs. Comma-separated list of strings.
-
+client.crm.contacts.meta_patch_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
-
-**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.
-
+Returns metadata for `CRMContact` PATCHs.
+
+
+#### 🔌 Usage
+
-
-**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.
-
+```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",
+)
+
+```
+
+
+#### ⚙️ Parameters
+
-
-**page_size:** `typing.Optional[int]` — Number of results to return per page.
+
+-
+
+**id:** `str`
@@ -24970,7 +24942,7 @@ client.filestorage.files.download_request_meta_list(
client.filestorage.files.meta_post_retrieve()
+client.crm.contacts.meta_post_retrieve()
-
@@ -24982,7 +24954,7 @@ client.filestorage.files.download_request_meta_list(
-
-Returns metadata for `FileStorageFile` POSTs.
+Returns metadata for `CRMContact` POSTs.
@@ -25003,7 +24975,7 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.filestorage.files.meta_post_retrieve()
+client.crm.contacts.meta_post_retrieve()
```
@@ -25031,8 +25003,7 @@ client.filestorage.files.meta_post_retrieve()
client.filestorage.folders.list(...)
+client.crm.contacts.remote_field_classes_list(...)
-
@@ -25044,7 +25015,7 @@ client.filestorage.files.meta_post_retrieve()
-
-Returns a list of `Folder` objects.
+Returns a list of `RemoteFieldClass` objects.
@@ -25059,41 +25030,27 @@ 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.crm.contacts.remote_field_classes_list(
cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
- drive_id="drive_id",
- expand=FoldersListRequestExpand.DRIVE,
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",
+ is_common_model_field=True,
+ is_custom=True,
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
```
@@ -25109,7 +25066,7 @@ client.filestorage.folders.list(
-
-**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
+**cursor:** `typing.Optional[str]` — The pagination cursor value.
@@ -25117,7 +25074,7 @@ client.filestorage.folders.list(
-
-**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
+**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
@@ -25125,7 +25082,7 @@ client.filestorage.folders.list(
-
-**cursor:** `typing.Optional[str]` — The pagination cursor value.
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -25133,7 +25090,7 @@ client.filestorage.folders.list(
-
-**drive_id:** `typing.Optional[str]` — If provided, will only return folders in this drive.
+**include_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.
@@ -25141,7 +25098,7 @@ client.filestorage.folders.list(
-
-**expand:** `typing.Optional[FoldersListRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -25149,7 +25106,7 @@ client.filestorage.folders.list(
-
-**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
+**is_common_model_field:** `typing.Optional[bool]` — If provided, will only return remote field classes with this is_common_model_field value
@@ -25157,7 +25114,7 @@ client.filestorage.folders.list(
-
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
+**is_custom:** `typing.Optional[bool]` — If provided, will only return remote fields classes with this is_custom value
@@ -25165,7 +25122,7 @@ client.filestorage.folders.list(
-
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
+**page_size:** `typing.Optional[int]` — Number of results to return per page.
@@ -25173,47 +25130,95 @@ client.filestorage.folders.list(
-
-**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
-
--
-**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
-
+client.crm.custom_object_classes.list(...)
-
-**name:** `typing.Optional[str]` — If provided, will only return folders with this name. This performs an exact match.
-
-
-
+#### 📝 Description
-
-**page_size:** `typing.Optional[int]` — Number of results to return per page.
-
+
+-
+
+Returns a list of `CustomObjectClass` objects.
+
+
+
+#### 🔌 Usage
-
-**parent_folder_id:** `typing.Optional[str]` — If provided, will only return folders in this parent folder. If null, will return folders in root directory.
-
+
+-
+
+```python
+import datetime
+
+from merge import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+response = 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",
+)
+for item in response:
+ yield item
+# alternatively, you can paginate page-by-page
+for page in response.iter_pages():
+ yield page
+
+```
+
+
+#### ⚙️ Parameters
+
-
-**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
+
+-
+
+**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
@@ -25221,73 +25226,67 @@ client.filestorage.folders.list(
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
-
-
+
+-
+**cursor:** `typing.Optional[str]` — The pagination cursor value.
+
-client.filestorage.folders.create(...)
-
-#### 📝 Description
-
-
--
+**expand:** `typing.Optional[
+ typing.Union[
+ typing.Literal["fields"], typing.Sequence[typing.Literal["fields"]]
+ ]
+]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+
+
+
-
-Creates a `Folder` object with the given values.
-
-
+**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
+
-#### 🔌 Usage
-
-
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
+
+
+
+
-
-```python
-from merge import Merge
-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(),
-)
-
-```
-
-
+**include_shell_data:** `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.
+
+
+
+
-
-**model:** `FolderRequest`
+**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
@@ -25295,7 +25294,7 @@ client.filestorage.folders.create(
-
-**is_debug_mode:** `typing.Optional[bool]` — Whether to include debug fields (such as log file links) in the response.
+**page_size:** `typing.Optional[int]` — Number of results to return per page.
@@ -25303,7 +25302,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.
@@ -25323,7 +25322,7 @@ client.filestorage.folders.create(
client.filestorage.folders.retrieve(...)
+client.crm.custom_object_classes.retrieve(...)
-
@@ -25335,7 +25334,7 @@ client.filestorage.folders.create(
-
-Returns a `Folder` object with the given `id`.
+Returns a `CustomObjectClass` object with the given `id`.
@@ -25351,17 +25350,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.crm.custom_object_classes.retrieve(
id="id",
- expand=FoldersRetrieveRequestExpand.DRIVE,
include_remote_data=True,
include_shell_data=True,
)
@@ -25388,7 +25383,11 @@ 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[
+ typing.Literal["fields"], typing.Sequence[typing.Literal["fields"]]
+ ]
+]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -25424,7 +25423,8 @@ client.filestorage.folders.retrieve(
client.filestorage.folders.meta_post_retrieve()
+## Crm AssociationTypes
+client.crm.association_types.custom_object_classes_association_types_list(...)
-
@@ -25436,7 +25436,7 @@ client.filestorage.folders.retrieve(
-
-Returns metadata for `FileStorageFolder` POSTs.
+Returns a list of `AssociationType` objects.
@@ -25451,13 +25451,42 @@ Returns metadata for `FileStorageFolder` POSTs.
-
```python
+import datetime
+
from merge import Merge
client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.filestorage.folders.meta_post_retrieve()
+response = (
+ 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",
+ )
+)
+for item in response:
+ yield item
+# alternatively, you can paginate page-by-page
+for page in response.iter_pages():
+ yield page
```
@@ -25473,71 +25502,100 @@ client.filestorage.folders.meta_post_retrieve()
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+**custom_object_class_id:** `str`
-
-
+
+-
+**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
+
-client.filestorage.generate_key.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.
+
+
+
+
-
-Create a remote key.
+**expand:** `typing.Optional[
+ typing.Union[
+ typing.Literal["target_object_classes"],
+ typing.Sequence[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/).
+
-#### 🔌 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.generate_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.
@@ -25557,8 +25615,7 @@ client.filestorage.generate_key.create(
client.filestorage.groups.list(...)
+client.crm.association_types.custom_object_classes_association_types_create(...)
-
@@ -25570,7 +25627,7 @@ client.filestorage.generate_key.create(
-
-Returns a list of `Group` objects.
+Creates an `AssociationType` object with the given values.
@@ -25585,33 +25642,34 @@ Returns a list of `Group` objects.
-
```python
-import datetime
-
from merge import Merge
+from merge.resources.crm import (
+ AssociationTypeRequestRequest,
+ ObjectClassDescriptionRequest,
+ OriginTypeEnum,
+)
client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.filestorage.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",
+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",
),
- page_size=1,
- remote_id="remote_id",
)
```
@@ -25628,7 +25686,7 @@ client.filestorage.groups.list(
-
-**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
+**custom_object_class_id:** `str`
@@ -25636,7 +25694,7 @@ client.filestorage.groups.list(
-
-**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
+**model:** `AssociationTypeRequestRequest`
@@ -25644,7 +25702,7 @@ client.filestorage.groups.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.
@@ -25652,7 +25710,7 @@ client.filestorage.groups.list(
-
-**expand:** `typing.Optional[typing.Literal["child_groups"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously.
@@ -25660,23 +25718,73 @@ client.filestorage.groups.list(
-
-**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+client.crm.association_types.custom_object_classes_association_types_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 an `AssociationType` 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.crm.association_types.custom_object_classes_association_types_retrieve(
+ custom_object_class_id="custom_object_class_id",
+ id="id",
+ include_remote_data=True,
+ include_shell_data=True,
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**custom_object_class_id:** `str`
@@ -25684,7 +25792,7 @@ client.filestorage.groups.list(
-
-**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
+**id:** `str`
@@ -25692,7 +25800,12 @@ client.filestorage.groups.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[
+ typing.Literal["target_object_classes"],
+ typing.Sequence[typing.Literal["target_object_classes"]],
+ ]
+]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -25700,7 +25813,7 @@ client.filestorage.groups.list(
-
-**page_size:** `typing.Optional[int]` — Number of results to return per page.
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -25708,7 +25821,7 @@ client.filestorage.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).
@@ -25728,7 +25841,7 @@ client.filestorage.groups.list(
client.filestorage.groups.retrieve(...)
+client.crm.association_types.custom_object_classes_association_types_meta_post_retrieve(...)
-
@@ -25740,7 +25853,7 @@ client.filestorage.groups.list(
-
-Returns a `Group` object with the given `id`.
+Returns metadata for `CRMAssociationType` POSTs.
@@ -25761,10 +25874,8 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.filestorage.groups.retrieve(
- id="id",
- include_remote_data=True,
- include_shell_data=True,
+client.crm.association_types.custom_object_classes_association_types_meta_post_retrieve(
+ custom_object_class_id="custom_object_class_id",
)
```
@@ -25781,31 +25892,7 @@ client.filestorage.groups.retrieve(
-
-**id:** `str`
-
-
-
-
-
--
-
-**expand:** `typing.Optional[typing.Literal["child_groups"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
-
-
-
-
-
--
-
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
-
-
-
-
-
--
-
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
+**custom_object_class_id:** `str`
@@ -25825,8 +25912,8 @@ client.filestorage.groups.retrieve(
client.filestorage.issues.list(...)
+## Crm CustomObjects
+client.crm.custom_objects.custom_object_classes_custom_objects_list(...)
-
@@ -25838,7 +25925,7 @@ client.filestorage.groups.retrieve(
-
-Gets all issues for Organization.
+Returns a list of `CustomObject` objects.
@@ -25856,36 +25943,38 @@ Gets all issues for Organization.
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",
- cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
- end_date="end_date",
- end_user_organization_name="end_user_organization_name",
- first_incident_time_after=datetime.datetime.fromisoformat(
+response = 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",
),
- first_incident_time_before=datetime.datetime.fromisoformat(
+ created_before=datetime.datetime.fromisoformat(
"2024-01-15 09:30:00+00:00",
),
- include_muted="include_muted",
- integration_name="integration_name",
- last_incident_time_after=datetime.datetime.fromisoformat(
+ cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
+ 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",
),
- last_incident_time_before=datetime.datetime.fromisoformat(
+ modified_before=datetime.datetime.fromisoformat(
"2024-01-15 09:30:00+00:00",
),
- linked_account_id="linked_account_id",
page_size=1,
- start_date="start_date",
- status=IssuesListRequestStatus.ONGOING,
+ 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
```
@@ -25901,15 +25990,7 @@ client.filestorage.issues.list(
-
-**account_token:** `typing.Optional[str]`
-
-
-
-
-
--
-
-**cursor:** `typing.Optional[str]` — The pagination cursor value.
+**custom_object_class_id:** `str`
@@ -25917,7 +25998,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.
@@ -25925,7 +26006,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.
@@ -25933,7 +26014,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.
@@ -25941,7 +26022,7 @@ client.filestorage.issues.list(
-
-**first_incident_time_before:** `typing.Optional[dt.datetime]` — If provided, will only return issues whose first incident time was before this datetime.
+**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
@@ -25949,7 +26030,7 @@ client.filestorage.issues.list(
-
-**include_muted:** `typing.Optional[str]` — If true, will include muted issues
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -25957,7 +26038,7 @@ client.filestorage.issues.list(
-
-**integration_name:** `typing.Optional[str]`
+**include_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.
@@ -25965,7 +26046,7 @@ client.filestorage.issues.list(
-
-**last_incident_time_after:** `typing.Optional[dt.datetime]` — If provided, will only return issues whose last incident time was after this datetime.
+**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -25973,7 +26054,7 @@ client.filestorage.issues.list(
-
-**last_incident_time_before:** `typing.Optional[dt.datetime]` — If provided, will only return issues whose last incident time was before this datetime.
+**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
@@ -25981,7 +26062,7 @@ client.filestorage.issues.list(
-
-**linked_account_id:** `typing.Optional[str]` — If provided, will only include issues pertaining to the linked account passed in.
+**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
@@ -25997,20 +26078,7 @@ client.filestorage.issues.list(
-
-**start_date:** `typing.Optional[str]` — If included, will only include issues whose most recent action occurred after this time
-
-
-
-
-
--
-
-**status:** `typing.Optional[IssuesListRequestStatus]`
-
-Status of the issue. Options: ('ONGOING', 'RESOLVED')
-
-* `ONGOING` - ONGOING
-* `RESOLVED` - RESOLVED
+**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
@@ -26030,7 +26098,7 @@ Status of the issue. Options: ('ONGOING', 'RESOLVED')
client.filestorage.issues.retrieve(...)
+client.crm.custom_objects.custom_object_classes_custom_objects_create(...)
-
@@ -26042,7 +26110,7 @@ Status of the issue. Options: ('ONGOING', 'RESOLVED')
-
-Get a specific issue.
+Creates a `CustomObject` object with the given values.
@@ -26058,13 +26126,19 @@ Get a specific issue.
```python
from merge import Merge
+from merge.resources.crm import CustomObjectRequest
client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.filestorage.issues.retrieve(
- id="id",
+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"},
+ ),
)
```
@@ -26081,7 +26155,31 @@ client.filestorage.issues.retrieve(
-
-**id:** `str`
+**custom_object_class_id:** `str`
+
+
+
+
+
+-
+
+**model:** `CustomObjectRequest`
+
+
+
+
+
+-
+
+**is_debug_mode:** `typing.Optional[bool]` — Whether to include debug fields (such as log file links) in the response.
+
+
+
+
+
+-
+
+**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously.
@@ -26101,8 +26199,7 @@ client.filestorage.issues.retrieve(
client.filestorage.link_token.create(...)
+client.crm.custom_objects.custom_object_classes_custom_objects_retrieve(...)
-
@@ -26114,7 +26211,7 @@ client.filestorage.issues.retrieve(
-
-Creates a link token to be used when linking a new end user.
+Returns a `CustomObject` object with the given `id`.
@@ -26130,17 +26227,17 @@ Creates a link token to be used when linking a new end user.
```python
from merge import Merge
-from merge.resources.filestorage import CategoriesEnum
client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.filestorage.link_token.create(
- end_user_email_address="example@gmail.com",
- end_user_organization_name="Test Organization",
- end_user_origin_id="12345",
- categories=[CategoriesEnum.HRIS, CategoriesEnum.ATS],
+client.crm.custom_objects.custom_object_classes_custom_objects_retrieve(
+ custom_object_class_id="custom_object_class_id",
+ id="id",
+ include_remote_data=True,
+ include_remote_fields=True,
+ include_shell_data=True,
)
```
@@ -26157,7 +26254,7 @@ client.filestorage.link_token.create(
-
-**end_user_email_address:** `str` — Your end user's email address. This is purely for identification purposes - setting this value will not cause any emails to be sent.
+**custom_object_class_id:** `str`
@@ -26165,7 +26262,7 @@ client.filestorage.link_token.create(
-
-**end_user_organization_name:** `str` — Your end user's organization.
+**id:** `str`
@@ -26173,7 +26270,7 @@ client.filestorage.link_token.create(
-
-**end_user_origin_id:** `str` — This unique identifier typically represents the ID for your end user in your product's database. This value must be distinct from other Linked Accounts' unique identifiers.
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -26181,7 +26278,7 @@ client.filestorage.link_token.create(
-
-**categories:** `typing.Sequence[CategoriesEnum]` — The integration categories to show in Merge Link.
+**include_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.
@@ -26189,7 +26286,7 @@ client.filestorage.link_token.create(
-
-**integration:** `typing.Optional[str]` — The slug of a specific pre-selected integration for this linking flow token. For examples of slugs, see https://docs.merge.dev/guides/merge-link/single-integration/.
+**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -26197,75 +26294,70 @@ client.filestorage.link_token.create(
-
-**link_expiry_mins:** `typing.Optional[int]` — An integer number of minutes between [30, 720 or 10080 if for a Magic Link URL] for how long this token is valid. Defaults to 30.
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
-
--
-**should_create_magic_link_url:** `typing.Optional[bool]` — Whether to generate a Magic Link URL. Defaults to false. For more information on Magic Link, see https://merge.dev/blog/integrations-fast-say-hello-to-magic-link.
-
+client.crm.custom_objects.custom_object_classes_custom_objects_meta_post_retrieve(...)
-
-**hide_admin_magic_link:** `typing.Optional[bool]` — Whether to generate a Magic Link URL on the Admin Needed screen during the linking flow. Defaults to false. For more information on Magic Link, see https://merge.dev/blog/integrations-fast-say-hello-to-magic-link.
-
-
-
+#### 📝 Description
-
-**common_models:** `typing.Optional[typing.Sequence[CommonModelScopesBodyRequest]]` — An array of objects to specify the models and fields that will be disabled for a given Linked Account. Each object uses model_id, enabled_actions, and disabled_fields to specify the model, method, and fields that are scoped for a given Linked Account.
-
-
-
-
-
-**category_common_model_scopes:** `typing.Optional[
- typing.Dict[
- str,
- typing.Optional[
- typing.Sequence[IndividualCommonModelScopeDeserializerRequest]
- ],
- ]
-]` — When creating a Link Token, you can set permissions for Common Models that will apply to the account that is going to be linked. Any model or field not specified in link token payload will default to existing settings.
-
+Returns metadata for `CRMCustomObject` POSTs.
+
+
+#### 🔌 Usage
+
-
-**language:** `typing.Optional[LanguageEnum]`
+
+-
-The following subset of IETF language tags can be used to configure localization.
+```python
+from merge import Merge
-* `en` - en
-* `de` - de
-
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.crm.custom_objects.custom_object_classes_custom_objects_meta_post_retrieve(
+ custom_object_class_id="custom_object_class_id",
+)
+
+```
+
+
+#### ⚙️ Parameters
+
-
-**are_syncs_disabled:** `typing.Optional[bool]` — The boolean that indicates whether initial, periodic, and force syncs will be disabled.
-
-
-
-
-
-**integration_specific_config:** `typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]]` — A JSON object containing integration-specific configuration options.
+**custom_object_class_id:** `str`
@@ -26285,8 +26377,7 @@ The following subset of IETF language tags can be used to configure localization
client.filestorage.linked_accounts.list(...)
+client.crm.custom_objects.custom_object_classes_custom_objects_remote_field_classes_list(...)
-
@@ -26298,7 +26389,7 @@ The following subset of IETF language tags can be used to configure localization
-
-List linked accounts for your organization.
+Returns a list of `RemoteFieldClass` objects.
@@ -26314,29 +26405,26 @@ List linked accounts for your organization.
```python
from merge import Merge
-from merge.resources.filestorage.resources.linked_accounts import (
- LinkedAccountsListRequestCategory,
-)
client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.filestorage.linked_accounts.list(
- category=LinkedAccountsListRequestCategory.ACCOUNTING,
+response = client.crm.custom_objects.custom_object_classes_custom_objects_remote_field_classes_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",
+ 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,
- status="status",
)
+for item in response:
+ yield item
+# alternatively, you can paginate page-by-page
+for page in response.iter_pages():
+ yield page
```
@@ -26352,24 +26440,6 @@ client.filestorage.linked_accounts.list(
-
-**category:** `typing.Optional[LinkedAccountsListRequestCategory]`
-
-Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing`
-
-* `hris` - hris
-* `ats` - ats
-* `accounting` - accounting
-* `ticketing` - ticketing
-* `crm` - crm
-* `mktg` - mktg
-* `filestorage` - filestorage
-
-
-
-
-
--
-
**cursor:** `typing.Optional[str]` — The pagination cursor value.
@@ -26378,31 +26448,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.
-
-
-
-
-
--
-
-**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.
+**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
@@ -26410,7 +26456,7 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing`
-
-**id:** `typing.Optional[str]`
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -26418,7 +26464,7 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing`
-
-**ids:** `typing.Optional[str]` — Comma-separated list of LinkedAccount IDs, making it possible to specify multiple LinkedAccounts at once.
+**include_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.
@@ -26426,7 +26472,7 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing`
-
-**include_duplicates:** `typing.Optional[bool]` — If `true`, will include complete production duplicates of the account specified by the `id` query parameter in the response. `id` must be for a complete production linked account.
+**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -26434,7 +26480,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.
+**is_common_model_field:** `typing.Optional[bool]` — If provided, will only return remote field classes with this is_common_model_field value
@@ -26442,7 +26488,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_custom:** `typing.Optional[bool]` — If provided, will only return remote fields classes with this is_custom value
@@ -26458,14 +26504,6 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing`
-
-**status:** `typing.Optional[str]` — Filter by status. Options: `COMPLETE`, `IDLE`, `INCOMPLETE`, `RELINK_NEEDED`
-
-
-
-
-
--
-
**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -26478,8 +26516,8 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing`
client.filestorage.passthrough.create(...)
+## Crm Associations
+client.crm.associations.custom_object_classes_custom_objects_associations_list(...)
-
@@ -26491,7 +26529,7 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing`
-
-Pull data from an endpoint not currently supported by Merge.
+Returns a list of `Association` objects.
@@ -26506,19 +26544,42 @@ Pull data from an endpoint not currently supported by Merge.
-
```python
+import datetime
+
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",
+response = 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",
)
+for item in response:
+ yield item
+# alternatively, you can paginate page-by-page
+for page in response.iter_pages():
+ yield page
```
@@ -26534,7 +26595,7 @@ client.filestorage.passthrough.create(
-
-**request:** `DataPassthroughRequest`
+**custom_object_class_id:** `str`
@@ -26542,71 +26603,31 @@ client.filestorage.passthrough.create(
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+**object_id:** `str`
-
-
-
-
-
-
-client.filestorage.regenerate_key.create(...)
-
--
-
-#### 📝 Description
-
-
--
-
-Exchange remote keys.
-
-
+**association_type_id:** `typing.Optional[str]` — If provided, will only return opportunities with this association_type.
+
-#### 🔌 Usage
-
-
--
-
-
-```python
-from merge import Merge
-
-client = Merge(
- account_token="YOUR_ACCOUNT_TOKEN",
- api_key="YOUR_API_KEY",
-)
-client.filestorage.regenerate_key.create(
- name="Remote Deployment Key 1",
-)
-
-```
-
-
+**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
+
-#### ⚙️ Parameters
-
-
--
-
-
-**name:** `str` — The name of the remote key
+**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
@@ -26614,72 +26635,36 @@ client.filestorage.regenerate_key.create(
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+**cursor:** `typing.Optional[str]` — The pagination cursor value.
-
-
-
-
-
-
-client.filestorage.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).
-
-
+**expand:** `typing.Optional[
+ typing.Union[
+ typing.Literal["association_type"],
+ typing.Sequence[typing.Literal["association_type"]],
+ ]
+]` — 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.filestorage.sync_status.list(
- cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
- page_size=1,
-)
-
-```
-
-
+**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is 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
-
-
--
-
-
-**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.
@@ -26687,7 +26672,7 @@ client.filestorage.sync_status.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).
@@ -26695,65 +26680,35 @@ client.filestorage.sync_status.list(
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
-
-
-
-
-
-
-client.filestorage.force_resync.sync_status_resync_create()
-
-#### 📝 Description
-
-
--
+**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
+
+
+
-
-Force re-sync of all models. This endpoint is available for monthly, quarterly, and highest sync frequency customers on the Professional or Enterprise plans. Doing so will consume a sync credit for the relevant linked account. Force re-syncs can also be triggered manually in the Merge Dashboard and is available for all customers.
-
-
+**page_size:** `typing.Optional[int]` — Number of results to return per page.
+
-#### 🔌 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()
-
-```
-
-
+**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
+
-#### ⚙️ Parameters
-
-
--
-
-
@@ -26769,8 +26724,7 @@ client.filestorage.force_resync.sync_status_resync_create()
client.filestorage.users.list(...)
+client.crm.associations.custom_object_classes_custom_objects_associations_update(...)
-
@@ -26782,7 +26736,7 @@ client.filestorage.force_resync.sync_status_resync_create()
-
-Returns a list of `User` objects.
+Creates an Association between `source_object_id` and `target_object_id` of type `association_type_id`.
@@ -26797,34 +26751,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",
- ),
- 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",
+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,
)
```
@@ -26841,39 +26781,7 @@ client.filestorage.users.list(
-
-**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
-
-
-
-
-
--
-
-**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
-
-
-
-
-
--
-
-**cursor:** `typing.Optional[str]` — The pagination cursor value.
-
-
-
-
-
--
-
-**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is 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.
+**source_class_id:** `str`
@@ -26881,7 +26789,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).
+**source_object_id:** `str`
@@ -26889,7 +26797,7 @@ client.filestorage.users.list(
-
-**is_me:** `typing.Optional[str]` — If provided, will only return the user object for requestor.
+**target_class_id:** `str`
@@ -26897,7 +26805,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.
+**target_object_id:** `str`
@@ -26905,7 +26813,7 @@ client.filestorage.users.list(
-
-**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
+**association_type_id:** `str`
@@ -26913,7 +26821,7 @@ client.filestorage.users.list(
-
-**page_size:** `typing.Optional[int]` — Number of results to return per page.
+**is_debug_mode:** `typing.Optional[bool]` — Whether to include debug fields (such as log file links) in the response.
@@ -26921,7 +26829,7 @@ client.filestorage.users.list(
-
-**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
+**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously.
@@ -26941,7 +26849,8 @@ client.filestorage.users.list(
client.filestorage.users.retrieve(...)
+## Crm Scopes
+client.crm.scopes.default_scopes_retrieve()
-
@@ -26953,7 +26862,7 @@ client.filestorage.users.list(
-
-Returns a `User` 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).
@@ -26974,11 +26883,7 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.filestorage.users.retrieve(
- id="id",
- include_remote_data=True,
- include_shell_data=True,
-)
+client.crm.scopes.default_scopes_retrieve()
```
@@ -26994,30 +26899,6 @@ client.filestorage.users.retrieve(
-
-**id:** `str`
-
-
-
-
-
--
-
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
-
-
-
-
-
--
-
-**include_shell_data:** `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.
@@ -27030,8 +26911,7 @@ client.filestorage.users.retrieve(
client.filestorage.webhook_receivers.list()
+client.crm.scopes.linked_account_scopes_retrieve()
-
@@ -27043,7 +26923,7 @@ client.filestorage.users.retrieve(
-
-Returns a list of `WebhookReceiver` objects.
+Get all available permissions for Merge Common Models and fields for a single Linked Account. [Learn more](https://help.merge.dev/en/articles/5950052-common-model-and-field-scopes).
@@ -27064,7 +26944,7 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.filestorage.webhook_receivers.list()
+client.crm.scopes.linked_account_scopes_retrieve()
```
@@ -27092,7 +26972,7 @@ client.filestorage.webhook_receivers.list()
client.filestorage.webhook_receivers.create(...)
+client.crm.scopes.linked_account_scopes_create(...)
-
@@ -27104,7 +26984,7 @@ client.filestorage.webhook_receivers.list()
-
-Creates a `WebhookReceiver` object with the given values.
+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)
@@ -27120,14 +27000,42 @@ Creates a `WebhookReceiver` object with the given values.
```python
from merge import Merge
+from merge.resources.crm import (
+ FieldPermissionDeserializerRequest,
+ IndividualCommonModelScopeDeserializerRequest,
+ ModelPermissionDeserializerRequest,
+)
client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.filestorage.webhook_receivers.create(
- event="event",
- is_active=True,
+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,
+ )
+ },
+ ),
+ ],
)
```
@@ -27144,23 +27052,7 @@ client.filestorage.webhook_receivers.create(
-
-**event:** `str`
-
-
-
-
-
--
-
-**is_active:** `bool`
-
-
-
-
-
--
-
-**key:** `typing.Optional[str]`
+**common_models:** `typing.Sequence[IndividualCommonModelScopeDeserializerRequest]` — The common models you want to update the scopes for
@@ -27180,8 +27072,8 @@ client.filestorage.webhook_receivers.create(
client.hris.account_details.retrieve()
+## Crm DeleteAccount
+client.crm.delete_account.delete()
-
@@ -27193,7 +27085,7 @@ client.filestorage.webhook_receivers.create(
-
-Get details for a linked account.
+Delete a linked account.
@@ -27214,7 +27106,7 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.hris.account_details.retrieve()
+client.crm.delete_account.delete()
```
@@ -27242,8 +27134,8 @@ client.hris.account_details.retrieve()
client.hris.account_token.retrieve(...)
+## Crm EngagementTypes
+client.crm.engagement_types.list(...)
-
@@ -27255,7 +27147,7 @@ client.hris.account_details.retrieve()
-
-Returns the account token for the end user with the provided public token.
+Returns a list of `EngagementType` objects.
@@ -27270,15 +27162,40 @@ Returns the account token for the end user with the provided public token.
-
```python
+import datetime
+
from merge import Merge
client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.hris.account_token.retrieve(
- public_token="public_token",
+response = 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",
)
+for item in response:
+ yield item
+# alternatively, you can paginate page-by-page
+for page in response.iter_pages():
+ yield page
```
@@ -27294,7 +27211,7 @@ client.hris.account_token.retrieve(
-
-**public_token:** `str`
+**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
@@ -27302,75 +27219,79 @@ client.hris.account_token.retrieve(
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
-
-
+
+-
+**cursor:** `typing.Optional[str]` — The pagination cursor value.
+
-client.hris.async_passthrough.create(...)
-
-#### 📝 Description
+**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
+
+
+
-
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
+
+
+
+
-
-Asynchronously pull data from an endpoint not currently supported by Merge.
-
-
+**include_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.
+
-#### 🔌 Usage
-
-
+**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
+
+
+
+
-
-```python
-from merge import Merge
-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",
- ),
-)
-
-```
+**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.
+
+
+
+
-
-**request:** `DataPassthroughRequest`
+**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
@@ -27390,7 +27311,7 @@ client.hris.async_passthrough.create(
client.hris.async_passthrough.retrieve(...)
+client.crm.engagement_types.retrieve(...)
-
@@ -27402,7 +27323,7 @@ client.hris.async_passthrough.create(
-
-Retrieves data from earlier async-passthrough POST request
+Returns an `EngagementType` object with the given `id`.
@@ -27423,8 +27344,11 @@ 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.engagement_types.retrieve(
+ id="id",
+ include_remote_data=True,
+ include_remote_fields=True,
+ include_shell_data=True,
)
```
@@ -27441,7 +27365,31 @@ client.hris.async_passthrough.retrieve(
-
-**async_passthrough_receipt_id:** `str`
+**id:** `str`
+
+
+
+
+
+-
+
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
+
+
+
+
+
+-
+
+**include_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).
@@ -27461,8 +27409,7 @@ client.hris.async_passthrough.retrieve(
client.hris.audit_trail.list(...)
+client.crm.engagement_types.remote_field_classes_list(...)
-
@@ -27474,7 +27421,7 @@ client.hris.async_passthrough.retrieve(
-
-Gets a list of audit trail events.
+Returns a list of `RemoteFieldClass` objects.
@@ -27495,14 +27442,21 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.hris.audit_trail.list(
+response = client.crm.engagement_types.remote_field_classes_list(
cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
- end_date="end_date",
- event_type="event_type",
+ 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,
- 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 +27480,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 +27488,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 +27496,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 +27504,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 +27512,7 @@ client.hris.audit_trail.list(
-
-**user_email:** `typing.Optional[str]` — If provided, this will return events associated with the specified user email. Please note that the email address reflects the user's email at the time of the event, and may not be their current email.
+**is_common_model_field:** `typing.Optional[bool]` — If provided, will only return remote field classes with this is_common_model_field value
@@ -27566,65 +27520,19 @@ client.hris.audit_trail.list(
-
-**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.hris.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.hris.available_actions.retrieve()
-
-```
-
-
+**page_size:** `typing.Optional[int]` — Number of results to return per page.
+
-#### ⚙️ Parameters
-
-
--
-
-
@@ -27640,8 +27548,8 @@ client.hris.available_actions.retrieve()
client.hris.bank_info.list(...)
+## Crm Engagements
+client.crm.engagements.list(...)
-
@@ -27653,7 +27561,7 @@ client.hris.available_actions.retrieve()
-
-Returns a list of `BankInfo` objects.
+Returns a list of `Engagement` objects.
@@ -27671,18 +27579,12 @@ Returns a list of `BankInfo` objects.
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",
+response = client.crm.engagements.list(
created_after=datetime.datetime.fromisoformat(
"2024-01-15 09:30:00+00:00",
),
@@ -27690,9 +27592,9 @@ client.hris.bank_info.list(
"2024-01-15 09:30:00+00:00",
),
cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
- employee_id="employee_id",
include_deleted_data=True,
include_remote_data=True,
+ include_remote_fields=True,
include_shell_data=True,
modified_after=datetime.datetime.fromisoformat(
"2024-01-15 09:30:00+00:00",
@@ -27700,10 +27602,20 @@ client.hris.bank_info.list(
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",
+ 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",
+ ),
)
+for item in response:
+ yield item
+# alternatively, you can paginate page-by-page
+for page in response.iter_pages():
+ yield page
```
@@ -27719,27 +27631,6 @@ client.hris.bank_info.list(
-
-**account_type:** `typing.Optional[BankInfoListRequestAccountType]`
-
-If provided, will only return BankInfo's with this account type. Options: ('SAVINGS', 'CHECKING')
-
-* `SAVINGS` - SAVINGS
-* `CHECKING` - CHECKING
-
-
-
-
-
--
-
-**bank_name:** `typing.Optional[str]` — If provided, will only return BankInfo's with this bank name.
-
-
-
-
-
--
-
**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
@@ -27764,7 +27655,12 @@ If provided, will only return BankInfo's with this account type. Options: ('SAVI
-
-**employee_id:** `typing.Optional[str]` — If provided, will only return bank accounts for this employee.
+**expand:** `typing.Optional[
+ typing.Union[
+ EngagementsListRequestExpandItem,
+ typing.Sequence[EngagementsListRequestExpandItem],
+ ]
+]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -27772,7 +27668,7 @@ If provided, will only return BankInfo's with this account type. Options: ('SAVI
-
-**expand:** `typing.Optional[typing.Literal["employee"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
@@ -27780,7 +27676,7 @@ If provided, will only return BankInfo's with this account type. Options: ('SAVI
-
-**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -27788,7 +27684,7 @@ If provided, will only return BankInfo's with this account type. Options: ('SAVI
-
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
+**include_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.
@@ -27820,15 +27716,7 @@ If provided, will only return BankInfo's with this account type. Options: ('SAVI
-
-**order_by:** `typing.Optional[BankInfoListRequestOrderBy]` — Overrides the default ordering for this endpoint. Possible values include: remote_created_at, -remote_created_at.
-
-
-
-
-
--
-
-**page_size:** `typing.Optional[int]` — Number of results to return per page. The maximum limit is 100.
+**page_size:** `typing.Optional[int]` — Number of results to return per page.
@@ -27836,7 +27724,7 @@ If provided, will only return BankInfo's with this account type. Options: ('SAVI
-
-**remote_fields:** `typing.Optional[typing.Literal["account_type"]]` — Deprecated. Use show_enum_origins.
+**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
@@ -27844,7 +27732,7 @@ If provided, will only return BankInfo's with this account type. Options: ('SAVI
-
-**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
+**started_after:** `typing.Optional[dt.datetime]` — If provided, will only return engagements started after this datetime.
@@ -27852,7 +27740,7 @@ If provided, will only return BankInfo's with this account type. Options: ('SAVI
-
-**show_enum_origins:** `typing.Optional[typing.Literal["account_type"]]` — A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter)
+**started_before:** `typing.Optional[dt.datetime]` — If provided, will only return engagements started before this datetime.
@@ -27872,7 +27760,7 @@ If provided, will only return BankInfo's with this account type. Options: ('SAVI
client.hris.bank_info.retrieve(...)
+client.crm.engagements.create(...)
-
@@ -27884,7 +27772,7 @@ If provided, will only return BankInfo's with this account type. Options: ('SAVI
-
-Returns a `BankInfo` object with the given `id`.
+Creates an `Engagement` object with the given values.
@@ -27900,15 +27788,16 @@ Returns a `BankInfo` object with the given `id`.
```python
from merge import Merge
+from merge.resources.crm import EngagementRequest
client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.hris.bank_info.retrieve(
- id="id",
- include_remote_data=True,
- include_shell_data=True,
+client.crm.engagements.create(
+ is_debug_mode=True,
+ run_async=True,
+ model=EngagementRequest(),
)
```
@@ -27925,31 +27814,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.
-
-
-
-
-
--
-
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
+**model:** `EngagementRequest`
@@ -27957,7 +27822,7 @@ client.hris.bank_info.retrieve(
-
-**remote_fields:** `typing.Optional[typing.Literal["account_type"]]` — Deprecated. Use show_enum_origins.
+**is_debug_mode:** `typing.Optional[bool]` — Whether to include debug fields (such as log file links) in the response.
@@ -27965,7 +27830,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)
+**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously.
@@ -27985,8 +27850,7 @@ client.hris.bank_info.retrieve(
client.hris.benefits.list(...)
+client.crm.engagements.retrieve(...)
-
@@ -27998,7 +27862,7 @@ client.hris.bank_info.retrieve(
-
-Returns a list of `Benefit` objects.
+Returns an `Engagement` object with the given `id`.
@@ -28013,34 +27877,17 @@ 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,
+client.crm.engagements.retrieve(
+ id="id",
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",
)
```
@@ -28057,7 +27904,7 @@ client.hris.benefits.list(
-
-**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
+**id:** `str`
@@ -28065,7 +27912,12 @@ client.hris.benefits.list(
-
-**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
+**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.
@@ -28073,7 +27925,7 @@ client.hris.benefits.list(
-
-**cursor:** `typing.Optional[str]` — The pagination cursor value.
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -28081,7 +27933,7 @@ client.hris.benefits.list(
-
-**employee_id:** `typing.Optional[str]` — If provided, will return the benefits associated with the employee.
+**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.
@@ -28089,7 +27941,7 @@ client.hris.benefits.list(
-
-**expand:** `typing.Optional[typing.Literal["employee"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -28097,31 +27949,74 @@ client.hris.benefits.list(
-
-**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+client.crm.engagements.partial_update(...)
-
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
-
+#### 📝 Description
+
+
+-
+
+
+-
+
+Updates an `Engagement` 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
+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(),
+)
+
+```
+
+
+#### ⚙️ Parameters
+
-
-**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
+
+-
+
+**id:** `str`
@@ -28129,7 +28024,7 @@ client.hris.benefits.list(
-
-**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
+**model:** `PatchedEngagementRequest`
@@ -28137,7 +28032,7 @@ client.hris.benefits.list(
-
-**page_size:** `typing.Optional[int]` — Number of results to return per page. The maximum limit is 100.
+**is_debug_mode:** `typing.Optional[bool]` — Whether to include debug fields (such as log file links) in the response.
@@ -28145,7 +28040,7 @@ client.hris.benefits.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.
@@ -28165,7 +28060,7 @@ client.hris.benefits.list(
client.hris.benefits.retrieve(...)
+client.crm.engagements.meta_patch_retrieve(...)
-
@@ -28177,7 +28072,7 @@ client.hris.benefits.list(
-
-Returns a `Benefit` object with the given `id`.
+Returns metadata for `Engagement` PATCHs.
@@ -28198,10 +28093,8 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.hris.benefits.retrieve(
+client.crm.engagements.meta_patch_retrieve(
id="id",
- include_remote_data=True,
- include_shell_data=True,
)
```
@@ -28226,27 +28119,64 @@ client.hris.benefits.retrieve(
-
-**expand:** `typing.Optional[typing.Literal["employee"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+client.crm.engagements.meta_post_retrieve()
-
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
-
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns metadata for `Engagement` POSTs.
+
+
+
+#### 🔌 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.crm.engagements.meta_post_retrieve()
+
+```
+
+
+#### ⚙️ Parameters
+
+
+-
+
-
@@ -28262,8 +28192,7 @@ client.hris.benefits.retrieve(
client.hris.companies.list(...)
+client.crm.engagements.remote_field_classes_list(...)
-
@@ -28275,7 +28204,7 @@ client.hris.benefits.retrieve(
-
-Returns a list of `Company` objects.
+Returns a list of `RemoteFieldClass` objects.
@@ -28290,34 +28219,27 @@ 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.engagements.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",
- ),
+ is_common_model_field=True,
+ is_custom=True,
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,22 +28255,6 @@ client.hris.companies.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.
@@ -28373,7 +28279,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).
+**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.
@@ -28381,7 +28287,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_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -28389,7 +28295,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.
+**is_common_model_field:** `typing.Optional[bool]` — If provided, will only return remote field classes with this is_common_model_field value
@@ -28397,7 +28303,7 @@ client.hris.companies.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
@@ -28405,7 +28311,7 @@ client.hris.companies.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.
@@ -28425,7 +28331,8 @@ client.hris.companies.list(
client.hris.companies.retrieve(...)
+## Crm FieldMapping
+client.crm.field_mapping.field_mappings_retrieve(...)
-
@@ -28437,7 +28344,7 @@ client.hris.companies.list(
-
-Returns a `Company` 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/).
@@ -28458,10 +28365,8 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.hris.companies.retrieve(
- id="id",
- include_remote_data=True,
- include_shell_data=True,
+client.crm.field_mapping.field_mappings_retrieve(
+ exclude_remote_field_metadata=True,
)
```
@@ -28478,23 +28383,7 @@ client.hris.companies.retrieve(
-
-**id:** `str`
-
-
-
-
-
--
-
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
-
-
-
-
-
--
-
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
+**exclude_remote_field_metadata:** `typing.Optional[bool]` — If `true`, remote fields metadata is excluded from each field mapping instance (i.e. `remote_fields.remote_key_name` and `remote_fields.schema` will be null). This will increase the speed of the request since these fields require some calculations.
@@ -28514,8 +28403,7 @@ client.hris.companies.retrieve(
client.hris.scopes.default_scopes_retrieve()
+client.crm.field_mapping.field_mappings_create(...)
-
@@ -28527,7 +28415,7 @@ client.hris.companies.retrieve(
-
-Get the default permissions for Merge Common Models and fields across all Linked Accounts of a given category. [Learn more](https://help.merge.dev/en/articles/5950052-common-model-and-field-scopes).
+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.
@@ -28548,7 +28436,15 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.hris.scopes.default_scopes_retrieve()
+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",
+)
```
@@ -28564,64 +28460,59 @@ client.hris.scopes.default_scopes_retrieve()
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+**target_field_name:** `str` — The name of the target field you want this remote field to map to.
-
-
+
+-
+**target_field_description:** `str` — The description of the target field you want this remote field to map to.
+
-client.hris.scopes.linked_account_scopes_retrieve()
-
-#### 📝 Description
-
-
--
+**remote_field_traversal_path:** `typing.Sequence[typing.Optional[typing.Any]]` — The field traversal path of the remote field listed when you hit the GET /remote-fields endpoint.
+
+
+
-
-Get all available permissions for Merge Common Models and fields for a single Linked Account. [Learn more](https://help.merge.dev/en/articles/5950052-common-model-and-field-scopes).
-
-
+**remote_method:** `str` — The method of the remote endpoint where the remote field is coming from.
+
-#### 🔌 Usage
-
-
+**remote_url_path:** `str` — The path of the remote endpoint where the remote field is coming from.
+
+
+
+
-
-```python
-from merge import Merge
-
-client = Merge(
- account_token="YOUR_ACCOUNT_TOKEN",
- api_key="YOUR_API_KEY",
-)
-client.hris.scopes.linked_account_scopes_retrieve()
-
-```
-
-
+**common_model_name:** `str` — The name of the Common Model that the remote field corresponds to in a given category.
+
-#### ⚙️ Parameters
-
-
+**exclude_remote_field_metadata:** `typing.Optional[bool]` — If `true`, remote fields metadata is excluded from each field mapping instance (i.e. `remote_fields.remote_key_name` and `remote_fields.schema` will be null). This will increase the speed of the request since these fields require some calculations.
+
+
+
+
-
@@ -28637,7 +28528,7 @@ client.hris.scopes.linked_account_scopes_retrieve()
client.hris.scopes.linked_account_scopes_create(...)
+client.crm.field_mapping.field_mappings_destroy(...)
-
@@ -28649,7 +28540,7 @@ client.hris.scopes.linked_account_scopes_retrieve()
-
-Update permissions for any Common Model or field for a single Linked Account. Any Scopes not set in this POST request will inherit the default Scopes. [Learn more](https://help.merge.dev/en/articles/5950052-common-model-and-field-scopes)
+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.
@@ -28665,42 +28556,13 @@ Update permissions for any Common Model or field for a single Linked Account. An
```python
from merge import Merge
-from merge.resources.hris import (
- FieldPermissionDeserializerRequest,
- IndividualCommonModelScopeDeserializerRequest,
- ModelPermissionDeserializerRequest,
-)
client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.hris.scopes.linked_account_scopes_create(
- common_models=[
- IndividualCommonModelScopeDeserializerRequest(
- model_name="Employee",
- model_permissions={
- "READ": ModelPermissionDeserializerRequest(
- is_enabled=True,
- ),
- "WRITE": ModelPermissionDeserializerRequest(
- is_enabled=False,
- ),
- },
- field_permissions=FieldPermissionDeserializerRequest(
- enabled_fields=["avatar", "home_location"],
- disabled_fields=["work_location"],
- ),
- ),
- IndividualCommonModelScopeDeserializerRequest(
- model_name="Benefit",
- model_permissions={
- "WRITE": ModelPermissionDeserializerRequest(
- is_enabled=False,
- )
- },
- ),
- ],
+client.crm.field_mapping.field_mappings_destroy(
+ field_mapping_id="field_mapping_id",
)
```
@@ -28717,7 +28579,7 @@ client.hris.scopes.linked_account_scopes_create(
-
-**common_models:** `typing.Sequence[IndividualCommonModelScopeDeserializerRequest]` — The common models you want to update the scopes for
+**field_mapping_id:** `str`
@@ -28737,8 +28599,7 @@ client.hris.scopes.linked_account_scopes_create(
client.hris.delete_account.delete()
+client.crm.field_mapping.field_mappings_partial_update(...)
-
@@ -28750,7 +28611,7 @@ client.hris.scopes.linked_account_scopes_create(
-
-Delete a linked account.
+Create or update existing Field Mappings for a Linked Account. Changes will be reflected after the next scheduled sync. This will cause the next sync for this Linked Account to sync **ALL** data from start.
@@ -28771,7 +28632,9 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.hris.delete_account.delete()
+client.crm.field_mapping.field_mappings_partial_update(
+ field_mapping_id="field_mapping_id",
+)
```
@@ -28787,6 +28650,38 @@ client.hris.delete_account.delete()
-
+**field_mapping_id:** `str`
+
+
+
+
+
+-
+
+**remote_field_traversal_path:** `typing.Optional[typing.Sequence[typing.Optional[typing.Any]]]` — The field traversal path of the remote field listed when you hit the GET /remote-fields endpoint.
+
+
+
+
+
+-
+
+**remote_method:** `typing.Optional[str]` — The method of the remote endpoint where the remote field is coming from.
+
+
+
+
+
+-
+
+**remote_url_path:** `typing.Optional[str]` — The path of the remote endpoint where the remote field is coming from.
+
+
+
+
+
+-
+
**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -28799,8 +28694,7 @@ client.hris.delete_account.delete()
client.hris.dependents.list(...)
+client.crm.field_mapping.remote_fields_retrieve(...)
-
@@ -28812,7 +28706,7 @@ client.hris.delete_account.delete()
-
-Returns a list of `Dependent` 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/).
@@ -28827,35 +28721,15 @@ Returns a list of `Dependent` objects.
-
```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",
+client.crm.field_mapping.remote_fields_retrieve(
+ common_models="common_models",
+ include_example_values="include_example_values",
)
```
@@ -28872,7 +28746,7 @@ client.hris.dependents.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.
@@ -28880,7 +28754,7 @@ client.hris.dependents.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.
@@ -28888,83 +28762,64 @@ client.hris.dependents.list(
-
-**cursor:** `typing.Optional[str]` — The pagination cursor value.
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
--
-
-**employee_id:** `typing.Optional[str]` — If provided, will only return 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/).
-
+
client.crm.field_mapping.target_fields_retrieve()
-
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
-
-
-
+#### 📝 Description
-
-**include_sensitive_fields:** `typing.Optional[bool]` — Whether to include sensitive fields (such as social security numbers) in the response.
-
-
-
-
-
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
-
+Get all 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.
-
-
-
-
-
@@ -28980,7 +28835,8 @@ client.hris.dependents.list(
client.hris.dependents.retrieve(...)
+## Crm GenerateKey
+client.crm.generate_key.create(...)
-
@@ -28992,7 +28848,7 @@ client.hris.dependents.list(
-
-Returns a `Dependent` object with the given `id`.
+Create a remote key.
@@ -29013,11 +28869,8 @@ 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,
+client.crm.generate_key.create(
+ name="Remote Deployment Key 1",
)
```
@@ -29034,31 +28887,7 @@ client.hris.dependents.retrieve(
-
-**id:** `str`
-
-
-
-
-
--
-
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
-
-
-
-
-
--
-
-**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).
+**name:** `str` — The name of the remote key
@@ -29078,8 +28907,8 @@ client.hris.dependents.retrieve(
client.hris.employee_payroll_runs.list(...)
+## Crm Issues
+client.crm.issues.list(...)
-
@@ -29091,7 +28920,7 @@ client.hris.dependents.retrieve(
-
-Returns a list of `EmployeePayrollRun` objects.
+Gets all issues for Organization.
@@ -29109,49 +28938,41 @@ Returns a list of `EmployeePayrollRun` objects.
import datetime
from merge import Merge
-from merge.resources.hris.resources.employee_payroll_runs import (
- EmployeePayrollRunsListRequestExpand,
-)
+from merge.resources.crm.resources.issues import IssuesListRequestStatus
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",
- ),
+response = client.crm.issues.list(
+ account_token="account_token",
cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
- employee_id="employee_id",
- ended_after=datetime.datetime.fromisoformat(
+ end_date="end_date",
+ end_user_organization_name="end_user_organization_name",
+ first_incident_time_after=datetime.datetime.fromisoformat(
"2024-01-15 09:30:00+00:00",
),
- ended_before=datetime.datetime.fromisoformat(
+ first_incident_time_before=datetime.datetime.fromisoformat(
"2024-01-15 09:30:00+00:00",
),
- expand=EmployeePayrollRunsListRequestExpand.EMPLOYEE,
- include_deleted_data=True,
- include_remote_data=True,
- include_shell_data=True,
- modified_after=datetime.datetime.fromisoformat(
+ include_muted="include_muted",
+ integration_name="integration_name",
+ last_incident_time_after=datetime.datetime.fromisoformat(
"2024-01-15 09:30:00+00:00",
),
- modified_before=datetime.datetime.fromisoformat(
+ last_incident_time_before=datetime.datetime.fromisoformat(
"2024-01-15 09:30:00+00:00",
),
+ linked_account_id="linked_account_id",
page_size=1,
- 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",
- ),
+ 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
```
@@ -29167,15 +28988,7 @@ client.hris.employee_payroll_runs.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.
+**account_token:** `typing.Optional[str]`
@@ -29191,15 +29004,7 @@ client.hris.employee_payroll_runs.list(
-
-**employee_id:** `typing.Optional[str]` — If provided, will only return employee payroll runs for this employee.
-
-
-
-
-
--
-
-**ended_after:** `typing.Optional[dt.datetime]` — If provided, will only return employee payroll runs ended after this datetime.
+**end_date:** `typing.Optional[str]` — If included, will only include issues whose most recent action occurred before this time
@@ -29207,7 +29012,7 @@ client.hris.employee_payroll_runs.list(
-
-**ended_before:** `typing.Optional[dt.datetime]` — If provided, will only return employee payroll runs ended before this datetime.
+**end_user_organization_name:** `typing.Optional[str]`
@@ -29215,7 +29020,7 @@ client.hris.employee_payroll_runs.list(
-
-**expand:** `typing.Optional[EmployeePayrollRunsListRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+**first_incident_time_after:** `typing.Optional[dt.datetime]` — If provided, will only return issues whose first incident time was after this datetime.
@@ -29223,7 +29028,7 @@ client.hris.employee_payroll_runs.list(
-
-**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
+**first_incident_time_before:** `typing.Optional[dt.datetime]` — If provided, will only return issues whose first incident time was before this datetime.
@@ -29231,7 +29036,7 @@ client.hris.employee_payroll_runs.list(
-
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
+**include_muted:** `typing.Optional[str]` — If true, will include muted issues
@@ -29239,7 +29044,7 @@ client.hris.employee_payroll_runs.list(
-
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
+**integration_name:** `typing.Optional[str]`
@@ -29247,7 +29052,7 @@ client.hris.employee_payroll_runs.list(
-
-**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
+**last_incident_time_after:** `typing.Optional[dt.datetime]` — If provided, will only return issues whose last incident time was after this datetime.
@@ -29255,7 +29060,7 @@ client.hris.employee_payroll_runs.list(
-
-**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
+**last_incident_time_before:** `typing.Optional[dt.datetime]` — If provided, will only return issues whose last incident time was before this datetime.
@@ -29263,7 +29068,7 @@ client.hris.employee_payroll_runs.list(
-
-**page_size:** `typing.Optional[int]` — Number of results to return per page. The maximum limit is 100.
+**linked_account_id:** `typing.Optional[str]` — If provided, will only include issues pertaining to the linked account passed in.
@@ -29271,7 +29076,7 @@ client.hris.employee_payroll_runs.list(
-
-**payroll_run_id:** `typing.Optional[str]` — If provided, will only return employee payroll runs for this employee.
+**page_size:** `typing.Optional[int]` — Number of results to return per page.
@@ -29279,7 +29084,7 @@ client.hris.employee_payroll_runs.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
@@ -29287,15 +29092,12 @@ client.hris.employee_payroll_runs.list(
-
-**started_after:** `typing.Optional[dt.datetime]` — If provided, will only return employee payroll runs started after this datetime.
-
-
-
+**status:** `typing.Optional[IssuesListRequestStatus]`
-
--
+Status of the issue. Options: ('ONGOING', 'RESOLVED')
-**started_before:** `typing.Optional[dt.datetime]` — If provided, will only return employee payroll runs started before this datetime.
+* `ONGOING` - ONGOING
+* `RESOLVED` - RESOLVED
@@ -29315,7 +29117,7 @@ client.hris.employee_payroll_runs.list(
client.hris.employee_payroll_runs.retrieve(...)
+client.crm.issues.retrieve(...)
-
@@ -29327,7 +29129,7 @@ client.hris.employee_payroll_runs.list(
-
-Returns an `EmployeePayrollRun` object with the given `id`.
+Get a specific issue.
@@ -29343,19 +29145,13 @@ Returns an `EmployeePayrollRun` object with the given `id`.
```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(
+client.crm.issues.retrieve(
id="id",
- expand=EmployeePayrollRunsRetrieveRequestExpand.EMPLOYEE,
- include_remote_data=True,
- include_shell_data=True,
)
```
@@ -29380,30 +29176,6 @@ client.hris.employee_payroll_runs.retrieve(
-
-**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.
@@ -29416,8 +29188,8 @@ client.hris.employee_payroll_runs.retrieve(
client.hris.employees.list(...)
+## Crm Leads
+client.crm.leads.list(...)
-
@@ -29429,7 +29201,7 @@ client.hris.employee_payroll_runs.retrieve(
-
-Returns a list of `Employee` objects.
+Returns a list of `Lead` objects.
@@ -29447,19 +29219,14 @@ Returns a list of `Employee` objects.
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",
+response = 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",
),
@@ -29467,49 +29234,27 @@ client.hris.employees.list(
"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",
+ email_addresses="email_addresses",
include_deleted_data=True,
include_remote_data=True,
- include_sensitive_fields=True,
+ include_remote_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",
),
+ owner_id="owner_id",
page_size=1,
- pay_group_id="pay_group_id",
- personal_email="personal_email",
- remote_fields=EmployeesListRequestRemoteFields.EMPLOYMENT_STATUS,
+ phone_numbers="phone_numbers",
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",
)
+for item in response:
+ yield item
+# alternatively, you can paginate page-by-page
+for page in response.iter_pages():
+ yield page
```
@@ -29525,7 +29270,7 @@ client.hris.employees.list(
-
-**company_id:** `typing.Optional[str]` — If provided, will only return employees for this company.
+**converted_account_id:** `typing.Optional[str]` — If provided, will only return leads with this account.
@@ -29533,7 +29278,7 @@ client.hris.employees.list(
-
-**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
+**converted_contact_id:** `typing.Optional[str]` — If provided, will only return leads with this contact.
@@ -29541,7 +29286,7 @@ client.hris.employees.list(
-
-**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
+**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
@@ -29549,7 +29294,7 @@ client.hris.employees.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.
@@ -29557,7 +29302,7 @@ client.hris.employees.list(
-
-**display_full_name:** `typing.Optional[str]` — If provided, will only return employees with this display name.
+**cursor:** `typing.Optional[str]` — The pagination cursor value.
@@ -29565,7 +29310,7 @@ client.hris.employees.list(
-
-**employee_number:** `typing.Optional[str]` — If provided, will only return employees with this employee number.
+**email_addresses:** `typing.Optional[str]` — If provided, will only return contacts matching the email addresses; multiple email_addresses can be separated by commas.
@@ -29573,13 +29318,11 @@ client.hris.employees.list(
-
-**employment_status:** `typing.Optional[EmployeesListRequestEmploymentStatus]`
-
-If provided, will only return employees with this employment status.
-
-* `ACTIVE` - ACTIVE
-* `PENDING` - PENDING
-* `INACTIVE` - INACTIVE
+**expand:** `typing.Optional[
+ typing.Union[
+ LeadsListRequestExpandItem, typing.Sequence[LeadsListRequestExpandItem]
+ ]
+]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -29587,7 +29330,7 @@ If provided, will only return employees with this employment status.
-
-**employment_type:** `typing.Optional[str]` — If provided, will only return employees that have an employment of the specified employment type.
+**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
@@ -29595,7 +29338,7 @@ If provided, will only return employees with this employment status.
-
-**expand:** `typing.Optional[EmployeesListRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -29603,7 +29346,7 @@ If provided, will only return employees with this employment status.
-
-**first_name:** `typing.Optional[str]` — If provided, will only return employees with this first name.
+**include_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.
@@ -29611,7 +29354,7 @@ If provided, will only return employees with this employment status.
-
-**groups:** `typing.Optional[str]` — If provided, will only return employees matching the group ids; multiple groups can be separated by commas.
+**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -29619,7 +29362,7 @@ If provided, will only return employees with this employment status.
-
-**home_location_id:** `typing.Optional[str]` — If provided, will only return employees for this home location.
+**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
@@ -29627,7 +29370,7 @@ If provided, will only return employees with this employment status.
-
-**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
+**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
@@ -29635,7 +29378,7 @@ If provided, will only return employees with this employment status.
-
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
+**owner_id:** `typing.Optional[str]` — If provided, will only return leads with this owner.
@@ -29643,7 +29386,7 @@ If provided, will only return employees with this employment status.
-
-**include_sensitive_fields:** `typing.Optional[bool]` — Whether to include sensitive fields (such as social security numbers) in the response.
+**page_size:** `typing.Optional[int]` — Number of results to return per page.
@@ -29651,7 +29394,7 @@ If provided, will only return employees with this employment status.
-
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
+**phone_numbers:** `typing.Optional[str]` — If provided, will only return contacts matching the phone numbers; multiple phone numbers can be separated by commas.
@@ -29659,7 +29402,7 @@ If provided, will only return employees with this employment status.
-
-**job_title:** `typing.Optional[str]` — If provided, will only return employees that have an employment of the specified job title.
+**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
@@ -29667,47 +29410,73 @@ If provided, will only return employees with this employment status.
-
-**last_name:** `typing.Optional[str]` — If provided, will only return employees with this last name.
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
-
--
-**manager_id:** `typing.Optional[str]` — If provided, will only return employees for this manager.
-
+client.crm.leads.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 a `Lead` object with the given values.
+
+
+#### 🔌 Usage
+
-
-**page_size:** `typing.Optional[int]` — Number of results to return per page.
-
+
+-
+
+```python
+from merge import Merge
+from merge.resources.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(),
+)
+
+```
+
+
+#### ⚙️ Parameters
+
-
-**pay_group_id:** `typing.Optional[str]` — If provided, will only return employees for this pay group
+
+-
+
+**model:** `LeadRequest`
@@ -29715,7 +29484,7 @@ If provided, will only return employees with this employment status.
-
-**personal_email:** `typing.Optional[str]` — If provided, will only return Employees with this personal email
+**is_debug_mode:** `typing.Optional[bool]` — Whether to include debug fields (such as log file links) in the response.
@@ -29723,7 +29492,7 @@ If provided, will only return employees with this employment status.
-
-**remote_fields:** `typing.Optional[EmployeesListRequestRemoteFields]` — Deprecated. Use show_enum_origins.
+**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously.
@@ -29731,39 +29500,73 @@ If provided, will only return employees with this employment status.
-
-**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
-
--
-**show_enum_origins:** `typing.Optional[EmployeesListRequestShowEnumOrigins]` — A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter)
-
+client.crm.leads.retrieve(...)
-
-**started_after:** `typing.Optional[dt.datetime]` — If provided, will only return employees that started after this datetime.
-
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a `Lead` object with the given `id`.
+
+
+#### 🔌 Usage
+
-
-**started_before:** `typing.Optional[dt.datetime]` — If provided, will only return employees that started before this datetime.
-
+
+-
+
+```python
+from merge import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.crm.leads.retrieve(
+ id="id",
+ include_remote_data=True,
+ include_remote_fields=True,
+ include_shell_data=True,
+)
+
+```
+
+
+#### ⚙️ Parameters
+
-
-**team_id:** `typing.Optional[str]` — If provided, will only return employees for this team.
+
+-
+
+**id:** `str`
@@ -29771,7 +29574,12 @@ If provided, will only return employees with this employment status.
-
-**terminated_after:** `typing.Optional[dt.datetime]` — If provided, will only return employees that were terminated after this datetime.
+**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.
@@ -29779,7 +29587,7 @@ If provided, will only return employees with this employment status.
-
-**terminated_before:** `typing.Optional[dt.datetime]` — If provided, will only return employees that were terminated before this datetime.
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -29787,7 +29595,7 @@ If provided, will only return employees with this employment status.
-
-**work_email:** `typing.Optional[str]` — If provided, will only return Employees with this work email
+**include_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.
@@ -29795,7 +29603,7 @@ If provided, will only return employees with this employment status.
-
-**work_location_id:** `typing.Optional[str]` — If provided, will only return employees for this location.
+**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -29815,7 +29623,7 @@ If provided, will only return employees with this employment status.
client.hris.employees.create(...)
+client.crm.leads.meta_post_retrieve()
-
@@ -29827,7 +29635,7 @@ If provided, will only return employees with this employment status.
-
-Creates an `Employee` object with the given values.
+Returns metadata for `Lead` POSTs.
@@ -29843,17 +29651,12 @@ Creates an `Employee` object with the given values.
```python
from merge import Merge
-from merge.resources.hris import EmployeeRequest
client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.hris.employees.create(
- is_debug_mode=True,
- run_async=True,
- model=EmployeeRequest(),
-)
+client.crm.leads.meta_post_retrieve()
```
@@ -29869,30 +29672,6 @@ client.hris.employees.create(
-
-**model:** `EmployeeRequest`
-
-
-
-
-
--
-
-**is_debug_mode:** `typing.Optional[bool]` — Whether to include debug fields (such as log file links) in the response.
-
-
-
-
-
--
-
-**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously.
-
-
-
-
-
--
-
**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -29905,7 +29684,7 @@ client.hris.employees.create(
client.hris.employees.retrieve(...)
+client.crm.leads.remote_field_classes_list(...)
-
@@ -29917,7 +29696,7 @@ client.hris.employees.create(
-
-Returns an `Employee` object with the given `id`.
+Returns a list of `RemoteFieldClass` objects.
@@ -29933,25 +29712,26 @@ Returns an `Employee` object with the given `id`.
```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,
+response = client.crm.leads.remote_field_classes_list(
+ cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
+ include_deleted_data=True,
include_remote_data=True,
- include_sensitive_fields=True,
+ include_remote_fields=True,
include_shell_data=True,
- remote_fields=EmployeesRetrieveRequestRemoteFields.EMPLOYMENT_STATUS,
- show_enum_origins=EmployeesRetrieveRequestShowEnumOrigins.EMPLOYMENT_STATUS,
+ 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
```
@@ -29967,7 +29747,7 @@ client.hris.employees.retrieve(
-
-**id:** `str`
+**cursor:** `typing.Optional[str]` — The pagination cursor value.
@@ -29975,7 +29755,7 @@ client.hris.employees.retrieve(
-
-**expand:** `typing.Optional[EmployeesRetrieveRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
@@ -29991,7 +29771,7 @@ client.hris.employees.retrieve(
-
-**include_sensitive_fields:** `typing.Optional[bool]` — Whether to include sensitive fields (such as social security numbers) in the response.
+**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.
@@ -30007,7 +29787,7 @@ client.hris.employees.retrieve(
-
-**remote_fields:** `typing.Optional[EmployeesRetrieveRequestRemoteFields]` — 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
@@ -30015,7 +29795,15 @@ client.hris.employees.retrieve(
-
-**show_enum_origins:** `typing.Optional[EmployeesRetrieveRequestShowEnumOrigins]` — A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter)
+**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.
@@ -30035,7 +29823,8 @@ client.hris.employees.retrieve(
client.hris.employees.ignore_create(...)
+## Crm LinkToken
+client.crm.link_token.create(...)
-
@@ -30047,7 +29836,7 @@ client.hris.employees.retrieve(
-
-Ignores a specific row based on the `model_id` in the url. These records will have their properties set to null, and will not be updated in future syncs. The "reason" and "message" fields in the request body will be stored for audit purposes.
+Creates a link token to be used when linking a new end user.
@@ -30063,15 +29852,17 @@ Ignores a specific row based on the `model_id` in the url. These records will ha
```python
from merge import Merge
-from merge.resources.hris import ReasonEnum
+from merge.resources.crm import CategoriesEnum
client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.hris.employees.ignore_create(
- model_id="model_id",
- reason=ReasonEnum.GENERAL_CUSTOMER_REQUEST,
+client.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],
)
```
@@ -30088,7 +29879,7 @@ client.hris.employees.ignore_create(
-
-**model_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.
@@ -30096,7 +29887,7 @@ client.hris.employees.ignore_create(
-
-**reason:** `IgnoreCommonModelRequestReason`
+**end_user_organization_name:** `str` — Your end user's organization.
@@ -30104,7 +29895,7 @@ client.hris.employees.ignore_create(
-
-**message:** `typing.Optional[str]`
+**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.
@@ -30112,64 +29903,95 @@ client.hris.employees.ignore_create(
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+**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/.
+
-client.hris.employees.meta_post_retrieve()
-
-#### 📝 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.
+
+
+
+
-
-Returns metadata for `Employee` POSTs.
+**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.
+
+
+
+
-
-```python
-from merge import Merge
+**language:** `typing.Optional[EndUserDetailsRequestLanguage]`
-client = Merge(
- account_token="YOUR_ACCOUNT_TOKEN",
- api_key="YOUR_API_KEY",
-)
-client.hris.employees.meta_post_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.Optional[typing.Any]]]` — A JSON object containing integration-specific configuration options.
+
+
+
+
-
@@ -30185,8 +30007,8 @@ client.hris.employees.meta_post_retrieve()
client.hris.employer_benefits.list(...)
+## Crm LinkedAccounts
+client.crm.linked_accounts.list(...)
-
@@ -30198,7 +30020,7 @@ client.hris.employees.meta_post_retrieve()
-
-Returns a list of `EmployerBenefit` objects.
+List linked accounts for your organization.
@@ -30213,34 +30035,35 @@ Returns a list of `EmployerBenefit` objects.
-
```python
-import datetime
-
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.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",
- ),
+response = client.crm.linked_accounts.list(
+ category=LinkedAccountsListRequestCategory.ACCOUNTING,
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",
- ),
+ 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,
- remote_id="remote_id",
+ status="status",
)
+for item in response:
+ yield item
+# alternatively, you can paginate page-by-page
+for page in response.iter_pages():
+ yield page
```
@@ -30256,7 +30079,17 @@ client.hris.employer_benefits.list(
-
-**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
+**category:** `typing.Optional[LinkedAccountsListRequestCategory]`
+
+Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing`
+
+* `hris` - hris
+* `ats` - ats
+* `accounting` - accounting
+* `ticketing` - ticketing
+* `crm` - crm
+* `mktg` - mktg
+* `filestorage` - filestorage
@@ -30264,7 +30097,7 @@ client.hris.employer_benefits.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.
@@ -30272,7 +30105,7 @@ client.hris.employer_benefits.list(
-
-**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.
@@ -30280,7 +30113,7 @@ client.hris.employer_benefits.list(
-
-**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
+**end_user_organization_name:** `typing.Optional[str]` — If provided, will only return linked accounts associated with the given organization name.
@@ -30288,7 +30121,7 @@ client.hris.employer_benefits.list(
-
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
+**end_user_origin_id:** `typing.Optional[str]` — If provided, will only return linked accounts associated with the given origin ID.
@@ -30296,7 +30129,7 @@ client.hris.employer_benefits.list(
-
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
+**end_user_origin_ids:** `typing.Optional[str]` — Comma-separated list of EndUser origin IDs, making it possible to specify multiple EndUsers at once.
@@ -30304,7 +30137,7 @@ client.hris.employer_benefits.list(
-
-**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
+**id:** `typing.Optional[str]`
@@ -30312,7 +30145,15 @@ client.hris.employer_benefits.list(
-
-**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
+**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.
@@ -30320,7 +30161,7 @@ client.hris.employer_benefits.list(
-
-**page_size:** `typing.Optional[int]` — Number of results to return per page. The maximum limit is 100.
+**integration_name:** `typing.Optional[str]` — If provided, will only return linked accounts associated with the given integration name.
@@ -30328,7 +30169,23 @@ client.hris.employer_benefits.list(
-
-**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
+**is_test_account:** `typing.Optional[str]` — If included, will only include test linked accounts. If not included, will only include non-test linked accounts.
+
+
+
+
+
+-
+
+**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`
@@ -30348,7 +30205,8 @@ client.hris.employer_benefits.list(
client.hris.employer_benefits.retrieve(...)
+## Crm Notes
+client.crm.notes.list(...)
-
@@ -30360,7 +30218,7 @@ client.hris.employer_benefits.list(
-
-Returns an `EmployerBenefit` object with the given `id`.
+Returns a list of `Note` objects.
@@ -30375,17 +30233,44 @@ Returns an `EmployerBenefit` object with the given `id`.
-
```python
+import datetime
+
from merge import Merge
client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.hris.employer_benefits.retrieve(
- id="id",
+response = 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",
+ ),
+ 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",
+ ),
+ 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
```
@@ -30401,7 +30286,7 @@ client.hris.employer_benefits.retrieve(
-
-**id:** `str`
+**account_id:** `typing.Optional[str]` — If provided, will only return notes with this account.
@@ -30409,7 +30294,7 @@ client.hris.employer_benefits.retrieve(
-
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
+**contact_id:** `typing.Optional[str]` — If provided, will only return notes with this contact.
@@ -30417,7 +30302,7 @@ client.hris.employer_benefits.retrieve(
-
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
+**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
@@ -30425,101 +30310,51 @@ client.hris.employer_benefits.retrieve(
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
-
-
+
+-
+**cursor:** `typing.Optional[str]` — The pagination cursor value.
+
-client.hris.employments.list(...)
-
-#### 📝 Description
-
-
--
+**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.
+
+
+
-
-Returns a list of `Employment` objects.
-
-
+**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is 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
-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,
-)
-
-```
-
-
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
+
-#### ⚙️ Parameters
-
-
--
-
-
-**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created 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.
@@ -30527,7 +30362,7 @@ client.hris.employments.list(
-
-**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
+**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -30535,7 +30370,7 @@ client.hris.employments.list(
-
-**cursor:** `typing.Optional[str]` — The pagination cursor value.
+**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
@@ -30543,7 +30378,7 @@ client.hris.employments.list(
-
-**employee_id:** `typing.Optional[str]` — If provided, will only return employments for this employee.
+**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
@@ -30551,7 +30386,7 @@ client.hris.employments.list(
-
-**expand:** `typing.Optional[EmploymentsListRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+**opportunity_id:** `typing.Optional[str]` — If provided, will only return notes with this opportunity.
@@ -30559,7 +30394,7 @@ client.hris.employments.list(
-
-**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
+**owner_id:** `typing.Optional[str]` — If provided, will only return notes with this owner.
@@ -30567,7 +30402,7 @@ client.hris.employments.list(
-
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
+**page_size:** `typing.Optional[int]` — Number of results to return per page.
@@ -30575,7 +30410,7 @@ client.hris.employments.list(
-
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
+**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
@@ -30583,39 +30418,73 @@ client.hris.employments.list(
-
-**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
-
--
-**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
-
+client.crm.notes.create(...)
-
-**order_by:** `typing.Optional[EmploymentsListRequestOrderBy]` — Overrides the default ordering for this endpoint. Possible values include: effective_date, -effective_date.
-
+#### 📝 Description
+
+
+-
+
+
+-
+
+Creates a `Note` object with the given values.
+
+
+
+#### 🔌 Usage
-
-**page_size:** `typing.Optional[int]` — Number of results to return per page. The maximum limit is 100.
-
+
+-
+
+```python
+from merge import Merge
+from merge.resources.crm import NoteRequest
+
+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(),
+)
+
+```
+
+
+
+#### ⚙️ Parameters
-
-**remote_fields:** `typing.Optional[EmploymentsListRequestRemoteFields]` — Deprecated. Use show_enum_origins.
+
+-
+
+**model:** `NoteRequest`
@@ -30623,7 +30492,7 @@ client.hris.employments.list(
-
-**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
+**is_debug_mode:** `typing.Optional[bool]` — Whether to include debug fields (such as log file links) in the response.
@@ -30631,7 +30500,7 @@ client.hris.employments.list(
-
-**show_enum_origins:** `typing.Optional[EmploymentsListRequestShowEnumOrigins]` — A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter)
+**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously.
@@ -30651,7 +30520,7 @@ client.hris.employments.list(
client.hris.employments.retrieve(...)
+client.crm.notes.retrieve(...)
-
@@ -30663,7 +30532,7 @@ client.hris.employments.list(
-
-Returns an `Employment` object with the given `id`.
+Returns a `Note` object with the given `id`.
@@ -30679,23 +30548,16 @@ Returns an `Employment` object with the given `id`.
```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(
+client.crm.notes.retrieve(
id="id",
- expand=EmploymentsRetrieveRequestExpand.EMPLOYEE,
include_remote_data=True,
+ include_remote_fields=True,
include_shell_data=True,
- remote_fields=EmploymentsRetrieveRequestRemoteFields.EMPLOYMENT_TYPE,
- show_enum_origins=EmploymentsRetrieveRequestShowEnumOrigins.EMPLOYMENT_TYPE,
)
```
@@ -30720,7 +30582,12 @@ client.hris.employments.retrieve(
-
-**expand:** `typing.Optional[EmploymentsRetrieveRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+**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.
@@ -30736,15 +30603,7 @@ client.hris.employments.retrieve(
-
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
-
-
-
-
-
--
-
-**remote_fields:** `typing.Optional[EmploymentsRetrieveRequestRemoteFields]` — Deprecated. Use show_enum_origins.
+**include_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.
@@ -30752,7 +30611,7 @@ client.hris.employments.retrieve(
-
-**show_enum_origins:** `typing.Optional[EmploymentsRetrieveRequestShowEnumOrigins]` — A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter)
+**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -30772,8 +30631,7 @@ client.hris.employments.retrieve(
client.hris.field_mapping.field_mappings_retrieve(...)
+client.crm.notes.meta_post_retrieve()
-
@@ -30785,7 +30643,7 @@ client.hris.employments.retrieve(
-
-Get all Field Mappings for this Linked Account. Field Mappings are mappings between third-party Remote Fields and user defined Merge fields. [Learn more](https://docs.merge.dev/supplemental-data/field-mappings/overview/).
+Returns metadata for `Note` POSTs.
@@ -30806,9 +30664,7 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.hris.field_mapping.field_mappings_retrieve(
- exclude_remote_field_metadata=True,
-)
+client.crm.notes.meta_post_retrieve()
```
@@ -30824,14 +30680,6 @@ client.hris.field_mapping.field_mappings_retrieve(
-
-**exclude_remote_field_metadata:** `typing.Optional[bool]` — If `true`, remote fields metadata is excluded from each field mapping instance (i.e. `remote_fields.remote_key_name` and `remote_fields.schema` will be null). This will increase the speed of the request since these fields require some calculations.
-
-
-
-
-
--
-
**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -30844,7 +30692,7 @@ client.hris.field_mapping.field_mappings_retrieve(
client.hris.field_mapping.field_mappings_create(...)
+client.crm.notes.remote_field_classes_list(...)
-
@@ -30856,7 +30704,7 @@ client.hris.field_mapping.field_mappings_retrieve(
-
-Create new Field Mappings that will be available after the next scheduled sync. This will cause the next sync for this Linked Account to sync **ALL** data from start.
+Returns a list of `RemoteFieldClass` objects.
@@ -30877,15 +30725,21 @@ 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",
+response = 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,
)
+for item in response:
+ yield item
+# alternatively, you can paginate page-by-page
+for page in response.iter_pages():
+ yield page
```
@@ -30901,7 +30755,7 @@ client.hris.field_mapping.field_mappings_create(
-
-**target_field_name:** `str` — The name of the target field you want this remote field to map to.
+**cursor:** `typing.Optional[str]` — The pagination cursor value.
@@ -30909,7 +30763,7 @@ client.hris.field_mapping.field_mappings_create(
-
-**target_field_description:** `str` — The description of the target field you want this remote field to map to.
+**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
@@ -30917,7 +30771,7 @@ client.hris.field_mapping.field_mappings_create(
-
-**remote_field_traversal_path:** `typing.Sequence[typing.Optional[typing.Any]]` — The field traversal path of the remote field listed when you hit the GET /remote-fields endpoint.
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -30925,7 +30779,7 @@ client.hris.field_mapping.field_mappings_create(
-
-**remote_method:** `str` — The method of the remote endpoint where the remote field is coming from.
+**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.
@@ -30933,7 +30787,7 @@ client.hris.field_mapping.field_mappings_create(
-
-**remote_url_path:** `str` — The path of the remote endpoint where the remote field is coming from.
+**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -30941,7 +30795,7 @@ client.hris.field_mapping.field_mappings_create(
-
-**common_model_name:** `str` — The name of the Common Model that the remote field corresponds to in a given category.
+**is_common_model_field:** `typing.Optional[bool]` — If provided, will only return remote field classes with this is_common_model_field value
@@ -30949,7 +30803,7 @@ client.hris.field_mapping.field_mappings_create(
-
-**exclude_remote_field_metadata:** `typing.Optional[bool]` — If `true`, remote fields metadata is excluded from each field mapping instance (i.e. `remote_fields.remote_key_name` and `remote_fields.schema` will be null). This will increase the speed of the request since these fields require some calculations.
+**is_custom:** `typing.Optional[bool]` — If provided, will only return remote fields classes with this is_custom value
@@ -30957,7 +30811,7 @@ client.hris.field_mapping.field_mappings_create(
-
-**jmes_path:** `typing.Optional[str]` — JMES path to specify json query expression to be used on field mapping.
+**page_size:** `typing.Optional[int]` — Number of results to return per page.
@@ -30977,7 +30831,8 @@ client.hris.field_mapping.field_mappings_create(
client.hris.field_mapping.field_mappings_destroy(...)
+## Crm Opportunities
+client.crm.opportunities.list(...)
-
@@ -30989,7 +30844,7 @@ client.hris.field_mapping.field_mappings_create(
-
-Deletes Field Mappings for a Linked Account. All data related to this Field Mapping will be deleted and these changes will be reflected after the next scheduled sync. This will cause the next sync for this Linked Account to sync **ALL** data from start.
+Returns a list of `Opportunity` objects.
@@ -31004,15 +30859,50 @@ Deletes Field Mappings for a Linked Account. All data related to this Field Mapp
-
```python
+import datetime
+
from merge import Merge
+from merge.resources.crm.resources.opportunities import (
+ OpportunitiesListRequestStatus,
+)
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",
+response = 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",
+ 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",
+ ),
+ remote_id="remote_id",
+ stage_id="stage_id",
+ status=OpportunitiesListRequestStatus.LOST,
)
+for item in response:
+ yield item
+# alternatively, you can paginate page-by-page
+for page in response.iter_pages():
+ yield page
```
@@ -31028,7 +30918,7 @@ client.hris.field_mapping.field_mappings_destroy(
-
-**field_mapping_id:** `str`
+**account_id:** `typing.Optional[str]` — If provided, will only return opportunities with this account.
@@ -31036,70 +30926,52 @@ client.hris.field_mapping.field_mappings_destroy(
-
-**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.hris.field_mapping.field_mappings_partial_update(...)
-
-#### 📝 Description
-
-
--
+**cursor:** `typing.Optional[str]` — The pagination cursor value.
+
+
+
-
-Create or update existing Field Mappings for a Linked Account. Changes will be reflected after the next scheduled sync. This will cause the next sync for this Linked Account to sync **ALL** data from start.
-
-
+**expand:** `typing.Optional[
+ typing.Union[
+ OpportunitiesListRequestExpandItem,
+ typing.Sequence[OpportunitiesListRequestExpandItem],
+ ]
+]` — 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.hris.field_mapping.field_mappings_partial_update(
- field_mapping_id="field_mapping_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
-
-
-
--
-
-**field_mapping_id:** `str`
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -31107,7 +30979,7 @@ client.hris.field_mapping.field_mappings_partial_update(
-
-**remote_field_traversal_path:** `typing.Optional[typing.Sequence[typing.Optional[typing.Any]]]` — The field traversal path of the remote field listed when you hit the GET /remote-fields endpoint.
+**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.
@@ -31115,7 +30987,7 @@ client.hris.field_mapping.field_mappings_partial_update(
-
-**remote_method:** `typing.Optional[str]` — The method of the remote endpoint where the remote field is coming from.
+**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -31123,7 +30995,7 @@ client.hris.field_mapping.field_mappings_partial_update(
-
-**remote_url_path:** `typing.Optional[str]` — The path of the remote endpoint where the remote field is coming from.
+**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
@@ -31131,7 +31003,7 @@ client.hris.field_mapping.field_mappings_partial_update(
-
-**jmes_path:** `typing.Optional[str]` — JMES path to specify json query expression to be used on field mapping.
+**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
@@ -31139,71 +31011,55 @@ client.hris.field_mapping.field_mappings_partial_update(
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+**owner_id:** `typing.Optional[str]` — If provided, will only return opportunities with this owner.
-
-
+
+-
+**page_size:** `typing.Optional[int]` — Number of results to return per page.
+
-client.hris.field_mapping.remote_fields_retrieve(...)
-
-#### 📝 Description
-
-
--
+**remote_created_after:** `typing.Optional[dt.datetime]` — If provided, will only return opportunities created in the third party platform after this datetime.
+
+
+
-
-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/).
-
-
+**remote_fields:** `typing.Optional[typing.Literal["status"]]` — Deprecated. Use show_enum_origins.
+
-#### 🔌 Usage
-
-
-
--
-
-```python
-from merge import Merge
-
-client = Merge(
- account_token="YOUR_ACCOUNT_TOKEN",
- api_key="YOUR_API_KEY",
-)
-client.hris.field_mapping.remote_fields_retrieve(
- common_models="common_models",
- include_example_values="include_example_values",
-)
-
-```
-
-
+**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
+
-#### ⚙️ Parameters
-
-
+**show_enum_origins:** `typing.Optional[typing.Literal["status"]]` — A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter)
+
+
+
+
-
-**common_models:** `typing.Optional[str]` — A comma seperated list of Common Model names. If included, will only return Remote Fields for those Common Models.
+**stage_id:** `typing.Optional[str]` — If provided, will only return opportunities with this stage.
@@ -31211,7 +31067,13 @@ client.hris.field_mapping.remote_fields_retrieve(
-
-**include_example_values:** `typing.Optional[str]` — If true, will include example values, where available, for remote fields in the 3rd party platform. These examples come from active data from your customers.
+**status:** `typing.Optional[OpportunitiesListRequestStatus]`
+
+If provided, will only return opportunities with this status. Options: ('OPEN', 'WON', 'LOST')
+
+* `OPEN` - OPEN
+* `WON` - WON
+* `LOST` - LOST
@@ -31231,7 +31093,7 @@ client.hris.field_mapping.remote_fields_retrieve(
client.hris.field_mapping.target_fields_retrieve()
+client.crm.opportunities.create(...)
-
@@ -31243,7 +31105,7 @@ client.hris.field_mapping.remote_fields_retrieve(
-
-Get all organization-wide Target Fields, this will not include any Linked Account specific Target Fields. Organization-wide Target Fields are additional fields appended to the Merge Common Model for all Linked Accounts in a category. [Learn more](https://docs.merge.dev/supplemental-data/field-mappings/target-fields/).
+Creates an `Opportunity` object with the given values.
@@ -31259,12 +31121,17 @@ Get all organization-wide Target Fields, this will not include any Linked Accoun
```python
from merge import Merge
+from merge.resources.crm import OpportunityRequest
client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.hris.field_mapping.target_fields_retrieve()
+client.crm.opportunities.create(
+ is_debug_mode=True,
+ run_async=True,
+ model=OpportunityRequest(),
+)
```
@@ -31280,6 +31147,30 @@ client.hris.field_mapping.target_fields_retrieve()
-
+**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.
@@ -31292,8 +31183,7 @@ client.hris.field_mapping.target_fields_retrieve()
client.hris.generate_key.create(...)
+client.crm.opportunities.retrieve(...)
-
@@ -31305,7 +31195,7 @@ client.hris.field_mapping.target_fields_retrieve()
-
-Create a remote key.
+Returns an `Opportunity` object with the given `id`.
@@ -31326,8 +31216,11 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.hris.generate_key.create(
- name="Remote Deployment Key 1",
+client.crm.opportunities.retrieve(
+ id="id",
+ include_remote_data=True,
+ include_remote_fields=True,
+ include_shell_data=True,
)
```
@@ -31344,7 +31237,7 @@ client.hris.generate_key.create(
-
-**name:** `str` — The name of the remote key
+**id:** `str`
@@ -31352,93 +31245,36 @@ client.hris.generate_key.create(
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+**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.
-
-
-
-
-
-
-client.hris.groups.list(...)
-
--
-
-#### 📝 Description
-
-
--
-
-Returns a list of `Group` objects.
-
-
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
+
-#### 🔌 Usage
-
-
--
-
-
-```python
-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",
-)
-
-```
-
-
+**include_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.
+
-#### ⚙️ Parameters
-
-
--
-
-
-**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).
@@ -31446,7 +31282,7 @@ client.hris.groups.list(
-
-**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
+**remote_fields:** `typing.Optional[typing.Literal["status"]]` — Deprecated. Use show_enum_origins.
@@ -31454,7 +31290,7 @@ client.hris.groups.list(
-
-**cursor:** `typing.Optional[str]` — The pagination cursor value.
+**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)
@@ -31462,71 +31298,74 @@ client.hris.groups.list(
-
-**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
-
--
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
-
+
client.crm.opportunities.partial_update(...)
-
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
-
-
-
+#### 📝 Description
-
-**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.
-
+Updates an `Opportunity` object with the given `id`.
+
+
+#### 🔌 Usage
+
-
-**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
-
-
-
-
-
-**names:** `typing.Optional[str]` — If provided, will only return groups with these names. Multiple values can be separated by commas.
-
+```python
+from merge import Merge
+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(),
+)
+
+```
+
+
+
+#### ⚙️ Parameters
-
-**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.
+**id:** `str`
@@ -31534,7 +31373,7 @@ client.hris.groups.list(
-
-**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
+**model:** `PatchedOpportunityRequest`
@@ -31542,7 +31381,7 @@ client.hris.groups.list(
-
-**show_enum_origins:** `typing.Optional[typing.Literal["type"]]` — A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter)
+**is_debug_mode:** `typing.Optional[bool]` — Whether to include debug fields (such as log file links) in the response.
@@ -31550,7 +31389,7 @@ client.hris.groups.list(
-
-**types:** `typing.Optional[str]` — If provided, will only return groups of these types. Multiple values can be separated by commas.
+**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously.
@@ -31570,7 +31409,7 @@ client.hris.groups.list(
client.hris.groups.retrieve(...)
+client.crm.opportunities.meta_patch_retrieve(...)
-
@@ -31582,7 +31421,7 @@ client.hris.groups.list(
-
-Returns a `Group` object with the given `id`.
+Returns metadata for `Opportunity` PATCHs.
@@ -31603,10 +31442,8 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.hris.groups.retrieve(
+client.crm.opportunities.meta_patch_retrieve(
id="id",
- include_remote_data=True,
- include_shell_data=True,
)
```
@@ -31631,34 +31468,63 @@ client.hris.groups.retrieve(
-
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
+**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.opportunities.meta_post_retrieve()
-
-**remote_fields:** `typing.Optional[typing.Literal["type"]]` — Deprecated. Use show_enum_origins.
-
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns metadata for `Opportunity` POSTs.
+
+
+#### 🔌 Usage
+
-
-**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)
-
+
+-
+
+```python
+from merge import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.crm.opportunities.meta_post_retrieve()
+
+```
+
+
+
+#### ⚙️ Parameters
+
+
+-
-
@@ -31675,8 +31541,7 @@ client.hris.groups.retrieve(
client.hris.issues.list(...)
+client.crm.opportunities.remote_field_classes_list(...)
-
@@ -31688,7 +31553,7 @@ client.hris.groups.retrieve(
-
-Gets all issues for Organization.
+Returns a list of `RemoteFieldClass` objects.
@@ -31703,39 +31568,27 @@ Gets all issues for Organization.
-
```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",
+response = client.crm.opportunities.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",
+ 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,
- 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
```
@@ -31751,7 +31604,7 @@ client.hris.issues.list(
-
-**account_token:** `typing.Optional[str]`
+**cursor:** `typing.Optional[str]` — The pagination cursor value.
@@ -31759,7 +31612,7 @@ client.hris.issues.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/).
@@ -31767,7 +31620,7 @@ client.hris.issues.list(
-
-**end_date:** `typing.Optional[str]` — If included, will only include issues whose most recent action occurred before this time
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -31775,7 +31628,7 @@ client.hris.issues.list(
-
-**end_user_organization_name:** `typing.Optional[str]`
+**include_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.
@@ -31783,7 +31636,7 @@ client.hris.issues.list(
-
-**first_incident_time_after:** `typing.Optional[dt.datetime]` — If provided, will only return issues whose first incident time was after this datetime.
+**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -31791,7 +31644,7 @@ client.hris.issues.list(
-
-**first_incident_time_before:** `typing.Optional[dt.datetime]` — If provided, will only return issues whose first incident time was before this datetime.
+**is_common_model_field:** `typing.Optional[bool]` — If provided, will only return remote field classes with this is_common_model_field value
@@ -31799,7 +31652,7 @@ client.hris.issues.list(
-
-**include_muted:** `typing.Optional[str]` — If true, will include muted issues
+**is_custom:** `typing.Optional[bool]` — If provided, will only return remote fields classes with this is_custom value
@@ -31807,7 +31660,7 @@ client.hris.issues.list(
-
-**integration_name:** `typing.Optional[str]`
+**page_size:** `typing.Optional[int]` — Number of results to return per page.
@@ -31815,52 +31668,75 @@ client.hris.issues.list(
-
-**last_incident_time_after:** `typing.Optional[dt.datetime]` — If provided, will only return issues whose last incident time was after this datetime.
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
-
--
-**last_incident_time_before:** `typing.Optional[dt.datetime]` — If provided, will only return issues whose last incident time was before this datetime.
-
+client.crm.passthrough.create(...)
-
-**linked_account_id:** `typing.Optional[str]` — If provided, will only include issues pertaining to the linked account passed in.
-
-
-
+#### 📝 Description
-
-**page_size:** `typing.Optional[int]` — Number of results to return per page. The maximum limit is 100.
-
+
+-
+
+Pull data from an endpoint not currently supported by Merge.
+
+
+#### 🔌 Usage
+
-
-**start_date:** `typing.Optional[str]` — If included, will only include issues whose most recent action occurred after this time
-
+
+-
+
+```python
+from merge import Merge
+from merge.resources.crm import DataPassthroughRequest, MethodEnum
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.crm.passthrough.create(
+ request=DataPassthroughRequest(
+ method=MethodEnum.GET,
+ path="/scooters",
+ ),
+)
+
+```
+
+
+#### ⚙️ Parameters
+
-
-**status:** `typing.Optional[IssuesListRequestStatus]`
-
-Status of the issue. Options: ('ONGOING', 'RESOLVED')
+
+-
-* `ONGOING` - ONGOING
-* `RESOLVED` - RESOLVED
+**request:** `DataPassthroughRequest`
@@ -31880,7 +31756,8 @@ Status of the issue. Options: ('ONGOING', 'RESOLVED')
client.hris.issues.retrieve(...)
+## Crm RegenerateKey
+client.crm.regenerate_key.create(...)
-
@@ -31892,7 +31769,7 @@ Status of the issue. Options: ('ONGOING', 'RESOLVED')
-
-Get a specific issue.
+Exchange remote keys.
@@ -31913,8 +31790,8 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.hris.issues.retrieve(
- id="id",
+client.crm.regenerate_key.create(
+ name="Remote Deployment Key 1",
)
```
@@ -31931,7 +31808,7 @@ client.hris.issues.retrieve(
-
-**id:** `str`
+**name:** `str` — The name of the remote key
@@ -31951,8 +31828,8 @@ client.hris.issues.retrieve(
client.hris.link_token.create(...)
+## Crm Stages
+client.crm.stages.list(...)
-
@@ -31964,7 +31841,7 @@ client.hris.issues.retrieve(
-
-Creates a link token to be used when linking a new end user.
+Returns a list of `Stage` objects.
@@ -31979,19 +31856,40 @@ Creates a link token to be used when linking a new end user.
-
```python
+import datetime
+
from merge import Merge
-from merge.resources.hris import CategoriesEnum
client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.hris.link_token.create(
- end_user_email_address="example@gmail.com",
- end_user_organization_name="Test Organization",
- end_user_origin_id="12345",
- categories=[CategoriesEnum.HRIS, CategoriesEnum.ATS],
+response = 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",
)
+for item in response:
+ yield item
+# alternatively, you can paginate page-by-page
+for page in response.iter_pages():
+ yield page
```
@@ -32007,7 +31905,7 @@ client.hris.link_token.create(
-
-**end_user_email_address:** `str` — Your end user's email address. This is purely for identification purposes - setting this value will not cause any emails to be sent.
+**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
@@ -32015,7 +31913,7 @@ client.hris.link_token.create(
-
-**end_user_organization_name:** `str` — Your end user's organization.
+**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
@@ -32023,7 +31921,7 @@ client.hris.link_token.create(
-
-**end_user_origin_id:** `str` — This unique identifier typically represents the ID for your end user in your product's database. This value must be distinct from other Linked Accounts' unique identifiers.
+**cursor:** `typing.Optional[str]` — The pagination cursor value.
@@ -32031,7 +31929,7 @@ client.hris.link_token.create(
-
-**categories:** `typing.Sequence[CategoriesEnum]` — The integration categories to show in Merge Link.
+**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
@@ -32039,7 +31937,7 @@ client.hris.link_token.create(
-
-**integration:** `typing.Optional[str]` — The slug of a specific pre-selected integration for this linking flow token. For examples of slugs, see https://docs.merge.dev/guides/merge-link/single-integration/.
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -32047,7 +31945,7 @@ client.hris.link_token.create(
-
-**link_expiry_mins:** `typing.Optional[int]` — An integer number of minutes between [30, 720 or 10080 if for a Magic Link URL] for how long this token is valid. Defaults to 30.
+**include_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.
@@ -32055,7 +31953,7 @@ client.hris.link_token.create(
-
-**should_create_magic_link_url:** `typing.Optional[bool]` — Whether to generate a Magic Link URL. Defaults to false. For more information on Magic Link, see https://merge.dev/blog/integrations-fast-say-hello-to-magic-link.
+**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -32063,7 +31961,7 @@ client.hris.link_token.create(
-
-**hide_admin_magic_link:** `typing.Optional[bool]` — Whether to generate a Magic Link URL on the Admin Needed screen during the linking flow. Defaults to false. For more information on Magic Link, see https://merge.dev/blog/integrations-fast-say-hello-to-magic-link.
+**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
@@ -32071,7 +31969,7 @@ client.hris.link_token.create(
-
-**common_models:** `typing.Optional[typing.Sequence[CommonModelScopesBodyRequest]]` — An array of objects to specify the models and fields that will be disabled for a given Linked Account. Each object uses model_id, enabled_actions, and disabled_fields to specify the model, method, and fields that are scoped for a given Linked Account.
+**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
@@ -32079,14 +31977,7 @@ client.hris.link_token.create(
-
-**category_common_model_scopes:** `typing.Optional[
- typing.Dict[
- str,
- typing.Optional[
- typing.Sequence[IndividualCommonModelScopeDeserializerRequest]
- ],
- ]
-]` — When creating a Link Token, you can set permissions for Common Models that will apply to the account that is going to be linked. Any model or field not specified in link token payload will default to existing settings.
+**page_size:** `typing.Optional[int]` — Number of results to return per page.
@@ -32094,20 +31985,81 @@ client.hris.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.crm.stages.retrieve(...)
-
-**are_syncs_disabled:** `typing.Optional[bool]` — The boolean that indicates whether initial, periodic, and force syncs will be disabled.
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a `Stage` object with the given `id`.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge import Merge
+
+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,
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**id:** `str`
@@ -32115,7 +32067,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.
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -32123,11 +32075,15 @@ The following subset of IETF language tags can be used to configure localization
-
-**completed_account_initial_screen:** `typing.Optional[EndUserDetailsRequestCompletedAccountInitialScreen]`
+**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.
+
+
+
-When creating a Link token, you can specifiy the initial screen of Linking Flow for a completed Linked Account.
+
+-
-* `SELECTIVE_SYNC` - SELECTIVE_SYNC
+**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -32147,8 +32103,7 @@ When creating a Link token, you can specifiy the initial screen of Linking Flow
client.hris.linked_accounts.list(...)
+client.crm.stages.remote_field_classes_list(...)
-
@@ -32160,7 +32115,7 @@ When creating a Link token, you can specifiy the initial screen of Linking Flow
-
-List linked accounts for your organization.
+Returns a list of `RemoteFieldClass` objects.
@@ -32176,29 +32131,26 @@ List linked accounts for your organization.
```python
from merge import Merge
-from merge.resources.hris.resources.linked_accounts import (
- LinkedAccountsListRequestCategory,
-)
client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.hris.linked_accounts.list(
- category=LinkedAccountsListRequestCategory.ACCOUNTING,
+response = client.crm.stages.remote_field_classes_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",
+ 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,
- status="status",
)
+for item in response:
+ yield item
+# alternatively, you can paginate page-by-page
+for page in response.iter_pages():
+ yield page
```
@@ -32214,17 +32166,7 @@ client.hris.linked_accounts.list(
-
-**category:** `typing.Optional[LinkedAccountsListRequestCategory]`
-
-Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing`
-
-* `hris` - hris
-* `ats` - ats
-* `accounting` - accounting
-* `ticketing` - ticketing
-* `crm` - crm
-* `mktg` - mktg
-* `filestorage` - filestorage
+**cursor:** `typing.Optional[str]` — The pagination cursor value.
@@ -32232,7 +32174,7 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing`
-
-**cursor:** `typing.Optional[str]` — The pagination cursor value.
+**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
@@ -32240,7 +32182,7 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing`
-
-**end_user_email_address:** `typing.Optional[str]` — If provided, will only return linked accounts associated with the given email address.
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -32248,7 +32190,7 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing`
-
-**end_user_organization_name:** `typing.Optional[str]` — If provided, will only return linked accounts associated with the given organization name.
+**include_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.
@@ -32256,7 +32198,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.
+**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -32264,7 +32206,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.
+**is_common_model_field:** `typing.Optional[bool]` — If provided, will only return remote field classes with this is_common_model_field value
@@ -32272,7 +32214,7 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing`
-
-**id:** `typing.Optional[str]`
+**is_custom:** `typing.Optional[bool]` — If provided, will only return remote fields classes with this is_custom value
@@ -32280,7 +32222,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.
+**page_size:** `typing.Optional[int]` — Number of results to return per page.
@@ -32288,23 +32230,72 @@ 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.
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+client.crm.sync_status.list(...)
+
+-
+
+#### 📝 Description
-
-**integration_name:** `typing.Optional[str]` — If provided, will only return linked accounts associated with the given integration name.
-
+
+-
+
+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_test_account:** `typing.Optional[str]` — If included, will only include test linked accounts. If not included, will only include non-test linked accounts.
+
+-
+
+```python
+from merge import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.crm.sync_status.list(
+ cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
+ page_size=1,
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**cursor:** `typing.Optional[str]` — The pagination cursor value.
@@ -32312,7 +32303,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.
+**page_size:** `typing.Optional[int]` — Number of results to return per page.
@@ -32320,10 +32311,64 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing`
-
-**status:** `typing.Optional[str]` — Filter by status. Options: `COMPLETE`, `IDLE`, `INCOMPLETE`, `RELINK_NEEDED`
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+client.crm.force_resync.sync_status_resync_create()
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Force re-sync of all models. This endpoint is available for monthly, quarterly, and highest sync frequency customers on the Professional or Enterprise plans. Doing so will consume a sync credit for the relevant linked account. Force re-syncs can also be triggered manually in the Merge Dashboard and is available for all customers.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from merge import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.crm.force_resync.sync_status_resync_create()
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
-
@@ -32340,8 +32385,8 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing`
client.hris.locations.list(...)
+## Crm Tasks
+client.crm.tasks.list(...)
-
@@ -32353,7 +32398,7 @@ Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing`
-
-Returns a list of `Location` objects.
+Returns a list of `Task` objects.
@@ -32371,17 +32416,12 @@ Returns a list of `Location` objects.
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(
+response = client.crm.tasks.list(
created_after=datetime.datetime.fromisoformat(
"2024-01-15 09:30:00+00:00",
),
@@ -32391,8 +32431,8 @@ client.hris.locations.list(
cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
include_deleted_data=True,
include_remote_data=True,
+ include_remote_fields=True,
include_shell_data=True,
- location_type=LocationsListRequestLocationType.HOME,
modified_after=datetime.datetime.fromisoformat(
"2024-01-15 09:30:00+00:00",
),
@@ -32400,10 +32440,13 @@ client.hris.locations.list(
"2024-01-15 09:30:00+00:00",
),
page_size=1,
- remote_fields=LocationsListRequestRemoteFields.COUNTRY,
remote_id="remote_id",
- show_enum_origins=LocationsListRequestShowEnumOrigins.COUNTRY,
)
+for item in response:
+ yield item
+# alternatively, you can paginate page-by-page
+for page in response.iter_pages():
+ yield page
```
@@ -32443,6 +32486,18 @@ client.hris.locations.list(
-
+**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.
+
+
+
+
+
+-
+
**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
@@ -32459,6 +32514,14 @@ client.hris.locations.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).
@@ -32467,12 +32530,15 @@ client.hris.locations.list(
-
-**location_type:** `typing.Optional[LocationsListRequestLocationType]`
+**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
+
+
+
-If provided, will only return locations with this location type
+
+-
-* `HOME` - HOME
-* `WORK` - WORK
+**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
@@ -32480,7 +32546,7 @@ If provided, will only return locations with this location type
-
-**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
+**page_size:** `typing.Optional[int]` — Number of results to return per page.
@@ -32488,7 +32554,7 @@ If provided, will only return locations with this location type
-
-**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
+**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
@@ -32496,15 +32562,73 @@ If provided, will only return locations with this location type
-
-**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.
+
+
+
+
+
+
+
client.crm.tasks.create(...)
-
-**remote_fields:** `typing.Optional[LocationsListRequestRemoteFields]` — Deprecated. Use show_enum_origins.
+#### 📝 Description
+
+
+-
+
+
+-
+
+Creates a `Task` object with the given values.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```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(),
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**model:** `TaskRequest`
@@ -32512,7 +32636,7 @@ If provided, will only return locations with this location type
-
-**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
+**is_debug_mode:** `typing.Optional[bool]` — Whether to include debug fields (such as log file links) in the response.
@@ -32520,7 +32644,7 @@ If provided, will only return locations with this location type
-
-**show_enum_origins:** `typing.Optional[LocationsListRequestShowEnumOrigins]` — A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter)
+**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously.
@@ -32540,7 +32664,7 @@ If provided, will only return locations with this location type
client.hris.locations.retrieve(...)
+client.crm.tasks.retrieve(...)
-
@@ -32552,7 +32676,7 @@ If provided, will only return locations with this location type
-
-Returns a `Location` object with the given `id`.
+Returns a `Task` object with the given `id`.
@@ -32568,21 +32692,16 @@ Returns a `Location` object with the given `id`.
```python
from merge import Merge
-from merge.resources.hris.resources.locations import (
- LocationsRetrieveRequestRemoteFields,
- LocationsRetrieveRequestShowEnumOrigins,
-)
client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.hris.locations.retrieve(
+client.crm.tasks.retrieve(
id="id",
include_remote_data=True,
+ include_remote_fields=True,
include_shell_data=True,
- remote_fields=LocationsRetrieveRequestRemoteFields.COUNTRY,
- show_enum_origins=LocationsRetrieveRequestShowEnumOrigins.COUNTRY,
)
```
@@ -32607,7 +32726,12 @@ client.hris.locations.retrieve(
-
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
+**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.
@@ -32615,7 +32739,7 @@ client.hris.locations.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.
@@ -32623,7 +32747,7 @@ client.hris.locations.retrieve(
-
-**remote_fields:** `typing.Optional[LocationsRetrieveRequestRemoteFields]` — Deprecated. Use show_enum_origins.
+**include_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.
@@ -32631,7 +32755,7 @@ client.hris.locations.retrieve(
-
-**show_enum_origins:** `typing.Optional[LocationsRetrieveRequestShowEnumOrigins]` — A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter)
+**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -32651,8 +32775,7 @@ client.hris.locations.retrieve(
client.hris.passthrough.create(...)
+client.crm.tasks.partial_update(...)
-
@@ -32664,7 +32787,7 @@ client.hris.locations.retrieve(
-
-Pull data from an endpoint not currently supported by Merge.
+Updates a `Task` object with the given `id`.
@@ -32680,17 +32803,17 @@ Pull data from an endpoint not currently supported by Merge.
```python
from merge import Merge
-from merge.resources.hris import DataPassthroughRequest, MethodEnum
+from merge.resources.crm import PatchedTaskRequest
client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.hris.passthrough.create(
- request=DataPassthroughRequest(
- method=MethodEnum.GET,
- path="/scooters",
- ),
+client.crm.tasks.partial_update(
+ id="id",
+ is_debug_mode=True,
+ run_async=True,
+ model=PatchedTaskRequest(),
)
```
@@ -32707,7 +32830,31 @@ client.hris.passthrough.create(
-
-**request:** `DataPassthroughRequest`
+**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.
@@ -32727,8 +32874,7 @@ client.hris.passthrough.create(
client.hris.pay_groups.list(...)
+client.crm.tasks.meta_patch_retrieve(...)
-
@@ -32740,7 +32886,7 @@ client.hris.passthrough.create(
-
-Returns a list of `PayGroup` objects.
+Returns metadata for `Task` PATCHs.
@@ -32755,33 +32901,14 @@ Returns a list of `PayGroup` objects.
-
```python
-import datetime
-
from merge import Merge
client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.hris.pay_groups.list(
- created_after=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- created_before=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
- include_deleted_data=True,
- include_remote_data=True,
- include_shell_data=True,
- modified_after=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- modified_before=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- page_size=1,
- remote_id="remote_id",
+client.crm.tasks.meta_patch_retrieve(
+ id="id",
)
```
@@ -32798,7 +32925,7 @@ client.hris.pay_groups.list(
-
-**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
+**id:** `str`
@@ -32806,75 +32933,64 @@ client.hris.pay_groups.list(
-
-**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
--
-
-**cursor:** `typing.Optional[str]` — The pagination cursor value.
-
-
--
-**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
-
+
client.crm.tasks.meta_post_retrieve()
-
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
-
-
-
+#### 📝 Description
-
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
-
-
-
-
-
-**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
-
+Returns metadata for `Task` POSTs.
+
+
+#### 🔌 Usage
+
-
-**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
-
-
-
-
-
-**page_size:** `typing.Optional[int]` — Number of results to return per page. The maximum limit is 100.
-
+```python
+from merge import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.crm.tasks.meta_post_retrieve()
+
+```
+
+
+#### ⚙️ Parameters
+
-
-**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
-
-
-
-
-
@@ -32890,7 +33006,7 @@ client.hris.pay_groups.list(
client.hris.pay_groups.retrieve(...)
+client.crm.tasks.remote_field_classes_list(...)
-
@@ -32902,7 +33018,7 @@ client.hris.pay_groups.list(
-
-Returns a `PayGroup` object with the given `id`.
+Returns a list of `RemoteFieldClass` objects.
@@ -32923,11 +33039,21 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.hris.pay_groups.retrieve(
- id="id",
+response = 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,
)
+for item in response:
+ yield item
+# alternatively, you can paginate page-by-page
+for page in response.iter_pages():
+ yield page
```
@@ -32943,7 +33069,15 @@ client.hris.pay_groups.retrieve(
-
-**id:** `str`
+**cursor:** `typing.Optional[str]` — The pagination cursor value.
+
+
+
+
+
+-
+
+**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
@@ -32959,6 +33093,14 @@ client.hris.pay_groups.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).
@@ -32967,6 +33109,30 @@ client.hris.pay_groups.retrieve(
-
+**is_common_model_field:** `typing.Optional[bool]` — If provided, will only return remote field classes with this is_common_model_field value
+
+
+
+
+
+-
+
+**is_custom:** `typing.Optional[bool]` — If provided, will only return remote fields classes with this is_custom value
+
+
+
+
+
+-
+
+**page_size:** `typing.Optional[int]` — Number of results to return per page.
+
+
+
+
+
+-
+
**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -32979,8 +33145,8 @@ client.hris.pay_groups.retrieve(
client.hris.payroll_runs.list(...)
+## Crm Users
+client.crm.users.list(...)
-
@@ -32992,7 +33158,7 @@ client.hris.pay_groups.retrieve(
-
-Returns a list of `PayrollRun` objects.
+Returns a list of `User` objects.
@@ -33010,17 +33176,12 @@ Returns a list of `PayrollRun` objects.
import datetime
from merge import Merge
-from merge.resources.hris.resources.payroll_runs import (
- PayrollRunsListRequestRemoteFields,
- PayrollRunsListRequestRunType,
- PayrollRunsListRequestShowEnumOrigins,
-)
client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.hris.payroll_runs.list(
+response = client.crm.users.list(
created_after=datetime.datetime.fromisoformat(
"2024-01-15 09:30:00+00:00",
),
@@ -33028,14 +33189,10 @@ client.hris.payroll_runs.list(
"2024-01-15 09:30:00+00:00",
),
cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
- ended_after=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- ended_before=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
+ 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",
@@ -33044,17 +33201,13 @@ client.hris.payroll_runs.list(
"2024-01-15 09:30:00+00:00",
),
page_size=1,
- remote_fields=PayrollRunsListRequestRemoteFields.RUN_STATE,
remote_id="remote_id",
- run_type=PayrollRunsListRequestRunType.CORRECTION,
- show_enum_origins=PayrollRunsListRequestShowEnumOrigins.RUN_STATE,
- started_after=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- started_before=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
)
+for item in response:
+ yield item
+# alternatively, you can paginate page-by-page
+for page in response.iter_pages():
+ yield page
```
@@ -33094,7 +33247,7 @@ client.hris.payroll_runs.list(
-
-**ended_after:** `typing.Optional[dt.datetime]` — If provided, will only return payroll runs ended after this datetime.
+**email:** `typing.Optional[str]` — If provided, will only return users with this email.
@@ -33102,7 +33255,7 @@ client.hris.payroll_runs.list(
-
-**ended_before:** `typing.Optional[dt.datetime]` — If provided, will only return payroll runs ended before this datetime.
+**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
@@ -33110,7 +33263,7 @@ client.hris.payroll_runs.list(
-
-**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -33118,7 +33271,7 @@ client.hris.payroll_runs.list(
-
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
+**include_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.
@@ -33150,7 +33303,7 @@ client.hris.payroll_runs.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.
@@ -33158,7 +33311,7 @@ client.hris.payroll_runs.list(
-
-**remote_fields:** `typing.Optional[PayrollRunsListRequestRemoteFields]` — Deprecated. Use show_enum_origins.
+**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
@@ -33166,85 +33319,37 @@ client.hris.payroll_runs.list(
-
-**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
--
-
-**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)
-
+
client.crm.users.retrieve(...)
-
-**started_after:** `typing.Optional[dt.datetime]` — If provided, will only return payroll runs started after this datetime.
-
-
-
+#### 📝 Description
-
-**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.
-
+Returns a `User` object with the given `id`.
-
-
-
-client.hris.payroll_runs.retrieve(...)
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Returns a `PayrollRun` object with the given `id`.
-
-
-
-
-
-#### 🔌 Usage
+#### 🔌 Usage
-
@@ -33254,21 +33359,16 @@ Returns a `PayrollRun` object with the given `id`.
```python
from merge import Merge
-from merge.resources.hris.resources.payroll_runs import (
- PayrollRunsRetrieveRequestRemoteFields,
- PayrollRunsRetrieveRequestShowEnumOrigins,
-)
client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.hris.payroll_runs.retrieve(
+client.crm.users.retrieve(
id="id",
include_remote_data=True,
+ include_remote_fields=True,
include_shell_data=True,
- remote_fields=PayrollRunsRetrieveRequestRemoteFields.RUN_STATE,
- show_enum_origins=PayrollRunsRetrieveRequestShowEnumOrigins.RUN_STATE,
)
```
@@ -33301,15 +33401,7 @@ client.hris.payroll_runs.retrieve(
-
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
-
-
-
-
-
--
-
-**remote_fields:** `typing.Optional[PayrollRunsRetrieveRequestRemoteFields]` — Deprecated. Use show_enum_origins.
+**include_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.
@@ -33317,7 +33409,7 @@ client.hris.payroll_runs.retrieve(
-
-**show_enum_origins:** `typing.Optional[PayrollRunsRetrieveRequestShowEnumOrigins]` — A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter)
+**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -33337,8 +33429,7 @@ client.hris.payroll_runs.retrieve(
client.hris.regenerate_key.create(...)
+client.crm.users.ignore_create(...)
-
@@ -33350,7 +33441,7 @@ client.hris.payroll_runs.retrieve(
-
-Exchange remote keys.
+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.
@@ -33366,13 +33457,17 @@ Exchange remote keys.
```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.hris.regenerate_key.create(
- name="Remote Deployment Key 1",
+client.crm.users.ignore_create(
+ model_id="model_id",
+ request=IgnoreCommonModelRequest(
+ reason=ReasonEnum.GENERAL_CUSTOMER_REQUEST,
+ ),
)
```
@@ -33389,7 +33484,15 @@ client.hris.regenerate_key.create(
-
-**name:** `str` — The name of the remote key
+**model_id:** `str`
+
+
+
+
+
+-
+
+**request:** `IgnoreCommonModelRequest`
@@ -33409,8 +33512,7 @@ client.hris.regenerate_key.create(
client.hris.sync_status.list(...)
+client.crm.users.remote_field_classes_list(...)
-
@@ -33422,7 +33524,7 @@ client.hris.regenerate_key.create(
-
-Get sync status for the current sync and the most recently finished sync. `last_sync_start` represents the most recent time any sync began. `last_sync_finished` represents the most recent time any sync completed. These timestamps may correspond to different sync instances which may result in a sync start time being later than a separate sync completed time. To ensure you are retrieving the latest available data reference the `last_sync_finished` timestamp where `last_sync_result` is `DONE`. Possible values for `status` and `last_sync_result` are `DISABLED`, `DONE`, `FAILED`, `PARTIALLY_SYNCED`, `PAUSED`, `SYNCING`. Learn more about sync status in our [Help Center](https://help.merge.dev/en/articles/8184193-merge-sync-statuses).
+Returns a list of `RemoteFieldClass` objects.
@@ -33443,10 +33545,21 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.hris.sync_status.list(
+response = client.crm.users.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
```
@@ -33470,7 +33583,7 @@ client.hris.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/).
@@ -33478,65 +33591,51 @@ client.hris.sync_status.list(
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
-
-
+
+-
+**include_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.
+
-client.hris.force_resync.sync_status_resync_create()
-
-#### 📝 Description
-
-
--
+**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
+
+
+
-
-Force re-sync of all models. This endpoint is available for monthly, quarterly, and highest sync frequency customers on the Professional or Enterprise plans. Doing so will consume a sync credit for the relevant linked account. Force re-syncs can also be triggered manually in the Merge Dashboard and is available for all customers.
-
-
+**is_common_model_field:** `typing.Optional[bool]` — If provided, will only return remote field classes with this is_common_model_field value
+
-#### 🔌 Usage
-
-
--
-
-
-```python
-from merge import Merge
-
-client = Merge(
- account_token="YOUR_ACCOUNT_TOKEN",
- api_key="YOUR_API_KEY",
-)
-client.hris.force_resync.sync_status_resync_create()
-
-```
-
-
+**is_custom:** `typing.Optional[bool]` — If provided, will only return remote fields classes with this is_custom value
+
-#### ⚙️ Parameters
-
-
+**page_size:** `typing.Optional[int]` — Number of results to return per page.
+
+
+
+
-
@@ -33552,8 +33651,8 @@ client.hris.force_resync.sync_status_resync_create()
client.hris.teams.list(...)
+## Crm WebhookReceivers
+client.crm.webhook_receivers.list()
-
@@ -33565,7 +33664,7 @@ client.hris.force_resync.sync_status_resync_create()
-
-Returns a list of `Team` objects.
+Returns a list of `WebhookReceiver` objects.
@@ -33580,35 +33679,13 @@ 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.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",
-)
+client.crm.webhook_receivers.list()
```
@@ -33624,79 +33701,71 @@ client.hris.teams.list(
-
-**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
--
-
-**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
-
-
--
-**cursor:** `typing.Optional[str]` — The pagination cursor value.
-
+
client.crm.webhook_receivers.create(...)
-
-**expand:** `typing.Optional[typing.Literal["parent_team"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
-
-
-
+#### 📝 Description
-
-**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
-
-
-
-
-
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
-
+Creates a `WebhookReceiver` object with the given values.
+
+
+
+#### 🔌 Usage
-
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
-
-
-
-
-
-**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
-
+```python
+from merge import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.crm.webhook_receivers.create(
+ event="event",
+ is_active=True,
+)
+
+```
+
+
+
+#### ⚙️ 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. The maximum limit is 100.
+**event:** `str`
@@ -33704,7 +33773,7 @@ client.hris.teams.list(
-
-**parent_team_id:** `typing.Optional[str]` — If provided, will only return teams with this parent team.
+**is_active:** `bool`
@@ -33712,7 +33781,7 @@ client.hris.teams.list(
-
-**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
+**key:** `typing.Optional[str]`
@@ -33732,7 +33801,8 @@ client.hris.teams.list(
client.hris.teams.retrieve(...)
+## FileStorage AccountDetails
+client.file_storage.account_details.retrieve()
-
@@ -33744,7 +33814,7 @@ client.hris.teams.list(
-
-Returns a `Team` object with the given `id`.
+Get details for a linked account.
@@ -33765,11 +33835,7 @@ 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,
-)
+client.file_storage.account_details.retrieve()
```
@@ -33785,38 +33851,6 @@ client.hris.teams.retrieve(
-
-**id:** `str`
-
-
-
-
-
--
-
-**expand:** `typing.Optional[typing.Literal["parent_team"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
-
-
-
-
-
--
-
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
-
-
-
-
-
--
-
-**include_shell_data:** `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.
@@ -33829,8 +33863,8 @@ client.hris.teams.retrieve(
client.hris.time_off.list(...)
+## FileStorage AccountToken
+client.file_storage.account_token.retrieve(...)
-
@@ -33842,7 +33876,7 @@ client.hris.teams.retrieve(
-
-Returns a list of `TimeOff` objects.
+Returns the account token for the end user with the provided public token.
@@ -33857,59 +33891,14 @@ Returns a list of `TimeOff` objects.
-
```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,
+client.file_storage.account_token.retrieve(
+ public_token="public_token",
)
```
@@ -33926,55 +33915,7 @@ client.hris.time_off.list(
-
-**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.
+**public_token:** `str`
@@ -33982,128 +33923,75 @@ client.hris.time_off.list(
-
-**expand:** `typing.Optional[TimeOffListRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+**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.file_storage.async_passthrough.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
-
-**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.
-
+Asynchronously pull data from an endpoint not currently supported by Merge.
-
-
--
-
-**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.
-
-
-
+#### 🔌 Usage
-
-**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
-
-
-
-
-
-**request_type:** `typing.Optional[TimeOffListRequestRequestType]`
+```python
+from merge import Merge
+from merge.resources.file_storage import DataPassthroughRequest, MethodEnum
-If provided, will only return TimeOff with this request type. Options: ('VACATION', 'SICK', 'PERSONAL', 'JURY_DUTY', 'VOLUNTEER', 'BEREAVEMENT')
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.file_storage.async_passthrough.create(
+ request=DataPassthroughRequest(
+ method=MethodEnum.GET,
+ path="/scooters",
+ ),
+)
-* `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.
-
-
-
+#### ⚙️ Parameters
-
-**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:** `DataPassthroughRequest`
@@ -34123,7 +34011,7 @@ If provided, will only return TimeOff with this status. Options: ('REQUESTED', '
client.hris.time_off.create(...)
+client.file_storage.async_passthrough.retrieve(...)
-
@@ -34135,7 +34023,7 @@ If provided, will only return TimeOff with this status. Options: ('REQUESTED', '
-
-Creates a `TimeOff` object with the given values.
+Retrieves data from earlier async-passthrough POST request
@@ -34151,16 +34039,13 @@ Creates a `TimeOff` object with the given values.
```python
from merge import Merge
-from merge.resources.hris import TimeOffRequest
client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.hris.time_off.create(
- is_debug_mode=True,
- run_async=True,
- model=TimeOffRequest(),
+client.file_storage.async_passthrough.retrieve(
+ async_passthrough_receipt_id="async_passthrough_receipt_id",
)
```
@@ -34177,23 +34062,7 @@ client.hris.time_off.create(
-
-**model:** `TimeOffRequest`
-
-
-
-
-
--
-
-**is_debug_mode:** `typing.Optional[bool]` — Whether to include debug fields (such as log file links) in the response.
-
-
-
-
-
--
-
-**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously.
+**async_passthrough_receipt_id:** `str`
@@ -34213,7 +34082,8 @@ client.hris.time_off.create(
client.hris.time_off.retrieve(...)
+## FileStorage AuditTrail
+client.file_storage.audit_trail.list(...)
-
@@ -34225,7 +34095,7 @@ client.hris.time_off.create(
-
-Returns a `TimeOff` object with the given `id`.
+Gets a list of audit trail events.
@@ -34241,24 +34111,24 @@ Returns a `TimeOff` object with the given `id`.
```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,
+response = client.file_storage.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
```
@@ -34274,7 +34144,7 @@ client.hris.time_off.retrieve(
-
-**id:** `str`
+**cursor:** `typing.Optional[str]` — The pagination cursor value.
@@ -34282,7 +34152,7 @@ client.hris.time_off.retrieve(
-
-**expand:** `typing.Optional[TimeOffRetrieveRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+**end_date:** `typing.Optional[str]` — If included, will only include audit trail events that occurred before this time
@@ -34290,7 +34160,7 @@ client.hris.time_off.retrieve(
-
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
+**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`
@@ -34298,7 +34168,7 @@ client.hris.time_off.retrieve(
-
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
+**page_size:** `typing.Optional[int]` — Number of results to return per page.
@@ -34306,7 +34176,7 @@ client.hris.time_off.retrieve(
-
-**remote_fields:** `typing.Optional[TimeOffRetrieveRequestRemoteFields]` — Deprecated. Use show_enum_origins.
+**start_date:** `typing.Optional[str]` — If included, will only include audit trail events that occurred after this time
@@ -34314,7 +34184,7 @@ client.hris.time_off.retrieve(
-
-**show_enum_origins:** `typing.Optional[TimeOffRetrieveRequestShowEnumOrigins]` — A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter)
+**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.
@@ -34334,7 +34204,8 @@ client.hris.time_off.retrieve(
client.hris.time_off.meta_post_retrieve()
+## FileStorage AvailableActions
+client.file_storage.available_actions.retrieve()
-
@@ -34346,7 +34217,7 @@ client.hris.time_off.retrieve(
-
-Returns metadata for `TimeOff` POSTs.
+Returns a list of models and actions available for an account.
@@ -34367,7 +34238,7 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.hris.time_off.meta_post_retrieve()
+client.file_storage.available_actions.retrieve()
```
@@ -34395,8 +34266,8 @@ client.hris.time_off.meta_post_retrieve()
client.hris.time_off_balances.list(...)
+## FileStorage Scopes
+client.file_storage.scopes.default_scopes_retrieve()
-
@@ -34408,7 +34279,7 @@ client.hris.time_off.meta_post_retrieve()
-
-Returns a list of `TimeOffBalance` 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).
@@ -34423,39 +34294,13 @@ Returns a list of `TimeOffBalance` objects.
-
```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",
-)
+client.file_storage.scopes.default_scopes_retrieve()
```
@@ -34471,132 +34316,64 @@ client.hris.time_off_balances.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.
-
-
-
-
-
--
-
-**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.
-
+
client.file_storage.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.
-
-
--
-
-**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
-
-
-
+#### 🔌 Usage
-
-**page_size:** `typing.Optional[int]` — Number of results to return per page. The maximum limit is 100.
-
-
-
-
-
-**policy_type:** `typing.Optional[TimeOffBalancesListRequestPolicyType]`
+```python
+from merge import Merge
-If provided, will only return TimeOffBalance with this policy type. Options: ('VACATION', 'SICK', 'PERSONAL', 'JURY_DUTY', 'VOLUNTEER', 'BEREAVEMENT')
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.file_storage.scopes.linked_account_scopes_retrieve()
-* `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.
-
-
-
+#### ⚙️ Parameters
-
-**show_enum_origins:** `typing.Optional[typing.Literal["policy_type"]]` — A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter)
-
-
-
-
-
@@ -34612,7 +34389,7 @@ If provided, will only return TimeOffBalance with this policy type. Options: ('V
client.hris.time_off_balances.retrieve(...)
+client.file_storage.scopes.linked_account_scopes_create(...)
-
@@ -34624,7 +34401,7 @@ If provided, will only return TimeOffBalance with this policy type. Options: ('V
-
-Returns a `TimeOffBalance` 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)
@@ -34640,15 +34417,42 @@ Returns a `TimeOffBalance` object with the given `id`.
```python
from merge import Merge
+from merge.resources.file_storage import (
+ FieldPermissionDeserializerRequest,
+ IndividualCommonModelScopeDeserializerRequest,
+ ModelPermissionDeserializerRequest,
+)
client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.hris.time_off_balances.retrieve(
- id="id",
- include_remote_data=True,
- include_shell_data=True,
+client.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,
+ )
+ },
+ ),
+ ],
)
```
@@ -34665,7 +34469,7 @@ client.hris.time_off_balances.retrieve(
-
-**id:** `str`
+**common_models:** `typing.Sequence[IndividualCommonModelScopeDeserializerRequest]` — The common models you want to update the scopes for
@@ -34673,42 +34477,64 @@ client.hris.time_off_balances.retrieve(
-
-**expand:** `typing.Optional[typing.Literal["employee"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+**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.file_storage.delete_account.delete()
-
-**include_shell_data:** `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
-
-**remote_fields:** `typing.Optional[typing.Literal["policy_type"]]` — Deprecated. Use show_enum_origins.
-
+
+-
+
+Delete a linked account.
+
+
+
+#### 🔌 Usage
-
-**show_enum_origins:** `typing.Optional[typing.Literal["policy_type"]]` — A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter)
-
+
+-
+
+```python
+from merge import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.file_storage.delete_account.delete()
+
+```
+
+
+
+#### ⚙️ Parameters
+
+
+-
-
@@ -34725,8 +34551,8 @@ client.hris.time_off_balances.retrieve(
client.hris.timesheet_entries.list(...)
+## FileStorage Drives
+client.file_storage.drives.list(...)
-
@@ -34738,7 +34564,7 @@ client.hris.time_off_balances.retrieve(
-
-Returns a list of `TimesheetEntry` objects.
+Returns a list of `Drive` objects.
@@ -34756,15 +34582,12 @@ Returns a list of `TimesheetEntry` objects.
import datetime
from merge import Merge
-from merge.resources.hris.resources.timesheet_entries import (
- TimesheetEntriesListRequestOrderBy,
-)
client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.hris.timesheet_entries.list(
+response = client.file_storage.drives.list(
created_after=datetime.datetime.fromisoformat(
"2024-01-15 09:30:00+00:00",
),
@@ -34772,13 +34595,6 @@ client.hris.timesheet_entries.list(
"2024-01-15 09:30:00+00:00",
),
cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
- employee_id="employee_id",
- ended_after=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- ended_before=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
include_deleted_data=True,
include_remote_data=True,
include_shell_data=True,
@@ -34788,16 +34604,15 @@ client.hris.timesheet_entries.list(
modified_before=datetime.datetime.fromisoformat(
"2024-01-15 09:30:00+00:00",
),
- order_by=TimesheetEntriesListRequestOrderBy.START_TIME_DESCENDING,
+ name="name",
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",
- ),
)
+for item in response:
+ yield item
+# alternatively, you can paginate page-by-page
+for page in response.iter_pages():
+ yield page
```
@@ -34837,7 +34652,7 @@ client.hris.timesheet_entries.list(
-
-**employee_id:** `typing.Optional[str]` — If provided, will only return timesheet entries for this employee.
+**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
@@ -34845,7 +34660,7 @@ client.hris.timesheet_entries.list(
-
-**ended_after:** `typing.Optional[dt.datetime]` — If provided, will only return timesheet entries ended after this datetime.
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -34853,7 +34668,7 @@ client.hris.timesheet_entries.list(
-
-**ended_before:** `typing.Optional[dt.datetime]` — If provided, will only return timesheet entries ended before this datetime.
+**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -34861,7 +34676,7 @@ client.hris.timesheet_entries.list(
-
-**expand:** `typing.Optional[typing.Literal["employee"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
@@ -34869,7 +34684,7 @@ client.hris.timesheet_entries.list(
-
-**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
+**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
@@ -34877,7 +34692,7 @@ client.hris.timesheet_entries.list(
-
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
+**name:** `typing.Optional[str]` — If provided, will only return drives with this name. This performs an exact match.
@@ -34885,7 +34700,7 @@ client.hris.timesheet_entries.list(
-
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
+**page_size:** `typing.Optional[int]` — Number of results to return per page.
@@ -34893,7 +34708,7 @@ client.hris.timesheet_entries.list(
-
-**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
+**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
@@ -34901,31 +34716,72 @@ client.hris.timesheet_entries.list(
-
-**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+client.file_storage.drives.retrieve(...)
-
-**order_by:** `typing.Optional[TimesheetEntriesListRequestOrderBy]` — Overrides the default ordering for this endpoint. Possible values include: start_time, -start_time.
-
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a `Drive` object with the given `id`.
+
+
+
+#### 🔌 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.file_storage.drives.retrieve(
+ id="id",
+ include_remote_data=True,
+ include_shell_data=True,
+)
+
+```
+
+
+#### ⚙️ Parameters
+
-
-**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
+
+-
+
+**id:** `str`
@@ -34933,7 +34789,7 @@ client.hris.timesheet_entries.list(
-
-**started_after:** `typing.Optional[dt.datetime]` — If provided, will only return timesheet entries started after this datetime.
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -34941,7 +34797,7 @@ client.hris.timesheet_entries.list(
-
-**started_before:** `typing.Optional[dt.datetime]` — If provided, will only return timesheet entries started before this datetime.
+**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -34961,7 +34817,8 @@ client.hris.timesheet_entries.list(
client.hris.timesheet_entries.create(...)
+## FileStorage FieldMapping
+client.file_storage.field_mapping.field_mappings_retrieve(...)
-
@@ -34973,7 +34830,7 @@ client.hris.timesheet_entries.list(
-
-Creates a `TimesheetEntry` object with the given values.
+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/).
@@ -34989,16 +34846,13 @@ Creates a `TimesheetEntry` object with the given values.
```python
from merge import Merge
-from merge.resources.hris import TimesheetEntryRequest
client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.hris.timesheet_entries.create(
- is_debug_mode=True,
- run_async=True,
- model=TimesheetEntryRequest(),
+client.file_storage.field_mapping.field_mappings_retrieve(
+ exclude_remote_field_metadata=True,
)
```
@@ -35015,23 +34869,7 @@ client.hris.timesheet_entries.create(
-
-**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.
+**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.
@@ -35051,7 +34889,7 @@ client.hris.timesheet_entries.create(
client.hris.timesheet_entries.retrieve(...)
+client.file_storage.field_mapping.field_mappings_create(...)
-
@@ -35063,7 +34901,7 @@ client.hris.timesheet_entries.create(
-
-Returns a `TimesheetEntry` object with the given `id`.
+Create new Field Mappings that will be available after the next scheduled sync. This will cause the next sync for this Linked Account to sync **ALL** data from start.
@@ -35084,10 +34922,14 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.hris.timesheet_entries.retrieve(
- id="id",
- include_remote_data=True,
- include_shell_data=True,
+client.file_storage.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",
)
```
@@ -35104,7 +34946,7 @@ client.hris.timesheet_entries.retrieve(
-
-**id:** `str`
+**target_field_name:** `str` — The name of the target field you want this remote field to map to.
@@ -35112,7 +34954,7 @@ client.hris.timesheet_entries.retrieve(
-
-**expand:** `typing.Optional[typing.Literal["employee"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+**target_field_description:** `str` — The description of the target field you want this remote field to map to.
@@ -35120,7 +34962,7 @@ client.hris.timesheet_entries.retrieve(
-
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
+**remote_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.
@@ -35128,7 +34970,31 @@ client.hris.timesheet_entries.retrieve(
-
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
+**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.
@@ -35148,7 +35014,7 @@ client.hris.timesheet_entries.retrieve(
client.hris.timesheet_entries.meta_post_retrieve()
+client.file_storage.field_mapping.field_mappings_destroy(...)
-
@@ -35160,7 +35026,7 @@ client.hris.timesheet_entries.retrieve(
-
-Returns metadata for `TimesheetEntry` POSTs.
+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.
@@ -35181,7 +35047,9 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.hris.timesheet_entries.meta_post_retrieve()
+client.file_storage.field_mapping.field_mappings_destroy(
+ field_mapping_id="field_mapping_id",
+)
```
@@ -35197,64 +35065,10 @@ client.hris.timesheet_entries.meta_post_retrieve()
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+**field_mapping_id:** `str`
-
-
-
-
-
-
-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
-
-
--
-
@@ -35271,7 +35085,7 @@ client.hris.webhook_receivers.list()
client.hris.webhook_receivers.create(...)
+client.file_storage.field_mapping.field_mappings_partial_update(...)
-
@@ -35283,7 +35097,7 @@ client.hris.webhook_receivers.list()
-
-Creates a `WebhookReceiver` object with the given values.
+Create or update existing Field Mappings for a Linked Account. Changes will be reflected after the next scheduled sync. This will cause the next sync for this Linked Account to sync **ALL** data from start.
@@ -35304,9 +35118,8 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.hris.webhook_receivers.create(
- event="event",
- is_active=True,
+client.file_storage.field_mapping.field_mappings_partial_update(
+ field_mapping_id="field_mapping_id",
)
```
@@ -35323,7 +35136,7 @@ client.hris.webhook_receivers.create(
-
-**event:** `str`
+**field_mapping_id:** `str`
@@ -35331,7 +35144,7 @@ client.hris.webhook_receivers.create(
-
-**is_active:** `bool`
+**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.
@@ -35339,7 +35152,15 @@ client.hris.webhook_receivers.create(
-
-**key:** `typing.Optional[str]`
+**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.
@@ -35359,8 +35180,7 @@ client.hris.webhook_receivers.create(
client.knowledgebase.account_details.retrieve()
+client.file_storage.field_mapping.remote_fields_retrieve(...)
-
@@ -35372,7 +35192,7 @@ client.hris.webhook_receivers.create(
-
-Get details for a linked account.
+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/).
@@ -35393,7 +35213,10 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.knowledgebase.account_details.retrieve()
+client.file_storage.field_mapping.remote_fields_retrieve(
+ common_models="common_models",
+ include_example_values="include_example_values",
+)
```
@@ -35409,6 +35232,22 @@ client.knowledgebase.account_details.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.
@@ -35421,8 +35260,7 @@ client.knowledgebase.account_details.retrieve()
client.knowledgebase.account_token.retrieve(...)
+client.file_storage.field_mapping.target_fields_retrieve()
-
@@ -35434,7 +35272,7 @@ client.knowledgebase.account_details.retrieve()
-
-Returns the account token for the end user with the provided public token.
+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/).
@@ -35455,9 +35293,7 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.knowledgebase.account_token.retrieve(
- public_token="public_token",
-)
+client.file_storage.field_mapping.target_fields_retrieve()
```
@@ -35473,14 +35309,6 @@ client.knowledgebase.account_token.retrieve(
-
-**public_token:** `str`
-
-
-
-
-
--
-
**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -35493,8 +35321,8 @@ client.knowledgebase.account_token.retrieve(
client.knowledgebase.articles.list(...)
+## FileStorage Files
+client.file_storage.files.list(...)
-
@@ -35506,7 +35334,7 @@ client.knowledgebase.account_token.retrieve(
-
-Returns a list of `Article` objects.
+Returns a list of `File` objects.
@@ -35524,16 +35352,13 @@ Returns a list of `Article` objects.
import datetime
from merge import Merge
-from merge.resources.knowledgebase.resources.articles import (
- ArticlesListRequestExpand,
- ArticlesListRequestType,
-)
+from merge.resources.file_storage.resources.files import FilesListRequestOrderBy
client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.knowledgebase.articles.list(
+response = client.file_storage.files.list(
created_after=datetime.datetime.fromisoformat(
"2024-01-15 09:30:00+00:00",
),
@@ -35541,24 +35366,28 @@ client.knowledgebase.articles.list(
"2024-01-15 09:30:00+00:00",
),
cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
- expand=ArticlesListRequestExpand.ATTACHMENTS,
+ drive_id="drive_id",
+ 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,
- 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,
)
+for item in response:
+ yield item
+# alternatively, you can paginate page-by-page
+for page in response.iter_pages():
+ yield page
```
@@ -35598,7 +35427,7 @@ client.knowledgebase.articles.list(
-
-**expand:** `typing.Optional[ArticlesListRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+**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.
@@ -35606,7 +35435,11 @@ client.knowledgebase.articles.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[
+ FilesListRequestExpandItem, typing.Sequence[FilesListRequestExpandItem]
+ ]
+]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -35614,7 +35447,7 @@ client.knowledgebase.articles.list(
-
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
+**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.
@@ -35622,7 +35455,7 @@ client.knowledgebase.articles.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/).
@@ -35630,7 +35463,7 @@ client.knowledgebase.articles.list(
-
-**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -35638,7 +35471,7 @@ client.knowledgebase.articles.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).
@@ -35646,7 +35479,7 @@ client.knowledgebase.articles.list(
-
-**page_size:** `typing.Optional[int]` — Number of results to return per page. The maximum limit is 100.
+**mime_type:** `typing.Optional[str]` — If provided, will only return files with these mime_types. Multiple values can be separated by commas.
@@ -35654,7 +35487,7 @@ client.knowledgebase.articles.list(
-
-**parent_article_id:** `typing.Optional[str]` — If provided, will only return sub articles of the parent_article_id.
+**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
@@ -35662,7 +35495,7 @@ client.knowledgebase.articles.list(
-
-**parent_container_id:** `typing.Optional[str]` — If provided, will only return sub articles of the parent_container_id.
+**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
@@ -35670,7 +35503,7 @@ client.knowledgebase.articles.list(
-
-**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
+**name:** `typing.Optional[str]` — If provided, will only return files with this name. This performs an exact match.
@@ -35678,7 +35511,7 @@ client.knowledgebase.articles.list(
-
-**root_container_id:** `typing.Optional[str]` — If provided, will only return sub articles of the root_container_id.
+**order_by:** `typing.Optional[FilesListRequestOrderBy]` — Overrides the default ordering for this endpoint. Possible values include: created_at, -created_at, modified_at, -modified_at.
@@ -35686,7 +35519,7 @@ client.knowledgebase.articles.list(
-
-**status:** `typing.Optional[str]` — If provided, will only return articles of the given status; multiple statuses can be separated by commas.
+**page_size:** `typing.Optional[int]` — Number of results to return per page.
@@ -35694,7 +35527,7 @@ client.knowledgebase.articles.list(
-
-**type:** `typing.Optional[ArticlesListRequestType]` — If provided, will only return articles of the given type.
+**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
@@ -35714,7 +35547,7 @@ client.knowledgebase.articles.list(
client.knowledgebase.articles.retrieve(...)
+client.file_storage.files.create(...)
-
@@ -35726,7 +35559,7 @@ client.knowledgebase.articles.list(
-
-Returns an `Article` object with the given `id`.
+Creates a `File` object with the given values.
@@ -35742,19 +35575,16 @@ Returns an `Article` object with the given `id`.
```python
from merge import Merge
-from merge.resources.knowledgebase.resources.articles import (
- ArticlesRetrieveRequestExpand,
-)
+from merge.resources.file_storage import FileRequest
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,
+client.file_storage.files.create(
+ is_debug_mode=True,
+ run_async=True,
+ model=FileRequest(),
)
```
@@ -35771,15 +35601,7 @@ client.knowledgebase.articles.retrieve(
-
-**id:** `str`
-
-
-
-
-
--
-
-**expand:** `typing.Optional[ArticlesRetrieveRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+**model:** `FileRequest`
@@ -35787,7 +35609,7 @@ client.knowledgebase.articles.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.
@@ -35795,7 +35617,7 @@ client.knowledgebase.articles.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.
@@ -35815,8 +35637,7 @@ client.knowledgebase.articles.retrieve(
client.knowledgebase.async_passthrough.create(...)
+client.file_storage.files.retrieve(...)
-
@@ -35828,7 +35649,7 @@ client.knowledgebase.articles.retrieve(
-
-Asynchronously pull data from an endpoint not currently supported by Merge.
+Returns a `File` object with the given `id`.
@@ -35844,17 +35665,15 @@ Asynchronously 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.async_passthrough.create(
- request=DataPassthroughRequest(
- method=MethodEnum.GET,
- path="/scooters",
- ),
+client.file_storage.files.retrieve(
+ id="id",
+ include_remote_data=True,
+ include_shell_data=True,
)
```
@@ -35871,7 +35690,36 @@ client.knowledgebase.async_passthrough.create(
-
-**request:** `DataPassthroughRequest`
+**id:** `str`
+
+
+
+
+
+-
+
+**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.
+
+
+
+
+
+-
+
+**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).
@@ -35891,7 +35739,7 @@ client.knowledgebase.async_passthrough.create(
client.knowledgebase.async_passthrough.retrieve(...)
+client.file_storage.files.download_request_meta_retrieve(...)
-
@@ -35903,7 +35751,7 @@ client.knowledgebase.async_passthrough.create(
-
-Retrieves data from earlier async-passthrough POST request
+Returns metadata to construct an authenticated file download request for a singular file, allowing you to download file directly from the third-party.
@@ -35924,8 +35772,9 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.knowledgebase.async_passthrough.retrieve(
- async_passthrough_receipt_id="async_passthrough_receipt_id",
+client.file_storage.files.download_request_meta_retrieve(
+ id="id",
+ mime_type="mime_type",
)
```
@@ -35942,7 +35791,15 @@ client.knowledgebase.async_passthrough.retrieve(
-
-**async_passthrough_receipt_id:** `str`
+**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.
@@ -35962,8 +35819,7 @@ client.knowledgebase.async_passthrough.retrieve(
client.knowledgebase.attachments.list(...)
+client.file_storage.files.download_request_meta_list(...)
-
@@ -35975,7 +35831,7 @@ client.knowledgebase.async_passthrough.retrieve(
-
-Returns a list of `Attachment` objects.
+Returns metadata to construct authenticated file download requests, allowing you to download files directly from the third-party.
@@ -35990,34 +35846,31 @@ Returns a list of `Attachment` objects.
-
```python
-import datetime
-
from merge import Merge
+from merge.resources.file_storage.resources.files import (
+ FilesDownloadRequestMetaListRequestOrderBy,
+)
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",
- ),
+response = client.file_storage.files.download_request_meta_list(
+ created_after="created_after",
+ created_before="created_before",
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",
- ),
+ mime_types="mime_types",
+ modified_after="modified_after",
+ modified_before="modified_before",
+ order_by=FilesDownloadRequestMetaListRequestOrderBy.CREATED_AT_DESCENDING,
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
```
@@ -36033,7 +35886,7 @@ client.knowledgebase.attachments.list(
-
-**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
+**created_after:** `typing.Optional[str]` — If provided, will only return objects created after this datetime.
@@ -36041,7 +35894,7 @@ client.knowledgebase.attachments.list(
-
-**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
+**created_before:** `typing.Optional[str]` — If provided, will only return objects created before this datetime.
@@ -36065,15 +35918,7 @@ client.knowledgebase.attachments.list(
-
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
-
-
-
-
-
--
-
-**include_shell_data:** `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_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.
@@ -36081,7 +35926,7 @@ client.knowledgebase.attachments.list(
-
-**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
+**modified_after:** `typing.Optional[str]` — If provided, will only return objects modified after this datetime.
@@ -36089,7 +35934,7 @@ client.knowledgebase.attachments.list(
-
-**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
+**modified_before:** `typing.Optional[str]` — If provided, will only return objects modified before this datetime.
@@ -36097,7 +35942,7 @@ client.knowledgebase.attachments.list(
-
-**page_size:** `typing.Optional[int]` — Number of results to return per page. The maximum limit is 100.
+**order_by:** `typing.Optional[FilesDownloadRequestMetaListRequestOrderBy]` — Overrides the default ordering for this endpoint. Possible values include: created_at, -created_at, modified_at, -modified_at.
@@ -36105,7 +35950,7 @@ client.knowledgebase.attachments.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.
@@ -36125,7 +35970,7 @@ client.knowledgebase.attachments.list(
client.knowledgebase.attachments.retrieve(...)
+client.file_storage.files.meta_post_retrieve()
-
@@ -36137,7 +35982,7 @@ client.knowledgebase.attachments.list(
-
-Returns an `Attachment` object with the given `id`.
+Returns metadata for `FileStorageFile` POSTs.
@@ -36158,11 +36003,7 @@ 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,
-)
+client.file_storage.files.meta_post_retrieve()
```
@@ -36178,30 +36019,6 @@ client.knowledgebase.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.
@@ -36214,8 +36031,8 @@ client.knowledgebase.attachments.retrieve(
client.knowledgebase.audit_trail.list(...)
+## FileStorage Folders
+client.file_storage.folders.list(...)
-
@@ -36227,7 +36044,7 @@ client.knowledgebase.attachments.retrieve(
-
-Gets a list of audit trail events.
+Returns a list of `Folder` objects.
@@ -36242,20 +36059,42 @@ Gets a list of audit trail events.
-
```python
+import datetime
+
from merge import Merge
client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.knowledgebase.audit_trail.list(
+response = client.file_storage.folders.list(
+ created_after=datetime.datetime.fromisoformat(
+ "2024-01-15 09:30:00+00:00",
+ ),
+ created_before=datetime.datetime.fromisoformat(
+ "2024-01-15 09:30:00+00:00",
+ ),
cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
- end_date="end_date",
- event_type="event_type",
+ drive_id="drive_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",
+ ),
+ name="name",
page_size=1,
- start_date="start_date",
- user_email="user_email",
+ 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
```
@@ -36271,7 +36110,7 @@ client.knowledgebase.audit_trail.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.
@@ -36279,7 +36118,7 @@ client.knowledgebase.audit_trail.list(
-
-**end_date:** `typing.Optional[str]` — If included, will only include audit trail events that occurred before this time
+**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
@@ -36287,7 +36126,7 @@ client.knowledgebase.audit_trail.list(
-
-**event_type:** `typing.Optional[str]` — If included, will only include events with the given event type. Possible values include: `CREATED_REMOTE_PRODUCTION_API_KEY`, `DELETED_REMOTE_PRODUCTION_API_KEY`, `CREATED_TEST_API_KEY`, `DELETED_TEST_API_KEY`, `REGENERATED_PRODUCTION_API_KEY`, `REGENERATED_WEBHOOK_SIGNATURE`, `INVITED_USER`, `TWO_FACTOR_AUTH_ENABLED`, `TWO_FACTOR_AUTH_DISABLED`, `DELETED_LINKED_ACCOUNT`, `DELETED_ALL_COMMON_MODELS_FOR_LINKED_ACCOUNT`, `CREATED_DESTINATION`, `DELETED_DESTINATION`, `CHANGED_DESTINATION`, `CHANGED_SCOPES`, `CHANGED_PERSONAL_INFORMATION`, `CHANGED_ORGANIZATION_SETTINGS`, `ENABLED_INTEGRATION`, `DISABLED_INTEGRATION`, `ENABLED_CATEGORY`, `DISABLED_CATEGORY`, `CHANGED_PASSWORD`, `RESET_PASSWORD`, `ENABLED_REDACT_UNMAPPED_DATA_FOR_ORGANIZATION`, `ENABLED_REDACT_UNMAPPED_DATA_FOR_LINKED_ACCOUNT`, `DISABLED_REDACT_UNMAPPED_DATA_FOR_ORGANIZATION`, `DISABLED_REDACT_UNMAPPED_DATA_FOR_LINKED_ACCOUNT`, `CREATED_INTEGRATION_WIDE_FIELD_MAPPING`, `CREATED_LINKED_ACCOUNT_FIELD_MAPPING`, `CHANGED_INTEGRATION_WIDE_FIELD_MAPPING`, `CHANGED_LINKED_ACCOUNT_FIELD_MAPPING`, `DELETED_INTEGRATION_WIDE_FIELD_MAPPING`, `DELETED_LINKED_ACCOUNT_FIELD_MAPPING`, `CREATED_LINKED_ACCOUNT_COMMON_MODEL_OVERRIDE`, `CHANGED_LINKED_ACCOUNT_COMMON_MODEL_OVERRIDE`, `DELETED_LINKED_ACCOUNT_COMMON_MODEL_OVERRIDE`, `FORCED_LINKED_ACCOUNT_RESYNC`, `MUTED_ISSUE`, `GENERATED_MAGIC_LINK`, `ENABLED_MERGE_WEBHOOK`, `DISABLED_MERGE_WEBHOOK`, `MERGE_WEBHOOK_TARGET_CHANGED`, `END_USER_CREDENTIALS_ACCESSED`
+**cursor:** `typing.Optional[str]` — The pagination cursor value.
@@ -36295,7 +36134,7 @@ client.knowledgebase.audit_trail.list(
-
-**page_size:** `typing.Optional[int]` — Number of results to return per page.
+**drive_id:** `typing.Optional[str]` — If provided, will only return folders in this drive.
@@ -36303,7 +36142,12 @@ client.knowledgebase.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[
+ FoldersListRequestExpandItem,
+ typing.Sequence[FoldersListRequestExpandItem],
+ ]
+]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -36311,7 +36155,7 @@ client.knowledgebase.audit_trail.list(
-
-**user_email:** `typing.Optional[str]` — If provided, this will return events associated with the specified user email. Please note that the email address reflects the user's email at the time of the event, and may not be their current email.
+**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
@@ -36319,65 +36163,67 @@ client.knowledgebase.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).
+
-client.knowledgebase.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.
-
-
+**name:** `typing.Optional[str]` — If provided, will only return folders with this name. This performs an exact match.
+
-#### 🔌 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.knowledgebase.available_actions.retrieve()
-
-```
-
-
+**parent_folder_id:** `typing.Optional[str]` — If provided, will only return folders in this parent folder. If null, will return folders in root directory.
+
-#### ⚙️ Parameters
-
-
+**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
+
+
+
+
-
@@ -36393,8 +36239,7 @@ client.knowledgebase.available_actions.retrieve()
client.knowledgebase.containers.list(...)
+client.file_storage.folders.create(...)
-
@@ -36406,7 +36251,7 @@ client.knowledgebase.available_actions.retrieve()
-
-Returns a list of `Container` objects.
+Creates a `Folder` object with the given values.
@@ -36421,41 +36266,17 @@ Returns a list of `Container` objects.
-
```python
-import datetime
-
from merge import Merge
-from merge.resources.knowledgebase.resources.containers import (
- ContainersListRequestExpand,
- ContainersListRequestType,
-)
+from merge.resources.file_storage import FolderRequest
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,
+client.file_storage.folders.create(
+ is_debug_mode=True,
+ run_async=True,
+ model=FolderRequest(),
)
```
@@ -36472,7 +36293,7 @@ client.knowledgebase.containers.list(
-
-**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
+**model:** `FolderRequest`
@@ -36480,7 +36301,7 @@ client.knowledgebase.containers.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.
@@ -36488,7 +36309,7 @@ client.knowledgebase.containers.list(
-
-**cursor:** `typing.Optional[str]` — The pagination cursor value.
+**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously.
@@ -36496,63 +36317,72 @@ client.knowledgebase.containers.list(
-
-**expand:** `typing.Optional[ContainersListRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+**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.file_storage.folders.retrieve(...)
-
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
-
-
-
+#### 📝 Description
-
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
-
-
-
-
-
-**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
-
+Returns a `Folder` object with the given `id`.
+
+
+
+#### 🔌 Usage
-
-**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
-
-
-
-
-
-**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.file_storage.folders.retrieve(
+ id="id",
+ include_remote_data=True,
+ include_shell_data=True,
+)
+
+```
+
+
+#### ⚙️ Parameters
+
-
-**parent_article_id:** `typing.Optional[str]` — If provided, will only return sub containers of the parent_article_id.
+
+-
+
+**id:** `str`
@@ -36560,7 +36390,12 @@ client.knowledgebase.containers.list(
-
-**parent_container_id:** `typing.Optional[str]` — If provided, will only return sub containers of the parent_container_id.
+**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.
@@ -36568,7 +36403,7 @@ client.knowledgebase.containers.list(
-
-**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -36576,7 +36411,7 @@ client.knowledgebase.containers.list(
-
-**type:** `typing.Optional[ContainersListRequestType]` — If provided, will only return containers of the given type.
+**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -36596,7 +36431,7 @@ client.knowledgebase.containers.list(
client.knowledgebase.containers.retrieve(...)
+client.file_storage.folders.meta_post_retrieve()
-
@@ -36608,7 +36443,7 @@ client.knowledgebase.containers.list(
-
-Returns a `Container` object with the given `id`.
+Returns metadata for `FileStorageFolder` POSTs.
@@ -36624,20 +36459,12 @@ Returns a `Container` object with the given `id`.
```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,
-)
+client.file_storage.folders.meta_post_retrieve()
```
@@ -36653,31 +36480,71 @@ client.knowledgebase.containers.retrieve(
-
-**id:** `str`
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+client.file_storage.generate_key.create(...)
-
-**expand:** `typing.Optional[ContainersRetrieveRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
-
+#### 📝 Description
+
+
+-
+
+
+-
+
+Create a remote key.
+
+
+#### 🔌 Usage
+
-
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
-
+
+-
+
+```python
+from merge import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.file_storage.generate_key.create(
+ name="Remote Deployment Key 1",
+)
+
+```
+
+
+#### ⚙️ Parameters
+
-
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
+
+-
+
+**name:** `str` — The name of the remote key
@@ -36697,8 +36564,8 @@ client.knowledgebase.containers.retrieve(
client.knowledgebase.scopes.default_scopes_retrieve()
+## FileStorage Groups
+client.file_storage.groups.list(...)
-
@@ -36710,7 +36577,7 @@ client.knowledgebase.containers.retrieve(
-
-Get the default permissions for Merge Common Models and fields across all Linked Accounts of a given category. [Learn more](https://help.merge.dev/en/articles/5950052-common-model-and-field-scopes).
+Returns a list of `Group` objects.
@@ -36725,13 +36592,39 @@ Get the default permissions for Merge Common Models and fields across all Linked
-
```python
+import datetime
+
from merge import Merge
client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.knowledgebase.scopes.default_scopes_retrieve()
+response = client.file_storage.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",
+)
+for item in response:
+ yield item
+# alternatively, you can paginate page-by-page
+for page in response.iter_pages():
+ yield page
```
@@ -36747,64 +36640,96 @@ client.knowledgebase.scopes.default_scopes_retrieve()
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
-
-
+
+-
+**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
+
-client.knowledgebase.scopes.linked_account_scopes_retrieve()
-
-#### 📝 Description
+**cursor:** `typing.Optional[str]` — The pagination cursor value.
+
+
+
-
+**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.
+
+
+
+
-
-Get all available permissions for Merge Common Models and fields for a single Linked Account. [Learn more](https://help.merge.dev/en/articles/5950052-common-model-and-field-scopes).
+**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
+
+
+
+-
+
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
+
-#### 🔌 Usage
-
-
+**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
+
+
+
+
-
-```python
-from merge import Merge
+**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
+
+
+
-client = Merge(
- account_token="YOUR_ACCOUNT_TOKEN",
- api_key="YOUR_API_KEY",
-)
-client.knowledgebase.scopes.linked_account_scopes_retrieve()
+
+-
-```
+**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
+
+
+
+-
+
+**page_size:** `typing.Optional[int]` — Number of results to return per page.
+
-#### ⚙️ Parameters
-
-
+**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
+
+
+
+
-
@@ -36820,7 +36745,7 @@ client.knowledgebase.scopes.linked_account_scopes_retrieve()
client.knowledgebase.scopes.linked_account_scopes_create(...)
+client.file_storage.groups.retrieve(...)
-
@@ -36832,7 +36757,7 @@ client.knowledgebase.scopes.linked_account_scopes_retrieve()
-
-Update permissions for any Common Model or field for a single Linked Account. Any Scopes not set in this POST request will inherit the default Scopes. [Learn more](https://help.merge.dev/en/articles/5950052-common-model-and-field-scopes)
+Returns a `Group` object with the given `id`.
@@ -36848,42 +36773,15 @@ Update permissions for any Common Model or field for a single Linked Account. An
```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,
- )
- },
- ),
- ],
+client.file_storage.groups.retrieve(
+ id="id",
+ include_remote_data=True,
+ include_shell_data=True,
)
```
@@ -36900,7 +36798,7 @@ client.knowledgebase.scopes.linked_account_scopes_create(
-
-**common_models:** `typing.Sequence[IndividualCommonModelScopeDeserializerRequest]` — The common models you want to update the scopes for
+**id:** `str`
@@ -36908,65 +36806,32 @@ client.knowledgebase.scopes.linked_account_scopes_create(
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+**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.
-
-
-
-
-
-client.knowledgebase.delete_account.delete()
-
-#### 📝 Description
-
-
--
-
-
--
-
-Delete a linked account.
-
-
+**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.knowledgebase.delete_account.delete()
-
-```
-
-
+**include_shell_data:** `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
-
-
--
-
-
@@ -36982,8 +36847,8 @@ client.knowledgebase.delete_account.delete()
client.knowledgebase.field_mapping.field_mappings_retrieve(...)
+## FileStorage Issues
+client.file_storage.issues.list(...)
-
@@ -36995,7 +36860,7 @@ client.knowledgebase.delete_account.delete()
-
-Get all Field Mappings for this Linked Account. Field Mappings are mappings between third-party Remote Fields and user defined Merge fields. [Learn more](https://docs.merge.dev/supplemental-data/field-mappings/overview/).
+Gets all issues for Organization.
@@ -37010,15 +36875,46 @@ Get all Field Mappings for this Linked Account. Field Mappings are mappings betw
-
```python
+import datetime
+
from merge import Merge
+from merge.resources.file_storage.resources.issues import (
+ IssuesListRequestStatus,
+)
client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.knowledgebase.field_mapping.field_mappings_retrieve(
- exclude_remote_field_metadata=True,
+response = client.file_storage.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,
)
+for item in response:
+ yield item
+# alternatively, you can paginate page-by-page
+for page in response.iter_pages():
+ yield page
```
@@ -37034,7 +36930,7 @@ client.knowledgebase.field_mapping.field_mappings_retrieve(
-
-**exclude_remote_field_metadata:** `typing.Optional[bool]` — If `true`, remote fields metadata is excluded from each field mapping instance (i.e. `remote_fields.remote_key_name` and `remote_fields.schema` will be null). This will increase the speed of the request since these fields require some calculations.
+**account_token:** `typing.Optional[str]`
@@ -37042,76 +36938,47 @@ client.knowledgebase.field_mapping.field_mappings_retrieve(
-
-**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
+
-client.knowledgebase.field_mapping.field_mappings_create(...)
-
-#### 📝 Description
-
-
--
+**end_user_organization_name:** `typing.Optional[str]`
+
+
+
-
-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.
-
-
+**first_incident_time_after:** `typing.Optional[dt.datetime]` — If provided, will only return issues whose first incident time was after 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_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",
-)
-
-```
-
-
+**first_incident_time_before:** `typing.Optional[dt.datetime]` — If provided, will only return issues whose first incident time was before this datetime.
+
-#### ⚙️ Parameters
-
-
--
-
-
-**target_field_name:** `str` — The name of the target field you want this remote field to map to.
+**include_muted:** `typing.Optional[str]` — If true, will include muted issues
@@ -37119,7 +36986,7 @@ client.knowledgebase.field_mapping.field_mappings_create(
-
-**target_field_description:** `str` — The description of the target field you want this remote field to map to.
+**integration_name:** `typing.Optional[str]`
@@ -37127,7 +36994,7 @@ client.knowledgebase.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.
+**last_incident_time_after:** `typing.Optional[dt.datetime]` — If provided, will only return issues whose last incident time was after this datetime.
@@ -37135,7 +37002,7 @@ client.knowledgebase.field_mapping.field_mappings_create(
-
-**remote_method:** `str` — The method of the remote endpoint where the remote field is coming from.
+**last_incident_time_before:** `typing.Optional[dt.datetime]` — If provided, will only return issues whose last incident time was before this datetime.
@@ -37143,7 +37010,7 @@ client.knowledgebase.field_mapping.field_mappings_create(
-
-**remote_url_path:** `str` — The path of the remote endpoint where the remote field is coming from.
+**linked_account_id:** `typing.Optional[str]` — If provided, will only include issues pertaining to the linked account passed in.
@@ -37151,7 +37018,7 @@ client.knowledgebase.field_mapping.field_mappings_create(
-
-**common_model_name:** `str` — The name of the Common Model that the remote field corresponds to in a given category.
+**page_size:** `typing.Optional[int]` — Number of results to return per page.
@@ -37159,7 +37026,7 @@ client.knowledgebase.field_mapping.field_mappings_create(
-
-**exclude_remote_field_metadata:** `typing.Optional[bool]` — If `true`, remote fields metadata is excluded from each field mapping instance (i.e. `remote_fields.remote_key_name` and `remote_fields.schema` will be null). This will increase the speed of the request since these fields require some calculations.
+**start_date:** `typing.Optional[str]` — If included, will only include issues whose most recent action occurred after this time
@@ -37167,7 +37034,12 @@ client.knowledgebase.field_mapping.field_mappings_create(
-
-**jmes_path:** `typing.Optional[str]` — JMES path to specify json query expression to be used on field mapping.
+**status:** `typing.Optional[IssuesListRequestStatus]`
+
+Status of the issue. Options: ('ONGOING', 'RESOLVED')
+
+* `ONGOING` - ONGOING
+* `RESOLVED` - RESOLVED
@@ -37187,7 +37059,7 @@ client.knowledgebase.field_mapping.field_mappings_create(
client.knowledgebase.field_mapping.field_mappings_destroy(...)
+client.file_storage.issues.retrieve(...)
-
@@ -37199,7 +37071,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.
+Get a specific issue.
@@ -37220,8 +37092,8 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.knowledgebase.field_mapping.field_mappings_destroy(
- field_mapping_id="field_mapping_id",
+client.file_storage.issues.retrieve(
+ id="id",
)
```
@@ -37238,7 +37110,7 @@ client.knowledgebase.field_mapping.field_mappings_destroy(
-
-**field_mapping_id:** `str`
+**id:** `str`
@@ -37258,7 +37130,8 @@ client.knowledgebase.field_mapping.field_mappings_destroy(
client.knowledgebase.field_mapping.field_mappings_partial_update(...)
+## FileStorage LinkToken
+client.file_storage.link_token.create(...)
-
@@ -37270,7 +37143,7 @@ client.knowledgebase.field_mapping.field_mappings_destroy(
-
-Create or update existing Field Mappings for a Linked Account. Changes will be reflected after the next scheduled sync. This will cause the next sync for this Linked Account to sync **ALL** data from start.
+Creates a link token to be used when linking a new end user.
@@ -37286,13 +37159,17 @@ Create or update existing Field Mappings for a Linked Account. Changes will be r
```python
from merge import Merge
+from merge.resources.file_storage import CategoriesEnum
client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.knowledgebase.field_mapping.field_mappings_partial_update(
- field_mapping_id="field_mapping_id",
+client.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],
)
```
@@ -37309,7 +37186,7 @@ client.knowledgebase.field_mapping.field_mappings_partial_update(
-
-**field_mapping_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.
@@ -37317,7 +37194,7 @@ 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.
+**end_user_organization_name:** `str` — Your end user's organization.
@@ -37325,7 +37202,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.
+**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.
@@ -37333,7 +37210,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.
+**categories:** `typing.Sequence[CategoriesEnum]` — The integration categories to show in Merge Link.
@@ -37341,7 +37218,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.
+**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/.
@@ -37349,71 +37226,67 @@ client.knowledgebase.field_mapping.field_mappings_partial_update(
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+**link_expiry_mins:** `typing.Optional[int]` — An integer number of minutes between [30, 720 or 10080 if for a Magic Link URL] for how long this token is valid. Defaults to 30.
-
-
+
+-
+**should_create_magic_link_url:** `typing.Optional[bool]` — Whether to generate a Magic Link URL. Defaults to false. For more information on Magic Link, see https://merge.dev/blog/integrations-fast-say-hello-to-magic-link.
+
-client.knowledgebase.field_mapping.remote_fields_retrieve(...)
-
-#### 📝 Description
-
-
--
+**hide_admin_magic_link:** `typing.Optional[bool]` — Whether to generate a Magic Link URL on the Admin Needed screen during the linking flow. Defaults to false. For more information on Magic Link, see https://merge.dev/blog/integrations-fast-say-hello-to-magic-link.
+
+
+
-
-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/).
-
-
+**common_models:** `typing.Optional[typing.Sequence[CommonModelScopesBodyRequest]]` — An array of objects to specify the models and fields that will be disabled for a given Linked Account. Each object uses model_id, enabled_actions, and disabled_fields to specify the model, method, and fields that are scoped for a given Linked Account.
+
-#### 🔌 Usage
-
-
+**category_common_model_scopes:** `typing.Optional[
+ typing.Dict[
+ str,
+ typing.Optional[
+ typing.Sequence[IndividualCommonModelScopeDeserializerRequest]
+ ],
+ ]
+]` — When creating a Link Token, you can set permissions for Common Models that will apply to the account that is going to be linked. Any model or field not specified in link token payload will default to existing settings.
+
+
+
+
-
-```python
-from merge import Merge
+**language:** `typing.Optional[EndUserDetailsRequestLanguage]`
-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",
-)
+The following subset of IETF language tags can be used to configure localization.
-```
-
-
+* `en` - en
+* `de` - de
+
-#### ⚙️ 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.
+**are_syncs_disabled:** `typing.Optional[bool]` — The boolean that indicates whether initial, periodic, and force syncs will be disabled.
@@ -37421,7 +37294,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.
+**integration_specific_config:** `typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]]` — A JSON object containing integration-specific configuration options.
@@ -37441,7 +37314,8 @@ client.knowledgebase.field_mapping.remote_fields_retrieve(
client.knowledgebase.field_mapping.target_fields_retrieve()
+## FileStorage LinkedAccounts
+client.file_storage.linked_accounts.list(...)
-
@@ -37453,7 +37327,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/).
+List linked accounts for your organization.
@@ -37469,76 +37343,34 @@ Get all organization-wide Target Fields, this will not include any Linked Accoun
```python
from merge import Merge
-
-client = Merge(
- account_token="YOUR_ACCOUNT_TOKEN",
- api_key="YOUR_API_KEY",
+from merge.resources.file_storage.resources.linked_accounts import (
+ LinkedAccountsListRequestCategory,
)
-client.knowledgebase.field_mapping.target_fields_retrieve()
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-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",
+response = client.file_storage.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",
)
+for item in response:
+ yield item
+# alternatively, you can paginate page-by-page
+for page in response.iter_pages():
+ yield page
```
@@ -37554,102 +37386,33 @@ client.knowledgebase.generate_key.create(
-
-**name:** `str` — The name of the remote key
-
-
-
+**category:** `typing.Optional[LinkedAccountsListRequestCategory]`
-
--
+Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `mktg`, `ticketing`
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+* `hris` - hris
+* `ats` - ats
+* `accounting` - accounting
+* `ticketing` - ticketing
+* `crm` - crm
+* `mktg` - mktg
+* `filestorage` - filestorage
-
-
-
-
-
-
-client.knowledgebase.groups.list(...)
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Returns a list of `Group` objects.
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-```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",
-)
-
-```
-
-
+**cursor:** `typing.Optional[str]` — The pagination cursor value.
+
-#### ⚙️ Parameters
-
-
--
-
-
-**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
+**end_user_email_address:** `typing.Optional[str]` — If provided, will only return linked accounts associated with the given email address.
@@ -37657,7 +37420,7 @@ client.knowledgebase.groups.list(
-
-**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
+**end_user_organization_name:** `typing.Optional[str]` — If provided, will only return linked accounts associated with the given organization name.
@@ -37665,7 +37428,7 @@ client.knowledgebase.groups.list(
-
-**cursor:** `typing.Optional[str]` — The pagination cursor value.
+**end_user_origin_id:** `typing.Optional[str]` — If provided, will only return linked accounts associated with the given origin ID.
@@ -37673,7 +37436,7 @@ client.knowledgebase.groups.list(
-
-**expand:** `typing.Optional[GroupsListRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+**end_user_origin_ids:** `typing.Optional[str]` — Comma-separated list of EndUser origin IDs, making it possible to specify multiple EndUsers at once.
@@ -37681,7 +37444,7 @@ client.knowledgebase.groups.list(
-
-**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
+**id:** `typing.Optional[str]`
@@ -37689,7 +37452,7 @@ client.knowledgebase.groups.list(
-
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
+**ids:** `typing.Optional[str]` — Comma-separated list of LinkedAccount IDs, making it possible to specify multiple LinkedAccounts at once.
@@ -37697,7 +37460,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).
+**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.
@@ -37705,7 +37468,7 @@ client.knowledgebase.groups.list(
-
-**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
+**integration_name:** `typing.Optional[str]` — If provided, will only return linked accounts associated with the given integration name.
@@ -37713,7 +37476,7 @@ client.knowledgebase.groups.list(
-
-**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
+**is_test_account:** `typing.Optional[str]` — If included, will only include test linked accounts. If not included, will only include non-test linked accounts.
@@ -37721,7 +37484,7 @@ client.knowledgebase.groups.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.
@@ -37729,7 +37492,7 @@ client.knowledgebase.groups.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`
@@ -37749,7 +37512,8 @@ client.knowledgebase.groups.list(
client.knowledgebase.groups.retrieve(...)
+## FileStorage Passthrough
+client.file_storage.passthrough.create(...)
-
@@ -37761,7 +37525,7 @@ client.knowledgebase.groups.list(
-
-Returns a `Group` object with the given `id`.
+Pull data from an endpoint not currently supported by Merge.
@@ -37777,19 +37541,17 @@ Returns a `Group` object with the given `id`.
```python
from merge import Merge
-from merge.resources.knowledgebase.resources.groups import (
- GroupsRetrieveRequestExpand,
-)
+from merge.resources.file_storage import DataPassthroughRequest, MethodEnum
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.file_storage.passthrough.create(
+ request=DataPassthroughRequest(
+ method=MethodEnum.GET,
+ path="/scooters",
+ ),
)
```
@@ -37806,31 +37568,7 @@ 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:** `DataPassthroughRequest`
@@ -37850,8 +37588,8 @@ client.knowledgebase.groups.retrieve(
client.knowledgebase.issues.list(...)
+## FileStorage RegenerateKey
+client.file_storage.regenerate_key.create(...)
-
@@ -37863,7 +37601,7 @@ client.knowledgebase.groups.retrieve(
-
-Gets all issues for Organization.
+Exchange remote keys.
@@ -37878,40 +37616,14 @@ Gets all issues for Organization.
-
```python
-import datetime
-
from merge import Merge
-from merge.resources.knowledgebase.resources.issues import (
- IssuesListRequestStatus,
-)
client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.knowledgebase.issues.list(
- account_token="account_token",
- cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
- end_date="end_date",
- end_user_organization_name="end_user_organization_name",
- first_incident_time_after=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- first_incident_time_before=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- include_muted="include_muted",
- integration_name="integration_name",
- last_incident_time_after=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- last_incident_time_before=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- linked_account_id="linked_account_id",
- page_size=1,
- start_date="start_date",
- status=IssuesListRequestStatus.ONGOING,
+client.file_storage.regenerate_key.create(
+ name="Remote Deployment Key 1",
)
```
@@ -37928,7 +37640,7 @@ client.knowledgebase.issues.list(
-
-**account_token:** `typing.Optional[str]`
+**name:** `str` — The name of the remote key
@@ -37936,95 +37648,77 @@ client.knowledgebase.issues.list(
-
-**cursor:** `typing.Optional[str]` — The pagination cursor value.
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
--
-
-**end_date:** `typing.Optional[str]` — If included, will only include issues whose most recent action occurred before this time
-
-
--
-**end_user_organization_name:** `typing.Optional[str]`
-
+
client.file_storage.sync_status.list(...)
-
-**first_incident_time_after:** `typing.Optional[dt.datetime]` — If provided, will only return issues whose first incident time was after this datetime.
-
-
-
+#### 📝 Description
-
-**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
-
+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).
-
-
--
-
-**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",
+)
+response = client.file_storage.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
-**linked_account_id:** `typing.Optional[str]` — If provided, will only include issues pertaining to the linked account passed in.
-
+```
+
+
+#### ⚙️ Parameters
+
-
-**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
+**cursor:** `typing.Optional[str]` — The pagination cursor value.
@@ -38032,12 +37726,7 @@ client.knowledgebase.issues.list(
-
-**status:** `typing.Optional[IssuesListRequestStatus]`
-
-Status of the issue. Options: ('ONGOING', 'RESOLVED')
-
-* `ONGOING` - ONGOING
-* `RESOLVED` - RESOLVED
+**page_size:** `typing.Optional[int]` — Number of results to return per page.
@@ -38057,7 +37746,8 @@ Status of the issue. Options: ('ONGOING', 'RESOLVED')
client.knowledgebase.issues.retrieve(...)
+## FileStorage ForceResync
+client.file_storage.force_resync.sync_status_resync_create()
-
@@ -38069,7 +37759,7 @@ Status of the issue. Options: ('ONGOING', 'RESOLVED')
-
-Get a specific issue.
+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.
@@ -38090,9 +37780,7 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.knowledgebase.issues.retrieve(
- id="id",
-)
+client.file_storage.force_resync.sync_status_resync_create()
```
@@ -38108,14 +37796,6 @@ client.knowledgebase.issues.retrieve(
-
-**id:** `str`
-
-
-
-
-
--
-
**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -38128,8 +37808,8 @@ client.knowledgebase.issues.retrieve(
client.knowledgebase.link_token.create(...)
+## FileStorage Users
+client.file_storage.users.list(...)
-
@@ -38141,7 +37821,7 @@ client.knowledgebase.issues.retrieve(
-
-Creates a link token to be used when linking a new end user.
+Returns a list of `User` objects.
@@ -38156,19 +37836,40 @@ Creates a link token to be used when linking a new end user.
-
```python
+import datetime
+
from merge import Merge
-from merge.resources.knowledgebase import CategoriesEnum
client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.knowledgebase.link_token.create(
- end_user_email_address="example@gmail.com",
- end_user_organization_name="Test Organization",
- end_user_origin_id="12345",
- categories=[CategoriesEnum.HRIS, CategoriesEnum.ATS],
+response = client.file_storage.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,
+ 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
```
@@ -38184,31 +37885,7 @@ client.knowledgebase.link_token.create(
-
-**end_user_email_address:** `str` — Your end user's email address. This is purely for identification purposes - setting this value will not cause any emails to be sent.
-
-
-
-
-
--
-
-**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.
+**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
@@ -38216,7 +37893,7 @@ client.knowledgebase.link_token.create(
-
-**integration:** `typing.Optional[str]` — The slug of a specific pre-selected integration for this linking flow token. For examples of slugs, see https://docs.merge.dev/guides/merge-link/single-integration/.
+**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
@@ -38224,7 +37901,7 @@ client.knowledgebase.link_token.create(
-
-**link_expiry_mins:** `typing.Optional[int]` — An integer number of minutes between [30, 720 or 10080 if for a Magic Link URL] for how long this token is valid. Defaults to 30.
+**cursor:** `typing.Optional[str]` — The pagination cursor value.
@@ -38232,7 +37909,7 @@ client.knowledgebase.link_token.create(
-
-**should_create_magic_link_url:** `typing.Optional[bool]` — Whether to generate a Magic Link URL. Defaults to false. For more information on Magic Link, see https://merge.dev/blog/integrations-fast-say-hello-to-magic-link.
+**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
@@ -38240,7 +37917,7 @@ client.knowledgebase.link_token.create(
-
-**hide_admin_magic_link:** `typing.Optional[bool]` — Whether to generate a Magic Link URL on the Admin Needed screen during the linking flow. Defaults to false. For more information on Magic Link, see https://merge.dev/blog/integrations-fast-say-hello-to-magic-link.
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -38248,7 +37925,7 @@ client.knowledgebase.link_token.create(
-
-**common_models:** `typing.Optional[typing.Sequence[CommonModelScopesBodyRequest]]` — An array of objects to specify the models and fields that will be disabled for a given Linked Account. Each object uses model_id, enabled_actions, and disabled_fields to specify the model, method, and fields that are scoped for a given Linked Account.
+**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -38256,14 +37933,7 @@ client.knowledgebase.link_token.create(
-
-**category_common_model_scopes:** `typing.Optional[
- typing.Dict[
- str,
- typing.Optional[
- typing.Sequence[IndividualCommonModelScopeDeserializerRequest]
- ],
- ]
-]` — When creating a Link Token, you can set permissions for Common Models that will apply to the account that is going to be linked. Any model or field not specified in link token payload will default to existing settings.
+**is_me:** `typing.Optional[str]` — If provided, will only return the user object for requestor.
@@ -38271,12 +37941,7 @@ client.knowledgebase.link_token.create(
-
-**language:** `typing.Optional[EndUserDetailsRequestLanguage]`
-
-The following subset of IETF language tags can be used to configure localization.
-
-* `en` - en
-* `de` - de
+**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
@@ -38284,7 +37949,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.
+**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
@@ -38292,7 +37957,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.
+**page_size:** `typing.Optional[int]` — Number of results to return per page.
@@ -38300,11 +37965,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
+**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
@@ -38324,8 +37985,7 @@ When creating a Link token, you can specifiy the initial screen of Linking Flow
client.knowledgebase.linked_accounts.list(...)
+client.file_storage.users.retrieve(...)
-
@@ -38337,7 +37997,7 @@ When creating a Link token, you can specifiy the initial screen of Linking Flow
-
-List linked accounts for your organization.
+Returns a `User` object with the given `id`.
@@ -38353,6871 +38013,15 @@ List linked accounts for your organization.
```python
from merge import Merge
-from merge.resources.knowledgebase.resources.linked_accounts import (
- LinkedAccountsListRequestCategory,
-)
client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.knowledgebase.linked_accounts.list(
- category=LinkedAccountsListRequestCategory.ACCOUNTING,
- cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
- end_user_email_address="end_user_email_address",
- end_user_organization_name="end_user_organization_name",
- end_user_origin_id="end_user_origin_id",
- end_user_origin_ids="end_user_origin_ids",
+client.file_storage.users.retrieve(
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`, `knowledgebase`, `mktg`, `ticketing`
-
-* `hris` - hris
-* `ats` - ats
-* `accounting` - accounting
-* `ticketing` - ticketing
-* `crm` - crm
-* `mktg` - mktg
-* `filestorage` - filestorage
-* `knowledgebase` - knowledgebase
-
-
-
-
-
--
-
-**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.
-
-
-
-
-
-
-
-
-
-client.knowledgebase.passthrough.create(...)
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-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.passthrough.create(
- request=DataPassthroughRequest(
- method=MethodEnum.GET,
- path="/scooters",
- ),
-)
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**request:** `DataPassthroughRequest`
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.knowledgebase.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.knowledgebase.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.
-
-
-
-
-
-
-
-
-
-client.knowledgebase.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.knowledgebase.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.
-
-
-
-
-
-
-
-
-
-client.knowledgebase.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.knowledgebase.force_resync.sync_status_resync_create()
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.knowledgebase.users.list(...)
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Returns a list of `User` objects.
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```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",
-)
-
-```
-
-
-
-
-
-#### ⚙️ 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.users.retrieve(...)
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Returns a `User` object with the given `id`.
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from merge import Merge
-
-client = Merge(
- account_token="YOUR_ACCOUNT_TOKEN",
- api_key="YOUR_API_KEY",
-)
-client.knowledgebase.users.retrieve(
- id="id",
- include_remote_data=True,
- include_shell_data=True,
-)
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**id:** `str`
-
-
-
-
-
--
-
-**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.knowledgebase.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.knowledgebase.webhook_receivers.list()
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.knowledgebase.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.knowledgebase.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.
-
-
-
-
-
-
-
-
-
-client.ticketing.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.ticketing.account_details.retrieve()
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.ticketing.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.ticketing.account_token.retrieve(
- public_token="public_token",
-)
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**public_token:** `str`
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.ticketing.accounts.list(...)
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Returns a list of `Account` objects.
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```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",
-)
-
-```
-
-
-
-
-
-#### ⚙️ 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.
-
-
-
-
-
-
-
-
-
-client.ticketing.accounts.retrieve(...)
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Returns an `Account` object with the given `id`.
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from merge import Merge
-
-client = Merge(
- account_token="YOUR_ACCOUNT_TOKEN",
- api_key="YOUR_API_KEY",
-)
-client.ticketing.accounts.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.
-
-
-
-
-
-
-
-
-
-client.ticketing.async_passthrough.create(...)
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Asynchronously pull data from an endpoint not currently supported by Merge.
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from merge import Merge
-from merge.resources.ticketing import DataPassthroughRequest, MethodEnum
-
-client = Merge(
- account_token="YOUR_ACCOUNT_TOKEN",
- api_key="YOUR_API_KEY",
-)
-client.ticketing.async_passthrough.create(
- request=DataPassthroughRequest(
- method=MethodEnum.GET,
- path="/scooters",
- ),
-)
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**request:** `DataPassthroughRequest`
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.ticketing.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.ticketing.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.
-
-
-
-
-
-
-
-
-
-client.ticketing.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.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",
- ),
- 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",
-)
-
-```
-
-
-
-
-
-#### ⚙️ 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["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/).
-
-
-
-
-
--
-
-**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_created_after:** `typing.Optional[dt.datetime]` — If provided, will only return attachments created in the third party platform after this datetime.
-
-
-
-
-
--
-
-**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
-
-
-
-
-
--
-
-**ticket_id:** `typing.Optional[str]` — If provided, will only return comments for this ticket.
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.ticketing.attachments.create(...)
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Creates an `Attachment` object with the given values.
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from merge import Merge
-from merge.resources.ticketing import AttachmentRequest
-
-client = Merge(
- account_token="YOUR_ACCOUNT_TOKEN",
- api_key="YOUR_API_KEY",
-)
-client.ticketing.attachments.create(
- is_debug_mode=True,
- run_async=True,
- model=AttachmentRequest(),
-)
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**model:** `AttachmentRequest`
-
-
-
-
-
--
-
-**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.ticketing.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.ticketing.attachments.retrieve(
- id="id",
- include_remote_data=True,
- include_shell_data=True,
-)
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**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).
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.ticketing.attachments.meta_post_retrieve()
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Returns metadata for `TicketingAttachment` POSTs.
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from merge import Merge
-
-client = Merge(
- account_token="YOUR_ACCOUNT_TOKEN",
- api_key="YOUR_API_KEY",
-)
-client.ticketing.attachments.meta_post_retrieve()
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.ticketing.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.ticketing.audit_trail.list(
- cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
- end_date="end_date",
- event_type="event_type",
- page_size=1,
- start_date="start_date",
- user_email="user_email",
-)
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**cursor:** `typing.Optional[str]` — The pagination cursor value.
-
-
-
-
-
--
-
-**end_date:** `typing.Optional[str]` — If included, will only include audit trail events that occurred before this time
-
-
-
-
-
--
-
-**event_type:** `typing.Optional[str]` — If included, will only include events with the given event type. Possible values include: `CREATED_REMOTE_PRODUCTION_API_KEY`, `DELETED_REMOTE_PRODUCTION_API_KEY`, `CREATED_TEST_API_KEY`, `DELETED_TEST_API_KEY`, `REGENERATED_PRODUCTION_API_KEY`, `REGENERATED_WEBHOOK_SIGNATURE`, `INVITED_USER`, `TWO_FACTOR_AUTH_ENABLED`, `TWO_FACTOR_AUTH_DISABLED`, `DELETED_LINKED_ACCOUNT`, `DELETED_ALL_COMMON_MODELS_FOR_LINKED_ACCOUNT`, `CREATED_DESTINATION`, `DELETED_DESTINATION`, `CHANGED_DESTINATION`, `CHANGED_SCOPES`, `CHANGED_PERSONAL_INFORMATION`, `CHANGED_ORGANIZATION_SETTINGS`, `ENABLED_INTEGRATION`, `DISABLED_INTEGRATION`, `ENABLED_CATEGORY`, `DISABLED_CATEGORY`, `CHANGED_PASSWORD`, `RESET_PASSWORD`, `ENABLED_REDACT_UNMAPPED_DATA_FOR_ORGANIZATION`, `ENABLED_REDACT_UNMAPPED_DATA_FOR_LINKED_ACCOUNT`, `DISABLED_REDACT_UNMAPPED_DATA_FOR_ORGANIZATION`, `DISABLED_REDACT_UNMAPPED_DATA_FOR_LINKED_ACCOUNT`, `CREATED_INTEGRATION_WIDE_FIELD_MAPPING`, `CREATED_LINKED_ACCOUNT_FIELD_MAPPING`, `CHANGED_INTEGRATION_WIDE_FIELD_MAPPING`, `CHANGED_LINKED_ACCOUNT_FIELD_MAPPING`, `DELETED_INTEGRATION_WIDE_FIELD_MAPPING`, `DELETED_LINKED_ACCOUNT_FIELD_MAPPING`, `CREATED_LINKED_ACCOUNT_COMMON_MODEL_OVERRIDE`, `CHANGED_LINKED_ACCOUNT_COMMON_MODEL_OVERRIDE`, `DELETED_LINKED_ACCOUNT_COMMON_MODEL_OVERRIDE`, `FORCED_LINKED_ACCOUNT_RESYNC`, `MUTED_ISSUE`, `GENERATED_MAGIC_LINK`, `ENABLED_MERGE_WEBHOOK`, `DISABLED_MERGE_WEBHOOK`, `MERGE_WEBHOOK_TARGET_CHANGED`, `END_USER_CREDENTIALS_ACCESSED`
-
-
-
-
-
--
-
-**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
-
-
-
-
-
--
-
-**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.
-
-
-
-
-
-
-
-
-
-client.ticketing.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.ticketing.available_actions.retrieve()
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.ticketing.collections.list(...)
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Returns a list of `Collection` objects.
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```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",
- ),
- 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",
-)
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**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.
-
-
-
-
-
--
-
-**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/).
-
-
-
-
-
--
-
-**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.
-
-
-
-
-
--
-
-**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.
-
-
-
-
-
--
-
-**parent_collection_id:** `typing.Optional[str]` — If provided, will only return collections whose parent collection matches the given id.
-
-
-
-
-
--
-
-**remote_fields:** `typing.Optional[typing.Literal["collection_type"]]` — Deprecated. Use show_enum_origins.
-
-
-
-
-
--
-
-**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
-
-
-
-
-
--
-
-**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.
-
-
-
-
-
-
-
-
-
-client.ticketing.collections.viewers_list(...)
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Returns a list of `Viewer` objects that point to a User id or Team id that is either an assignee or viewer on a `Collection` with the given id. [Learn more.](https://help.merge.dev/en/articles/10333658-ticketing-access-control-list-acls)
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```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",
- cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
- expand=CollectionsViewersListRequestExpand.TEAM,
- include_deleted_data=True,
- include_remote_data=True,
- include_shell_data=True,
- page_size=1,
-)
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**collection_id:** `str`
-
-
-
-
-
--
-
-**cursor:** `typing.Optional[str]` — The pagination cursor value.
-
-
-
-
-
--
-
-**expand:** `typing.Optional[CollectionsViewersListRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
-
-
-
-
-
--
-
-**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
-
-
-
-
-
--
-
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
-
-
-
-
-
--
-
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
-
-
-
-
-
--
-
-**page_size:** `typing.Optional[int]` — Number of results to return per page.
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.ticketing.collections.retrieve(...)
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Returns a `Collection` object with the given `id`.
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from merge import Merge
-
-client = Merge(
- account_token="YOUR_ACCOUNT_TOKEN",
- api_key="YOUR_API_KEY",
-)
-client.ticketing.collections.retrieve(
- id="id",
- include_remote_data=True,
- include_shell_data=True,
-)
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**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.
-
-
-
-
-
-
-
-
-
-client.ticketing.comments.list(...)
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Returns a list of `Comment` objects.
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-import datetime
-
-from merge import Merge
-from merge.resources.ticketing.resources.comments import (
- CommentsListRequestExpand,
-)
-
-client = Merge(
- account_token="YOUR_ACCOUNT_TOKEN",
- api_key="YOUR_API_KEY",
-)
-client.ticketing.comments.list(
- created_after=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- created_before=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
- expand=CommentsListRequestExpand.CONTACT,
- include_deleted_data=True,
- include_remote_data=True,
- include_shell_data=True,
- modified_after=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- modified_before=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- page_size=1,
- remote_created_after=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- remote_id="remote_id",
- ticket_id="ticket_id",
-)
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
-
-
-
-
-
--
-
-**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
-
-
-
-
-
--
-
-**cursor:** `typing.Optional[str]` — The pagination cursor value.
-
-
-
-
-
--
-
-**expand:** `typing.Optional[CommentsListRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
-
-
-
-
-
--
-
-**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
-
-
-
-
-
--
-
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
-
-
-
-
-
--
-
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
-
-
-
-
-
--
-
-**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
-
-
-
-
-
--
-
-**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
-
-
-
-
-
--
-
-**page_size:** `typing.Optional[int]` — Number of results to return per page. The maximum limit is 100.
-
-
-
-
-
--
-
-**remote_created_after:** `typing.Optional[dt.datetime]` — If provided, will only return Comments created in the third party platform after this datetime.
-
-
-
-
-
--
-
-**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
-
-
-
-
-
--
-
-**ticket_id:** `typing.Optional[str]` — If provided, will only return comments for this ticket.
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.ticketing.comments.create(...)
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Creates a `Comment` object with the given values.
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from merge import Merge
-from merge.resources.ticketing import CommentRequest
-
-client = Merge(
- account_token="YOUR_ACCOUNT_TOKEN",
- api_key="YOUR_API_KEY",
-)
-client.ticketing.comments.create(
- is_debug_mode=True,
- run_async=True,
- model=CommentRequest(),
-)
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**model:** `CommentRequest`
-
-
-
-
-
--
-
-**is_debug_mode:** `typing.Optional[bool]` — Whether to include debug fields (such as log file links) in the response.
-
-
-
-
-
--
-
-**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously.
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.ticketing.comments.retrieve(...)
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Returns a `Comment` object with the given `id`.
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```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(
- id="id",
- expand=CommentsRetrieveRequestExpand.CONTACT,
- include_remote_data=True,
- include_shell_data=True,
-)
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**id:** `str`
-
-
-
-
-
--
-
-**expand:** `typing.Optional[CommentsRetrieveRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
-
-
-
-
-
--
-
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
-
-
-
-
-
--
-
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.ticketing.comments.meta_post_retrieve()
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Returns metadata for `Comment` POSTs.
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from merge import Merge
-
-client = Merge(
- account_token="YOUR_ACCOUNT_TOKEN",
- api_key="YOUR_API_KEY",
-)
-client.ticketing.comments.meta_post_retrieve()
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.ticketing.contacts.list(...)
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Returns a list of `Contact` objects.
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```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",
-)
-
-```
-
-
-
-
-
-#### ⚙️ 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.
-
-
-
-
-
--
-
-**email_address:** `typing.Optional[str]` — If provided, will only return Contacts that match this email.
-
-
-
-
-
--
-
-**expand:** `typing.Optional[typing.Literal["account"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
-
-
-
-
-
--
-
-**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is 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.ticketing.contacts.create(...)
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Creates a `Contact` object with the given values.
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from merge import Merge
-from merge.resources.ticketing import ContactRequest
-
-client = Merge(
- account_token="YOUR_ACCOUNT_TOKEN",
- api_key="YOUR_API_KEY",
-)
-client.ticketing.contacts.create(
- is_debug_mode=True,
- run_async=True,
- model=ContactRequest(),
-)
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**model:** `ContactRequest`
-
-
-
-
-
--
-
-**is_debug_mode:** `typing.Optional[bool]` — Whether to include debug fields (such as log file links) in the response.
-
-
-
-
-
--
-
-**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously.
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.ticketing.contacts.retrieve(...)
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Returns a `Contact` object with the given `id`.
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from merge import Merge
-
-client = Merge(
- account_token="YOUR_ACCOUNT_TOKEN",
- api_key="YOUR_API_KEY",
-)
-client.ticketing.contacts.retrieve(
- id="id",
- include_remote_data=True,
- include_shell_data=True,
-)
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**id:** `str`
-
-
-
-
-
--
-
-**expand:** `typing.Optional[typing.Literal["account"]]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
-
-
-
-
-
--
-
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
-
-
-
-
-
--
-
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.ticketing.contacts.meta_post_retrieve()
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Returns metadata for `TicketingContact` POSTs.
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from merge import Merge
-
-client = Merge(
- account_token="YOUR_ACCOUNT_TOKEN",
- api_key="YOUR_API_KEY",
-)
-client.ticketing.contacts.meta_post_retrieve()
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.ticketing.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.ticketing.scopes.default_scopes_retrieve()
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.ticketing.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.ticketing.scopes.linked_account_scopes_retrieve()
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.ticketing.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.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,
- )
- },
- ),
- ],
-)
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**common_models:** `typing.Sequence[IndividualCommonModelScopeDeserializerRequest]` — The common models you want to update the scopes for
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.ticketing.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.ticketing.delete_account.delete()
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.ticketing.field_mapping.field_mappings_retrieve(...)
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Get all Field Mappings for this Linked Account. Field Mappings are mappings between third-party Remote Fields and user defined Merge fields. [Learn more](https://docs.merge.dev/supplemental-data/field-mappings/overview/).
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from merge import Merge
-
-client = Merge(
- account_token="YOUR_ACCOUNT_TOKEN",
- api_key="YOUR_API_KEY",
-)
-client.ticketing.field_mapping.field_mappings_retrieve(
- 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.ticketing.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.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",
-)
-
-```
-
-
-
-
-
-#### ⚙️ 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.ticketing.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.ticketing.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.ticketing.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.ticketing.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.ticketing.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.ticketing.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.ticketing.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.ticketing.field_mapping.target_fields_retrieve()
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.ticketing.generate_key.create(...)
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Create a remote key.
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from merge import Merge
-
-client = Merge(
- account_token="YOUR_ACCOUNT_TOKEN",
- api_key="YOUR_API_KEY",
-)
-client.ticketing.generate_key.create(
- name="Remote Deployment Key 1",
-)
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**name:** `str` — The name of the remote key
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.ticketing.issues.list(...)
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Gets all issues for Organization.
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-import datetime
-
-from merge import Merge
-from merge.resources.ticketing.resources.issues import IssuesListRequestStatus
-
-client = Merge(
- account_token="YOUR_ACCOUNT_TOKEN",
- api_key="YOUR_API_KEY",
-)
-client.ticketing.issues.list(
- account_token="account_token",
- cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
- end_date="end_date",
- end_user_organization_name="end_user_organization_name",
- first_incident_time_after=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- first_incident_time_before=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- include_muted="include_muted",
- integration_name="integration_name",
- last_incident_time_after=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- last_incident_time_before=datetime.datetime.fromisoformat(
- "2024-01-15 09:30:00+00:00",
- ),
- linked_account_id="linked_account_id",
- page_size=1,
- start_date="start_date",
- status=IssuesListRequestStatus.ONGOING,
-)
-
-```
-
-
-
-
-
-#### ⚙️ 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.ticketing.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.ticketing.issues.retrieve(
- id="id",
-)
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**id:** `str`
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.ticketing.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.ticketing import CategoriesEnum
-
-client = Merge(
- account_token="YOUR_ACCOUNT_TOKEN",
- api_key="YOUR_API_KEY",
-)
-client.ticketing.link_token.create(
- end_user_email_address="example@gmail.com",
- end_user_organization_name="Test Organization",
- end_user_origin_id="12345",
- categories=[CategoriesEnum.HRIS, CategoriesEnum.ATS],
-)
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**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.
-
-
-
-
-
-
-
-
-
-client.ticketing.linked_accounts.list(...)
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-List linked accounts for your organization.
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```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",
-)
-
-```
-
-
-
-
-
-#### ⚙️ 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.
-
-
-
-
-
-
-
-
-
-client.ticketing.passthrough.create(...)
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Pull data from an endpoint not currently supported by Merge.
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from merge import Merge
-from merge.resources.ticketing import DataPassthroughRequest, MethodEnum
-
-client = Merge(
- account_token="YOUR_ACCOUNT_TOKEN",
- api_key="YOUR_API_KEY",
-)
-client.ticketing.passthrough.create(
- request=DataPassthroughRequest(
- method=MethodEnum.GET,
- path="/scooters",
- ),
-)
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**request:** `DataPassthroughRequest`
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.ticketing.projects.list(...)
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Returns a list of `Project` objects.
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```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",
-)
-
-```
-
-
-
-
-
-#### ⚙️ 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.ticketing.projects.retrieve(...)
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Returns a `Project` object with the given `id`.
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from merge import Merge
-
-client = Merge(
- account_token="YOUR_ACCOUNT_TOKEN",
- api_key="YOUR_API_KEY",
-)
-client.ticketing.projects.retrieve(
- id="id",
- 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.
-
-
-
-
-
-
-
-
-
-client.ticketing.projects.users_list(...)
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Returns a list of `User` objects.
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```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",
- cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
- expand=ProjectsUsersListRequestExpand.ROLES,
- include_deleted_data=True,
- include_remote_data=True,
- include_shell_data=True,
- page_size=1,
-)
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**parent_id:** `str`
-
-
-
-
-
--
-
-**cursor:** `typing.Optional[str]` — The pagination cursor value.
-
-
-
-
-
--
-
-**expand:** `typing.Optional[ProjectsUsersListRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
-
-
-
-
-
--
-
-**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
-
-
-
-
-
--
-
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
-
-
-
-
-
--
-
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
-
-
-
-
-
--
-
-**page_size:** `typing.Optional[int]` — Number of results to return per page. The maximum limit is 100.
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.ticketing.regenerate_key.create(...)
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Exchange remote keys.
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from merge import Merge
-
-client = Merge(
- account_token="YOUR_ACCOUNT_TOKEN",
- api_key="YOUR_API_KEY",
-)
-client.ticketing.regenerate_key.create(
- name="Remote Deployment Key 1",
-)
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**name:** `str` — The name of the remote key
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.ticketing.roles.list(...)
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Returns a list of `Role` objects.
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-import datetime
-
-from merge import Merge
-
-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",
-)
-
-```
-
-
-
-
-
-#### ⚙️ 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.ticketing.roles.retrieve(...)
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Returns a `Role` object with the given `id`.
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from merge import Merge
-
-client = Merge(
- account_token="YOUR_ACCOUNT_TOKEN",
- api_key="YOUR_API_KEY",
-)
-client.ticketing.roles.retrieve(
- id="id",
- include_remote_data=True,
- include_shell_data=True,
-)
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**id:** `str`
-
-
-
-
-
--
-
-**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.ticketing.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.ticketing.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.
-
-
-
-
-
-
-
-
-
-client.ticketing.force_resync.sync_status_resync_create()
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Force re-sync of all models. This endpoint is available for monthly, quarterly, and highest sync frequency customers on the Professional or Enterprise plans. Doing so will consume a sync credit for the relevant linked account. Force re-syncs can also be triggered manually in the Merge Dashboard and is available for all customers.
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from merge import Merge
-
-client = Merge(
- account_token="YOUR_ACCOUNT_TOKEN",
- api_key="YOUR_API_KEY",
-)
-client.ticketing.force_resync.sync_status_resync_create()
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.ticketing.tags.list(...)
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Returns a list of `Tag` objects.
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```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",
- ),
- 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.ticketing.tags.retrieve(...)
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Returns a `Tag` object with the given `id`.
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from merge import Merge
-
-client = Merge(
- account_token="YOUR_ACCOUNT_TOKEN",
- api_key="YOUR_API_KEY",
-)
-client.ticketing.tags.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.
-
-
-
-
-
-
-
-
-
-client.ticketing.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.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",
-)
-
-```
-
-
-
-
-
-#### ⚙️ 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.ticketing.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.ticketing.teams.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.
-
-
-
-
-
-
-
-
-
-client.ticketing.tickets.list(...)
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Returns a list of `Ticket` objects.
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```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",
-)
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**account_id:** `typing.Optional[str]` — If provided, will only return tickets for this account.
-
-
-
-
-
--
-
-**assignee_ids:** `typing.Optional[str]` — If provided, will only return tickets assigned to the assignee_ids; multiple assignee_ids can be separated by commas.
-
-
-
-
-
--
-
-**collection_ids:** `typing.Optional[str]` — If provided, will only return tickets assigned to the collection_ids; multiple collection_ids can be separated by commas.
-
-
-
-
-
--
-
-**completed_after:** `typing.Optional[dt.datetime]` — If provided, will only return tickets completed after this datetime.
-
-
-
-
-
--
-
-**completed_before:** `typing.Optional[dt.datetime]` — If provided, will only return tickets completed before this datetime.
-
-
-
-
-
--
-
-**contact_id:** `typing.Optional[str]` — If provided, will only return tickets for this contact.
-
-
-
-
-
--
-
-**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
-
-
-
-
-
--
-
-**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
-
-
-
-
-
--
-
-**creator_id:** `typing.Optional[str]` — If provided, will only return tickets created by this creator_id.
-
-
-
-
-
--
-
-**creator_ids:** `typing.Optional[str]` — If provided, will only return tickets created by the creator_ids; multiple creator_ids can be separated by commas.
-
-
-
-
-
--
-
-**cursor:** `typing.Optional[str]` — The pagination cursor value.
-
-
-
-
-
--
-
-**due_after:** `typing.Optional[dt.datetime]` — If provided, will only return tickets due after this datetime.
-
-
-
-
-
--
-
-**due_before:** `typing.Optional[dt.datetime]` — If provided, will only return tickets due before this datetime.
-
-
-
-
-
--
-
-**expand:** `typing.Optional[TicketsListRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
-
-
-
-
-
--
-
-**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
-
-
-
-
-
--
-
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
-
-
-
-
-
--
-
-**include_remote_fields:** `typing.Optional[bool]` — Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.
-
-
-
-
-
--
-
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
-
-
-
-
-
--
-
-**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
-
-
-
-
-
--
-
-**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
-
-
-
-
-
--
-
-**name:** `typing.Optional[str]` — If provided, will only return tickets with this name.
-
-
-
-
-
--
-
-**page_size:** `typing.Optional[int]` — Number of results to return per page. The maximum limit is 100.
-
-
-
-
-
--
-
-**parent_ticket_id:** `typing.Optional[str]` — If provided, will only return sub tickets of the parent_ticket_id.
-
-
-
-
-
--
-
-**priority:** `typing.Optional[TicketsListRequestPriority]`
-
-If provided, will only return tickets of this priority.
-
-* `URGENT` - URGENT
-* `HIGH` - HIGH
-* `NORMAL` - NORMAL
-* `LOW` - LOW
-
-
-
-
-
--
-
-**remote_created_after:** `typing.Optional[dt.datetime]` — If provided, will only return tickets created in the third party platform after this datetime.
-
-
-
-
-
--
-
-**remote_created_before:** `typing.Optional[dt.datetime]` — If provided, will only return tickets created in the third party platform before this datetime.
-
-
-
-
-
--
-
-**remote_fields:** `typing.Optional[TicketsListRequestRemoteFields]` — Deprecated. Use show_enum_origins.
-
-
-
-
-
--
-
-**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
-
-
-
-
-
--
-
-**remote_updated_after:** `typing.Optional[dt.datetime]` — If provided, will only return tickets updated in the third party platform after this datetime.
-
-
-
-
-
--
-
-**remote_updated_before:** `typing.Optional[dt.datetime]` — If provided, will only return tickets updated in the third party platform before this datetime.
-
-
-
-
-
--
-
-**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.
-
-
-
-
-
--
-
-**tags:** `typing.Optional[str]` — If provided, will only return tickets matching the tags; multiple tags can be separated by commas.
-
-
-
-
-
--
-
-**ticket_type:** `typing.Optional[str]` — If provided, will only return tickets of this type.
-
-
-
-
-
--
-
-**ticket_url:** `typing.Optional[str]` — If provided, will only return tickets where the URL matches or contains the substring
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.ticketing.tickets.create(...)
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Creates a `Ticket` object with the given values.
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```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(),
-)
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**model:** `TicketRequest`
-
-
-
-
-
--
-
-**is_debug_mode:** `typing.Optional[bool]` — Whether to include debug fields (such as log file links) in the response.
-
-
-
-
-
--
-
-**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously.
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.ticketing.tickets.retrieve(...)
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Returns a `Ticket` object with the given `id`.
-
-
-
-
-
-#### 🔌 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,
)
```
@@ -45242,7 +38046,7 @@ client.ticketing.tickets.retrieve(
-
-**expand:** `typing.Optional[TicketsRetrieveRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -45250,7 +38054,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.
+**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -45258,34 +38062,64 @@ 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.
+**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.webhook_receivers.list()
-
-**remote_fields:** `typing.Optional[TicketsRetrieveRequestRemoteFields]` — Deprecated. Use show_enum_origins.
-
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a list of `WebhookReceiver` objects.
+
+
+#### 🔌 Usage
+
-
-**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)
-
+
+-
+
+```python
+from merge import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.file_storage.webhook_receivers.list()
+
+```
+
+
+
+#### ⚙️ Parameters
+
+
+-
-
@@ -45302,7 +38136,7 @@ client.ticketing.tickets.retrieve(
client.ticketing.tickets.partial_update(...)
+client.file_storage.webhook_receivers.create(...)
-
@@ -45314,7 +38148,7 @@ client.ticketing.tickets.retrieve(
-
-Updates a `Ticket` object with the given `id`.
+Creates a `WebhookReceiver` object with the given values.
@@ -45330,17 +38164,14 @@ Updates a `Ticket` object with the given `id`.
```python
from merge import Merge
-from merge.resources.ticketing import PatchedTicketRequest
client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.ticketing.tickets.partial_update(
- id="id",
- is_debug_mode=True,
- run_async=True,
- model=PatchedTicketRequest(),
+client.file_storage.webhook_receivers.create(
+ event="event",
+ is_active=True,
)
```
@@ -45357,15 +38188,7 @@ client.ticketing.tickets.partial_update(
-
-**id:** `str`
-
-
-
-
-
--
-
-**model:** `PatchedTicketRequest`
+**event:** `str`
@@ -45373,7 +38196,7 @@ client.ticketing.tickets.partial_update(
-
-**is_debug_mode:** `typing.Optional[bool]` — Whether to include debug fields (such as log file links) in the response.
+**is_active:** `bool`
@@ -45381,7 +38204,7 @@ client.ticketing.tickets.partial_update(
-
-**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously.
+**key:** `typing.Optional[str]`
@@ -45401,7 +38224,8 @@ client.ticketing.tickets.partial_update(
client.ticketing.tickets.viewers_list(...)
+## Hris AccountDetails
+client.hris.account_details.retrieve()
-
@@ -45413,7 +38237,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)
+Get details for a linked account.
@@ -45429,23 +38253,12 @@ 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,
-)
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.hris.account_details.retrieve()
```
@@ -45461,55 +38274,71 @@ client.ticketing.tickets.viewers_list(
-
-**ticket_id:** `str`
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
-
--
-**cursor:** `typing.Optional[str]` — The pagination cursor value.
-
+client.hris.account_token.retrieve(...)
-
-**expand:** `typing.Optional[TicketsViewersListRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
-
-
-
+#### 📝 Description
-
-**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
-
-
-
-
-
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
-
+Returns the account token for the end user with the provided public token.
+
+
+
+#### 🔌 Usage
-
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
-
+
+-
+
+```python
+from merge import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.hris.account_token.retrieve(
+ public_token="public_token",
+)
+
+```
+
+
+#### ⚙️ Parameters
+
-
-**page_size:** `typing.Optional[int]` — Number of results to return per page. The maximum limit is 100.
+
+-
+
+**public_token:** `str`
@@ -45529,7 +38358,8 @@ client.ticketing.tickets.viewers_list(
client.ticketing.tickets.meta_patch_retrieve(...)
+## Hris AsyncPassthrough
+client.hris.async_passthrough.create(...)
-
@@ -45541,7 +38371,7 @@ client.ticketing.tickets.viewers_list(
-
-Returns metadata for `Ticket` PATCHs.
+Asynchronously pull data from an endpoint not currently supported by Merge.
@@ -45557,13 +38387,17 @@ Returns metadata for `Ticket` PATCHs.
```python
from merge import Merge
+from merge.resources.hris import DataPassthroughRequest, MethodEnum
client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.ticketing.tickets.meta_patch_retrieve(
- id="id",
+client.hris.async_passthrough.create(
+ request=DataPassthroughRequest(
+ method=MethodEnum.GET,
+ path="/scooters",
+ ),
)
```
@@ -45580,7 +38414,7 @@ client.ticketing.tickets.meta_patch_retrieve(
-
-**id:** `str`
+**request:** `DataPassthroughRequest`
@@ -45600,7 +38434,7 @@ client.ticketing.tickets.meta_patch_retrieve(
client.ticketing.tickets.meta_post_retrieve(...)
+client.hris.async_passthrough.retrieve(...)
-
@@ -45612,7 +38446,7 @@ client.ticketing.tickets.meta_patch_retrieve(
-
-Returns metadata for `Ticket` POSTs.
+Retrieves data from earlier async-passthrough POST request
@@ -45633,9 +38467,8 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.ticketing.tickets.meta_post_retrieve(
- collection_id="collection_id",
- ticket_type="ticket_type",
+client.hris.async_passthrough.retrieve(
+ async_passthrough_receipt_id="async_passthrough_receipt_id",
)
```
@@ -45652,15 +38485,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.
+**async_passthrough_receipt_id:** `str`
@@ -45680,7 +38505,8 @@ client.ticketing.tickets.meta_post_retrieve(
client.ticketing.tickets.remote_field_classes_list(...)
+## Hris AuditTrail
+client.hris.audit_trail.list(...)
-
@@ -45692,7 +38518,7 @@ client.ticketing.tickets.meta_post_retrieve(
-
-Returns a list of `RemoteFieldClass` objects.
+Gets a list of audit trail events.
@@ -45713,16 +38539,19 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.ticketing.tickets.remote_field_classes_list(
+response = client.hris.audit_trail.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,
+ 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
```
@@ -45746,23 +38575,7 @@ client.ticketing.tickets.remote_field_classes_list(
-
-**ids:** `typing.Optional[str]` — If provided, will only return remote field classes with the `ids` in this list
-
-
-
-
-
--
-
-**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
-
-
-
-
-
--
-
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
+**end_date:** `typing.Optional[str]` — If included, will only include audit trail events that occurred before this time
@@ -45770,7 +38583,7 @@ client.ticketing.tickets.remote_field_classes_list(
-
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
+**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`
@@ -45778,7 +38591,7 @@ client.ticketing.tickets.remote_field_classes_list(
-
-**is_common_model_field:** `typing.Optional[bool]` — If provided, will only return remote field classes with this is_common_model_field value
+**page_size:** `typing.Optional[int]` — Number of results to return per page.
@@ -45786,7 +38599,7 @@ client.ticketing.tickets.remote_field_classes_list(
-
-**is_custom:** `typing.Optional[bool]` — If provided, will only return remote fields classes with this is_custom value
+**start_date:** `typing.Optional[str]` — If included, will only include audit trail events that occurred after this time
@@ -45794,7 +38607,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.
+**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.
@@ -45814,8 +38627,8 @@ client.ticketing.tickets.remote_field_classes_list(
client.ticketing.users.list(...)
+## Hris AvailableActions
+client.hris.available_actions.retrieve()
-
@@ -45827,7 +38640,7 @@ client.ticketing.tickets.remote_field_classes_list(
-
-Returns a list of `User` objects.
+Returns a list of models and actions available for an account.
@@ -45842,38 +38655,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.hris.available_actions.retrieve()
```
@@ -45889,87 +38677,108 @@ 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.
-
-
--
-
-**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
-
-
--
-**cursor:** `typing.Optional[str]` — The pagination cursor value.
-
+
client.hris.bank_info.list(...)
-
-**email_address:** `typing.Optional[str]` — If provided, will only return users with emails equal to this value (case insensitive).
-
-
-
+#### 📝 Description
-
-**expand:** `typing.Optional[UsersListRequestExpand]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
-
-
-
-
-
-**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
-
+Returns a list of `BankInfo` objects.
-
-
--
-
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
-
+#### 🔌 Usage
+
-
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
-
-
-
-
-
-**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
-
+```python
+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",
+)
+response = 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",
+)
+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. The maximum limit is 100.
+**account_type:** `typing.Optional[BankInfoListRequestAccountType]`
+
+If provided, will only return BankInfo's with this account type. Options: ('SAVINGS', 'CHECKING')
+
+* `SAVINGS` - SAVINGS
+* `CHECKING` - CHECKING
@@ -45977,7 +38786,7 @@ client.ticketing.users.list(
-
-**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
+**bank_name:** `typing.Optional[str]` — If provided, will only return BankInfo's with this bank name.
@@ -45985,7 +38794,7 @@ client.ticketing.users.list(
-
-**team:** `typing.Optional[str]` — If provided, will only return users matching in this team.
+**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
@@ -45993,74 +38802,35 @@ client.ticketing.users.list(
-
-**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.ticketing.users.retrieve(...)
-
--
-
-#### 📝 Description
-
-
--
-
-Returns a `User` object with the given `id`.
-
-
+**cursor:** `typing.Optional[str]` — The pagination cursor value.
+
-#### 🔌 Usage
-
-
--
-
-
-```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(
- id="id",
- expand=UsersRetrieveRequestExpand.ROLES,
- include_remote_data=True,
- include_shell_data=True,
-)
-
-```
-
-
+**employee_id:** `typing.Optional[str]` — If provided, will only return bank accounts for this employee.
+
-#### ⚙️ Parameters
-
-
-
--
-
-**id:** `str`
+**expand:** `typing.Optional[
+ typing.Union[
+ typing.Literal["employee"], typing.Sequence[typing.Literal["employee"]]
+ ]
+]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -46068,7 +38838,7 @@ 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_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
@@ -46092,65 +38862,59 @@ client.ticketing.users.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.
-
-
+
+-
+**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
+
-
client.ticketing.webhook_receivers.list()
-
-#### 📝 Description
-
-
--
+**order_by:** `typing.Optional[BankInfoListRequestOrderBy]` — Overrides the default ordering for this endpoint. Possible values include: remote_created_at, -remote_created_at.
+
+
+
-
-Returns a list of `WebhookReceiver` objects.
-
-
+**page_size:** `typing.Optional[int]` — Number of results to return per page.
+
-#### 🔌 Usage
-
-
+**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.ticketing.webhook_receivers.list()
-
-```
-
-
+**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
+
-#### ⚙️ Parameters
-
-
+**show_enum_origins:** `typing.Optional[typing.Literal["account_type"]]` — A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter)
+
+
+
+
-
@@ -46166,7 +38930,7 @@ client.ticketing.webhook_receivers.list()
client.ticketing.webhook_receivers.create(...)
+client.hris.bank_info.retrieve(...)
-
@@ -46178,7 +38942,7 @@ client.ticketing.webhook_receivers.list()
-
-Creates a `WebhookReceiver` object with the given values.
+Returns a `BankInfo` object with the given `id`.
@@ -46199,9 +38963,10 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.ticketing.webhook_receivers.create(
- event="event",
- is_active=True,
+client.hris.bank_info.retrieve(
+ id="id",
+ include_remote_data=True,
+ include_shell_data=True,
)
```
@@ -46218,7 +38983,7 @@ client.ticketing.webhook_receivers.create(
-
-**event:** `str`
+**id:** `str`
@@ -46226,7 +38991,11 @@ client.ticketing.webhook_receivers.create(
-
-**is_active:** `bool`
+**expand:** `typing.Optional[
+ typing.Union[
+ typing.Literal["employee"], typing.Sequence[typing.Literal["employee"]]
+ ]
+]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -46234,7 +39003,7 @@ client.ticketing.webhook_receivers.create(
-
-**key:** `typing.Optional[str]`
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -46242,65 +39011,27 @@ client.ticketing.webhook_receivers.create(
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
-
-
-
-
-
-
-client.accounting.account_details.retrieve()
-
--
-
-#### 📝 Description
-
-
--
-
-Get details for a linked account.
-
-
+**remote_fields:** `typing.Optional[typing.Literal["account_type"]]` — Deprecated. Use show_enum_origins.
+
-#### 🔌 Usage
-
-
--
-
-
-```python
-from merge import Merge
-
-client = Merge(
- account_token="YOUR_ACCOUNT_TOKEN",
- api_key="YOUR_API_KEY",
-)
-client.accounting.account_details.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)
+
-#### ⚙️ Parameters
-
-
--
-
-
@@ -46316,8 +39047,8 @@ client.accounting.account_details.retrieve()
client.accounting.account_token.retrieve(...)
+## Hris Benefits
+client.hris.benefits.list(...)
-
@@ -46329,7 +39060,7 @@ client.accounting.account_details.retrieve()
-
-Returns the account token for the end user with the provided public token.
+Returns a list of `Benefit` objects.
@@ -46344,15 +39075,40 @@ Returns the account token for the end user with the provided public token.
-
```python
+import datetime
+
from merge import Merge
client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.accounting.account_token.retrieve(
- public_token="public_token",
+response = 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",
)
+for item in response:
+ yield item
+# alternatively, you can paginate page-by-page
+for page in response.iter_pages():
+ yield page
```
@@ -46368,7 +39124,7 @@ client.accounting.account_token.retrieve(
-
-**public_token:** `str`
+**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
@@ -46376,75 +39132,59 @@ client.accounting.account_token.retrieve(
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
-
-
+
+-
+**cursor:** `typing.Optional[str]` — The pagination cursor value.
+
-client.accounting.accounting_periods.list(...)
-
-#### 📝 Description
-
-
--
+**employee_id:** `typing.Optional[str]` — If provided, will return the benefits associated with the employee.
+
+
+
-
-Returns a list of `AccountingPeriod` objects.
-
-
+**expand:** `typing.Optional[
+ typing.Union[
+ typing.Literal["employee"], typing.Sequence[typing.Literal["employee"]]
+ ]
+]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
+
-#### 🔌 Usage
-
-
-
--
-
-```python
-from merge import Merge
-
-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,
-)
-
-```
-
-
+**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
+
-#### ⚙️ Parameters
-
-
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
+
+
+
+
-
-**cursor:** `typing.Optional[str]` — The pagination cursor value.
+**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -46452,7 +39192,7 @@ client.accounting.accounting_periods.list(
-
-**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
+**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
@@ -46460,7 +39200,7 @@ client.accounting.accounting_periods.list(
-
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
+**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
@@ -46468,7 +39208,7 @@ client.accounting.accounting_periods.list(
-
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
+**page_size:** `typing.Optional[int]` — Number of results to return per page.
@@ -46476,7 +39216,7 @@ client.accounting.accounting_periods.list(
-
-**page_size:** `typing.Optional[int]` — Number of results to return per page.
+**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
@@ -46496,7 +39236,7 @@ client.accounting.accounting_periods.list(
client.accounting.accounting_periods.retrieve(...)
+client.hris.benefits.retrieve(...)
-
@@ -46508,7 +39248,7 @@ client.accounting.accounting_periods.list(
-
-Returns an `AccountingPeriod` object with the given `id`.
+Returns a `Benefit` object with the given `id`.
@@ -46529,7 +39269,7 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.accounting.accounting_periods.retrieve(
+client.hris.benefits.retrieve(
id="id",
include_remote_data=True,
include_shell_data=True,
@@ -46557,6 +39297,18 @@ client.accounting.accounting_periods.retrieve(
-
+**expand:** `typing.Optional[
+ typing.Union[
+ typing.Literal["employee"], typing.Sequence[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.
@@ -46585,8 +39337,8 @@ client.accounting.accounting_periods.retrieve(
client.accounting.accounts.list(...)
+## Hris Companies
+client.hris.companies.list(...)
-
@@ -46598,7 +39350,7 @@ client.accounting.accounting_periods.retrieve(
-
-Returns a list of `Account` objects.
+Returns a list of `Company` objects.
@@ -46616,21 +39368,12 @@ Returns a list of `Account` objects.
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",
+response = client.hris.companies.list(
created_after=datetime.datetime.fromisoformat(
"2024-01-15 09:30:00+00:00",
),
@@ -46647,13 +39390,14 @@ client.accounting.accounts.list(
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,30 +39413,6 @@ client.accounting.accounts.list(
-
-**account_type:** `typing.Optional[str]` — If provided, will only return accounts with the passed in enum.
-
-
-
-
-
--
-
-**classification:** `typing.Optional[AccountsListRequestClassification]` — If provided, will only return accounts with this classification.
-
-
-
-
-
--
-
-**company_id:** `typing.Optional[str]` — If provided, will only return accounts for this company.
-
-
-
-
-
--
-
**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
@@ -46717,14 +39437,6 @@ 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.
-
-
-
-
-
--
-
**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
@@ -46765,14 +39477,6 @@ client.accounting.accounts.list(
-
-**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.
@@ -46781,14 +39485,6 @@ client.accounting.accounts.list(
-
-**remote_fields:** `typing.Optional[AccountsListRequestRemoteFields]` — Deprecated. Use show_enum_origins.
-
-
-
-
-
--
-
**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
@@ -46797,22 +39493,6 @@ client.accounting.accounts.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.
@@ -46825,7 +39505,7 @@ client.accounting.accounts.list(
client.accounting.accounts.create(...)
+client.hris.companies.retrieve(...)
-
@@ -46837,7 +39517,7 @@ client.accounting.accounts.list(
-
-Creates an `Account` object with the given values.
+Returns a `Company` object with the given `id`.
@@ -46853,16 +39533,15 @@ 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(),
+client.hris.companies.retrieve(
+ id="id",
+ include_remote_data=True,
+ include_shell_data=True,
)
```
@@ -46879,7 +39558,7 @@ client.accounting.accounts.create(
-
-**model:** `AccountRequest`
+**id:** `str`
@@ -46887,7 +39566,7 @@ client.accounting.accounts.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.
@@ -46895,7 +39574,7 @@ client.accounting.accounts.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).
@@ -46915,7 +39594,8 @@ client.accounting.accounts.create(
client.accounting.accounts.retrieve(...)
+## Hris Scopes
+client.hris.scopes.default_scopes_retrieve()
-
@@ -46927,7 +39607,7 @@ client.accounting.accounts.create(
-
-Returns an `Account` object with the given `id`.
+Get the default permissions for Merge Common Models and fields across all Linked Accounts of a given category. [Learn more](https://help.merge.dev/en/articles/5950052-common-model-and-field-scopes).
@@ -46943,22 +39623,12 @@ Returns an `Account` object with the given `id`.
```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,
-)
+client.hris.scopes.default_scopes_retrieve()
```
@@ -46974,54 +39644,6 @@ client.accounting.accounts.retrieve(
-
-**id:** `str`
-
-
-
-
-
--
-
-**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_shell_data:** `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[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.
@@ -47034,7 +39656,7 @@ client.accounting.accounts.retrieve(
client.accounting.accounts.meta_post_retrieve()
+client.hris.scopes.linked_account_scopes_retrieve()
-
@@ -47046,7 +39668,7 @@ client.accounting.accounts.retrieve(
-
-Returns metadata for `Account` 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).
@@ -47067,7 +39689,7 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.accounting.accounts.meta_post_retrieve()
+client.hris.scopes.linked_account_scopes_retrieve()
```
@@ -47095,8 +39717,7 @@ client.accounting.accounts.meta_post_retrieve()
client.accounting.addresses.retrieve(...)
+client.hris.scopes.linked_account_scopes_create(...)
-
@@ -47108,7 +39729,7 @@ client.accounting.accounts.meta_post_retrieve()
-
-Returns an `Address` 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)
@@ -47124,15 +39745,42 @@ Returns an `Address` object with the given `id`.
```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.addresses.retrieve(
- id="id",
- include_remote_data=True,
- include_shell_data=True,
+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,
+ )
+ },
+ ),
+ ],
)
```
@@ -47149,7 +39797,7 @@ client.accounting.addresses.retrieve(
-
-**id:** `str`
+**common_models:** `typing.Sequence[IndividualCommonModelScopeDeserializerRequest]` — The common models you want to update the scopes for
@@ -47157,35 +39805,65 @@ client.accounting.addresses.retrieve(
-
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
-
--
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
-
+client.hris.delete_account.delete()
-
-**remote_fields:** `typing.Optional[typing.Literal["type"]]` — Deprecated. Use show_enum_origins.
-
+#### 📝 Description
+
+
+-
+
+
+-
+
+Delete a linked account.
+
+
+#### 🔌 Usage
+
-
-**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)
-
+
+-
+
+```python
+from merge import Merge
+
+client = Merge(
+ account_token="YOUR_ACCOUNT_TOKEN",
+ api_key="YOUR_API_KEY",
+)
+client.hris.delete_account.delete()
+
+```
+
+
+#### ⚙️ Parameters
+
+
+-
+
-
@@ -47201,8 +39879,8 @@ client.accounting.addresses.retrieve(
client.accounting.async_passthrough.create(...)
+## Hris Dependents
+client.hris.dependents.list(...)
-
@@ -47214,7 +39892,7 @@ client.accounting.addresses.retrieve(
-
-Asynchronously pull data from an endpoint not currently supported by Merge.
+Returns a list of `Dependent` objects.
@@ -47229,19 +39907,40 @@ Asynchronously pull data from an endpoint not currently supported by Merge.
-
```python
+import datetime
+
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.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",
+ 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",
)
+for item in response:
+ yield item
+# alternatively, you can paginate page-by-page
+for page in response.iter_pages():
+ yield page
```
@@ -47257,7 +39956,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 +39964,79 @@ 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
-
-
--
+**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
+
+
+
-
-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
-
-
+**include_sensitive_fields:** `typing.Optional[bool]` — Whether to include sensitive fields (such as social security numbers) in the response.
+
+
+
+
-
-```python
-from merge import Merge
-
-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",
-)
-
-```
+**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
+
+
+
+-
+
+**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
+
-#### ⚙️ Parameters
+
+-
+
+**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
+
+
+
-
+**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 +40056,7 @@ client.accounting.async_passthrough.retrieve(
client.accounting.async_tasks.retrieve(...)
+client.hris.dependents.retrieve(...)
-
@@ -47361,7 +40068,7 @@ client.accounting.async_passthrough.retrieve(
-
-Returns an `AsyncPostTask` object with the given `id`.
+Returns a `Dependent` object with the given `id`.
@@ -47382,8 +40089,11 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.accounting.async_tasks.retrieve(
+client.hris.dependents.retrieve(
id="id",
+ include_remote_data=True,
+ include_sensitive_fields=True,
+ include_shell_data=True,
)
```
@@ -47408,6 +40118,30 @@ client.accounting.async_tasks.retrieve(
-
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
+
+
+
+
+
+-
+
+**include_sensitive_fields:** `typing.Optional[bool]` — Whether to include sensitive fields (such as social security numbers) in the response.
+
+
+
+
+
+-
+
+**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
+
+
+
+
+
+-
+
**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -47420,8 +40154,8 @@ client.accounting.async_tasks.retrieve(
client.accounting.attachments.list(...)
+## Hris EmployeePayrollRuns
+client.hris.employee_payroll_runs.list(...)
-
@@ -47433,7 +40167,7 @@ client.accounting.async_tasks.retrieve(
-
-Returns a list of `AccountingAttachment` objects.
+Returns a list of `EmployeePayrollRun` objects.
@@ -47456,8 +40190,7 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.accounting.attachments.list(
- company_id="company_id",
+response = client.hris.employee_payroll_runs.list(
created_after=datetime.datetime.fromisoformat(
"2024-01-15 09:30:00+00:00",
),
@@ -47465,6 +40198,13 @@ client.accounting.attachments.list(
"2024-01-15 09:30:00+00:00",
),
cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
+ employee_id="employee_id",
+ ended_after=datetime.datetime.fromisoformat(
+ "2024-01-15 09:30:00+00:00",
+ ),
+ ended_before=datetime.datetime.fromisoformat(
+ "2024-01-15 09:30:00+00:00",
+ ),
include_deleted_data=True,
include_remote_data=True,
include_shell_data=True,
@@ -47475,8 +40215,20 @@ client.accounting.attachments.list(
"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",
+ ),
)
+for item in response:
+ yield item
+# alternatively, you can paginate page-by-page
+for page in response.iter_pages():
+ yield page
```
@@ -47492,14 +40244,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.
@@ -47524,7 +40268,7 @@ client.accounting.attachments.list(
-
-**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
+**employee_id:** `typing.Optional[str]` — If provided, will only return employee payroll runs for this employee.
@@ -47532,7 +40276,7 @@ client.accounting.attachments.list(
-
-**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
+**ended_after:** `typing.Optional[dt.datetime]` — If provided, will only return employee payroll runs ended after this datetime.
@@ -47540,7 +40284,7 @@ client.accounting.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).
+**ended_before:** `typing.Optional[dt.datetime]` — If provided, will only return employee payroll runs ended before this datetime.
@@ -47548,7 +40292,12 @@ client.accounting.attachments.list(
-
-**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
+**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.
@@ -47556,7 +40305,7 @@ client.accounting.attachments.list(
-
-**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
+**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
@@ -47564,7 +40313,7 @@ client.accounting.attachments.list(
-
-**page_size:** `typing.Optional[int]` — Number of results to return per page.
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -47572,7 +40321,7 @@ client.accounting.attachments.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).
@@ -47580,73 +40329,39 @@ client.accounting.attachments.list(
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
-
-
-
-
-
-
-client.accounting.attachments.create(...)
-
-#### 📝 Description
-
-
--
+**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
+
+
+
-
-Creates an `AccountingAttachment` object with the given values.
-
-
+**page_size:** `typing.Optional[int]` — Number of results to return per page.
+
-#### 🔌 Usage
-
-
--
-
-
-```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(),
-)
-
-```
-
-
+**payroll_run_id:** `typing.Optional[str]` — If provided, will only return employee payroll runs for this employee.
+
-#### ⚙️ Parameters
-
-
--
-
-
-**model:** `AccountingAttachmentRequest`
+**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
@@ -47654,7 +40369,7 @@ client.accounting.attachments.create(
-
-**is_debug_mode:** `typing.Optional[bool]` — Whether to include debug fields (such as log file links) in the response.
+**started_after:** `typing.Optional[dt.datetime]` — If provided, will only return employee payroll runs started after this datetime.
@@ -47662,7 +40377,7 @@ client.accounting.attachments.create(
-
-**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously.
+**started_before:** `typing.Optional[dt.datetime]` — If provided, will only return employee payroll runs started before this datetime.
@@ -47682,7 +40397,7 @@ client.accounting.attachments.create(
client.accounting.attachments.retrieve(...)
+client.hris.employee_payroll_runs.retrieve(...)
-
@@ -47694,7 +40409,7 @@ client.accounting.attachments.create(
-
-Returns an `AccountingAttachment` object with the given `id`.
+Returns an `EmployeePayrollRun` object with the given `id`.
@@ -47715,7 +40430,7 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.accounting.attachments.retrieve(
+client.hris.employee_payroll_runs.retrieve(
id="id",
include_remote_data=True,
include_shell_data=True,
@@ -47743,6 +40458,19 @@ client.accounting.attachments.retrieve(
-
+**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.
+
+
+
+
+
+-
+
**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -47771,7 +40499,8 @@ client.accounting.attachments.retrieve(
client.accounting.attachments.meta_post_retrieve()
+## Hris Employees
+client.hris.employees.list(...)
-
@@ -47783,7 +40512,7 @@ client.accounting.attachments.retrieve(
-
-Returns metadata for `AccountingAttachment` POSTs.
+Returns a list of `Employee` objects.
@@ -47798,13 +40527,74 @@ Returns metadata for `AccountingAttachment` POSTs.
-
```python
+import datetime
+
from merge import Merge
+from merge.resources.hris.resources.employees import (
+ EmployeesListRequestEmploymentStatus,
+ EmployeesListRequestRemoteFields,
+ EmployeesListRequestShowEnumOrigins,
+)
client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.accounting.attachments.meta_post_retrieve()
+response = 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",
+ employment_status=EmployeesListRequestEmploymentStatus.ACTIVE,
+ employment_type="employment_type",
+ 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",
+)
+for item in response:
+ yield item
+# alternatively, you can paginate page-by-page
+for page in response.iter_pages():
+ yield page
```
@@ -47820,76 +40610,61 @@ client.accounting.attachments.meta_post_retrieve()
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+**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.
+
-client.accounting.audit_trail.list(...)
-
-#### 📝 Description
-
-
--
+**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
+
+
+
-
-Gets a list of audit trail events.
-
-
+**cursor:** `typing.Optional[str]` — The pagination cursor value.
+
-#### 🔌 Usage
-
-
+**display_full_name:** `typing.Optional[str]` — If provided, will only return employees with this display name.
+
+
+
+
-
-```python
-from merge import Merge
+**employment_status:** `typing.Optional[EmployeesListRequestEmploymentStatus]`
-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",
-)
+If provided, will only return employees with this employment status.
-```
-
-
+* `ACTIVE` - ACTIVE
+* `PENDING` - PENDING
+* `INACTIVE` - INACTIVE
+
-#### ⚙️ Parameters
-
-
--
-
-
-**cursor:** `typing.Optional[str]` — The pagination cursor value.
+**employment_type:** `typing.Optional[str]` — If provided, will only return employees that have an employment of the specified employment_type.
@@ -47897,7 +40672,12 @@ client.accounting.audit_trail.list(
-
-**end_date:** `typing.Optional[str]` — If included, will only include audit trail events that occurred before this time
+**expand:** `typing.Optional[
+ typing.Union[
+ EmployeesListRequestExpandItem,
+ typing.Sequence[EmployeesListRequestExpandItem],
+ ]
+]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -47905,7 +40685,7 @@ client.accounting.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`
+**first_name:** `typing.Optional[str]` — If provided, will only return employees with this first name.
@@ -47913,7 +40693,7 @@ client.accounting.audit_trail.list(
-
-**page_size:** `typing.Optional[int]` — Number of results to return per page.
+**groups:** `typing.Optional[str]` — If provided, will only return employees matching the group ids; multiple groups can be separated by commas.
@@ -47921,7 +40701,7 @@ client.accounting.audit_trail.list(
-
-**start_date:** `typing.Optional[str]` — If included, will only include audit trail events that occurred after this time
+**home_location_id:** `typing.Optional[str]` — If provided, will only return employees for this home location.
@@ -47929,7 +40709,7 @@ client.accounting.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/).
@@ -47937,153 +40717,127 @@ client.accounting.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_sensitive_fields:** `typing.Optional[bool]` — Whether to include sensitive fields (such as social security numbers) in the response.
+
-client.accounting.available_actions.retrieve()
-
-#### 📝 Description
-
-
--
+**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
+
+
+
-
-Returns a list of models and actions available for an account.
-
-
+**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
-from merge import Merge
-
-client = Merge(
- account_token="YOUR_ACCOUNT_TOKEN",
- api_key="YOUR_API_KEY",
-)
-client.accounting.available_actions.retrieve()
-
-```
-
-
+**manager_id:** `typing.Optional[str]` — If provided, will only return employees for this manager.
+
-#### ⚙️ Parameters
-
-
+**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
+
+
+
+
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
-
-
+
+-
+**page_size:** `typing.Optional[int]` — Number of results to return per page.
+
-client.accounting.balance_sheets.list(...)
-
-#### 📝 Description
+**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
+
+
+
+
-
-Returns a list of `BalanceSheet` objects.
-
-
+**remote_fields:** `typing.Optional[EmployeesListRequestRemoteFields]` — Deprecated. Use show_enum_origins.
+
-#### 🔌 Usage
-
-
+**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
+
+
+
+
-
-```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",
- ),
- 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",
-)
-
-```
-
-
+**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)
+
-#### ⚙️ Parameters
-
-
+**started_after:** `typing.Optional[dt.datetime]` — If provided, will only return employees that started after this datetime.
+
+
+
+
-
-**company_id:** `typing.Optional[str]` — If provided, will only return balance sheets for this company.
+**started_before:** `typing.Optional[dt.datetime]` — If provided, will only return employees that started before this datetime.
@@ -48091,7 +40845,7 @@ client.accounting.balance_sheets.list(
-
-**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
+**team_id:** `typing.Optional[str]` — If provided, will only return employees for this team.
@@ -48099,7 +40853,7 @@ client.accounting.balance_sheets.list(
-
-**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
+**terminated_after:** `typing.Optional[dt.datetime]` — If provided, will only return employees that were terminated after this datetime.
@@ -48107,7 +40861,7 @@ client.accounting.balance_sheets.list(
-
-**cursor:** `typing.Optional[str]` — The pagination cursor value.
+**terminated_before:** `typing.Optional[dt.datetime]` — If provided, will only return employees that were terminated before this datetime.
@@ -48115,7 +40869,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.
+**work_email:** `typing.Optional[str]` — If provided, will only return Employees with this work email
@@ -48123,7 +40877,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/).
+**work_location_id:** `typing.Optional[str]` — If provided, will only return employees for this location.
@@ -48131,31 +40885,73 @@ 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.
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+client.hris.employees.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 an `Employee` 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.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
+
-
-**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
+
+-
+
+**model:** `EmployeeRequest`
@@ -48163,7 +40959,7 @@ client.accounting.balance_sheets.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.
@@ -48171,7 +40967,7 @@ client.accounting.balance_sheets.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.
@@ -48191,7 +40987,7 @@ client.accounting.balance_sheets.list(
client.accounting.balance_sheets.retrieve(...)
+client.hris.employees.retrieve(...)
-
@@ -48203,7 +40999,7 @@ client.accounting.balance_sheets.list(
-
-Returns a `BalanceSheet` object with the given `id`.
+Returns an `Employee` object with the given `id`.
@@ -48219,15 +41015,22 @@ Returns a `BalanceSheet` object with the given `id`.
```python
from merge import Merge
+from merge.resources.hris.resources.employees import (
+ EmployeesRetrieveRequestRemoteFields,
+ EmployeesRetrieveRequestShowEnumOrigins,
+)
client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.accounting.balance_sheets.retrieve(
+client.hris.employees.retrieve(
id="id",
include_remote_data=True,
+ include_sensitive_fields=True,
include_shell_data=True,
+ remote_fields=EmployeesRetrieveRequestRemoteFields.EMPLOYMENT_STATUS,
+ show_enum_origins=EmployeesRetrieveRequestShowEnumOrigins.EMPLOYMENT_STATUS,
)
```
@@ -48252,7 +41055,12 @@ 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.
+**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.
@@ -48268,6 +41076,14 @@ client.accounting.balance_sheets.retrieve(
-
+**include_sensitive_fields:** `typing.Optional[bool]` — Whether to include sensitive fields (such as social security numbers) in the response.
+
+
+
+
+
+-
+
**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -48276,6 +41092,22 @@ client.accounting.balance_sheets.retrieve(
-
+**remote_fields:** `typing.Optional[EmployeesRetrieveRequestRemoteFields]` — Deprecated. Use show_enum_origins.
+
+
+
+
+
+-
+
+**show_enum_origins:** `typing.Optional[EmployeesRetrieveRequestShowEnumOrigins]` — A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter)
+
+
+
+
+
+-
+
**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -48288,8 +41120,7 @@ client.accounting.balance_sheets.retrieve(
client.accounting.bank_feed_accounts.list(...)
+client.hris.employees.ignore_create(...)
-
@@ -48301,7 +41132,7 @@ client.accounting.balance_sheets.retrieve(
-
-Returns a list of `BankFeedAccount` 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.
@@ -48317,17 +41148,17 @@ Returns a list of `BankFeedAccount` objects.
```python
from merge import Merge
+from merge.resources.hris import IgnoreCommonModelRequest, ReasonEnum
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,
+client.hris.employees.ignore_create(
+ model_id="model_id",
+ request=IgnoreCommonModelRequest(
+ reason=ReasonEnum.GENERAL_CUSTOMER_REQUEST,
+ ),
)
```
@@ -48344,7 +41175,7 @@ client.accounting.bank_feed_accounts.list(
-
-**cursor:** `typing.Optional[str]` — The pagination cursor value.
+**model_id:** `str`
@@ -48352,7 +41183,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/).
+**request:** `IgnoreCommonModelRequest`
@@ -48360,27 +41191,64 @@ 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.
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+client.hris.employees.meta_post_retrieve()
-
-**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
-
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns metadata for `Employee` 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.hris.employees.meta_post_retrieve()
+
+```
+
+
+#### ⚙️ Parameters
+
+
+-
+
-
@@ -48396,7 +41264,8 @@ client.accounting.bank_feed_accounts.list(
client.accounting.bank_feed_accounts.create(...)
+## Hris EmployerBenefits
+client.hris.employer_benefits.list(...)
-
@@ -48408,7 +41277,7 @@ client.accounting.bank_feed_accounts.list(
-
-Creates a `BankFeedAccount` object with the given values.
+Returns a list of `EmployerBenefit` objects.
@@ -48423,18 +41292,39 @@ Creates a `BankFeedAccount` object with the given values.
-
```python
+import datetime
+
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(),
+response = 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",
)
+for item in response:
+ yield item
+# alternatively, you can paginate page-by-page
+for page in response.iter_pages():
+ yield page
```
@@ -48450,7 +41340,7 @@ client.accounting.bank_feed_accounts.create(
-
-**model:** `BankFeedAccountRequest`
+**created_after:** `typing.Optional[dt.datetime]` — If provided, will only return objects created after this datetime.
@@ -48458,7 +41348,7 @@ 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.
+**created_before:** `typing.Optional[dt.datetime]` — If provided, will only return objects created before this datetime.
@@ -48466,7 +41356,7 @@ client.accounting.bank_feed_accounts.create(
-
-**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously.
+**cursor:** `typing.Optional[str]` — The pagination cursor value.
@@ -48474,72 +41364,39 @@ client.accounting.bank_feed_accounts.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.accounting.bank_feed_accounts.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 a `BankFeedAccount` object with the given `id`.
-
-
+**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
+
-#### 🔌 Usage
-
-
-
--
-
-```python
-from merge import Merge
-
-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,
-)
-
-```
-
-
+**modified_after:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge after this date time will be returned.
+
-#### ⚙️ Parameters
-
-
-
--
-
-**id:** `str`
+**modified_before:** `typing.Optional[dt.datetime]` — If provided, only objects synced by Merge before this date time will be returned.
@@ -48547,7 +41404,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.
+**page_size:** `typing.Optional[int]` — Number of results to return per page.
@@ -48555,7 +41412,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).
+**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
@@ -48575,7 +41432,7 @@ client.accounting.bank_feed_accounts.retrieve(
client.accounting.bank_feed_accounts.meta_post_retrieve()
+client.hris.employer_benefits.retrieve(...)
-
@@ -48587,7 +41444,7 @@ client.accounting.bank_feed_accounts.retrieve(
-
-Returns metadata for `BankFeedAccount` POSTs.
+Returns an `EmployerBenefit` object with the given `id`.
@@ -48608,7 +41465,11 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.accounting.bank_feed_accounts.meta_post_retrieve()
+client.hris.employer_benefits.retrieve(
+ id="id",
+ include_remote_data=True,
+ include_shell_data=True,
+)
```
@@ -48624,6 +41485,30 @@ client.accounting.bank_feed_accounts.meta_post_retrieve()
-
+**id:** `str`
+
+
+
+
+
+-
+
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
+
+
+
+
+
+-
+
+**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
+
+
+
+
+
+-
+
**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -48636,8 +41521,8 @@ client.accounting.bank_feed_accounts.meta_post_retrieve()
client.accounting.bank_feed_transactions.list(...)
+## Hris Employments
+client.hris.employments.list(...)
-
@@ -48649,7 +41534,7 @@ client.accounting.bank_feed_accounts.meta_post_retrieve()
-
-Returns a list of `BankFeedTransaction` objects.
+Returns a list of `Employment` objects.
@@ -48667,12 +41552,17 @@ Returns a list of `BankFeedTransaction` objects.
import datetime
from merge import Merge
+from merge.resources.hris.resources.employments import (
+ EmploymentsListRequestOrderBy,
+ EmploymentsListRequestRemoteFields,
+ EmploymentsListRequestShowEnumOrigins,
+)
client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.accounting.bank_feed_transactions.list(
+response = client.hris.employments.list(
created_after=datetime.datetime.fromisoformat(
"2024-01-15 09:30:00+00:00",
),
@@ -48680,19 +41570,27 @@ client.accounting.bank_feed_transactions.list(
"2024-01-15 09:30:00+00:00",
),
cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
+ employee_id="employee_id",
include_deleted_data=True,
include_remote_data=True,
include_shell_data=True,
- 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",
),
+ order_by=EmploymentsListRequestOrderBy.EFFECTIVE_DATE_DESCENDING,
page_size=1,
+ remote_fields=EmploymentsListRequestRemoteFields.EMPLOYMENT_TYPE,
remote_id="remote_id",
+ show_enum_origins=EmploymentsListRequestShowEnumOrigins.EMPLOYMENT_TYPE,
)
+for item in response:
+ yield item
+# alternatively, you can paginate page-by-page
+for page in response.iter_pages():
+ yield page
```
@@ -48732,7 +41630,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.
+**employee_id:** `typing.Optional[str]` — If provided, will only return employments for this employee.
@@ -48740,7 +41638,12 @@ 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/).
+**expand:** `typing.Optional[
+ typing.Union[
+ EmploymentsListRequestExpandItem,
+ typing.Sequence[EmploymentsListRequestExpandItem],
+ ]
+]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -48748,7 +41651,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.
+**include_deleted_data:** `typing.Optional[bool]` — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
@@ -48756,7 +41659,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).
+**include_remote_data:** `typing.Optional[bool]` — Whether to include the original data Merge fetched from the third-party to produce these models.
@@ -48764,7 +41667,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
+**include_shell_data:** `typing.Optional[bool]` — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
@@ -48788,15 +41691,7 @@ client.accounting.bank_feed_transactions.list(
-
-**page_size:** `typing.Optional[int]` — Number of results to return per page.
-
-
-
-
-
--
-
-**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
+**order_by:** `typing.Optional[EmploymentsListRequestOrderBy]` — Overrides the default ordering for this endpoint. Possible values include: effective_date, -effective_date.
@@ -48804,73 +41699,15 @@ client.accounting.bank_feed_transactions.list(
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+**page_size:** `typing.Optional[int]` — Number of results to return per page.
-
-
-
-
-
-
-
-
-client.accounting.bank_feed_transactions.create(...)
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Creates a `BankFeedTransaction` object with the given values.
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from merge import Merge
-from merge.resources.accounting import BankFeedTransactionRequestRequest
-
-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(),
-)
-
-```
-
-
-#### ⚙️ Parameters
-
-
-
--
-
-**model:** `BankFeedTransactionRequestRequest`
+**remote_fields:** `typing.Optional[EmploymentsListRequestRemoteFields]` — Deprecated. Use show_enum_origins.
@@ -48878,7 +41715,7 @@ client.accounting.bank_feed_transactions.create(
-
-**is_debug_mode:** `typing.Optional[bool]` — Whether to include debug fields (such as log file links) in the response.
+**remote_id:** `typing.Optional[str]` — The API provider's ID for the given object.
@@ -48886,7 +41723,7 @@ client.accounting.bank_feed_transactions.create(
-
-**run_async:** `typing.Optional[bool]` — Whether or not third-party updates should be run asynchronously.
+**show_enum_origins:** `typing.Optional[EmploymentsListRequestShowEnumOrigins]` — A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter)
@@ -48906,7 +41743,7 @@ client.accounting.bank_feed_transactions.create(
client.accounting.bank_feed_transactions.retrieve(...)
+client.hris.employments.retrieve(...)
-
@@ -48918,7 +41755,7 @@ client.accounting.bank_feed_transactions.create(
-
-Returns a `BankFeedTransaction` object with the given `id`.
+Returns an `Employment` object with the given `id`.
@@ -48934,15 +41771,21 @@ Returns a `BankFeedTransaction` object with the given `id`.
```python
from merge import Merge
+from merge.resources.hris.resources.employments import (
+ EmploymentsRetrieveRequestRemoteFields,
+ EmploymentsRetrieveRequestShowEnumOrigins,
+)
client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.accounting.bank_feed_transactions.retrieve(
+client.hris.employments.retrieve(
id="id",
include_remote_data=True,
include_shell_data=True,
+ remote_fields=EmploymentsRetrieveRequestRemoteFields.EMPLOYMENT_TYPE,
+ show_enum_origins=EmploymentsRetrieveRequestShowEnumOrigins.EMPLOYMENT_TYPE,
)
```
@@ -48967,7 +41810,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[
+ EmploymentsRetrieveRequestExpandItem,
+ typing.Sequence[EmploymentsRetrieveRequestExpandItem],
+ ]
+]` — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
@@ -48991,6 +41839,22 @@ client.accounting.bank_feed_transactions.retrieve(
-
+**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.
@@ -49003,7 +41867,8 @@ client.accounting.bank_feed_transactions.retrieve(
client.accounting.bank_feed_transactions.meta_post_retrieve()
+## Hris FieldMapping
+client.hris.field_mapping.field_mappings_retrieve(...)
-
@@ -49015,7 +41880,7 @@ client.accounting.bank_feed_transactions.retrieve(
-
-Returns metadata for `BankFeedTransaction` POSTs.
+Get all Field Mappings for this Linked Account. Field Mappings are mappings between third-party Remote Fields and user defined Merge fields. [Learn more](https://docs.merge.dev/supplemental-data/field-mappings/overview/).
@@ -49036,7 +41901,9 @@ client = Merge(
account_token="YOUR_ACCOUNT_TOKEN",
api_key="YOUR_API_KEY",
)
-client.accounting.bank_feed_transactions.meta_post_retrieve()
+client.hris.field_mapping.field_mappings_retrieve(
+ exclude_remote_field_metadata=True,
+)
```
@@ -49052,6 +41919,14 @@ client.accounting.bank_feed_transactions.meta_post_retrieve()
-
+**exclude_remote_field_metadata:** `typing.Optional[bool]` — If `true`, remote fields metadata is excluded from each field mapping instance (i.e. `remote_fields.remote_key_name` and `remote_fields.schema` will be null). This will increase the speed of the request since these fields require some calculations.
+
+
+
+
+
+-
+
**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -49064,8 +41939,7 @@ client.accounting.bank_feed_transactions.meta_post_retrieve()
client.accounting.cash_flow_statements.list(...)
+client.hris.field_mapping.field_mappings_create(...)
-
@@ -49077,7 +41951,7 @@ client.accounting.bank_feed_transactions.meta_post_retrieve()